@ibgib/web-gib 0.0.1

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

@@ -0,0 +1,121 @@
+import { CommentData_V1 } from "@ibgib/core-gib/dist/common/comment/comment-types.mjs";
+import { IbGib_V1, IbGibRel8ns_V1 } from "@ibgib/ts-gib/dist/V1/types.mjs";
+import type { getProjectIb } from './project-helper.mjs';
+import { AGENT_REL8N_NAME } from "../../witness/agent/agent-constants.mjs";
+import { IbGibAddr } from "@ibgib/ts-gib/dist/types.mjs";
+
+// #region constants - Pulled in from project-constants, but we need default data/rel8ns structure here
+
+export const DEFAULT_PROJECT_TEXT = 'default project text';
+export const DEFAULT_PROJECT_NAME = 'untitled_project';
+export const DEFAULT_PROJECT_DESCRIPTION = 'This is an ibgib project. ';
+
+/**
+ * Default rel8ns values for a Project. Includes inherited defaults from IbGib.
+ */
+export const DEFAULT_PROJECT_REL8NS_V1: ProjectRel8ns_V1 | undefined = undefined;
+
+// #endregion constants
+
+/**
+ * Represents the data structure for a Project ibGib.
+ * Contains the core information defining a project.
+ */
+export interface ProjectData_V1 extends CommentData_V1 {
+    /**
+     * Description of the project.
+     * This can be a more detailed explanation of the project's purpose or scope.
+     * Optional.
+     */
+    description?: string;
+}
+
+/**
+ * Represents the relationships structure for a Project ibGib.
+ * Currently holds standard ibGib relationships but can be extended
+ * in the future if projects require specific relationship types (e.g., rel8n_tasks).
+ */
+export interface ProjectRel8ns_V1 extends IbGibRel8ns_V1 {
+    // Add any project-specific rel8ns here if needed.
+    [AGENT_REL8N_NAME]?: IbGibAddr[];
+}
+
+/**
+ * Represents a fully formed Project ibGib, combining its data and relationships.
+ * This is the primary type used when interacting with Project ibGibs.
+ */
+export interface ProjectIbGib_V1 extends IbGib_V1<ProjectData_V1, ProjectRel8ns_V1> {
+}
+
+/**
+ * Default data values for a Project. Includes inherited defaults from Comment/IbGib.
+ */
+export const DEFAULT_PROJECT_DATA_V1: ProjectData_V1 = {
+    // Inherited from CommentData_V1 -> IbGibData_V1
+    name: DEFAULT_PROJECT_NAME, // Default project name
+    text: DEFAULT_PROJECT_TEXT, // Default comment text
+    textTimestamp: '',
+
+    // ProjectData_V1 specific (or CommentData_V1 overrides)
+    description: DEFAULT_PROJECT_DESCRIPTION, // Default project description
+};
+
+/**
+ * Represents the parsed information extracted from the `addlMetadataText`
+ * segment within a project's `ib` string. This segment follows the `safeName`
+ * and is delimited by underscores internally if multiple fields are present.
+ */
+export interface ProjectAddlMetadataInfo {
+    /**
+     * Ticks version of the timestamp derived from ibgib.data.timestamp.
+     * This value is encoded within the addlMetadataText segment of the ib string.
+     */
+    timestampInTicks: number;
+    // Add other fields here if the addlMetadataText segment grows,
+    // ensuring they are underscore-delimited in the raw text.
+}
+
+
+/**
+ * Represents the parsed information extracted from a project's `ib` string.
+ * The `ib` string contains core metadata encoded for efficient referencing.
+ *
+ * @see {@link getProjectIb} for ib schema
+ */
+export interface ProjectIbInfo {
+    /** The atom identifier (must be 'project'). Checked during parsing. */
+    atom: 'project';
+    /**
+     * A 'saferized', often truncated, version of the name (project title).
+     * Extracted as the first space-delimited segment after the atom.
+     */
+    safeName: string;
+    /**
+     * The raw string containing underscore-delimited additional metadata (e.g., "1678886400000").
+     * Extracted as the second space-delimited segment after safeName.
+     *
+     * @see {@link addlMetadata}
+     */
+    addlMetadataText: string;
+    /**
+     * The parsed content of the addlMetadataText segment.
+     *
+     * @see {@link addlMetadataText}
+     */
+    addlMetadata: ProjectAddlMetadataInfo;
+}
+
+// #region LensMode
+export const LENS_MODE_RAW = 'raw';
+export const LENS_MODE_TEXT = 'text';
+export const LENS_MODE_MINIGAME = 'minigame';
+export type LensMode =
+    | typeof LENS_MODE_RAW
+    | typeof LENS_MODE_TEXT
+    | typeof LENS_MODE_MINIGAME;
+export const LensMode = {
+    raw: LENS_MODE_RAW,
+    text: LENS_MODE_TEXT,
+    minigame: LENS_MODE_MINIGAME,
+} satisfies { [key in LensMode]: LensMode };
+// #endregion LensMode

