@blkc-code/mapgen 0.0.0-stage → 0.6.0

package/README.md

@@ -1,3 +1,11 @@
-# Temporary Holding Version
+# @blkc-code/mapgen
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Grow a unique map from a project, and keep it in step as the project changes. Rooms that exist stay where they are, and new folders add new ones. The output is plain JSON, so any renderer can draw it.
+
+```ts
+import { evolveMap, scanProject } from "@blkc-code/mapgen";
+
+const { map, changes } = evolveMap(previous, scanProject("."), "my-project");
+```
+
+Part of [BLKC](https://blkc.blackcode.space). Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+/**
+ * BLKC Mapgen. Grows a building from a project. Every project gets its own map: the seed comes from its
+ * name, and the rooms from its folders. The map evolves rather than regenerates: rooms that
+ * exist stay where they are, new folders add rooms, bigger folders get bigger rooms, and a
+ * room someone has edited by hand is never touched again.
+ *
+ * Folder names, file counts and project manifests (package.json, pnpm-workspace.yaml) are read
+ * here, never source code.
+ */
+import { type RoomRole, type Theme, type WorldPlan } from "./plan.js";
+export * from "./plan.js";
+export * from "./project-files.js";
+export * from "./tree.js";
+export * from "./roads.js";
+export interface MapRoom {
+    id: string;
+    name: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    floor: string;
+    paths: string[];
+    /** lobby, lounge and quests are always there. hall is a corridor. vacant is an empty room, free for the next folder. */
+    role?: RoomRole;
+    /** Edited by hand: the generator leaves it alone. */
+    locked?: boolean;
+    files?: number;
+    /** The road this sits on, as a path. */
+    road?: string;
+}
+export interface MapItem {
+    type: string;
+    x: number;
+    y: number;
+    room?: string;
+    /** The real folder or file group this stands for. */
+    part?: string;
+    /** Shown beside it on the map, for things like a group of loose files. */
+    label?: string;
+}
+export interface MapDoor {
+    x: number;
+    y: number;
+}
+export interface OfficeMap {
+    version: 1;
+    /** Which world this map is for. The office if left out. */
+    world?: string;
+    /** roads: grows from the project's folders, with no size limit. halls: even rows along corridors. Left out on the oldest maps. */
+    layout?: "halls" | "roads";
+    /** How tall the rooms are in the first pair of rows. */
+    roomHeight?: number;
+    seed: string;
+    /** Follow the project as it changes. */
+    evolve: boolean;
+    cols: number;
+    rows: number;
+    rooms: MapRoom[];
+    doors: MapDoor[];
+    furniture: MapItem[];
+    log: {
+        at: string;
+        text: string;
+    }[];
+    /** Which rooms depend on which, and whether a door joins them. */
+    links?: MapLink[];
+}
+export interface MapLink {
+    from: string;
+    to: string;
+    door: boolean;
+}
+/** A map, for any world. */
+export type WorldMap = OfficeMap;
+export interface ProjectArea {
+    id: string;
+    name: string;
+    path: string;
+    files: number;
+    /** How many other areas depend on this one. */
+    dependents?: number;
+    /** The folder path it sits on, such as "apps/". */
+    street?: string;
+}
+/** How to read a project. This is the part of a Kit's world.json the scan needs. */
+export interface ScanOptions {
+    /** File names that mark a folder as an application, such as "go.mod" or "*.xydsf". */
+    markers?: string[];
+    /** Use only `markers`, not the built-in ones as well. */
+    replaceDefaults?: boolean;
+    /** Folders that get a building even with no marker. */
+    include?: string[];
+    /** Folders that never get a building: a name, or a path from the top. */
+    ignore?: string[];
+}
+export interface ProjectScan {
+    areas: ProjectArea[];
+    rootFiles: number;
+    /** `from` depends on `to`. */
+    links?: {
+        from: string;
+        to: string;
+    }[];
+    /** Folders that didn't make the map. */
+    omitted?: number;
+}
+export declare const slug: (value: string) => string;
+export declare const titled: (value: string) => string;
+export declare function hashText(text: string): number;
+/** A small seeded generator, so the same project always grows the same way. */
+export declare function rng(seed: string): () => number;
+/** Folder names, file counts and how the folders depend on each other. */
+export declare function scanProject(root: string, options?: ScanOptions): ProjectScan;
+/** The look comes from a folder's own name, so everything in apps/ doesn't look like a front end. */
+export declare function themeFor(folder: string, plan: WorldPlan, random: () => number): Theme;
+export declare const deskCount: (files: number) => number;
+export declare function furnish(room: MapRoom, doors: MapDoor[], seed: string, plan: WorldPlan): MapItem[];
+/**
+ * The map after the project's latest changes, or a new one. Returns what changed in words.
+ * Pure: the same map, scan and seed always give the same result.
+ */
+export declare function evolveMap(previous: OfficeMap | undefined, scan: ProjectScan, seed: string, now?: string, newWorld?: WorldPlan): {
+    map: OfficeMap;
+    changes: string[];
+};
+/** The room a project file belongs to: the longest matching folder. */
+export declare function roomForPath(rooms: {
+    id: string;
+    paths?: string[];
+}[], relative: string): string | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH,OAAO,EAA0B,KAAK,QAAQ,EAAE,KAAK,KAAK,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAE9F,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAE3B,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,wHAAwH;IACxH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,qDAAqD;IACrD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,OAAO;IAAG,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE;AACjD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,CAAC,CAAC;IACX,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kIAAkI;IAClI,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC3B,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,GAAG,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACpC,kEAAkE;IAClE,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AACD,MAAM,WAAW,OAAO;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE;AAEpE,4BAA4B;AAC5B,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC;AAEjC,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oFAAoF;AACpF,MAAM,WAAW,WAAW;IAC1B,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,yDAAyD;IACzD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACvC,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAiBD,eAAO,MAAM,IAAI,GAAI,OAAO,MAAM,KAAG,MAA8F,CAAC;AACpI,eAAO,MAAM,MAAM,GAAI,OAAO,MAAM,KAAG,MACiH,CAAC;AAEzJ,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7C;AAED,+EAA+E;AAC/E,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,MAAM,CAS9C;AA+CD,0EAA0E;AAC1E,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,WAAW,CA8HhF;AAID,qGAAqG;AACrG,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,MAAM,GAAG,KAAK,CAMrF;AAYD,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,KAAG,MAAwE,CAAC;AAiOnH,wBAAgB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,EAAE,CAuGjG;AAgBD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,SAA2B,EAAE,QAAQ,GAAE,SAAuB,GAAG;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAsKpM;AAED,uEAAuE;AACvE,wBAAgB,WAAW,CAAC,KAAK,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAa3G"}