@gtkx/codegen 1.0.0 → 1.2.0

package/src/analysis/ts-type.ts

@@ -1,6 +1,8 @@
+import { sanitizeTypeIdentifier } from "@gtkx/utils";
 import type { Library } from "../gir/library.js";
 import type { EntityType, GirType } from "../gir/type.js";
 import type { ModuleContext } from "../writer/context.js";
+import { isEmittableEntity } from "../gir/emittable.js";
 import { PRIMITIVE_TS_TYPE } from "../gir/primitives.js";
 import {
     type CArrayType,
@@ -10,6 +12,7 @@ import {
     type TypeId,
 } from "../gir/type-id.js";
 import { gtypeTsType } from "../store/gi/gtype-binding.js";
+import { isByteSequence } from "./type-shape.js";
 
 type ReferenceName = {
     namespaceName: string;
@@ -19,26 +22,23 @@ type ReferenceName = {
 type TsTypeTarget = {
     containerStyle: "map" | "record";
     callbackType: string;
-    shouldRenderByteArrayAsNumber: boolean;
+    byteArrayType: string;
     renderNamed: (resolved: GirType | undefined, name: ReferenceName) => string;
     renderGtype: () => string;
 };
 
-const willEmitEntity = (type: EntityType): boolean => {
-    switch (type.kind) {
-        case "callback": {
-            return type.value.introspectable && type.value.name.length > 0;
-        }
-        case "record": {
-            return type.value.introspectable && type.value.name.length > 0;
-        }
-        case "alias":
-        case "class":
-        case "enum":
-        case "interface": {
-            return true;
-        }
-    }
+const BYTE_ARRAY_TYPE = "Uint8Array";
+const BYTE_ARRAY_INPUT_TYPE = "Uint8Array | number[]";
+const NUMBER_ARRAY_TYPE = "number[]";
+
+const willEmitEntity = (type: EntityType): boolean => isEmittableEntity(type.value);
+
+const referenceName = (library: Library, ref: TypeId): ReferenceName | undefined => {
+    const name = library.nameFor(ref);
+
+    return name === undefined
+        ? undefined
+        : { namespaceName: name.namespaceName, typeName: sanitizeTypeIdentifier(name.typeName) };
 };
 
 const renderPrimitiveType = (target: TsTypeTarget, type: Extract<GirType, { kind: "primitive" }>): string =>
@@ -56,12 +56,13 @@ const renderBaseType = (library: Library, target: TsTypeTarget, ref: TypeId | un
     }
 
     const type = library.typeFor(ref);
-    const name = library.nameFor(ref);
 
     if (type === undefined) {
-        return renderNamedType(target, undefined, name);
+        return renderNamedType(target, undefined, undefined);
     }
 
+    const name = referenceName(library, ref);
+
     switch (type.kind) {
         case "primitive": {
             return renderPrimitiveType(target, type);
@@ -101,14 +102,14 @@ const renderContainerType = (
 };
 
 const renderSequenceType = (library: Library, target: TsTypeTarget, type: CArrayType | ListType): string => {
-    if (type.kind === "list" && type.flavor === "gbytearray" && target.shouldRenderByteArrayAsNumber) {
-        return "number[]";
-    }
-
     if (type.kind === "carray" && hasUnknownArrayLength(type)) {
         return "number";
     }
 
+    if (isByteSequence(library, type)) {
+        return target.byteArrayType;
+    }
+
     return `${renderBaseType(library, target, type.element)}[]`;
 };
 
@@ -124,20 +125,34 @@ const renderNamedType = (
     return target.renderNamed(resolved, name);
 };
 
-const moduleTarget = (context: ModuleContext): TsTypeTarget => ({
+const getByteArrayType = (library: Library): string =>
+    library.isByteArrayTyped ? BYTE_ARRAY_TYPE : NUMBER_ARRAY_TYPE;
+
+const moduleTarget = (context: ModuleContext, byteArrayType: string): TsTypeTarget => ({
     containerStyle: "map",
     callbackType: "((...args: any[]) => any)",
-    shouldRenderByteArrayAsNumber: true,
+    byteArrayType,
     renderNamed: (_resolved, name) => context.qualify(name.namespaceName, name.typeName),
     renderGtype: () => gtypeTsType(context),
 });
 
-const renderTsType = (context: ModuleContext, ref: TypeId | undefined, isNullable = false): string => {
-    const base = renderBaseType(context.library, moduleTarget(context), ref);
+const renderModuleType = (
+    context: ModuleContext,
+    ref: TypeId | undefined,
+    isNullable: boolean,
+    byteArrayType: string,
+): string => {
+    const base = renderBaseType(context.library, moduleTarget(context, byteArrayType), ref);
 
     return isNullable ? `${base} | null` : base;
 };
 
+const renderTsType = (context: ModuleContext, ref: TypeId | undefined, isNullable = false): string =>
+    renderModuleType(context, ref, isNullable, getByteArrayType(context.library));
+
+const renderParameterTsType = (context: ModuleContext, ref: TypeId | undefined, isNullable = false): string =>
+    renderModuleType(context, ref, isNullable, BYTE_ARRAY_INPUT_TYPE);
+
 const recordTypeTarget = (
     library: Library,
     renderNamedRef: (name: ReferenceName) => string,
@@ -146,7 +161,7 @@ const recordTypeTarget = (
     const target: TsTypeTarget = {
         containerStyle: "record",
         callbackType: "((...args: unknown[]) => unknown)",
-        shouldRenderByteArrayAsNumber: false,
+        byteArrayType: getByteArrayType(library),
         renderNamed: (resolved, name) => {
             if (resolved?.kind === "alias") {
                 return resolved.value.target === undefined
@@ -162,4 +177,4 @@ const recordTypeTarget = (
     return target;
 };
 
-export { renderBaseType, renderTsType, recordTypeTarget, type TsTypeTarget };
+export { renderBaseType, renderParameterTsType, renderTsType, recordTypeTarget, type TsTypeTarget };

package/src/analysis/type-key.ts

@@ -0,0 +1,14 @@
+import type { Library } from "../gir/library.js";
+import type { TypeId } from "../gir/type-id.js";
+
+const typeKey = (library: Library, ref: TypeId | undefined): string => {
+    if (ref === undefined) {
+        return "void";
+    }
+
+    const type = library.typeFor(ref);
+
+    return type?.kind === "primitive" && type.category === "void" ? "void" : `${String(ref.nsId)}.${String(ref.id)}`;
+};
+
+export { typeKey };

package/src/analysis/type-shape.ts

@@ -1,6 +1,6 @@
 import type { Library } from "../gir/library.js";
 import type { PrimitiveCategory } from "../gir/primitives.js";
-import type { CArrayType, TypeId } from "../gir/type-id.js";
+import type { CArrayType, ListType, TypeId } from "../gir/type-id.js";
 import type { GirType } from "../gir/type.js";
 
 const resolvedTypeFor = (library: Library, ref: TypeId | undefined): GirType | undefined =>
@@ -21,4 +21,7 @@ const primitiveCategoryFor = (library: Library, ref: TypeId | undefined): Primit
 const isUnboundedArray = (type: CArrayType): boolean =>
     type.isZeroTerminated && type.lengthParameterIndex === undefined && type.fixedSize === undefined;
 
-export { carrayFor, isUnboundedArray, primitiveCategoryFor };
+const isByteSequence = (library: Library, type: CArrayType | ListType): boolean =>
+    type.kind === "list" ? type.flavor === "gbytearray" : primitiveCategoryFor(library, type.element) === "uint8";
+
+export { carrayFor, isByteSequence, isUnboundedArray, primitiveCategoryFor };

package/src/compile.ts

@@ -1,20 +1,46 @@
-import { existsSync, mkdirSync, mkdtempSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
+import { errorCode, errorMessage, normalizeError } from "@gtkx/utils";
+import { existsSync, mkdirSync, renameSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
 import { dirname, isAbsolute, join, relative } from "node:path";
 import { fileURLToPath } from "node:url";
 import ts from "typescript";
+import { createStagingDir, sweepStrandedDirs } from "./staging.js";
 
-type SourceModule = {
+type ProjectFile = {
     fileName: string;
+    origin?: string | undefined;
+};
+
+type SourceModule = ProjectFile & {
     source: string;
 };
 
-type CompileProjectParams = {
+type ProjectContext = {
     projectDir: string;
-    fileNames: string[];
+    files: ProjectFile[];
+    label: string;
+};
+
+type CompileProjectParams = ProjectContext & {
     compilerOptions: Record<string, unknown>;
+};
+
+type EmitModulesParams = {
+    projectDir: string;
+    files: SourceModule[];
     label: string;
 };
 
+type DiagnosedFile = {
+    fileName: string;
+    text: string;
+};
+
+type FailedProjectInput = {
+    projectDir: string;
+    keepAt: string;
+    error: unknown;
+};
+
 const BASE_COMPILER_OPTIONS = {
     module: "esnext",
     moduleResolution: "bundler",
@@ -43,6 +69,34 @@ const CHECK_OPTIONS = {
     noEmit: true,
 };
 
+const DECLARATION_EMIT = {
+    declaration: true,
+    isolatedDeclarations: true,
+    removeComments: false,
+};
+
+const MODULE_EMIT = {
+    removeComments: false,
+};
+
+const DECLARATION_OPTIONS = ts.convertCompilerOptionsFromJson(
+    { ...BASE_COMPILER_OPTIONS, ...DECLARATION_EMIT },
+    ".",
+).options;
+
+const MODULE_OPTIONS = ts.convertCompilerOptionsFromJson(
+    { ...BASE_COMPILER_OPTIONS, ...MODULE_EMIT },
+    ".",
+).options;
+
+const TS_EXTENSION_PATTERN = /\.tsx?$/;
+const DECLARATION_EXTENSION = ".d.ts";
+const JAVASCRIPT_EXTENSION = ".js";
+const CHECK_DIR = ".gtkx-check";
+const FAILED_CHECK_DIR = `${CHECK_DIR}.failed`;
+const LEGACY_CHECK_PREFIX = `${CHECK_DIR}-`;
+const ESM_SCOPE_MANIFEST = `${JSON.stringify({ type: "module" }, null, 4)}\n`;
+
 const FORMAT_HOST: ts.FormatDiagnosticsHost = {
     getCanonicalFileName: (fileName) => fileName,
     getCurrentDirectory: () => ts.sys.getCurrentDirectory(),
@@ -69,57 +123,120 @@ const linkToolingModules = (projectDir: string): (() => void) => {
     };
 };
 
+const ensureModuleScope = (projectDir: string): void => {
+    try {
+        writeFileSync(join(projectDir, "package.json"), ESM_SCOPE_MANIFEST, { flag: "wx" });
+    } catch (error) {
+        if (errorCode(error) !== "EEXIST") {
+            throw error;
+        }
+    }
+};
+
 const isProjectFile = (rel: string): boolean =>
     !rel.startsWith("..") && !isAbsolute(rel) && !rel.split(/[/\\]/).includes("node_modules");
 
-const projectDiagnosticLine = (diagnostic: ts.Diagnostic, projectDir: string): string | undefined => {
+const projectDiagnosticFile = (diagnostic: ts.Diagnostic, projectDir: string): DiagnosedFile | undefined => {
     const { file, start } = diagnostic;
 
     if (file === undefined || start === undefined) {
         return undefined;
     }
 
-    const filePath = relative(projectDir, file.fileName);
+    const fileName = relative(projectDir, file.fileName);
 
-    if (!isProjectFile(filePath)) {
+    if (!isProjectFile(fileName)) {
         return undefined;
     }
 
     const { line, character } = file.getLineAndCharacterOfPosition(start);
     const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
 
-    return `${filePath}:${String(line + 1)}:${String(character + 1)} - ${message} (TS${String(diagnostic.code)})`;
+    return {
+        fileName,
+        text: `${fileName}:${String(line + 1)}:${String(character + 1)} - ${message} (TS${String(diagnostic.code)})`,
+    };
 };
 
-const projectDiagnosticLines = (diagnostics: ts.Diagnostic[], projectDir: string): string[] => {
-    const lines: string[] = [];
+const projectDiagnosticFiles = (diagnostics: ts.Diagnostic[], projectDir: string): DiagnosedFile[] => {
+    const diagnosed: DiagnosedFile[] = [];
 
     for (const diagnostic of diagnostics) {
-        const line = projectDiagnosticLine(diagnostic, projectDir);
+        const entry = projectDiagnosticFile(diagnostic, projectDir);
 
-        if (line !== undefined) {
-            lines.push(line);
+        if (entry !== undefined) {
+            diagnosed.push(entry);
         }
     }
 
-    return lines;
+    return diagnosed;
 };
 
-const diagnosticError = (label: string, projectDir: string, diagnostics: ts.Diagnostic[]): Error => {
-    const lines = projectDiagnosticLines(diagnostics, projectDir);
+const collectOrigins = (files: ProjectFile[]): Map<string, string> => {
+    const origins: Map<string, string> = new Map();
 
-    if (lines.length > 0) {
-        return new Error(`Type checking ${label} found ${String(lines.length)} error(s):\n${lines.join("\n")}`);
+    for (const { fileName, origin } of files) {
+        if (origin !== undefined) {
+            origins.set(fileName, origin);
+        }
+    }
+
+    return origins;
+};
+
+const groupByOrigin = (diagnosed: DiagnosedFile[], origins: Map<string, string>): Map<string, Set<string>> => {
+    const grouped: Map<string, Set<string>> = new Map();
+
+    for (const { fileName } of diagnosed) {
+        const origin = origins.get(fileName);
+
+        if (origin !== undefined) {
+            grouped.set(origin, (grouped.get(origin) ?? new Set<string>()).add(fileName));
+        }
     }
 
-    return new Error(`Type checking ${label} failed:\n${ts.formatDiagnostics(diagnostics, FORMAT_HOST).trim()}`);
+    return grouped;
+};
+
+const originLines = (diagnosed: DiagnosedFile[], files: ProjectFile[]): string[] =>
+    [...groupByOrigin(diagnosed, collectOrigins(files))].map(
+        ([origin, generated]) => `Generated from ${origin}: ${[...generated].join(", ")}`,
+    );
+
+const diagnosticError = (params: ProjectContext, diagnostics: ts.Diagnostic[]): Error => {
+    const diagnosed = projectDiagnosticFiles(diagnostics, params.projectDir);
+    const { label } = params;
+
+    if (diagnosed.length === 0) {
+        return new Error(`Compiling ${label} failed:\n${ts.formatDiagnostics(diagnostics, FORMAT_HOST).trim()}`);
+    }
+
+    const lines = [...diagnosed.map((entry) => entry.text), ...originLines(diagnosed, params.files)];
+
+    return new Error(`Compiling ${label} found ${String(diagnosed.length)} error(s):\n${lines.join("\n")}`);
+};
+
+const keepFailedProject = (input: FailedProjectInput): Error => {
+    const { projectDir, keepAt, error } = input;
+
+    if (!existsSync(projectDir)) {
+        return normalizeError(error);
+    }
+
+    rmSync(keepAt, { recursive: true, force: true });
+    renameSync(projectDir, keepAt);
+    const rebased = errorMessage(error).split(projectDir).join(keepAt);
+
+    return new Error(`${rebased}\nThe generated sources are kept at ${keepAt}, where every path above resolves.`, {
+        cause: error,
+    });
 };
 
 const runProgram = (params: CompileProjectParams): ts.Diagnostic[] => {
     const parsed = ts.parseJsonConfigFileContent(
         {
             compilerOptions: { ...BASE_COMPILER_OPTIONS, ...params.compilerOptions },
-            files: params.fileNames.map((name) => `./${name}`),
+            files: params.files.map((file) => `./${file.fileName}`),
         },
         ts.sys,
         params.projectDir,
@@ -140,24 +257,69 @@ const runProgram = (params: CompileProjectParams): ts.Diagnostic[] => {
     return [...program.emit().diagnostics];
 };
 
+const replaceExtension = (fileName: string, extension: string): string =>
+    `${fileName.replace(TS_EXTENSION_PATTERN, "")}${extension}`;
+
+const transpileOptions = (compilerOptions: ts.CompilerOptions, fileName: string): ts.TranspileOptions => ({
+    compilerOptions,
+    fileName,
+    reportDiagnostics: true,
+});
+
+const emitModule = (module: SourceModule, projectDir: string): ts.Diagnostic[] => {
+    const fileName = join(projectDir, module.fileName);
+    const declaration = ts.transpileDeclaration(module.source, transpileOptions(DECLARATION_OPTIONS, fileName));
+    const javascript = ts.transpileModule(module.source, transpileOptions(MODULE_OPTIONS, fileName));
+    const diagnostics = [...declaration.diagnostics ?? [], ...javascript.diagnostics ?? []];
+
+    if (diagnostics.length > 0) {
+        return diagnostics;
+    }
+
+    writeFileSync(replaceExtension(fileName, DECLARATION_EXTENSION), declaration.outputText);
+    writeFileSync(replaceExtension(fileName, JAVASCRIPT_EXTENSION), javascript.outputText);
+
+    return [];
+};
+
+const emitModules = (params: EmitModulesParams): void => {
+    const diagnostics: ts.Diagnostic[] = [];
+
+    for (const module of params.files) {
+        diagnostics.push(...emitModule(module, params.projectDir));
+    }
+
+    if (diagnostics.length > 0) {
+        throw diagnosticError(params, diagnostics);
+    }
+};
+
 const compileProject = (params: CompileProjectParams): void => {
+    ensureModuleScope(params.projectDir);
     const unlinkToolingModules = linkToolingModules(params.projectDir);
 
     try {
         const diagnostics = runProgram(params);
 
         if (diagnostics.length > 0) {
-            throw diagnosticError(params.label, params.projectDir, diagnostics);
+            throw diagnosticError(params, diagnostics);
         }
     } finally {
         unlinkToolingModules();
     }
 };
 
+const stageCheckProject = (checkRoot: string): string => {
+    const projectDir = createStagingDir(join(checkRoot, CHECK_DIR));
+    sweepStrandedDirs(checkRoot, LEGACY_CHECK_PREFIX);
+
+    return projectDir;
+};
+
 const checkModules = (params: { modules: SourceModule[]; resolveFrom: string; label: string }): void => {
     const checkRoot = join(params.resolveFrom, "node_modules");
-    mkdirSync(checkRoot, { recursive: true });
-    const projectDir = mkdtempSync(join(checkRoot, ".gtkx-check-"));
+    const projectDir = stageCheckProject(checkRoot);
+    const keepAt = join(checkRoot, FAILED_CHECK_DIR);
 
     try {
         for (const module of params.modules) {
@@ -168,13 +330,16 @@ const checkModules = (params: { modules: SourceModule[]; resolveFrom: string; la
 
         compileProject({
             projectDir,
-            fileNames: params.modules.map((module) => module.fileName),
+            files: params.modules,
             compilerOptions: CHECK_OPTIONS,
             label: params.label,
         });
-    } finally {
-        rmSync(projectDir, { recursive: true, force: true });
+    } catch (error) {
+        throw keepFailedProject({ projectDir, keepAt, error });
     }
+
+    rmSync(projectDir, { recursive: true, force: true });
+    rmSync(keepAt, { recursive: true, force: true });
 };
 
-export { compileProject, checkModules, type SourceModule };
+export { checkModules, emitModules, keepFailedProject, type SourceModule };

package/src/docs/api-reference.ts

@@ -1,7 +1,8 @@
-import { pascalCase, sortStrings, sortStringsBy } from "@gtkx/utils";
+import { sanitizeIdentifier, sanitizeTypeIdentifier, sortStrings, sortStringsBy } from "@gtkx/utils";
 import type { GirClass } from "../gir/class.js";
 import type { GirFunction } from "../gir/function.js";
 import type { GirRecord } from "../gir/record.js";
+import { isEmittableEntity } from "../gir/emittable.js";
 import { Library } from "../gir/library.js";
 import { type GirNamespace, namespaceDirectory } from "../gir/namespace.js";
 import { dedupeCallables, isEmittableCallable } from "../store/gi/callables.js";
@@ -23,6 +24,8 @@ type ApiReferenceOptions = {
     props?: ElementProps;
     /** GObject properties the project omits from generated props; without it pages show props that do not exist. */
     omittedProps?: OmittedProps;
+    /** Describes GIR byte sequences as `Uint8Array` rather than `number[]`; defaults to false. */
+    isByteArrayTyped?: boolean;
 };
 
 /** Narrows an `ApiReference.symbols` enumeration. */
@@ -214,13 +217,13 @@ const functionEntry = (
 };
 
 const classEntry = (namespace: GirNamespace, klass: GirClass): GiSymbolEntry | undefined => {
-    if (!klass.introspectable || klass.name.length === 0) {
+    if (!isEmittableEntity(klass)) {
         return undefined;
     }
 
     const kind = klass.isInterface ? "interface" : "class";
 
-    return { kind, namespace, name: pascalCase(klass.name), doc: klass.doc, klass };
+    return { kind, namespace, name: sanitizeTypeIdentifier(klass.name), doc: klass.doc, klass };
 };
 
 const classEntries = (namespace: GirNamespace): GiSymbolEntry[] => {
@@ -238,11 +241,11 @@ const classEntries = (namespace: GirNamespace): GiSymbolEntry[] => {
 };
 
 const recordEntry = (namespace: GirNamespace, record: GirRecord): GiSymbolEntry | undefined => {
-    if (!record.introspectable || record.isVtable || record.name.length === 0) {
+    if (record.isVtable || !isEmittableEntity(record)) {
         return undefined;
     }
 
-    return { kind: "record", namespace, name: record.name, doc: record.doc, record };
+    return { kind: "record", namespace, name: sanitizeTypeIdentifier(record.name), doc: record.doc, record };
 };
 
 const recordEntries = (namespace: GirNamespace): GiSymbolEntry[] => {
@@ -265,7 +268,7 @@ const valueEntries = (namespace: GirNamespace): GiSymbolEntry[] => [
         .map<GiSymbolEntry>((enumeration) => ({
             kind: "enum",
             namespace,
-            name: enumeration.name,
+            name: sanitizeTypeIdentifier(enumeration.name),
             doc: enumeration.doc,
             enumeration,
         })),
@@ -274,21 +277,21 @@ const valueEntries = (namespace: GirNamespace): GiSymbolEntry[] => [
         .map<GiSymbolEntry>((callback) => ({
             kind: "callback",
             namespace,
-            name: callback.name,
+            name: sanitizeTypeIdentifier(callback.name),
             doc: callback.doc,
             callback,
         })),
     ...namespace.aliases.map<GiSymbolEntry>((alias) => ({
         kind: "alias",
         namespace,
-        name: alias.name,
+        name: sanitizeTypeIdentifier(alias.name),
         doc: alias.doc,
         alias,
     })),
     ...namespace.constants.map<GiSymbolEntry>((constant) => ({
         kind: "constant",
         namespace,
-        name: constant.name,
+        name: sanitizeIdentifier(constant.name),
         doc: constant.doc,
         constant,
     })),
@@ -370,7 +373,7 @@ class ApiReference {
         this.libraries = options.libraries;
         this.props = options.props ?? {};
         this.omittedProps = options.omittedProps ?? {};
-        this.library = Library.load(options.libraries, options.girPath);
+        this.library = Library.load(options.libraries, options.girPath, options.isByteArrayTyped === true);
         this.elementContext = { library: this.library, linkFor: (): string | undefined => undefined };
         this.buildIndex();
     }

package/src/docs/element-page.ts

@@ -29,6 +29,7 @@ import {
     originSignatureBlocks,
     type OriginSignatureEntry,
     propertyMetaLine,
+    qualifiedClassName,
     renderDocsSignalSignature,
     renderDocsType,
     signalTags,
@@ -76,7 +77,9 @@ const hierarchySection = (entry: GlibNamedClass, context: ElementPageContext): s
     const parts = ancestors.map((ancestor) => {
         const glib = getGlibName(ancestor.klass);
 
-        return glib === undefined ? `\`${ancestor.namespaceName}.${ancestor.klass.name}\`` : glibLabel(context, glib);
+        return glib === undefined
+            ? `\`${qualifiedClassName(ancestor.namespaceName, ancestor.klass.name)}\``
+            : glibLabel(context, glib);
     });
 
     parts.push(`**${entry.glibName}**`);
@@ -265,7 +268,7 @@ const methodsSection = (entry: GlibNamedClass, context: ElementPageContext, self
 };
 
 const renderElementPage = (entry: GlibNamedClass, context: ElementPageContext): string => {
-    const selfType = `${entry.namespace.name}.${entry.klass.name}`;
+    const selfType = qualifiedClassName(entry.namespace.name, entry.klass.name);
 
     return joinSections([
         frontmatter(entry),