@sitecoreai-labs/sitecoreai-cli 0.0.4 → 0.1.0

package/dist/brand/documents/upload.d.ts

@@ -0,0 +1,113 @@
+import type { BrandApiClientOptions } from "../api/client";
+/**
+ * Base path for the Brand Documents API. Same edge host as the
+ * Brand Management / Brand Review APIs.
+ */
+export declare const DOCUMENTS_BASE_PATH = "/stream/ai-document-api";
+export interface DocumentUploadReference {
+    /** Reference type — always `"brandkit"` for kit-bound docs. */
+    type: "brandkit";
+    /** UUID of the target brand kit. */
+    id: string;
+    /** Canonical brand kit references path. */
+    path: string;
+}
+export type UploadDocumentSource = {
+    kind: "url";
+    url: string;
+} | {
+    kind: "bytes";
+    bytes: Buffer | Uint8Array;
+    mimeType?: string;
+};
+/**
+ * Why local-file (`bytes`) upload is rejected. The documents API
+ * offers two routes for a local file and neither works:
+ *
+ *   - The documented v2 `multipart/form-data` `file` part is
+ *     server-broken — the parser drops the sibling `create_request`
+ *     part whenever a `file` part is present and returns
+ *     `400 create_request: Field required`.
+ *   - A `data:<mime>;base64,…` value in the `url` field is accepted
+ *     at POST time (201) but the server never fetches it, so the doc
+ *     stays at `numberOfPages: 0` and never processes.
+ *
+ * Both reproduced empirically against the Agents tenant 2026-05-15
+ * (`scripts/_smoke-brand-upload-modes.ts`). Until Sitecore exposes a
+ * working local-upload path, callers must host the file and use URL
+ * mode.
+ */
+export declare const LOCAL_UPLOAD_UNSUPPORTED_MESSAGE = "Local-file document upload is not supported \u2014 the Sitecore documents API has no working path for it.";
+export declare const LOCAL_UPLOAD_UNSUPPORTED_HINT = "Host the PDF at an HTTPS URL that Sitecore's edge can reach (S3, GitHub raw, a CDN), then upload it by URL \u2014 `--url <pdfUrl>` on the CLI, or the `url` field on the MCP tool.";
+export interface UploadDocumentOptions {
+    client: BrandApiClientOptions;
+    /** Brand kit UUID to attach the document to. */
+    brandKitId: string;
+    /**
+     * Source of the document. Only URL mode works:
+     *
+     *   - `{ kind: "url", url }` — Sitecore fetches the file from the
+     *     URL and copies it into MMS. The URL must be an HTTP(S)
+     *     address reachable from Sitecore's edge.
+     *   - `{ kind: "bytes", … }` — local-file upload. **Not supported**
+     *     — `uploadDocument` rejects it with `INPUT_INVALID`. See
+     *     {@link LOCAL_UPLOAD_UNSUPPORTED_MESSAGE} for why.
+     *
+     * The string form `{ url }` is shorthand for `{ kind: "url", url }`.
+     */
+    source: UploadDocumentSource | {
+        url: string;
+    };
+    /** Document type tag, e.g. "brand guidelines". */
+    type?: string;
+    /**
+     * Document MIME type, e.g. "application/pdf". The working Sync kit
+     * docs use the full MIME (not labels like "PDF").
+     */
+    fileType?: string;
+    /** Display title; if `setMetadata: true` the server may overwrite. */
+    title?: string;
+    /** Brief description. */
+    summary?: string;
+    /** Tags. The server rejects null — defaults to []. */
+    tags?: string[];
+    /**
+     * Whether the server should auto-fill metadata (page count, etc.)
+     * from the fetched file. Defaults to true.
+     */
+    setMetadata?: boolean;
+    signal?: AbortSignal;
+}
+export interface UploadedDocument {
+    id: string;
+    organizationId?: string;
+    status?: string;
+    /** Sitecore MMS URL the file got copied to (when copying happens). */
+    url?: string;
+    fileId?: string;
+    type?: string;
+    fileType?: string;
+    brandkitId?: string;
+    references?: Array<{
+        id: string;
+        path: string;
+        type: string;
+    }>;
+    [extra: string]: unknown;
+}
+/**
+ * Upload a brand document to the Sitecore Brand Documents API and
+ * attach it to a specific brand kit.
+ *
+ * **URL mode only.** The server fetches the file from `url` and copies
+ * it to Sitecore MMS asynchronously, so the `url` must be an HTTP(S)
+ * address reachable from Sitecore's edge. Local-file (`bytes`) uploads
+ * are rejected up front — see {@link LOCAL_UPLOAD_UNSUPPORTED_MESSAGE}.
+ *
+ * **Wire shape:** v2 endpoint, `application/x-www-form-urlencoded`, a
+ * single `create_request` form parameter whose value is a JSON string
+ * carrying `url`, `tags`, `references`, and metadata fields. The
+ * documented `multipart/form-data` `file` part is server-broken; the
+ * form-urlencoded path is what returns 201 with references populated.
+ */
+export declare const uploadDocument: (options: UploadDocumentOptions) => Promise<UploadedDocument>;

