@cntrl-site/sdk 1.25.6 → 1.25.8

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/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/index.d.ts

@@ -6,7 +6,7 @@ export { Rect } from './Rect/Rect';
 export { SectionHeightMode } from './types/article/Section';
 export { TextAlign, TextDecoration, TextTransform, VerticalAlign } from './types/article/RichText';
 export { ArticleItemType } from './types/article/ArticleItemType';
-export { AreaAnchor, AnchorSide, DimensionMode, PositionType } from './types/article/ItemArea';
+export { AreaAnchor, AnchorSide, DimensionMode, PositionType, DimensionsType } from './types/article/ItemArea';
 export { KeyframeType } from './types/keyframe/Keyframe';
 export type { Article } from './types/article/Article';
 export type { Section, SectionHeight } from './types/article/Section';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyframeType = exports.PositionType = exports.DimensionMode = exports.AnchorSide = exports.AreaAnchor = exports.ArticleItemType = exports.VerticalAlign = exports.TextTransform = exports.TextDecoration = exports.TextAlign = exports.SectionHeightMode = exports.Rect = exports.ScrollPlaybackVideoManager = exports.measureFont = exports.getLayoutMediaQuery = exports.getLayoutStyles = exports.FontFaceGenerator = exports.CntrlClient = void 0;
