@ibgib/core-gib 0.0.7 → 0.0.10

package/src/witness/robbot/{robbot-helper.spec.mts → robbot-helper.respec.mts}

@@ -1,3 +1,9 @@
+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 { getIbAndGib } from '@ibgib/ts-gib';
 // import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
 // import { getGibInfo } from 'ts-gib/dist/V1/transforms/transform-helper';
@@ -10,9 +16,9 @@
 import { IbGib_V1 } from "@ibgib/ts-gib/dist/V1/types.mjs";
 import { getSpaceDelimitedSaferRequestText } from "./robbot-helper.mjs";
 
-describe('getRequestTextFromComment', () => {
+await respecfully(sir, 'getRequestTextFromComment', async () => {
 
-    it('should get request text with single-char escape', () => {
+    await ifWe(sir, 'should get request text with single-char escape', () => {
         ['?', '??', '/', '/esc'].forEach(escape => {
             ['help', 'hi',].forEach(requestText => {
                 const text = escape + requestText;
@@ -23,7 +29,7 @@ describe('getRequestTextFromComment', () => {
                     data: { text }
                 }
                 const resRequestText = getSpaceDelimitedSaferRequestText({ ibGib, requestEscapeString: escape });
-                expect(resRequestText).toEqual(requestText);
+                iReckon(sir, resRequestText).isGonnaBe(requestText);
             });
         });
     });
@@ -31,7 +37,7 @@ describe('getRequestTextFromComment', () => {
 
 
 
-// describe('RobbotSessionIb', () => {
+// await respecfully(sir, 'RobbotSessionIb', () => {
 
 //     // one big test because jasmine unfortunately makes you declare variables
 //     // multiple times to get async working, which doesn't scale, so it's a bad
@@ -58,12 +64,12 @@ describe('getRequestTextFromComment', () => {
 //             contextTjpGib: commentGibInfo.tjpGib,
 //             sessionId,
 //         });
-//         expect(ib).toBeTruthy();
-//         expect(ib.startsWith(ROBBOT_SESSION_ATOM)).toBe(true, `doesnt start with robbot session atom. (${ib})`);
-//         expect(ib.match(timestampInTicks)).toBeTruthy(`timestampInTicks not included. (${ib}\n${timestampInTicks})`);
-//         expect(ib.match(sessionId)).toBeTruthy(`sessionId.\nib: ${ib}\nsessionId: ${sessionId}`);
-//         expect(ib.match(robbot.data.name)).toBeTruthy('robbot name');
-//         expect(ib.match(robbot.data.uuid)).toBeTruthy('robbot uuid');
+//         expect(ib).isGonnaBeTruthy();
+//         expect(ib.startsWith(ROBBOT_SESSION_ATOM)).isGonnaBe(true, `doesnt start with robbot session atom. (${ib})`);
+//         expect(ib.match(timestampInTicks)).isGonnaBeTruthy(`timestampInTicks not included. (${ib}\n${timestampInTicks})`);
+//         expect(ib.match(sessionId)).isGonnaBeTruthy(`sessionId.\nib: ${ib}\nsessionId: ${sessionId}`);
+//         expect(ib.match(robbot.data.name)).isGonnaBeTruthy('robbot name');
+//         expect(ib.match(robbot.data.uuid)).isGonnaBeTruthy('robbot uuid');
 
 //         let { timestamp, robbotName,
 //             robbotClassname, robbotId, robbotTjpGib,
@@ -71,14 +77,14 @@ describe('getRequestTextFromComment', () => {
 //             addlMetadata: addlMetadata_Out
 //         } = parseRobbotSessionIb({ ib });
 
-//         expect(timestamp).toBe(timestampInTicks, 'timestampInTicks');
-//         expect(robbotName).toBe(robbot.data.name, 'robbot name');
-//         expect(robbotClassname).toBe(robbot.data.classname, 'robbot classname');
-//         expect(robbotId).toBe(robbot.data.uuid, 'robbot uuid');
-//         expect(robbotTjpGib).toBe(getGibInfo({ gib: robbot.gib }).tjpGib, 'robbot tjpgib');
-//         expect(sessionId_Out).toBe(sessionId, 'sessionId');
-//         expect(contextTjpGib).toBe(getGibInfo({ gib: commentIbGib.gib }).tjpGib, 'contextTjpGib');
-//         expect(addlMetadata_Out).toBe(undefined, 'addlMetadata');
+//         expect(timestamp).isGonnaBe(timestampInTicks, 'timestampInTicks');
+//         expect(robbotName).isGonnaBe(robbot.data.name, 'robbot name');
+//         expect(robbotClassname).isGonnaBe(robbot.data.classname, 'robbot classname');
+//         expect(robbotId).isGonnaBe(robbot.data.uuid, 'robbot uuid');
+//         expect(robbotTjpGib).isGonnaBe(getGibInfo({ gib: robbot.gib }).tjpGib, 'robbot tjpgib');
+//         expect(sessionId_Out).isGonnaBe(sessionId, 'sessionId');
+//         expect(contextTjpGib).isGonnaBe(getGibInfo({ gib: commentIbGib.gib }).tjpGib, 'contextTjpGib');
+//         expect(addlMetadata_Out).isGonnaBe(undefined, 'addlMetadata');
 
 //         // #endregion get/parse normal, no metadata
 
@@ -92,13 +98,13 @@ describe('getRequestTextFromComment', () => {
 //             addlMetadata,
 //         });
 
-//         expect(ib).toBeTruthy();
-//         expect(ib.startsWith(ROBBOT_SESSION_ATOM)).toBe(true, `2 doesnt start with robbot session atom. (${ib})`);
-//         expect(ib.match(timestampInTicks)).toBeTruthy(`2 timestampInTicks not included. (${ib}\n${timestampInTicks})`);
-//         expect(ib.match(sessionId)).toBeTruthy(`2 sessionId.\nib: ${ib}\nsessionId: ${sessionId}`);
-//         expect(ib.match(robbot.data.name)).toBeTruthy('2 robbot name');
-//         expect(ib.match(robbot.data.uuid)).toBeTruthy('2 robbot uuid');
-//         expect(ib.match(addlMetadata)).toBeTruthy('addlMetadata');
+//         expect(ib).isGonnaBeTruthy();
+//         expect(ib.startsWith(ROBBOT_SESSION_ATOM)).isGonnaBe(true, `2 doesnt start with robbot session atom. (${ib})`);
+//         expect(ib.match(timestampInTicks)).isGonnaBeTruthy(`2 timestampInTicks not included. (${ib}\n${timestampInTicks})`);
+//         expect(ib.match(sessionId)).isGonnaBeTruthy(`2 sessionId.\nib: ${ib}\nsessionId: ${sessionId}`);
+//         expect(ib.match(robbot.data.name)).isGonnaBeTruthy('2 robbot name');
+//         expect(ib.match(robbot.data.uuid)).isGonnaBeTruthy('2 robbot uuid');
+//         expect(ib.match(addlMetadata)).isGonnaBeTruthy('addlMetadata');
 
 //         // thanks https://flaviocopes.com/javascript-destructure-object-to-existing-variable/
 //         ({
@@ -107,14 +113,14 @@ describe('getRequestTextFromComment', () => {
 //             sessionId: sessionId_Out, contextTjpGib, addlMetadata: addlMetadata_Out
 //         } = parseRobbotSessionIb({ ib }));
 
-//         expect(timestamp).toBe(timestampInTicks, '2 timestampInTicks');
-//         expect(robbotName).toBe(robbot.data.name, '2 robbot name');
-//         expect(robbotClassname).toBe(robbot.data.classname, '2 robbot classname');
-//         expect(robbotId).toBe(robbot.data.uuid, '2 robbot uuid');
-//         expect(robbotTjpGib).toBe(getGibInfo({ gib: robbot.gib }).tjpGib, '2 robbot tjpgib');
-//         expect(sessionId_Out).toBe(sessionId, '2 sessionId');
-//         expect(contextTjpGib).toBe(getGibInfo({ gib: commentIbGib.gib }).tjpGib, '2 contextTjpGib');
-//         expect(addlMetadata_Out).toBe(addlMetadata, 'addlMetadata');
+//         expect(timestamp).isGonnaBe(timestampInTicks, '2 timestampInTicks');
+//         expect(robbotName).isGonnaBe(robbot.data.name, '2 robbot name');
+//         expect(robbotClassname).isGonnaBe(robbot.data.classname, '2 robbot classname');
+//         expect(robbotId).isGonnaBe(robbot.data.uuid, '2 robbot uuid');
+//         expect(robbotTjpGib).isGonnaBe(getGibInfo({ gib: robbot.gib }).tjpGib, '2 robbot tjpgib');
+//         expect(sessionId_Out).isGonnaBe(sessionId, '2 sessionId');
+//         expect(contextTjpGib).isGonnaBe(getGibInfo({ gib: commentIbGib.gib }).tjpGib, '2 contextTjpGib');
+//         expect(addlMetadata_Out).isGonnaBe(addlMetadata, 'addlMetadata');
 
 //         // #endregion with addl metadata
 

package/src/witness/space/bootstrap/bootstrap-helper.mts

@@ -0,0 +1,50 @@
+import { getIbGibAddr } from "@ibgib/ts-gib";
+import { IbGib_V1 } from "@ibgib/ts-gib/dist/V1/index.mjs";
+import { BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY, BOOTSTRAP_IBGIB_ADDR } from "./bootstrap-constants.mjs";
+import { validateIbGibIntrinsically } from "@ibgib/ts-gib/dist/V1/validate-helper.mjs";
+import { BootstrapData, BootstrapRel8ns } from "./bootstrap-types.mjs";
+
+export async function validateBootstrapIbGib(bootstrapSpace: IbGib_V1): Promise<boolean> {
+    const lc = `[${validateBootstrapIbGib.name}]`;
+    const errors: string[] = [];
+    try {
+        const addr = getIbGibAddr({ ibGib: bootstrapSpace });
+        if (addr !== BOOTSTRAP_IBGIB_ADDR) {
+            errors.push(`invalid bootstrapSpace addr. Should equal "${BOOTSTRAP_IBGIB_ADDR}" (E: ecfdbed719284db7a1aa3f867f706fe9)`);
+        }
+        let intrinsicErrors = await validateIbGibIntrinsically({ ibGib: bootstrapSpace });
+        if (intrinsicErrors?.length ?? -1 > 0) { intrinsicErrors!.forEach(e => errors.push(e)); }
+
+        const data = (bootstrapSpace.data as BootstrapData);
+        const rel8ns = (bootstrapSpace.rel8ns as BootstrapRel8ns);
+
+        if (Object.keys(data || {}).length === 0) {
+            errors.push(`invalid bootstrapSpace data. data required (E: 5a9bd15dd0644f9b93cafbbba660cfdf)`);
+        }
+        if ((data.spaceIds ?? []).length === 0) {
+            errors.push(`invalid bootstrapSpace, data.spaceIds required. (E: 6b91ddc12cfd41e59ded7d7502c1909f)`);
+        }
+        if (Object.keys(bootstrapSpace.rel8ns || {}).length === 0) {
+            errors.push(`invalid bootstrapSpace rel8ns (empty). Should have at least one rel8n, with rel8nName corresponding to the spaceId (E: b188ce4ae25e49f794f35e141bc2ecde)`);
+        }
+        data.spaceIds.forEach((spaceId: string) => {
+            if ((rel8ns[spaceId] ?? []).length === 0) {
+                errors.push(`invalid bootstrap. Each spaceId listed in data should have a corresponding address in rel8ns. spaceId (${spaceId}) missing. (E: 62dd0d76e29a415a98b4b27deb8db17e)`);
+            }
+        });
+        if (!data[BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY]) {
+            errors.push(`invalid bootstrap. data.${BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY} required. (E: f763af2e275f445cbf1db5801bacafad)`);
+        } else if ((rel8ns[data[BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY]] ?? []).length === 0) {
+            errors.push(`invalid bootstrap. data.${BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY} (${data[BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY]}) not found in rel8ns. (E: 44d0799d232f4a51a0b0019ebebe019f)`);
+        }
+        if (errors.length === 0) {
+            return true;
+        } else {
+            console.error(`${lc} errors: ${errors.join('|')}`);
+            return false;
+        }
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        return false;
+    }
+}

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

@@ -0,0 +1,123 @@
+/**
+ * @module bootstrap
+ *
+ * @see {@link BootstrapIbGib}
+ */
+
+import { IbGibRel8ns_V1, IbGib_V1 } from "@ibgib/ts-gib/dist/V1/index.mjs";
+
+import { SpaceId } from "../space-types.mjs";
+import { BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY, BOOTSTRAP_DATA_KNOWN_SPACE_IDS_KEY } from "./bootstrap-constants.mjs";
+
+/**
+ * Data of a {@link BootstrapIbGib}
+ */
+export interface BootstrapData {
+    /**
+     * this id will be the default space of the bootstrap (meta space).
+     *
+     * The `bootstrapIbGib.rel8ns` will contain links to the space addresses,
+     * with `rel8nName === spaceId`.
+     *
+     * So to get the default space, you need the default space address. To get
+     * that address, you first read this data value, then index into
+     * `bootstrap.rel8ns[spaceId]`.
+     */
+    [BOOTSTRAP_DATA_DEFAULT_SPACE_ID_KEY]: SpaceId;
+    /**
+     * List of known spaces in this bootstrap. These should be rel8n names in
+     * the bootstrap's `rel8ns` map.
+     */
+    [BOOTSTRAP_DATA_KNOWN_SPACE_IDS_KEY]: SpaceId[];
+}
+
+/**
+ * Rel8ns of a {@link BootstrapIbGib}
+ *
+ * atow, these will have rel8nNames of [spaceId] that point to the corresponding
+ * latest spaceAddr, such that the length is always === 1.
+ */
+export interface BootstrapRel8ns extends IbGibRel8ns_V1 {
+    // [BOOTSTRAP_REL8N_NAME_SPACE]: IbGibAddr[];
+}
+
+/**
+ * # tl;dr
+ *
+ * a bootstrap ibgib...
+ *
+ * * is a meta space without hash.
+ * * contain info for a "default" local space
+ *   * default local space defines what space is used when not specified in space functions
+ * * contains a list of known spaces available to some entity (app/robbot/etc via ibgibs svc)
+ *
+ * # bootstrapping "applications"
+ *
+ * When the application first starts, it looks to bootstrap itself.  So it will
+ * look for an ibgib with this "primitive" address, i.e. where the gib is the
+ * string literal 'gib'. It looks for this address inside what is called the
+ * "zero space". This is a default space with default parameters that always
+ * points to the same location, relative to the context (app in our current case,
+ * but in the future the context could be e.g. an IoT device or AI microservice).
+ *
+ * So the context execution starts, creating a default zero space ibgib in
+ * memory, which itself has a default location/parameters that the space looks
+ * in in storage. Here it looks for the bootstrap ibgib with a known address
+ * "bootstrap^gib" (atow). Inside that bootstrap ibgib, there should be at least
+ * one local space referenced, or a new one must be created and then stored here
+ * for future app/context startups.
+ *
+ * Spaces are rel8d by their `spaceId`'s in `ibgib.rel8ns`, and the `ibgib.data`
+ * key (`ibgib.data.defaultSpaceId` atow) contains the default `spaceId`.  If
+ * there are multiple local spaces that the bootstrap ibgib knows about, there
+ * will be only one "default" set.
+ *
+ * ## first run
+ *
+ * @see {@link IbgibsService.createNewLocalSpaceAndBootstrapGib}
+ * @see {@link getLocalSpace} in `helper/space.ts`
+ *
+ * A new local space will be created, whose parameters (including its `uuid`
+ * which is its `spaceId`) contribute to its reiffied gib hash. A new bootstrap
+ * ibgib is created, and in its `bootstrapIbGib.data.defaultSpaceId` we set the
+ * newly created local space's id. We then rel8 the space to the bootstrap also
+ * via this spaceId as the rel8nName.
+ *
+ * Note that when the local space is updated, its most recent address must
+ * replace the address that the bootstrap ibgib is pointing to.
+ *
+ * @example
+ *
+ * Here is a copy of a bootstrap^gib.json file on March 30, 2022:
+ * ```
+ * {
+ *   "ib":"bootstrap",
+ *   "gib":"gib",
+ *   "data":{
+ *     "defaultSpaceId":"72af3bba9c6da224829de86982346e283469823e49862398a56510c238bad869",
+ *     "spaceIds":["72af3bba9c6da224829de86982346e283469823e49862398a56510c238bad869"]
+ *   },
+ *   "rel8ns":{
+ *     "72af3bba9c6da224829de86982346e283469823e49862398a56510c238bad869": [
+ *       "witness space IonicSpace_V1 test_space_name 72af3bba9c6da224829de86982346e283469823e49862398a56510c238bad869^62879B18C2726D27262626552672868923477EE09171626A386C1982F392AC26"
+ *     ]
+ *   }
+ * }
+ * ```
+ *
+ * ## notes
+ *
+ * Usually primitives are not stored/persisted. This is because the `gib`
+ * indicates that there is no hash corroboration ("guarantee") to the internal
+ * data or rel8ns. However, a newly started app has to start somewhere. This
+ * offers an alternative to using app storage and streamlines the app overall,
+ * since instead of working with two stores (in Ionic: `Storage` and
+ * `FileSystem`) we will just be working with one (`FileSystem`).
+ *
+ * In the future, we'll want to do a workflow here where the user
+ * can start from an existing space, but for now it's just located
+ * here.
+ */
+export interface BootstrapIbGib
+    extends IbGib_V1<BootstrapData, BootstrapRel8ns> {
+}

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

@@ -0,0 +1,66 @@
+import { IBGIB_SPACE_NAME_DEFAULT } from "../space-constants.mjs";
+import { Directory, Encoding } from "./filesystem-types.mjs";
+
+/**
+ * atow this is '.' (cwd)
+ *
+ * In original ionic space, this would be "DOCUMENTS" or similar.
+ */
+export const IBGIB_BASE_DIR: Directory = '.';
+/**
+ * atow this is 'utf8'
+ *
+ * this stems from original ionic space default encoding.
+ */
+export const IBGIB_ENCODING: Encoding = 'utf8';
+/**
+ * Base directory for all data of the app.
+ */
+export const IBGIB_BASE_SUBPATH = 'ibgib';
+/**
+ * Default space that is also used for bootstrapping.
+ *
+ * The user should provide his/her own space name that will contain their data.
+ * If a custom user space name is not provided, one should be auto-generated.
+ *
+ * ## notes
+ *
+ * * the leading 000's help to put the space earlier in alphabetized listing if viewing through an OS file viewer
+ */
+export const IBGIB_SPACE_SUBPATH_DEFAULT = `000_${IBGIB_SPACE_NAME_DEFAULT}`;
+/**
+ * Subpath for "normal" ibgibs (non-meta, non-dna, non-binary, etc.).
+ */
+export const IBGIB_IBGIBS_SUBPATH = 'ibgibs';
+/**
+ * should contain special-use ibgibs to the application.
+ *
+ * Use case:
+ *   Because some special ibgibs will be changed frequently,
+ *   e.g. settings, a separate folder will be useful.
+ */
+export const IBGIB_META_SUBPATH = 'meta';
+/**
+ * Path for storing the dna for ibgibs.
+ *
+ * bins will be stored without hyphens in the format:
+ *   [hash].[ext]
+ *
+ * @example
+ *   641575866a7c42bda89f58de5cd1c3aa.jpg
+ */
+export const IBGIB_BIN_SUBPATH = 'bin';
+/**
+ * Path for storing the dna for ibgibs.
+ *
+ * ## notes
+ *
+ * eventually, these should most likely be stored in "colder"
+ * storage, like compressed, low-priority.
+ */
+export const IBGIB_DNA_SUBPATH = 'dna';
+
+/**
+ * Yep, this one starts with default instead of ending with it.
+ */
+export const DEFAULT_FILESYSTEM_SPACE_DESCRIPTION = `This is a filesystem space. The ibgib data contains settings for the space itself, and the witness ibgib object interfaces with a back end that is hierarchical like a filesystem. Descend from this class if you're working with a similar space.`;