@ibgib/web-gib 0.0.1

package/dist/common/project/project-constants.mjs

@@ -0,0 +1,71 @@
+import { SETTINGS_ATOM } from "../settings/settings-constants.mjs";
+import { ChatAPIFunctionInfos } from "../../api/commands/chat/chat-index.mjs";
+import { IbGibAPIFunctionInfos } from "../../api/commands/ibgib/ibgib-index.mjs";
+// import { editProjectFunctionInfo } from "../../api/commands/project/project-edit.mjs";
+import { TextAPIFunctionInfos } from "../../api/commands/text/text-index.mjs";
+// import { MinigameFunctionInfos } from "../../api/commands/minigame/minigame-index.mjs";
+import { updateCSSVariablesFunctionInfo } from "../../api/commands/ui/update-css-variables.mjs";
+export const PROJECT_ATOM = 'project';
+/**
+ * must match {@link PROJECT_MAX_NAME_LENGTH}
+ */
+export const PROJECT_NAME_REGEXP = /^[a-zA-Z0-9_\-. ]{1,128}$/;
+export const PROJECT_DESC_REGEXP = /.{1,255}/;
+/**
+ * must match {@link PROJECT_NAME_REGEXP}
+ */
+export const PROJECT_MAX_NAME_LENGTH = 128;
+export const PROJECT_SETTINGS_SCOPE = `${SETTINGS_ATOM}_${PROJECT_ATOM}`;
+export const DEFAULT_PROJECT_SAFE_NAME_LENGTH = 32;
+/**
+ * change this in the future if we add more fields
+ */
+export const DEFAULT_PROJECT_ADDL_METADATA_LENGTH = 32;
+// export const DEFAULT_PROJECT_DATA_V1 ,
+// export const DEFAULT_PROJECT_REL8NS_V1,
+export const PROJECT_REL8N_NAME = PROJECT_ATOM;
+/**
+ * project children are ibgibs that are expected to be shown in a project tab.
+ * These are _kinda_ like contained files/folders when viewing the project as a
+ * folder.
+ */
+export const PROJECT_CHILD_DEFAULT_REL8N_NAME = 'child';
+/**
+ * all over the place, but the idea is here that barring a few key rel8nNames
+ * (e.g. dna, ancestor, past, etc.), all other rel8nNames are considered
+ * "children".
+ */
+export const PROJECT_CHILD_TEXT_REL8N_NAME = 'text';
+/**
+ * @constant ProjectAgentFunctionInfos - An array of all available API functions for project agents.
+ */
+export const ProjectFunctionInfos = [
+// editProjectFunctionInfo,
+];
+export const ProjectChildTextFunctionInfos = [
+// ?
+];
+export const AGENT_AVAILABLE_FUNCTIONS_PROJECTAGENT = [
+    updateCSSVariablesFunctionInfo,
+    ...ChatAPIFunctionInfos,
+    ...TextAPIFunctionInfos,
+    ...IbGibAPIFunctionInfos,
+    ...ProjectFunctionInfos,
+];
+export const AGENT_AVAILABLE_FUNCTIONS_PROJECTCHILDTEXTAGENT = [
+    ...ChatAPIFunctionInfos,
+    ...TextAPIFunctionInfos,
+    ...IbGibAPIFunctionInfos,
+];
+// ugly hack for some circular dependency that I can't find
+// setTimeout(async () => {
+//     while (!MinigameFunctionInfos) {
+//         await delay(100);
+//         debugger;
+//     }
+//     MinigameFunctionInfos.forEach(x => {
+//         AGENT_AVAILABLE_FUNCTIONS_PROJECTAGENT.push(x);
+//         AGENT_AVAILABLE_FUNCTIONS_PROJECTCHILDTEXTAGENT.push(x);
+//     }); // hasn't initialized yet
+// });
+//# sourceMappingURL=project-constants.mjs.map

