@atproto/lex-builder 0.0.13 → 0.0.14

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atproto/lex-builder
 
+## 0.0.14
+
+### Patch Changes
+
+- [#4601](https://github.com/bluesky-social/atproto/pull/4601) [`ed61c62`](https://github.com/bluesky-social/atproto/commit/ed61c62f3161fcde85ee9a93f8ed339c7e06c015) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add JSDoc
+
+- Updated dependencies [[`7b9a98a`](https://github.com/bluesky-social/atproto/commit/7b9a98a763636c5f66a06da11fe6013f29dd9157), [`7b9a98a`](https://github.com/bluesky-social/atproto/commit/7b9a98a763636c5f66a06da11fe6013f29dd9157), [`7b9a98a`](https://github.com/bluesky-social/atproto/commit/7b9a98a763636c5f66a06da11fe6013f29dd9157), [`7b9a98a`](https://github.com/bluesky-social/atproto/commit/7b9a98a763636c5f66a06da11fe6013f29dd9157), [`ed61c62`](https://github.com/bluesky-social/atproto/commit/ed61c62f3161fcde85ee9a93f8ed339c7e06c015), [`7b9a98a`](https://github.com/bluesky-social/atproto/commit/7b9a98a763636c5f66a06da11fe6013f29dd9157), [`7b9a98a`](https://github.com/bluesky-social/atproto/commit/7b9a98a763636c5f66a06da11fe6013f29dd9157), [`ed61c62`](https://github.com/bluesky-social/atproto/commit/ed61c62f3161fcde85ee9a93f8ed339c7e06c015)]:
+  - @atproto/lex-schema@0.0.12
+  - @atproto/lex-document@0.0.13
+
 ## 0.0.13
 
 ### Patch Changes

package/dist/filter.d.ts

@@ -1,7 +1,62 @@
+/**
+ * Options for building a filter function to include/exclude lexicon documents.
+ */
 export type BuildFilterOptions = {
+    /**
+     * Pattern(s) for lexicon NSIDs to include.
+     *
+     * Supports glob patterns with `*` as a wildcard that matches one or more
+     * characters. If not specified, all lexicons are included by default.
+     *
+     * @example
+     * ```ts
+     * { include: 'app.bsky.*' }           // Include all app.bsky lexicons
+     * { include: ['com.atproto.*', 'app.bsky.*'] }  // Include multiple patterns
+     * ```
+     */
     include?: string | string[];
+    /**
+     * Pattern(s) for lexicon NSIDs to exclude.
+     *
+     * Supports glob patterns with `*` as a wildcard. Exclusions are applied
+     * after inclusions.
+     *
+     * @example
+     * ```ts
+     * { exclude: '*.internal.*' }         // Exclude internal lexicons
+     * { exclude: ['*.test', '*.mock'] }   // Exclude test and mock lexicons
+     * ```
+     */
     exclude?: string | string[];
 };
+/**
+ * A function that tests whether a lexicon NSID should be included.
+ *
+ * @param input - The lexicon NSID to test
+ * @returns `true` if the NSID passes the filter, `false` otherwise
+ */
 export type Filter = (input: string) => boolean;
+/**
+ * Builds a filter function from include/exclude patterns.
+ *
+ * The returned filter returns `true` for NSIDs that match any include pattern
+ * (or all NSIDs if no include patterns are specified) AND do not match any
+ * exclude pattern.
+ *
+ * @param options - The filter options containing include/exclude patterns
+ * @returns A filter function that can be applied to lexicon NSIDs
+ *
+ * @example
+ * ```ts
+ * const filter = buildFilter({
+ *   include: 'app.bsky.*',
+ *   exclude: '*.internal.*',
+ * })
+ *
+ * filter('app.bsky.feed.post')     // true
+ * filter('app.bsky.internal.foo')  // false
+ * filter('com.atproto.repo')       // false (not included)
+ * ```
+ */
 export declare function buildFilter(options: BuildFilterOptions): Filter;
 //# sourceMappingURL=filter.d.ts.map

package/dist/filter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../src/filter.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;AAE/C,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAK/D"}
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../src/filter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC5B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAK/D"}

package/dist/filter.js

@@ -1,6 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildFilter = buildFilter;
+/**
+ * Builds a filter function from include/exclude patterns.
+ *
+ * The returned filter returns `true` for NSIDs that match any include pattern
+ * (or all NSIDs if no include patterns are specified) AND do not match any
+ * exclude pattern.
+ *
+ * @param options - The filter options containing include/exclude patterns
+ * @returns A filter function that can be applied to lexicon NSIDs
+ *
+ * @example
+ * ```ts
+ * const filter = buildFilter({
+ *   include: 'app.bsky.*',
+ *   exclude: '*.internal.*',
+ * })
+ *
+ * filter('app.bsky.feed.post')     // true
+ * filter('app.bsky.internal.foo')  // false
+ * filter('com.atproto.repo')       // false (not included)
+ * ```
+ */
 function buildFilter(options) {
     const include = createMatcher(options.include, () => true);
     const exclude = createMatcher(options.exclude, () => false);

package/dist/filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.js","sourceRoot":"","sources":["../src/filter.ts"],"names":[],"mappings":";;AAOA,kCAKC;AALD,SAAgB,WAAW,CAAC,OAA2B;IACrD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;IAC1D,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAA;IAE3D,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED,SAAS,aAAa,CACpB,OAAsC,EACtC,QAAgB;IAEhB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QACrB,OAAO,QAAQ,CAAA;IACjB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IACzD,CAAC;SAAM,CAAC;QACN,OAAO,YAAY,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,CAAS,EAAE,CAAS;IAC1C,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAA;AAChD,CAAC;AAED,SAAS,YAAY,CAAC,OAAe;IACnC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,MAAM,CACtB,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAC5D,CAAA;QACD,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7C,CAAC;IAED,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,CAAA;AAC7C,CAAC","sourcesContent":["export type BuildFilterOptions = {\n  include?: string | string[]\n  exclude?: string | string[]\n}\n\nexport type Filter = (input: string) => boolean\n\nexport function buildFilter(options: BuildFilterOptions): Filter {\n  const include = createMatcher(options.include, () => true)\n  const exclude = createMatcher(options.exclude, () => false)\n\n  return (id) => include(id) && !exclude(id)\n}\n\nfunction createMatcher(\n  pattern: undefined | string | string[],\n  fallback: Filter,\n): Filter {\n  if (!pattern?.length) {\n    return fallback\n  } else if (Array.isArray(pattern)) {\n    return pattern.map(buildMatcher).reduce(combineFilters)\n  } else {\n    return buildMatcher(pattern)\n  }\n}\n\nfunction combineFilters(a: Filter, b: Filter): Filter {\n  return (input: string) => a(input) || b(input)\n}\n\nfunction buildMatcher(pattern: string): Filter {\n  if (pattern.includes('*')) {\n    const regex = new RegExp(\n      `^${pattern.replaceAll('.', '\\\\.').replaceAll('*', '.+')}$`,\n    )\n    return (input: string) => regex.test(input)\n  }\n\n  return (input: string) => pattern === input\n}\n"]}
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../src/filter.ts"],"names":[],"mappings":";;AA8DA,kCAKC;AA3BD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,WAAW,CAAC,OAA2B;IACrD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;IAC1D,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAA;IAE3D,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED,SAAS,aAAa,CACpB,OAAsC,EACtC,QAAgB;IAEhB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QACrB,OAAO,QAAQ,CAAA;IACjB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IACzD,CAAC;SAAM,CAAC;QACN,OAAO,YAAY,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,CAAS,EAAE,CAAS;IAC1C,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAA;AAChD,CAAC;AAED,SAAS,YAAY,CAAC,OAAe;IACnC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,MAAM,CACtB,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAC5D,CAAA;QACD,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7C,CAAC;IAED,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,CAAA;AAC7C,CAAC","sourcesContent":["/**\n * Options for building a filter function to include/exclude lexicon documents.\n */\nexport type BuildFilterOptions = {\n  /**\n   * Pattern(s) for lexicon NSIDs to include.\n   *\n   * Supports glob patterns with `*` as a wildcard that matches one or more\n   * characters. If not specified, all lexicons are included by default.\n   *\n   * @example\n   * ```ts\n   * { include: 'app.bsky.*' }           // Include all app.bsky lexicons\n   * { include: ['com.atproto.*', 'app.bsky.*'] }  // Include multiple patterns\n   * ```\n   */\n  include?: string | string[]\n  /**\n   * Pattern(s) for lexicon NSIDs to exclude.\n   *\n   * Supports glob patterns with `*` as a wildcard. Exclusions are applied\n   * after inclusions.\n   *\n   * @example\n   * ```ts\n   * { exclude: '*.internal.*' }         // Exclude internal lexicons\n   * { exclude: ['*.test', '*.mock'] }   // Exclude test and mock lexicons\n   * ```\n   */\n  exclude?: string | string[]\n}\n\n/**\n * A function that tests whether a lexicon NSID should be included.\n *\n * @param input - The lexicon NSID to test\n * @returns `true` if the NSID passes the filter, `false` otherwise\n */\nexport type Filter = (input: string) => boolean\n\n/**\n * Builds a filter function from include/exclude patterns.\n *\n * The returned filter returns `true` for NSIDs that match any include pattern\n * (or all NSIDs if no include patterns are specified) AND do not match any\n * exclude pattern.\n *\n * @param options - The filter options containing include/exclude patterns\n * @returns A filter function that can be applied to lexicon NSIDs\n *\n * @example\n * ```ts\n * const filter = buildFilter({\n *   include: 'app.bsky.*',\n *   exclude: '*.internal.*',\n * })\n *\n * filter('app.bsky.feed.post')     // true\n * filter('app.bsky.internal.foo')  // false\n * filter('com.atproto.repo')       // false (not included)\n * ```\n */\nexport function buildFilter(options: BuildFilterOptions): Filter {\n  const include = createMatcher(options.include, () => true)\n  const exclude = createMatcher(options.exclude, () => false)\n\n  return (id) => include(id) && !exclude(id)\n}\n\nfunction createMatcher(\n  pattern: undefined | string | string[],\n  fallback: Filter,\n): Filter {\n  if (!pattern?.length) {\n    return fallback\n  } else if (Array.isArray(pattern)) {\n    return pattern.map(buildMatcher).reduce(combineFilters)\n  } else {\n    return buildMatcher(pattern)\n  }\n}\n\nfunction combineFilters(a: Filter, b: Filter): Filter {\n  return (input: string) => a(input) || b(input)\n}\n\nfunction buildMatcher(pattern: string): Filter {\n  if (pattern.includes('*')) {\n    const regex = new RegExp(\n      `^${pattern.replaceAll('.', '\\\\.').replaceAll('*', '.+')}$`,\n    )\n    return (input: string) => regex.test(input)\n  }\n\n  return (input: string) => pattern === input\n}\n"]}

package/dist/formatter.d.ts

@@ -1,13 +1,54 @@
 import { Options as PrettierOptions } from 'prettier';
+/**
+ * Options for configuring the code formatter.
+ */
 export type FormatterOptions = {
-    /** @default false */
+    /**
+     * Whether to format the generated code with Prettier.
+     *
+     * - `false`: No formatting (default)
+     * - `true`: Format with default Prettier options
+     * - `PrettierOptions`: Format with custom Prettier configuration
+     *
+     * @default false
+     */
     pretty?: boolean | PrettierOptions;
+    /**
+     * A banner comment to prepend to each generated file.
+     *
+     * @default '/* THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT. *\/'
+     */
     banner?: string;
 };
+/**
+ * Formats generated TypeScript code with optional Prettier formatting
+ * and banner comments.
+ *
+ * @example
+ * ```ts
+ * const formatter = new Formatter({ pretty: true })
+ * const formatted = await formatter.format(generatedCode)
+ * ```
+ */
 export declare class Formatter {
+    /** The banner comment to prepend to formatted code. */
     readonly banner: string;
+    /** Prettier options, or `null` if formatting is disabled. */
     readonly prettierOptions: PrettierOptions | null;
+    /**
+     * Creates a new Formatter instance.
+     *
+     * @param options - Formatting configuration options
+     */
     constructor(options?: FormatterOptions);
+    /**
+     * Formats the given code string.
+     *
+     * Applies Prettier formatting if enabled, and prepends the banner comment.
+     *
+     * @param code - The TypeScript code to format
+     * @returns The formatted code with banner
+     */
     format(code: string): Promise<string>;
 }
 //# sourceMappingURL=formatter.d.ts.map

package/dist/formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,eAAe,EAA4B,MAAM,UAAU,CAAA;AAc/E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,qBAAa,SAAS;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI,CAAA;gBAEpC,OAAO,GAAE,gBAAqB;IASpC,MAAM,CAAC,IAAI,EAAE,MAAM;CAQ1B"}
+{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,eAAe,EAA4B,MAAM,UAAU,CAAA;AAc/E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;IAClC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;;;;;;GASG;AACH,qBAAa,SAAS;IACpB,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,6DAA6D;IAC7D,QAAQ,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI,CAAA;IAEhD;;;;OAIG;gBACS,OAAO,GAAE,gBAAqB;IAS1C;;;;;;;OAOG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM;CAQ1B"}

package/dist/formatter.js

@@ -12,9 +12,26 @@ const DEFAULT_FORMAT_OPTIONS = {
 const DEFAULT_BANNER = `/*
  * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
  */`;
+/**
+ * Formats generated TypeScript code with optional Prettier formatting
+ * and banner comments.
+ *
+ * @example
+ * ```ts
+ * const formatter = new Formatter({ pretty: true })
+ * const formatted = await formatter.format(generatedCode)
+ * ```
+ */
 class Formatter {
+    /** The banner comment to prepend to formatted code. */
     banner;
+    /** Prettier options, or `null` if formatting is disabled. */
     prettierOptions;
+    /**
+     * Creates a new Formatter instance.
+     *
+     * @param options - Formatting configuration options
+     */
     constructor(options = {}) {
         this.banner = options?.banner ?? DEFAULT_BANNER;
         this.prettierOptions =
@@ -22,6 +39,14 @@ class Formatter {
                 ? DEFAULT_FORMAT_OPTIONS
                 : options?.pretty || null;
     }
+    /**
+     * Formats the given code string.
+     *
+     * Applies Prettier formatting if enabled, and prepends the banner comment.
+     *
+     * @param code - The TypeScript code to format
+     * @returns The formatted code with banner
+     */
     async format(code) {
         const bannerPadding = this.banner && !this.banner.endsWith('\n') ? '\n\n' : '';
         const codePretty = this.prettierOptions

package/dist/formatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":";;;AAAA,uCAA+E;AAE/E,MAAM,sBAAsB,GAAoB;IAC9C,MAAM,EAAE,YAAY;IACpB,QAAQ,EAAE,CAAC;IACX,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,KAAK;CACrB,CAAA;AAED,MAAM,cAAc,GAAG;;IAEnB,CAAA;AAQJ,MAAa,SAAS;IACX,MAAM,CAAQ;IACd,eAAe,CAAwB;IAEhD,YAAY,UAA4B,EAAE;QACxC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,cAAc,CAAA;QAE/C,IAAI,CAAC,eAAe;YAClB,OAAO,EAAE,MAAM,KAAK,IAAI;gBACtB,CAAC,CAAC,sBAAsB;gBACxB,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,IAAI,CAAA;IAC/B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAY;QACvB,MAAM,aAAa,GACjB,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe;YACrC,CAAC,CAAC,MAAM,IAAA,iBAAc,EAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC;YAClD,CAAC,CAAC,IAAI,CAAA;QACR,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,aAAa,GAAG,UAAU,EAAE,CAAA;IACtD,CAAC;CACF;AArBD,8BAqBC","sourcesContent":["import { Options as PrettierOptions, format as prettierFormat } from 'prettier'\n\nconst DEFAULT_FORMAT_OPTIONS: PrettierOptions = {\n  parser: 'typescript',\n  tabWidth: 2,\n  semi: false,\n  singleQuote: true,\n  trailingComma: 'all',\n}\n\nconst DEFAULT_BANNER = `/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */`\n\nexport type FormatterOptions = {\n  /** @default false */\n  pretty?: boolean | PrettierOptions\n  banner?: string\n}\n\nexport class Formatter {\n  readonly banner: string\n  readonly prettierOptions: PrettierOptions | null\n\n  constructor(options: FormatterOptions = {}) {\n    this.banner = options?.banner ?? DEFAULT_BANNER\n\n    this.prettierOptions =\n      options?.pretty === true\n        ? DEFAULT_FORMAT_OPTIONS\n        : options?.pretty || null\n  }\n\n  async format(code: string) {\n    const bannerPadding =\n      this.banner && !this.banner.endsWith('\\n') ? '\\n\\n' : ''\n    const codePretty = this.prettierOptions\n      ? await prettierFormat(code, this.prettierOptions)\n      : code\n    return `${this.banner}${bannerPadding}${codePretty}`\n  }\n}\n"]}
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":";;;AAAA,uCAA+E;AAE/E,MAAM,sBAAsB,GAAoB;IAC9C,MAAM,EAAE,YAAY;IACpB,QAAQ,EAAE,CAAC;IACX,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,KAAK;CACrB,CAAA;AAED,MAAM,cAAc,GAAG;;IAEnB,CAAA;AAwBJ;;;;;;;;;GASG;AACH,MAAa,SAAS;IACpB,uDAAuD;IAC9C,MAAM,CAAQ;IACvB,6DAA6D;IACpD,eAAe,CAAwB;IAEhD;;;;OAIG;IACH,YAAY,UAA4B,EAAE;QACxC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,cAAc,CAAA;QAE/C,IAAI,CAAC,eAAe;YAClB,OAAO,EAAE,MAAM,KAAK,IAAI;gBACtB,CAAC,CAAC,sBAAsB;gBACxB,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,IAAI,CAAA;IAC/B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,IAAY;QACvB,MAAM,aAAa,GACjB,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe;YACrC,CAAC,CAAC,MAAM,IAAA,iBAAc,EAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC;YAClD,CAAC,CAAC,IAAI,CAAA;QACR,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,aAAa,GAAG,UAAU,EAAE,CAAA;IACtD,CAAC;CACF;AApCD,8BAoCC","sourcesContent":["import { Options as PrettierOptions, format as prettierFormat } from 'prettier'\n\nconst DEFAULT_FORMAT_OPTIONS: PrettierOptions = {\n  parser: 'typescript',\n  tabWidth: 2,\n  semi: false,\n  singleQuote: true,\n  trailingComma: 'all',\n}\n\nconst DEFAULT_BANNER = `/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */`\n\n/**\n * Options for configuring the code formatter.\n */\nexport type FormatterOptions = {\n  /**\n   * Whether to format the generated code with Prettier.\n   *\n   * - `false`: No formatting (default)\n   * - `true`: Format with default Prettier options\n   * - `PrettierOptions`: Format with custom Prettier configuration\n   *\n   * @default false\n   */\n  pretty?: boolean | PrettierOptions\n  /**\n   * A banner comment to prepend to each generated file.\n   *\n   * @default '/* THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT. *\\/'\n   */\n  banner?: string\n}\n\n/**\n * Formats generated TypeScript code with optional Prettier formatting\n * and banner comments.\n *\n * @example\n * ```ts\n * const formatter = new Formatter({ pretty: true })\n * const formatted = await formatter.format(generatedCode)\n * ```\n */\nexport class Formatter {\n  /** The banner comment to prepend to formatted code. */\n  readonly banner: string\n  /** Prettier options, or `null` if formatting is disabled. */\n  readonly prettierOptions: PrettierOptions | null\n\n  /**\n   * Creates a new Formatter instance.\n   *\n   * @param options - Formatting configuration options\n   */\n  constructor(options: FormatterOptions = {}) {\n    this.banner = options?.banner ?? DEFAULT_BANNER\n\n    this.prettierOptions =\n      options?.pretty === true\n        ? DEFAULT_FORMAT_OPTIONS\n        : options?.pretty || null\n  }\n\n  /**\n   * Formats the given code string.\n   *\n   * Applies Prettier formatting if enabled, and prepends the banner comment.\n   *\n   * @param code - The TypeScript code to format\n   * @returns The formatted code with banner\n   */\n  async format(code: string) {\n    const bannerPadding =\n      this.banner && !this.banner.endsWith('\\n') ? '\\n\\n' : ''\n    const codePretty = this.prettierOptions\n      ? await prettierFormat(code, this.prettierOptions)\n      : code\n    return `${this.banner}${bannerPadding}${codePretty}`\n  }\n}\n"]}

package/dist/index.d.ts

@@ -2,6 +2,39 @@ import './polyfill.js';
 import { LexBuilderLoadOptions, LexBuilderOptions, LexBuilderSaveOptions } from './lex-builder.js';
 export * from './lex-builder.js';
 export * from './lexicon-directory-indexer.js';
+/**
+ * Combined options for building a TypeScript project from Lexicon documents.
+ *
+ * This type merges all configuration options needed for the complete build
+ * process, including builder configuration, loading options, and save options.
+ *
+ * @see {@link LexBuilderOptions} for builder configuration
+ * @see {@link LexBuilderLoadOptions} for lexicon loading options
+ * @see {@link LexBuilderSaveOptions} for output save options
+ */
 export type TsProjectBuildOptions = LexBuilderOptions & LexBuilderLoadOptions & LexBuilderSaveOptions;
+/**
+ * Builds TypeScript schemas from Lexicon documents.
+ *
+ * This is the main entry point for programmatic usage of the lex-builder
+ * package. It creates a new {@link LexBuilder} instance, loads lexicon
+ * documents from the specified directory, and saves the generated TypeScript
+ * files to the output directory.
+ *
+ * @param options - Combined build options including source directory, output
+ *   directory, and generation settings
+ *
+ * @example
+ * ```ts
+ * import { build } from '@atproto/lex-builder'
+ *
+ * await build({
+ *   lexicons: './lexicons',
+ *   out: './src/generated',
+ *   pretty: true,
+ *   clear: true,
+ * })
+ * ```
+ */
 export declare function build(options: TsProjectBuildOptions): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,CAAA;AAEtB,OAAO,EAEL,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,kBAAkB,CAAA;AAEzB,cAAc,kBAAkB,CAAA;AAChC,cAAc,gCAAgC,CAAA;AAE9C,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GACnD,qBAAqB,GACrB,qBAAqB,CAAA;AAEvB,wBAAsB,KAAK,CAAC,OAAO,EAAE,qBAAqB,iBAIzD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,CAAA;AAEtB,OAAO,EAEL,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,kBAAkB,CAAA;AAEzB,cAAc,kBAAkB,CAAA;AAChC,cAAc,gCAAgC,CAAA;AAE9C;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GACnD,qBAAqB,GACrB,qBAAqB,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,qBAAqB,iBAIzD"}

package/dist/index.js

@@ -7,6 +7,29 @@ require("./polyfill.js");
 const lex_builder_js_1 = require("./lex-builder.js");
 tslib_1.__exportStar(require("./lex-builder.js"), exports);
 tslib_1.__exportStar(require("./lexicon-directory-indexer.js"), exports);
+/**
+ * Builds TypeScript schemas from Lexicon documents.
+ *
+ * This is the main entry point for programmatic usage of the lex-builder
+ * package. It creates a new {@link LexBuilder} instance, loads lexicon
+ * documents from the specified directory, and saves the generated TypeScript
+ * files to the output directory.
+ *
+ * @param options - Combined build options including source directory, output
+ *   directory, and generation settings
+ *
+ * @example
+ * ```ts
+ * import { build } from '@atproto/lex-builder'
+ *
+ * await build({
+ *   lexicons: './lexicons',
+ *   out: './src/generated',
+ *   pretty: true,
+ *   clear: true,
+ * })
+ * ```
+ */
 async function build(options) {
     const builder = new lex_builder_js_1.LexBuilder(options);
     await builder.load(options);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAiBA,sBAIC;;AArBD,gBAAgB;AAChB,yBAAsB;AAEtB,qDAKyB;AAEzB,2DAAgC;AAChC,yEAA8C;AAMvC,KAAK,UAAU,KAAK,CAAC,OAA8B;IACxD,MAAM,OAAO,GAAG,IAAI,2BAAU,CAAC,OAAO,CAAC,CAAA;IACvC,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC3B,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC7B,CAAC","sourcesContent":["// Must be first\nimport './polyfill.js'\n\nimport {\n  LexBuilder,\n  LexBuilderLoadOptions,\n  LexBuilderOptions,\n  LexBuilderSaveOptions,\n} from './lex-builder.js'\n\nexport * from './lex-builder.js'\nexport * from './lexicon-directory-indexer.js'\n\nexport type TsProjectBuildOptions = LexBuilderOptions &\n  LexBuilderLoadOptions &\n  LexBuilderSaveOptions\n\nexport async function build(options: TsProjectBuildOptions) {\n  const builder = new LexBuilder(options)\n  await builder.load(options)\n  await builder.save(options)\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAkDA,sBAIC;;AAtDD,gBAAgB;AAChB,yBAAsB;AAEtB,qDAKyB;AAEzB,2DAAgC;AAChC,yEAA8C;AAgB9C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,KAAK,CAAC,OAA8B;IACxD,MAAM,OAAO,GAAG,IAAI,2BAAU,CAAC,OAAO,CAAC,CAAA;IACvC,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC3B,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC7B,CAAC","sourcesContent":["// Must be first\nimport './polyfill.js'\n\nimport {\n  LexBuilder,\n  LexBuilderLoadOptions,\n  LexBuilderOptions,\n  LexBuilderSaveOptions,\n} from './lex-builder.js'\n\nexport * from './lex-builder.js'\nexport * from './lexicon-directory-indexer.js'\n\n/**\n * Combined options for building a TypeScript project from Lexicon documents.\n *\n * This type merges all configuration options needed for the complete build\n * process, including builder configuration, loading options, and save options.\n *\n * @see {@link LexBuilderOptions} for builder configuration\n * @see {@link LexBuilderLoadOptions} for lexicon loading options\n * @see {@link LexBuilderSaveOptions} for output save options\n */\nexport type TsProjectBuildOptions = LexBuilderOptions &\n  LexBuilderLoadOptions &\n  LexBuilderSaveOptions\n\n/**\n * Builds TypeScript schemas from Lexicon documents.\n *\n * This is the main entry point for programmatic usage of the lex-builder\n * package. It creates a new {@link LexBuilder} instance, loads lexicon\n * documents from the specified directory, and saves the generated TypeScript\n * files to the output directory.\n *\n * @param options - Combined build options including source directory, output\n *   directory, and generation settings\n *\n * @example\n * ```ts\n * import { build } from '@atproto/lex-builder'\n *\n * await build({\n *   lexicons: './lexicons',\n *   out: './src/generated',\n *   pretty: true,\n *   clear: true,\n * })\n * ```\n */\nexport async function build(options: TsProjectBuildOptions) {\n  const builder = new LexBuilder(options)\n  await builder.load(options)\n  await builder.save(options)\n}\n"]}

package/dist/lex-builder.d.ts

@@ -2,6 +2,14 @@ import { BuildFilterOptions } from './filter.js';
 import { FormatterOptions } from './formatter.js';
 import { LexDefBuilderOptions } from './lex-def-builder.js';
 import { LexiconDirectoryIndexerOptions } from './lexicon-directory-indexer.js';
+/**
+ * Configuration options for the {@link LexBuilder} class.
+ *
+ * Extends {@link LexDefBuilderOptions} with additional settings for
+ * controlling the generated TypeScript project structure.
+ *
+ * @see {@link LexDefBuilderOptions} for definition generation options
+ */
 export type LexBuilderOptions = LexDefBuilderOptions & {
     /**
      * Whether to generate an index file at the root exporting all top-level
@@ -11,15 +19,76 @@ export type LexBuilderOptions = LexDefBuilderOptions & {
      * @default false
      */
     indexFile?: boolean;
+    /**
+     * The file extension to use for import specifiers in the generated code.
+     *
+     * @default '.js'
+     */
     importExt?: string;
+    /**
+     * The file extension to use for generated TypeScript files.
+     *
+     * @default '.ts'
+     */
     fileExt?: string;
 };
+/**
+ * Options for loading lexicon documents into the builder.
+ *
+ * Combines directory indexing options with filtering options to control
+ * which lexicon documents are processed.
+ *
+ * @see {@link LexiconDirectoryIndexerOptions} for directory scanning options
+ * @see {@link BuildFilterOptions} for include/exclude filtering
+ */
 export type LexBuilderLoadOptions = LexiconDirectoryIndexerOptions & BuildFilterOptions;
+/**
+ * Options for saving generated TypeScript files.
+ *
+ * Combines formatting options with output directory configuration.
+ */
 export type LexBuilderSaveOptions = FormatterOptions & {
+    /**
+     * The output directory path where generated TypeScript files will be written.
+     */
     out: string;
+    /**
+     * Whether to clear the output directory before writing files.
+     *
+     * When `true`, the entire output directory is deleted before writing new files.
+     *
+     * @default false
+     */
     clear?: boolean;
+    /**
+     * Whether to allow overwriting existing files.
+     *
+     * When `false`, an error is thrown if any output file already exists.
+     *
+     * @default false
+     */
     override?: boolean;
 };
+/**
+ * Main builder class for generating TypeScript schemas from Lexicon documents.
+ *
+ * The LexBuilder orchestrates the entire code generation process:
+ * 1. Loading and indexing lexicon documents from the filesystem
+ * 2. Generating TypeScript type definitions and runtime schemas
+ * 3. Creating namespace export trees for convenient imports
+ * 4. Saving formatted output files
+ *
+ * @example
+ * ```ts
+ * const builder = new LexBuilder({ indexFile: true, pretty: true })
+ *
+ * // Load lexicons from a directory
+ * await builder.load({ lexicons: './lexicons' })
+ *
+ * // Save generated TypeScript to output directory
+ * await builder.save({ out: './src/generated', clear: true })
+ * ```
+ */
 export declare class LexBuilder {
     #private;
     private readonly options;

package/dist/lex-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lex-builder.d.ts","sourceRoot":"","sources":["../src/lex-builder.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAAe,MAAM,aAAa,CAAA;AAE7D,OAAO,EAAa,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAiB,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAEL,8BAA8B,EAC/B,MAAM,gCAAgC,CAAA;AAGvC,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG;IACrD;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,8BAA8B,GAChE,kBAAkB,CAAA;AAEpB,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG;IACrD,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,qBAAa,UAAU;;IAOT,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,GAAE,iBAAsB;IAE5D,IAAI,OAAO,WAEV;IAED,IAAI,SAAS,WAEZ;IAEY,IAAI,CAAC,OAAO,EAAE,qBAAqB;IAkBnC,IAAI,CAAC,OAAO,EAAE,qBAAqB;IA4BhD,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,OAAO;YAID,gBAAgB;YAyDhB,cAAc;CAU7B"}
+{"version":3,"file":"lex-builder.d.ts","sourceRoot":"","sources":["../src/lex-builder.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAAe,MAAM,aAAa,CAAA;AAE7D,OAAO,EAAa,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAiB,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAEL,8BAA8B,EAC/B,MAAM,gCAAgC,CAAA;AAGvC;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG;IACrD;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAAG,8BAA8B,GAChE,kBAAkB,CAAA;AAEpB;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG;IACrD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,UAAU;;IAOT,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,GAAE,iBAAsB;IAE5D,IAAI,OAAO,WAEV;IAED,IAAI,SAAS,WAEZ;IAEY,IAAI,CAAC,OAAO,EAAE,qBAAqB;IAkBnC,IAAI,CAAC,OAAO,EAAE,qBAAqB;IA4BhD,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,OAAO;YAID,gBAAgB;YAyDhB,cAAc;CAU7B"}

package/dist/lex-builder.js

@@ -12,6 +12,26 @@ const formatter_js_1 = require("./formatter.js");
 const lex_def_builder_js_1 = require("./lex-def-builder.js");
 const lexicon_directory_indexer_js_1 = require("./lexicon-directory-indexer.js");
 const ts_lang_js_1 = require("./ts-lang.js");
+/**
+ * Main builder class for generating TypeScript schemas from Lexicon documents.
+ *
+ * The LexBuilder orchestrates the entire code generation process:
+ * 1. Loading and indexing lexicon documents from the filesystem
+ * 2. Generating TypeScript type definitions and runtime schemas
+ * 3. Creating namespace export trees for convenient imports
+ * 4. Saving formatted output files
+ *
+ * @example
+ * ```ts
+ * const builder = new LexBuilder({ indexFile: true, pretty: true })
+ *
+ * // Load lexicons from a directory
+ * await builder.load({ lexicons: './lexicons' })
+ *
+ * // Save generated TypeScript to output directory
+ * await builder.save({ out: './src/generated', clear: true })
+ * ```
+ */
 class LexBuilder {
     options;
     #imported = new Set();

package/dist/lex-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"lex-builder.js","sourceRoot":"","sources":["../src/lex-builder.ts"],"names":[],"mappings":";;;;AAAA,sEAAgC;AAChC,+CAA6D;AAC7D,yCAAyC;AACzC,uCAAmD;AAEnD,2CAA6D;AAC7D,+DAAuD;AACvD,iDAA4D;AAC5D,6DAA0E;AAC1E,iFAGuC;AACvC,6CAAgD;AAwBhD,MAAa,UAAU;IAOQ;IANpB,SAAS,GAAG,IAAI,GAAG,EAAU,CAAA;IAC7B,QAAQ,GAAG,IAAI,kBAAO,CAAC;QAC9B,qBAAqB,EAAE,IAAI;QAC3B,oBAAoB,EAAE,EAAE,eAAe,EAAE,0BAAe,CAAC,SAAS,EAAE;KACrE,CAAC,CAAA;IAEF,YAA6B,UAA6B,EAAE;QAA/B,YAAO,GAAP,OAAO,CAAwB;IAAG,CAAC;IAEhE,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAA;IACtC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,KAAK,CAAA;IACxC,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,OAA8B;;;YAC9C,MAAY,OAAO,0CAAG,IAAI,qCAAe,CACvC,IAAI,sDAAuB,CAAC,OAAO,CAAC,EACpC,IAAA,uBAAW,EAAC,OAAO,CAAC,CACrB,OAAA,CAAA;YAED,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;oBAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBAC5B,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBAC7D,CAAC;gBAED,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;gBACvC,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;YAClC,CAAC;;;;;;;;;;;KACF;IAEM,KAAK,CAAC,IAAI,CAAC,OAA8B;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAA;QAE5C,MAAM,WAAW,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAExC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAA,aAAE,EAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QACzD,CAAC;aAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC7B,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CACpB,mBAAmB,CAAC,IAAA,gBAAI,EAAC,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CACxD,CACF,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC,OAAO,CAAC,CAAA;QAExC,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,IAAA,gBAAI,EAAC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YACtD,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YAC1D,MAAM,IAAA,gBAAK,EAAC,IAAA,gBAAI,EAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;YACtD,MAAM,IAAA,aAAE,EAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;YACpD,MAAM,IAAA,oBAAS,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;QAC5C,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAEO,UAAU,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IAEO,OAAO,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IACnE,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,GAAoB;QACjD,MAAM,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEpC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YAEvD,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAE,CAAA;YAC5B,IAAA,qBAAM,EACJ,KAAK,KAAK,OAAO,EACjB,8EAA8E,CAC/E,CAAA;YACD,MAAM,cAAc,GAAG,KAAK,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACpD,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC;gBACpD,SAAS,CAAC,oBAAoB,CAAC;oBAC7B,eAAe,EAAE,cAAc;oBAC/B,eAAe,EAAE,IAAA,8BAAiB,EAAC,KAAK,CAAC;iBAC1C,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,qCAAqC;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;YAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAEjC,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YACrD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YAEnD,MAAM,oBAAoB,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACzE,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAA;YAC3D,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,IAAI,CAAC,oBAAoB,CAAC;oBACxB,eAAe,EAAE,oBAAoB;oBACrC,eAAe,EAAE,IAAA,8BAAiB,EAAC,OAAO,CAAC;iBAC5C,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,GAAG,UAAU,CAAC,CAAA;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAEnD,IAAI,CAAC,oBAAoB,CAAC;YACxB,eAAe,EAAE,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE;SAChE,CAAC,CAAA;QAEF,0EAA0E;QAC1E,4EAA4E;QAC5E,sEAAsE;QACtE,uEAAuE;QACvE,mBAAmB;QACnB,IAAI,CAAC,oBAAoB,CAAC;YACxB,eAAe,EAAE,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE;YAC/D,eAAe,EAAE,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,GAAoB,EACpB,OAAuB;QAEvB,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAE3D,MAAM,WAAW,GAAG,IAAI,kCAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;QACvE,MAAM,WAAW,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;CACF;AA1ID,gCA0IC;AAED,KAAK,UAAU,mBAAmB,CAAC,IAAY;IAC7C,IAAI,CAAC;QACH,MAAM,IAAA,eAAI,EAAC,IAAI,CAAC,CAAA;QAChB,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAA;IACjD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAM;QAC1E,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC","sourcesContent":["import assert from 'node:assert'\nimport { mkdir, rm, stat, writeFile } from 'node:fs/promises'\nimport { join, resolve } from 'node:path'\nimport { IndentationText, Project } from 'ts-morph'\nimport { LexiconDocument, LexiconIndexer } from '@atproto/lex-document'\nimport { BuildFilterOptions, buildFilter } from './filter.js'\nimport { FilteredIndexer } from './filtered-indexer.js'\nimport { Formatter, FormatterOptions } from './formatter.js'\nimport { LexDefBuilder, LexDefBuilderOptions } from './lex-def-builder.js'\nimport {\n  LexiconDirectoryIndexer,\n  LexiconDirectoryIndexerOptions,\n} from './lexicon-directory-indexer.js'\nimport { asNamespaceExport } from './ts-lang.js'\n\nexport type LexBuilderOptions = LexDefBuilderOptions & {\n  /**\n   * Whether to generate an index file at the root exporting all top-level\n   * namespaces.\n   *\n   * @note This could theoretically cause name conflicts if a\n   * @default false\n   */\n  indexFile?: boolean\n  importExt?: string\n  fileExt?: string\n}\n\nexport type LexBuilderLoadOptions = LexiconDirectoryIndexerOptions &\n  BuildFilterOptions\n\nexport type LexBuilderSaveOptions = FormatterOptions & {\n  out: string\n  clear?: boolean\n  override?: boolean\n}\n\nexport class LexBuilder {\n  readonly #imported = new Set<string>()\n  readonly #project = new Project({\n    useInMemoryFileSystem: true,\n    manipulationSettings: { indentationText: IndentationText.TwoSpaces },\n  })\n\n  constructor(private readonly options: LexBuilderOptions = {}) {}\n\n  get fileExt() {\n    return this.options.fileExt ?? '.ts'\n  }\n\n  get importExt() {\n    return this.options.importExt ?? '.js'\n  }\n\n  public async load(options: LexBuilderLoadOptions) {\n    await using indexer = new FilteredIndexer(\n      new LexiconDirectoryIndexer(options),\n      buildFilter(options),\n    )\n\n    for await (const doc of indexer) {\n      if (!this.#imported.has(doc.id)) {\n        this.#imported.add(doc.id)\n      } else {\n        throw new Error(`Duplicate lexicon document id: ${doc.id}`)\n      }\n\n      await this.createDefsFile(doc, indexer)\n      await this.createExportTree(doc)\n    }\n  }\n\n  public async save(options: LexBuilderSaveOptions) {\n    const files = this.#project.getSourceFiles()\n\n    const destination = resolve(options.out)\n\n    if (options.clear) {\n      await rm(destination, { recursive: true, force: true })\n    } else if (!options.override) {\n      await Promise.all(\n        files.map(async (f) =>\n          assertNotFileExists(join(destination, f.getFilePath())),\n        ),\n      )\n    }\n\n    const formatter = new Formatter(options)\n\n    await Promise.all(\n      Array.from(files, async (file) => {\n        const filePath = join(destination, file.getFilePath())\n        const content = await formatter.format(file.getFullText())\n        await mkdir(join(filePath, '..'), { recursive: true })\n        await rm(filePath, { recursive: true, force: true })\n        await writeFile(filePath, content, 'utf8')\n      }),\n    )\n  }\n\n  private createFile(path: string) {\n    return this.#project.createSourceFile(path)\n  }\n\n  private getFile(path: string) {\n    return this.#project.getSourceFile(path) || this.createFile(path)\n  }\n\n  private async createExportTree(doc: LexiconDocument) {\n    const namespaces = doc.id.split('.')\n\n    if (this.options.indexFile) {\n      const indexFile = this.getFile(`/index${this.fileExt}`)\n\n      const tldNs = namespaces[0]!\n      assert(\n        tldNs !== 'index',\n        'The \"indexFile\" options cannot be used with namespaces using a \".index\" tld.',\n      )\n      const tldNsSpecifier = `./${tldNs}${this.importExt}`\n      if (!indexFile.getExportDeclaration(tldNsSpecifier)) {\n        indexFile.addExportDeclaration({\n          moduleSpecifier: tldNsSpecifier,\n          namespaceExport: asNamespaceExport(tldNs),\n        })\n      }\n    }\n\n    // First create the parent namespaces\n    for (let i = 0; i < namespaces.length - 1; i++) {\n      const currentNs = namespaces[i]\n      const childNs = namespaces[i + 1]\n\n      const path = join('/', ...namespaces.slice(0, i + 1))\n      const file = this.getFile(`${path}${this.fileExt}`)\n\n      const childModuleSpecifier = `./${currentNs}/${childNs}${this.importExt}`\n      const dec = file.getExportDeclaration(childModuleSpecifier)\n      if (!dec) {\n        file.addExportDeclaration({\n          moduleSpecifier: childModuleSpecifier,\n          namespaceExport: asNamespaceExport(childNs),\n        })\n      }\n    }\n\n    // The child file exports the schemas (as *)\n    const path = join('/', ...namespaces)\n    const file = this.getFile(`${path}${this.fileExt}`)\n\n    file.addExportDeclaration({\n      moduleSpecifier: `./${namespaces.at(-1)}.defs${this.importExt}`,\n    })\n\n    // @NOTE Individual exports exports from the defs file might conflict with\n    // child namespaces. For this reason, we also add a namespace export for the\n    // defs (export * as $defs from './xyz.defs'). This is an escape hatch\n    // allowing to still access the definitions if a hash get shadowed by a\n    // child namespace.\n    file.addExportDeclaration({\n      moduleSpecifier: `./${namespaces.at(-1)}.defs${this.importExt}`,\n      namespaceExport: '$defs',\n    })\n  }\n\n  private async createDefsFile(\n    doc: LexiconDocument,\n    indexer: LexiconIndexer,\n  ): Promise<void> {\n    const path = join('/', ...doc.id.split('.'))\n    const file = this.createFile(`${path}.defs${this.fileExt}`)\n\n    const fileBuilder = new LexDefBuilder(this.options, file, doc, indexer)\n    await fileBuilder.build()\n  }\n}\n\nasync function assertNotFileExists(file: string): Promise<void> {\n  try {\n    await stat(file)\n    throw new Error(`File already exists: ${file}`)\n  } catch (err) {\n    if (err instanceof Error && 'code' in err && err.code === 'ENOENT') return\n    throw err\n  }\n}\n"]}
+{"version":3,"file":"lex-builder.js","sourceRoot":"","sources":["../src/lex-builder.ts"],"names":[],"mappings":";;;;AAAA,sEAAgC;AAChC,+CAA6D;AAC7D,yCAAyC;AACzC,uCAAmD;AAEnD,2CAA6D;AAC7D,+DAAuD;AACvD,iDAA4D;AAC5D,6DAA0E;AAC1E,iFAGuC;AACvC,6CAAgD;AAyEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,UAAU;IAOQ;IANpB,SAAS,GAAG,IAAI,GAAG,EAAU,CAAA;IAC7B,QAAQ,GAAG,IAAI,kBAAO,CAAC;QAC9B,qBAAqB,EAAE,IAAI;QAC3B,oBAAoB,EAAE,EAAE,eAAe,EAAE,0BAAe,CAAC,SAAS,EAAE;KACrE,CAAC,CAAA;IAEF,YAA6B,UAA6B,EAAE;QAA/B,YAAO,GAAP,OAAO,CAAwB;IAAG,CAAC;IAEhE,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAA;IACtC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,KAAK,CAAA;IACxC,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,OAA8B;;;YAC9C,MAAY,OAAO,0CAAG,IAAI,qCAAe,CACvC,IAAI,sDAAuB,CAAC,OAAO,CAAC,EACpC,IAAA,uBAAW,EAAC,OAAO,CAAC,CACrB,OAAA,CAAA;YAED,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;oBAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBAC5B,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBAC7D,CAAC;gBAED,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;gBACvC,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;YAClC,CAAC;;;;;;;;;;;KACF;IAEM,KAAK,CAAC,IAAI,CAAC,OAA8B;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAA;QAE5C,MAAM,WAAW,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAExC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAA,aAAE,EAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QACzD,CAAC;aAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC7B,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CACpB,mBAAmB,CAAC,IAAA,gBAAI,EAAC,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CACxD,CACF,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC,OAAO,CAAC,CAAA;QAExC,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,IAAA,gBAAI,EAAC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YACtD,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YAC1D,MAAM,IAAA,gBAAK,EAAC,IAAA,gBAAI,EAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;YACtD,MAAM,IAAA,aAAE,EAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;YACpD,MAAM,IAAA,oBAAS,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;QAC5C,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAEO,UAAU,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IAEO,OAAO,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IACnE,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,GAAoB;QACjD,MAAM,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEpC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YAEvD,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAE,CAAA;YAC5B,IAAA,qBAAM,EACJ,KAAK,KAAK,OAAO,EACjB,8EAA8E,CAC/E,CAAA;YACD,MAAM,cAAc,GAAG,KAAK,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACpD,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC;gBACpD,SAAS,CAAC,oBAAoB,CAAC;oBAC7B,eAAe,EAAE,cAAc;oBAC/B,eAAe,EAAE,IAAA,8BAAiB,EAAC,KAAK,CAAC;iBAC1C,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,qCAAqC;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;YAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAEjC,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YACrD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YAEnD,MAAM,oBAAoB,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACzE,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAA;YAC3D,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,IAAI,CAAC,oBAAoB,CAAC;oBACxB,eAAe,EAAE,oBAAoB;oBACrC,eAAe,EAAE,IAAA,8BAAiB,EAAC,OAAO,CAAC;iBAC5C,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,GAAG,UAAU,CAAC,CAAA;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAEnD,IAAI,CAAC,oBAAoB,CAAC;YACxB,eAAe,EAAE,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE;SAChE,CAAC,CAAA;QAEF,0EAA0E;QAC1E,4EAA4E;QAC5E,sEAAsE;QACtE,uEAAuE;QACvE,mBAAmB;QACnB,IAAI,CAAC,oBAAoB,CAAC;YACxB,eAAe,EAAE,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE;YAC/D,eAAe,EAAE,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,GAAoB,EACpB,OAAuB;QAEvB,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAE3D,MAAM,WAAW,GAAG,IAAI,kCAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;QACvE,MAAM,WAAW,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;CACF;AA1ID,gCA0IC;AAED,KAAK,UAAU,mBAAmB,CAAC,IAAY;IAC7C,IAAI,CAAC;QACH,MAAM,IAAA,eAAI,EAAC,IAAI,CAAC,CAAA;QAChB,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAA;IACjD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAM;QAC1E,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC","sourcesContent":["import assert from 'node:assert'\nimport { mkdir, rm, stat, writeFile } from 'node:fs/promises'\nimport { join, resolve } from 'node:path'\nimport { IndentationText, Project } from 'ts-morph'\nimport { LexiconDocument, LexiconIndexer } from '@atproto/lex-document'\nimport { BuildFilterOptions, buildFilter } from './filter.js'\nimport { FilteredIndexer } from './filtered-indexer.js'\nimport { Formatter, FormatterOptions } from './formatter.js'\nimport { LexDefBuilder, LexDefBuilderOptions } from './lex-def-builder.js'\nimport {\n  LexiconDirectoryIndexer,\n  LexiconDirectoryIndexerOptions,\n} from './lexicon-directory-indexer.js'\nimport { asNamespaceExport } from './ts-lang.js'\n\n/**\n * Configuration options for the {@link LexBuilder} class.\n *\n * Extends {@link LexDefBuilderOptions} with additional settings for\n * controlling the generated TypeScript project structure.\n *\n * @see {@link LexDefBuilderOptions} for definition generation options\n */\nexport type LexBuilderOptions = LexDefBuilderOptions & {\n  /**\n   * Whether to generate an index file at the root exporting all top-level\n   * namespaces.\n   *\n   * @note This could theoretically cause name conflicts if a\n   * @default false\n   */\n  indexFile?: boolean\n  /**\n   * The file extension to use for import specifiers in the generated code.\n   *\n   * @default '.js'\n   */\n  importExt?: string\n  /**\n   * The file extension to use for generated TypeScript files.\n   *\n   * @default '.ts'\n   */\n  fileExt?: string\n}\n\n/**\n * Options for loading lexicon documents into the builder.\n *\n * Combines directory indexing options with filtering options to control\n * which lexicon documents are processed.\n *\n * @see {@link LexiconDirectoryIndexerOptions} for directory scanning options\n * @see {@link BuildFilterOptions} for include/exclude filtering\n */\nexport type LexBuilderLoadOptions = LexiconDirectoryIndexerOptions &\n  BuildFilterOptions\n\n/**\n * Options for saving generated TypeScript files.\n *\n * Combines formatting options with output directory configuration.\n */\nexport type LexBuilderSaveOptions = FormatterOptions & {\n  /**\n   * The output directory path where generated TypeScript files will be written.\n   */\n  out: string\n  /**\n   * Whether to clear the output directory before writing files.\n   *\n   * When `true`, the entire output directory is deleted before writing new files.\n   *\n   * @default false\n   */\n  clear?: boolean\n  /**\n   * Whether to allow overwriting existing files.\n   *\n   * When `false`, an error is thrown if any output file already exists.\n   *\n   * @default false\n   */\n  override?: boolean\n}\n\n/**\n * Main builder class for generating TypeScript schemas from Lexicon documents.\n *\n * The LexBuilder orchestrates the entire code generation process:\n * 1. Loading and indexing lexicon documents from the filesystem\n * 2. Generating TypeScript type definitions and runtime schemas\n * 3. Creating namespace export trees for convenient imports\n * 4. Saving formatted output files\n *\n * @example\n * ```ts\n * const builder = new LexBuilder({ indexFile: true, pretty: true })\n *\n * // Load lexicons from a directory\n * await builder.load({ lexicons: './lexicons' })\n *\n * // Save generated TypeScript to output directory\n * await builder.save({ out: './src/generated', clear: true })\n * ```\n */\nexport class LexBuilder {\n  readonly #imported = new Set<string>()\n  readonly #project = new Project({\n    useInMemoryFileSystem: true,\n    manipulationSettings: { indentationText: IndentationText.TwoSpaces },\n  })\n\n  constructor(private readonly options: LexBuilderOptions = {}) {}\n\n  get fileExt() {\n    return this.options.fileExt ?? '.ts'\n  }\n\n  get importExt() {\n    return this.options.importExt ?? '.js'\n  }\n\n  public async load(options: LexBuilderLoadOptions) {\n    await using indexer = new FilteredIndexer(\n      new LexiconDirectoryIndexer(options),\n      buildFilter(options),\n    )\n\n    for await (const doc of indexer) {\n      if (!this.#imported.has(doc.id)) {\n        this.#imported.add(doc.id)\n      } else {\n        throw new Error(`Duplicate lexicon document id: ${doc.id}`)\n      }\n\n      await this.createDefsFile(doc, indexer)\n      await this.createExportTree(doc)\n    }\n  }\n\n  public async save(options: LexBuilderSaveOptions) {\n    const files = this.#project.getSourceFiles()\n\n    const destination = resolve(options.out)\n\n    if (options.clear) {\n      await rm(destination, { recursive: true, force: true })\n    } else if (!options.override) {\n      await Promise.all(\n        files.map(async (f) =>\n          assertNotFileExists(join(destination, f.getFilePath())),\n        ),\n      )\n    }\n\n    const formatter = new Formatter(options)\n\n    await Promise.all(\n      Array.from(files, async (file) => {\n        const filePath = join(destination, file.getFilePath())\n        const content = await formatter.format(file.getFullText())\n        await mkdir(join(filePath, '..'), { recursive: true })\n        await rm(filePath, { recursive: true, force: true })\n        await writeFile(filePath, content, 'utf8')\n      }),\n    )\n  }\n\n  private createFile(path: string) {\n    return this.#project.createSourceFile(path)\n  }\n\n  private getFile(path: string) {\n    return this.#project.getSourceFile(path) || this.createFile(path)\n  }\n\n  private async createExportTree(doc: LexiconDocument) {\n    const namespaces = doc.id.split('.')\n\n    if (this.options.indexFile) {\n      const indexFile = this.getFile(`/index${this.fileExt}`)\n\n      const tldNs = namespaces[0]!\n      assert(\n        tldNs !== 'index',\n        'The \"indexFile\" options cannot be used with namespaces using a \".index\" tld.',\n      )\n      const tldNsSpecifier = `./${tldNs}${this.importExt}`\n      if (!indexFile.getExportDeclaration(tldNsSpecifier)) {\n        indexFile.addExportDeclaration({\n          moduleSpecifier: tldNsSpecifier,\n          namespaceExport: asNamespaceExport(tldNs),\n        })\n      }\n    }\n\n    // First create the parent namespaces\n    for (let i = 0; i < namespaces.length - 1; i++) {\n      const currentNs = namespaces[i]\n      const childNs = namespaces[i + 1]\n\n      const path = join('/', ...namespaces.slice(0, i + 1))\n      const file = this.getFile(`${path}${this.fileExt}`)\n\n      const childModuleSpecifier = `./${currentNs}/${childNs}${this.importExt}`\n      const dec = file.getExportDeclaration(childModuleSpecifier)\n      if (!dec) {\n        file.addExportDeclaration({\n          moduleSpecifier: childModuleSpecifier,\n          namespaceExport: asNamespaceExport(childNs),\n        })\n      }\n    }\n\n    // The child file exports the schemas (as *)\n    const path = join('/', ...namespaces)\n    const file = this.getFile(`${path}${this.fileExt}`)\n\n    file.addExportDeclaration({\n      moduleSpecifier: `./${namespaces.at(-1)}.defs${this.importExt}`,\n    })\n\n    // @NOTE Individual exports exports from the defs file might conflict with\n    // child namespaces. For this reason, we also add a namespace export for the\n    // defs (export * as $defs from './xyz.defs'). This is an escape hatch\n    // allowing to still access the definitions if a hash get shadowed by a\n    // child namespace.\n    file.addExportDeclaration({\n      moduleSpecifier: `./${namespaces.at(-1)}.defs${this.importExt}`,\n      namespaceExport: '$defs',\n    })\n  }\n\n  private async createDefsFile(\n    doc: LexiconDocument,\n    indexer: LexiconIndexer,\n  ): Promise<void> {\n    const path = join('/', ...doc.id.split('.'))\n    const file = this.createFile(`${path}.defs${this.fileExt}`)\n\n    const fileBuilder = new LexDefBuilder(this.options, file, doc, indexer)\n    await fileBuilder.build()\n  }\n}\n\nasync function assertNotFileExists(file: string): Promise<void> {\n  try {\n    await stat(file)\n    throw new Error(`File already exists: ${file}`)\n  } catch (err) {\n    if (err instanceof Error && 'code' in err && err.code === 'ENOENT') return\n    throw err\n  }\n}\n"]}

package/dist/lex-def-builder.d.ts

@@ -1,13 +1,49 @@
 import { SourceFile } from 'ts-morph';
 import { LexiconDocument, LexiconIndexer, LexiconProcedure, LexiconQuery, LexiconSubscription } from '@atproto/lex-document';
 import { RefResolverOptions, ResolvedRef } from './ref-resolver.js';
+/**
+ * Configuration options for the {@link LexDefBuilder} class.
+ *
+ * @see {@link RefResolverOptions} for reference resolution options
+ */
 export type LexDefBuilderOptions = RefResolverOptions & {
+    /**
+     * The module specifier to use for importing the lexicon schema library.
+     *
+     * @default '@atproto/lex-schema'
+     */
     lib?: string;
+    /**
+     * Whether to allow legacy blob references in the generated schemas.
+     *
+     * When `true`, blob types will accept both modern `BlobRef` and legacy
+     * `LegacyBlobRef` formats.
+     *
+     * @default false
+     */
     allowLegacyBlobs?: boolean;
+    /**
+     * Whether to add `#__PURE__` annotations to function calls.
+     *
+     * These annotations help bundlers with tree-shaking by marking
+     * side-effect-free function calls.
+     *
+     * @default false
+     */
     pureAnnotations?: boolean;
 };
 /**
- * Utility class to build a TypeScript source file from a lexicon document.
+ * Builds TypeScript type definitions and runtime schemas from a single
+ * Lexicon document.
+ *
+ * This class is responsible for generating the `.defs.ts` files that contain:
+ * - Type aliases for each lexicon definition
+ * - Runtime schema validators using `@atproto/lex-schema`
+ * - Utility functions for type checking and validation
+ * - Proper import statements for cross-references
+ *
+ * Each lexicon definition type (record, object, query, procedure, etc.)
+ * is handled with specialized code generation logic.
  */
 export declare class LexDefBuilder {
     private readonly options;

package/dist/lex-def-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lex-def-builder.d.ts","sourceRoot":"","sources":["../src/lex-def-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,UAAU,CAAA;AACjB,OAAO,EAOL,eAAe,EAEf,cAAc,EAMd,gBAAgB,EAChB,YAAY,EAKZ,mBAAmB,EAGpB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAEL,kBAAkB,EAClB,WAAW,EAEZ,MAAM,mBAAmB,CAAA;AAG1B,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,GAAG;IACtD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED;;GAEG;AACH,qBAAa,aAAa;IAItB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IALtB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;gBAGtB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,eAAe,EACrC,OAAO,EAAE,cAAc;IAKzB,OAAO,CAAC,IAAI;IAIN,KAAK;IAyBX,OAAO,CAAC,QAAQ;YAgBF,MAAM;YA8BN,gBAAgB;YAsBhB,YAAY;YA4BZ,QAAQ;YA0BR,eAAe;IA0B7B,kBAAkB,CAChB,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,gBAAgB,GAAG,YAAY,GAAG,mBAAmB;YAmD9C,SAAS;YAsBT,SAAS;YAiBT,QAAQ;YAQR,QAAQ;YAuBR,SAAS;YA2FT,cAAc;YAkBd,iBAAiB;YAQjB,mBAAmB;YAWnB,aAAa;YAKb,mBAAmB;YAKnB,wBAAwB;YAsBxB,sBAAsB;YAYtB,0BAA0B;YAuB1B,wBAAwB;YAoBxB,sBAAsB;YA8BtB,oBAAoB;YA8BpB,kBAAkB;YASlB,gBAAgB;YAIhB,oBAAoB;YAIpB,kBAAkB;IAIhC,OAAO,CAAC,WAAW;YAQL,oBAAoB;YAYpB,kBAAkB;YAKlB,oBAAoB;YA0BpB,kBAAkB;YAOlB,mBAAmB;YA6BnB,iBAAiB;YA2CjB,kBAAkB;YAQlB,gBAAgB;YAIhB,iBAAiB;YAUjB,eAAe;YAMf,oBAAoB;YAIpB,kBAAkB;YAIlB,gBAAgB;YAOhB,cAAc;YAKd,qBAAqB;YAmBrB,mBAAmB;YAWnB,kBAAkB;YAYlB,gBAAgB;YAShB,iBAAiB;YAgBjB,eAAe;CAK9B"}
+{"version":3,"file":"lex-def-builder.d.ts","sourceRoot":"","sources":["../src/lex-def-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,UAAU,CAAA;AACjB,OAAO,EAOL,eAAe,EAEf,cAAc,EAMd,gBAAgB,EAChB,YAAY,EAKZ,mBAAmB,EAGpB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAEL,kBAAkB,EAClB,WAAW,EAEZ,MAAM,mBAAmB,CAAA;AAG1B;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,GAAG;IACtD;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,aAAa;IAItB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IALtB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;gBAGtB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,eAAe,EACrC,OAAO,EAAE,cAAc;IAKzB,OAAO,CAAC,IAAI;IAIN,KAAK;IAyBX,OAAO,CAAC,QAAQ;YAgBF,MAAM;YA8BN,gBAAgB;YAsBhB,YAAY;YA4BZ,QAAQ;YA0BR,eAAe;IA0B7B,kBAAkB,CAChB,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,gBAAgB,GAAG,YAAY,GAAG,mBAAmB;YAmD9C,SAAS;YAsBT,SAAS;YAiBT,QAAQ;YAQR,QAAQ;YAuBR,SAAS;YA2FT,cAAc;YAkBd,iBAAiB;YAQjB,mBAAmB;YAWnB,aAAa;YAKb,mBAAmB;YAKnB,wBAAwB;YAsBxB,sBAAsB;YAYtB,0BAA0B;YAuB1B,wBAAwB;YAoBxB,sBAAsB;YA8BtB,oBAAoB;YA8BpB,kBAAkB;YASlB,gBAAgB;YAIhB,oBAAoB;YAIpB,kBAAkB;IAIhC,OAAO,CAAC,WAAW;YAQL,oBAAoB;YAYpB,kBAAkB;YAKlB,oBAAoB;YA0BpB,kBAAkB;YAOlB,mBAAmB;YA6BnB,iBAAiB;YA2CjB,kBAAkB;YAQlB,gBAAgB;YAIhB,iBAAiB;YAUjB,eAAe;YAMf,oBAAoB;YAIpB,kBAAkB;YAIlB,gBAAgB;YAOhB,cAAc;YAKd,qBAAqB;YAmBrB,mBAAmB;YAWnB,kBAAkB;YAYlB,gBAAgB;YAShB,iBAAiB;YAgBjB,eAAe;CAK9B"}

package/dist/lex-def-builder.js

@@ -6,7 +6,17 @@ const lex_schema_1 = require("@atproto/lex-schema");
 const ref_resolver_js_1 = require("./ref-resolver.js");
 const ts_lang_js_1 = require("./ts-lang.js");
 /**
- * Utility class to build a TypeScript source file from a lexicon document.
+ * Builds TypeScript type definitions and runtime schemas from a single
+ * Lexicon document.
+ *
+ * This class is responsible for generating the `.defs.ts` files that contain:
+ * - Type aliases for each lexicon definition
+ * - Runtime schema validators using `@atproto/lex-schema`
+ * - Utility functions for type checking and validation
+ * - Proper import statements for cross-references
+ *
+ * Each lexicon definition type (record, object, query, procedure, etc.)
+ * is handled with specialized code generation logic.
  */
 class LexDefBuilder {
     options;