@uniformdev/assets 20.63.0 → 20.63.1-alpha.17

package/dist/index.d.mts

@@ -969,12 +969,20 @@ interface paths {
                      *     This is a list query parameter, and cannot be used with any primary query parameters
                      *      */
                     keyword?: components["parameters"]["keyword"];
+                    /**
+                     * @deprecated
+                     * @description BETA: Semantic search using vector similarity to find assets by meaning.
+                     *     Use this for "images of mountains" style queries.
+                     *     Requires AI credits.
+                     *
+                     */
+                    searchSemantic?: components["parameters"]["searchSemantic"];
                     /** @description Max number of records to return */
                     limit?: components["parameters"]["limit"];
                     /** @description Number of records to skip */
                     offset?: components["parameters"]["offset"];
                     /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
-                     *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
+                     *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
                      *      */
                     orderBy?: components["parameters"]["orderBy"];
                     /**
@@ -1547,8 +1555,16 @@ interface components {
          *     This is a list query parameter, and cannot be used with any primary query parameters
          *      */
         keyword: string;
+        /**
+         * @deprecated
+         * @description BETA: Semantic search using vector similarity to find assets by meaning.
+         *     Use this for "images of mountains" style queries.
+         *     Requires AI credits.
+         *
+         */
+        searchSemantic: string;
         /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
-         *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
+         *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
          *      */
         orderBy: string[];
         /**
@@ -1706,6 +1722,7 @@ type AssetDefinition = {
     namePlural: string;
 };
 declare const assetDefinitions: Record<AssetDefinitionType, AssetDefinition>;
+declare const getAssetDefinitionType: (mimeType: string) => AssetDefinitionType;
 
 /**
  * A union type of possible query parameters for the image delivery API.
@@ -1763,6 +1780,9 @@ declare const imageFrom: (asset: Asset | AssetParamValueItem | 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;
+declare function convertAssetToPutAsset(asset: {
+    asset: Pick<AssetGetResponseSingle['asset'], '_id' | '_dataResources' | '_name' | 'type' | 'labels' | 'fields'>;
+    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 ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, imageFrom };
+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 ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

package/dist/index.d.ts

@@ -969,12 +969,20 @@ interface paths {
                      *     This is a list query parameter, and cannot be used with any primary query parameters
                      *      */
                     keyword?: components["parameters"]["keyword"];
+                    /**
+                     * @deprecated
+                     * @description BETA: Semantic search using vector similarity to find assets by meaning.
+                     *     Use this for "images of mountains" style queries.
+                     *     Requires AI credits.
+                     *
+                     */
+                    searchSemantic?: components["parameters"]["searchSemantic"];
                     /** @description Max number of records to return */
                     limit?: components["parameters"]["limit"];
                     /** @description Number of records to skip */
                     offset?: components["parameters"]["offset"];
                     /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
-                     *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
+                     *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
                      *      */
                     orderBy?: components["parameters"]["orderBy"];
                     /**
@@ -1547,8 +1555,16 @@ interface components {
          *     This is a list query parameter, and cannot be used with any primary query parameters
          *      */
         keyword: string;
+        /**
+         * @deprecated
+         * @description BETA: Semantic search using vector similarity to find assets by meaning.
+         *     Use this for "images of mountains" style queries.
+         *     Requires AI credits.
+         *
+         */
+        searchSemantic: string;
         /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
-         *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
+         *     Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
          *      */
         orderBy: string[];
         /**
@@ -1706,6 +1722,7 @@ type AssetDefinition = {
     namePlural: string;
 };
 declare const assetDefinitions: Record<AssetDefinitionType, AssetDefinition>;
+declare const getAssetDefinitionType: (mimeType: string) => AssetDefinitionType;
 
 /**
  * A union type of possible query parameters for the image delivery API.
@@ -1763,6 +1780,9 @@ declare const imageFrom: (asset: Asset | AssetParamValueItem | 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;
+declare function convertAssetToPutAsset(asset: {
+    asset: Pick<AssetGetResponseSingle['asset'], '_id' | '_dataResources' | '_name' | 'type' | 'labels' | 'fields'>;
+    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 ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, imageFrom };
+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 ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

package/dist/index.esm.js

@@ -42,6 +42,7 @@ var UncachedAssetClient = class extends AssetClient {
 };
 
 // src/definitions.ts
+import { FILE_MIME_TYPES_AUDIO, FILE_MIME_TYPES_IMAGE, FILE_MIME_TYPES_VIDEO } from "@uniformdev/files";
 var assetDefinitions = {
   image: {
     id: "image",
@@ -64,6 +65,18 @@ var assetDefinitions = {
     namePlural: "Other Assets"
   }
 };
+var getAssetDefinitionType = (mimeType) => {
+  if (FILE_MIME_TYPES_IMAGE.includes(mimeType)) {
+    return assetDefinitions.image.id;
+  }
+  if (FILE_MIME_TYPES_VIDEO.includes(mimeType)) {
+    return assetDefinitions.video.id;
+  }
+  if (FILE_MIME_TYPES_AUDIO.includes(mimeType)) {
+    return assetDefinitions.audio.id;
+  }
+  return assetDefinitions.other.id;
+};
 
 // src/imageDelivery.ts
 var isUniformImageUrl = (imageUrl) => {
@@ -161,5 +174,6 @@ export {
   UncachedAssetClient,
   assetDefinitions,
   convertAssetToPutAsset,
+  getAssetDefinitionType,
   imageFrom
 };

package/dist/index.js

@@ -24,6 +24,7 @@ __export(src_exports, {
   UncachedAssetClient: () => UncachedAssetClient,
   assetDefinitions: () => assetDefinitions,
   convertAssetToPutAsset: () => convertAssetToPutAsset,
+  getAssetDefinitionType: () => getAssetDefinitionType,
   imageFrom: () => imageFrom
 });
 module.exports = __toCommonJS(src_exports);
@@ -72,6 +73,7 @@ var UncachedAssetClient = class extends AssetClient {
 };
 
 // src/definitions.ts
+var import_files = require("@uniformdev/files");
 var assetDefinitions = {
   image: {
     id: "image",
@@ -94,6 +96,18 @@ var assetDefinitions = {
     namePlural: "Other Assets"
   }
 };
+var getAssetDefinitionType = (mimeType) => {
+  if (import_files.FILE_MIME_TYPES_IMAGE.includes(mimeType)) {
+    return assetDefinitions.image.id;
+  }
+  if (import_files.FILE_MIME_TYPES_VIDEO.includes(mimeType)) {
+    return assetDefinitions.video.id;
+  }
+  if (import_files.FILE_MIME_TYPES_AUDIO.includes(mimeType)) {
+    return assetDefinitions.audio.id;
+  }
+  return assetDefinitions.other.id;
+};
 
 // src/imageDelivery.ts
 var isUniformImageUrl = (imageUrl) => {
@@ -192,5 +206,6 @@ function convertAssetToPutAsset(asset) {
   UncachedAssetClient,
   assetDefinitions,
   convertAssetToPutAsset,
+  getAssetDefinitionType,
   imageFrom
 });

package/dist/index.mjs

@@ -42,6 +42,7 @@ var UncachedAssetClient = class extends AssetClient {
 };
 
 // src/definitions.ts
+import { FILE_MIME_TYPES_AUDIO, FILE_MIME_TYPES_IMAGE, FILE_MIME_TYPES_VIDEO } from "@uniformdev/files";
 var assetDefinitions = {
   image: {
     id: "image",
@@ -64,6 +65,18 @@ var assetDefinitions = {
     namePlural: "Other Assets"
   }
 };
+var getAssetDefinitionType = (mimeType) => {
+  if (FILE_MIME_TYPES_IMAGE.includes(mimeType)) {
+    return assetDefinitions.image.id;
+  }
+  if (FILE_MIME_TYPES_VIDEO.includes(mimeType)) {
+    return assetDefinitions.video.id;
+  }
+  if (FILE_MIME_TYPES_AUDIO.includes(mimeType)) {
+    return assetDefinitions.audio.id;
+  }
+  return assetDefinitions.other.id;
+};
 
 // src/imageDelivery.ts
 var isUniformImageUrl = (imageUrl) => {
@@ -161,5 +174,6 @@ export {
   UncachedAssetClient,
   assetDefinitions,
   convertAssetToPutAsset,
+  getAssetDefinitionType,
   imageFrom
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/assets",
-  "version": "20.63.0",
+  "version": "20.63.1-alpha.17+cd7eca3818",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -35,10 +35,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.63.0"
+    "@uniformdev/context": "20.63.1-alpha.17+cd7eca3818",
+    "@uniformdev/files": "20.63.1-alpha.17+cd7eca3818"
   },
   "devDependencies": {
     "ts-xor": "^1.3.0"
   },
-  "gitHead": "76729fa5c8c4dc3d71d65fdb181a659755ec34ae"
+  "gitHead": "cd7eca38189533a6ba5899bf872b72e1331c4aa3"
 }