@proveanything/smartlinks 2.0.29 → 2.0.31

package/dist/api/collection.d.ts

@@ -1,4 +1,4 @@
-import { CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, AppsConfigResponse, DomainTarget, HubAvailabilityResponse } from "../types/collection.js";
+import { CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, AppsConfigResponse, DomainTarget, HubAvailabilityResponse, CollectionUser, CollectionAccessLevel, InviteUserInput } from "../types/collection.js";
 export declare namespace collection {
     /**
      * Retrieves a single Collection by its ID.
@@ -170,4 +170,35 @@ export declare namespace collection {
      * @throws ErrorResponse if the request fails
      */
     function assignSN(collectionId: string, codeId: string, value: any): Promise<any>;
+    /**
+     * List the users with access to a collection, each with their access level (admin only). Access is
+     * stored in the collection's `roles` map (userId → level); this resolves each to name/email.
+     * GET /admin/collection/:collectionId/getUsers
+     * @param collectionId - Identifier of the collection
+     * @returns Promise resolving to the collection's users
+     */
+    function getUsers(collectionId: string): Promise<CollectionUser[]>;
+    /**
+     * Grant, change, or remove a user's access level on a collection (admin only). Pass `null` or
+     * `'None'` to remove access. The server enforces privilege-escalation rules — you cannot grant an
+     * access level above your own, nor change a user whose level is above yours.
+     * POST /admin/collection/:collectionId/updateUserAccess
+     * @param collectionId - Identifier of the collection
+     * @param userId - The user (auth uid) whose access to change
+     * @param access - The new access level, or `null` to remove access
+     */
+    function setUserAccess(collectionId: string, userId: string, access: CollectionAccessLevel | null): Promise<void>;
+    /**
+     * Invite a user to a collection by email (admin only). Creates or links their account in the login /
+     * auth-kit collection (`loginCollectionId`, default `'global'`) and emails them an invite (new account)
+     * or an added-to-collection notice (existing account); returns their `uid`. This does NOT grant access
+     * on its own — follow with {@link setUserAccess} to set their level (this mirrors the console flow).
+     * POST /user/inviteUser
+     * @param collectionId - The collection the user is being added to (the invite's target)
+     * @param input - Invite details (email, optional name, access level, login collection, origin)
+     * @returns Promise resolving to the invited user's `{ uid }`
+     */
+    function inviteUser(collectionId: string, input: InviteUserInput): Promise<{
+        uid: string;
+    }>;
 }

package/dist/api/collection.js

@@ -253,4 +253,54 @@ export var collection;
         return post(path, { value });
     }
     collection.assignSN = assignSN;
