Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: [#4204] Fix remaining eslint warnings - botbuilder-core (1/2) #4228

Merged
merged 5 commits into from
Jun 16, 2022
Merged

fix: [#4204] Fix remaining eslint warnings - botbuilder-core (1/2) #4228

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
463f2e2
Fix eslint issues in botbuilder-core (1/2)
ceciliaavila May 2, 2022
000a6f2
Fix depcheck error
ceciliaavila May 2, 2022
4424b84
Merge branch 'main' into southworks/fix/eslint-botbuilder-core-1
tracyboehrer Jun 16, 2022
a11832f
Corrected conflict resolution error
Jun 16, 2022
77ee4dd
Fixed accessor conflict
Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 39 additions & 49 deletions libraries/botbuilder-core/etc/botbuilder-core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export class ActivityHandler extends ActivityHandlerBase {
[type: string]: BotHandler[];
};
protected on(type: string, handler: BotHandler): this;
protected onAdaptiveCardInvoke(context: TurnContext, invokeValue: AdaptiveCardInvokeValue): Promise<AdaptiveCardInvokeResponse>;
protected onAdaptiveCardInvoke(_context: TurnContext, _invokeValue: AdaptiveCardInvokeValue): Promise<AdaptiveCardInvokeResponse>;
onCommand(handler: BotHandler): this;
protected onCommandActivity(context: TurnContext): Promise<void>;
onCommandResult(handler: BotHandler): this;
Expand Down Expand Up @@ -96,8 +96,8 @@ export class ActivityHandler extends ActivityHandlerBase {
protected onReactionsAddedActivity(reactionsAdded: MessageReaction[], context: TurnContext): Promise<void>;
onReactionsRemoved(handler: BotHandler): this;
protected onReactionsRemovedActivity(reactionsRemoved: MessageReaction[], context: TurnContext): Promise<void>;
protected onSearchInvoke(context: TurnContext, invokeValue: SearchInvokeValue): Promise<SearchInvokeResponse>;
protected onSignInInvoke(context: TurnContext): Promise<void>;
protected onSearchInvoke(_context: TurnContext, _invokeValue: SearchInvokeValue): Promise<SearchInvokeResponse>;
protected onSignInInvoke(_context: TurnContext): Promise<void>;
onTokenResponseEvent(handler: BotHandler): this;
onTurn(handler: BotHandler): this;
protected onTurnActivity(context: TurnContext): Promise<void>;
Expand All @@ -110,24 +110,24 @@ export class ActivityHandler extends ActivityHandlerBase {

// @public
export class ActivityHandlerBase {
protected onCommandActivity(context: TurnContext): Promise<void>;
protected onCommandResultActivity(context: TurnContext): Promise<void>;
protected onCommandActivity(_context: TurnContext): Promise<void>;
protected onCommandResultActivity(_context: TurnContext): Promise<void>;
protected onConversationUpdateActivity(context: TurnContext): Promise<void>;
protected onEndOfConversationActivity(context: TurnContext): Promise<void>;
protected onEventActivity(context: TurnContext): Promise<void>;
protected onEndOfConversationActivity(_context: TurnContext): Promise<void>;
protected onEventActivity(_context: TurnContext): Promise<void>;
protected onInstallationUpdateActivity(context: TurnContext): Promise<void>;
protected onInstallationUpdateAddActivity(context: TurnContext): Promise<void>;
protected onInstallationUpdateRemoveActivity(context: TurnContext): Promise<void>;
protected onInvokeActivity(context: TurnContext): Promise<InvokeResponse>;
protected onMembersAddedActivity(membersAdded: ChannelAccount[], context: TurnContext): Promise<void>;
protected onMembersRemovedActivity(membersRemoved: ChannelAccount[], context: TurnContext): Promise<void>;
protected onMessageActivity(context: TurnContext): Promise<void>;
protected onInstallationUpdateAddActivity(_context: TurnContext): Promise<void>;
protected onInstallationUpdateRemoveActivity(_context: TurnContext): Promise<void>;
protected onInvokeActivity(_context: TurnContext): Promise<InvokeResponse>;
protected onMembersAddedActivity(_membersAdded: ChannelAccount[], _context: TurnContext): Promise<void>;
protected onMembersRemovedActivity(_membersRemoved: ChannelAccount[], _context: TurnContext): Promise<void>;
protected onMessageActivity(_context: TurnContext): Promise<void>;
protected onMessageReactionActivity(context: TurnContext): Promise<void>;
protected onReactionsAddedActivity(reactionsAdded: MessageReaction[], context: TurnContext): Promise<void>;
protected onReactionsRemovedActivity(reactionsRemoved: MessageReaction[], context: TurnContext): Promise<void>;
protected onReactionsAddedActivity(_reactionsAdded: MessageReaction[], _context: TurnContext): Promise<void>;
protected onReactionsRemovedActivity(_reactionsRemoved: MessageReaction[], _context: TurnContext): Promise<void>;
protected onTurnActivity(context: TurnContext): Promise<void>;
protected onTypingActivity(context: TurnContext): Promise<void>;
protected onUnrecognizedActivity(context: TurnContext): Promise<void>;
protected onTypingActivity(_context: TurnContext): Promise<void>;
protected onUnrecognizedActivity(_context: TurnContext): Promise<void>;
run(context: TurnContext): Promise<void>;
}

Expand Down Expand Up @@ -159,7 +159,7 @@ export abstract class BotAdapter {
continueConversationAsync(botAppId: string, reference: Partial<ConversationReference>, logic: (context: TurnContext) => Promise<void>): Promise<void>;
continueConversationAsync(claimsIdentity: ClaimsIdentity, reference: Partial<ConversationReference>, logic: (context: TurnContext) => Promise<void>): Promise<void>;
continueConversationAsync(claimsIdentity: ClaimsIdentity, reference: Partial<ConversationReference>, audience: string, logic: (context: TurnContext) => Promise<void>): Promise<void>;
createConversationAsync(botAppId: string, channelId: string, serviceUrl: string, audience: string, conversationParameters: ConversationParameters, logic: (context: TurnContext) => Promise<void>): Promise<void>;
createConversationAsync(_botAppId: string, _channelId: string, _serviceUrl: string, _audience: string, _conversationParameters: ConversationParameters, _logic: (context: TurnContext) => Promise<void>): Promise<void>;
abstract deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>;
// (undocumented)
protected middleware: MiddlewareSet;
Expand Down Expand Up @@ -299,15 +299,15 @@ export class CardFactory {
static videoCard(title: string, media: (MediaUrl | string)[], buttons?: (CardAction | string)[], other?: Partial<VideoCard>): Attachment;
}

// @public (undocumented)
// @public
export abstract class CloudAdapterBase extends BotAdapter {
constructor(botFrameworkAuthentication: BotFrameworkAuthentication);
// (undocumented)
protected readonly botFrameworkAuthentication: BotFrameworkAuthentication;
// (undocumented)
readonly ConnectorFactoryKey: symbol;
// @deprecated (undocumented)
continueConversation(reference: Partial<ConversationReference>, logic: (context: TurnContext) => Promise<void>): Promise<void>;
continueConversation(_reference: Partial<ConversationReference>, _logic: (context: TurnContext) => Promise<void>): Promise<void>;
// @internal (undocumented)
continueConversationAsync(botAppIdOrClaimsIdentity: string | ClaimsIdentity, reference: Partial<ConversationReference>, logicOrAudience: ((context: TurnContext) => Promise<void>) | string, maybeLogic?: (context: TurnContext) => Promise<void>): Promise<void>;
protected createClaimsIdentity(botAppId?: string): ClaimsIdentity;
Expand Down Expand Up @@ -335,17 +335,11 @@ export class ComponentRegistration {
// @public
export class ConfigurationBotFrameworkAuthentication extends BotFrameworkAuthentication {
constructor(botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions);
// (undocumented)
authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>;
// (undocumented)
authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>;
// (undocumented)
authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>;
// (undocumented)
createBotFrameworkClient(): BotFrameworkClient;
// (undocumented)
createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory;
// (undocumented)
createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>;
}

Expand Down Expand Up @@ -396,7 +390,7 @@ export function createServiceClientCredentialFactoryFromConfiguration(configurat
// @public
export type DeleteActivityHandler = (context: TurnContext, reference: Partial<ConversationReference>, next: () => Promise<void>) => Promise<void>;

// @public
// @public @deprecated
export interface ExtendedUserTokenProvider extends IUserTokenProvider {
exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>;
exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>;
Expand Down Expand Up @@ -426,16 +420,15 @@ export interface IntentScore {
// @public (undocumented)
export const INVOKE_RESPONSE_KEY: unique symbol;

// @public (undocumented)
// @public
export class InvokeException<T = unknown> extends Error {
constructor(status: StatusCodes, response?: T);
// (undocumented)
createInvokeResponse(): InvokeResponse;
}

export { InvokeResponse }

// @public
// @public @deprecated
export interface IUserTokenProvider {
getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<{
[propertyName: string]: TokenResponse;
Expand Down Expand Up @@ -498,13 +491,13 @@ export class MiddlewareSet implements Middleware {

// @public
export class NullTelemetryClient implements BotTelemetryClient, BotPageViewTelemetryClient {
constructor(settings?: any);
constructor(_settings?: any);
flush(): void;
trackDependency(telemetry: TelemetryDependency): void;
trackEvent(telemetry: TelemetryEvent): void;
trackException(telemetry: TelemetryException): void;
trackPageView(telemetry: TelemetryPageView): void;
trackTrace(telemetry: TelemetryTrace): void;
trackDependency(_telemetry: TelemetryDependency): void;
trackEvent(_telemetry: TelemetryEvent): void;
trackException(_telemetry: TelemetryException): void;
trackPageView(_telemetry: TelemetryPageView): void;
trackTrace(_telemetry: TelemetryTrace): void;
}

// @public
Expand Down Expand Up @@ -574,26 +567,23 @@ export class ShowTypingMiddleware implements Middleware {
onTurn(context: TurnContext, next: () => Promise<void>): Promise<void>;
}

// @public (undocumented)
// @public
export class SkillConversationIdFactory extends SkillConversationIdFactoryBase {
constructor(storage: Storage_2);
// (undocumented)
createSkillConversationIdWithOptions(options: SkillConversationIdFactoryOptions): Promise<string>;
// (undocumented)
deleteConversationReference(skillConversationId: string): Promise<void>;
// (undocumented)
getSkillConversationReference(skillConversationId: string): Promise<SkillConversationReference>;
}

// @public
export abstract class SkillConversationIdFactoryBase {
// @deprecated
createSkillConversationId(conversationReference: ConversationReference): Promise<string>;
createSkillConversationIdWithOptions(options: SkillConversationIdFactoryOptions): Promise<string>;
createSkillConversationId(_conversationReference: ConversationReference): Promise<string>;
createSkillConversationIdWithOptions(_options: SkillConversationIdFactoryOptions): Promise<string>;
abstract deleteConversationReference(skillConversationId: string): Promise<void>;
// @deprecated
getConversationReference(skillConversationId: string): Promise<ConversationReference>;
getSkillConversationReference(skillConversationId: string): Promise<SkillConversationReference>;
getConversationReference(_skillConversationId: string): Promise<ConversationReference>;
getSkillConversationReference(_skillConversationId: string): Promise<SkillConversationReference>;
}

// @public (undocumented)
Expand Down Expand Up @@ -773,7 +763,7 @@ export class TestAdapter extends BotAdapter implements ExtendedUserTokenProvider
get activityBuffer(): Partial<Activity>[];
addExchangeableToken(connectionName: string, channelId: string, userId: string, exchangeableItem: string, token: string): void;
addUserToken(connectionName: string, channelId: string, userId: string, token: string, magicCode?: string): void;
continueConversation(reference: Partial<ConversationReference>, logic: (revocableContext: TurnContext) => Promise<void>): Promise<void>;
continueConversation(_reference: Partial<ConversationReference>, _logic: (revocableContext: TurnContext) => Promise<void>): Promise<void>;
conversation: ConversationReference;
protected createContext(request: Partial<Activity>): TurnContext;
static createConversation(name: string, user?: string, bot?: string): ConversationReference;
Expand All @@ -782,13 +772,13 @@ export class TestAdapter extends BotAdapter implements ExtendedUserTokenProvider
// Warning: (ae-setter-with-docs) The doc comment for the property "enableTrace" must appear on the getter, not the setter.
set enableTrace(value: boolean);
exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>;
getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<{
getAadTokens(_context: TurnContext, _connectionName: string, _resourceUrls: string[]): Promise<{
[propertyName: string]: TokenResponse;
}>;
getNextReply(): Partial<Activity>;
getSignInLink(context: TurnContext, connectionName: string): Promise<string>;
getSignInResource(context: TurnContext, connectionName: string, userId?: string, finalRedirect?: string): Promise<SignInUrlResponse>;
getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>;
getSignInResource(context: TurnContext, connectionName: string, userId?: string, _finalRedirect?: string): Promise<SignInUrlResponse>;
getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, _oAuthAppCredentials?: any): Promise<any[]>;
getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>;
locale: string;
makeActivity(text?: string): Partial<Activity>;
Expand All @@ -799,7 +789,7 @@ export class TestAdapter extends BotAdapter implements ExtendedUserTokenProvider
sendTextToBot(userSays: string, callback: (context: TurnContext) => Promise<any>): Promise<any>;
signOutUser(context: TurnContext, connectionName?: string, userId?: string): Promise<void>;
readonly template: Partial<Activity>;
test(userSays: string | Partial<Activity>, expected: string | Partial<Activity> | ((activity: Partial<Activity>, description?: string) => void), description?: string, timeout?: number): TestFlow;
test(userSays: string | Partial<Activity>, expected: string | Partial<Activity> | ((activity: Partial<Activity>, description?: string) => void), description?: string, _timeout?: number): TestFlow;
testActivities(activities: Partial<Activity>[], description?: string, timeout?: number): TestFlow;
throwOnExchangeRequest(connectionName: string, channelId: string, userId: string, exchangeableItem: string): void;
updateActivity(context: TurnContext, activity: Partial<Activity>): Promise<ResourceResponse | void>;
Expand Down
1 change: 0 additions & 1 deletion libraries/botbuilder-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
},
"devDependencies": {
"chatdown": "^1.2.4",
"lodash": "^4.17.20",
"request": "^2.88.2",
"unzipper": "^0.10.9"
},
Expand Down
31 changes: 23 additions & 8 deletions libraries/botbuilder-core/src/activityFactory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ export class ActivityFactory {

/**
* Generate the activity.
*
* @param lgResult string result from languageGenerator.
* @returns The generated MessageActivity.
*/
public static fromObject(lgResult: any): Partial<Activity> {
if (lgResult == null) {
Expand All @@ -135,7 +137,9 @@ export class ActivityFactory {

/**
* Given a lg result, create a text activity. This method will create a MessageActivity from text.
*
* @param text lg text output.
* @returns The created MessageActivity.
*/
private static buildActivityFromText(text: string): Partial<Activity> {
const msg: Partial<Activity> = {
Expand All @@ -152,7 +156,9 @@ export class ActivityFactory {

/**
* Given a structured lg result, create an activity. This method will create an MessageActivity from object
*
* @param lgValue lg output.
* @returns The created MessageActivity.
*/
private static buildActivityFromLGStructuredResult(lgValue: any): Partial<Activity> {
let activity: Partial<Activity> = {};
Expand All @@ -171,6 +177,7 @@ export class ActivityFactory {

/**
* Builds an [Activity](xref:botframework-schema.Activity) with a given message.
*
* @param messageValue Message value on which to base the activity.
* @returns [Activity](xref:botframework-schema.Activity) with the given message.
*/
Expand Down Expand Up @@ -312,7 +319,7 @@ export class ActivityFactory {
const value: any = input[key];

switch (property.toLowerCase()) {
case 'contenttype':
case 'contenttype': {
const type: string = value.toString().toLowerCase();
if (this.genericCardTypeMapping.has(type)) {
attachment.contentType = this.genericCardTypeMapping.get(type);
Expand All @@ -322,9 +329,11 @@ export class ActivityFactory {
attachment.contentType = type;
}
break;
default:
}
default: {
attachment[this.realProperty(property, this.attachmentProperties)] = value;
break;
}
}
}

Expand All @@ -342,11 +351,12 @@ export class ActivityFactory {
const value: any = input[key];

switch (property) {
case 'tap':
case 'tap': {
card[property] = this.getCardAction(value);
break;
}
case 'image':
case 'images':
case 'images': {
if (type === CardFactory.contentTypes.heroCard || type === CardFactory.contentTypes.thumbnailCard) {
if (!('images' in card)) {
card['images'] = [];
Expand All @@ -358,35 +368,40 @@ export class ActivityFactory {
card['image'] = this.normalizedToMediaOrImage(value);
}
break;
case 'media':
}
case 'media': {
if (!('media' in card)) {
card['media'] = [];
}

const mediaList = this.normalizedToList(value);
mediaList.forEach((u): any => card['media'].push(this.normalizedToMediaOrImage(u)));
break;
case 'buttons':
}
case 'buttons': {
if (!('buttons' in card)) {
card['buttons'] = [];
}

const buttons: any[] = this.getButtons(value);
buttons.forEach((u): any => card[property].push(u));
break;
}
case 'autostart':
case 'shareable':
case 'autoloop':
case 'autoloop': {
const boolValue: boolean = this.getValidBooleanValue(value.toString());
if (boolValue !== undefined) {
card[property] = boolValue;
} else {
card[property] = value;
}
break;
default:
}
default: {
card[this.realProperty(key.trim(), this.cardProperties)] = value;
break;
}
}
}

Expand Down
Loading