@uniformdev/assets 20.8.2-alpha.31 → 20.9.1-alpha.16

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { ApiClient, ClientOptions } from '@uniformdev/context/api';
+import { XOR } from 'ts-xor';
 
 interface components$1 {
     schemas: {
@@ -218,6 +219,27 @@ interface components$1 {
              * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
              */
             workflowId?: string;
+            /** @description Configurations for previewing an entry on a consuming pattern or composition. */
+            previewConfigurations?: components$1["schemas"]["ContentTypePreviewConfiguration"][];
+        };
+        /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
+        ContentTypePreviewConfiguration: {
+            /**
+             * @description The type of preview configuration
+             * @enum {string}
+             */
+            type: "pattern" | "project-map";
+            /** @description Display label for the preview configuration */
+            label: string;
+            /**
+             * Format: uuid
+             * @description Target preview entity ID (project map node ID or pattern ID)
+             */
+            id: string;
+            /** @description Optional mapping of dynamic input names to their values */
+            dynamicInputs?: {
+                [key: string]: string;
+            };
         };
         /** @description Defines an editable parameter on a component */
         ComponentParameter: {
@@ -1157,6 +1179,14 @@ interface components {
                     /** @constant */
                     type: "number";
                 };
+                focalPoint?: {
+                    value: {
+                        x: number;
+                        y: number;
+                    };
+                    /** @constant */
+                    type: "focalPoint";
+                };
                 /** @description Asset field values */
                 custom?: {
                     [key: string]: components["schemas"]["ComponentParameter"];
@@ -1192,6 +1222,14 @@ interface components {
                     /** @constant */
                     type: "file";
                 };
+                focalPoint?: {
+                    value: {
+                        x: number;
+                        y: number;
+                    };
+                    /** @constant */
+                    type: "focalPoint";
+                };
             };
             _dataResources?: components["schemas"]["DataResourceDefinitions"];
         };
@@ -1497,33 +1535,31 @@ type AssetParamValueItem = {
         };
         /**
          * The width of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
          */
         width?: {
             type: 'number';
-            value: number | string | undefined;
+            value: number | undefined;
         };
         /**
          * The height of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
          */
         height?: {
             type: 'number';
-            value: number | string | undefined;
+            value: number | undefined;
         };
         /**
          * The size in bytes of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
          */
         size?: {
             type: 'number';
-            value: number | string | undefined;
+            value: number | undefined;
+        };
+        focalPoint?: {
+            type: 'focalPoint';
+            value: {
+                x: number;
+                y: number;
+            } | undefined;
         };
         /**
          * Any key/value properties which the source
@@ -1566,10 +1602,32 @@ type AssetDefinition = {
 };
 declare const assetDefinitions: Record<AssetDefinitionType, AssetDefinition>;
 
+type ImageDeliveryParams = XOR<{
+    format: 'original';
+}, {
+    width?: number;
+    height?: number;
+    /**
+     * scale-down - resize the image to fit within the given dimensions, but never larger than the original size, while maintaining the aspect ratio
+     * contain - resize the image to fit within the given dimensions, including possibly enlarging the image, while maintaining the aspect ratio
+     * cover - resize the image to fully cover the given dimensions, cropping as needed
+     *
+     * "cover" additionally supports specifying a focal point via the "focal" parameter
+     */
+    fit?: 'scale-down' | 'contain' | 'cover';
+}, {
+    width?: number;
+    height?: number;
+    /** cover - resize the image to fully cover the given dimensions, cropping as needed */
+    fit: 'cover';
+    /** "string" is in format NxM - N and M are numbers between 0.00 and 1.00, N representing the x-axis and M representing the y-axis */
+    focal: 'auto' | 'center' | string;
+}>;
+
 /**
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
  * Removes things like author, stats, etc.
  */
 declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
 
-export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset };
+export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { ApiClient, ClientOptions } from '@uniformdev/context/api';
+import { XOR } from 'ts-xor';
 
 interface components$1 {
     schemas: {
@@ -218,6 +219,27 @@ interface components$1 {
              * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
              */
             workflowId?: string;
+            /** @description Configurations for previewing an entry on a consuming pattern or composition. */
+            previewConfigurations?: components$1["schemas"]["ContentTypePreviewConfiguration"][];
+        };
+        /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
+        ContentTypePreviewConfiguration: {
+            /**
+             * @description The type of preview configuration
+             * @enum {string}
+             */
+            type: "pattern" | "project-map";
+            /** @description Display label for the preview configuration */
+            label: string;
+            /**
+             * Format: uuid
+             * @description Target preview entity ID (project map node ID or pattern ID)
+             */
+            id: string;
+            /** @description Optional mapping of dynamic input names to their values */
+            dynamicInputs?: {
+                [key: string]: string;
+            };
         };
         /** @description Defines an editable parameter on a component */
         ComponentParameter: {
@@ -1157,6 +1179,14 @@ interface components {
                     /** @constant */
                     type: "number";
                 };
+                focalPoint?: {
+                    value: {
+                        x: number;
+                        y: number;
+                    };
+                    /** @constant */
+                    type: "focalPoint";
+                };
                 /** @description Asset field values */
                 custom?: {
                     [key: string]: components["schemas"]["ComponentParameter"];
@@ -1192,6 +1222,14 @@ interface components {
                     /** @constant */
                     type: "file";
                 };
+                focalPoint?: {
+                    value: {
+                        x: number;
+                        y: number;
+                    };
+                    /** @constant */
+                    type: "focalPoint";
+                };
             };
             _dataResources?: components["schemas"]["DataResourceDefinitions"];
         };
@@ -1497,33 +1535,31 @@ type AssetParamValueItem = {
         };
         /**
          * The width of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
          */
         width?: {
             type: 'number';
-            value: number | string | undefined;
+            value: number | undefined;
         };
         /**
          * The height of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
          */
         height?: {
             type: 'number';
-            value: number | string | undefined;
+            value: number | undefined;
         };
         /**
          * The size in bytes of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
          */
         size?: {
             type: 'number';
-            value: number | string | undefined;
+            value: number | undefined;
+        };
+        focalPoint?: {
+            type: 'focalPoint';
+            value: {
+                x: number;
+                y: number;
+            } | undefined;
         };
         /**
          * Any key/value properties which the source
@@ -1566,10 +1602,32 @@ type AssetDefinition = {
 };
 declare const assetDefinitions: Record<AssetDefinitionType, AssetDefinition>;
 
+type ImageDeliveryParams = XOR<{
+    format: 'original';
+}, {
+    width?: number;
+    height?: number;
+    /**
+     * scale-down - resize the image to fit within the given dimensions, but never larger than the original size, while maintaining the aspect ratio
+     * contain - resize the image to fit within the given dimensions, including possibly enlarging the image, while maintaining the aspect ratio
+     * cover - resize the image to fully cover the given dimensions, cropping as needed
+     *
+     * "cover" additionally supports specifying a focal point via the "focal" parameter
+     */
+    fit?: 'scale-down' | 'contain' | 'cover';
+}, {
+    width?: number;
+    height?: number;
+    /** cover - resize the image to fully cover the given dimensions, cropping as needed */
+    fit: 'cover';
+    /** "string" is in format NxM - N and M are numbers between 0.00 and 1.00, N representing the x-axis and M representing the y-axis */
+    focal: 'auto' | 'center' | string;
+}>;
+
 /**
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
  * Removes things like author, stats, etc.
  */
 declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
 
-export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset };
+export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset };

