@matserdam/prisma-neighborhood 0.0.1

package/dist/parser/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Parser module exports.
+ * Provides schema parsing functionality and type definitions.
+ */
+export { parseSchema } from "./schema-parser";
+export type { Field, Model, ParsedSchema, ParseResult, ParserOptions, Relation, RelationType, ScalarType, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/parser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EACX,KAAK,EACL,KAAK,EACL,YAAY,EACZ,WAAW,EACX,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,UAAU,GACV,MAAM,SAAS,CAAC"}

package/dist/parser/schema-parser.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Prisma schema parser using @prisma/internals.
+ * Parses Prisma schema files and converts them to our internal representation.
+ */
+import type { ParseResult, ParserOptions } from "./types";
+/**
+ * Parses a Prisma schema file and returns a structured representation.
+ *
+ * Uses @prisma/internals getDMMF to parse the schema file and extract
+ * model definitions, fields, and relationships.
+ *
+ * @param options - Parser configuration options
+ * @returns A ParseResult containing the parsed schema or an error
+ *
+ * @example
+ * ```typescript
+ * const result = await parseSchema({ schemaPath: './prisma/schema.prisma' });
+ * if (result.success) {
+ *   console.log(result.schema.models);
+ * }
+ * ```
+ */
+export declare function parseSchema(options: ParserOptions): Promise<ParseResult>;
+//# sourceMappingURL=schema-parser.d.ts.map

package/dist/parser/schema-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-parser.d.ts","sourceRoot":"","sources":["../../src/parser/schema-parser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAGX,WAAW,EACX,aAAa,EAGb,MAAM,SAAS,CAAC;AAmEjB;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,WAAW,CAChC,OAAO,EAAE,aAAa,GACpB,OAAO,CAAC,WAAW,CAAC,CA6GtB"}

package/dist/parser/types.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @fileoverview Type definitions for parsed Prisma schema models.
+ * These types provide a clean internal representation independent of Prisma internals.
+ */
+/**
+ * Represents the cardinality of a relationship between models.
+ * - ONE_TO_ONE: Single record on both sides
+ * - ONE_TO_MANY: Single record on one side, multiple on the other
+ * - MANY_TO_MANY: Multiple records on both sides
+ */
+export type RelationType = "ONE_TO_ONE" | "ONE_TO_MANY" | "MANY_TO_MANY";
+/**
+ * Represents a relationship between two models in the schema.
+ */
+export interface Relation {
+    /** The name of the related model */
+    readonly relatedModel: string;
+    /** The type of relationship (cardinality) */
+    readonly type: RelationType;
+    /** The field name on this model that defines the relation */
+    readonly fieldName: string;
+    /** Whether this is the owning side of the relation (has the foreign key) */
+    readonly isOwner: boolean;
+}
+/**
+ * Scalar field types supported in Prisma schemas.
+ */
+export type ScalarType = "String" | "Int" | "BigInt" | "Float" | "Decimal" | "Boolean" | "DateTime" | "Json" | "Bytes";
+/**
+ * Represents a field in a Prisma model.
+ */
+export interface Field {
+    /** The field name */
+    readonly name: string;
+    /** The field type (scalar type or model name for relations) */
+    readonly type: string;
+    /** Whether the field is required (not nullable) */
+    readonly isRequired: boolean;
+    /** Whether the field is a list (array) */
+    readonly isList: boolean;
+    /** Whether this field is the primary key */
+    readonly isPrimaryKey: boolean;
+    /** Whether this field is unique */
+    readonly isUnique: boolean;
+    /** Whether this field is a relation to another model */
+    readonly isRelation: boolean;
+}
+/**
+ * Represents a parsed Prisma model with its fields and relations.
+ */
+export interface Model {
+    /** The model name */
+    readonly name: string;
+    /** All fields in the model */
+    readonly fields: readonly Field[];
+    /** Relations to other models */
+    readonly relations: readonly Relation[];
+}
+/**
+ * Represents the complete parsed schema containing all models.
+ */
+export interface ParsedSchema {
+    /** All models in the schema, keyed by model name */
+    readonly models: ReadonlyMap<string, Model>;
+}
+/**
+ * Configuration options for the schema parser.
+ */
+export interface ParserOptions {
+    /** Path to the Prisma schema file */
+    readonly schemaPath: string;
+}
+/**
+ * Result of a parsing operation.
+ */
+export type ParseResult = {
+    readonly success: true;
+    readonly schema: ParsedSchema;
+} | {
+    readonly success: false;
+    readonly error: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/parser/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/parser/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,cAAc,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,oCAAoC;IACpC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAE5B,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,4EAA4E;IAC5E,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GACnB,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,GACT,UAAU,GACV,MAAM,GACN,OAAO,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB,qBAAqB;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,mDAAmD;IACnD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAE/B,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B,wDAAwD;IACxD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB,qBAAqB;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,8BAA8B;IAC9B,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IAElC,gCAAgC;IAChC,QAAQ,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB;IAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;CAAE,GACzD;IAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/renderer/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @fileoverview Renderer module exports.
+ * Provides diagram rendering functionality and type definitions.
+ */
+export { MermaidRenderer } from "./mermaid-renderer";
+export { RendererRegistry, rendererRegistry } from "./registry";
+export type { DiagramRenderer, ExportFormat, ExportResult, RendererRegistration, RenderResult, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/renderer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/renderer/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAChE,YAAY,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,oBAAoB,EACpB,YAAY,GACZ,MAAM,SAAS,CAAC"}

package/dist/renderer/mermaid-renderer.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @fileoverview Mermaid ERD renderer implementation.
+ * Converts traversed models to Mermaid Entity-Relationship Diagram syntax.
+ */
+import type { TraversedModel } from "../traversal/types";
+import type { DiagramRenderer, ExportFormat } from "./types";
+/**
+ * Mermaid ERD renderer implementation.
+ * Generates Mermaid Entity-Relationship Diagram syntax from traversed models.
+ *
+ * @example
+ * ```typescript
+ * const renderer = new MermaidRenderer();
+ * const output = renderer.render(traversedModels);
+ * console.log(output);
+ * // erDiagram
+ * //   User {
+ * //     Int id PK
+ * //     String email UK
+ * //     ...
+ * //   }
+ * ```
+ */
+export declare class MermaidRenderer implements DiagramRenderer {
+    /** Unique renderer identifier */
+    readonly name = "mermaid";
+    /** Human-readable description */
+    readonly description = "Mermaid ERD syntax - supports PNG/PDF export via mermaid-cli";
+    /**
+     * Generate Mermaid ERD syntax from traversed models.
+     *
+     * The output includes:
+     * - Entity definitions with fields and types
+     * - Primary key (PK) and unique (UK) markers
+     * - Relationship lines between entities
+     *
+     * @param models - The traversed models to render
+     * @returns The Mermaid ERD syntax as a string
+     */
+    render(models: readonly TraversedModel[]): string;
+    /**
+     * Export the diagram to PNG or PDF format.
+     * Uses mermaid-cli (@mermaid-js/mermaid-cli) for rendering.
+     *
+     * @param content - The Mermaid diagram content
+     * @param outputPath - Path to write the output file
+     * @param format - The export format (png or pdf)
+     * @throws Error if mermaid-cli is not available or export fails
+     */
+    export(content: string, outputPath: string, format: ExportFormat): Promise<void>;
+    /**
+     * Whether this renderer supports export functionality.
+     * @returns True - MermaidRenderer supports PNG/PDF export
+     */
+    supportsExport(): boolean;
+    /**
+     * Run mermaid-cli to convert the diagram to an image.
+     *
+     * @param inputPath - Path to the input .mmd file
+     * @param outputPath - Path to write the output file
+     * @param format - The export format
+     */
+    private runMermaidCli;
+}
+//# sourceMappingURL=mermaid-renderer.d.ts.map

package/dist/renderer/mermaid-renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid-renderer.d.ts","sourceRoot":"","sources":["../../src/renderer/mermaid-renderer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAgB7D;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,eAAgB,YAAW,eAAe;IACtD,iCAAiC;IACjC,QAAQ,CAAC,IAAI,aAAa;IAE1B,iCAAiC;IACjC,QAAQ,CAAC,WAAW,kEAC4C;IAEhE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,GAAG,MAAM;IA0EjD;;;;;;;;OAQG;IACG,MAAM,CACX,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,YAAY,GAClB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;OAGG;IACH,cAAc,IAAI,OAAO;IAIzB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;CA4CrB"}

package/dist/renderer/registry.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @fileoverview Renderer registry for managing diagram renderers.
+ * Provides a central registry with default renderer support.
+ */
+import type { DiagramRenderer, RendererRegistration } from "./types";
+/**
+ * Registry for managing diagram renderers.
+ * Supports registration, lookup, and listing of renderers.
+ */
+export declare class RendererRegistry {
+    /** Map of renderer name to renderer instance */
+    private readonly renderers;
+    /** The name of the default renderer */
+    private defaultRendererName;
+    /**
+     * Register a renderer with the registry.
+     *
+     * @param registration - The renderer registration configuration
+     * @throws Error if a renderer with the same name is already registered
+     *
+     * @example
+     * ```typescript
+     * registry.register({
+     *   renderer: new MermaidRenderer(),
+     *   isDefault: true
+     * });
+     * ```
+     */
+    register(registration: RendererRegistration): void;
+    /**
+     * Get a renderer by name.
+     *
+     * @param name - The renderer name to look up
+     * @returns The renderer, or undefined if not found
+     */
+    get(name: string): DiagramRenderer | undefined;
+    /**
+     * Get the default renderer.
+     *
+     * @returns The default renderer, or undefined if no default is set
+     */
+    getDefault(): DiagramRenderer | undefined;
+    /**
+     * Get the name of the default renderer.
+     *
+     * @returns The default renderer name
+     */
+    getDefaultName(): string;
+    /**
+     * Check if a renderer is registered.
+     *
+     * @param name - The renderer name to check
+     * @returns True if the renderer is registered
+     */
+    has(name: string): boolean;
+    /**
+     * Get all registered renderers.
+     *
+     * @returns An array of all registered renderers
+     */
+    list(): readonly DiagramRenderer[];
+    /**
+     * Get all renderer names.
+     *
+     * @returns An array of all registered renderer names
+     */
+    listNames(): readonly string[];
+    /**
+     * Clear all registered renderers.
+     * Primarily used for testing.
+     */
+    clear(): void;
+}
+/**
+ * The global renderer registry instance.
+ * Use this instance for registering and looking up renderers.
+ */
+export declare const rendererRegistry: RendererRegistry;
+//# sourceMappingURL=registry.d.ts.map

package/dist/renderer/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/renderer/registry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAKrE;;;GAGG;AACH,qBAAa,gBAAgB;IAC5B,gDAAgD;IAChD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAsC;IAEhE,uCAAuC;IACvC,OAAO,CAAC,mBAAmB,CAAiC;IAE5D;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,IAAI;IAiBlD;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAI9C;;;;OAIG;IACH,UAAU,IAAI,eAAe,GAAG,SAAS;IAIzC;;;;OAIG;IACH,cAAc,IAAI,MAAM;IAIxB;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B;;;;OAIG;IACH,IAAI,IAAI,SAAS,eAAe,EAAE;IAIlC;;;;OAIG;IACH,SAAS,IAAI,SAAS,MAAM,EAAE;IAI9B;;;OAGG;IACH,KAAK,IAAI,IAAI;CAIb;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,kBAAyB,CAAC"}

package/dist/renderer/types.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @fileoverview Type definitions for the pluggable renderer system.
+ * Defines the DiagramRenderer interface and registry types for extensibility.
+ */
+import type { TraversedModel } from "../traversal/types";
+/**
+ * Supported export formats for diagram rendering.
+ */
+export type ExportFormat = "png" | "pdf";
+/**
+ * Interface for diagram renderers.
+ * Implementations convert traversed models to diagram syntax and optionally
+ * support exporting to image formats.
+ *
+ * @example
+ * ```typescript
+ * class MermaidRenderer implements DiagramRenderer {
+ *   readonly name = "mermaid";
+ *
+ *   render(models: TraversedModel[]): string {
+ *     // Generate Mermaid ERD syntax
+ *     return "erDiagram\\n...";
+ *   }
+ *
+ *   async export(content: string, outputPath: string, format: ExportFormat): Promise<void> {
+ *     // Use mermaid-cli to render to PNG/PDF
+ *   }
+ * }
+ * ```
+ */
+export interface DiagramRenderer {
+    /**
+     * Unique renderer identifier (e.g., "mermaid", "plantuml").
+     * Used for CLI flag matching and registry lookup.
+     */
+    readonly name: string;
+    /**
+     * Human-readable description of the renderer.
+     * Displayed in --list-renderers output.
+     */
+    readonly description: string;
+    /**
+     * Generate diagram text from traversed models.
+     *
+     * @param models - The traversed models to render
+     * @returns The diagram syntax as a string
+     */
+    render(models: readonly TraversedModel[]): string;
+    /**
+     * Export the diagram to a file format (PNG/PDF) if supported.
+     * This method is optional - not all renderers support export.
+     *
+     * @param content - The rendered diagram content
+     * @param outputPath - Path to write the output file
+     * @param format - The export format (png or pdf)
+     * @throws Error if export is not supported or fails
+     */
+    export?(content: string, outputPath: string, format: ExportFormat): Promise<void>;
+    /**
+     * Whether this renderer supports export functionality.
+     * @returns True if export() is implemented and functional
+     */
+    supportsExport(): boolean;
+}
+/**
+ * Configuration for renderer registration.
+ */
+export interface RendererRegistration {
+    /** The renderer instance */
+    readonly renderer: DiagramRenderer;
+    /** Whether this is the default renderer */
+    readonly isDefault?: boolean;
+}
+/**
+ * Result of a render operation.
+ */
+export type RenderResult = {
+    readonly success: true;
+    readonly output: string;
+} | {
+    readonly success: false;
+    readonly error: string;
+};
+/**
+ * Result of an export operation.
+ */
+export type ExportResult = {
+    readonly success: true;
+    readonly outputPath: string;
+} | {
+    readonly success: false;
+    readonly error: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/renderer/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/renderer/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,eAAe;IAC/B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,GAAG,MAAM,CAAC;IAElD;;;;;;;;OAQG;IACH,MAAM,CAAC,CACN,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,YAAY,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,4BAA4B;IAC5B,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IAEnC,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB;IAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB;IAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/traversal/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Traversal module exports.
+ * Provides model traversal functionality and type definitions.
+ */
+export { traverseModels } from "./model-traverser";
+export type { TraversalOptions, TraversalResult, TraversedModel, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/traversal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/traversal/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,YAAY,EACX,gBAAgB,EAChB,eAAe,EACf,cAAc,GACd,MAAM,SAAS,CAAC"}

package/dist/traversal/model-traverser.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @fileoverview Model traverser for depth-limited BFS traversal.
+ * Traverses model relationships from a starting model with configurable depth.
+ */
+import type { ParsedSchema } from "../parser/types";
+import type { TraversalOptions, TraversalResult } from "./types";
+/**
+ * Performs a breadth-first traversal of model relationships starting from
+ * a specified model, with configurable depth limiting.
+ *
+ * The traversal:
+ * - Starts from the specified model at depth 0
+ * - Visits all related models at each subsequent depth level
+ * - Tracks visited models to prevent cycles
+ * - Stops when max depth is reached or all reachable models are visited
+ *
+ * @param schema - The parsed schema containing all models
+ * @param options - Traversal configuration options
+ * @returns A TraversalResult containing the traversed models or an error
+ *
+ * @example
+ * ```typescript
+ * const result = traverseModels(schema, {
+ *   startModel: 'User',
+ *   maxDepth: 2
+ * });
+ * if (result.success) {
+ *   for (const { model, depth } of result.models) {
+ *     console.log(`${model.name} at depth ${depth}`);
+ *   }
+ * }
+ * ```
+ */
+export declare function traverseModels(schema: ParsedSchema, options: TraversalOptions): TraversalResult;
+//# sourceMappingURL=model-traverser.d.ts.map

package/dist/traversal/model-traverser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-traverser.d.ts","sourceRoot":"","sources":["../../src/traversal/model-traverser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAS,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EACX,gBAAgB,EAChB,eAAe,EAEf,MAAM,SAAS,CAAC;AAKjB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,gBAAgB,GACvB,eAAe,CAkEjB"}

package/dist/traversal/types.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @fileoverview Type definitions for model traversal.
+ * These types support BFS traversal of model relationships with depth limiting.
+ */
+import type { Model } from "../parser/types";
+/**
+ * Represents a model that has been visited during traversal,
+ * including its depth level from the starting model.
+ */
+export interface TraversedModel {
+    /** The traversed model */
+    readonly model: Model;
+    /** The depth level from the starting model (0 = starting model) */
+    readonly depth: number;
+}
+/**
+ * Configuration options for model traversal.
+ */
+export interface TraversalOptions {
+    /** The name of the model to start traversal from */
+    readonly startModel: string;
+    /** Maximum depth to traverse (default: 3) */
+    readonly maxDepth?: number;
+}
+/**
+ * Result of a traversal operation.
+ */
+export type TraversalResult = {
+    readonly success: true;
+    readonly models: readonly TraversedModel[];
+} | {
+    readonly success: false;
+    readonly error: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/traversal/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/traversal/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,0BAA0B;IAC1B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAEtB,mEAAmE;IACnE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,6CAA6C;IAC7C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACxB;IAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,GACtE;IAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@matserdam/prisma-neighborhood",
+  "version": "0.0.1",
+  "description": "CLI tool that generates ERD diagrams from Prisma schemas with configurable depth traversal",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "prisma-neighborhood": "./dist/cli.js",
+    "prisma-hood": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc --emitDeclarationOnly && bun run build:cli && bun run build:index",
+    "build:cli": "bun build src/cli.ts --outfile dist/cli.js --format cjs --target node",
+    "build:index": "bun build src/index.ts --outfile dist/index.js --format cjs --target node",
+    "dev": "bun run src/cli.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "bunx @biomejs/biome check src/",
+    "lint:fix": "bunx @biomejs/biome check src/ --write",
+    "prepack": "bun run build",
+    "generate:examples": "bash scripts/generate-examples.sh"
+  },
+  "dependencies": {
+    "@prisma/internals": "^7.2.0",
+    "commander": "^14.0.0"
+  },
+  "devDependencies": {
+    "@mermaid-js/mermaid-cli": "^11.0.0",
+    "@types/bun": "latest",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.16"
+  },
+  "keywords": [
+    "prisma",
+    "erd",
+    "diagram",
+    "mermaid",
+    "cli",
+    "neighborhood",
+    "subgraph"
+  ],
+  "author": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Matserdam/prisma-neighbourhood.git"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}