@proveanything/smartlinks 1.3.34 → 1.3.35

package/dist/api/product.d.ts

@@ -20,6 +20,24 @@ export declare namespace product {
     /**
      * Create a new product for a collection (admin only).
      * The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
+     *
+     * **Hero Image Auto-Fetch:**
+     * You can pass `heroImage` as either:
+     * - A full asset object: `{ url: '...', thumbnails: {...} }`
+     * - A string URL: The system automatically fetches and stores the image
+     *
+     * @example
+     * ```typescript
+     * // Using a URL - auto-fetched and stored
+     * const product = await product.create(collectionId, {
+     *   name: 'Wine Bottle',
+     *   description: 'Premium red wine',
+     *   heroImage: 'https://example.com/wine.jpg', // Auto-fetched!
+     *   tags: {},
+     *   data: {}
+     * });
+     * ```
+     *
      * @param collectionId – Identifier of the parent collection
      * @param data – Product creation data (see ProductCreateRequest)
      * @returns Promise resolving to a ProductResponse object
@@ -29,6 +47,20 @@ export declare namespace product {
     /**
      * Update a product for a collection (admin only).
      * The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
+     *
+     * **Hero Image Auto-Fetch:**
+     * You can pass `heroImage` as either:
+     * - A full asset object: `{ url: '...', thumbnails: {...} }`
+     * - A string URL: The system automatically fetches and stores the image
+     *
+     * @example
+     * ```typescript
+     * // Update with new URL - auto-fetched and stored
+     * const product = await product.update(collectionId, productId, {
+     *   heroImage: 'https://example.com/new-wine.jpg' // Auto-fetched!
+     * });
+     * ```
+     *
      * @param collectionId – Identifier of the parent collection
      * @param productId – Identifier of the product
      * @param data – Product update data (see ProductUpdateRequest)

package/dist/api/product.js

@@ -32,6 +32,24 @@ export var product;
     /**
      * Create a new product for a collection (admin only).
      * The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
+     *
+     * **Hero Image Auto-Fetch:**
+     * You can pass `heroImage` as either:
+     * - A full asset object: `{ url: '...', thumbnails: {...} }`
+     * - A string URL: The system automatically fetches and stores the image
+     *
+     * @example
+     * ```typescript
+     * // Using a URL - auto-fetched and stored
+     * const product = await product.create(collectionId, {
+     *   name: 'Wine Bottle',
+     *   description: 'Premium red wine',
+     *   heroImage: 'https://example.com/wine.jpg', // Auto-fetched!
+     *   tags: {},
+     *   data: {}
+     * });
+     * ```
+     *
      * @param collectionId – Identifier of the parent collection
      * @param data – Product creation data (see ProductCreateRequest)
      * @returns Promise resolving to a ProductResponse object
@@ -45,6 +63,20 @@ export var product;
     /**
      * Update a product for a collection (admin only).
      * The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
+     *
+     * **Hero Image Auto-Fetch:**
+     * You can pass `heroImage` as either:
+     * - A full asset object: `{ url: '...', thumbnails: {...} }`
+     * - A string URL: The system automatically fetches and stores the image
+     *
+     * @example
+     * ```typescript
+     * // Update with new URL - auto-fetched and stored
+     * const product = await product.update(collectionId, productId, {
+     *   heroImage: 'https://example.com/new-wine.jpg' // Auto-fetched!
+     * });
+     * ```
+     *
      * @param collectionId – Identifier of the parent collection
      * @param productId – Identifier of the product
      * @param data – Product update data (see ProductUpdateRequest)

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.34  |  Generated: 2026-02-16T09:46:01.466Z
+Version: 1.3.35  |  Generated: 2026-02-16T09:53:23.211Z
 
 This is a concise summary of all available API functions and types.
 
@@ -3363,6 +3363,10 @@ interface Product {
   description: string
   gtin?: string
   type?: string
+  * Hero image asset object.
+  * When creating/updating, you can pass either:
+  * - A full asset object with url and thumbnails
+  * - A string URL - the system will automatically fetch and store the image
   heroImage: {
   url: string
   thumbnails: {
@@ -3382,9 +3386,9 @@ interface Product {
 
 **ProductResponse** = `Product`
 
-**ProductCreateRequest** = `Omit<Product, 'id' | 'collectionId'>`
+**ProductCreateRequest** = `Omit<Product, 'id' | 'collectionId'> & {`
 
-**ProductUpdateRequest** = `Partial<Omit<Product, 'id' | 'collectionId'>>`
+**ProductUpdateRequest** = `Partial<Omit<Product, 'id' | 'collectionId'>> & {`
 
 ### proof
 
@@ -4778,12 +4782,12 @@ List all Product Items for a Collection.
 
 **create**(collectionId: string,
     data: ProductCreateRequest) → `Promise<ProductResponse>`
-Create a new product for a collection (admin only). The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
+Create a new product for a collection (admin only). The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`. **Hero Image Auto-Fetch:** You can pass `heroImage` as either: - A full asset object: `{ url: '...', thumbnails: {...} }` - A string URL: The system automatically fetches and stores the image ```typescript // Using a URL - auto-fetched and stored const product = await product.create(collectionId, { name: 'Wine Bottle', description: 'Premium red wine', heroImage: 'https://example.com/wine.jpg', // Auto-fetched! tags: {}, data: {} }); ```
 
 **update**(collectionId: string,
     productId: string,
     data: ProductUpdateRequest) → `Promise<ProductResponse>`
-Update a product for a collection (admin only). The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
+Update a product for a collection (admin only). The `data` payload is a partial of ProductResponse minus `id` and `collectionId`. **Hero Image Auto-Fetch:** You can pass `heroImage` as either: - A full asset object: `{ url: '...', thumbnails: {...} }` - A string URL: The system automatically fetches and stores the image ```typescript // Update with new URL - auto-fetched and stored const product = await product.update(collectionId, productId, { heroImage: 'https://example.com/new-wine.jpg' // Auto-fetched! }); ```
 
 **remove**(collectionId: string,
     productId: string) → `Promise<void>`

package/dist/types/product.d.ts

@@ -14,7 +14,12 @@ export interface Product {
     gtin?: string;
     /** An optional product type from the standard smartlinks types */
     type?: string;
-    /** Hero image asset object */
+    /**
+     * Hero image asset object.
+     * When creating/updating, you can pass either:
+     * - A full asset object with url and thumbnails
+     * - A string URL - the system will automatically fetch and store the image
+     */
     heroImage: {
         /** URL to the asset */
         url: string;
@@ -35,5 +40,9 @@ export interface Product {
     };
 }
 export type ProductResponse = Product;
-export type ProductCreateRequest = Omit<Product, 'id' | 'collectionId'>;
-export type ProductUpdateRequest = Partial<Omit<Product, 'id' | 'collectionId'>>;
+export type ProductCreateRequest = Omit<Product, 'id' | 'collectionId'> & {
+    heroImage?: Product['heroImage'] | string;
+};
+export type ProductUpdateRequest = Partial<Omit<Product, 'id' | 'collectionId'>> & {
+    heroImage?: Product['heroImage'] | string;
+};

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.34  |  Generated: 2026-02-16T09:46:01.466Z
+Version: 1.3.35  |  Generated: 2026-02-16T09:53:23.211Z
 
 This is a concise summary of all available API functions and types.
 
@@ -3363,6 +3363,10 @@ interface Product {
   description: string
   gtin?: string
   type?: string
+  * Hero image asset object.
+  * When creating/updating, you can pass either:
+  * - A full asset object with url and thumbnails
+  * - A string URL - the system will automatically fetch and store the image
   heroImage: {
   url: string
   thumbnails: {
@@ -3382,9 +3386,9 @@ interface Product {
 
 **ProductResponse** = `Product`
 
-**ProductCreateRequest** = `Omit<Product, 'id' | 'collectionId'>`
+**ProductCreateRequest** = `Omit<Product, 'id' | 'collectionId'> & {`
 
-**ProductUpdateRequest** = `Partial<Omit<Product, 'id' | 'collectionId'>>`
+**ProductUpdateRequest** = `Partial<Omit<Product, 'id' | 'collectionId'>> & {`
 
 ### proof
 
@@ -4778,12 +4782,12 @@ List all Product Items for a Collection.
 
 **create**(collectionId: string,
     data: ProductCreateRequest) → `Promise<ProductResponse>`
-Create a new product for a collection (admin only). The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
+Create a new product for a collection (admin only). The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`. **Hero Image Auto-Fetch:** You can pass `heroImage` as either: - A full asset object: `{ url: '...', thumbnails: {...} }` - A string URL: The system automatically fetches and stores the image ```typescript // Using a URL - auto-fetched and stored const product = await product.create(collectionId, { name: 'Wine Bottle', description: 'Premium red wine', heroImage: 'https://example.com/wine.jpg', // Auto-fetched! tags: {}, data: {} }); ```
 
 **update**(collectionId: string,
     productId: string,
     data: ProductUpdateRequest) → `Promise<ProductResponse>`
-Update a product for a collection (admin only). The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
+Update a product for a collection (admin only). The `data` payload is a partial of ProductResponse minus `id` and `collectionId`. **Hero Image Auto-Fetch:** You can pass `heroImage` as either: - A full asset object: `{ url: '...', thumbnails: {...} }` - A string URL: The system automatically fetches and stores the image ```typescript // Update with new URL - auto-fetched and stored const product = await product.update(collectionId, productId, { heroImage: 'https://example.com/new-wine.jpg' // Auto-fetched! }); ```
 
 **remove**(collectionId: string,
     productId: string) → `Promise<void>`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.3.34",
+  "version": "1.3.35",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",