package/dist/index.esm.js

@@ -64,7 +64,7 @@ var assetDefinitions = {
 
 // src/utils/assetConverter.ts
 function convertAssetToPutAsset(asset) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   return {
     asset: {
       _id: asset.asset._id,
@@ -74,7 +74,8 @@ function convertAssetToPutAsset(asset) {
       fields: {
         title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
         description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
-        file: (_c = asset.asset.fields) == null ? void 0 : _c.file
+        file: (_c = asset.asset.fields) == null ? void 0 : _c.file,
+        focalPoint: (_d = asset.asset.fields) == null ? void 0 : _d.focalPoint
       }
     },
     projectId: asset.projectId

package/dist/index.js

@@ -93,7 +93,7 @@ var assetDefinitions = {
 
 // src/utils/assetConverter.ts
 function convertAssetToPutAsset(asset) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   return {
     asset: {
       _id: asset.asset._id,
@@ -103,7 +103,8 @@ function convertAssetToPutAsset(asset) {
       fields: {
         title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
         description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
-        file: (_c = asset.asset.fields) == null ? void 0 : _c.file
+        file: (_c = asset.asset.fields) == null ? void 0 : _c.file,
+        focalPoint: (_d = asset.asset.fields) == null ? void 0 : _d.focalPoint
       }
     },
     projectId: asset.projectId

package/dist/index.mjs

@@ -64,7 +64,7 @@ var assetDefinitions = {
 
 // src/utils/assetConverter.ts
 function convertAssetToPutAsset(asset) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   return {
     asset: {
       _id: asset.asset._id,
@@ -74,7 +74,8 @@ function convertAssetToPutAsset(asset) {
       fields: {
         title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
         description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
-        file: (_c = asset.asset.fields) == null ? void 0 : _c.file
+        file: (_c = asset.asset.fields) == null ? void 0 : _c.file,
+        focalPoint: (_d = asset.asset.fields) == null ? void 0 : _d.focalPoint
       }
     },
     projectId: asset.projectId

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/assets",
-  "version": "20.8.2-alpha.31+dc19eea5f9",
+  "version": "20.9.1-alpha.16+5d93781920",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -36,7 +36,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.8.2-alpha.31+dc19eea5f9"
+    "@uniformdev/context": "20.9.1-alpha.16+5d93781920"
   },
-  "gitHead": "dc19eea5f979ff3b4526db1dd75a2e1e0f4f43f7"
+  "devDependencies": {
+    "ts-xor": "^1.3.0"
+  },
+  "gitHead": "5d937819205e0fe171a5b51f2e204cddc910cbf3"
 }