@xyo-network/archivist-model 3.8.0 → 3.8.2

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 (67) hide show
  1. package/dist/neutral/index.d.ts +995 -14
  2. package/dist/neutral/index.mjs.map +1 -1
  3. package/package.json +7 -7
  4. package/src/ArchivistFunctions.ts +22 -0
  5. package/src/Instance.ts +3 -3
  6. package/src/Module.ts +10 -8
  7. package/src/ModuleInstance.ts +11 -0
  8. package/src/PayloadArchivist.ts +36 -0
  9. package/src/attachable/AttachableInstance.ts +2 -2
  10. package/src/index.ts +3 -2
  11. package/src/typeChecks.ts +2 -2
  12. package/dist/neutral/Config.d.ts +0 -27
  13. package/dist/neutral/Config.d.ts.map +0 -1
  14. package/dist/neutral/EventData.d.ts +0 -5
  15. package/dist/neutral/EventData.d.ts.map +0 -1
  16. package/dist/neutral/EventModels/Cleared.d.ts +0 -7
  17. package/dist/neutral/EventModels/Cleared.d.ts.map +0 -1
  18. package/dist/neutral/EventModels/Deleted.d.ts +0 -10
  19. package/dist/neutral/EventModels/Deleted.d.ts.map +0 -1
  20. package/dist/neutral/EventModels/Inserted.d.ts +0 -10
  21. package/dist/neutral/EventModels/Inserted.d.ts.map +0 -1
  22. package/dist/neutral/EventModels/index.d.ts +0 -4
  23. package/dist/neutral/EventModels/index.d.ts.map +0 -1
  24. package/dist/neutral/IndexDescription.d.ts +0 -34
  25. package/dist/neutral/IndexDescription.d.ts.map +0 -1
  26. package/dist/neutral/Instance.d.ts +0 -10
  27. package/dist/neutral/Instance.d.ts.map +0 -1
  28. package/dist/neutral/Labels.d.ts +0 -5
  29. package/dist/neutral/Labels.d.ts.map +0 -1
  30. package/dist/neutral/Module.d.ts +0 -6
  31. package/dist/neutral/Module.d.ts.map +0 -1
  32. package/dist/neutral/NextOptions.d.ts +0 -10
  33. package/dist/neutral/NextOptions.d.ts.map +0 -1
  34. package/dist/neutral/Params.d.ts +0 -5
  35. package/dist/neutral/Params.d.ts.map +0 -1
  36. package/dist/neutral/Queries/All.d.ts +0 -7
  37. package/dist/neutral/Queries/All.d.ts.map +0 -1
  38. package/dist/neutral/Queries/Clear.d.ts +0 -7
  39. package/dist/neutral/Queries/Clear.d.ts.map +0 -1
  40. package/dist/neutral/Queries/Commit.d.ts +0 -7
  41. package/dist/neutral/Queries/Commit.d.ts.map +0 -1
  42. package/dist/neutral/Queries/Delete.d.ts +0 -9
  43. package/dist/neutral/Queries/Delete.d.ts.map +0 -1
  44. package/dist/neutral/Queries/Get.d.ts +0 -9
  45. package/dist/neutral/Queries/Get.d.ts.map +0 -1
  46. package/dist/neutral/Queries/Insert.d.ts +0 -7
  47. package/dist/neutral/Queries/Insert.d.ts.map +0 -1
  48. package/dist/neutral/Queries/Next.d.ts +0 -6
  49. package/dist/neutral/Queries/Next.d.ts.map +0 -1
  50. package/dist/neutral/Queries/index.d.ts +0 -18
  51. package/dist/neutral/Queries/index.d.ts.map +0 -1
  52. package/dist/neutral/QueryFunctions.d.ts +0 -23
  53. package/dist/neutral/QueryFunctions.d.ts.map +0 -1
  54. package/dist/neutral/RawQueryFunctions.d.ts +0 -16
  55. package/dist/neutral/RawQueryFunctions.d.ts.map +0 -1
  56. package/dist/neutral/attachable/AttachableInstance.d.ts +0 -14
  57. package/dist/neutral/attachable/AttachableInstance.d.ts.map +0 -1
  58. package/dist/neutral/attachable/asAttachableInstance.d.ts +0 -191
  59. package/dist/neutral/attachable/asAttachableInstance.d.ts.map +0 -1
  60. package/dist/neutral/attachable/index.d.ts +0 -4
  61. package/dist/neutral/attachable/index.d.ts.map +0 -1
  62. package/dist/neutral/attachable/isAttachableInstance.d.ts +0 -6
  63. package/dist/neutral/attachable/isAttachableInstance.d.ts.map +0 -1
  64. package/dist/neutral/index.d.ts.map +0 -1
  65. package/dist/neutral/typeChecks.d.ts +0 -625
  66. package/dist/neutral/typeChecks.d.ts.map +0 -1
  67. package/src/QueryFunctions.ts +0 -39
