@proveanything/smartlinks 1.3.6 → 1.3.9

package/dist/types/iframeResponder.d.ts

@@ -0,0 +1,112 @@
+export type { AuthKitUser } from './authKit';
+export type { AppConfig as CollectionApp } from './collection';
+import type { AppConfig } from './collection';
+export interface CachedData {
+    collection?: Record<string, any>;
+    product?: Record<string, any>;
+    proof?: Record<string, any>;
+    user?: {
+        uid: string;
+        email?: string;
+        displayName?: string;
+        accountData?: Record<string, any>;
+    } | null;
+    apps?: AppConfig[];
+}
+export interface IframeResponderOptions {
+    collectionId: string;
+    appId: string;
+    productId?: string;
+    proofId?: string;
+    /** Version to load: 'stable' | 'development' | specific version */
+    version?: string;
+    /** Override auto-resolved URL (for local development) */
+    appUrl?: string;
+    /** Initial hash path (e.g., '/settings') */
+    initialPath?: string;
+    /** Is user an admin of this collection */
+    isAdmin?: boolean;
+    cache?: CachedData;
+    onAuthLogin?: (token: string, user: any, accountData?: Record<string, any>) => Promise<void>;
+    onAuthLogout?: () => Promise<void>;
+    onRouteChange?: (path: string, state: Record<string, string>) => void;
+    onResize?: (height: number) => void;
+    onError?: (error: Error) => void;
+    onReady?: () => void;
+}
+export interface RouteChangeMessage {
+    type: 'smartlinks-route-change';
+    path: string;
+    context: Record<string, string>;
+    state: Record<string, string>;
+    appId?: string;
+}
+export interface SmartlinksIframeMessage {
+    _smartlinksIframeMessage: true;
+    type: 'smartlinks:resize' | 'smartlinks:redirect' | 'smartlinks:authkit:login' | 'smartlinks:authkit:logout' | 'smartlinks:authkit:redirect';
+    payload: Record<string, any>;
+    messageId?: string;
+}
+export interface ProxyRequest {
+    _smartlinksProxyRequest: true;
+    id: string;
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    path: string;
+    body?: any;
+    headers?: Record<string, string>;
+}
+export interface CustomProxyRequest {
+    _smartlinksProxyRequest: true;
+    _smartlinksCustomProxyRequest: true;
+    id: string;
+    request: 'REDIRECT' | string;
+    params: Record<string, any>;
+}
+export interface ProxyResponse {
+    _smartlinksProxyResponse: true;
+    id: string;
+    data?: any;
+    error?: string;
+}
+export interface UploadStartMessage {
+    _smartlinksProxyUpload: true;
+    phase: 'start';
+    id: string;
+    fields: [string, string][];
+    fileInfo: {
+        type?: string;
+        name?: string;
+        key?: string;
+    };
+    path: string;
+    headers?: Record<string, string>;
+}
+export interface UploadChunkMessage {
+    _smartlinksProxyUpload: true;
+    phase: 'chunk';
+    id: string;
+    seq: number;
+    chunk: ArrayBuffer;
+}
+export interface UploadEndMessage {
+    _smartlinksProxyUpload: true;
+    phase: 'end';
+    id: string;
+}
+export interface UploadAckMessage {
+    _smartlinksProxyUpload: true;
+    phase: 'ack';
+    id: string;
+    seq: number;
+}
+export interface UploadDoneMessage {
+    _smartlinksProxyUpload: true;
+    phase: 'done';
+    id: string;
+    ok: boolean;
+    data?: any;
+    error?: string;
+}
+export type UploadMessage = UploadStartMessage | UploadChunkMessage | UploadEndMessage | UploadAckMessage | UploadDoneMessage;
+/** Reserved iframe context parameters (not app state) */
+export declare const KNOWN_IFRAME_PARAMS: Set<string>;

package/dist/types/iframeResponder.js

@@ -0,0 +1,18 @@
+// =============================================================================
+// IframeResponder Types - Type definitions for iframe communication
+// =============================================================================
+// =============================================================================
+// Constants
+// =============================================================================
+/** Reserved iframe context parameters (not app state) */
+export const KNOWN_IFRAME_PARAMS = new Set([
+    'collectionId',
+    'appId',
+    'productId',
+    'proofId',
+    'isAdmin',
+    'dark',
+    'parentUrl',
+    'theme',
+    'lang',
+]);

package/dist/types/index.d.ts

@@ -24,3 +24,4 @@ export * from "./jobs";
 export * from "./realtime";
 export * from "./tags";
 export * from "./order";
