@ibgib/core-gib 0.0.7 → 0.0.10

package/src/witness/space/filesystem-space/filesystem-space-v1.respec.mts

@@ -0,0 +1,110 @@
+import {
+    firstOfEach, firstOfAll, ifWe,
+    lastOfEach, lastOfAll,
+    ifWeMight, iReckon, respecfully
+} from '@ibgib/helper-gib/dist/respec-gib/respec-gib.mjs';
+const maam = `[${import.meta.url}]`, sir = maam;
+import { getUUID, } from '@ibgib/helper-gib';
+import { getIbGibAddr } from '@ibgib/ts-gib';
+
+import {
+    testSpace_createAndInit,
+    testSpace_persistTransformResult,
+    testSpace_PutGetDelete
+} from '../space-respec-helper.mjs';
+import { FilesystemSpace_V1, } from './filesystem-space-v1.mjs';
+import {
+    PutIbGibFileOpts, PutIbGibFileResult,
+    DeleteIbGibFileOpts, DeleteIbGibFilesResult,
+    GetIbGibFileOpts, GetIbGibFileResult
+} from './filesystem-types.mjs';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
+
+/**
+ * simple mock that naively implements file operations using a private map that holds ibgibs.
+ */
+class MockFilesystemSpace_V1 extends FilesystemSpace_V1<any, any, any, any> {
+    #files: { [key: string]: IbGib_V1 } = {};
+
+    protected async putFile({ ibGib, isMeta, isDna, }: PutIbGibFileOpts): Promise<PutIbGibFileResult> {
+        if (!ibGib) { throw new Error(`ibGib required (E: 8a63c7d0922565d6d14ceabd9d881f23)`); }
+        let addr = getIbGibAddr({ ibGib });
+        this.#files[addr] = ibGib;
+        return { success: true }
+    }
+    protected async deleteFile({ addr, isMeta, isDna, }: DeleteIbGibFileOpts): Promise<DeleteIbGibFilesResult> {
+        if (!addr) { throw new Error(`addr required (E: 74167b11ed53abd5db45da2e19d4c923)`); }
+        if (this.#files[addr]) { delete this.#files[addr]; }
+        return { success: true }
+    }
+    protected async getFile({ addr, isMeta, isDna, }: GetIbGibFileOpts): Promise<GetIbGibFileResult> {
+        if (!addr) { throw new Error(`addr required (E: 07bcbc77f59b26266f447bedc7bab723)`); }
+        if (this.#files[addr]) {
+            return {
+                success: true,
+                ibGib: this.#files[addr],
+            };
+        } else {
+            return {
+                success: false,
+                errorMsg: 'addr not found',
+            }
+        }
+    }
+
+}
+
+await respecfully(sir, `[${FilesystemSpace_V1.name} specs]`, async () => {
+
+    await testSpace_createAndInit({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        fnGetInitialData: async () => {
+            return {
+                name: (await getUUID()).substring(0, 8),
+                uuid: await getUUID(),
+            };
+        },
+        fnGetInitialRel8ns: () => {
+            return Promise.resolve(undefined);
+        },
+        fnGetSpace: (initialData: any, initialRel8ns) => {
+            return Promise.resolve(new MockFilesystemSpace_V1(initialData, initialRel8ns));
+        },
+    })
+
+    await testSpace_PutGetDelete({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        fnGetInitialData: async () => {
+            return {
+                name: (await getUUID()).substring(0, 8),
+                uuid: await getUUID(),
+            };
+        },
+        fnGetInitialRel8ns: () => {
+            return Promise.resolve(undefined);
+        },
+        fnGetSpace: (initialData: any, initialRel8ns) => {
+            return Promise.resolve(new MockFilesystemSpace_V1(initialData, initialRel8ns));
+        },
+    });
+
+    await testSpace_persistTransformResult({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        fnGetInitialData: async () => {
+            return {
+                name: (await getUUID()).substring(0, 8),
+                uuid: await getUUID(),
+            };
+        },
+        fnGetInitialRel8ns: () => {
+            return Promise.resolve(undefined);
+        },
+        fnGetSpace: (initialData: any, initialRel8ns) => {
+            return Promise.resolve(new MockFilesystemSpace_V1(initialData, initialRel8ns));
+        },
+    });
+
+});

package/src/witness/space/filesystem-space/filesystem-types.mts

@@ -0,0 +1,75 @@
+import { IbGibAddr } from "@ibgib/ts-gib";
+import { IbGib_V1 } from "@ibgib/ts-gib/dist/V1/index.mjs";
+
+/**
+ * encoding of the file.
+ *
+ * I'm bringing this over from my IonicSpace_V1 which used Capacitor.
+ * In that lib, this is a string mapped enum.
+ */
+export type Encoding = 'utf8' | 'UTF-8' | string;
+
+/**
+ * I'm bringing this over from my IonicSpace_V1 which used Capacitor.
+ * In that lib, this is a string mapped enum.
+ *
+ * But in that case, this is a special folder, whereas with this
+ * implementation that may not be the case.
+ */
+export type Directory = string;
+
+/**
+ * common shape of get/put/delete file function results
+ */
+export interface FileResult {
+    success?: boolean;
+    /**
+     * If errored, this will contain the errorMsg.
+     */
+    errorMsg?: string;
+}
+
+/**
+ * Options for retrieving data from the file system.
+ */
+export interface GetIbGibFileOpts {
+    /**
+     * If getting ibGib object, this is its address.
+     */
+    addr?: IbGibAddr;
+    /**
+     * If truthy, will look in the meta subpath first, then the regular if not found.
+     */
+    isMeta?: boolean;
+    /**
+     * Are we looking for a DNA ibgib?
+     */
+    isDna?: boolean;
+}
+/**
+ * Result for retrieving an ibGib from the file system.
+ */
+export interface GetIbGibFileResult extends FileResult {
+    /**
+     * ibGib if retrieving a "regular" ibGib.
+     *
+     * This is used when you're not getting a pic, e.g.
+     */
+    ibGib?: IbGib_V1;
+}
+
+export interface PutIbGibFileOpts {
+    ibGib?: IbGib_V1;
+    /**
+     * If true, will store with metas.
+     */
+    isMeta?: boolean;
+    /**
+     * If true, will store in a different folder.
+     */
+    isDna?: boolean;
+}
+export interface PutIbGibFileResult extends FileResult { }
+
+export interface DeleteIbGibFileOpts extends GetIbGibFileOpts { }
+export interface DeleteIbGibFilesResult extends FileResult { }