@proveanything/smartlinks 1.0.35 → 1.0.38

package/API_SUMMARY.md

@@ -1,11 +1,14 @@
 # Smartlinks API Summary
 
+Version: 1.0.38  |  Generated: 2025-10-04T11:16:35.687Z
+
 This is a concise summary of all available API functions and types.
 
 ## API Namespaces
 
 The Smartlinks SDK is organized into the following namespaces:
 
+- **ai** - Functions for ai operations
 - **appConfiguration** - Application configuration and settings management
 - **appRecord** - Functions for appRecord operations
 - **asset** - File upload and asset management for collections, products, and proofs
@@ -200,7 +203,7 @@ interface ProductResponse {
   x512: string
   }
   }
-  groupTags: {
+  tags: {
   [tagName: string]: boolean
   }
   data: {
@@ -236,6 +239,52 @@ interface ProofResponse {
 
 **VariantUpdateRequest** = `any`
 
+### ai
+
+**AIGenerateContentRequest** (interface)
+```typescript
+interface AIGenerateContentRequest {
+  contents: string | any
+  responseMimeType?: string
+  systemInstruction?: string
+  provider?: string
+  model?: string
+  [key: string]: any
+}
+```
+
+**AIGenerateImageRequest** (interface)
+```typescript
+interface AIGenerateImageRequest {
+  prompt: string
+  provider?: string
+  model?: string
+  size?: string
+  [key: string]: any
+}
+```
+
+**AISearchPhotosRequest** (interface)
+```typescript
+interface AISearchPhotosRequest {
+  query: string
+  per_page?: number
+  orientation?: 'landscape' | 'portrait' | 'squarish'
+  [key: string]: any
+}
+```
+
+**AISearchPhotosPhoto** (interface)
+```typescript
+interface AISearchPhotosPhoto {
+  url: string
+  alt?: string
+  photographer?: string
+  photographerUrl?: string
+  [key: string]: any
+}
+```
+
 **AppConfigOptions** = `{
   appId: string
   collectionId?: string
@@ -304,6 +353,50 @@ interface ProofResponse {
 
 ## API Functions
 
+### ai
+
+**generateContent**(collectionId: string,
+    params: AIGenerateContentRequest,
+    admin: boolean = true) → `Promise<any>`
+Generate text/content via AI (admin)
+
+**generateImage**(collectionId: string, params: AIGenerateImageRequest) → `Promise<any>`
+Generate an image via AI (admin)
+
+**searchPhotos**(collectionId: string,
+    params: AISearchPhotosRequest) → `Promise<AISearchPhotosPhoto[]>`
+Search stock photos or similar via AI (admin)
+
+**uploadFile**(collectionId: string, params: any) → `Promise<any>`
+Upload a file for AI usage (admin). Pass FormData for binary uploads.
+
+**createCache**(collectionId: string, params: any) → `Promise<any>`
+Create or warm a cache for AI (admin)
+
+**postChat**(collectionId: string, params: any, admin: boolean = true) → `Promise<any>`
+Post a chat message to the AI (admin or public)
+
+**generateContent**(collectionId: string,
+    params: AIGenerateContentRequest,
+    admin: boolean = true) → `Promise<any>`
+Generate text/content via AI (admin)
+
+**generateImage**(collectionId: string, params: AIGenerateImageRequest) → `Promise<any>`
+Generate an image via AI (admin)
+
+**searchPhotos**(collectionId: string,
+    params: AISearchPhotosRequest) → `Promise<AISearchPhotosPhoto[]>`
+Search stock photos or similar via AI (admin)
+
+**uploadFile**(collectionId: string, params: any) → `Promise<any>`
+Upload a file for AI usage (admin). Pass FormData for binary uploads.
+
+**createCache**(collectionId: string, params: any) → `Promise<any>`
+Create or warm a cache for AI (admin)
+
+**postChat**(collectionId: string, params: any, admin: boolean = true) → `Promise<any>`
+Post a chat message to the AI (admin or public)
+
 ### appConfiguration
 
 **getConfig**(opts: AppConfigOptions) → `Promise<any>`
@@ -493,6 +586,14 @@ Requests an admin JWT for the current user and a specific collection Returns JWT
 **requestPublicJWT**(collectionId: string, productId: string, proofId: string) → `Promise<string>`
 Requests a JWT for the current user and a specific collection/product/proof Validates if the user has access to the resource, and returns a JWT
 
+**getUserToken**(opts?: {
+    email?: string
+    collectionId?: string
+    userId?: string
+    expiry?: string
+  }) → `Promise<`
+Admin: Get a user bearer token (impersonation/automation). POST /admin/auth/userToken All fields are optional; at least one identifier should be provided.
+
 **getAccount**() → `Promise<AccountInfoResponse>`
 Gets current account information for the logged in user. Returns user, owner, account, and location objects.
 
@@ -511,6 +612,14 @@ Requests an admin JWT for the current user and a specific collection Returns JWT
 **requestPublicJWT**(collectionId: string, productId: string, proofId: string) → `Promise<string>`
 Requests a JWT for the current user and a specific collection/product/proof Validates if the user has access to the resource, and returns a JWT
 
+**getUserToken**(opts?: {
+    email?: string
+    collectionId?: string
+    userId?: string
+    expiry?: string
+  }) → `Promise<`
+Admin: Get a user bearer token (impersonation/automation). POST /admin/auth/userToken All fields are optional; at least one identifier should be provided.
+
 **getAccount**() → `Promise<AccountInfoResponse>`
 Gets current account information for the logged in user. Returns user, owner, account, and location objects.
 
@@ -890,6 +999,11 @@ Create a proof for a product (admin only). POST /admin/collection/:collectionId/
     values: any) → `Promise<ProofResponse>`
 Update a proof for a product (admin only). PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
 
+**remove**(collectionId: string,
+    productId: string,
+    proofId: string) → `Promise<void>`
+Delete a proof for a product (admin only). DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId
+
 **getByUser**(collectionId: string,
     userId: string) → `Promise<ProofResponse[]>`
 Get proofs for a user in a collection (admin only). GET /admin/collection/:collectionId/proof/findByUser/:userId
@@ -928,6 +1042,11 @@ Create a proof for a product (admin only). POST /admin/collection/:collectionId/
     values: any) → `Promise<ProofResponse>`
 Update a proof for a product (admin only). PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
 
+**remove**(collectionId: string,
+    productId: string,
+    proofId: string) → `Promise<void>`
+Delete a proof for a product (admin only). DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId
+
 **getByUser**(collectionId: string,
     userId: string) → `Promise<ProofResponse[]>`
 Get proofs for a user in a collection (admin only). GET /admin/collection/:collectionId/proof/findByUser/:userId

package/dist/api/ai.d.ts

@@ -0,0 +1,74 @@
+export interface AIGenerateContentRequest {
+    /** The prompt or message contents sent to the AI */
+    contents: string | any;
+    /** Desired MIME type of the response payload (e.g. 'application/json', 'text/plain') */
+    responseMimeType?: string;
+    /** Optional system instruction or system prompt to steer the model */
+    systemInstruction?: string;
+    /** AI provider identifier (e.g. 'openai', 'google', 'anthropic') */
+    provider?: string;
+    /** The model name to use (e.g. 'gpt-4o', 'gemini-1.5-pro') */
+    model?: string;
+    /** Allow passing additional provider/model-specific options */
+    [key: string]: any;
+}
+export interface AIGenerateImageRequest {
+    /** Text prompt describing the desired image */
+    prompt: string;
+    /** AI provider identifier (e.g. 'openai', 'google', 'stability') */
+    provider?: string;
+    /** Optional model name to use for image generation */
+    model?: string;
+    /** Requested image size, e.g. '1024x1024' */
+    size?: string;
+    /** Additional provider/model-specific options */
+    [key: string]: any;
+}
+export interface AISearchPhotosRequest {
+    /** Search query keyword(s) */
+    query: string;
+    /** Number of results to return per page (e.g. 1) */
+    per_page?: number;
+    /** Desired orientation of photos */
+    orientation?: 'landscape' | 'portrait' | 'squarish';
+    /** Additional provider-specific options */
+    [key: string]: any;
+}
+export interface AISearchPhotosPhoto {
+    /** Direct image URL */
+    url: string;
+    /** Alt text/description for accessibility */
+    alt?: string;
+    /** Photographer display name */
+    photographer?: string;
+    /** Link to the photographer profile */
+    photographerUrl?: string;
+    /** Allow extra fields */
+    [key: string]: any;
+}
+export declare namespace ai {
+    /**
+     * Generate text/content via AI (admin)
+     */
+    function generateContent(collectionId: string, params: AIGenerateContentRequest, admin?: boolean): Promise<any>;
+    /**
+     * Generate an image via AI (admin)
+     */
+    function generateImage(collectionId: string, params: AIGenerateImageRequest): Promise<any>;
+    /**
+     * Search stock photos or similar via AI (admin)
+     */
+    function searchPhotos(collectionId: string, params: AISearchPhotosRequest): Promise<AISearchPhotosPhoto[]>;
+    /**
+     * Upload a file for AI usage (admin). Pass FormData for binary uploads.
+     */
+    function uploadFile(collectionId: string, params: any): Promise<any>;
+    /**
+     * Create or warm a cache for AI (admin)
+     */
+    function createCache(collectionId: string, params: any): Promise<any>;
+    /**
+     * Post a chat message to the AI (admin or public)
+     */
+    function postChat(collectionId: string, params: any, admin?: boolean): Promise<any>;
+}

package/dist/api/ai.js

@@ -0,0 +1,56 @@
+// src/api/ai.ts
+// AI endpoints: public and admin helpers
+import { post } from "../http";
+export var ai;
+(function (ai) {
+    /**
+     * Generate text/content via AI (admin)
+     */
+    async function generateContent(collectionId, params, admin = true) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/ai/generateContent`;
+        return post(path, params);
+    }
+    ai.generateContent = generateContent;
+    /**
+     * Generate an image via AI (admin)
+     */
+    async function generateImage(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/generateImage`;
+        return post(path, params);
+    }
+    ai.generateImage = generateImage;
+    /**
+     * Search stock photos or similar via AI (admin)
+     */
+    async function searchPhotos(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/searchPhotos`;
+        return post(path, params);
+    }
+    ai.searchPhotos = searchPhotos;
+    /**
+     * Upload a file for AI usage (admin). Pass FormData for binary uploads.
+     */
+    async function uploadFile(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/uploadFile`;
+        return post(path, params);
+    }
+    ai.uploadFile = uploadFile;
+    /**
+     * Create or warm a cache for AI (admin)
+     */
+    async function createCache(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/createCache`;
+        return post(path, params);
+    }
+    ai.createCache = createCache;
+    /**
+     * Post a chat message to the AI (admin or public)
+     */
+    async function postChat(collectionId, params, admin = true) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/ai/postChat`;
+        return post(path, params);
+    }
+    ai.postChat = postChat;
+})(ai || (ai = {}));

package/dist/api/auth.d.ts

@@ -70,6 +70,19 @@ export declare namespace auth {
      * Validates if the user has access to the resource, and returns a JWT
      */
     function requestPublicJWT(collectionId: string, productId: string, proofId: string): Promise<string>;
+    /**
+     * Admin: Get a user bearer token (impersonation/automation).
+     * POST /admin/auth/userToken
+     * All fields are optional; at least one identifier should be provided.
+     */
+    function getUserToken(opts?: {
+        email?: string;
+        collectionId?: string;
+        userId?: string;
+        expiry?: string;
+    }): Promise<{
+        bearerToken: string;
+    }>;
     /**
      * Gets current account information for the logged in user.
      * Returns user, owner, account, and location objects.

package/dist/api/auth.js

@@ -60,6 +60,16 @@ export var auth;
         return post("/public/auth/requestJWT", { collectionId, productId, proofId });
     }
     auth.requestPublicJWT = requestPublicJWT;
+    /**
+     * Admin: Get a user bearer token (impersonation/automation).
+     * POST /admin/auth/userToken
+     * All fields are optional; at least one identifier should be provided.
+     */
+    async function getUserToken(opts) {
+        const body = opts !== null && opts !== void 0 ? opts : {};
+        return post("/admin/auth/getUserToken", body);
+    }
+    auth.getUserToken = getUserToken;
     /**
      * Gets current account information for the logged in user.
      * Returns user, owner, account, and location objects.

package/dist/api/index.d.ts

@@ -11,3 +11,5 @@ export { claimSet } from "./claimSet";
 export { crate } from "./crate";
 export { batch } from "./batch";
 export { variant } from "./variant";
+export { ai } from "./ai";
+export type { AIGenerateContentRequest, AIGenerateImageRequest, AISearchPhotosRequest, AISearchPhotosPhoto } from "./ai";

package/dist/api/index.js

@@ -13,3 +13,4 @@ export { claimSet } from "./claimSet";
 export { crate } from "./crate";
 export { batch } from "./batch";
 export { variant } from "./variant";
+export { ai } from "./ai";

package/dist/api/proof.d.ts

@@ -19,6 +19,11 @@ export declare namespace proof {
      * PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
      */
     function update(collectionId: string, productId: string, proofId: string, values: any): Promise<ProofResponse>;
+    /**
+     * Delete a proof for a product (admin only).
+     * DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId
+     */
+    function remove(collectionId: string, productId: string, proofId: string): Promise<void>;
     /**
      * Get proofs for a user in a collection (admin only).
      * GET /admin/collection/:collectionId/proof/findByUser/:userId

package/dist/api/proof.js

@@ -1,5 +1,5 @@
 // src/api/proof.ts
-import { request, post, put } from "../http";
+import { request, post, put, del } from "../http";
 export var proof;
 (function (proof) {
     /**
@@ -39,6 +39,15 @@ export var proof;
         return put(path, values);
     }
     proof.update = update;
+    /**
+     * Delete a proof for a product (admin only).
+     * DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId
+     */
+    async function remove(collectionId, productId, proofId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/proof/${encodeURIComponent(proofId)}`;
+        return del(path);
+    }
+    proof.remove = remove;
     /**
      * Get proofs for a user in a collection (admin only).
      * GET /admin/collection/:collectionId/proof/findByUser/:userId

package/dist/types/product.d.ts

@@ -26,7 +26,7 @@ export interface ProductResponse {
         };
     };
     /** Flexible map of tags with true/false values */
-    groupTags: {
+    tags: {
         [tagName: string]: boolean;
     };
     /** Flexible key/value data map */

package/package.json

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