@cntrl-site/sdk 1.14.0 → 1.16.0

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

@@ -7,6 +7,7 @@ const RichTextItem_schema_1 = require("./RichTextItem.schema");
 const ItemBase_schema_1 = require("./ItemBase.schema");
 const ArticleItemType_1 = require("../../types/article/ArticleItemType");
 const ItemArea_1 = require("../../types/article/ItemArea");
+const pointerEvents = zod_1.z.enum(['never', 'when_visible', 'always']).optional();
 exports.FXControlSchema = zod_1.z.discriminatedUnion('type', [
     zod_1.z.object({
         type: zod_1.z.literal('float'),
@@ -24,19 +25,20 @@ exports.FXControlSchema = zod_1.z.discriminatedUnion('type', [
         value: zod_1.z.tuple([zod_1.z.number(), zod_1.z.number()])
     })
 ]);
+const FXParams = zod_1.z.object({
+    url: zod_1.z.string().min(1),
+    hasGLEffect: zod_1.z.boolean().optional(),
+    fragmentShader: zod_1.z.string().nullable(),
+    FXCursor: zod_1.z.object({
+        type: zod_1.z.enum(['mouse', 'manual']),
+        x: zod_1.z.number(),
+        y: zod_1.z.number()
+    }).nullable(),
+    FXControls: zod_1.z.array(exports.FXControlSchema).optional()
+});
 const ImageItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Image),
-    commonParams: zod_1.z.object({
-        url: zod_1.z.string().min(1),
-        hasGLEffect: zod_1.z.boolean().optional(),
-        fragmentShader: zod_1.z.string().nullable(),
-        FXCursor: zod_1.z.object({
-            type: zod_1.z.enum(['mouse', 'manual']),
-            x: zod_1.z.number(),
-            y: zod_1.z.number()
-        }).nullable(),
-        FXControls: zod_1.z.array(exports.FXControlSchema).optional()
-    }),
+    commonParams: FXParams,
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
         to: zod_1.z.number().optional()
@@ -53,9 +55,9 @@ const ImageItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
 const VideoItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Video),
     commonParams: zod_1.z.object({
-        url: zod_1.z.string().min(1),
-        coverUrl: zod_1.z.string().nullable()
-    }),
+        coverUrl: zod_1.z.string().nullable(),
+        pointerEvents
+    }).merge(FXParams),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
         to: zod_1.z.number().optional()
