@ibgib/core-gib 0.0.105 → 0.0.107

package/src/common/other/other-helper.web.mts

@@ -0,0 +1,184 @@
+import { extractErrorMsg } from "@ibgib/helper-gib/dist/helpers/utils-helper.mjs";
+
+import { GLOBAL_LOG_A_LOT } from "../../core-constants.mjs";
+import { FlatIbGibGraph } from "./graph-types.mjs";
+import { SerializedUint8Array } from "./other-types.mjs";
+
+const logalot = GLOBAL_LOG_A_LOT;
+
+/**
+ * @internal Helper to convert a Uint8Array to a Base64 string
+ * @param uint8Array @
+ * @returns Base64 string
+ */
+function uint8ArrayToBase64(uint8Array: Uint8Array): Promise<string> {
+    return new Promise((resolve, reject) => {
+        const blob = new Blob([uint8Array], { type: 'application/octet-stream' });
+        const reader = new FileReader();
+        reader.onload = () => {
+            const dataUrl = reader.result as string;
+            // The result is a data URL: "data:application/octet-stream;base64,..."
+            // We only want the Base64 part.
+            const base64String = dataUrl.split(',')[1];
+            resolve(base64String);
+        };
+        reader.onerror = (error) => reject(error);
+        reader.readAsDataURL(blob);
+    });
+}
+
+/**
+ * @internal Helper to convert a Base64 string back to a Uint8Array
+ * @param base64String to convert back to Uint8Array
+ * @returns Uint8Array
+ */
+async function base64ToUint8Array(base64String: string): Promise<Uint8Array> {
+    // Use the fetch API to decode the Base64 string.
+    // This is a modern and robust way to handle Base64 in the browser.
+    const dataUrl = `data:application/octet-stream;base64,${base64String}`;
+    const response = await fetch(dataUrl);
+    const blob = await response.blob();
+    const buffer = await blob.arrayBuffer();
+    return new Uint8Array(buffer);
+}
+
+/**
+ * Compresses an FlatIbGibGraph object into a Blob.
+ * @param graph The FlatIbGibGraph object to compress.
+ * @returns A Promise that resolves with the compressed Blob.
+ */
+export async function compressIbGib(graph: FlatIbGibGraph): Promise<Blob> {
+    // 1. Serialize: Create a JSON-safe representation of the graph
+    // We use a custom replacer to handle Uint8Array
+    // const replacer = (key: string, value: any) => {
+    //     if (value instanceof Uint8Array) {
+    //         // This part is async, so we can't use it directly in JSON.stringify.
+    //         // We must pre-process the object first.
+    //         throw new Error("Cannot use async replacer. Pre-process the object first.");
+    //     }
+    //     return value;
+    // };
+
+    // Pre-process the graph to handle async Base64 conversion
+    const serializableGraph = JSON.parse(JSON.stringify(graph)); // Deep clone to avoid mutation
+    for (const key in serializableGraph) {
+        if (graph[key].data instanceof Uint8Array) {
+            serializableGraph[key].data = {
+                _dataType: 'Uint8Array_Base64',
+                value: await uint8ArrayToBase64(graph[key].data as Uint8Array)
+            } as SerializedUint8Array;
+        }
+    }
+
+    // 2. Stringify: Convert the serializable object to a JSON string
+    const jsonString = JSON.stringify(serializableGraph);
+
+    // 3. Encode: Convert the string to a Uint8Array (UTF-8)
+    const dataToCompress = new TextEncoder().encode(jsonString);
+
+    // 4. Compress: Use the Compression Streams API
+    const stream = new Response(dataToCompress).body!;
+    const compressedStream = stream.pipeThrough(new CompressionStream('gzip'));
+
+    // Return the compressed data as a Blob
+    return await new Response(compressedStream).blob();
+}
+
+/**
+ * Decompresses a Blob back into an FlatIbGibGraph object.
+ * @param compressedBlob The Blob containing the compressed graph data.
+ * @returns A Promise that resolves with the original FlatIbGibGraph object.
+ */
+export async function decompressIbGib(compressedBlob: Blob): Promise<FlatIbGibGraph> {
+    // 1. Decompress: Use the Decompression Streams API
+    const decompressedStream = compressedBlob.stream().pipeThrough(
+        new DecompressionStream('gzip')
+    );
+
+    // 2. Decode: Convert the decompressed stream back to a string
+    const jsonString = await new Response(decompressedStream).text();
+
+    // 3. Deserialize: Parse the JSON with a reviver to restore Uint8Arrays
+    const reviver = (key: string, value: any) => {
+        if (value && value._dataType === 'Uint8Array_Base64') {
+            // This part is async, so we can't use it in JSON.parse.
+            // We must post-process the object.
+            return value; // Return the placeholder for now
+        }
+        return value;
+    };
+
+    const parsedGraph = JSON.parse(jsonString, reviver);
+
+    // Post-process to convert Base64 back to Uint8Array
+    for (const key in parsedGraph) {
+        const data = parsedGraph[key].data;
+        if (data && data._dataType === 'Uint8Array_Base64') {
+            parsedGraph[key].data = await base64ToUint8Array(data.value);
+        }
+    }
+
+    return parsedGraph as FlatIbGibGraph;
+}
+
+/**
+ * Compresses an FlatIbGibGraph object and returns a Base64 string representation.
+ * @param graph The FlatIbGibGraph object to compress.
+ * @returns A Promise that resolves with the compressed data as a Base64 string.
+ */
+export async function compressIbGibGraphToString({
+    graph
+}: {
+    graph: FlatIbGibGraph
+}): Promise<string> {
+    const lc = `[${compressIbGibGraphToString.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 1352f8540c08f0b725952df8f18c4825)`); }
+
+        // 1. Get the compressed data as a Blob first.
+        const compressedBlob = await compressIbGib(graph);
+
+        // 2. Convert the Blob's binary data to a Uint8Array.
+        const buffer = await compressedBlob.arrayBuffer();
+        const uint8Array = new Uint8Array(buffer);
+
+        // 3. Convert that Uint8Array to a Base64 string.
+        return await uint8ArrayToBase64(uint8Array);
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
+/**
+ * Decompresses a Base64 string back into an FlatIbGibGraph object.
+ * @param compressedBase64 The Base64 string containing the compressed graph data.
+ * @returns A Promise that resolves with the original FlatIbGibGraph object.
+ */
+export async function decompressIbGibGraphFromString({
+    compressedBase64,
+}: {
+    compressedBase64: string,
+}): Promise<FlatIbGibGraph> {
+    const lc = `[${decompressIbGibGraphFromString.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 5f3fa940a2c8f8d7b877978ae7f87825)`); }
+
+        // 1. Convert the Base64 string back to a Uint8Array.
+        const compressedUint8Array = await base64ToUint8Array(compressedBase64);
+
+        // 2. Create a Blob from the Uint8Array.
+        // The MIME type isn't strictly necessary for DecompressionStream but is good practice.
+        const compressedBlob = new Blob([compressedUint8Array], { type: 'application/gzip' });
+
+        // 3. Use our existing function to decompress the Blob.
+        return await decompressIbGib(compressedBlob);
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}

