@proveanything/smartlinks 1.0.13 → 1.0.16

package/temp-docs/modules.md

@@ -0,0 +1,176 @@
+## Table of contents
+
+### Namespaces
+
+- [appConfiguration](modules/appConfiguration.md)
+- [asset](modules/asset.md)
+- [attestation](modules/attestation.md)
+- [auth](modules/auth.md)
+- [collection](modules/collection.md)
+- [product](modules/product.md)
+- [proof](modules/proof.md)
+
+### Interfaces
+
+- [AppConfigurationResponse](interfaces/AppConfigurationResponse.md)
+- [AssetResponse](interfaces/AssetResponse.md)
+- [AttestationCreateRequest](interfaces/AttestationCreateRequest.md)
+- [AttestationResponse](interfaces/AttestationResponse.md)
+- [AttestationUpdateRequest](interfaces/AttestationUpdateRequest.md)
+- [CollectionResponse](interfaces/CollectionResponse.md)
+- [ErrorResponse](interfaces/ErrorResponse.md)
+- [ProductResponse](interfaces/ProductResponse.md)
+- [ProofResponse](interfaces/ProofResponse.md)
+
+### Type Aliases
+
+- [AccountInfoResponse](modules.md#accountinforesponse)
+- [AppConfigOptions](modules.md#appconfigoptions)
+- [LoginResponse](modules.md#loginresponse)
+- [VerifyTokenResponse](modules.md#verifytokenresponse)
+
+### Functions
+
+- [initializeApi](modules.md#initializeapi)
+- [request](modules.md#request)
+
+## Type Aliases
+
+### AccountInfoResponse
+
+Ƭ **AccountInfoResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `account` | `Record`\<`string`, `any`\> |
+| `location` | `Record`\<`string`, `any`\> |
+| `owner` | `Record`\<`string`, `any`\> |
+| `user` | `Record`\<`string`, `any`\> |
+
+#### Defined in
+
+[api/auth.ts:19](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/auth.ts#L19)
+
+___
+
+### AppConfigOptions
+
+Ƭ **AppConfigOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `admin?` | `boolean` |
+| `appId` | `string` |
+| `batchId?` | `string` |
+| `collectionId?` | `string` |
+| `config?` | `any` |
+| `data?` | `any` |
+| `itemId?` | `string` |
+| `productId?` | `string` |
+| `user?` | `boolean` |
+| `userData?` | `boolean` |
+| `variantId?` | `string` |
+
+#### Defined in
+
+[api/appConfiguration.ts:4](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L4)
+
+___
+
+### LoginResponse
+
+Ƭ **LoginResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `account` | `Record`\<`string`, `any`\> |
+| `bearerToken` | `string` |
+| `email` | `string` |
+| `id` | `string` |
+| `name` | `string` |
+
+#### Defined in
+
+[api/auth.ts:3](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/auth.ts#L3)
+
+___
+
+### VerifyTokenResponse
+
+Ƭ **VerifyTokenResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `account?` | `Record`\<`string`, `any`\> |
+| `email?` | `string` |
+| `id?` | `string` |
+| `name?` | `string` |
+| `valid` | `boolean` |
+
+#### Defined in
+
+[api/auth.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/auth.ts#L11)
+
+## Functions
+
+### initializeApi
+
+▸ **initializeApi**(`options`): `void`
+
+Call this once (e.g. at app startup) to configure baseURL/auth.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | `Object` | Configuration options |
+| `options.apiKey?` | `string` | - |
+| `options.baseURL` | `string` | - |
+| `options.bearerToken?` | `string` | - |
+| `options.proxyMode?` | `boolean` | - |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[http.ts:20](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/http.ts#L20)
+
+___
+
+### request
+
+▸ **request**\<`T`\>(`path`): `Promise`\<`T`\>
+
+Internal helper that performs a GET request to `\${baseURL}\${path}`, 
+injecting headers for apiKey or bearerToken if present. 
+Returns the parsed JSON as T, or throws an Error.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`\<`T`\>
+
+#### Defined in
+
+[http.ts:96](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/http.ts#L96)

package/docs/functions/appConfiguration.get.html

@@ -1,6 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>get | @proveanything/smartlinks</title><meta name="description" content="Documentation for @proveanything/smartlinks"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@proveanything/smartlinks</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@proveanything/smartlinks</a></li><li><a href="../modules/appConfiguration.html">appConfiguration</a></li><li><a href="appConfiguration.get.html">get</a></li></ul><h1>Function get</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="get" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">collectionId</span>, <span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AppConfigurationResponse.html" class="tsd-signature-type tsd-kind-interface">AppConfigurationResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a single App Configuration by Collection ID and App ID.</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>– Identifier of the parent collection</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>– Identifier of the app configuration</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AppConfigurationResponse.html" class="tsd-signature-type tsd-kind-interface">AppConfigurationResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to an AppConfigurationResponse object</p>
-<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ErrorResponse if the request fails</p>
-</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Prove-Anything/smartlinks/blob/0d6eafe653ce3bf1805419336959a85b5439616c/src/api/appConfiguration.ts#L13">api/appConfiguration.ts:13</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@proveanything/smartlinks</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>