@proveanything/smartlinks 1.0.14 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7341 -230
- package/build-docs.ts +69 -0
- package/dist/api/appConfiguration.d.ts +20 -9
- package/dist/api/appConfiguration.js +85 -11
- package/dist/api/auth.d.ts +3 -4
- package/dist/api/claimSet.d.ts +14 -0
- package/dist/api/claimSet.js +24 -0
- package/dist/api/collection.d.ts +9 -1
- package/dist/api/collection.js +16 -2
- package/dist/api/form.d.ts +34 -0
- package/dist/api/form.js +58 -0
- package/dist/api/index.d.ts +2 -0
- package/dist/api/index.js +2 -0
- package/dist/build-docs.js +61 -0
- package/dist/http.d.ts +12 -3
- package/dist/http.js +29 -3
- package/dist/index.d.ts +4 -1
- package/dist/index.js +1 -1
- package/docs/README.md +7469 -0
- package/docs/assets/highlight.css +12 -33
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/documentation.json +4719 -1986
- package/docs/functions/appConfiguration.deleteConfig.html +1 -0
- package/docs/functions/appConfiguration.deleteDataItem.html +1 -0
- package/docs/functions/appConfiguration.getConfig.html +1 -0
- package/docs/functions/appConfiguration.getData.html +1 -0
- package/docs/functions/appConfiguration.getDataItem.html +1 -0
- package/docs/functions/appConfiguration.setConfig.html +1 -0
- package/docs/functions/appConfiguration.setDataItem.html +1 -0
- package/docs/functions/asset.getForCollection.html +1 -1
- package/docs/functions/asset.getForProduct.html +1 -1
- package/docs/functions/asset.getForProof.html +1 -1
- package/docs/functions/asset.listForCollection.html +1 -1
- package/docs/functions/asset.listForProduct.html +1 -1
- package/docs/functions/asset.listForProof.html +1 -1
- package/docs/functions/asset.uploadAsset.html +1 -1
- package/docs/functions/attestation.create.html +2 -2
- package/docs/functions/attestation.get.html +2 -2
- package/docs/functions/attestation.list.html +2 -2
- package/docs/functions/attestation.remove.html +1 -1
- package/docs/functions/attestation.update.html +2 -2
- package/docs/functions/auth.getAccount.html +2 -2
- package/docs/functions/auth.login.html +2 -2
- package/docs/functions/auth.logout.html +1 -1
- package/docs/functions/auth.verifyToken.html +2 -2
- package/docs/functions/claimSet.assignClaims.html +4 -0
- package/docs/functions/claimSet.updateClaimData.html +4 -0
- package/docs/functions/collection.get.html +3 -2
- package/docs/functions/collection.list.html +5 -0
- package/docs/functions/form.create.html +4 -0
- package/docs/functions/form.get.html +5 -0
- package/docs/functions/form.list.html +4 -0
- package/docs/functions/form.remove.html +4 -0
- package/docs/functions/form.update.html +5 -0
- package/docs/functions/initializeApi.html +2 -4
- package/docs/functions/product.get.html +1 -1
- package/docs/functions/product.list.html +1 -1
- package/docs/functions/proof.get.html +1 -1
- package/docs/functions/proof.list.html +1 -1
- package/docs/functions/request.html +1 -1
- package/docs/functions/sendCustomProxyMessage.html +5 -0
- package/docs/index.html +4 -112
- package/docs/interfaces/AppConfigurationResponse.html +4 -4
- package/docs/interfaces/AssetResponse.html +2 -2
- package/docs/interfaces/AttestationCreateRequest.html +4 -0
- package/docs/interfaces/AttestationResponse.html +7 -0
- package/docs/interfaces/AttestationUpdateRequest.html +3 -0
- package/docs/interfaces/CollectionResponse.html +5 -5
- package/docs/interfaces/ErrorResponse.html +3 -3
- package/docs/interfaces/ProductResponse.html +5 -5
- package/docs/interfaces/ProofResponse.html +8 -8
- package/docs/modules/appConfiguration.html +7 -1
- package/docs/modules/asset.html +1 -1
- package/docs/modules/attestation.html +1 -1
- package/docs/modules/auth.html +1 -1
- package/docs/modules/claimSet.html +3 -0
- package/docs/modules/collection.html +2 -1
- package/docs/modules/form.html +6 -0
- package/docs/modules/product.html +1 -1
- package/docs/modules/proof.html +1 -1
- package/docs/modules.html +10 -0
- package/docs/types/AccountInfoResponse.html +1 -0
- package/docs/types/AppConfigOptions.html +1 -0
- package/docs/types/LoginResponse.html +1 -0
- package/docs/types/VerifyTokenResponse.html +1 -0
- package/package.json +5 -2
- package/src/api/appConfiguration.ts +99 -17
- package/src/api/auth.ts +3 -3
- package/src/api/claimSet.ts +23 -0
- package/src/api/collection.ts +17 -3
- package/src/api/form.ts +57 -0
- package/src/api/index.ts +2 -0
- package/src/http.ts +32 -5
- package/src/index.ts +14 -1
- package/temp-docs/.nojekyll +1 -0
- package/temp-docs/README.md +7254 -0
- package/temp-docs/interfaces/AppConfigurationResponse.md +45 -0
- package/temp-docs/interfaces/AssetResponse.md +39 -0
- package/temp-docs/interfaces/AttestationCreateRequest.md +37 -0
- package/temp-docs/interfaces/AttestationResponse.md +70 -0
- package/temp-docs/interfaces/AttestationUpdateRequest.md +26 -0
- package/temp-docs/interfaces/CollectionResponse.md +58 -0
- package/temp-docs/interfaces/ErrorResponse.md +32 -0
- package/temp-docs/interfaces/ProductResponse.md +58 -0
- package/temp-docs/interfaces/ProofResponse.md +97 -0
- package/temp-docs/modules/appConfiguration.md +151 -0
- package/temp-docs/modules/asset.md +171 -0
- package/temp-docs/modules/attestation.md +134 -0
- package/temp-docs/modules/auth.md +88 -0
- package/temp-docs/modules/claimSet.md +52 -0
- package/temp-docs/modules/collection.md +63 -0
- package/temp-docs/modules/form.md +126 -0
- package/temp-docs/modules/product.md +63 -0
- package/temp-docs/modules/proof.md +57 -0
- package/temp-docs/modules.md +210 -0
- package/docs/functions/appConfiguration.get.html +0 -6
package/docs/modules.html
CHANGED
|
@@ -2,15 +2,25 @@
|
|
|
2
2
|
<a href="modules/asset.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>asset</span></a>
|
|
3
3
|
<a href="modules/attestation.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>attestation</span></a>
|
|
4
4
|
<a href="modules/auth.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>auth</span></a>
|
|
5
|
+
<a href="modules/claimSet.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>claim<wbr/>Set</span></a>
|
|
5
6
|
<a href="modules/collection.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>collection</span></a>
|
|
7
|
+
<a href="modules/form.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>form</span></a>
|
|
6
8
|
<a href="modules/product.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>product</span></a>
|
|
7
9
|
<a href="modules/proof.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-4"></use></svg><span>proof</span></a>
|
|
8
10
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="interfaces/AppConfigurationResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>App<wbr/>Configuration<wbr/>Response</span></a>
|
|
9
11
|
<a href="interfaces/AssetResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Asset<wbr/>Response</span></a>
|
|
12
|
+
<a href="interfaces/AttestationCreateRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Attestation<wbr/>Create<wbr/>Request</span></a>
|
|
13
|
+
<a href="interfaces/AttestationResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Attestation<wbr/>Response</span></a>
|
|
14
|
+
<a href="interfaces/AttestationUpdateRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Attestation<wbr/>Update<wbr/>Request</span></a>
|
|
10
15
|
<a href="interfaces/CollectionResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Collection<wbr/>Response</span></a>
|
|
11
16
|
<a href="interfaces/ErrorResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Error<wbr/>Response</span></a>
|
|
12
17
|
<a href="interfaces/ProductResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Product<wbr/>Response</span></a>
|
|
13
18
|
<a href="interfaces/ProofResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Proof<wbr/>Response</span></a>
|
|
19
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="types/AccountInfoResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Account<wbr/>Info<wbr/>Response</span></a>
|
|
20
|
+
<a href="types/AppConfigOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>App<wbr/>Config<wbr/>Options</span></a>
|
|
21
|
+
<a href="types/LoginResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Login<wbr/>Response</span></a>
|
|
22
|
+
<a href="types/VerifyTokenResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Verify<wbr/>Token<wbr/>Response</span></a>
|
|
14
23
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="functions/initializeApi.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>initialize<wbr/>Api</span></a>
|
|
15
24
|
<a href="functions/request.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>request</span></a>
|
|
25
|
+
<a href="functions/sendCustomProxyMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>send<wbr/>Custom<wbr/>Proxy<wbr/>Message</span></a>
|
|
16
26
|
</div></section></section></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" class="current"><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>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountInfoResponse | @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="AccountInfoResponse.html">AccountInfoResponse</a></li></ul><h1>Type alias AccountInfoResponse</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Account<wbr/>Info<wbr/>Response</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">location</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">location</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L19">api/auth.ts:19</a></li></ul></aside></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>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AppConfigOptions | @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="AppConfigOptions.html">AppConfigOptions</a></li></ul><h1>Type alias AppConfigOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">App<wbr/>Config<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">admin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">appId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">batchId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">collectionId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">itemId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">productId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">userData</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">variantId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">admin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">batch<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">collection<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">item<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">product<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">user<wbr/>Data</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">variant<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L4">api/appConfiguration.ts:4</a></li></ul></aside></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>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LoginResponse | @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="LoginResponse.html">LoginResponse</a></li></ul><h1>Type alias LoginResponse</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Login<wbr/>Response</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">bearerToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">bearer<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L3">api/auth.ts:3</a></li></ul></aside></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>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VerifyTokenResponse | @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="VerifyTokenResponse.html">VerifyTokenResponse</a></li></ul><h1>Type alias VerifyTokenResponse</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Verify<wbr/>Token<wbr/>Response</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">valid</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">valid</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L11">api/auth.ts:11</a></li></ul></aside></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>
|
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@proveanything/smartlinks",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.17",
|
|
4
4
|
"description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"build": "tsc",
|
|
9
|
-
"docs": "typedoc --out docs src/index.ts --json docs/documentation.json"
|
|
9
|
+
"docs": "typedoc --out docs src/index.ts --json docs/documentation.json",
|
|
10
|
+
"build:docs": "tsc build-docs.ts --outDir dist && node dist/build-docs.js"
|
|
10
11
|
},
|
|
11
12
|
"author": "Glenn Shoosmith",
|
|
12
13
|
"license": "MIT",
|
|
@@ -17,7 +18,9 @@
|
|
|
17
18
|
"cross-fetch": "^3.1.5"
|
|
18
19
|
},
|
|
19
20
|
"devDependencies": {
|
|
21
|
+
"ts-node": "^10.9.1",
|
|
20
22
|
"typedoc": "^0.25.13",
|
|
23
|
+
"typedoc-plugin-markdown": "^3.17.1",
|
|
21
24
|
"typescript": "^4.9.0"
|
|
22
25
|
},
|
|
23
26
|
"repository": {
|
|
@@ -1,22 +1,104 @@
|
|
|
1
1
|
// src/api/appConfiguration.ts
|
|
2
|
-
import { request } from "../http"
|
|
3
|
-
|
|
2
|
+
import { request, post, del } from "../http"
|
|
3
|
+
|
|
4
|
+
export type AppConfigOptions = {
|
|
5
|
+
appId: string
|
|
6
|
+
collectionId?: string
|
|
7
|
+
productId?: string
|
|
8
|
+
variantId?: string
|
|
9
|
+
batchId?: string
|
|
10
|
+
itemId?: string
|
|
11
|
+
user?: boolean
|
|
12
|
+
userData?: boolean
|
|
13
|
+
admin?: boolean
|
|
14
|
+
config?: any
|
|
15
|
+
data?: any
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
function buildAppPath(opts: AppConfigOptions, type: "config" | "data" | "dataItem"): string {
|
|
19
|
+
if (opts.user) {
|
|
20
|
+
// /public/auth/app/:appId
|
|
21
|
+
let path = `/public/auth/app/${encodeURIComponent(opts.appId)}`
|
|
22
|
+
if (type === "data") path += "/data"
|
|
23
|
+
if (type === "dataItem" && opts.itemId) path += `/data/${encodeURIComponent(opts.itemId)}`
|
|
24
|
+
return path
|
|
25
|
+
}
|
|
26
|
+
if (opts.userData) {
|
|
27
|
+
// /public/auth/app/:appId/data or /public/auth/app/:appId/data/:itemId
|
|
28
|
+
let path = `/public/auth/app/${encodeURIComponent(opts.appId)}/data`
|
|
29
|
+
if (type === "dataItem" && opts.itemId) path += `/${encodeURIComponent(opts.itemId)}`
|
|
30
|
+
return path
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
const base = opts.admin ? "admin" : "public"
|
|
34
|
+
let path = `/${base}`
|
|
35
|
+
|
|
36
|
+
if (opts.collectionId) {
|
|
37
|
+
path += `/collection/${encodeURIComponent(opts.collectionId)}`
|
|
38
|
+
if (opts.productId) {
|
|
39
|
+
path += `/product/${encodeURIComponent(opts.productId)}`
|
|
40
|
+
if (opts.variantId) {
|
|
41
|
+
path += `/variant/${encodeURIComponent(opts.variantId)}`
|
|
42
|
+
} else if (opts.batchId) {
|
|
43
|
+
path += `/batch/${encodeURIComponent(opts.batchId)}`
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
path += `/app/${encodeURIComponent(opts.appId)}`
|
|
49
|
+
|
|
50
|
+
if (type === "data" || type === "dataItem") {
|
|
51
|
+
path += "/data"
|
|
52
|
+
if (type === "dataItem" && opts.itemId) {
|
|
53
|
+
path += `/${encodeURIComponent(opts.itemId)}`
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
return path
|
|
58
|
+
}
|
|
4
59
|
|
|
5
60
|
export namespace appConfiguration {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
export async function
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
61
|
+
// Get config (app, collection, product, variant, batch, user)
|
|
62
|
+
export async function getConfig(opts: AppConfigOptions): Promise<any> {
|
|
63
|
+
const path = buildAppPath(opts, "config")
|
|
64
|
+
return request<any>(path)
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
// Set config (app, collection, product, variant, batch, user)
|
|
68
|
+
export async function setConfig(opts: AppConfigOptions): Promise<any> {
|
|
69
|
+
const path = buildAppPath(opts, "config")
|
|
70
|
+
return post<any>(path, opts.config)
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Delete config (user only)
|
|
74
|
+
export async function deleteConfig(opts: AppConfigOptions): Promise<void> {
|
|
75
|
+
const path = buildAppPath(opts, "config")
|
|
76
|
+
return del<void>(path)
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// Get all data items (app, collection, product, variant, batch, userData)
|
|
80
|
+
export async function getData(opts: AppConfigOptions): Promise<any[]> {
|
|
81
|
+
const path = buildAppPath(opts, "data")
|
|
82
|
+
return request<any[]>(path)
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// Get a single data item (app, collection, product, variant, batch, userData)
|
|
86
|
+
export async function getDataItem(opts: AppConfigOptions): Promise<any> {
|
|
87
|
+
if (!opts.itemId) throw new Error("itemId is required for getDataItem")
|
|
88
|
+
const path = buildAppPath(opts, "dataItem")
|
|
89
|
+
return request<any>(path)
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
// Set a data item (app, collection, product, variant, batch, userData)
|
|
93
|
+
export async function setDataItem(opts: AppConfigOptions): Promise<any> {
|
|
94
|
+
const path = buildAppPath(opts, "data")
|
|
95
|
+
return post<any>(path, opts.data)
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// Delete a data item (app, collection, product, variant, batch, userData)
|
|
99
|
+
export async function deleteDataItem(opts: AppConfigOptions): Promise<void> {
|
|
100
|
+
if (!opts.itemId) throw new Error("itemId is required for deleteDataItem")
|
|
101
|
+
const path = buildAppPath(opts, "dataItem")
|
|
102
|
+
return del<void>(path)
|
|
21
103
|
}
|
|
22
104
|
}
|
package/src/api/auth.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { post, request, setBearerToken, getApiHeaders } from "../http"
|
|
2
2
|
|
|
3
|
-
type LoginResponse = {
|
|
3
|
+
export type LoginResponse = {
|
|
4
4
|
id: string
|
|
5
5
|
name: string
|
|
6
6
|
email: string
|
|
@@ -8,7 +8,7 @@ type LoginResponse = {
|
|
|
8
8
|
account: Record<string, any>
|
|
9
9
|
}
|
|
10
10
|
|
|
11
|
-
type VerifyTokenResponse = {
|
|
11
|
+
export type VerifyTokenResponse = {
|
|
12
12
|
valid: boolean
|
|
13
13
|
id?: string
|
|
14
14
|
name?: string
|
|
@@ -16,7 +16,7 @@ type VerifyTokenResponse = {
|
|
|
16
16
|
account?: Record<string, any>
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
-
type AccountInfoResponse = {
|
|
19
|
+
export type AccountInfoResponse = {
|
|
20
20
|
user: Record<string, any>
|
|
21
21
|
owner: Record<string, any>
|
|
22
22
|
account: Record<string, any>
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { post } from "../http";
|
|
2
|
+
|
|
3
|
+
export namespace claimSet {
|
|
4
|
+
/**
|
|
5
|
+
* Assign claims to a claim set.
|
|
6
|
+
* @param collectionId – The collection identifier
|
|
7
|
+
* @param data – The claims data to assign
|
|
8
|
+
*/
|
|
9
|
+
export async function assignClaims(collectionId: string, data: any): Promise<any> {
|
|
10
|
+
const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(data.id)}/assignClaims`;
|
|
11
|
+
return post<any>(path, data);
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Update claim data for a collection.
|
|
16
|
+
* @param collectionId – The collection identifier
|
|
17
|
+
* @param data – The claim data to update
|
|
18
|
+
*/
|
|
19
|
+
export async function updateClaimData(collectionId: string, data: any): Promise<any> {
|
|
20
|
+
const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/updateClaimData`;
|
|
21
|
+
return post<any>(path, data);
|
|
22
|
+
}
|
|
23
|
+
}
|
package/src/api/collection.ts
CHANGED
|
@@ -6,11 +6,25 @@ export namespace collection {
|
|
|
6
6
|
/**
|
|
7
7
|
* Retrieves a single Collection by its ID.
|
|
8
8
|
* @param collectionId – Identifier of the collection
|
|
9
|
+
* @param admin – If true, fetches from the admin endpoint
|
|
9
10
|
* @returns Promise resolving to a CollectionResponse object
|
|
10
11
|
* @throws ErrorResponse if the request fails
|
|
11
12
|
*/
|
|
12
|
-
export async function get(collectionId: string): Promise<CollectionResponse> {
|
|
13
|
-
const
|
|
14
|
-
|
|
13
|
+
export async function get(collectionId: string, admin?: boolean): Promise<CollectionResponse> {
|
|
14
|
+
const base = admin ? '/admin/collection' : '/public/collection';
|
|
15
|
+
const path = `${base}/${encodeURIComponent(collectionId)}`;
|
|
16
|
+
return request<CollectionResponse>(path);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Retrieves all Collections.
|
|
21
|
+
* @param admin – If true, fetches from the admin endpoint
|
|
22
|
+
* @returns Promise resolving to an array of CollectionResponse objects
|
|
23
|
+
* @throws ErrorResponse if the request fails
|
|
24
|
+
*/
|
|
25
|
+
export async function list(admin?: boolean): Promise<CollectionResponse[]> {
|
|
26
|
+
const base = admin ? '/admin/collection' : '/public/collection';
|
|
27
|
+
const path = `${base}`;
|
|
28
|
+
return request<CollectionResponse[]>(path);
|
|
15
29
|
}
|
|
16
30
|
}
|
package/src/api/form.ts
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { request, post, put, del } from "../http";
|
|
2
|
+
|
|
3
|
+
export namespace form {
|
|
4
|
+
/**
|
|
5
|
+
* Get a single form by ID for a collection.
|
|
6
|
+
* @param collectionId – The collection identifier
|
|
7
|
+
* @param formId – The form identifier
|
|
8
|
+
* @param admin – If true, use admin endpoint; otherwise, use public
|
|
9
|
+
*/
|
|
10
|
+
export async function get(collectionId: string, formId: string, admin?: boolean): Promise<any> {
|
|
11
|
+
const base = admin ? '/admin' : '/public';
|
|
12
|
+
const path = `${base}/${encodeURIComponent(collectionId)}/form/${encodeURIComponent(formId)}`;
|
|
13
|
+
return request<any>(path);
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* List all forms for a collection.
|
|
18
|
+
* @param collectionId – The collection identifier
|
|
19
|
+
* @param admin – If true, use admin endpoint; otherwise, use public
|
|
20
|
+
*/
|
|
21
|
+
export async function list(collectionId: string, admin?: boolean): Promise<any[]> {
|
|
22
|
+
const base = admin ? '/admin' : '/public';
|
|
23
|
+
const path = `${base}/${encodeURIComponent(collectionId)}/form`;
|
|
24
|
+
return request<any[]>(path);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Create a new form for a collection (admin only).
|
|
29
|
+
* @param collectionId – The collection identifier
|
|
30
|
+
* @param data – The form data
|
|
31
|
+
*/
|
|
32
|
+
export async function create(collectionId: string, data: any): Promise<any> {
|
|
33
|
+
const path = `/admin/${encodeURIComponent(collectionId)}/form`;
|
|
34
|
+
return post<any>(path, data);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update a form for a collection (admin only).
|
|
39
|
+
* @param collectionId – The collection identifier
|
|
40
|
+
* @param formId – The form identifier
|
|
41
|
+
* @param data – The form data
|
|
42
|
+
*/
|
|
43
|
+
export async function update(collectionId: string, formId: string, data: any): Promise<any> {
|
|
44
|
+
const path = `/admin/${encodeURIComponent(collectionId)}/form/${encodeURIComponent(formId)}`;
|
|
45
|
+
return put<any>(path, data);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Delete a form for a collection (admin only).
|
|
50
|
+
* @param collectionId – The collection identifier
|
|
51
|
+
* @param formId – The form identifier
|
|
52
|
+
*/
|
|
53
|
+
export async function remove(collectionId: string, formId: string): Promise<void> {
|
|
54
|
+
const path = `/admin/${encodeURIComponent(collectionId)}/form/${encodeURIComponent(formId)}`;
|
|
55
|
+
return del<void>(path);
|
|
56
|
+
}
|
|
57
|
+
}
|
package/src/api/index.ts
CHANGED
package/src/http.ts
CHANGED
|
@@ -9,11 +9,13 @@ let bearerToken: string | undefined = undefined
|
|
|
9
9
|
let proxyMode: boolean = false
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
* Call this once (e.g. at app startup) to configure baseURL/auth.
|
|
13
|
-
*
|
|
14
|
-
* @param options
|
|
15
|
-
* @
|
|
16
|
-
* @
|
|
12
|
+
* Call this once (e.g. at app startup) to configure baseURL/auth.
|
|
13
|
+
*
|
|
14
|
+
* @param options - Configuration options
|
|
15
|
+
* @property {string} options.baseURL - The root URL of the Smartlinks API (e.g. "https://smartlinks.app/api/v1")
|
|
16
|
+
* @property {string} [options.apiKey] - (Optional) API key for X-API-Key header
|
|
17
|
+
* @property {string} [options.bearerToken] - (Optional) Bearer token for AUTHORIZATION header
|
|
18
|
+
* @property {boolean} [options.proxyMode] - (Optional) Tells the API that it is running in an iframe via parent proxy
|
|
17
19
|
*/
|
|
18
20
|
export function initializeApi(options: {
|
|
19
21
|
baseURL: string
|
|
@@ -334,3 +336,28 @@ export function getApiHeaders(): Record<string, string> {
|
|
|
334
336
|
if (bearerToken) headers["AUTHORIZATION"] = `Bearer ${bearerToken}`
|
|
335
337
|
return headers
|
|
336
338
|
}
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Sends a custom proxy message in proxyMode and waits for a matching reply.
|
|
342
|
+
* @param request - The request type string
|
|
343
|
+
* @param params - The parameters object
|
|
344
|
+
* @returns The data from the proxy response
|
|
345
|
+
*/
|
|
346
|
+
export async function sendCustomProxyMessage<T = any>(request: string, params: any): Promise<T> {
|
|
347
|
+
if (!proxyMode) {
|
|
348
|
+
throw new Error("sendCustomProxyMessage can only be used in proxyMode");
|
|
349
|
+
}
|
|
350
|
+
ensureProxyListener();
|
|
351
|
+
const id = generateProxyId();
|
|
352
|
+
const msg = {
|
|
353
|
+
_smartlinksCustomProxyRequest: true,
|
|
354
|
+
id,
|
|
355
|
+
request,
|
|
356
|
+
params,
|
|
357
|
+
};
|
|
358
|
+
return new Promise<T>((resolve, reject) => {
|
|
359
|
+
proxyPending[id] = { resolve, reject };
|
|
360
|
+
window.parent.postMessage(msg, "*");
|
|
361
|
+
// Optionally: add a timeout here to reject if no response
|
|
362
|
+
});
|
|
363
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -1,6 +1,19 @@
|
|
|
1
1
|
// src/index.ts
|
|
2
2
|
// Top-level entrypoint of the npm package. Re-export initializeApi + all namespaces.
|
|
3
3
|
|
|
4
|
-
export { initializeApi, request } from "./http"
|
|
4
|
+
export { initializeApi, request, sendCustomProxyMessage } from "./http"
|
|
5
5
|
export * from "./api"
|
|
6
6
|
export * from "./types"
|
|
7
|
+
|
|
8
|
+
// Explicitly re-export types for documentation
|
|
9
|
+
export type {
|
|
10
|
+
LoginResponse,
|
|
11
|
+
VerifyTokenResponse,
|
|
12
|
+
AccountInfoResponse,
|
|
13
|
+
} from "./api/auth"
|
|
14
|
+
export type {
|
|
15
|
+
AttestationResponse,
|
|
16
|
+
AttestationCreateRequest,
|
|
17
|
+
AttestationUpdateRequest,
|
|
18
|
+
} from "./types/attestation"
|
|
19
|
+
export type { AppConfigOptions } from "./api/appConfiguration"
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|