@cntrl-site/sdk 1.28.0-6 → 1.28.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 CNTRL
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 CNTRL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,2 +1,2 @@
-# CNTRL SDK
-This is a root SDK module for CNTRL. Should be used along with other framework-specific modules like `@cntrl-site/sdk-react`
+# CNTRL SDK
+This is a root SDK module for CNTRL. Should be used along with other framework-specific modules like `@cntrl-site/sdk-react`

package/lib/Client/Client.d.ts

@@ -18,6 +18,7 @@ export declare class Client {
     getHostname(): string;
     private fetchProject;
     private fetchArticle;
+    private request;
     private findArticleIdByPageSlug;
 }
 interface FetchImplResponse {

package/lib/Client/Client.js

@@ -90,11 +90,7 @@ class Client {
         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}`
-                }
-            });
+            const response = yield this.request(url.href, apiKey);
             if (!response.ok) {
                 throw new Error(`Failed to fetch custom components for project #${projectId}: ${response.statusText}`);
             }
@@ -105,11 +101,7 @@ class Client {
         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}`
-                }
-            });
+            const response = yield this.request(url.href, apiKey);
             if (!response.ok) {
                 throw new Error(`Failed to fetch bundle for custom component #${componentId}: ${response.statusText}`);
             }
@@ -123,11 +115,7 @@ class Client {
         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}?buildMode=${buildMode}`, origin);
-            const response = yield this.fetchImpl(url.href, {
-                headers: {
-                    Authorization: `Bearer ${apiKey}`
-                }
-            });
+            const response = yield this.request(url.href, apiKey);
             if (!response.ok) {
                 throw new Error(`Failed to fetch project with id #${projectId}: ${response.statusText}`);
             }
@@ -140,11 +128,7 @@ class Client {
         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}?buildMode=${buildMode}`, origin);
-            const response = yield this.fetchImpl(url.href, {
-                headers: {
-                    Authorization: `Bearer ${apiKey}`
-                }
-            });
+            const response = yield this.request(url.href, apiKey);
             if (!response.ok) {
                 throw new Error(`Failed to fetch article with id #${articleId}: ${response.statusText}`);
             }
@@ -154,6 +138,16 @@ class Client {
             return { article, keyframes };
         });
     }
