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

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.
Files changed (2) hide show
  1. package/README.md +231 -10
  2. package/package.json +9 -9
package/README.md CHANGED
@@ -1,23 +1,244 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/previous-hash-store-indexeddb
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
4
13
 
5
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Primary SDK for using XYO Protocol 2.0
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__previous-hash-store-indexeddb)
24
+ Using pnpm:
25
+
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### protocol
46
+
47
+ ### packages
48
+
49
+ ### crypto
50
+
51
+ ### packages
52
+
53
+ ### previous-hash-store
54
+
55
+ ### packages
56
+
57
+ ### indexeddb
58
+
59
+ ### .temp-typedoc
60
+
61
+ ### classes
62
+
63
+ ### <a id="IndexedDbPreviousHashStore"></a>IndexedDbPreviousHashStore
64
+
65
+ [**@xyo-network/previous-hash-store-indexeddb**](#../README)
66
+
67
+ ***
68
+
69
+ ## Implements
70
+
71
+ - `PreviousHashStore`
72
+
73
+ ## Constructors
74
+
75
+ ### Constructor
76
+
77
+ ```ts
78
+ new IndexedDbPreviousHashStore(): IndexedDbPreviousHashStore;
79
+ ```
80
+
81
+ ### Returns
82
+
83
+ `IndexedDbPreviousHashStore`
84
+
85
+ ## Properties
86
+
87
+ ### CurrentSchemaVersion
88
+
89
+ ```ts
90
+ readonly static CurrentSchemaVersion: 1 = 1;
91
+ ```
92
+
93
+ ## Accessors
94
+
95
+ ### dbName
96
+
97
+ ### Get Signature
98
+
99
+ ```ts
100
+ get dbName(): "xyo";
101
+ ```
102
+
103
+ The database name.
104
+
105
+ #### Returns
106
+
107
+ `"xyo"`
108
+
109
+ ***
110
+
111
+ ### storeName
112
+
113
+ ### Get Signature
114
+
115
+ ```ts
116
+ get storeName(): "previous-hash";
117
+ ```
118
+
119
+ The name of the object store.
120
+
121
+ #### Returns
122
+
123
+ `"previous-hash"`
124
+
125
+ ## Methods
126
+
127
+ ### getItem()
128
+
129
+ ```ts
130
+ getItem(address): Promise<BrandedHash | null>;
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ #### address
136
+
137
+ `BrandedAddress`
138
+
139
+ ### Returns
140
+
141
+ `Promise`\<`BrandedHash` \| `null`\>
142
+
143
+ ### Implementation of
144
+
145
+ ```ts
146
+ PreviousHashStore.getItem
147
+ ```
148
+
149
+ ***
150
+
151
+ ### removeItem()
152
+
153
+ ```ts
154
+ removeItem(address): Promise<void>;
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ #### address
160
+
161
+ `BrandedAddress`
162
+
163
+ ### Returns
164
+
165
+ `Promise`\<`void`\>
166
+
167
+ ### Implementation of
168
+
169
+ ```ts
170
+ PreviousHashStore.removeItem
171
+ ```
172
+
173
+ ***
174
+
175
+ ### setItem()
176
+
177
+ ```ts
178
+ setItem(address, previousHash): Promise<void>;
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ #### address
184
+
185
+ `BrandedAddress`
186
+
187
+ #### previousHash
188
+
189
+ `string`
190
+
191
+ ### Returns
192
+
193
+ `Promise`\<`void`\>
194
+
195
+ ### Implementation of
196
+
197
+ ```ts
198
+ PreviousHashStore.setItem
199
+ ```
200
+
201
+ ### interfaces
202
+
203
+ ### <a id="PreviousHashStoreSchemaV1"></a>PreviousHashStoreSchemaV1
204
+
205
+ [**@xyo-network/previous-hash-store-indexeddb**](#../README)
206
+
207
+ ***
208
+
209
+ ## Extends
210
+
211
+ - `DBSchema`
212
+
213
+ ## Indexable
214
+
215
+ ```ts
216
+ [s: string]: DBSchemaValue
217
+ ```
218
+
219
+ ## Properties
220
+
221
+ ### previous-hash
222
+
223
+ ```ts
224
+ previous-hash: object;
225
+ ```
226
+
227
+ ### key
228
+
229
+ ```ts
230
+ key: string;
231
+ ```
232
+
233
+ ### value
18
234
 
19
- ## Credits
235
+ ```ts
236
+ value: string;
237
+ ```
20
238
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
239
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
240
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
241
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/previous-hash-store-indexeddb.svg
242
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/previous-hash-store-indexeddb
243
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/previous-hash-store-indexeddb.svg
244
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/previous-hash-store-indexeddb",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -36,16 +36,16 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/previous-hash-store-model": "~5.3.24"
39
+ "@xyo-network/previous-hash-store-model": "~5.3.26"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@opentelemetry/api": "^1.9.1",
43
- "@types/node": "^25.5.0",
43
+ "@types/node": "^25.5.2",
44
44
  "@types/uuid": "11.0.0",
45
- "@xylabs/sdk-js": "^5.0.93",
46
- "@xylabs/ts-scripts-common": "~7.6.16",
47
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
48
- "@xylabs/tsconfig": "~7.6.16",
45
+ "@xylabs/sdk-js": "^5.0.94",
46
+ "@xylabs/ts-scripts-common": "~7.7.5",
47
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
48
+ "@xylabs/tsconfig": "~7.7.5",
49
49
  "acorn": "^8.16.0",
50
50
  "axios": "^1.14.0",
51
51
  "esbuild": "^0.28.0",
@@ -56,7 +56,7 @@
56
56
  "vite": "^8.0.3",
57
57
  "vitest": "~4.1.2",
58
58
  "zod": "^4.3.6",
59
- "@xyo-network/previous-hash-store-model": "~5.3.24"
59
+ "@xyo-network/previous-hash-store-model": "~5.3.26"
60
60
  },
61
61
  "peerDependencies": {
62
62
  "@xylabs/sdk-js": "^5",