@ibgib/ts-gib 0.4.9

package/dist/helper.mjs

@@ -0,0 +1,179 @@
+let crypto = globalThis.crypto;
+let { subtle } = crypto;
+export const HashAlgorithm = {
+    'sha_256': 'SHA-256',
+    'sha_512': 'SHA-512',
+};
+export function clone(obj) {
+    return JSON.parse(JSON.stringify(obj));
+}
+export function getTimestamp() {
+    return (new Date()).toUTCString();
+}
+/**
+ * Gets the ib^gib address from the given ib and gib or
+ * from the ibGib object.
+ *
+ * Need to refactor to getIbGibAddr
+ */
+export function getIbGibAddr({ ib, gib, ibGib, delimiter = '^' }) {
+    ib = ib || ibGib?.ib || '';
+    gib = gib || ibGib?.gib || '';
+    return ib + delimiter + gib;
+}
+/**
+ * Get the ib and gib fields from an ibGib object or ibGibAddr
+ * with the given `delimiter`.
+ */
+export function getIbAndGib({ ibGib, ibGibAddr, delimiter = '^' }) {
+    const lc = '[getIbAndGib]';
+    if (!ibGibAddr) {
+        if (ibGib) {
+            ibGibAddr = getIbGibAddr({ ibGib });
+        }
+        else {
+            throw new Error(`${lc} We need either an address or an ibGib object`);
+        }
+    }
+    if (!ibGibAddr) {
+        throw new Error(`${lc} Couldn't get ibGibAddr. ibGib invalid?`);
+    }
+    if (!delimiter) {
+        delimiter = '^';
+    }
+    const pieces = ibGibAddr.split(delimiter);
+    if (pieces.length === 2) {
+        // normal v1 case, e.g. 'ib^gib' or 'tag home^ABC123'
+        return { ib: pieces[0], gib: pieces[1] };
+    }
+    else if (pieces.length === 1 && ibGibAddr.endsWith(delimiter)) {
+        // normal v1 primitive, e.g. '7^' or 'name^'
+        return { ib: pieces[0], gib: '' };
+    }
+    else if (pieces.length === 1 && ibGibAddr.startsWith(delimiter)) {
+        // only gib/hash is provided like maybe a binary file
+        // e.g. ^ABC123 or ^XYZ456 or ^some_gib_that_isnt_a_hash
+        return { ib: '', gib: pieces[0] };
+    }
+    else if (pieces.length === 2 && pieces[0] === '' && pieces[1] === '') {
+        // edge case of address is only the delimiter.
+        // So it's the primitive for that delimiter
+        return { ib: delimiter, gib: '' };
+        // } else if (pieces.length === 0 ) {
+        // ibGibAddr is falsy, so would have thrown earlier in this function
+        // I'm just noting this case for intent ATOW
+    }
+    else {
+        console.warn(`${lc} multiple delimiters found in ibGibAddr. Considering last delimiter as the demarcation of gib hash`);
+        // e.g. 'ib^ABC123^gib'
+        // ib: 'ib^ABC123'
+        // gib: 'gib'
+        return {
+            ib: pieces.slice(0, pieces.length - 1).join(delimiter),
+            gib: pieces.slice(pieces.length - 1)[0],
+        };
+    }
+}
+/**
+ * Simple hash function.
+ *
+ * NOTE:
+ *   This is not used for ibGib.gib values (ATOW)
+ *   but rather as a helper function for generating random UUIDs.
+ *
+ * @param s string to hash
+ * @param algorithm to use, currently only 'SHA-256'
+ */
+export async function hash({ s, algorithm = 'SHA-256', }) {
+    if (!s) {
+        return '';
+    }
+    const validAlgorithms = Object.values(HashAlgorithm);
+    if (!validAlgorithms.includes(algorithm)) {
+        console.error(`Only ${validAlgorithms} implemented`);
+        return '';
+    }
+    try {
+        const msgUint8 = new TextEncoder().encode(s);
+        const buffer = await subtle.digest(algorithm, msgUint8);
+        const asArray = Array.from(new Uint8Array(buffer));
+        return asArray.map(b => b.toString(16).padStart(2, '0')).join('');
+    }
+    catch (e) {
+        console.error(extractErrorMsg(e.message));
+        return '';
+    }
+}
+/**
+ * Simple func to generate UUID (sha-256 hash basically).
+ *
+ * @param seedSize size of seed for UUID generation
+ */
+export async function getUUID(seedSize = 64) {
+    let uuid = '';
+    if (seedSize < 32) {
+        throw new Error(`Seed size must be at least 32`);
+    }
+    if (!globalThis.crypto) {
+        throw new Error(`Cannot create UUID, as unknown crypto library version. If using node.js, v19+ is required. (E: c02cee3fd8a94f678d3f4ebe9dc49797)`);
+    }
+    const values = crypto.getRandomValues(new Uint8Array(16));
+    uuid = await hash({ s: values.join('') });
+    if (!uuid) {
+        throw new Error(`Did not create UUID...hmm...`);
+    }
+    return uuid;
+}
+/**
+ * Syntactic sugar for JSON.stringify(obj, null, 2);
+ *
+ * @param obj to pretty stringify
+ */
+export function pretty(obj) {
+    return JSON.stringify(obj, null, 2);
+}
+/**
+ * Just delays given number of ms.
+ *
+ * @param ms milliseconds to delay
+ */
+export async function delay(ms) {
+    return new Promise(resolve => {
+        setTimeout(() => {
+            resolve();
+        }, ms);
+    });
+}
+/**
+ * extracts the error message from an error object/string/falsy arg.
+ *
+ * ## notes
+ *
+ * * some libs throw errors, some throw just strings.
+ * * who knows what else it could be.
+ *
+ * ## todo
+ *
+ * * extract inner errors/causes if we ever use this function extensively.
+ *
+ * @param error the error object in the catch area of the try..catch block.
+ * @returns error.message if it's a string, error itself if it's a string, or canned error messages if it's falsy or none of the above.
+ */
+export function extractErrorMsg(error) {
+    if (!error && error !== 0) {
+        return '[error is falsy]';
+    }
+    else if (typeof error === 'string') {
+        return error;
+    }
+    else if (typeof error.message === 'string') {
+        return error.message;
+    }
+    else if (typeof error === 'number') {
+        return JSON.stringify(error);
+    }
+    else {
+        return `[error is not a string and error.message is not a string. typeof error: ${typeof error}]`;
+    }
+}
+//# sourceMappingURL=helper.mjs.map

