@cntrl-site/sdk 1.3.0 → 1.4.1

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyframeType = exports.AnchorSide = exports.ScaleAnchor = exports.ArticleItemType = exports.VerticalAlign = exports.TextTransform = exports.TextDecoration = exports.TextAlign = exports.SectionHeightMode = exports.getLayoutMediaQuery = exports.getLayoutStyles = exports.FontFaceGenerator = exports.CntrlClient = void 0;
+exports.KeyframeType = exports.PositionType = exports.AnchorSide = exports.ScaleAnchor = exports.ArticleItemType = exports.VerticalAlign = exports.TextTransform = exports.TextDecoration = exports.TextAlign = exports.SectionHeightMode = exports.getLayoutMediaQuery = exports.getLayoutStyles = exports.FontFaceGenerator = exports.CntrlClient = void 0;
 // logic
 var Client_1 = require("./Client/Client");
 Object.defineProperty(exports, "CntrlClient", { enumerable: true, get: function () { return Client_1.Client; } });
@@ -22,5 +22,6 @@ Object.defineProperty(exports, "ArticleItemType", { enumerable: true, get: funct
 var ItemArea_1 = require("./types/article/ItemArea");
 Object.defineProperty(exports, "ScaleAnchor", { enumerable: true, get: function () { return ItemArea_1.ScaleAnchor; } });
 Object.defineProperty(exports, "AnchorSide", { enumerable: true, get: function () { return ItemArea_1.AnchorSide; } });
+Object.defineProperty(exports, "PositionType", { enumerable: true, get: function () { return ItemArea_1.PositionType; } });
 var Keyframe_1 = require("./types/keyframe/Keyframe");
 Object.defineProperty(exports, "KeyframeType", { enumerable: true, get: function () { return Keyframe_1.KeyframeType; } });

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(),

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

@@ -12,5 +12,6 @@ exports.ItemAreaSchema = zod_1.z.object({
     angle: zod_1.z.number(),
     anchorSide: zod_1.z.nativeEnum(ItemArea_1.AnchorSide).optional(),
     scale: zod_1.z.number().nonnegative(),
+    positionType: zod_1.z.nativeEnum(ItemArea_1.PositionType),
     scaleAnchor: zod_1.z.nativeEnum(ItemArea_1.ScaleAnchor)
 });

package/lib/types/article/ItemArea.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScaleAnchor = exports.AnchorSide = void 0;
+exports.ScaleAnchor = exports.PositionType = exports.AnchorSide = void 0;
 var AnchorSide;
 (function (AnchorSide) {
     AnchorSide["Top"] = "top";
     AnchorSide["Bottom"] = "bottom";
     AnchorSide["Center"] = "center";
 })(AnchorSide = exports.AnchorSide || (exports.AnchorSide = {}));
+var PositionType;
+(function (PositionType) {
+    PositionType["SectionBased"] = "section-based";
+    PositionType["ScreenBased"] = "screen-based";
+})(PositionType = exports.PositionType || (exports.PositionType = {}));
 var ScaleAnchor;
 (function (ScaleAnchor) {
     ScaleAnchor["TopLeft"] = "top-left";

package/package.json

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

package/src/index.ts

@@ -7,7 +7,7 @@ export { getLayoutStyles, getLayoutMediaQuery } from './utils';
 export { SectionHeightMode } from './types/article/Section';
 export { TextAlign, TextDecoration, TextTransform, VerticalAlign } from './types/article/RichText';
 export { ArticleItemType } from './types/article/ArticleItemType';
-export { ScaleAnchor, AnchorSide } from './types/article/ItemArea';
+export { ScaleAnchor, AnchorSide, PositionType } from './types/article/ItemArea';
 export { KeyframeType } from './types/keyframe/Keyframe';
 
 // types

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

@@ -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({

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AnchorSide, ScaleAnchor } from '../../types/article/ItemArea';
+import { AnchorSide, PositionType, ScaleAnchor } from '../../types/article/ItemArea';
 
 export const ItemAreaSchema = z.object({
   top: z.number(),
@@ -10,5 +10,6 @@ export const ItemAreaSchema = z.object({
   angle: z.number(),
   anchorSide: z.nativeEnum(AnchorSide).optional(),
   scale: z.number().nonnegative(),
+  positionType: z.nativeEnum(PositionType),
   scaleAnchor: z.nativeEnum(ScaleAnchor)
 });

package/src/types/article/Item.ts

@@ -43,7 +43,10 @@ interface MediaCommonParams {
 
 interface VideoCommonParams extends MediaCommonParams {}
 
-interface ImageCommonParams extends MediaCommonParams {}
+interface ImageCommonParams extends MediaCommonParams {
+  hasGLEffect?: boolean;
+  fragmentShader?: string;
+}
 
 interface RichTextCommonParams {
   text: string;

package/src/types/article/ItemArea.ts

@@ -4,6 +4,11 @@ export enum AnchorSide {
   Center = 'center'
 }
 
+export enum PositionType {
+  SectionBased = 'section-based',
+  ScreenBased = 'screen-based'
+}
+
 export enum ScaleAnchor {
   TopLeft = 'top-left',
   TopCenter = 'top-center',
@@ -21,6 +26,7 @@ export interface ItemArea {
   left: number;
   width: number;
   height: number;
+  positionType: PositionType;
   zIndex: number;
   angle: number;
   anchorSide?: AnchorSide;