@xyo-network/filesystem-archivist 2.73.4 → 2.74.1
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.
- package/dist/FilesystemArchivist.d.mts +37 -0
- package/dist/FilesystemArchivist.d.mts.map +1 -0
- package/dist/FilesystemArchivist.d.ts +37 -0
- package/dist/FilesystemArchivist.d.ts.map +1 -0
- package/dist/docs.json +12250 -11513
- package/dist/index.d.mts +2 -39
- package/dist/index.d.mts.map +1 -0
- package/dist/index.d.ts +2 -39
- package/dist/index.d.ts.map +1 -0
- package/package.json +14 -20
- package/tsup.config.ts +0 -16
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { AbstractArchivist } from '@xyo-network/archivist-abstract';
|
|
2
|
+
import { ArchivistConfig, ArchivistInstance, ArchivistParams } from '@xyo-network/archivist-model';
|
|
3
|
+
import { BoundWitness } from '@xyo-network/boundwitness-model';
|
|
4
|
+
import { AnyConfigSchema } from '@xyo-network/module';
|
|
5
|
+
import { Payload } from '@xyo-network/payload-model';
|
|
6
|
+
import { PromisableArray } from '@xyo-network/promise';
|
|
7
|
+
export interface FileSystemArchivistData {
|
|
8
|
+
payloads: Payload[];
|
|
9
|
+
}
|
|
10
|
+
export type FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config';
|
|
11
|
+
export declare const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema;
|
|
12
|
+
export type FilesystemArchivistConfig = ArchivistConfig<{
|
|
13
|
+
filePath?: string;
|
|
14
|
+
schema: FilesystemArchivistConfigSchema;
|
|
15
|
+
}>;
|
|
16
|
+
export type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;
|
|
17
|
+
/** @description Currently only a read-only archivist that loads payloads from filesystem
|
|
18
|
+
* but allows for future expansion to read/write
|
|
19
|
+
*/
|
|
20
|
+
export declare class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams> extends AbstractArchivist<TParams> implements ArchivistInstance {
|
|
21
|
+
static configSchemas: "network.xyo.archivist.filesystem.config"[];
|
|
22
|
+
private _memoryArchivist?;
|
|
23
|
+
get filePath(): string;
|
|
24
|
+
get queries(): string[];
|
|
25
|
+
private get memoryArchivist();
|
|
26
|
+
private static dataFromRawJson;
|
|
27
|
+
private static payloadsFromRawPayloads;
|
|
28
|
+
protected allHandler(): PromisableArray<Payload>;
|
|
29
|
+
protected clearHandler(): void | Promise<void>;
|
|
30
|
+
protected commitHandler(): Promise<BoundWitness[]>;
|
|
31
|
+
protected deleteHandler(hashes: string[]): PromisableArray<string>;
|
|
32
|
+
protected getHandler(hashes: string[]): Promise<Payload[]>;
|
|
33
|
+
protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
|
|
34
|
+
protected startHandler(): Promise<boolean>;
|
|
35
|
+
private rawJsonFromFile;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=FilesystemArchivist.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FilesystemArchivist.d.ts","sourceRoot":"","sources":["../src/FilesystemArchivist.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EACf,iBAAiB,EACjB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAG9D,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,OAAO,EAAE,CAAA;CACpB;AAED,MAAM,MAAM,+BAA+B,GAAG,yCAAyC,CAAA;AACvF,eAAO,MAAM,+BAA+B,EAAE,+BAA2E,CAAA;AAEzH,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,+BAA+B,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC,CAAA;AAEnG;;GAEG;AACH,qBACa,mBAAmB,CAAC,OAAO,SAAS,yBAAyB,GAAG,yBAAyB,CACpG,SAAQ,iBAAiB,CAAC,OAAO,CACjC,YAAW,iBAAiB;IAE5B,OAAgB,aAAa,8CAAoC;IAEjE,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAE1C,IAAI,QAAQ,WAEX;IAED,IAAa,OAAO,aAEnB;IAED,OAAO,KAAK,eAAe,GAE1B;IAED,OAAO,CAAC,MAAM,CAAC,eAAe;IAQ9B,OAAO,CAAC,MAAM,CAAC,uBAAuB;cAKnB,UAAU,IAAI,eAAe,CAAC,OAAO,CAAC;cAItC,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAI9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAI9C,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC;cAIlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAItD,YAAY;YAevB,eAAe;CAG9B"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { AbstractArchivist } from '@xyo-network/archivist-abstract';
|
|
2
|
+
import { ArchivistConfig, ArchivistInstance, ArchivistParams } from '@xyo-network/archivist-model';
|
|
3
|
+
import { BoundWitness } from '@xyo-network/boundwitness-model';
|
|
4
|
+
import { AnyConfigSchema } from '@xyo-network/module';
|
|
5
|
+
import { Payload } from '@xyo-network/payload-model';
|
|
6
|
+
import { PromisableArray } from '@xyo-network/promise';
|
|
7
|
+
export interface FileSystemArchivistData {
|
|
8
|
+
payloads: Payload[];
|
|
9
|
+
}
|
|
10
|
+
export type FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config';
|
|
11
|
+
export declare const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema;
|
|
12
|
+
export type FilesystemArchivistConfig = ArchivistConfig<{
|
|
13
|
+
filePath?: string;
|
|
14
|
+
schema: FilesystemArchivistConfigSchema;
|
|
15
|
+
}>;
|
|
16
|
+
export type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;
|
|
17
|
+
/** @description Currently only a read-only archivist that loads payloads from filesystem
|
|
18
|
+
* but allows for future expansion to read/write
|
|
19
|
+
*/
|
|
20
|
+
export declare class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams> extends AbstractArchivist<TParams> implements ArchivistInstance {
|
|
21
|
+
static configSchemas: "network.xyo.archivist.filesystem.config"[];
|
|
22
|
+
private _memoryArchivist?;
|
|
23
|
+
get filePath(): string;
|
|
24
|
+
get queries(): string[];
|
|
25
|
+
private get memoryArchivist();
|
|
26
|
+
private static dataFromRawJson;
|
|
27
|
+
private static payloadsFromRawPayloads;
|
|
28
|
+
protected allHandler(): PromisableArray<Payload>;
|
|
29
|
+
protected clearHandler(): void | Promise<void>;
|
|
30
|
+
protected commitHandler(): Promise<BoundWitness[]>;
|
|
31
|
+
protected deleteHandler(hashes: string[]): PromisableArray<string>;
|
|
32
|
+
protected getHandler(hashes: string[]): Promise<Payload[]>;
|
|
33
|
+
protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
|
|
34
|
+
protected startHandler(): Promise<boolean>;
|
|
35
|
+
private rawJsonFromFile;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=FilesystemArchivist.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FilesystemArchivist.d.ts","sourceRoot":"","sources":["../src/FilesystemArchivist.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EACf,iBAAiB,EACjB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAG9D,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,OAAO,EAAE,CAAA;CACpB;AAED,MAAM,MAAM,+BAA+B,GAAG,yCAAyC,CAAA;AACvF,eAAO,MAAM,+BAA+B,EAAE,+BAA2E,CAAA;AAEzH,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,+BAA+B,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC,CAAA;AAEnG;;GAEG;AACH,qBACa,mBAAmB,CAAC,OAAO,SAAS,yBAAyB,GAAG,yBAAyB,CACpG,SAAQ,iBAAiB,CAAC,OAAO,CACjC,YAAW,iBAAiB;IAE5B,OAAgB,aAAa,8CAAoC;IAEjE,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAE1C,IAAI,QAAQ,WAEX;IAED,IAAa,OAAO,aAEnB;IAED,OAAO,KAAK,eAAe,GAE1B;IAED,OAAO,CAAC,MAAM,CAAC,eAAe;IAQ9B,OAAO,CAAC,MAAM,CAAC,uBAAuB;cAKnB,UAAU,IAAI,eAAe,CAAC,OAAO,CAAC;cAItC,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAI9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAI9C,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC;cAIlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAItD,YAAY;YAevB,eAAe;CAG9B"}
|