@ibgib/ts-gib 0.4.9 → 0.5.1

package/dist/types.d.mts

@@ -1,17 +1,43 @@
 /**
- * The core of the simplicity of the ibGib protocol is that
- * fundamentally you are taking two ibGibs and producing a third.
+ * @module types
  *
- * There are three primary functions: mut8, rel8, fork
+ * These are the core types at the lowest level of the ibGib protocol.
  *
- * These are actually different aspects of the single function of
- * relationship and time, either extending or creating a timeline.
+ * The core of the simplicity of the ibGib protocol is that fundamentally you
+ * are encompassing the idea of an ibgib (similar to a base class "object" or
+ * "thing") that has intrinsic data and relationships to extrinsic ibgib.  Each
+ * ibgib is content addressed with a unique addressing style called its ib^gib
+ * address. This allows us semantics for abstracting the "content addressing"
+ * per use case, with various schemas allowed, but in general the `ib` is
+ * per-use-case metadata and the `gib` is the more conventional hash of the
+ * ibgib record to allow for the cryptographic guarantees one would expect. Each
+ * discrete frame in time of the ibgib is its own ibgib, and a timeline stream
+ * of that ibgib is created via the "past" relationship (`rel8n`).
  *
- * Mut8 is intrinsic, rel8 is extrinsic, fork is a new timeline.
- * Mut8 changes a timeline, rel8 changes a timeline's link(s),
- * fork creates a new timeline.
+ * New ibgib records are created via "transforms", of which atow there are three
+ * kinds: `mut8`, `rel8`, `fork`
+ *
+ * These are actually different aspects of the single function of relationship
+ * and time, either extending or creating a timeline.
+ *
+ * Mut8 is intrinsic, rel8 is extrinsic, fork makes a new timeline.  Mut8
+ * changes a timeline, rel8 changes a timeline's link(s), fork creates a new
+ * timeline.
+ *
+ * ## notes
+ *
+ * I have attempted to make these version independent, though we will not know
+ * how successful that is until we do a V2.
+ */
+/**
+ * Type alias of string (or empty string) that is meant to convey that it
+ * is used as the ib in an ib^gib address or an `IbGib` class.
  */
 export declare type Ib = '' | string;
+/**
+ * Type alias of string (or empty string) that is meant to convey that it
+ * is used as the gib in an ib^gib address or an `IbGib` class.
+ */
 export declare type Gib = '' | 'gib' | string;
 /**
  * Convenient for when destructuring an IbGibAddr
@@ -27,6 +53,11 @@ export interface IbAndGib {
  * that's to decide for future.
  */
 export declare type IbGibAddr = string;