package/src/common/other/other-types.mts

@@ -185,3 +185,11 @@ export interface IbGibTimelineUpdateInfo extends IbGib_V1 {
     latestAddr: IbGibAddr;
     latestIbGib?: IbGib_V1<any>;
 }
+
+/**
+ * Serializing helper type for compressing dependency graphs.
+ */
+export type SerializedUint8Array = {
+    _dataType: 'Uint8Array_Base64';
+    value: string;
+};

package/dist/common/import-export/import-export-helper.d.mts

@@ -1,18 +0,0 @@
-import { Ib } from "@ibgib/ts-gib/dist/types.mjs";
-import { RawExportData_V1, RawExportIbInfo } from "./import-export-types.mjs";
-/**
- * builds the ib for a {@link RawExportIbGib_V1}
- */
-export declare function getRawExportIb({ data, }: {
-    data: RawExportData_V1;
-}): Ib;
-/**
- * space-delimited info contained in ib.
- *
- * atow (02/2024)
- *   `${RAW_EXPORT_ATOM} ${timestampInTicks} ${graphSize} ${graphStringLength}`
- */
-export declare function parseRawExportIb({ ib, }: {
-    ib: Ib;
-}): RawExportIbInfo;
-//# sourceMappingURL=import-export-helper.d.mts.map

