canopycms 0.0.67-int.90 → 0.0.67

package/dist/build-mode.d.ts

@@ -1,8 +1,8 @@
 import type { AuthenticatedUser } from './user.js';
 /**
- * Check if this deployment is static (no request context, no auth).
- * When true: STATIC_DEPLOY_USER is used, permissions are skipped.
- * All content is assumed publicly readable.
+ * Is this deployment static (no request context, no auth)? When true,
+ * `STATIC_DEPLOY_USER` stands in, permission checks are skipped, and all content
+ * is assumed publicly readable.
  */
 export declare const isDeployedStatic: (config: {
     deployedAs?: string;
@@ -10,40 +10,38 @@ export declare const isDeployedStatic: (config: {
 /**
  * Detect a build, where there is no request and no auth.
  *
- * Under Next.js this is `NEXT_PHASE === 'phase-production-build'`, which
- * `next build` sets itself: after compiling, and immediately before it creates
- * the static worker that collects page data and prerenders, whose processes
- * inherit it. So it is true in page modules, `generateStaticParams` and
- * prerendering, but NOT yet set when `next build` loads `next.config.*`, which
- * it does first. `next dev`, `next start` and the standalone server never set
- * it. Verified in Next 15.5.21 and 16.1.7, where `build/index.js` (in both
- * `dist/` and `dist/esm/`) holds the only assignment -- re-check on every Next
- * major.
+ * Under Next.js that is `NEXT_PHASE === 'phase-production-build'`, which `next
+ * build` sets after compiling and before creating the static worker that
+ * collects page data and prerenders, whose processes inherit it. So it is true
+ * in page modules, `generateStaticParams` and prerendering, but not yet set
+ * while `next build` loads `next.config.*`, which it does first. `next dev`,
+ * `next start` and the standalone server never set it. Verified in Next 15.5.21
+ * and 16.1.7, where `build/index.js` (in both `dist/` and `dist/esm/`) holds the
+ * only assignment -- re-check on every Next major.
  *
- * `CANOPY_BUILD_MODE=true` is the framework-neutral switch: for builds Next
- * does not drive, and for scripts run alongside one (the generated
- * `Dockerfile.cms` sets it in its builder stage, ahead of the build command).
+ * `CANOPY_BUILD_MODE=true` is the framework-neutral switch: for builds Next does
+ * not drive, and for scripts run alongside one (the generated `Dockerfile.cms`
+ * sets it in its builder stage, ahead of the build command).
  */
 export declare const isBuildMode: () => boolean;
 /**
- * Is content read straight from the checkout, rather than from a branch
- * workspace?
- *
- * This decides WHERE content is read. `isDeployedStatic` and `isBuildMode`
- * used on their own decide WHO reads it (`STATIC_DEPLOY_USER`, no ACLs).
+ * Is content read straight from the checkout rather than from a branch
+ * workspace? This decides WHERE content is read; `isDeployedStatic` and
+ * `isBuildMode` on their own decide WHO reads it (`STATIC_DEPLOY_USER`, no
+ * ACLs).
  *
  * True for a static deployment, and for every build in either mode and either
- * deployment type. A build reads the working tree at `process.cwd()` and
- * never touches git, `.canopy-dev` or a branch clone: CI builds exactly the
- * checked-out commit, and a local build reads what is on disk, uncommitted
- * files included. Editor saves not yet copied out of `.canopy-dev`
- * (`canopycms sync pull`) are not part of a build.
+ * deployment type. A build reads the working tree at `process.cwd()` and never
+ * touches git, `.canopy-dev` or a branch clone: CI builds exactly the
+ * checked-out commit, and a local build reads what is on disk, uncommitted files
+ * included. Editor saves not yet copied out of `.canopy-dev` (`canopycms sync
+ * pull`) are not part of a build.
  */
 export declare const readsFromCheckout: (config: {
     deployedAs?: string;
 }) => boolean;
 /**
- * Synthetic user with full access for static deployments and build phase.
- * Has Admin privileges — all content is readable, permissions are skipped.
+ * Synthetic Admin user for static deployments and the build phase: all content
+ * is readable and permission checks are skipped.
  */
 export declare const STATIC_DEPLOY_USER: AuthenticatedUser;

package/dist/build-mode.js

@@ -1,7 +1,7 @@
 /**
- * Check if this deployment is static (no request context, no auth).
- * When true: STATIC_DEPLOY_USER is used, permissions are skipped.
- * All content is assumed publicly readable.
+ * Is this deployment static (no request context, no auth)? When true,
+ * `STATIC_DEPLOY_USER` stands in, permission checks are skipped, and all content
+ * is assumed publicly readable.
  */
 export const isDeployedStatic = (config) => {
     return config.deployedAs === 'static';
@@ -9,49 +9,45 @@ export const isDeployedStatic = (config) => {
 /**
  * Detect a build, where there is no request and no auth.
  *
- * Under Next.js this is `NEXT_PHASE === 'phase-production-build'`, which
- * `next build` sets itself: after compiling, and immediately before it creates
- * the static worker that collects page data and prerenders, whose processes
- * inherit it. So it is true in page modules, `generateStaticParams` and
- * prerendering, but NOT yet set when `next build` loads `next.config.*`, which
- * it does first. `next dev`, `next start` and the standalone server never set
- * it. Verified in Next 15.5.21 and 16.1.7, where `build/index.js` (in both
- * `dist/` and `dist/esm/`) holds the only assignment -- re-check on every Next
- * major.
+ * Under Next.js that is `NEXT_PHASE === 'phase-production-build'`, which `next
+ * build` sets after compiling and before creating the static worker that
+ * collects page data and prerenders, whose processes inherit it. So it is true
+ * in page modules, `generateStaticParams` and prerendering, but not yet set
+ * while `next build` loads `next.config.*`, which it does first. `next dev`,
+ * `next start` and the standalone server never set it. Verified in Next 15.5.21
+ * and 16.1.7, where `build/index.js` (in both `dist/` and `dist/esm/`) holds the
+ * only assignment -- re-check on every Next major.
  *
- * `CANOPY_BUILD_MODE=true` is the framework-neutral switch: for builds Next
- * does not drive, and for scripts run alongside one (the generated
- * `Dockerfile.cms` sets it in its builder stage, ahead of the build command).
+ * `CANOPY_BUILD_MODE=true` is the framework-neutral switch: for builds Next does
+ * not drive, and for scripts run alongside one (the generated `Dockerfile.cms`
+ * sets it in its builder stage, ahead of the build command).
  */
 export const isBuildMode = () => {
-    // Next.js build phase
     if (process.env.NEXT_PHASE === 'phase-production-build')
         return true;
-    // Generic build mode flag (can be set by any framework)
     if (process.env.CANOPY_BUILD_MODE === 'true')
         return true;
     return false;
 };
 /**
- * Is content read straight from the checkout, rather than from a branch
- * workspace?
- *
- * This decides WHERE content is read. `isDeployedStatic` and `isBuildMode`
- * used on their own decide WHO reads it (`STATIC_DEPLOY_USER`, no ACLs).
+ * Is content read straight from the checkout rather than from a branch
+ * workspace? This decides WHERE content is read; `isDeployedStatic` and
+ * `isBuildMode` on their own decide WHO reads it (`STATIC_DEPLOY_USER`, no
+ * ACLs).
  *
  * True for a static deployment, and for every build in either mode and either
- * deployment type. A build reads the working tree at `process.cwd()` and
- * never touches git, `.canopy-dev` or a branch clone: CI builds exactly the
- * checked-out commit, and a local build reads what is on disk, uncommitted
- * files included. Editor saves not yet copied out of `.canopy-dev`
- * (`canopycms sync pull`) are not part of a build.
+ * deployment type. A build reads the working tree at `process.cwd()` and never
+ * touches git, `.canopy-dev` or a branch clone: CI builds exactly the
+ * checked-out commit, and a local build reads what is on disk, uncommitted files
+ * included. Editor saves not yet copied out of `.canopy-dev` (`canopycms sync
+ * pull`) are not part of a build.
  */
 export const readsFromCheckout = (config) => {
     return isDeployedStatic(config) || isBuildMode();
 };
 /**
- * Synthetic user with full access for static deployments and build phase.
- * Has Admin privileges — all content is readable, permissions are skipped.
+ * Synthetic Admin user for static deployments and the build phase: all content
+ * is readable and permission checks are skipped.
  */
 export const STATIC_DEPLOY_USER = Object.freeze({
     type: 'authenticated',

package/dist/cli/cli.d.ts

@@ -17,31 +17,25 @@ export declare function parseArgs(rawArgs: string[]): {
     command: string | undefined;
 };
 /**
- * The argv after a literal `--`, as a real string array.
- *
- * minimist types its parsed object with an `any` index signature, so reading
- * `argv['--']` directly would hand an `any` straight to spawn(). Narrowed here
- * through `unknown` instead, and returned as `[]` when absent so callers can
- * treat "no passthrough" and "empty passthrough" the same way. Exported for
- * testing.
+ * The argv after a literal `--`, as a real string array. minimist types its
+ * parsed object with an `any` index signature, so this narrows through
+ * `unknown` and returns `[]` when absent, letting callers treat "no
+ * passthrough" and "empty passthrough" alike. Exported for testing.
  */
 export declare function passthroughArgs(argv: Record<string, unknown>): string[];
 /**
- * Validate the --auth flag value for `init`. Returns undefined when the flag
- * was not provided (caller should fall through to interactive prompt / default).
- * Throws when a value was provided but isn't a recognized auth provider.
+ * Validates --auth for `init`. Undefined means "not passed" (caller falls
+ * through to prompt/default); throws if a value is given but unrecognized.
  * Exported for testing.
  */
 export declare function parseAuthFlag(value: string | boolean | undefined): AuthProvider | undefined;
 /**
- * Validate/coerce the --dual-build flag value for `init`. Returns undefined
- * when the flag was not provided (caller should fall through to init()'s own
- * prompt-or-default logic). minimist leaves `dual-build` undeclared (see
+ * Validates/coerces --dual-build for `init`. minimist leaves it undeclared (see
  * parseArgs above), so `--dual-build=true` / `--dual-build true` parse as the
- * STRINGS "true"/"false" rather than real booleans — coerce those explicitly
- * so they don't silently fall through to `undefined` (then `false` by
- * default in non-interactive mode), the opposite of what the user asked.
- * Throws when a value was provided but isn't a real boolean or "true"/"false".
+ * STRINGS "true"/"false" rather than booleans — coerced explicitly so they don't
+ * fall through to `undefined` (then `false` in non-interactive mode), the
+ * opposite of what was asked. Undefined means "not passed" (falls through to
+ * init()'s own prompt/default); throws on any other non-boolean value.
  * Exported for testing.
  */
 export declare function parseDualBuildFlag(value: unknown): boolean | undefined;
@@ -53,15 +47,10 @@ export type KnownAuthMode = (typeof KNOWN_AUTH_MODES)[number];
 /**
  * Whether `CANOPY_AUTH_MODE` names a provider the CLI can actually construct.
  *
- * Pure and exported so it is testable: the dispatch below branches on 'clerk'
- * and 'dev' only, and the catch around plugin loading fires solely on an
- * IMPORT failure -- so before this guard existed, any other value (a typo,
- * wrong casing like 'Clerk', a stale value from another system) selected no
- * plugin, skipped the auth refresh entirely, and let the command run to "Done"
- * with exit code 0. A cron'd `CANOPY_AUTH_MODE=clerk canopycms worker
- * run-once` that became `Clerk` refreshed nothing for as long as the typo
- * survived, while the cache aged and a user removed from the Clerk org kept
- * editor access.
+ * The dispatch below recognizes only 'clerk' and 'dev', and the plugin-load
+ * catch fires only on an import failure — so an unrecognized mode MUST be
+ * refused here, or it silently selects no plugin, skips the auth refresh,
+ * and exits 0.
  */
 export declare function isKnownAuthMode(value: string): value is KnownAuthMode;
 /** Resolve sync subcommand from positional arg. Returns null if missing or invalid. Exported for testing. */