@ibgib/core-gib 0.0.4

package/dist/witness/witness-form-builder.mjs

@@ -0,0 +1,95 @@
+import { GLOBAL_LOG_A_LOT } from '../core-constants.mjs';
+import { DynamicFormBuilder } from '../common/form/form-helper.mjs';
+const logalot = GLOBAL_LOG_A_LOT || false;
+/**
+ * Fluent-style builder helper class.
+ *
+ * I'm making this to share common fields' settings among witness classes.
+ *
+ * Descend from this class for sharing other commonalities.
+ */
+export class WitnessFormBuilder extends DynamicFormBuilder {
+    constructor() {
+        super(...arguments);
+        this.lc = `[${WitnessFormBuilder.name}]`;
+    }
+    allowPrimitiveArgs({ of, required = true, }) {
+        this.addItem({
+            // witness.data.allowPrimitiveArgs
+            name: "allowPrimitiveArgs",
+            description: `Technical setting on if this ${this.what} accepts primitive incoming ibgibs`,
+            label: "Allow Primitive Args",
+            dataType: 'toggle',
+            value: of ?? true,
+            readonly: true,
+            required,
+        });
+        return this;
+    }
+    catchAllErrors({ of, required = true, }) {
+        this.addItem({
+            // witness.data.catchAllErrors
+            name: "catchAllErrors",
+            description: `Technical setting on what the ${this.what} does when it encounters an internal error.`,
+            label: "Catch All Errors",
+            dataType: 'toggle',
+            value: of ?? true,
+            readonly: true,
+            required,
+        });
+        return this;
+    }
+    persistOptsAndResultIbGibs({ of, required = true, }) {
+        this.addItem({
+            // witness.data.persistOptsAndResultIbGibs
+            name: "persistOptsAndResultIbGibs",
+            description: `Technical setting on if the ${this.what} maintains an audit trail of all of its inputs/outputs.`,
+            label: "Persist Opts and Result IbGibs",
+            dataType: 'toggle',
+            value: of ?? false,
+            readonly: true,
+            required,
+        });
+        return this;
+    }
+    trace({ of, required, }) {
+        this.addItem({
+            // witness.data.trace
+            name: "trace",
+            description: `Technical setting on if the ${this.what}'s activity should be traced (logged to the console).`,
+            label: "Trace",
+            dataType: 'toggle',
+            value: of ?? false,
+            readonly: true,
+            required,
+        });
+        return this;
+    }
+    /**
+     * Includes common witness fields.
+     *
+     * All common fields default to `true`, so set any you want to skip to
+     * `false`.
+     *
+     * @returns `this` for fluent builder
+     */
+    commonWitnessFields({ data, allowPrimitiveArgs = true, catchAllErrors = true, persistOptsAndResultIbGibs = true, trace = true, version = true, }) {
+        if (allowPrimitiveArgs) {
+            this.allowPrimitiveArgs({ of: data.allowPrimitiveArgs });
+        }
+        if (catchAllErrors) {
+            this.catchAllErrors({ of: data.catchAllErrors });
+        }
+        if (persistOptsAndResultIbGibs) {
+            this.persistOptsAndResultIbGibs({ of: data.persistOptsAndResultIbGibs });
+        }
+        if (trace) {
+            this.trace({ of: data.trace });
+        }
+        if (version) {
+            this.version({ of: data.version });
+        }
+        return this;
+    }
+}
+//# sourceMappingURL=witness-form-builder.mjs.map

