@apimatic/cli 1.5.0 → 2.0.0-beta.2

package/lib/prompts/sdk/publish.d.ts

@@ -4,7 +4,7 @@ import { PublishLogItem } from '../../types/publish-api/publish-log.js';
 import { PublishingInfo } from '../../types/publish-api/publishing-info.js';
 import { PublishType } from '../../types/publish-api/publishing-profile-item.js';
 import { SemVersion } from '../../types/publish/version.js';
-import { CodegenOption, Language } from '../../types/sdk/generate.js';
+import { Language, Stability } from '../../types/sdk/generate.js';
 import { PublishingProfile } from '../../types/publish/publishing-profile.js';
 export type PublishingOutcome = 'succeeded' | 'failed' | 'cancelled';
 export declare class SdkPublishPrompts {
@@ -20,6 +20,6 @@ export interface PublishingDetails {
     language: Language;
     version: SemVersion;
     publishType: PublishType[];
-    codegenOption?: CodegenOption;
+    stability?: Stability;
 }
-export declare function formatPublishingDetails({ profile, language, version, publishType, codegenOption }: PublishingDetails): string;
+export declare function formatPublishingDetails({ profile, language, version, publishType, stability }: PublishingDetails): string;

package/lib/prompts/sdk/publish.js

@@ -1,4 +1,5 @@
 import { log, spinner } from '@clack/prompts';
+import { sleep } from '../../infrastructure/timer-extensions.js';
 import { PublishType } from '../../types/publish-api/publishing-profile-item.js';
 import { noteWrapped, withSpinner } from '../prompt.js';
 import { format as f } from '../format.js';
@@ -24,10 +25,10 @@ ${f.link(publishingLogUrl)}`;
     async pollPublishingStatus(getSdkPublishingLogFn) {
         const TERMINAL_STATES = new Set(['Succeeded', 'Failed', 'Exception', 'InternalError']);
         const POLL_INTERVAL_MS = 10000; // poll after every 10 seconds.
-        let abortWait;
+        const waitAbort = new AbortController();
         const spin = spinner({
             onCancel: () => {
-                abortWait === null || abortWait === void 0 ? void 0 : abortWait();
+                waitAbort.abort();
             },
             cancelMessage: 'Publishing is still running on APIMatic and will continue without the CLI.'
         });
@@ -43,14 +44,13 @@ ${f.link(publishingLogUrl)}`;
             const statusMessage = [...events]
                 .sort((a, b) => (a.publishType === 'SourceCode' ? -1 : b.publishType === 'SourceCode' ? 1 : 0))
                 .map((event) => {
-                var _a;
                 const target = event.publishType === 'SourceCode' ? 'Source Code' : 'Package';
                 const eventLabels = {
                     Queued: 'Queued',
                     InProgress: 'In Progress',
                     Succeeded: 'Published'
                 };
-                const label = (_a = eventLabels[event.eventType]) !== null && _a !== void 0 ? _a : 'Failed';
+                const label = eventLabels[event.eventType] ?? 'Failed';
                 return `${target}: [${label}]`;
             })
                 .join(' | ');
@@ -60,23 +60,19 @@ ${f.link(publishingLogUrl)}`;
                 return isExecutionSuccessful ? 'succeeded' : 'failed';
             }
             spin.message(statusMessage);
-            await new Promise((resolve) => {
-                const timer = setTimeout(resolve, POLL_INTERVAL_MS);
-                abortWait = () => {
-                    clearTimeout(timer);
-                    resolve();
-                };
-            });
-            abortWait = undefined;
+            const sleepResult = await sleep(POLL_INTERVAL_MS, waitAbort.signal);
+            if (sleepResult !== 'ok') {
+                return sleepResult;
+            }
         }
         return 'cancelled';
     }
 }
-export function formatPublishingDetails({ profile, language, version, publishType, codegenOption }) {
+export function formatPublishingDetails({ profile, language, version, publishType, stability }) {
     const targets = [...publishType]
-        .map((t) => (t === PublishType.PackagePublishing ? "Package" : "Source Code"))
-        .join(" + ");
-    const generator = codegenOption ? `\n  Generator: ${codegenOption}` : "";
-    return `\n\n  Profile:   ${profile}\n  Language:  ${language}\n  Version:   ${version}\n  Targets:   ${targets}${generator}`;
+        .map((t) => (t === PublishType.PackagePublishing ? 'Package' : 'Source Code'))
+        .join(' + ');
+    const level = stability ? `\n  Stability: ${stability}` : '';
+    return `\n\n  Profile:   ${profile}\n  Language:  ${language}\n  Version:   ${version}\n  Targets:   ${targets}${level}`;
 }
 //# sourceMappingURL=publish.js.map

package/lib/prompts/sdk/publish.js.map

@@ -1 +1 @@
-{"version":3,"file":"publish.js","sourceRoot":"","sources":["../../../src/prompts/sdk/publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAK9C,OAAO,EAAE,WAAW,EAAE,MAAM,oDAAoD,CAAC;AAGjF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAK3C,MAAM,OAAO,iBAAiB;IACrB,UAAU,CAAC,EAAiD;QACjE,OAAO,WAAW,CAAC,gBAAgB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEM,yBAAyB,CAAC,YAA0B;QACzD,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEM,YAAY,CAAC,iBAAyB;QAC3C,GAAG,CAAC,IAAI,CACN,kGAAkG;YAChG,iBAAiB,CACpB,CAAC;IACJ,CAAC;IAEM,uBAAuB,CAAC,iBAAyB;QACtD,GAAG,CAAC,IAAI,CAAC,0CAA0C,GAAG,iBAAiB,CAAC,CAAC;IAC3E,CAAC;IAEM,qBAAqB,CAAC,gBAAwB;QACnD,MAAM,OAAO,GAAG;EAClB,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACzB,WAAW,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC1C,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAC/B,qBAA0E;QAE1E,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QACvF,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,+BAA+B;QAE/D,IAAI,SAAmC,CAAC;QACxC,MAAM,IAAI,GAAG,OAAO,CAAC;YACnB,QAAQ,EAAE,GAAG,EAAE;gBACb,SAAS,aAAT,SAAS,uBAAT,SAAS,EAAI,CAAC;YAChB,CAAC;YACD,aAAa,EAAE,4EAA4E;SAC5F,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAE/C,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,MAAM,mBAAmB,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE1D,IAAI,mBAAmB,CAAC,KAAK,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,oCAAoC,EAAE,CAAC,CAAC,CAAC;gBACnD,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,GAAG,mBAAmB,CAAC,KAAK,CAAC;YAC7C,MAAM,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YACzF,MAAM,aAAa,GAAG,CAAC,GAAG,MAAM,CAAC;iBAC9B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC9F,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;gBACb,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC9E,MAAM,WAAW,GAA2B;oBAC1C,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE,aAAa;oBACzB,SAAS,EAAE,WAAW;iBACvB,CAAC;gBACF,MAAM,KAAK,GAAG,MAAA,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,mCAAI,QAAQ,CAAC;gBACvD,OAAO,GAAG,MAAM,MAAM,KAAK,GAAG,CAAC;YACjC,CAAC,CAAC;iBACD,IAAI,CAAC,KAAK,CAAC,CAAC;YAEf,IAAI,kBAAkB,EAAE,CAAC;gBACvB,MAAM,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,OAAO,qBAAqB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxD,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC5B,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;gBACpD,SAAS,GAAG,GAAG,EAAE;oBACf,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,SAAS,GAAG,SAAS,CAAC;QACxB,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAUD,MAAM,UAAU,uBAAuB,CAAC,EACtC,OAAO,EACP,QAAQ,EACR,OAAO,EACP,WAAW,EACX,aAAa,EACK;IAClB,MAAM,OAAO,GAAG,CAAC,GAAG,WAAW,CAAC;SAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;SAC7E,IAAI,CAAC,KAAK,CAAC,CAAC;IAEf,MAAM,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,OAAO,oBAAoB,OAAO,kBAAkB,QAAQ,kBAAkB,OAAO,kBAAkB,OAAO,GAAG,SAAS,EAAE,CAAC;AAC/H,CAAC"}
+{"version":3,"file":"publish.js","sourceRoot":"","sources":["../../../src/prompts/sdk/publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG9C,OAAO,EAAE,KAAK,EAAE,MAAM,0CAA0C,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,MAAM,oDAAoD,CAAC;AAGjF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAK3C,MAAM,OAAO,iBAAiB;IACrB,UAAU,CAAC,EAAiD;QACjE,OAAO,WAAW,CAAC,gBAAgB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEM,yBAAyB,CAAC,YAA0B;QACzD,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEM,YAAY,CAAC,iBAAyB;QAC3C,GAAG,CAAC,IAAI,CACN,kGAAkG;YAChG,iBAAiB,CACpB,CAAC;IACJ,CAAC;IAEM,uBAAuB,CAAC,iBAAyB;QACtD,GAAG,CAAC,IAAI,CAAC,0CAA0C,GAAG,iBAAiB,CAAC,CAAC;IAC3E,CAAC;IAEM,qBAAqB,CAAC,gBAAwB;QACnD,MAAM,OAAO,GAAG;EAClB,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACzB,WAAW,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC1C,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAC/B,qBAA0E;QAE1E,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QACvF,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,+BAA+B;QAE/D,MAAM,SAAS,GAAG,IAAI,eAAe,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,OAAO,CAAC;YACnB,QAAQ,EAAE,GAAG,EAAE;gBACb,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,CAAC;YACD,aAAa,EAAE,4EAA4E;SAC5F,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAE/C,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,MAAM,mBAAmB,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE1D,IAAI,mBAAmB,CAAC,KAAK,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,oCAAoC,EAAE,CAAC,CAAC,CAAC;gBACnD,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,GAAG,mBAAmB,CAAC,KAAK,CAAC;YAC7C,MAAM,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YACzF,MAAM,aAAa,GAAG,CAAC,GAAG,MAAM,CAAC;iBAC9B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC9F,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACb,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC9E,MAAM,WAAW,GAA2B;oBAC1C,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE,aAAa;oBACzB,SAAS,EAAE,WAAW;iBACvB,CAAC;gBACF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,QAAQ,CAAC;gBACvD,OAAO,GAAG,MAAM,MAAM,KAAK,GAAG,CAAC;YACjC,CAAC,CAAC;iBACD,IAAI,CAAC,KAAK,CAAC,CAAC;YAEf,IAAI,kBAAkB,EAAE,CAAC;gBACvB,MAAM,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,OAAO,qBAAqB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxD,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAE5B,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YACpE,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAUD,MAAM,UAAU,uBAAuB,CAAC,EACtC,OAAO,EACP,QAAQ,EACR,OAAO,EACP,WAAW,EACX,SAAS,EACS;IAClB,MAAM,OAAO,GAAG,CAAC,GAAG,WAAW,CAAC;SAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;SAC7E,IAAI,CAAC,KAAK,CAAC,CAAC;IAEf,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,kBAAkB,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,OAAO,oBAAoB,OAAO,kBAAkB,QAAQ,kBAAkB,OAAO,kBAAkB,OAAO,GAAG,KAAK,EAAE,CAAC;AAC3H,CAAC"}

package/lib/prompts/sdk/record-published-sdk.d.ts

@@ -0,0 +1,7 @@
+import { Language } from '../../types/sdk/generate.js';
+export declare class RecordPublishedSdkPrompts {
+    sdkRecorded(language: Language, configExists: boolean): void;
+    noSourceRepository(language: Language): void;
+    configUnreadable(reason?: string): void;
+    configNotWritten(): void;
+}

package/lib/prompts/sdk/record-published-sdk.js

@@ -0,0 +1,26 @@
+import { log } from '@clack/prompts';
+import { APIMATIC_CONFIG_FILE_NAME } from '../../types/apimatic-config/document.js';
+import { format as f } from '../format.js';
+export class RecordPublishedSdkPrompts {
+    sdkRecorded(language, configExists) {
+        const message = (configExists
+            ? `Updated ${f.var(APIMATIC_CONFIG_FILE_NAME)} for ${f.var(language)}. `
+            : `Created ${f.var(APIMATIC_CONFIG_FILE_NAME)} and added ${f.var(language)}. `) +
+            `Run '${f.cmdAlt('apimatic', 'plugin', 'generate')}' to build your context plugin.`;
+        log.info(message);
+    }
+    noSourceRepository(language) {
+        const message = `Context plugin generation needs a source repository, and none was published for ${f.var(language)}. ` +
+            `Publish the SDK's source code to complete its ${f.var(APIMATIC_CONFIG_FILE_NAME)} entry.`;
+        log.warn(message);
+    }
+    configUnreadable(reason) {
+        const cause = reason ? `: ${reason}` : '';
+        const message = `${f.var(APIMATIC_CONFIG_FILE_NAME)} cannot be used${cause}, so this published SDK's details were not added to it. ` + `Fix it and try again.`;
+        log.warn(message);
+    }
+    configNotWritten() {
+        log.warn(`${f.var(APIMATIC_CONFIG_FILE_NAME)} could not be written, so this published SDK's details were not added to it.`);
+    }
+}
+//# sourceMappingURL=record-published-sdk.js.map