+export * from "./iframeResponder";

package/dist/types/index.js

@@ -26,3 +26,4 @@ export * from "./jobs";
 export * from "./realtime";
 export * from "./tags";
 export * from "./order";
+export * from "./iframeResponder";

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.6  |  Generated: 2026-02-04T13:17:46.204Z
+Version: 1.3.9  |  Generated: 2026-02-05T20:01:56.914Z
 
 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'>`
@@ -1458,6 +1489,165 @@ interface ErrorResponse {
 }
 ```
 
+### iframeResponder
+
+**CachedData** (interface)
+```typescript
+interface CachedData {
+  collection?: Record<string, any>;
+  product?: Record<string, any>;
+  proof?: Record<string, any>;
+  user?: {
+  uid: string;
+  email?: string;
+  displayName?: string;
+  accountData?: Record<string, any>;
+  } | null;
+  apps?: AppConfig[];
+}
+```
+
+**IframeResponderOptions** (interface)
+```typescript
+interface IframeResponderOptions {
+  collectionId: string;
+  appId: string;
+  productId?: string;
+  proofId?: string;
+  version?: string;
+  appUrl?: string;
+  initialPath?: string;
+  isAdmin?: boolean;
+  cache?: CachedData;
+  onAuthLogin?: (
+  token: string,
+  user: any,
+  accountData?: Record<string, any>
+  ) => Promise<void>;
+  onAuthLogout?: () => Promise<void>;
+  onRouteChange?: (path: string, state: Record<string, string>) => void;
+  onResize?: (height: number) => void;
+  onError?: (error: Error) => void;
+  onReady?: () => void;
+}
+```
+
+**RouteChangeMessage** (interface)
+```typescript
+interface RouteChangeMessage {
+  type: 'smartlinks-route-change';
+  path: string;
+  context: Record<string, string>;
+  state: Record<string, string>;
+  appId?: string;
+}
+```
+
+**SmartlinksIframeMessage** (interface)
+```typescript
+interface SmartlinksIframeMessage {
+  _smartlinksIframeMessage: true;
+  type:
+  | 'smartlinks:resize'
+  | 'smartlinks:redirect'
+  | 'smartlinks:authkit:login'
+  | 'smartlinks:authkit:logout'
+  | 'smartlinks:authkit:redirect';
+  payload: Record<string, any>;
+  messageId?: string;
+}
+```
+
+**ProxyRequest** (interface)
+```typescript
+interface ProxyRequest {
+  _smartlinksProxyRequest: true;
+  id: string;
+  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+  path: string;
+  body?: any;
+  headers?: Record<string, string>;
+}
+```
+
+**CustomProxyRequest** (interface)
+```typescript
+interface CustomProxyRequest {
+  _smartlinksProxyRequest: true;
+  _smartlinksCustomProxyRequest: true;
+  id: string;
+  request: 'REDIRECT' | string;
+  params: Record<string, any>;
+}
+```
+
+**ProxyResponse** (interface)
+```typescript
+interface ProxyResponse {
+  _smartlinksProxyResponse: true;
+  id: string;
+  data?: any;
+  error?: string;
+}
+```
+
+**UploadStartMessage** (interface)
+```typescript
+interface UploadStartMessage {
+  _smartlinksProxyUpload: true;
+  phase: 'start';
+  id: string;
+  fields: [string, string][];
+  fileInfo: { type?: string; name?: string; key?: string };
+  path: string;
+  headers?: Record<string, string>;
+}
+```
+
+**UploadChunkMessage** (interface)
+```typescript
+interface UploadChunkMessage {
+  _smartlinksProxyUpload: true;
+  phase: 'chunk';
+  id: string;
+  seq: number;
+  chunk: ArrayBuffer;
+}
+```
+
+**UploadEndMessage** (interface)
+```typescript
+interface UploadEndMessage {
+  _smartlinksProxyUpload: true;
+  phase: 'end';
+  id: string;
+}
+```
+
+**UploadAckMessage** (interface)
+```typescript
+interface UploadAckMessage {
+  _smartlinksProxyUpload: true;
+  phase: 'ack';
+  id: string;
+  seq: number;
+}
+```
+
+**UploadDoneMessage** (interface)
+```typescript
+interface UploadDoneMessage {
+  _smartlinksProxyUpload: true;
+  phase: 'done';
+  id: string;
+  ok: boolean;
+  data?: any;
+  error?: string;
+}
+```
+
+**UploadMessage** = ``
+
 ### interaction
 
 **AdminInteractionsQueryRequest** (interface)
@@ -2998,6 +3188,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).