@apimatic/cli 2.0.0-beta.3 → 2.0.0-beta.5
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 +18 -67
- package/apimatic.schema.json +2 -2
- package/lib/actions/action-result.d.ts +4 -2
- package/lib/actions/action-result.js +8 -3
- package/lib/actions/action-result.js.map +1 -1
- package/lib/actions/api/transform.d.ts +7 -6
- package/lib/actions/api/transform.js +12 -13
- package/lib/actions/api/transform.js.map +1 -1
- package/lib/actions/api/validate.d.ts +4 -5
- package/lib/actions/api/validate.js +30 -32
- package/lib/actions/api/validate.js.map +1 -1
- package/lib/actions/plugin/record-metadata.js +1 -1
- package/lib/actions/plugin/record-metadata.js.map +1 -1
- package/lib/actions/portal/generate.js +3 -3
- package/lib/actions/portal/generate.js.map +1 -1
- package/lib/actions/quickstart.d.ts +1 -9
- package/lib/actions/quickstart.js +122 -102
- package/lib/actions/quickstart.js.map +1 -1
- package/lib/commands/api/transform.d.ts +1 -1
- package/lib/commands/api/transform.js +2 -2
- package/lib/commands/api/transform.js.map +1 -1
- package/lib/commands/api/validate.d.ts +3 -3
- package/lib/commands/api/validate.js +28 -17
- package/lib/commands/api/validate.js.map +1 -1
- package/lib/commands/plugin/generate.d.ts +1 -1
- package/lib/commands/portal/generate.d.ts +2 -2
- package/lib/commands/portal/generate.js +1 -1
- package/lib/commands/portal/generate.js.map +1 -1
- package/lib/commands/portal/serve.d.ts +2 -2
- package/lib/commands/portal/serve.js +1 -1
- package/lib/commands/quickstart.d.ts +1 -1
- package/lib/commands/quickstart.js +1 -1
- package/lib/commands/quickstart.js.map +1 -1
- package/lib/commands/sdk/generate.d.ts +2 -2
- package/lib/commands/sdk/generate.js +4 -2
- package/lib/commands/sdk/generate.js.map +1 -1
- package/lib/infrastructure/file-service.d.ts +3 -0
- package/lib/infrastructure/file-service.js +24 -0
- package/lib/infrastructure/file-service.js.map +1 -1
- package/lib/infrastructure/portal-dev-server-service.js +2 -1
- package/lib/infrastructure/portal-dev-server-service.js.map +1 -1
- package/lib/infrastructure/portal-project-service.d.ts +1 -0
- package/lib/infrastructure/portal-project-service.js +7 -3
- package/lib/infrastructure/portal-project-service.js.map +1 -1
- package/lib/infrastructure/service-error.js +15 -15
- package/lib/infrastructure/service-error.js.map +1 -1
- package/lib/infrastructure/services/file-download-service.d.ts +4 -4
- package/lib/infrastructure/services/file-download-service.js +14 -14
- package/lib/infrastructure/services/file-download-service.js.map +1 -1
- package/lib/prompts/api/transform.d.ts +0 -2
- package/lib/prompts/api/transform.js +0 -3
- package/lib/prompts/api/transform.js.map +1 -1
- package/lib/prompts/api/validate.d.ts +2 -2
- package/lib/prompts/api/validate.js +35 -3
- 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/plugin/record-metadata.d.ts +1 -1
- package/lib/prompts/plugin/record-metadata.js +2 -2
- package/lib/prompts/portal/generate.d.ts +2 -1
- package/lib/prompts/portal/generate.js +22 -6
- package/lib/prompts/portal/generate.js.map +1 -1
- package/lib/prompts/portal/prepare-project.js +5 -0
- package/lib/prompts/portal/prepare-project.js.map +1 -1
- package/lib/prompts/portal/serve.js +4 -3
- package/lib/prompts/portal/serve.js.map +1 -1
- package/lib/prompts/portal/source.d.ts +2 -5
- package/lib/prompts/portal/source.js +7 -17
- package/lib/prompts/portal/source.js.map +1 -1
- package/lib/prompts/publishing/links.d.ts +1 -1
- package/lib/prompts/publishing/links.js +1 -1
- package/lib/prompts/publishing/links.js.map +1 -1
- package/lib/prompts/quickstart.d.ts +14 -13
- package/lib/prompts/quickstart.js +44 -29
- package/lib/prompts/quickstart.js.map +1 -1
- package/lib/types/apimatic-config/document.d.ts +2 -0
- package/lib/types/apimatic-config/document.js +4 -0
- package/lib/types/apimatic-config/document.js.map +1 -1
- package/lib/types/apimatic-config-context.d.ts +1 -1
- package/lib/types/apimatic-config-context.js +1 -1
- package/lib/types/apimatic-config-context.js.map +1 -1
- package/lib/types/file/resource-input.d.ts +7 -5
- package/lib/types/file/resource-input.js +16 -15
- package/lib/types/file/resource-input.js.map +1 -1
- package/lib/types/flags-provider.d.ts +6 -1
- package/lib/types/flags-provider.js +22 -12
- package/lib/types/flags-provider.js.map +1 -1
- package/lib/types/plugin-config-context.d.ts +3 -0
- package/lib/types/plugin-config-context.js +33 -12
- package/lib/types/plugin-config-context.js.map +1 -1
- package/lib/types/portal/config/site-address.d.ts +16 -0
- package/lib/types/portal/config/site-address.js +67 -0
- package/lib/types/portal/config/site-address.js.map +1 -0
- package/lib/types/portal/config/site-config.d.ts +3 -5
- package/lib/types/portal/config/site-config.js +10 -33
- package/lib/types/portal/config/site-config.js.map +1 -1
- package/lib/types/portal/config/static-asset.d.ts +2 -2
- package/lib/types/portal/config/static-asset.js +2 -2
- package/lib/types/portal/config/static-asset.js.map +1 -1
- package/lib/types/portal/content-tree.d.ts +11 -4
- package/lib/types/portal/content-tree.js +19 -4
- package/lib/types/portal/content-tree.js.map +1 -1
- package/lib/types/portal/page.js +16 -1
- package/lib/types/portal/page.js.map +1 -1
- package/lib/types/portal/portal-config.d.ts +6 -3
- package/lib/types/portal/portal-config.js +8 -4
- package/lib/types/portal/portal-config.js.map +1 -1
- package/lib/types/portal/portal-languages.d.ts +2 -0
- package/lib/types/portal/portal-languages.js +5 -1
- package/lib/types/portal/portal-languages.js.map +1 -1
- package/lib/types/portal/portal-source.d.ts +9 -3
- package/lib/types/portal-source-context.d.ts +7 -8
- package/lib/types/portal-source-context.js +51 -26
- package/lib/types/portal-source-context.js.map +1 -1
- package/lib/types/project-context.d.ts +18 -0
- package/lib/types/project-context.js +18 -1
- package/lib/types/project-context.js.map +1 -1
- package/lib/types/resource-context.d.ts +25 -10
- package/lib/types/resource-context.js +40 -23
- package/lib/types/resource-context.js.map +1 -1
- package/lib/types/sdk/generate.d.ts +1 -4
- package/lib/types/sdk/generate.js +6 -6
- package/lib/types/sdk/generate.js.map +1 -1
- package/oclif.manifest.json +90 -72
- package/package.json +2 -2
- package/portal-template/dependency-directories.ts +45 -0
- package/portal-template/downloads.ts +6 -3
- package/portal-template/portal-config.ts +2 -0
- package/portal-template/prerender-pages.ts +8 -2
- package/portal-template/src/components/api-markdown.tsx +32 -0
- package/portal-template/src/components/api-page.tsx +8 -1
- package/portal-template/src/components/authorization-failure.tsx +63 -0
- package/portal-template/src/components/markdown-copy-button.tsx +60 -0
- package/portal-template/src/components/plugin-install.tsx +6 -5
- package/portal-template/src/components/sdk-actions.tsx +3 -2
- package/portal-template/src/components/sdk-cards.tsx +2 -1
- package/portal-template/src/components/search.tsx +9 -2
- package/portal-template/src/lib/base-path.ts +14 -0
- package/portal-template/src/lib/code-titles.ts +8 -0
- package/portal-template/src/lib/copy-markdown.ts +14 -0
- package/portal-template/src/lib/install-command.ts +5 -5
- package/portal-template/src/lib/layout.shared.tsx +5 -3
- package/portal-template/src/lib/llms.server.ts +29 -5
- package/portal-template/src/lib/oauth-callback.ts +63 -0
- package/portal-template/src/lib/portal-types.ts +3 -3
- package/portal-template/src/lib/rehype-code-titles.ts +3 -5
- package/portal-template/src/lib/remark-image-references.ts +35 -0
- package/portal-template/src/lib/search-content.ts +28 -0
- package/portal-template/src/lib/search-options.ts +7 -0
- package/portal-template/src/lib/source.server.ts +2 -0
- package/portal-template/src/router.tsx +3 -1
- package/portal-template/src/routes/$.tsx +6 -10
- package/portal-template/src/routes/__root.tsx +8 -1
- package/portal-template/src/routes/api/search[.]json.ts +23 -2
- package/portal-template/src/routes/oauth.callback.tsx +54 -0
- package/portal-template/static-functions-base.ts +41 -0
- package/portal-template/vite.config.ts +22 -2
|
@@ -124,6 +124,10 @@ export class ApimaticConfigDocument {
|
|
|
124
124
|
languages() {
|
|
125
125
|
return isJsonObject(this.root.languages) ? this.root.languages : undefined;
|
|
126
126
|
}
|
|
127
|
+
/** Whether the file holds the block at all, in whatever shape. */
|
|
128
|
+
has(block) {
|
|
129
|
+
return this.root[block] !== undefined;
|
|
130
|
+
}
|
|
127
131
|
findingsFor(...blocks) {
|
|
128
132
|
return this.findings.filter((finding) => blocks.includes(finding.block));
|
|
129
133
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/types/apimatic-config/document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,MAAM,CAAC,MAAM,yBAAyB,GAAG,eAAe,CAAC;AAEzD;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,sEAAsE,CAAC;AAE1G,2FAA2F;AAC3F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAqBhC,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;AAEjD,MAAM,mBAAmB,GAAG,+FAA+F,CAAC;AAE5H,MAAM,wBAAwB,GAAG,wEAAwE,CAAC;AAE1G,oHAAoH;AACpH,MAAM,OAAO,sBAAsB;IAEd,IAAI;IACJ,QAAQ;IAF3B,YACmB,IAA6B,EAC7B,QAAkC;oBADlC,IAAI;wBACJ,QAAQ;IACxB,CAAC;IAEJ,+CAA+C;IACxC,MAAM,CAAC,KAAK;QACjB,OAAO,sBAAsB,CAAC,EAAE,CAAC,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,IAAY;QAC9B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3B,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,EAAE,CAAC,IAA6B;QAC7C,OAAO,IAAI,sBAAsB,CAAC,IAAI,EAAE,sBAAsB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,4FAA4F;IAC5F,wFAAwF;IACxF,yFAAyF;IACzF,qCAAqC;IAC7B,MAAM,CAAC,OAAO,CAAC,IAA6B;QAClD,OAAO;YACL,GAAG,sBAAsB,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC;YACnE,GAAG,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC;YACrD,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC;SAC5D,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,aAAsB;QACzD,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,cAAc,EAAE,CAAC;YACpE,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO;YACL;gBACE,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,eAAe;gBACtB,OAAO,EAAE,MAAM,OAAO,2DAA2D,cAAc,EAAE;aAClG;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAe;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC3B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YAChF,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC;QACrC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;YACpG,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CAAC;QACvG,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,SAAkB;QACjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,6FAA6F;QAC7F,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAmB,EAAE;YAC9E,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,QAAQ,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC9F,CAAC;YACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtE,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,QAAQ,aAAa,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;YACzG,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,wFAAwF;IACjF,MAAM;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,wFAAwF;IACjF,MAAM;QACX,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,CAAC;IAED,wFAAwF;IACjF,SAAS;QACd,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,CAAC;IAEM,WAAW,CAAC,GAAG,MAAqB;QACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,wEAAwE;IACjE,iBAAiB,CAAC,SAAiB;QACxC,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC;QACpB,OAAO,sBAAsB,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,KAAsB,EAAE,KAAa;QAC/C,OAAO,sBAAsB,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,wGAAwG;IACjG,SAAS,CAAC,MAAc,EAAE,eAAwB;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAED,+GAA+G;AAC/G,MAAM,UAAU,gBAAgB,CAAC,QAAkC;IACjE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CACzC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,yBAAyB,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,OAAO,GAAG,CACvF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,QAAkC;IAC9D,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,OAAO,EAAE,CAAC,CAAC;SAC7F,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}
|
|
1
|
+
{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/types/apimatic-config/document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,MAAM,CAAC,MAAM,yBAAyB,GAAG,eAAe,CAAC;AAEzD;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,sEAAsE,CAAC;AAE1G,2FAA2F;AAC3F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAqBhC,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;AAEjD,MAAM,mBAAmB,GAAG,+FAA+F,CAAC;AAE5H,MAAM,wBAAwB,GAAG,wEAAwE,CAAC;AAE1G,oHAAoH;AACpH,MAAM,OAAO,sBAAsB;IAEd,IAAI;IACJ,QAAQ;IAF3B,YACmB,IAA6B,EAC7B,QAAkC;oBADlC,IAAI;wBACJ,QAAQ;IACxB,CAAC;IAEJ,+CAA+C;IACxC,MAAM,CAAC,KAAK;QACjB,OAAO,sBAAsB,CAAC,EAAE,CAAC,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,IAAY;QAC9B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3B,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,EAAE,CAAC,IAA6B;QAC7C,OAAO,IAAI,sBAAsB,CAAC,IAAI,EAAE,sBAAsB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,4FAA4F;IAC5F,wFAAwF;IACxF,yFAAyF;IACzF,qCAAqC;IAC7B,MAAM,CAAC,OAAO,CAAC,IAA6B;QAClD,OAAO;YACL,GAAG,sBAAsB,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC;YACnE,GAAG,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC;YACrD,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC;SAC5D,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,aAAsB;QACzD,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,cAAc,EAAE,CAAC;YACpE,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO;YACL;gBACE,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,eAAe;gBACtB,OAAO,EAAE,MAAM,OAAO,2DAA2D,cAAc,EAAE;aAClG;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAe;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC3B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YAChF,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC;QACrC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;YACpG,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CAAC;QACvG,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,SAAkB;QACjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,6FAA6F;QAC7F,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAmB,EAAE;YAC9E,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,QAAQ,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC9F,CAAC;YACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtE,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,QAAQ,aAAa,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;YACzG,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,wFAAwF;IACjF,MAAM;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,wFAAwF;IACjF,MAAM;QACX,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,CAAC;IAED,wFAAwF;IACjF,SAAS;QACd,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,CAAC;IAED,kEAAkE;IAC3D,GAAG,CAAC,KAAsB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;IACxC,CAAC;IAEM,WAAW,CAAC,GAAG,MAAqB;QACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,wEAAwE;IACjE,iBAAiB,CAAC,SAAiB;QACxC,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC;QACpB,OAAO,sBAAsB,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,KAAsB,EAAE,KAAa;QAC/C,OAAO,sBAAsB,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,wGAAwG;IACjG,SAAS,CAAC,MAAc,EAAE,eAAwB;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAED,+GAA+G;AAC/G,MAAM,UAAU,gBAAgB,CAAC,QAAkC;IACjE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CACzC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,yBAAyB,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,OAAO,GAAG,CACvF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,QAAkC;IAC9D,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,OAAO,EAAE,CAAC,CAAC;SAC7F,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}
|
|
@@ -18,7 +18,7 @@ export type ApimaticConfigState = {
|
|
|
18
18
|
path: FilePath;
|
|
19
19
|
};
|
|
20
20
|
export type ApimaticConfigWriteFailure = 'unreadable' | 'unwritable';
|
|
21
|
-
/** The `apimatic.json` in a project's `src
|
|
21
|
+
/** The `apimatic.json` in a project's `src/`. */
|
|
22
22
|
export declare class ApimaticConfigContext {
|
|
23
23
|
private readonly sourceDirectory;
|
|
24
24
|
private readonly fileService;
|
|
@@ -7,7 +7,7 @@ import { FileName } from './file/fileName.js';
|
|
|
7
7
|
import { FilePath } from './file/filePath.js';
|
|
8
8
|
/** How a file the CLI creates is laid out; one it found keeps its own layout. */
|
|
9
9
|
const DEFAULT_FORMAT = { indent: ' ', trailingNewline: true };
|
|
10
|
-
/** The `apimatic.json` in a project's `src
|
|
10
|
+
/** The `apimatic.json` in a project's `src/`. */
|
|
11
11
|
export class ApimaticConfigContext {
|
|
12
12
|
sourceDirectory;
|
|
13
13
|
fileService = new FileService();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apimatic-config-context.js","sourceRoot":"","sources":["../../src/types/apimatic-config-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EAGvB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAkB9C,iFAAiF;AACjF,MAAM,cAAc,GAAW,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;AAOvE
|
|
1
|
+
{"version":3,"file":"apimatic-config-context.js","sourceRoot":"","sources":["../../src/types/apimatic-config-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EAGvB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAkB9C,iFAAiF;AACjF,MAAM,cAAc,GAAW,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;AAOvE,iDAAiD;AACjD,MAAM,OAAO,qBAAqB;IAGH,eAAe;IAF3B,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IAEjD,YAA6B,eAA8B;+BAA9B,eAAe;IAAkB,CAAC;IAE/D,IAAY,UAAU;QACpB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACrF,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;YAC1B,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QACxF,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IACnF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,KAAK,CAChB,MAAkC,EAClC,KAAmE;QAEnE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,QAAQ,GAAG,sBAAsB,CAAC,KAAK,EAAE,CAAC;QAC9C,IAAI,MAAM,GAAG,cAAc,CAAC;QAC5B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;YAC3B,CAAC;YACD,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;YAC/B,IAAI,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvD,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;YAC3B,CAAC;YACD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QACzB,CAAC;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;QACzE,IAAI,UAAU,KAAK,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7E,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACtE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB;QAC9B,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC1D,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,IAAI;QAChB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC1D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,sBAAsB,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;gBACnG,MAAM,EAAE,cAAc;aACvB,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;IAC1G,CAAC;IAED,4FAA4F;IAC5F,wEAAwE;IAChE,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC;QACtE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAC1D,CAAC;CACF"}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import { FilePath } from
|
|
2
|
-
import { UrlPath } from
|
|
3
|
-
|
|
4
|
-
export
|
|
5
|
-
export declare
|
|
1
|
+
import { FilePath } from './filePath.js';
|
|
2
|
+
import { UrlPath } from './urlPath.js';
|
|
3
|
+
import { ProjectContext } from '../project-context.js';
|
|
4
|
+
export type ResourceInput = FilePath | UrlPath | ProjectContext;
|
|
5
|
+
export declare const createResourceInput: (file: string | undefined, url: string | undefined, input: string | undefined) => ResourceInput;
|
|
6
|
+
export declare const createFileOrUrlInput: (file?: string, url?: string) => FilePath | UrlPath;
|
|
7
|
+
export declare function createFileOrUrlFromInput(path: string): FilePath | UrlPath | undefined;
|
|
@@ -1,33 +1,34 @@
|
|
|
1
|
-
import path from
|
|
2
|
-
import { DirectoryPath } from
|
|
3
|
-
import { FileName } from
|
|
4
|
-
import { FilePath } from
|
|
5
|
-
import { UrlPath } from
|
|
6
|
-
import { removeQuotes } from
|
|
7
|
-
|
|
8
|
-
export const createResourceInput = (file, url) =>
|
|
1
|
+
import path from 'path';
|
|
2
|
+
import { DirectoryPath } from './directoryPath.js';
|
|
3
|
+
import { FileName } from './fileName.js';
|
|
4
|
+
import { FilePath } from './filePath.js';
|
|
5
|
+
import { UrlPath } from './urlPath.js';
|
|
6
|
+
import { removeQuotes } from '../../utils/string-utils.js';
|
|
7
|
+
import { ProjectContext } from '../project-context.js';
|
|
8
|
+
export const createResourceInput = (file, url, input) => (file || url ? createFileOrUrlInput(file, url) : ProjectContext.at(input));
|
|
9
|
+
export const createFileOrUrlInput = (file, url) => {
|
|
9
10
|
if (file && url) {
|
|
10
|
-
throw new Error(
|
|
11
|
+
throw new Error('Cannot specify both file and url. Please provide only one.');
|
|
11
12
|
}
|
|
12
13
|
if (!file && !url) {
|
|
13
|
-
throw new Error(
|
|
14
|
+
throw new Error('Must specify either file or url.');
|
|
14
15
|
}
|
|
15
16
|
if (file) {
|
|
16
17
|
if (!file.trim()) {
|
|
17
|
-
throw new Error(
|
|
18
|
+
throw new Error('Invalid file path provided.');
|
|
18
19
|
}
|
|
19
20
|
return new FilePath(new DirectoryPath(path.dirname(file)), new FileName(path.basename(file)));
|
|
20
21
|
}
|
|
21
22
|
if (url) {
|
|
22
23
|
if (!url.trim()) {
|
|
23
|
-
throw new Error(
|
|
24
|
+
throw new Error('Invalid URL provided.');
|
|
24
25
|
}
|
|
25
26
|
return new UrlPath(url);
|
|
26
27
|
}
|
|
27
|
-
throw new Error(
|
|
28
|
+
throw new Error('Must specify either file or url.');
|
|
28
29
|
};
|
|
29
|
-
export function
|
|
30
|
-
const sanitizedPath = removeQuotes(path.trim() ??
|
|
30
|
+
export function createFileOrUrlFromInput(path) {
|
|
31
|
+
const sanitizedPath = removeQuotes(path.trim() ?? '');
|
|
31
32
|
const urlPath = UrlPath.create(sanitizedPath);
|
|
32
33
|
if (urlPath) {
|
|
33
34
|
return urlPath;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource-input.js","sourceRoot":"","sources":["../../../src/types/file/resource-input.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"resource-input.js","sourceRoot":"","sources":["../../../src/types/file/resource-input.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAIvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,IAAwB,EACxB,GAAuB,EACvB,KAAyB,EACV,EAAE,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAE/F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAa,EAAE,GAAY,EAAsB,EAAE;IACtF,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,QAAQ,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;IACD,IAAI,GAAG,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,MAAM,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC9C,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAChD,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
|
@@ -1,13 +1,18 @@
|
|
|
1
1
|
export declare class FlagsProvider {
|
|
2
2
|
private static readonly inputFlagName;
|
|
3
|
+
private static readonly inputFlagOptions;
|
|
4
|
+
static readonly nonEmpty: (value: string) => Promise<string>;
|
|
3
5
|
static input: {
|
|
4
6
|
[FlagsProvider.inputFlagName]: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
5
7
|
};
|
|
8
|
+
static nonEmptyInput: {
|
|
9
|
+
[FlagsProvider.inputFlagName]: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
10
|
+
};
|
|
6
11
|
static destination(artifact: string, artifactName: string): {
|
|
7
12
|
destination: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
8
13
|
};
|
|
9
14
|
static authKey: {
|
|
10
|
-
|
|
15
|
+
'auth-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
16
|
};
|
|
12
17
|
static force: {
|
|
13
18
|
force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
@@ -1,33 +1,43 @@
|
|
|
1
|
-
import { Flags } from
|
|
1
|
+
import { Flags } from '@oclif/core';
|
|
2
2
|
export class FlagsProvider {
|
|
3
|
-
static inputFlagName =
|
|
3
|
+
static inputFlagName = 'input';
|
|
4
|
+
static inputFlagOptions = {
|
|
5
|
+
char: 'i',
|
|
6
|
+
description: "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files."
|
|
7
|
+
};
|
|
8
|
+
static nonEmpty = async (value) => {
|
|
9
|
+
if (value.trim() === '') {
|
|
10
|
+
throw new Error('The value is empty. Give a value, or leave the flag out.');
|
|
11
|
+
}
|
|
12
|
+
return value;
|
|
13
|
+
};
|
|
4
14
|
// Common folder flag group
|
|
5
15
|
static input = {
|
|
6
|
-
[FlagsProvider.inputFlagName]: Flags.string(
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
})
|
|
16
|
+
[FlagsProvider.inputFlagName]: Flags.string(FlagsProvider.inputFlagOptions)
|
|
17
|
+
};
|
|
18
|
+
static nonEmptyInput = {
|
|
19
|
+
[FlagsProvider.inputFlagName]: Flags.string({ ...FlagsProvider.inputFlagOptions, parse: FlagsProvider.nonEmpty })
|
|
10
20
|
};
|
|
11
21
|
static destination(artifact, artifactName) {
|
|
12
22
|
return {
|
|
13
23
|
destination: Flags.string({
|
|
14
|
-
char:
|
|
24
|
+
char: 'd',
|
|
15
25
|
description: `[default: <${FlagsProvider.inputFlagName}>/${artifact}] path where the ${artifactName} will be generated.`
|
|
16
26
|
})
|
|
17
27
|
};
|
|
18
28
|
}
|
|
19
29
|
// Auth key group
|
|
20
30
|
static authKey = {
|
|
21
|
-
|
|
22
|
-
char:
|
|
23
|
-
description:
|
|
31
|
+
'auth-key': Flags.string({
|
|
32
|
+
char: 'k',
|
|
33
|
+
description: 'override current authentication state with an authentication key.'
|
|
24
34
|
})
|
|
25
35
|
};
|
|
26
36
|
static force = {
|
|
27
37
|
force: Flags.boolean({
|
|
28
|
-
char:
|
|
38
|
+
char: 'f',
|
|
29
39
|
default: false,
|
|
30
|
-
description:
|
|
40
|
+
description: 'overwrite changes without asking for user consent.'
|
|
31
41
|
})
|
|
32
42
|
};
|
|
33
43
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flags-provider.js","sourceRoot":"","sources":["../../src/types/flags-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,MAAM,OAAO,aAAa;IAChB,MAAM,CAAU,aAAa,GAAW,OAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"flags-provider.js","sourceRoot":"","sources":["../../src/types/flags-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,MAAM,OAAO,aAAa;IAChB,MAAM,CAAU,aAAa,GAAW,OAAgB,CAAC;IACzD,MAAM,CAAU,gBAAgB,GAAG;QACzC,IAAI,EAAE,GAAG;QACT,WAAW,EACT,uIAAuI;KACjI,CAAC;IAEJ,MAAM,CAAU,QAAQ,GAAG,KAAK,EAAE,KAAa,EAAmB,EAAE;QACzE,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,2BAA2B;IACpB,MAAM,CAAC,KAAK,GAAG;QACpB,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC;KAC5E,CAAC;IAEK,MAAM,CAAC,aAAa,GAAG;QAC5B,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,aAAa,CAAC,gBAAgB,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC;KAClH,CAAC;IAEK,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,YAAoB;QAC9D,OAAO;YACL,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;gBACxB,IAAI,EAAE,GAAG;gBACT,WAAW,EAAE,cAAc,aAAa,CAAC,aAAa,KAAK,QAAQ,oBAAoB,YAAY,qBAAqB;aACzH,CAAC;SACH,CAAC;IACJ,CAAC;IAED,iBAAiB;IACV,MAAM,CAAC,OAAO,GAAG;QACtB,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,mEAAmE;SACjF,CAAC;KACH,CAAC;IAEK,MAAM,CAAC,KAAK,GAAG;QACpB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,oDAAoD;SAClE,CAAC;KACH,CAAC;CACH"}
|
|
@@ -45,6 +45,9 @@ export declare class PluginConfigContext {
|
|
|
45
45
|
constructor(sourceDirectory: DirectoryPath);
|
|
46
46
|
getPluginConfigState(): Promise<PluginConfigState>;
|
|
47
47
|
upsertMetadata(metadata: PluginMetadata, author?: PluginAuthor): Promise<Result<PluginConfig, PluginConfigWriteFailure>>;
|
|
48
|
+
addMetadataIfMissing(metadata: PluginMetadata): Promise<Result<void, PluginConfigWriteFailure>>;
|
|
49
|
+
languagesMissing(): Promise<boolean>;
|
|
50
|
+
addLanguagesIfMissing(languages: readonly Language[]): Promise<Result<void, PluginConfigWriteFailure>>;
|
|
48
51
|
recordLanguages(languages: readonly Language[]): Promise<Result<PluginConfig, PluginConfigWriteFailure>>;
|
|
49
52
|
/**
|
|
50
53
|
* The `src/` to upload: a copy whose `languages` names exactly what the plugin covers. The
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
import { ResultAsync } from 'neverthrow';
|
|
1
|
+
import { ok, ResultAsync } from 'neverthrow';
|
|
2
2
|
import { FileService } from '../infrastructure/file-service.js';
|
|
3
3
|
import { ApimaticConfigContext } from './apimatic-config-context.js';
|
|
4
4
|
import { findingClause } from './apimatic-config/document.js';
|
|
5
5
|
import { isPublished, languagesOf } from './apimatic-config/languages-block.js';
|
|
6
6
|
import { DEFAULT_PLUGIN_LICENSE } from './plugin/plugin-config.js';
|
|
7
|
+
import { PortalLanguages } from './portal/portal-languages.js';
|
|
7
8
|
import { SOURCE_DIRECTORY_NAME } from './project-layout.js';
|
|
8
9
|
import { SemVersion } from './publish/version.js';
|
|
9
10
|
import { isAvailableLanguage } from './sdk/generate.js';
|
|
@@ -83,6 +84,18 @@ const recorded = (document, languages, keep) => {
|
|
|
83
84
|
/** In the user's file a cleared language goes, unless its entry records where an SDK was published. */
|
|
84
85
|
const keepsRecord = (language, entry) => !isAvailableLanguage(language) || isPublished(entry);
|
|
85
86
|
const isUnavailableLanguage = (language) => !isAvailableLanguage(language);
|
|
87
|
+
const namesNoLanguage = (document) => PortalLanguages.namesNone(document.languages(), document.findingsFor('languages'));
|
|
88
|
+
const withMetadata = (document, metadata, author) => {
|
|
89
|
+
const plugin = (document.plugin() ?? {});
|
|
90
|
+
return document.with('plugin', {
|
|
91
|
+
...plugin,
|
|
92
|
+
pluginId: metadata.pluginId,
|
|
93
|
+
pluginName: metadata.pluginName,
|
|
94
|
+
pluginVersion: metadata.pluginVersion,
|
|
95
|
+
...(!plugin.author && author && { author }),
|
|
96
|
+
license: plugin.license ?? DEFAULT_PLUGIN_LICENSE
|
|
97
|
+
});
|
|
98
|
+
};
|
|
86
99
|
export class PluginConfigContext {
|
|
87
100
|
sourceDirectory;
|
|
88
101
|
configContext;
|
|
@@ -106,17 +119,25 @@ export class PluginConfigContext {
|
|
|
106
119
|
return PluginConfig.create(PluginConfigContext.configOf(state.document));
|
|
107
120
|
}
|
|
108
121
|
async upsertMetadata(metadata, author) {
|
|
109
|
-
return await this.merge((document) =>
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
122
|
+
return await this.merge((document) => withMetadata(document, metadata, author));
|
|
123
|
+
}
|
|
124
|
+
// Merged against `plugin` alone: a file's `languages` is not what this write could spread or break.
|
|
125
|
+
async addMetadataIfMissing(metadata) {
|
|
126
|
+
const state = await this.configContext.read();
|
|
127
|
+
if (state.state === 'parsed' && state.document.has('plugin')) {
|
|
128
|
+
return ok(undefined);
|
|
129
|
+
}
|
|
130
|
+
const merged = await this.configContext.merge(['plugin'], (document) => withMetadata(document, metadata));
|
|
131
|
+
return merged.map(() => undefined);
|
|
132
|
+
}
|
|
133
|
+
async languagesMissing() {
|
|
134
|
+
const state = await this.configContext.read();
|
|
135
|
+
return state.state === 'parsed' && namesNoLanguage(state.document);
|
|
136
|
+
}
|
|
137
|
+
// Merged against `languages` alone, as `addMetadataIfMissing` is against `plugin`.
|
|
138
|
+
async addLanguagesIfMissing(languages) {
|
|
139
|
+
const merged = await this.configContext.merge(['languages'], (document) => namesNoLanguage(document) ? document.with('languages', recorded(document, languages, keepsRecord)) : document);
|
|
140
|
+
return merged.map(() => undefined);
|
|
120
141
|
}
|
|
121
142
|
// A published entry survives a cleared checkbox: only `sdk publish` can write that record.
|
|
122
143
|
async recordLanguages(languages) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin-config-context.js","sourceRoot":"","sources":["../../src/types/plugin-config-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,WAAW,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"plugin-config-context.js","sourceRoot":"","sources":["../../src/types/plugin-config-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAU,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAA8B,MAAM,8BAA8B,CAAC;AACjG,OAAO,EAA2C,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACvG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAwC,MAAM,sCAAsC,CAAC;AAGtH,OAAO,EACL,sBAAsB,EAKvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAY,MAAM,mBAAmB,CAAC;AASlE,MAAM,OAAO,YAAY;IAOJ,MAAM;IACN,OAAO;IACP,WAAW;IARd,KAAK,GAAG,SAAkB,CAAC;IAE3C,oEAAoE;IAC7D,MAAM,CAAU,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IAEtE,YACmB,MAAwB,EACxB,OAAyD,EACzD,WAA8B;sBAF9B,MAAM;uBACN,OAAO;2BACP,WAAW;IAC3B,CAAC;IAEJ,2FAA2F;IACpF,MAAM,CAAC,MAAM,CAAC,MAAwB;QAC3C,MAAM,OAAO,GAA4C,EAAE,CAAC;QAC5D,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACjE,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAkC,CAAC,CAAC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC9F,CAAC;IAED,sDAAsD;IAC/C,iBAAiB;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,2FAA2F;IAC3F,2DAA2D;IACpD,WAAW;QAChB,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAC9F,OAAO,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC5F,CAAC;IAED,sGAAsG;IAC/F,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC3D,CAAC;IAEM,UAAU;QACf,MAAM,QAAQ,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,MAAM,UAAU,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,QAAQ,KAAK,EAAE,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YACzC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAC3C,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EACpC,GAAG,EAAE,CAAC,SAAS,CAChB,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,QAAkB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC;IAChE,CAAC;CACF;AAID,MAAM,YAAY,GAA+B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,QAAQ,GAAG,CACf,QAAgC,EAChC,SAA8B,EAC9B,IAAqF,EAC5D,EAAE;IAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAS,SAAS,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IACpH,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAExG,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,KAAgD,EAAW,EAAE,CAClG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;AAEvD,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAW,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAE5F,MAAM,eAAe,GAAG,CAAC,QAAgC,EAAW,EAAE,CACpE,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;AAErF,MAAM,YAAY,GAAG,CACnB,QAAgC,EAChC,QAAwB,EACxB,MAAqB,EACG,EAAE;IAC1B,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAuB,CAAC;IAC/D,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE;QAC7B,GAAG,MAAM;QACT,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QAC3C,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,sBAAsB;KAClD,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,OAAO,mBAAmB;IAID,eAAe;IAH3B,aAAa,CAAwB;IACrC,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IAEjD,YAA6B,eAA8B;+BAA9B,eAAe;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;YAClC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1F,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAC;QACrE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QACpF,CAAC;QACD,OAAO,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,QAAwB,EACxB,MAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,oGAAoG;IAC7F,KAAK,CAAC,oBAAoB,CAAC,QAAwB;QACxD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7D,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC1G,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED,mFAAmF;IAC5E,KAAK,CAAC,qBAAqB,CAAC,SAA8B;QAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CACxE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAC9G,CAAC;QACF,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,eAAe,CAC1B,SAA8B;QAE9B,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CACtB,IAAmB,EACnB,SAA8B;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAE3E,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC5D,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC,CACjF,CAAC;QAEF,2FAA2F;QAC3F,6EAA6E;QAC7E,OAAO,MAAM,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAEO,KAAK,CAAC,KAAK,CACjB,KAAmE;QAEnE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,QAAgC;QACtD,OAAO;YACL,GAAI,QAAQ,CAAC,MAAM,EAAqC;YACxD,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC;SACjC,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { Parsed } from './fields.js';
|
|
2
|
+
/** Where the portal is hosted: an origin, and the path it is served under there. */
|
|
3
|
+
export declare class SiteAddress {
|
|
4
|
+
private readonly origin;
|
|
5
|
+
/** `''` at the root of the host, otherwise `/docs` or deeper, with no trailing slash. */
|
|
6
|
+
private readonly basePath;
|
|
7
|
+
private constructor();
|
|
8
|
+
static parse(value: unknown, path: string): Parsed<SiteAddress>;
|
|
9
|
+
/** Where the portal is served, in the form Vite's `base` takes: `/`, or `/docs/`. */
|
|
10
|
+
path(): string;
|
|
11
|
+
hasPath(): boolean;
|
|
12
|
+
/** A portal-relative path's address on the host: `/sitemap.xml` is `https://example.com/docs/sitemap.xml`. */
|
|
13
|
+
addressOf(portalPath: string): string;
|
|
14
|
+
/** The site address, with no trailing slash. */
|
|
15
|
+
toString(): string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { err, ok } from 'neverthrow';
|
|
2
|
+
import { isWebAddress } from './fields.js';
|
|
3
|
+
/** One spelling of the path everywhere: Vite's base, the router's prefix, the host's folder and canonical links. */
|
|
4
|
+
const SEGMENT = /^[A-Za-z0-9._~-]+$/;
|
|
5
|
+
/** The last part of a page's address, such as a home page's `index.html`, which the portal cannot be served under. */
|
|
6
|
+
const PAGE = /\.html?$/i;
|
|
7
|
+
const GIVE_THE_ADDRESS = "Give the address the portal is hosted at, for example 'https://example.com/docs'.";
|
|
8
|
+
/** Where the portal is hosted: an origin, and the path it is served under there. */
|
|
9
|
+
export class SiteAddress {
|
|
10
|
+
origin;
|
|
11
|
+
basePath;
|
|
12
|
+
constructor(origin,
|
|
13
|
+
/** `''` at the root of the host, otherwise `/docs` or deeper, with no trailing slash. */
|
|
14
|
+
basePath) {
|
|
15
|
+
this.origin = origin;
|
|
16
|
+
this.basePath = basePath;
|
|
17
|
+
}
|
|
18
|
+
static parse(value, path) {
|
|
19
|
+
const text = typeof value === 'string' ? value.trim() : '';
|
|
20
|
+
const hostStart = text.indexOf('//') + 2;
|
|
21
|
+
const pathStart = text.indexOf('/', hostStart);
|
|
22
|
+
// Checked as written: the URL parser drops a tab from the host and reads past extra slashes before it.
|
|
23
|
+
const host = text.slice(hostStart, pathStart === -1 ? undefined : pathStart);
|
|
24
|
+
if (!isWebAddress(text) || !/^\S+$/.test(host)) {
|
|
25
|
+
return err([
|
|
26
|
+
`'${path}' must be the address the portal is hosted at, for example 'https://docs.example.com' or 'https://example.com/docs'.`
|
|
27
|
+
]);
|
|
28
|
+
}
|
|
29
|
+
// Checked as written: the URL parser reads `\` as `/` and drops an empty query or fragment.
|
|
30
|
+
const character = ['?', '#', '\\'].find((candidate) => text.includes(candidate));
|
|
31
|
+
if (character !== undefined) {
|
|
32
|
+
return err([`'${path}' cannot contain '${character}'. ${GIVE_THE_ADDRESS}`]);
|
|
33
|
+
}
|
|
34
|
+
const basePath = pathStart === -1 ? '' : text.slice(pathStart).replace(/\/$/, '');
|
|
35
|
+
const segments = basePath.split('/').slice(1);
|
|
36
|
+
if (segments.includes('')) {
|
|
37
|
+
return err([`'${path}' has an empty part ('//') in its path.`]);
|
|
38
|
+
}
|
|
39
|
+
const invalid = segments.find((segment) => !SEGMENT.test(segment) || segment === '.' || segment === '..');
|
|
40
|
+
if (invalid !== undefined) {
|
|
41
|
+
return err([
|
|
42
|
+
`'${path}' has '${invalid}' in its path. Each part between '/'s can use only letters, digits, '.', '_', '~' and '-', and cannot be '.' or '..'.`
|
|
43
|
+
]);
|
|
44
|
+
}
|
|
45
|
+
const page = segments.at(-1);
|
|
46
|
+
if (page !== undefined && PAGE.test(page)) {
|
|
47
|
+
return err([`'${path}' ends in '${page}', which names a page. ${GIVE_THE_ADDRESS}`]);
|
|
48
|
+
}
|
|
49
|
+
return ok(new SiteAddress(new URL(text).origin, basePath));
|
|
50
|
+
}
|
|
51
|
+
/** Where the portal is served, in the form Vite's `base` takes: `/`, or `/docs/`. */
|
|
52
|
+
path() {
|
|
53
|
+
return `${this.basePath}/`;
|
|
54
|
+
}
|
|
55
|
+
hasPath() {
|
|
56
|
+
return this.basePath !== '';
|
|
57
|
+
}
|
|
58
|
+
/** A portal-relative path's address on the host: `/sitemap.xml` is `https://example.com/docs/sitemap.xml`. */
|
|
59
|
+
addressOf(portalPath) {
|
|
60
|
+
return `${this.origin}${this.basePath}${portalPath}`;
|
|
61
|
+
}
|
|
62
|
+
/** The site address, with no trailing slash. */
|
|
63
|
+
toString() {
|
|
64
|
+
return `${this.origin}${this.basePath}`;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
//# sourceMappingURL=site-address.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"site-address.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAC;AAEnD,oHAAoH;AACpH,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAErC,sHAAsH;AACtH,MAAM,IAAI,GAAG,WAAW,CAAC;AAEzB,MAAM,gBAAgB,GAAG,mFAAmF,CAAC;AAE7G,oFAAoF;AACpF,MAAM,OAAO,WAAW;IAEH,MAAM;IAEN,QAAQ;IAH3B,YACmB,MAAc;IAC/B,yFAAyF;IACxE,QAAgB;sBAFhB,MAAM;wBAEN,QAAQ;IACxB,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC/C,uGAAuG;QACvG,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,sHAAsH;aAC/H,CAAC,CAAC;QACL,CAAC;QACD,4FAA4F;QAC5F,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACjF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,qBAAqB,SAAS,MAAM,gBAAgB,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,MAAM,QAAQ,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClF,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,yCAAyC,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC;QAC1G,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,UAAU,OAAO,uHAAuH;aACjJ,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,cAAc,IAAI,0BAA0B,gBAAgB,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,qFAAqF;IAC9E,IAAI;QACT,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC;IAC7B,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,8GAA8G;IACvG,SAAS,CAAC,UAAkB;QACjC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,GAAG,UAAU,EAAE,CAAC;IACvD,CAAC;IAED,gDAAgD;IACzC,QAAQ;QACb,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC1C,CAAC;CACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { UrlPath } from '../../file/urlPath.js';
|
|
2
1
|
import { Parsed } from './fields.js';
|
|
2
|
+
import { SiteAddress } from './site-address.js';
|
|
3
3
|
/** What a specification says about itself, which is what a portal is called until the block says otherwise. */
|
|
4
4
|
export interface SuggestedSite {
|
|
5
5
|
name: string;
|
|
@@ -8,7 +8,7 @@ export interface SuggestedSite {
|
|
|
8
8
|
export declare const PLACEHOLDER_SITE: Readonly<SuggestedSite>;
|
|
9
9
|
export declare class SiteConfig {
|
|
10
10
|
private readonly name;
|
|
11
|
-
private readonly
|
|
11
|
+
private readonly address;
|
|
12
12
|
private readonly description;
|
|
13
13
|
private constructor();
|
|
14
14
|
/**
|
|
@@ -19,7 +19,7 @@ export declare class SiteConfig {
|
|
|
19
19
|
static suggested(site: SuggestedSite): SiteConfig;
|
|
20
20
|
siteName(): string;
|
|
21
21
|
siteDescription(): string | null;
|
|
22
|
-
|
|
22
|
+
siteAddress(): SiteAddress | null;
|
|
23
23
|
toJSON(): {
|
|
24
24
|
name: string;
|
|
25
25
|
url?: string;
|
|
@@ -27,6 +27,4 @@ export declare class SiteConfig {
|
|
|
27
27
|
};
|
|
28
28
|
private static validName;
|
|
29
29
|
private static validDescription;
|
|
30
|
-
private static validUrl;
|
|
31
|
-
private static parseOrigin;
|
|
32
30
|
}
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { err, ok, Result } from 'neverthrow';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
2
|
+
import { allOf, namespace, nonEmptyString, optional, unknownKeys } from './fields.js';
|
|
3
|
+
import { SiteAddress } from './site-address.js';
|
|
4
4
|
export const PLACEHOLDER_SITE = Object.freeze({ name: 'My API', description: null });
|
|
5
5
|
const KNOWN = ['name', 'url', 'description'];
|
|
6
6
|
export class SiteConfig {
|
|
7
7
|
name;
|
|
8
|
-
|
|
8
|
+
address;
|
|
9
9
|
description;
|
|
10
|
-
constructor(name,
|
|
10
|
+
constructor(name, address, description) {
|
|
11
11
|
this.name = name;
|
|
12
|
-
this.
|
|
12
|
+
this.address = address;
|
|
13
13
|
this.description = description;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
@@ -19,9 +19,9 @@ export class SiteConfig {
|
|
|
19
19
|
static parse(value, path, suggested) {
|
|
20
20
|
return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN, path), Result.combineWithAllErrors([
|
|
21
21
|
SiteConfig.validName(data.name, `${path}.name`, suggested),
|
|
22
|
-
|
|
22
|
+
optional(data.url, (url) => SiteAddress.parse(url, `${path}.url`)),
|
|
23
23
|
SiteConfig.validDescription(data.description, `${path}.description`, suggested)
|
|
24
|
-
])).map(([name,
|
|
24
|
+
])).map(([name, address, description]) => new SiteConfig(name, address, description)));
|
|
25
25
|
}
|
|
26
26
|
static suggested(site) {
|
|
27
27
|
return new SiteConfig(site.name, null, site.description);
|
|
@@ -32,13 +32,13 @@ export class SiteConfig {
|
|
|
32
32
|
siteDescription() {
|
|
33
33
|
return this.description;
|
|
34
34
|
}
|
|
35
|
-
|
|
36
|
-
return this.
|
|
35
|
+
siteAddress() {
|
|
36
|
+
return this.address;
|
|
37
37
|
}
|
|
38
38
|
toJSON() {
|
|
39
39
|
return {
|
|
40
40
|
name: this.name,
|
|
41
|
-
...(this.
|
|
41
|
+
...(this.address === null ? {} : { url: this.address.toString() }),
|
|
42
42
|
...(this.description === null ? {} : { description: this.description })
|
|
43
43
|
};
|
|
44
44
|
}
|
|
@@ -61,28 +61,5 @@ export class SiteConfig {
|
|
|
61
61
|
const trimmed = description.trim();
|
|
62
62
|
return ok(trimmed.length > 0 ? trimmed : null);
|
|
63
63
|
}
|
|
64
|
-
// Only the origin is accepted: the portal is hosted at the root of its host, so a path,
|
|
65
|
-
// query or fragment would produce canonical links that do not resolve.
|
|
66
|
-
static validUrl(url, path) {
|
|
67
|
-
if (url === undefined) {
|
|
68
|
-
return ok(null);
|
|
69
|
-
}
|
|
70
|
-
const origin = typeof url === 'string' ? SiteConfig.parseOrigin(url.trim()) : null;
|
|
71
|
-
return origin === null
|
|
72
|
-
? err([
|
|
73
|
-
`'${path}' must be the address the portal is hosted at, without a path, for example 'https://docs.example.com'.`
|
|
74
|
-
])
|
|
75
|
-
: ok(origin);
|
|
76
|
-
}
|
|
77
|
-
static parseOrigin(value) {
|
|
78
|
-
if (!isWebAddress(value)) {
|
|
79
|
-
return null;
|
|
80
|
-
}
|
|
81
|
-
const parsed = new URL(value);
|
|
82
|
-
if (parsed.pathname !== '/' || parsed.search !== '' || parsed.hash !== '') {
|
|
83
|
-
return null;
|
|
84
|
-
}
|
|
85
|
-
return new UrlPath(parsed.origin);
|
|
86
|
-
}
|
|
87
64
|
}
|
|
88
65
|
//# sourceMappingURL=site-config.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"site-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"site-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAQhD,MAAM,CAAC,MAAM,gBAAgB,GAA4B,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAE9G,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;AAE7C,MAAM,OAAO,UAAU;IAEF,IAAI;IACJ,OAAO;IACP,WAAW;IAH9B,YACmB,IAAY,EACZ,OAA2B,EAC3B,WAA0B;oBAF1B,IAAI;uBACJ,OAAO;2BACP,WAAW;IAC3B,CAAC;IAEJ;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY,EAAE,SAA+B;QAC/E,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CACH,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAC9B,MAAM,CAAC,oBAAoB,CAAC;YAC1B,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,SAAS,CAAC;YAC1D,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC;YAClE,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,cAAc,EAAE,SAAS,CAAC;SAChF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CACpF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAmB;QACzC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YAClE,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;SACxE,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,IAAa,EAAE,IAAY,EAAE,SAA+B;QACnF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,KAAK,IAAI;YACvB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,8DAA8D,CAAC,CAAC;YAC/E,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,kFAAkF;IAC1E,MAAM,CAAC,gBAAgB,CAC7B,WAAoB,EACpB,IAAY,EACZ,SAA+B;QAE/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAC,SAAS,EAAE,WAAW,IAAI,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACF"}
|
|
@@ -13,10 +13,10 @@ export declare class StaticAsset {
|
|
|
13
13
|
resolveIn(sourceDirectory: DirectoryPath): FilePath;
|
|
14
14
|
settingPath(): string;
|
|
15
15
|
/**
|
|
16
|
-
* The `static/` prefix is the
|
|
16
|
+
* The `static/` prefix is the portal's root. Each name is escaped, since a `#`, `?` or `%` in it
|
|
17
17
|
* would otherwise end or alter the path.
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
portalPath(): string;
|
|
20
20
|
imageType(): string | null;
|
|
21
21
|
isEqual(other: StaticAsset): boolean;
|
|
22
22
|
toJSON(): string;
|
|
@@ -45,10 +45,10 @@ export class StaticAsset {
|
|
|
45
45
|
return this.setting;
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
* The `static/` prefix is the
|
|
48
|
+
* The `static/` prefix is the portal's root. Each name is escaped, since a `#`, `?` or `%` in it
|
|
49
49
|
* would otherwise end or alter the path.
|
|
50
50
|
*/
|
|
51
|
-
|
|
51
|
+
portalPath() {
|
|
52
52
|
return `/${this.relativePath.slice(STATIC_PREFIX.length).split('/').map(encodeURIComponent).join('/')}`;
|
|
53
53
|
}
|
|
54
54
|
imageType() {
|