-
Notifications
You must be signed in to change notification settings - Fork 188
/
manifestUpdater.ts
320 lines (279 loc) · 10.5 KB
/
manifestUpdater.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
"use strict";
import { OpenAPIV3 } from "openapi-types";
import fs from "fs-extra";
import path from "path";
import { AuthInfo, ErrorType, ParseOptions, ProjectType, WarningResult } from "./interfaces";
import { Utils } from "./utils";
import { SpecParserError } from "./specParserError";
import { ConstantString } from "./constants";
import {
IComposeExtension,
IMessagingExtensionCommand,
TeamsAppManifest,
PluginManifestSchema,
FunctionObject,
FunctionParameters,
FunctionParameter,
} from "@microsoft/teams-manifest";
export class ManifestUpdater {
static async updateManifestWithAiPlugin(
manifestPath: string,
outputSpecPath: string,
apiPluginFilePath: string,
spec: OpenAPIV3.Document,
options: ParseOptions
): Promise<[TeamsAppManifest, PluginManifestSchema]> {
const manifest: TeamsAppManifest = await fs.readJSON(manifestPath);
const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
manifest.plugins = [
{
pluginFile: apiPluginRelativePath,
},
];
ManifestUpdater.updateManifestDescription(manifest, spec);
const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
const apiPlugin = ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, options);
return [manifest, apiPlugin];
}
static updateManifestDescription(manifest: TeamsAppManifest, spec: OpenAPIV3.Document): void {
manifest.description = {
short: spec.info.title.slice(0, ConstantString.ShortDescriptionMaxLens),
full: (spec.info.description ?? manifest.description.full)?.slice(
0,
ConstantString.FullDescriptionMaxLens
),
};
}
static mapOpenAPISchemaToFuncParam(
schema: OpenAPIV3.SchemaObject,
method: string,
pathUrl: string
): FunctionParameter {
let parameter: FunctionParameter;
if (
schema.type === "string" ||
schema.type === "boolean" ||
schema.type === "integer" ||
schema.type === "number" ||
schema.type === "array"
) {
parameter = schema as any;
} else {
throw new SpecParserError(
Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)),
ErrorType.UpdateManifestFailed
);
}
return parameter;
}
static generatePluginManifestSchema(
spec: OpenAPIV3.Document,
specRelativePath: string,
options: ParseOptions
): PluginManifestSchema {
const functions: FunctionObject[] = [];
const functionNames: string[] = [];
const paths = spec.paths;
for (const pathUrl in paths) {
const pathItem = paths[pathUrl];
if (pathItem) {
const operations = pathItem;
for (const method in operations) {
if (options.allowMethods!.includes(method)) {
const operationItem = (operations as any)[method] as OpenAPIV3.OperationObject;
if (operationItem) {
const operationId = operationItem.operationId!;
const description = operationItem.description ?? "";
const paramObject = operationItem.parameters as OpenAPIV3.ParameterObject[];
const requestBody = operationItem.requestBody as OpenAPIV3.ParameterObject;
const parameters: Required<FunctionParameters> = {
type: "object",
properties: {},
required: [],
};
if (paramObject) {
for (let i = 0; i < paramObject.length; i++) {
const param = paramObject[i];
const schema = param.schema as OpenAPIV3.SchemaObject;
parameters.properties[param.name] = ManifestUpdater.mapOpenAPISchemaToFuncParam(
schema,
method,
pathUrl
);
if (param.required) {
parameters.required.push(param.name);
}
if (!parameters.properties[param.name].description) {
parameters.properties[param.name].description = param.description ?? "";
}
}
}
if (requestBody) {
const requestJsonBody = requestBody.content!["application/json"];
const requestBodySchema = requestJsonBody.schema as OpenAPIV3.SchemaObject;
if (requestBodySchema.type === "object") {
if (requestBodySchema.required) {
parameters.required.push(...requestBodySchema.required);
}
for (const property in requestBodySchema.properties) {
const schema = requestBodySchema.properties[property] as OpenAPIV3.SchemaObject;
parameters.properties[property] = ManifestUpdater.mapOpenAPISchemaToFuncParam(
schema,
method,
pathUrl
);
}
} else {
throw new SpecParserError(
Utils.format(
ConstantString.UnsupportedSchema,
method,
pathUrl,
JSON.stringify(requestBodySchema)
),
ErrorType.UpdateManifestFailed
);
}
}
const funcObj: FunctionObject = {
name: operationId,
description: description,
parameters: parameters,
};
functions.push(funcObj);
functionNames.push(operationId);
}
}
}
}
}
const apiPlugin: PluginManifestSchema = {
schema_version: "v2",
name_for_human: spec.info.title,
description_for_human: spec.info.description ?? "<Please add description of the plugin>",
functions: functions,
runtimes: [
{
type: "OpenApi",
auth: {
type: "none", // TODO, support auth in the future
},
spec: {
url: specRelativePath,
},
run_for_functions: functionNames,
},
],
};
return apiPlugin;
}
static async updateManifest(
manifestPath: string,
outputSpecPath: string,
spec: OpenAPIV3.Document,
options: ParseOptions,
adaptiveCardFolder?: string,
authInfo?: AuthInfo
): Promise<[TeamsAppManifest, WarningResult[]]> {
try {
const originalManifest: TeamsAppManifest = await fs.readJSON(manifestPath);
const updatedPart: any = {};
updatedPart.composeExtensions = [];
let warnings: WarningResult[] = [];
if (options.projectType === ProjectType.SME) {
const updateResult = await ManifestUpdater.generateCommands(
spec,
manifestPath,
options,
adaptiveCardFolder
);
const commands = updateResult[0];
warnings = updateResult[1];
const composeExtension: IComposeExtension = {
composeExtensionType: "apiBased",
apiSpecificationFile: ManifestUpdater.getRelativePath(manifestPath, outputSpecPath),
commands: commands,
};
if (authInfo) {
const auth = authInfo.authScheme;
if (Utils.isAPIKeyAuth(auth) || Utils.isBearerTokenAuth(auth)) {
const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(
`${authInfo.name}_${ConstantString.RegistrationIdPostfix}`
);
(composeExtension as any).authorization = {
authType: "apiSecretServiceAuth",
apiSecretServiceAuthConfiguration: {
apiSecretRegistrationId: `\${{${safeApiSecretRegistrationId}}}`,
},
};
} else if (Utils.isOAuthWithAuthCodeFlow(auth)) {
const safeOAuth2RegistrationId = Utils.getSafeRegistrationIdEnvName(
`${authInfo.name}_${ConstantString.OAuthRegistrationIdPostFix}`
);
(composeExtension as any).authorization = {
authType: "oAuth2.0",
oAuthConfiguration: {
oauthConfigurationId: `\${{${safeOAuth2RegistrationId}}}`,
},
};
updatedPart.webApplicationInfo = {
id: "${{AAD_APP_CLIENT_ID}}",
resource: "api://${{DOMAIN}}/${{AAD_APP_CLIENT_ID}}",
};
}
}
updatedPart.composeExtensions = [composeExtension];
}
updatedPart.description = originalManifest.description;
ManifestUpdater.updateManifestDescription(updatedPart, spec);
const updatedManifest = { ...originalManifest, ...updatedPart };
return [updatedManifest, warnings];
} catch (err) {
throw new SpecParserError((err as Error).toString(), ErrorType.UpdateManifestFailed);
}
}
static async generateCommands(
spec: OpenAPIV3.Document,
manifestPath: string,
options: ParseOptions,
adaptiveCardFolder?: string
): Promise<[IMessagingExtensionCommand[], WarningResult[]]> {
const paths = spec.paths;
const commands: IMessagingExtensionCommand[] = [];
const warnings: WarningResult[] = [];
if (paths) {
for (const pathUrl in paths) {
const pathItem = paths[pathUrl];
if (pathItem) {
const operations = pathItem;
// Currently only support GET and POST method
for (const method in operations) {
if (options.allowMethods?.includes(method)) {
const operationItem = (operations as any)[method];
if (operationItem) {
const [command, warning] = Utils.parseApiInfo(operationItem, options);
if (adaptiveCardFolder) {
const adaptiveCardPath = path.join(adaptiveCardFolder, command.id + ".json");
command.apiResponseRenderingTemplateFile = (await fs.pathExists(adaptiveCardPath))
? ManifestUpdater.getRelativePath(manifestPath, adaptiveCardPath)
: "";
}
if (warning) {
warnings.push(warning);
}
commands.push(command);
}
}
}
}
}
}
return [commands, warnings];
}
static getRelativePath(from: string, to: string): string {
const relativePath = path.relative(path.dirname(from), to);
return path.normalize(relativePath).replace(/\\/g, "/");
}
}