@xyo-network/huri 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,310 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/huri
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__huri)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### protocol
+
+    ### packages
+
+      ### payload
+
+        ### packages
+
+          ### huri
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="Huri"></a>Huri
+
+[**@xyo-network/huri**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+## Constructors
+
+### Constructor
+
+```ts
+new Huri<T>(huri, __namedParameters?): Huri<T>;
+```
+
+### Parameters
+
+#### huri
+
+`string` \| `Huri`\<`Payload`\> \| `BrandedHash`
+
+#### \_\_namedParameters?
+
+[`HuriOptions`](#../interfaces/HuriOptions) = `{}`
+
+### Returns
+
+`Huri`\<`T`\>
+
+## Properties
+
+### archive?
+
+```ts
+optional archive?: string;
+```
+
+***
+
+### archivist?
+
+```ts
+optional archivist?: string | BrandedAddress;
+```
+
+***
+
+### hash
+
+```ts
+hash: BrandedHash;
+```
+
+***
+
+### originalHref
+
+```ts
+originalHref: string;
+```
+
+***
+
+### protocol?
+
+```ts
+optional protocol?: string;
+```
+
+***
+
+### token?
+
+```ts
+optional token?: string;
+```
+
+## Accessors
+
+### href
+
+### Get Signature
+
+```ts
+get href(): string;
+```
+
+#### Returns
+
+`string`
+
+## Methods
+
+### fetch()
+
+```ts
+static fetch<T>(huri): Promise<T | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload` = `Payload`
+
+### Parameters
+
+#### huri
+
+`Huri`
+
+### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+***
+
+### isHuri()
+
+```ts
+static isHuri(value): Huri<Payload> | undefined;
+```
+
+### Parameters
+
+#### value
+
+`unknown`
+
+### Returns
+
+`Huri`\<`Payload`\> \| `undefined`
+
+***
+
+### fetch()
+
+```ts
+fetch(): Promise<T | undefined>;
+```
+
+### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+***
+
+### toString()
+
+```ts
+toString(): string;
+```
+
+### Returns
+
+`string`
+
+              ### interfaces
+
+                ### <a id="FetchedPayload"></a>FetchedPayload
+
+[**@xyo-network/huri**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+## Properties
+
+### huri?
+
+```ts
+optional huri?: Huri<Payload>;
+```
+
+***
+
+### payload
+
+```ts
+payload: T;
+```
+
+                ### <a id="HuriOptions"></a>HuriOptions
+
+[**@xyo-network/huri**](#../README)
+
+***
+
+## Properties
+
+### archivistUri?
+
+```ts
+optional archivistUri?: string;
+```
+
+***
+
+### token?
+
+```ts
+optional token?: string;
+```
+
+              ### type-aliases
+
+                ### <a id="HuriFetchFunction"></a>HuriFetchFunction
+
+[**@xyo-network/huri**](#../README)
+
+***
+
+```ts
+type HuriFetchFunction = (huri) => Promise<Payload | undefined>;
+```
+
+## Parameters
+
+### huri
+
+[`Huri`](#../classes/Huri)
+
+## Returns
+
+`Promise`\<`Payload` \| `undefined`\>
+
+                ### <a id="ObjectCategory"></a>ObjectCategory
+
+[**@xyo-network/huri**](#../README)
+
+***
 
-## Credits
+```ts
+type ObjectCategory = "block" | "payload";
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/huri.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/huri
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/huri.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/huri",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,17 +36,17 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/account": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/account": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
+    "@xylabs/vitest-extended": "~5.0.94",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
@@ -56,8 +56,8 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/account": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/account": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",