camox 0.69.0 → 0.72.0

package/dist/core/createLayout.d.ts

@@ -22,23 +22,7 @@ interface LayoutBlock<TLayoutOnly extends boolean = boolean> {
     layoutOnly: TLayoutOnly;
     Component: React.ComponentType<{
       blockData: any;
-      mode: "site" | "peek" | "layout";
-      isFirstBlock?: boolean;
-      showAddBlockTop?: boolean;
-      showAddBlockBottom?: boolean;
-      addBlockAfterPosition?: string | null;
     }>;
-    getInitialBundle: () => {
-      content: Record<string, unknown>;
-      settings: Record<string, unknown>;
-      repeatableItems: Array<{
-        tempId: string;
-        parentTempId: string | null;
-        fieldName: string;
-        content: Record<string, unknown>;
-        position: string;
-      }>;
-    };
   };
 }
 /**
@@ -49,15 +33,6 @@ interface LayoutBlock<TLayoutOnly extends boolean = boolean> {
  * instead of the unreadable structural diff on the full Block shape.
  */
 type ValidateLayoutOnlyBlocks<T extends readonly LayoutBlock[]> = { [K in keyof T]: T[K] extends LayoutBlock<true> ? T[K] : "❌ Camox: blocks in `blocks.before` and `blocks.after` must be defined with `layoutOnly: true`. Add `layoutOnly: true` to this block's `createBlock` options."; };
