@proveanything/smartlinks 1.9.13 → 1.9.15

package/dist/types/config.d.ts

@@ -0,0 +1,132 @@
+/** Accepted input widget types for a FieldDefinition. */
+export type FieldType = 'text' | 'email' | 'url' | 'textarea' | 'number' | 'select' | 'switch' | 'checkbox' | 'date' | 'json' | 'image-upload' | 'file-upload';
+/** A label/value pair used when FieldDefinition.type === 'select'. */
+export interface FieldOption {
+    label: string;
+    value: string;
+}
+/**
+ * A single entry in the platform field catalog.
+ * Fields are referenced by their `id` inside ProofTypeDefinition.groupFields / proofFields arrays.
+ */
+export interface FieldDefinition {
+    /** Unique identifier, kebab-case. Auto-generated from `label` if omitted on create. */
+    id: string;
+    /** Human-readable display label shown in forms. */
+    label: string;
+    /** Key used when storing the value on the product/proof document. Defaults to `id`. */
+    storageKey?: string;
+    /** Input widget type. */
+    type: FieldType;
+    /** Available choices — only relevant when type === 'select'. */
+    options?: FieldOption[];
+    /** Whether the field must be filled in. */
+    required?: boolean;
+    /** Column span (1–12) in a 12-column grid. */
+    col?: number;
+    /** Placeholder text shown inside the input. */
+    placeholder?: string;
+    /** Descriptive hint shown below the input. */
+    help?: string;
+    /** Numeric minimum — only relevant when type === 'number'. */
+    min?: number;
+    /** Numeric maximum — only relevant when type === 'number'. */
+    max?: number;
+    /** Step increment — only relevant when type === 'number'. */
+    step?: number;
+    /** Number of visible rows — only relevant when type === 'textarea' or 'json'. */
+    rows?: number;
+    /** Auto-grow textarea height — only relevant when type === 'textarea'. */
+    autoGrow?: boolean;
+    /** Accept filter passed to the file input — only relevant when type === 'image-upload' or 'file-upload'. Examples: 'image/*', '.glb,.gltf,.fbx' */
+    accept?: string;
+    /** Whether the input has a clear (×) button (text/number fields). Default true. */
+    clearable?: boolean;
+    /** Disable this field regardless of model state. */
+    disabled?: boolean;
+    /**
+     * Conditional visibility. If absent the field is always shown.
+     * Object form: `{ field: 'someKey', equals: 'someValue' }` — show when `model[field] === equals`.
+     */
+    showIf?: {
+        field: string;
+        equals: unknown;
+    };
+}
+/**
+ * The base proof mechanism that items in a proof type use.
+ * Matches the `proofType` / `proofTypes` values stored on product documents.
+ */
+export type ProofMechanism = 'certificate' | 'ownable' | 'consumable' | 'timeline' | 'docent' | 'connected' | 'text' | 'image' | 'video';
+/**
+ * A proof type defines a template for creating products.
+ * It specifies which fields to show, which apps are pre-installed,
+ * and how the portal should behave.
+ */
+export interface ProofTypeDefinition {
+    /** Unique identifier, kebab-case. Auto-generated from `name` if omitted on create. */
+    id: string;
+    /** Human-readable name shown in product-creation wizards. */
+    name: string;
+    /** Long description shown in the proof type picker UI. */
+    description?: string;
+    /**
+     * Grouping used to organise proof types in the picker.
+     * Examples: 'basic', 'retail', 'ownable', 'consumable', 'attendance',
+     * 'qualification', 'creative', 'memories', 'safety', 'connected',
+     * 'smartdocent', 'tradable'
+     */
+    category?: string;
+    /**
+     * Whether this proof type is shown to users.
+     * Only types with `active === true` are returned to the public API
+     * when the platform admin has filtered by "Only Active".
+     */
+    active?: boolean;
+    /** Whether this proof type produces a group of items (true) or a single item (false). */
+    group: boolean;
+    /**
+     * The underlying proof mechanisms that products of this type can use.
+     * Stored as `proofTypes` (plural) on the product document.
+     */
+    proofTypes?: ProofMechanism[];
+    /** Legacy single-value equivalent of proofTypes. */
+    proofType?: ProofMechanism;
+    /**
+     * Field IDs (from the field catalog) shown when creating/editing the product group.
+     * Ordered — rendered in this sequence.
+     */
+    groupFields?: string[];
+    /**
+     * Field IDs shown when creating/editing an individual proof item within the group.
+     * If absent, falls back to groupFields.
+     */
+    proofFields?: string[];
+    /**
+     * Column definitions shown in the proof list view.
+     * Keys are field IDs; value true means show the column.
+     */
+    listFields?: Record<string, boolean>;
+    /**
+     * App uniqueNames automatically installed (for free) when this proof type is selected.
+     */
+    freeApps?: string[];
+    /**
+     * App uniqueNames shown as recommended paid add-ons for this proof type.
+     */
+    apps?: string[];
+    /** Collection-level slug that this proof type is scoped to (legacy, rarely used). */
+    collection?: string;
+    /** Action name used by the legacy proof action pipeline. */
+    action?: string;
+    /** Whether items are soul-bound (non-transferable by default). */
+    bound?: 'soul';
+    /**
+     * UI translation overrides for this proof type.
+     * Keys are source English words; values are replacement strings.
+     * Example: `{ "Products": "Works" }`
+     */
+    translations?: Record<string, string>;
+    /** Whether product tools (edit, duplicate, etc.) are hidden in the console UI. */
+    hideProductTools?: boolean;
+}