package/dist/common/project/project-constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-constants.mjs","sourceRoot":"","sources":["../../../src/common/project/project-constants.mts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,yFAAyF;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAC9E,0FAA0F;AAC1F,OAAO,EAAE,8BAA8B,EAAE,MAAM,gDAAgD,CAAC;AAEhG,MAAM,CAAC,MAAM,YAAY,GAAG,SAAS,CAAC;AACtC;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,2BAA2B,CAAC;AAC/D,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;AAC9C;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAE3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,aAAa,IAAI,YAAY,EAAE,CAAC;AAEzE,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AACnD;;GAEG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,EAAE,CAAC;AAEvD,yCAAyC;AACzC,0CAA0C;AAE1C,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAC/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,OAAO,CAAC;AACxD;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAA2B;AACxD,2BAA2B;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAA2B;AACjE,IAAI;CACP,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAA2B;IAC1E,8BAA8B;IAC9B,GAAG,oBAAoB;IACvB,GAAG,oBAAoB;IACvB,GAAG,qBAAqB;IACxB,GAAG,oBAAoB;CAC1B,CAAC;AAEF,MAAM,CAAC,MAAM,+CAA+C,GAA2B;IACnF,GAAG,oBAAoB;IACvB,GAAG,oBAAoB;IACvB,GAAG,qBAAqB;CAC3B,CAAC;AAEF,2DAA2D;AAC3D,2BAA2B;AAC3B,uCAAuC;AACvC,4BAA4B;AAC5B,oBAAoB;AACpB,QAAQ;AACR,2CAA2C;AAC3C,0DAA0D;AAC1D,mEAAmE;AACnE,oCAAoC;AACpC,MAAM"}

package/dist/common/project/project-helper.d.mts

@@ -0,0 +1,127 @@
+import { Ib, TransformResult } from '@ibgib/ts-gib/dist/types.mjs';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
+import { CommentIbGib_V1 } from '@ibgib/core-gib/dist/common/comment/comment-types.mjs';
+import { IbGibSpaceAny } from '@ibgib/core-gib/dist/witness/space/space-base-v1.mjs';
+import { MetaspaceService } from '@ibgib/core-gib/dist/witness/space/metaspace/metaspace-types.mjs';
+import { ProjectData_V1, ProjectIbGib_V1, ProjectIbInfo } from './project-types.mjs';
+export declare function getProjectSafeName({ name }: {
+    name: string;
+}): string;
+/**
+ * Generates the `ib` string for a ProjectIbGib based on its data.
+ * The structure is: `${PROJECT_ATOM} ${safeName} ${addlMetadataText}`
+ * where addlMetadataText contains underscore-delimited fields like timestampInTicks.
+ *
+ * ## notes
+ *
+ * atow (04/2025), we are "descending" (forking) from a source comment ibgib to
+ * create the project. As such, we are positioning the project ibgib itself to
+ * have a similar structure to a comment ibgib. So the schema for the `ib`
+ * purposefully has the safeName in the second position just like a comment
+ * ibgib has a saferized version of the comment.data.text in its ib schema.
+ *
+ * WARNING
+ * WARNING
+ * ATOW (05/2025) THIS FUNCTION'S DETAILS ARE USED IN MUT8-IBGIB
+ * APIFUNCTIONINFO.  IF THIS CHANGES, THEN THAT FUNCTION MUST BE CHANGED TOO.
+ * WARNING
+ * WARNING
+ *
+ * @see {@link ProjectIbInfo}
+ * @see {@link ProjectAddlMetadataInfo}
+ *
+ */
+export declare function getProjectIb({ data, }: {
+    data: ProjectData_V1;
+}): string;
+export declare function validateProjectIb({ ib, }: {
+    ib: Ib;
+}): string[] | undefined;
+/**
+ * Parses a project `ib` string into its components.
+ *
+ * @see {@link getProjectIb} for expected ib schema
+ */
+export declare function parseProjectIb({ ib, }: {
+    ib: Ib;
+}): ProjectIbInfo;
+/**
+ * Validates the ProjectData_V1 structure.
+ * Returns array of error messages if invalid, otherwise undefined.
+ */
+export declare function validateProjectData_V1({ data, }: {
+    data: ProjectData_V1 | any;
+}): string[] | undefined;
+/**
+ * Validates a ProjectIbGib_V1 intrinsically, its data, and the consistency
+ * between the ib string and the data content.
+ * Returns an array of error messages if invalid, otherwise undefined.
+ */
+export declare function validateProjectIbGib_V1({ ibGib, }: {
+    ibGib: IbGib_V1;
+}): Promise<string[] | undefined>;
+/**
+ * Type guard to check if an object conforms to ProjectData_V1 structure.
+ */
+export declare function isProjectData_V1(data: any): data is ProjectData_V1;
+/**
+ * Type guard to check if an IbGib_V1 is structurally a ProjectIbGib_V1.
+ * Verifies the atom in the ib and checks data structure using isProjectData_V1.
+ */
+export declare function isProjectIbGib_V1(ibGib: IbGib_V1): ibGib is ProjectIbGib_V1;
+/**
+ * Creates a new Project ibGib.
+ */
+export declare function createProjectIbGib({ name, srcCommentIbGib, description, saveInSpace, space, }: {
+    name: string;
+    /**
+     * NOT implemented yet
+     */
+    srcCommentIbGib?: CommentIbGib_V1;
+    description?: string;
+    /**
+     * If true, saves the newly created project ibgib and all intermediate
+     * dependency ibgibs (dna and others) in the given {@link space}, or default
+     * local space if that is falsy.
+     */
+    saveInSpace?: boolean;
+    /**
+     * If set and {@link saveInSpace} is true, then this will be where all
+     * ibgibs are saved.
+     */
+    space?: IbGibSpaceAny;
+}): Promise<TransformResult<ProjectIbGib_V1>>;
+interface AddChildOptsDetails_Text {
+    type: 'text';
+    title?: string;
+    text?: string;
+}
+interface AddChildOptsDetails_Canvas {
+    wakka: string;
+}
+/**
+ * discriminate union other options here
+ */
+type AddChildOptsDetails = AddChildOptsDetails_Text | AddChildOptsDetails_Canvas;
+interface AddChildOpts<TDetails extends AddChildOptsDetails = any> {
+    type: 'text';
+    ibGib: IbGib_V1;
+    details: TDetails;
+    /**
+     * rel8nName to use to rel8 the child to the ibgib.
+     */
+    rel8nName?: string;
+    metaspace: MetaspaceService;
+    space: IbGibSpaceAny;
+}
+export declare function addChildIbGib(arg: AddChildOpts): Promise<IbGib_V1>;
+/**
+ * Retrieves all the latest project ibGibs from a given space (or the default
+ * local user space).
+ */
+export declare function getProjects({ metaspace, space, }: {
+    metaspace: MetaspaceService;
+    space?: IbGibSpaceAny;
+}): Promise<ProjectIbGib_V1[]>;
+export {};
+//# sourceMappingURL=project-helper.d.mts.map