+/**
+ * Type alias that indicates that this is intended to be a tjp (temporal
+ * junction point) address.
+ */
+export declare type TjpIbGibAddr = IbGibAddr;
 export declare type IbGibRel8ns = {
     /**
      * The key is the rel8nName.

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;AACrC,MAAM,CAAC,OAAO,MAAM,GAAG,GAAG,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC;AAC9C;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,EAAE,GAAG,CAAC;CACZ;AACD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,SAAS,GAAG,MAAM,CAAC;AACvC,MAAM,CAAC,OAAO,MAAM,WAAW,GAAG;IAC9B;;;;;;;OAOG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;CACjD,CAAC;AACF;;;GAGG;AACH,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,CAAC,EAAE,GAAG,CAAC;CACb;AACD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,KAAK;IACzG;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC;AACD,MAAM,CAAC,OAAO,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAC7D,MAAM,WAAW,aAAa,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK;IACrD;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AACD,MAAM,WAAW,4BAA4B;IACzC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AACD,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,CAAE,SAAQ,aAAa,CAAC,IAAI,CAAC;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,4BAA4B,CAAC;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AACD,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,EAAE,QAAQ,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,IAAI,CAAC;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;IACF;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;IACF;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,CAAE,SAAQ,aAAa,CAAC,IAAI,CAAC;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,WAAW,CAAC;CACtC;AAED,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,KAAK;IAC/C;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;IACd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC;CAC/B"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;AACrC;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,GAAG,GAAG,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC;AAC9C;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,EAAE,GAAG,CAAC;CACZ;AACD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,SAAS,GAAG,MAAM,CAAC;AACvC;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,YAAY,GAAG,SAAS,CAAC;AAC7C,MAAM,CAAC,OAAO,MAAM,WAAW,GAAG;IAC9B;;;;;;;OAOG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;CACjD,CAAC;AACF;;;GAGG;AACH,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,CAAC,EAAE,GAAG,CAAC;CACb;AACD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,KAAK;IACzG;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC;AACD,MAAM,CAAC,OAAO,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAC7D,MAAM,WAAW,aAAa,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK;IACrD;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AACD,MAAM,WAAW,4BAA4B;IACzC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AACD,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,CAAE,SAAQ,aAAa,CAAC,IAAI,CAAC;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,4BAA4B,CAAC;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AACD,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,EAAE,QAAQ,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,IAAI,CAAC;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;IACF;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;IACF;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,CAAE,SAAQ,aAAa,CAAC,IAAI,CAAC;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,WAAW,CAAC;CACtC;AACD,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,KAAK;IAC/C;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;IACd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC;CAC/B"}

package/dist/types.mjs

@@ -1,2 +1,33 @@
+/**
+ * @module types
+ *
+ * These are the core types at the lowest level of the ibGib protocol.
+ *
+ * The core of the simplicity of the ibGib protocol is that fundamentally you
+ * are encompassing the idea of an ibgib (similar to a base class "object" or
+ * "thing") that has intrinsic data and relationships to extrinsic ibgib.  Each
+ * ibgib is content addressed with a unique addressing style called its ib^gib
+ * address. This allows us semantics for abstracting the "content addressing"
+ * per use case, with various schemas allowed, but in general the `ib` is
+ * per-use-case metadata and the `gib` is the more conventional hash of the
+ * ibgib record to allow for the cryptographic guarantees one would expect. Each
+ * discrete frame in time of the ibgib is its own ibgib, and a timeline stream
+ * of that ibgib is created via the "past" relationship (`rel8n`).
+ *
+ * New ibgib records are created via "transforms", of which atow there are three
+ * kinds: `mut8`, `rel8`, `fork`
+ *
+ * These are actually different aspects of the single function of relationship
+ * and time, either extending or creating a timeline.
+ *
+ * Mut8 is intrinsic, rel8 is extrinsic, fork makes a new timeline.  Mut8
+ * changes a timeline, rel8 changes a timeline's link(s), fork creates a new
+ * timeline.
+ *
+ * ## notes
+ *
+ * I have attempted to make these version independent, though we will not know
+ * how successful that is until we do a V2.
+ */
 export {};
 //# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":""}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG"}

package/jasmine-browser.json

@@ -13,6 +13,6 @@
     "random": true
   },
   "browser": {
-    "name": "firefox"
+    "name": "headlessChrome"
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibgib/ts-gib",
-  "version": "0.4.9",
+  "version": "0.5.1",
   "description": "ibgib library with low-level graphing-related substrate functionality, e.g. creating raw ibgibs and transformations. node19+ needed for heavily-used webcrypto hashing isomorphically consumed in node and browsers (apps).",
   "repository": {
     "url": "https://gitlab.com/ibgib/ts-gib",
@@ -32,6 +32,7 @@
     "test:browser:serve:nobuild": "npx jasmine-browser-runner serve --config=jasmine-browser.json ",
     "man:test:browser:serve:nobuild": "use this if you are troubleshooting existing dist output and don't want to overwrite those files. (and you're debugging in the browser)",
     "pack": "npm pack --pack-destination=\"./published\"",
+    "prepare:publish:minor": "npm run clean && npm version minor && npm run build && npm run pack",
     "prepare:publish": "npm run clean && npm version patch && npm run build && npm run pack",
     "man:prepare:publish": "use this to patch > build > pack for publishing to npm repo"
   },
@@ -57,5 +58,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@ibgib/helper-gib": "^0.0.2"
   }
 }

