@cntrl-site/sdk 1.6.0 → 1.7.0

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

@@ -1,11 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ItemSchema = void 0;
+exports.ItemSchema = exports.FXControlSchema = void 0;
 const zod_1 = require("zod");
 const ItemState_schema_1 = require("./ItemState.schema");
 const RichTextItem_schema_1 = require("./RichTextItem.schema");
 const ItemBase_schema_1 = require("./ItemBase.schema");
 const ArticleItemType_1 = require("../../types/article/ArticleItemType");
+exports.FXControlSchema = zod_1.z.discriminatedUnion('type', [
+    zod_1.z.object({
+        type: zod_1.z.literal('float'),
+        shaderParam: zod_1.z.string(),
+        value: zod_1.z.number()
+    }),
+    zod_1.z.object({
+        type: zod_1.z.literal('int'),
+        shaderParam: zod_1.z.string(),
+        value: zod_1.z.number()
+    }),
+    zod_1.z.object({
+        type: zod_1.z.literal('vec2'),
+        shaderParam: zod_1.z.string(),
+        value: zod_1.z.tuple([zod_1.z.number(), zod_1.z.number()])
+    })
+]);
 const ImageItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Image),
     commonParams: zod_1.z.object({
@@ -16,7 +33,8 @@ const ImageItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
             type: zod_1.z.enum(['mouse', 'manual']),
             x: zod_1.z.number(),
             y: zod_1.z.number()
-        }).optional()
+        }).optional(),
+        FXControls: zod_1.z.array(exports.FXControlSchema).optional()
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -44,10 +62,6 @@ const VideoItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     }).nullable()),
     layoutParams: zod_1.z.record(zod_1.z.object({
         autoplay: zod_1.z.boolean(),
-        scrollPlayback: zod_1.z.object({
-            from: zod_1.z.number(),
-            to: zod_1.z.number()
-        }).nullable(),
         opacity: zod_1.z.number().nonnegative(),
         radius: zod_1.z.number(),
         strokeWidth: zod_1.z.number(),

package/lib/types/article/FX.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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

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

@@ -17,6 +17,25 @@ import {
 import { RichTextItemSchema } from './RichTextItem.schema';
 import { ItemBaseSchema } from './ItemBase.schema';
 import { ArticleItemType } from '../../types/article/ArticleItemType';
+import { FXControlAny } from '../../types/article/FX';
+
+export const FXControlSchema = z.discriminatedUnion('type',[
+  z.object({
+    type: z.literal('float'),
+    shaderParam: z.string(),
+    value: z.number()
+  }),
+  z.object({
+    type: z.literal('int'),
+    shaderParam: z.string(),
+    value: z.number()
+  }),
+  z.object({
+    type: z.literal('vec2'),
+    shaderParam: z.string(),
+    value: z.tuple([z.number(), z.number()])
+  })
+]) satisfies ZodType<FXControlAny>;
 
 const ImageItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.Image),
@@ -28,7 +47,8 @@ const ImageItemSchema = ItemBaseSchema.extend({
       type: z.enum(['mouse', 'manual']),
       x: z.number(),
       y: z.number()
-    }).optional()
+    }).optional(),
+    FXControls: z.array(FXControlSchema).optional()
   }),
   sticky: z.record(
     z.object({
@@ -64,10 +84,6 @@ const VideoItemSchema = ItemBaseSchema.extend({
   layoutParams: z.record(
     z.object({
       autoplay: z.boolean(),
-      scrollPlayback: z.object({
-        from: z.number(),
-        to: z.number()
-      }).nullable(),
       opacity: z.number().nonnegative(),
       radius: z.number(),
       strokeWidth: z.number(),

package/src/types/article/FX.ts

@@ -0,0 +1,28 @@
+export type FXControlType = 'float' | 'int' | 'vec2';
+export type FXControlInput = 'knob' | 'matrix2d' | 'slider';
+
+export interface FXCursor {
+  type: 'mouse' | 'manual';
+  x: number;
+  y: number;
+}
+
+export interface FXControlValuesMap {
+  'float': number;
+  'int': number;
+  'vec2': [number, number];
+}
+
+export interface FXControlTypeMap {
+  'float': 'knob' | 'slider';
+  'int': 'knob';
+  'vec2': 'matrix2d';
+}
+
+export interface FXControl<Type extends FXControlType, Input extends FXControlTypeMap[Type]> {
+  type: Type;
+  shaderParam: string;
+  value: FXControlValuesMap[Type];
+}
+
+export type FXControlAny = FXControl<FXControlType, FXControlInput>;

package/src/types/article/Item.ts

@@ -2,6 +2,7 @@ import { RichTextBlock, RichTextStyle, TextAlign, TextDecoration, TextTransform,
 import { ArticleItemType } from './ArticleItemType';
 import { ItemArea } from './ItemArea';
 import { ItemState } from './ItemState';
+import { FXControlAny, FXCursor } from './FX';
 
 export type ItemAny = Item<ArticleItemType>;
 
@@ -44,18 +45,13 @@ interface MediaCommonParams {
   url: string;
 }
 
-interface FXCursor {
-  type: 'mouse' | 'manual';
-  x: number;
-  y: number;
-}
-
 interface VideoCommonParams extends MediaCommonParams {}
 
 interface ImageCommonParams extends MediaCommonParams {
   hasGLEffect?: boolean;
   fragmentShader?: string;
   FXCursor?: FXCursor;
+  FXControls?: FXControlAny[];
 }
 
 interface RichTextCommonParams {
@@ -117,7 +113,6 @@ interface ImageLayoutParams extends MediaLayoutParams {}
 
 interface VideoLayoutParams extends MediaLayoutParams {
   autoplay: boolean;
-  scrollPlayback: ScrollPlaybackParams | null;
 }
 
 interface RichTextLayoutParams {
@@ -149,11 +144,6 @@ interface RectangleLayoutParams {
   blurMode: 'default' | 'backdrop';
 }
 
-export interface ScrollPlaybackParams {
-  from: number;
-  to: number;
-}
-
 export interface StickyParams {
   from: number;
   to?: number;