@xyo-network/previous-hash-store 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,478 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/previous-hash-store
 
-[![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}}
+```
 
-Version: 5.0.2
+Using yarn:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+yarn add {{name}}
+```
 
-## Documentation
+Using pnpm:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__previous-hash-store)
+```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
+
+      ### crypto
+
+        ### packages
+
+          ### previous-hash-store
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="IndexedDbPreviousHashStore"></a>IndexedDbPreviousHashStore
+
+[**@xyo-network/previous-hash-store**](#../README)
+
+***
+
+## Implements
+
+- [`PreviousHashStore`](#../interfaces/PreviousHashStore)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IndexedDbPreviousHashStore(): IndexedDbPreviousHashStore;
+```
+
+### Returns
+
+`IndexedDbPreviousHashStore`
+
+## Properties
+
+### CurrentSchemaVersion
+
+```ts
+readonly static CurrentSchemaVersion: 1 = 1;
+```
+
+## Accessors
+
+### dbName
+
+### Get Signature
+
+```ts
+get dbName(): "xyo";
+```
+
+The database name.
+
+#### Returns
+
+`"xyo"`
+
+***
+
+### storeName
+
+### Get Signature
+
+```ts
+get storeName(): "previous-hash";
+```
+
+The name of the object store.
+
+#### Returns
+
+`"previous-hash"`
+
+## Methods
+
+### getItem()
+
+```ts
+getItem(address): Promise<BrandedHash | null>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`Promise`\<`BrandedHash` \| `null`\>
+
+### Implementation of
+
+[`PreviousHashStore`](#../interfaces/PreviousHashStore).[`getItem`](../interfaces/PreviousHashStore.md#getitem)
+
+***
+
+### removeItem()
+
+```ts
+removeItem(address): Promise<void>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Implementation of
+
+[`PreviousHashStore`](#../interfaces/PreviousHashStore).[`removeItem`](../interfaces/PreviousHashStore.md#removeitem)
+
+***
+
+### setItem()
+
+```ts
+setItem(address, previousHash): Promise<void>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+#### previousHash
+
+`string`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Implementation of
+
+[`PreviousHashStore`](#../interfaces/PreviousHashStore).[`setItem`](../interfaces/PreviousHashStore.md#setitem)
+
+                ### <a id="StoragePreviousHashStore"></a>StoragePreviousHashStore
+
+[**@xyo-network/previous-hash-store**](#../README)
+
+***
+
+## Implements
+
+- [`PreviousHashStore`](#../interfaces/PreviousHashStore)
+
+## Constructors
+
+### Constructor
+
+```ts
+new StoragePreviousHashStore(opts?): StoragePreviousHashStore;
+```
+
+### Parameters
+
+#### opts?
+
+[`StoragePreviousHashOpts`](#../type-aliases/StoragePreviousHashOpts)
+
+### Returns
+
+`StoragePreviousHashStore`
+
+## Properties
+
+### DefaultNamespace
+
+```ts
+readonly static DefaultNamespace: "xyo-previous-hash-store" = "xyo-previous-hash-store";
+```
+
+***
+
+### DefaultStorageType
+
+```ts
+readonly static DefaultStorageType: Storage;
+```
+
+## Accessors
+
+### namespace
+
+### Get Signature
+
+```ts
+get namespace(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### type
+
+### Get Signature
+
+```ts
+get type(): Storage;
+```
+
+#### Returns
+
+[`Storage`](#../type-aliases/Storage)
+
+## Methods
+
+### getItem()
+
+```ts
+getItem(address): Promise<BrandedHash | null>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`Promise`\<`BrandedHash` \| `null`\>
+
+### Implementation of
+
+[`PreviousHashStore`](#../interfaces/PreviousHashStore).[`getItem`](../interfaces/PreviousHashStore.md#getitem)
+
+***
+
+### removeItem()
+
+```ts
+removeItem(address): Promise<void>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Implementation of
+
+[`PreviousHashStore`](#../interfaces/PreviousHashStore).[`removeItem`](../interfaces/PreviousHashStore.md#removeitem)
+
+***
+
+### setItem()
+
+```ts
+setItem(address, previousHash): Promise<void>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+#### previousHash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Implementation of
+
+[`PreviousHashStore`](#../interfaces/PreviousHashStore).[`setItem`](../interfaces/PreviousHashStore.md#setitem)
+
+              ### interfaces
+
+                ### <a id="PreviousHashStore"></a>PreviousHashStore
+
+[**@xyo-network/previous-hash-store**](#../README)
+
+***
+
+## Methods
+
+### getItem()
+
+```ts
+getItem(address): BrandedHash | Promise<BrandedHash | null> | null;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`BrandedHash` \| `Promise`\<`BrandedHash` \| `null`\> \| `null`
+
+***
+
+### removeItem()
+
+```ts
+removeItem(address): void | Promise<void>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### setItem()
+
+```ts
+setItem(address, previousHash): void | Promise<void>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+#### previousHash
+
+`BrandedHash`
+
+### Returns
+
+`void` \| `Promise`\<`void`\>
+
+                ### <a id="PreviousHashStoreSchemaV1"></a>PreviousHashStoreSchemaV1
+
+[**@xyo-network/previous-hash-store**](#../README)
+
+***
+
+## Extends
+
+- `DBSchema`
+
+## Indexable
+
+```ts
+[s: string]: DBSchemaValue
+```
+
+## Properties
+
+### previous-hash
+
+```ts
+previous-hash: object;
+```
+
+### key
+
+```ts
+key: string;
+```
+
+### value
+
+```ts
+value: string;
+```
+
+              ### type-aliases
+
+                ### <a id="Storage"></a>Storage
+
+[**@xyo-network/previous-hash-store**](#../README)
+
+***
+
+```ts
+type Storage = "local" | "session" | "page";
+```
+
+                ### <a id="StoragePreviousHashOpts"></a>StoragePreviousHashOpts
+
+[**@xyo-network/previous-hash-store**](#../README)
+
+***
+
+```ts
+type StoragePreviousHashOpts = object;
+```
+
+## Properties
+
+### namespace?
+
+```ts
+optional namespace?: string;
+```
+
+***
+
+### type?
 
-## Credits
+```ts
+optional type?: Storage;
+```
 
-[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/previous-hash-store.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/previous-hash-store
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/previous-hash-store.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/previous-hash-store",
-  "version": "5.3.24",
+  "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/previous-hash-store-indexeddb": "~5.3.24",
-    "@xyo-network/previous-hash-store-model": "~5.3.24",
-    "@xyo-network/previous-hash-store-storage": "~5.3.24"
+    "@xyo-network/previous-hash-store-indexeddb": "~5.3.26",
+    "@xyo-network/previous-hash-store-model": "~5.3.26",
+    "@xyo-network/previous-hash-store-storage": "~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",
+    "@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",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
@@ -58,9 +58,9 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/previous-hash-store-model": "~5.3.24",
-    "@xyo-network/previous-hash-store-indexeddb": "~5.3.24",
-    "@xyo-network/previous-hash-store-storage": "~5.3.24"
+    "@xyo-network/previous-hash-store-indexeddb": "~5.3.26",
+    "@xyo-network/previous-hash-store-model": "~5.3.26",
+    "@xyo-network/previous-hash-store-storage": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",