@proveanything/smartlinks 1.0.29 → 1.0.31

package/dist/api/appRecord.d.ts

@@ -0,0 +1,6 @@
+export declare namespace appRecord {
+    function get(collectionId: string, appId: string): Promise<any>;
+    function create(collectionId: string, appId: string, data: any): Promise<any>;
+    function update(collectionId: string, appId: string, data: any): Promise<any>;
+    function remove(collectionId: string, appId: string): Promise<void>;
+}

package/dist/api/appRecord.js

@@ -0,0 +1,29 @@
+// src/api/appRecord.ts
+import { request, post, put, del } from "../http";
+export var appRecord;
+(function (appRecord) {
+    // Get app record (admin only)
+    async function get(collectionId, appId) {
+        const path = `/api/v1/admin/collection/${encodeURIComponent(collectionId)}/app/${encodeURIComponent(appId)}`;
+        return request(path);
+    }
+    appRecord.get = get;
+    // Create app record (admin only)
+    async function create(collectionId, appId, data) {
+        const path = `/api/v1/admin/collection/${encodeURIComponent(collectionId)}/app/${encodeURIComponent(appId)}`;
+        return post(path, data);
+    }
+    appRecord.create = create;
+    // Update app record (admin only)
+    async function update(collectionId, appId, data) {
+        const path = `/api/v1/admin/collection/${encodeURIComponent(collectionId)}/app/${encodeURIComponent(appId)}`;
+        return put(path, data);
+    }
+    appRecord.update = update;
+    // Delete app record (admin only)
+    async function remove(collectionId, appId) {
+        const path = `/api/v1/admin/collection/${encodeURIComponent(collectionId)}/app/${encodeURIComponent(appId)}`;
+        return del(path);
+    }
+    appRecord.remove = remove;
+})(appRecord || (appRecord = {}));

package/dist/api/auth.d.ts

