@isentinel/rojo-utils 0.1.0

package/out-tsc/index.d.ts

@@ -0,0 +1,10 @@
+export { loadRojoProject } from "./loader.ts";
+export { collectMounts, pruneAncestors } from "./mount-collector.ts";
+export type { Mount, PathClassifier, PathKind } from "./mount-collector.ts";
+export { mapFsPathToDataModel, mapFsRootToDataModel } from "./path-mapper.ts";
+export { FileRelation, NetworkType, RbxPathParent, RbxType, RojoResolver, } from "./rojo-resolver.ts";
+export type { PartitionInfo, RbxPath, RelativeRbxPath, RojoResolverState, } from "./rojo-resolver.ts";
+export { collectPaths, rebaseTreePaths, resolveNestedProjects, resolveNestedProjectSources, } from "./rojo-tree.ts";
+export { findInTree, matchNodePath } from "./tree-mapper.ts";
+export type { LoadedRojoProject, RojoProject, RojoTreeNode } from "./types.ts";
+//# sourceMappingURL=index.d.ts.map

package/out-tsc/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACrE,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EACN,YAAY,EACZ,WAAW,EACX,aAAa,EACb,OAAO,EACP,YAAY,GACZ,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACX,aAAa,EACb,OAAO,EACP,eAAe,EACf,iBAAiB,GACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,2BAA2B,GAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC7D,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}

package/out-tsc/index.js

@@ -0,0 +1,6 @@
+export { loadRojoProject } from "./loader.js";
+export { collectMounts, pruneAncestors } from "./mount-collector.js";
+export { mapFsPathToDataModel, mapFsRootToDataModel } from "./path-mapper.js";
+export { FileRelation, NetworkType, RbxPathParent, RbxType, RojoResolver, } from "./rojo-resolver.js";
+export { collectPaths, rebaseTreePaths, resolveNestedProjects, resolveNestedProjectSources, } from "./rojo-tree.js";
+export { findInTree, matchNodePath } from "./tree-mapper.js";

package/out-tsc/loader.d.ts

@@ -0,0 +1,3 @@
+import type { LoadedRojoProject } from "./types.ts";
+export declare function loadRojoProject(projectPath: string): LoadedRojoProject;
+//# sourceMappingURL=loader.d.ts.map

package/out-tsc/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAgB,MAAM,YAAY,CAAC;AAElE,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,iBAAiB,CAsCtE"}

package/out-tsc/loader.js

@@ -0,0 +1,37 @@
+import { readFileSync } from "node:fs";
+import { dirname } from "node:path";
+import { resolveNestedProjects } from "./rojo-tree.js";
+export function loadRojoProject(projectPath) {
+    let content;
+    try {
+        content = readFileSync(projectPath, "utf-8");
+    }
+    catch (err) {
+        throw new Error(`Could not read Rojo project: ${projectPath}`, { cause: err });
+    }
+    let parsed;
+    try {
+        parsed = JSON.parse(content);
+    }
+    catch (err) {
+        throw new Error(`Failed to parse Rojo project: ${projectPath}`, { cause: err });
+    }
+    if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
+        throw new Error(`Rojo project must be a JSON object: ${projectPath}`);
+    }
+    const raw = parsed;
+    if (typeof raw["name"] !== "string" || raw["name"] === "") {
+        throw new Error(`Rojo project must have a non-empty "name" field: ${projectPath}`);
+    }
+    if (typeof raw["tree"] !== "object" || raw["tree"] === null || Array.isArray(raw["tree"])) {
+        throw new Error(`Rojo project must have a "tree" object: ${projectPath}`);
+    }
+    const rootDirectory = dirname(projectPath);
+    const tree = resolveNestedProjects(raw["tree"], rootDirectory);
+    return {
+        name: raw["name"],
+        raw,
+        servePort: typeof raw["servePort"] === "number" ? raw["servePort"] : undefined,
+        tree,
+    };
+}

package/out-tsc/mount-collector.d.ts

