@cntrl-site/sdk 1.22.21 → 1.23.0

package/dist/index.d.ts

@@ -13,7 +13,7 @@ export type { Item, ImageItem, ItemAny, CustomItem, ItemCommonParamsMap, ItemLay
 export type { RichTextBlock, RichTextEntity, RichTextStyle } from './types/article/RichText';
 export type { ItemArea } from './types/article/ItemArea';
 export type { ItemState, ItemStateParams, StateParams, ItemStatesMap } from './types/article/ItemState';
-export type { Interaction, InteractionTrigger, InteractionState } from './types/article/Interaction';
+export type { Interaction, InteractionItemTrigger, InteractionScrollTrigger, InteractionState } from './types/article/Interaction';
 export type { Layout } from './types/project/Layout';
 export type { Project } from './types/project/Project';
 export type { Meta } from './types/project/Meta';

package/dist/index.js

@@ -550,12 +550,18 @@ const SectionSchema = zod.z.object({
   color: zod.z.record(zod.z.nullable(zod.z.string())),
   media: zod.z.record(SectionMediaSchema).optional()
 });
-const TriggerSchema = zod.z.object({
+const ItemTriggerSchema = zod.z.object({
   itemId: zod.z.string(),
   type: zod.z.enum(["hover-in", "hover-out", "click"]),
   from: zod.z.string(),
   to: zod.z.string()
 });
+const ScrollTriggerSchema = zod.z.object({
+  position: zod.z.number(),
+  from: zod.z.string(),
+  to: zod.z.string(),
+  isReverse: zod.z.boolean()
+});
 const VideoInteractionActionSchema = zod.z.object({
   type: zod.z.enum(["play", "pause"]),
   itemId: zod.z.string()
@@ -566,7 +572,7 @@ const StateSchema = zod.z.object({
 });
 const InteractionSchema = zod.z.object({
   id: zod.z.string(),
-  triggers: zod.z.array(TriggerSchema),
+  triggers: zod.z.array(zod.z.union([ItemTriggerSchema, ScrollTriggerSchema])),
   states: zod.z.array(StateSchema),
   startStateId: zod.z.string()
 });

package/dist/index.mjs

@@ -531,12 +531,18 @@ const SectionSchema = z.object({
   color: z.record(z.nullable(z.string())),
   media: z.record(SectionMediaSchema).optional()
 });
-const TriggerSchema = z.object({
+const ItemTriggerSchema = z.object({
   itemId: z.string(),
   type: z.enum(["hover-in", "hover-out", "click"]),
   from: z.string(),
   to: z.string()
 });
+const ScrollTriggerSchema = z.object({
+  position: z.number(),
+  from: z.string(),
+  to: z.string(),
+  isReverse: z.boolean()
+});
 const VideoInteractionActionSchema = z.object({
   type: z.enum(["play", "pause"]),
   itemId: z.string()
@@ -547,7 +553,7 @@ const StateSchema = z.object({
 });
 const InteractionSchema = z.object({
   id: z.string(),
-  triggers: z.array(TriggerSchema),
+  triggers: z.array(z.union([ItemTriggerSchema, ScrollTriggerSchema])),
   states: z.array(StateSchema),
   startStateId: z.string()
 });

package/dist/schemas/article/Article.schema.d.ts

@@ -121,7 +121,7 @@ export declare const ArticleSchema: z.ZodObject<{
     }>, "many">;
     interactions: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
         id: z.ZodString;
-        triggers: z.ZodArray<z.ZodObject<{
+        triggers: z.ZodArray<z.ZodUnion<[z.ZodObject<{
             itemId: z.ZodString;
             type: z.ZodEnum<["hover-in", "hover-out", "click"]>;
             from: z.ZodString;
@@ -136,7 +136,22 @@ export declare const ArticleSchema: z.ZodObject<{
             from: string;
             to: string;
             itemId: string;
-        }>, "many">;
+        }>, z.ZodObject<{
+            position: z.ZodNumber;
+            from: z.ZodString;
+            to: z.ZodString;
+            isReverse: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            position: number;
+            from: string;
+            to: string;
+            isReverse: boolean;
+        }, {
+            position: number;
+            from: string;
+            to: string;
+            isReverse: boolean;
+        }>]>, "many">;
         states: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -165,12 +180,17 @@ export declare const ArticleSchema: z.ZodObject<{
         startStateId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         id: string;
-        triggers: {
+        triggers: ({
             type: "hover-in" | "hover-out" | "click";
             from: string;
             to: string;
             itemId: string;
-        }[];
+        } | {
+            position: number;
+            from: string;
+            to: string;
+            isReverse: boolean;
+        })[];
         states: {
             id: string;
             actions?: {
@@ -181,12 +201,17 @@ export declare const ArticleSchema: z.ZodObject<{
         startStateId: string;
     }, {
         id: string;
-        triggers: {
+        triggers: ({
             type: "hover-in" | "hover-out" | "click";
             from: string;
             to: string;
             itemId: string;
-        }[];
+        } | {
+            position: number;
+            from: string;
+            to: string;
+            isReverse: boolean;
+        })[];
         states: {
             id: string;
             actions?: {
@@ -228,12 +253,17 @@ export declare const ArticleSchema: z.ZodObject<{
     }[];
     interactions: Record<string, {
         id: string;
-        triggers: {
+        triggers: ({
             type: "hover-in" | "hover-out" | "click";
             from: string;
             to: string;
             itemId: string;
-        }[];
+        } | {
+            position: number;
+            from: string;
+            to: string;
+            isReverse: boolean;
+        })[];
         states: {
             id: string;
             actions?: {
@@ -275,12 +305,17 @@ export declare const ArticleSchema: z.ZodObject<{
     }[];
     interactions: Record<string, {
         id: string;
-        triggers: {
+        triggers: ({
             type: "hover-in" | "hover-out" | "click";
             from: string;
             to: string;
             itemId: string;
-        }[];
+        } | {
+            position: number;
+            from: string;
+            to: string;
+            isReverse: boolean;
+        })[];
         states: {
             id: string;
             actions?: {

package/dist/schemas/article/Interaction.schema.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 export declare const InteractionSchema: z.ZodObject<{
     id: z.ZodString;
-    triggers: z.ZodArray<z.ZodObject<{
+    triggers: z.ZodArray<z.ZodUnion<[z.ZodObject<{
         itemId: z.ZodString;
         type: z.ZodEnum<["hover-in", "hover-out", "click"]>;
         from: z.ZodString;
@@ -16,7 +16,22 @@ export declare const InteractionSchema: z.ZodObject<{
         from: string;
         to: string;
         itemId: string;
-    }>, "many">;
+    }>, z.ZodObject<{
+        position: z.ZodNumber;
+        from: z.ZodString;
+        to: z.ZodString;
+        isReverse: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        position: number;
+        from: string;
+        to: string;
+        isReverse: boolean;
+    }, {
+        position: number;
+        from: string;
+        to: string;
+        isReverse: boolean;
+    }>]>, "many">;
     states: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -45,12 +60,17 @@ export declare const InteractionSchema: z.ZodObject<{
     startStateId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    triggers: {
+    triggers: ({
         type: "hover-in" | "hover-out" | "click";
         from: string;
         to: string;
         itemId: string;
-    }[];
+    } | {
+        position: number;
+        from: string;
+        to: string;
+        isReverse: boolean;
+    })[];
     states: {
         id: string;
         actions?: {
@@ -61,12 +81,17 @@ export declare const InteractionSchema: z.ZodObject<{
     startStateId: string;
 }, {
     id: string;
-    triggers: {
+    triggers: ({
         type: "hover-in" | "hover-out" | "click";
         from: string;
         to: string;
         itemId: string;
-    }[];
+    } | {
+        position: number;
+        from: string;
+        to: string;
+        isReverse: boolean;
+    })[];
     states: {
         id: string;
         actions?: {

package/dist/schemas/article/Interaction.schema.js

@@ -2,12 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InteractionSchema = void 0;
 const zod_1 = require("zod");
-const TriggerSchema = zod_1.z.object({
+const ItemTriggerSchema = zod_1.z.object({
     itemId: zod_1.z.string(),
     type: zod_1.z.enum(['hover-in', 'hover-out', 'click']),
     from: zod_1.z.string(),
     to: zod_1.z.string()
 });
+const ScrollTriggerSchema = zod_1.z.object({
+    position: zod_1.z.number(),
+    from: zod_1.z.string(),
+    to: zod_1.z.string(),
+    isReverse: zod_1.z.boolean()
+});
 const VideoInteractionActionSchema = zod_1.z.object({
     type: zod_1.z.enum(['play', 'pause']),
     itemId: zod_1.z.string()
@@ -18,7 +24,7 @@ const StateSchema = zod_1.z.object({
 });
 exports.InteractionSchema = zod_1.z.object({
     id: zod_1.z.string(),
-    triggers: zod_1.z.array(TriggerSchema),
+    triggers: zod_1.z.array(zod_1.z.union([ItemTriggerSchema, ScrollTriggerSchema])),
     states: zod_1.z.array(StateSchema),
     startStateId: zod_1.z.string(),
 });

package/dist/types/article/Interaction.d.ts

@@ -1,15 +1,21 @@
 export interface Interaction {
     id: string;
-    triggers: InteractionTrigger[];
+    triggers: (InteractionItemTrigger | InteractionScrollTrigger)[];
     states: InteractionState[];
     startStateId: string;
 }
-export interface InteractionTrigger {
+export interface InteractionItemTrigger {
     itemId: string;
     type: 'hover-in' | 'hover-out' | 'click';
     from: StateId;
     to: StateId;
 }
+export interface InteractionScrollTrigger {
+    position: number;
+    from: StateId;
+    to: StateId;
+    isReverse: boolean;
+}
 export type VideoInteractionAction = {
     type: 'play' | 'pause';
     itemId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "1.22.21",
+  "version": "1.23.0",
   "description": "Generic SDK for use in public websites.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",