package/dist/brand/documents/upload.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadDocument = exports.LOCAL_UPLOAD_UNSUPPORTED_HINT = exports.LOCAL_UPLOAD_UNSUPPORTED_MESSAGE = exports.DOCUMENTS_BASE_PATH = void 0;
+const errors_1 = require("../../shared/errors");
+const keychain_1 = require("../../shared/keychain");
+const auth_1 = require("../api/auth");
+const types_1 = require("../api/types");
+/**
+ * Base path for the Brand Documents API. Same edge host as the
+ * Brand Management / Brand Review APIs.
+ */
+exports.DOCUMENTS_BASE_PATH = "/stream/ai-document-api";
+/**
+ * Why local-file (`bytes`) upload is rejected. The documents API
+ * offers two routes for a local file and neither works:
+ *
+ *   - The documented v2 `multipart/form-data` `file` part is
+ *     server-broken — the parser drops the sibling `create_request`
+ *     part whenever a `file` part is present and returns
+ *     `400 create_request: Field required`.
+ *   - A `data:<mime>;base64,…` value in the `url` field is accepted
+ *     at POST time (201) but the server never fetches it, so the doc
+ *     stays at `numberOfPages: 0` and never processes.
+ *
+ * Both reproduced empirically against the Agents tenant 2026-05-15
+ * (`scripts/_smoke-brand-upload-modes.ts`). Until Sitecore exposes a
+ * working local-upload path, callers must host the file and use URL
+ * mode.
+ */
+exports.LOCAL_UPLOAD_UNSUPPORTED_MESSAGE = "Local-file document upload is not supported — the Sitecore documents API has no working path for it.";
+exports.LOCAL_UPLOAD_UNSUPPORTED_HINT = "Host the PDF at an HTTPS URL that Sitecore's edge can reach (S3, GitHub raw, a CDN), then upload it by URL — `--url <pdfUrl>` on the CLI, or the `url` field on the MCP tool.";
+const buildReferencePath = (orgId, brandKitId) => `/api/brands/v1/organizations/${orgId}/brandkits/${brandKitId}/references`;
+/**
+ * Upload a brand document to the Sitecore Brand Documents API and
+ * attach it to a specific brand kit.
+ *
+ * **URL mode only.** The server fetches the file from `url` and copies
+ * it to Sitecore MMS asynchronously, so the `url` must be an HTTP(S)
+ * address reachable from Sitecore's edge. Local-file (`bytes`) uploads
+ * are rejected up front — see {@link LOCAL_UPLOAD_UNSUPPORTED_MESSAGE}.
+ *
+ * **Wire shape:** v2 endpoint, `application/x-www-form-urlencoded`, a
+ * single `create_request` form parameter whose value is a JSON string
+ * carrying `url`, `tags`, `references`, and metadata fields. The
+ * documented `multipart/form-data` `file` part is server-broken; the
+ * form-urlencoded path is what returns 201 with references populated.
+ */
+const uploadDocument = async (options) => {
+    const source = "kind" in options.source ? options.source : { kind: "url", url: options.source.url };
+    if (source.kind === "bytes") {
+        throw (0, errors_1.createScaiError)(exports.LOCAL_UPLOAD_UNSUPPORTED_MESSAGE, "INPUT_INVALID", {
+            hint: exports.LOCAL_UPLOAD_UNSUPPORTED_HINT,
+        });
+    }
+    const host = options.client.host ?? types_1.BRAND_API_HOST;
+    const url = new URL(`${exports.DOCUMENTS_BASE_PATH}/api/documents/v2/organizations/${options.client.orgId}/documents`, host).toString();
+    const createRequestJson = JSON.stringify({
+        url: source.url,
+        setMetadata: options.setMetadata ?? true,
+        type: options.type ?? "brand guidelines",
+        fileType: options.fileType ?? "application/pdf",
+        title: options.title,
+        summary: options.summary,
+        tags: options.tags ?? [],
+        references: [
+            {
+                type: "brandkit",
+                id: options.brandKitId,
+                path: buildReferencePath(options.client.orgId, options.brandKitId),
+            },
+        ],
+    });
+    const fire = async (token) => {
+        const body = new URLSearchParams();
+        body.set("create_request", createRequestJson);
+        return fetch(url, {
+            method: "POST",
+            headers: {
+                Authorization: `Bearer ${token}`,
+                Accept: "application/json",
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+            body: body.toString(),
+            signal: options.signal,
+        });
+    };
+    let token = await (0, auth_1.acquireBrandToken)({
+        orgId: options.client.orgId,
+        credential: options.client.credential,
+    });
+    let response = await fire(token);
+    if (response.status === 401) {
+        await (0, keychain_1.clearBrandToken)(options.client.orgId);
+        token = await (0, auth_1.acquireBrandToken)({
+            orgId: options.client.orgId,
+            credential: options.client.credential,
+        });
+        response = await fire(token);
+    }
+    if (!response.ok) {
+        const detail = await response.text();
+        throw (0, errors_1.createScaiError)(`Document upload failed (${response.status}): ${detail || "Unknown error"}`, "BRAND_API_FAILED");
+    }
+    return (await response.json());
+};
+exports.uploadDocument = uploadDocument;

package/dist/brand/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Public library surface for the Sitecore Brand APIs
+ * (Brand Management + Brand Review).
+ *
+ * Exported as `@sitecoreai-labs/sitecoreai-cli/unstable/brand`. Library
+ * callers (SDK consumers, MCP server, tests) construct a
+ * `BrandApiClientOptions` with their org's credential and call the
+ * per-operation primitives directly. The CLI commands and MCP tools sit
+ * on top of these primitives — see [[scai-direct-graphql-own-mcp]] for
+ * the "primitives over compositions" principle this module follows.
+ *
+ * **Status**: UNSTABLE. The Brand APIs are reverse-engineered from
+ * observed traffic; this surface ships under `./unstable/brand` and
+ * carries no SemVer stability promise. Schemas, types, and behavior may
+ * change in any release without a major bump or a changeset.
+ */
+export { BRAND_REQUIRED_SCOPES, acquireBrandToken, extractScopes, hasBrandScopes, type AcquireBrandTokenOptions, } from "./api/auth";
+export { requestBrandApi, type BrandApiClientOptions, type BrandApiRequest } from "./api/client";
+export { BRAND_API_HOST, BRAND_MANAGEMENT_BASE_PATH, BRAND_REVIEW_BASE_PATH, type BrandKitSectionName, type BrandReviewInput, type BrandReviewResult, type BrandReviewScore, type BrandReviewSectionResult, type BrandReviewSelector, } from "./api/types";
+export { generateBrandReview, type GenerateBrandReviewOptions } from "./review/generate";
+export { runBrandLogin, type BrandLoginOptions } from "./tasks/login";
+export { runBrandReview, resolveReviewInputs, detectInputFormat, computeExitCode, type BrandReviewCommandOptions, type BrandReviewRunResult, type BrandReviewFormat, } from "./tasks/review";
+export { scoreToSarifLevel, summarizeOutcomes, type ReviewOutcome, type OutcomeSummary, } from "./review/outcomes";
+export { buildJsonReport, type BrandReviewJsonReport } from "./review/format-json";
+export { buildSarifReport, type SarifReport } from "./review/format-sarif";
+export { buildTextReport, formatTextRow, formatTextSummary } from "./review/format-text";
+export { uploadDocument, DOCUMENTS_BASE_PATH, LOCAL_UPLOAD_UNSUPPORTED_MESSAGE, LOCAL_UPLOAD_UNSUPPORTED_HINT, type UploadDocumentOptions, type UploadDocumentSource, type UploadedDocument, type DocumentUploadReference, } from "./documents/upload";
+export { runBrandIngestionPipeline, runEnrichSectionsPipeline, PIPELINE_BASE_PATH, type RunBrandIngestionOptions, type RunEnrichSectionsOptions, } from "./pipeline/run";
+export { listBrandKits, getBrandKit, type BrandKitSummary, type ListBrandKitsResponse, type ListBrandKitsOptions, type GetBrandKitOptions, } from "./kits/list";
+export { listBrandKitSections, listBrandKitFields, updateBrandKitField, type BrandKitSectionSummary, type BrandKitFieldSummary, type BrandKitFieldType, type BrandKitFieldValue, type BrandKitArrayEntry, type BrandKitRichArrayEntry, type ListBrandKitSectionsOptions, type ListBrandKitFieldsOptions, type UpdateBrandKitFieldOptions, } from "./kits/sections";
+export { createBrandKit, publishBrandKit, deleteBrandKit, type CreateBrandKitOptions, type PublishBrandKitOptions, type DeleteBrandKitOptions, } from "./kits/create";
+export { listDocuments, getDocument, deleteDocument, type DocumentSummary, type ListDocumentsResponse, type ListDocumentsOptions, type GetDocumentOptions, type DeleteDocumentOptions, } from "./documents/list";
+export { seedBrandKit, type SeedBrandKitOptions, type SeedBrandKitResult, type SeedProgressEvent, type SeedStage, } from "./seed";

package/dist/brand/index.js

@@ -0,0 +1,76 @@
+"use strict";
+/**
+ * Public library surface for the Sitecore Brand APIs
+ * (Brand Management + Brand Review).
+ *
+ * Exported as `@sitecoreai-labs/sitecoreai-cli/unstable/brand`. Library
+ * callers (SDK consumers, MCP server, tests) construct a
+ * `BrandApiClientOptions` with their org's credential and call the
+ * per-operation primitives directly. The CLI commands and MCP tools sit
+ * on top of these primitives — see [[scai-direct-graphql-own-mcp]] for
+ * the "primitives over compositions" principle this module follows.
+ *
+ * **Status**: UNSTABLE. The Brand APIs are reverse-engineered from
+ * observed traffic; this surface ships under `./unstable/brand` and
+ * carries no SemVer stability promise. Schemas, types, and behavior may
+ * change in any release without a major bump or a changeset.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.seedBrandKit = exports.deleteDocument = exports.getDocument = exports.listDocuments = exports.deleteBrandKit = exports.publishBrandKit = exports.createBrandKit = exports.updateBrandKitField = exports.listBrandKitFields = exports.listBrandKitSections = exports.getBrandKit = exports.listBrandKits = exports.PIPELINE_BASE_PATH = exports.runEnrichSectionsPipeline = exports.runBrandIngestionPipeline = exports.LOCAL_UPLOAD_UNSUPPORTED_HINT = exports.LOCAL_UPLOAD_UNSUPPORTED_MESSAGE = exports.DOCUMENTS_BASE_PATH = exports.uploadDocument = exports.formatTextSummary = exports.formatTextRow = exports.buildTextReport = exports.buildSarifReport = exports.buildJsonReport = exports.summarizeOutcomes = exports.scoreToSarifLevel = exports.computeExitCode = exports.detectInputFormat = exports.resolveReviewInputs = exports.runBrandReview = exports.runBrandLogin = exports.generateBrandReview = exports.BRAND_REVIEW_BASE_PATH = exports.BRAND_MANAGEMENT_BASE_PATH = exports.BRAND_API_HOST = exports.requestBrandApi = exports.hasBrandScopes = exports.extractScopes = exports.acquireBrandToken = exports.BRAND_REQUIRED_SCOPES = void 0;
+var auth_1 = require("./api/auth");
+Object.defineProperty(exports, "BRAND_REQUIRED_SCOPES", { enumerable: true, get: function () { return auth_1.BRAND_REQUIRED_SCOPES; } });
+Object.defineProperty(exports, "acquireBrandToken", { enumerable: true, get: function () { return auth_1.acquireBrandToken; } });
+Object.defineProperty(exports, "extractScopes", { enumerable: true, get: function () { return auth_1.extractScopes; } });
+Object.defineProperty(exports, "hasBrandScopes", { enumerable: true, get: function () { return auth_1.hasBrandScopes; } });
+var client_1 = require("./api/client");
+Object.defineProperty(exports, "requestBrandApi", { enumerable: true, get: function () { return client_1.requestBrandApi; } });
+var types_1 = require("./api/types");
+Object.defineProperty(exports, "BRAND_API_HOST", { enumerable: true, get: function () { return types_1.BRAND_API_HOST; } });
+Object.defineProperty(exports, "BRAND_MANAGEMENT_BASE_PATH", { enumerable: true, get: function () { return types_1.BRAND_MANAGEMENT_BASE_PATH; } });
+Object.defineProperty(exports, "BRAND_REVIEW_BASE_PATH", { enumerable: true, get: function () { return types_1.BRAND_REVIEW_BASE_PATH; } });
+var generate_1 = require("./review/generate");
+Object.defineProperty(exports, "generateBrandReview", { enumerable: true, get: function () { return generate_1.generateBrandReview; } });
+var login_1 = require("./tasks/login");
+Object.defineProperty(exports, "runBrandLogin", { enumerable: true, get: function () { return login_1.runBrandLogin; } });
+var review_1 = require("./tasks/review");
+Object.defineProperty(exports, "runBrandReview", { enumerable: true, get: function () { return review_1.runBrandReview; } });
+Object.defineProperty(exports, "resolveReviewInputs", { enumerable: true, get: function () { return review_1.resolveReviewInputs; } });
+Object.defineProperty(exports, "detectInputFormat", { enumerable: true, get: function () { return review_1.detectInputFormat; } });
+Object.defineProperty(exports, "computeExitCode", { enumerable: true, get: function () { return review_1.computeExitCode; } });
+var outcomes_1 = require("./review/outcomes");
+Object.defineProperty(exports, "scoreToSarifLevel", { enumerable: true, get: function () { return outcomes_1.scoreToSarifLevel; } });
+Object.defineProperty(exports, "summarizeOutcomes", { enumerable: true, get: function () { return outcomes_1.summarizeOutcomes; } });
+var format_json_1 = require("./review/format-json");
+Object.defineProperty(exports, "buildJsonReport", { enumerable: true, get: function () { return format_json_1.buildJsonReport; } });
+var format_sarif_1 = require("./review/format-sarif");
+Object.defineProperty(exports, "buildSarifReport", { enumerable: true, get: function () { return format_sarif_1.buildSarifReport; } });
+var format_text_1 = require("./review/format-text");
+Object.defineProperty(exports, "buildTextReport", { enumerable: true, get: function () { return format_text_1.buildTextReport; } });
+Object.defineProperty(exports, "formatTextRow", { enumerable: true, get: function () { return format_text_1.formatTextRow; } });
+Object.defineProperty(exports, "formatTextSummary", { enumerable: true, get: function () { return format_text_1.formatTextSummary; } });
+var upload_1 = require("./documents/upload");
+Object.defineProperty(exports, "uploadDocument", { enumerable: true, get: function () { return upload_1.uploadDocument; } });
+Object.defineProperty(exports, "DOCUMENTS_BASE_PATH", { enumerable: true, get: function () { return upload_1.DOCUMENTS_BASE_PATH; } });
+Object.defineProperty(exports, "LOCAL_UPLOAD_UNSUPPORTED_MESSAGE", { enumerable: true, get: function () { return upload_1.LOCAL_UPLOAD_UNSUPPORTED_MESSAGE; } });
+Object.defineProperty(exports, "LOCAL_UPLOAD_UNSUPPORTED_HINT", { enumerable: true, get: function () { return upload_1.LOCAL_UPLOAD_UNSUPPORTED_HINT; } });
+var run_1 = require("./pipeline/run");
+Object.defineProperty(exports, "runBrandIngestionPipeline", { enumerable: true, get: function () { return run_1.runBrandIngestionPipeline; } });
+Object.defineProperty(exports, "runEnrichSectionsPipeline", { enumerable: true, get: function () { return run_1.runEnrichSectionsPipeline; } });
+Object.defineProperty(exports, "PIPELINE_BASE_PATH", { enumerable: true, get: function () { return run_1.PIPELINE_BASE_PATH; } });
+var list_1 = require("./kits/list");
+Object.defineProperty(exports, "listBrandKits", { enumerable: true, get: function () { return list_1.listBrandKits; } });
+Object.defineProperty(exports, "getBrandKit", { enumerable: true, get: function () { return list_1.getBrandKit; } });
+var sections_1 = require("./kits/sections");
+Object.defineProperty(exports, "listBrandKitSections", { enumerable: true, get: function () { return sections_1.listBrandKitSections; } });
+Object.defineProperty(exports, "listBrandKitFields", { enumerable: true, get: function () { return sections_1.listBrandKitFields; } });
+Object.defineProperty(exports, "updateBrandKitField", { enumerable: true, get: function () { return sections_1.updateBrandKitField; } });
+var create_1 = require("./kits/create");
+Object.defineProperty(exports, "createBrandKit", { enumerable: true, get: function () { return create_1.createBrandKit; } });
+Object.defineProperty(exports, "publishBrandKit", { enumerable: true, get: function () { return create_1.publishBrandKit; } });
+Object.defineProperty(exports, "deleteBrandKit", { enumerable: true, get: function () { return create_1.deleteBrandKit; } });
+var list_2 = require("./documents/list");
+Object.defineProperty(exports, "listDocuments", { enumerable: true, get: function () { return list_2.listDocuments; } });
+Object.defineProperty(exports, "getDocument", { enumerable: true, get: function () { return list_2.getDocument; } });
+Object.defineProperty(exports, "deleteDocument", { enumerable: true, get: function () { return list_2.deleteDocument; } });
+var seed_1 = require("./seed");
+Object.defineProperty(exports, "seedBrandKit", { enumerable: true, get: function () { return seed_1.seedBrandKit; } });

package/dist/brand/kits/create.d.ts

@@ -0,0 +1,58 @@
+import { type BrandApiClientOptions } from "../api/client";
+import type { BrandKitSummary } from "./list";
+export interface CreateBrandKitOptions {
+    client: BrandApiClientOptions;
+    /** Display name; required. */
+    name: string;
+    /** Optional human description. */
+    description?: string;
+    /** Industry label (free-form, e.g. "retail", "developer-tools"). */
+    industry?: string;
+    /** Internal brand name (often same as `name`). */
+    brandName?: string;
+    /** Company name if different from brand. */
+    companyName?: string;
+    /** Logo URL — must be a PNG per the OpenAPI. */
+    logo?: string;
+    signal?: AbortSignal;
+}
+/**
+ * Create a new brand kit. New kits land in `status: "draft"` and must
+ * be PATCHed to `published` via `publishBrandKit` before either of
+ * the ingestion pipelines will populate sections — see
+ * [[project-scai-brand-kit-seed-recipe]] for the full sequence.
+ *
+ * Returns the created kit's summary record with its UUID.
+ */
+export declare const createBrandKit: (options: CreateBrandKitOptions) => Promise<BrandKitSummary>;
+export interface PublishBrandKitOptions {
+    client: BrandApiClientOptions;
+    brandKitId: string;
+    signal?: AbortSignal;
+}
+/**
+ * Flip a brand kit's `status` to `"published"`. Required before the
+ * brand ingestion / enrichment pipelines will populate the kit's
+ * sections — leaving a kit in `draft` causes the pipelines to chunk
+ * the source documents but never produce section content (the
+ * symptom: doc `summarized` stays `null` and the kit's section list
+ * stays empty indefinitely).
+ *
+ * Idempotent: PATCHing an already-published kit returns 200 with the
+ * same status.
+ */
+export declare const publishBrandKit: (options: PublishBrandKitOptions) => Promise<BrandKitSummary>;
+export interface DeleteBrandKitOptions {
+    client: BrandApiClientOptions;
+    brandKitId: string;
+    signal?: AbortSignal;
+}
+/**
+ * Delete a brand kit. The endpoint is undocumented in Sitecore's
+ * OpenAPI but the portal UI uses it and it works
+ * (`DELETE /api/brands/v1/.../brandkits/{id}` returns `204`).
+ *
+ * Caveat: this DOES NOT delete the kit's attached documents. Use
+ * `deleteDocument` for cleanup of dangling docs.
+ */
+export declare const deleteBrandKit: (options: DeleteBrandKitOptions) => Promise<void>;

