@cntrl-site/sdk 1.25.10 → 1.25.11-components.0

package/lib/Client/Client.d.ts

@@ -3,6 +3,7 @@ import { Project } from '../types/project/Project';
 import { Layout } from '../types/project/Layout';
 import { Article } from '../types/article/Article';
 import { KeyframeAny } from '../types/keyframe/Keyframe';
+import { CustomComponentMeta } from '../types/customComponent/CustomComponentMeta';
 export declare class Client {
     private fetchImpl;
     private url;
@@ -11,6 +12,8 @@ export declare class Client {
     getPageData(pageSlug: string, buildMode?: 'default' | 'self-hosted'): Promise<CntrlPageData>;
     getProjectPagesPaths(): Promise<string[]>;
     getLayouts(): Promise<Layout[]>;
+    fetchCustomComponents(buildMode?: 'default' | 'self-hosted'): Promise<CustomComponentMeta[]>;
+    fetchCustomComponentBundle(componentId: string, buildMode?: 'default' | 'self-hosted'): Promise<string>;
     private fetchProject;
     private fetchArticle;
     private findArticleIdByPageSlug;
@@ -18,6 +21,7 @@ export declare class Client {
 interface FetchImplResponse {
     ok: boolean;
     json(): Promise<any>;
+    text(): Promise<string>;
     statusText: string;
 }
 type FetchImpl = (url: string, init?: RequestInit) => Promise<FetchImplResponse>;

package/lib/Client/Client.js

@@ -81,6 +81,36 @@ class Client {
             }
         });
     }
+    fetchCustomComponents() {
+        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}/custom-components?buildMode=${buildMode}`, origin);
+            const response = yield this.fetchImpl(url.href, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`
+                }
+            });
+            if (!response.ok) {
+                throw new Error(`Failed to fetch custom components for project #${projectId}: ${response.statusText}`);
+            }
+            return response.json();
+        });
+    }
+    fetchCustomComponentBundle(componentId_1) {
+        return __awaiter(this, arguments, void 0, function* (componentId, buildMode = 'default') {
+            const { username: projectId, password: apiKey, origin } = this.url;
+            const url = new url_1.URL(`/projects/${projectId}/custom-components/${componentId}/bundle.js?buildMode=${buildMode}`, origin);
+            const response = yield this.fetchImpl(url.href, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`
+                }
+            });
+            if (!response.ok) {
+                throw new Error(`Failed to fetch bundle for custom component #${componentId}: ${response.statusText}`);
+            }
+            return response.text();
+        });
+    }
     fetchProject() {
         return __awaiter(this, arguments, void 0, function* (buildMode = 'default') {
             const { username: projectId, password: apiKey, origin } = this.url;

package/lib/index.d.ts

@@ -21,3 +21,4 @@ export type { Meta } from './types/project/Meta';
 export type { KeyframeValueMap, KeyframeAny } from './types/keyframe/Keyframe';
 export type { CompoundSettings } from './types/article/CompoundSettings';
 export type { Dimensions, Left, Position, RectCoordinates, RectObject, ScaleOrigin, Sides, Top } from './types/article/Rect';
+export type { CustomComponentMeta } from './types/customComponent/CustomComponentMeta';

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

@@ -191,7 +191,8 @@ 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()
+        content: zod_1.z.any().optional(),
+        parameters: zod_1.z.record(zod_1.z.any()).optional()
     }),
     sticky: zod_1.z.record(zod_1.z.object({
         from: zod_1.z.number(),

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

@@ -89,6 +89,7 @@ interface YoutubeEmbedCommonParams extends CommonParamsBase {
 interface ComponentCommonParams extends CommonParamsBase {
     componentId: string;
     content?: any;
+    parameters?: Record<string, any>;
 }
 interface MediaLayoutParams {
     opacity: number;

package/lib/types/customComponent/CustomComponentMeta.d.ts

@@ -0,0 +1,5 @@
+export type CustomComponentMeta = {
+    id: string;
+    name: string;
+    schema: Record<string, unknown>;
+};

package/lib/types/customComponent/CustomComponentMeta.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "1.25.10",
+  "version": "1.25.11-components.0",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -8,6 +8,7 @@
     "test": "jest",
     "prebuild": "rimraf ./lib",
     "build": "tsc --project tsconfig.build.json",
+    "build:watch": "tsc --watch --project tsconfig.build.json",
     "prepublishOnly": "cross-env NODE_ENV=production npm run build"
   },
   "bin": {