@proveanything/smartlinks 1.12.0 → 1.13.0

package/README.md

@@ -363,21 +363,36 @@ await asset.remove({
 
 ```json
 {
-  "name": "Screenshot 2025-09-15 at 15.21.14",
+  "id": "aBcDeFgHiJkLmNoPqRsT",
+  "collectionId": "acme-demo",
+  "site": "acme-demo",
+  "productId": null,
+  "proofId": null,
+  "app": null,
+  "name": "product-hero-shot",
+  "cleanName": "product-hero-shot",
   "assetType": "Image",
+  "fileType": "png",
   "type": "png",
-  "collectionId": "ChaseAtlantic",
-  "url": "https://cdn.smartlinks.app/sites%2FChaseAtlantic%2Fimages%2F2025%2F9%2FScreenshot%202025-09-15%20at%2015%2C21%2C14-1757946214537.png",
-  "createdAt": "2005-10-10T23:15:03",
-  "hash": "fb98140a6b41ee69b824f29cc8b6795444246f871e4ab2379528b34a4d16284e",
-  "thumbnails": {
-    "x100": "https://cdn.smartlinks.app/..._100x100.png",
-    "x200": "https://cdn.smartlinks.app/..._200x200.png",
-    "x512": "https://cdn.smartlinks.app/..._512x512.png"
-  },
-  "id": "7k1cGErrlmQ94J8yDlVj",
-  "site": "ChaseAtlantic",
-  "cleanName": "Screenshot 2025-09-15 at 15.21"
+  "url": "https://cdn.smartlinks.app/sites%2Facme-demo%2Fimages%2F2025%2F1%2Fproduct-hero-shot-1234567890123.png",
+  "thumbnail": "https://cdn.smartlinks.app/sites%2Facme-demo%2Fimages%2F2025%2F1%2Fproduct-hero-shot-1234567890123_thumb.webp",
+  "mimeType": "image/png",
+  "contentType": "image/png",
+  "size": 204800,
+  "width": 1440,
+  "height": 900,
+  "hash": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
+  "labels": [],
+  "metadata": {},
+  "versions": [],
+  "uploadedBy": "uid_mock0001",
+  "uploaderContactId": null,
+  "uploadTokenId": null,
+  "uploaderIp": null,
+  "status": "active",
+  "createdAt": "2025-01-15T10:00:00Z",
+  "updatedAt": "2025-01-15T10:00:00Z",
+  "deletedAt": null
 }
 ```
 

package/dist/api/asset.d.ts

@@ -1,4 +1,4 @@
-import { Asset, AssetResponse, UploadAssetOptions, UploadFromUrlOptions, ListAssetsOptions, GetAssetOptions, RemoveAssetOptions } from "../types/asset";
+import { Asset, AssetResponse, UploadAssetOptions, UploadFromUrlOptions, ListAssetsOptions, GetAssetOptions, RemoveAssetOptions, AdminListAssetsOptions, AdminListAssetsResponse, UpdateAssetOptions, ReplaceAssetFileOptions, DeleteAssetOptions, BulkDeleteAssetsOptions, RequestUploadTokenOptions, UploadTokenResponse, PublicTokenUploadOptions } from "../types/asset";
 export declare namespace asset {
     /**
      * Error type for asset uploads
@@ -73,4 +73,63 @@ export declare namespace asset {
      * Remove an asset by id within a scope (admin)
      */
     function remove(options: RemoveAssetOptions): Promise<void>;
+    /**
+     * List assets for a collection with full filtering options.
+     */
+    function listAdmin(options: AdminListAssetsOptions): Promise<AdminListAssetsResponse>;
+    /**
+     * Get a single asset by ID (admin).
+     */
+    function getAdmin(collectionId: string, assetId: string): Promise<Asset>;
+    /**
+     * Update asset metadata (admin). Use `replaceFile` to swap the file.
+     */
+    function updateAdmin(options: UpdateAssetOptions): Promise<Asset>;
+    /**
+     * Replace the file of an existing asset. The previous file URL is snapshotted
+     * into `versions[]` on the asset.
+     */
+    function replaceFile(options: ReplaceAssetFileOptions): Promise<Asset>;
+    /**
+     * Soft-delete an asset. Schedules CDN purge after `graceDays` (default 30).
+     * Recoverable via `restoreAdmin` until purge runs.
+     */
+    function deleteAdmin(options: DeleteAssetOptions): Promise<{
+        deleted: true;
+    }>;
+    /**
+     * Restore a soft-deleted asset (clears `deletedAt`).
+     */
+    function restoreAdmin(collectionId: string, assetId: string): Promise<Asset>;
+    /**
+     * Soft-delete multiple assets in one request.
+     */
+    function bulkDelete(options: BulkDeleteAssetsOptions): Promise<{
+        deleted: number;
+    }>;
+    /**
+     * Request a single-use upload token for a public (unauthenticated) upload.
+     * The token encodes the upload policy (allowed types, max size, review requirement).
+     *
+     * @example
+     * ```typescript
+     * const { tokenId, policy } = await asset.requestUploadToken({
+     *   collectionId: 'my-collection',
+     *   appId: 'user-gallery',
+     *   contactId: contact.id,
+     * })
+     * const uploaded = await asset.publicUploadWithToken({
+     *   collectionId: 'my-collection',
+     *   tokenId,
+     *   file: selectedFile,
+     * })
+     * ```
+     */
+    function requestUploadToken(options: RequestUploadTokenOptions): Promise<UploadTokenResponse>;
+    /**
+     * Upload a file using a single-use upload token (no admin auth required).
+     * Assets are created with `status: 'pending_review'` when the token policy
+     * has `reviewRequired: true`.
+     */
+    function publicUploadWithToken(options: PublicTokenUploadOptions): Promise<Asset>;
 }

package/dist/api/asset.js

@@ -1,4 +1,15 @@
-import { request, post, del, getApiHeaders, isProxyEnabled, proxyUploadFormData } from "../http";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { request, post, put, del, getApiHeaders, isProxyEnabled, proxyUploadFormData } from "../http";
 export var asset;
 (function (asset) {
     /**
@@ -76,7 +87,7 @@ export var asset;
                             const code = mapStatusToUploadErrorCode(status, errBody === null || errBody === void 0 ? void 0 : errBody.code);
                             reject(new AssetUploadError((errBody === null || errBody === void 0 ? void 0 : errBody.message) || `Upload failed (${status})`, code, errBody));
                         }
-                        catch (_a) {
+                        catch (_b) {
                             const code = mapStatusToUploadErrorCode(status);
                             reject(new AssetUploadError(`Asset upload failed with status ${status}`, code));
                         }
@@ -277,4 +288,236 @@ export var asset;
         return del(path);
     }
     asset.remove = remove;
+    // ---------------------------------------------------------------------------
+    // Admin asset management — flat collection-scoped endpoints
+    // Base: /api/admin/collection/:collectionId/assets
+    // ---------------------------------------------------------------------------
+    /**
+     * List assets for a collection with full filtering options.
+     */
+    async function listAdmin(options) {
+        const params = new URLSearchParams();
+        if (options.productId)
+            params.set('productId', options.productId);
+        if (options.proofId)
+            params.set('proofId', options.proofId);
+        if (options.appId)
+            params.set('appId', options.appId);
+        if (options.assetType)
+            params.set('assetType', options.assetType);
+        if (options.labels)
+            params.set('labels', options.labels);
+        if (options.sort)
+            params.set('sort', options.sort);
+        if (options.order)
+            params.set('order', options.order);
+        if (typeof options.limit === 'number')
+            params.set('limit', String(options.limit));
+        if (typeof options.offset === 'number')
+            params.set('offset', String(options.offset));
+        const qs = params.toString();
+        const path = `/admin/collection/${encodeURIComponent(options.collectionId)}/assets${qs ? `?${qs}` : ''}`;
+        return request(path);
+    }
+    asset.listAdmin = listAdmin;
+    /**
+     * Get a single asset by ID (admin).
+     */
+    async function getAdmin(collectionId, assetId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/assets/${encodeURIComponent(assetId)}`;
+        return request(path);
+    }
+    asset.getAdmin = getAdmin;
+    /**
+     * Update asset metadata (admin). Use `replaceFile` to swap the file.
+     */
+    async function updateAdmin(options) {
+        const path = `/admin/collection/${encodeURIComponent(options.collectionId)}/assets/${encodeURIComponent(options.assetId)}`;
+        const { collectionId: _c, assetId: _a } = options, body = __rest(options, ["collectionId", "assetId"]);
+        return put(path, body);
+    }
+    asset.updateAdmin = updateAdmin;
+    /**
+     * Replace the file of an existing asset. The previous file URL is snapshotted
+     * into `versions[]` on the asset.
+     */
+    async function replaceFile(options) {
+        const path = `/admin/collection/${encodeURIComponent(options.collectionId)}/assets/${encodeURIComponent(options.assetId)}/replace`;
+        const formData = new FormData();
+        formData.append('file', options.file);
+        if (options.onProgress && typeof window !== 'undefined' && !isProxyEnabled()) {
+            const url = (typeof window !== 'undefined' && window.SMARTLINKS_API_BASEURL)
+                ? window.SMARTLINKS_API_BASEURL + path
+                : path;
+            const headers = getApiHeaders ? getApiHeaders() : {};
+            return new Promise((resolve, reject) => {
+                const xhr = new XMLHttpRequest();
+                xhr.open('POST', url);
+                for (const [key, value] of Object.entries(headers))
+                    xhr.setRequestHeader(key, value);
+                xhr.upload.onprogress = (event) => {
+                    if (options.onProgress && event.lengthComputable) {
+                        options.onProgress(Math.round((event.loaded / event.total) * 100));
+                    }
+                };
+                xhr.onload = () => {
+                    if (xhr.status >= 200 && xhr.status < 300) {
+                        try {
+                            resolve(JSON.parse(xhr.responseText));
+                        }
+                        catch (_b) {
+                            reject(new AssetUploadError('Failed to parse server response', 'UNKNOWN'));
+                        }
+                    }
+                    else {
+                        try {
+                            const e = JSON.parse(xhr.responseText);
+                            reject(new AssetUploadError((e === null || e === void 0 ? void 0 : e.message) || `Replace failed (${xhr.status})`, mapStatusToUploadErrorCode(xhr.status, e === null || e === void 0 ? void 0 : e.code), e));
+                        }
+                        catch (_d) {
+                            reject(new AssetUploadError(`Replace failed with status ${xhr.status}`, mapStatusToUploadErrorCode(xhr.status)));
+                        }
+                    }
+                };
+                xhr.onerror = () => reject(new AssetUploadError('Network error during file replace', 'NETWORK_ERROR'));
+                xhr.send(formData);
+            });
+        }
+        return post(path, formData);
+    }
+    asset.replaceFile = replaceFile;
+    /**
+     * Soft-delete an asset. Schedules CDN purge after `graceDays` (default 30).
+     * Recoverable via `restoreAdmin` until purge runs.
+     */
+    async function deleteAdmin(options) {
+        const params = new URLSearchParams();
+        if (typeof options.graceDays === 'number')
+            params.set('graceDays', String(options.graceDays));
+        const qs = params.toString();
+        const path = `/admin/collection/${encodeURIComponent(options.collectionId)}/assets/${encodeURIComponent(options.assetId)}${qs ? `?${qs}` : ''}`;
+        return del(path);
+    }
+    asset.deleteAdmin = deleteAdmin;
+    /**
+     * Restore a soft-deleted asset (clears `deletedAt`).
+     */
+    async function restoreAdmin(collectionId, assetId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/assets/${encodeURIComponent(assetId)}/restore`;
+        return post(path, {});
+    }
+    asset.restoreAdmin = restoreAdmin;
+    /**
+     * Soft-delete multiple assets in one request.
+     */
+    async function bulkDelete(options) {
+        const path = `/admin/collection/${encodeURIComponent(options.collectionId)}/assets/bulk-delete`;
+        const body = { assetIds: options.assetIds };
+        if (typeof options.graceDays === 'number')
+            body.graceDays = options.graceDays;
+        return post(path, body);
+    }
+    asset.bulkDelete = bulkDelete;
+    // ---------------------------------------------------------------------------
+    // Public (token-based) uploads
+    // ---------------------------------------------------------------------------
+    /**
+     * Request a single-use upload token for a public (unauthenticated) upload.
+     * The token encodes the upload policy (allowed types, max size, review requirement).
+     *
+     * @example
+     * ```typescript
+     * const { tokenId, policy } = await asset.requestUploadToken({
+     *   collectionId: 'my-collection',
+     *   appId: 'user-gallery',
+     *   contactId: contact.id,
+     * })
+     * const uploaded = await asset.publicUploadWithToken({
+     *   collectionId: 'my-collection',
+     *   tokenId,
+     *   file: selectedFile,
+     * })
+     * ```
+     */
+    async function requestUploadToken(options) {
+        const path = `/public/collection/${encodeURIComponent(options.collectionId)}/asset/token`;
+        const body = { appId: options.appId };
+        if (options.contactId)
+            body.contactId = options.contactId;
+        if (options.productId)
+            body.productId = options.productId;
+        if (options.proofId)
+            body.proofId = options.proofId;
+        return post(path, body);
+    }
+    asset.requestUploadToken = requestUploadToken;
+    /**
+     * Upload a file using a single-use upload token (no admin auth required).
+     * Assets are created with `status: 'pending_review'` when the token policy
+     * has `reviewRequired: true`.
+     */
+    async function publicUploadWithToken(options) {
+        const path = `/public/collection/${encodeURIComponent(options.collectionId)}/asset`;
+        const formData = new FormData();
+        formData.append('file', options.file);
+        if (options.name)
+            formData.append('name', options.name);
+        if (options.metadata)
+            formData.append('metadata', JSON.stringify(options.metadata));
+        if (options.onProgress && typeof window !== 'undefined' && !isProxyEnabled()) {
+            const baseUrl = (typeof window !== 'undefined' && window.SMARTLINKS_API_BASEURL)
+                ? window.SMARTLINKS_API_BASEURL + path
+                : path;
+            const headers = Object.assign(Object.assign({}, getApiHeaders()), { 'X-Upload-Token': options.tokenId });
+            return new Promise((resolve, reject) => {
+                const xhr = new XMLHttpRequest();
+                xhr.open('POST', baseUrl);
+                for (const [key, value] of Object.entries(headers))
+                    xhr.setRequestHeader(key, value);
+                xhr.upload.onprogress = (event) => {
+                    if (options.onProgress && event.lengthComputable) {
+                        options.onProgress(Math.round((event.loaded / event.total) * 100));
+                    }
+                };
+                xhr.onload = () => {
+                    if (xhr.status >= 200 && xhr.status < 300) {
+                        try {
+                            resolve(JSON.parse(xhr.responseText));
+                        }
+                        catch (_b) {
+                            reject(new AssetUploadError('Failed to parse server response', 'UNKNOWN'));
+                        }
+                    }
+                    else {
+                        try {
+                            const e = JSON.parse(xhr.responseText);
+                            reject(new AssetUploadError((e === null || e === void 0 ? void 0 : e.message) || `Upload failed (${xhr.status})`, mapStatusToUploadErrorCode(xhr.status, e === null || e === void 0 ? void 0 : e.code), e));
+                        }
+                        catch (_d) {
+                            reject(new AssetUploadError(`Upload failed with status ${xhr.status}`, mapStatusToUploadErrorCode(xhr.status)));
+                        }
+                    }
+                };
+                xhr.onerror = () => reject(new AssetUploadError('Network error during public upload', 'NETWORK_ERROR'));
+                xhr.send(formData);
+            });
+        }
+        // Pass the token as a header via a custom fetch; post() doesn't accept extra headers,
+        // so we build the request manually using the same base URL resolution.
+        const baseUrl = (typeof window !== 'undefined' && window.SMARTLINKS_API_BASEURL)
+            ? window.SMARTLINKS_API_BASEURL + path
+            : path;
+        const headers = Object.assign(Object.assign({}, getApiHeaders()), { 'X-Upload-Token': options.tokenId });
+        const response = await fetch(baseUrl, { method: 'POST', headers, body: formData });
+        if (!response.ok) {
+            let errBody;
+            try {
+                errBody = await response.json();
+            }
+            catch ( /* ignore */_b) { /* ignore */ }
+            throw new AssetUploadError((errBody === null || errBody === void 0 ? void 0 : errBody.message) || `Public upload failed (${response.status})`, mapStatusToUploadErrorCode(response.status, errBody === null || errBody === void 0 ? void 0 : errBody.code), errBody);
+        }
+        return response.json();
+    }
+    asset.publicUploadWithToken = publicUploadWithToken;
 })(asset || (asset = {}));