package/dist/common/project/project-helper.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-helper.d.mts","sourceRoot":"","sources":["../../../src/common/project/project-helper.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAGnE,OAAO,EAAE,QAAQ,EAAG,MAAM,iCAAiC,CAAC;AAK5D,OAAO,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAC;AAExF,OAAO,EAAE,aAAa,EAAE,MAAM,sDAAsD,CAAC;AAErF,OAAO,EAAE,gBAAgB,EAAE,MAAM,kEAAkE,CAAC;AASpG,OAAO,EACH,cAAc,EAAE,eAAe,EAAE,aAAa,EACjD,MAAM,qBAAqB,CAAC;AAM7B,wBAAgB,kBAAkB,CAAC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAgBrE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,YAAY,CAAC,EACzB,IAAI,GACP,EAAE;IACC,IAAI,EAAE,cAAc,CAAC;CACxB,GAAG,MAAM,CAmCT;AAED,wBAAgB,iBAAiB,CAAC,EAC9B,EAAE,GACL,EAAE;IACC,EAAE,EAAE,EAAE,CAAC;CACV,GAAG,MAAM,EAAE,GAAG,SAAS,CAoBvB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAC3B,EAAE,GACL,EAAE;IACC,EAAE,EAAE,EAAE,CAAC;CACV,GAAG,aAAa,CA8ChB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,EACnC,IAAI,GACP,EAAE;IACC,IAAI,EAAE,cAAc,GAAG,GAAG,CAAC;CAC9B,GAAG,MAAM,EAAE,GAAG,SAAS,CAuFvB;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,EAC1C,KAAK,GACR,EAAE;IACC,KAAK,EAAE,QAAQ,CAAC;CACnB,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAkChC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,cAAc,CAalE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,IAAI,eAAe,CAM3E;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,EACrC,IAAI,EACJ,eAAe,EACf,WAAW,EACX,WAAW,EACX,KAAK,GACR,EAAE;IACC,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB,GAAG,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,CAiI5C;AAED,UAAU,wBAAwB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,UAAU,0BAA0B;IAChC,KAAK,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,KAAK,mBAAmB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;AAEjF,UAAU,YAAY,CAAC,QAAQ,SAAS,mBAAmB,GAAG,GAAG;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,KAAK,EAAE,aAAa,CAAC;CACxB;AAGD,wBAAgB,aAAa,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiBlE;AA0DD;;;GAGG;AACH,wBAAsB,WAAW,CAAC,EAC9B,SAAS,EACT,KAAK,GACR,EAAE;IACC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CA2F7B"}