@uniformdev/assets 20.77.2-alpha.3.sha-e9420d8e77 → 20.79.0

package/dist/index.d.mts

@@ -386,6 +386,11 @@ interface components$1 {
             _patternDataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
+            /**
+             * Query-string opt-ins coming from a pattern resolved for this component.
+             *     Means nothing for PUTs; it will be ignored
+             */
+            _patternOptedInQueryStrings?: string[];
             _patternError?: components$1["schemas"]["PatternError"];
             /**
              * Defines patch overrides to component IDs that live in the composition.
@@ -459,6 +464,11 @@ interface components$1 {
             _patternDataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
+            /**
+             * Query-string opt-ins coming from a pattern resolved for this component.
+             *     Means nothing for PUTs; it will be ignored
+             */
+            _patternOptedInQueryStrings?: string[];
             _dataResources?: components$1["schemas"]["DataResourceDefinitions"];
             _patternError?: components$1["schemas"]["PatternError"];
             /**
@@ -493,6 +503,12 @@ interface components$1 {
             _overridability?: components$1["schemas"]["ComponentOverridability"];
             /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
             _locales?: string[];
+            /**
+             * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
+             *     Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
+             *     holds only what was authored here. Omitted whenever overrides are resolved.
+             */
+            _optedInQueryStrings?: string[];
         };
         /**
          * Defines how to override a specific component.
@@ -960,6 +976,12 @@ interface components$1 {
             value?: string;
             /** Help text for authors who might be setting up a preview value for this query string */
             helpText?: string;
+            /**
+             * Controls whether a global query string is always shown in Canvas or must be opted into.
+             *     This property is ignored on node-level query strings. When omitted, the query string is always shown.
+
+             */
+            editorVisibility?: "opt-in";
             /** Configuration for providing a list of allowed values for this query string */
             optionsSource?: {
                 /**
@@ -1933,21 +1955,6 @@ interface ImageFromApi {
  */
 declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => ImageFromApi;
 
-type AssetInputFields = NonNullable<NonNullable<AssetUpsertRequest['asset']>['fields']>;
-/**
- * The asset `fields` a write carries. The API assembles `url`, `mediaType`, `size`, `width` and
- * `height` from the attached file on every read, and the write schema rejects those along with
- * `custom`, so a write can neither send nor settle them.
- *
- * The CLI's asset comparator projects onto this same list, so a push only reports a difference a
- * push can act on.
- */
-declare const WRITABLE_ASSET_FIELDS: readonly ["title", "description", "file", "focalPoint"];
-/**
- * Selects the asset fields a write carries, dropping the ones the API computes from the attached
- * file. Returns a new object rather than editing the asset it reads.
- */
-declare const selectWritableAssetFields: (fields?: Asset["fields"]) => AssetInputFields;
 /**
  * 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.
@@ -1957,4 +1964,4 @@ declare function convertAssetToPutAsset(asset: {
     projectId: string;
 }): 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, type ImageDeliveryParams, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, WRITABLE_ASSET_FIELDS, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom, selectWritableAssetFields };
+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, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

package/dist/index.d.ts

@@ -386,6 +386,11 @@ interface components$1 {
             _patternDataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
+            /**
+             * Query-string opt-ins coming from a pattern resolved for this component.
+             *     Means nothing for PUTs; it will be ignored
+             */
+            _patternOptedInQueryStrings?: string[];
             _patternError?: components$1["schemas"]["PatternError"];
             /**
              * Defines patch overrides to component IDs that live in the composition.
@@ -459,6 +464,11 @@ interface components$1 {
             _patternDataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
+            /**
+             * Query-string opt-ins coming from a pattern resolved for this component.
+             *     Means nothing for PUTs; it will be ignored
+             */
+            _patternOptedInQueryStrings?: string[];
             _dataResources?: components$1["schemas"]["DataResourceDefinitions"];
             _patternError?: components$1["schemas"]["PatternError"];
             /**
@@ -493,6 +503,12 @@ interface components$1 {
             _overridability?: components$1["schemas"]["ComponentOverridability"];
             /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
             _locales?: string[];
+            /**
+             * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
+             *     Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
+             *     holds only what was authored here. Omitted whenever overrides are resolved.
+             */
+            _optedInQueryStrings?: string[];
         };
         /**
          * Defines how to override a specific component.
@@ -960,6 +976,12 @@ interface components$1 {
             value?: string;
             /** Help text for authors who might be setting up a preview value for this query string */
             helpText?: string;