@@ -1,16 +0,0 @@
1
- import type { Hash } from '@xylabs/hex';
2
- import type { Promisable } from '@xylabs/promise';
3
- import type { AccountInstance } from '@xyo-network/account-model';
4
- import type { ModuleQueryResult } from '@xyo-network/module-model';
5
- import type { Payload } from '@xyo-network/payload-model';
6
- import type { ArchivistNextOptions } from './NextOptions.ts';
7
- export interface ArchivistRawQueryFunctions {
8
- allQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
9
- clearQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
10
- commitQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
11
- deleteQuery(hashes: Hash[], account?: AccountInstance): Promisable<ModuleQueryResult>;
12
- getQuery(hashes: Hash[], account?: AccountInstance): Promisable<ModuleQueryResult>;
13
- insertQuery(payloads: Payload[], account?: AccountInstance): Promisable<ModuleQueryResult>;
14
- nextQuery(options?: ArchivistNextOptions, account?: AccountInstance): Promisable<ModuleQueryResult>;
15
- }
16
- //# sourceMappingURL=RawQueryFunctions.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"RawQueryFunctions.d.ts","sourceRoot":"","sources":["../../src/RawQueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAE5D,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClE,UAAU,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IACpE,WAAW,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IACrE,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IACrF,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClF,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAC1F,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;CACpG"}
@@ -1,14 +0,0 @@
1
- import type { TypeCheck } from '@xylabs/object';
2
- import { IsObjectFactory } from '@xylabs/object';
3
- import type { AttachableModuleInstance } from '@xyo-network/module-model';
4
- import type { Payload } from '@xyo-network/payload-model';
5
- import type { ArchivistModuleEventData } from '../EventData.ts';
6
- import type { ArchivistInstance } from '../Instance.ts';
7
- import type { ArchivistModule } from '../Module.ts';
8
- import type { ArchivistParams } from '../Params.ts';
9
- export interface AttachableArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModule<TParams, TEventData>, AttachableModuleInstance<TParams, TEventData>, ArchivistInstance<TParams, TEventData, TPayload> {
10
- }
11
- export type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>;
12
- export declare class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {
13
- }
14
- //# sourceMappingURL=AttachableInstance.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"AttachableInstance.d.ts","sourceRoot":"","sources":["../../../src/attachable/AttachableInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAA;AACzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAEnD,MAAM,WAAW,2BAA2B,CAC1C,OAAO,SAAS,eAAe,GAAG,eAAe,EACjD,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,EACtE,QAAQ,SAAS,OAAO,GAAG,OAAO,CAClC,SAAQ,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,EAC5C,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,EAC7C,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC;CAAG;AAErD,MAAM,MAAM,oCAAoC,CAAC,CAAC,SAAS,2BAA2B,GAAG,2BAA2B,IAAI,SAAS,CAAC,CAAC,CAAC,CAAA;AAEpI,qBAAa,oCAAoC,CAAC,CAAC,SAAS,2BAA2B,GAAG,2BAA2B,CAAE,SAAQ,eAAe,CAAC,CAAC,CAAC;CAAG"}
@@ -1,191 +0,0 @@
1
- export declare const asAttachableArchivistInstance: {
2
- <TType extends import("./AttachableInstance.ts").AttachableArchivistInstance<import("@xylabs/object").BaseParamsFields & {
3
- account?: import("@xyo-network/account-model").AccountInstance | "random";
4
- addToResolvers?: boolean;
5
- additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
6
- allowNameResolution?: boolean;
7
- config: import("@xylabs/object").DeepRestrictToStringKeys<{
8
- schema: import("@xyo-network/payload-model").Schema;
9
- parents?: {
10
- commit?: string[] | undefined;
11
- read?: string[] | undefined;
12
- write?: string[] | undefined;
13
- } | undefined;
14
- requireAllParents?: boolean | undefined;
15
- storage?: {
16
- indexes?: {
17
- key: {
18
- [x: string]: import("../IndexDescription.ts").IndexDirection;
19
- };
20
- multiEntry?: boolean | undefined;
21
- name?: string | undefined;
22
- unique?: boolean | undefined;
23
- }[] | undefined;
24
- } | undefined;
25
- storeParentReads?: boolean | undefined;
26
- readonly archiving?: {
27
- readonly archivists?: string[] | undefined;
28
- readonly queries?: string[] | undefined;
29
- } | undefined;
30
- readonly allowedQueries?: string[] | undefined;
31
- readonly archivist?: import("@xyo-network/module-model").ModuleIdentifier | undefined;
32
- readonly consoleLogger?: import("@xylabs/logger").LogLevel | undefined;
33
- readonly labels?: {
34
- [x: string]: string | undefined;
35
- } | undefined;
36
- readonly name?: import("@xyo-network/module-model").ModuleName | undefined;
37
- readonly paging?: {
38
- [x: string]: {
39
- size?: number | undefined;
40
- };
41
- } | undefined;
42
- readonly retry?: {
43
- backoff?: number | undefined;
44
- interval?: number | undefined;
45
- retries?: number | undefined;
46
- } | undefined;
47
- readonly security?: {
48
- readonly allowAnonymous?: boolean | undefined;
49
- readonly allowed?: {
50
- [x: string]: (Lowercase<string> | Lowercase<string>[])[];
51
- } | undefined;
52
- readonly disallowed?: {
53
- [x: string]: Lowercase<string>[];
54
- } | undefined;
55
- } | undefined;
56
- readonly sign?: boolean | undefined;
57
- readonly storeQueries?: boolean | undefined;
58
- readonly timestamp?: boolean | undefined;
59
- }>;
60
- ephemeralQueryAccountEnabled?: boolean;
61
- moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
62
- }, import("../EventData.ts").ArchivistModuleEventData, import("@xylabs/object").DeepRestrictToStringKeys<{
63
- schema: import("@xyo-network/payload-model").Schema;
64
- }>>>(value: import("@xylabs/promise").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
65
- <TType extends import("./AttachableInstance.ts").AttachableArchivistInstance<import("@xylabs/object").BaseParamsFields & {
66
- account?: import("@xyo-network/account-model").AccountInstance | "random";
67
- addToResolvers?: boolean;
68
- additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
69
- allowNameResolution?: boolean;
70
- config: import("@xylabs/object").DeepRestrictToStringKeys<{
71
- schema: import("@xyo-network/payload-model").Schema;
72
- parents?: {
73
- commit?: string[] | undefined;
74
- read?: string[] | undefined;
75
- write?: string[] | undefined;
76
- } | undefined;
77
- requireAllParents?: boolean | undefined;
78
- storage?: {
79
- indexes?: {
80
- key: {
81
- [x: string]: import("../IndexDescription.ts").IndexDirection;
82
- };
83
- multiEntry?: boolean | undefined;
84
- name?: string | undefined;
85
- unique?: boolean | undefined;
86
- }[] | undefined;
87
- } | undefined;
88
- storeParentReads?: boolean | undefined;
89
- readonly archiving?: {
90
- readonly archivists?: string[] | undefined;
91
- readonly queries?: string[] | undefined;
92
- } | undefined;
93
- readonly allowedQueries?: string[] | undefined;
94
- readonly archivist?: import("@xyo-network/module-model").ModuleIdentifier | undefined;
95
- readonly consoleLogger?: import("@xylabs/logger").LogLevel | undefined;
96
- readonly labels?: {
97
- [x: string]: string | undefined;
98
- } | undefined;
99
- readonly name?: import("@xyo-network/module-model").ModuleName | undefined;
100
- readonly paging?: {
101
- [x: string]: {
102
- size?: number | undefined;
103
- };
104
- } | undefined;
105
- readonly retry?: {
106
- backoff?: number | undefined;
107
- interval?: number | undefined;
108
- retries?: number | undefined;
109
- } | undefined;
110
- readonly security?: {
111
- readonly allowAnonymous?: boolean | undefined;
112
- readonly allowed?: {
113
- [x: string]: (Lowercase<string> | Lowercase<string>[])[];
114
- } | undefined;
115
- readonly disallowed?: {
116
- [x: string]: Lowercase<string>[];
117
- } | undefined;
118
- } | undefined;
119
- readonly sign?: boolean | undefined;
120
- readonly storeQueries?: boolean | undefined;
121
- readonly timestamp?: boolean | undefined;
122
- }>;
123
- ephemeralQueryAccountEnabled?: boolean;
124
- moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
125
- }, import("../EventData.ts").ArchivistModuleEventData, import("@xylabs/object").DeepRestrictToStringKeys<{
126
- schema: import("@xyo-network/payload-model").Schema;
127
- }>>>(value: import("@xylabs/promise").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<import("./AttachableInstance.ts").AttachableArchivistInstance<import("@xylabs/object").BaseParamsFields & {
128
- account?: import("@xyo-network/account-model").AccountInstance | "random";
129
- addToResolvers?: boolean;
130
- additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
131
- allowNameResolution?: boolean;
132
- config: import("@xylabs/object").DeepRestrictToStringKeys<{
133
- schema: import("@xyo-network/payload-model").Schema;
134
- parents?: {
135
- commit?: string[] | undefined;
136
- read?: string[] | undefined;
137
- write?: string[] | undefined;
138
- } | undefined;
139
- requireAllParents?: boolean | undefined;
140
- storage?: {
141
- indexes?: {
142
- key: {
143
- [x: string]: import("../IndexDescription.ts").IndexDirection;
144
- };
145
- multiEntry?: boolean | undefined;
146
- name?: string | undefined;
147
- unique?: boolean | undefined;
148
- }[] | undefined;
149
- } | undefined;
150
- storeParentReads?: boolean | undefined;
151
- readonly archiving?: {
152
- readonly archivists?: string[] | undefined;
153
- readonly queries?: string[] | undefined;
154
- } | undefined;
155
- readonly allowedQueries?: string[] | undefined;
156
- readonly archivist?: import("@xyo-network/module-model").ModuleIdentifier | undefined;
157
- readonly consoleLogger?: import("@xylabs/logger").LogLevel | undefined;
158
- readonly labels?: {
159
- [x: string]: string | undefined;
160
- } | undefined;
161
- readonly name?: import("@xyo-network/module-model").ModuleName | undefined;
162
- readonly paging?: {
163
- [x: string]: {
164
- size?: number | undefined;
165
- };
166
- } | undefined;
167
- readonly retry?: {
168
- backoff?: number | undefined;
169
- interval?: number | undefined;
170
- retries?: number | undefined;
171
- } | undefined;
172
- readonly security?: {
173
- readonly allowAnonymous?: boolean | undefined;
174
- readonly allowed?: {
175
- [x: string]: (Lowercase<string> | Lowercase<string>[])[];
176
- } | undefined;
177
- readonly disallowed?: {
178
- [x: string]: Lowercase<string>[];
179
- } | undefined;
180
- } | undefined;
181
- readonly sign?: boolean | undefined;
182
- readonly storeQueries?: boolean | undefined;
183
- readonly timestamp?: boolean | undefined;
184
- }>;
185
- ephemeralQueryAccountEnabled?: boolean;
186
- moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
187
- }, import("../EventData.ts").ArchivistModuleEventData, import("@xylabs/object").DeepRestrictToStringKeys<{
188
- schema: import("@xyo-network/payload-model").Schema;
189
- }>>>, config?: import("@xylabs/object").TypeCheckConfig): TType;
190
- };
191
- //# sourceMappingURL=asAttachableInstance.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"asAttachableInstance.d.ts","sourceRoot":"","sources":["../../../src/attachable/asAttachableInstance.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAChB,iBAAiB,iCAAiC,gBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAA+E,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAAgG,gBAAoB;CADlN,CAAA"}
@@ -1,4 +0,0 @@
1
- export * from './asAttachableInstance.ts';
2
- export * from './AttachableInstance.ts';
3
- export * from './isAttachableInstance.ts';
4
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/attachable/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA"}
@@ -1,6 +0,0 @@
1
- import type { TypeCheck } from '@xylabs/object';
2
- import type { ObjectTypeShape } from '@xylabs/typeof';
3
- import type { AttachableArchivistInstance } from './AttachableInstance.ts';
4
- export declare const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape;
5
- export declare const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance>;
6
- //# sourceMappingURL=isAttachableInstance.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"isAttachableInstance.d.ts","sourceRoot":"","sources":["../../../src/attachable/isAttachableInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAIrD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAE1E,eAAO,MAAM,4CAA4C,EAAE,eAAoB,CAAA;AAK/E,eAAO,MAAM,6BAA6B,EAAE,SAAS,CAAC,2BAA2B,CAG/E,CAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA"}