package/dist/brand/kits/create.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteBrandKit = exports.publishBrandKit = exports.createBrandKit = void 0;
+const client_1 = require("../api/client");
+const types_1 = require("../api/types");
+/**
+ * Create a new brand kit. New kits land in `status: "draft"` and must
+ * be PATCHed to `published` via `publishBrandKit` before either of
+ * the ingestion pipelines will populate sections — see
+ * [[project-scai-brand-kit-seed-recipe]] for the full sequence.
+ *
+ * Returns the created kit's summary record with its UUID.
+ */
+const createBrandKit = async (options) => {
+    return (0, client_1.requestBrandApi)(options.client, {
+        basePath: types_1.BRAND_MANAGEMENT_BASE_PATH,
+        path: `/api/brands/v1/organizations/${options.client.orgId}/brandkits`,
+        method: "POST",
+        body: {
+            name: options.name,
+            brandName: options.brandName ?? options.name,
+            description: options.description,
+            industry: options.industry,
+            companyName: options.companyName,
+            logo: options.logo,
+        },
+        signal: options.signal,
+    });
+};
+exports.createBrandKit = createBrandKit;
+/**
+ * Flip a brand kit's `status` to `"published"`. Required before the
+ * brand ingestion / enrichment pipelines will populate the kit's
+ * sections — leaving a kit in `draft` causes the pipelines to chunk
+ * the source documents but never produce section content (the
+ * symptom: doc `summarized` stays `null` and the kit's section list
+ * stays empty indefinitely).
+ *
+ * Idempotent: PATCHing an already-published kit returns 200 with the
+ * same status.
+ */
+const publishBrandKit = async (options) => {
+    return (0, client_1.requestBrandApi)(options.client, {
+        basePath: types_1.BRAND_MANAGEMENT_BASE_PATH,
+        path: `/api/brands/v1/organizations/${options.client.orgId}/brandkits/${options.brandKitId}`,
+        method: "PATCH",
+        body: { status: "published" },
+        signal: options.signal,
+    });
+};
+exports.publishBrandKit = publishBrandKit;
+/**
+ * Delete a brand kit. The endpoint is undocumented in Sitecore's
+ * OpenAPI but the portal UI uses it and it works
+ * (`DELETE /api/brands/v1/.../brandkits/{id}` returns `204`).
+ *
+ * Caveat: this DOES NOT delete the kit's attached documents. Use
+ * `deleteDocument` for cleanup of dangling docs.
+ */
+const deleteBrandKit = async (options) => {
+    await (0, client_1.requestBrandApi)(options.client, {
+        basePath: types_1.BRAND_MANAGEMENT_BASE_PATH,
+        path: `/api/brands/v1/organizations/${options.client.orgId}/brandkits/${options.brandKitId}`,
+        method: "DELETE",
+        signal: options.signal,
+    });
+};
+exports.deleteBrandKit = deleteBrandKit;

