@sitecoreai-labs/sitecoreai-cli 0.0.4

package/dist/sites/api/request.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sitesRequest = void 0;
+const errors_1 = require("../../shared/errors");
+const redact_1 = require("../../shared/redact");
+const request_1 = require("../../deploy/api/common/request");
+const types_1 = require("./types");
+/**
+ * Sites API transport — `sitesRequest()`.
+ *
+ * Mirrors `deployRequest()` from `src/deploy/api/common/request.ts` in
+ * shape: bearer auth, JSON request/response, error mapping that surfaces
+ * Sitecore's structured error bodies. Differences from Deploy:
+ *
+ *  - Different base URL (`xmapps-api.sitecorecloud.io`)
+ *  - Type generics — the path + method + body + response shapes come
+ *    from the OpenAPI codegen output (`schema.d.ts`). Helpers in
+ *    `sites.ts` / `collections.ts` / `languages.ts` pick the right
+ *    operation and pass typed body / response generics through. Each
+ *    operation gets a one-line wrapper; the transport stays generic.
+ *
+ * Errors map to scai's `CliError` — `NETWORK` for transport failures,
+ * `SITES_API_FAILED` for non-2xx responses with a message extracted
+ * from the body when present.
+ */
+const toQueryString = (query) => {
+    if (!query)
+        return "";
+    const params = new URLSearchParams();
+    for (const [key, value] of Object.entries(query)) {
+        if (value === undefined)
+            continue;
+        if (Array.isArray(value)) {
+            for (const entry of value) {
+                params.append(key, String(entry));
+            }
+            continue;
+        }
+        params.set(key, String(value));
+    }
+    const output = params.toString();
+    return output ? `?${output}` : "";
+};
+/**
+ * Generic typed request to the Sites API.
+ *
+ * Helpers parameterise the response type via the `TResponse` generic
+ * — the transport stays untyped on body so each helper can pick its
+ * operation's request body shape from `schema.d.ts`.
+ *
+ * @example
+ *   const sites = await sitesRequest<SitesListResponse>(
+ *     options,
+ *     "/api/v1/sites",
+ *   );
+ *   const created = await sitesRequest<SiteResponse>(
+ *     options,
+ *     "/api/v1/sites",
+ *     { method: "POST", body: { name: "Foo", siteTemplate: "..." } },
+ *   );
+ */
+const sitesRequest = async (options, path, init) => {
+    const baseUrl = options.baseUrl ?? types_1.DEFAULT_SITES_API_BASE;
+    const url = `${baseUrl.replace(/\/$/, "")}${path}${toQueryString(init?.query)}`;
+    const method = init?.method ? init.method.toUpperCase() : "GET";
+    const headers = {
+        Authorization: `Bearer ${options.accessToken}`,
+        Accept: "application/json",
+    };
+    if (init?.headers) {
+        Object.assign(headers, init.headers);
+    }
+    let body;
+    if (init?.body !== undefined) {
+        headers["Content-Type"] = "application/json";
+        body = typeof init.body === "string" ? init.body : JSON.stringify(init.body);
+    }
+    let response;
+    try {
+        response = await fetch(url, { method, headers, body });
+    }
+    catch (error) {
+        throw (0, errors_1.createCliError)((0, redact_1.redactSecrets)(`Sites API request failed: ${error instanceof Error ? error.message : String(error)}`), "NETWORK", { hint: "Check network connectivity or try again later." });
+    }
+    if (!response.ok) {
+        const responseBody = await (0, request_1.parseJsonIfPossible)(response);
+        const message = (0, request_1.extractErrorMessage)(responseBody);
+        const sanitized = message ? (0, redact_1.redactSecrets)(message) : undefined;
+        throw (0, errors_1.createCliError)(sanitized ?? `Sites API request failed (${response.status})`, "SITES_API_FAILED");
+    }
+    // 204 No Content responses (e.g. DELETE) have no body — return
+    // `undefined as TResponse` and let helpers type their return as `void`
+    // or the appropriate result.
+    if (response.status === 204) {
+        return undefined;
+    }
+    return (await (0, request_1.parseJsonIfPossible)(response));
+};
+exports.sitesRequest = sitesRequest;

package/dist/sites/api/sites.d.ts

