@xyo-network/archivist-model-mongodb 5.3.29 → 5.4.0

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 +0 -273
  2. package/package.json +14 -16
package/README.md CHANGED
@@ -38,279 +38,6 @@ bun add {{name}}
38
38
 
39
39
  See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
40
 
41
- ## Reference
42
-
43
- ### packages
44
-
45
- ### modules
46
-
47
- ### packages
48
-
49
- ### archivist
50
-
51
- ### packages
52
-
53
- ### mongodb
54
-
55
- ### packages
56
-
57
- ### model
58
-
59
- ### .temp-typedoc
60
-
61
- ### interfaces
62
-
63
- ### <a id="ArchivistLabels"></a>ArchivistLabels
64
-
65
- [**@xyo-network/archivist-model-mongodb**](#../README)
66
-
67
- ***
68
-
69
- ## Extends
70
-
71
- - `Labels`
72
-
73
- ## Indexable
74
-
75
- ```ts
76
- [key: string]: string | undefined
77
- ```
78
-
79
- ## Properties
80
-
81
- ### network.xyo.archivist.persistence.scope
82
-
83
- ```ts
84
- network.xyo.archivist.persistence.scope: "memory" | "thread" | "process" | "disk" | "network";
85
- ```
86
-
87
- ### <a id="MongoDBArchivistParams"></a>MongoDBArchivistParams
88
-
89
- [**@xyo-network/archivist-model-mongodb**](#../README)
90
-
91
- ***
92
-
93
- ## Extends
94
-
95
- - `ArchivistParams`\<`AnyConfigSchema`\<[`MongoDBArchivistConfig`](#../type-aliases/MongoDBArchivistConfig)\>\>
96
-
97
- ## Properties
98
-
99
- ### keys?
100
-
101
- ```ts
102
- optional keys?: ArchivistKeyParams<BrandedHash, Payload, BrandedHash>;
103
- ```
104
-
105
- ### Inherited from
106
-
107
- ```ts
108
- ArchivistParams.keys
109
- ```
110
-
111
- ***
112
-
113
- ### parents?
114
-
115
- ```ts
116
- optional parents?: ArchivistParentInstances;
117
- ```
118
-
119
- ### Inherited from
120
-
121
- ```ts
122
- ArchivistParams.parents
123
- ```
124
-
125
- ***
126
-
127
- ### values?
128
-
129
- ```ts
130
- optional values?: ArchivistValueParams<Payload, Payload>;
131
- ```
132
-
133
- ### Inherited from
134
-
135
- ```ts
136
- ArchivistParams.values
137
- ```
138
-
139
- ***
140
-
141
- ### boundWitnessSdkConfig
142
-
143
- ```ts
144
- boundWitnessSdkConfig: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
145
- ```
146
-
147
- ***
148
-
149
- ### payloadSdkConfig
150
-
151
- ```ts
152
- payloadSdkConfig: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
153
- ```
154
-
155
- ***
156
-
157
- ### account?
158
-
159
- ```ts
160
- optional account?: AccountInstance | "random";
161
- ```
162
-
163
- ### Inherited from
164
-
165
- ```ts
166
- ArchivistParams.account
167
- ```
168
-
169
- ***
170
-
171
- ### addToResolvers?
172
-
173
- ```ts
174
- optional addToResolvers?: boolean;
175
- ```
176
-
177
- ### Inherited from
178
-
179
- ```ts
180
- ArchivistParams.addToResolvers
181
- ```
182
-
183
- ***
184
-
185
- ### additionalSigners?
186
-
187
- ```ts
188
- optional additionalSigners?: AccountInstance[];
189
- ```
190
-
191
- ### Inherited from
192
-
193
- ```ts
194
- ArchivistParams.additionalSigners
195
- ```
196
-
197
- ***
198
-
199
- ### allowNameResolution?
200
-
201
- ```ts
202
- optional allowNameResolution?: boolean;
203
- ```
204
-
205
- ### Inherited from
206
-
207
- ```ts
208
- ArchivistParams.allowNameResolution
209
- ```
210
-
211
- ***
212
-
213
- ### config
214
-
215
- ```ts
216
- config: Partial<TConfig>;
217
- ```
218
-
219
- ### Inherited from
220
-
221
- ```ts
222
- ArchivistParams.config
223
- ```
224
-
225
- ***
226
-
227
- ### ephemeralQueryAccountEnabled?
228
-
229
- ```ts
230
- optional ephemeralQueryAccountEnabled?: boolean;
231
- ```
232
-
233
- ### Inherited from
234
-
235
- ```ts
236
- ArchivistParams.ephemeralQueryAccountEnabled
237
- ```
238
-
239
- ***
240
-
241
- ### moduleIdentifierTransformers?
242
-
243
- ```ts
244
- optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
245
- ```
246
-
247
- ### Inherited from
248
-
249
- ```ts
250
- ArchivistParams.moduleIdentifierTransformers
251
- ```
252
-
253
- ***
254
-
255
- ### statusReporter?
256
-
257
- ```ts
258
- optional statusReporter?: ModuleStatusReporter;
259
- ```
260
-
261
- Optional reporter for broadcasting status changes.
262
-
263
- ### Inherited from
264
-
265
- ```ts
266
- ArchivistParams.statusReporter
267
- ```
268
-
269
- ### type-aliases
270
-
271
- ### <a id="MongoDBArchivistConfig"></a>MongoDBArchivistConfig
272
-
273
- [**@xyo-network/archivist-model-mongodb**](#../README)
274
-
275
- ***
276
-
277
- ```ts
278
- type MongoDBArchivistConfig = ArchivistConfig<{
279
- boundWitnessSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
280
- payloadSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
281
- schema: MongoDBArchivistConfigSchema;
282
- }>;
283
- ```
284
-
285
- ### <a id="MongoDBArchivistConfigSchema"></a>MongoDBArchivistConfigSchema
286
-
287
- [**@xyo-network/archivist-model-mongodb**](#../README)
288
-
289
- ***
290
-
291
- ```ts
292
- type MongoDBArchivistConfigSchema = typeof MongoDBArchivistConfigSchema;
293
- ```
294
-
295
- ### variables
296
-
297
- ### <a id="MongoDBArchivistConfigSchema"></a>MongoDBArchivistConfigSchema
298
-
299
- [**@xyo-network/archivist-model-mongodb**](#../README)
300
-
301
- ***
302
-
303
- ```ts
304
- const MongoDBArchivistConfigSchema: "network.xyo.archivist.mongodb.config" & object;
305
- ```
306
-
307
- ## Type Declaration
308
-
309
- ### \_\_schema
310
-
311
- ```ts
312
- readonly __schema: true;
313
- ```
314
41
 
315
42
 
316
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/archivist-model-mongodb",
3
- "version": "5.3.29",
3
+ "version": "5.4.0",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -36,30 +36,28 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/archivist-model": "~5.3.29",
40
- "@xyo-network/module-model": "~5.3.29",
41
- "@xyo-network/payload-model": "~5.3.29"
39
+ "@xyo-network/archivist-model": "~5.4.0",
40
+ "@xyo-network/payload-model": "~5.4.0",
41
+ "@xyo-network/module-model": "~5.4.0"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@opentelemetry/api": "^1.9.1",
45
- "@xylabs/mongo": "^5.0.95",
46
- "@xylabs/sdk-js": "^5.0.95",
47
- "@xylabs/ts-scripts-common": "~7.8.4",
48
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
49
- "@xylabs/tsconfig": "~7.8.4",
50
- "axios": "^1.14.0",
45
+ "@xylabs/mongo": "^5.0.97",
46
+ "@xylabs/sdk-js": "^5.0.97",
47
+ "@xylabs/toolchain": "~7.10.8",
48
+ "@xylabs/tsconfig": "~7.10.8",
51
49
  "mongodb": "^7.1.1",
52
50
  "pako": "~2.1.0",
53
51
  "typescript": "~5.9.3",
54
52
  "zod": "^4.3.6",
55
- "@xyo-network/manifest-model": "~5.3.29",
56
- "@xyo-network/account-model": "~5.3.29",
57
- "@xyo-network/previous-hash-store-model": "~5.3.29"
53
+ "@xyo-network/account-model": "~5.4.0",
54
+ "@xyo-network/previous-hash-store-model": "~5.4.0",
55
+ "@xyo-network/manifest-model": "~5.4.0"
58
56
  },
59
57
  "peerDependencies": {
60
- "@xylabs/mongo": "^5",
61
- "@xyo-network/manifest-model": "~5.3.29",
62
- "@xyo-network/account-model": "~5.3.29"
58
+ "@xylabs/mongo": "^5.0.97",
59
+ "@xyo-network/account-model": "~5.4",
60
+ "@xyo-network/manifest-model": "~5.4"
63
61
  },
64
62
  "publishConfig": {
65
63
  "access": "public"