package/dist/helper.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper.mjs","sourceRoot":"","sources":["../src/helper.mts"],"names":[],"mappings":"AACA,IAAI,MAAM,GAAQ,UAAU,CAAC,MAAM,CAAC;AACpC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;AAGxB,MAAM,CAAC,MAAM,aAAa,GAAqC;IAC3D,SAAS,EAAE,SAA0B;IACrC,SAAS,EAAE,SAA0B;CACxC,CAAA;AAED,MAAM,UAAU,KAAK,CAAC,GAAQ;IAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AACD,MAAM,UAAU,YAAY;IACxB,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AACtC,CAAC;AACD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,EACzB,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,GAAG,GAAG,EAMlC;IACG,EAAE,GAAG,EAAE,IAAI,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC;IAC3B,GAAG,GAAG,GAAG,IAAI,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC;IAC9B,OAAO,EAAE,GAAG,SAAS,GAAG,GAAG,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,EACxB,KAAK,EACL,SAAS,EACT,SAAS,GAAG,GAAG,EAKlB;IACG,MAAM,EAAE,GAAG,eAAe,CAAC;IAC3B,IAAI,CAAC,SAAS,EAAE;QACZ,IAAI,KAAK,EAAE;YACP,SAAS,GAAG,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;SACvC;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,+CAA+C,CAAC,CAAC;SACzE;KACJ;IACD,IAAI,CAAC,SAAS,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,yCAAyC,CAAC,CAAC;KAAE;IAEpF,IAAI,CAAC,SAAS,EAAE;QAAE,SAAS,GAAG,GAAG,CAAC;KAAE;IAEpC,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,qDAAqD;QACrD,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5C;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC7D,4CAA4C;QAC5C,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;KACrC;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC/D,qDAAqD;QACrD,wDAAwD;QACxD,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;KACrC;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;QACpE,8CAA8C;QAC9C,2CAA2C;QAC3C,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QAClC,qCAAqC;QACrC,oEAAoE;QACpE,4CAA4C;KAC/C;SAAM;QACH,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,oGAAoG,CAAC,CAAC;QACxH,uBAAuB;QACvB,kBAAkB;QAClB,aAAa;QACb,OAAO;YACH,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACtD,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C,CAAA;KACJ;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,EACvB,CAAC,EACD,SAAS,GAAG,SAAS,GAIxB;IACG,IAAI,CAAC,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC;KAAE;IAEtB,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACrD,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACtC,OAAO,CAAC,KAAK,CAAC,QAAQ,eAAe,cAAc,CAAC,CAAC;QAAC,OAAO,EAAE,CAAC;KACnE;IACD,IAAI;QACA,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KACrE;IAAC,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1C,OAAO,EAAE,CAAC;KACb;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,QAAQ,GAAG,EAAE;IACvC,IAAI,IAAI,GAAW,EAAE,CAAC;IACtB,IAAI,QAAQ,GAAG,EAAE,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;KAAE;IACxE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,kIAAkI,CAAC,CAAC;KAAE;IAEhL,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,IAAI,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAE1C,IAAI,CAAC,IAAI,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KAAE;IAE/D,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAQ;IAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,EAAU;IAClC,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;QAC/B,UAAU,CAAC,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;QACd,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAAC,KAAU;IACtC,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE;QACvB,OAAO,kBAAkB,CAAC;KAC7B;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAClC,OAAO,KAAK,CAAC;KAChB;SAAM,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE;QAC1C,OAAO,KAAK,CAAC,OAAO,CAAC;KACxB;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;KAChC;SAAM;QACH,OAAO,2EAA2E,OAAO,KAAK,GAAG,CAAC;KACrG;AACL,CAAC"}

