@cntrl-site/sdk 1.4.0 → 1.5.0

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

@@ -9,7 +9,9 @@ const ArticleItemType_1 = require("../../types/article/ArticleItemType");
 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)
+        url: zod_1.z.string().min(1),
+        hasGLEffect: zod_1.z.boolean().optional(),
+        fragmentShader: zod_1.z.string().optional()
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),
@@ -126,6 +128,21 @@ const YoutubeEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
         hover: zod_1.z.record(ItemState_schema_1.EmbedHoverStateParamsSchema)
     })
 });
+const GroupItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
+    type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Group),
+    commonParams: zod_1.z.object({}),
+    itemsIds: zod_1.z.array(zod_1.z.string()),
+    sticky: zod_1.z.record(zod_1.z.object({
+        from: zod_1.z.number(),
+        to: zod_1.z.number().optional()
+    }).nullable()),
+    layoutParams: zod_1.z.record(zod_1.z.object({
+        opacity: zod_1.z.number().nonnegative()
+    })),
+    state: zod_1.z.object({
+        hover: zod_1.z.record(ItemState_schema_1.GroupHoverStateParamsSchema)
+    })
+});
 exports.ItemSchema = zod_1.z.discriminatedUnion('type', [
     ImageItemSchema,
     VideoItemSchema,
@@ -133,5 +150,6 @@ exports.ItemSchema = zod_1.z.discriminatedUnion('type', [
     CustomItemSchema,
     RichTextItem_schema_1.RichTextItemSchema,
     VimeoEmbedItemSchema,
-    YoutubeEmbedItemSchema
+    YoutubeEmbedItemSchema,
+    GroupItemSchema
 ]);

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ItemHoverStateParamsSchema = exports.RichTextHoverStateParamsSchema = exports.EmbedHoverStateParamsSchema = exports.CustomItemHoverStateParamsSchema = exports.RectangleHoverStateParamsSchema = exports.MediaHoverStateParamsSchema = exports.ItemHoverStateBaseSchema = exports.getHoverParamsSchema = void 0;
+exports.ItemHoverStateParamsSchema = exports.GroupHoverStateParamsSchema = exports.RichTextHoverStateParamsSchema = exports.EmbedHoverStateParamsSchema = exports.CustomItemHoverStateParamsSchema = exports.RectangleHoverStateParamsSchema = exports.MediaHoverStateParamsSchema = exports.ItemHoverStateBaseSchema = exports.getHoverParamsSchema = void 0;
 const zod_1 = require("zod");
 const getHoverParamsSchema = (schema) => {
     return zod_1.z.object({
@@ -43,10 +43,14 @@ exports.RichTextHoverStateParamsSchema = zod_1.z.object({
     letterSpacing: (0, exports.getHoverParamsSchema)(zod_1.z.number()),
     wordSpacing: (0, exports.getHoverParamsSchema)(zod_1.z.number())
 }).merge(exports.ItemHoverStateBaseSchema);
+exports.GroupHoverStateParamsSchema = zod_1.z.object({
+    opacity: (0, exports.getHoverParamsSchema)(zod_1.z.number().nonnegative())
+}).merge(exports.ItemHoverStateBaseSchema);
 exports.ItemHoverStateParamsSchema = zod_1.z.union([
     exports.EmbedHoverStateParamsSchema,
     exports.MediaHoverStateParamsSchema,
     exports.RectangleHoverStateParamsSchema,
     exports.RichTextHoverStateParamsSchema,
-    exports.CustomItemHoverStateParamsSchema
+    exports.CustomItemHoverStateParamsSchema,
+    exports.GroupHoverStateParamsSchema
 ]);

package/lib/types/article/ArticleItemType.js

@@ -10,4 +10,5 @@ var ArticleItemType;
     ArticleItemType["VimeoEmbed"] = "vimeo-embed";
     ArticleItemType["YoutubeEmbed"] = "youtube-embed";
     ArticleItemType["Custom"] = "custom";
+    ArticleItemType["Group"] = "group";
 })(ArticleItemType = exports.ArticleItemType || (exports.ArticleItemType = {}));

package/package.json

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

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

@@ -1,6 +1,6 @@
 import { z, ZodType } from 'zod';
 import {
-  CustomItem,
+  CustomItem, GroupItem,
   ImageItem,
   RectangleItem,
   VideoItem,
@@ -9,7 +9,7 @@ import {
 } from '../../types/article/Item';
 import {
   CustomItemHoverStateParamsSchema,
-  EmbedHoverStateParamsSchema, MediaHoverStateParamsSchema,
+  EmbedHoverStateParamsSchema, GroupHoverStateParamsSchema, MediaHoverStateParamsSchema,
   RectangleHoverStateParamsSchema
 } from './ItemState.schema';
 import { RichTextItemSchema } from './RichTextItem.schema';
@@ -19,7 +19,9 @@ import { ArticleItemType } from '../../types/article/ArticleItemType';
 const ImageItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.Image),
   commonParams: z.object({
-    url: z.string().min(1)
+    url: z.string().min(1),
+    hasGLEffect: z.boolean().optional(),
+    fragmentShader: z.string().optional()
   }),
   sticky: z.record(
     z.object({
@@ -164,6 +166,26 @@ const YoutubeEmbedItemSchema = ItemBaseSchema.extend({
   })
 }) satisfies ZodType<YoutubeEmbedItem>;
 
+const GroupItemSchema =  ItemBaseSchema.extend({
+  type: z.literal(ArticleItemType.Group),
+  commonParams: z.object({}),
+  itemsIds: z.array(z.string()),
+  sticky: z.record(
+    z.object({
+      from: z.number(),
+      to: z.number().optional()
+    }).nullable(),
+  ),
+  layoutParams: z.record(
+    z.object({
+      opacity: z.number().nonnegative()
+    })
+  ),
+  state: z.object({
+    hover: z.record(GroupHoverStateParamsSchema)
+  })
+}) satisfies ZodType<GroupItem>;
+
 export const ItemSchema = z.discriminatedUnion('type', [
   ImageItemSchema,
   VideoItemSchema,
@@ -171,5 +193,6 @@ export const ItemSchema = z.discriminatedUnion('type', [
   CustomItemSchema,
   RichTextItemSchema,
   VimeoEmbedItemSchema,
-  YoutubeEmbedItemSchema
+  YoutubeEmbedItemSchema,
+  GroupItemSchema
 ]);

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

@@ -1,6 +1,6 @@
 import { z, ZodType } from 'zod';
 import {
-  CustomHoverStateParams, EmbedHoverStateParams,
+  CustomHoverStateParams, EmbedHoverStateParams, GroupHoverStateParams,
   MediaHoverStateParams,
   RectangleHoverStateParams, RichTextHoverStateParams
 } from '../../types/article/ItemState';
@@ -53,10 +53,15 @@ export const RichTextHoverStateParamsSchema = z.object({
   wordSpacing: getHoverParamsSchema(z.number())
 }).merge(ItemHoverStateBaseSchema) satisfies ZodType<RichTextHoverStateParams>;
 
+export const GroupHoverStateParamsSchema = z.object({
+  opacity: getHoverParamsSchema(z.number().nonnegative())
+}).merge(ItemHoverStateBaseSchema) satisfies ZodType<GroupHoverStateParams>;
+
 export const ItemHoverStateParamsSchema = z.union([
   EmbedHoverStateParamsSchema,
   MediaHoverStateParamsSchema,
   RectangleHoverStateParamsSchema,
   RichTextHoverStateParamsSchema,
-  CustomItemHoverStateParamsSchema
+  CustomItemHoverStateParamsSchema,
+  GroupHoverStateParamsSchema
 ]);

package/src/types/article/ArticleItemType.ts

@@ -5,5 +5,6 @@ export enum ArticleItemType {
   Rectangle = 'rectangle',
   VimeoEmbed = 'vimeo-embed',
   YoutubeEmbed = 'youtube-embed',
-  Custom = 'custom'
+  Custom = 'custom',
+  Group = 'group'
 }

package/src/types/article/Item.ts

@@ -11,6 +11,7 @@ export interface Item<T extends ArticleItemType> {
   area: Record<LayoutIdentifier, ItemArea>;
   hidden: Record<LayoutIdentifier, boolean>;
   link?: Link;
+  itemsIds?: T extends ArticleItemType.Group ? string[] : never;
   sticky: Record<LayoutIdentifier, StickyParams | null>;
   commonParams: ItemCommonParamsMap[T];
   state: ItemState<T>;
@@ -25,6 +26,7 @@ export interface ItemCommonParamsMap {
   [ArticleItemType.VimeoEmbed]: VimeoEmbedCommonParams;
   [ArticleItemType.YoutubeEmbed]: YoutubeEmbedCommonParams;
   [ArticleItemType.Custom]: CustomCommonParams;
+  [ArticleItemType.Group]: GroupCommonParams;
 }
 
 export interface ItemLayoutParamsMap {
@@ -35,6 +37,7 @@ export interface ItemLayoutParamsMap {
   [ArticleItemType.VimeoEmbed]: VimeoEmbedLayoutParams;
   [ArticleItemType.YoutubeEmbed]: YoutubeEmbedLayoutParams;
   [ArticleItemType.Custom]: CustomLayoutParams;
+  [ArticleItemType.Group]: GroupLayoutParams;
 }
 
 interface MediaCommonParams {
@@ -43,7 +46,10 @@ interface MediaCommonParams {
 
 interface VideoCommonParams extends MediaCommonParams {}
 
-interface ImageCommonParams extends MediaCommonParams {}
+interface ImageCommonParams extends MediaCommonParams {
+  hasGLEffect?: boolean;
+  fragmentShader?: string;
+}
 
 interface RichTextCommonParams {
   text: string;
@@ -58,6 +64,8 @@ interface CustomCommonParams {
   name: string;
 }
 
+interface GroupCommonParams {}
+
 interface VimeoEmbedCommonParams {
   play: 'on-hover' | 'on-click' | 'auto';
   controls: boolean;
@@ -84,6 +92,10 @@ interface MediaLayoutParams {
 
 interface CustomLayoutParams {}
 
+interface GroupLayoutParams {
+  opacity: number;
+}
+
 interface VimeoEmbedLayoutParams {
   radius: number;
   blur: number;
@@ -148,3 +160,4 @@ export type RichTextItem = Item<ArticleItemType.RichText>;
 export type VimeoEmbedItem = Item<ArticleItemType.VimeoEmbed>;
 export type YoutubeEmbedItem = Item<ArticleItemType.YoutubeEmbed>;
 export type CustomItem = Item<ArticleItemType.Custom>;
+export type GroupItem = Item<ArticleItemType.Group>;

package/src/types/article/ItemState.ts

@@ -16,6 +16,7 @@ export interface ItemHoverStatesMap {
   [ArticleItemType.VimeoEmbed]: EmbedHoverStateParams;
   [ArticleItemType.YoutubeEmbed]: EmbedHoverStateParams;
   [ArticleItemType.Custom]: CustomHoverStateParams;
+  [ArticleItemType.Group]: GroupHoverStateParams;
 }
 
 export interface HoverParams<T> {
@@ -62,3 +63,7 @@ export interface EmbedHoverStateParams extends ItemHoversBaseMap {
 }
 
 export interface CustomHoverStateParams extends ItemHoversBaseMap {}
+
+export interface GroupHoverStateParams extends ItemHoversBaseMap {
+  opacity?: HoverParams<number>;
+}