@@ -0,0 +1,10 @@
+import type { RojoTreeNode } from "./types.ts";
+export type PathKind = "directory" | "file" | "missing";
+export type PathClassifier = (fsPath: string) => PathKind;
+export interface Mount {
+    dataModelPath: string;
+    fsPath: string;
+}
+export declare function collectMounts(node: RojoTreeNode, currentDataModelPath: string, classify: PathClassifier): Array<Mount>;
+export declare function pruneAncestors(paths: Array<string>): Array<string>;
+//# sourceMappingURL=mount-collector.d.ts.map

package/out-tsc/mount-collector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount-collector.d.ts","sourceRoot":"","sources":["../src/mount-collector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,MAAM,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAExD,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,QAAQ,CAAC;AAE1D,MAAM,WAAW,KAAK;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CACf;AAID,wBAAgB,aAAa,CAC5B,IAAI,EAAE,YAAY,EAClB,oBAAoB,EAAE,MAAM,EAC5B,QAAQ,EAAE,cAAc,GACtB,KAAK,CAAC,KAAK,CAAC,CAId;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAIlE"}

package/out-tsc/mount-collector.js

@@ -0,0 +1,37 @@
+const TrailingSlashPattern = /\/$/;
+export function collectMounts(node, currentDataModelPath, classify) {
+    const result = [];
+    walk(node, currentDataModelPath, classify, result);
+    return result;
+}
+export function pruneAncestors(paths) {
+    return paths.filter((candidate) => {
+        return paths.every((other) => other === candidate || !candidate.startsWith(`${other}/`));
+    });
+}
+function addDirectoryMount(node, dataModelPath, classify, result) {
+    const rawPath = node.$path;
+    if (typeof rawPath !== "string") {
+        return;
+    }
+    if (rawPath.endsWith(".project.json")) {
+        return;
+    }
+    const fsPath = rawPath.replace(TrailingSlashPattern, "");
+    if (classify(fsPath) === "directory") {
+        result.push({ dataModelPath, fsPath });
+    }
+}
+function isTreeChild(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function walk(node, currentDataModelPath, classify, result) {
+    for (const [key, value] of Object.entries(node)) {
+        if (key.startsWith("$") || !isTreeChild(value)) {
+            continue;
+        }
+        const childDataModelPath = currentDataModelPath === "" ? key : `${currentDataModelPath}/${key}`;
+        addDirectoryMount(value, childDataModelPath, classify, result);
+        walk(value, childDataModelPath, classify, result);
+    }
+}

package/out-tsc/path-mapper.d.ts

@@ -0,0 +1,4 @@
+import type { RojoTreeNode } from "./types.ts";
+export declare function mapFsRootToDataModel(outDirectory: string, rojoTree: RojoTreeNode): string;
+export declare function mapFsPathToDataModel(fsPath: string, rojoTree: RojoTreeNode): string | undefined;
+//# sourceMappingURL=path-mapper.d.ts.map

package/out-tsc/path-mapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-mapper.d.ts","sourceRoot":"","sources":["../src/path-mapper.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI/C,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM,CAgBzF;AAKD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAiB/F"}

package/out-tsc/path-mapper.js

@@ -0,0 +1,34 @@
+import { collectPaths } from "./rojo-tree.js";
+import { findInTree } from "./tree-mapper.js";
+const TRAILING_SLASH = /\/$/;
+export function mapFsRootToDataModel(outDirectory, rojoTree) {
+    const normalized = outDirectory.replace(TRAILING_SLASH, "");
+    const result = findInTree(rojoTree, normalized, "");
+    if (result === undefined) {
+        const available = [];
+        collectPaths(rojoTree, available);
+        let message = `No Rojo tree mapping found for path: ${normalized}`;
+        if (available.length > 0) {
+            message += `\n\nAvailable $path entries: ${available.join(", ")}`;
+        }
+        throw new Error(message);
+    }
+    return result;
+}
+const LUAU_EXTENSIONS = /\.luau?$/;
+const INIT_SUFFIX = /\/init$/;
+export function mapFsPathToDataModel(fsPath, rojoTree) {
+    const normalized = fsPath.replaceAll("\\", "/").replace(LUAU_EXTENSIONS, "");
+    const withoutInit = normalized.replace(INIT_SUFFIX, "");
+    const rootPath = rojoTree.$path;
+    if (typeof rootPath === "string") {
+        const normalizedRootPath = rootPath.replace(TRAILING_SLASH, "");
+        if (withoutInit === normalizedRootPath) {
+            return "";
+        }
+        if (withoutInit.startsWith(`${normalizedRootPath}/`)) {
+            return withoutInit.slice(normalizedRootPath.length + 1);
+        }
+    }
+    return findInTree(rojoTree, withoutInit, "");
+}

package/out-tsc/rojo-resolver.d.ts

@@ -0,0 +1,110 @@
+interface RojoTreeProperty {
+    Type: string;
+    Value: unknown;
+}
+interface RojoTreeMetadata {
+    $className?: string;
+    $ignoreUnknownInstances?: boolean;
+    $path?: string | {
+        optional: string;
+    };
+    $properties?: Array<RojoTreeProperty>;
+}
+type RojoTree = RojoTreeMembers & RojoTreeMetadata;
+interface RojoTreeMembers {
+    [name: string]: RojoTree;
+}
+export declare const RbxType: {
+    readonly LocalScript: 2;
+    readonly ModuleScript: 0;
+    readonly Script: 1;
+    readonly Unknown: 3;
+};
+export type RbxType = (typeof RbxType)[keyof typeof RbxType];
+/** Represents a roblox tree path. */
+export type RbxPath = ReadonlyArray<string>;
+export type RelativeRbxPath = ReadonlyArray<RbxPathParent | string>;
+export interface PartitionInfo {
+    fsPath: string;
+    rbxPath: RbxPath;
+}
+export declare const FileRelation: {
+    readonly InToIn: 3;
+    readonly InToOut: 2;
+    readonly OutToIn: 1;
+    readonly OutToOut: 0;
+};
+export type FileRelation = (typeof FileRelation)[keyof typeof FileRelation];
+export declare const NetworkType: {
+    readonly Client: 1;
+    readonly Server: 2;
+    readonly Unknown: 0;
+};
+export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
+/** Serializable snapshot of a {@link RojoResolver} for disk caching. */
+export interface RojoResolverState {
+    filePathToRbxPathMap: Array<[string, RbxPath]>;
+    isGame: boolean;
+    isolatedContainers: Array<RbxPath>;
+    partitions: Array<PartitionInfo>;
+    walkedConfigFiles: Array<string>;
+    walkedDirs: Array<string>;
+    warnings: Array<string>;
+}
+export declare const RbxPathParent: unique symbol;
+export type RbxPathParent = typeof RbxPathParent;
+export declare class RojoResolver {
+    private readonly rbxPath;
+    private readonly realpathCache;
+    private readonly walkedConfigFilesInternal;
+    private readonly walkedDirectoriesInternal;
+    private filePathToRbxPathMap;
+    private isolatedContainers;
+    private partitions;
+    private warnings;
+    isGame: boolean;
+    static findRojoConfigFilePath(projectPath: string): {
+        path: string | undefined;
+        warnings: Array<string>;
+    };
+    static fromPath(rojoConfigFilePath: string): RojoResolver;
+    /**
+     * Restore a resolver from a {@link RojoResolverState} snapshot.
+     * @param state - The serialized resolver state to restore from.
+     * @returns A resolver equivalent to the one the state was captured from.
+     */
+    static fromState(state: RojoResolverState): RojoResolver;
+    static fromTree(basePath: string, tree: RojoTree): RojoResolver;
+    getFileRelation(fileRbxPath: RbxPath, moduleRbxPath: RbxPath): FileRelation;
+    getNetworkType(rbxPath: RbxPath): NetworkType;
+    getPartitions(): ReadonlyArray<PartitionInfo>;
+    getRbxPathFromFilePath(filePath: string): RbxPath | undefined;
+    getRbxTypeFromFilePath(filePath: string): RbxType;
+    /**
+     * Serialize this resolver to a {@link RojoResolverState} snapshot.
+     * @returns A serializable snapshot of this resolver's state.
+     */
+    getState(): RojoResolverState;
+    getWarnings(): ReadonlyArray<string>;
+    isIsolated(rbxPath: RbxPath): boolean;
+    static relative(rbxFrom: RbxPath, rbxTo: RbxPath): RelativeRbxPath;
+    /**
+     * Create a synthetic RojoResolver for ProjectType.Package. Forces all imports
+     * to be relative.
+     * @param basePath - The base filesystem path the package resolves against.
+     * @returns A resolver that maps every file in the package relatively.
+     */
+    static synthetic(basePath: string): RojoResolver;
+    get walkedConfigFiles(): ReadonlySet<string>;
+    get walkedDirectories(): ReadonlySet<string>;
+    private cachedRealpath;
+    private getContainer;
+    private parseConfig;
+    private parsePath;
+    private parseTree;
+    private searchChildren;
+    private searchDirectory;
+    private warn;
+}
+export {};
+//# sourceMappingURL=rojo-resolver.d.ts.map

package/out-tsc/rojo-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rojo-resolver.d.ts","sourceRoot":"","sources":["../src/rojo-resolver.ts"],"names":[],"mappings":"AAmBA,UAAU,gBAAgB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CACf;AAED,UAAU,gBAAgB;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACtC,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACtC;AAED,KAAK,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAEnD,UAAU,eAAe;IACxB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB;AAYD,eAAO,MAAM,OAAO;aACnB,WAAW,EAAE,CAAC;aACd,YAAY,EAAE,CAAC;aACf,MAAM,EAAE,CAAC;aACT,OAAO,EAAE,CAAC;CACD,CAAC;AAEX,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,OAAO,OAAO,CAAC,CAAC;AAQ7D,qCAAqC;AACrC,MAAM,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,eAAe,GAAG,aAAa,CAAC,aAAa,GAAG,MAAM,CAAC,CAAC;AAEpE,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACjB;AAcD,eAAO,MAAM,YAAY;aACxB,MAAM,EAAE,CAAC;aACT,OAAO,EAAE,CAAC;aACV,OAAO,EAAE,CAAC;aACV,QAAQ,EAAE,CAAC;CACF,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,eAAO,MAAM,WAAW;aACvB,MAAM,EAAE,CAAC;aACT,MAAM,EAAE,CAAC;aACT,OAAO,EAAE,CAAC;CACD,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IACjC,oBAAoB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/C,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACjC,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACjC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AA0DD,eAAO,MAAM,aAAa,EAAE,OAAO,MAAyB,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC;AAEjD,qBAAa,YAAY;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAC/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;IAC3D,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAqB;IAC/D,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAqB;IAE/D,OAAO,CAAC,oBAAoB,CAA8B;IAC1D,OAAO,CAAC,kBAAkB,CAAoC;IAC9D,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,QAAQ,CAAuB;IAEhC,MAAM,UAAS;IAEtB,OAAc,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG;QAC1D,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;QACzB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACxB,CAuBA;IAED,OAAc,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,YAAY,CAI/D;IAED;;;;OAIG;IACH,OAAc,SAAS,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY,CA6B9D;IAED,OAAc,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,YAAY,CAIrE;IAEM,eAAe,CAAC,WAAW,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAG,YAAY,CAqBjF;IAEM,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAUnD;IAEM,aAAa,IAAI,aAAa,CAAC,aAAa,CAAC,CAEnD;IAEM,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAuBnE;IAEM,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAUvD;IAED;;;OAGG;IACI,QAAQ,IAAI,iBAAiB,CAiBnC;IAEM,WAAW,IAAI,aAAa,CAAC,MAAM,CAAC,CAE1C;IAEM,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE3C;IAED,OAAc,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,eAAe,CAuBxE;IAED;;;;;OAKG;IACH,OAAc,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAItD;IAED,IAAW,iBAAiB,IAAI,WAAW,CAAC,MAAM,CAAC,CAElD;IAED,IAAW,iBAAiB,IAAI,WAAW,CAAC,MAAM,CAAC,CAElD;IAED,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,WAAW;IA8BnB,OAAO,CAAC,SAAS;IAuCjB,OAAO,CAAC,SAAS;IA6BjB,OAAO,CAAC,cAAc;IAgDtB,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,IAAI;CAGZ"}