@gxpl/sdk 0.0.1

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

@@ -0,0 +1,40 @@
+import { z, ZodType } from 'zod';
+import { ItemAny } from '../../types/article/Item';
+export declare const FXControlSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"float">;
+    shaderParam: z.ZodString;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    type: "float";
+    shaderParam: string;
+}, {
+    value: number;
+    type: "float";
+    shaderParam: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"int">;
+    shaderParam: z.ZodString;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    type: "int";
+    shaderParam: string;
+}, {
+    value: number;
+    type: "int";
+    shaderParam: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"vec2">;
+    shaderParam: z.ZodString;
+    value: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+}, "strip", z.ZodTypeAny, {
+    value: [number, number];
+    type: "vec2";
+    shaderParam: string;
+}, {
+    value: [number, number];
+    type: "vec2";
+    shaderParam: string;
+}>]>;
+export declare const ItemSchema: ZodType<ItemAny>;

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

@@ -0,0 +1,242 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+const ItemArea_1 = require("../../types/article/ItemArea");
+const FillLayer_schema_1 = require("./FillLayer.schema");
+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'),
+        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 FXParams = zod_1.z.object({
+    url: zod_1.z.string().min(1),
+    hasGLEffect: zod_1.z.boolean().optional(),
+    fragmentShader: zod_1.z.string().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({
+        pointerEvents
+    }).merge(FXParams),
+    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(),
+        radius: zod_1.z.number(),
+        strokeWidth: zod_1.z.number(),
+        strokeFill: zod_1.z.array(FillLayer_schema_1.FillLayerSchema),
+        blur: zod_1.z.number(),
+        isDraggable: zod_1.z.boolean().optional()
+    })),
+    state: zod_1.z.record(ItemState_schema_1.MediaStateParamsSchema)
+});
+const VideoItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
+    type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Video),
+    commonParams: zod_1.z.object({
+        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()
+    }).nullable()),
+    layoutParams: zod_1.z.record(zod_1.z.object({
+        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(),
+        strokeFill: zod_1.z.array(FillLayer_schema_1.FillLayerSchema),
+        blur: zod_1.z.number(),
+        isDraggable: zod_1.z.boolean().optional(),
+        play: zod_1.z.enum(['on-hover', 'on-click', 'auto']),
+        muted: zod_1.z.boolean(),
+        controls: zod_1.z.boolean(),
+    })),
+    state: zod_1.z.record(ItemState_schema_1.MediaStateParamsSchema)
+});
+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(),
+        pointerEvents
+    }),
+    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({
+        radius: zod_1.z.number(),
+        strokeWidth: zod_1.z.number(),
+        fill: zod_1.z.array(FillLayer_schema_1.FillLayerSchema),
+        strokeFill: zod_1.z.array(FillLayer_schema_1.FillLayerSchema),
+        blur: zod_1.z.number(),
+        backdropBlur: zod_1.z.number(),
+        blurMode: zod_1.z.enum(['default', 'backdrop']),
+        isDraggable: zod_1.z.boolean().optional()
+    })),
+    state: zod_1.z.record(ItemState_schema_1.RectangleStateParamsSchema)
+});
+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(),
+        pointerEvents
+    }),
+    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({
+        isDraggable: zod_1.z.boolean().optional()
+    })),
+    state: zod_1.z.record(ItemState_schema_1.CustomItemStateParamsSchema)
+});
+const VimeoEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
+    type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.VimeoEmbed),
+    commonParams: zod_1.z.object({
+        url: zod_1.z.string().min(1),
+        coverUrl: zod_1.z.string().nullable(),
+        ratioLock: zod_1.z.boolean(),
+        pointerEvents
+    }),
+    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({
+        radius: zod_1.z.number(),
+        blur: zod_1.z.number(),
+        opacity: zod_1.z.number().nonnegative(),
+        play: zod_1.z.union([zod_1.z.literal('on-hover'), zod_1.z.literal('on-click'), zod_1.z.literal('auto')]),
+        controls: zod_1.z.boolean(),
+        loop: zod_1.z.boolean(),
+        muted: zod_1.z.boolean(),
+        pictureInPicture: zod_1.z.boolean()
+    })),
+    state: zod_1.z.record(ItemState_schema_1.EmbedStateParamsSchema)
+});
+const YoutubeEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
+    type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.YoutubeEmbed),
+    commonParams: zod_1.z.object({
+        url: zod_1.z.string().min(1),
+        coverUrl: zod_1.z.string().nullable(),
+        pointerEvents
+    }),
+    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({
+        radius: zod_1.z.number(),
+        blur: zod_1.z.number(),
+        opacity: zod_1.z.number().nonnegative(),
+        play: zod_1.z.enum(['on-hover', 'on-click', 'auto']),
+        controls: zod_1.z.boolean(),
+        loop: zod_1.z.boolean(),
+    })),
+    state: zod_1.z.record(ItemState_schema_1.EmbedStateParamsSchema)
+});
+const CodeEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
+    type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.CodeEmbed),
+    commonParams: zod_1.z.object({
+        html: zod_1.z.string(),
+        scale: zod_1.z.boolean(),
+        iframe: zod_1.z.boolean(),
+        pointerEvents
+    }),
+    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({
+        areaAnchor: zod_1.z.nativeEnum(ItemArea_1.AreaAnchor),
+        opacity: zod_1.z.number().nonnegative(),
+        blur: zod_1.z.number(),
+        isDraggable: zod_1.z.boolean().optional()
+    })),
+    state: zod_1.z.record(ItemState_schema_1.CodeEmbedStateParamsSchema)
+});
+const ComponentItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
+    type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Component),
+    commonParams: zod_1.z.object({
+        componentId: zod_1.z.string(),
+        content: zod_1.z.any().optional()
+    }),
+    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({
+        parameters: zod_1.z.any().optional(),
+        opacity: zod_1.z.number().nonnegative(),
+        blur: zod_1.z.number()
+    })),
+    state: zod_1.z.record(ItemState_schema_1.ComponentStateParamsSchema)
+});
+exports.ItemSchema = zod_1.z.lazy(() => zod_1.z.discriminatedUnion('type', [
+    ImageItemSchema,
+    VideoItemSchema,
+    RectangleItemSchema,
+    CustomItemSchema,
+    RichTextItem_schema_1.RichTextItemSchema,
+    VimeoEmbedItemSchema,
+    YoutubeEmbedItemSchema,
+    CodeEmbedItemSchema,
+    ComponentItemSchema,
+    ItemBase_schema_1.ItemBaseSchema.extend({
+        type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.Group),
+        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(),
+            to: zod_1.z.number().optional()
+        }).nullable()),
+        layoutParams: zod_1.z.record(zod_1.z.object({
+            opacity: zod_1.z.number().nonnegative(),
+            blur: zod_1.z.number()
+        })),
+        state: zod_1.z.record(ItemState_schema_1.GroupStateParamsSchema)
+    }),
+    ItemBase_schema_1.ItemBaseSchema.extend({
+        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({
+            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.record(ItemState_schema_1.CompoundStateParamsSchema)
+    })
+]));

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

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+import { AnchorSide, PositionType, AreaAnchor } from '../../types/article/ItemArea';
+export declare const ItemAreaSchema: z.ZodObject<{
+    top: z.ZodNumber;
+    left: z.ZodNumber;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    zIndex: z.ZodNumber;
+    angle: z.ZodNumber;
+    anchorSide: z.ZodOptional<z.ZodNativeEnum<typeof AnchorSide>>;
+    scale: z.ZodNumber;
+    positionType: z.ZodNativeEnum<typeof PositionType>;
+    scaleAnchor: z.ZodNativeEnum<typeof AreaAnchor>;
+}, "strip", z.ZodTypeAny, {
+    left: number;
+    top: number;
+    scale: number;
+    angle: number;
+    width: number;
+    height: number;
+    zIndex: number;
+    positionType: PositionType;
+    scaleAnchor: AreaAnchor;
+    anchorSide?: AnchorSide | undefined;
+}, {
+    left: number;
+    top: number;
+    scale: number;
+    angle: number;
+    width: number;
+    height: number;
+    zIndex: number;
+    positionType: PositionType;
+    scaleAnchor: AreaAnchor;
+    anchorSide?: AnchorSide | undefined;
+}>;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemAreaSchema = void 0;
+const zod_1 = require("zod");
+const ItemArea_1 = require("../../types/article/ItemArea");
+exports.ItemAreaSchema = zod_1.z.object({
+    top: zod_1.z.number(),
+    left: zod_1.z.number(),
+    width: zod_1.z.number(),
+    height: zod_1.z.number(),
+    zIndex: zod_1.z.number(),
+    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.AreaAnchor)
+});

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