package/dist/witness/witness-form-builder.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"witness-form-builder.mjs","sourceRoot":"","sources":["../../src/witness/witness-form-builder.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE,MAAM,OAAO,GAAG,gBAAgB,IAAI,KAAK,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,OAAO,kBAAmB,SAAQ,kBAAkB;IAA1D;;QACc,OAAE,GAAW,IAAI,kBAAkB,CAAC,IAAI,GAAG,CAAC;IAiH1D,CAAC;IA/GG,kBAAkB,CAAC,EACf,EAAE,EACF,QAAQ,GAAG,IAAI,GAIlB;QACG,IAAI,CAAC,OAAO,CAAC;YACT,kCAAkC;YAClC,IAAI,EAAE,oBAAoB;YAC1B,WAAW,EAAE,gCAAgC,IAAI,CAAC,IAAI,oCAAoC;YAC1F,KAAK,EAAE,sBAAsB;YAC7B,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,EAAE,IAAI,IAAI;YACjB,QAAQ,EAAE,IAAI;YACd,QAAQ;SACX,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,cAAc,CAAC,EACX,EAAE,EACF,QAAQ,GAAG,IAAI,GAIlB;QACG,IAAI,CAAC,OAAO,CAAC;YACT,8BAA8B;YAC9B,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,iCAAiC,IAAI,CAAC,IAAI,6CAA6C;YACpG,KAAK,EAAE,kBAAkB;YACzB,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,EAAE,IAAI,IAAI;YACjB,QAAQ,EAAE,IAAI;YACd,QAAQ;SACX,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,0BAA0B,CAAC,EACvB,EAAE,EACF,QAAQ,GAAG,IAAI,GAIlB;QACG,IAAI,CAAC,OAAO,CAAC;YACT,0CAA0C;YAC1C,IAAI,EAAE,4BAA4B;YAClC,WAAW,EAAE,+BAA+B,IAAI,CAAC,IAAI,yDAAyD;YAC9G,KAAK,EAAE,gCAAgC;YACvC,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,EAAE,IAAI,KAAK;YAClB,QAAQ,EAAE,IAAI;YACd,QAAQ;SACX,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,EACF,EAAE,EACF,QAAQ,GAIX;QACG,IAAI,CAAC,OAAO,CAAC;YACT,qBAAqB;YACrB,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,+BAA+B,IAAI,CAAC,IAAI,uDAAuD;YAC5G,KAAK,EAAE,OAAO;YACd,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,EAAE,IAAI,KAAK;YAClB,QAAQ,EAAE,IAAI;YACd,QAAQ;SACX,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAChB,IAAI,EACJ,kBAAkB,GAAG,IAAI,EACzB,cAAc,GAAG,IAAI,EACrB,0BAA0B,GAAG,IAAI,EACjC,KAAK,GAAG,IAAI,EACZ,OAAO,GAAG,IAAI,GAQjB;QACG,IAAI,kBAAkB,EAAE;YAAE,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;SAAE;QACrF,IAAI,cAAc,EAAE;YAAE,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;SAAE;QACzE,IAAI,0BAA0B,EAAE;YAAE,IAAI,CAAC,0BAA0B,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC;SAAE;QAC7G,IAAI,KAAK,EAAE;YAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;SAAE;QAC9C,IAAI,OAAO,EAAE;YAAE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;SAAE;QACpD,OAAO,IAAI,CAAC;IAChB,CAAC;CAEJ"}

package/dist/witness/witness-helper.d.mts

