@xyo-network/data 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,407 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/data
 
-[![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:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__data)
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+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
+
+      ### core
+
+        ### packages
+
+          ### data
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="AbstractData"></a>AbstractData
+
+[**@xyo-network/data**](#../README)
+
+***
+
+## Extended by
+
+- [`Data`](#Data)
+
+## Implements
+
+- [`DataInstance`](#../interfaces/DataInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+new AbstractData(): AbstractData;
+```
+
+### Returns
+
+`AbstractData`
+
+## Accessors
+
+### length
+
+### Get Signature
+
+```ts
+get length(): number;
+```
+
+#### Returns
+
+`number`
+
+***
+
+### base58
+
+### Get Signature
+
+```ts
+get abstract base58(): string;
+```
+
+#### Returns
+
+`string`
+
+### Implementation of
+
+[`DataInstance`](#../interfaces/DataInstance).[`base58`](../interfaces/DataInstance.md#base58)
+
+***
+
+### bytes
+
+### Get Signature
+
+```ts
+get abstract bytes(): ArrayBufferLike;
+```
+
+#### Returns
+
+`ArrayBufferLike`
+
+### Implementation of
+
+[`DataInstance`](#../interfaces/DataInstance).[`bytes`](../interfaces/DataInstance.md#bytes)
+
+***
+
+### hex
+
+### Get Signature
+
+```ts
+get abstract hex(): BrandedHex;
+```
+
+#### Returns
+
+`BrandedHex`
+
+### Implementation of
+
+[`DataInstance`](#../interfaces/DataInstance).[`hex`](../interfaces/DataInstance.md#hex)
+
+***
+
+### keccak256
+
+### Get Signature
+
+```ts
+get abstract keccak256(): ArrayBufferLike;
+```
+
+#### Returns
+
+`ArrayBufferLike`
+
+### Implementation of
+
+[`DataInstance`](#../interfaces/DataInstance).[`keccak256`](../interfaces/DataInstance.md#keccak256)
+
+## Methods
+
+### is()
+
+```ts
+static is(value): value is AbstractData;
+```
+
+### Parameters
+
+#### value
+
+`unknown`
+
+### Returns
+
+`value is AbstractData`
+
+                ### <a id="Data"></a>Data
+
+[**@xyo-network/data**](#../README)
+
+***
+
+## Extends
+
+- [`AbstractData`](#AbstractData)
+
+## Constructors
+
+### Constructor
+
+```ts
+new Data(
+   length, 
+   bytes?, 
+   base?): Data;
+```
+
+### Parameters
+
+#### length
+
+`number`
+
+#### bytes?
+
+`ArrayBufferLike`
+
+#### base?
+
+`number`
+
+### Returns
+
+`Data`
+
+### Overrides
+
+[`AbstractData`](#AbstractData).[`constructor`](AbstractData.md#constructor)
+
+## Accessors
+
+### length
+
+### Get Signature
+
+```ts
+get length(): number;
+```
+
+#### Returns
+
+`number`
+
+### Inherited from
+
+[`AbstractData`](#AbstractData).[`length`](AbstractData.md#length)
+
+***
+
+### base58
+
+### Get Signature
+
+```ts
+get base58(): string;
+```
+
+#### Returns
+
+`string`
+
+### Overrides
+
+[`AbstractData`](#AbstractData).[`base58`](AbstractData.md#base58)
+
+***
+
+### bytes
+
+### Get Signature
+
+```ts
+get bytes(): ArrayBuffer | SharedArrayBuffer;
+```
+
+#### Returns
+
+`ArrayBuffer` \| `SharedArrayBuffer`
+
+### Overrides
+
+[`AbstractData`](#AbstractData).[`bytes`](AbstractData.md#bytes)
+
+***
+
+### hex
+
+### Get Signature
+
+```ts
+get hex(): BrandedHex;
+```
+
+#### Returns
+
+`BrandedHex`
+
+### Overrides
+
+[`AbstractData`](#AbstractData).[`hex`](AbstractData.md#hex)
+
+***
+
+### keccak256
+
+### Get Signature
+
+```ts
+get keccak256(): ArrayBufferLike;
+```
+
+#### Returns
+
+`ArrayBufferLike`
+
+### Overrides
+
+[`AbstractData`](#AbstractData).[`keccak256`](AbstractData.md#keccak256)
+
+## Methods
+
+### is()
+
+```ts
+static is(value): value is AbstractData;
+```
+
+### Parameters
+
+#### value
+
+`unknown`
+
+### Returns
+
+`value is AbstractData`
+
+### Inherited from
+
+[`AbstractData`](#AbstractData).[`is`](AbstractData.md#is)
+
+***
+
+### from()
+
+```ts
+static from(data): Data | undefined;
+```
+
+### Parameters
+
+#### data
+
+`ArrayBuffer` \| `undefined`
+
+### Returns
+
+`Data` \| `undefined`
+
+              ### interfaces
+
+                ### <a id="DataInstance"></a>DataInstance
+
+[**@xyo-network/data**](#../README)
+
+***
+
+## Properties
+
+### base58
+
+```ts
+base58: string;
+```
+
+***
+
+### bytes
+
+```ts
+bytes: ArrayBufferLike;
+```
+
+***
+
+### hex
+
+```ts
+hex: BrandedHex;
+```
+
+***
+
+### keccak256
 
-## Credits
+```ts
+keccak256: ArrayBufferLike;
+```
 
-[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/data.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/data
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/data.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/data",
-  "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",
@@ -41,12 +41,12 @@
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@scure/base": "~2.0.0",
-    "@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",