@ibgib/core-gib 0.0.4

package/src/witness/app/app-helper.mts

@@ -0,0 +1,322 @@
+import { UUID_REGEXP, getTimestampInTicks, pretty } from '@ibgib/helper-gib';
+import { Gib, Ib, } from '@ibgib/ts-gib';
+import { validateIbGibIntrinsically } from '@ibgib/ts-gib/dist/V1/validate-helper.mjs';
+
+
+import { APP_NAME_REGEXP, APP_REL8N_NAME, GLOBAL_LOG_A_LOT } from '../../core-constants.mjs';
+import { AppData_V1, } from './app-types.mjs';
+import { IbGibAppAny } from './app-base-v1.mjs';
+// import { CommonService } from '../../services/common.service.mjs';
+// import { getFn_promptAppIbGib } from './prompt-functions.mjs';
+import { IbGibSpaceAny } from '../space/space-base-v1.mjs';
+import { WitnessFormBuilder } from '../witness-form-builder.mjs';
+// import { persistTransformResult, registerNewIbGib, rel8ToSpecialIbGib } from './space.mjs';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+import { IbGibLocalSpaceService_AllPowerful } from '../../core-types.mjs';
+import { IbGibTimelineUpdateInfo } from '../../common/other/other-types.mjs';
+import { persistTransformResult, registerNewIbGib, rel8ToSpecialIbGib } from '../space/space-helper.mjs';
+
+const logalot = GLOBAL_LOG_A_LOT || false;
+
+
+export function getAppResultMetadata({ app }: { app: IbGibAppAny }): string {
+    return `${app.ib} ${getTimestampInTicks()}`;
+}
+
+export function validateCommonAppData({
+    appData,
+}: {
+    appData: AppData_V1 | undefined,
+}): string[] {
+    const lc = `[${validateCommonAppData.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting...`); }
+        if (!appData) { throw new Error(`appData required (E: 3df782b29bc4406a87e4895cfcea28ed)`); }
+        const errors: string[] = [];
+        const {
+            name, uuid, classname,
+        } =
+            appData;
+
+        if (name) {
+            if (!name.match(APP_NAME_REGEXP)) {
+                errors.push(`name must match regexp: ${APP_NAME_REGEXP}`);
+            }
+        } else {
+            errors.push(`name required.`);
+        }
+
+        if (uuid) {
+            if (!uuid.match(UUID_REGEXP)) {
+                errors.push(`uuid must match regexp: ${UUID_REGEXP}`);
+            }
+        } else {
+            errors.push(`uuid required.`);
+        }
+
+        if (classname) {
+            if (!classname.match(APP_NAME_REGEXP)) {
+                errors.push(`classname must match regexp: ${APP_NAME_REGEXP}`);
+            }
+        }
+
+        return errors;
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
+export function getAppIb({
+    appData,
+    classname,
+}: {
+    appData: AppData_V1,
+    classname?: string,
+}): Ib {
+    const lc = `[${getAppIb.name}]`;
+    try {
+        const validationErrors = validateCommonAppData({ appData });
+        if (validationErrors.length > 0) { throw new Error(`invalid appData: ${validationErrors} (E: 9aff04f0cfc54a5188ca8bc40764160d)`); }
+        if (classname) {
+            if (appData.classname && appData.classname !== classname) { throw new Error(`classname does not match appData.classname (E: 66f1447eef97485fba521c40980f5eb5)`); }
+        } else {
+            classname = appData.classname;
+            if (!classname) { throw new Error(`classname required (E: 5f6ffb4317044125b94f662070e1f40b)`); }
+        }
+
+        const { name, uuid } = appData;
+        return `app ${classname} ${name} ${uuid}`;
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+/**
+ * Current schema is `app ${classname} ${name} ${uuid}`
+ *
+ * NOTE this is space-delimited
+ */
+export function getInfoFromAppIb({
+    appIb,
+}: {
+    appIb: Ib,
+}): {
+    appClassname: string,
+    appName: string,
+    appId: string,
+} {
+    const lc = `[${getInfoFromAppIb.name}]`;
+    try {
+        if (!appIb) { throw new Error(`appIb required (E: 6b065aee67e641ba9f9c6db367ebb0fb)`); }
+
+        const pieces = appIb.split(' ');
+
+        return {
+            appClassname: pieces[1],
+            appName: pieces[2],
+            appId: pieces[3],
+        };
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+export function getAppInfoIb({
+    appData,
+    appTjpGib,
+    classname,
+}: {
+    appData: AppData_V1,
+    appTjpGib: Gib,
+    /**
+     * Not sure why i have this here, since it should always be in the appData.classname...
+     */
+    classname?: string,
+}): Ib {
+    const lc = `[${getAppIb.name}]`;
+    try {
+        const validationErrors = validateCommonAppData({ appData });
+        if (validationErrors.length > 0) { throw new Error(`invalid appData: ${validationErrors} (E: 7be1f54ce8af4e4982966b2dedb4cf6e)`); }
+        if (classname) {
+            if (appData.classname && appData.classname !== classname) { throw new Error(`classname does not match appData.classname (E: 64bd9eaef1f94be8856e18b791d4ae52)`); }
+        } else {
+            classname = appData.classname;
+            if (!classname) { throw new Error(`classname required (E: 8d194cf8fb3f4c8eb2f708e0ccfe187c)`); }
+        }
+
+        const { name, uuid } = appData;
+        return `info_app ${classname} ${name} ${uuid} ${appTjpGib ?? 0}`;
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+/**
+ * Current schema is `info_app ${classname} ${name} ${uuid} ${appTjpGib ?? 0}`
+ *
+ * NOTE this is space-delimited
+ */
+export function getInfoFromAppInfoIb({
+    appInfoIb,
+}: {
+    appInfoIb: Ib,
+}): {
+    appClassname: string;
+    appName: string;
+    appId: string;
+    appTjpGib: Gib;
+} {
+    const lc = `[${getInfoFromAppIb.name}]`;
+    try {
+        if (!appInfoIb) { throw new Error(`appInfoIb required (E: d12756f218144d22acb14c794dd3eeef)`); }
+
+        const pieces = appInfoIb.split(' ');
+
+        if (pieces.length !== 5) { throw new Error(`invalid appInfoIb. Expected space-delimited pieces.length === 5 (E: 21bfc58e4d88c298680ea95bc6dfc622)`); }
+
+        return {
+            appClassname: pieces[1],
+            appName: pieces[2],
+            appId: pieces[3],
+            appTjpGib: pieces[4],
+        };
+    } catch (error) {
+        console.error(`${lc} ${error.message}`);
+        throw error;
+    }
+}
+
+
+/**
+ * Prompts the user a form to build the app.
+ *
+ * Once prompted, the app is:
+ * 1. validated
+ * 2. persisted in the given {@link space}
+ * 3. registered with the space
+ * 4. related to the space's special apps index
+ * 5. new app is returned
+ *
+ * @returns newly created app ibgib (witness)
+ */
+export async function createNewApp({
+    ibgibs,
+    space,
+}: {
+    /**
+     * Either {@link common} or {@link ibgibs} is required
+     * @hack
+     */
+    ibgibs?: IbGibLocalSpaceService_AllPowerful,
+    /**
+     * space within which to create the app. if not provided, the
+     * defaults to the local user space via {@link common} or {@link ibgibs}.
+     */
+    space: IbGibSpaceAny,
+}): Promise<IbGibAppAny | undefined> {
+    const lc = `[${createNewApp.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting...`); }
+
+        if (!ibgibs) { throw new Error(`ibgibs all powerful service required. (E: b24e78de0d204dc78909022bee296b30)`); }
+
+        space = space ?? await ibgibs.getLocalUserSpace({ lock: true });
+
+        // prompt user to create the ibgib, passing in null because we're
+        // creating not editing.
+        let resApp = await ibgibs.fnPromptApp(space, /*ibGib*/ null);
+
+        if (!resApp) { throw new Error(`resApp falsy after prompt for app. (E: 2225a567abcd680a5e957e81fbb64123)`); }
+
+        /** this should be the witness class itself at this point. */
+        const newApp = (resApp.newIbGib as IbGibAppAny);
+
+        let allIbGibs: IbGib_V1[] = [];
+        allIbGibs.push(newApp);
+        resApp.intermediateIbGibs?.forEach((x: IbGib_V1) => allIbGibs.push(x));
+        resApp.dnas?.forEach((x: IbGib_V1) => allIbGibs.push(x));
+        for (let i = 0; i < allIbGibs.length; i++) {
+            const ibGib = allIbGibs[i];
+            const validationErrors = await validateIbGibIntrinsically({ ibGib });
+            if ((validationErrors ?? []).length > 0) { throw new Error(`(UNEXPECTED) invalid app ibgib created. validationErrors: ${validationErrors}. app: ${pretty(newApp.toIbGibDto())} (E: 54cfc2f6bc284ed79be91d2da5e4bd2f)`); }
+        }
+
+        await persistTransformResult({ resTransform: resApp, isMeta: true, space });
+        const { zeroSpace, fnBroadcast, fnUpdateBootstrap } = ibgibs;
+        await registerNewIbGib({
+            ibGib: newApp,
+            space,
+            zeroSpace,
+            fnBroadcast: (x: IbGibTimelineUpdateInfo) => fnBroadcast(x),
+            fnUpdateBootstrap: (x: IbGibSpaceAny) => fnUpdateBootstrap(x),
+        });
+
+        await rel8ToSpecialIbGib({
+            type: "apps",
+            rel8nName: APP_REL8N_NAME,
+            ibGibsToRel8: [newApp],
+            space,
+            zeroSpace,
+            fnUpdateBootstrap,
+            fnBroadcast,
+        });
+        return newApp;
+    } catch (error) {
+        debugger;
+        console.error(`${lc} ${error.message}`);
+        return;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
+export class AppFormBuilder extends WitnessFormBuilder {
+    protected lc: string = `${super.lc}[${AppFormBuilder.name}]`;
+
+    constructor() {
+        super();
+        this.what = 'app';
+    }
+
+    icon({
+        of,
+        required,
+        defaultValue,
+        iconsList,
+    }: {
+        of: string,
+        required?: boolean,
+        defaultValue?: string,
+        iconsList: string[],
+    }): AppFormBuilder {
+        // const exampleIonicons = IONICONS.slice(0, 4).map(x => `"${x}"`).join(', ');
+        const exampleIonicons = iconsList.slice(0, 4).map(x => `"${x}"`).join(', ');
+        this.addItem({
+            // witness.data.outputPrefix
+            name: "icon",
+            description: `Icon name for the app's icon in the app bar. (NOTE: Only ionicons right now, e.g. ${exampleIonicons}). See https://ionic.io/ionicons for a full list.`,
+            label: "Icon",
+            fnValid: (x: string | number) => { return typeof x === 'string' && iconsList.includes(x); },
+            defaultErrorMsg: `Must be a valid icon from the icons list.`,
+            dataType: 'select',
+            value: of,
+            defaultValue: defaultValue || 'beer',
+            selectOptions: [
+                ...iconsList,
+            ],
+            required,
+        });
+        return this;
+    }
+
+}
+
+export function documentLocationIsAtWelcomePage(): boolean {
+    return ['welcome', '/welcome', '/welcome/'].includes(document.location.pathname);
+}

package/src/witness/app/app-types.mts

@@ -0,0 +1,252 @@
+import { IbGibAddr, TransformResult } from '@ibgib/ts-gib';
+import { IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+
+
+// import { IonicSpaceData_V1 } from '../witnesses/spaces/ionic-space-v1';
+import {
+  WitnessData_V1, WitnessRel8ns_V1,
+  WitnessCmdData, WitnessCmdRel8ns, WitnessCmdIbGib,
+  WitnessResultData, WitnessResultRel8ns, WitnessResultIbGib,
+} from '../witness-types.mjs';
+import { IbGibSpaceData_Subpathed } from '../space/space-types.mjs';
+import { IbGibAppAny } from './app-base-v1.mjs';
+
+
+
+/**
+ * ...hmm...?
+ *
+ * This originally descends from IonicSpaceData_V1. I need to figure out what
+ * this is doing, because this shouldn't be scoped to even subpathed strategy.
+ * That is entirely an implementation decision.
+ */
+export interface AppSpaceData extends IbGibSpaceData_Subpathed { }
+
+export enum AppSpaceRel8n {
+  roots = 'roots',
+  tags = 'tags',
+  latest = 'latest',
+  outerspaces = 'outerspaces',
+  secrets = "secrets",
+  encryptions = "encryptions",
+}
+
+export interface AppSpaceRel8ns extends IbGibRel8ns_V1 {
+  [AppSpaceRel8n.tags]?: IbGibAddr[];
+  [AppSpaceRel8n.roots]?: IbGibAddr[];
+  [AppSpaceRel8n.latest]?: IbGibAddr[];
+  [AppSpaceRel8n.outerspaces]?: IbGibAddr[];
+  [AppSpaceRel8n.secrets]?: IbGibAddr[];
+  [AppSpaceRel8n.encryptions]?: IbGibAddr[];
+}
+
+/**
+ * An app space itself works as the config instead of
+ * having an external config object.
+ *
+ * ## notes
+ *
+ * Probably need to change this at some point...
+ */
+export interface ConfigIbGib_V1 extends IbGib_V1<AppSpaceData, AppSpaceRel8ns> { }
+
+
+export interface AppData_V1 extends WitnessData_V1 {
+
+  /**
+   * Name of a App instance...after all, Robbie was only the first App.
+   */
+  name: string;
+
+  /**
+   * Redeclared over {@link WitnessData_V1.uuid} making it a required field.
+   */
+  uuid: string;
+
+  /**
+   * Right now, this will be just for ionicons.
+   */
+  icon: string;
+
+}
+
+
+export interface AppRel8ns_V1 extends WitnessRel8ns_V1 {
+}
+
+/**
+ */
+export interface AppIbGib_V1 extends IbGib_V1<AppData_V1, AppRel8ns_V1> {
+}
+
+/**
+ * Cmds for interacting with ibgib spaces.
+ *
+ * Not all of these will be implemented for every space.
+ *
+ * ## todo
+ *
+ * change these commands to better structure, e.g., verb/do/mod, can/get/addrs
+ * */
+export type AppCmd =
+  'ib' | 'gib' | 'ibgib';
+/** Cmds for interacting with ibgib spaces. */
+export const AppCmd = {
+  /**
+   * it's more like a grunt that is intepreted by context from the app.
+   *
+   * my initial use of this will be to
+   * ...
+   */
+  ib: 'ib' as AppCmd,
+  /**
+   * it's more like a grunt that is intepreted by context from the app.
+   *
+   * my initial use of this will be to indicate to a app ...
+   */
+  gib: 'gib' as AppCmd,
+  /**
+   * third placeholder command.
+   *
+   * I imagine this will be like "what's up", but who knows.
+   */
+  ibgib: 'ibgib' as AppCmd,
+}
+
+/**
+ * Flags to affect the command's interpretation.
+ */
+export type AppCmdModifier =
+  'ib' | 'gib' | 'ibgib';
+/**
+ * Flags to affect the command's interpretation.
+ */
+export const AppCmdModifier = {
+  /**
+   * hmm...
+   */
+  ib: 'ib' as AppCmdModifier,
+  /**
+   * hmm...
+   */
+  gib: 'gib' as AppCmdModifier,
+  /**
+   * hmm...
+   */
+  ibgib: 'ibgib' as AppCmdModifier,
+}
+
+/** Information for interacting with spaces. */
+export interface AppCmdData
+  extends WitnessCmdData<AppCmd, AppCmdModifier> {
+}
+
+export interface AppCmdRel8ns extends WitnessCmdRel8ns {
+}
+
+/**
+ * Shape of options ibgib if used for a app.
+ *
+ * I'm not sure what to do with this atm, so I'm just stubbing out...
+ */
+export interface AppCmdIbGib<
+  TIbGib extends IbGib_V1 = IbGib_V1,
+  TCmdData extends AppCmdData = AppCmdData,
+  TCmdRel8ns extends AppCmdRel8ns = AppCmdRel8ns,
+> extends WitnessCmdIbGib<TIbGib, AppCmd, AppCmdModifier, TCmdData, TCmdRel8ns> {
+}
+
+/**
+ * Optional shape of result data to app interactions.
+ *
+ * This is in addition of course to {@link WitnessResultData}.
+ *
+ * ## notes
+ *
+ * * I'm not sure what to do with this atm, so I'm just stubbing out...
+ */
+export interface AppResultData extends WitnessResultData {
+}
+
+/**
+ * Marker interface rel8ns atm...
+ *
+ * I'm not sure what to do with this atm, so I'm just stubbing out...
+ */
+export interface AppResultRel8ns extends WitnessResultRel8ns { }
+
+/**
+ * Shape of result ibgib if used for a app.
+ *
+ * I'm not sure what to do with this atm, so I'm just stubbing out...
+ */
+export interface AppResultIbGib<
+  TIbGib extends IbGib_V1,
+  TResultData extends AppResultData,
+  TResultRel8ns extends AppResultRel8ns
+>
+  extends WitnessResultIbGib<TIbGib, TResultData, TResultRel8ns> {
+}
+
+/**
+ * When coming from the extension in firefox/chrome(chromium), this info
+ * represents a selection to be converted/saved in an ibgib graph.
+ */
+export interface ExtensionSelectionInfo {
+  type: 'comment' | 'link';
+  text: string;
+  url?: string;
+  children?: ExtensionSelectionInfo[];
+}
+
+/**
+ * this is generated in background.js (WARNING! background.js atow is generated
+ * from background.v2.js or background.v3.js . ...do NOT make changes directly
+ * in background.js!).
+ *
+ * When the user is in their browser with the ibgib extension and selects some
+ * text or clicks an ibgib context menu item to initiate the app, this info is
+ * passed to the app via query params (atow).
+ */
+export interface ExtensionLaunchInfo {
+  /** brand the event so we know it's ours */
+  ib: boolean;
+  /**
+   * indicate to the receiving angular app that we're launching
+   * from an extension in firefox/chrome. (this is obvious here in
+   * background.js but in the angular app, not so much).
+   */
+  isExtensionLaunch: boolean;
+  /**
+   * So consumer knows where this is coming from. (obvious to us
+   * here, but helps consumer)
+   */
+  lc: string,
+  /**
+   * text of the context menu clicked
+   * @link https://developer.chrome.com/docs/extensions/reference/contextMenus/#type-OnClickData
+   */
+  menuItemId: string;
+  /**
+   * url of the page that _initiates_ the click and starts the app.
+   * so if the user is on wikipedia.org, selects some text and clicks on the ibgib link,
+   * in order to generate some ibgib data based on the page, this will be
+   * https://en.wikipedia.org/wiki/Phanerozoic (or whatever).
+   *
+   * @link https://developer.chrome.com/docs/extensions/reference/contextMenus/#type-OnClickData
+   */
+  pageUrl: string;
+  /**
+   * info about selections user made when starting the (extension) app.
+   *
+   * So if they highlight some text and add it, that is one info. If they highlight a whole paragraph
+   * it will create a comment for the p and possibly children infos for links in that paragraph.
+   *
+   * Same goes for if they select a header tag.
+   *
+   * @link https://developer.chrome.com/docs/extensions/reference/contextMenus/#type-OnClickData
+   */
+  selectionInfos?: ExtensionSelectionInfo[];
+}
+
+export type AppPromptResult = TransformResult<IbGibAppAny>;

package/src/witness/app/chat-app/chat-app-types.mts

@@ -0,0 +1,40 @@
+import { AppData_V1, AppRel8ns_V1 } from '../app-types.mjs';
+
+export const DEFAULT_UUID_CHAT_APP = '0';
+export const DEFAULT_NAME_CHAT_APP = 'chat_gib';
+export const DEFAULT_DESCRIPTION_CHAT_APP =
+    `A chat app done ibgib style, enabling infinitely nesting comments, pics and links. It's ibgibs all the way down...`;
+
+
+export interface ChatAppData_V1 extends AppData_V1 {
+
+}
+
+
+export interface ChatAppRel8ns_V1 extends AppRel8ns_V1 {
+
+}
+
+/**
+ * Default data values for a random app.
+ *
+ * If you change this, please bump the version
+ *
+ * (but of course won't be the end of the world when this doesn't happen).
+ */
+export const DEFAULT_CHAT_APP_DATA_V1: ChatAppData_V1 = {
+    version: '1',
+    uuid: DEFAULT_UUID_CHAT_APP,
+    name: DEFAULT_NAME_CHAT_APP,
+    description: DEFAULT_DESCRIPTION_CHAT_APP,
+    // classname: ChatApp_V1.name,
+    classname: `ChatApp_V1`,
+
+    icon: 'chatbubbles',
+
+    persistOptsAndResultIbGibs: false,
+    allowPrimitiveArgs: true,
+    catchAllErrors: true,
+    trace: false,
+}
+export const DEFAULT_CHAT_APP_REL8NS_V1: ChatAppRel8ns_V1 | undefined = undefined;

package/src/witness/app/flash-app/flash-app-types.mts

@@ -0,0 +1,38 @@
+import { AppData_V1, AppRel8ns_V1 } from '../app-types.mjs';
+
+export const DEFAULT_UUID_FLASH_APP = '0';
+export const DEFAULT_NAME_FLASH_APP = 'flash_gib';
+export const DEFAULT_DESCRIPTION_FLASH_APP =
+    `A flashcard app done ibgib style, where ibgib are the "cards" and are shown in various ways.`;
+
+
+export interface FlashAppData_V1 extends AppData_V1 {
+
+}
+
+
+export interface FlashAppRel8ns_V1 extends AppRel8ns_V1 {
+
+}
+
+/**
+ * Default data values for a flash app.
+ *
+ * If you change this, please bump the version.
+ */
+export const DEFAULT_FLASH_APP_DATA_V1: FlashAppData_V1 = {
+    version: '1',
+    uuid: DEFAULT_UUID_FLASH_APP,
+    name: DEFAULT_NAME_FLASH_APP,
+    description: DEFAULT_DESCRIPTION_FLASH_APP,
+    // classname: FlashApp_V1.name,
+    classname: `FlashApp_V1`,
+
+    icon: 'flash',
+
+    persistOptsAndResultIbGibs: false,
+    allowPrimitiveArgs: true,
+    catchAllErrors: true,
+    trace: false,
+}
+export const DEFAULT_FLASH_APP_REL8NS_V1: FlashAppRel8ns_V1 | undefined = undefined;

package/src/witness/app/raw-app/raw-app-types.mts

@@ -0,0 +1,40 @@
+import { AppData_V1, AppRel8ns_V1 } from '../app-types.mjs';
+
+export const DEFAULT_UUID_RAW_APP = '0';
+export const DEFAULT_NAME_RAW_APP = 'raw_gib';
+export const DEFAULT_DESCRIPTION_RAW_APP =
+    `Explorer app for navigating raw ibgib data.`;
+
+
+export interface RawAppData_V1 extends AppData_V1 {
+
+}
+
+export interface RawAppRel8ns_V1 extends AppRel8ns_V1 {
+
+}
+
+/**
+ * Default data values for a random app.
+ *
+ * If you change this, please bump the version
+ *
+ * (but of course won't be the end of the world when this doesn't happen).
+ */
+export const DEFAULT_RAW_APP_DATA_V1: RawAppData_V1 = {
+    version: '1',
+    uuid: DEFAULT_UUID_RAW_APP,
+    name: DEFAULT_NAME_RAW_APP,
+    description: DEFAULT_DESCRIPTION_RAW_APP,
+    // classname: RawApp_V1.name,
+    classname: `RawApp_V1`,
+
+    icon: 'paper-plane',
+
+    persistOptsAndResultIbGibs: false,
+    allowPrimitiveArgs: true,
+    catchAllErrors: true,
+    trace: false,
+}
+
+export const DEFAULT_RAW_APP_REL8NS_V1: RawAppRel8ns_V1 | undefined = undefined;