@@ -0,0 +1,89 @@
+import { Ib } from '@ibgib/ts-gib';
+import { IbGib_V1, IbGibRel8ns_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+/**
+ * Builds the ib for the witness arg ibgib.
+ *
+ * @returns ib that we'll use when creating a witness arg.
+ */
+export declare function getArgIb(ibMetadata: string | undefined): string;
+/**
+ * helper function that checks if an incoming `ib` or `ibGib.ib` indicates that
+ * it is an arg ibGib used with witnesses.
+ *
+ * ## notes
+ * * atow, this basically just checks to see if it starts with
+ *   `WITNESS_ARG_METADATA_STRING` (`witness_arg`).
+ *
+ * @throws if neither `ib` nor `ibGib` are provided.
+ *
+ * @returns true if the ib/ibGib.ib indicates an arg ibgib, else false
+ *
+ * @see {@link argy_}
+ */
+export declare function isArg({ ib, ibGib, }: {
+    ib?: Ib;
+    ibGib?: IbGib_V1;
+}): boolean;
+/**
+ * Builds the ib for the witness result ibgib.
+ *
+ * @returns ib that we'll use when creating a witness result.
+ */
+export declare function getResultIb(ibMetadata: string | undefined): string;
+/**
+ * helper function that checks if an incoming `ib` or `ibGib.ib` indicates that
+ * it is a result ibGib used with witnesses.
+ *
+ * ## notes
+ * * atow, this basically just checks to see if it starts with
+ *   `WITNESS_ARG_METADATA_STRING` (`witness_arg`).
+ *
+ * @throws if neither `ib` nor `ibGib` are provided.
+ *
+ * @returns true if the ib/ibGib.ib indicates a result ibgib, else false
+ *
+ * @see {@link resulty_}
+ */
+export declare function isResult({ ib, ibGib, }: {
+    ib?: Ib;
+    ibGib?: IbGib_V1;
+}): boolean;
+/**
+ * This builds the arg ibGib for a witness function.
+ *
+ * By default, this is considered a one-off ibGib. As such,
+ * there is no dna and no uuid. The timestamp will be included, which
+ * adds some metadata (and makes for a most-often unique tjp). If there
+ * is something that needs to reference this result, it can use the
+ * the ibgib's address.
+ *
+ * @returns Result (wrapper) ibGib for a `witness` function.
+ */
+export declare function argy_<TArgData, TArgRel8ns extends IbGibRel8ns_V1, TArgIbGib extends IbGib_V1<TArgData, TArgRel8ns> = IbGib_V1<TArgData, TArgRel8ns>>({ argData, ibMetadata, noTimestamp, }: {
+    argData: TArgData;
+    ibMetadata?: string;
+    noTimestamp?: boolean;
+}): Promise<TArgIbGib>;
+/**
+ * This builds the result ibGib for a witness function.
+ *
+ * By default, the result is considered a one-off ibGib. As such,
+ * there is no dna and no uuid. The timestamp will be included, which
+ * adds some metadata (and makes for a most-often unique tjp). If there
+ * is something that needs to reference this result, it can use the
+ * the ibgib's address.
+ *
+ * @returns Result (wrapper) ibGib for a `witness` function.
+ */
+export declare function resulty_<TResultData, TResultIbGib extends IbGib_V1<TResultData> = IbGib_V1<TResultData>>({ resultData, ibMetadata, noTimestamp, }: {
+    resultData: TResultData;
+    ibMetadata?: string;
+    noTimestamp?: boolean;
+}): Promise<TResultIbGib>;
+/**
+ * If valid, returns null.
+ */
+export declare function validateWitnessClassname({ classname, }: {
+    classname: string;
+}): string | null;
+//# sourceMappingURL=witness-helper.d.mts.map

package/dist/witness/witness-helper.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"witness-helper.d.mts","sourceRoot":"","sources":["../../src/witness/witness-helper.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AACnC,OAAO,EACH,QAAQ,EAAE,cAAc,EAC3B,MAAM,iCAAiC,CAAC;AAQzC;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAY/D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CAAC,EAClB,EAAE,EACF,KAAK,GACR,EAAE;IACC,EAAE,CAAC,EAAE,EAAE,CAAC;IACR,KAAK,CAAC,EAAE,QAAQ,CAAC;CACpB,GAAG,OAAO,CAoBV;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAYlE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,EACrB,EAAE,EACF,KAAK,GACR,EAAE;IACC,EAAE,CAAC,EAAE,EAAE,CAAC;IACR,KAAK,CAAC,EAAE,QAAQ,CAAC;CACpB,GAAG,OAAO,CAoBV;AACD;;;;;;;;;;GAUG;AACH,wBAAsB,KAAK,CACvB,QAAQ,EACR,UAAU,SAAS,cAAc,EACjC,SAAS,SAAS,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAC9C,GAAG,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAChC,OAAO,EACP,UAAU,EACV,WAAW,GACd,EAAE;IACC,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,GAAG,OAAO,CAAC,SAAS,CAAC,CA0BzB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,CAAC,WAAW,EAAE,YAAY,SAAS,QAAQ,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,EAAE,EAC5G,UAAU,EACV,UAAU,EACV,WAAW,GACd,EAAE;IACC,UAAU,EAAE,WAAW,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,GAAG,OAAO,CAAC,YAAY,CAAC,CA0BxB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,EACrC,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,MAAM,CAAC;CACrB,GAAG,MAAM,GAAG,IAAI,CAiBhB"}

package/dist/witness/witness-helper.mjs

@@ -0,0 +1,229 @@
+import { CLASSNAME_REGEXP } from '@ibgib/helper-gib';
+import { Factory_V1 as factory, sha256v1, } from '@ibgib/ts-gib/dist/V1/index.mjs';
+import { GLOBAL_LOG_A_LOT } from '../core-constants.mjs';
+import { WITNESS_ARG_METADATA_STRING, WITNESS_RESULT_METADATA_STRING } from './witness-constants.mjs';
+const logalot = GLOBAL_LOG_A_LOT || false;
+/**
+ * Builds the ib for the witness arg ibgib.
+ *
+ * @returns ib that we'll use when creating a witness arg.
+ */
+export function getArgIb(ibMetadata) {
+    const lc = `[${getArgIb.name}]`;
+    try {
+        const ib = ibMetadata ?
+            `${WITNESS_ARG_METADATA_STRING} ${ibMetadata}` :
+            WITNESS_ARG_METADATA_STRING;
+        if (logalot) {
+            console.log(`${lc} ${ib}`);
+        }
+        return ib;
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+/**
+ * helper function that checks if an incoming `ib` or `ibGib.ib` indicates that
+ * it is an arg ibGib used with witnesses.
+ *
+ * ## notes
+ * * atow, this basically just checks to see if it starts with
+ *   `WITNESS_ARG_METADATA_STRING` (`witness_arg`).
+ *
+ * @throws if neither `ib` nor `ibGib` are provided.
+ *
+ * @returns true if the ib/ibGib.ib indicates an arg ibgib, else false
+ *
+ * @see {@link argy_}
+ */
+export function isArg({ ib, ibGib, }) {
+    const lc = `[${isArg.name}]`;
+    try {
+        if (logalot) {
+            console.log(`${lc} starting...`);
+        }
+        if (!ib) {
+            if (ibGib) {
+                ib = ibGib.ib;
+            }
+            else {
+                throw new Error(`either ib or ibGib required (E: c052a9d76df867626f9ba17141cdce22)`);
+            }
+        }
+        return ib.startsWith(WITNESS_ARG_METADATA_STRING);
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+    finally {
+        if (logalot) {
+            console.log(`${lc} complete.`);
+        }
+    }
+}
+/**
+ * Builds the ib for the witness result ibgib.
+ *
+ * @returns ib that we'll use when creating a witness result.
+ */
+export function getResultIb(ibMetadata) {
+    const lc = `[${getResultIb.name}]`;
+    try {
+        const ib = ibMetadata ?
+            `${WITNESS_RESULT_METADATA_STRING} ${ibMetadata}` :
+            WITNESS_RESULT_METADATA_STRING;
+        if (logalot) {
+            console.log(`${lc} ${ib}`);
+        }
+        return ib;
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+/**
+ * helper function that checks if an incoming `ib` or `ibGib.ib` indicates that
+ * it is a result ibGib used with witnesses.
+ *
+ * ## notes
+ * * atow, this basically just checks to see if it starts with
+ *   `WITNESS_ARG_METADATA_STRING` (`witness_arg`).
+ *
+ * @throws if neither `ib` nor `ibGib` are provided.
+ *
+ * @returns true if the ib/ibGib.ib indicates a result ibgib, else false
+ *
+ * @see {@link resulty_}
+ */
+export function isResult({ ib, ibGib, }) {
+    const lc = `[${isResult.name}]`;
+    try {
+        if (logalot) {
+            console.log(`${lc} starting...`);
+        }
+        if (!ib) {
+            if (ibGib) {
+                ib = ibGib.ib;
+            }
+            else {
+                throw new Error(`either ib or ibGib required (E: 7d32a54825764d8ea72a8a38cac14224)`);
+            }
+        }
+        return ib.startsWith(WITNESS_RESULT_METADATA_STRING);
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+    finally {
+        if (logalot) {
+            console.log(`${lc} complete.`);
+        }
+    }
+}
+/**
+ * This builds the arg ibGib for a witness function.
+ *
+ * By default, this is considered a one-off ibGib. As such,
+ * there is no dna and no uuid. The timestamp will be included, which
+ * adds some metadata (and makes for a most-often unique tjp). If there
+ * is something that needs to reference this result, it can use the
+ * the ibgib's address.
+ *
+ * @returns Result (wrapper) ibGib for a `witness` function.
+ */
+export async function argy_({ argData, ibMetadata, noTimestamp, }) {
+    const lc = `[${argy_.name}]`;
+    try {
+        const resArgIbGib = await factory.firstGen({
+            ib: getArgIb(ibMetadata),
+            parentIbGib: factory.primitive({ ib: WITNESS_ARG_METADATA_STRING }),
+            data: argData,
+            dna: false,
+            noTimestamp,
+        });
+        if (resArgIbGib.newIbGib) {
+            const { newIbGib: resultIbGib } = resArgIbGib;
+            // clear out past, disregard any intermediate ibgibs.
+            resultIbGib.rel8ns.past = [];
+            resultIbGib.gib = await sha256v1(resultIbGib);
+            return resultIbGib;
+        }
+        else {
+            throw new Error(`create ibGib failed`);
+        }
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+/**
+ * This builds the result ibGib for a witness function.
+ *
+ * By default, the result is considered a one-off ibGib. As such,
+ * there is no dna and no uuid. The timestamp will be included, which
+ * adds some metadata (and makes for a most-often unique tjp). If there
+ * is something that needs to reference this result, it can use the
+ * the ibgib's address.
+ *
+ * @returns Result (wrapper) ibGib for a `witness` function.
+ */
+export async function resulty_({ resultData, ibMetadata, noTimestamp, }) {
+    const lc = `[${resulty_.name}]`;
+    try {
+        const resResultIbGib = await factory.firstGen({
+            ib: getResultIb(ibMetadata),
+            parentIbGib: factory.primitive({ ib: WITNESS_RESULT_METADATA_STRING }),
+            data: resultData,
+            dna: false,
+            noTimestamp,
+        });
+        if (resResultIbGib?.newIbGib) {
+            const { newIbGib: resultIbGib } = resResultIbGib;
+            // clear out past, disregard any intermediate ibgibs.
+            resultIbGib.rel8ns.past = [];
+            resultIbGib.gib = await sha256v1(resultIbGib);
+            return resultIbGib;
+        }
+        else {
+            throw new Error(`create ibGib failed`);
+        }
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+/**
+ * If valid, returns null.
+ */
+export function validateWitnessClassname({ classname, }) {
+    const lc = `[${validateWitnessClassname.name}]`;
+    try {
+        if (logalot) {
+            console.log(`${lc} starting...`);
+        }
+        if (!classname) {
+            throw new Error(`classname required (E: b1c7b455d58fdd8d77acd15bdf017722)`);
+        }
+        if (!classname.match(CLASSNAME_REGEXP)) {
+            return `classname (${classname}) must match regex ${CLASSNAME_REGEXP}`;
+        }
+        return null;
+    }
+    catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+    finally {
+        if (logalot) {
+            console.log(`${lc} complete.`);
+        }
+    }
+}
+//# sourceMappingURL=witness-helper.mjs.map

package/dist/witness/witness-helper.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"witness-helper.mjs","sourceRoot":"","sources":["../../src/witness/witness-helper.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EACuB,UAAU,IAAI,OAAO,EAAE,QAAQ,GAC5D,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AAGtG,MAAM,OAAO,GAAG,gBAAgB,IAAI,KAAK,CAAC;AAE1C;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,UAA8B;IACnD,MAAM,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC;IAChC,IAAI;QACA,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;YACnB,GAAG,2BAA2B,IAAI,UAAU,EAAE,CAAC,CAAC;YAChD,2BAA2B,CAAC;QAChC,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;SAAE;QAC5C,OAAO,EAAE,CAAC;KACb;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,KAAK,CAAC,EAClB,EAAE,EACF,KAAK,GAIR;IACG,MAAM,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC;IAC7B,IAAI;QACA,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;SAAE;QAElD,IAAI,CAAC,EAAE,EAAE;YACL,IAAI,KAAK,EAAE;gBACP,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;aACjB;iBAAM;gBACH,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;aACxF;SACJ;QAED,OAAO,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;KACrD;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;YAAS;QACN,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;SAAE;KACnD;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,UAA8B;IACtD,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC;IACnC,IAAI;QACA,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;YACnB,GAAG,8BAA8B,IAAI,UAAU,EAAE,CAAC,CAAC;YACnD,8BAA8B,CAAC;QACnC,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;SAAE;QAC5C,OAAO,EAAE,CAAC;KACb;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,QAAQ,CAAC,EACrB,EAAE,EACF,KAAK,GAIR;IACG,MAAM,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC;IAChC,IAAI;QACA,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;SAAE;QAElD,IAAI,CAAC,EAAE,EAAE;YACL,IAAI,KAAK,EAAE;gBACP,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;aACjB;iBAAM;gBACH,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;aACxF;SACJ;QAED,OAAO,EAAE,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;KACxD;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;YAAS;QACN,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;SAAE;KACnD;AACL,CAAC;AACD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAIa,EAChC,OAAO,EACP,UAAU,EACV,WAAW,GAKd;IACD,MAAM,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC;IAC7B,IAAI;QACA,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAW;YACjD,EAAE,EAAE,QAAQ,CAAC,UAAU,CAAC;YACxB,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,2BAA2B,EAAE,CAAC;YACnE,IAAI,EAAE,OAAO;YACb,GAAG,EAAE,KAAK;YACV,WAAW;SACd,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,QAAQ,EAAE;YACtB,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;YAE9C,qDAAqD;YACrD,WAAW,CAAC,MAAO,CAAC,IAAI,GAAG,EAAE,CAAC;YAE9B,WAAW,CAAC,GAAG,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;YAE9C,OAAQ,WAAyB,CAAC;SACrC;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;KACJ;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAkF,EAC5G,UAAU,EACV,UAAU,EACV,WAAW,GAKd;IACG,MAAM,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC;IAChC,IAAI;QACA,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAc;YACvD,EAAE,EAAE,WAAW,CAAC,UAAU,CAAC;YAC3B,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,8BAA8B,EAAE,CAAC;YACtE,IAAI,EAAE,UAAU;YAChB,GAAG,EAAE,KAAK;YACV,WAAW;SACd,CAAC,CAAC;QACH,IAAI,cAAc,EAAE,QAAQ,EAAE;YAC1B,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC;YAEjD,qDAAqD;YACrD,WAAW,CAAC,MAAO,CAAC,IAAI,GAAG,EAAE,CAAC;YAE9B,WAAW,CAAC,GAAG,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;YAE9C,OAAO,WAA2B,CAAC;SACtC;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;KACJ;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,EACrC,SAAS,GAGZ;IACG,MAAM,EAAE,GAAG,IAAI,wBAAwB,CAAC,IAAI,GAAG,CAAC;IAChD,IAAI;QACA,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;SAAE;QAClD,IAAI,CAAC,SAAS,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;SAAE;QAEhG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;YACpC,OAAO,cAAc,SAAS,sBAAsB,gBAAgB,EAAE,CAAC;SAC1E;QAED,OAAO,IAAI,CAAC;KACf;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC;KACf;YAAS;QACN,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;SAAE;KACnD;AACL,CAAC"}

package/dist/witness/witness-types.d.mts

@@ -0,0 +1,211 @@
+import { IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+import { IbGib, IbGibWithDataAndRel8ns, IbGibRel8ns, IbGibAddr } from '@ibgib/ts-gib';
+import { ErrorIbGib_V1 } from '../common/error/error-types.mjs';
+/**
+ * A witness is a lot like an ibGib analog for a function.
+ * Now remember in FP, a function takes a single arg, and
+ * multiple args are actually reified single-arg functions
+ * that are curried.
+ *
+ * So an ibGib witness is an ibGib that has a single function: `witness`.
+ * What can it witness? Another ibGib. What does it return? An ibGib.
+ *
+ * ## notes
+ *
+ * I'm not smart enough to descend this from just IbGib, so I'm doing
+ * IbGibwithDataAndRel8ns. This is more of a convenience anyway.
+ */
+export interface Witness<TIbGibIn extends IbGib, TIbGibOut extends IbGib, TData = any, TRel8ns extends IbGibRel8ns = IbGibRel8ns> extends IbGibWithDataAndRel8ns<TData, TRel8ns> {
+    witness(arg: TIbGibIn): Promise<TIbGibOut | undefined>;
+}
+/**
+ * Data that corresponds to all witnesses being implemented in V1.
+ *
+ * This should be expanded only sparingly, and all properties should be optional.
+ */
+export interface WitnessData_V1 {
+    /**
+     * @optional string for tracking version control of witness.
+     */
+    version?: string;
+    /**
+     * @optional Name for the witness.
+     */
+    name?: string;
+    /**
+     * @optional classname of the witness.
+     */
+    classname?: string;
+    /**
+     * @optional description of the witness.
+     */
+    description?: string;
+    /**
+     * @optional
+     *
+     * If true, then this will allow primitive args when validating incoming
+     * args.
+     *
+     * so if you want a witness to be able to witness, e.g., "16816^gib", then
+     * set this to truthy. Otherwise, this will flag this as a validation error.
+     */
+    allowPrimitiveArgs?: boolean;
+    /**
+     * If true, any calls to `witness` should have the opt and result ibGibs
+     * persisted, regardless of what the actual opt/result is. This is
+     * ultimately up to the witness itself though.
+     *
+     * This is like providing a persistent logging feature for the witness
+     * itself, as opposed to ephemeral logging via {@link trace}.
+     *
+     * ## implementation
+     *
+     * In the case of V1, WitnessBase_V1<...> has an empty function
+     */
+    persistOptsAndResultIbGibs?: boolean;
+    /**
+     * @optional
+     *
+     * "Should" be a unique identifier for the witness.
+     */
+    uuid?: string;
+    /**
+     * @optional configuration for `witness` call.
+     *
+     * If true, then this space will not catch an error in `witnessImpl`
+     * function.
+     *
+     * ## notes
+     *
+     * Descendants of Witness who don't override the base `witness` function
+     * (but rather override `witnessImpl` as expected) don't need to check
+     * for this explicitly, since it is referenced in the base `witness`
+     * function implementation.
+     */
+    catchAllErrors?: boolean;
+    /**
+     * @optional arg for verbose logging.
+     *
+     * Space implementations can check this value directly, or if
+     * they descend from `WitnessBase`, then there is a property
+     * that safely navigates this value.
+     */
+    trace?: boolean;
+}
+/**
+ * marker interface atm
+ */
+export interface WitnessRel8ns_V1 extends IbGibRel8ns_V1 {
+}
+/**
+ * This interface simply types our data and rel8ns to V1 style.
+ */
+export interface Witness_V1<TDataIn extends any, TRel8nsIn extends IbGibRel8ns_V1, TIbGibIn extends IbGib_V1<TDataIn, TRel8nsIn>, TDataOut extends any, TRel8nsOut extends IbGibRel8ns_V1, TIbGibOut extends IbGib_V1<TDataOut, TRel8nsOut> | ErrorIbGib_V1, TData extends WitnessData_V1 = any, TRel8ns extends WitnessRel8ns_V1 = WitnessRel8ns_V1> extends Witness<TIbGibIn, TIbGibOut, TData, TRel8ns> {
+}
+/**
+ * Base information for cmd with optional modifiers to interact with a witness.
+ *
+ * Note that it is not necessary for a witness to listen to these types of
+ * ibgibs, this is just convenient plumbing for those who wish to listen to
+ * command-style ibgibs.
+ */
+export interface WitnessCmdData<TCmds, TCmdModifiers> {
+    /**
+     * Not really in use atm, but will use in the future.
+     */
+    version?: string;
+    /**
+     * The `cmd` property is the name of the command, analogous to a function
+     * name.
+     */
+    cmd: TCmds | string;
+    /**
+     * Optional modifier flag(s) to the command.
+     *
+     * ## notes
+     *
+     * An implementing class can always use/extend these or extend the interface
+     * of the options data.
+     */
+    cmdModifiers?: (TCmdModifiers | string)[];
+    /**
+     * Addrs of ibgibs to get/delete
+     */
+    ibGibAddrs?: IbGibAddr[];
+}
+export interface WitnessCmdRel8ns extends IbGibRel8ns_V1 {
+}
+export interface WitnessCmdIbGib<TIbGib extends IbGib, TCmds, TCmdModifiers, TCmdData extends WitnessCmdData<TCmds, TCmdModifiers>, TCmdRel8ns extends WitnessCmdRel8ns> extends IbGib_V1<TCmdData, TCmdRel8ns> {
+    /**
+     * When putting ibGibs, we don't want to persist the entire graph in the
+     * data object. So these ibGibs live on the ibGib arg object itself.
+     *
+     * If only ibGibs are passed in, and not their corresponding ibGibAddrs in
+     * the `TOptsData`, then you can't confirm cryptographically if the ibGibs
+     * are legit.  But if you include their corresponding ibGibAddrs in that
+     * data, then the space can confirm that the ibGibs have not been altered
+     * from the expected cryptographic audit trail.
+     *
+     * This doesn't mean that the ibGibs are kosher completely, but at least
+     * there is internal agreement and an audit trail.
+     *
+     * ## example
+     *
+     * For an example, check out sync space saga
+     */
+    ibGibs?: TIbGib[];
+}
+export interface WitnessResultData {
+    /**
+     * The address of the options ibGib that corresponds this space result.
+     *
+     * So if you called `space.witness(opts)` which produced this result, this is
+     * `getIbGibAddr({ibGib: opts})`.
+     *
+     * Perhaps I should have this as a rel8n on the actual result ibGib instead of here
+     * in the data.
+     */
+    optsAddr: IbGibAddr;
+    /**
+     * true if the operation executed successfully.
+     *
+     * If this is a `canGet` or `canPut` `cmd`, this does NOT indicate if you
+     * can or can't. For that, see the `can` property of this interface.
+     */
+    success?: boolean;
+    /**
+     * Any error messages go here. If this is populated, then the `success`
+     * *should* be false (but obvious the interface can't guarantee implementation).
+     */
+    errors?: string[];
+    /**
+     * Any warnings that don't cause this operation to explicitly fail, i.e. `errors`
+     * is falsy/empty.
+     */
+    warnings?: string[];
+    /**
+     * If getting address(es), they will be here.
+     */
+    addrs?: IbGibAddr[];
+    /**
+     * Addresses for ibGibs which had errors.
+     */
+    addrsErrored?: IbGibAddr[];
+}
+export interface WitnessResultRel8ns extends IbGibRel8ns_V1 {
+}
+/**
+ * Optional witness result ibgib interface.
+ *
+ * You do NOT have to use this class when returning results for witness ibgibs.
+ * This is provided as convenience plumbing for when you do want a standard-ish
+ * special result ibgib.
+ */
+export interface WitnessResultIbGib<TIbGib extends IbGib, TResultData extends WitnessResultData, TResultRel8ns extends WitnessResultRel8ns> extends IbGibWithDataAndRel8ns<TResultData, TResultRel8ns> {
+    /**
+     * When expecting ibGibs back, we don't want to persist the graph. So this property of
+     * ibGibs lives on the ibGib result object, but not in the `data` property.
+     */
+    ibGibs?: TIbGib[];
+}
+//# sourceMappingURL=witness-types.d.mts.map

package/dist/witness/witness-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"witness-types.d.mts","sourceRoot":"","sources":["../../src/witness/witness-types.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,OAAO,CACpB,QAAQ,SAAS,KAAK,EACtB,SAAS,SAAS,KAAK,EACvB,KAAK,GAAG,GAAG,EACX,OAAO,SAAS,WAAW,GAAG,WAAW,CAEzC,SAAQ,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC;IAC9C,OAAO,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;CAC1D;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAEvD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CACvB,OAAO,SAAS,GAAG,EACnB,SAAS,SAAS,cAAc,EAChC,QAAQ,SAAS,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,EAC7C,QAAQ,SAAS,GAAG,EACpB,UAAU,SAAS,cAAc,EACjC,SAAS,SAAS,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,aAAa,EAChE,KAAK,SAAS,cAAc,GAAG,GAAG,EAClC,OAAO,SAAS,gBAAgB,GAAG,gBAAgB,CAEnD,SAAQ,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;CACvD;AAGD;;;;;;GAMG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,EAAE,aAAa;IAChD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,GAAG,EAAE,KAAK,GAAG,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,CAAC;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CACvD;AAED,MAAM,WAAW,eAAe,CAC5B,MAAM,SAAS,KAAK,EACpB,KAAK,EAAE,aAAa,EACpB,QAAQ,SAAS,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,EACrD,UAAU,SAAS,gBAAgB,CACrC,SAAQ,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAGD,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;OAQG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAoB,SAAQ,cAAc;CAAI;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB,CAC/B,MAAM,SAAS,KAAK,EACpB,WAAW,SAAS,iBAAiB,EACrC,aAAa,SAAS,mBAAmB,CAEzC,SAAQ,sBAAsB,CAAC,WAAW,EAAE,aAAa,CAAC;IAE1D;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB"}

package/dist/witness/witness-types.mjs

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

package/dist/witness/witness-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"witness-types.mjs","sourceRoot":"","sources":["../../src/witness/witness-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": "headlessChrome"
+  }
+}

package/jasmine.json

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