@@ -77,7 +79,8 @@ const VideoItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
 const RectangleItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Rectangle),
     commonParams: zod_1.z.object({
-        ratioLock: zod_1.z.boolean()
+        ratioLock: zod_1.z.boolean(),
+        pointerEvents
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -97,7 +100,8 @@ const RectangleItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
 const CustomItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Custom),
     commonParams: zod_1.z.object({
-        name: zod_1.z.string()
+        name: zod_1.z.string(),
+        pointerEvents
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -116,7 +120,8 @@ const VimeoEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
         pictureInPicture: zod_1.z.boolean(),
         url: zod_1.z.string().min(1),
         coverUrl: zod_1.z.string().nullable(),
-        ratioLock: zod_1.z.boolean()
+        ratioLock: zod_1.z.boolean(),
+        pointerEvents
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -136,7 +141,8 @@ const YoutubeEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
         controls: zod_1.z.boolean(),
         loop: zod_1.z.boolean(),
         url: zod_1.z.string().min(1),
-        coverUrl: zod_1.z.string().nullable()
+        coverUrl: zod_1.z.string().nullable(),
+        pointerEvents
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -154,7 +160,8 @@ const CodeEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     commonParams: zod_1.z.object({
         html: zod_1.z.string(),
         scale: zod_1.z.boolean(),
-        iframe: zod_1.z.boolean()
+        iframe: zod_1.z.boolean(),
+        pointerEvents
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -178,7 +185,9 @@ exports.ItemSchema = zod_1.z.lazy(() => zod_1.z.discriminatedUnion('type', [
     CodeEmbedItemSchema,
     ItemBase_schema_1.ItemBaseSchema.extend({
         type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Group),
-        commonParams: zod_1.z.object({}),
+        commonParams: zod_1.z.object({
+            pointerEvents
+        }),
         items: zod_1.z.array(exports.ItemSchema),
         sticky: zod_1.z.record(zod_1.z.object({
             from: zod_1.z.number(),
@@ -193,6 +202,7 @@ exports.ItemSchema = zod_1.z.lazy(() => zod_1.z.discriminatedUnion('type', [
         type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Compound),
         commonParams: zod_1.z.object({
             overflow: zod_1.z.enum(['hidden', 'visible']),
+            pointerEvents,
         }),
         items: zod_1.z.array(exports.ItemSchema),
         sticky: zod_1.z.record(zod_1.z.object({

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

@@ -8,9 +8,6 @@ exports.Link = zod_1.z.object({
     url: zod_1.z.string().min(1),
     target: zod_1.z.string().min(1)
 });
-const CommonParamsBase = zod_1.z.object({
-    sizing: zod_1.z.string().min(1)
-});
 exports.CompoundSettingsSchema = zod_1.z.object({
     positionAnchor: zod_1.z.nativeEnum(ItemArea_1.AreaAnchor),
     widthMode: zod_1.z.nativeEnum(ItemArea_1.DimensionMode),
@@ -21,7 +18,6 @@ exports.ItemBaseSchema = zod_1.z.object({
     area: zod_1.z.record(ItemArea_schema_1.ItemAreaSchema),
     hidden: zod_1.z.record(zod_1.z.boolean()),
     link: exports.Link.optional(),
-    commonParams: CommonParamsBase,
     compoundSettings: zod_1.z.record(exports.CompoundSettingsSchema).optional(),
     layoutParams: zod_1.z.record(zod_1.z.any()).optional()
 });

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

@@ -6,6 +6,7 @@ const RichText_1 = require("../../types/article/RichText");
 const ItemBase_schema_1 = require("./ItemBase.schema");
 const ArticleItemType_1 = require("../../types/article/ArticleItemType");
 const ItemState_schema_1 = require("./ItemState.schema");
+const pointerEvents = zod_1.z.enum(['never', 'when_visible', 'always']).optional();
 exports.RichTextEntitySchema = zod_1.z.object({
     start: zod_1.z.number().nonnegative(),
     end: zod_1.z.number().nonnegative(),
@@ -30,7 +31,8 @@ exports.RichTextItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.RichText),
     commonParams: zod_1.z.object({
         text: zod_1.z.string(),
-        blocks: zod_1.z.array(exports.RichTextBlockSchema).optional()
+        blocks: zod_1.z.array(exports.RichTextBlockSchema).optional(),
+        pointerEvents
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),

package/package.json

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

package/src/schemas/article/Item.schema.ts

@@ -22,6 +22,8 @@ import { ArticleItemType } from '../../types/article/ArticleItemType';
 import { FXControlAny } from '../../types/article/FX';
 import { AreaAnchor } from '../../types/article/ItemArea';
 
+const pointerEvents = z.enum(['never', 'when_visible', 'always']).optional();
+
 export const FXControlSchema = z.discriminatedUnion('type',[
   z.object({
     type: z.literal('float'),
@@ -40,19 +42,21 @@ export const FXControlSchema = z.discriminatedUnion('type',[
   })
 ]) satisfies ZodType<FXControlAny>;
 
+const FXParams = z.object({
+  url: z.string().min(1),
+  hasGLEffect: z.boolean().optional(),
+  fragmentShader: z.string().nullable(),
+  FXCursor: z.object({
+    type: z.enum(['mouse', 'manual']),
+    x: z.number(),
+    y: z.number()
+  }).nullable(),
+  FXControls: z.array(FXControlSchema).optional()
+});
+
 const ImageItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.Image),
-  commonParams: z.object({
-    url: z.string().min(1),
-    hasGLEffect: z.boolean().optional(),
-    fragmentShader: z.string().nullable(),
-    FXCursor: z.object({
-      type: z.enum(['mouse', 'manual']),
-      x: z.number(),
-      y: z.number()
-    }).nullable(),
-    FXControls: z.array(FXControlSchema).optional()
-  }),
+  commonParams: FXParams,
   sticky: z.record(
     z.object({
       from: z.number(),
@@ -74,9 +78,9 @@ const ImageItemSchema = ItemBaseSchema.extend({
 const VideoItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.Video),
   commonParams: z.object({
-    url: z.string().min(1),
-    coverUrl: z.string().nullable()
-  }),
+    coverUrl: z.string().nullable(),
+    pointerEvents
+  }).merge(FXParams),
   sticky: z.record(
     z.object({
       from: z.number(),
@@ -103,7 +107,8 @@ const VideoItemSchema = ItemBaseSchema.extend({
 const RectangleItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.Rectangle),
   commonParams: z.object({
-    ratioLock: z.boolean()
+    ratioLock: z.boolean(),
+    pointerEvents
   }),
   sticky: z.record(
     z.object({
@@ -128,7 +133,8 @@ const RectangleItemSchema = ItemBaseSchema.extend({
 const CustomItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.Custom),
   commonParams: z.object({
-    name: z.string()
+    name: z.string(),
+    pointerEvents
   }),
   sticky: z.record(
     z.object({
@@ -150,7 +156,8 @@ const VimeoEmbedItemSchema = ItemBaseSchema.extend({
     pictureInPicture: z.boolean(),
     url: z.string().min(1),
     coverUrl: z.string().nullable(),
-    ratioLock: z.boolean()
+    ratioLock: z.boolean(),
+    pointerEvents
   }),
   sticky: z.record(
     z.object({
@@ -175,7 +182,8 @@ const YoutubeEmbedItemSchema = ItemBaseSchema.extend({
     controls: z.boolean(),
     loop: z.boolean(),
     url: z.string().min(1),
-    coverUrl: z.string().nullable()
+    coverUrl: z.string().nullable(),
+    pointerEvents
   }),
   sticky: z.record(
     z.object({
@@ -198,7 +206,8 @@ const CodeEmbedItemSchema =  ItemBaseSchema.extend({
   commonParams: z.object({
     html: z.string(),
     scale: z.boolean(),
-    iframe: z.boolean()
+    iframe: z.boolean(),
+    pointerEvents
   }),
   sticky: z.record(
     z.object({
@@ -227,7 +236,9 @@ export const ItemSchema: ZodType<ItemAny> = z.lazy(() => z.discriminatedUnion('t
   CodeEmbedItemSchema,
   ItemBaseSchema.extend({
     type: z.literal(ArticleItemType.Group),
-    commonParams: z.object({}),
+    commonParams: z.object({
+      pointerEvents
+    }),
     items: z.array(ItemSchema),
     sticky: z.record(
       z.object({
@@ -246,6 +257,7 @@ export const ItemSchema: ZodType<ItemAny> = z.lazy(() => z.discriminatedUnion('t
     type: z.literal(ArticleItemType.Compound),
     commonParams: z.object({
       overflow: z.enum(['hidden', 'visible']),
+      pointerEvents,
     }),
     items: z.array(ItemSchema),
     sticky: z.record(

package/src/schemas/article/ItemBase.schema.ts

@@ -7,10 +7,6 @@ export const Link = z.object({
   target: z.string().min(1)
 });
 
-const CommonParamsBase = z.object({
-  sizing: z.string().min(1)
-});
-
 export const CompoundSettingsSchema = z.object({
   positionAnchor: z.nativeEnum(AreaAnchor),
   widthMode: z.nativeEnum(DimensionMode),
@@ -22,7 +18,6 @@ export const ItemBaseSchema = z.object({
   area: z.record(ItemAreaSchema),
   hidden: z.record(z.boolean()),
   link: Link.optional(),
-  commonParams: CommonParamsBase,
   compoundSettings: z.record(CompoundSettingsSchema).optional(),
   layoutParams: z.record(z.any()).optional()
 });

package/src/schemas/article/RichTextItem.schema.ts

@@ -5,6 +5,8 @@ import { ArticleItemType } from '../../types/article/ArticleItemType';
 import { RichTextStateParamsSchema } from './ItemState.schema';
 import { RichTextItem } from '../../types/article/Item';
 
+const pointerEvents = z.enum(['never', 'when_visible', 'always']).optional();
+
 export const RichTextEntitySchema = z.object({
   start: z.number().nonnegative(),
   end: z.number().nonnegative(),
@@ -34,7 +36,8 @@ export const RichTextItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.RichText),
   commonParams: z.object({
     text: z.string(),
-    blocks: z.array(RichTextBlockSchema).optional()
+    blocks: z.array(RichTextBlockSchema).optional(),
+    pointerEvents
   }),
   sticky: z.record(
     z.object({

package/src/types/article/Item.ts

@@ -47,47 +47,50 @@ export interface ItemLayoutParamsMap {
   [ArticleItemType.CodeEmbed]: CodeEmbedLayoutParams;
 }
 
-interface MediaCommonParams {
-  url: string;
-}
-
-interface VideoCommonParams extends MediaCommonParams {
-  coverUrl: string | null;
+interface CommonParamsBase {
+  pointerEvents?: 'never' | 'when_visible' | 'always';
 }
 
-interface ImageCommonParams extends MediaCommonParams {
+interface MediaCommonParams extends CommonParamsBase {
+  url: string;
   hasGLEffect?: boolean;
   fragmentShader: string | null;
   FXCursor: FXCursor | null;
   FXControls?: FXControlAny[];
 }
 
-interface RichTextCommonParams {
+interface VideoCommonParams extends MediaCommonParams {
+  coverUrl: string | null;
+}
+
+interface ImageCommonParams extends MediaCommonParams {}
+
+interface RichTextCommonParams extends CommonParamsBase {
   text: string;
   blocks?: RichTextBlock[];
 }
 
-interface RectangleCommonParams {
+interface RectangleCommonParams extends CommonParamsBase {
   ratioLock: boolean;
 }
 
-interface CustomCommonParams {
+interface CustomCommonParams extends CommonParamsBase {
   name: string;
 }
 
-interface GroupCommonParams {}
+interface GroupCommonParams extends CommonParamsBase {}
 
-interface CompoundCommonParams {
+interface CompoundCommonParams extends CommonParamsBase {
   overflow: 'hidden' | 'visible';
 }
 
-interface CodeEmbedCommonParams {
+interface CodeEmbedCommonParams extends CommonParamsBase {
   html: string;
   scale: boolean;
   iframe: boolean;
 }
 
-interface VimeoEmbedCommonParams {
+interface VimeoEmbedCommonParams extends CommonParamsBase {
   play: 'on-hover' | 'on-click' | 'auto';
   controls: boolean;
   loop: boolean;
@@ -97,7 +100,7 @@ interface VimeoEmbedCommonParams {
   coverUrl: string | null;
 }
 
-interface YoutubeEmbedCommonParams {
+interface YoutubeEmbedCommonParams extends CommonParamsBase {
   play: 'on-hover' | 'on-click' | 'auto';
   controls: boolean;
   loop: boolean;