package/dist/brand/kits/list.d.ts

@@ -0,0 +1,53 @@
+import { type BrandApiClientOptions } from "../api/client";
+export interface BrandKitSummary {
+    /** Brand kit UUID. */
+    id: string;
+    /** Display name. */
+    name: string;
+    /** Optional internal brand label, often same as `name`. */
+    brandName?: string | null;
+    /** Optional human description. */
+    description?: string | null;
+    /** Industry label. */
+    industry?: string | null;
+    /** Lifecycle state. New kits start `draft`; must be `published` for pipelines. */
+    status?: string;
+    /** Owning organization. */
+    organizationId?: string;
+    createdOn?: string;
+    createdBy?: string;
+    updatedOn?: string;
+    updatedBy?: string;
+    /** Other fields the server returns; surfaced as-is for callers. */
+    [extra: string]: unknown;
+}
+export interface ListBrandKitsResponse {
+    totalCount: number;
+    pageSize?: number;
+    pageNumber?: number;
+    data: BrandKitSummary[];
+}
+export interface ListBrandKitsOptions {
+    client: BrandApiClientOptions;
+    /** 1-based page number; defaults to 1. */
+    pageNumber?: number;
+    /** Items per page; defaults to the server's default (50). */
+    pageSize?: number;
+    signal?: AbortSignal;
+}
+/**
+ * List brand kits in the active organization. Server-paginated; the
+ * defaults (pageNumber=1, pageSize=server-default) cover the common
+ * case. Callers expecting many kits should iterate page numbers.
+ */
+export declare const listBrandKits: (options: ListBrandKitsOptions) => Promise<ListBrandKitsResponse>;
+export interface GetBrandKitOptions {
+    client: BrandApiClientOptions;
+    brandKitId: string;
+    signal?: AbortSignal;
+}
+/**
+ * Retrieve a single brand kit by UUID. Returns the same shape as
+ * `listBrandKits` entries.
+ */
+export declare const getBrandKit: (options: GetBrandKitOptions) => Promise<BrandKitSummary>;

