@proveanything/smartlinks 1.0.13 → 1.0.16

package/temp-docs/README.md

@@ -0,0 +1,101 @@
+# @proveanything/smartlinks
+
+An official JavaScript/TypeScript client SDK for the Smartlinks API. This package provides simple, namespaced functions to fetch Collection, Product, Proof, and App Configuration data in both browser and Node.js environments.
+
+## Installation
+
+```bash
+npm install @proveanything/smartlinks
+# or
+yarn add @proveanything/smartlinks
+```
+
+## Quickstart
+
+```ts
+import {
+  initializeApi,
+  collection,
+  product,
+  proof,
+  appConfiguration,
+} from "@proveanything/smartlinks";
+
+async function main() {
+  // Initialize once (provide base URL and optional API key, bearer token, or proxyMode)
+  initializeApi({
+    baseURL: "https://smartlinks.app/api/v1",
+    apiKey: "YOUR_API_KEY_HERE",       // optional
+    bearerToken: "YOUR_BEARER_TOKEN",  // optional
+    proxyMode: false                   // optional, set true if running in iframe via parent proxy
+  });
+
+  try {
+    // Fetch a collection by ID
+    const coll = await collection.get("abc123");
+    console.log("Collection:", coll);
+
+    // Fetch a product item by collection ID & product ID
+    const prod = await product.get("abc123", "prod789");
+    console.log("Product Item:", prod);
+
+    // Fetch a proof by collection ID & proof ID
+    const prf = await proof.get("abc123", "proof456");
+    console.log("Proof:", prf);
+
+    // Fetch an app configuration by collection ID & app ID
+    const cfg = await appConfiguration.get("abc123", "app789");
+    console.log("App Configuration:", cfg);
+  } catch (err) {
+    console.error("Error fetching data:", err);
+  }
+}
+
+main();
+```
+
+## API Reference
+
+### Initialization
+
+```ts
+initializeApi(options: { baseURL: string; apiKey?: string; bearerToken?: string; proxyMode?: boolean }): void
+```
+
+- **Parameters:**
+  - `baseURL` (`string`, required): The root URL of the Smartlinks API, e.g. `https://smartlinks.app/api/v1`.
+  - `apiKey`  (`string`, optional): Your API key for the `X-API-Key` header.
+  - `bearerToken` (`string`, optional): Your Bearer token for the `Authorization` header.
+  - `proxyMode` (`boolean`, optional): Set to `true` if running in an iframe and using a parent proxy for requests.
+
+All subsequent calls to the API functions will use these settings.
+
+---
+
+### Namespaced Modules
+
+Each namespace provides a `get` method for fetching data:
+
+- **collection.get(collectionId: string): Promise<Collection>**
+- **product.get(collectionId: string, productId: string): Promise<Product>**
+- **proof.get(collectionId: string, proofId: string): Promise<Proof>**
+- **appConfiguration.get(collectionId: string, appId: string): Promise<AppConfiguration>**
+
+All methods return a Promise resolving to the corresponding object, or throw an `Error` on failure.
+
+---
+
+## Changelog
+
+### 1.0.0
+
+- Initial release:
+  - `initializeApi` function to configure baseURL and auth.
+  - Namespaced modules:
+    - `collection.get(collectionId)`
+    - `product.get(collectionId, productId)`
+    - `proof.get(collectionId, proofId)`
+    - `appConfiguration.get(collectionId, appId)`
+  - Full TypeScript typings and JSDoc.
+  - Browser/Node fetch support via `cross-fetch`.
+  - Error handling via thrown `Error` objects.

package/temp-docs/interfaces/AppConfigurationResponse.md

