sf-plugin-cms 0.1.0

package/lib/openapi/intake.js

@@ -0,0 +1,176 @@
+import { createHash } from 'node:crypto';
+import { readFile } from 'node:fs/promises';
+import { LineCounter, parseDocument } from 'yaml';
+const HTTP_METHODS = new Set(['delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace']);
+export class OpenApiIntakeError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'OpenApiIntakeError';
+    }
+}
+function formatYamlDiagnostic(source, diagnostic, lineCounter) {
+    const position = diagnostic.pos?.[0];
+    const location = position === undefined
+        ? ''
+        : (() => {
+            const { line, col } = lineCounter.linePos(position);
+            return `:${line}:${col}`;
+        })();
+    const code = diagnostic.code ? ` [${diagnostic.code}]` : '';
+    return `${source}${location}${code}: ${diagnostic.message.replaceAll(/\s+/g, ' ').trim()}`;
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function decodePointerToken(token, reference) {
+    if (/%[0-9a-f]{2}/iu.test(token)) {
+        throw new OpenApiIntakeError(`escaped ref is forbidden: ${reference}`);
+    }
+    if (/~(?![01])/u.test(token)) {
+        throw new OpenApiIntakeError(`malformed JSON Pointer escape in ref: ${reference}`);
+    }
+    return token.replaceAll('~1', '/').replaceAll('~0', '~');
+}
+export function resolveInternalRef(root, reference) {
+    if (!reference.startsWith('#/')) {
+        throw new OpenApiIntakeError(`only canonical internal refs beginning #/ are allowed: ${reference}`);
+    }
+    if (reference.includes('\\') || reference.includes('?')) {
+        throw new OpenApiIntakeError(`malformed internal ref: ${reference}`);
+    }
+    let current = root;
+    const tokens = reference
+        .slice(2)
+        .split('/')
+        .map((token) => decodePointerToken(token, reference));
+    for (const [index, token] of tokens.entries()) {
+        if (Array.isArray(current)) {
+            if (!/^(0|[1-9]\d*)$/u.test(token) || Number(token) >= current.length) {
+                throw new OpenApiIntakeError(`unresolved internal ref ${reference} at segment ${index + 1} (${JSON.stringify(token)})`);
+            }
+            current = current[Number(token)];
+        }
+        else if (isRecord(current) && Object.hasOwn(current, token)) {
+            current = current[token];
+        }
+        else {
+            throw new OpenApiIntakeError(`unresolved internal ref ${reference} at segment ${index + 1} (${JSON.stringify(token)})`);
+        }
+    }
+    return current;
+}
+function validateRefs(root) {
+    const visitedObjects = new WeakSet();
+    const resolvedRefs = new Map();
+    let refCount = 0;
+    const visit = (value, refStack) => {
+        if (Array.isArray(value)) {
+            if (visitedObjects.has(value))
+                return;
+            visitedObjects.add(value);
+            for (const item of value)
+                visit(item, refStack);
+            return;
+        }
+        if (!isRecord(value))
+            return;
+        if (visitedObjects.has(value))
+            return;
+        visitedObjects.add(value);
+        const reference = value.$ref;
+        if (reference !== undefined) {
+            if (typeof reference !== 'string' || reference.length === 0) {
+                throw new OpenApiIntakeError('$ref must be a non-empty string');
+            }
+            refCount += 1;
+            const target = resolvedRefs.has(reference)
+                ? resolvedRefs.get(reference)
+                : resolveInternalRef(root, reference);
+            resolvedRefs.set(reference, target);
+            if (!refStack.has(reference)) {
+                visit(target, new Set([...refStack, reference]));
+            }
+        }
+        for (const [key, child] of Object.entries(value)) {
+            if (key !== '$ref')
+                visit(child, refStack);
+        }
+    };
+    visit(root, new Set());
+    return refCount;
+}
+function validateOperations(root) {
+    if (root.openapi !== '3.0.3') {
+        throw new OpenApiIntakeError(`expected OpenAPI 3.0.3, received ${JSON.stringify(root.openapi)}`);
+    }
+    const info = root.info;
+    if (!isRecord(info) || info.title !== 'CMS Connect REST API' || info.version !== 'v67.0') {
+        throw new OpenApiIntakeError('expected CMS Connect REST API document version v67.0');
+    }
+    if (!isRecord(root.paths))
+        throw new OpenApiIntakeError('OpenAPI paths must be an object');
+    const operationIds = new Set();
+    const identities = new Set();
+    const operations = [];
+    for (const path of Object.keys(root.paths).toSorted()) {
+        if (!path.startsWith('/'))
+            throw new OpenApiIntakeError(`invalid OpenAPI path: ${path}`);
+        const pathItem = root.paths[path];
+        if (!isRecord(pathItem))
+            throw new OpenApiIntakeError(`path item must be an object: ${path}`);
+        for (const method of Object.keys(pathItem).toSorted()) {
+            if (!HTTP_METHODS.has(method.toLowerCase()))
+                continue;
+            const operation = pathItem[method];
+            if (!isRecord(operation))
+                throw new OpenApiIntakeError(`operation must be an object: ${method} ${path}`);
+            if (typeof operation.operationId !== 'string' || operation.operationId.trim() === '') {
+                throw new OpenApiIntakeError(`missing operationId: ${method.toUpperCase()} ${path}`);
+            }
+            const operationId = operation.operationId.trim();
+            const identity = `${method.toUpperCase()} ${path}`;
+            if (identities.has(identity))
+                throw new OpenApiIntakeError(`duplicate operation identity: ${identity}`);
+            if (operationIds.has(operationId))
+                throw new OpenApiIntakeError(`duplicate operationId: ${operationId}`);
+            identities.add(identity);
+            operationIds.add(operationId);
+            operations.push({ method: method.toUpperCase(), operationId, path });
+        }
+    }
+    return operations.toSorted((left, right) => left.path.localeCompare(right.path) || left.method.localeCompare(right.method));
+}
+export async function intakeOpenApi(sourcePath) {
+    const bytes = await readFile(sourcePath);
+    const text = bytes.toString('utf8');
+    if (text.startsWith('\uFEFF'))
+        throw new OpenApiIntakeError(`${sourcePath}: UTF-8 BOM is forbidden`);
+    const lineCounter = new LineCounter();
+    const yamlDocument = parseDocument(text, {
+        customTags: [],
+        lineCounter,
+        uniqueKeys: true,
+        version: '1.2',
+    });
+    const diagnostics = [...yamlDocument.errors, ...yamlDocument.warnings];
+    if (diagnostics.length > 0) {
+        throw new OpenApiIntakeError(diagnostics
+            .map((diagnostic) => formatYamlDiagnostic(sourcePath, diagnostic, lineCounter))
+            .join('\n'));
+    }
+    const document = yamlDocument.toJS({ maxAliasCount: 100 });
+    if (!isRecord(document))
+        throw new OpenApiIntakeError('OpenAPI document root must be an object');
+    const operations = validateOperations(document);
+    const refCount = validateRefs(document);
+    return {
+        byteSize: bytes.byteLength,
+        document: document,
+        operationCount: operations.length,
+        operations,
+        refCount,
+        sha256: createHash('sha256').update(bytes).digest('hex'),
+        source: sourcePath,
+    };
+}
+//# sourceMappingURL=intake.js.map

package/lib/openapi/intake.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intake.js","sourceRoot":"","sources":["../../src/openapi/intake.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,aAAa,EAAyC,MAAM,MAAM,CAAC;AAEzF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAqBpG,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAmB,OAAe;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,SAAS,oBAAoB,CAC3B,MAAc,EACd,UAAwC,EACxC,WAAwB;IAExB,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACrC,MAAM,QAAQ,GACZ,QAAQ,KAAK,SAAS;QACpB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAC,GAAG,EAAE;YACJ,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpD,OAAO,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;QAC3B,CAAC,CAAC,EAAE,CAAC;IACX,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5D,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;AAC7F,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa,EAAE,SAAiB;IAC1D,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,kBAAkB,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAAC,yCAAyC,SAAS,EAAE,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAa,EAAE,SAAiB;IACjE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,kBAAkB,CAC1B,0DAA0D,SAAS,EAAE,CACtE,CAAC;IACJ,CAAC;IACD,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,kBAAkB,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,MAAM,GAAG,SAAS;SACrB,KAAK,CAAC,CAAC,CAAC;SACR,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;IACxD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACtE,MAAM,IAAI,kBAAkB,CAC1B,2BAA2B,SAAS,eAAe,KAAK,GAAG,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAC1F,CAAC;YACJ,CAAC;YACD,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YAC9D,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,kBAAkB,CAC1B,2BAA2B,SAAS,eAAe,KAAK,GAAG,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAC1F,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,IAAa;IACjC,MAAM,cAAc,GAAG,IAAI,OAAO,EAAU,CAAC;IAC7C,MAAM,YAAY,GAAG,IAAI,GAAG,EAAmB,CAAC;IAChD,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,QAA6B,EAAQ,EAAE;QACpE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO;YACtC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC1B,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAChD,OAAO;QACT,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAC7B,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO;QACtC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE1B,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;QAC7B,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5D,MAAM,IAAI,kBAAkB,CAAC,iCAAiC,CAAC,CAAC;YAClE,CAAC;YACD,QAAQ,IAAI,CAAC,CAAC;YACd,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC;gBACxC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC;gBAC7B,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACxC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,GAAG,KAAK,MAAM;gBAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC,CAAC;IAEF,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IACvB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,kBAAkB,CAAC,IAA6B;IACvD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAC1B,oCAAoC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CACnE,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,sBAAsB,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACzF,MAAM,IAAI,kBAAkB,CAAC,sDAAsD,CAAC,CAAC;IACvF,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,kBAAkB,CAAC,iCAAiC,CAAC,CAAC;IAE3F,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IACvC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,MAAM,UAAU,GAAuB,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,kBAAkB,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;QACzF,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,kBAAkB,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;QAC9F,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAAE,SAAS;YACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACtB,MAAM,IAAI,kBAAkB,CAAC,gCAAgC,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC;YACjF,IAAI,OAAO,SAAS,CAAC,WAAW,KAAK,QAAQ,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACrF,MAAM,IAAI,kBAAkB,CAAC,wBAAwB,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;YACvF,CAAC;YACD,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YACjD,MAAM,QAAQ,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;YACnD,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC1B,MAAM,IAAI,kBAAkB,CAAC,iCAAiC,QAAQ,EAAE,CAAC,CAAC;YAC5E,IAAI,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC;gBAC/B,MAAM,IAAI,kBAAkB,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAC;YACxE,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACzB,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC9B,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC,QAAQ,CACxB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAChG,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAkB;IACpD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QAC3B,MAAM,IAAI,kBAAkB,CAAC,GAAG,UAAU,0BAA0B,CAAC,CAAC;IAExE,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,EAAE;QACvC,UAAU,EAAE,EAAE;QACd,WAAW;QACX,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvE,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,kBAAkB,CAC1B,WAAW;aACR,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,oBAAoB,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;aAC9E,IAAI,CAAC,IAAI,CAAC,CACd,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAY,YAAY,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;IACpE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,MAAM,IAAI,kBAAkB,CAAC,yCAAyC,CAAC,CAAC;IACjG,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAExC,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,UAAU;QAC1B,QAAQ,EAAE,QAAwC;QAClD,cAAc,EAAE,UAAU,CAAC,MAAM;QACjC,UAAU;QACV,QAAQ;QACR,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;QACxD,MAAM,EAAE,UAAU;KACnB,CAAC;AACJ,CAAC"}

package/lib/openapi/selected.d.ts

@@ -0,0 +1,11 @@
+export type SelectedOperationConfig = {
+    localKey: string;
+    operationId: string;
+};
+export declare const SELECTED_OPERATION_CONFIG: readonly SelectedOperationConfig[];
+export declare const DEFERRED_STAGE_1_CAPABILITIES: {
+    readonly 'content.list': "No bounded unfiltered enhanced-workspace content enumeration is evidenced.";
+    readonly 'delivery.get': "Delivery is not clearly required for the Stage 1 workspace, channel, content, and variant read slice.";
+    readonly 'delivery.media.get': "Media delivery is not clearly required for the Stage 1 read slice.";
+    readonly 'variant.list': "No independent or stable embedded variant collection is evidenced.";
+};

package/lib/openapi/selected.js

@@ -0,0 +1,49 @@
+export const SELECTED_OPERATION_CONFIG = [
+    {
+        localKey: 'channel.get',
+        operationId: 'getManagedContentChannel',
+    },
+    {
+        localKey: 'content.create',
+        operationId: 'postManagedContentDocumentCreate',
+    },
+    {
+        localKey: 'content.get',
+        operationId: 'getManagedContentDocument',
+    },
+    {
+        localKey: 'variant.create',
+        operationId: 'postManagedContentVariantCreate',
+    },
+    {
+        localKey: 'variant.delete',
+        operationId: 'deleteManagedContentVariant',
+    },
+    {
+        localKey: 'variant.get',
+        operationId: 'getManagedContentVariant',
+    },
+    {
+        localKey: 'workspace.channel.list',
+        operationId: 'getManagedContentSpaceChannels',
+    },
+    {
+        localKey: 'workspace.get',
+        operationId: 'getManagedContentSpace',
+    },
+    {
+        localKey: 'workspace.list',
+        operationId: 'getManagedContentSpaceCollection',
+    },
+    {
+        localKey: 'workspace.variant.search',
+        operationId: 'getManagedContentSearchItems',
+    },
+];
+export const DEFERRED_STAGE_1_CAPABILITIES = {
+    'content.list': 'No bounded unfiltered enhanced-workspace content enumeration is evidenced.',
+    'delivery.get': 'Delivery is not clearly required for the Stage 1 workspace, channel, content, and variant read slice.',
+    'delivery.media.get': 'Media delivery is not clearly required for the Stage 1 read slice.',
+    'variant.list': 'No independent or stable embedded variant collection is evidenced.',
+};
+//# sourceMappingURL=selected.js.map

package/lib/openapi/selected.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selected.js","sourceRoot":"","sources":["../../src/openapi/selected.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,yBAAyB,GAAuC;IAC3E;QACE,QAAQ,EAAE,aAAa;QACvB,WAAW,EAAE,0BAA0B;KACxC;IACD;QACE,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,kCAAkC;KAChD;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,WAAW,EAAE,2BAA2B;KACzC;IACD;QACE,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,iCAAiC;KAC/C;IACD;QACE,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,6BAA6B;KAC3C;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,WAAW,EAAE,0BAA0B;KACxC;IACD;QACE,QAAQ,EAAE,wBAAwB;QAClC,WAAW,EAAE,gCAAgC;KAC9C;IACD;QACE,QAAQ,EAAE,eAAe;QACzB,WAAW,EAAE,wBAAwB;KACtC;IACD;QACE,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,kCAAkC;KAChD;IACD;QACE,QAAQ,EAAE,0BAA0B;QACpC,WAAW,EAAE,8BAA8B;KAC5C;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,cAAc,EAAE,4EAA4E;IAC5F,cAAc,EACZ,uGAAuG;IACzG,oBAAoB,EAAE,oEAAoE;IAC1F,cAAc,EAAE,oEAAoE;CAC5E,CAAC"}

package/lib/services/export-workspace.d.ts

@@ -0,0 +1,37 @@
+import type { Connection } from '@salesforce/core';
+import { type JsonRequestOptions } from '../transport/json-request.js';
+export type WorkspaceExportWarning = {
+    code: 'COUNT_MISMATCH' | 'DETAIL_FAILED' | 'DUPLICATE_VARIANTS' | 'OWNERSHIP_MISMATCH' | 'PREMATURE_EMPTY_PAGE' | 'UNSUPPORTED_WILDCARD';
+    message: string;
+    variantIds?: string[];
+};
+export type WorkspaceExportEntry = {
+    file: string;
+    variantId: string;
+};
+export type WorkspaceExportManifest = {
+    schemaVersion: 1;
+    mode: 'experimental-best-effort';
+    workspaceId: string;
+    search: {
+        contentSpaceOrFolderIds: [string];
+        languages: ['All'];
+        pageSize: 250;
+        queryTerm: '*';
+    };
+    expectedCount: number;
+    foundCount: number;
+    exportedCount: number;
+    pagesRequested: number;
+    entries: WorkspaceExportEntry[];
+    rejectedVariantIds: string[];
+    failedVariantIds: string[];
+    warnings: WorkspaceExportWarning[];
+};
+export type ExportWorkspaceResult = {
+    destination: string;
+    manifest: WorkspaceExportManifest;
+};
+type RequestConnection = Pick<Connection, 'request'>;
+export declare function exportWorkspace(connection: RequestConnection, workspaceId: string, destination: string, options?: JsonRequestOptions): Promise<ExportWorkspaceResult>;
+export {};

package/lib/services/export-workspace.js

@@ -0,0 +1,214 @@
+import { mkdir, open, rename, rm, stat } from 'node:fs/promises';
+import path from 'node:path';
+import { getSelectedOperation, requestJson, } from '../transport/json-request.js';
+import { getVariant } from './read.js';
+const PAGE_SIZE = 250;
+const ABSOLUTE_PAGE_CAP = 1000;
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function nonemptyString(value) {
+    return typeof value === 'string' && value.length > 0;
+}
+function responseItems(value) {
+    return isRecord(value) && Array.isArray(value.items) ? value.items : [];
+}
+function responseCount(value) {
+    if (!isRecord(value))
+        return 0;
+    for (const key of ['total', 'totalCount', 'count']) {
+        const count = value[key];
+        if (typeof count === 'number' && Number.isInteger(count) && count >= 0)
+            return count;
+    }
+    return 0;
+}
+function searchRow(value) {
+    if (!isRecord(value))
+        return undefined;
+    return value.type === 'ManagedContentVariantSearchResultRepresentation' &&
+        nonemptyString(value.id) &&
+        nonemptyString(value.managedContentSpaceId)
+        ? { id: value.id, managedContentSpaceId: value.managedContentSpaceId }
+        : undefined;
+}
+function detailWorkspaceId(detail) {
+    const contentSpace = detail.contentSpace;
+    return isRecord(contentSpace) && nonemptyString(contentSpace.id) ? contentSpace.id : undefined;
+}
+function jsonBytes(value) {
+    return `${JSON.stringify(value, null, 2)}\n`;
+}
+async function exists(path) {
+    try {
+        await stat(path);
+        return true;
+    }
+    catch (error) {
+        if (isRecord(error) && error.code === 'ENOENT')
+            return false;
+        throw error;
+    }
+}
+async function writeExclusive(path, value) {
+    const handle = await open(path, 'wx');
+    try {
+        await handle.writeFile(jsonBytes(value), 'utf8');
+    }
+    finally {
+        await handle.close();
+    }
+}
+export async function exportWorkspace(connection, workspaceId, destination, options = {}) {
+    if (!nonemptyString(workspaceId))
+        throw new TypeError('workspaceId must be a nonempty string');
+    if (!nonemptyString(destination))
+        throw new TypeError('destination must be a nonempty string');
+    if (await exists(destination))
+        throw new Error(`Export destination already exists: ${destination}`);
+    const warnings = [
+        {
+            code: 'UNSUPPORTED_WILDCARD',
+            message: 'Wildcard search is unsupported and this export is experimental best-effort.',
+        },
+    ];
+    const rejected = new Set();
+    const ownershipMismatchIds = new Set();
+    const duplicateIds = new Set();
+    const candidates = new Map();
+    let expectedCount = 0;
+    let pagesRequested = 0;
+    let page = 0;
+    let pageLimit = 1;
+    while (page < pageLimit) {
+        const response = await requestJson(connection, getSelectedOperation('workspace.variant.search'), {
+            query: {
+                contentSpaceOrFolderIds: [workspaceId],
+                languages: ['All'],
+                page,
+                pageSize: PAGE_SIZE,
+                queryTerm: '*',
+            },
+        }, options);
+        pagesRequested += 1;
+        const items = responseItems(response.data);
+        if (page === 0) {
+            expectedCount = responseCount(response.data);
+            pageLimit = Math.min(ABSOLUTE_PAGE_CAP, Math.max(1, Math.ceil(expectedCount / PAGE_SIZE) + 2));
+        }
+        let additions = 0;
+        for (const item of items) {
+            const row = searchRow(item);
+            if (!row)
+                continue;
+            if (row.managedContentSpaceId !== workspaceId) {
+                rejected.add(row.id);
+                ownershipMismatchIds.add(row.id);
+                continue;
+            }
+            if (candidates.has(row.id)) {
+                duplicateIds.add(row.id);
+            }
+            else {
+                candidates.set(row.id, row);
+                additions += 1;
+            }
+        }
+        if (candidates.size >= expectedCount)
+            break;
+        if (items.length === 0) {
+            if (candidates.size < expectedCount) {
+                warnings.push({
+                    code: 'PREMATURE_EMPTY_PAGE',
+                    message: `Search returned an empty page before the advertised count was satisfied.`,
+                });
+            }
+            break;
+        }
+        if (additions === 0)
+            break;
+        page += 1;
+    }
+    if (duplicateIds.size > 0) {
+        warnings.push({
+            code: 'DUPLICATE_VARIANTS',
+            message: 'Duplicate variant IDs were ignored.',
+            variantIds: [...duplicateIds].toSorted(),
+        });
+    }
+    if (candidates.size !== expectedCount) {
+        warnings.push({
+            code: 'COUNT_MISMATCH',
+            message: `Advertised ${expectedCount} variants but found ${candidates.size}.`,
+        });
+    }
+    const details = new Map();
+    const failedIds = [];
+    for (const variantId of [...candidates.keys()].toSorted()) {
+        try {
+            const detail = await getVariant(connection, variantId, options);
+            if (detailWorkspaceId(detail) === workspaceId) {
+                details.set(variantId, detail);
+            }
+            else {
+                rejected.add(variantId);
+                ownershipMismatchIds.add(variantId);
+            }
+        }
+        catch {
+            failedIds.push(variantId);
+            warnings.push({
+                code: 'DETAIL_FAILED',
+                message: `Variant detail request failed for ${variantId}.`,
+                variantIds: [variantId],
+            });
+        }
+    }
+    if (ownershipMismatchIds.size > 0) {
+        warnings.push({
+            code: 'OWNERSHIP_MISMATCH',
+            message: 'Variants outside the requested workspace were rejected.',
+            variantIds: [...ownershipMismatchIds].toSorted(),
+        });
+    }
+    const entries = [...details.keys()].toSorted().map((variantId) => ({
+        file: `items/${variantId}.json`,
+        variantId,
+    }));
+    const manifest = {
+        schemaVersion: 1,
+        mode: 'experimental-best-effort',
+        workspaceId,
+        search: {
+            contentSpaceOrFolderIds: [workspaceId],
+            languages: ['All'],
+            pageSize: PAGE_SIZE,
+            queryTerm: '*',
+        },
+        expectedCount,
+        foundCount: candidates.size,
+        exportedCount: entries.length,
+        pagesRequested,
+        entries,
+        rejectedVariantIds: [...rejected].toSorted(),
+        failedVariantIds: failedIds.toSorted(),
+        warnings,
+    };
+    const parent = path.dirname(destination);
+    const temporary = path.join(parent, `.${path.basename(destination)}.tmp-${process.pid}-${Date.now()}`);
+    try {
+        await mkdir(temporary);
+        await mkdir(path.join(temporary, 'items'));
+        for (const entry of entries) {
+            await writeExclusive(path.join(temporary, entry.file), details.get(entry.variantId));
+        }
+        await writeExclusive(path.join(temporary, 'manifest.json'), manifest);
+        await rename(temporary, destination);
+    }
+    catch (error) {
+        await rm(temporary, { force: true, recursive: true });
+        throw error;
+    }
+    return { destination, manifest };
+}
+//# sourceMappingURL=export-workspace.js.map

package/lib/services/export-workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-workspace.js","sourceRoot":"","sources":["../../src/services/export-workspace.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EACL,oBAAoB,EACpB,WAAW,GAEZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD,MAAM,SAAS,GAAG,GAAG,CAAC;AACtB,MAAM,iBAAiB,GAAG,IAAI,CAAC;AA+C/B,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1E,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,CAAC;QACnD,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;IACvF,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACvC,OAAO,KAAK,CAAC,IAAI,KAAK,iDAAiD;QACrE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,cAAc,CAAC,KAAK,CAAC,qBAAqB,CAAC;QAC3C,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,qBAAqB,EAAE,KAAK,CAAC,qBAAqB,EAAE;QACtE,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAiB;IAC1C,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IACzC,OAAO,QAAQ,CAAC,YAAY,CAAC,IAAI,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACjG,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7D,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,KAAc;IACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,UAA6B,EAC7B,WAAmB,EACnB,WAAmB,EACnB,UAA8B,EAAE;IAEhC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;QAAE,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;IAC/F,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;QAAE,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;IAC/F,IAAI,MAAM,MAAM,CAAC,WAAW,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,sCAAsC,WAAW,EAAE,CAAC,CAAC;IAEvE,MAAM,QAAQ,GAA6B;QACzC;YACE,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EAAE,6EAA6E;SACvF;KACF,CAAC;IACF,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/C,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IACvC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAqB,CAAC;IAChD,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,OAAO,IAAI,GAAG,SAAS,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAChC,UAAU,EACV,oBAAoB,CAAC,0BAA0B,CAAC,EAChD;YACE,KAAK,EAAE;gBACL,uBAAuB,EAAE,CAAC,WAAW,CAAC;gBACtC,SAAS,EAAE,CAAC,KAAK,CAAC;gBAClB,IAAI;gBACJ,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,GAAG;aACf;SACF,EACD,OAAO,CACR,CAAC;QACF,cAAc,IAAI,CAAC,CAAC;QACpB,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;YACf,aAAa,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7C,SAAS,GAAG,IAAI,CAAC,GAAG,CAClB,iBAAiB,EACjB,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CACtD,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,IAAI,GAAG,CAAC,qBAAqB,KAAK,WAAW,EAAE,CAAC;gBAC9C,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACrB,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;YACD,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC3B,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;gBAC5B,SAAS,IAAI,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,IAAI,aAAa;YAAE,MAAM;QAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,IAAI,UAAU,CAAC,IAAI,GAAG,aAAa,EAAE,CAAC;gBACpC,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,sBAAsB;oBAC5B,OAAO,EAAE,0EAA0E;iBACpF,CAAC,CAAC;YACL,CAAC;YACD,MAAM;QACR,CAAC;QACD,IAAI,SAAS,KAAK,CAAC;YAAE,MAAM;QAC3B,IAAI,IAAI,CAAC,CAAC;IACZ,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAC1B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,qCAAqC;YAC9C,UAAU,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,QAAQ,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACtC,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,cAAc,aAAa,uBAAuB,UAAU,CAAC,IAAI,GAAG;SAC9E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC7C,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,KAAK,MAAM,SAAS,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC1D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAChE,IAAI,iBAAiB,CAAC,MAAM,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC9C,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACxB,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,qCAAqC,SAAS,GAAG;gBAC1D,UAAU,EAAE,CAAC,SAAS,CAAC;aACxB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,oBAAoB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAClC,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,yDAAyD;YAClE,UAAU,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,QAAQ,EAAE;SACjD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACjE,IAAI,EAAE,SAAS,SAAS,OAAO;QAC/B,SAAS;KACV,CAAC,CAAC,CAAC;IACJ,MAAM,QAAQ,GAA4B;QACxC,aAAa,EAAE,CAAC;QAChB,IAAI,EAAE,0BAA0B;QAChC,WAAW;QACX,MAAM,EAAE;YACN,uBAAuB,EAAE,CAAC,WAAW,CAAC;YACtC,SAAS,EAAE,CAAC,KAAK,CAAC;YAClB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,GAAG;SACf;QACD,aAAa;QACb,UAAU,EAAE,UAAU,CAAC,IAAI;QAC3B,aAAa,EAAE,OAAO,CAAC,MAAM;QAC7B,cAAc;QACd,OAAO;QACP,kBAAkB,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE;QAC5C,gBAAgB,EAAE,SAAS,CAAC,QAAQ,EAAE;QACtC,QAAQ;KACT,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CACzB,MAAM,EACN,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAClE,CAAC;IACF,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;QACvB,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAC3C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC;QACtE,MAAM,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;AACnC,CAAC"}

package/lib/services/import-workspace.d.ts

@@ -0,0 +1,112 @@
+import type { Connection } from '@salesforce/core';
+import type { JsonRequestOptions } from '../transport/json-request.js';
+import type { WorkspaceExportManifest } from './export-workspace.js';
+type RequestConnection = Pick<Connection, 'request'>;
+type JsonObject = {
+    readonly [key: string]: JsonValue;
+};
+type JsonValue = boolean | JsonObject | readonly JsonValue[] | null | number | string;
+export type WorkspaceImportItem = JsonObject & {
+    readonly apiName?: string;
+    readonly contentBody: JsonObject;
+    readonly contentKey: string;
+    readonly contentSpace: JsonObject & {
+        readonly id: string;
+    };
+    readonly contentType: string;
+    readonly externalId?: string;
+    readonly externalSource?: JsonObject;
+    readonly id: string;
+    readonly language: string;
+    readonly title: string;
+    readonly urlName?: string;
+};
+export type LoadedWorkspaceExport = {
+    readonly isPartial: boolean;
+    readonly items: readonly WorkspaceImportItem[];
+    readonly manifest: WorkspaceExportManifest;
+    readonly manifestSha256: string;
+    readonly sourceDirectory: string;
+};
+export type DestinationWorkspace = JsonObject & {
+    readonly defaultLanguage: string;
+    readonly id: string;
+    readonly rootFolderId: string;
+};
+export type WorkspaceImportGroupPlan = {
+    readonly contentKey: string;
+    readonly primary: WorkspaceImportItem;
+    readonly variants: readonly WorkspaceImportItem[];
+};
+export type WorkspaceImportPlan = {
+    readonly destinationWorkspaceId: string;
+    readonly groups: readonly WorkspaceImportGroupPlan[];
+    readonly rootFolderId: string;
+    readonly source: LoadedWorkspaceExport;
+};
+export type CreatedParentRecord = {
+    readonly childVariantIds: string[];
+    readonly contentId: string;
+    readonly contentKey: string;
+    readonly primaryVariantId: string;
+};
+export type WorkspaceImportOperation = {
+    readonly contentKey: string;
+    readonly destinationOrgId: string;
+    readonly destinationWorkspaceId: string;
+    readonly language: string;
+    readonly operationId: string;
+    readonly operationKind: 'create-parent' | 'create-child';
+    readonly requestIdentity: string;
+    readonly requestSha256: string;
+    readonly runId: string;
+    error?: string;
+    result?: {
+        readonly contentId?: string;
+        readonly primaryVariantId?: string;
+        readonly variantId?: string;
+    };
+    state: 'pending' | 'succeeded' | 'failed';
+};
+export type WorkspaceImportRunReport = {
+    readonly createdParents: CreatedParentRecord[];
+    readonly destinationOrgId: string;
+    readonly destinationWorkspaceId: string;
+    readonly operations: WorkspaceImportOperation[];
+    readonly runId: string;
+    readonly sourceDirectory: string;
+    readonly sourceManifestSha256: string;
+    state: 'applying' | 'completed' | 'failed' | 'ownership-uncertain';
+};
+export declare class WorkspaceImportOwnershipUncertainError extends Error {
+    readonly operation: WorkspaceImportOperation;
+    readonly state: "ownership-uncertain";
+    constructor(operation: WorkspaceImportOperation, cause: unknown);
+}
+export type WorkspaceImportReportPersistence = {
+    readonly rewrite: (file: string, report: WorkspaceImportRunReport) => Promise<void>;
+};
+export type ExecuteWorkspaceImportOptions = {
+    readonly allowPartial?: boolean;
+    readonly connection: RequestConnection;
+    readonly destinationOrgId: string;
+    readonly destinationWorkspace: unknown;
+    readonly dryRun?: boolean;
+    readonly reportDirectory?: string;
+    readonly reportPersistence?: WorkspaceImportReportPersistence;
+    readonly requestOptions?: JsonRequestOptions;
+    readonly sourceDirectory: string;
+    readonly workspaceId: string;
+};
+export type WorkspaceImportResult = {
+    readonly dryRun: boolean;
+    readonly plan: WorkspaceImportPlan;
+    readonly report?: WorkspaceImportRunReport;
+    readonly reportFile?: string;
+};
+export declare function loadWorkspaceExport(sourceDirectory: string, options?: {
+    readonly allowPartial?: boolean;
+}): Promise<LoadedWorkspaceExport>;
+export declare function planWorkspaceImport(source: LoadedWorkspaceExport, workspace: unknown, expectedWorkspaceId: string): WorkspaceImportPlan;
+export declare function executeWorkspaceImport(options: ExecuteWorkspaceImportOptions): Promise<WorkspaceImportResult>;
+export {};