package/src/common/prompt-functions.web.mts

@@ -0,0 +1,447 @@
+import { extractErrorMsg } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
+import { IbGibSpaceAny } from '@ibgib/core-gib/dist/witness/space/space-base-v1.mjs';
+// import { SecretModalFormComponent } from '../modals/secret-modal-form/secret-modal-form.component';
+// import { EncryptionModalFormComponent } from '../modals/encryption-modal-form/encryption-modal-form.component';
+// import { OuterspaceModalFormComponent } from '../modals/outerspace-modal-form/outerspace-modal-form.component';
+// import { UpdatePicModalFormComponent, UpdatePicPromptResult } from '../modals/update-pic-modal-form/update-pic-modal-form.component';
+// import { UpdateCommentModalFormComponent, UpdateCommentPromptResult } from '../modals/update-comment-modal-form/update-comment-modal-form.component';
+// import { EncryptionData_V1 } from '@ibgib/core-gib/dist/common/encrypt/encrypt-types.mjs';
+// import { OuterSpaceIbGib } from '@ibgib/core-gib/dist/witness/space/outer-space/outer-space-types.mjs';
+// import { PicIbGib_V1 } from '@ibgib/core-gib/dist/common/pic/pic-types.mjs';
+// import { RobbotIbGib_V1 } from '@ibgib/core-gib/dist/witness/robbot/robbot-types.mjs';
+// import {
+//     RobbotModalFormComponent, RobbotPromptResult
+// } from '@ibgib/core-gib/dist/modals/robbot-modal-form/robbot-modal-form.component';
+// import { AppIbGib_V1 } from '@ibgib/core-gib/dist/witness/app/app-types.mjs';
+// import {
+//     AppModalFormComponent, AppPromptResult
+// } from '@ibgib/core-gib/dist../modals/app-modal-form/app-modal-form.component';
+// import { clearDoCancelModalOnBackButton, registerCancelModalOnBackButton } from '@ibgib/core-gib/dist./utils';
+// import { CommentIbGib_V1 } from '@ibgib/core-gib/dist/common/comment/comment-types.mjs';
+// import { SECRET_REL8N_NAME } from '@ibgib/core-gib/dist/common/encrypt/encrypt-constants.mjs';
+
+import { GLOBAL_LOG_A_LOT } from '../constants.mjs';
+import { alertUser, promptForConfirm, promptForText } from '../helpers.web.mjs';
+
+const logalot = GLOBAL_LOG_A_LOT || false;
+
+
+/**
+ * Wrapper for alerting via atow capacitor modals.
+ *
+ * @returns FUNCTION that alerts (doesn't actually do the alert)
+ */
+export function getFnAlert(): ({ title, msg }: { title: string, msg: string }) => Promise<void> {
+    return async ({ title, msg }: { title: string, msg: string }) => {
+        // await Dialog.alert({ title, message: msg });
+        // const titlePlusMsg = `${title}: ${msg}`;
+        // console.log(titlePlusMsg);
+        // alert(titlePlusMsg)
+        await alertUser({ msg, title });
+    };
+}
+
+/**
+ * Wrapper for prompting via custom dialog function.
+ *
+ * @returns FUNCTION that prompts (doesn't actually do the prompt, just creates
+ * the function that will)
+ */
+export function getFnPrompt(): ({ title, msg }: { title: string, msg: string }) => Promise<string | null> {
+    return async ({ title, msg }: { title: string, msg: string }) => {
+        const lc = `[${getFnPrompt.name}]`;
+        let answer: string;
+        try {
+            if (!msg) { throw new Error(`msg required. (E: c39d1656b6b803e11bad46efe15b6823)`); }
+
+            answer = await promptForText({ title, msg });
+
+            // const titlePlusMsg = `${title}: ${msg}`;
+            // console.log(`${lc} ${titlePlusMsg}`);
+            // answer = window.prompt(titlePlusMsg) ?? '';
+            // if (logalot) { console.log(`${lc} answer: ${answer} (I: 89e4379f368c136a31e52107447b7b24)`); }
+
+            // const rl = readline.createInterface({ input: stdin, output: stdout });
+            // try {
+            //     const text = title ? `\n# ${title}:\n\n${msg}\n` : `${msg}\n`;
+            //     answer = await rl.question(text);
+            //     if (logalot) { console.log(`${lc} text: ${text}. answer: ${answer} (I: 7f0375b3abd7eba9c75636d31bbca323)`); }
+            // } catch (error) {
+            //     throw error;
+            // } finally {
+            //     rl.close();
+            // }
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        }
+        return answer || answer === '' ? answer : null;
+    };
+}
+
+/**
+ * Wrapper for confirming via commandline/terminal prompt.
+ *
+ * @returns FUNCTION that prompts (doesn't actually do the prompt)
+ */
+export function getFnConfirm():
+    ({ title, msg, okButtonTitle, cancelButtonTitle }:
+        { title: string, msg: string, okButtonTitle?: string, cancelButtonTitle?: string }) => Promise<boolean> {
+    return async ({ title, msg, okButtonTitle, cancelButtonTitle }:
+        { title: string, msg: string, okButtonTitle?: string, cancelButtonTitle?: string }) => {
+        okButtonTitle ||= 'yes';
+        cancelButtonTitle ||= 'no';
+
+        if (okButtonTitle === cancelButtonTitle) { throw new Error(`okButtonTitle (${okButtonTitle}) must be different than cancelButtonTitle (${cancelButtonTitle}) (E: 254e92fed2e99edc362de337e8bf3123)`); }
+        // if (okButtonTitle[0] === cancelButtonTitle[0]) { throw new Error(`okButtonTitle (${okButtonTitle}) must start with a different character than cancelButtonTitle (${cancelButtonTitle}) (E: 8bdd34b0d90f479399d911af58df9190)`); }
+
+        let result = await promptForConfirm({
+            msg,
+            yesLabel: okButtonTitle,
+            noLabel: cancelButtonTitle,
+        });
+
+        return result;
+
+        // const promptFn = getFnPrompt();
+        // let result: string | null = null;
+        // do {
+        //     // result = await promptFn({ title, msg: `${msg} (${okButtonTitle}/${cancelButtonTitle})` });
+        //     result = await promptForConfirm({
+        //         title,
+        //         msg: `${msg} (${okButtonTitle}/${cancelButtonTitle})`
+        //     }) ?? null;
+        //     result = result ? result!.toLowerCase() : null;
+        // } while (!result);
+
+        // if (result === okButtonTitle![0].toLowerCase()) { result = okButtonTitle!; }
+        // return result === okButtonTitle;
+    };
+}
+
+/**
+ * Prompts the user for a password using an ionic capacitor (atow) alert
+ * controller with an input of type `'password'`.
+ *
+ *
+ *
+ * @returns either the password or null if cancelled
+ */
+export function getFnPromptPassword(): (title: string, msg: string) => Promise<string | null> {
+    const lc = `[${getFnPromptPassword.name}]`;
+    try {
+        throw new Error(`not implemented yet. i have added PromptPasswordFunction type in core-gib/core-types (E: 78c7dbb8958f8f353730d0dbb86b5423)`);
+        // if (!alertController) { throw new Error('alertController required.'); }
+        // let fnPromptPassword = async (title: string, msg: string) => {
+        //     const alert = await alertController.create({
+        //         header: title,
+        //         message: msg,
+        //         inputs: [
+        //             { name: 'password', type: 'password', label: 'Password: ', },
+        //         ],
+        //         buttons: ['OK', 'Cancel'],
+        //     });
+        //     await alert.present();
+        //     let result = await alert.onDidDismiss();
+        //     if (result?.data?.values?.password) {
+        //         return result!.data!.values!.password;
+        //     } else {
+        //         return null;
+        //     }
+        // };
+        // return fnPromptPassword;
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    }
+}
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to create an secret ibgib. If the user chooses to save, then the
+ * modal will create the secret ibgib, save the transform result in the
+ * given `space` (atow this is the local user space), and return the new
+ * secret ibgib.
+ */
+export function getFn_promptCreateSecretIbGib(
+): (space: IbGibSpaceAny) => Promise<IbGib_V1 | undefined> {
+    const lc = `[${getFn_promptCreateSecretIbGib.name}]`;
+    return async (space: IbGibSpaceAny) => {
+        throw new Error(`not impl yet (E: 990b79f9b8c2302163cc656deceaf923)`);
+        // /** hacked untyped document reference to hack a solution to the back button leaving modals open. */
+        // try {
+        //     const modal = await common.modalController.create({
+        //         component: SecretModalFormComponent,
+        //     });
+        //     // have to register/clear modal for cancelling in case the user
+        //     // presses the back button while the modal is still visible
+        //     registerCancelModalOnBackButton(modal);
+        //     await modal.present();
+        //     let resModal = await modal.onWillDismiss();
+        //     // clear the cancel since it dismissed naturally
+        //     clearDoCancelModalOnBackButton();
+        //     if (resModal.data) {
+        //         const resNewSecret = <TransformResult<SecretIbGib_V1>>resModal.data;
+        //         await common.ibgibs.persistTransformResult({ resTransform: resNewSecret, space });
+        //         const addr = getIbGibAddr({ ibGib: resNewSecret.newIbGib });
+        //         if (logalot) { console.log(`${lc} created secret. addr: ${addr}`); }
+        //         await common.ibgibs.rel8ToSpecialIbGib({
+        //             type: "secrets",
+        //             rel8nName: SECRET_REL8N_NAME,
+        //             ibGibsToRel8: [resNewSecret.newIbGib],
+        //             space,
+        //         });
+        //         return resNewSecret.newIbGib;
+        //     } else {
+        //         // didn't create one
+        //         console.warn(`${lc} didn't create at this time.`);
+        //         return undefined;
+        //     }
+        // } catch (error) {
+        //     console.error(`${lc} error: ${extractErrorMsg(error)}`);
+        //     return undefined;
+        // }
+    }
+}
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to create an encryption ibgib. If the user chooses to save, then the
+ * modal will create the encryption ibgib, save the transform result in the
+ * given `space` (atow this is the local user space), and return the new
+ * encryption ibgib.
+ */
+export function getFn_promptCreateEncryptionIbGib(
+    // common: CommonService,
+): (space: IbGibSpaceAny) => Promise<IbGib_V1 | undefined> {
+    throw new Error(`not impl yet (E: 69c7d552de7318a97457363adfd34f23)`);
+    // const lc = `[${getFn_promptCreateEncryptionIbGib.name}]`;
+    // return async (space: IbGibSpaceAny) => {
+    //     try {
+    //         const modal = await common.modalController.create({
+    //             component: EncryptionModalFormComponent,
+    //         });
+    //         // have to register/clear modal for cancelling in case the user
+    //         // presses the back button while the modal is still visible
+    //         registerCancelModalOnBackButton(modal);
+    //         await modal.present();
+    //         let resModal = await modal.onWillDismiss();
+    //         // clear the cancel since it dismissed naturally
+    //         clearDoCancelModalOnBackButton();
+    //         if (resModal.data) {
+    //             const resNewEncryption = <TransformResult<IbGib_V1<EncryptionData_V1>>>resModal.data;
+    //             await common.ibgibs.persistTransformResult({ resTransform: resNewEncryption, space });
+    //             const addr = getIbGibAddr({ ibGib: resNewEncryption.newIbGib });
+    //             if (logalot) { console.log(`${lc} created encryption. addr: ${addr}`); }
+    //             return resNewEncryption.newIbGib;
+    //         } else {
+    //             // didn't create one
+    //             console.warn(`${lc} didn't create at this time.`);
+    //             return undefined;
+    //         }
+    //     } catch (error) {
+    //         console.error(`${lc} error: ${extractErrorMsg(error)}`);
+    //         return undefined;
+    //     }
+    // }
+}
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to create an outerspace ibgib. If the user chooses to save, then the
+ * modal will create the outerspace ibgib, save the transform result in the
+ * given `space` (atow this is the local user space), and return the new
+ * outerspace ibgib.
+ */
+export function getFn_promptCreateOuterSpaceIbGib(
+    // common: CommonService,
+): (space: IbGibSpaceAny) => Promise<IbGib_V1 | undefined> {
+    throw new Error(`not impl yet (E: e48ef8a7b4252cfe795dde791de99523)`);
+    // const lc = `[${getFn_promptCreateOuterSpaceIbGib.name}]`;
+    // return async (space: IbGibSpaceAny) => {
+    //     try {
+    //         const modal = await common.modalController.create({
+    //             component: OuterspaceModalFormComponent,
+    //         });
+    //         // have to register/clear modal for cancelling in case the user
+    //         // presses the back button while the modal is still visible
+    //         registerCancelModalOnBackButton(modal);
+    //         await modal.present();
+    //         let resModal = await modal.onWillDismiss();
+    //         // clear the cancel since it dismissed naturally
+    //         clearDoCancelModalOnBackButton();
+    //         if (resModal.data) {
+    //             const resOuterSpace = <TransformResult<OuterSpaceIbGib>>resModal.data;
+    //             await common.ibgibs.persistTransformResult({ resTransform: resOuterSpace, space });
+    //             const addr = getIbGibAddr({ ibGib: resOuterSpace.newIbGib });
+    //             if (logalot) { console.log(`${lc} created outerspace. addr: ${addr}`); }
+    //             return resOuterSpace.newIbGib;
+    //         } else {
+    //             // didn't create one
+    //             console.warn(`${lc} didn't create outerspace at this time.`);
+    //             return undefined;
+    //         }
+    //     } catch (error) {
+    //         console.error(`${lc} error: ${extractErrorMsg(error)}`);
+    //         return undefined;
+    //     }
+    // }
+}
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to mutate a pic ibgib. If the user chooses to save, then the modal will
+ * perform the mutation, save the transform result in the given `space`, and
+ * return the new pic ibgib.
+ */
+// export function getFn_promptUpdatePicIbGib(
+//     common: CommonService,
+// ): (space: IbGibSpaceAny, picIbGib: PicIbGib_V1) => Promise<UpdatePicPromptResult | undefined> {
+//     const lc = `[${getFn_promptUpdatePicIbGib.name}]`;
+//     return async (space: IbGibSpaceAny, picIbGib: PicIbGib_V1) => {
+//         try {
+//             const modal = await common.modalController.create({
+//                 component: UpdatePicModalFormComponent,
+//                 componentProps: { picIbGib, space },
+//             });
+//             // have to register/clear modal for cancelling in case the user
+//             // presses the back button while the modal is still visible
+//             registerCancelModalOnBackButton(modal);
+//             await modal.present();
+//             let resModal = await modal.onWillDismiss();
+//             // clear the cancel since it dismissed naturally
+//             clearDoCancelModalOnBackButton();
+//             if (resModal.data) {
+//                 const result = <UpdatePicPromptResult>resModal.data;
+//                 const [resCreatePic, _resCreateBin] = result;
+//                 const addr = getIbGibAddr({ ibGib: resCreatePic.newIbGib });
+//                 if (logalot) { console.log(`${lc} updated pic. addr: ${addr}`); }
+//                 return result;
+//             } else {
+//                 // didn't create one
+//                 console.warn(`${lc} didn't create at this time.`);
+//                 return undefined;
+//             }
+//         } catch (error) {
+//             console.error(`${lc} error: ${extractErrorMsg(error)}`);
+//             return undefined;
+//         }
+//     }
+// }
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to mutate a comment ibgib. If the user chooses to save, then the modal will
+ * perform the mutation, save the transform result in the given `space`, and
+ * return the new comment ibgib.
+ */
+// export function getFn_promptUpdateCommentIbGib(
+//     common: CommonService,
+// ): (space: IbGibSpaceAny, commentIbGib: CommentIbGib_V1) => Promise<UpdateCommentPromptResult | undefined> {
+//     const lc = `[${getFn_promptUpdateCommentIbGib.name}]`;
+//     return async (space: IbGibSpaceAny, commentIbGib: CommentIbGib_V1) => {
+//         try {
+//             const modal = await common.modalController.create({
+//                 component: UpdateCommentModalFormComponent,
+//                 componentProps: { commentIbGib, space },
+//             });
+//             // have to register/clear modal for cancelling in case the user
+//             // presses the back button while the modal is still visible
+//             registerCancelModalOnBackButton(modal);
+//             await modal.present();
+//             let resModal = await modal.onWillDismiss();
+//             // clear the cancel since it dismissed naturally
+//             clearDoCancelModalOnBackButton();
+//             if (resModal.data) {
+//                 const resCreateComment = <UpdateCommentPromptResult>resModal.data;
+//                 const addr = getIbGibAddr({ ibGib: resCreateComment.newIbGib });
+//                 if (logalot) { console.log(`${lc} updated comment. addr: ${addr}`); }
+//                 return resCreateComment;
+//             } else {
+//                 // didn't create one
+//                 console.warn(`${lc} didn't create at this time.`);
+//                 return undefined;
+//             }
+//         } catch (error) {
+//             console.error(`${lc} error: ${extractErrorMsg(error)}`);
+//             return undefined;
+//         }
+//     }
+// }
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to create a robbot ibgib. If the user chooses to save, then the modal will
+ * perform the mutation, save the transform result in the given `space`, and
+ * return the new pic ibgib.
+ */
+// export function getFn_promptRobbotIbGib(
+//     common: CommonService,
+// ): (space: IbGibSpaceAny, ibGib: RobbotIbGib_V1) => Promise<RobbotPromptResult | undefined> {
+//     const lc = `[${getFn_promptRobbotIbGib.name}]`;
+//     return async (space: IbGibSpaceAny, ibGib: RobbotIbGib_V1) => {
+//         try {
+//             const modal = await common.modalController.create({
+//                 component: RobbotModalFormComponent,
+//                 componentProps: { ibGib, space },
+//             });
+//             // have to register/clear modal for cancelling in case the user
+//             // presses the back button while the modal is still visible
+//             registerCancelModalOnBackButton(modal);
+//             await modal.present();
+//             let resModal = await modal.onWillDismiss();
+//             // clear the cancel since it dismissed naturally
+//             clearDoCancelModalOnBackButton();
+//             if (resModal.data) {
+//                 const result = <RobbotPromptResult>resModal.data;
+//                 return result;
+//             } else {
+//                 // didn't create one
+//                 console.warn(`${lc} didn't create at this time.`);
+//                 return undefined;
+//             }
+//         } catch (error) {
+//             console.error(`${lc} error: ${extractErrorMsg(error)}`);
+//             return undefined;
+//         }
+//     }
+// }
+
+/**
+ * Creates a function with a single `space` arg. This fn when called shows a
+ * modal to create a app ibgib. If the user chooses to save, then the modal will
+ * perform the mutation, save the transform result in the given `space`, and
+ * return the new pic ibgib.
+ */
+// export function getFn_promptAppIbGib(
+//     common: CommonService,
+// ): (space: IbGibSpaceAny, ibGib: AppIbGib_V1) => Promise<AppPromptResult | undefined> {
+//     const lc = `[${getFn_promptAppIbGib.name}]`;
+//     return async (space: IbGibSpaceAny, ibGib: AppIbGib_V1) => {
+//         try {
+//             const modal = await common.modalController.create({
+//                 component: AppModalFormComponent,
+//                 componentProps: { ibGib, space },
+//             });
+//             // have to register/clear modal for cancelling in case the user
+//             // presses the back button while the modal is still visible
+//             registerCancelModalOnBackButton(modal);
+//             await modal.present();
+//             let resModal = await modal.onWillDismiss();
+//             // clear the cancel since it dismissed naturally
+//             clearDoCancelModalOnBackButton();
+//             if (resModal.data) {
+//                 const result = <AppPromptResult>resModal.data;
+//                 return result;
+//             } else {
+//                 // didn't create one
+//                 console.warn(`${lc} didn't create at this time.`);
+//                 return undefined;
+//             }
+//         } catch (error) {
+//             console.error(`${lc} error: ${extractErrorMsg(error)}`);
+//             return undefined;
+//         }
+//     }
+// }

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

