@ibgib/node-gib 0.0.2

package/src/witness/space/node-filesystem-space/node-indexed-filesystem-space/respec/testSpace_registerNewIbGib_GetLatest.node-indexed-filesystem-space-v1.respec.mts

@@ -0,0 +1,72 @@
+import { rm } from 'node:fs/promises';
+
+import {
+    respecfully,
+    respecfullyDear,
+} from '@ibgib/helper-gib/dist/respec-gib/respec-gib.mjs';
+const maam = `[${import.meta.url}]`, sir = maam;
+
+import {
+    testSpace_registerNewIbGib_GetLatest,
+} from '@ibgib/core-gib/dist/witness/space/space-respec-helper.mjs';
+import {
+    getCurrentFilename, specGetBaseDir, specGetBaseSubPath, specGetSpaceDescription,
+    specGetSpaceId, specGetSpaceName
+} from '@ibgib/core-gib/dist/spec-helper.node.respec.mjs';
+import { NodeIndexedFilesystemSpace_V1 } from '../node-indexed-filesystem-space-v1.mjs';
+import { IBGIB_ENCODING } from '@ibgib/core-gib/dist/witness/space/filesystem-space/filesystem-constants.mjs';
+import { NodeFilesystemSpaceData_V1 } from '../../node-filesystem-space-types.mjs';
+
+const logalot = false;
+const TEST_BASE_DIR_ROOT = (await getCurrentFilename(import.meta.url)).replace('testSpace_', '').substring(0, 18) + '_troot';
+const lc = `[${TEST_BASE_DIR_ROOT}]`;
+
+const fnGetInitialRel8ns = () => {
+    return Promise.resolve(undefined);
+};
+
+const fnGetSpace = async (initialData: any, initialRel8ns: any) => {
+    const space = new NodeIndexedFilesystemSpace_V1(initialData, initialRel8ns);
+    return space;
+};
+
+await respecfully(sir, `[${NodeIndexedFilesystemSpace_V1.name} specs]`, async () => {
+
+    console.log('---'); // output buffer
+    console.log('---'); // output buffer
+    await testSpace_registerNewIbGib_GetLatest({
+        respecfulTitle: sir,
+        logalot: false,
+        // shortcircuitRespec: true,
+        fnGetInitialSpaceData: async () => {
+            const uuid = await specGetSpaceId();
+            return {
+                version: '1',
+                classname: NodeIndexedFilesystemSpace_V1.name,
+                uuid,
+                name: specGetSpaceName(uuid),
+                description: specGetSpaceDescription(uuid),
+                baseDir: specGetBaseDir(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                baseSubPath: specGetBaseSubPath(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                binSubPath: 'bin',
+                dnaSubPath: 'dna',
+                encoding: IBGIB_ENCODING,
+                ibgibsSubPath: 'ibgibs',
+                metaSubPath: 'meta',
+                spaceSubPath: 'space',
+                allowPrimitiveArgs: false,
+                catchAllErrors: false,
+                longPollingIntervalMs: 500,
+                persistOptsAndResultIbGibs: false,
+                trace: false,
+                validateIbGibAddrsMatchIbGibs: false,
+            } satisfies NodeFilesystemSpaceData_V1;
+        },
+        fnGetInitialSpaceRel8ns: fnGetInitialRel8ns,
+        fnGetSpace,
+        testLatestIterations: 10,
+    })
+    console.log('---'); // output buffer
+    console.log('---'); // output buffer
+
+});

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

@@ -0,0 +1,87 @@
+import { default as pathUtils } from 'path';
+import { rm } from 'node:fs/promises';
+
+import {
+    firstOfAll, ifWe, ifWeMight, iReckon,
+    lastOfAll, respecfully, respecfullyDear
+} from '@ibgib/helper-gib/dist/respec-gib/respec-gib.mjs';
+const maam = `[${import.meta.url}]`, sir = maam;
+
+import {
+    testSpace_createAndInit,
+    testSpace_persistTransformResult,
+    testSpace_putGetDelete,
+    testSpace_registerNewIbGib_GetLatest,
+} from '@ibgib/core-gib/dist/witness/space/space-respec-helper.mjs';
+import {
+    getCurrentFilename, specGetBaseDir, specGetBaseSubPath, specGetSpaceDescription,
+    specGetSpaceId, specGetSpaceName
+} from '@ibgib/core-gib/dist/spec-helper.node.respec.mjs';
+import { NodeFilesystemSpace_V1, } from '../node-filesystem-space-v1.mjs';
+import { IBGIB_ENCODING } from '@ibgib/core-gib/dist/witness/space/filesystem-space/filesystem-constants.mjs';
+import { NodeFilesystemSpaceData_V1 } from '../node-filesystem-space-types.mjs';
+
+
+const logalot = false;
+// const lc = `[${import.meta.url}]`;
+const TEST_BASE_DIR_ROOT = (await getCurrentFilename(import.meta.url)).replace('testSpace_', '').substring(0, 18) + '_troot';
+const lc = `[${TEST_BASE_DIR_ROOT}]`;
+if (logalot) { console.log(`${lc} TEST_BASE_DIR_ROOT: ${TEST_BASE_DIR_ROOT} (I: a482e556fbf8076e3b2c6346c4dda423)`); }
+
+
+const fnGetInitialRel8ns = () => {
+    return Promise.resolve(undefined);
+};
+
+const fnGetSpace = async (initialData: any, initialRel8ns: any) => {
+    const space = new NodeFilesystemSpace_V1(initialData, initialRel8ns);
+    if (logalot) {
+        console.log(`${lc} console.dir(space)... (I: 0cbfba3b9b3d43f18a5d7b2f5286dff7)`);
+        console.dir(space)
+    }
+    return space;
+};
+
+await respecfully(sir, `[${NodeFilesystemSpace_V1.name} specs]`, async () => {
+    lastOfAll(sir, async () => {
+        // rm -rf TEST_BASE_DIR_ROOT
+        // comment this out if you want to examine generated ibgib data
+        await rm(TEST_BASE_DIR_ROOT, {
+            recursive: true,
+            force: true,
+        });
+    });
+
+    await testSpace_createAndInit({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        // logalot: true,
+        fnGetInitialSpaceData: async () => {
+            const uuid = await specGetSpaceId();
+            return {
+                version: '1',
+                classname: NodeFilesystemSpace_V1.name,
+                uuid,
+                name: specGetSpaceName(uuid),
+                description: specGetSpaceDescription(uuid),
+                baseDir: specGetBaseDir(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                baseSubPath: specGetBaseSubPath(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                binSubPath: 'bin',
+                dnaSubPath: 'dna',
+                encoding: IBGIB_ENCODING,
+                ibgibsSubPath: 'ibgibs',
+                metaSubPath: 'meta',
+                spaceSubPath: 'space',
+                allowPrimitiveArgs: false,
+                catchAllErrors: false,
+                longPollingIntervalMs: 500,
+                persistOptsAndResultIbGibs: false,
+                trace: false,
+                validateIbGibAddrsMatchIbGibs: false,
+            } satisfies NodeFilesystemSpaceData_V1;
+        },
+        fnGetInitialSpaceRel8ns: fnGetInitialRel8ns,
+        fnGetSpace,
+    })
+
+});

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

@@ -0,0 +1,88 @@
+import { default as pathUtils } from 'path';
+import { rm } from 'node:fs/promises';
+
+import {
+    firstOfAll, ifWe, ifWeMight, iReckon,
+    lastOfAll, respecfully, respecfullyDear
+} from '@ibgib/helper-gib/dist/respec-gib/respec-gib.mjs';
+const maam = `[${import.meta.url}]`, sir = maam;
+
+import {
+    testSpace_createAndInit,
+    testSpace_persistTransformResult,
+    testSpace_putGetDelete,
+    testSpace_registerNewIbGib_GetLatest,
+} from '@ibgib/core-gib/dist/witness/space/space-respec-helper.mjs';
+import {
+    getCurrentFilename, specGetBaseDir, specGetBaseSubPath, specGetSpaceDescription,
+    specGetSpaceId, specGetSpaceName
+} from '@ibgib/core-gib/dist/spec-helper.node.respec.mjs';
+import { NodeFilesystemSpace_V1, } from '../node-filesystem-space-v1.mjs';
+import { IBGIB_ENCODING } from '@ibgib/core-gib/dist/witness/space/filesystem-space/filesystem-constants.mjs';
+import { NodeFilesystemSpaceData_V1 } from '../node-filesystem-space-types.mjs';
+
+
+const logalot = false;
+// const lc = `[${import.meta.url}]`;
+
+const TEST_BASE_DIR_ROOT = (await getCurrentFilename(import.meta.url)).replace('testSpace_', '').substring(0, 18) + '_troot';
+const lc = `[${TEST_BASE_DIR_ROOT}]`;
+if (logalot) { console.log(`${lc} TEST_BASE_DIR_ROOT: ${TEST_BASE_DIR_ROOT} (I: a482e556fbf8076e3b2c6346c4dda423)`); }
+
+
+const fnGetInitialRel8ns = () => {
+    return Promise.resolve(undefined);
+};
+
+const fnGetSpace = async (initialData: any, initialRel8ns: any) => {
+    const space = new NodeFilesystemSpace_V1(initialData, initialRel8ns);
+    if (logalot) {
+        console.log(`${lc} console.dir(space)... (I: 91c18417156bf3ab41c30285b3251c23)`);
+        console.dir(space)
+    }
+    return space;
+};
+
+await respecfully(sir, `[${NodeFilesystemSpace_V1.name} specs]`, async () => {
+    lastOfAll(sir, async () => {
+        // rm -rf TEST_BASE_DIR_ROOT
+        // comment this out if you want to examine generated ibgib data
+        await rm(TEST_BASE_DIR_ROOT, {
+            recursive: true,
+            force: true,
+        });
+    });
+
+    await testSpace_persistTransformResult({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        // logalot: true,
+        fnGetInitialSpaceData: async () => {
+            const uuid = await specGetSpaceId();
+            return {
+                version: '1',
+                classname: 'NodeFilesystemSpace_V1',
+                uuid,
+                name: specGetSpaceName(uuid),
+                description: specGetSpaceDescription(uuid),
+                baseDir: specGetBaseDir(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                baseSubPath: specGetBaseSubPath(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                binSubPath: 'bin',
+                dnaSubPath: 'dna',
+                encoding: IBGIB_ENCODING,
+                ibgibsSubPath: 'ibgibs',
+                metaSubPath: 'meta',
+                spaceSubPath: 'space',
+                allowPrimitiveArgs: false,
+                catchAllErrors: false,
+                longPollingIntervalMs: 500,
+                persistOptsAndResultIbGibs: false,
+                trace: false,
+                validateIbGibAddrsMatchIbGibs: false,
+            };
+        },
+        fnGetInitialSpaceRel8ns: fnGetInitialRel8ns,
+        fnGetSpace,
+    });
+
+});

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

@@ -0,0 +1,88 @@
+import { default as pathUtils } from 'path';
+import { rm } from 'node:fs/promises';
+
+import {
+    firstOfAll, ifWe, ifWeMight, iReckon,
+    lastOfAll, respecfully, respecfullyDear
+} from '@ibgib/helper-gib/dist/respec-gib/respec-gib.mjs';
+const maam = `[${import.meta.url}]`, sir = maam;
+
+import {
+    testSpace_createAndInit,
+    testSpace_persistTransformResult,
+    testSpace_putGetDelete,
+    testSpace_registerNewIbGib_GetLatest,
+} from '@ibgib/core-gib/dist/witness/space/space-respec-helper.mjs';
+import {
+    getCurrentFilename, specGetBaseDir, specGetBaseSubPath, specGetSpaceDescription,
+    specGetSpaceId, specGetSpaceName
+} from '@ibgib/core-gib/dist/spec-helper.node.respec.mjs';
+import { NodeFilesystemSpace_V1, } from '../node-filesystem-space-v1.mjs';
+import { IBGIB_ENCODING } from '@ibgib/core-gib/dist/witness/space/filesystem-space/filesystem-constants.mjs';
+import { NodeFilesystemSpaceData_V1 } from '../node-filesystem-space-types.mjs';
+
+
+const logalot = false;
+// const lc = `[${import.meta.url}]`;
+const TEST_BASE_DIR_ROOT = (await getCurrentFilename(import.meta.url)).replace('testSpace_', '').substring(0, 18) + '_troot';
+const lc = `[${TEST_BASE_DIR_ROOT}]`;
+if (logalot) { console.log(`${lc} TEST_BASE_DIR_ROOT: ${TEST_BASE_DIR_ROOT} (I: a482e556fbf8076e3b2c6346c4dda423)`); }
+
+
+const fnGetInitialRel8ns = () => {
+    return Promise.resolve(undefined);
+};
+
+const fnGetSpace = async (initialData: any, initialRel8ns: any) => {
+    const space = new NodeFilesystemSpace_V1(initialData, initialRel8ns);
+    if (logalot) {
+        console.log(`${lc} console.dir(space)... (I: 91c18417156bf3ab41c30285b3251c23)`);
+        console.dir(space)
+    }
+    return space;
+};
+
+await respecfully(sir, `[${lc} respecs]`, async () => {
+    lastOfAll(sir, async () => {
+        // rm -rf TEST_BASE_DIR_ROOT
+        // comment this out if you want to examine generated ibgib data
+        await rm(TEST_BASE_DIR_ROOT, {
+            recursive: true,
+            force: true,
+        });
+    });
+
+    await testSpace_putGetDelete({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        // logalot: true,
+        // fnBeforeEach: async () => { },
+        fnGetInitialSpaceData: async () => {
+            const uuid = await specGetSpaceId();
+            return {
+                version: '1',
+                classname: 'NodeFilesystemSpace_V1',
+                uuid,
+                name: specGetSpaceName(uuid),
+                description: specGetSpaceDescription(uuid),
+                baseDir: specGetBaseDir(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                baseSubPath: specGetBaseSubPath(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                binSubPath: 'bin',
+                dnaSubPath: 'dna',
+                encoding: IBGIB_ENCODING,
+                ibgibsSubPath: 'ibgibs',
+                metaSubPath: 'meta',
+                spaceSubPath: 'space',
+                allowPrimitiveArgs: false,
+                catchAllErrors: false,
+                longPollingIntervalMs: 500,
+                persistOptsAndResultIbGibs: false,
+                trace: false,
+                validateIbGibAddrsMatchIbGibs: false,
+            };
+        },
+        fnGetInitialSpaceRel8ns: fnGetInitialRel8ns,
+        fnGetSpace,
+    });
+
+});

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

@@ -0,0 +1,90 @@
+import { default as pathUtils } from 'path';
+import { rm } from 'node:fs/promises';
+
+import {
+    firstOfAll, ifWe, ifWeMight, iReckon,
+    lastOfAll, respecfully, respecfullyDear
+} from '@ibgib/helper-gib/dist/respec-gib/respec-gib.mjs';
+const maam = `[${import.meta.url}]`, sir = maam;
+
+import {
+    testSpace_createAndInit,
+    testSpace_persistTransformResult,
+    testSpace_putGetDelete,
+    testSpace_registerNewIbGib_GetLatest,
+} from '@ibgib/core-gib/dist/witness/space/space-respec-helper.mjs';
+import {
+    getCurrentFilename, specGetBaseDir, specGetBaseSubPath, specGetSpaceDescription,
+    specGetSpaceId, specGetSpaceName
+} from '@ibgib/core-gib/dist/spec-helper.node.respec.mjs';
+import { NodeFilesystemSpace_V1, } from '../node-filesystem-space-v1.mjs';
+import { IBGIB_ENCODING } from '@ibgib/core-gib/dist/witness/space/filesystem-space/filesystem-constants.mjs';
+import { NodeFilesystemSpaceData_V1 } from '../node-filesystem-space-types.mjs';
+
+
+const logalot = false;
+const TEST_BASE_DIR_ROOT = (await getCurrentFilename(import.meta.url)).replace('testSpace_', '').substring(0, 18) + '_troot';
+const lc = `[${TEST_BASE_DIR_ROOT}]`;
+
+if (logalot) { console.log(`${lc} TEST_BASE_DIR_ROOT: ${TEST_BASE_DIR_ROOT} (I: a482e556fbf8076e3b2c6346c4dda423)`); }
+
+
+const fnGetInitialRel8ns = () => {
+    return Promise.resolve(undefined);
+};
+
+const fnGetSpace = async (initialData: any, initialRel8ns: any) => {
+    const space = new NodeFilesystemSpace_V1(initialData, initialRel8ns);
+    if (logalot) {
+        console.log(`${lc} console.dir(space)... (I: 91c18417156bf3ab41c30285b3251c23)`);
+        console.dir(space)
+    }
+    return space;
+};
+
+await respecfully(sir, `[${lc} respecs]`, async () => {
+    lastOfAll(sir, async () => {
+        // rm -rf TEST_BASE_DIR_ROOT
+        // comment this out if you want to examine generated ibgib data
+        await rm(TEST_BASE_DIR_ROOT, {
+            recursive: true,
+            force: true,
+        });
+    });
+
+    await testSpace_registerNewIbGib_GetLatest({
+        respecfulTitle: sir,
+        // shortcircuitRespec: true,
+        // logalot: true,
+        fnGetInitialSpaceData: async () => {
+            const uuid = await specGetSpaceId();
+            return {
+                version: '1',
+                classname: 'NodeFilesystemSpace_V1',
+                uuid,
+                name: specGetSpaceName(uuid),
+                description: specGetSpaceDescription(uuid),
+                baseDir: specGetBaseDir(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                baseSubPath: specGetBaseSubPath(TEST_BASE_DIR_ROOT, uuid, logalot, lc),
+                binSubPath: 'bin',
+                dnaSubPath: 'dna',
+                encoding: IBGIB_ENCODING,
+                ibgibsSubPath: 'ibgibs',
+                metaSubPath: 'meta',
+                spaceSubPath: specGetSpaceName(uuid),
+                allowPrimitiveArgs: false,
+                catchAllErrors: false,
+                longPollingIntervalMs: 500,
+                persistOptsAndResultIbGibs: false,
+                trace: false,
+                validateIbGibAddrsMatchIbGibs: false,
+            };
+        },
+        fnGetInitialSpaceRel8ns: fnGetInitialRel8ns,
+        fnGetSpace,
+        // the more iterations the longer per iteration because it has to filter,
+        // sort and parse the metastones each time getLatest is called.
+        testLatestIterations: 25,
+    });
+
+});

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "declaration": true, /* Generates corresponding '.d.ts' file. */
+    "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true, /* Generates corresponding '.map' file. */
+    "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "composite": true, /* Enable project compilation */
+    "outDir": "./dist", /* Redirect output structure to the directory. */
+    "module": "ESNext", /* https://www.typescriptlang.org/docs/handbook/esm-node.html */
+  },
+  "exclude": [
+    "./node_modules",
+    "**/*.spec.mts",
+    "./dist/**/*"
+  ]
+}

package/tsconfig.test.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist", /* Redirect output structure to the directory. */
+    "module": "ESNext", /* https://www.typescriptlang.org/docs/handbook/esm-node.html */
+  },
+  "exclude": [
+    // override inherited exclude of spec files
+  ]
+}