+    /**
+     * List the users with access to a collection, each with their access level (admin only). Access is
+     * stored in the collection's `roles` map (userId → level); this resolves each to name/email.
+     * GET /admin/collection/:collectionId/getUsers
+     * @param collectionId - Identifier of the collection
+     * @returns Promise resolving to the collection's users
+     */
+    async function getUsers(collectionId) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/getUsers`);
+    }
+    collection.getUsers = getUsers;
+    /**
+     * Grant, change, or remove a user's access level on a collection (admin only). Pass `null` or
+     * `'None'` to remove access. The server enforces privilege-escalation rules — you cannot grant an
+     * access level above your own, nor change a user whose level is above yours.
+     * POST /admin/collection/:collectionId/updateUserAccess
+     * @param collectionId - Identifier of the collection
+     * @param userId - The user (auth uid) whose access to change
+     * @param access - The new access level, or `null` to remove access
+     */
+    async function setUserAccess(collectionId, userId, access) {
+        await post(`/admin/collection/${encodeURIComponent(collectionId)}/updateUserAccess`, {
+            userId,
+            access: access !== null && access !== void 0 ? access : 'None'
+        });
+    }
+    collection.setUserAccess = setUserAccess;
+    /**
+     * Invite a user to a collection by email (admin only). Creates or links their account in the login /
+     * auth-kit collection (`loginCollectionId`, default `'global'`) and emails them an invite (new account)
+     * or an added-to-collection notice (existing account); returns their `uid`. This does NOT grant access
+     * on its own — follow with {@link setUserAccess} to set their level (this mirrors the console flow).
+     * POST /user/inviteUser
+     * @param collectionId - The collection the user is being added to (the invite's target)
+     * @param input - Invite details (email, optional name, access level, login collection, origin)
+     * @returns Promise resolving to the invited user's `{ uid }`
+     */
+    async function inviteUser(collectionId, input) {
+        var _a, _b;
+        const consoleOrigin = (_a = input.consoleOrigin) !== null && _a !== void 0 ? _a : (typeof window !== 'undefined' ? window.location.origin : undefined);
+        return post(`/user/inviteUser`, {
+            email: input.email.trim(),
+            name: input.name,
+            collectionId: (_b = input.loginCollectionId) !== null && _b !== void 0 ? _b : 'global',
+            targetCollectionId: collectionId,
+            accessLevel: input.access,
+            consoleOrigin
+        });
+    }
+    collection.inviteUser = inviteUser;
 })(collection || (collection = {}));

package/dist/api/integrations.d.ts

@@ -1,4 +1,4 @@
-import type { IntegrationFlow, CreateFlowInput, UpdateFlowInput, ListFlowsQuery, FlowList, RunFlowInput, RunFlowResult, RunFlowSummary, RunFlowEnqueued, RecordTypesResponse } from "../types/integrations.js";
+import type { IntegrationFlow, CreateFlowInput, UpdateFlowInput, ListFlowsQuery, FlowList, RunFlowInput, RunFlowResult, RunFlowSummary, RunFlowEnqueued, RecordTypesResponse, FlowRun, ListRunsQuery, RunList, ListRunItemsQuery, RunItemList, LoggingWindow, SetLoggingInput } from "../types/integrations.js";
 export declare namespace integrations {
     /** List flows in a collection. GET /integrations/flows */
     function listFlows(collectionId: string, query?: ListFlowsQuery): Promise<FlowList>;
@@ -31,4 +31,30 @@ export declare namespace integrations {
     function isRunSummary(r: RunFlowResult): r is RunFlowSummary;
     /** Type guard: the run was enqueued (async). */
     function isRunEnqueued(r: RunFlowResult): r is RunFlowEnqueued;
+    /** List a flow's runs, newest first. GET /integrations/flows/:id/runs */
+    function listRuns(collectionId: string, flowId: string, query?: ListRunsQuery): Promise<RunList>;
+    /** Get one run's summary. GET /integrations/flows/:id/runs/:runId */
+    function getRun(collectionId: string, flowId: string, runId: string): Promise<FlowRun>;
+    /**
+     * List a run's per-record items. GET /integrations/flows/:id/runs/:runId/items
+     * `request`/`response` are populated only for items captured while enhanced logging
+     * was active (and before the 24h body purge).
+     */
+    function listRunItems(collectionId: string, flowId: string, runId: string, query?: ListRunItemsQuery): Promise<RunItemList>;
+    /** Every run touching an entity (e.g. a product), across flows. GET /integrations/runs/entity/:entityId */
+    function listEntityRuns(collectionId: string, entityId: string, query?: {
+        limit?: number;
+    }): Promise<RunList>;
+    /** Is enhanced logging active for a connection? GET /integrations/logging/:connectionId */
+    function getLogging(collectionId: string, connectionId: string): Promise<{
+        window: LoggingWindow | null;
+    }>;
+    /** Enable enhanced logging. POST /integrations/logging/:connectionId (omit ttlMinutes = until cancelled) */
+    function setLogging(collectionId: string, connectionId: string, input?: SetLoggingInput): Promise<{
+        window: LoggingWindow;
+    }>;
+    /** Cancel enhanced logging now. DELETE /integrations/logging/:connectionId */
+    function cancelLogging(collectionId: string, connectionId: string): Promise<{
+        canceled: boolean;
+    }>;
 }

package/dist/api/integrations.js

@@ -88,4 +88,51 @@ export var integrations;
         return r.enqueued === true;
     }
     integrations.isRunEnqueued = isRunEnqueued;
+    // --- Run logs -----------------------------------------------------------
+    // A run row is written for every execution (manual, event, scheduled, test). Per-record
+    // request/response detail is captured only while enhanced logging is active for the
+    // connection (see setLogging); otherwise runs carry metadata only.
+    /** List a flow's runs, newest first. GET /integrations/flows/:id/runs */
+    async function listRuns(collectionId, flowId, query = {}) {
+        return request(`${base(collectionId)}/${enc(flowId)}/runs${encodeQuery(query)}`);
+    }
+    integrations.listRuns = listRuns;
+    /** Get one run's summary. GET /integrations/flows/:id/runs/:runId */
+    async function getRun(collectionId, flowId, runId) {
+        return request(`${base(collectionId)}/${enc(flowId)}/runs/${enc(runId)}`);
+    }
+    integrations.getRun = getRun;
+    /**
+     * List a run's per-record items. GET /integrations/flows/:id/runs/:runId/items
+     * `request`/`response` are populated only for items captured while enhanced logging
+     * was active (and before the 24h body purge).
+     */
+    async function listRunItems(collectionId, flowId, runId, query = {}) {
+        return request(`${base(collectionId)}/${enc(flowId)}/runs/${enc(runId)}/items${encodeQuery(query)}`);
+    }
+    integrations.listRunItems = listRunItems;
+    /** Every run touching an entity (e.g. a product), across flows. GET /integrations/runs/entity/:entityId */
+    async function listEntityRuns(collectionId, entityId, query = {}) {
+        return request(`/admin/collection/${enc(collectionId)}/integrations/runs/entity/${enc(entityId)}${encodeQuery(query)}`);
+    }
+    integrations.listEntityRuns = listEntityRuns;
+    // --- Enhanced logging window (per connection) ---------------------------
+    // Full request/response capture is off by default. Turn it on for a connection while
+    // debugging; it applies to every flow on that connection and auto-expires (or runs until
+    // cancelled). Bodies are redacted at capture and purged after 24h.
+    /** Is enhanced logging active for a connection? GET /integrations/logging/:connectionId */
+    async function getLogging(collectionId, connectionId) {
+        return request(`/admin/collection/${enc(collectionId)}/integrations/logging/${enc(connectionId)}`);
+    }
+    integrations.getLogging = getLogging;
+    /** Enable enhanced logging. POST /integrations/logging/:connectionId (omit ttlMinutes = until cancelled) */
+    async function setLogging(collectionId, connectionId, input = {}) {
+        return post(`/admin/collection/${enc(collectionId)}/integrations/logging/${enc(connectionId)}`, input);
+    }
+    integrations.setLogging = setLogging;
+    /** Cancel enhanced logging now. DELETE /integrations/logging/:connectionId */
+    async function cancelLogging(collectionId, connectionId) {
+        return del(`/admin/collection/${enc(collectionId)}/integrations/logging/${enc(connectionId)}`);
+    }
+    integrations.cancelLogging = cancelLogging;
 })(integrations || (integrations = {}));

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 2.0.29  |  Generated: 2026-09-29T10:33:46.286Z
+Version: 2.0.31  |  Generated: 2026-09-29T19:37:17.528Z
 
 This is a concise summary of all available API functions and types.
 
@@ -4711,6 +4711,27 @@ interface AppConfig {
 }
 ```
 
