@cntrl-site/sdk 1.27.1 → 1.28.0-0

package/lib/schemas/article/StructuredBlock.schema.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StructuredBlockSchema = exports.StructuredBlockLayoutParamsSchema = exports.StructuredBlockCommonParamsSchema = exports.StructuredBlockImageLayoutParamsSchema = exports.StructuredBlockRichTextLayoutParamsSchema = exports.StructuredBlockImageCommonParamsSchema = exports.StructuredBlockRichTextCommonParamsSchema = exports.StructuredBlockComponentCommonParamsSchema = exports.StructuredBlockAreaSchema = void 0;
+const zod_1 = require("zod");
+const RichTextItem_schema_1 = require("./RichTextItem.schema");
+const Item_schema_1 = require("./Item.schema");
+const FillLayer_schema_1 = require("./FillLayer.schema");
+const StructuredBlockType_1 = require("../../types/article/StructuredBlockType");
+const ItemState_schema_1 = require("./ItemState.schema");
+exports.StructuredBlockAreaSchema = zod_1.z.object({
+    width: zod_1.z.number().nonnegative().optional(),
+    height: zod_1.z.number().nonnegative().optional(),
+    paddingTop: zod_1.z.number().optional(),
+    zIndex: zod_1.z.number()
+});
+exports.StructuredBlockComponentCommonParamsSchema = zod_1.z.object({
+    componentId: zod_1.z.string(),
+    content: zod_1.z.any().optional(),
+    parameters: zod_1.z.record(zod_1.z.any()).optional()
+});
+exports.StructuredBlockRichTextCommonParamsSchema = zod_1.z.object({
+    text: zod_1.z.string(),
+    preset: zod_1.z.string(),
+    blocks: zod_1.z.array(RichTextItem_schema_1.RichTextBlockSchema)
+});
+const pointerEvents = zod_1.z.enum(['never', 'when_visible', 'always']).optional();
+const FXParamsSchema = zod_1.z.object({
+    hasGLEffect: zod_1.z.boolean(),
+    fragmentShader: zod_1.z.string().nullable(),
+    shaderName: zod_1.z.string().nullable(),
+    FXControls: zod_1.z.array(Item_schema_1.FXControlSchema)
+});
+exports.StructuredBlockImageCommonParamsSchema = zod_1.z.object({
+    url: zod_1.z.string().min(1),
+    ratioLock: zod_1.z.boolean(),
+    isPlaceholder: zod_1.z.boolean().optional(),
+    altText: zod_1.z.string(),
+    caption: zod_1.z.string().optional(),
+    pointerEvents
+}).merge(FXParamsSchema);
+exports.StructuredBlockRichTextLayoutParamsSchema = zod_1.z.object({
+    rangeStyles: zod_1.z.array(RichTextItem_schema_1.RichTextStyleSchema)
+});
+exports.StructuredBlockImageLayoutParamsSchema = zod_1.z.object({
+    opacity: zod_1.z.number().nonnegative(),
+    radius: zod_1.z.number(),
+    strokeWidth: zod_1.z.number(),
+    strokeFill: zod_1.z.array(FillLayer_schema_1.FillLayerSchema),
+    blur: zod_1.z.number(),
+    isDraggable: zod_1.z.boolean().optional(),
+    blendMode: zod_1.z.string().optional()
+});
+const StructuredBlockBaseSchema = zod_1.z.object({
+    id: zod_1.z.string().min(1),
+    label: zod_1.z.string().optional().nullable(),
+    area: zod_1.z.record(exports.StructuredBlockAreaSchema),
+    hidden: zod_1.z.record(zod_1.z.boolean()).optional()
+});
+const ComponentStructuredBlockSchema = StructuredBlockBaseSchema.extend({
+    type: zod_1.z.literal(StructuredBlockType_1.StructuredBlockType.Component),
+    commonParams: exports.StructuredBlockComponentCommonParamsSchema,
+    layoutParams: zod_1.z.record(Item_schema_1.ComponentItemLayoutParamsSchema),
+    state: zod_1.z.record(ItemState_schema_1.ComponentBlockStateParamsSchema)
+});
+const RichTextStructuredBlockSchema = StructuredBlockBaseSchema.extend({
+    type: zod_1.z.literal(StructuredBlockType_1.StructuredBlockType.RichText),
+    commonParams: exports.StructuredBlockRichTextCommonParamsSchema,
+    layoutParams: zod_1.z.record(exports.StructuredBlockRichTextLayoutParamsSchema),
+    state: zod_1.z.record(ItemState_schema_1.RichTextBlockStateParamsSchema)
+});
+const ImageStructuredBlockSchema = StructuredBlockBaseSchema.extend({
+    type: zod_1.z.literal(StructuredBlockType_1.StructuredBlockType.Image),
+    commonParams: exports.StructuredBlockImageCommonParamsSchema,
+    layoutParams: zod_1.z.record(exports.StructuredBlockImageLayoutParamsSchema),
+    state: zod_1.z.record(ItemState_schema_1.MediaBlockStateParamsSchema)
+});
+const VimeoEmbedStructuredBlockSchema = StructuredBlockBaseSchema.extend({
+    type: zod_1.z.literal(StructuredBlockType_1.StructuredBlockType.VimeoEmbed),
+    commonParams: zod_1.z.object({
+        url: zod_1.z.string().min(1),
+        coverUrl: zod_1.z.string().nullable(),
+        ratioLock: zod_1.z.boolean(),
+        pointerEvents
+    }),
+    layoutParams: zod_1.z.record(Item_schema_1.VimeoEmbedLayoutParamsSchema),
+    state: zod_1.z.record(ItemState_schema_1.VideoEmbedBlockStateParamsSchema)
+});
+const YoutubeEmbedStructuredBlockSchema = StructuredBlockBaseSchema.extend({
+    type: zod_1.z.literal(StructuredBlockType_1.StructuredBlockType.YoutubeEmbed),
+    commonParams: zod_1.z.object({
+        url: zod_1.z.string().min(1),
+        coverUrl: zod_1.z.string().nullable(),
+        ratioLock: zod_1.z.boolean(),
+        pointerEvents
+    }),
+    layoutParams: zod_1.z.record(Item_schema_1.YoutubeEmbedLayoutParamsSchema),
+    state: zod_1.z.record(ItemState_schema_1.VideoEmbedBlockStateParamsSchema)
+});
+exports.StructuredBlockCommonParamsSchema = zod_1.z.union([
+    exports.StructuredBlockComponentCommonParamsSchema,
+    exports.StructuredBlockRichTextCommonParamsSchema,
+    exports.StructuredBlockImageCommonParamsSchema
+]);
+exports.StructuredBlockLayoutParamsSchema = zod_1.z.union([
+    Item_schema_1.ComponentItemLayoutParamsSchema,
+    exports.StructuredBlockRichTextLayoutParamsSchema,
+    exports.StructuredBlockImageLayoutParamsSchema
+]);
+exports.StructuredBlockSchema = zod_1.z.discriminatedUnion('type', [
+    ComponentStructuredBlockSchema,
+    RichTextStructuredBlockSchema,
+    ImageStructuredBlockSchema,
+    VimeoEmbedStructuredBlockSchema,
+    YoutubeEmbedStructuredBlockSchema
+]);