+            /**
+             * Controls whether a global query string is always shown in Canvas or must be opted into.
+             *     This property is ignored on node-level query strings. When omitted, the query string is always shown.
+
+             */
+            editorVisibility?: "opt-in";
             /** Configuration for providing a list of allowed values for this query string */
             optionsSource?: {
                 /**
@@ -1933,21 +1955,6 @@ interface ImageFromApi {
  */
 declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => ImageFromApi;
 
-type AssetInputFields = NonNullable<NonNullable<AssetUpsertRequest['asset']>['fields']>;
-/**
- * The asset `fields` a write carries. The API assembles `url`, `mediaType`, `size`, `width` and
- * `height` from the attached file on every read, and the write schema rejects those along with
- * `custom`, so a write can neither send nor settle them.
- *
- * The CLI's asset comparator projects onto this same list, so a push only reports a difference a
- * push can act on.
- */
-declare const WRITABLE_ASSET_FIELDS: readonly ["title", "description", "file", "focalPoint"];
-/**
- * Selects the asset fields a write carries, dropping the ones the API computes from the attached
- * file. Returns a new object rather than editing the asset it reads.
- */
-declare const selectWritableAssetFields: (fields?: Asset["fields"]) => AssetInputFields;
 /**
  * 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.
@@ -1957,4 +1964,4 @@ declare function convertAssetToPutAsset(asset: {
     projectId: string;
 }): 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, type ImageDeliveryParams, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, WRITABLE_ASSET_FIELDS, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom, selectWritableAssetFields };
+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, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

package/dist/index.esm.js

@@ -172,21 +172,8 @@ var imageFrom = (asset) => {
 };
 
 // src/utils/assetConverter.ts
-var WRITABLE_ASSET_FIELDS = [
-  "title",
-  "description",
-  "file",
-  "focalPoint"
-];
-var selectProperties = (source, names) => {
-  const selected = {};
-  for (const name of names) {
-    selected[name] = source[name];
-  }
-  return selected;
-};
-var selectWritableAssetFields = (fields = {}) => selectProperties(fields, WRITABLE_ASSET_FIELDS);
 function convertAssetToPutAsset(asset) {
+  var _a, _b, _c, _d;
   return {
     asset: {
       _id: asset.asset._id,
@@ -194,7 +181,12 @@ function convertAssetToPutAsset(asset) {
       _name: asset.asset._name,
       type: asset.asset.type,
       labels: asset.asset.labels,
-      fields: selectWritableAssetFields(asset.asset.fields)
+      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,
+        focalPoint: (_d = asset.asset.fields) == null ? void 0 : _d.focalPoint
+      }
     },
     projectId: asset.projectId
   };
@@ -202,10 +194,8 @@ function convertAssetToPutAsset(asset) {
 export {
   AssetClient,
   UncachedAssetClient,
-  WRITABLE_ASSET_FIELDS,
   assetDefinitions,
   convertAssetToPutAsset,
   getAssetDefinitionType,
-  imageFrom,
-  selectWritableAssetFields
+  imageFrom
 };

package/dist/index.js

@@ -22,12 +22,10 @@ var index_exports = {};
 __export(index_exports, {
   AssetClient: () => AssetClient,
   UncachedAssetClient: () => UncachedAssetClient,
-  WRITABLE_ASSET_FIELDS: () => WRITABLE_ASSET_FIELDS,
   assetDefinitions: () => assetDefinitions,
   convertAssetToPutAsset: () => convertAssetToPutAsset,
   getAssetDefinitionType: () => getAssetDefinitionType,
-  imageFrom: () => imageFrom,
-  selectWritableAssetFields: () => selectWritableAssetFields
+  imageFrom: () => imageFrom
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -205,21 +203,8 @@ var imageFrom = (asset) => {
 };
 
 // src/utils/assetConverter.ts
-var WRITABLE_ASSET_FIELDS = [
-  "title",
-  "description",
-  "file",
-  "focalPoint"
-];
-var selectProperties = (source, names) => {
-  const selected = {};
-  for (const name of names) {
-    selected[name] = source[name];
-  }
-  return selected;
-};
-var selectWritableAssetFields = (fields = {}) => selectProperties(fields, WRITABLE_ASSET_FIELDS);
 function convertAssetToPutAsset(asset) {
+  var _a, _b, _c, _d;
   return {
     asset: {
       _id: asset.asset._id,
@@ -227,7 +212,12 @@ function convertAssetToPutAsset(asset) {
       _name: asset.asset._name,
       type: asset.asset.type,
       labels: asset.asset.labels,
-      fields: selectWritableAssetFields(asset.asset.fields)
+      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,
+        focalPoint: (_d = asset.asset.fields) == null ? void 0 : _d.focalPoint
+      }
     },
     projectId: asset.projectId
   };
@@ -236,10 +226,8 @@ function convertAssetToPutAsset(asset) {
 0 && (module.exports = {
   AssetClient,
   UncachedAssetClient,
-  WRITABLE_ASSET_FIELDS,
   assetDefinitions,
   convertAssetToPutAsset,
   getAssetDefinitionType,
-  imageFrom,
-  selectWritableAssetFields
+  imageFrom
 });

package/dist/index.mjs

@@ -172,21 +172,8 @@ var imageFrom = (asset) => {
 };
 
 // src/utils/assetConverter.ts
-var WRITABLE_ASSET_FIELDS = [
-  "title",
-  "description",
-  "file",
-  "focalPoint"
-];
-var selectProperties = (source, names) => {
-  const selected = {};
-  for (const name of names) {
-    selected[name] = source[name];
-  }
-  return selected;
-};
-var selectWritableAssetFields = (fields = {}) => selectProperties(fields, WRITABLE_ASSET_FIELDS);
 function convertAssetToPutAsset(asset) {
+  var _a, _b, _c, _d;
   return {
     asset: {
       _id: asset.asset._id,
@@ -194,7 +181,12 @@ function convertAssetToPutAsset(asset) {
       _name: asset.asset._name,
       type: asset.asset.type,
       labels: asset.asset.labels,
-      fields: selectWritableAssetFields(asset.asset.fields)
+      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,
+        focalPoint: (_d = asset.asset.fields) == null ? void 0 : _d.focalPoint
+      }
     },
     projectId: asset.projectId
   };
@@ -202,10 +194,8 @@ function convertAssetToPutAsset(asset) {
 export {
   AssetClient,
   UncachedAssetClient,
-  WRITABLE_ASSET_FIELDS,
   assetDefinitions,
   convertAssetToPutAsset,
   getAssetDefinitionType,
-  imageFrom,
-  selectWritableAssetFields
+  imageFrom
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/assets",
-  "version": "20.77.2-alpha.3.sha-e9420d8e77",
+  "version": "20.79.0",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -37,11 +37,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.77.2-alpha.3.sha-e9420d8e77",
-    "@uniformdev/files": "20.77.2-alpha.3.sha-e9420d8e77"
+    "@uniformdev/context": "20.79.0",
+    "@uniformdev/files": "20.79.0"
   },
   "devDependencies": {
     "ts-xor": "^1.3.0"
   },
-  "gitHead": "e9420d8e77e7b9b0c5ea14bfe38f1f16a9a236ee"
+  "gitHead": "f419f94df6de01601261042943593cabfd739357"
 }