@@ -0,0 +1,53 @@
+import type { components } from "./schema";
+import type { SitesApiClientOptions } from "./types";
+/**
+ * Sites resource group — the recipe-required subset.
+ *
+ * Async creation note: `createSite` returns a `JobResponse` (a job
+ * handle), not the created site. The Sites API runs site creation
+ * as an async background job; callers poll the job via `getJobStatus`
+ * (in `./jobs.ts`) until completion before reading the new site.
+ * This is a Sites API characteristic — neither the recipe push nor
+ * any callers should assume the site is ready the moment `createSite`
+ * resolves.
+ */
+export type Site = components["schemas"]["Site"];
+export type SiteTemplate = components["schemas"]["SiteTemplate"];
+export type NewSiteInput = components["schemas"]["NewSiteInput"];
+/**
+ * Codegen-typed JobResponse, extended for the runtime shape. The
+ * OpenAPI spec defines only `handle`, but some Sites API deployments
+ * return `jobHandle` instead. Callers must accept either.
+ */
+export type JobResponse = components["schemas"]["JobResponse"] & {
+    /** Runtime-only alias for `handle` returned by some deployments. */
+    jobHandle?: string | null;
+};
+/**
+ * Create a new site from a site template (async).
+ *
+ * Returns a `JobResponse` carrying a job handle; the actual site
+ * creation runs server-side. Poll via `getJobStatus` until the job
+ * completes, then look up the site by name via `listSites`.
+ *
+ * Pass either `collectionId` (existing collection) or
+ * `collectionName` (creates a new collection alongside the site).
+ */
+export declare const createSite: (options: SitesApiClientOptions, input: NewSiteInput) => Promise<JobResponse>;
+/** Retrieve a single site by ID. */
+export declare const retrieveSite: (options: SitesApiClientOptions, siteId: string) => Promise<Site>;
+/** List all sites in the environment. */
+export declare const listSites: (options: SitesApiClientOptions) => Promise<Site[]>;
+/**
+ * Delete a site permanently — removes pages, settings, media,
+ * datasources, presentation elements, dictionaries, components,
+ * variants, and page designs. Async; returns a job handle.
+ */
+export declare const deleteSite: (options: SitesApiClientOptions, siteId: string) => Promise<JobResponse>;
+/**
+ * List site templates available for site creation. Use this to look
+ * up the `templateId` that `createSite` requires when the caller
+ * only knows the template's display name.
+ */
+export declare const listSiteTemplates: (options: SitesApiClientOptions) => Promise<SiteTemplate[]>;
+//# sourceMappingURL=sites.d.ts.map

package/dist/sites/api/sites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sites.d.ts","sourceRoot":"","sources":["../../../src/sites/api/sites.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AACjD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACjE,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACjE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,GAAG;IAC/D,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GACrB,SAAS,qBAAqB,EAC9B,OAAO,YAAY,KAClB,OAAO,CAAC,WAAW,CAIlB,CAAC;AAEL,oCAAoC;AACpC,eAAO,MAAM,YAAY,GAAI,SAAS,qBAAqB,EAAE,QAAQ,MAAM,KAAG,OAAO,CAAC,IAAI,CACd,CAAC;AAE7E,yCAAyC;AACzC,eAAO,MAAM,SAAS,GAAI,SAAS,qBAAqB,KAAG,OAAO,CAAC,IAAI,EAAE,CACzB,CAAC;AAEjD;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,SAAS,qBAAqB,EAAE,QAAQ,MAAM,KAAG,OAAO,CAAC,WAAW,CAG3F,CAAC;AAEL;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,SAAS,qBAAqB,KAAG,OAAO,CAAC,YAAY,EAAE,CACvB,CAAC"}

package/dist/sites/api/sites.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listSiteTemplates = exports.deleteSite = exports.listSites = exports.retrieveSite = exports.createSite = void 0;
+const request_1 = require("./request");
+/**
+ * Create a new site from a site template (async).
+ *
+ * Returns a `JobResponse` carrying a job handle; the actual site
+ * creation runs server-side. Poll via `getJobStatus` until the job
+ * completes, then look up the site by name via `listSites`.
+ *
+ * Pass either `collectionId` (existing collection) or
+ * `collectionName` (creates a new collection alongside the site).
+ */
+const createSite = (options, input) => (0, request_1.sitesRequest)(options, "/api/v1/sites", {
+    method: "POST",
+    body: input,
+});
+exports.createSite = createSite;
+/** Retrieve a single site by ID. */
+const retrieveSite = (options, siteId) => (0, request_1.sitesRequest)(options, `/api/v1/sites/${encodeURIComponent(siteId)}`);
+exports.retrieveSite = retrieveSite;
+/** List all sites in the environment. */
+const listSites = (options) => (0, request_1.sitesRequest)(options, "/api/v1/sites");
+exports.listSites = listSites;
+/**
+ * Delete a site permanently — removes pages, settings, media,
+ * datasources, presentation elements, dictionaries, components,
+ * variants, and page designs. Async; returns a job handle.
+ */
+const deleteSite = (options, siteId) => (0, request_1.sitesRequest)(options, `/api/v1/sites/${encodeURIComponent(siteId)}`, {
+    method: "DELETE",
+});
+exports.deleteSite = deleteSite;
+/**
+ * List site templates available for site creation. Use this to look
+ * up the `templateId` that `createSite` requires when the caller
+ * only knows the template's display name.
+ */
+const listSiteTemplates = (options) => (0, request_1.sitesRequest)(options, "/api/v1/sites/templates");
+exports.listSiteTemplates = listSiteTemplates;

