@storyblok/live-preview 0.2.0 → 0.3.0-alpha.0

package/dist/index.d.cts

@@ -1097,17 +1097,37 @@ type Prettify<T> = { [K in keyof T]: T[K] } & {};
 type Override<T, U> = Prettify<Omit<T, keyof U> & U>;
 //#endregion
 //#region src/generated/types/block.d.ts
-/** Wire form: the MAPI object map keyed by field name. This is what `defineBlock` returns. */
-type BlockSchema = Record<string, Field & {
+/**
+ * Ordered array of named fields — the content-shape DSL form `defineBlock`
+ * accepts and returns. A field's position in the array sets the order it appears
+ * in the editor (mapped to the wire `pos` on push).
+ */
+type BlockFields = ReadonlyArray<Field & {
+  name: string;
+  pos?: number;
   required?: boolean;
 }>;
-/** A Storyblok block. */
-type Block<TName extends string = string, TBlockSchema extends BlockSchema = BlockSchema, TIsRoot extends boolean = boolean, TIsNestable extends boolean = boolean, TComponentGroupUuid extends string | null = string | null> = Override<Component, {
+/**
+ * A Storyblok block: a named, ordered set of content fields. Uses the
+ * content-shape DSL `fields` array rather than the MAPI wire `schema` record.
+ */
+type Block<TName extends string = string, TFields extends BlockFields = BlockFields, TIsRoot extends boolean = boolean, TIsNestable extends boolean = boolean> = Override<Omit<Component, 'schema' | 'component_group_uuid'>, {
   name: TName;
-  schema: TBlockSchema;
+  fields: TFields;
   is_root?: TIsRoot;
   is_nestable?: TIsNestable;
-  component_group_uuid?: TComponentGroupUuid;
+  /**
+   * Escape hatch for pinning this block to a Storyblok UI-managed component
+   * group by UUID. Component groups are normally maintained in code via the
+   * schema directory layout; set this only if you intentionally manage groups
+   * in the Storyblok UI, and fill in the group UUID yourself. When set,
+   * `schema push` diffs it and sends it to the Management API; when omitted,
+   * the block's remote group is left untouched.
+   *
+   * @deprecated Prefer maintaining component groups in code through the
+   * directory layout.
+   */
+  component_group_uuid?: string | null;
 }>;
 /**
  * A root {@link Block} (`is_root: true`). Given a union of blocks, narrows to
@@ -1128,21 +1148,28 @@ type RootBlock<T extends Block = Block & {
 type NoBlocks$1 = false;
 /** True when `T` is the un-narrowed base `Block` (i.e. no specific block was supplied). */
 type IsBaseBlock<T> = [Block] extends [T] ? true : false;
-type RequiredFieldKeys<T> = { [K in keyof T]: T[K] extends {
+/**
+ * Maps a block's ordered `fields` array to its read content object, splitting
+ * required (`required: true`) from optional fields. Each `F` is a member of the
+ * field union, so it provably satisfies `FieldValue`'s `Field` constraint.
+ */
+type ContentFields<TFields extends BlockFields, TBlocks> = Prettify<{ [F in TFields[number] as F extends {
+  required: true;
+} ? F['name'] : never]: FieldValue<F, TBlocks> } & { [F in TFields[number] as F extends {
   required: true;
-} ? K : never }[keyof T];
-type OptionalFieldKeys<T> = Exclude<keyof T, RequiredFieldKeys<T>>;
+} ? never : F['name']]?: FieldValue<F, TBlocks> | null }>;
+/** Input (write) variant of {@link ContentFields}, resolving each field via {@link FieldValueInput}. */
 /**
  * Content object for a single block instance as returned by the Storyblok
  * Content Delivery API. Without a `TBlock` argument, this is the loose
  * runtime shape (any block, `_editable` optional). With a schema-typed
- * `TBlock`, fields are narrowed per the block's schema.
+ * `TBlock`, fields are narrowed per the block's `fields`.
  */
 type BlockContent<TBlock extends Block = Block, TBlocks = NoBlocks$1> = IsBaseBlock<TBlock> extends true ? BlockContentBase : TBlock extends any ? Prettify<{
   _uid: string;
   component: TBlock['name'];
   _editable?: string;
-} & { [K in RequiredFieldKeys<TBlock['schema']>]: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> } & { [K in OptionalFieldKeys<TBlock['schema']>]?: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> | null }> : never;
+} & ContentFields<TBlock['fields'], TBlocks>> : never;
 interface FieldTypeValueMap {
   text: string;
   textarea: string;
@@ -1167,15 +1194,15 @@ type IsNestable<T> = T extends {
 } ? false : T extends {
   is_nestable: true;
 } ? true : true;
-type ApplyWhitelist<TField, TBlocks> = TField extends {
-  component_whitelist: ReadonlyArray<infer TWhitelisted extends string>;
+type ApplyAllow<TField, TBlocks> = TField extends {
+  allow: ReadonlyArray<infer TAllowed extends string>;
 } ? Extract<TBlocks, {
-  name: TWhitelisted;
+  name: TAllowed;
 }> : TBlocks extends any ? IsNestable<TBlocks> extends true ? TBlocks : never : never;
 /** Resolves a field definition to its runtime content value type (read). */
 type FieldValue<TField extends Field = Field, TBlocks = NoBlocks$1> = Prettify<TField extends {
   type: 'bloks';
-} ? [TBlocks] extends [never] ? BlockContentBase[] : [TBlocks] extends [Block] ? BlockContent<ApplyWhitelist<TField, TBlocks>, TBlocks>[] : BlockContentBase[] : FieldTypeValueMap[TField['type']]>;
+} ? [TBlocks] extends [never] ? BlockContentBase[] : [TBlocks] extends [Block] ? BlockContent<ApplyAllow<TField, TBlocks>, TBlocks>[] : BlockContentBase[] : FieldTypeValueMap[TField['type']]>;
 //#endregion
 //#region src/editable.d.ts
 declare function storyblokEditable(block?: Pick<BlockContent, '_editable'>): {

package/dist/index.d.mts

@@ -1097,17 +1097,37 @@ type Prettify<T> = { [K in keyof T]: T[K] } & {};
 type Override<T, U> = Prettify<Omit<T, keyof U> & U>;
 //#endregion
 //#region src/generated/types/block.d.ts
-/** Wire form: the MAPI object map keyed by field name. This is what `defineBlock` returns. */
-type BlockSchema = Record<string, Field & {
+/**
+ * Ordered array of named fields — the content-shape DSL form `defineBlock`
+ * accepts and returns. A field's position in the array sets the order it appears
+ * in the editor (mapped to the wire `pos` on push).
+ */
+type BlockFields = ReadonlyArray<Field & {
+  name: string;
+  pos?: number;
   required?: boolean;
 }>;
-/** A Storyblok block. */
-type Block<TName extends string = string, TBlockSchema extends BlockSchema = BlockSchema, TIsRoot extends boolean = boolean, TIsNestable extends boolean = boolean, TComponentGroupUuid extends string | null = string | null> = Override<Component, {
+/**
+ * A Storyblok block: a named, ordered set of content fields. Uses the
+ * content-shape DSL `fields` array rather than the MAPI wire `schema` record.
+ */
+type Block<TName extends string = string, TFields extends BlockFields = BlockFields, TIsRoot extends boolean = boolean, TIsNestable extends boolean = boolean> = Override<Omit<Component, 'schema' | 'component_group_uuid'>, {
   name: TName;
-  schema: TBlockSchema;
+  fields: TFields;
   is_root?: TIsRoot;
   is_nestable?: TIsNestable;
-  component_group_uuid?: TComponentGroupUuid;
+  /**
+   * Escape hatch for pinning this block to a Storyblok UI-managed component
+   * group by UUID. Component groups are normally maintained in code via the
+   * schema directory layout; set this only if you intentionally manage groups
+   * in the Storyblok UI, and fill in the group UUID yourself. When set,
+   * `schema push` diffs it and sends it to the Management API; when omitted,
+   * the block's remote group is left untouched.
+   *
+   * @deprecated Prefer maintaining component groups in code through the
+   * directory layout.
+   */
+  component_group_uuid?: string | null;
 }>;
 /**
  * A root {@link Block} (`is_root: true`). Given a union of blocks, narrows to
@@ -1128,21 +1148,28 @@ type RootBlock<T extends Block = Block & {
 type NoBlocks$1 = false;
 /** True when `T` is the un-narrowed base `Block` (i.e. no specific block was supplied). */
 type IsBaseBlock<T> = [Block] extends [T] ? true : false;
-type RequiredFieldKeys<T> = { [K in keyof T]: T[K] extends {
+/**
+ * Maps a block's ordered `fields` array to its read content object, splitting
+ * required (`required: true`) from optional fields. Each `F` is a member of the
+ * field union, so it provably satisfies `FieldValue`'s `Field` constraint.
+ */
+type ContentFields<TFields extends BlockFields, TBlocks> = Prettify<{ [F in TFields[number] as F extends {
+  required: true;
+} ? F['name'] : never]: FieldValue<F, TBlocks> } & { [F in TFields[number] as F extends {
   required: true;
-} ? K : never }[keyof T];
-type OptionalFieldKeys<T> = Exclude<keyof T, RequiredFieldKeys<T>>;
+} ? never : F['name']]?: FieldValue<F, TBlocks> | null }>;
+/** Input (write) variant of {@link ContentFields}, resolving each field via {@link FieldValueInput}. */
 /**
  * Content object for a single block instance as returned by the Storyblok
  * Content Delivery API. Without a `TBlock` argument, this is the loose
  * runtime shape (any block, `_editable` optional). With a schema-typed
- * `TBlock`, fields are narrowed per the block's schema.
+ * `TBlock`, fields are narrowed per the block's `fields`.
  */
 type BlockContent<TBlock extends Block = Block, TBlocks = NoBlocks$1> = IsBaseBlock<TBlock> extends true ? BlockContentBase : TBlock extends any ? Prettify<{
   _uid: string;
   component: TBlock['name'];
   _editable?: string;
-} & { [K in RequiredFieldKeys<TBlock['schema']>]: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> } & { [K in OptionalFieldKeys<TBlock['schema']>]?: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> | null }> : never;
+} & ContentFields<TBlock['fields'], TBlocks>> : never;
 interface FieldTypeValueMap {
   text: string;
   textarea: string;
@@ -1167,15 +1194,15 @@ type IsNestable<T> = T extends {
 } ? false : T extends {
   is_nestable: true;
 } ? true : true;
-type ApplyWhitelist<TField, TBlocks> = TField extends {
-  component_whitelist: ReadonlyArray<infer TWhitelisted extends string>;
+type ApplyAllow<TField, TBlocks> = TField extends {
+  allow: ReadonlyArray<infer TAllowed extends string>;
 } ? Extract<TBlocks, {
-  name: TWhitelisted;
+  name: TAllowed;
 }> : TBlocks extends any ? IsNestable<TBlocks> extends true ? TBlocks : never : never;
 /** Resolves a field definition to its runtime content value type (read). */
 type FieldValue<TField extends Field = Field, TBlocks = NoBlocks$1> = Prettify<TField extends {
   type: 'bloks';
-} ? [TBlocks] extends [never] ? BlockContentBase[] : [TBlocks] extends [Block] ? BlockContent<ApplyWhitelist<TField, TBlocks>, TBlocks>[] : BlockContentBase[] : FieldTypeValueMap[TField['type']]>;
+} ? [TBlocks] extends [never] ? BlockContentBase[] : [TBlocks] extends [Block] ? BlockContent<ApplyAllow<TField, TBlocks>, TBlocks>[] : BlockContentBase[] : FieldTypeValueMap[TField['type']]>;
 //#endregion
 //#region src/editable.d.ts
 declare function storyblokEditable(block?: Pick<BlockContent, '_editable'>): {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@storyblok/live-preview",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.0-alpha.0",
   "private": false,
   "description": "Official Live Preview integration for the Storyblok Headless CMS",
   "author": "Storyblok",