package/lib/types/article/Item.d.ts

@@ -47,7 +47,7 @@ export interface ItemLayoutParamsMap {
 interface CommonParamsBase {
     pointerEvents?: 'never' | 'when_visible' | 'always';
 }
-interface MediaCommonParams extends CommonParamsBase {
+export interface MediaCommonParams extends CommonParamsBase {
     url: string;
     hasGLEffect?: boolean;
     fragmentShader: string | null;
@@ -80,11 +80,11 @@ interface CodeEmbedCommonParams extends CommonParamsBase {
     scale: boolean;
     iframe: boolean;
 }
-interface VimeoEmbedCommonParams extends CommonParamsBase {
+export interface VimeoEmbedCommonParams extends CommonParamsBase {
     url: string;
     coverUrl: string | null;
 }
-interface YoutubeEmbedCommonParams extends CommonParamsBase {
+export interface YoutubeEmbedCommonParams extends CommonParamsBase {
     url: string;
     coverUrl: string | null;
 }
@@ -93,7 +93,7 @@ interface ComponentCommonParams extends CommonParamsBase {
     content?: any;
     parameters?: Record<string, any>;
 }
-interface MediaLayoutParams {
+export interface MediaLayoutParams {
     opacity: number;
     radius: number;
     strokeWidth: number;
@@ -124,7 +124,7 @@ interface CodeEmbedLayoutParams {
     isDraggable?: boolean;
     blendMode?: string;
 }
-interface VimeoEmbedLayoutParams {
+export interface VimeoEmbedLayoutParams {
     play: 'on-hover' | 'on-click' | 'auto';
     controls: boolean;
     loop: boolean;
@@ -135,7 +135,7 @@ interface VimeoEmbedLayoutParams {
     opacity: number;
     blendMode?: string;
 }
-interface YoutubeEmbedLayoutParams {
+export interface YoutubeEmbedLayoutParams {
     play: 'on-hover' | 'on-click' | 'auto';
     controls: boolean;
     loop: boolean;
@@ -246,7 +246,7 @@ export interface Link {
     target: string;
 }
 type LayoutIdentifier = string;
-interface ComponentLayoutParams {
+export interface ComponentLayoutParams {
     parameters?: any;
     opacity: number;
     blur: number;

package/lib/types/article/ItemState.d.ts

@@ -1,8 +1,9 @@
 import { ArticleItemType } from './ArticleItemType';
 import { FillLayer } from './Item';
+import { StructuredBlockType } from './StructuredBlockType';
 type StateId = string;
-export type ItemState<T extends ArticleItemType> = Record<StateId, ItemStatesMap[T]>;
-export type ItemStateParams = ItemStatesMap[ArticleItemType];
+export type ItemState<T extends ArticleItemType | StructuredBlockType> = Record<StateId, ItemStatesMap[T]>;
+export type ItemStateParams = ItemStatesMap[ArticleItemType] | ItemStatesMap[StructuredBlockType];
 export interface ItemStatesMap {
     [ArticleItemType.Image]: MediaStateParams;
     [ArticleItemType.Video]: MediaStateParams;
@@ -15,6 +16,11 @@ export interface ItemStatesMap {
     [ArticleItemType.CodeEmbed]: CodeEmbedStateParams;
     [ArticleItemType.Compound]: CompoundStateParams;
     [ArticleItemType.Component]: ComponentStateParams;
+    [StructuredBlockType.Component]: ComponentBlockStateParams;
+    [StructuredBlockType.RichText]: RichTextBlockStateParams;
+    [StructuredBlockType.Image]: MediaBlockStateParams;
+    [StructuredBlockType.VimeoEmbed]: VideoEmbedBlockStateParams;
+    [StructuredBlockType.YoutubeEmbed]: VideoEmbedBlockStateParams;
 }
 export interface StateParams<T> {
     value: T;
@@ -38,6 +44,24 @@ interface ItemStatesBaseMap {
     scale?: StateParams<number>;
     blur?: StateParams<number>;
 }
+export interface ComponentBlockStateParams {
+    opacity?: StateParams<number>;
+}
+export interface RichTextBlockStateParams {
+    color?: StateParams<string>;
+    letterSpacing?: StateParams<number>;
+    wordSpacing?: StateParams<number>;
+}
+export interface MediaBlockStateParams {
+    opacity?: StateParams<number>;
+    radius?: StateParams<number>;
+    strokeWidth?: StateParams<number>;
+    strokeFill?: StateParams<FillLayer[]>;
+}
+export interface VideoEmbedBlockStateParams {
+    opacity?: StateParams<number>;
+    radius?: StateParams<number>;
+}
 export interface MediaStateParams extends ItemStatesBaseMap {
     opacity?: StateParams<number>;
     radius?: StateParams<number>;

package/lib/types/article/ItemState.js

@@ -1,3 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ArticleItemType_1 = require("./ArticleItemType");
+const StructuredBlockType_1 = require("./StructuredBlockType");

package/lib/types/article/Section.d.ts

@@ -1,4 +1,5 @@
 import { ItemAny } from './Item';
+import { StructuredBlockAny } from './StructuredBlock';
 export declare enum SectionHeightMode {
     ControlUnits = "control-units",
     ViewportHeightUnits = "viewport-height-units"
@@ -24,14 +25,38 @@ export type SectionImage = {
     position: string;
     offsetX: number | null;
 };
+interface ContentBasedSectionSettings {
+    defaultWidth: Record<string, number>;
+    paddingBottom: Record<string, number>;
+}
+interface ComponentBasedSectionSettings {
+    paddingBottom: Record<string, number>;
+}
 export type SectionMedia = SectionVideo | SectionImage;
-export interface Section {
+type SectionBase = {
     id: string;
     name?: string;
-    height: Record<string, SectionHeight>;
-    hidden: Record<string, boolean>;
     items: ItemAny[];
     position: Record<string, number>;
     color: Record<string, string | null>;
     media?: Record<string, SectionMedia>;
-}
+    hidden: Record<string, boolean>;
+};
+export type FreehandSection = SectionBase & {
+    type: 'freehand';
+    height: Record<string, SectionHeight>;
+};
+export type ComponentBasedSection = SectionBase & {
+    type: 'component-based';
+    minHeight: Record<string, SectionHeight>;
+    structuredContent: StructuredBlockAny[];
+    structuredContentSettings: ComponentBasedSectionSettings;
+};
+export type ContentBasedSection = SectionBase & {
+    type: 'content-based';
+    minHeight: Record<string, SectionHeight>;
+    structuredContent: StructuredBlockAny[];
+    structuredContentSettings: ContentBasedSectionSettings;
+};
+export type Section = FreehandSection | ComponentBasedSection | ContentBasedSection;
+export {};

package/lib/types/article/StructuredBlock.d.ts

@@ -0,0 +1,58 @@
+import { RichTextBlock, RichTextStyle } from './RichText';
+import { ItemState } from './ItemState';
+import { StructuredBlockType } from './StructuredBlockType';
+import { ComponentLayoutParams, MediaCommonParams, MediaLayoutParams, VimeoEmbedCommonParams, VimeoEmbedLayoutParams, YoutubeEmbedCommonParams, YoutubeEmbedLayoutParams } from './Item';
+type LayoutIdentifier = string;
+export interface StructuredBlockArea {
+    width?: number;
+    height?: number;
+    paddingTop?: number;
+    zIndex: number;
+}
+export interface StructuredBlockComponentCommonParams {
+    componentId: string;
+    content?: any;
+    parameters?: Record<string, any>;
+}
+export interface StructuredBlockRichTextCommonParams {
+    text: string;
+    blocks?: RichTextBlock[];
+}
+export interface StructuredBlockRichTextLayoutParams {
+    rangeStyles: RichTextStyle[];
+}
+export interface StructuredBlockImageCommonParams extends MediaCommonParams {
+    altText: string;
+    caption?: string;
+}
+export interface StructuredBlockLayoutParamsMap {
+    [StructuredBlockType.Component]: ComponentLayoutParams;
+    [StructuredBlockType.RichText]: StructuredBlockRichTextLayoutParams;
+    [StructuredBlockType.Image]: MediaLayoutParams;
+    [StructuredBlockType.VimeoEmbed]: VimeoEmbedLayoutParams;
+    [StructuredBlockType.YoutubeEmbed]: YoutubeEmbedLayoutParams;
+}
+export interface StructuredBlockCommonParamsMap {
+    [StructuredBlockType.Component]: StructuredBlockComponentCommonParams;
+    [StructuredBlockType.RichText]: StructuredBlockRichTextCommonParams;
+    [StructuredBlockType.Image]: StructuredBlockImageCommonParams;
+    [StructuredBlockType.VimeoEmbed]: VimeoEmbedCommonParams;
+    [StructuredBlockType.YoutubeEmbed]: YoutubeEmbedCommonParams;
+}
+export interface StructuredBlock<T extends StructuredBlockType> {
+    id: string;
+    type: T;
+    label?: string | null;
+    area: Record<LayoutIdentifier, StructuredBlockArea>;
+    layoutParams: Record<LayoutIdentifier, StructuredBlockLayoutParamsMap[T]>;
+    commonParams: StructuredBlockCommonParamsMap[T];
+    hidden?: Record<LayoutIdentifier, boolean>;
+    state: ItemState<T>;
+}
+export type StructuredBlockAny = StructuredBlock<StructuredBlockType>;
+export type ComponentStructuredBlock = StructuredBlock<StructuredBlockType.Component>;
+export type RichTextStructuredBlock = StructuredBlock<StructuredBlockType.RichText>;
+export type ImageStructuredBlock = StructuredBlock<StructuredBlockType.Image>;
+export type VimeoEmbedStructuredBlock = StructuredBlock<StructuredBlockType.VimeoEmbed>;
+export type YoutubeEmbedStructuredBlock = StructuredBlock<StructuredBlockType.YoutubeEmbed>;
+export {};

package/lib/types/article/StructuredBlock.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const StructuredBlockType_1 = require("./StructuredBlockType");

package/lib/types/article/StructuredBlockType.d.ts

@@ -0,0 +1,7 @@
+export declare enum StructuredBlockType {
+    Component = "component-block",
+    RichText = "rich-text-block",
+    Image = "image-block",
+    VimeoEmbed = "vimeo-embed-block",
+    YoutubeEmbed = "youtube-embed-block"
+}

package/lib/types/article/StructuredBlockType.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StructuredBlockType = void 0;
+var StructuredBlockType;
+(function (StructuredBlockType) {
+    StructuredBlockType["Component"] = "component-block";
+    StructuredBlockType["RichText"] = "rich-text-block";
+    StructuredBlockType["Image"] = "image-block";
+    StructuredBlockType["VimeoEmbed"] = "vimeo-embed-block";
+    StructuredBlockType["YoutubeEmbed"] = "youtube-embed-block";
+})(StructuredBlockType || (exports.StructuredBlockType = StructuredBlockType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "1.27.1",
+  "version": "1.28.0-0",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",