package/dist/sites/api/types.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Public configuration shape for Sites API clients. Mirrors
+ * `DeployApiClientOptions` so callers feel consistent across scai's
+ * API clients — bring your own access token (minted via the shared
+ * OAuth client-credentials helper) and optionally override the base
+ * URL for testing.
+ */
+export type SitesApiClientOptions = {
+    /** Defaults to `https://xmapps-api.sitecorecloud.io`. */
+    baseUrl?: string;
+    /** Bearer token from `auth.sitecorecloud.io` (audience `https://api.sitecorecloud.io`, scope `xmcloud.cm:admin`). */
+    accessToken: string;
+};
+export declare const DEFAULT_SITES_API_BASE = "https://xmapps-api.sitecorecloud.io";
+/**
+ * Per-call options shared by every helper. Mirrors `DeployRequestInit`
+ * (less the body field — request body shape varies per operation and
+ * is typed at the helper level).
+ */
+export type SitesRequestInit = {
+    /** Override the HTTP method. Defaults are baked into each helper. */
+    method?: string;
+    /** Extra headers; merged on top of the default `Authorization` + `Accept`. */
+    headers?: Record<string, string>;
+};
+/** Query-value shape — Sites API operations either take no query params or simple key/value pairs. */
+export type SitesQueryValue = string | number | boolean;
+export type SitesQueryRecord = Record<string, SitesQueryValue | SitesQueryValue[] | undefined>;
+//# sourceMappingURL=types.d.ts.map

package/dist/sites/api/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/sites/api/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qHAAqH;IACrH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,sBAAsB,wCAAwC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,sGAAsG;AACtG,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACxD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,EAAE,GAAG,SAAS,CAAC,CAAC"}

package/dist/sites/api/types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SITES_API_BASE = void 0;
+exports.DEFAULT_SITES_API_BASE = "https://xmapps-api.sitecorecloud.io";

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@sitecoreai-labs/sitecoreai-cli",
+  "version": "0.0.4",
+  "description": "SitecoreAI Deploy & Sync CLI for serialization and deployment workflows",
+  "license": "MIT",
+  "type": "commonjs",
+  "author": "Liz Nelson <liz.nelson@sitecore.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sitecore-studio-labs/sitecoreai-cli.git"
+  },
+  "homepage": "https://github.com/sitecore-studio-labs/sitecoreai-cli",
+  "bugs": {
+    "url": "https://github.com/sitecore-studio-labs/sitecoreai-cli/issues"
+  },
+  "bin": {
+    "sitecoreai-cli": "bin/sitecoreai-cli",
+    "scai": "bin/sitecoreai-cli"
+  },
+  "main": "dist/cli.js",
+  "exports": {
+    ".": "./dist/cli.js",
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "AGENTS.md",
+    "README.md",
+    "package.json",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc && tsc-alias",
+    "changeset": "changeset",
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "dev": "tsx -r tsconfig-paths/register src/cli.ts",
+    "format": "prettier . --write",
+    "format:check": "prettier . --check",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prepack": "npm run build",
+    "prepare": "husky",
+    "release": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc && tsc-alias && changeset publish",
+    "sites:codegen": "openapi-typescript src/sites/api/openapi.yaml --output src/sites/api/schema.d.ts",
+    "smoke": "npm run build && node scripts/smoke.cjs",
+    "start": "node dist/cli.js",
+    "pretest": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "test:integration": "vitest run --config vitest.integration.config.ts",
+    "typecheck": "tsc --noEmit",
+    "check": "pnpm format:check && pnpm lint && pnpm typecheck && pnpm test",
+    "version": "changeset version"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,cjs,mjs}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.16",
+    "ajv": "^8.17.1",
+    "ajv-draft-04": "^1.0.0",
+    "ajv-formats": "^3.0.1",
+    "commander": "^12.1.0",
+    "consola": "^3.4.2",
+    "dotenv": "^17.2.3",
+    "fast-glob": "^3.3.3",
+    "keytar": "^7.9.0",
+    "ora": "^9.1.0",
+    "tsx": "^4.21.0",
+    "uuid": "^14.0.0",
+    "yaml": "^2.8.2",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.8",
+    "@eslint/js": "^9.39.2",
+    "@types/adm-zip": "^0.5.7",
+    "@types/node": "^22.10.2",
+    "@typescript-eslint/eslint-plugin": "^8.43.0",
+    "@typescript-eslint/parser": "^8.43.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.35.0",
+    "globals": "^15.15.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.2",
+    "openapi-typescript": "^7.13.0",
+    "prettier": "^3.6.2",
+    "tsc-alias": "^1.8.16",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^4.0.18"
+  }
+}