package/src/V1/constants.mts

@@ -1,8 +1,27 @@
 import { IbGib_V1 } from './types.mjs';
 
+/**
+ * This is essentially an alias of the string literal `'ib'`
+ */
 export const IB = 'ib';
+/**
+ * This is essentially an alias of the string literal `'gib'`
+ *
+ * When you have a primitive ibgib, this should be the `ibGib.gib` value, as
+ * there is no hashing metadata for primitives.
+ */
 export const GIB = 'gib';
+/**
+ * This is the root ibgib from which all ibgib are ultimately forked.
+ * It has 0 and infinite data, 0 and infinite rel8ns. Its ib and gib
+ * are simply 'ib' and 'gib'.
+ */
 export const ROOT: IbGib_V1 = { ib: IB, gib: GIB, }
+/**
+ * The default delimiter is the caret (^) symbol. This is derived from
+ * taking an ib^gib address and turning it into an ibGib object (note
+ * the capitalized "G").
+ */
 export const IBGIB_DELIMITER = '^';
 /**
  * Gib is often just a single hash for a single ib^gib record.
@@ -15,9 +34,18 @@ export const IBGIB_DELIMITER = '^';
  * @example "comment abc^TJPHASH123", "comment abc^TJPHASH123.THISRECORDHASH456"
  */
 export const GIB_DELIMITER = '.';
+/**
+ * This is the address of the ROOT ibgib with the default delimiter (caret ^).
+ */
 export const ROOT_ADDR = 'ib^gib'; // `${IB}${IBGIB_DELIMITER}${GIB}`;
-
 /**
- * Some rel8ns should not be able to be renamed or removed.
+ * Some rel8ns should not be able to be renamed or removed, as these have
+ * "special" semantic meaning in the low-level graphing protocol.
+ *
+ * ## notes
+ *
+ * * Of course, this can be forged or tinkered with, and that ultimately is what
+ *   consensus would be utilized for.
+ * * protocols built on top of this may also have reserved rel8n/data key names
  */
-export const FORBIDDEN_ADD_RENAME_REMOVE_REL8N_NAMES = ['past', 'ancestor', 'dna', 'tjp'];
+export const FORBIDDEN_ADD_RENAME_REMOVE_REL8N_NAMES = ['past', 'ancestor', 'dna', 'tjp'];

package/src/V1/factory.mts