package/lib/prompts/sdk/record-published-sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-published-sdk.js","sourceRoot":"","sources":["../../../src/prompts/sdk/record-published-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAEpF,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,OAAO,yBAAyB;IAC7B,WAAW,CAAC,QAAkB,EAAE,YAAqB;QAC1D,MAAM,OAAO,GACX,CAAC,YAAY;YACX,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI;YACxE,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjF,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,iCAAiC,CAAC;QACtF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,kBAAkB,CAAC,QAAkB;QAC1C,MAAM,OAAO,GACX,mFAAmF,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI;YACtG,iDAAiD,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,SAAS,CAAC;QAC7F,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,gBAAgB,CAAC,MAAe;QACrC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,MAAM,OAAO,GACX,GAAG,CAAC,CAAC,GAAG,CACN,yBAAyB,CAC1B,kBAAkB,KAAK,0DAA0D,GAAG,uBAAuB,CAAC;QAC/G,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,gBAAgB;QACrB,GAAG,CAAC,IAAI,CACN,GAAG,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,8EAA8E,CAClH,CAAC;IACJ,CAAC;CACF"}

package/lib/types/apimatic-config/document.d.ts

@@ -0,0 +1,68 @@
+import { Result } from 'neverthrow';
+export declare const APIMATIC_CONFIG_FILE_NAME = "apimatic.json";
+/**
+ * Where editors find the file's schema: the copy the published package carries, under the `beta`
+ * dist-tag. jsDelivr resolves a major range such as `@2` to its newest stable release and never to
+ * a prerelease, so `@2` leads nowhere until 2.0.0 ships; `@beta` reaches the newest prerelease.
+ */
+export declare const APIMATIC_SCHEMA_URL = "https://cdn.jsdelivr.net/npm/@apimatic/cli@beta/apimatic.schema.json";
+/** The one format this CLI reads. A file naming another is refused rather than misread. */
+export declare const SCHEMA_VERSION = 1;
+/** A block one command owns. */
+export type ConfigBlockName = 'portal' | 'plugin' | 'languages';
+/** Where a finding comes from: a block, or `root` for the file itself and the keys beside the blocks. */
+export type ConfigBlock = 'root' | ConfigBlockName;
+/**
+ * Something wrong with the file, kept apart from its wording. The portal path lists findings
+ * one sentence each and the plugin path folds them into one clause behind the file's name; both
+ * read the same `field` and `problem`, so the two cannot drift.
+ */
+export interface ConfigFinding {
+    block: ConfigBlock;
+    /** The key the finding is about, as a dotted path from the root, or null for the file as a whole. */
+    field: string | null;
+    /** What is wrong with it, as a predicate: "is not a JSON object". */
+    problem: string;
+}
+/** The parsed `apimatic.json`: its blocks, the keys around them in the order written, and what is wrong with it. */
+export declare class ApimaticConfigDocument {
+    private readonly root;
+    private readonly findings;
+    private constructor();
+    /** What a file the CLI creates starts from. */
+    static empty(): ApimaticConfigDocument;
+    /**
+     * Refuses only what no command could use: a file holding no JSON object at all. Everything
+     * else parses, and what is wrong inside it is carried as findings for each command to read or
+     * ignore by block, so a malformed block one command owns never stops another.
+     */
+    static parse(text: string): Result<ApimaticConfigDocument, ConfigFinding[]>;
+    private static of;
+    private static analyze;
+    private static schemaVersionFindings;
+    private static pluginFindings;
+    private static languagesFindings;
+    /** As written, whatever that is: the portal's own parser says what is wrong with it. */
+    portal(): unknown;
+    /** The block, or undefined when it is absent or, as the findings say, not an object. */
+    plugin(): Record<string, unknown> | undefined;
+    /** The block, or undefined when it is absent or, as the findings say, not an object. */
+    languages(): Record<string, unknown> | undefined;
+    findingsFor(...blocks: ConfigBlock[]): ConfigFinding[];
+    /** `$schema` goes first among the keys, where a reader looks for it. */
+    referencingSchema(schemaUrl: string): ApimaticConfigDocument;
+    /**
+     * The document with one block replaced. A block the file already holds keeps its place among
+     * the other keys; a new one goes after the last.
+     */
+    with(block: ConfigBlockName, value: object): ApimaticConfigDocument;
+    /** The file's text, keys in the order held, in the indentation and with the ending the caller found. */
+    serialize(indent: string, trailingNewline: boolean): string;
+}
+/** One sentence per finding, each naming the file or the field, for a list a user fixes one line at a time. */
+export declare function findingSentences(findings: readonly ConfigFinding[]): string[];
+/**
+ * Every finding as one clause about the file, for a message that has already named it:
+ * "it is empty", "its 'languages' is not a JSON object".
+ */
+export declare function findingClause(findings: readonly ConfigFinding[]): string;

