@proveanything/smartlinks 1.0.14 → 1.0.17

package/build-docs.ts

@@ -0,0 +1,69 @@
+import { execSync } from "child_process"
+import { readdirSync, readFileSync, writeFileSync, existsSync, mkdirSync } from "fs"
+import { join, extname } from "path"
+
+// Run TypeDoc to generate markdown docs in temp-docs
+execSync("npx typedoc --out temp-docs --plugin typedoc-plugin-markdown --entryPoints src/index.ts --excludePrivate --excludeInternal --hideBreadcrumbs --hidePageTitle", { stdio: "inherit" })
+
+const tempDocsDir = join(__dirname, "..", "temp-docs")
+const docsDir = join(__dirname, "..", "docs")
+const outPath = join(docsDir, "README.md")
+
+if (!existsSync(docsDir)) mkdirSync(docsDir)
+
+const files = readdirSync(tempDocsDir)
+  .filter(f => extname(f) === ".md")
+  .sort((a, b) => a === "modules.md" ? -1 : a.localeCompare(b)) // modules.md first
+
+let content = "# Smartlinks SDK Documentation\n\n"
+for (const file of files) {
+  const fileContent = readFileSync(join(tempDocsDir, file), "utf-8")
+  // Remove redundant titles (except for the first file)
+  content += file === "modules.md"
+    ? fileContent + "\n\n"
+    : fileContent.replace(/^# .*\n/, "") + "\n\n"
+}
+
+writeFileSync(outPath, content)
+console.log("Documentation built at docs/README.md")
+
+import * as fs from "fs";
+import * as path from "path";
+
+// Use process.cwd() to ensure relative to project root
+const docsJsonPath = path.join(process.cwd(), "docs", "documentation.json");
+const readmePath = path.join(process.cwd(), "README.md");
+
+function extractFullApiDocs(json: any): string {
+  // This is a minimal implementation. For a full-featured generator,
+  // parse all namespaces, functions, and types from the TypeDoc JSON.
+  // Here, we just dump the JSON for demonstration.
+  // Replace this with a real markdown generator as needed.
+  return [
+    "# @proveanything/smartlinks",
+    "",
+    "This README is auto-generated from the TypeScript API documentation.",
+    "",
+    "## API Reference",
+    "",
+    "```json",
+    JSON.stringify(json, null, 2),
+    "```",
+    "",
+    "_Replace this with a full markdown generator for production use._"
+  ].join("\n");
+}
+
+function main() {
+  console.log("Looking for docs JSON at:", docsJsonPath);
+  
+  if (!fs.existsSync(docsJsonPath)) {
+    throw new Error("documentation.json not found. Run `npm run docs` first.");
+  }
+  const json = JSON.parse(fs.readFileSync(docsJsonPath, "utf-8"));
+  const markdown = extractFullApiDocs(json);
+  fs.writeFileSync(readmePath, markdown, "utf-8");
+  console.log("README.md generated from API documentation.");
+}
+
+main();

package/dist/api/appConfiguration.d.ts

@@ -1,11 +1,22 @@
-import { AppConfigurationResponse } from "../types/appConfiguration";
+export type AppConfigOptions = {
+    appId: string;
+    collectionId?: string;
+    productId?: string;
+    variantId?: string;
+    batchId?: string;
+    itemId?: string;
+    user?: boolean;
+    userData?: boolean;
+    admin?: boolean;
+    config?: any;
+    data?: any;
+};
 export declare namespace appConfiguration {
-    /**
-     * Retrieves a single App Configuration by Collection ID and App ID.
-     * @param collectionId – Identifier of the parent collection
-     * @param appId        – Identifier of the app configuration
-     * @returns Promise resolving to an AppConfigurationResponse object
-     * @throws ErrorResponse if the request fails
-     */
-    function get(collectionId: string, appId: string): Promise<AppConfigurationResponse>;
+    function getConfig(opts: AppConfigOptions): Promise<any>;
+    function setConfig(opts: AppConfigOptions): Promise<any>;
+    function deleteConfig(opts: AppConfigOptions): Promise<void>;
+    function getData(opts: AppConfigOptions): Promise<any[]>;
+    function getDataItem(opts: AppConfigOptions): Promise<any>;
+    function setDataItem(opts: AppConfigOptions): Promise<any>;
+    function deleteDataItem(opts: AppConfigOptions): Promise<void>;
 }

package/dist/api/appConfiguration.js

@@ -1,17 +1,91 @@
 // src/api/appConfiguration.ts
-import { request } from "../http";
+import { request, post, del } from "../http";
+function buildAppPath(opts, type) {
+    if (opts.user) {
+        // /public/auth/app/:appId
+        let path = `/public/auth/app/${encodeURIComponent(opts.appId)}`;
+        if (type === "data")
+            path += "/data";
+        if (type === "dataItem" && opts.itemId)
+            path += `/data/${encodeURIComponent(opts.itemId)}`;
+        return path;
+    }
+    if (opts.userData) {
+        // /public/auth/app/:appId/data or /public/auth/app/:appId/data/:itemId
+        let path = `/public/auth/app/${encodeURIComponent(opts.appId)}/data`;
+        if (type === "dataItem" && opts.itemId)
+            path += `/${encodeURIComponent(opts.itemId)}`;
+        return path;
+    }
+    const base = opts.admin ? "admin" : "public";
+    let path = `/${base}`;
+    if (opts.collectionId) {
+        path += `/collection/${encodeURIComponent(opts.collectionId)}`;
+        if (opts.productId) {
+            path += `/product/${encodeURIComponent(opts.productId)}`;
+            if (opts.variantId) {
+                path += `/variant/${encodeURIComponent(opts.variantId)}`;
+            }
+            else if (opts.batchId) {
+                path += `/batch/${encodeURIComponent(opts.batchId)}`;
+            }
+        }
+    }
+    path += `/app/${encodeURIComponent(opts.appId)}`;
+    if (type === "data" || type === "dataItem") {
+        path += "/data";
+        if (type === "dataItem" && opts.itemId) {
+            path += `/${encodeURIComponent(opts.itemId)}`;
+        }
+    }
+    return path;
+}
 export var appConfiguration;
 (function (appConfiguration) {
-    /**
-     * Retrieves a single App Configuration by Collection ID and App ID.
-     * @param collectionId – Identifier of the parent collection
-     * @param appId        – Identifier of the app configuration
-     * @returns Promise resolving to an AppConfigurationResponse object
-     * @throws ErrorResponse if the request fails
-     */
-    async function get(collectionId, appId) {
-        const path = `/public/collection/${encodeURIComponent(collectionId)}/app/${encodeURIComponent(appId)}`;
+    // Get config (app, collection, product, variant, batch, user)
+    async function getConfig(opts) {
+        const path = buildAppPath(opts, "config");
+        return request(path);
+    }
+    appConfiguration.getConfig = getConfig;
+    // Set config (app, collection, product, variant, batch, user)
+    async function setConfig(opts) {
+        const path = buildAppPath(opts, "config");
+        return post(path, opts.config);
+    }
+    appConfiguration.setConfig = setConfig;
+    // Delete config (user only)
+    async function deleteConfig(opts) {
+        const path = buildAppPath(opts, "config");
+        return del(path);
+    }
+    appConfiguration.deleteConfig = deleteConfig;
+    // Get all data items (app, collection, product, variant, batch, userData)
+    async function getData(opts) {
+        const path = buildAppPath(opts, "data");
+        return request(path);
+    }
+    appConfiguration.getData = getData;
+    // Get a single data item (app, collection, product, variant, batch, userData)
+    async function getDataItem(opts) {
+        if (!opts.itemId)
+            throw new Error("itemId is required for getDataItem");
+        const path = buildAppPath(opts, "dataItem");
         return request(path);
     }
-    appConfiguration.get = get;
+    appConfiguration.getDataItem = getDataItem;
+    // Set a data item (app, collection, product, variant, batch, userData)
+    async function setDataItem(opts) {
+        const path = buildAppPath(opts, "data");
+        return post(path, opts.data);
+    }
+    appConfiguration.setDataItem = setDataItem;
+    // Delete a data item (app, collection, product, variant, batch, userData)
+    async function deleteDataItem(opts) {
+        if (!opts.itemId)
+            throw new Error("itemId is required for deleteDataItem");
+        const path = buildAppPath(opts, "dataItem");
+        return del(path);
+    }
+    appConfiguration.deleteDataItem = deleteDataItem;
 })(appConfiguration || (appConfiguration = {}));

package/dist/api/auth.d.ts

@@ -1,18 +1,18 @@
-type LoginResponse = {
+export type LoginResponse = {
     id: string;
     name: string;
     email: string;
     bearerToken: string;
     account: Record<string, any>;
 };
-type VerifyTokenResponse = {
+export type VerifyTokenResponse = {
     valid: boolean;
     id?: string;
     name?: string;
     email?: string;
     account?: Record<string, any>;
 };
-type AccountInfoResponse = {
+export type AccountInfoResponse = {
     user: Record<string, any>;
     owner: Record<string, any>;
     account: Record<string, any>;
@@ -39,4 +39,3 @@ export declare namespace auth {
      */
     function getAccount(): Promise<AccountInfoResponse>;
 }
-export {};

package/dist/api/claimSet.d.ts

@@ -0,0 +1,14 @@
+export declare namespace claimSet {
+    /**
+     * Assign claims to a claim set.
+     * @param collectionId – The collection identifier
+     * @param data – The claims data to assign
+     */
+    function assignClaims(collectionId: string, data: any): Promise<any>;
+    /**
+     * Update claim data for a collection.
+     * @param collectionId – The collection identifier
+     * @param data – The claim data to update
+     */
+    function updateClaimData(collectionId: string, data: any): Promise<any>;
+}

package/dist/api/claimSet.js

@@ -0,0 +1,24 @@
+import { post } from "../http";
+export var claimSet;
+(function (claimSet) {
+    /**
+     * Assign claims to a claim set.
+     * @param collectionId – The collection identifier
+     * @param data – The claims data to assign
+     */
+    async function assignClaims(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(data.id)}/assignClaims`;
+        return post(path, data);
+    }
+    claimSet.assignClaims = assignClaims;
+    /**
+     * Update claim data for a collection.
+     * @param collectionId – The collection identifier
+     * @param data – The claim data to update
+     */
+    async function updateClaimData(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/updateClaimData`;
+        return post(path, data);
+    }
+    claimSet.updateClaimData = updateClaimData;
+})(claimSet || (claimSet = {}));

package/dist/api/collection.d.ts

@@ -3,8 +3,16 @@ export declare namespace collection {
     /**
      * Retrieves a single Collection by its ID.
      * @param collectionId – Identifier of the collection
+     * @param admin – If true, fetches from the admin endpoint
      * @returns Promise resolving to a CollectionResponse object
      * @throws ErrorResponse if the request fails
      */
-    function get(collectionId: string): Promise<CollectionResponse>;
+    function get(collectionId: string, admin?: boolean): Promise<CollectionResponse>;
+    /**
+     * Retrieves all Collections.
+     * @param admin – If true, fetches from the admin endpoint
+     * @returns Promise resolving to an array of CollectionResponse objects
+     * @throws ErrorResponse if the request fails
+     */
+    function list(admin?: boolean): Promise<CollectionResponse[]>;
 }

package/dist/api/collection.js

@@ -5,12 +5,26 @@ export var collection;
     /**
      * Retrieves a single Collection by its ID.
      * @param collectionId – Identifier of the collection
+     * @param admin – If true, fetches from the admin endpoint
      * @returns Promise resolving to a CollectionResponse object
      * @throws ErrorResponse if the request fails
      */
-    async function get(collectionId) {
-        const path = `/public/collection/${encodeURIComponent(collectionId)}`;
+    async function get(collectionId, admin) {
+        const base = admin ? '/admin/collection' : '/public/collection';
+        const path = `${base}/${encodeURIComponent(collectionId)}`;
         return request(path);
     }
     collection.get = get;
+    /**
+     * Retrieves all Collections.
+     * @param admin – If true, fetches from the admin endpoint
+     * @returns Promise resolving to an array of CollectionResponse objects
+     * @throws ErrorResponse if the request fails
+     */
+    async function list(admin) {
+        const base = admin ? '/admin/collection' : '/public/collection';
+        const path = `${base}`;
+        return request(path);
+    }
+    collection.list = list;
 })(collection || (collection = {}));

package/dist/api/form.d.ts

@@ -0,0 +1,34 @@
+export declare namespace form {
+    /**
+     * Get a single form by ID for a collection.
+     * @param collectionId – The collection identifier
+     * @param formId – The form identifier
+     * @param admin – If true, use admin endpoint; otherwise, use public
+     */
+    function get(collectionId: string, formId: string, admin?: boolean): Promise<any>;
+    /**
+     * List all forms for a collection.
+     * @param collectionId – The collection identifier
+     * @param admin – If true, use admin endpoint; otherwise, use public
+     */
+    function list(collectionId: string, admin?: boolean): Promise<any[]>;
+    /**
+     * Create a new form for a collection (admin only).
+     * @param collectionId – The collection identifier
+     * @param data – The form data
+     */
+    function create(collectionId: string, data: any): Promise<any>;
+    /**
+     * Update a form for a collection (admin only).
+     * @param collectionId – The collection identifier
+     * @param formId – The form identifier
+     * @param data – The form data
+     */
+    function update(collectionId: string, formId: string, data: any): Promise<any>;
+    /**
+     * Delete a form for a collection (admin only).
+     * @param collectionId – The collection identifier
+     * @param formId – The form identifier
+     */
+    function remove(collectionId: string, formId: string): Promise<void>;
+}

package/dist/api/form.js

@@ -0,0 +1,58 @@
+import { request, post, put, del } from "../http";
+export var form;
+(function (form) {
+    /**
+     * Get a single form by ID for a collection.
+     * @param collectionId – The collection identifier
+     * @param formId – The form identifier
+     * @param admin – If true, use admin endpoint; otherwise, use public
+     */
+    async function get(collectionId, formId, admin) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/${encodeURIComponent(collectionId)}/form/${encodeURIComponent(formId)}`;
+        return request(path);
+    }
+    form.get = get;
+    /**
+     * List all forms for a collection.
+     * @param collectionId – The collection identifier
+     * @param admin – If true, use admin endpoint; otherwise, use public
+     */
+    async function list(collectionId, admin) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/${encodeURIComponent(collectionId)}/form`;
+        return request(path);
+    }
+    form.list = list;
+    /**
+     * Create a new form for a collection (admin only).
+     * @param collectionId – The collection identifier
+     * @param data – The form data
+     */
+    async function create(collectionId, data) {
+        const path = `/admin/${encodeURIComponent(collectionId)}/form`;
+        return post(path, data);
+    }
+    form.create = create;
+    /**
+     * Update a form for a collection (admin only).
+     * @param collectionId – The collection identifier
+     * @param formId – The form identifier
+     * @param data – The form data
+     */
+    async function update(collectionId, formId, data) {
+        const path = `/admin/${encodeURIComponent(collectionId)}/form/${encodeURIComponent(formId)}`;
+        return put(path, data);
+    }
+    form.update = update;
+    /**
+     * Delete a form for a collection (admin only).
+     * @param collectionId – The collection identifier
+     * @param formId – The form identifier
+     */
+    async function remove(collectionId, formId) {
+        const path = `/admin/${encodeURIComponent(collectionId)}/form/${encodeURIComponent(formId)}`;
+        return del(path);
+    }
+    form.remove = remove;
+})(form || (form = {}));

package/dist/api/index.d.ts

@@ -5,3 +5,5 @@ export { appConfiguration } from "./appConfiguration";
 export { asset } from "./asset";
 export { attestation } from "./attestation";
 export { auth } from "./auth";
+export { form } from "./form";
+export { claimSet } from "./claimSet";

package/dist/api/index.js

@@ -7,3 +7,5 @@ export { appConfiguration } from "./appConfiguration";
 export { asset } from "./asset";
 export { attestation } from "./attestation";
 export { auth } from "./auth";
+export { form } from "./form";
+export { claimSet } from "./claimSet";

package/dist/build-docs.js

@@ -0,0 +1,61 @@
+"use strict";
+exports.__esModule = true;
+var child_process_1 = require("child_process");
+var fs_1 = require("fs");
+var path_1 = require("path");
+// Run TypeDoc to generate markdown docs in temp-docs
+(0, child_process_1.execSync)("npx typedoc --out temp-docs --plugin typedoc-plugin-markdown --entryPoints src/index.ts --excludePrivate --excludeInternal --hideBreadcrumbs --hidePageTitle", { stdio: "inherit" });
+var tempDocsDir = (0, path_1.join)(__dirname, "..", "temp-docs");
+var docsDir = (0, path_1.join)(__dirname, "..", "docs");
+var outPath = (0, path_1.join)(docsDir, "README.md");
+if (!(0, fs_1.existsSync)(docsDir))
+    (0, fs_1.mkdirSync)(docsDir);
+var files = (0, fs_1.readdirSync)(tempDocsDir)
+    .filter(function (f) { return (0, path_1.extname)(f) === ".md"; })
+    .sort(function (a, b) { return a === "modules.md" ? -1 : a.localeCompare(b); }); // modules.md first
+var content = "# Smartlinks SDK Documentation\n\n";
+for (var _i = 0, files_1 = files; _i < files_1.length; _i++) {
+    var file = files_1[_i];
+    var fileContent = (0, fs_1.readFileSync)((0, path_1.join)(tempDocsDir, file), "utf-8");
+    // Remove redundant titles (except for the first file)
+    content += file === "modules.md"
+        ? fileContent + "\n\n"
+        : fileContent.replace(/^# .*\n/, "") + "\n\n";
+}
+(0, fs_1.writeFileSync)(outPath, content);
+console.log("Documentation built at docs/README.md");
+var fs = require("fs");
+var path = require("path");
+// Use process.cwd() to ensure relative to project root
+var docsJsonPath = path.join(process.cwd(), "docs", "documentation.json");
+var readmePath = path.join(process.cwd(), "README.md");
+function extractFullApiDocs(json) {
+    // This is a minimal implementation. For a full-featured generator,
+    // parse all namespaces, functions, and types from the TypeDoc JSON.
+    // Here, we just dump the JSON for demonstration.
+    // Replace this with a real markdown generator as needed.
+    return [
+        "# @proveanything/smartlinks",
+        "",
+        "This README is auto-generated from the TypeScript API documentation.",
+        "",
+        "## API Reference",
+        "",
+        "```json",
+        JSON.stringify(json, null, 2),
+        "```",
+        "",
+        "_Replace this with a full markdown generator for production use._"
+    ].join("\n");
+}
+function main() {
+    console.log("Looking for docs JSON at:", docsJsonPath);
+    if (!fs.existsSync(docsJsonPath)) {
+        throw new Error("documentation.json not found. Run `npm run docs` first.");
+    }
+    var json = JSON.parse(fs.readFileSync(docsJsonPath, "utf-8"));
+    var markdown = extractFullApiDocs(json);
+    fs.writeFileSync(readmePath, markdown, "utf-8");
+    console.log("README.md generated from API documentation.");
+}
+main();

package/dist/http.d.ts

@@ -1,9 +1,11 @@
 /**
  * Call this once (e.g. at app startup) to configure baseURL/auth.
  *
- * @param options.baseURL - The root URL of the Smartlinks API (e.g. "https://smartlinks.app/api/v1")
- * @param options.apiKey - (Optional) API key for X-API-Key header
- * @param options.bearerToken - (Optional) Bearer token for AUTHORIZATION header
+ * @param options - Configuration options
+ * @property {string} options.baseURL - The root URL of the Smartlinks API (e.g. "https://smartlinks.app/api/v1")
+ * @property {string} [options.apiKey] - (Optional) API key for X-API-Key header
+ * @property {string} [options.bearerToken] - (Optional) Bearer token for AUTHORIZATION header
+ * @property {boolean} [options.proxyMode] - (Optional) Tells the API that it is running in an iframe via parent proxy
  */
 export declare function initializeApi(options: {
     baseURL: string;
@@ -51,3 +53,10 @@ export declare function del<T>(path: string, extraHeaders?: Record<string, strin
  * Returns the common headers used for API requests, including apiKey and bearerToken if set.
  */
 export declare function getApiHeaders(): Record<string, string>;
+/**
+ * Sends a custom proxy message in proxyMode and waits for a matching reply.
+ * @param request - The request type string
+ * @param params - The parameters object
+ * @returns The data from the proxy response
+ */
+export declare function sendCustomProxyMessage<T = any>(request: string, params: any): Promise<T>;

package/dist/http.js

@@ -9,9 +9,11 @@ let proxyMode = false;
 /**
  * Call this once (e.g. at app startup) to configure baseURL/auth.
  *
- * @param options.baseURL - The root URL of the Smartlinks API (e.g. "https://smartlinks.app/api/v1")
- * @param options.apiKey - (Optional) API key for X-API-Key header
- * @param options.bearerToken - (Optional) Bearer token for AUTHORIZATION header
+ * @param options - Configuration options
+ * @property {string} options.baseURL - The root URL of the Smartlinks API (e.g. "https://smartlinks.app/api/v1")
+ * @property {string} [options.apiKey] - (Optional) API key for X-API-Key header
+ * @property {string} [options.bearerToken] - (Optional) Bearer token for AUTHORIZATION header
+ * @property {boolean} [options.proxyMode] - (Optional) Tells the API that it is running in an iframe via parent proxy
  */
 export function initializeApi(options) {
     baseURL = options.baseURL.replace(/\/+\$/, ""); // trim trailing slash
@@ -276,3 +278,27 @@ export function getApiHeaders() {
         headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
     return headers;
 }
+/**
+ * Sends a custom proxy message in proxyMode and waits for a matching reply.
+ * @param request - The request type string
+ * @param params - The parameters object
+ * @returns The data from the proxy response
+ */
+export async function sendCustomProxyMessage(request, params) {
+    if (!proxyMode) {
+        throw new Error("sendCustomProxyMessage can only be used in proxyMode");
+    }
+    ensureProxyListener();
+    const id = generateProxyId();
+    const msg = {
+        _smartlinksCustomProxyRequest: true,
+        id,
+        request,
+        params,
+    };
+    return new Promise((resolve, reject) => {
+        proxyPending[id] = { resolve, reject };
+        window.parent.postMessage(msg, "*");
+        // Optionally: add a timeout here to reject if no response
+    });
+}

package/dist/index.d.ts

@@ -1,3 +1,6 @@
-export { initializeApi, request } from "./http";
+export { initializeApi, request, sendCustomProxyMessage } from "./http";
 export * from "./api";
 export * from "./types";
+export type { LoginResponse, VerifyTokenResponse, AccountInfoResponse, } from "./api/auth";
+export type { AttestationResponse, AttestationCreateRequest, AttestationUpdateRequest, } from "./types/attestation";
+export type { AppConfigOptions } from "./api/appConfiguration";

package/dist/index.js

@@ -1,5 +1,5 @@
 // src/index.ts
 // Top-level entrypoint of the npm package. Re-export initializeApi + all namespaces.
-export { initializeApi, request } from "./http";
+export { initializeApi, request, sendCustomProxyMessage } from "./http";
 export * from "./api";
 export * from "./types";