+    request(url, apiKey) {
+        const init = {
+            compress: false,
+            headers: {
+                Authorization: `Bearer ${apiKey}`,
+                'Accept-Encoding': 'identity'
+            }
+        };
+        return this.fetchImpl(url, init);
+    }
     findArticleIdByPageSlug(slug, pages) {
         const { username: projectId } = this.url;
         const page = pages.find((page) => page.slug === slug);

package/lib/FontFaceGenerator/FontFaceGenerator.js

@@ -15,12 +15,12 @@ class FontFaceGenerator {
             const otherFiles = font.files
                 .filter(file => file.type !== 'eot')
                 .map(file => `url('${file.url}') format('${FILE_TYPES_MAP[file.type] || file.type}')`);
-            return `
-@font-face {
-  font-family: "${font.name}";
-  font-weight: ${font.weight};
-  font-style: ${font.style};
-  ${eotFile ? `src: url('${eotFile.url}');\n  ` : ''}src: ${otherFiles.join(', ')};
+            return `
+@font-face {
+  font-family: "${font.name}";
+  font-weight: ${font.weight};
+  font-style: ${font.style};
+  ${eotFile ? `src: url('${eotFile.url}');\n  ` : ''}src: ${otherFiles.join(', ')};
 }`;
         }).join('\n');
     }

package/lib/schemas/article/StructuredBlock.schema.d.ts

@@ -6,16 +6,22 @@ export declare const StructuredBlockAreaSchema: z.ZodObject<{
     height: z.ZodOptional<z.ZodNumber>;
     paddingTop: z.ZodOptional<z.ZodNumber>;
     zIndex: z.ZodNumber;
+    alignment: z.ZodOptional<z.ZodEnum<["left", "center", "right"]>>;
+    horizontalOffset: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     zIndex: number;
     width?: number | undefined;
     height?: number | undefined;
     paddingTop?: number | undefined;
+    alignment?: "center" | "left" | "right" | undefined;
+    horizontalOffset?: number | undefined;
 }, {
     zIndex: number;
     width?: number | undefined;
     height?: number | undefined;
     paddingTop?: number | undefined;
+    alignment?: "center" | "left" | "right" | undefined;
+    horizontalOffset?: number | undefined;
 }>;
 export declare const StructuredBlockComponentCommonParamsSchema: z.ZodObject<{
     componentId: z.ZodString;

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

@@ -12,7 +12,9 @@ exports.StructuredBlockAreaSchema = zod_1.z.object({
     width: zod_1.z.number().nonnegative().optional(),
     height: zod_1.z.number().nonnegative().optional(),
     paddingTop: zod_1.z.number().optional(),
-    zIndex: zod_1.z.number()
+    zIndex: zod_1.z.number(),
+    alignment: zod_1.z.enum(['left', 'center', 'right']).optional(),
+    horizontalOffset: zod_1.z.number().optional()
 });
 exports.StructuredBlockComponentCommonParamsSchema = zod_1.z.object({
     componentId: zod_1.z.string(),

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

@@ -8,6 +8,8 @@ export interface StructuredBlockArea {
     height?: number;
     paddingTop?: number;
     zIndex: number;
+    alignment?: 'left' | 'center' | 'right';
+    horizontalOffset?: number;
 }
 export interface StructuredBlockComponentCommonParams {
     componentId: string;

package/lib/utils.js

@@ -8,8 +8,8 @@ function getLayoutStyles(layouts, layoutValues, mapToStyles) {
         .sort((a, b) => a.startsWith - b.startsWith)
         .reduce((acc, layout) => {
         const values = layoutValues.map(lv => lv[layout.id]);
-        return `
-        ${acc}
+        return `
+        ${acc}
         ${layout.startsWith !== 0
             ? `@media (min-width: ${layout.startsWith}px) {${mapToStyles(values, layout.exemplary)}}`
             : `${mapToStyles(values, layout.exemplary)}`}`;

package/package.json

@@ -1,63 +1,63 @@
-{
-  "name": "@cntrl-site/sdk",
-  "version": "1.28.0-6",
-  "description": "Generic SDK for use in public websites.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "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": {
-    "cntrl-sdk": "lib/cli.js"
-  },
-  "files": [
-    "lib",
-    "resources"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cntrl-site/sdk.git"
-  },
-  "author": "arsen@momdesign.nyc",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/cntrl-site/sdk/issues"
-  },
-  "homepage": "https://github.com/cntrl-site/sdk#readme",
-  "directories": {
-    "lib": "lib"
-  },
-  "dependencies": {
-    "@splidejs/react-splide": "^0.7.12",
-    "@types/ejs": "^3.1.2",
-    "@types/isomorphic-fetch": "^0.0.36",
-    "@types/ua-parser-js": "^0.7.39",
-    "commander": "^10.0.1",
-    "dotenv": "^16.1.3",
-    "ejs": "^3.1.9",
-    "isomorphic-fetch": "^3.0.0",
-    "mp4box": "^0.5.2",
-    "styled-jsx": "^5.1.6",
-    "ts-node": "^10.9.1",
-    "ua-parser-js": "^1.0.37",
-    "url": "^0.11.0",
-    "zod": "^3.22.4"
-  },
-  "devDependencies": {
-    "@tsconfig/node16": "^1.0.3",
-    "@tsconfig/recommended": "^1.0.1",
-    "@types/jest": "^29.0.0",
-    "@types/node": "^18.11.7",
-    "@types/react": "^18.2.0",
-    "@types/react-dom": "^18.2.0",
-    "@vitejs/plugin-react": "^4.3.4",
-    "cross-env": "^10.1.0",
-    "jest": "^28.1.3",
-    "ts-jest": "^28.0.8",
-    "typescript": "^5.2.2"
-  }
-}
+{
+  "name": "@cntrl-site/sdk",
+  "version": "1.28.0",
+  "description": "Generic SDK for use in public websites.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "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": {
+    "cntrl-sdk": "lib/cli.js"
+  },
+  "files": [
+    "lib",
+    "resources"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cntrl-site/sdk.git"
+  },
+  "author": "arsen@momdesign.nyc",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/cntrl-site/sdk/issues"
+  },
+  "homepage": "https://github.com/cntrl-site/sdk#readme",
+  "directories": {
+    "lib": "lib"
+  },
+  "dependencies": {
+    "@splidejs/react-splide": "^0.7.12",
+    "@types/ejs": "^3.1.2",
+    "@types/isomorphic-fetch": "^0.0.36",
+    "@types/ua-parser-js": "^0.7.39",
+    "commander": "^10.0.1",
+    "dotenv": "^16.1.3",
+    "ejs": "^3.1.9",
+    "isomorphic-fetch": "^3.0.0",
+    "mp4box": "^0.5.2",
+    "styled-jsx": "^5.1.6",
+    "ts-node": "^10.9.1",
+    "ua-parser-js": "^1.0.37",
+    "url": "^0.11.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@tsconfig/node16": "^1.0.3",
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^18.11.7",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "@vitejs/plugin-react": "^4.3.4",
+    "cross-env": "^10.1.0",
+    "jest": "^28.1.3",
+    "ts-jest": "^28.0.8",
+    "typescript": "^5.2.2"
+  }
+}