package/lib/types/apimatic-config/document.js

@@ -0,0 +1,161 @@
+import { err, ok } from 'neverthrow';
+import { isJsonObject } from '../../utils/json-utils.js';
+import { stripByteOrderMark } from '../../utils/string-utils.js';
+import { PLUGIN_ID_PATTERN } from '../plugin/plugin-config.js';
+import { SemVersion } from '../publish/version.js';
+export const APIMATIC_CONFIG_FILE_NAME = 'apimatic.json';
+/**
+ * Where editors find the file's schema: the copy the published package carries, under the `beta`
+ * dist-tag. jsDelivr resolves a major range such as `@2` to its newest stable release and never to
+ * a prerelease, so `@2` leads nowhere until 2.0.0 ships; `@beta` reaches the newest prerelease.
+ */
+export const APIMATIC_SCHEMA_URL = 'https://cdn.jsdelivr.net/npm/@apimatic/cli@beta/apimatic.schema.json';
+/** The one format this CLI reads. A file naming another is refused rather than misread. */
+export const SCHEMA_VERSION = 1;
+const NOT_A_JSON_OBJECT = 'is not a JSON object';
+const MALFORMED_PLUGIN_ID = `must be lower-case alphanumeric words separated by single dashes, for example 'acme-payments'`;
+const MALFORMED_PLUGIN_VERSION = `must be a version in the format major.minor.patch, for example '0.1.0'`;
+/** The parsed `apimatic.json`: its blocks, the keys around them in the order written, and what is wrong with it. */
+export class ApimaticConfigDocument {
+    root;
+    findings;
+    constructor(root, findings) {
+        this.root = root;
+        this.findings = findings;
+    }
+    /** What a file the CLI creates starts from. */
+    static empty() {
+        return ApimaticConfigDocument.of({ schemaVersion: SCHEMA_VERSION });
+    }
+    /**
+     * Refuses only what no command could use: a file holding no JSON object at all. Everything
+     * else parses, and what is wrong inside it is carried as findings for each command to read or
+     * ignore by block, so a malformed block one command owns never stops another.
+     */
+    static parse(text) {
+        const contents = stripByteOrderMark(text);
+        if (contents.trim() === '') {
+            return err([{ block: 'root', field: null, problem: 'is empty' }]);
+        }
+        let data;
+        try {
+            data = JSON.parse(contents);
+        }
+        catch {
+            return err([{ block: 'root', field: null, problem: 'is not valid JSON' }]);
+        }
+        if (!isJsonObject(data)) {
+            return err([{ block: 'root', field: null, problem: NOT_A_JSON_OBJECT }]);
+        }
+        return ok(ApimaticConfigDocument.of(data));
+    }
+    static of(root) {
+        return new ApimaticConfigDocument(root, ApimaticConfigDocument.analyze(root));
+    }
+    // The shape checks are what the writers need: a merge spreads a block, which turns a string
+    // into `{"0":"a"}` and a number into nothing, so a wrong shape is refused before it can
+    // corrupt the file. The identity checks are the plugin's own rules, reported here so the
+    // portal path can leave them unread.
+    static analyze(root) {
+        return [
+            ...ApimaticConfigDocument.schemaVersionFindings(root.schemaVersion),
+            ...ApimaticConfigDocument.pluginFindings(root.plugin),
+            ...ApimaticConfigDocument.languagesFindings(root.languages)
+        ];
+    }
+    static schemaVersionFindings(schemaVersion) {
+        if (schemaVersion === undefined || schemaVersion === SCHEMA_VERSION) {
+            return [];
+        }
+        const written = JSON.stringify(schemaVersion);
+        return [
+            {
+                block: 'root',
+                field: 'schemaVersion',
+                problem: `is ${written}, which this version of the CLI does not read; it reads ${SCHEMA_VERSION}`
+            }
+        ];
+    }
+    static pluginFindings(plugin) {
+        if (plugin === undefined) {
+            return [];
+        }
+        if (!isJsonObject(plugin)) {
+            return [{ block: 'plugin', field: 'plugin', problem: NOT_A_JSON_OBJECT }];
+        }
+        const findings = [];
+        const id = plugin.pluginId;
+        if (typeof id === 'string' && (id.trim() === '' || !PLUGIN_ID_PATTERN.test(id))) {
+            findings.push({ block: 'plugin', field: 'plugin.pluginId', problem: MALFORMED_PLUGIN_ID });
+        }
+        const version = plugin.pluginVersion;
+        if (typeof version === 'string' && (version.trim() === '' || SemVersion.tryCreate(version).isErr())) {
+            findings.push({ block: 'plugin', field: 'plugin.pluginVersion', problem: MALFORMED_PLUGIN_VERSION });
+        }
+        return findings;
+    }
+    static languagesFindings(languages) {
+        if (languages === undefined) {
+            return [];
+        }
+        if (!isJsonObject(languages)) {
+            return [{ block: 'languages', field: 'languages', problem: NOT_A_JSON_OBJECT }];
+        }
+        // Both levels are spread by `upsertLanguage`, so both are refused when they are not objects.
+        return Object.entries(languages).flatMap(([language, entry]) => {
+            if (!isJsonObject(entry)) {
+                return [{ block: 'languages', field: `languages.${language}`, problem: NOT_A_JSON_OBJECT }];
+            }
+            if (entry.publishing !== undefined && !isJsonObject(entry.publishing)) {
+                return [{ block: 'languages', field: `languages.${language}.publishing`, problem: NOT_A_JSON_OBJECT }];
+            }
+            return [];
+        });
+    }
+    /** As written, whatever that is: the portal's own parser says what is wrong with it. */
+    portal() {
+        return this.root.portal;
+    }
+    /** The block, or undefined when it is absent or, as the findings say, not an object. */
+    plugin() {
+        return isJsonObject(this.root.plugin) ? this.root.plugin : undefined;
+    }
+    /** The block, or undefined when it is absent or, as the findings say, not an object. */
+    languages() {
+        return isJsonObject(this.root.languages) ? this.root.languages : undefined;
+    }
+    findingsFor(...blocks) {
+        return this.findings.filter((finding) => blocks.includes(finding.block));
+    }
+    /** `$schema` goes first among the keys, where a reader looks for it. */
+    referencingSchema(schemaUrl) {
+        const rest = { ...this.root };
+        delete rest.$schema;
+        return ApimaticConfigDocument.of({ $schema: schemaUrl, ...rest });
+    }
+    /**
+     * The document with one block replaced. A block the file already holds keeps its place among
+     * the other keys; a new one goes after the last.
+     */
+    with(block, value) {
+        return ApimaticConfigDocument.of({ ...this.root, [block]: value });
+    }
+    /** The file's text, keys in the order held, in the indentation and with the ending the caller found. */
+    serialize(indent, trailingNewline) {
+        return JSON.stringify(this.root, null, indent) + (trailingNewline ? '\n' : '');
+    }
+}
+/** One sentence per finding, each naming the file or the field, for a list a user fixes one line at a time. */
+export function findingSentences(findings) {
+    return findings.map(({ field, problem }) => field === null ? `${APIMATIC_CONFIG_FILE_NAME} ${problem}.` : `'${field}' ${problem}.`);
+}
+/**
+ * Every finding as one clause about the file, for a message that has already named it:
+ * "it is empty", "its 'languages' is not a JSON object".
+ */
+export function findingClause(findings) {
+    return findings
+        .map(({ field, problem }) => (field === null ? `it ${problem}` : `its '${field}' ${problem}`))
+        .join('; ');
+}
+//# sourceMappingURL=document.js.map

