@proveanything/smartlinks 1.9.13 → 1.9.15

package/dist/api/claimSet.d.ts

@@ -1,110 +1,98 @@
-import { UpdateClaimDataRequest, AssignClaimsRequest, CreateClaimSetTagRequest, CreateClaimSetTagResponse } from "../types";
+import { UpdateClaimDataRequest, AssignClaimsRequest, CreateClaimSetTagRequest, CreateClaimSetTagResponse, CreateClaimSetRequest, ImportClaimSetTagsRequest, ImportClaimSetTagsResponse } from "../types";
 export declare namespace claimSet {
     /**
-     * Get all claim sets for a collection.
-     * @param collectionId – The collection identifier
-     * @returns Promise resolving to an array of claim sets
+     * 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.
+     * @param collectionId – Optional collection identifier
      */
-    function getAllForCollection(collectionId: string): Promise<any[]>;
+    function getAll(collectionId?: string): Promise<any[]>;
     /**
-     * Get a specific claim set for a collection.
-     * @param collectionId – The collection identifier
+     * Get a specific claim set by ID.
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to a claim set object
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
      */
-    function getForCollection(collectionId: string, claimSetId: string): Promise<any>;
+    function get(claimSetId: string, collectionId?: string): Promise<any>;
     /**
-     * Get all tags for a claim set.
-     * @param collectionId – The collection identifier
+     * Create a new claim set.
+     * When collectionId is provided, creates it scoped to that collection.
+     * When omitted, creates a global user-owned claim set.
+     * @param params – Claim set creation parameters
+     * @param collectionId – Optional collection identifier
+     */
+    function create(params: CreateClaimSetRequest, collectionId?: string): Promise<any>;
+    /**
+     * Update a claim set.
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to an array of tags
+     * @param params – Fields to update
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
      */
-    function getAllTags(collectionId: string, claimSetId: string): Promise<any[]>;
+    function update(claimSetId: string, params: any, collectionId?: string): Promise<any>;
     /**
-     * Get a report for a claim set.
-     * @param collectionId – The collection identifier
+     * Delete (soft-delete) a claim set.
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to a report object
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
      */
-    function getReport(collectionId: string, claimSetId: string): Promise<any>;
+    function remove(claimSetId: string, collectionId?: string): Promise<any>;
+    /**
+     * Get all tags for a claim set (including data).
+     * @param claimSetId – The claim set identifier
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    function getAllTags(claimSetId: string, collectionId?: string): Promise<any>;
+    /**
+     * Get assigned tags for a claim set — tags soft-assigned to a collection or product.
+     * @param claimSetId – The claim set identifier
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    function getAssignedTags(claimSetId: string, collectionId?: string): Promise<any>;
+    /**
+     * Create a single tag inside a claim set.
+     * @param claimSetId – The claim set identifier
+     * @param data – Tag creation parameters
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    function createTag(claimSetId: string, data: CreateClaimSetTagRequest, collectionId?: string): Promise<CreateClaimSetTagResponse>;
+    /**
+     * Bulk import tags into a claim set.
+     * @param claimSetId – The claim set identifier
+     * @param data – Import parameters: tags array and optional mode ("upsert" | "replace")
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    function importTags(claimSetId: string, data: ImportClaimSetTagsRequest, collectionId?: string): Promise<ImportClaimSetTagsResponse>;
     /**
-     * Get assigned tags for a claim set.
+     * Get a report for a claim set (collection-scoped).
      * @param collectionId – The collection identifier
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to assigned tags
      */
-    function getAssignedTags(collectionId: string, claimSetId: string): Promise<any>;
+    function getReport(collectionId: string, claimSetId: string): Promise<any>;
     /**
      * Get tag summary for a collection.
      * @param collectionId – The collection identifier
-     * @returns Promise resolving to tag summary
      */
     function getTagSummary(collectionId: string): Promise<any>;
     /**
      * Perform a tag query for a collection.
      * @param collectionId – The collection identifier
      * @param data – The query data
-     * @returns Promise resolving to query results
      */
     function tagQuery(collectionId: string, data: any): Promise<any>;
     /**
-     * Create a new claim set for a collection.
-     * @param collectionId – The collection identifier
-     * @param params – The claim set creation parameters
-     * @returns Promise resolving to the created claim set
-     */
-    function createForCollection(collectionId: string, params: any): Promise<any>;
-    /**
-     * Update a claim set for a collection.
-     * @param collectionId – The collection identifier
-     * @param params – The claim set update parameters (must include id)
-     * @returns Promise resolving to the updated claim set
-     */
-    function updateForCollection(collectionId: string, params: any): Promise<any>;
-    /**
-     * Make a claim for a claim set.
+     * Make a claim against a claim set (collection-scoped).
      * @param collectionId – The collection identifier
-     * @param params – The claim parameters (must include id)
-     * @returns Promise resolving to the claim result
+     * @param params – Claim parameters (must include id)
      */
     function makeClaim(collectionId: string, params: any): Promise<any>;
     /**
-     * Assign claims to a claim set.
+     * Assign claims to codes or ranges within a collection.
      * @param collectionId – The collection identifier
-     * @param data – The claims data to assign
-     *  {
-     *    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
-     *  }
+     * @param data – Claims assignment data
      */
     function assignClaims(collectionId: string, data: AssignClaimsRequest): Promise<any>;
     /**
-     * Update claim data for a collection.
+     * Update claim data for a claim set (collection-scoped).
      * @param collectionId – The collection identifier
-     * @param data – The claim data to update
+     * @param data – Claim data to update
      */
     function updateClaimData(collectionId: string, data: UpdateClaimDataRequest): Promise<any>;
-    /**
-     * Create a single tag/code inside an existing claim set (collection admin).
-     * POST /admin/collection/:collectionId/claimSet/:claimSetId/createTag
-     * @param collectionId – The collection identifier
-     * @param claimSetId – The claim set identifier
-     * @param data – Tag creation parameters
-     * @returns Promise resolving to the created tag
-     */
-    function createTag(collectionId: string, 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
-     * @param claimSetId – The claim set identifier
-     * @param data – Tag creation parameters
-     * @returns Promise resolving to the created tag
-     */
-    function createTagPlatform(claimSetId: string, data: CreateClaimSetTagRequest): Promise<CreateClaimSetTagResponse>;
 }

package/dist/api/claimSet.js

@@ -1,167 +1,155 @@
-import { request, post, put } from "../http";
+import { request, post, put, del } from "../http";
+/**
+ * Returns the base path for claim set endpoints.
+ * When collectionId is provided, routes to the collection-scoped admin API.
+ * When omitted, routes to the user-scoped admin API (global claim sets).
+ */
+function base(collectionId) {
+    return collectionId
+        ? `/admin/collection/${encodeURIComponent(collectionId)}/claimSet`
+        : `/admin/claimSet`;
+}
 export var claimSet;
 (function (claimSet) {
     /**
-     * Get all claim sets for a collection.
-     * @param collectionId – The collection identifier
-     * @returns Promise resolving to an array of claim sets
+     * 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.
+     * @param collectionId – Optional collection identifier
      */
-    async function getAllForCollection(collectionId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet`;
-        return request(path);
+    async function getAll(collectionId) {
+        return request(base(collectionId));
     }
-    claimSet.getAllForCollection = getAllForCollection;
+    claimSet.getAll = getAll;
     /**
-     * Get a specific claim set for a collection.
-     * @param collectionId – The collection identifier
+     * Get a specific claim set by ID.
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to a claim set object
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
      */
-    async function getForCollection(collectionId, claimSetId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(claimSetId)}`;
-        return request(path);
+    async function get(claimSetId, collectionId) {
+        return request(`${base(collectionId)}/${encodeURIComponent(claimSetId)}`);
     }
-    claimSet.getForCollection = getForCollection;
+    claimSet.get = get;
     /**
-     * Get all tags for a claim set.
-     * @param collectionId – The collection identifier
+     * Create a new claim set.
+     * When collectionId is provided, creates it scoped to that collection.
+     * When omitted, creates a global user-owned claim set.
+     * @param params – Claim set creation parameters
+     * @param collectionId – Optional collection identifier
+     */
+    async function create(params, collectionId) {
+        return post(base(collectionId), params);
+    }
+    claimSet.create = create;
+    /**
+     * Update a claim set.
+     * @param claimSetId – The claim set identifier
+     * @param params – Fields to update
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    async function update(claimSetId, params, collectionId) {
+        return put(`${base(collectionId)}/${encodeURIComponent(claimSetId)}`, params);
+    }
+    claimSet.update = update;
+    /**
+     * Delete (soft-delete) a claim set.
+     * @param claimSetId – The claim set identifier
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    async function remove(claimSetId, collectionId) {
+        return del(`${base(collectionId)}/${encodeURIComponent(claimSetId)}`);
+    }
+    claimSet.remove = remove;
+    /**
+     * Get all tags for a claim set (including data).
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to an array of tags
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
      */
-    async function getAllTags(collectionId, claimSetId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(claimSetId)}/tags`;
-        return request(path);
+    async function getAllTags(claimSetId, collectionId) {
+        return request(`${base(collectionId)}/${encodeURIComponent(claimSetId)}/tags`);
     }
     claimSet.getAllTags = getAllTags;
     /**
-     * Get a report for a claim set.
-     * @param collectionId – The collection identifier
+     * Get assigned tags for a claim set — tags soft-assigned to a collection or product.
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to a report object
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
      */
-    async function getReport(collectionId, claimSetId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(claimSetId)}/report`;
-        return request(path);
+    async function getAssignedTags(claimSetId, collectionId) {
+        return request(`${base(collectionId)}/${encodeURIComponent(claimSetId)}/assignedTags`);
     }
-    claimSet.getReport = getReport;
+    claimSet.getAssignedTags = getAssignedTags;
     /**
-     * Get assigned tags for a claim set.
+     * Create a single tag inside a claim set.
+     * @param claimSetId – The claim set identifier
+     * @param data – Tag creation parameters
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    async function createTag(claimSetId, data, collectionId) {
+        return post(`${base(collectionId)}/${encodeURIComponent(claimSetId)}/createTag`, data);
+    }
+    claimSet.createTag = createTag;
+    /**
+     * Bulk import tags into a claim set.
+     * @param claimSetId – The claim set identifier
+     * @param data – Import parameters: tags array and optional mode ("upsert" | "replace")
+     * @param collectionId – Optional collection identifier; omit for user-scoped access
+     */
+    async function importTags(claimSetId, data, collectionId) {
+        return post(`${base(collectionId)}/${encodeURIComponent(claimSetId)}/importTags`, data);
+    }
+    claimSet.importTags = importTags;
+    // ─── Collection-scoped-only operations ──────────────────────────────────────
+    /**
+     * Get a report for a claim set (collection-scoped).
      * @param collectionId – The collection identifier
      * @param claimSetId – The claim set identifier
-     * @returns Promise resolving to assigned tags
      */
-    async function getAssignedTags(collectionId, claimSetId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(claimSetId)}/assignedTags`;
-        return request(path);
+    async function getReport(collectionId, claimSetId) {
+        return request(`${base(collectionId)}/${encodeURIComponent(claimSetId)}/report`);
     }
-    claimSet.getAssignedTags = getAssignedTags;
+    claimSet.getReport = getReport;
     /**
      * Get tag summary for a collection.
      * @param collectionId – The collection identifier
-     * @returns Promise resolving to tag summary
      */
     async function getTagSummary(collectionId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/tagSummary`;
-        return request(path);
+        return request(`${base(collectionId)}/tagSummary`);
     }
     claimSet.getTagSummary = getTagSummary;
     /**
      * Perform a tag query for a collection.
      * @param collectionId – The collection identifier
      * @param data – The query data
-     * @returns Promise resolving to query results
      */
     async function tagQuery(collectionId, data) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/tagQuery`;
-        return post(path, data);
+        return post(`${base(collectionId)}/tagQuery`, data);
     }
     claimSet.tagQuery = tagQuery;
     /**
-     * Create a new claim set for a collection.
-     * @param collectionId – The collection identifier
-     * @param params – The claim set creation parameters
-     * @returns Promise resolving to the created claim set
-     */
-    async function createForCollection(collectionId, params) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet`;
-        return post(path, params);
-    }
-    claimSet.createForCollection = createForCollection;
-    /**
-     * Update a claim set for a collection.
-     * @param collectionId – The collection identifier
-     * @param params – The claim set update parameters (must include id)
-     * @returns Promise resolving to the updated claim set
-     */
-    async function updateForCollection(collectionId, params) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(params.id)}`;
-        return put(path, params);
-    }
-    claimSet.updateForCollection = updateForCollection;
-    /**
-     * Make a claim for a claim set.
+     * Make a claim against a claim set (collection-scoped).
      * @param collectionId – The collection identifier
-     * @param params – The claim parameters (must include id)
-     * @returns Promise resolving to the claim result
+     * @param params – Claim parameters (must include id)
      */
     async function makeClaim(collectionId, params) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(params.id)}/makeClaim`;
-        return post(path, params);
+        return post(`${base(collectionId)}/${encodeURIComponent(params.id)}/makeClaim`, params);
     }
     claimSet.makeClaim = makeClaim;
     /**
-     * Assign claims to a claim set.
+     * Assign claims to codes or ranges within a collection.
      * @param collectionId – The collection identifier
-     * @param data – The claims data to assign
-     *  {
-     *    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
-     *  }
+     * @param data – Claims assignment data
      */
     async function assignClaims(collectionId, data) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(data.id)}/assignClaims`;
-        return post(path, data);
+        return post(`${base(collectionId)}/${encodeURIComponent(data.id)}/assignClaims`, data);
     }
     claimSet.assignClaims = assignClaims;
     /**
-     * Update claim data for a collection.
+     * Update claim data for a claim set (collection-scoped).
      * @param collectionId – The collection identifier
-     * @param data – The claim data to update
+     * @param data – Claim data to update
      */
     async function updateClaimData(collectionId, data) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/updateClaimData`;