@@ -0,0 +1,72 @@
+import { Settings_Chronologys, Settings_General, Settings_Minigame, Settings_Project, Settings_TextEditor, SettingsData_V1 } from "./settings-types.mjs";
+
+export const SETTINGS_ATOM = 'settings';
+
+// #region SettingsType enum
+export const SETTINGS_TYPE_GENERAL = 'general';
+export const SETTINGS_TYPE_TEXTEDITOR = 'text-editor';
+export const SETTINGS_TYPE_PROJECTS = 'projects';
+export const SETTINGS_TYPE_PROJECTSEXPLORER = 'projects-explorer';
+export const SETTINGS_TYPE_PROJECTSDROPDOWN = 'projects-dropdown';
+export const SETTINGS_TYPE_PROJECT = 'project';
+export const SETTINGS_TYPE_MINIGAME = 'minigame';
+export const SETTINGS_TYPE_CHRONOLOGYS = 'chronologys';
+/**
+ * Discriminator for Settings info
+ */
+export type SettingsType =
+    | typeof SETTINGS_TYPE_GENERAL
+    | typeof SETTINGS_TYPE_TEXTEDITOR
+    | typeof SETTINGS_TYPE_PROJECTS
+    | typeof SETTINGS_TYPE_PROJECTSEXPLORER
+    | typeof SETTINGS_TYPE_PROJECTSDROPDOWN
+    | typeof SETTINGS_TYPE_PROJECT
+    | typeof SETTINGS_TYPE_MINIGAME
+    | typeof SETTINGS_TYPE_CHRONOLOGYS
+    ;
+export const SettingsType = {
+    general: SETTINGS_TYPE_GENERAL satisfies SettingsType,
+    textEditor: SETTINGS_TYPE_TEXTEDITOR satisfies SettingsType,
+    projects: SETTINGS_TYPE_PROJECTS satisfies SettingsType,
+    projectsExplorer: SETTINGS_TYPE_PROJECTSEXPLORER satisfies SettingsType,
+    projectsDropdown: SETTINGS_TYPE_PROJECTSDROPDOWN satisfies SettingsType,
+    project: SETTINGS_TYPE_PROJECT satisfies SettingsType,
+    minigame: SETTINGS_TYPE_MINIGAME satisfies SettingsType,
+    chronologys: SETTINGS_TYPE_CHRONOLOGYS satisfies SettingsType,
+} satisfies { readonly [key: string]: SettingsType; };
+export const SETTINGS_TYPE_VALID_VALUES: SettingsType[] = Object.values(SettingsType);
+export function isSettingsType(value: any): value is SettingsType {
+    return SETTINGS_TYPE_VALID_VALUES.includes(value);
+}
+// #endregion SettingsType enum
+
+export const DEFAULT_SETTINGS_GENERAL: Settings_General = {
+    type: SettingsType.general,
+    editor: undefined,
+    readonly: true,
+    viewer: 'ibgib-raw-viewer',
+}
+export const DEFAULT_SETTINGS_TEXTEDITOR: Settings_TextEditor = {
+    type: SettingsType.textEditor,
+    wrap: 'wrap',
+}
+export const DEFAULT_SETTINGS_PROJECT: Settings_Project = {
+    type: SettingsType.project,
+    openChildTjpAddrs: [],
+    activeChildTjpAddr: undefined,
+    lensMode: 'raw',
+}
+export const DEFAULT_SETTINGS_MINIGAME: Settings_Minigame = {
+    type: SettingsType.minigame,
+}
+
+export const DEFAULT_SETTINGS_CHRONOLOGYS: Settings_Chronologys = {
+    type: SettingsType.chronologys,
+    openChildTjpAddrs: [],
+    activeChildTjpAddr: undefined,
+}
+
+export const DEFAULT_SETTINGS_DATA_V1: SettingsData_V1 = {
+    sections: {},
+    children: {},
+}