@shapio/cms 0.5.1 → 0.5.2

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { $ as parseLockFile, A as buildEditorManifest, B as RESERVED_DEFINITION_API_KEYS, C as loopbackUrl, D as BEFORE_EVENTS, E as AFTER_EVENTS, F as lockById, G as THEME_VARIANTS, H as RESERVED_TYPE_NAMES, I as update, J as hashDefinition, K as checkThemeContrast, L as STORAGE_DRIVERS, N as listForAssets, O as EXTENSION_JOB_PREFIX, P as listLiveByDriver, Q as parseDefinition, R as describeError, S as createUrlBuilder, T as loadProjectConfig, U as SCHEMA_KIND_DIRECTORIES, V as RESERVED_FIELD_API_KEYS, W as SITES_DIRECTORY, X as lockEntriesForSite, Y as lockCoversSite, Z as mergePulledLock, _ as listAllSites, a as loadConfig, at as toTypeName, b as generateToken, ct as withSiteCovered, d as migrateToLatest, dt as createStableId, et as schemaFilePath, f as SHAPIO_VERSION, ft as validateRichText, g as createSite, i as assertDatabaseReachable, it as suggestPlural, k as EXTENSION_ROUTE_ROOT, lt as RICHTEXT_FORMAT, mt as sqliteDriverOf, n as startServer, nt as serializeDefinition, o as loadEnvFileIfPresent, ot as upgradeLockFile, p as createMediaStorage, pt as createDb, q as foldApiKey, r as copyObjectVerified, rt as serializeLockFile, st as validateSchema, t as startDedicatedWorker, tt as scopeDirectory, u as getPendingMigrations, ut as SAFE_LINK_PATTERN, v as createAdminDirect, w as SITE_KEY_PATTERN, x as createLogger, y as SYSTEM_CLI_ACTOR } from "./worker-BU-V4qbH.js";
+import { $ as parseLockFile, A as buildEditorManifest, B as RESERVED_DEFINITION_API_KEYS, C as loopbackUrl, D as BEFORE_EVENTS, E as AFTER_EVENTS, F as lockById, G as THEME_VARIANTS, H as RESERVED_TYPE_NAMES, I as update, J as hashDefinition, K as checkThemeContrast, L as STORAGE_DRIVERS, N as listForAssets, O as EXTENSION_JOB_PREFIX, P as listLiveByDriver, Q as parseDefinition, R as describeError, S as createUrlBuilder, T as loadProjectConfig, U as SCHEMA_KIND_DIRECTORIES, V as RESERVED_FIELD_API_KEYS, W as SITES_DIRECTORY, X as lockEntriesForSite, Y as lockCoversSite, Z as mergePulledLock, _ as listAllSites, a as loadConfig, at as toTypeName, b as generateToken, ct as withSiteCovered, d as migrateToLatest, dt as createStableId, et as schemaFilePath, f as SHAPIO_VERSION, ft as validateRichText, g as createSite, i as assertDatabaseReachable, it as suggestPlural, k as EXTENSION_ROUTE_ROOT, lt as RICHTEXT_FORMAT, mt as sqliteDriverOf, n as startServer, nt as serializeDefinition, o as loadEnvFileIfPresent, ot as upgradeLockFile, p as createMediaStorage, pt as createDb, q as foldApiKey, r as copyObjectVerified, rt as serializeLockFile, st as validateSchema, t as startDedicatedWorker, tt as scopeDirectory, u as getPendingMigrations, ut as SAFE_LINK_PATTERN, v as createAdminDirect, w as SITE_KEY_PATTERN, x as createLogger, y as SYSTEM_CLI_ACTOR } from "./worker-W5eY5lSj.js";
 import { createDecipheriv, createHash, scryptSync } from "node:crypto";
 import { createReadStream, createWriteStream, existsSync, openAsBlob } from "node:fs";
 import { basename, dirname, extname, isAbsolute, join, posix, relative, resolve } from "node:path";
@@ -2290,12 +2290,18 @@ const planStrapiSchema = (schemas) => {
 	};
 	const taken = /* @__PURE__ */ new Set();
 	const plans = /* @__PURE__ */ new Map();