-/**
- * A block module, imported only when Camox seeds the initial page. A static import would put
- * the block in every visitor's bundle, since layouts load on every page.
- */
-type InitialBlockImport = () => Promise<{
-  block: LayoutBlock;
-}>;
-declare const INITIAL_LAYOUT_ONLY_ERROR = "❌ Camox: blocks in `blocks.initial` must NOT be `layoutOnly: true` — `initial` is for page-content blocks. Remove `layoutOnly: true` from this block's `createBlock` options.";
-type ValidatePageContentBlocks<T extends readonly InitialBlockImport[]> = { [K in keyof T]: Awaited<ReturnType<T[K]>>["block"] extends LayoutBlock<true> ? typeof INITIAL_LAYOUT_ONLY_ERROR : T[K]; };
 /** Successful ordinary loader result. Data must be JSON-serializable. */
 export interface LayoutLoaderResult<Data = unknown> {
   kind: "data";
@@ -185,21 +160,16 @@ export type RecordPages = {
   field: string;
   param?: string;
 };
-interface LayoutBaseOptions<TBefore extends readonly LayoutBlock[], TAfter extends readonly LayoutBlock[], TInitial extends readonly InitialBlockImport[]> {
+interface LayoutBaseOptions<TBefore extends readonly LayoutBlock[], TAfter extends readonly LayoutBlock[]> {
   id: string;
   title: string;
   description: string;
   blocks: {
     before: ValidateLayoutOnlyBlocks<TBefore>;
     after: ValidateLayoutOnlyBlocks<TAfter>;
-    /**
-     * Ordered list of blocks to create on the initial page when a project is first set up, as
-     * imports of their modules: `[() => import("../blocks/hero")]`.
-     */
-    initial?: ValidatePageContentBlocks<TInitial>;
   };
 }
-type CreateLayoutOptions<TBefore extends readonly LayoutBlock[], TAfter extends readonly LayoutBlock[], TInitial extends readonly InitialBlockImport[], Result extends LoaderReturn = LoaderReturn, Declared extends LayoutStructuredData | undefined = LayoutStructuredData | undefined> = LayoutBaseOptions<TBefore, TAfter, TInitial> & {
+type CreateLayoutOptions<TBefore extends readonly LayoutBlock[], TAfter extends readonly LayoutBlock[], Result extends LoaderReturn = LoaderReturn, Declared extends LayoutStructuredData | undefined = LayoutStructuredData | undefined> = LayoutBaseOptions<TBefore, TAfter> & {
   kind?: "curated" | "derived" | "singleton";
   loader?: (context: LayoutLoaderContext) => Result;
   /** Lists the pages of a derived layout, for the sitemap and the Canvas. */
@@ -215,11 +185,10 @@ type CreateLayoutOptions<TBefore extends readonly LayoutBlock[], TAfter extends
  * Every option a layout may define, as the implementation reads them. The public signatures
  * validated which slot each block may go in.
  */
-type AnyLayoutOptions = Omit<LayoutBaseOptions<any, any, any>, "blocks"> & {
+type AnyLayoutOptions = Omit<LayoutBaseOptions<any, any>, "blocks"> & {
   blocks: {
     before: readonly LayoutBlock<true>[];
     after: readonly LayoutBlock<true>[];
-    initial?: readonly InitialBlockImport[];
   };
   kind?: "curated" | "derived" | "singleton";
   loader?: (context: LayoutLoaderContext) => LoaderReturn;
@@ -271,41 +240,11 @@ declare function createLayoutDefinition(options: AnyLayoutOptions): {
     toStructuredData: (context: AnyLayoutContext) => LayoutStructuredData | undefined;
     blockDefinitions: ({
       type: string;
-      content: Record<string, unknown>;
-      settings: Record<string, unknown>;
-      repeatableItems: {
-        tempId: string;
-        parentTempId: string | null;
-        fieldName: string;
-        content: Record<string, unknown>;
-        position: string;
-      }[];
       slot: "before";
     } | {
       type: string;
-      content: Record<string, unknown>;
-      settings: Record<string, unknown>;
-      repeatableItems: {
-        tempId: string;
-        parentTempId: string | null;
-        fieldName: string;
-        content: Record<string, unknown>;
-        position: string;
-      }[];
       slot: "after";
     })[];
-    loadInitialBlockBundles: (() => Promise<{
-      type: string;
-      content: Record<string, unknown>;
-      settings: Record<string, unknown>;
-      repeatableItems: {
-        tempId: string;
-        parentTempId: string | null;
-        fieldName: string;
-        content: Record<string, unknown>;
-        position: string;
-      }[];
-    }[]>) | undefined;
     /** Renders the layout around the page, with the page's context as props. */
     toReact: React.ComponentType<AnyLayoutContext & {
       children?: React.ReactNode;
@@ -328,7 +267,7 @@ type Params<Id extends string> = Id extends `${infer Head}.${infer Tail}` ? Para
 type RouteParams<Id extends string> = Id extends keyof LayoutFileRoutes ? LayoutFileRoutes[Id] extends {
   params: infer P;
 } ? P : Params<Id> : Params<Id>;
-type FileOptions<Id extends string, Result extends LoaderReturn, B extends readonly LayoutBlock[], A extends readonly LayoutBlock[], I extends readonly InitialBlockImport[], Declared extends LayoutStructuredData | undefined> = Omit<LayoutBaseOptions<B, A, I>, "id"> & (({
+type FileOptions<Id extends string, Result extends LoaderReturn, B extends readonly LayoutBlock[], A extends readonly LayoutBlock[], Declared extends LayoutStructuredData | undefined> = Omit<LayoutBaseOptions<B, A>, "id"> & (({
   kind: "curated";
   loader?: never;
   routes?: never;
@@ -338,11 +277,6 @@ type FileOptions<Id extends string, Result extends LoaderReturn, B extends reado
   children: React.ReactNode;
 }, Declared>) | ({
   kind: "singleton";
-  blocks: {
-    before: ValidateLayoutOnlyBlocks<B>;
-    after: ValidateLayoutOnlyBlocks<A>;
-    initial?: never;
-  };
   loader?: (context: LayoutLoaderContext<Record<string, never>>) => Result;
   routes?: never;
   recordPages?: never;
@@ -351,11 +285,6 @@ type FileOptions<Id extends string, Result extends LoaderReturn, B extends reado
   children?: never;
 }, Declared>) | ({
   kind: "derived";
-  blocks: {
-    before: ValidateLayoutOnlyBlocks<B>;
-    after: ValidateLayoutOnlyBlocks<A>;
-    initial?: never;
-  };
   loader: (context: LayoutLoaderContext<RouteParams<Id>>) => Result;
   routes?: (context: LayoutRoutesContext) => RoutesReturn<RouteParams<Id>>;
   recordPages?: RecordPages;
@@ -363,7 +292,7 @@ type FileOptions<Id extends string, Result extends LoaderReturn, B extends reado
 } & LayoutOutputs<LoadedContext<LoaderData<Result>, RouteParams<Id>, RecordFields<Result>>, {
   children?: never;
 }, Declared>));
-export declare function createLayout<const B extends readonly LayoutBlock[], const A extends readonly LayoutBlock[], const I extends readonly InitialBlockImport[] = [], Result extends LoaderReturn = never, Declared extends LayoutStructuredData | undefined = undefined>(options: CreateLayoutOptions<B, A, I, Result, Declared>): LayoutFor<Result>;
-export declare function createLayout<const Id extends string>(id: Id): <Result extends LoaderReturn = never, const B extends readonly LayoutBlock[] = [], const A extends readonly LayoutBlock[] = [], const I extends readonly InitialBlockImport[] = [], Declared extends LayoutStructuredData | undefined = undefined>(options: FileOptions<Id, Result, B, A, I, Declared>) => LayoutFor<Result>;
+export declare function createLayout<const B extends readonly LayoutBlock[], const A extends readonly LayoutBlock[], Result extends LoaderReturn = never, Declared extends LayoutStructuredData | undefined = undefined>(options: CreateLayoutOptions<B, A, Result, Declared>): LayoutFor<Result>;
+export declare function createLayout<const Id extends string>(id: Id): <Result extends LoaderReturn = never, const B extends readonly LayoutBlock[] = [], const A extends readonly LayoutBlock[] = [], Declared extends LayoutStructuredData | undefined = undefined>(options: FileOptions<Id, Result, B, A, Declared>) => LayoutFor<Result>;
 //#endregion
 export { type CuratedLayoutContext, type LayoutPage, type LayoutProject, type LayoutRequestContext, type LayoutStructuredData, type LoadedLayoutContext, type MainEntity, type RecordLayoutContext, type StructuredDataNode, type StructuredDataType, type WebPageKind, notFound };

package/dist/core/createLayout.js

@@ -9,33 +9,25 @@ import * as React from "react";
 import { Fragment, jsx } from "react/jsx-runtime";
 
 //#region src/core/createLayout.tsx
-const INITIAL_LAYOUT_ONLY_ERROR = "❌ Camox: blocks in `blocks.initial` must NOT be `layoutOnly: true` — `initial` is for page-content blocks. Remove `layoutOnly: true` from this block's `createBlock` options.";
 function createLayoutDefinition(options) {
 	if (options.kind === "singleton" && !/^[\w-]+(?:\.[\w-]+)*$/.test(options.id)) throw new Error(`Singleton layouts require a fixed file route: ${options.id}`);
-	if (options.kind && options.kind !== "curated" && options.blocks.initial) throw new Error("Code-owned layouts cannot define initial page blocks");
 	if (options.routes && options.kind !== "derived") throw new Error(`Only derived layouts can define routes: ${options.id}`);
 	if (options.toMarkdown && (options.kind ?? "curated") === "curated") throw new Error(`Curated layouts cannot define toMarkdown: ${options.id}`);
 	const LayoutContext = React.createContext(null);
-	const { before: beforeBlocks, after: afterBlocks, initial: initialBlocks } = options.blocks;
+	const { before: beforeBlocks, after: afterBlocks } = options.blocks;
 	const BeforeBlocks = () => {
 		const $ = c(4);
 		const ctx = React.use(LayoutContext);
 		if (!ctx) throw new Error(`Layout "${options.id}" BeforeBlocks must be rendered inside its Provider`);
 		let t0;
 		if ($[0] !== ctx) {
-			t0 = beforeBlocks.map((block, i) => {
+			t0 = beforeBlocks.map((block) => {
 				const blockData = ctx.layoutBlocks[block._internal.id];
 				if (!blockData) return null;
-				const isLastBefore = i === beforeBlocks.length - 1;
 				return /* @__PURE__ */ jsx(BlockErrorBoundary, {
 					blockId: blockData._id,
 					blockType: blockData.type,
-					children: /* @__PURE__ */ jsx(block._internal.Component, {
-						blockData,
-						mode: "layout",
-						showAddBlockBottom: (options.kind ?? "curated") === "curated" && isLastBefore || void 0,
-						addBlockAfterPosition: isLastBefore ? "" : void 0
-					})
+					children: /* @__PURE__ */ jsx(block._internal.Component, { blockData })
 				}, block._internal.id);
 			});
 			$[0] = ctx;
@@ -56,19 +48,13 @@ function createLayoutDefinition(options) {
 		if (!ctx) throw new Error(`Layout "${options.id}" AfterBlocks must be rendered inside its Provider`);
 		let t0;
 		if ($[0] !== ctx) {
-			t0 = afterBlocks.map((block, i) => {
+			t0 = afterBlocks.map((block) => {
 				const blockData = ctx.layoutBlocks[block._internal.id];
 				if (!blockData) return null;
-				const isFirstAfter = i === 0;
 				return /* @__PURE__ */ jsx(BlockErrorBoundary, {
 					blockId: blockData._id,
 					blockType: blockData.type,
-					children: /* @__PURE__ */ jsx(block._internal.Component, {
-						blockData,
-						mode: "layout",
-						showAddBlockTop: (options.kind ?? "curated") === "curated" && isFirstAfter || void 0,
-						addBlockAfterPosition: isFirstAfter ? null : void 0
-					})
+					children: /* @__PURE__ */ jsx(block._internal.Component, { blockData })
 				}, block._internal.id);
 			});
 			$[0] = ctx;
@@ -172,36 +158,13 @@ function createLayoutDefinition(options) {
 		return t1;
 	};
 	Item.displayName = `LayoutItem(${options.id})`;
-	const blockDefinitions = [...beforeBlocks.map((block) => {
-		const bundle = block._internal.getInitialBundle();
-		return {
-			type: block._internal.id,
-			content: bundle.content,
-			settings: bundle.settings,
-			repeatableItems: bundle.repeatableItems,
-			slot: "before"
-		};
-	}), ...afterBlocks.map((block) => {
-		const bundle = block._internal.getInitialBundle();
-		return {
-			type: block._internal.id,
-			content: bundle.content,
-			settings: bundle.settings,
-			repeatableItems: bundle.repeatableItems,
-			slot: "after"
-		};
-	})];
-	const loadInitialBlockBundles = initialBlocks && (() => Promise.all(initialBlocks.map(async (load) => {
-		const { block } = await load();
-		if (block._internal.layoutOnly) throw new Error(`${INITIAL_LAYOUT_ONLY_ERROR} (block "${block._internal.id}")`);
-		const bundle = block._internal.getInitialBundle();
-		return {
-			type: block._internal.id,
-			content: bundle.content,
-			settings: bundle.settings,
-			repeatableItems: bundle.repeatableItems
-		};
-	})));
+	const blockDefinitions = [...beforeBlocks.map((block) => ({
+		type: block._internal.id,
+		slot: "before"
+	})), ...afterBlocks.map((block) => ({
+		type: block._internal.id,
+		slot: "after"
+	}))];
 	return {
 		BeforeBlocks,
 		AfterBlocks,
@@ -225,7 +188,6 @@ function createLayoutDefinition(options) {
 			toImage: options.toImage,
 			toStructuredData: (context) => options.toStructuredData?.(context),
 			blockDefinitions,
-			loadInitialBlockBundles,
 			toReact: options.toReact,
 			Provider
 		}

package/dist/core/editing/createEditableBlock.d.ts

@@ -23,13 +23,14 @@ interface BlockBaseOptions<TSchemaShape extends Record<string, TSchema>, TSettin
    */
   description: string;
   /**
-   * The block's editable content, built from `field`. Every field needs a default.
+   * The block's editable content, built from `field`. An unset field holds the empty value of
+   * its kind.
    *
    * @example
    * content: (field) => ({
-   *   title: field.string({ default: "Hello" }),
+   *   title: field.string(),
    *   items: field.repeater({
-   *     content: (field) => ({ name: field.string({ default: "Item" }) }),
+   *     content: (field) => ({ name: field.string() }),
    *     minItems: 1,
    *     maxItems: 10,
    *     toTitle: ({ content }) => content.name,
@@ -44,14 +45,14 @@ interface BlockBaseOptions<TSchemaShape extends Record<string, TSchema>, TSettin
    *
    * @example
    * settings: (setting) => ({
-   *   alignment: setting.enum({ default: "left", options: { left: "Left", center: "Center" } }),
-   *   showBackground: setting.boolean({ default: true }),
+   *   alignment: setting.enum({ options: { left: "Left", center: "Center" } }),
+   *   showBackground: setting.boolean(),
    * })
    */
   settings?: (setting: SettingBuilder) => TSettingsShape;
   /**
-   * When true, this block can only be used inside layouts and won't appear in the block picker
-   * or be available for AI page generation.
+   * When true, this block can only be used inside layouts and isn't available for AI page
+   * generation.
    */
   layoutOnly?: TLayoutOnly;
   /** Share content and settings across all placements of this block definition. Defaults to false. */
@@ -121,36 +122,6 @@ interface BlockData<TContent> {
 }
 export interface BlockComponentProps<TContent> {
   blockData: BlockData<TContent>;
-  mode: "site" | "peek" | "layout";
-  isFirstBlock?: boolean;
-  showAddBlockTop?: boolean;
-  showAddBlockBottom?: boolean;
-  addBlockAfterPosition?: string | null;
-}
-export interface PeekItem {
-  id: string;
-  blockId: string;
-  parentItemId: string | null;
-  fieldName: string;
-  content: unknown;
-  settings: Record<string, unknown> | null;
-  summary: string;
-  title: string;
-  position: string;
-  createdAt: number;
-  updatedAt: number;
-  projectId: number | null;
-  sharedContentType: string | null;
-  /** Peek items link no records. */
-  references: Record<string, never>;
-}
-export interface RepeatableItemSeed {
-  tempId: string;
-  parentTempId: string | null;
-  fieldName: string;
-  content: Record<string, unknown>;
-  settings?: Record<string, unknown>;
-  position: string;
 }
 export declare function createEditableBlock<TSchemaShape extends Record<string, TSchema>, TSettingsShape extends Record<string, TSchema> = Record<string, never>, TLayoutOnly extends boolean = false, TNodes extends BlockStructuredData = BlockStructuredData>(options: CreateBlockOptions<TSchemaShape, TSettingsShape, TLayoutOnly, TNodes>): {
   Detached: ({ children }: {
@@ -1684,7 +1655,7 @@ export declare function createEditableBlock<TSchemaShape extends Record<string,
      * It exposes context that will be consumed by the Field component, and provides visual editing
      * capabilities (e.g. delete and reorder blocks).
      */
-    Component: ({ blockData, mode, isFirstBlock, showAddBlockTop, showAddBlockBottom, addBlockAfterPosition }: BlockComponentProps<import("@sinclair/typebox").Evaluate<Readonly<Partial<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
+    Component: ({ blockData }: BlockComponentProps<import("@sinclair/typebox").Evaluate<Readonly<Partial<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
       params: unknown[] & [];
     })["static"]; }, { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchemaShape[K]> ? K : never : never; }[keyof TSchemaShape]>>> & Readonly<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
       params: unknown[] & [];
@@ -1715,43 +1686,6 @@ export declare function createEditableBlock<TSchemaShape extends Record<string,
     } | undefined;
     layoutOnly: TLayoutOnly;
     synced: boolean;
-    getInitialBundle: () => {
-      content: Record<string, unknown>;
-      settings: {
-        [x: string]: unknown;
-      };
-      repeatableItems: RepeatableItemSeed[];
-    };
-    getInitialContent: () => import("@sinclair/typebox").Evaluate<Readonly<Partial<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
-      params: unknown[] & [];
-    })["static"]; }, { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchemaShape[K]> ? K : never : never; }[keyof TSchemaShape]>>> & Readonly<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
-      params: unknown[] & [];
-    })["static"]; }, { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchemaShape[K]> ? never : K : never; }[keyof TSchemaShape]>> & Partial<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
-      params: unknown[] & [];
-    })["static"]; }, { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchemaShape[K]> ? never : K : never; }[keyof TSchemaShape]>> & Required<Pick<{ [K in keyof TSchemaShape]: (TSchemaShape[K] & {
-      params: unknown[] & [];
-    })["static"]; }, Exclude<keyof TSchemaShape, { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchemaShape[K]> ? never : K : never; }[keyof TSchemaShape] | { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchemaShape[K]> ? K : never : never; }[keyof TSchemaShape] | { [K in keyof TSchemaShape]: TSchemaShape[K] extends import("@sinclair/typebox").TReadonly<TSchema> ? TSchemaShape[K] extends import("@sinclair/typebox").TOptional<TSchemaShape[K]> ? never : K : never; }[keyof TSchemaShape]>>>>;
-    getInitialSettings: () => {
-      [x: string]: unknown;
-    };
-    getPeekBundle: () => {
-      block: {
-        id: string;
-        pageId: null;
-        layoutId: null;
-        type: string;
-        content: Record<string, unknown>;
-        settings: Record<string, unknown>;
-        slot: null;
-        summary: string;
-        title: string;
-        position: string;
-        createdAt: number;
-        updatedAt: number;
-      };
-      repeatableItems: PeekItem[];
-      files: never[];
-    };
   };
 };
 //#endregion