@@ -0,0 +1,137 @@
+import { z } from 'zod';
+import { AreaAnchor, DimensionMode } from '../../types/article/ItemArea';
+export declare const Link: z.ZodObject<{
+    url: z.ZodString;
+    target: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    target: string;
+}, {
+    url: string;
+    target: string;
+}>;
+export declare const CompoundSettingsSchema: z.ZodObject<{
+    positionAnchor: z.ZodNativeEnum<typeof AreaAnchor>;
+    widthMode: z.ZodNativeEnum<typeof DimensionMode>;
+    heightMode: z.ZodNativeEnum<typeof DimensionMode>;
+}, "strip", z.ZodTypeAny, {
+    positionAnchor: AreaAnchor;
+    widthMode: DimensionMode;
+    heightMode: DimensionMode;
+}, {
+    positionAnchor: AreaAnchor;
+    widthMode: DimensionMode;
+    heightMode: DimensionMode;
+}>;
+export declare const ItemBaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    area: z.ZodRecord<z.ZodString, z.ZodObject<{
+        top: z.ZodNumber;
+        left: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        zIndex: z.ZodNumber;
+        angle: z.ZodNumber;
+        anchorSide: z.ZodOptional<z.ZodNativeEnum<typeof import('../../types/article/ItemArea').AnchorSide>>;
+        scale: z.ZodNumber;
+        positionType: z.ZodNativeEnum<typeof import('../../types/article/ItemArea').PositionType>;
+        scaleAnchor: z.ZodNativeEnum<typeof AreaAnchor>;
+    }, "strip", z.ZodTypeAny, {
+        left: number;
+        top: number;
+        scale: number;
+        angle: number;
+        width: number;
+        height: number;
+        zIndex: number;
+        positionType: import('../../types/article/ItemArea').PositionType;
+        scaleAnchor: AreaAnchor;
+        anchorSide?: import('../../types/article/ItemArea').AnchorSide | undefined;
+    }, {
+        left: number;
+        top: number;
+        scale: number;
+        angle: number;
+        width: number;
+        height: number;
+        zIndex: number;
+        positionType: import('../../types/article/ItemArea').PositionType;
+        scaleAnchor: AreaAnchor;
+        anchorSide?: import('../../types/article/ItemArea').AnchorSide | undefined;
+    }>>;
+    hidden: z.ZodRecord<z.ZodString, z.ZodBoolean>;
+    link: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        target: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        target: string;
+    }, {
+        url: string;
+        target: string;
+    }>>;
+    compoundSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        positionAnchor: z.ZodNativeEnum<typeof AreaAnchor>;
+        widthMode: z.ZodNativeEnum<typeof DimensionMode>;
+        heightMode: z.ZodNativeEnum<typeof DimensionMode>;
+    }, "strip", z.ZodTypeAny, {
+        positionAnchor: AreaAnchor;
+        widthMode: DimensionMode;
+        heightMode: DimensionMode;
+    }, {
+        positionAnchor: AreaAnchor;
+        widthMode: DimensionMode;
+        heightMode: DimensionMode;
+    }>>>;
+    layoutParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    hidden: Record<string, boolean>;
+    id: string;
+    area: Record<string, {
+        left: number;
+        top: number;
+        scale: number;
+        angle: number;
+        width: number;
+        height: number;
+        zIndex: number;
+        positionType: import('../../types/article/ItemArea').PositionType;
+        scaleAnchor: AreaAnchor;
+        anchorSide?: import('../../types/article/ItemArea').AnchorSide | undefined;
+    }>;
+    link?: {
+        url: string;
+        target: string;
+    } | undefined;
+    compoundSettings?: Record<string, {
+        positionAnchor: AreaAnchor;
+        widthMode: DimensionMode;
+        heightMode: DimensionMode;
+    }> | undefined;
+    layoutParams?: Record<string, any> | undefined;
+}, {
+    hidden: Record<string, boolean>;
+    id: string;
+    area: Record<string, {
+        left: number;
+        top: number;
+        scale: number;
+        angle: number;
+        width: number;
+        height: number;
+        zIndex: number;
+        positionType: import('../../types/article/ItemArea').PositionType;
+        scaleAnchor: AreaAnchor;
+        anchorSide?: import('../../types/article/ItemArea').AnchorSide | undefined;
+    }>;
+    link?: {
+        url: string;
+        target: string;
+    } | undefined;
+    compoundSettings?: Record<string, {
+        positionAnchor: AreaAnchor;
+        widthMode: DimensionMode;
+        heightMode: DimensionMode;
+    }> | undefined;
+    layoutParams?: Record<string, any> | undefined;
+}>;

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemBaseSchema = exports.CompoundSettingsSchema = exports.Link = void 0;
+const zod_1 = require("zod");
+const ItemArea_schema_1 = require("./ItemArea.schema");
+const ItemArea_1 = require("../../types/article/ItemArea");
+exports.Link = zod_1.z.object({
+    url: zod_1.z.string().min(1),
+    target: 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),
+    heightMode: zod_1.z.nativeEnum(ItemArea_1.DimensionMode),
+});
+exports.ItemBaseSchema = zod_1.z.object({
+    id: zod_1.z.string().min(1),
+    area: zod_1.z.record(ItemArea_schema_1.ItemAreaSchema),
+    hidden: zod_1.z.record(zod_1.z.boolean()),
+    link: exports.Link.optional(),
+    compoundSettings: zod_1.z.record(exports.CompoundSettingsSchema).optional(),
+    layoutParams: zod_1.z.record(zod_1.z.any()).optional()
+});