@@ -0,0 +1,45 @@
+Represents an App Configuration object.
+
+## Table of contents
+
+### Properties
+
+- [id](AppConfigurationResponse.md#id)
+- [name](AppConfigurationResponse.md#name)
+- [settings](AppConfigurationResponse.md#settings)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the app configuration
+
+#### Defined in
+
+[types/appConfiguration.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/appConfiguration.ts#L7)
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the app configuration
+
+#### Defined in
+
+[types/appConfiguration.ts:9](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/appConfiguration.ts#L9)
+
+___
+
+### settings
+
+• `Optional` **settings**: `Record`\<`string`, `any`\>
+
+Key-value pairs representing configuration settings
+
+#### Defined in
+
+[types/appConfiguration.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/appConfiguration.ts#L11)

package/temp-docs/interfaces/AssetResponse.md

@@ -0,0 +1,39 @@
+Represents an Asset object.
+
+## Table of contents
+
+### Properties
+
+- [id](AssetResponse.md#id)
+- [name](AssetResponse.md#name)
+- [url](AssetResponse.md#url)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[types/asset.ts:5](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/asset.ts#L5)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[types/asset.ts:6](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/asset.ts#L6)
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+[types/asset.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/asset.ts#L7)

package/temp-docs/interfaces/AttestationCreateRequest.md

@@ -0,0 +1,37 @@
+## Table of contents
+
+### Properties
+
+- [private](AttestationCreateRequest.md#private)
+- [proof](AttestationCreateRequest.md#proof)
+- [public](AttestationCreateRequest.md#public)
+
+## Properties
+
+### private
+
+• **private**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:12](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L12)
+
+___
+
+### proof
+
+• **proof**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:13](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L13)
+
+___
+
+### public
+
+• **public**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L11)

package/temp-docs/interfaces/AttestationResponse.md

@@ -0,0 +1,70 @@
+## Table of contents
+
+### Properties
+
+- [createdAt](AttestationResponse.md#createdat)
+- [id](AttestationResponse.md#id)
+- [private](AttestationResponse.md#private)
+- [proof](AttestationResponse.md#proof)
+- [public](AttestationResponse.md#public)
+- [updatedAt](AttestationResponse.md#updatedat)
+
+## Properties
+
+### createdAt
+
+• **createdAt**: `string`
+
+#### Defined in
+
+[types/attestation.ts:3](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L3)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[types/attestation.ts:2](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L2)
+
+___
+
+### private
+
+• **private**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:6](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L6)
+
+___
+
+### proof
+
+• **proof**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L7)
+
+___
+
+### public
+
+• **public**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:5](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L5)
+
+___
+
+### updatedAt
+
+• **updatedAt**: `string`
+
+#### Defined in
+
+[types/attestation.ts:4](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L4)

package/temp-docs/interfaces/AttestationUpdateRequest.md

@@ -0,0 +1,26 @@
+## Table of contents
+
+### Properties
+
+- [data](AttestationUpdateRequest.md#data)
+- [type](AttestationUpdateRequest.md#type)
+
+## Properties
+
+### data
+
+• `Optional` **data**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[types/attestation.ts:18](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L18)
+
+___
+
+### type
+
+• `Optional` **type**: `string`
+
+#### Defined in
+
+[types/attestation.ts:17](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/attestation.ts#L17)

package/temp-docs/interfaces/CollectionResponse.md

@@ -0,0 +1,58 @@
+Represents a Collection object.
+
+## Table of contents
+
+### Properties
+
+- [id](CollectionResponse.md#id)
+- [logoImage](CollectionResponse.md#logoimage)
+- [name](CollectionResponse.md#name)
+- [title](CollectionResponse.md#title)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the collection
+
+#### Defined in
+
+[types/collection.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/collection.ts#L7)
+
+___
+
+### logoImage
+
+• **logoImage**: `string`
+
+URL to the collection’s logo image
+
+#### Defined in
+
+[types/collection.ts:13](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/collection.ts#L13)
+
+___
+
+### name
+
+• **name**: `string`
+
+Machine-readable name of the collection
+
+#### Defined in
+
+[types/collection.ts:9](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/collection.ts#L9)
+
+___
+
+### title
+
+• **title**: `string`
+
+Human-readable title of the collection
+
+#### Defined in
+
+[types/collection.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/collection.ts#L11)

package/temp-docs/interfaces/ErrorResponse.md

@@ -0,0 +1,32 @@
+Represents a standardized error response.
+
+## Table of contents
+
+### Properties
+
+- [code](ErrorResponse.md#code)
+- [message](ErrorResponse.md#message)
+
+## Properties
+
+### code
+
+• **code**: `number`
+
+Numeric error code
+
+#### Defined in
+
+[types/error.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/error.ts#L7)
+
+___
+
+### message
+
+• **message**: `string`
+
+Human-readable error message
+
+#### Defined in
+
+[types/error.ts:9](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/error.ts#L9)

package/temp-docs/interfaces/ProductResponse.md

@@ -0,0 +1,58 @@
+Represents a Product Item object.
+
+## Table of contents
+
+### Properties
+
+- [description](ProductResponse.md#description)
+- [heroImage](ProductResponse.md#heroimage)
+- [id](ProductResponse.md#id)
+- [name](ProductResponse.md#name)
+
+## Properties
+
+### description
+
+• **description**: `string`
+
+Detailed description of the product
+
+#### Defined in
+
+[types/product.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/product.ts#L11)
+
+___
+
+### heroImage
+
+• **heroImage**: `string`
+
+URL to the product’s hero image
+
+#### Defined in
+
+[types/product.ts:13](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/product.ts#L13)
+
+___
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the product
+
+#### Defined in
+
+[types/product.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/product.ts#L7)
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the product
+
+#### Defined in
+
+[types/product.ts:9](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/product.ts#L9)

package/temp-docs/interfaces/ProofResponse.md

@@ -0,0 +1,97 @@
+Represents a Proof object.
+
+## Table of contents
+
+### Properties
+
+- [collectionId](ProofResponse.md#collectionid)
+- [createdAt](ProofResponse.md#createdat)
+- [id](ProofResponse.md#id)
+- [productId](ProofResponse.md#productid)
+- [tokenId](ProofResponse.md#tokenid)
+- [userId](ProofResponse.md#userid)
+- [values](ProofResponse.md#values)
+
+## Properties
+
+### collectionId
+
+• **collectionId**: `string`
+
+Unique identifier for the collection
+
+#### Defined in
+
+[types/proof.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L7)
+
+___
+
+### createdAt
+
+• **createdAt**: `string`
+
+Creation timestamp
+
+#### Defined in
+
+[types/proof.ts:9](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L9)
+
+___
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the proof
+
+#### Defined in
+
+[types/proof.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L11)
+
+___
+
+### productId
+
+• **productId**: `string`
+
+Unique identifier for the product
+
+#### Defined in
+
+[types/proof.ts:13](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L13)
+
+___
+
+### tokenId
+
+• **tokenId**: `string`
+
+Unique identifier for the token
+
+#### Defined in
+
+[types/proof.ts:15](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L15)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+Unique identifier for the user
+
+#### Defined in
+
+[types/proof.ts:17](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L17)
+
+___
+
+### values
+
+• **values**: `Record`\<`string`, `any`\>
+
+Arbitrary key-value pairs for proof values
+
+#### Defined in
+
+[types/proof.ts:19](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L19)