package/dist/types/config.js

@@ -0,0 +1,2 @@
+// src/types/config.ts
+export {};

package/dist/types/index.d.ts

@@ -33,3 +33,4 @@ export * from "./appManifest";
 export * from "./appObjects";
 export * from "./loyalty";
 export * from "./translations";
+export * from "./config";

package/dist/types/index.js

@@ -35,3 +35,4 @@ export * from "./appManifest";
 export * from "./appObjects";
 export * from "./loyalty";
 export * from "./translations";
+export * from "./config";

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.9.13  |  Generated: 2026-03-31T17:02:49.636Z
+Version: 1.9.15  |  Generated: 2026-04-13T12:48:02.968Z
 
 This is a concise summary of all available API functions and types.
 
@@ -103,6 +103,7 @@ The Smartlinks SDK is organized into the following namespaces:
 - **async** - Functions for async operations
 - **attestation** - Functions for attestation operations
 - **attestations** - Functions for attestations operations
+- **config** - Functions for config operations
 - **containers** - Functions for containers operations
 - **facets** - Functions for facets operations
 - **jobs** - Functions for jobs operations
@@ -2866,6 +2867,42 @@ interface CreateClaimSetTagRequest {
 }
 ```
 
+**CreateClaimSetRequest** (interface)
+```typescript
+interface CreateClaimSetRequest {
+  name: string
+  claimMode: string
+  allocationMode: string
+}
+```
+
+**ImportClaimSetTagItem** (interface)
+```typescript
+interface ImportClaimSetTagItem {
+  id: string
+  tagId?: string
+  index?: number
+}
+```
+
+**ImportClaimSetTagsRequest** (interface)
+```typescript
+interface ImportClaimSetTagsRequest {
+  tags: ImportClaimSetTagItem[]
+  * Import mode:
+  * - "upsert" (default) merges with existing tags
+  * - "replace" wipes all existing tags first then writes the new set
+  mode?: 'upsert' | 'replace'
+}
+```
+
+**ImportClaimSetTagsResponse** (interface)
+```typescript
+interface ImportClaimSetTagsResponse {
+  written: number
+}
+```
+
 **CreateClaimSetTagResponse** (interface)
 ```typescript
 interface CreateClaimSetTagResponse {
@@ -3709,6 +3746,90 @@ export interface TransactionalSendError {
 
 export type TransactionalSendResult =`
 
+### config
+
+**FieldOption** (interface)
+```typescript
+interface FieldOption {
+  label: string
+  value: string
+}
+```
+
+**FieldDefinition** (interface)
+```typescript
+interface FieldDefinition {
+  id: string
+  label: string
+  storageKey?: string
+  type: FieldType
+  options?: FieldOption[]
+  required?: boolean
+  col?: number
+  placeholder?: string
+  help?: string
+  min?: number
+  max?: number
+  step?: number
+  rows?: number
+  autoGrow?: boolean
+  accept?: string
+  clearable?: boolean
+  disabled?: boolean
+  * Conditional visibility. If absent the field is always shown.
+  * Object form: `{ field: 'someKey', equals: 'someValue' }` — show when `model[field] === equals`.
+  showIf?: { field: string; equals: unknown }
+}
+```
+
+**ProofTypeDefinition** (interface)
+```typescript
+interface ProofTypeDefinition {
+  id: string
+  name: string
+  description?: string
+  * Grouping used to organise proof types in the picker.
+  * Examples: 'basic', 'retail', 'ownable', 'consumable', 'attendance',
+  * 'qualification', 'creative', 'memories', 'safety', 'connected',
+  * 'smartdocent', 'tradable'
+  category?: string
+  * Whether this proof type is shown to users.
+  * Only types with `active === true` are returned to the public API
+  * when the platform admin has filtered by "Only Active".
+  active?: boolean
+  group: boolean
+  * The underlying proof mechanisms that products of this type can use.
+  * Stored as `proofTypes` (plural) on the product document.
+  proofTypes?: ProofMechanism[]
+  proofType?: ProofMechanism
+  * Field IDs (from the field catalog) shown when creating/editing the product group.
+  * Ordered — rendered in this sequence.
+  groupFields?: string[]
+  * Field IDs shown when creating/editing an individual proof item within the group.
+  * If absent, falls back to groupFields.
+  proofFields?: string[]
+  * Column definitions shown in the proof list view.
+  * Keys are field IDs; value true means show the column.
+  listFields?: Record<string, boolean>
+  * App uniqueNames automatically installed (for free) when this proof type is selected.
+  freeApps?: string[]
+  * App uniqueNames shown as recommended paid add-ons for this proof type.
+  apps?: string[]
+  collection?: string
+  action?: string
+  bound?: 'soul'
+  * UI translation overrides for this proof type.
+  * Keys are source English words; values are replacement strings.
+  * Example: `{ "Products": "Works" }`
+  translations?: Record<string, string>
+  hideProductTools?: boolean
+}
+```
+
+**FieldType** = ``
+
+**ProofMechanism** = ``
+
 ### contact
 
 **Contact** (interface)
@@ -7425,20 +7546,39 @@ Create a Responses API request (streaming or non-streaming)
 
 ### claimSet
 
-**getAllForCollection**(collectionId: string) → `Promise<any[]>`
-Get all claim sets for a collection.
+**getAll**(collectionId?: string) → `Promise<any[]>`
+Get all claim sets. When collectionId is provided, returns claim sets for that collection. When omitted, returns all claim sets owned by the authenticated user.
 
-**getForCollection**(collectionId: string, claimSetId: string) → `Promise<any>`
-Get a specific claim set for a collection.
+**get**(claimSetId: string, collectionId?: string) → `Promise<any>`
+Get a specific claim set by ID.
 
-**getAllTags**(collectionId: string, claimSetId: string) → `Promise<any[]>`
-Get all tags for a claim set.
+**create**(params: CreateClaimSetRequest, collectionId?: string) → `Promise<any>`
+Create a new claim set. When collectionId is provided, creates it scoped to that collection. When omitted, creates a global user-owned claim set.
 
-**getReport**(collectionId: string, claimSetId: string) → `Promise<any>`
-Get a report for a claim set.
+**update**(claimSetId: string, params: any, collectionId?: string) → `Promise<any>`
+Update a claim set.
+
+**remove**(claimSetId: string, collectionId?: string) → `Promise<any>`
+Delete (soft-delete) a claim set.
+
+**getAllTags**(claimSetId: string, collectionId?: string) → `Promise<any>`
+Get all tags for a claim set (including data).
 
-**getAssignedTags**(collectionId: string, claimSetId: string) → `Promise<any>`
-Get assigned tags for a claim set.
+**getAssignedTags**(claimSetId: string, collectionId?: string) → `Promise<any>`
+Get assigned tags for a claim set — tags soft-assigned to a collection or product.
+
+**createTag**(claimSetId: string,
+    data: CreateClaimSetTagRequest,
+    collectionId?: string) → `Promise<CreateClaimSetTagResponse>`
+Create a single tag inside a claim set.
+
+**importTags**(claimSetId: string,
+    data: ImportClaimSetTagsRequest,
+    collectionId?: string) → `Promise<ImportClaimSetTagsResponse>`
+Bulk import tags into a claim set.
+
+**getReport**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get a report for a claim set (collection-scoped).
 
 **getTagSummary**(collectionId: string) → `Promise<any>`
 Get tag summary for a collection.
@@ -7446,29 +7586,14 @@ Get tag summary for a collection.
 **tagQuery**(collectionId: string, data: any) → `Promise<any>`
 Perform a tag query for a collection.
 
-**createForCollection**(collectionId: string, params: any) → `Promise<any>`
-Create a new claim set for a collection.
-
-**updateForCollection**(collectionId: string, params: any) → `Promise<any>`
-Update a claim set for a collection.
-
 **makeClaim**(collectionId: string, params: any) → `Promise<any>`
-Make a claim for a claim set.
+Make a claim against a claim set (collection-scoped).
 
 **assignClaims**(collectionId: string, data: AssignClaimsRequest) → `Promise<any>`
-Assign claims to a claim set. { id: string,          // claim set id (required) collectionId: string,// required productId: string,   // required batchId?: string,    // optional start?: number,      // optional bulk range start end?: number,        // optional bulk range end codeId?: string,     // optional single code data?: { [k: string]: any } // optional claim key/values }
+Assign claims to codes or ranges within a collection.
 
 **updateClaimData**(collectionId: string, data: UpdateClaimDataRequest) → `Promise<any>`
-Update claim data for a collection.
-
-**createTag**(collectionId: string,
-    claimSetId: string,
-    data: CreateClaimSetTagRequest) → `Promise<CreateClaimSetTagResponse>`
-Create a single tag/code inside an existing claim set (collection admin). POST /admin/collection/:collectionId/claimSet/:claimSetId/createTag
-
-**createTagPlatform**(claimSetId: string,
-    data: CreateClaimSetTagRequest) → `Promise<CreateClaimSetTagResponse>`
-Create a single tag/code inside an existing claim set (platform; requires account.features.adminClaimSets). POST /platform/claimSet/:claimSetId/createTag
+Update claim data for a claim set (collection-scoped).
 
 ### collection
 
@@ -7597,6 +7722,14 @@ Logging: Append a single communication event. POST /admin/collection/:collection
     body: LogBulkCommunicationEventsBody | ({ sourceId: string; ids: string[]; idField?: 'userId'|'contactId'; [k: string]: any }) → `void`
 Logging: Append many communication events for a list of IDs. POST /admin/collection/:collectionId/comm/log/bulk
 
+### config
+
+**getFields**() → `Promise<FieldDefinition[]>`
+Returns the full platform field catalog. Fields are used as building blocks for proof type templates — they define the input widgets shown when creating or editing products and proof items. **Endpoint:** `GET /api/v1/public/config/fields`
+
+**getProofTypes**() → `Promise<ProofTypeDefinition[]>`
+Returns all proof type definitions. Proof types are templates that specify which fields to show, which apps are pre-installed, and how the portal behaves for a given product category. **Endpoint:** `GET /api/v1/public/config/proofTypes`
+
 ### contact
 
 **create**(collectionId: string, data: ContactCreateRequest) → `Promise<ContactResponse>`