@apimatic/cli 1.1.0-beta.2 → 1.1.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -1
- package/lib/actions/action-result.d.ts +12 -6
- package/lib/actions/action-result.js +36 -10
- package/lib/actions/action-result.js.map +1 -1
- package/lib/actions/api/validate.d.ts +3 -1
- package/lib/actions/api/validate.js +14 -3
- package/lib/actions/api/validate.js.map +1 -1
- package/lib/actions/portal/copilot.js +2 -2
- package/lib/actions/portal/quickstart.d.ts +1 -0
- package/lib/actions/portal/quickstart.js +21 -0
- package/lib/actions/portal/quickstart.js.map +1 -1
- package/lib/actions/portal/toc/new-toc.d.ts +5 -5
- package/lib/actions/portal/toc/new-toc.js +41 -40
- package/lib/actions/portal/toc/new-toc.js.map +1 -1
- package/lib/actions/sdk/quickstart.d.ts +1 -0
- package/lib/actions/sdk/quickstart.js +20 -0
- package/lib/actions/sdk/quickstart.js.map +1 -1
- package/lib/application/portal/toc/toc-structure-generator.d.ts +6 -2
- package/lib/application/portal/toc/toc-structure-generator.js +102 -60
- package/lib/application/portal/toc/toc-structure-generator.js.map +1 -1
- package/lib/commands/portal/toc/new.d.ts +5 -3
- package/lib/commands/portal/toc/new.js +32 -24
- package/lib/commands/portal/toc/new.js.map +1 -1
- package/lib/infrastructure/services/portal-service.js +1 -1
- package/lib/infrastructure/services/portal-service.js.map +1 -1
- package/lib/infrastructure/services/validation-service.d.ts +27 -2
- package/lib/infrastructure/services/validation-service.js +106 -15
- package/lib/infrastructure/services/validation-service.js.map +1 -1
- package/lib/prompts/api/validate.d.ts +5 -2
- package/lib/prompts/api/validate.js +36 -0
- package/lib/prompts/api/validate.js.map +1 -1
- package/lib/prompts/format.d.ts +1 -1
- package/lib/prompts/format.js.map +1 -1
- package/lib/prompts/portal/quickstart.d.ts +3 -0
- package/lib/prompts/portal/quickstart.js +39 -2
- package/lib/prompts/portal/quickstart.js.map +1 -1
- package/lib/prompts/portal/toc/new-toc.d.ts +1 -1
- package/lib/prompts/portal/toc/new-toc.js +10 -2
- package/lib/prompts/portal/toc/new-toc.js.map +1 -1
- package/lib/prompts/sdk/quickstart.d.ts +3 -0
- package/lib/prompts/sdk/quickstart.js +39 -2
- package/lib/prompts/sdk/quickstart.js.map +1 -1
- package/lib/types/sdl/sdl.d.ts +20 -3
- package/lib/types/sdl/sdl.js +120 -22
- package/lib/types/sdl/sdl.js.map +1 -1
- package/lib/types/toc/toc.d.ts +31 -6
- package/lib/utils/string-utils.d.ts +1 -0
- package/lib/utils/string-utils.js +42 -0
- package/lib/utils/string-utils.js.map +1 -1
- package/package.json +1 -1
|
@@ -26,6 +26,42 @@ export class ApiValidatePrompts {
|
|
|
26
26
|
});
|
|
27
27
|
}
|
|
28
28
|
}
|
|
29
|
+
formatValidationEntry(entry) {
|
|
30
|
+
let formatted = replaceHTML(entry.message);
|
|
31
|
+
if (entry.fileReference && entry.lineInfo) {
|
|
32
|
+
formatted += ` [${entry.fileReference}:${entry.lineInfo.startLineNumber}:${entry.lineInfo.startLinePosition}]`;
|
|
33
|
+
}
|
|
34
|
+
if (entry.jsonReferencePath) {
|
|
35
|
+
formatted += ` (${entry.jsonReferencePath})`;
|
|
36
|
+
}
|
|
37
|
+
return formatted;
|
|
38
|
+
}
|
|
39
|
+
displayValidationSummary(summary) {
|
|
40
|
+
if (summary.blocking.length > 0) {
|
|
41
|
+
log.error("Blocking");
|
|
42
|
+
for (const entry of summary.blocking) {
|
|
43
|
+
log.message(this.formatValidationEntry(entry));
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
if (summary.errors.length > 0) {
|
|
47
|
+
log.error("Errors");
|
|
48
|
+
for (const entry of summary.errors) {
|
|
49
|
+
log.message(this.formatValidationEntry(entry));
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
if (summary.warnings.length > 0) {
|
|
53
|
+
log.warning("Warnings");
|
|
54
|
+
for (const entry of summary.warnings) {
|
|
55
|
+
log.message(this.formatValidationEntry(entry));
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
if (summary.information.length > 0) {
|
|
59
|
+
log.info("Information");
|
|
60
|
+
for (const entry of summary.information) {
|
|
61
|
+
log.message(this.formatValidationEntry(entry));
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
29
65
|
logValidationError(error) {
|
|
30
66
|
log.error(error);
|
|
31
67
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../src/prompts/api/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../src/prompts/api/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,MAAM,OAAO,kBAAkB;IACtB,KAAK,CAAC,WAAW,CAAC,EAAgD;QACvE,OAAO,WAAW,CAAC,gBAAgB,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAChG,CAAC;IAED,yBAAyB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAsB;QAC1E,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACrB,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACvB,GAAG,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxB,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACvB,GAAG,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACrB,GAAG,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,qBAAqB,CAAC,KAAsB;QAC1C,IAAI,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE3C,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC1C,SAAS,IAAI,KAAK,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,IAAI,KAAK,CAAC,QAAQ,CAAC,iBAAiB,GAAG,CAAC;QACjH,CAAC;QAED,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,SAAS,IAAI,KAAK,KAAK,CAAC,iBAAiB,GAAG,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,wBAAwB,CAAC,OAA0B;QACxD,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACtB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACxB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED,kBAAkB,CAAC,KAAa;QAC9B,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAEM,YAAY,CAAC,YAA0B;QAC5C,MAAM,OAAO,GAAG,YAAY,CAAC,YAAY,CAAC;QAC1C,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,mBAAmB,CAAC,QAAkB;QAC3C,GAAG,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;CACF"}
|
package/lib/prompts/format.d.ts
CHANGED
|
@@ -19,7 +19,7 @@ export declare const format: {
|
|
|
19
19
|
outroCancelled: (text: string) => string;
|
|
20
20
|
};
|
|
21
21
|
export declare function intro(text: string): void;
|
|
22
|
-
export declare function outro(result: ActionResult): void;
|
|
22
|
+
export declare function outro<T>(result: ActionResult<T>): void;
|
|
23
23
|
export declare function getDirectoryTree(dir: Directory, prefix?: string, isLast?: boolean): string;
|
|
24
24
|
export interface LeafNode {
|
|
25
25
|
name: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/prompts/format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAIvD,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,qBAAqB;IACrB,GAAG,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC;IAC9C,IAAI,EAAE,CAAC,IAA8B,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC;IAC9D,GAAG,EAAE,CAAC,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;IAC1G,MAAM,EAAE,CAAC,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;IAC5H,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACzD,WAAW,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,IAAI,EAAE,CAAC;IACxD,IAAI,EAAE,CAAC,IAAY,EAAE,QAA4B,SAAS,EAAE,EAAE;QAC5D,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;YAClE,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;QAC9D,CAAC;QACD,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;IACpC,CAAC;IAED,wBAAwB;IACxB,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IACzC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;IACrC,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;IAErC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;IACxC,YAAY,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAChD,YAAY,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IAC9C,cAAc,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;CACnE,CAAC;AAEF,MAAM,UAAU,KAAK,CAAC,IAAY;IAChC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;AAC/B,CAAC;
|
|
1
|
+
{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/prompts/format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAIvD,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,qBAAqB;IACrB,GAAG,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC;IAC9C,IAAI,EAAE,CAAC,IAA8B,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC;IAC9D,GAAG,EAAE,CAAC,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;IAC1G,MAAM,EAAE,CAAC,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;IAC5H,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACzD,WAAW,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,IAAI,EAAE,CAAC;IACxD,IAAI,EAAE,CAAC,IAAY,EAAE,QAA4B,SAAS,EAAE,EAAE;QAC5D,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;YAClE,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;QAC9D,CAAC;QACD,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;IACpC,CAAC;IAED,wBAAwB;IACxB,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IACzC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;IACrC,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;IAErC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;IACxC,YAAY,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAChD,YAAY,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IAC9C,cAAc,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;CACnE,CAAC;AAEF,MAAM,UAAU,KAAK,CAAC,IAAY;IAChC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;AAC/B,CAAC;AACD,MAAM,UAAU,KAAK,CAAI,MAAuB;IAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAEpC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAChC,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAClC,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAClC,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CACrC,CAAC;IAEF,CAAC,CAAC,YAAY,CAAC,CAAC;IAChB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,GAAc,EAAE,SAAiB,EAAE,EAAE,SAAkB,IAAI;IAC1F,MAAM,iBAAiB,GAA2B;QAChD,IAAI,EAAE,qCAAqC;QAC3C,OAAO,EAAE,mDAAmD;QAC5D,MAAM,EAAE,6DAA6D;KACtE,CAAC;IAEF,MAAM,gBAAgB,GAA2B;QAC/C,SAAS,EAAE,uEAAuE;QAClF,qBAAqB,EAAE,6FAA6F;KACrH,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACvC,MAAM,UAAU,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;IAChD,MAAM,WAAW,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3G,IAAI,MAAM,GAAG,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAEzF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACxB,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAEpD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAExC,IAAI,IAAI,YAAY,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjC,MAAM,eAAe,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzG,MAAM,IAAI,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;QACrG,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAaD,MAAM,UAAU,OAAO,CACrB,GAAa,EACb,SAAiB,EAAE,EACnB,SAAkB,IAAI;IAEtB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACvC,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC;IAC5B,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/E,IAAI,MAAM,GAAG,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAEzF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACxB,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAEpD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAExC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,IAAI,OAAO,CAAC,IAAgB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;YAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrF,MAAM,IAAI,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;QACrG,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -5,6 +5,7 @@ import { ServiceError } from "../../infrastructure/service-error.js";
|
|
|
5
5
|
import { Directory } from "../../types/file/directory.js";
|
|
6
6
|
import { ResourceInput } from "../../types/file/resource-input.js";
|
|
7
7
|
import { FileDownloadResponse } from "../../infrastructure/services/file-download-service.js";
|
|
8
|
+
import { UnallowedFeaturesResponse } from "../../infrastructure/services/validation-service.js";
|
|
8
9
|
export declare class PortalQuickstartPrompts {
|
|
9
10
|
importSpecStep(): void;
|
|
10
11
|
specPathPrompt(defaultSpecUrl: UrlPath): Promise<ResourceInput | undefined>;
|
|
@@ -13,6 +14,8 @@ export declare class PortalQuickstartPrompts {
|
|
|
13
14
|
useDefaultSpecPrompt(): Promise<boolean>;
|
|
14
15
|
fixYourSpec(): void;
|
|
15
16
|
validateSpecStep(): void;
|
|
17
|
+
splitSpecDetected(unallowed: UnallowedFeaturesResponse): void;
|
|
18
|
+
stripUnallowedFeaturesStep(unallowed: UnallowedFeaturesResponse): void;
|
|
16
19
|
selectLanguagesStep(): void;
|
|
17
20
|
selectLanguagesPrompt(): Promise<string[] | undefined>;
|
|
18
21
|
noLanguagesSelected(): void;
|
|
@@ -55,12 +55,48 @@ export class PortalQuickstartPrompts {
|
|
|
55
55
|
validateSpecStep() {
|
|
56
56
|
log.info(`Step 2 of 4: Validate and Lint your OpenAPI Definition`);
|
|
57
57
|
}
|
|
58
|
+
splitSpecDetected(unallowed) {
|
|
59
|
+
const featuresList = unallowed.Features.map((f) => ` • ${f}`).join("\n");
|
|
60
|
+
let endpointMessage = "";
|
|
61
|
+
if (unallowed.EndpointLimit < unallowed.EndpointCount) {
|
|
62
|
+
endpointMessage = `\nEndpoint limit exceeded: ${unallowed.EndpointCount} endpoints found, but your plan allows ${unallowed.EndpointLimit}\n`;
|
|
63
|
+
}
|
|
64
|
+
const message = [
|
|
65
|
+
"Your API Specification includes components not available on your current subscription plan:",
|
|
66
|
+
"",
|
|
67
|
+
featuresList,
|
|
68
|
+
endpointMessage,
|
|
69
|
+
"To continue:",
|
|
70
|
+
"- Remove these components from your API Specification and re-run this command.",
|
|
71
|
+
"- Combine your split API Specification files into a single file. We can automatically remove unsupported components from single-file specs.",
|
|
72
|
+
"- Upgrade your subscription to unlock additional features: https://www.apimatic.io/pricing"
|
|
73
|
+
].join("\n");
|
|
74
|
+
log.info(message);
|
|
75
|
+
}
|
|
76
|
+
stripUnallowedFeaturesStep(unallowed) {
|
|
77
|
+
const featuresList = unallowed.Features.map((f) => ` • ${f}`).join("\n");
|
|
78
|
+
let endpointMessage = "";
|
|
79
|
+
if (unallowed.EndpointLimit < unallowed.EndpointCount) {
|
|
80
|
+
const endpointsToRemove = unallowed.EndpointCount - unallowed.EndpointLimit;
|
|
81
|
+
endpointMessage = `\n${endpointsToRemove} endpoint(s) will be removed from your spec\n`;
|
|
82
|
+
}
|
|
83
|
+
const message = [
|
|
84
|
+
"Your API Specification includes components not available on your current subscription plan.",
|
|
85
|
+
"We'll automatically remove these components before proceeding:",
|
|
86
|
+
featuresList,
|
|
87
|
+
endpointMessage,
|
|
88
|
+
"",
|
|
89
|
+
"You won't see these components in the generated SDKs or documentation.",
|
|
90
|
+
"Want to keep them? Upgrade your subscription to unlock additional features: https://www.apimatic.io/pricing"
|
|
91
|
+
].join("\n");
|
|
92
|
+
log.info(message);
|
|
93
|
+
}
|
|
58
94
|
selectLanguagesStep() {
|
|
59
95
|
log.info(`Step 3 of 4: Select programming languages`);
|
|
60
96
|
}
|
|
61
97
|
async selectLanguagesPrompt() {
|
|
62
98
|
const languages = (await multiselect({
|
|
63
|
-
message: "Your API Portal will contain SDKs and SDK Documentation in the following Languages. Press enter to continue with all languages, or use the arrow keys and space to customize your selection:",
|
|
99
|
+
message: "Your API Portal will contain SDKs and SDK Documentation in the following Languages (HTTP is enabled by default). Press enter to continue with all languages, or use the arrow keys and space to customize your selection:",
|
|
64
100
|
options: [
|
|
65
101
|
{ label: "Typescript", value: "typescript" },
|
|
66
102
|
{ label: "Ruby", value: "ruby" },
|
|
@@ -70,7 +106,8 @@ export class PortalQuickstartPrompts {
|
|
|
70
106
|
{ label: "PHP", value: "php" },
|
|
71
107
|
{ label: "Go", value: "go" }
|
|
72
108
|
],
|
|
73
|
-
initialValues: ["typescript", "ruby", "python", "java", "csharp", "php", "go"]
|
|
109
|
+
initialValues: ["typescript", "ruby", "python", "java", "csharp", "php", "go"],
|
|
110
|
+
required: false
|
|
74
111
|
}));
|
|
75
112
|
if (isCancel(languages)) {
|
|
76
113
|
return undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/prompts/portal/quickstart.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAE1E,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAG3D,OAAO,EAAE,4BAA4B,EAAiB,MAAM,oCAAoC,CAAC;AAEjG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/prompts/portal/quickstart.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAE1E,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAG3D,OAAO,EAAE,4BAA4B,EAAiB,MAAM,oCAAoC,CAAC;AAEjG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGxD,MAAM,kBAAkB,GACtB,6FAA6F,CAAC;AAChG,MAAM,yBAAyB,GAAG,oEAAoE,CAAC;AAEvG,MAAM,OAAO,uBAAuB;IAC3B,cAAc;QACnB,GAAG,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,cAAuB;QACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;YACtB,OAAO,EAAE,wEAAwE;YACjF,WAAW,EAAE,4FAA4F;YACzG,YAAY,EAAE,cAAc,CAAC,QAAQ,EAAE;YAEvC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,KAAK,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,EAAE,CAAC;oBAClD,OAAO,wCAAwC,CAAC;gBAClD,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QACH,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,KAAK,CAAC,2FAA2F,CAAC,CAAC;IACzG,CAAC;IAEM,eAAe;QACpB,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC;YAClC,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE;gBACP;oBACE,KAAK,EAAE,IAAI;oBACX,KAAK,EAAE,qEAAqE,kBAAkB,EAAE;iBACjG;gBACD,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,kDAAkD,EAAE;aAC5E;SACF,CAAC,CAAC;QACH,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,cAAc,KAAK,KAAK,CAAC;IAClC,CAAC;IAEM,WAAW;QAChB,MAAM,OAAO,GAAG,6FAA6F,CAAC;QAC9G,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,gBAAgB;QACrB,GAAG,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IACrE,CAAC;IAEM,iBAAiB,CAAC,SAAoC;QAC3D,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1E,IAAI,eAAe,GAAG,EAAE,CAAC;QACzB,IAAI,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;YACtD,eAAe,GAAG,8BAA8B,SAAS,CAAC,aAAa,0CAA0C,SAAS,CAAC,aAAa,IAAI,CAAC;QAC/I,CAAC;QAED,MAAM,OAAO,GAAG;YACd,6FAA6F;YAC7F,EAAE;YACF,YAAY;YACZ,eAAe;YACf,cAAc;YACd,gFAAgF;YAChF,6IAA6I;YAC7I,4FAA4F;SAC7F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,0BAA0B,CAAC,SAAoC;QACpE,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1E,IAAI,eAAe,GAAG,EAAE,CAAC;QACzB,IAAI,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;YACtD,MAAM,iBAAiB,GAAG,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;YAC5E,eAAe,GAAG,KAAK,iBAAiB,+CAA+C,CAAC;QAC1F,CAAC;QAED,MAAM,OAAO,GAAG;YACd,6FAA6F;YAC7F,gEAAgE;YAChE,YAAY;YACZ,eAAe;YACf,EAAE;YACF,wEAAwE;YACxE,6GAA6G;SAC9G,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,mBAAmB;QACxB,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAChC,MAAM,SAAS,GAAG,CAAC,MAAM,WAAW,CAAC;YACnC,OAAO,EACL,2NAA2N;YAC7N,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;gBAC5C,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;gBACpC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;gBAChC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;YACD,aAAa,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;YAC9E,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAa,CAAC;QAEhB,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAChC,CAAC;IAEM,mBAAmB;QACxB,GAAG,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACvD,CAAC;IAEM,wBAAwB;QAC7B,GAAG,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,wBAAwB;;QACnC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC;YAChC,OAAO,EAAE,sGAAsG;YAC/G,WAAW,EAAE,qFAAqF;YAClG,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,WAAW,GAAG,YAAY,CAAC,MAAC,cAAyB,aAAzB,cAAc,uBAAd,cAAc,CAAa,IAAI,EAAE,mCAAI,EAAE,CAAC,CAAC;QAC3E,OAAO,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAEM,8BAA8B,CAAC,cAA6B;QACjE,GAAG,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACtF,CAAC;IAEM,sBAAsB,CAAC,cAA6B;QACzD,GAAG,CAAC,KAAK,CACP,wBAAwB,CAAC,CAAC,IAAI,CAC5B,cAAc,CACf,mFAAmF,CACrF,CAAC;IACJ,CAAC;IAEM,wBAAwB;QAC7B,GAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC3C,CAAC;IAEM,sBAAsB,CAAC,EAAuD;QACnF,OAAO,WAAW,CAChB,6BAA6B,EAC7B,sCAAsC,EACtC,mCAAmC,EACnC,EAAE,CACH,CAAC;IACJ,CAAC;IAEM,gBAAgB,CAAC,EAAuD;QAC7E,OAAO,WAAW,CAChB,4BAA4B,EAC5B,2BAA2B,EAC3B,mCAAmC,EACnC,EAAE,CACH,CAAC;IACJ,CAAC;IAEM,SAAS;QACd,MAAM,OAAO,GAAG;;EAElB,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC;QAClC,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;IAEM,YAAY,CAAC,YAA0B;QAC5C,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEM,uBAAuB,CAAC,cAA6B,EAAE,SAAoB;QAChF,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;QAC3G,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;QAChD,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC;IAC9B,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAChF,CAAC;CACF"}
|
|
@@ -10,6 +10,6 @@ export declare class PortalNewTocPrompts {
|
|
|
10
10
|
logError(message: string): void;
|
|
11
11
|
contentDirectoryNotFound(contentFolderPath: DirectoryPath): void;
|
|
12
12
|
invalidBuildDirectory(directory: DirectoryPath): void;
|
|
13
|
-
|
|
13
|
+
extractComponents(fn: Promise<Result<Sdl, ServiceError>>, expandEndpoints: boolean, expandModels: boolean, expandWebhooks: boolean, expandCallbacks: boolean): Promise<Result<Sdl, ServiceError>>;
|
|
14
14
|
tocCreated(tocPath: FilePath): void;
|
|
15
15
|
}
|
|
@@ -28,8 +28,16 @@ export class PortalNewTocPrompts {
|
|
|
28
28
|
const message = `The ${f.var("src")} directory is either empty or invalid: ${f.path(directory)}`;
|
|
29
29
|
log.error(message);
|
|
30
30
|
}
|
|
31
|
-
|
|
32
|
-
|
|
31
|
+
extractComponents(fn, expandEndpoints, expandModels, expandWebhooks, expandCallbacks) {
|
|
32
|
+
const components = [
|
|
33
|
+
expandEndpoints && "Endpoint groups",
|
|
34
|
+
expandModels && "Models",
|
|
35
|
+
expandWebhooks && "Webhooks",
|
|
36
|
+
expandCallbacks && "Callbacks"
|
|
37
|
+
]
|
|
38
|
+
.filter(Boolean)
|
|
39
|
+
.join(" and ");
|
|
40
|
+
return withSpinner(`Extracting ${components}`, `${components} extracted`, `${components} extraction failed`, fn);
|
|
33
41
|
}
|
|
34
42
|
tocCreated(tocPath) {
|
|
35
43
|
log.info(`The TOC file successfully created at: ${f.path(tocPath)}`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"new-toc.js","sourceRoot":"","sources":["../../../../src/prompts/portal/toc/new-toc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAGxD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,iBAAiB,CAAC;AAI9C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,OAAO,mBAAmB;IACvB,KAAK,CAAC,YAAY,CAAC,OAAiB;QACzC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;YAC9B,OAAO,EAAE,wBAAwB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,+CAA+C;YAC/F,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACzD,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,KAAK,CAAC,8FAA8F,CAAC,CAAC;IAC5G,CAAC;IAEM,QAAQ,CAAC,OAAe;QAC7B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,wBAAwB,CAAC,iBAAgC;QAC9D,GAAG,CAAC,KAAK,CAAC,gCAAgC,iBAAiB,EAAE,CAAC,CAAC;IACjE,CAAC;IAEM,qBAAqB,CAAC,SAAwB;QACnD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACjG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,
|
|
1
|
+
{"version":3,"file":"new-toc.js","sourceRoot":"","sources":["../../../../src/prompts/portal/toc/new-toc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAGxD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,iBAAiB,CAAC;AAI9C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,OAAO,mBAAmB;IACvB,KAAK,CAAC,YAAY,CAAC,OAAiB;QACzC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;YAC9B,OAAO,EAAE,wBAAwB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,+CAA+C;YAC/F,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACzD,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,KAAK,CAAC,8FAA8F,CAAC,CAAC;IAC5G,CAAC;IAEM,QAAQ,CAAC,OAAe;QAC7B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,wBAAwB,CAAC,iBAAgC;QAC9D,GAAG,CAAC,KAAK,CAAC,gCAAgC,iBAAiB,EAAE,CAAC,CAAC;IACjE,CAAC;IAEM,qBAAqB,CAAC,SAAwB;QACnD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACjG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,iBAAiB,CACtB,EAAsC,EACtC,eAAwB,EACxB,YAAqB,EACrB,cAAuB,EACvB,eAAwB;QAExB,MAAM,UAAU,GAAG;YACjB,eAAe,IAAI,iBAAiB;YACpC,YAAY,IAAI,QAAQ;YACxB,cAAc,IAAI,UAAU;YAC5B,eAAe,IAAI,WAAW;SAC/B;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjB,OAAO,WAAW,CAAC,cAAc,UAAU,EAAE,EAAE,GAAG,UAAU,YAAY,EAAE,GAAG,UAAU,oBAAoB,EAAE,EAAE,CAAC,CAAC;IACnH,CAAC;IAEM,UAAU,CAAC,OAAiB;QACjC,GAAG,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;CACF"}
|
|
@@ -6,9 +6,12 @@ import { ServiceError } from "../../infrastructure/service-error.js";
|
|
|
6
6
|
import { DirectoryPath } from "../../types/file/directoryPath.js";
|
|
7
7
|
import { Directory } from "../../types/file/directory.js";
|
|
8
8
|
import { Language } from "../../types/sdk/generate.js";
|
|
9
|
+
import { UnallowedFeaturesResponse } from "../../infrastructure/services/validation-service.js";
|
|
9
10
|
export declare class SdkQuickstartPrompts {
|
|
10
11
|
importSpecStep(): void;
|
|
11
12
|
specPathPrompt(defaultSpecUrl: UrlPath): Promise<ResourceInput | undefined>;
|
|
13
|
+
splitSpecDetected(unallowed: UnallowedFeaturesResponse): void;
|
|
14
|
+
stripUnallowedFeaturesStep(unallowed: UnallowedFeaturesResponse): void;
|
|
12
15
|
specFileDoesNotExist(): void;
|
|
13
16
|
noSpecSpecified(): void;
|
|
14
17
|
downloadSpecFile(fn: Promise<Result<FileDownloadResponse, ServiceError>>): Promise<Result<FileDownloadResponse, ServiceError>>;
|
|
@@ -7,7 +7,6 @@ import { removeQuotes } from "../../utils/string-utils.js";
|
|
|
7
7
|
import { Language } from "../../types/sdk/generate.js";
|
|
8
8
|
const vscodeExtensionUrl = "https://marketplace.visualstudio.com/items?itemName=apimatic-developers.apimatic-for-vscode";
|
|
9
9
|
const sdkCustomizationUrl = "https://docs.apimatic.io/generate-sdks/codegen-settings/codegen-settings-overview/";
|
|
10
|
-
const defaultSrcDirectoryPath = process.cwd();
|
|
11
10
|
export class SdkQuickstartPrompts {
|
|
12
11
|
importSpecStep() {
|
|
13
12
|
log.info(`Step 1 of 4: Import your OpenAPI Definition`);
|
|
@@ -28,6 +27,42 @@ export class SdkQuickstartPrompts {
|
|
|
28
27
|
}
|
|
29
28
|
return createResourceInputFromInput(spec);
|
|
30
29
|
}
|
|
30
|
+
splitSpecDetected(unallowed) {
|
|
31
|
+
const featuresList = unallowed.Features.map((f) => ` • ${f}`).join("\n");
|
|
32
|
+
let endpointMessage = "";
|
|
33
|
+
if (unallowed.EndpointLimit < unallowed.EndpointCount) {
|
|
34
|
+
endpointMessage = `\nEndpoint limit exceeded: ${unallowed.EndpointCount} endpoints found, but your plan allows ${unallowed.EndpointLimit}\n`;
|
|
35
|
+
}
|
|
36
|
+
const message = [
|
|
37
|
+
"Your API Specification includes components not available on your current subscription plan:",
|
|
38
|
+
"",
|
|
39
|
+
featuresList,
|
|
40
|
+
endpointMessage,
|
|
41
|
+
"To continue:",
|
|
42
|
+
"- Remove these components from your API Specification and re-run this command.",
|
|
43
|
+
"- Combine your split API Specification files into a single file. We can automatically remove unsupported components from single-file specs.",
|
|
44
|
+
"- Upgrade your subscription to unlock additional features: https://www.apimatic.io/pricing"
|
|
45
|
+
].join("\n");
|
|
46
|
+
log.info(message);
|
|
47
|
+
}
|
|
48
|
+
stripUnallowedFeaturesStep(unallowed) {
|
|
49
|
+
const featuresList = unallowed.Features.map((f) => ` • ${f}`).join("\n");
|
|
50
|
+
let endpointMessage = "";
|
|
51
|
+
if (unallowed.EndpointLimit < unallowed.EndpointCount) {
|
|
52
|
+
const endpointsToRemove = unallowed.EndpointCount - unallowed.EndpointLimit;
|
|
53
|
+
endpointMessage = `\n${endpointsToRemove} endpoint(s) will be removed from your spec\n`;
|
|
54
|
+
}
|
|
55
|
+
const message = [
|
|
56
|
+
"Your API Specification includes components not available on your current subscription plan.",
|
|
57
|
+
"We'll automatically remove these components before proceeding:",
|
|
58
|
+
featuresList,
|
|
59
|
+
endpointMessage,
|
|
60
|
+
"",
|
|
61
|
+
"You won't see these components in the generated SDKs or documentation.",
|
|
62
|
+
"Want to keep them? Upgrade your subscription to unlock additional features: https://www.apimatic.io/pricing"
|
|
63
|
+
].join("\n");
|
|
64
|
+
log.info(message);
|
|
65
|
+
}
|
|
31
66
|
specFileDoesNotExist() {
|
|
32
67
|
log.error("The specified file does not exist or is not a valid file. Please enter a valid file path.");
|
|
33
68
|
}
|
|
@@ -127,7 +162,9 @@ export class SdkQuickstartPrompts {
|
|
|
127
162
|
log.info("Opened the SDK directory in VS Code. To get started with your SDK, review the README file.");
|
|
128
163
|
}
|
|
129
164
|
nextSteps(language, specDirectory) {
|
|
130
|
-
const specDirectoryFlag = !specDirectory.isEqual(DirectoryPath.default)
|
|
165
|
+
const specDirectoryFlag = !specDirectory.isEqual(DirectoryPath.default)
|
|
166
|
+
? `${f.flag("spec", specDirectory.toString())} `
|
|
167
|
+
: "";
|
|
131
168
|
const message = `Run the command
|
|
132
169
|
'${f.cmdAlt("apimatic", "sdk", "generate")} ${specDirectoryFlag}${f.flag("language", language)}'
|
|
133
170
|
to regenerate your SDK.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/prompts/sdk/quickstart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAExD,OAAO,EAAE,4BAA4B,EAAiB,MAAM,oCAAoC,CAAC;AAGjG,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/prompts/sdk/quickstart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAExD,OAAO,EAAE,4BAA4B,EAAiB,MAAM,oCAAoC,CAAC;AAGjG,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAGvD,MAAM,kBAAkB,GACtB,6FAA6F,CAAC;AAChG,MAAM,mBAAmB,GAAG,oFAAoF,CAAC;AAEjH,MAAM,OAAO,oBAAoB;IACxB,cAAc;QACnB,GAAG,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,cAAuB;QACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;YACtB,OAAO,EAAE,wEAAwE;YACjF,WAAW,EACT,uGAAuG;YACzG,YAAY,EAAE,cAAc,CAAC,QAAQ,EAAE;YAEvC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,KAAK,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,EAAE,CAAC;oBAClD,OAAO,wCAAwC,CAAC;gBAClD,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEM,iBAAiB,CAAC,SAAoC;QAC3D,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1E,IAAI,eAAe,GAAG,EAAE,CAAC;QACzB,IAAI,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;YACtD,eAAe,GAAG,8BAA8B,SAAS,CAAC,aAAa,0CAA0C,SAAS,CAAC,aAAa,IAAI,CAAC;QAC/I,CAAC;QAED,MAAM,OAAO,GAAG;YACd,6FAA6F;YAC7F,EAAE;YACF,YAAY;YACZ,eAAe;YACf,cAAc;YACd,gFAAgF;YAChF,6IAA6I;YAC7I,4FAA4F;SAC7F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,0BAA0B,CAAC,SAAoC;QACpE,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1E,IAAI,eAAe,GAAG,EAAE,CAAC;QACzB,IAAI,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;YACtD,MAAM,iBAAiB,GAAG,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;YAC5E,eAAe,GAAG,KAAK,iBAAiB,+CAA+C,CAAC;QAC1F,CAAC;QAED,MAAM,OAAO,GAAG;YACd,6FAA6F;YAC7F,gEAAgE;YAChE,YAAY;YACZ,eAAe;YACf,EAAE;YACF,wEAAwE;YACxE,6GAA6G;SAC9G,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,KAAK,CAAC,2FAA2F,CAAC,CAAC;IACzG,CAAC;IAEM,eAAe;QACpB,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC/C,CAAC;IAEM,gBAAgB,CAAC,EAAuD;QAC7E,OAAO,WAAW,CAChB,4BAA4B,EAC5B,2BAA2B,EAC3B,mCAAmC,EACnC,EAAE,CACH,CAAC;IACJ,CAAC;IAEM,YAAY,CAAC,YAA0B;QAC5C,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEM,gBAAgB;QACrB,GAAG,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IACrE,CAAC;IAEM,oBAAoB;QACzB,GAAG,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC;YAClC,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE;gBACP;oBACE,KAAK,EAAE,IAAI;oBACX,KAAK,EAAE,qEAAqE,kBAAkB,EAAE;iBACjG;gBACD,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,wDAAwD,EAAE;aAClF;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,cAAc,KAAK,KAAK,CAAC;IAClC,CAAC;IAEM,WAAW;QAChB,MAAM,OAAO,GAAG,6FAA6F,CAAC;QAC9G,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,kBAAkB;QACvB,GAAG,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC;YAC5B,OAAO,EAAE,+CAA+C;YACxD,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,CAAC,UAAU,EAAE;gBACnD,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE;gBACvC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE;gBAC3C,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE;gBACvC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE;gBACvC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE;gBACrC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;aACpC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,kBAAkB;QACvB,GAAG,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACrD,CAAC;IAEM,wBAAwB;QAC7B,GAAG,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,wBAAwB;;QACnC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC;YAChC,OAAO,EAAE,+FAA+F;YACxG,WAAW,EAAE,qFAAqF;YAClG,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,WAAW,GAAG,YAAY,CAAC,MAAC,cAAyB,aAAzB,cAAc,uBAAd,cAAc,CAAa,IAAI,EAAE,mCAAI,EAAE,CAAC,CAAC;QAC3E,OAAO,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAEM,wBAAwB;QAC7B,GAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC3C,CAAC;IAEM,8BAA8B,CAAC,cAA6B;QACjE,GAAG,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACtF,CAAC;IAEM,sBAAsB,CAAC,cAA6B;QACzD,GAAG,CAAC,KAAK,CACP,wBAAwB,CAAC,CAAC,IAAI,CAC5B,cAAc,CACf,mFAAmF,CACrF,CAAC;IACJ,CAAC;IAEM,oBAAoB,CAAC,EAAuD;QACjF,OAAO,WAAW,CAChB,6BAA6B,EAC7B,sCAAsC,EACtC,mCAAmC,EACnC,EAAE,CACH,CAAC;IACJ,CAAC;IAEM,uBAAuB,CAAC,cAA6B,EAAE,SAAoB;QAChF,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;QAC3G,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;QAChD,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC;IAC9B,CAAC;IAEM,iBAAiB;QACtB,GAAG,CAAC,IAAI,CAAC,4FAA4F,CAAC,CAAC;IACzG,CAAC;IAEM,SAAS,CAAC,QAAkB,EAAE,aAA4B;QAC/D,MAAM,iBAAiB,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC;YACrE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG;YAChD,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,OAAO,GAAG;GACjB,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;;;;EAI5F,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC5B,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;CACF"}
|
package/lib/types/sdl/sdl.d.ts
CHANGED
|
@@ -1,21 +1,38 @@
|
|
|
1
|
-
import { TocEndpoint,
|
|
1
|
+
import { TocEndpoint, TocModelPage, TocWebhookPage, TocCallbackPage } from '../toc/toc.js';
|
|
2
2
|
export type EndpointGroup = Map<string, TocEndpoint[]>;
|
|
3
|
+
export type WebhookGroup = Map<string, TocWebhookPage[]>;
|
|
4
|
+
export type CallbackGroup = Map<string, TocCallbackPage[]>;
|
|
3
5
|
export type SdlTocComponents = {
|
|
4
6
|
endpointGroups: EndpointGroup;
|
|
5
|
-
models:
|
|
7
|
+
models: TocModelPage[];
|
|
8
|
+
webhookGroups: WebhookGroup;
|
|
9
|
+
callbackGroups: CallbackGroup;
|
|
6
10
|
};
|
|
7
11
|
export interface Sdl {
|
|
8
12
|
readonly Endpoints: SdlEndpoint[];
|
|
9
13
|
readonly CustomTypes: SdlModel[];
|
|
14
|
+
readonly Webhooks: SdlWebhook[];
|
|
10
15
|
}
|
|
11
16
|
export interface SdlEndpoint {
|
|
12
17
|
readonly Name: string;
|
|
13
18
|
readonly Description: string;
|
|
14
19
|
readonly Group: string;
|
|
20
|
+
readonly Callbacks: SdlCallback[];
|
|
15
21
|
}
|
|
16
22
|
export interface SdlModel {
|
|
17
23
|
readonly Name: string;
|
|
18
24
|
}
|
|
19
|
-
export
|
|
25
|
+
export interface SdlCallback {
|
|
26
|
+
readonly Id: string;
|
|
27
|
+
readonly CallbackGroupName?: string;
|
|
28
|
+
}
|
|
29
|
+
export interface SdlWebhook {
|
|
30
|
+
readonly Id: string;
|
|
31
|
+
readonly WebhookGroupName?: string;
|
|
32
|
+
}
|
|
20
33
|
export declare function getEndpointDescription(endpointGroups: Map<string, SdlEndpoint[]>, endpointGroupName: string, endpointName: string): string;
|
|
21
34
|
export declare function getEndpointGroupsFromSdl(sdl: Sdl): Map<string, SdlEndpoint[]>;
|
|
35
|
+
export declare function extractEndpointGroupsForToc(sdl: Sdl): Map<string, TocEndpoint[]>;
|
|
36
|
+
export declare function extractModelsForToc(sdl: Sdl): TocModelPage[];
|
|
37
|
+
export declare function extractWebhooksForToc(sdl: Sdl): Map<string, TocWebhookPage[]>;
|
|
38
|
+
export declare function extractCallbacksForToc(sdl: Sdl): Map<string, TocCallbackPage[]>;
|
package/lib/types/sdl/sdl.js
CHANGED
|
@@ -1,8 +1,27 @@
|
|
|
1
|
-
|
|
1
|
+
import { toTitleCase } from '../../utils/string-utils.js';
|
|
2
|
+
export function getEndpointDescription(endpointGroups, endpointGroupName, endpointName) {
|
|
3
|
+
return endpointGroups.get(endpointGroupName).find((e) => e.Name === endpointName).Description;
|
|
4
|
+
}
|
|
5
|
+
export function getEndpointGroupsFromSdl(sdl) {
|
|
6
|
+
const endpointGroups = new Map();
|
|
7
|
+
for (const endpoint of sdl.Endpoints) {
|
|
8
|
+
if (!endpointGroups.has(endpoint.Group)) {
|
|
9
|
+
endpointGroups.set(endpoint.Group, []);
|
|
10
|
+
}
|
|
11
|
+
endpointGroups.get(endpoint.Group).push({
|
|
12
|
+
Name: endpoint.Name,
|
|
13
|
+
Description: endpoint.Description,
|
|
14
|
+
Group: endpoint.Group,
|
|
15
|
+
Callbacks: endpoint.Callbacks
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
return endpointGroups;
|
|
19
|
+
}
|
|
20
|
+
export function extractEndpointGroupsForToc(sdl) {
|
|
2
21
|
const endpointGroups = new Map();
|
|
3
22
|
const endpoints = sdl.Endpoints.map((e) => ({
|
|
4
23
|
generate: null,
|
|
5
|
-
from:
|
|
24
|
+
from: 'endpoint',
|
|
6
25
|
endpointName: e.Name,
|
|
7
26
|
endpointGroup: e.Group
|
|
8
27
|
}));
|
|
@@ -15,33 +34,112 @@ function extractEndpointGroupsForToc(sdl) {
|
|
|
15
34
|
});
|
|
16
35
|
return endpointGroups;
|
|
17
36
|
}
|
|
18
|
-
function extractModelsForToc(sdl) {
|
|
37
|
+
export function extractModelsForToc(sdl) {
|
|
19
38
|
return sdl.CustomTypes.map((e) => ({
|
|
20
39
|
generate: null,
|
|
21
|
-
from:
|
|
40
|
+
from: 'model',
|
|
22
41
|
modelName: e.Name
|
|
23
42
|
}));
|
|
24
43
|
}
|
|
25
|
-
export function
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
|
|
44
|
+
export function extractWebhooksForToc(sdl) {
|
|
45
|
+
var _a;
|
|
46
|
+
if (sdl.Webhooks.length === 0) {
|
|
47
|
+
return new Map();
|
|
48
|
+
}
|
|
49
|
+
let groupedWebhooks = new Map();
|
|
50
|
+
const ungrouped = [];
|
|
51
|
+
for (const webhook of sdl.Webhooks) {
|
|
52
|
+
const event = {
|
|
53
|
+
generate: null,
|
|
54
|
+
from: 'webhook',
|
|
55
|
+
webhookName: webhook.Id,
|
|
56
|
+
webhookGroup: (_a = webhook.WebhookGroupName) !== null && _a !== void 0 ? _a : null
|
|
57
|
+
};
|
|
58
|
+
if (webhook.WebhookGroupName) {
|
|
59
|
+
const groupTitle = toTitleCase(webhook.WebhookGroupName);
|
|
60
|
+
if (!groupedWebhooks.has(groupTitle)) {
|
|
61
|
+
groupedWebhooks.set(groupTitle, [
|
|
62
|
+
{
|
|
63
|
+
generate: null,
|
|
64
|
+
from: 'webhook-group-overview',
|
|
65
|
+
webhookGroup: webhook.WebhookGroupName
|
|
66
|
+
}
|
|
67
|
+
]);
|
|
68
|
+
}
|
|
69
|
+
groupedWebhooks.get(groupTitle).push(event);
|
|
70
|
+
}
|
|
71
|
+
else {
|
|
72
|
+
ungrouped.push(event);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
let ungroupedWebhooks = new Map();
|
|
76
|
+
if (ungrouped.length > 0) {
|
|
77
|
+
const uniqueGroupName = getUniqueGroupName('Webhooks', new Set(groupedWebhooks.keys()));
|
|
78
|
+
const uniqueGroupTitle = toTitleCase(uniqueGroupName);
|
|
79
|
+
ungroupedWebhooks.set(uniqueGroupTitle, [
|
|
80
|
+
{
|
|
81
|
+
generate: null,
|
|
82
|
+
from: 'webhook-group-overview',
|
|
83
|
+
webhookGroup: uniqueGroupName
|
|
84
|
+
},
|
|
85
|
+
...ungrouped.map((event) => (Object.assign(Object.assign({}, event), { webhookGroup: uniqueGroupName })))
|
|
86
|
+
]);
|
|
87
|
+
}
|
|
88
|
+
return new Map([...[...groupedWebhooks].sort((a, b) => a[0].localeCompare(b[0])), ...ungroupedWebhooks]);
|
|
32
89
|
}
|
|
33
|
-
export function
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
90
|
+
export function extractCallbacksForToc(sdl) {
|
|
91
|
+
var _a;
|
|
92
|
+
if (sdl.Endpoints.length === 0) {
|
|
93
|
+
return new Map();
|
|
94
|
+
}
|
|
95
|
+
let groupedCallbacks = new Map();
|
|
96
|
+
const ungrouped = [];
|
|
97
|
+
for (const callback of sdl.Endpoints.flatMap((e) => e.Callbacks)) {
|
|
98
|
+
const event = {
|
|
99
|
+
generate: null,
|
|
100
|
+
from: 'callback',
|
|
101
|
+
callbackName: callback.Id,
|
|
102
|
+
callbackGroup: (_a = callback.CallbackGroupName) !== null && _a !== void 0 ? _a : null
|
|
103
|
+
};
|
|
104
|
+
if (callback.CallbackGroupName) {
|
|
105
|
+
const groupTitle = toTitleCase(callback.CallbackGroupName);
|
|
106
|
+
if (!groupedCallbacks.has(groupTitle)) {
|
|
107
|
+
groupedCallbacks.set(groupTitle, [
|
|
108
|
+
{
|
|
109
|
+
generate: null,
|
|
110
|
+
from: 'callback-group-overview',
|
|
111
|
+
callbackGroup: callback.CallbackGroupName
|
|
112
|
+
}
|
|
113
|
+
]);
|
|
114
|
+
}
|
|
115
|
+
groupedCallbacks.get(groupTitle).push(event);
|
|
116
|
+
}
|
|
117
|
+
else {
|
|
118
|
+
ungrouped.push(event);
|
|
38
119
|
}
|
|
39
|
-
endpointGroups.get(endpoint.Group).push({
|
|
40
|
-
Name: endpoint.Name,
|
|
41
|
-
Description: endpoint.Description,
|
|
42
|
-
Group: endpoint.Group
|
|
43
|
-
});
|
|
44
120
|
}
|
|
45
|
-
|
|
121
|
+
let ungroupedCallbacks = new Map();
|
|
122
|
+
if (ungrouped.length > 0) {
|
|
123
|
+
const uniqueGroupName = getUniqueGroupName('Callbacks', new Set(groupedCallbacks.keys()));
|
|
124
|
+
const uniqueGroupTitle = toTitleCase(uniqueGroupName);
|
|
125
|
+
ungroupedCallbacks.set(uniqueGroupTitle, [
|
|
126
|
+
{
|
|
127
|
+
generate: null,
|
|
128
|
+
from: 'callback-group-overview',
|
|
129
|
+
callbackGroup: uniqueGroupName
|
|
130
|
+
},
|
|
131
|
+
...ungrouped.map((event) => (Object.assign(Object.assign({}, event), { callbackGroup: uniqueGroupName })))
|
|
132
|
+
]);
|
|
133
|
+
}
|
|
134
|
+
return new Map([...[...groupedCallbacks].sort((a, b) => a[0].localeCompare(b[0])), ...ungroupedCallbacks]);
|
|
135
|
+
}
|
|
136
|
+
function getUniqueGroupName(baseName, existingGroups) {
|
|
137
|
+
let counter = 1;
|
|
138
|
+
let name = baseName;
|
|
139
|
+
while (existingGroups.has(toTitleCase(name))) {
|
|
140
|
+
name = `${baseName}${counter}`;
|
|
141
|
+
counter++;
|
|
142
|
+
}
|
|
143
|
+
return name;
|
|
46
144
|
}
|
|
47
145
|
//# sourceMappingURL=sdl.js.map
|
package/lib/types/sdl/sdl.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdl.js","sourceRoot":"","sources":["../../../src/types/sdl/sdl.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"sdl.js","sourceRoot":"","sources":["../../../src/types/sdl/sdl.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAwC1D,MAAM,UAAU,sBAAsB,CACpC,cAA0C,EAC1C,iBAAyB,EACzB,YAAoB;IAEpB,OAAO,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAE,CAAC,WAAW,CAAC;AAClG,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,GAAQ;IAC/C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;IACxD,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;QACrC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC;YACvC,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,SAAS,EAAE,QAAQ,CAAC,SAAS;SAC9B,CAAC,CAAC;IACL,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,GAAQ;IAClD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;IAExD,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CACjC,CAAC,CAAc,EAAe,EAAE,CAAC,CAAC;QAChC,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,CAAC,CAAC,IAAI;QACpB,aAAa,EAAE,CAAC,CAAC,KAAK;KACvB,CAAC,CACH,CAAC;IAEF,SAAS,CAAC,OAAO,CAAC,CAAC,QAAqB,EAAE,EAAE;QAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC;QACrC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,cAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IAC1C,OAAO,GAAG,CAAC,WAAW,CAAC,GAAG,CACxB,CAAC,CAAW,EAAgB,EAAE,CAAC,CAAC;QAC9B,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,CAAC,CAAC,IAAI;KAClB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAQ;;IAC5C,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,IAAI,eAAe,GAAG,IAAI,GAAG,EAA4B,CAAC;IAC1D,MAAM,SAAS,GAAiB,EAAE,CAAC;IAEnC,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,KAAK,GAAe;YACxB,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,OAAO,CAAC,EAAE;YACvB,YAAY,EAAE,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI;SAC/C,CAAC;QAEF,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YACzD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBACrC,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE;oBAC9B;wBACE,QAAQ,EAAE,IAAI;wBACd,IAAI,EAAE,wBAAwB;wBAC9B,YAAY,EAAE,OAAO,CAAC,gBAAgB;qBACvC;iBACF,CAAC,CAAC;YACL,CAAC;YACD,eAAe,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,IAAI,iBAAiB,GAAG,IAAI,GAAG,EAA4B,CAAC;IAE5D,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,eAAe,GAAG,kBAAkB,CAAC,UAAU,EAAE,IAAI,GAAG,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACxF,MAAM,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;QACtD,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,EAAE;YACtC;gBACE,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,wBAAwB;gBAC9B,YAAY,EAAE,eAAe;aAC9B;YACD,GAAG,SAAS,CAAC,GAAG,CACd,CAAC,KAAK,EAAc,EAAE,CAAC,iCAClB,KAAK,KACR,YAAY,EAAE,eAAe,IAC7B,CACH;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC;AAC3G,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAQ;;IAC7C,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,IAAI,gBAAgB,GAAG,IAAI,GAAG,EAA6B,CAAC;IAC5D,MAAM,SAAS,GAAkB,EAAE,CAAC;IAEpC,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;QACjE,MAAM,KAAK,GAAgB;YACzB,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,UAAU;YAChB,YAAY,EAAE,QAAQ,CAAC,EAAE;YACzB,aAAa,EAAE,MAAA,QAAQ,CAAC,iBAAiB,mCAAI,IAAI;SAClD,CAAC;QAEF,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YAC/B,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAC3D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtC,gBAAgB,CAAC,GAAG,CAAC,UAAU,EAAE;oBAC/B;wBACE,QAAQ,EAAE,IAAI;wBACd,IAAI,EAAE,yBAAyB;wBAC/B,aAAa,EAAE,QAAQ,CAAC,iBAAiB;qBAC1C;iBACF,CAAC,CAAC;YACL,CAAC;YACD,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,IAAI,kBAAkB,GAAG,IAAI,GAAG,EAA6B,CAAC;IAE9D,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC1F,MAAM,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;QACtD,kBAAkB,CAAC,GAAG,CAAC,gBAAgB,EAAE;YACvC;gBACE,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,yBAAyB;gBAC/B,aAAa,EAAE,eAAe;aAC/B;YACD,GAAG,SAAS,CAAC,GAAG,CACd,CAAC,KAAK,EAAe,EAAE,CAAC,iCACnB,KAAK,KACR,aAAa,EAAE,eAAe,IAC9B,CACH;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC;AAC7G,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAgB,EAAE,cAA2B;IACvE,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,IAAI,GAAG,QAAQ,CAAC;IAEpB,OAAO,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC7C,IAAI,GAAG,GAAG,QAAQ,GAAG,OAAO,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/lib/types/toc/toc.d.ts
CHANGED
|
@@ -3,28 +3,53 @@ export interface Toc {
|
|
|
3
3
|
}
|
|
4
4
|
export interface TocGroup {
|
|
5
5
|
readonly group: string;
|
|
6
|
-
readonly items: Array<TocGroup | TocGenerated |
|
|
6
|
+
readonly items: Array<TocGroup | TocGenerated | TocEndpointPage | TocWebhookPage | TocCallbackPage | TocModelPage | TocCustomPage>;
|
|
7
7
|
}
|
|
8
8
|
export interface TocGenerated {
|
|
9
|
-
readonly generate: string;
|
|
9
|
+
readonly generate: string | null;
|
|
10
10
|
readonly from: string;
|
|
11
11
|
}
|
|
12
|
+
export type TocEndpointPage = TocEndpoint | TocEndpointGroupOverview;
|
|
13
|
+
export type TocWebhookPage = TocWebhook | TocWebhookOverview;
|
|
14
|
+
export type TocCallbackPage = TocCallback | TocCallbackOverview;
|
|
12
15
|
export interface TocEndpointGroupOverview {
|
|
13
16
|
readonly generate: null;
|
|
14
|
-
readonly from:
|
|
17
|
+
readonly from: 'endpoint-group-overview';
|
|
15
18
|
readonly endpointGroup: string;
|
|
16
19
|
}
|
|
17
20
|
export interface TocEndpoint {
|
|
18
21
|
readonly generate: null;
|
|
19
|
-
readonly from:
|
|
22
|
+
readonly from: 'endpoint';
|
|
20
23
|
readonly endpointName: string;
|
|
21
24
|
readonly endpointGroup: string;
|
|
22
25
|
}
|
|
23
|
-
export interface
|
|
26
|
+
export interface TocModelPage {
|
|
24
27
|
readonly generate: null;
|
|
25
|
-
readonly from:
|
|
28
|
+
readonly from: 'model';
|
|
26
29
|
readonly modelName: string;
|
|
27
30
|
}
|
|
31
|
+
export interface TocWebhookOverview {
|
|
32
|
+
readonly generate: null;
|
|
33
|
+
readonly from: 'webhook-group-overview';
|
|
34
|
+
readonly webhookGroup: string | null;
|
|
35
|
+
}
|
|
36
|
+
export interface TocWebhook {
|
|
37
|
+
readonly generate: null;
|
|
38
|
+
readonly from: 'webhook';
|
|
39
|
+
readonly webhookName: string;
|
|
40
|
+
readonly webhookGroup: string | null;
|
|
41
|
+
}
|
|
42
|
+
export interface TocCallbackOverview {
|
|
43
|
+
readonly generate: null;
|
|
44
|
+
readonly from: 'callback-group-overview';
|
|
45
|
+
readonly callbackGroup: string | null;
|
|
46
|
+
}
|
|
47
|
+
export interface TocCallback {
|
|
48
|
+
readonly generate: null;
|
|
49
|
+
readonly from: 'callback';
|
|
50
|
+
readonly callbackName: string;
|
|
51
|
+
readonly callbackGroup: string | null;
|
|
52
|
+
}
|
|
28
53
|
export interface TocCustomPage {
|
|
29
54
|
readonly page: string;
|
|
30
55
|
readonly file: string;
|