package/dist/index.cjs

@@ -0,0 +1,4 @@
+export * as V1 from './V1/index.mjs';
+export * from './types.mjs';
+export * from './helper.mjs';
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/dist/index.d.cts

@@ -0,0 +1,4 @@
+export * as V1 from './V1/index.mjs';
+export * from './types.mjs';
+export * from './helper.mjs';
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/dist/index.d.mts

@@ -0,0 +1,4 @@
+export * as V1 from './V1/index.mjs';
+export * from './types.mjs';
+export * from './helper.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+export * as V1 from './V1/index.mjs';
+export * from './types.mjs';
+export * from './helper.mjs';
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/dist/types.d.mts

@@ -0,0 +1,242 @@
+/**
+ * The core of the simplicity of the ibGib protocol is that
+ * fundamentally you are taking two ibGibs and producing a third.
+ *
+ * There are three primary functions: 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 is a new timeline.
+ * Mut8 changes a timeline, rel8 changes a timeline's link(s),
+ * fork creates a new timeline.
+ */
+export declare type Ib = '' | string;
+export declare type Gib = '' | 'gib' | string;
+/**
+ * Convenient for when destructuring an IbGibAddr
+ */
+export interface IbAndGib {
+    ib: Ib;
+    gib: Gib;
+}
+/**
+ * Mostly a marker type of address.
+ *
+ * Not sure how to enforce schema on demand in TypeScript, but
+ * that's to decide for future.
+ */
+export declare type IbGibAddr = string;
+export declare type IbGibRel8ns = {
+    /**
+     * The key is the rel8nName.
+     *
+     * TS doesnt allow for the indexer to have a non-number/string value
+     * even if it's an alias for one of these types to be more readable.
+     * Otherwise I would type the `key` here as a `Rel8nName` alias of
+     * `string.`
+     */
+    [key: string]: IbGibAddr[] | null | undefined;
+};
+/**
+ * At the base ibGib, the bare minimum is that an ib (data) is required,
+ * with an optional gib (metadata).
+ */
+export interface IbGib {
+    ib: Ib;
+    gib?: Gib;
+}
+/**
+ * When adding additional structure to an ibGib, the first representation
+ * mechanism (from V1) was having explicit Data and Rel8ns keys.
+ *
+ * This is, however, not the only way to represent this. As just one example,
+ * you could also have a prefix for keys that are meant to be the relationships
+ * to other ibGibs.
+ *
+ * I'm including this shape at the core here and not just in V1 because it could
+ * be reused for other versions that are different tweaks with different default
+ * relationships and data structures but still adhere to this data/rel8ns split
+ * (and naming convention).
+ */
+export interface IbGibWithDataAndRel8ns<TData = any, TRel8ns extends IbGibRel8ns = IbGibRel8ns> extends IbGib {
+    /**
+     * Intrinsic data to this ibGib, most likely with primitives e.g. strings or numbers,
+     * that will be statically copied from mutation to mutation.
+     */
+    data?: TData | undefined;
+    /**
+     * Extrinsic data WRT this ibGib, which can track their own timelines of changes.
+     *
+     * Note that even if the relationships here point to the same address, i.e. do
+     * not change, the other ibGibs can be seen as changing or not. It all depends
+     * on how you want to interpret the relationship.
+     *
+     * For example, if you want to pause/freeze a relationship, then this would be
+     * handled by the viewer of the relationship. It just wouldn't check anywhere for
+     * the more up-to-date version.
+     */
+    rel8ns?: TRel8ns | undefined;
+}
+export declare type TransformType = 'fork' | 'mut8' | 'rel8';
+export interface TransformOpts<TSrc extends IbGib = IbGib> {
+    /**
+     * Fork, mut8, rel8
+     */
+    type?: TransformType;
+    /**
+     * If truthy, does NOT add a timestamp to the new ibGib.
+     */
+    noTimestamp?: boolean;
+    /**
+     * If truthy, creates dna ibGibs like V1.
+     * If falsy, skips the dna and only creates the resultant ibGib.
+     */
+    dna?: boolean;
+    /**
+     * Src to apply the transform to.
+     *
+     * Used at runtime, NOT persisted in space.
+     */
+    src?: TSrc;
+    /**
+     * Address of Src. Used in the space persistence.
+     */
+    srcAddr?: IbGibAddr;
+    /**
+     * There are two ways of creating rel8ns to other ibgibs:
+     *
+     * 1) Concat previous ones with new one
+     *   * e.g. past: ['a^gib'] --> past: ['a^gib', 'b^gib'] --> past: ['a^gib', 'b^gib', 'c^gib']
+     * 2) Only have most recent one, linked list style:
+     *   * e.g. past: ['a^gib'] --> past: ['b^gib'] --> past: ['c^gib']
+     *
+     * If you choose #1, then you have the advantage of not needing to load up all of the previous
+     * records to evaluate. So this will give you minimal runtime requirements, but take up more space.
+     * If you choose #2, like in a blockchain e.g., then you will have a smaller space footprint but
+     * it takes longer to build the entire list.
+     *
+     * This gives flexibility for having rel8ns that only wish to have a single value at most.
+     *
+     */
+    linkedRel8ns?: string[];
+    /**
+     * If truthy, this will include a data['n'] value that acts as an incremented
+     * counter for a naive versioning tracker.
+     *
+     * So A0^123.data.n = 0, A1^456.data.n = 1, etc.
+     */
+    nCounter?: boolean;
+}
+export interface TemporalJunctionPointOptions {
+    timestamp?: boolean;
+    uuid?: boolean;
+}
+export interface TransformOpts_Fork<TSrc extends IbGib = IbGib> extends TransformOpts<TSrc> {
+    type?: 'fork';
+    /**
+     * Destination ib for the transform.
+     */
+    destIb?: string;
+    /**
+     * If truthy, creates a UUID to encourage local uniqueness of the fork.
+     */
+    uuid?: boolean;
+    /**
+     * If truthy, the forked ibGib will be a temporal junction point using
+     * the specified
+     * This will provide a UUID to encourage local uniqueness of the fork.
+     *
+     * For what a temporal junction point is, refer to
+     * Back to the Future II (or ask me).
+     */
+    tjp?: TemporalJunctionPointOptions;
+    /**
+     * If true, retains parent/source's extrinsic rel8ns.
+     */
+    cloneRel8ns?: boolean;
+    /**
+     * If true, retains parent/source's intrinsic data.
+     */
+    cloneData?: boolean;
+}
+export interface TransformOpts_Mut8<TSrc extends IbGib = IbGib, TNewData = any> extends TransformOpts<TSrc> {
+    type?: 'mut8';
+    /**
+     * Info to rename keys. Should be an object where each value should either be
+     * a string or an object. If it's a string, then the corresponding key will
+     * be renamed to that value. If it's an object, then it will recurse at that
+     * key.
+     *
+     * @example
+     * data = { a: 'aaa', b: { rename: 'me', ignore: 'me' }}
+     * dataToRemove = { a: 'aRenamed', b: { rename: 'renamed' } }
+     * data = { aRenamed: 'aaa', b: { renamed: 'me', ignore: 'me' }}
+     */
+    dataToRename?: {
+        [key: string]: any;
+    };
+    /**
+     * Info to remove keys. Should be an object where each value should either be
+     * a string or an object. If it's a string, then the corresponding key will
+     * be removed (the value is ignored). If it's an object, then it will recurse at that
+     * key.
+     *
+     * @example
+     * data = { a: 'aaa', b: { remove: 'me', ignore: 'me' }}
+     * dataToRemove = { b: { remove: '' } }
+     * data = { a: 'aaa', b: { ignore: 'me' }}
+     */
+    dataToRemove?: {
+        [key: string]: any;
+    };
+    /**
+     * Data object that contains only additive information for ibGib's intrinsic data.
+     */
+    dataToAddOrPatch?: TNewData;
+    /**
+     * If given, will mut8 the ib (without forking the entire ibGib).
+     *
+     * Often this will act as a 'rename', e.g. (if the ib is acting as the 'name')
+     */
+    mut8Ib?: string;
+}
+export interface TransformOpts_Rel8<TSrc extends IbGib = IbGib> extends TransformOpts<TSrc> {
+    type?: 'rel8';
+    /**
+     * Relationships to add to an ibGib, either by creating new relationships or by
+     * concatenating the arrays to existing ones.
+     *
+     * NOTES:
+     *   - Moving relationships can be performed by combining add/remove rel8ns.
+     *   - How the relations are actually represented in the ibGib record is
+     *     left to the compiler. The same goes for how this information is
+     *     recorded in the dna, if generating dna.
+     */
+    rel8nsToAddByAddr?: IbGibRel8ns;
+    /**
+     * Relationships to remove from an ibGib.
+     *
+     * NOTES:
+     *   - Moving relationships can be performed by combining add/remove rel8ns.
+     *   - Attempting to remove a non-existing relationship may or may not cause
+     *     an error, depending on the compiler.
+     */
+    rel8nsToRemoveByAddr?: IbGibRel8ns;
+}
+export interface TransformResult<TOut extends IbGib> {
+    /**
+     * The final result of the transformation
+     */
+    newIbGib: TOut;
+    /**
+     * DNA side effects created in the transformation.
+     */
+    dnas?: TOut[];
+    /**
+     * If you're performing a transform with multiple steps,
+     * then there will be intermediate ibGibs created.
+     */
+    intermediateIbGibs?: TOut[];
+}
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +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"}

