@cntrl-site/sdk 1.22.19-alpha.1 → 1.22.21-alpha.0

package/dist/Client/Client.d.ts

@@ -8,7 +8,7 @@ export declare class Client {
     private url;
     constructor(APIUrl: string, fetchImpl?: FetchImpl);
     private static getPageMeta;
-    getPageData(pageSlug: string): Promise<CntrlPageData>;
+    getPageData(pageSlug: string, buildMode?: 'default' | 'self-hosted'): Promise<CntrlPageData>;
     getProjectPagesPaths(): Promise<string[]>;
     getLayouts(): Promise<Layout[]>;
     private fetchProject;

package/dist/Client/Client.js

@@ -39,12 +39,12 @@ class Client {
             favicon: (_e = projectMeta.favicon) !== null && _e !== void 0 ? _e : ''
         } : projectMeta;
     }
-    getPageData(pageSlug) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getPageData(pageSlug_1) {
+        return __awaiter(this, arguments, void 0, function* (pageSlug, buildMode = 'default') {
             try {
-                const project = yield this.fetchProject();
+                const project = yield this.fetchProject(buildMode);
                 const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
-                const { article, keyframes } = yield this.fetchArticle(articleId);
+                const { article, keyframes } = yield this.fetchArticle(articleId, buildMode);
                 const page = project.pages.find(page => page.slug === pageSlug);
                 const meta = Client.getPageMeta(project.meta, page === null || page === void 0 ? void 0 : page.meta);
                 return {
@@ -82,9 +82,9 @@ class Client {
         });
     }
     fetchProject() {
-        return __awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, arguments, void 0, function* (buildMode = 'default') {
             const { username: projectId, password: apiKey, origin } = this.url;
-            const url = new url_1.URL(`/projects/${projectId}`, origin);
+            const url = new url_1.URL(`/projects/${projectId}?buildMode=${buildMode}`, origin);
             const response = yield this.fetchImpl(url.href, {
                 headers: {
                     Authorization: `Bearer ${apiKey}`
@@ -98,10 +98,10 @@ class Client {
             return project;
         });
     }
-    fetchArticle(articleId) {
-        return __awaiter(this, void 0, void 0, function* () {
+    fetchArticle(articleId_1) {
+        return __awaiter(this, arguments, void 0, function* (articleId, buildMode = 'default') {
             const { username: projectId, password: apiKey, origin } = this.url;
-            const url = new url_1.URL(`/projects/${projectId}/articles/${articleId}`, origin);
+            const url = new url_1.URL(`/projects/${projectId}/articles/${articleId}?buildMode=${buildMode}`, origin);
             const response = yield this.fetchImpl(url.href, {
                 headers: {
                     Authorization: `Bearer ${apiKey}`

package/dist/index.js

@@ -311,6 +311,7 @@ const VideoItemSchema = ItemBaseSchema.extend({
   ),
   layoutParams: zod.z.record(
     zod.z.object({
+      autoplay: zod.z.boolean(),
       scrollPlayback: zod.z.object({
         from: zod.z.number(),
         to: zod.z.number()
@@ -320,10 +321,7 @@ const VideoItemSchema = ItemBaseSchema.extend({
       strokeWidth: zod.z.number(),
       strokeColor: zod.z.string(),
       blur: zod.z.number(),
-      isDraggable: zod.z.boolean().optional(),
-      play: zod.z.enum(["on-hover", "on-click", "auto"]),
-      muted: zod.z.boolean(),
-      controls: zod.z.boolean()
+      isDraggable: zod.z.boolean().optional()
     })
   ),
   state: zod.z.record(MediaStateParamsSchema)
@@ -374,6 +372,11 @@ const CustomItemSchema = ItemBaseSchema.extend({
 const VimeoEmbedItemSchema = ItemBaseSchema.extend({
   type: zod.z.literal(ArticleItemType.VimeoEmbed),
   commonParams: zod.z.object({
+    play: zod.z.union([zod.z.literal("on-hover"), zod.z.literal("on-click"), zod.z.literal("auto")]),
+    controls: zod.z.boolean(),
+    loop: zod.z.boolean(),
+    muted: zod.z.boolean(),
+    pictureInPicture: zod.z.boolean(),
     url: zod.z.string().min(1),
     coverUrl: zod.z.string().nullable(),
     ratioLock: zod.z.boolean(),
@@ -389,12 +392,7 @@ const VimeoEmbedItemSchema = ItemBaseSchema.extend({
     zod.z.object({
       radius: zod.z.number(),
       blur: zod.z.number(),
-      opacity: zod.z.number().nonnegative(),
-      play: zod.z.union([zod.z.literal("on-hover"), zod.z.literal("on-click"), zod.z.literal("auto")]),
-      controls: zod.z.boolean(),
-      loop: zod.z.boolean(),
-      muted: zod.z.boolean(),
-      pictureInPicture: zod.z.boolean()
+      opacity: zod.z.number().nonnegative()
     })
   ),
   state: zod.z.record(EmbedStateParamsSchema)
@@ -402,6 +400,9 @@ const VimeoEmbedItemSchema = ItemBaseSchema.extend({
 const YoutubeEmbedItemSchema = ItemBaseSchema.extend({
   type: zod.z.literal(ArticleItemType.YoutubeEmbed),
   commonParams: zod.z.object({
+    play: zod.z.enum(["on-hover", "on-click", "auto"]),
+    controls: zod.z.boolean(),
+    loop: zod.z.boolean(),
     url: zod.z.string().min(1),
     coverUrl: zod.z.string().nullable(),
     pointerEvents
@@ -416,10 +417,7 @@ const YoutubeEmbedItemSchema = ItemBaseSchema.extend({
     zod.z.object({
       radius: zod.z.number(),
       blur: zod.z.number(),
-      opacity: zod.z.number().nonnegative(),
-      play: zod.z.enum(["on-hover", "on-click", "auto"]),
-      controls: zod.z.boolean(),
-      loop: zod.z.boolean()
+      opacity: zod.z.number().nonnegative()
     })
   ),
   state: zod.z.record(EmbedStateParamsSchema)
@@ -785,11 +783,11 @@ class Client {
       favicon: projectMeta.favicon ?? ""
     } : projectMeta;
   }
-  async getPageData(pageSlug) {
+  async getPageData(pageSlug, buildMode = "default") {
     try {
-      const project = await this.fetchProject();
+      const project = await this.fetchProject(buildMode);
       const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
-      const { article, keyframes } = await this.fetchArticle(articleId);
+      const { article, keyframes } = await this.fetchArticle(articleId, buildMode);
       const page = project.pages.find((page2) => page2.slug === pageSlug);
       const meta = Client.getPageMeta(project.meta, page == null ? void 0 : page.meta);
       return {
@@ -818,9 +816,9 @@ class Client {
       throw e;
     }
   }
-  async fetchProject() {
+  async fetchProject(buildMode = "default") {
     const { username: projectId, password: apiKey, origin } = this.url;
-    const url$1 = new url.URL(`/projects/${projectId}`, origin);
+    const url$1 = new url.URL(`/projects/${projectId}?buildMode=${buildMode}`, origin);
     const response = await this.fetchImpl(url$1.href, {
       headers: {
         Authorization: `Bearer ${apiKey}`
@@ -833,9 +831,9 @@ class Client {
     const project = ProjectSchema.parse(data);
     return project;
   }
-  async fetchArticle(articleId) {
+  async fetchArticle(articleId, buildMode = "default") {
     const { username: projectId, password: apiKey, origin } = this.url;
-    const url$1 = new url.URL(`/projects/${projectId}/articles/${articleId}`, origin);
+    const url$1 = new url.URL(`/projects/${projectId}/articles/${articleId}?buildMode=${buildMode}`, origin);
     const response = await this.fetchImpl(url$1.href, {
       headers: {
         Authorization: `Bearer ${apiKey}`

package/dist/index.mjs

@@ -292,6 +292,7 @@ const VideoItemSchema = ItemBaseSchema.extend({
   ),
   layoutParams: z.record(
     z.object({
+      autoplay: z.boolean(),
       scrollPlayback: z.object({
         from: z.number(),
         to: z.number()
@@ -301,10 +302,7 @@ const VideoItemSchema = ItemBaseSchema.extend({
       strokeWidth: z.number(),
       strokeColor: z.string(),
       blur: z.number(),
-      isDraggable: z.boolean().optional(),
-      play: z.enum(["on-hover", "on-click", "auto"]),
-      muted: z.boolean(),
-      controls: z.boolean()
+      isDraggable: z.boolean().optional()
     })
   ),
   state: z.record(MediaStateParamsSchema)
@@ -355,6 +353,11 @@ const CustomItemSchema = ItemBaseSchema.extend({
 const VimeoEmbedItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.VimeoEmbed),
   commonParams: z.object({
+    play: z.union([z.literal("on-hover"), z.literal("on-click"), z.literal("auto")]),
+    controls: z.boolean(),
+    loop: z.boolean(),
+    muted: z.boolean(),
+    pictureInPicture: z.boolean(),
     url: z.string().min(1),
     coverUrl: z.string().nullable(),
     ratioLock: z.boolean(),
@@ -370,12 +373,7 @@ const VimeoEmbedItemSchema = ItemBaseSchema.extend({
     z.object({
       radius: z.number(),
       blur: z.number(),
-      opacity: z.number().nonnegative(),
-      play: z.union([z.literal("on-hover"), z.literal("on-click"), z.literal("auto")]),
-      controls: z.boolean(),
-      loop: z.boolean(),
-      muted: z.boolean(),
-      pictureInPicture: z.boolean()
+      opacity: z.number().nonnegative()
     })
   ),
   state: z.record(EmbedStateParamsSchema)
@@ -383,6 +381,9 @@ const VimeoEmbedItemSchema = ItemBaseSchema.extend({
 const YoutubeEmbedItemSchema = ItemBaseSchema.extend({
   type: z.literal(ArticleItemType.YoutubeEmbed),
   commonParams: z.object({
+    play: z.enum(["on-hover", "on-click", "auto"]),
+    controls: z.boolean(),
+    loop: z.boolean(),
     url: z.string().min(1),
     coverUrl: z.string().nullable(),
     pointerEvents
@@ -397,10 +398,7 @@ const YoutubeEmbedItemSchema = ItemBaseSchema.extend({
     z.object({
       radius: z.number(),
       blur: z.number(),
-      opacity: z.number().nonnegative(),
-      play: z.enum(["on-hover", "on-click", "auto"]),
-      controls: z.boolean(),
-      loop: z.boolean()
+      opacity: z.number().nonnegative()
     })
   ),
   state: z.record(EmbedStateParamsSchema)
@@ -766,11 +764,11 @@ class Client {
       favicon: projectMeta.favicon ?? ""
     } : projectMeta;
   }
-  async getPageData(pageSlug) {
+  async getPageData(pageSlug, buildMode = "default") {
     try {
-      const project = await this.fetchProject();
+      const project = await this.fetchProject(buildMode);
       const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
-      const { article, keyframes } = await this.fetchArticle(articleId);
+      const { article, keyframes } = await this.fetchArticle(articleId, buildMode);
       const page = project.pages.find((page2) => page2.slug === pageSlug);
       const meta = Client.getPageMeta(project.meta, page == null ? void 0 : page.meta);
       return {
@@ -799,9 +797,9 @@ class Client {
       throw e;
     }
   }
-  async fetchProject() {
+  async fetchProject(buildMode = "default") {
     const { username: projectId, password: apiKey, origin } = this.url;
-    const url = new URL(`/projects/${projectId}`, origin);
+    const url = new URL(`/projects/${projectId}?buildMode=${buildMode}`, origin);
     const response = await this.fetchImpl(url.href, {
       headers: {
         Authorization: `Bearer ${apiKey}`
@@ -814,9 +812,9 @@ class Client {
     const project = ProjectSchema.parse(data);
     return project;
   }
-  async fetchArticle(articleId) {
+  async fetchArticle(articleId, buildMode = "default") {
     const { username: projectId, password: apiKey, origin } = this.url;
-    const url = new URL(`/projects/${projectId}/articles/${articleId}`, origin);
+    const url = new URL(`/projects/${projectId}/articles/${articleId}?buildMode=${buildMode}`, origin);
     const response = await this.fetchImpl(url.href, {
       headers: {
         Authorization: `Bearer ${apiKey}`

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

@@ -31,16 +31,16 @@ export declare const ArticleSchema: z.ZodObject<{
             offsetX: z.ZodNullable<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
             url: string;
-            coverUrl: string | null;
             play: "on-click" | "auto";
+            coverUrl: string | null;
             position: string;
             type: "video";
             size: string;
             offsetX: number | null;
         }, {
             url: string;
-            coverUrl: string | null;
             play: "on-click" | "auto";
+            coverUrl: string | null;
             position: string;
             type: "video";
             size: string;
@@ -78,8 +78,8 @@ export declare const ArticleSchema: z.ZodObject<{
         name?: string | undefined;
         media?: Record<string, {
             url: string;
-            coverUrl: string | null;
             play: "on-click" | "auto";
+            coverUrl: string | null;
             position: string;
             type: "video";
             size: string;
@@ -105,8 +105,8 @@ export declare const ArticleSchema: z.ZodObject<{
         name?: string | undefined;
         media?: Record<string, {
             url: string;
-            coverUrl: string | null;
             play: "on-click" | "auto";
+            coverUrl: string | null;
             position: string;
             type: "video";
             size: string;
@@ -212,8 +212,8 @@ export declare const ArticleSchema: z.ZodObject<{
         name?: string | undefined;
         media?: Record<string, {
             url: string;
-            coverUrl: string | null;
             play: "on-click" | "auto";
+            coverUrl: string | null;
             position: string;
             type: "video";
             size: string;
@@ -259,8 +259,8 @@ export declare const ArticleSchema: z.ZodObject<{
         name?: string | undefined;
         media?: Record<string, {
             url: string;
-            coverUrl: string | null;
             play: "on-click" | "auto";
+            coverUrl: string | null;
             position: string;
             type: "video";
             size: string;

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

@@ -61,6 +61,7 @@ const VideoItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
         to: zod_1.z.number().optional()
     }).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()
@@ -70,10 +71,7 @@ const VideoItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
         strokeWidth: zod_1.z.number(),
         strokeColor: zod_1.z.string(),
         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(),
+        isDraggable: zod_1.z.boolean().optional()
     })),
     state: zod_1.z.record(ItemState_schema_1.MediaStateParamsSchema)
 });
@@ -117,6 +115,11 @@ const CustomItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
 const VimeoEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     type: zod_1.z.literal(ArticleItemType_1.ArticleItemType.VimeoEmbed),
     commonParams: zod_1.z.object({
+        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(),
         url: zod_1.z.string().min(1),
         coverUrl: zod_1.z.string().nullable(),
         ratioLock: zod_1.z.boolean(),
@@ -129,18 +132,16 @@ const VimeoEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     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()
+        opacity: zod_1.z.number().nonnegative()
     })),
     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({
+        play: zod_1.z.enum(['on-hover', 'on-click', 'auto']),
+        controls: zod_1.z.boolean(),
+        loop: zod_1.z.boolean(),
         url: zod_1.z.string().min(1),
         coverUrl: zod_1.z.string().nullable(),
         pointerEvents
@@ -152,10 +153,7 @@ const YoutubeEmbedItemSchema = ItemBase_schema_1.ItemBaseSchema.extend({
     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(),
+        opacity: zod_1.z.number().nonnegative()
     })),
     state: zod_1.z.record(ItemState_schema_1.EmbedStateParamsSchema)
 });

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

@@ -23,16 +23,16 @@ export declare const SectionMediaSchema: z.ZodDiscriminatedUnion<"type", [z.ZodO
     offsetX: z.ZodNullable<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     url: string;
-    coverUrl: string | null;
     play: "on-click" | "auto";
+    coverUrl: string | null;
     position: string;
     type: "video";
     size: string;
     offsetX: number | null;
 }, {
     url: string;
-    coverUrl: string | null;
     play: "on-click" | "auto";
+    coverUrl: string | null;
     position: string;
     type: "video";
     size: string;
@@ -86,16 +86,16 @@ export declare const SectionSchema: z.ZodObject<{
         offsetX: z.ZodNullable<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         url: string;
-        coverUrl: string | null;
         play: "on-click" | "auto";
+        coverUrl: string | null;
         position: string;
         type: "video";
         size: string;
         offsetX: number | null;
     }, {
         url: string;
-        coverUrl: string | null;
         play: "on-click" | "auto";
+        coverUrl: string | null;
         position: string;
         type: "video";
         size: string;
@@ -133,8 +133,8 @@ export declare const SectionSchema: z.ZodObject<{
     name?: string | undefined;
     media?: Record<string, {
         url: string;
-        coverUrl: string | null;
         play: "on-click" | "auto";
+        coverUrl: string | null;
         position: string;
         type: "video";
         size: string;
@@ -160,8 +160,8 @@ export declare const SectionSchema: z.ZodObject<{
     name?: string | undefined;
     media?: Record<string, {
         url: string;
-        coverUrl: string | null;
         play: "on-click" | "auto";
+        coverUrl: string | null;
         position: string;
         type: "video";
         size: string;

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

@@ -79,10 +79,18 @@ interface CodeEmbedCommonParams extends CommonParamsBase {
     iframe: boolean;
 }
 interface VimeoEmbedCommonParams extends CommonParamsBase {
+    play: 'on-hover' | 'on-click' | 'auto';
+    controls: boolean;
+    loop: boolean;
+    muted: boolean;
+    pictureInPicture: boolean;
     url: string;
     coverUrl: string | null;
 }
 interface YoutubeEmbedCommonParams extends CommonParamsBase {
+    play: 'on-hover' | 'on-click' | 'auto';
+    controls: boolean;
+    loop: boolean;
     url: string;
     coverUrl: string | null;
 }
@@ -117,19 +125,11 @@ interface CodeEmbedLayoutParams {
     isDraggable?: boolean;
 }
 interface VimeoEmbedLayoutParams {
-    play: 'on-hover' | 'on-click' | 'auto';
-    controls: boolean;
-    loop: boolean;
-    muted: boolean;
-    pictureInPicture: boolean;
     radius: number;
     blur: number;
     opacity: number;
 }
 interface YoutubeEmbedLayoutParams {
-    play: 'on-hover' | 'on-click' | 'auto';
-    controls: boolean;
-    loop: boolean;
     radius: number;
     blur: number;
     opacity: number;
@@ -137,9 +137,7 @@ interface YoutubeEmbedLayoutParams {
 interface ImageLayoutParams extends MediaLayoutParams {
 }
 interface VideoLayoutParams extends MediaLayoutParams {
-    play: 'on-hover' | 'on-click' | 'auto';
-    muted: boolean;
-    controls: boolean;
+    autoplay: boolean;
     scrollPlayback: ScrollPlaybackParams | null;
 }
 interface RichTextLayoutParams {

package/package.json

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