package/dist/brand/kits/list.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBrandKit = exports.listBrandKits = void 0;
+const client_1 = require("../api/client");
+const types_1 = require("../api/types");
+/**
+ * List brand kits in the active organization. Server-paginated; the
+ * defaults (pageNumber=1, pageSize=server-default) cover the common
+ * case. Callers expecting many kits should iterate page numbers.
+ */
+const listBrandKits = async (options) => {
+    return (0, client_1.requestBrandApi)(options.client, {
+        basePath: types_1.BRAND_MANAGEMENT_BASE_PATH,
+        path: `/api/brands/v1/organizations/${options.client.orgId}/brandkits`,
+        method: "GET",
+        query: {
+            pageNumber: options.pageNumber !== undefined ? String(options.pageNumber) : undefined,
+            pageSize: options.pageSize !== undefined ? String(options.pageSize) : undefined,
+        },
+        signal: options.signal,
+    });
+};
+exports.listBrandKits = listBrandKits;
+/**
+ * Retrieve a single brand kit by UUID. Returns the same shape as
+ * `listBrandKits` entries.
+ */
+const getBrandKit = async (options) => {
+    return (0, client_1.requestBrandApi)(options.client, {
+        basePath: types_1.BRAND_MANAGEMENT_BASE_PATH,
+        path: `/api/brands/v1/organizations/${options.client.orgId}/brandkits/${options.brandKitId}`,
+        method: "GET",
+        signal: options.signal,
+    });
+};
+exports.getBrandKit = getBrandKit;