@@ -13,6 +13,8 @@ export type VerifyTokenResponse = {
     account?: Record<string, any>;
 };
 export type AccountInfoResponse = {
+    jwtToken: string;
+    jwtExpiry: number;
     accessType: string;
     analyticsCode: string;
     analyticsId: string;
@@ -60,6 +62,16 @@ export declare namespace auth {
      * Returns user/account info if valid.
      */
     function verifyToken(token?: string): Promise<VerifyTokenResponse>;
+    /**
+     * Requests an admin JWT for the current user and a specific collection
+     * Returns JWT if valid.
+     */
+    function requestAdminJWT(collectionId: string): Promise<VerifyTokenResponse>;
+    /**
+     * Requests a JWT for the current user and a specific collection/product/proof
+     * Validates if the user has access to the resource, and returns a JWT
+     */
+    function requestPublicJWT(collectionId: string, productId: string, proofId: string): Promise<VerifyTokenResponse>;
     /**
      * Gets current account information for the logged in user.
      * Returns user, owner, account, and location objects.

package/dist/api/auth.js

@@ -42,6 +42,24 @@ export var auth;
         return result;
     }
     auth.verifyToken = verifyToken;
+    /**
+     * Requests an admin JWT for the current user and a specific collection
+     * Returns JWT if valid.
+     */
+    async function requestAdminJWT(collectionId) {
+        // Use the provided token, or the one from getApiHeaders
+        return post("/admin/auth/requestJWT", { collectionId });
+    }
+    auth.requestAdminJWT = requestAdminJWT;
+    /**
+     * Requests a JWT for the current user and a specific collection/product/proof
+     * Validates if the user has access to the resource, and returns a JWT
+     */
+    async function requestPublicJWT(collectionId, productId, proofId) {
+        // Use the provided token, or the one from getApiHeaders
+        return post("/public/auth/requestJWT", { collectionId, productId, proofId });
+    }
+    auth.requestPublicJWT = requestPublicJWT;
     /**
      * Gets current account information for the logged in user.
      * Returns user, owner, account, and location objects.

package/dist/api/index.d.ts

@@ -2,6 +2,7 @@ export { collection } from "./collection";
 export { product } from "./product";
 export { proof } from "./proof";
 export { appConfiguration } from "./appConfiguration";
+export { appRecord } from "./appRecord";
 export { asset } from "./asset";
 export { attestation } from "./attestation";
 export { auth } from "./auth";

package/dist/api/index.js

@@ -4,6 +4,7 @@ export { collection } from "./collection";
 export { product } from "./product";
 export { proof } from "./proof";
 export { appConfiguration } from "./appConfiguration";
+export { appRecord } from "./appRecord";
 export { asset } from "./asset";
 export { attestation } from "./attestation";
 export { auth } from "./auth";

package/dist/http.d.ts

@@ -54,9 +54,11 @@ export declare function del<T>(path: string, extraHeaders?: Record<string, strin
  */
 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
+ * Sends a custom proxy message to the parent Smartlinks application when running in an iframe.
+ * This function is used to communicate with the parent window when the SDK is embedded in an iframe
+ * and proxyMode is enabled. It sends a message to the parent and waits for a response.
+ * @param request - The request type string to identify the message type
+ * @param params - The parameters object containing data to send to the parent
  * @returns The data from the proxy response
  */
 export declare function sendCustomProxyMessage<T = any>(request: string, params: any): Promise<T>;

package/dist/http.js

@@ -279,9 +279,11 @@ export function getApiHeaders() {
     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
+ * Sends a custom proxy message to the parent Smartlinks application when running in an iframe.
+ * This function is used to communicate with the parent window when the SDK is embedded in an iframe
+ * and proxyMode is enabled. It sends a message to the parent and waits for a response.
+ * @param request - The request type string to identify the message type
+ * @param params - The parameters object containing data to send to the parent
  * @returns The data from the proxy response
  */
 export async function sendCustomProxyMessage(request, params) {

package/package.json

@@ -1,15 +1,30 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.0.29",
+  "version": "1.0.31",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "README.md",
+    "API_SUMMARY.md"
+  ],
   "scripts": {
     "build": "tsc",
     "docs": "typedoc",
     "docs:summary": "node generate-api-summary.js",
-    "build:docs": "tsc build-docs.ts --outDir dist && node dist/build-docs.js"
+    "build:docs": "tsc build-docs.ts --outDir dist && node dist/build-docs.js",
+    "prepublishOnly": "npm run build && npm run docs:summary"
   },
+  "keywords": [
+    "smartlinks",
+    "api",
+    "authentication", 
+    "traceability",
+    "blockchain",
+    "typescript",
+    "sdk"
+  ],
   "author": "Glenn Shoosmith",
   "license": "MIT",
   "publishConfig": {
@@ -27,5 +42,6 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/Prove-Anything/smartlinks.git"
-  }
+  },
+  "homepage": "https://smartlinks.app"
 }

package/build-docs.ts

@@ -1,69 +0,0 @@
-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/debug.log

@@ -1,6 +0,0 @@
-[0602/081836.172:ERROR:registration_protocol_win.cc(108)] CreateFile: The system cannot find the file specified. (0x2)
-[0602/081836.202:ERROR:registration_protocol_win.cc(108)] CreateFile: The system cannot find the file specified. (0x2)
-[0602/081836.512:ERROR:registration_protocol_win.cc(108)] CreateFile: The system cannot find the file specified. (0x2)
-[0602/081858.471:ERROR:registration_protocol_win.cc(108)] CreateFile: The system cannot find the file specified. (0x2)
-[0602/081858.497:ERROR:registration_protocol_win.cc(108)] CreateFile: The system cannot find the file specified. (0x2)
-[0602/081858.832:ERROR:registration_protocol_win.cc(108)] CreateFile: The system cannot find the file specified. (0x2)

package/examples/browser-demo.html

@@ -1,43 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8" />
-  <title>Smartlinks SDK Browser Demo</title>
-</head>
-<body>
-  <h1>Smartlinks SDK Browser Demo</h1>
-  <pre id="output"></pre>
-  <script type="module">
-    import { initializeApi } from '../dist/index.js';
-    import { collection } from '../dist/api/collection.js';
-    import { product } from '../dist/api/product.js';
-    import { proof } from '../dist/api/proof.js';
-
-    async function run() {
-      const apiKey = 'YOUR_API_KEY'; // optional
-      const bearerToken = 'YOUR_BEARER_TOKEN'; // optional
-
-      // Initialize global config for API requests
-      initializeApi({
-        baseURL: 'https://smartlinks.app/api/v1',
-        apiKey,
-        bearerToken,
-      });
-
-      try {
-        const collectionData = await collection.get('abc123');
-        const productData = await product.get('abc123', 'prod789');
-        const proofData = await proof.get('abc123', 'proof456');
-        document.getElementById('output').textContent = JSON.stringify(
-          { collection: collectionData, product: productData, proof: proofData },
-          null,
-          2
-        );
-      } catch (err) {
-        document.getElementById('output').textContent = 'Error: ' + err.message;
-      }
-    }
-    run();
-  </script>
-</body>
-</html>

package/examples/node-demo.ts

@@ -1,50 +0,0 @@
-import { initializeApi } from "../dist/index";
-import { collection } from "../dist/api/collection";
-import { product } from "../dist/api/product";
-import { proof } from "../dist/api/proof";
-import { batch } from "../dist/api/batch";
-
-async function main() {
-  const apiKey = "YOUR_API_KEY"; // optional
-  const bearerToken = "YOUR_BEARER_TOKEN"; // optional
-
-  initializeApi({
-    baseURL: "https://smartlinks.app/api/v1",
-    apiKey,
-    bearerToken,
-  });
-
-  try {
-    const collectionData = await collection.get("abc123");
-    console.log("Collection:", collectionData);
-
-    const productData = await product.get("abc123", "prod789");
-    console.log("Product Item:", productData);
-
-    const proofData = await proof.get("abc123", "proof456");
-    console.log("Proof:", proofData);
-
-    // Batch API examples
-    // Admin operations (requires admin privileges)
-    const batchList = await batch.list("abc123", "prod789");
-    console.log("Batch List:", batchList);
-
-    const newBatch = await batch.create("abc123", "prod789", {
-      name: "New Batch",
-      description: "Example batch creation",
-      status: "active",
-    });
-    console.log("Created Batch:", newBatch);
-
-    const batchData = await batch.get("abc123", "prod789", newBatch.id);
-    console.log("Batch:", batchData);
-
-    // Public batch endpoint (read-only)
-    const publicBatchData = await batch.getPublic("abc123", "prod789", newBatch.id);
-    console.log("Public Batch:", publicBatchData);
-  } catch (err) {
-    console.error("Error fetching data:", err);
-  }
-}
-
-main();

package/examples/react-demo.tsx

@@ -1,58 +0,0 @@
-import React, { useEffect, useState } from 'react';
-import { initializeApi } from '../dist/index';
-import { collection } from '../dist/api/collection';
-import { product } from '../dist/api/product';
-import { proof } from '../dist/api/proof';
-import type { CollectionResponse } from '../dist/types/collection';
-import type { ProductResponse } from '../dist/types/product';
-import type { ProofResponse } from '../dist/types/proof';
-
-// You can provide either or both of these values:
-const apiKey = 'YOUR_API_KEY'; // optional
-const bearerToken = 'YOUR_BEARER_TOKEN'; // optional
-
-initializeApi({
-  baseURL: 'https://smartlinks.app/api/v1',
-  apiKey,
-  bearerToken,
-});
-
-const ReactDemo: React.FC = () => {
-  const [collectionData, setCollection] = useState<CollectionResponse | null>(null);
-  const [productData, setProduct] = useState<ProductResponse | null>(null);
-  const [proofData, setProof] = useState<ProofResponse | null>(null);
-  const [error, setError] = useState<string | null>(null);
-
-  useEffect(() => {
-    async function fetchData() {
-      try {
-        const col = await collection.get('abc123');
-        const prod = await product.get('abc123', 'prod789');
-        const prf = await proof.get('abc123', 'proof456');
-        setCollection(col);
-        setProduct(prod);
-        setProof(prf);
-      } catch (err) {
-        setError((err as Error).message);
-      }
-    }
-    fetchData();
-  }, []);
-
-  if (error) return <div>Error: {error}</div>;
-  if (!collectionData || !productData || !proofData) return <div>Loading...</div>;
-
-  return (
-    <div>
-      <h1>{collectionData.title}</h1>
-      <img src={collectionData.logoImage} alt={collectionData.title} width="100" />
-      <h2>{productData.name}</h2>
-      <img src={productData.heroImage} alt={productData.name} width="100" />
-      <p>{productData.description}</p>
-      <h3>Proof</h3>
-      <pre>{JSON.stringify(proofData, null, 2)}</pre>
-    </div>
-  );
-};
-
-export default ReactDemo;