package/resources/template.scss.ejs

@@ -1,50 +1,50 @@
-// CAUTION: THIS FILE IS AUTO-GENERATED BASED ON
-// LAYOUT CONFIGURATION IN YOUR CNTRL PROJECT
-// WE HIGHLY ADVICE YOU TO NOT CHANGE IT MANUALLY
-@use "sass:map";
-
-$__CNTRL_LAYOUT_WIDTH__: <%= ranges[0].exemplary %>;
-
-$layout: (
-<% ranges.forEach(function(range) { %>
-    <%= range.name %>: (
-        start: <%= range.start %>,
-        end: <%= range.end %>,
-        exemplary: <%= range.exemplary %>,
-        isFirst: <%= range.isFirst %>,
-        isLast: <%= range.isLast %>
-    ),
-<% }); %>
-);
-
-@function size($value) {
-    @return #{$value/$__CNTRL_LAYOUT_WIDTH__*100}vw;
-}
-
-@mixin for($name) {
-    $start: map.get(map.get($layout, $name), "start");
-    $end: map.get(map.get($layout, $name), "end");
-    $isFirst: map.get(map.get($layout, $name), "isFirst");
-    $isLast: map.get(map.get($layout, $name), "isLast");
-    $exemplary: map.get(map.get($layout, $name), "exemplary");
-    $__CNTRL_LAYOUT_WIDTH__: $exemplary !global;
-
-    @if $isFirst == true and $isLast == true {
-        @content;
-    } @else if $isFirst == true {
-        @media (max-width: #{$end}px) {
-            @content;
-        }
-    } @else if $isLast == true {
-        @media (min-width: #{$start}px) {
-            @content;
-        }
-    } @else {
-        @media (min-width: #{$start}px) and (max-width: #{$end}px) {
-            @content;
-        }
-    }
-
-    // reset global variable back to first layout's exemplary (mobile-first)
-    $__CNTRL_LAYOUT_WIDTH__: <%= ranges[0].exemplary %> !global;
-}
+// CAUTION: THIS FILE IS AUTO-GENERATED BASED ON
+// LAYOUT CONFIGURATION IN YOUR CNTRL PROJECT
+// WE HIGHLY ADVICE YOU TO NOT CHANGE IT MANUALLY
+@use "sass:map";
+
+$__CNTRL_LAYOUT_WIDTH__: <%= ranges[0].exemplary %>;
+
+$layout: (
+<% ranges.forEach(function(range) { %>
+    <%= range.name %>: (
+        start: <%= range.start %>,
+        end: <%= range.end %>,
+        exemplary: <%= range.exemplary %>,
+        isFirst: <%= range.isFirst %>,
+        isLast: <%= range.isLast %>
+    ),
+<% }); %>
+);
+
+@function size($value) {
+    @return #{$value/$__CNTRL_LAYOUT_WIDTH__*100}vw;
+}
+
+@mixin for($name) {
+    $start: map.get(map.get($layout, $name), "start");
+    $end: map.get(map.get($layout, $name), "end");
+    $isFirst: map.get(map.get($layout, $name), "isFirst");
+    $isLast: map.get(map.get($layout, $name), "isLast");
+    $exemplary: map.get(map.get($layout, $name), "exemplary");
+    $__CNTRL_LAYOUT_WIDTH__: $exemplary !global;
+
+    @if $isFirst == true and $isLast == true {
+        @content;
+    } @else if $isFirst == true {
+        @media (max-width: #{$end}px) {
+            @content;
+        }
+    } @else if $isLast == true {
+        @media (min-width: #{$start}px) {
+            @content;
+        }
+    } @else {
+        @media (min-width: #{$start}px) and (max-width: #{$end}px) {
+            @content;
+        }
+    }
+
+    // reset global variable back to first layout's exemplary (mobile-first)
+    $__CNTRL_LAYOUT_WIDTH__: <%= ranges[0].exemplary %> !global;
+}