package/dist/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

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

package/jasmine-browser.json

@@ -0,0 +1,18 @@
+{
+  "srcDir": "dist",
+  "srcFiles": [
+    "**/*[!spec].mjs"
+  ],
+  "specDir": "dist",
+  "specFiles": [
+    "**/*.spec.mjs"
+  ],
+  "env": {
+    "stopSpecOnExpectationFailure": false,
+    "stopOnSpecFailure": false,
+    "random": true
+  },
+  "browser": {
+    "name": "firefox"
+  }
+}

package/jasmine.json

@@ -0,0 +1,6 @@
+{
+    "spec_dir": "dist",
+    "spec_files": [
+        "**/*.spec.mjs"
+    ]
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@ibgib/ts-gib",
+  "version": "0.4.9",
+  "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",
+    "type": "git"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://paypal.me/ibGib"
+  },
+  "main": "dist/index.mjs",
+  "scripts": {
+    "build": "npm run clean && tsc -b tsconfig.json --force",
+    "build:test": "npm run clean && tsc -b tsconfig.test.json --force",
+    "build:test:noclean": "tsc -b tsconfig.test.json --force",
+    "clean": "rm -rf ./dist",
+    "test": "npm run test:both",
+    "test:both": "npm run build:test && npm run test:node:nobuild && npm run test:browser:nobuild",
+    "man:test:both": "use this if you want to test in both node and browser contexts",
+    "test:node": "npm run build:test && npx jasmine --config=jasmine.json",
+    "man:test:node": "use this if you want to build+test in node",
+    "test:node:nobuild": "npx jasmine --config=jasmine.json",
+    "man:test:node:nobuild": "use this if you want to test in node but its already built",
+    "test:browser": "npm run build:test && npx jasmine-browser-runner runSpecs --config=jasmine-browser.json ",
+    "man:test:browser": "use this if you want to build+test only the browser context",
+    "test:browser:nobuild": "npx jasmine-browser-runner runSpecs --config=jasmine-browser.json ",
+    "man:test:browser:nobuild": "use this if you want to test only the browser context but its already built",
+    "test:browser:serve": "npm run build:test && npx jasmine-browser-runner serve --config=jasmine-browser.json ",
+    "man:test:browser:serve": "use this if you want to build+test in the browser and don't want the browser to close when your done. (i.e. you're debugging)",
+    "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": "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"
+  },
+  "type": "module",
+  "keywords": [
+    "ibgib",
+    "dlt",
+    "blockchain",
+    "graph-database"
+  ],
+  "author": "William Raiford",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jasmine": "^4.3.1",
+    "@types/node": "^16.11.6",
+    "jasmine": "^4.5.0",
+    "jasmine-browser-runner": "^1.3.0",
+    "jasmine-core": "^4.5.0",
+    "typescript": "^4.9.5"
+  },
+  "engines": {
+    "node": ">=19.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/V1/constants.mts

@@ -0,0 +1,23 @@
+import { IbGib_V1 } from './types.mjs';
+
+export const IB = 'ib';
+export const GIB = 'gib';
+export const ROOT: IbGib_V1 = { ib: IB, gib: GIB, }
+export const IBGIB_DELIMITER = '^';
+/**
+ * Gib is often just a single hash for a single ib^gib record.
+ * But if the ibgib has a tjp, which implies a timeline ("stream"
+ * in some senses), then we will include the tjp gib hash alongside the
+ * individual punctilear ibgib frame.
+ *
+ * ATOW this has the default schema of
+ *
+ * @example "comment abc^TJPHASH123", "comment abc^TJPHASH123.THISRECORDHASH456"
+ */
+export const GIB_DELIMITER = '.';
+export const ROOT_ADDR = 'ib^gib'; // `${IB}${IBGIB_DELIMITER}${GIB}`;
+
+/**
+ * Some rel8ns should not be able to be renamed or removed.
+ */
+export const FORBIDDEN_ADD_RENAME_REMOVE_REL8N_NAMES = ['past', 'ancestor', 'dna', 'tjp'];