package/dist/common/import-export/import-export-helper.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"import-export-helper.d.mts","sourceRoot":"","sources":["../../../src/common/import-export/import-export-helper.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,8BAA8B,CAAC;AAGlD,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAK9E;;GAEG;AACH,wBAAgB,cAAc,CAAC,EAC3B,IAAI,GACP,EAAE;IACC,IAAI,EAAE,gBAAgB,CAAC;CAC1B,GAAG,EAAE,CAcL;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAC7B,EAAE,GACL,EAAE;IACC,EAAE,EAAE,EAAE,CAAC;CACV,GAAG,eAAe,CAmBlB"}

package/dist/common/import-export/import-export-helper.mjs

@@ -1,65 +0,0 @@
-import { extractErrorMsg, getTimestampInTicks } from "@ibgib/helper-gib/dist/helpers/utils-helper.mjs";
-import { GLOBAL_LOG_A_LOT } from "../../core-constants.mjs";
-import { RAW_EXPORT_ATOM } from "./import-export-constants.mjs";
-const logalot = GLOBAL_LOG_A_LOT;
-/**
- * builds the ib for a {@link RawExportIbGib_V1}
- */
-export function getRawExportIb({ data, }) {
-    const lc = `[${getRawExportIb.name}]`;
-    try {
-        if (logalot) {
-            console.log(`${lc} starting... (I: 158dfaeb9613a1531be71a9735184624)`);
-        }
-        const { graphSize, dependencyGraphAsString, timestamp } = data;
-        const graphStringLength = dependencyGraphAsString.length;
-        const timestampInTicks = getTimestampInTicks(timestamp);
-        return `${RAW_EXPORT_ATOM} ${timestampInTicks} ${graphSize} ${graphStringLength}`;
-    }
-    catch (error) {
-        console.error(`${lc} ${extractErrorMsg(error)}`);
-        throw error;
-    }
-    finally {
-        if (logalot) {
-            console.log(`${lc} complete.`);
-        }
-    }
-}
-/**
- * space-delimited info contained in ib.
- *
- * atow (02/2024)
- *   `${RAW_EXPORT_ATOM} ${timestampInTicks} ${graphSize} ${graphStringLength}`
- */
-export function parseRawExportIb({ ib, }) {
-    const lc = `[${parseRawExportIb.name}]`;
-    try {
-        if (logalot) {
-            console.log(`${lc} starting... (I: 3297e51184f87a45d343d8654b165324)`);
-        }
-        const [atom, timestampInTicks, graphSizeStr, graphStringLengthStr] = ib.split(' ');
-        if (atom !== RAW_EXPORT_ATOM) {
-            throw new Error(`atom (${atom}) !== ${RAW_EXPORT_ATOM} (E: ad7545da5b8c4baeb15d86e92d657524)`);
-        }
-        const graphSize = Number.parseInt(graphSizeStr);
-        if (Number.isNaN(graphSize) || graphSize < 0) {
-            throw new Error(`graphSize (${graphSizeStr}) is not a positive integer. (E: 2b43d9d3462f6e16547b121bccef9b24)`);
-        }
-        const graphStringLength = Number.parseInt(graphStringLengthStr);
-        if (Number.isNaN(graphStringLength) || graphStringLength < 0) {
-            throw new Error(`graphStringLength (${graphStringLengthStr}) is not a positive integer. (E: 112ceccee1a54b19ab4f4662b6694ba0)`);
-        }
-        return { atom, timestampInTicks, graphSize, graphStringLength };
-    }
-    catch (error) {
-        console.error(`${lc} ${extractErrorMsg(error)}`);
-        throw error;
-    }
-    finally {
-        if (logalot) {
-            console.log(`${lc} complete.`);
-        }
-    }
-}
-//# sourceMappingURL=import-export-helper.mjs.map

package/dist/common/import-export/import-export-helper.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"import-export-helper.mjs","sourceRoot":"","sources":["../../../src/common/import-export/import-export-helper.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAGvG,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEjC;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,EAC3B,IAAI,GAGP;IACG,MAAM,EAAE,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC;IACtC,IAAI;QACA,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,oDAAoD,CAAC,CAAC;SAAE;QACxF,MAAM,EAAE,SAAS,EAAE,uBAAuB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC/D,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,MAAM,CAAC;QACzD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACxD,OAAO,GAAG,eAAe,IAAI,gBAAgB,IAAI,SAAS,IAAI,iBAAiB,EAAE,CAAC;KACrF;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,KAAK,CAAC;KACf;YAAS;QACN,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;SAAE;KACnD;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAC7B,EAAE,GAGL;IACG,MAAM,EAAE,GAAG,IAAI,gBAAgB,CAAC,IAAI,GAAG,CAAC;IACxC,IAAI;QACA,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,oDAAoD,CAAC,CAAC;SAAE;QACxF,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnF,IAAI,IAAI,KAAK,eAAe,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,SAAS,eAAe,wCAAwC,CAAC,CAAC;SAAE;QACjI,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,YAAY,oEAAoE,CAAC,CAAC;SAAE;QAElK,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;QAChE,IAAI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,oBAAoB,oEAAoE,CAAC,CAAC;SAAE;QAElM,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;KACnE;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,KAAK,CAAC;KACf;YAAS;QACN,IAAI,OAAO,EAAE;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;SAAE;KACnD;AACL,CAAC"}

package/src/common/import-export/import-export-helper.mts

@@ -1,62 +0,0 @@
-import { extractErrorMsg, getTimestampInTicks } from "@ibgib/helper-gib/dist/helpers/utils-helper.mjs";
-import { Ib } from "@ibgib/ts-gib/dist/types.mjs";
-
-import { GLOBAL_LOG_A_LOT } from "../../core-constants.mjs";
-import { RawExportData_V1, RawExportIbInfo } from "./import-export-types.mjs";
-import { RAW_EXPORT_ATOM } from "./import-export-constants.mjs";
-
-const logalot = GLOBAL_LOG_A_LOT;
-
-/**
- * builds the ib for a {@link RawExportIbGib_V1}
- */
-export function getRawExportIb({
-    data,
-}: {
-    data: RawExportData_V1,
-}): Ib {
-    const lc = `[${getRawExportIb.name}]`;
-    try {
-        if (logalot) { console.log(`${lc} starting... (I: 158dfaeb9613a1531be71a9735184624)`); }
-        const { graphSize, dependencyGraphAsString, timestamp } = data;
-        const graphStringLength = dependencyGraphAsString.length;
-        const timestampInTicks = getTimestampInTicks(timestamp);
-        return `${RAW_EXPORT_ATOM} ${timestampInTicks} ${graphSize} ${graphStringLength}`;
-    } catch (error) {
-        console.error(`${lc} ${extractErrorMsg(error)}`);
-        throw error;
-    } finally {
-        if (logalot) { console.log(`${lc} complete.`); }
-    }
-}
-
-/**
- * space-delimited info contained in ib.
- *
- * atow (02/2024)
- *   `${RAW_EXPORT_ATOM} ${timestampInTicks} ${graphSize} ${graphStringLength}`
- */
-export function parseRawExportIb({
-    ib,
-}: {
-    ib: Ib,
-}): RawExportIbInfo {
-    const lc = `[${parseRawExportIb.name}]`;
-    try {
-        if (logalot) { console.log(`${lc} starting... (I: 3297e51184f87a45d343d8654b165324)`); }
-        const [atom, timestampInTicks, graphSizeStr, graphStringLengthStr] = ib.split(' ');
-        if (atom !== RAW_EXPORT_ATOM) { throw new Error(`atom (${atom}) !== ${RAW_EXPORT_ATOM} (E: ad7545da5b8c4baeb15d86e92d657524)`); }
-        const graphSize = Number.parseInt(graphSizeStr);
-        if (Number.isNaN(graphSize) || graphSize < 0) { throw new Error(`graphSize (${graphSizeStr}) is not a positive integer. (E: 2b43d9d3462f6e16547b121bccef9b24)`); }
-
-        const graphStringLength = Number.parseInt(graphStringLengthStr);
-        if (Number.isNaN(graphStringLength) || graphStringLength < 0) { throw new Error(`graphStringLength (${graphStringLengthStr}) is not a positive integer. (E: 112ceccee1a54b19ab4f4662b6694ba0)`); }
-
-        return { atom, timestampInTicks, graphSize, graphStringLength };
-    } catch (error) {
-        console.error(`${lc} ${extractErrorMsg(error)}`);
-        throw error;
-    } finally {
-        if (logalot) { console.log(`${lc} complete.`); }
-    }
-}