package/lib/types/apimatic-config/document.js.map

@@ -0,0 +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"}

package/lib/types/apimatic-config/languages-block.d.ts

@@ -0,0 +1,39 @@
+import { JsonObject } from '../../utils/json-utils.js';
+import { GitConfiguration, PackageConfigurationForLanguage, PackageSettingsState } from '../publish/package-settings-configuration.js';
+import { SemVersion, SemVersionString } from '../publish/version.js';
+import { Language } from '../sdk/generate.js';
+import { ApimaticConfigDocument } from './document.js';
+export declare const LANGUAGES_EXAMPLE = "\"languages\": { \"typescript\": {} }";
+export interface LanguageSource {
+    repositoryUrl: string;
+    branch?: string;
+}
+/** The package's name is not here: the service reads it from `packageConfiguration`. */
+interface PackageRelease {
+    version: SemVersionString;
+}
+interface LanguagePublishing<TConfiguration> {
+    source?: LanguageSource;
+    package?: PackageRelease;
+    /** Optional because a profile can configure a repository without a package. */
+    packageConfiguration?: TConfiguration;
+}
+export type LanguagePublishingEntry<L extends Language> = LanguagePublishing<PackageConfigurationForLanguage[L]>;
+/** Without `publishing`, the language was asked for but nothing has been published yet. */
+export interface PluginLanguageEntry<L extends Language> {
+    publishing?: LanguagePublishingEntry<L>;
+}
+export type PluginLanguages = Partial<{
+    [L in Language]: PluginLanguageEntry<L>;
+}>;
+export declare const languagesOf: (document: ApimaticConfigDocument) => PluginLanguages;
+export declare const isPublished: (entry: PluginLanguageEntry<Language> | undefined) => boolean;
+export declare function buildLanguageEntry<L extends Language>(language: L, gitConfiguration: GitConfiguration | undefined, packageConfiguration: PackageConfigurationForLanguage[L] | undefined, packageVersion: SemVersion | undefined): PluginLanguageEntry<L>;
+export declare function withLanguage<L extends Language>(languages: PluginLanguages, language: L, entry: PluginLanguageEntry<L>, packageSettings: PackageSettingsState): PluginLanguages;
+export interface RecordedPublishing {
+    repositoryUrl: string | null;
+    version: string | null;
+    packageConfiguration: Readonly<JsonObject>;
+}
+export declare function recordedPublishing(entry: unknown): RecordedPublishing;
+export {};

