@xyo-network/filesystem-archivist 4.0.3 → 4.1.0

package/dist/node/index.d.ts

@@ -0,0 +1,44 @@
+import { Hash } from '@xylabs/hex';
+import { PromisableArray } from '@xylabs/promise';
+import { AbstractArchivist } from '@xyo-network/archivist-abstract';
+import { ArchivistConfig, ArchivistParams, ArchivistInstance } from '@xyo-network/archivist-model';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+import { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
+
+interface FileSystemArchivistData {
+    payloads: Payload[];
+}
+declare const FilesystemArchivistConfigSchema: "network.xyo.archivist.filesystem.config";
+type FilesystemArchivistConfigSchema = typeof FilesystemArchivistConfigSchema;
+type FilesystemArchivistConfig = ArchivistConfig<{
+    filePath?: string;
+    schema: FilesystemArchivistConfigSchema;
+}>;
+type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;
+/** @description Currently only a read-only archivist that loads payloads from filesystem
+ * but allows for future expansion to read/write
+ */
+declare class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams> extends AbstractArchivist<TParams> implements ArchivistInstance {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    static readonly labels: {
+        "network.xyo.storage.class": string;
+    };
+    private _memoryArchivist?;
+    get filePath(): string;
+    get queries(): string[];
+    private get memoryArchivist();
+    private static dataFromRawJson;
+    protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
+    protected clearHandler(): void | Promise<void>;
+    protected commitHandler(): Promise<BoundWitness[]>;
+    protected deleteHandler(hashes: Hash[]): PromisableArray<WithStorageMeta<Payload>>;
+    protected getHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
+    protected insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]>;
+    protected startHandler(): Promise<void>;
+    private rawJsonFromFile;
+}
+
+export { FilesystemArchivist, FilesystemArchivistConfigSchema };
+export type { FileSystemArchivistData, FilesystemArchivistConfig, FilesystemArchivistParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/filesystem-archivist",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,30 +21,31 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/node/index.d.ts",
+      "browser": {},
       "module": "./dist/node/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/node/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/node/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.4",
-    "@xylabs/error": "^4.13.4",
-    "@xylabs/hex": "^4.13.4",
-    "@xylabs/promise": "^4.13.4",
-    "@xyo-network/archivist-abstract": "^4.0.3",
-    "@xyo-network/archivist-memory": "^4.0.3",
-    "@xyo-network/archivist-model": "^4.0.3",
-    "@xyo-network/boundwitness-model": "^4.0.3",
-    "@xyo-network/module-model": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3",
-    "@xyo-network/wallet": "^4.0.3"
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xyo-network/archivist-abstract": "^4.1.0",
+    "@xyo-network/archivist-memory": "^4.1.0",
+    "@xyo-network/archivist-model": "^4.1.0",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0",
+    "@xyo-network/wallet": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
-    "@xylabs/vitest-extended": "^4.13.4",
+    "@xylabs/error": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/vitest-extended": "^4.13.15",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },