@ibgib/core-gib 0.0.4

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

@@ -0,0 +1,76 @@
+/**
+ * @module
+ *
+ * not quite sure where these go.
+ *
+ * todo: check after the project is building where these other-constants fit.
+ */
+
+/**
+ * default id settings where...?
+ */
+export const DEFAULT_UUID = undefined;
+
+import { ROBBOT_REL8N_NAME } from '../../witness/robbot/robbot-constants.mjs';
+import { SYNC_SPACE_REL8N_NAME } from '../../witness/space/space-constants.mjs';
+import { DEFAULT_ROOT_REL8N_NAME, ROOT_REL8N_NAME } from '../root/root-constants.mjs';
+import { TAGGED_REL8N_NAME, TAG_REL8N_NAME } from '../tag/tag-constants.mjs';
+
+
+export const CONSENSUS_REL8N_NAME = 'consensus';
+export const CONSENSUS_ADDR_SYNC_NAIVE_PUT_MERGE = 'sync naive put merge^gib'
+
+export const AUTOSYNC_ALWAYS_REL8N_NAME = 'always';
+export const ARCHIVE_REL8N_NAME = 'archive';
+export const TRASH_REL8N_NAME = 'trash';
+
+/**
+ * These rel8n names are shown in a list view by default.
+ *
+ * This should perhaps go into a chat or common ux constants?
+ */
+export const DEFAULT_LIST_REL8N_NAMES: string[] = [
+    'pic', 'comment', 'link',
+    'result', 'import',
+    'tagged',
+    TAGGED_REL8N_NAME,
+    TAG_REL8N_NAME,
+    ROOT_REL8N_NAME, // hack for now to get all to show
+    DEFAULT_ROOT_REL8N_NAME,
+    ROBBOT_REL8N_NAME,
+    SYNC_SPACE_REL8N_NAME,
+];
+
+/**
+ *
+ */
+export const CURRENT_VERSION = '1';
+
+/**
+ * List of common special chars for english.
+ *
+ * ## intent
+ *
+ * When sanitizing input.
+ */
+export const ALLISH_SPECIAL_CHARS = `\`~!@#$%^&*()_\\-+=|\\\\\\]}[{"':;?/>.<,`;
+export const FILENAME_SPECIAL_CHARS = ` \`~!@#$%&*()_\\-+=|\\]}[{"';?>.<,`;
+
+/**
+ * If this matches, then we will encode the data field in our storage (aws
+ * anyway atow)
+ */
+export const IBGIB_DATA_REGEX_INDICATES_NEED_TO_ENCODE = /[^\w\s\d`~!@#$%\^&*()_\\\-+=|\]\}\[\{"':;?/>.<,]/;
+
+/**
+ * hacky scroll to bottom after items load per platform
+ */
+export const DEFAULT_SCROLL_DELAY_MS_WEB_HACK = 5_000;
+/**
+ * hacky scroll to bottom after items load per platform
+ */
+export const DEFAULT_SCROLL_DELAY_MS_ANDROID_HACK = 3_000;
+/**
+ * hacky scroll to bottom after items load per platform
+ */
+export const DEFAULT_SCROLL_DELAY_MS_IOS_HACK = 2_000;

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

@@ -0,0 +1,186 @@
+// #region from common/types/legacy.ts
+
+// todo: clean up legacy get/put functions
+// I started ionic-gib without a clear architectural design, so this is "legacy"
+// with respect to that. I had several functions that used these types, and I
+// left them as-is at the time. after this refactor, this needs to be cleaned
+// up. Perhaps this goes in capacitor-gib even?
+
+import { IbGibAddr } from '@ibgib/ts-gib';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+import { IbGibSpaceAny } from '../../witness/space/space-base-v1.mjs';
+
+export interface FileResult {
+    success?: boolean;
+    /**
+     * If errored, this will contain the errorMsg.
+     */
+    errorMsg?: string;
+    /**
+     * True if failed due to timing out.
+     */
+    timedOut?: boolean;
+}
+
+/**
+ * Options for retrieving data from the file system.
+ */
+export interface GetIbGibOpts {
+    /**
+     * If getting ibGib object, this is its address.
+     */
+    addr?: IbGibAddr;
+    /**
+     * If getting multiple ibGibs, use this array of addrs.
+     */
+    addrs?: IbGibAddr[];
+    /**
+     * If truthy, will look in the meta subpath first, then the regular if not found.
+     */
+    isMeta?: boolean;
+    /**
+     * Are we looking for a DNA ibgib?
+     */
+    isDna?: boolean;
+    /**
+     * space from which to get the ibgib
+     *
+     * @default localUserSpace
+     */
+    space?: IbGibSpaceAny,
+    /**
+     * If supplied, first acquires the lock with this scope on the
+     * given `space` (which defaults to localUserSpace).
+     */
+    lockScope?: string,
+    /**
+     * Cancels if can't acquire lock after approximately this time.
+     */
+    lockTimeoutMs?: number,
+    /**
+     * If true, will not get from cache and will force retrieval from the real
+     * bucket. In Ionic space, this means will look in ionic storage proper.
+     */
+    force?: boolean;
+}
+
+/**
+ * Result for retrieving an ibGib from the file system.
+ */
+export interface GetIbGibResult extends FileResult {
+    /**
+     * ibGibs if retrieving a "regular" ibGib.
+     *
+     * This is used when you're not getting a pic, e.g.
+     */
+    ibGibs?: IbGib_V1[];
+    /**
+     * This is used when you're getting a pic's binary content.
+     */
+    // binData?: any;
+    /**
+     * access to raw result ibgib that caller must cast to the correct shape.
+     */
+    rawResultIbGib?: IbGib_V1;
+}
+
+export interface PutIbGibOpts {
+    /**
+     * ibGib to put.
+     *
+     * If you only want to do just one, use this param. Otherwise, use the
+     * `ibGibs` array param.
+     */
+    ibGib?: IbGib_V1;
+    /**
+     * ibGibs to put in the space.
+     *
+     * If you want to put more than one ibGib, use this param. If you only
+     * want to put a single ibGib, you could also use the `ibGib` param.
+     */
+    ibGibs?: IbGib_V1[];
+    /**
+     * if true, will store this data in the bin folder with its hash.
+     */
+    // binData?: string;
+    /**
+     * If true, will store in a different folder.
+     */
+    isDna?: boolean;
+    /**
+     * extension to store the bindata with.
+     */
+    // binExt?: string;
+    /**
+     * If true, will store with metas.
+     */
+    isMeta?: boolean;
+    /**
+     * If true, will replace an existing ibGib file
+     */
+    force?: boolean;
+    /**
+     * space into which we shall put the ibgib.
+     *
+     * @default localCurrentSpace
+     */
+    space?: IbGibSpaceAny,
+}
+
+/**
+ * Result for putting ibgib.
+ */
+export interface PutIbGibResult extends FileResult {
+    binHash?: string;
+}
+
+export interface DeleteIbGibOpts extends GetIbGibOpts { }
+export interface DeleteIbGibResult extends FileResult { }
+
+// #endregion from common/types/legacy.ts
+
+/**
+ * Special ibgib types, used for metadata within a space.
+ *
+ * Unsure where to place this...
+ */
+export type SpecialIbGibType =
+    "tags" | "roots" | "latest" | "outerspaces" | "secrets" |
+    "encryptions" | "autosyncs" | "robbots" | "apps" | "history";
+/**
+ * Special ibgib types, used for metadata within a space.
+ *
+ * Unsure where to place this...
+ */
+export const SpecialIbGibType = {
+    /** indexes all tag ibgibs within a space */
+    tags: "tags" as SpecialIbGibType,
+    /** indexes all root ibgibs within a space */
+    roots: "roots" as SpecialIbGibType,
+    /**
+     * Ephemeral index ibgib that maps a tjp address -> latest local address in
+     * a space.
+     */
+    latest: "latest" as SpecialIbGibType,
+    /** indexes all outerspace ibgibs, including sync spaces, within a space */
+    outerspaces: "outerspaces" as SpecialIbGibType,
+    /** indexes all secret ibgibs within a space */
+    secrets: "secrets" as SpecialIbGibType,
+    /** indexes all encryption setting ibgibs within a space */
+    encryptions: "encryptions" as SpecialIbGibType,
+    /** indexes all tjp addresses that automatically sync. */
+    autosyncs: "autosyncs" as SpecialIbGibType,
+    robbots: "robbots" as SpecialIbGibType,
+    apps: "apps" as SpecialIbGibType,
+    /** timelines history */
+    history: "history" as SpecialIbGibType,
+}
+
+/**
+ * There has been a new ibGib that is the latest for a given tjp timeline.
+ */
+export interface IbGibTimelineUpdateInfo {
+    tjpAddr?: IbGibAddr;
+    latestAddr: IbGibAddr;
+    latestIbGib?: IbGib_V1<any>;
+}

package/src/common/other/svg-constants.mts

@@ -0,0 +1 @@
+export const SVG_NAMESPACE = 'http://www.w3.org/2000/svg';

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

@@ -0,0 +1,238 @@
+import { SVG_NAMESPACE } from "./svg-constants.mjs";
+
+export function ibSvg({
+    width, height,
+}: {
+    width: number, height: number,
+}): SVGElement {
+    const lc = `[${ibSvg.name}]`;
+    try {
+        const svg = document.createElementNS(SVG_NAMESPACE, 'svg');
+        svg.setAttribute('width', `${width}`);
+        svg.setAttribute('height', `${height}`);
+
+        const defs: SVGDefsElement = document.createElementNS(SVG_NAMESPACE, 'defs');
+        svg.append(defs);
+
+        return svg;
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+export function ibGetDefs({
+    svg,
+}: {
+    svg: SVGElement,
+}): SVGDefsElement | undefined {
+    const lc = `[${ibGetDefs.name}]`;
+    try {
+        let defs: SVGDefsElement | undefined;
+        svg.childNodes.forEach(x => {
+            if (x.nodeName === 'defs') { defs = (x as SVGDefsElement); }
+        });
+        return defs ?? undefined;
+    } catch (error) {
+        debugger;
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+export function ibGroup({
+    parent,
+    x, y,
+    width, height,
+    style,
+    fill,
+    opacity,
+    stroke,
+    strokeWidth,
+}: {
+    /**
+     * If provided, will append to the svg
+     */
+    parent?: SVGElement,
+    x: number, y: number,
+    width: number, height: number,
+    style?: string,
+    fill?: string,
+    opacity?: number,
+    stroke?: string,
+    strokeWidth?: string,
+}): SVGGElement {
+    const lc = `[${ibGroup.name}]`;
+    try {
+        stroke = stroke || 'black';
+        strokeWidth = strokeWidth || '1px';
+        if (!style) {
+            style = `stroke:${stroke};stroke-width:${strokeWidth}`;
+            if (fill) { style += `;fill:${fill}`; }
+        }
+
+        const group = document.createElementNS(SVG_NAMESPACE, 'g');
+        group.setAttribute('x', `${x}`);
+        group.setAttribute('y', `${y}`);
+        group.setAttribute('transform', `translate(${x},${y})`);
+        group.setAttribute('width', `${width}`);
+        group.setAttribute('height', `${height}`);
+        if (opacity || opacity == 0) { group.setAttribute('opacity', opacity.toString()); }
+        group.setAttribute('style', style);
+
+        if (parent) { parent.appendChild(group); }
+
+        return group;
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+export function ibCircle({
+    parent,
+    id,
+    cx, cy,
+    r,
+    style,
+    fill,
+    opacity,
+    stroke,
+    strokeWidth,
+    picSrcFn,
+}: {
+    /**
+     * If provided, will append created element to this
+     */
+    parent?: SVGElement,
+    id?: string,
+    cx: number, cy: number,
+    r: number,
+    style?: string,
+    fill?: string,
+    opacity?: number,
+    stroke?: string,
+    strokeWidth?: string,
+    picSrcFn?: () => string,
+    commentTextFn?: () => string,
+}): SVGCircleElement {
+    const lc = `[${ibCircle.name}]`;
+    try {
+        stroke = stroke || 'black';
+        strokeWidth = strokeWidth || '1px';
+        if (!style) {
+            style = `stroke:${stroke};stroke-width:${strokeWidth}`;
+        }
+
+        const circle = document.createElementNS(SVG_NAMESPACE, 'circle');
+        circle.setAttribute('cx', `${cx}`);
+        circle.setAttribute('cy', `${cy}`);
+        circle.setAttribute('r', `${r}`);
+        if (fill) { circle.setAttribute('fill', fill); }
+        if (opacity || opacity == 0) { circle.setAttribute('opacity', opacity.toString()); }
+        circle.setAttribute('style', style);
+
+        if (picSrcFn) {
+            const widthHeight = `${2 * r}`;
+            let defs: SVGDefsElement | undefined;
+            if (!parent) { throw new Error(`(UNEXPECTED) parent falsy but picSrcFn truthy (E: cb15575c925943fec85ac49d7cb70d23)`); }
+            parent.childNodes?.forEach((child: any) => {
+                if (child.nodeName === 'defs') { defs = child; }
+            });
+            if (!defs) {
+                defs = document.createElementNS(SVG_NAMESPACE, 'defs');
+                parent.appendChild(defs);
+            }
+
+            let pattern: SVGPatternElement = document.createElementNS(SVG_NAMESPACE, 'pattern');
+            if (!id) { throw new Error(`id required for pics (E: a179adeb6d2998af0ebea19b7a81b722)`); }
+            pattern.setAttribute('id', `id_${id}`);
+            pattern.setAttribute('patternUnits', 'userSpaceOnUse');
+            pattern.setAttribute('width', widthHeight);
+            pattern.setAttribute('height', widthHeight);
+            pattern.setAttribute('x', `-${r}`);
+            pattern.setAttribute('y', `-${r}`);
+            // pattern.setAttribute('patternUnits', 'objectBoundingBox');
+            // pattern.setAttribute('width', '1');
+            // pattern.setAttribute('height', '1');
+            defs.appendChild(pattern);
+
+            let image: SVGImageElement = document.createElementNS(SVG_NAMESPACE, 'image');
+            let src = picSrcFn();
+            image.setAttribute('href', src);
+            image.setAttribute('x', '0');
+            image.setAttribute('y', '0');
+            image.setAttribute('width', widthHeight);
+            image.setAttribute('height', widthHeight);
+            pattern.appendChild(image);
+
+            // fill="url(#image)"
+            circle.setAttribute('fill', `url(#id_${id})`);
+            // circle.appendChild(image);
+            // https://blog.idrsolutions.com/how-to-embed-base64-images-in-svg/
+        }
+
+        if (parent) { parent.appendChild(circle); }
+
+        return circle;
+    } catch (error) {
+        debugger;
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+export function ibLine({
+    parent,
+    x1y1, x2y2,
+    style,
+    opacity,
+    stroke,
+    strokeWidth,
+}: {
+    /**
+     * If provided, will append created element to this
+     */
+    parent?: SVGElement,
+    x1y1: [number, number],
+    x2y2: [number, number],
+    style?: string,
+    opacity?: number,
+    stroke?: string,
+    strokeWidth?: string,
+}): SVGLineElement {
+    const lc = `[${ibLine.name}]`;
+    try {
+        stroke = stroke || 'black';
+        strokeWidth = strokeWidth || '1px';
+        if (!style) {
+            style = `stroke:${stroke};stroke-width:${strokeWidth}`;
+        }
+
+        const line = document.createElementNS(SVG_NAMESPACE, 'line');
+        line.setAttribute('x1', `${x1y1[0]}`);
+        line.setAttribute('y1', `${x1y1[1]}`);
+        line.setAttribute('x2', `${x2y2[0]}`);
+        line.setAttribute('y2', `${x2y2[1]}`);
+        if (opacity || opacity == 0) { line.setAttribute('opacity', opacity.toString()); }
+        line.setAttribute('style', style);
+
+        if (parent) { parent.appendChild(line); }
+
+        return line;
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+export function ibAnimate({
+
+}): SVGAnimateElement | undefined {
+    return undefined;
+}
+export function ibAnimateMotion({
+
+}): SVGAnimateMotionElement | undefined {
+    return undefined;
+}

package/src/common/pic/pic-constants.mts

@@ -0,0 +1,13 @@
+/**
+ * default if for some reason there is no extension in data.ext
+ *
+ * ## driving itnent
+ *
+ * implementing download pic
+ */
+export const DEFAULT_PIC_FILE_EXTENSION = 'png';
+
+/**
+ * todo: resolve pic/bin separation. BINARY_REL8N_NAME
+ */
+export const BINARY_REL8N_NAME = 'bin';