+	/** The API ID for `name`; a reserved or repeated name gets a suffix, which the plan lists. */
+	const claimApiKey = (schema, name) => {
+		const apiKey = definitionApiKey(name, taken);
+		if (apiKey !== toCamelCase(name)) context.notes.push(`${schema.uid} is named ${apiKey} (the name is reserved or already taken).`);
+		return apiKey;
+	};
 	for (const schema of contentTypes) {
-		const apiKey = definitionApiKey(schema.info?.singularName ?? schema.uid.split(".").at(-1) ?? "model", taken);
-		plans.set(schema.uid, planDefinition(schema, apiKey, context));
+		const name = schema.info?.singularName ?? schema.uid.split(".").at(-1) ?? "model";
+		plans.set(schema.uid, planDefinition(schema, claimApiKey(schema, name), context));
 	}
 	const baseName = componentBaseNames(components);
-	for (const schema of components) plans.set(schema.uid, planDefinition(schema, definitionApiKey(baseName(schema), taken), context));
+	for (const schema of components) plans.set(schema.uid, planDefinition(schema, claimApiKey(schema, baseName(schema)), context));
 	if (contentTypes.some((schema) => schema.options?.draftAndPublish === false)) context.notes.push(`Draft and publish is turned on for ${contentTypes.filter((schema) => schema.options?.draftAndPublish === false).map((schema) => plans.get(schema.uid)?.definition.apiKey).join(", ")} (off in Strapi), so imported entries are reviewed before they go live.`);
 	return {
 		plans,
@@ -2337,6 +2343,8 @@ const indexLinks = (links) => {
 const stringOf = (value) => typeof value === "string" ? value : void 0;
 /** Strapi IDs and numeric scalars as text (objects are not scalars and give undefined). */
 const textOf = (value) => typeof value === "string" ? value : typeof value === "number" || typeof value === "bigint" ? String(value) : void 0;
+/** Strapi's `name` may lack the extension (its example project's names do); `ext` always has it. */
+const withExtension = (name, ext) => name.toLowerCase().endsWith(ext.toLowerCase()) ? name : `${name}${ext}`;
 const fileMedia = (data, root) => {
 	const hash = stringOf(data.hash);
 	const ext = stringOf(data.ext) ?? "";
@@ -2345,9 +2353,10 @@ const fileMedia = (data, root) => {
 	const alt = stringOf(data.alternativeText);
 	const caption = stringOf(data.caption);
 	const mimeType = stringOf(data.mime);
+	const name = stringOf(data.name);
 	return {
 		sourceId: `file:${id}`,
-		filename: stringOf(data.name) ?? `${hash}${ext}`,
+		filename: name ? withExtension(name, ext) : `${hash}${ext}`,
 		path: join(root, "assets", "uploads", `${hash}${ext}`),
 		...mimeType ? { mimeType } : {},
 		...alt ? { alt } : {},
@@ -3649,13 +3658,39 @@ const runMap = async (options, io) => {
 	for (const failure of changeSets.failed) io.stderr(`  ! change set item ${failure.key}: ${failure.message}\n`);
 	return printSummary(run, source, changeSets.failed.length);
 };
+/**
+* The site a `--plan` writes its models for. `--plan` runs offline (no URL or token), so it cannot ask the
+* instance which site a token works on: it takes `--site`, else `SHAPIO_SITE`, else the primary site, whose key
+* is always `default`. On a single-site instance that is the only site, so the planned models apply with an
+* ordinary admin token. `--shared` plans models shared with all sites instead (applying them needs a network
+* admin token).
+*/
+const PRIMARY_SITE_KEY = "default";
+const resolvePlanSite = (options, env) => {
+	const named = options.site?.trim() || void 0;
+	if (options.shared) {
+		if (named) throw new UsageError$1("Pass either --site <key> or --shared, not both");
+		return {
+			site: void 0,
+			explicit: true
+		};
+	}
+	const site = named ?? (env.SHAPIO_SITE?.trim() || void 0);
+	return site ? {
+		site,
+		explicit: true
+	} : {
+		site: PRIMARY_SITE_KEY,
+		explicit: false
+	};
+};
 /** Relative to the working directory when inside it, else absolute (what to paste into the next command). */
 const display = (path) => {
 	const shown = relative(process.cwd(), path);
 	return !shown ? "." : shown.startsWith("..") || isAbsolute(shown) ? path : shown;
 };
 /** What `--plan` wrote and what to do next. */
-const formatPlanSummary = (source, definitions, dir, command, site) => {
+const formatPlanSummary = (source, definitions, dir, command, { site, explicit }) => {
 	const keyOf = new Map(source.definitions.map((definition) => [definition.apiKey, definition.key]));
 	const lines = [`Planned ${definitions.length} definition(s) in ${display(`${dir}/${PLAN_SCHEMA_DIR}`)}:`];
 	for (const definition of definitions) {
@@ -3666,8 +3701,8 @@ const formatPlanSummary = (source, definitions, dir, command, site) => {
 	lines.push(`Media: ${source.media.length} file(s) to import.`);
 	lines.push("Every model has draft and publish on: nothing goes live until you ship the change set(s) the import opens.");
 	lines.push(...source.notes);
-	lines.push(site ? `The models and components will belong to site "${site}".` : "No --site given: the models and components will be shared with all sites. Plan again with --site <key> to keep them on one site.");
-	const siteFlag = site ? ` --site ${site}` : "";
+	lines.push(!site ? "The models and components will be shared with all sites (--shared): applying them needs a network admin token." : explicit ? `The models and components will belong to site "${site}".` : `The models and components will belong to the primary site ("${site}"). Plan with --site <key> for another site, or --shared to share them with all sites.`);
+	const siteFlag = site && explicit ? ` --site ${site}` : "";
 	lines.push("Next:", "  1. Review the files: rename API IDs or delete fields you do not want (entries follow the stable IDs).", `  2. shapio schema apply --dir ${display(`${dir}/${PLAN_SCHEMA_DIR}`)} --lock ${display(`${dir}/${PLAN_LOCK_FILE}`)}${siteFlag}`, `  3. shapio import ${command} --map ${display(dir)}${siteFlag}`);
 	return `${lines.join("\n")}\n`;
 };
@@ -3681,6 +3716,10 @@ const parse = (args, spec) => {
 				type: "boolean",
 				default: false
 			},
+			shared: {
+				type: "boolean",
+				default: false
+			},
 			url: { type: "string" },
 			token: { type: "string" },
 			site: { type: "string" },
@@ -3692,28 +3731,33 @@ const parse = (args, spec) => {
 	if (values.plan === void 0 === (values.map === void 0)) throw new UsageError$1("Pass either --plan <dir> (with the export file) or --map <dir>");
 	if (values.plan !== void 0 && !positionals[0]) throw new UsageError$1("--plan needs the export file");
 	if (values.map !== void 0 && positionals[0]) throw new UsageError$1("--map reads the export recorded in the plan: leave the file out");
+	if (values.map !== void 0 && values.shared) throw new UsageError$1("--shared is a --plan option: --map imports where the plan put the models");
+	if (values.shared && values.site !== void 0) throw new UsageError$1("Pass either --site <key> or --shared, not both");
 	return {
 		values,
 		file: positionals[0]
 	};
 };
-/** `--site`, else SHAPIO_SITE: the site the plan's schema belongs to and the map step writes to. */
+/** `--site`, else SHAPIO_SITE: the site `--map` writes to (else the site the plan recorded). */
 const siteOf = (values, io) => (values.site ?? io.env.SHAPIO_SITE)?.trim() || void 0;
 const runPlan = async (spec, file, values, io) => {
 	const dir = resolve(String(values.plan));
 	const path = resolve(file);
 	await checkPlanDirectory(dir, values.force === true);
+	const planSite = resolvePlanSite({
+		site: values.site,
+		shared: values.shared === true
+	}, io.env);
 	const source = await spec.plan(path, dir, values);
-	const site = siteOf(values, io);
 	const { definitions } = await writePlan(dir, source, {
 		kind: source.kind,
 		path,
 		sha256: await sha256File(path)
 	}, {
 		force: values.force === true,
-		site
+		site: planSite.site
 	});
-	io.stdout(formatPlanSummary(source, definitions, dir, spec.name, site));
+	io.stdout(formatPlanSummary(source, definitions, dir, spec.name, planSite));
 	return 0;
 };
 const runMapStep = (spec, values, io) => {
@@ -3759,7 +3803,7 @@ const importStrapiCommand = createImporterCommand({
 	name: "strapi",
 	label: "Strapi",
 	summary: "Import a Strapi 5 export: --plan writes schema files, --map creates drafts and change sets",
-	usage: "shapio import strapi <export.tar.gz[.enc]> --plan <dir> [--key <encryption key>] [--site <key>] [--force]\n       shapio import strapi --map <dir> [--url <origin>] [--token <admin token>] [--site <key>]\n  --plan unpacks the export into <dir>/source (--key for an encrypted export) and writes the planned models\n  and components (<dir>/schema) and <dir>/import-map.json; it sends nothing. With --site (or SHAPIO_SITE)\n  they belong to that site (<dir>/schema/sites/<key>/); without, they are shared (--map\n  without --site imports into the planned site). Apply the schema with\n  `shapio schema apply --dir <dir>/schema --lock <dir>/schema-lock.json [--site <key>]`, then run --map:\n  it uploads the media, creates every document as a draft and opens change sets with the published ones.\n  Strapi 5 only.",
+	usage: "shapio import strapi <export.tar[.gz[.enc]]> --plan <dir> [--key <encryption key>] [--site <key> | --shared] [--force]\n       shapio import strapi --map <dir> [--url <origin>] [--token <admin token>] [--site <key>]\n  --plan unpacks the export into <dir>/source (--key for an encrypted export) and writes the planned models\n  and components (<dir>/schema) and <dir>/import-map.json; it sends nothing. They belong to one site\n  (<dir>/schema/sites/<key>/): --site (or SHAPIO_SITE), else the primary site (\"default\"); --shared shares\n  them with all sites (applying them needs a network admin token). --map without --site imports into the\n  planned site. Apply the schema with\n  `shapio schema apply --dir <dir>/schema --lock <dir>/schema-lock.json [--site <key>]`, then run --map:\n  it uploads the media, creates every document as a draft and opens change sets with the published ones.\n  Strapi 5 only.",
 	options: ["key"],
 	plan: async (file, dir, values) => {
 		await extractStrapiExport(file, sourceDir(dir), typeof values.key === "string" ? values.key : void 0);
@@ -4353,7 +4397,7 @@ const importWordPressCommand = createImporterCommand({
 	name: "wordpress",
 	label: "WordPress",
 	summary: "Import a WordPress export (WXR): --plan writes schema files, --map creates drafts and change sets",
-	usage: "shapio import wordpress <export.xml> --plan <dir> [--site <key>] [--force]\n       shapio import wordpress --map <dir> [--url <origin>] [--token <admin token>] [--site <key>] [--media-dir <uploads dir>]\n  --plan reads the export and writes the planned models (<dir>/schema) and <dir>/import-map.json; it sends nothing.\n  With --site (or SHAPIO_SITE) the models belong to that site (<dir>/schema/sites/<key>/); without, they are shared;\n  --map without --site then imports into the planned site.\n  Apply the models with `shapio schema apply --dir <dir>/schema --lock <dir>/schema-lock.json [--site <key>]`, then run --map:\n  it uploads the media (downloaded from the site, or read from --media-dir, a copy of wp-content/uploads),\n  creates every post and page as a draft, and opens change sets with the published ones. Re-run --map to resume.",
+	usage: "shapio import wordpress <export.xml> --plan <dir> [--site <key> | --shared] [--force]\n       shapio import wordpress --map <dir> [--url <origin>] [--token <admin token>] [--site <key>] [--media-dir <uploads dir>]\n  --plan reads the export and writes the planned models (<dir>/schema) and <dir>/import-map.json; it sends nothing.\n  The models belong to one site (<dir>/schema/sites/<key>/): --site (or SHAPIO_SITE), else the primary site\n  (\"default\"); --shared shares them with all sites (applying them needs a network admin token).\n  --map without --site imports into the planned site.\n  Apply the models with `shapio schema apply --dir <dir>/schema --lock <dir>/schema-lock.json [--site <key>]`, then run --map:\n  it uploads the media (downloaded from the site, or read from --media-dir, a copy of wp-content/uploads),\n  creates every post and page as a draft, and opens change sets with the published ones. Re-run --map to resume.",
 	options: ["media-dir"],
 	plan: async (file) => wordpressSource(await readWxr(file)),
 	load: async (map, _dir, values) => wordpressSource(await readWxr(map.source.path), mediaDirOf(values))