package/lib/types/apimatic-config/languages-block.js

@@ -0,0 +1,58 @@
+import { isJsonObject } from '../../utils/json-utils.js';
+const GITHUB_BASE_URL = 'https://github.com';
+export const LANGUAGES_EXAMPLE = '"languages": { "typescript": {} }';
+export const languagesOf = (document) => (document.languages() ?? {});
+export const isPublished = (entry) => Boolean(entry?.publishing?.source ?? entry?.publishing?.package);
+export function buildLanguageEntry(language, gitConfiguration, packageConfiguration, packageVersion) {
+    const repositoryName = gitConfiguration?.repositoryName?.trim();
+    const source = repositoryName
+        ? {
+            repositoryUrl: `${GITHUB_BASE_URL}/${repositoryName}`,
+            branch: gitConfiguration?.branch ? gitConfiguration.branch : undefined
+        }
+        : undefined;
+    return {
+        publishing: {
+            source,
+            package: packageVersion ? { version: packageVersion.toString() } : undefined,
+            // Written even without a release: it says how the package is set up, not that one exists.
+            packageConfiguration
+        }
+    };
+}
+export function withLanguage(languages, language, entry, packageSettings) {
+    const existingEntry = languages[language];
+    const existingPublishing = existingEntry?.publishing;
+    const publishing = entry.publishing
+        ? {
+            ...existingPublishing,
+            ...entry.publishing,
+            source: entry.publishing.source ?? existingPublishing?.source,
+            package: entry.publishing.package ?? existingPublishing?.package,
+            packageConfiguration: packageSettings === 'disabled'
+                ? undefined
+                : entry.publishing.packageConfiguration ?? existingPublishing?.packageConfiguration
+        }
+        : existingPublishing;
+    return { ...languages, [language]: { ...existingEntry, ...entry, ...(publishing ? { publishing } : {}) } };
+}
+export function recordedPublishing(entry) {
+    const publishing = objectAt(entry, 'publishing');
+    const source = objectAt(publishing, 'source');
+    const release = objectAt(publishing, 'package');
+    return {
+        repositoryUrl: stringAt(source, 'repositoryUrl'),
+        version: stringAt(release, 'version'),
+        packageConfiguration: objectAt(publishing, 'packageConfiguration')
+    };
+}
+// `T` only types `key`, so renaming a field fails to compile here instead of reading nothing.
+function objectAt(value, key) {
+    const found = isJsonObject(value) ? value[key] : undefined;
+    return isJsonObject(found) ? found : {};
+}
+function stringAt(value, key) {
+    const found = value[key];
+    return typeof found === 'string' ? found : null;
+}
+//# sourceMappingURL=languages-block.js.map

