@cmssy/next 0.7.2 → 0.7.4

package/dist/index.cjs

@@ -95,6 +95,33 @@ function resolveEditorOrigin(editorOrigin) {
   }
   return value.trim().length > 0 ? value : DEFAULT_CMSSY_EDITOR_ORIGINS;
 }
+var REQUIRED_CONFIG_ENV = [
+  ["workspaceSlug", "CMSSY_WORKSPACE_SLUG"],
+  ["draftSecret", "CMSSY_DRAFT_SECRET"]
+];
+function defineCmssyConfig(config) {
+  const resolved = { ...config };
+  const missing = [];
+  for (const [key, env] of REQUIRED_CONFIG_ENV) {
+    const value = config[key];
+    const trimmed = typeof value === "string" ? value.trim() : "";
+    if (trimmed) {
+      resolved[key] = trimmed;
+    } else {
+      missing.push(`${env} (config.${key})`);
+    }
+  }
+  if (missing.length > 0) {
+    throw new Error(
+      `cmssy: missing required configuration:
+  - ${missing.join(
+        "\n  - "
+      )}
+Set the listed environment variables (e.g. in .env.local) and restart the dev server.`
+    );
+  }
+  return resolved;
+}
 function assertAuthConfig(config) {
   const auth = config.auth;
   if (!auth || typeof auth.modelSlug !== "string" || !auth.modelSlug) {
@@ -203,7 +230,7 @@ function createCmssyPage(config, blocks, options) {
     const editMode = isEnabled || hasEditFlag(query[EDIT_QUERY_PARAM]);
     const devAllowed = isDevelopment() && Boolean(config.devToken?.trim());
     const devFlagged = hasEditFlag(query[DEV_QUERY_PARAM]);
-    const devPreview = devAllowed && (devFlagged || Boolean(config.devPreview));
+    const devPreview = devAllowed && (devFlagged || config.preview === "dev");
     const editorActive = editMode || devAllowed && devFlagged;
     let locale;
     let pagePath = path;
@@ -1671,6 +1698,7 @@ exports.createCmssyPage = createCmssyPage;
 exports.createCmssyRobots = createCmssyRobots;
 exports.createCmssySitemap = createCmssySitemap;
 exports.createDraftRoute = createDraftRoute;
+exports.defineCmssyConfig = defineCmssyConfig;
 exports.fetchProduct = fetchProduct;
 exports.fetchProducts = fetchProducts;
 exports.getCmssyAccessToken = getCmssyAccessToken;

package/dist/index.d.cts

@@ -12,6 +12,7 @@ interface CmssyAuthConfig {
     modelSlug: string;
     sessionSecret: string;
 }
+type CmssyPreviewMode = "dev" | "live";
 interface CmssyNextConfig {
     /**
      * Full GraphQL delivery endpoint. Defaults to the cmssy cloud endpoint
@@ -22,11 +23,12 @@ interface CmssyNextConfig {
     draftSecret: string;
     devToken?: string;
     /**
-     * When true (and NODE_ENV=development with a devToken), the app serves the
-     * caller's dev-draft overlay on every request without the `?cmssyDev` flag -
-     * for local development against your own dev drafts. Ignored in production.
+     * Local content-source mode. `"dev"` (with NODE_ENV=development + a devToken)
+     * serves the caller's dev-draft overlay on every request without the
+     * `?cmssyDev` flag; `"live"` (or unset) serves published content. Ignored in
+     * production. Pass the raw env value through - the SDK owns the semantics.
      */
-    devPreview?: boolean;
+    preview?: CmssyPreviewMode | (string & {});
     /**
      * Origin allowed to frame your app in the editor. Defaults to
      * {@link DEFAULT_CMSSY_EDITOR_ORIGINS}; set it only for self-hosted admins.
@@ -44,6 +46,24 @@ interface CmssyNextConfig {
     enabledLocales?: string[];
     resolveLocale?: () => string | Promise<string>;
 }
+/**
+ * Env-shaped input for {@link defineCmssyConfig}: the required string fields are
+ * widened to `string | undefined` so a config can pass `process.env.*` straight
+ * through without a `?? ""` fallback (which would mask a missing value as an
+ * empty string) or a cast.
+ */
+type CmssyEnvConfig = Omit<CmssyNextConfig, "workspaceSlug" | "draftSecret"> & {
+    workspaceSlug?: string;
+    draftSecret?: string;
+};
+/**
+ * Validates an env-sourced config and returns a strictly-typed
+ * {@link CmssyNextConfig}. Pass raw `process.env.*` values; this throws a clear,
+ * actionable error listing any missing required variables (rendered by the
+ * Next.js error overlay / boundary), so the app fails fast instead of running
+ * with silently-empty config.
+ */
+declare function defineCmssyConfig(config: CmssyEnvConfig): CmssyNextConfig;
 declare function assertAuthConfig(config: CmssyNextConfig): CmssyAuthConfig;
 
 interface CmssyEditorProps {
@@ -347,4 +367,4 @@ declare class CmssyWebhookError extends Error {
  */
 declare function verifyCmssyWebhook(options: VerifyCmssyWebhookOptions): CmssyWebhookEvent;
 
-export { type BuildCmssyMetadataOptions, CMSSY_CART_COOKIE, CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CMSSY_SESSION_COOKIE, type CmssyAuthConfig, type CmssyAuthMiddleware, type CmssyAuthRouteHandlers, type CmssyCartRouteHandlers, type CmssyCspOptions, type CmssyDraftRouteConfig, type CmssyEditorProps, type CmssyNextConfig, type CmssyOrdersRouteHandlers, type CmssySessionPayload, type CmssySessionUser, CmssyWebhookError, type CmssyWebhookEvent, type CmssyWebhookOrder, type CreateCmssyNotFoundOptions, type CreateCmssyPageOptions, type CreateCmssyRobotsOptions, type CreateCmssySitemapOptions, DEFAULT_CMSSY_EDITOR_ORIGINS, type FetchProductOptions, type FetchProductsOptions, type MyOrdersResult, SESSION_MAX_AGE_SECONDS, type SessionCookieOptions, type VerifyCmssyWebhookOptions, applyCmssyCsp, assertAuthConfig, buildCmssyMetadata, cmssyCspHeaders, createCmssyAuthMiddleware, createCmssyAuthRoute, createCmssyCartRoute, createCmssyLocaleMiddleware, createCmssyNotFound, createCmssyOrdersRoute, createCmssyPage, createCmssyRobots, createCmssySitemap, createDraftRoute, fetchProduct, fetchProducts, getCmssyAccessToken, getCmssyLocale, getCmssyUser, isAccessExpired, isCmssyEditMode, isCmssyEditRequest, localeForPathname, openSession, resolveEditorOrigin, resolveLocaleFromPathname, sealSession, sessionCookieOptions, splitCmssyLocale, verifyCmssyWebhook };
+export { type BuildCmssyMetadataOptions, CMSSY_CART_COOKIE, CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CMSSY_SESSION_COOKIE, type CmssyAuthConfig, type CmssyAuthMiddleware, type CmssyAuthRouteHandlers, type CmssyCartRouteHandlers, type CmssyCspOptions, type CmssyDraftRouteConfig, type CmssyEditorProps, type CmssyEnvConfig, type CmssyNextConfig, type CmssyOrdersRouteHandlers, type CmssySessionPayload, type CmssySessionUser, CmssyWebhookError, type CmssyWebhookEvent, type CmssyWebhookOrder, type CreateCmssyNotFoundOptions, type CreateCmssyPageOptions, type CreateCmssyRobotsOptions, type CreateCmssySitemapOptions, DEFAULT_CMSSY_EDITOR_ORIGINS, type FetchProductOptions, type FetchProductsOptions, type MyOrdersResult, SESSION_MAX_AGE_SECONDS, type SessionCookieOptions, type VerifyCmssyWebhookOptions, applyCmssyCsp, assertAuthConfig, buildCmssyMetadata, cmssyCspHeaders, createCmssyAuthMiddleware, createCmssyAuthRoute, createCmssyCartRoute, createCmssyLocaleMiddleware, createCmssyNotFound, createCmssyOrdersRoute, createCmssyPage, createCmssyRobots, createCmssySitemap, createDraftRoute, defineCmssyConfig, fetchProduct, fetchProducts, getCmssyAccessToken, getCmssyLocale, getCmssyUser, isAccessExpired, isCmssyEditMode, isCmssyEditRequest, localeForPathname, openSession, resolveEditorOrigin, resolveLocaleFromPathname, sealSession, sessionCookieOptions, splitCmssyLocale, verifyCmssyWebhook };

package/dist/index.d.ts

@@ -12,6 +12,7 @@ interface CmssyAuthConfig {
     modelSlug: string;
     sessionSecret: string;
 }
+type CmssyPreviewMode = "dev" | "live";
 interface CmssyNextConfig {
     /**
      * Full GraphQL delivery endpoint. Defaults to the cmssy cloud endpoint
@@ -22,11 +23,12 @@ interface CmssyNextConfig {
     draftSecret: string;
     devToken?: string;
     /**
-     * When true (and NODE_ENV=development with a devToken), the app serves the
-     * caller's dev-draft overlay on every request without the `?cmssyDev` flag -
-     * for local development against your own dev drafts. Ignored in production.
+     * Local content-source mode. `"dev"` (with NODE_ENV=development + a devToken)
+     * serves the caller's dev-draft overlay on every request without the
+     * `?cmssyDev` flag; `"live"` (or unset) serves published content. Ignored in
+     * production. Pass the raw env value through - the SDK owns the semantics.
      */
-    devPreview?: boolean;
+    preview?: CmssyPreviewMode | (string & {});
     /**
      * Origin allowed to frame your app in the editor. Defaults to
      * {@link DEFAULT_CMSSY_EDITOR_ORIGINS}; set it only for self-hosted admins.
@@ -44,6 +46,24 @@ interface CmssyNextConfig {
     enabledLocales?: string[];
     resolveLocale?: () => string | Promise<string>;
 }
+/**
+ * Env-shaped input for {@link defineCmssyConfig}: the required string fields are
+ * widened to `string | undefined` so a config can pass `process.env.*` straight
+ * through without a `?? ""` fallback (which would mask a missing value as an
+ * empty string) or a cast.
+ */
+type CmssyEnvConfig = Omit<CmssyNextConfig, "workspaceSlug" | "draftSecret"> & {
+    workspaceSlug?: string;
+    draftSecret?: string;
+};
+/**
+ * Validates an env-sourced config and returns a strictly-typed
+ * {@link CmssyNextConfig}. Pass raw `process.env.*` values; this throws a clear,
+ * actionable error listing any missing required variables (rendered by the
+ * Next.js error overlay / boundary), so the app fails fast instead of running
+ * with silently-empty config.
+ */
+declare function defineCmssyConfig(config: CmssyEnvConfig): CmssyNextConfig;
 declare function assertAuthConfig(config: CmssyNextConfig): CmssyAuthConfig;
 
 interface CmssyEditorProps {
@@ -347,4 +367,4 @@ declare class CmssyWebhookError extends Error {
  */
 declare function verifyCmssyWebhook(options: VerifyCmssyWebhookOptions): CmssyWebhookEvent;
 
-export { type BuildCmssyMetadataOptions, CMSSY_CART_COOKIE, CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CMSSY_SESSION_COOKIE, type CmssyAuthConfig, type CmssyAuthMiddleware, type CmssyAuthRouteHandlers, type CmssyCartRouteHandlers, type CmssyCspOptions, type CmssyDraftRouteConfig, type CmssyEditorProps, type CmssyNextConfig, type CmssyOrdersRouteHandlers, type CmssySessionPayload, type CmssySessionUser, CmssyWebhookError, type CmssyWebhookEvent, type CmssyWebhookOrder, type CreateCmssyNotFoundOptions, type CreateCmssyPageOptions, type CreateCmssyRobotsOptions, type CreateCmssySitemapOptions, DEFAULT_CMSSY_EDITOR_ORIGINS, type FetchProductOptions, type FetchProductsOptions, type MyOrdersResult, SESSION_MAX_AGE_SECONDS, type SessionCookieOptions, type VerifyCmssyWebhookOptions, applyCmssyCsp, assertAuthConfig, buildCmssyMetadata, cmssyCspHeaders, createCmssyAuthMiddleware, createCmssyAuthRoute, createCmssyCartRoute, createCmssyLocaleMiddleware, createCmssyNotFound, createCmssyOrdersRoute, createCmssyPage, createCmssyRobots, createCmssySitemap, createDraftRoute, fetchProduct, fetchProducts, getCmssyAccessToken, getCmssyLocale, getCmssyUser, isAccessExpired, isCmssyEditMode, isCmssyEditRequest, localeForPathname, openSession, resolveEditorOrigin, resolveLocaleFromPathname, sealSession, sessionCookieOptions, splitCmssyLocale, verifyCmssyWebhook };
+export { type BuildCmssyMetadataOptions, CMSSY_CART_COOKIE, CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CMSSY_SESSION_COOKIE, type CmssyAuthConfig, type CmssyAuthMiddleware, type CmssyAuthRouteHandlers, type CmssyCartRouteHandlers, type CmssyCspOptions, type CmssyDraftRouteConfig, type CmssyEditorProps, type CmssyEnvConfig, type CmssyNextConfig, type CmssyOrdersRouteHandlers, type CmssySessionPayload, type CmssySessionUser, CmssyWebhookError, type CmssyWebhookEvent, type CmssyWebhookOrder, type CreateCmssyNotFoundOptions, type CreateCmssyPageOptions, type CreateCmssyRobotsOptions, type CreateCmssySitemapOptions, DEFAULT_CMSSY_EDITOR_ORIGINS, type FetchProductOptions, type FetchProductsOptions, type MyOrdersResult, SESSION_MAX_AGE_SECONDS, type SessionCookieOptions, type VerifyCmssyWebhookOptions, applyCmssyCsp, assertAuthConfig, buildCmssyMetadata, cmssyCspHeaders, createCmssyAuthMiddleware, createCmssyAuthRoute, createCmssyCartRoute, createCmssyLocaleMiddleware, createCmssyNotFound, createCmssyOrdersRoute, createCmssyPage, createCmssyRobots, createCmssySitemap, createDraftRoute, defineCmssyConfig, fetchProduct, fetchProducts, getCmssyAccessToken, getCmssyLocale, getCmssyUser, isAccessExpired, isCmssyEditMode, isCmssyEditRequest, localeForPathname, openSession, resolveEditorOrigin, resolveLocaleFromPathname, sealSession, sessionCookieOptions, splitCmssyLocale, verifyCmssyWebhook };

package/dist/index.js

@@ -94,6 +94,33 @@ function resolveEditorOrigin(editorOrigin) {
   }
   return value.trim().length > 0 ? value : DEFAULT_CMSSY_EDITOR_ORIGINS;
 }
+var REQUIRED_CONFIG_ENV = [
+  ["workspaceSlug", "CMSSY_WORKSPACE_SLUG"],
+  ["draftSecret", "CMSSY_DRAFT_SECRET"]
+];
+function defineCmssyConfig(config) {
+  const resolved = { ...config };
+  const missing = [];
+  for (const [key, env] of REQUIRED_CONFIG_ENV) {
+    const value = config[key];
+    const trimmed = typeof value === "string" ? value.trim() : "";
+    if (trimmed) {
+      resolved[key] = trimmed;
+    } else {
+      missing.push(`${env} (config.${key})`);
+    }
+  }
+  if (missing.length > 0) {
+    throw new Error(
+      `cmssy: missing required configuration:
+  - ${missing.join(
+        "\n  - "
+      )}
+Set the listed environment variables (e.g. in .env.local) and restart the dev server.`
+    );
+  }
+  return resolved;
+}
 function assertAuthConfig(config) {
   const auth = config.auth;
   if (!auth || typeof auth.modelSlug !== "string" || !auth.modelSlug) {
@@ -202,7 +229,7 @@ function createCmssyPage(config, blocks, options) {
     const editMode = isEnabled || hasEditFlag(query[EDIT_QUERY_PARAM]);
     const devAllowed = isDevelopment() && Boolean(config.devToken?.trim());
     const devFlagged = hasEditFlag(query[DEV_QUERY_PARAM]);
-    const devPreview = devAllowed && (devFlagged || Boolean(config.devPreview));
+    const devPreview = devAllowed && (devFlagged || config.preview === "dev");
     const editorActive = editMode || devAllowed && devFlagged;
     let locale;
     let pagePath = path;
@@ -1641,4 +1668,4 @@ function verifyCmssyWebhook(options) {
   return parsed;
 }
 
-export { CMSSY_CART_COOKIE, CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CMSSY_SESSION_COOKIE, CmssyWebhookError, DEFAULT_CMSSY_EDITOR_ORIGINS, SESSION_MAX_AGE_SECONDS, applyCmssyCsp, assertAuthConfig, buildCmssyMetadata, cmssyCspHeaders, createCmssyAuthMiddleware, createCmssyAuthRoute, createCmssyCartRoute, createCmssyLocaleMiddleware, createCmssyNotFound, createCmssyOrdersRoute, createCmssyPage, createCmssyRobots, createCmssySitemap, createDraftRoute, fetchProduct, fetchProducts, getCmssyAccessToken, getCmssyLocale, getCmssyUser, isAccessExpired, isCmssyEditMode, isCmssyEditRequest, localeForPathname, openSession, resolveEditorOrigin, resolveLocaleFromPathname, sealSession, sessionCookieOptions, splitCmssyLocale, verifyCmssyWebhook };
+export { CMSSY_CART_COOKIE, CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CMSSY_SESSION_COOKIE, CmssyWebhookError, DEFAULT_CMSSY_EDITOR_ORIGINS, SESSION_MAX_AGE_SECONDS, applyCmssyCsp, assertAuthConfig, buildCmssyMetadata, cmssyCspHeaders, createCmssyAuthMiddleware, createCmssyAuthRoute, createCmssyCartRoute, createCmssyLocaleMiddleware, createCmssyNotFound, createCmssyOrdersRoute, createCmssyPage, createCmssyRobots, createCmssySitemap, createDraftRoute, defineCmssyConfig, fetchProduct, fetchProducts, getCmssyAccessToken, getCmssyLocale, getCmssyUser, isAccessExpired, isCmssyEditMode, isCmssyEditRequest, localeForPathname, openSession, resolveEditorOrigin, resolveLocaleFromPathname, sealSession, sessionCookieOptions, splitCmssyLocale, verifyCmssyWebhook };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/next",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "Next.js App Router bindings for cmssy headless sites (createCmssyPage + draft preview)",
   "keywords": [
     "cmssy",
@@ -41,7 +41,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "@cmssy/react": "^0.7.2",
+    "@cmssy/react": "^0.7.4",
     "next": ">=15",
     "react": "^18.2.0 || ^19.0.0",
     "react-dom": "^18.2.0 || ^19.0.0"
@@ -54,7 +54,7 @@
     "tsup": "^8.3.0",
     "typescript": "^5.6.0",
     "vitest": "^2.1.0",
-    "@cmssy/react": "0.7.2"
+    "@cmssy/react": "0.7.4"
   },
   "dependencies": {
     "jose": "^6.2.3"