@proveanything/smartlinks 1.3.5 → 1.3.8

package/dist/types/collection.d.ts

@@ -66,3 +66,45 @@ export interface Collection {
 export type CollectionResponse = Collection;
 export type CollectionCreateRequest = Omit<Collection, 'id' | 'shortId'>;
 export type CollectionUpdateRequest = Partial<Omit<Collection, 'id' | 'shortId'>>;
+/**
+ * Configuration for an app module within a collection.
+ */
+export interface AppConfig {
+    /** Unique identifier for the app */
+    id: string;
+    /** Underling app module id */
+    srcAppId: string;
+    /** Display name of the app */
+    name: string;
+    /** Optional description of the app */
+    description?: string;
+    /** Optional icon for the app */
+    faIcon?: string;
+    /** app category */
+    category: "Authenticity" | "Documentation" | "Commerce" | "Engagement" | "AI" | "Digital Product Passports" | "Integration" | "Web3" | "Other";
+    /** Whether the app is enabled for this collection */
+    active?: boolean;
+    /** Whether the app is only accessible to owners */
+    ownersOnly?: boolean;
+    /** Whether the app is hidden in the UI */
+    hidden?: boolean;
+    /** Universal iframe URL for external embedding */
+    publicIframeUrl?: string;
+    /** supports multiple pages / deep links into the app */
+    supportsDeepLinks?: boolean;
+    /** App component configuration */
+    usage: {
+        collection: boolean;
+        product: boolean;
+        proof: boolean;
+        widget: boolean;
+    };
+    [key: string]: any;
+}
+/**
+ * Response containing app configurations for a collection.
+ */
+export interface AppsConfigResponse {
+    /** Array of app configurations */
+    apps: AppConfig[];
+}

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.5  |  Generated: 2026-02-02T20:16:48.361Z
+Version: 1.3.8  |  Generated: 2026-02-05T19:14:34.871Z
 
 This is a concise summary of all available API functions and types.
 
@@ -856,6 +856,37 @@ interface Collection {
 }
 ```
 
+**AppConfig** (interface)
+```typescript
+interface AppConfig {
+  id: string
+  srcAppId: string
+  name: string
+  description?: string
+  faIcon?: string
+  category: "Authenticity" | "Documentation" | "Commerce" | "Engagement" | "AI" | "Digital Product Passports" | "Integration" | "Web3" | "Other";
+  active?: boolean
+  ownersOnly?: boolean
+  hidden?: boolean
+  publicIframeUrl?: string
+  supportsDeepLinks?: boolean;
+  usage: {
+  collection: boolean;  // use at the collecton level
+  product: boolean; // use at the product level
+  proof: boolean;  // use at the proof level
+  widget: boolean; // has a widget component available
+  }
+  [key: string]: any
+}
+```
+
+**AppsConfigResponse** (interface)
+```typescript
+interface AppsConfigResponse {
+  apps: AppConfig[]
+}
+```
+
 **CollectionResponse** = `Collection`
 
 **CollectionCreateRequest** = `Omit<Collection, 'id' | 'shortId'>`
@@ -2998,6 +3029,9 @@ Retrieve a collection by its shortId (public endpoint).
 **getSettings**(collectionId: string, settingGroup: string, admin?: boolean) → `Promise<any>`
 Retrieve a specific settings group for a collection (public endpoint).
 
+**getAppsConfig**(collectionId: string) → `Promise<AppsConfigResponse>`
+Retrieve all configured app module definitions for a collection (public endpoint).
+
 **updateSettings**(collectionId: string, settingGroup: string, settings: any) → `Promise<any>`
 Update a specific settings group for a collection (admin endpoint).
 
@@ -3506,19 +3540,29 @@ Get a single tag mapping by tagId. ```typescript const tag = await tags.get('col
     params?: ListTagsRequest) → `Promise<ListTagsResponse>`
 List all tags for a collection with optional filters and pagination. ```typescript // List all tags const all = await tags.list('coll_123') // List with filters const filtered = await tags.list('coll_123', { productId: 'prod_456', variantId: 'var_789', limit: 50, offset: 0 }) ```
 
-**publicGet**(collectionId: string,
+**getTag**(tagId: string,
+    params?: PublicGetTagRequest) → `Promise<PublicGetTagResponse>`
+Public lookup of a single tag by tagId (global). Optionally embed related collection, product, or proof data. No authentication required. ```typescript // Simple lookup const result = await tags.getTag('TAG001') // With embedded data const withData = await tags.getTag('TAG001', { embed: 'collection,product,proof' }) console.log(withData.tag, withData.collection, withData.product, withData.proof) ```
+
+**publicGet**(_collectionId: string,
     tagId: string,
     params?: PublicGetTagRequest) → `Promise<PublicGetTagResponse>`
-Public lookup of a single tag by tagId within a specific collection. Optionally embed related collection, product, or proof data. No authentication required. ```typescript // Simple lookup const result = await tags.publicGet('coll_123', 'TAG001') // With embedded data const withData = await tags.publicGet('coll_123', 'TAG001', { embed: 'collection,product,proof' }) console.log(withData.tag, withData.collection, withData.product, withData.proof) ```
+Backward-compat: Public lookup with collectionId parameter (ignored). Calls global route under /public/tags/:tagId.
 
-**publicBatchLookup**(collectionId: string,
-    data: PublicBatchLookupRequest) → `Promise<PublicBatchLookupResponse>`
+**lookupTags**(data: PublicBatchLookupRequest) → `Promise<PublicBatchLookupResponse>`
 Public batch lookup of multiple tags in a single request (POST). Only returns tags from the specified collection. Optionally embed related data. Related data is deduplicated and batch-fetched. No authentication required. ```typescript const result = await tags.publicBatchLookup('coll_123', { tagIds: ['TAG001', 'TAG002', 'TAG003'], embed: 'collection,product' }) // Access tags and deduplicated collections/products console.log(result.tags['TAG001']) console.log(result.collections) console.log(result.products) ```
 
-**publicBatchLookupQuery**(collectionId: string,
-    params: PublicBatchLookupQueryRequest) → `Promise<PublicBatchLookupQueryResponse>`
+**publicBatchLookup**(_collectionId: string,
+    data: PublicBatchLookupRequest) → `Promise<PublicBatchLookupResponse>`
+Backward-compat: Public batch lookup with collectionId parameter (ignored). Calls global route under /public/tags/lookup.
+
+**lookupTagsQuery**(params: PublicBatchLookupQueryRequest) → `Promise<PublicBatchLookupQueryResponse>`
 Public batch lookup of multiple tags using query parameters (GET). Only returns tags from the specified collection. Alternative to publicBatchLookup for simple GET requests. No authentication required. ```typescript const result = await tags.publicBatchLookupQuery('coll_123', { tagIds: 'TAG001,TAG002,TAG003', embed: 'collection' }) ```
 
+**publicBatchLookupQuery**(_collectionId: string,
+    params: PublicBatchLookupQueryRequest) → `Promise<PublicBatchLookupQueryResponse>`
+Backward-compat: Public batch lookup (GET) with collectionId parameter (ignored). Calls global route under /public/tags/lookup.
+
 ### template
 
 **getAll**(collectionId: string) → `Promise<Template[]>`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.3.5",
+  "version": "1.3.8",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,11 +10,11 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsc && node scripts/copy-docs-to-dist.js",
+    "build": "tsc && node generate-api-summary.js && node scripts/copy-docs-to-dist.js",
     "docs": "typedoc",
     "docs:summary": "node generate-api-summary.js",
     "build:docs": "tsc build-docs.ts --outDir dist && node dist/build-docs.js",
-    "prepublishOnly": "npm run build && npm run docs:summary"
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "smartlinks",