+exports.KeyframeType = exports.DimensionsType = exports.PositionType = exports.DimensionMode = exports.AnchorSide = exports.AreaAnchor = exports.ArticleItemType = exports.VerticalAlign = exports.TextTransform = exports.TextDecoration = exports.TextAlign = exports.SectionHeightMode = exports.Rect = exports.ScrollPlaybackVideoManager = exports.measureFont = 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; } });
@@ -29,5 +29,6 @@ Object.defineProperty(exports, "AreaAnchor", { enumerable: true, get: function (
 Object.defineProperty(exports, "AnchorSide", { enumerable: true, get: function () { return ItemArea_1.AnchorSide; } });
 Object.defineProperty(exports, "DimensionMode", { enumerable: true, get: function () { return ItemArea_1.DimensionMode; } });
 Object.defineProperty(exports, "PositionType", { enumerable: true, get: function () { return ItemArea_1.PositionType; } });
+Object.defineProperty(exports, "DimensionsType", { enumerable: true, get: function () { return ItemArea_1.DimensionsType; } });
 var Keyframe_1 = require("./types/keyframe/Keyframe");
 Object.defineProperty(exports, "KeyframeType", { enumerable: true, get: function () { return Keyframe_1.KeyframeType; } });

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AnchorSide, PositionType, AreaAnchor } from '../../types/article/ItemArea';
+import { AnchorSide, PositionType, AreaAnchor, DimensionsType } from '../../types/article/ItemArea';
 export declare const ItemAreaSchema: z.ZodObject<{
     top: z.ZodNumber;
     left: z.ZodNumber;
@@ -10,6 +10,7 @@ export declare const ItemAreaSchema: z.ZodObject<{
     anchorSide: z.ZodOptional<z.ZodNativeEnum<typeof AnchorSide>>;
     scale: z.ZodNumber;
     positionType: z.ZodNativeEnum<typeof PositionType>;
+    dimensionsType: z.ZodOptional<z.ZodNativeEnum<typeof DimensionsType>>;
     scaleAnchor: z.ZodNativeEnum<typeof AreaAnchor>;
 }, "strip", z.ZodTypeAny, {
     left: number;
@@ -22,6 +23,7 @@ export declare const ItemAreaSchema: z.ZodObject<{
     positionType: PositionType;
     scaleAnchor: AreaAnchor;
     anchorSide?: AnchorSide | undefined;
+    dimensionsType?: DimensionsType | undefined;
 }, {
     left: number;
     top: number;
@@ -33,4 +35,5 @@ export declare const ItemAreaSchema: z.ZodObject<{
     positionType: PositionType;
     scaleAnchor: AreaAnchor;
     anchorSide?: AnchorSide | undefined;
+    dimensionsType?: DimensionsType | undefined;
 }>;

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

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

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

@@ -35,6 +35,7 @@ export declare const ItemBaseSchema: z.ZodObject<{
         anchorSide: z.ZodOptional<z.ZodNativeEnum<typeof import("../../types/article/ItemArea").AnchorSide>>;
         scale: z.ZodNumber;
         positionType: z.ZodNativeEnum<typeof import("../../types/article/ItemArea").PositionType>;
+        dimensionsType: z.ZodOptional<z.ZodNativeEnum<typeof import("../../types/article/ItemArea").DimensionsType>>;
         scaleAnchor: z.ZodNativeEnum<typeof AreaAnchor>;
     }, "strip", z.ZodTypeAny, {
         left: number;
@@ -47,6 +48,7 @@ export declare const ItemBaseSchema: z.ZodObject<{
         positionType: import("../../types/article/ItemArea").PositionType;
         scaleAnchor: AreaAnchor;
         anchorSide?: import("../../types/article/ItemArea").AnchorSide | undefined;
+        dimensionsType?: import("../../types/article/ItemArea").DimensionsType | undefined;
     }, {
         left: number;
         top: number;
@@ -58,6 +60,7 @@ export declare const ItemBaseSchema: z.ZodObject<{
         positionType: import("../../types/article/ItemArea").PositionType;
         scaleAnchor: AreaAnchor;
         anchorSide?: import("../../types/article/ItemArea").AnchorSide | undefined;
+        dimensionsType?: import("../../types/article/ItemArea").DimensionsType | undefined;
     }>>;
     hidden: z.ZodRecord<z.ZodString, z.ZodBoolean>;
     link: z.ZodOptional<z.ZodObject<{
@@ -98,6 +101,7 @@ export declare const ItemBaseSchema: z.ZodObject<{
         positionType: import("../../types/article/ItemArea").PositionType;
         scaleAnchor: AreaAnchor;
         anchorSide?: import("../../types/article/ItemArea").AnchorSide | undefined;
+        dimensionsType?: import("../../types/article/ItemArea").DimensionsType | undefined;
     }>;
     link?: {
         url: string;
@@ -123,6 +127,7 @@ export declare const ItemBaseSchema: z.ZodObject<{
         positionType: import("../../types/article/ItemArea").PositionType;
         scaleAnchor: AreaAnchor;
         anchorSide?: import("../../types/article/ItemArea").AnchorSide | undefined;
+        dimensionsType?: import("../../types/article/ItemArea").DimensionsType | undefined;
     }>;
     link?: {
         url: string;

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

@@ -57,6 +57,7 @@ export declare const RichTextItemSchema: z.ZodObject<{
         anchorSide: z.ZodOptional<z.ZodNativeEnum<typeof import("../..").AnchorSide>>;
         scale: z.ZodNumber;
         positionType: z.ZodNativeEnum<typeof import("../..").PositionType>;
+        dimensionsType: z.ZodOptional<z.ZodNativeEnum<typeof import("../..").DimensionsType>>;
         scaleAnchor: z.ZodNativeEnum<typeof import("../..").AreaAnchor>;
     }, "strip", z.ZodTypeAny, {
         left: number;
@@ -69,6 +70,7 @@ export declare const RichTextItemSchema: z.ZodObject<{
         positionType: import("../..").PositionType;
         scaleAnchor: import("../..").AreaAnchor;
         anchorSide?: import("../..").AnchorSide | undefined;
+        dimensionsType?: import("../..").DimensionsType | undefined;
     }, {
         left: number;
         top: number;
@@ -80,6 +82,7 @@ export declare const RichTextItemSchema: z.ZodObject<{
         positionType: import("../..").PositionType;
         scaleAnchor: import("../..").AreaAnchor;
         anchorSide?: import("../..").AnchorSide | undefined;
+        dimensionsType?: import("../..").DimensionsType | undefined;
     }>>;
     compoundSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         positionAnchor: z.ZodNativeEnum<typeof import("../..").AreaAnchor>;
@@ -1007,6 +1010,7 @@ export declare const RichTextItemSchema: z.ZodObject<{
         positionType: import("../..").PositionType;
         scaleAnchor: import("../..").AreaAnchor;
         anchorSide?: import("../..").AnchorSide | undefined;
+        dimensionsType?: import("../..").DimensionsType | undefined;
     }>;
     layoutParams: Record<string, {
         color: string;
@@ -1197,6 +1201,7 @@ export declare const RichTextItemSchema: z.ZodObject<{
         positionType: import("../..").PositionType;
         scaleAnchor: import("../..").AreaAnchor;
         anchorSide?: import("../..").AnchorSide | undefined;
+        dimensionsType?: import("../..").DimensionsType | undefined;
     }>;
     layoutParams: Record<string, {
         color: string;

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

@@ -7,6 +7,10 @@ export declare enum PositionType {
     SectionBased = "section-based",
     ScreenBased = "screen-based"
 }
+export declare enum DimensionsType {
+    PixelsBased = "pixels-based",
+    PercentageBased = "percentage-based"
+}
 export declare enum AreaAnchor {
     TopLeft = "top-left",
     TopCenter = "top-center",
@@ -28,6 +32,7 @@ export interface ItemArea {
     width: number;
     height: number;
     positionType: PositionType;
+    dimensionsType?: DimensionsType;
     zIndex: number;
     angle: number;
     anchorSide?: AnchorSide;

package/lib/types/article/ItemArea.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DimensionMode = exports.AreaAnchor = exports.PositionType = exports.AnchorSide = void 0;
+exports.DimensionMode = exports.AreaAnchor = exports.DimensionsType = exports.PositionType = exports.AnchorSide = void 0;
 var AnchorSide;
 (function (AnchorSide) {
     AnchorSide["Top"] = "top";
@@ -12,6 +12,11 @@ var PositionType;
     PositionType["SectionBased"] = "section-based";
     PositionType["ScreenBased"] = "screen-based";
 })(PositionType || (exports.PositionType = PositionType = {}));
+var DimensionsType;
+(function (DimensionsType) {
+    DimensionsType["PixelsBased"] = "pixels-based";
+    DimensionsType["PercentageBased"] = "percentage-based";
+})(DimensionsType || (exports.DimensionsType = DimensionsType = {}));
 var AreaAnchor;
 (function (AreaAnchor) {
     AreaAnchor["TopLeft"] = "top-left";

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,62 +1,62 @@
-{
-  "name": "@cntrl-site/sdk",
-  "version": "1.25.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",
-    "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.25.8",
+  "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",
+    "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;
+}