-        return post(path, data);
+        return post(`${base(collectionId)}/updateClaimData`, data);
     }
     claimSet.updateClaimData = updateClaimData;
-    /**
-     * Create a single tag/code inside an existing claim set (collection admin).
-     * POST /admin/collection/:collectionId/claimSet/:claimSetId/createTag
-     * @param collectionId – The collection identifier
-     * @param claimSetId – The claim set identifier
-     * @param data – Tag creation parameters
-     * @returns Promise resolving to the created tag
-     */
-    async function createTag(collectionId, claimSetId, data) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(claimSetId)}/createTag`;
-        return post(path, data);
-    }
-    claimSet.createTag = createTag;
-    /**
-     * Create a single tag/code inside an existing claim set (platform; requires account.features.adminClaimSets).
-     * POST /platform/claimSet/:claimSetId/createTag
-     * @param claimSetId – The claim set identifier
-     * @param data – Tag creation parameters
-     * @returns Promise resolving to the created tag
-     */
-    async function createTagPlatform(claimSetId, data) {
-        const path = `/platform/claimSet/${encodeURIComponent(claimSetId)}/createTag`;
-        return post(path, data);
-    }
-    claimSet.createTagPlatform = createTagPlatform;
 })(claimSet || (claimSet = {}));

package/dist/api/config.d.ts

@@ -0,0 +1,19 @@
+import type { FieldDefinition, ProofTypeDefinition } from "../types/config";
+export declare namespace config {
+    /**
+     * 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`
+     */
+    function getFields(): Promise<FieldDefinition[]>;
+    /**
+     * 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`
+     */
+    function getProofTypes(): Promise<ProofTypeDefinition[]>;
+}

package/dist/api/config.js

@@ -0,0 +1,27 @@
+// src/api/config.ts
+import { request } from "../http";
+export var config;
+(function (config) {
+    /**
+     * 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`
+     */
+    async function getFields() {
+        return request("/public/config/fields");
+    }
+    config.getFields = getFields;
+    /**
+     * 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`
+     */
+    async function getProofTypes() {
+        return request("/public/config/proofTypes");
+    }
+    config.getProofTypes = getProofTypes;
+})(config || (config = {}));

package/dist/api/index.d.ts

@@ -36,3 +36,4 @@ export { attestations } from "./attestations";
 export { containers } from "./containers";
 export { loyalty } from "./loyalty";
 export { translations } from "./translations";
+export { config } from "./config";

package/dist/api/index.js

@@ -39,3 +39,4 @@ export { attestations } from "./attestations";
 export { containers } from "./containers";
 export { loyalty } from "./loyalty";
 export { translations } from "./translations";
+export { config } from "./config";