+**CollectionUser** (interface)
+```typescript
+interface CollectionUser {
+  uid: string
+  access: CollectionAccessLevel | string
+  name?: string
+  email?: string
+}
+```
+
+**InviteUserInput** (interface)
+```typescript
+interface InviteUserInput {
+  email: string
+  name?: string
+  access: CollectionAccessLevel | string
+  loginCollectionId?: string
+  consoleOrigin?: string
+}
+```
+
 **CollectionResponse** = `Collection`
 
 **CollectionCreateRequest** = `Omit<Collection, 'id' | 'shortId'>`
@@ -4719,6 +4740,8 @@ interface AppConfig {
 
 **DomainTarget** = `"smartlinks" | "hub"`
 
+**CollectionAccessLevel** = `'Owner' | 'Admin' | 'Assigner' | 'Reporter' | 'User' | 'None'`
+
 ### common
 
 **IdField** = `'userId' | 'contactId'`
@@ -6539,6 +6562,7 @@ interface FlowList {
 ```typescript
 interface RunFlowInput {
   entityId?: string
+  trigger?: RunTrigger
 }
 ```
 
@@ -6551,6 +6575,128 @@ interface RunFlowSummary {
   sent: number
   failed: number
   status: RunStatus
+  runId?: string
+}
+```
+
+**CapturedRequest** (interface)
+```typescript
+interface CapturedRequest {
+  transport: string
+  method: string
+  url: string
+  headers: Record<string, string>
+  partitionKey?: string
+  body: unknown
+  bodyBytes: number
+  truncated: boolean
+}
+```
+
+**CapturedResponse** (interface)
+```typescript
+interface CapturedResponse {
+  status: number | null
+  ok: boolean | null
+  headers: Record<string, string>
+  body: unknown
+  bodyBytes: number
+  truncated: boolean
+  error: string | null
+}
+```
+
+**FlowRun** (interface)
+```typescript
+interface FlowRun {
+  id: string
+  flowId: string
+  connectionId?: string | null
+  trigger: RunTrigger
+  triggerEvent?: string | null
+  triggerEntityId?: string | null
+  status: FlowRunStatus
+  records: number
+  sent: number
+  failed: number
+  error?: string | null
+  correlationId?: string | null
+  captureLevel: CaptureLevel
+  bodiesPurged: boolean
+  startedAt: string
+  completedAt?: string | null
+  durationMs?: number | null
+}
+```
+
+**FlowRunItem** (interface)
+```typescript
+interface FlowRunItem {
+  id: string
+  runId: string
+  entityType: string
+  entityId?: string | null
+  entityLabel?: string | null
+  status: FlowRunItemStatus
+  skipReason?: string | null
+  request?: CapturedRequest | null
+  response?: CapturedResponse | null
+  attempt: number
+  durationMs?: number | null
+  createdAt: string
+}
+```
+
+**ListRunsQuery** (interface)
+```typescript
+interface ListRunsQuery {
+  status?: FlowRunStatus
+  trigger?: RunTrigger
+  entityId?: string
+  limit?: number
+  cursor?: string
+}
+```
+
+**RunList** (interface)
+```typescript
+interface RunList {
+  runs: FlowRun[]; nextCursor?: string
+}
+```
+
+**ListRunItemsQuery** (interface)
+```typescript
+interface ListRunItemsQuery {
+  status?: FlowRunItemStatus; limit?: number; cursor?: string
+}
+```
+
+**RunItemList** (interface)
+```typescript
+interface RunItemList {
+  items: FlowRunItem[]; nextCursor?: string
+}
+```
+
+**LoggingWindow** (interface)
+```typescript
+interface LoggingWindow {
+  id: string
+  connectionId: string
+  level: CaptureLevel
+  enabledBy?: string | null
+  enabledAt: string
+  expiresAt?: string | null
+  canceledAt?: string | null
+}
+```
+
+**SetLoggingInput** (interface)
+```typescript
+interface SetLoggingInput {
+  ttlMinutes?: number
+  level?: 'full' | 'errors_only'
 }
 ```
 
@@ -6637,6 +6783,14 @@ interface RecordTypesResponse {
 
 **UpdateFlowInput** = `Partial<Omit<CreateFlowInput, 'direction'>> & {`
 
+**RunTrigger** = `'manual' | 'event' | 'schedule' | 'test'`
+
+**FlowRunStatus** = `'running' | 'success' | 'partial' | 'failed' | 'skipped'`
+
+**FlowRunItemStatus** = `'sent' | 'failed' | 'skipped'`
+
+**CaptureLevel** = `'metadata' | 'errors_only' | 'full'`
+
 **RunFlowResult** = `RunFlowSummary | RunFlowEnqueued`
 
 ### interaction
@@ -10433,6 +10587,18 @@ Look up a serial number by code for a collection (admin only).
     value: any) → `Promise<any>`
 Assign a value to a serial number for a collection (admin only).
 
+**getUsers**(collectionId: string) → `Promise<CollectionUser[]>`
+List the users with access to a collection, each with their access level (admin only). Access is stored in the collection's `roles` map (userId → level); this resolves each to name/email. GET /admin/collection/:collectionId/getUsers
+
+**setUserAccess**(collectionId: string,
+    userId: string,
+    access: CollectionAccessLevel | null) → `Promise<void>`
+Grant, change, or remove a user's access level on a collection (admin only). Pass `null` or `'None'` to remove access. The server enforces privilege-escalation rules — you cannot grant an access level above your own, nor change a user whose level is above yours. POST /admin/collection/:collectionId/updateUserAccess
+
+**inviteUser**(collectionId: string,
+    input: InviteUserInput) → `Promise<`
+Invite a user to a collection by email (admin only). Creates or links their account in the login / auth-kit collection (`loginCollectionId`, default `'global'`) and emails them an invite (new account) or an added-to-collection notice (existing account); returns their `uid`. This does NOT grant access on its own — follow with {@link setUserAccess} to set their level (this mirrors the console flow). POST /user/inviteUser
+
 ### comms
 
 **getPushVapidPublicKey**(collectionId: string) → `Promise<import("../types/comms").PushVapidResponse>`
@@ -10815,6 +10981,27 @@ Type guard: the run executed inline and returned a summary.
 **isRunEnqueued**(r: RunFlowResult) → `r is RunFlowEnqueued`
 Type guard: the run was enqueued (async).
 
+**listRuns**(collectionId: string, flowId: string, query: ListRunsQuery = {}) → `Promise<RunList>`
+List a flow's runs, newest first. GET /integrations/flows/:id/runs
+
+**getRun**(collectionId: string, flowId: string, runId: string) → `Promise<FlowRun>`
+Get one run's summary. GET /integrations/flows/:id/runs/:runId
+
+**listRunItems**(collectionId: string, flowId: string, runId: string, query: ListRunItemsQuery = {}) → `Promise<RunItemList>`
+List a run's per-record items. GET /integrations/flows/:id/runs/:runId/items `request`/`response` are populated only for items captured while enhanced logging was active (and before the 24h body purge).
+
+**listEntityRuns**(collectionId: string, entityId: string, query: { limit?: number } = {}) → `Promise<RunList>`
+Every run touching an entity (e.g. a product), across flows. GET /integrations/runs/entity/:entityId
+
+**getLogging**(collectionId: string, connectionId: string) → `Promise<`
+Is enhanced logging active for a connection? GET /integrations/logging/:connectionId
+
+**setLogging**(collectionId: string, connectionId: string, input: SetLoggingInput = {}) → `Promise<`
+Enable enhanced logging. POST /integrations/logging/:connectionId (omit ttlMinutes = until cancelled)
+
+**cancelLogging**(collectionId: string, connectionId: string) → `Promise<`
+Cancel enhanced logging now. DELETE /integrations/logging/:connectionId
+
 ### interactions
 
 **query**(collectionId: string,