package/lib/types/apimatic-config/languages-block.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languages-block.js","sourceRoot":"","sources":["../../../src/types/apimatic-config/languages-block.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAc,MAAM,2BAA2B,CAAC;AAUrE,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAE7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,mCAAmC,CAAC;AA4BrE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAgC,EAAmB,EAAE,CAC/E,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,CAAoB,CAAC;AAElD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAgD,EAAW,EAAE,CACvF,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAEnE,MAAM,UAAU,kBAAkB,CAChC,QAAW,EACX,gBAA8C,EAC9C,oBAAoE,EACpE,cAAsC;IAEtC,MAAM,cAAc,GAAG,gBAAgB,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;IAChE,MAAM,MAAM,GAA+B,cAAc;QACvD,CAAC,CAAC;YACE,aAAa,EAAE,GAAG,eAAe,IAAI,cAAc,EAAE;YACrD,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SACvE;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,UAAU,EAAE;YACV,MAAM;YACN,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS;YAC5E,0FAA0F;YAC1F,oBAAoB;SACrB;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,SAA0B,EAC1B,QAAW,EACX,KAA6B,EAC7B,eAAqC;IAErC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,kBAAkB,GAAG,aAAa,EAAE,UAAU,CAAC;IACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU;QACjC,CAAC,CAAC;YACE,GAAG,kBAAkB;YACrB,GAAG,KAAK,CAAC,UAAU;YACnB,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,IAAI,kBAAkB,EAAE,MAAM;YAC7D,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,IAAI,kBAAkB,EAAE,OAAO;YAChE,oBAAoB,EAClB,eAAe,KAAK,UAAU;gBAC5B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,oBAAoB,IAAI,kBAAkB,EAAE,oBAAoB;SACxF;QACH,CAAC,CAAC,kBAAkB,CAAC;IAEvB,OAAO,EAAE,GAAG,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;AAC7G,CAAC;AAQD,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,MAAM,UAAU,GAAG,QAAQ,CAAgC,KAAK,EAAE,YAAY,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,QAAQ,CAA8B,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC3E,MAAM,OAAO,GAAG,QAAQ,CAA8B,UAAU,EAAE,SAAS,CAAC,CAAC;IAE7E,OAAO;QACL,aAAa,EAAE,QAAQ,CAAiB,MAAM,EAAE,eAAe,CAAC;QAChE,OAAO,EAAE,QAAQ,CAAiB,OAAO,EAAE,SAAS,CAAC;QACrD,oBAAoB,EAAE,QAAQ,CAA8B,UAAU,EAAE,sBAAsB,CAAC;KAChG,CAAC;AACJ,CAAC;AAED,8FAA8F;AAC9F,SAAS,QAAQ,CAAI,KAAc,EAAE,GAAqB;IACxD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1C,CAAC;AAED,SAAS,QAAQ,CAAI,KAAiB,EAAE,GAAqB;IAC3D,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAClD,CAAC"}