@@ -9,6 +9,12 @@ export class Factory_V1 {
     static root() {
         return Factory_V1.primitive({ ib: IB });
     }
+
+    /**
+     * Returns an ibGib primitive with the given `ib`, e.g. "{ib: '7', gib: 'gib'}".
+     *
+     * @returns a single primitive ibGib
+     */
     static primitive({
         ib
     }: {
@@ -17,14 +23,24 @@ export class Factory_V1 {
         return { ib, gib: GIB };
     }
 
+    /**
+     * generates multiple primitive ibgibs from the given `ibs` array.
+     * @returns array of generated ibgibs.
+     */
     static primitives({
         ibs
     }: {
         ibs: Ib[]
-    }) {
+    }): IbGib_V1[] {
         return ibs.map(ib => Factory_V1.primitive({ ib }));
     }
 
+    /**
+     * Takes the incoming `parentIbGib` and forks it. Then applies the
+     * `data` and/or `rel8ns` if any, depending on the other config params.
+     *
+     * @returns The entire transform result object that includes the newly produced ibGib as well as any derivative/intermediate ibgibs.
+     */
     static async firstGen<TData = any>({
         ib = IB,
         parentIbGib = Factory_V1.root(),
@@ -45,7 +61,7 @@ export class Factory_V1 {
         linkedRel8ns?: string[],
         noTimestamp?: boolean,
         nCounter?: boolean,
-    }) {
+    }): Promise<TransformResult<IbGib_V1>> {
         const lc = `[firstGen]`;
         /** * Multiple transform steps will create multiple results. */
         const interimResults: TransformResult<IbGib_V1>[] = [];

package/src/V1/factory.spec.mts

@@ -2,7 +2,8 @@
 import { IbGib_V1, IbGibRel8ns_V1, Rel8n } from './types.mjs';
 import { fork } from './transforms/fork.mjs';
 import { TransformOpts_Fork, IbGibAddr, Ib, TransformResult, IbGibRel8ns } from '../types.mjs';
-import { pretty, clone, delay, getIbGibAddr } from '../helper.mjs';
+import { getIbGibAddr, getIbAndGib } from '../helper.mjs';
+import { pretty, clone, delay, } from '@ibgib/helper-gib';
 import { ROOT, ROOT_ADDR } from './constants.mjs';
 import { Factory_V1 as factory } from './factory.mjs';
 import { mut8 } from './transforms/mut8.mjs';

package/src/V1/sha256v1.mts

@@ -1,9 +1,9 @@
-let crypto: any = globalThis.crypto;
-let { subtle } = crypto;
-
+import { extractErrorMsg } from "@ibgib/helper-gib";
 import { IbGib_V1, IbGibData_V1, IbGibRel8ns_V1 } from "./types.mjs";
 import { Ib } from "../types.mjs";
-import { extractErrorMsg } from "../helper.mjs";
+
+let crypto: any = globalThis.crypto;
+let { subtle } = crypto;
 
 /**
  * Performs the gib hash like V1
@@ -82,4 +82,4 @@ export async function hashToHexCopy(
         console.error(extractErrorMsg(e.message));
         return undefined;
     }
-};
+};

package/src/V1/transforms/fork.mts

@@ -1,4 +1,5 @@
-import { getIbGibAddr, clone, getUUID, getTimestamp } from '../../helper.mjs';
+import { getIbGibAddr } from '../../helper.mjs';
+import { clone, getUUID, getTimestamp } from '@ibgib/helper-gib';
 import { sha256v1 } from '../sha256v1.mjs';
 import { IbGib_V1, IbGibData_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
 import { TransformOpts_Fork, TransformResult } from '../../types.mjs';

package/src/V1/transforms/fork.spec.mts

@@ -19,7 +19,8 @@
 import { IbGib_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
 import { fork } from './fork.mjs';
 import { TransformOpts_Fork, IbGibAddr, Ib, TransformResult } from '../../types.mjs';
-import { pretty, clone, delay, getIbGibAddr } from '../../helper.mjs';
+import { getIbGibAddr } from '../../helper.mjs';
+import { pretty, clone, delay, } from '@ibgib/helper-gib';
 import { ROOT, ROOT_ADDR } from '../constants.mjs';
 import { mut8 } from './mut8.mjs';
 import { getGib } from './transform-helper.mjs';

package/src/V1/transforms/index.mts

@@ -1,4 +1,4 @@
 export * from './fork.mjs';
 export * from './mut8.mjs';
 export * from './rel8.mjs';
-export { isPrimitive, isDna } from './transform-helper.mjs';
+export * from './transform-helper.mjs';

package/src/V1/transforms/mut8.mts

@@ -1,4 +1,5 @@
-import { getIbGibAddr, clone, getTimestamp } from '../../helper.mjs';
+import { getIbGibAddr } from '../../helper.mjs';
+import { clone, getTimestamp, } from '@ibgib/helper-gib';
 import { IbGib_V1, IbGibData_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
 import { TransformOpts_Mut8, TransformResult } from '../../types.mjs';
 import { IBGIB_DELIMITER, } from '../constants.mjs';

package/src/V1/transforms/mut8.spec.mts

@@ -7,11 +7,12 @@
  *   going.
  */
 
-import { IbGib_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
+import { IbGib_V1, IbGibRel8ns_V1 } from '../types.mjs';
 import { TransformOpts_Mut8, IbGibAddr } from '../../types.mjs';
-import { pretty, clone, delay, getIbGibAddr, getIbAndGib, } from '../../helper.mjs';
+import { getIbGibAddr, getIbAndGib, } from '../../helper.mjs';
+import { clone, delay, } from '@ibgib/helper-gib';
 import { sha256v1, } from '../sha256v1.mjs';
-import { ROOT, ROOT_ADDR, GIB_DELIMITER } from '../constants.mjs';
+import { ROOT } from '../constants.mjs';
 import { fork } from './fork.mjs';
 import { mut8 } from './mut8.mjs';
 import { Factory_V1 as factory } from '../factory.mjs';

package/src/V1/transforms/rel8.mts

@@ -1,4 +1,5 @@
-import { getIbGibAddr, clone, getTimestamp } from '../../helper.mjs';
+import { getIbGibAddr, getIbAndGib } from '../../helper.mjs';
+import { pretty, clone, delay, getTimestamp, } from '@ibgib/helper-gib';
 import { sha256v1 } from '../sha256v1.mjs';
 import { IbGib_V1, IbGibData_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
 import { TransformOpts_Rel8, TransformResult, IbGibAddr } from '../../types.mjs';

package/src/V1/transforms/rel8.spec.mts

@@ -9,7 +9,8 @@
 
 import { IbGib_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
 import { TransformOpts_Rel8, IbGibAddr, IbGibRel8ns } from '../../types.mjs';
-import { pretty, clone, delay, getIbGibAddr, getIbAndGib } from '../../helper.mjs';
+import { getIbGibAddr, getIbAndGib } from '../../helper.mjs';
+import { pretty, clone, delay, } from '@ibgib/helper-gib';
 import { ROOT, ROOT_ADDR } from '../constants.mjs';
 import { fork } from './fork.mjs';
 // import { mut8 } from './mut8.mjs';

package/src/V1/transforms/transform-helper.mts

@@ -1,5 +1,6 @@
-import { TransformOpts, IbGib, Gib, Ib, IbGibAddr, } from "../../types.mjs";
-import { clone, getIbGibAddr, getIbAndGib, HashAlgorithm, extractErrorMsg, } from "../../helper.mjs";
+import { clone, extractErrorMsg, } from "@ibgib/helper-gib";
+import { TransformOpts, IbGib, Gib, IbGibAddr, } from "../../types.mjs";
+import { getIbGibAddr, getIbAndGib, } from "../../helper.mjs";
 import { sha256v1, } from "../sha256v1.mjs";
 import { GibInfo, IbGib_V1, } from "../types.mjs";
 import { IBGIB_DELIMITER, GIB, GIB_DELIMITER } from "../constants.mjs";

package/src/V1/transforms/transform-helper.spec.mts

@@ -3,13 +3,14 @@
  */
 
 
-import { IbGib_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
-import { TransformOpts_Rel8, IbGibAddr, IbGibRel8ns } from '../../types.mjs';
-import { pretty, clone, delay, getIbGibAddr } from '../../helper.mjs';
-import { ROOT, ROOT_ADDR } from '../constants.mjs';
+// import { IbGib_V1, IbGibRel8ns_V1, Rel8n } from '../types.mjs';
+// import { TransformOpts_Rel8, IbGibAddr, IbGibRel8ns } from '../../types.mjs';
+// import { getIbGibAddr, getIbAndGib } from '../../helper.mjs';
+// import { pretty, clone, delay, } from '@ibgib/helper-gib';
+// import { ROOT, ROOT_ADDR } from '../constants.mjs';
 import { fork } from './fork.mjs';
 // import { mut8 } from './mut8.mjs';
-import { rel8 } from './rel8.mjs';
+// import { rel8 } from './rel8.mjs';
 import { Factory_V1 as factory } from '../factory.mjs';
 import { isDna } from './transform-helper.mjs';
 

package/src/V1/v1-helper.mts

@@ -0,0 +1,90 @@
+import { getIbGibAddr, getIbAndGib } from '../helper.mjs';
+import { pretty, clone, delay, } from '@ibgib/helper-gib';
+import * as cTsGib from './constants.mjs';
+import { getGibInfo } from './transforms/transform-helper.mjs';
+import { IbGibRel8ns_V1, IbGib_V1 } from "./types.mjs";
+
+/**
+ * Helper function that checks the given `ibGib` to see if it
+ * either has a tjp or is a tjp itself.
+ *
+ * ## notes
+ *
+ * Only unique ibGibs are meant to have tjps, or rather, if an
+ * ibGib timeline is expected to be unique over "time", then the
+ * tjp is an extremely convenient mechanism that provides a
+ * "name" for that timeline.
+ *
+ * Otherwise, if they are not unique, then successive "different"
+ * timelines cannot be easily referenced by their first unique
+ * frame in time, making it much harder to pub/sub updates among
+ * other things. (If there are no unique frames, then they are
+ * the same ibGib.)
+ *
+ * ## tjp = temporal junction point
+ *
+ * I've written elsewhere on this as well. Refer to B2tF2.
+ *
+ * @returns true if the ibGib has/is a tjp, else false
+ */
+export function hasTjp({ ibGib }: { ibGib: IbGib_V1 }): boolean {
+    const lc = `[${hasTjp.name}]`;
+
+    if (!ibGib) {
+        console.warn(`${lc} ibGib falsy. (W: 884178562f5b4f15933ac4d98db74cc6)`);
+        return false;
+    }
+
+    if (ibGib.data?.isTjp || ibGib.rel8ns?.tjp?.length! > 0) {
+        return true;
+    }
+
+    // dna transforms do not have tjp
+    const dnaPrimitives = ['fork^gib', 'mut8^gib', 'rel8^gib'];
+    if ((ibGib.rel8ns?.ancestor ?? []).some(x => dnaPrimitives.includes(x))) {
+        return false;
+    }
+
+    if (!ibGib.gib) {
+        console.warn(`${lc} ibGib.gib falsy. (W: 6400d780822b44d992846f1196509be3)`);
+        return false;
+    }
+    if (ibGib.gib.includes(cTsGib.GIB_DELIMITER)) {
+        return true;
+    }
+
+    if (ibGib.gib === cTsGib.GIB) {
+        // primitive
+        return false;
+    }
+
+    // use more expensive getGibInfo call.
+    // could possibly just return false at this point, but since gib info
+    // would change if we change our standards for gib, this is nicer.
+    const gibInfo = getGibInfo({ ibGibAddr: getIbGibAddr({ ibGib }) });
+    return gibInfo.tjpGib ? true : false;
+}
+
+/**
+ * If you have an ibgib object, it may also contain other properties/functions.
+ *
+ * This helper function takes the incoming object and returns a copy
+ * @param param0
+ * @returns
+ */
+export function toDto<TData, TRel8ns extends IbGibRel8ns_V1 = IbGibRel8ns_V1>({
+    ibGib,
+}: {
+    ibGib: IbGib_V1,
+}): IbGib_V1<TData, TRel8ns> {
+    const lc = `[${toDto.name}]`;
+    if (!ibGib.ib) { console.warn(`${lc} ibGib.ib is falsy. (W: e60e41c2a1fc48268379d88ce13cb77b)`); }
+    if (!ibGib.gib) { console.warn(`${lc} ibGib.gib is falsy. (W: fb3889cbf0684ae4ac51e48f28570377)`); }
+
+    let dtoIbGib: IbGib_V1<TData, TRel8ns> = { ib: (ibGib.ib || '').slice() };
+    if (ibGib.gib) { dtoIbGib.gib = ibGib.gib.slice(); };
+    if (ibGib.data) { dtoIbGib.data = clone(ibGib.data); }
+    if (ibGib.rel8ns) { dtoIbGib.rel8ns = clone(ibGib.rel8ns); }
+
+    return dtoIbGib;
+}