@proveanything/smartlinks 1.4.1 → 1.4.2

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.4.1  |  Generated: 2026-02-20T19:32:34.980Z
+Version: 1.4.2  |  Generated: 2026-02-20T21:56:06.588Z
 
 This is a concise summary of all available API functions and types.
 
@@ -821,6 +821,41 @@ interface AppConfigurationResponse {
 
 ### appManifest
 
+**AppBundle** (interface)
+```typescript
+interface AppBundle {
+  js: string | null;
+  css: string | null;
+  source?: string;
+  styles?: string;
+}
+```
+
+**AppWidgetDefinition** (interface)
+```typescript
+interface AppWidgetDefinition {
+  name: string;
+  description?: string;
+  sizes?: Array<'compact' | 'standard' | 'large' | string>;
+  props?: {
+  required?: string[];
+  optional?: string[];
+  };
+}
+```
+
+**AppContainerDefinition** (interface)
+```typescript
+interface AppContainerDefinition {
+  name: string;
+  description?: string;
+  props?: {
+  required?: string[];
+  optional?: string[];
+  };
+}
+```
+
 **AppManifest** (interface)
 ```typescript
 interface AppManifest {
@@ -832,15 +867,8 @@ interface AppManifest {
   platformRevision?: string;
   appId: string;
   };
-  widgets?: Array<{
-  name: string;
-  description?: string;
-  sizes?: string[];
-  props?: {
-  required?: string[];
-  optional?: string[];
-  };
-  }>;
+  widgets?: AppWidgetDefinition[];
+  containers?: AppContainerDefinition[];
   setup?: {
   description?: string;
   questions?: Array<{
@@ -849,12 +877,14 @@ interface AppManifest {
   type: string;
   default?: any;
   required?: boolean;
+  options?: Array<{ value: string; label: string }>;
   }>;
   configSchema?: Record<string, any>;
   saveWith?: {
   method: string;
-  scope: string;
+  scope: 'collection' | 'product' | string;
   admin?: boolean;
+  note?: string;
   };
   contentHints?: Record<string, {
   aiGenerate?: boolean;
@@ -885,44 +915,38 @@ interface AppManifest {
   name: string;
   description?: string;
   type: string;
+  options?: string[];
   }>;
   };
   metrics?: {
-  interactions?: Array<{
-  id: string;
-  description?: string;
-  }>;
-  kpis?: Array<{
-  name: string;
-  compute?: string;
-  }>;
+  interactions?: Array<{ id: string; description?: string }>;
+  kpis?: Array<{ name: string; compute?: string }>;
   };
-  [key: string]: any; // Allow additional custom fields
+  [key: string]: any;
 }
 ```
 
-**CollectionWidget** (interface)
+**CollectionAppWidget** (interface)
 ```typescript
-interface CollectionWidget {
+interface CollectionAppWidget {
   appId: string;
-  manifestUrl: string;
   manifest: AppManifest;
-  bundleSource: string;
-  bundleCss?: string; // Optional CSS file
+  widget: AppBundle;
+  container: AppBundle | null;
 }
 ```
 
 **CollectionWidgetsResponse** (interface)
 ```typescript
 interface CollectionWidgetsResponse {
-  apps: CollectionWidget[];
+  apps: CollectionAppWidget[];
 }
 ```
 
 **GetCollectionWidgetsOptions** (interface)
 ```typescript
 interface GetCollectionWidgetsOptions {
-  force?: boolean; // Bypass cache and fetch fresh data
+  force?: boolean;
 }
 ```
 

package/dist/types/appManifest.d.ts

@@ -1,6 +1,54 @@
 /**
- * SmartLinks App Manifest structure
- * Defines the configuration, widgets, setup, import, and metrics for a microapp
+ * A bundle (widget or container) as returned by the collection widgets endpoint.
+ *
+ * The server currently returns URLs only. In future it may also inline the file
+ * contents when bundles are small or frequently accessed. Clients should check
+ * for inline content first and fall back to loading the URL.
+ *
+ *   if (bundle.source) {
+ *     // inline JS — create a Blob URL or inject directly
+ *   } else if (bundle.js) {
+ *     // load from URL
+ *   }
+ */
+export interface AppBundle {
+    /** URL to the JavaScript file — load if `source` is absent */
+    js: string | null;
+    /** URL to the CSS file — load if `styles` is absent */
+    css: string | null;
+    /** Inlined JavaScript source (present when server bundles it inline) */
+    source?: string;
+    /** Inlined CSS styles (present when server bundles it inline) */
+    styles?: string;
+}
+/**
+ * A single widget defined in the manifest.
+ * Presence of the `widgets` array means a widget bundle exists for this app.
+ */
+export interface AppWidgetDefinition {
+    name: string;
+    description?: string;
+    sizes?: Array<'compact' | 'standard' | 'large' | string>;
+    props?: {
+        required?: string[];
+        optional?: string[];
+    };
+}
+/**
+ * A single container defined in the manifest.
+ * Presence of the `containers` array means a container bundle exists for this app.
+ * Containers are full-page / embedded components (larger than widgets, no iframe needed).
+ */
+export interface AppContainerDefinition {
+    name: string;
+    description?: string;
+    props?: {
+        required?: string[];
+        optional?: string[];
+    };
+}
+/**
+ * SmartLinks App Manifest — the app.manifest.json structure.
  */
 export interface AppManifest {
     $schema?: string;
@@ -11,15 +59,10 @@ export interface AppManifest {
         platformRevision?: string;
         appId: string;
     };
-    widgets?: Array<{
-        name: string;
-        description?: string;
-        sizes?: string[];
-        props?: {
-            required?: string[];
-            optional?: string[];
-        };
-    }>;
+    /** Presence means a widget bundle (widgets.umd.js / widgets.css) exists */
+    widgets?: AppWidgetDefinition[];
+    /** Presence means a container bundle (containers.umd.js / containers.css) exists */
+    containers?: AppContainerDefinition[];
     setup?: {
         description?: string;
         questions?: Array<{
@@ -28,12 +71,17 @@ export interface AppManifest {
             type: string;
             default?: any;
             required?: boolean;
+            options?: Array<{
+                value: string;
+                label: string;
+            }>;
         }>;
         configSchema?: Record<string, any>;
         saveWith?: {
             method: string;
-            scope: string;
+            scope: 'collection' | 'product' | string;
             admin?: boolean;
+            note?: string;
         };
         contentHints?: Record<string, {
             aiGenerate?: boolean;
@@ -64,6 +112,7 @@ export interface AppManifest {
             name: string;
             description?: string;
             type: string;
+            options?: string[];
         }>;
     };
     metrics?: {
@@ -79,24 +128,26 @@ export interface AppManifest {
     [key: string]: any;
 }
 /**
- * Single app widget data with manifest and bundle files
+ * One app entry in the collection widgets response.
  */
-export interface CollectionWidget {
+export interface CollectionAppWidget {
     appId: string;
-    manifestUrl: string;
     manifest: AppManifest;
-    bundleSource: string;
-    bundleCss?: string;
+    /** Widget bundle — always present (apps without widgets are excluded from the response) */
+    widget: AppBundle;
+    /** Container bundle — null when the app has no containers */
+    container: AppBundle | null;
 }
 /**
- * Response from collection widgets endpoint
+ * Response from GET /api/v1/public/collection/:collectionId/widgets
  */
 export interface CollectionWidgetsResponse {
-    apps: CollectionWidget[];
+    apps: CollectionAppWidget[];
 }
 /**
  * Options for fetching collection widgets
  */
 export interface GetCollectionWidgetsOptions {
+    /** Bypass server cache and fetch fresh manifests */
     force?: boolean;
 }

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.4.1  |  Generated: 2026-02-20T19:32:34.980Z
+Version: 1.4.2  |  Generated: 2026-02-20T21:56:06.588Z
 
 This is a concise summary of all available API functions and types.
 
@@ -821,6 +821,41 @@ interface AppConfigurationResponse {
 
 ### appManifest
 
+**AppBundle** (interface)
+```typescript
+interface AppBundle {
+  js: string | null;
+  css: string | null;
+  source?: string;
+  styles?: string;
+}
+```
+
+**AppWidgetDefinition** (interface)
+```typescript
+interface AppWidgetDefinition {
+  name: string;
+  description?: string;
+  sizes?: Array<'compact' | 'standard' | 'large' | string>;
+  props?: {
+  required?: string[];
+  optional?: string[];
+  };
+}
+```
+
+**AppContainerDefinition** (interface)
+```typescript
+interface AppContainerDefinition {
+  name: string;
+  description?: string;
+  props?: {
+  required?: string[];
+  optional?: string[];
+  };
+}
+```
+
 **AppManifest** (interface)
 ```typescript
 interface AppManifest {
@@ -832,15 +867,8 @@ interface AppManifest {
   platformRevision?: string;
   appId: string;
   };
-  widgets?: Array<{
-  name: string;
-  description?: string;
-  sizes?: string[];
-  props?: {
-  required?: string[];
-  optional?: string[];
-  };
-  }>;
+  widgets?: AppWidgetDefinition[];
+  containers?: AppContainerDefinition[];
   setup?: {
   description?: string;
   questions?: Array<{
@@ -849,12 +877,14 @@ interface AppManifest {
   type: string;
   default?: any;
   required?: boolean;
+  options?: Array<{ value: string; label: string }>;
   }>;
   configSchema?: Record<string, any>;
   saveWith?: {
   method: string;
-  scope: string;
+  scope: 'collection' | 'product' | string;
   admin?: boolean;
+  note?: string;
   };
   contentHints?: Record<string, {
   aiGenerate?: boolean;
@@ -885,44 +915,38 @@ interface AppManifest {
   name: string;
   description?: string;
   type: string;
+  options?: string[];
   }>;
   };
   metrics?: {
-  interactions?: Array<{
-  id: string;
-  description?: string;
-  }>;
-  kpis?: Array<{
-  name: string;
-  compute?: string;
-  }>;
+  interactions?: Array<{ id: string; description?: string }>;
+  kpis?: Array<{ name: string; compute?: string }>;
   };
-  [key: string]: any; // Allow additional custom fields
+  [key: string]: any;
 }
 ```
 
-**CollectionWidget** (interface)
+**CollectionAppWidget** (interface)
 ```typescript
-interface CollectionWidget {
+interface CollectionAppWidget {
   appId: string;
-  manifestUrl: string;
   manifest: AppManifest;
-  bundleSource: string;
-  bundleCss?: string; // Optional CSS file
+  widget: AppBundle;
+  container: AppBundle | null;
 }
 ```
 
 **CollectionWidgetsResponse** (interface)
 ```typescript
 interface CollectionWidgetsResponse {
-  apps: CollectionWidget[];
+  apps: CollectionAppWidget[];
 }
 ```
 
 **GetCollectionWidgetsOptions** (interface)
 ```typescript
 interface GetCollectionWidgetsOptions {
-  force?: boolean; // Bypass cache and fetch fresh data
+  force?: boolean;
 }
 ```
 

package/package.json

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