package/lib/types/apimatic-config-context.d.ts

@@ -0,0 +1,48 @@
+import { Result } from 'neverthrow';
+import { ApimaticConfigDocument, ConfigBlockName, ConfigFinding } from './apimatic-config/document.js';
+import { DirectoryPath } from './file/directoryPath.js';
+import { FilePath } from './file/filePath.js';
+/**
+ * What a reader finds. `path` rides along purely so a prompt can say where to fix the file.
+ * A parsed document may still carry findings; each command reads the blocks it owns.
+ */
+export type ApimaticConfigState = {
+    state: 'missing';
+} | {
+    state: 'unparseable';
+    findings: ConfigFinding[];
+    path: FilePath;
+} | {
+    state: 'parsed';
+    document: ApimaticConfigDocument;
+    path: FilePath;
+};
+export type ApimaticConfigWriteFailure = 'unreadable' | 'unwritable';
+/** The `apimatic.json` in a project's `src/`, beside `APIMATIC-BUILD.json`. */
+export declare class ApimaticConfigContext {
+    private readonly sourceDirectory;
+    private readonly fileService;
+    constructor(sourceDirectory: DirectoryPath);
+    private get configFile();
+    exists(): Promise<boolean>;
+    read(): Promise<ApimaticConfigState>;
+    /**
+     * Reads the document, hands the whole of it to `apply`, writes back the whole of what comes
+     * back. `blocks` names what the caller is about to write: a finding in one of them, or at
+     * the root, refuses the write, so a merge never spreads a malformed block into the file. A
+     * missing file starts from the empty document. A file that exists but cannot be parsed is
+     * left alone rather than overwritten, and a write fault is reported rather than thrown: this
+     * runs after work that already succeeded, and nothing here may turn that into a crash. A merge
+     * that changes nothing writes nothing, so re-running a command leaves the file as it was saved.
+     */
+    merge(blocks: readonly ConfigBlockName[], apply: (document: ApimaticConfigDocument) => ApimaticConfigDocument): Promise<Result<ApimaticConfigDocument, ApimaticConfigWriteFailure>>;
+    /**
+     * Rewrites the file without its byte-order mark, if it has one. Reading past a mark is enough
+     * while the file stays here, but `plugin generate` zips it and sends it to a parser that is
+     * not this one. Only the mark goes: the rest is written back byte for byte, so a layout this
+     * CLI never chose, and the line endings with it, survive a rewrite nobody asked for.
+     */
+    removeByteOrderMark(): Promise<Result<void, ApimaticConfigWriteFailure>>;
+    private load;
+    private static detectFormat;
+}