@proveanything/smartlinks 1.11.13 → 1.13.0

package/dist/types/asset.d.ts

@@ -1,63 +1,98 @@
 /**
- * Response from any asset upload or retrieval operation
+ * Slim reference to an asset embedded inside product and collection documents.
+ * Use `asset.get()` with the `id` to retrieve the full `Asset` record.
  */
+export interface AssetRef {
+    /** Postgres UUID — use to fetch the full Asset */
+    id: string;
+    /** CDN URL of the original file */
+    url: string;
+    /** WebP thumbnail URL (max 512px longest edge), or null if not yet generated */
+    thumbnail: string | null;
+}
+/**
+ * A previous file version recorded when `replace` is called on an asset.
+ */
+export interface AssetVersion {
+    url: string;
+    mimeType: string | null;
+    fileType: string | null;
+    size: number | null;
+    hash: string | null;
+    thumbnail: string | null;
+    replacedAt: string;
+    replacedBy: string | null;
+}
 /**
- * Represents an Asset object.
- *
- * Example server response shape:
- * @example
- * {
- *   "name": "Screenshot 2025-09-15 at 15.21.14",
- *   "assetType": "Image",
- *   "type": "png",
- *   "collectionId": "myCollection",
- *   "url": "https://cdn.smartlinks.app/s25-09-15%20at14537.png",
- *   "createdAt": "2005-10-10T23:15:03",
- *   "hash": "fb98140a6b41ee69b824f29cc8b6795444246f871e4ab2379528b34a4d16284e",
- *   "thumbnails": {
- *     "x100": "https://cdn.smartlinks.app/sit2F..._100x100.png",
- *     "x200": "https://cdn.smartlinks.app/sit2F..._200x200.png",
- *     "x512": "https://cdn.smartlinks.app/sit2F..._512x512.png"
- *   },
- *   "id": "7k1cGErrlmQ94J8yDlVj",
- *   "site": "ChaseAtlantic",
- *   "cleanName": "Screenshot 2025-09-15 at 15.21"
- * }
+ * Full Asset object as returned by the platform.
  */
 export interface Asset {
-    /** Unique identifier for the asset */
+    /** Postgres UUID — stable permanent identifier */
     id: string;
-    /** The public URL to access the asset */
+    /** Owning collection */
+    collectionId: string;
+    /** Alias for collectionId (compat) */
+    site: string;
+    /** Set when scoped to a product */
+    productId: string | null;
+    /** Set when scoped to a proof (ledger entry) */
+    proofId: string | null;
+    /** App that owns this asset, e.g. 'homepage' */
+    app: string | null;
+    /** CDN URL of the original file */
     url: string;
+    /**
+     * CDN URL of the WebP thumbnail (max 512px longest edge, no crop).
+     * Always .webp — null until thumbnail generation has run.
+     */
+    thumbnail: string | null;
     /** Original filename */
     name: string;
-    /** MIME type (e.g., 'image/jpeg', 'video/mp4') */
-    mimeType?: string;
+    /** Filename without extension */
+    cleanName: string | null;
+    /** Broad asset classification */
+    assetType: 'Image' | 'Video' | 'Audio' | 'Document';
+    /** File extension, e.g. 'jpg' */
+    fileType: string | null;
+    /** Alias for fileType (compat) */
+    type: string | null;
+    /** MIME type, e.g. 'image/jpeg' */
+    mimeType: string | null;
+    /** Alias for mimeType (compat) */
+    contentType: string | null;
     /** File size in bytes */
-    size?: number;
-    /** When the asset was uploaded */
-    createdAt?: string;
-    /** Any custom metadata attached during upload */
-    metadata?: Record<string, any>;
-    /** Optional: broader classification like 'Image' or 'Video' */
-    assetType?: string;
-    /** Optional: file extension/type shorthand (e.g., 'png') */
-    type?: string;
-    /** Optional: owning collection identifier */
-    collectionId?: string;
-    /** Optional: content hash */
-    hash?: string;
-    /** Optional: CDN thumbnail URLs */
+    size: number | null;
+    /** Width in pixels (images only) */
+    width: number | null;
+    /** Height in pixels (images only) */
+    height: number | null;
+    /** SHA-256 of file content */
+    hash: string | null;
+    /** Arbitrary string labels for filtering */
+    labels: string[];
+    metadata: Record<string, any>;
+    /** Previous file versions, populated by replace */
+    versions: AssetVersion[];
+    /** Firebase UID of admin uploader */
+    uploadedBy: string | null;
+    /** Contact ID for public/token uploads */
+    uploaderContactId: string | null;
+    /** Upload token used for public uploads */
+    uploadTokenId: string | null;
+    uploaderIp: string | null;
+    status: 'active' | 'pending_review' | 'deleted';
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    /**
+     * @deprecated Use `thumbnail` instead. Legacy multi-size thumbnail map.
+     */
     thumbnails?: {
         x100?: string;
         x200?: string;
         x512?: string;
         [key: string]: string | undefined;
     };
-    /** Optional: site identifier alias */
-    site?: string;
-    /** Optional: prettified name */
-    cleanName?: string;
 }
 export type AssetResponse = Asset;
 export interface UploadAssetOptions {
@@ -89,8 +124,8 @@ export interface UploadAssetOptions {
     admin?: boolean;
 }
 /**
- * Options for uploading an asset from a URL
- * The server will fetch the file from the URL and store it in your CDN
+ * Options for uploading an asset from a URL.
+ * The server will fetch the file from the URL and store it in your CDN.
  */
 export interface UploadFromUrlOptions {
     /** The URL of the file to fetch and upload */
@@ -172,3 +207,81 @@ export interface RemoveAssetOptions {
         proofId: string;
     };
 }
+export interface AdminListAssetsOptions {
+    collectionId: string;
+    productId?: string;
+    proofId?: string;
+    appId?: string;
+    assetType?: 'Image' | 'Video' | 'Audio' | 'Document';
+    /** Comma-separated label filter (any match) */
+    labels?: string;
+    sort?: 'createdAt' | 'name' | 'size' | 'assetType';
+    order?: 'asc' | 'desc';
+    limit?: number;
+    offset?: number;
+}
+export interface AdminListAssetsResponse {
+    data: Asset[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface UpdateAssetOptions {
+    collectionId: string;
+    assetId: string;
+    name?: string;
+    app?: string;
+    labels?: string[];
+    metadata?: Record<string, any>;
+    /** Manually override the thumbnail URL */
+    thumbnail?: string;
+}
+export interface ReplaceAssetFileOptions {
+    collectionId: string;
+    assetId: string;
+    file: File;
+    onProgress?: (percent: number) => void;
+}
+export interface DeleteAssetOptions {
+    collectionId: string;
+    assetId: string;
+    /** Days before the file is purged from CDN (default 30) */
+    graceDays?: number;
+}
+export interface BulkDeleteAssetsOptions {
+    collectionId: string;
+    assetIds: string[];
+    graceDays?: number;
+}
+export interface RequestUploadTokenOptions {
+    collectionId: string;
+    appId: string;
+    /** Required when the app policy requireLevel is 'contact' */
+    contactId?: string;
+    productId?: string;
+    proofId?: string;
+}
+export interface UploadTokenPolicy {
+    requireLevel: 'anonymous' | 'contact' | 'owner';
+    allowedMimeTypes: string[];
+    maxFileSizeBytes: number;
+    /** When true, asset is created with status 'pending_review' */
+    reviewRequired: boolean;
+    productId: string | null;
+    proofId: string | null;
+}
+export interface UploadTokenResponse {
+    /** Pass as the X-Upload-Token header when uploading */
+    tokenId: string;
+    expiresAt: string;
+    policy: UploadTokenPolicy;
+}
+export interface PublicTokenUploadOptions {
+    collectionId: string;
+    /** Token ID returned by requestUploadToken */
+    tokenId: string;
+    file: File;
+    name?: string;
+    metadata?: Record<string, any>;
+    onProgress?: (percent: number) => void;
+}

package/dist/types/collection.d.ts

@@ -1,3 +1,4 @@
+import { AssetRef } from "./asset";
 /**
  * Represents a Collection object.
  */
@@ -8,28 +9,10 @@ export interface Collection {
     title: string;
     /** Description of collection */
     description: string;
-    /** URL to the collection's larger header/hero image */
-    headerImage?: {
-        /** URL to the asset */
-        url: string;
-        /** Thumbnail URLs in different sizes */
-        thumbnails: {
-            x100: string;
-            x200: string;
-            x512: string;
-        };
-    };
-    /** URL to the collection's logo image */
-    logoImage?: {
-        /** URL to the asset */
-        url: string;
-        /** Thumbnail URLs in different sizes */
-        thumbnails: {
-            x100: string;
-            x200: string;
-            x512: string;
-        };
-    };
+    /** Slim reference to the collection's header/hero image */
+    headerImage?: AssetRef | null;
+    /** Slim reference to the collection's logo image */
+    logoImage?: AssetRef | null;
     /** Collection's loader image */
     loaderImage?: {
         /** Override name for the file */

package/dist/types/product.d.ts

@@ -1,3 +1,4 @@
+import { AssetRef } from "./asset";
 export type JsonPrimitive = string | number | boolean | null;
 export type JsonValue = JsonPrimitive | JsonValue[] | {
     [key: string]: JsonValue;
@@ -7,29 +8,6 @@ export interface ProductKey {
     collectionId: string;
     id: string;
 }
-export interface ProductImageThumbnails {
-    x100?: string;
-    x200?: string;
-    x512?: string;
-}
-export interface ProductImage {
-    id?: string;
-    collectionId?: string;
-    productId?: string;
-    site?: string;
-    name?: string;
-    cleanName?: string;
-    assetType?: string;
-    type?: string;
-    url?: string;
-    thumbnails?: ProductImageThumbnails;
-    contentType?: string;
-    size?: string | number;
-    hash?: string;
-    createdAt?: ISODateString | null;
-    updatedAt?: ISODateString | null;
-    deletedAt?: ISODateString | null;
-}
 export interface ProductImageUrlInput {
     url: string;
 }
@@ -79,19 +57,31 @@ export interface Product extends ProductKey {
     name: string;
     description?: string | null;
     gtin?: string | null;
-    ownGtin?: boolean | null;
-    additionalGtins?: AdditionalGtin[];
+    ownGtin?: string | null;
+    additionalGtins?: AdditionalGtin[] | null;
     sku?: string | null;
+    /** Canonical type key, e.g. 'ownable-product' */
+    schemaType?: string | null;
+    /** Alias for schemaType (compat) */
+    type?: string | null;
+    /** First segment of schemaType, e.g. 'ownable' */
+    category?: string | null;
     label?: string | null;
-    status?: string | null;
+    status?: 'active' | 'deleted' | null;
     sortOrder?: number | null;
-    heroImage?: ProductImage | null;
+    /** Slim image reference — use `id` to fetch the full Asset record */
+    heroImage?: AssetRef | null;
+    /** Ordered array of additional image references */
+    additionalImages?: AssetRef[];
     facets?: ProductFacetMap;
+    /** Tag keys where value is true */
+    tags?: Record<string, boolean>;
     data?: Record<string, JsonValue>;
     admin?: Record<string, JsonValue>;
     extra?: Record<string, JsonValue>;
-    validCollections?: string[];
+    validCollections?: string[] | null;
     group?: boolean | null;
+    groupKey?: string | null;
     createdAt?: ISODateString | null;
     updatedAt?: ISODateString | null;
     deletedAt?: ISODateString | null;
@@ -104,14 +94,25 @@ export interface ProductWriteInput {
     name: string;
     description?: string | null;
     gtin?: string | null;
-    ownGtin?: boolean | null;
+    ownGtin?: string | null;
     additionalGtins?: AdditionalGtin[];
     sku?: string | null;
+    schemaType?: string | null;
     label?: string | null;
     status?: string | null;
     sortOrder?: number | null;
-    heroImage?: ProductImage | ProductImageUrlInput | string | null;
+    /**
+     * Pass the existing `AssetRef` unchanged to keep the current image,
+     * or a URL string / `{ url }` object to import a new file.
+     */
+    heroImage?: AssetRef | ProductImageUrlInput | string | null;
+    /**
+     * Pass existing `AssetRef` entries unchanged; replace entries with a URL string
+     * or `{ url }` object to import new files.
+     */
+    additionalImages?: Array<AssetRef | ProductImageUrlInput | string>;
     facets?: ProductFacetMap;
+    tags?: Record<string, boolean>;
     data?: Record<string, JsonValue>;
     admin?: Record<string, JsonValue>;
     extra?: Record<string, JsonValue>;