@hydranium/cli 1.0.0-next.10

package/lib/commands/generate-transfer-model.d.ts

@@ -0,0 +1,110 @@
+/********************************************************************************
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+import { type SourceFile } from 'ts-morph';
+/**
+ * Options for the transfer-model generator.
+ *
+ * The generator reads the Langium-generated AST source plus the consumer's
+ * module-augmentation file and emits a serializable "transfer model" — a
+ * 1:1 TypeScript projection of the AST suitable for client-server
+ * communication. All semantic narrowings happen in the consumer's handwritten
+ * overlay file that wraps the generated output.
+ */
+export interface GenerateTransferModelOptions {
+    /** Path to the Langium-generated AST file. */
+    astFile: string;
+    /** Path to the augmentation file that re-exports the generated AST. */
+    augmentationFile: string;
+    /** Destination path for the generated transfer model. */
+    outFile: string;
+    /** Name used for the base element type in the output. Defaults to `TransferElement`. */
+    elementTypeName?: string;
+    /** Name used for the terminal-patterns const in the output. Defaults to `ModelTerminals`. */
+    terminalsName?: string;
+    /**
+     * Name of the source variable holding the terminal regex literals in the AST file
+     * (Langium emits this as `<LanguageId>Terminals`). If omitted, auto-derived from
+     * the `<LanguageId>AstReflection` class found in the AST file.
+     *
+     * In a multi-language project each language's namespace also declares its own
+     * `Terminals` const; those are always read in addition to this one, so a
+     * multi-language consumer does not need to configure anything here.
+     */
+    terminalsSourceName?: string;
+    /**
+     * Type-alias names to skip when emitting. Langium-generated infrastructure type
+     * aliases (`<LanguageId>AstType`, `<LanguageId>TerminalNames`, `<LanguageId>TokenNames`)
+     * are auto-skipped via the language-id derivation; this list is for additional
+     * consumer-specific aliases.
+     */
+    skipTypeAliases?: string[];
+    /** Terminal names to skip when emitting validation patterns. */
+    skipTerminals?: string[];
+    /**
+     * Header comment line shown after "Generated from the Langium AST — DO NOT EDIT
+     * MANUALLY!". Defaults to a generic instruction; consumers typically pass the
+     * command that regenerates the file in their own repo.
+     */
+    regenCommand?: string;
+}
+/**
+ * Generate once, then re-generate whenever the AST or augmentation file changes,
+ * until `signal` aborts (the CLI wires this to SIGINT). Regeneration is debounced
+ * so an editor's multi-event save fires a single run, and a generation error is
+ * logged without tearing down the watch. Resolves when the signal aborts.
+ */
+export declare function watchTransferModel(options: GenerateTransferModelOptions, context: {
+    signal: AbortSignal;
+}): Promise<void>;
+/** Run the transfer-model generator. */
+export declare function generateTransferModel(options: GenerateTransferModelOptions): void;
+/**
+ * Collect terminal regex literals from the AST file.
+ *
+ * Single-language projects put every terminal in one top-level
+ * `<LanguageId>Terminals` const. Multi-language projects keep that const as a
+ * spread of per-language `Terminals` consts declared inside each language's
+ * namespace, and each namespace carries only the terminals its own grammar
+ * reaches — so both sources are read and unioned.
+ *
+ * De-duplicated by terminal name, top-level first: when two grammars declare the
+ * same terminal, the first declaration wins and the rest are dropped rather than
+ * emitting a duplicate validation pattern. Terminals differing only by grammar are indistinguishable
+ * in the flat output, which is why the emitted patterns stay a
+ * lowest-common-denominator client-side check rather than a per-language one.
+ */
+export declare function parseTerminals(astSource: SourceFile, terminalsSourceName: string, skipTerminals: Set<string>): Array<{
+    name: string;
+    pattern: string;
+}>;
+/**
+ * Type-guard expression (against an `item: unknown`) for one member of a non-literal type-alias
+ * union. Covers the full set of Langium data-type primitives: the `typeof`-checkable ones
+ * (`string`/`number`/`boolean`/`bigint`) use `typeof`; `Date` — the one Langium primitive `typeof`
+ * reports as `'object'` — uses `instanceof`; any other member is a named type whose generated
+ * `is<Member>` guard is called.
+ */
+export declare function typeAliasMemberGuard(member: string): string;
+/**
+ * Flatten a type-alias definition that references per-language namespace members
+ * into a single string-literal union.
+ *
+ * Langium emits namespace-qualified aliases for a multi-language project, but the
+ * protocol package that consumes the generated transfer model cannot see those
+ * namespaces, so the reference has to be inlined here or it emits an unresolvable
+ * name.
+ *
+ * Each referenced member is inlined and de-duplicated, preserving first-seen
+ * order. The definition is returned UNCHANGED when it holds no
+ * namespace-qualified reference (the single-language case) or when any referenced
+ * member is not a pure string-literal union — passing it through rather than
+ * emitting a half-resolved union.
+ */
+export declare function resolveNamespacedStringUnion(astSource: SourceFile, definition: string): string;
+//# sourceMappingURL=generate-transfer-model.d.ts.map

package/lib/commands/generate-transfer-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-transfer-model.d.ts","sourceRoot":"","sources":["../../src/commands/generate-transfer-model.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAIlF,OAAO,EAOJ,KAAK,UAAU,EACjB,MAAM,UAAU,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IAC1C,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,gBAAgB,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,wFAAwF;IACxF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,6FAA6F;IAC7F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,gEAAgE;IAChE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACxB;AAwBD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAmCzH;AAED,wCAAwC;AACxC,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,IAAI,CA4QjF;AAwFD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAC3B,SAAS,EAAE,UAAU,EACrB,mBAAmB,EAAE,MAAM,EAC3B,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,GAC1B,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CA8B1C;AAsFD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAY3D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAqB9F"}