@gtkx/codegen 1.1.0 → 1.2.0

package/dist/store/store-fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"store-fs.js","sourceRoot":"","sources":["../../src/store/store-fs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACH,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,UAAU,EACV,MAAM,EACN,WAAW,EACX,aAAa,GAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAqB,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAyClD,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAsC,EAAE,CAAC,CAAC;IACzE,KAAK,EAAE,KAAK,IAAI,OAAO;IACvB,OAAO,EAAE,KAAK,IAAI,KAAK;CAC1B,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAwC,EAAE,CAAC,CAAC;IAClF,QAAQ,EAAE,GAAG,SAAS,WAAW;IACjC,MAAM,EAAE,oBAAoB,SAAS,SAAS;CACjD,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,KAAoB,EAAY,EAAE;IACrD,MAAM,QAAQ,GAAa;QACvB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE;KACpE,CAAC;IAEF,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;QACzB,QAAQ,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;IACvD,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAwB,EAAQ,EAAE;IAClD,MAAM,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,GAAG,mBAAmB,EAAE,CAAC;IAE1D,IAAI,CAAC;QACD,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC5B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,iBAAiB,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,MAAwB,EAAQ,EAAE;IACnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAC9B,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,YAAY,CAAC;QACT,QAAQ,EAAE,GAAG;QACb,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;QACjC,GAAG,CAAC,MAAM,CAAC,oBAAoB,KAAK,SAAS,IAAI,EAAE,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,EAAE,CAAC;KAC1G,CAAC,CAAC;IAEH,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;IAEvC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QACzB,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,QAAgB,EAAE,MAAc,EAAQ,EAAE;IACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1C,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,UAAkB,EAAQ,EAAE;IACnE,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,QAAkB,EAAQ,EAAE;IACpE,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5F,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,QAAgB,EAAQ,EAAE;IACtD,MAAM,QAAQ,GAAG,GAAG,QAAQ,MAAM,CAAC;IACnC,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvB,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC1B,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAe,EAAW,EAAE;IAC/C,IAAI,CAAC;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtE,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAe,EAAQ,EAAE;IAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1E,OAAO;IACX,CAAC;IAED,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,KAAc,EAAU,EAAE,CACnE,uCAAuC,QAAQ,KAAK,YAAY,CAAC,KAAK,CAAC,IAAI;IAC3E,kFAAkF;IAClF,MAAM,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC;AAElD,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAU,EAAE;IACjD,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACvC,SAAS,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAE/B,OAAO,GAAG,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EACH,aAAa,EACb,aAAa,EACb,eAAe,EACf,eAAe,EACf,UAAU,GAGb,CAAC","sourcesContent":["import { errorMessage } from \"@gtkx/utils\";\nimport {\n    chmodSync,\n    existsSync,\n    mkdirSync,\n    realpathSync,\n    renameSync,\n    rmSync,\n    symlinkSync,\n    writeFileSync,\n} from \"node:fs\";\nimport { dirname, join, relative } from \"node:path\";\nimport { keepFailedProject, type SourceModule } from \"../compile.js\";\nimport { createStagingDir } from \"../staging.js\";\nimport { compileStore } from \"./compile-store.js\";\n\n/** Where one generated store is written and how it is reached. */\ntype StoreOptions = {\n    /** Directory the generated package is written to, replaced atomically on each run. */\n    storeDir: string;\n    /** Path the store is symlinked at, which is the specifier's resolution target under `node_modules`. */\n    linkDir: string;\n    /** Version stamped on the store's `package.json`, taken from the dependency the store is generated for. */\n    version: string;\n};\n\ntype StoreLink = Pick<StoreOptions, \"storeDir\" | \"linkDir\">;\n\ntype Manifest = {\n    name: string;\n    type: \"module\";\n    version: string;\n    sideEffects: true;\n    exports: Record<string, unknown>;\n    peerDependencies?: Record<string, string>;\n};\n\ntype ManifestInput = {\n    name: string;\n    version: string;\n    exports: Record<string, unknown>;\n    peerDependencies?: Record<string, string>;\n};\n\ntype RawFile = { relativePath: string; content: string };\n\ntype WriteStoreParams = {\n    storeDir: string;\n    linkDir: string;\n    files: SourceModule[];\n    manifest: Manifest;\n    rawFiles?: RawFile[];\n    requiresEnvReference?: boolean;\n};\n\nconst STORE_DIR_MODE = 0o755;\nconst FAILED_STORE_SUFFIX = \".failed\";\n\nconst subpathExport = (stem: string): { types: string; default: string } => ({\n    types: `./${stem}.d.ts`,\n    default: `./${stem}.js`,\n});\n\nconst namespaceBarrel = (directory: string): { fileName: string; source: string } => ({\n    fileName: `${directory}/index.ts`,\n    source: `export * from \"./${directory}.js\";\\n`,\n});\n\nconst buildManifest = (input: ManifestInput): Manifest => {\n    const manifest: Manifest = {\n        name: input.name,\n        type: \"module\",\n        version: input.version,\n        sideEffects: true,\n        exports: { \"./package.json\": \"./package.json\", ...input.exports },\n    };\n\n    if (input.peerDependencies) {\n        manifest.peerDependencies = input.peerDependencies;\n    }\n\n    return manifest;\n};\n\nconst writeStore = (params: WriteStoreParams): void => {\n    const tmp = createTempStore(params.storeDir);\n    const keepAt = `${params.storeDir}${FAILED_STORE_SUFFIX}`;\n\n    try {\n        buildTempStore(tmp, params);\n        swapStore(tmp, params.storeDir);\n        ensureStoreLink(params);\n    } catch (error) {\n        throw keepFailedProject({ projectDir: tmp, keepAt, error });\n    }\n\n    rmSync(keepAt, { recursive: true, force: true });\n};\n\nconst buildTempStore = (tmp: string, params: WriteStoreParams): void => {\n    for (const file of params.files) {\n        writeSourceFile(tmp, file.fileName, file.source);\n    }\n\n    compileStore({\n        storeDir: tmp,\n        files: params.files,\n        packageName: params.manifest.name,\n        ...(params.requiresEnvReference !== undefined && { requiresEnvReference: params.requiresEnvReference }),\n    });\n\n    writePackageJson(tmp, params.manifest);\n    const rawFiles = params.rawFiles ?? [];\n\n    for (const raw of rawFiles) {\n        writeFileSync(join(tmp, raw.relativePath), raw.content);\n    }\n};\n\nconst writeSourceFile = (storeDir: string, fileName: string, source: string): void => {\n    const filePath = join(storeDir, fileName);\n    mkdirSync(dirname(filePath), { recursive: true });\n    writeFileSync(filePath, source);\n};\n\nconst symlinkRelative = (linkPath: string, realTarget: string): void => {\n    mkdirSync(dirname(linkPath), { recursive: true });\n    rmSync(linkPath, { recursive: true, force: true });\n    symlinkSync(relative(dirname(linkPath), realTarget), linkPath, \"dir\");\n};\n\nconst writePackageJson = (storeDir: string, manifest: Manifest): void => {\n    writeFileSync(join(storeDir, \"package.json\"), `${JSON.stringify(manifest, null, 2)}\\n`);\n};\n\nconst swapStore = (tmp: string, storeDir: string): void => {\n    const previous = `${storeDir}.old`;\n    rmSync(previous, { recursive: true, force: true });\n\n    if (existsSync(storeDir)) {\n        renameSync(storeDir, previous);\n    }\n\n    renameSync(tmp, storeDir);\n    rmSync(previous, { recursive: true, force: true });\n};\n\nconst isStoreLinked = (link: StoreLink): boolean => {\n    try {\n        return realpathSync(link.linkDir) === realpathSync(link.storeDir);\n    } catch {\n        return false;\n    }\n};\n\nconst ensureStoreLink = (link: StoreLink): void => {\n    if (!existsSync(join(link.storeDir, \"package.json\")) || isStoreLinked(link)) {\n        return;\n    }\n\n    symlinkRelative(link.linkDir, link.storeDir);\n};\n\nconst storeWriteMessage = (storeDir: string, error: unknown): string =>\n    `Cannot write the generated store to ${storeDir}: ${errorMessage(error)}. ` +\n    \"Codegen writes the store into the node_modules the @gtkx packages resolve from, \" +\n    `so ${dirname(storeDir)} has to be writable.`;\n\nconst createTempStore = (storeDir: string): string => {\n    try {\n        const tmp = createStagingDir(storeDir);\n        chmodSync(tmp, STORE_DIR_MODE);\n\n        return tmp;\n    } catch (error) {\n        throw new Error(storeWriteMessage(storeDir, error), { cause: error });\n    }\n};\n\nexport {\n    subpathExport,\n    buildManifest,\n    ensureStoreLink,\n    namespaceBarrel,\n    writeStore,\n    type StoreOptions,\n    type RawFile,\n};\n"]}
+{"version":3,"file":"store-fs.js","sourceRoot":"","sources":["../../src/store/store-fs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACH,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,UAAU,EACV,MAAM,EACN,WAAW,EACX,aAAa,GAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAqB,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAwClD,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAsC,EAAE,CAAC,CAAC;IACzE,KAAK,EAAE,KAAK,IAAI,OAAO;IACvB,OAAO,EAAE,KAAK,IAAI,KAAK;CAC1B,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAwC,EAAE,CAAC,CAAC;IAClF,QAAQ,EAAE,GAAG,SAAS,WAAW;IACjC,MAAM,EAAE,oBAAoB,SAAS,SAAS;CACjD,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,KAAoB,EAAY,EAAE;IACrD,MAAM,QAAQ,GAAa;QACvB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE;KACpE,CAAC;IAEF,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;QACzB,QAAQ,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;IACvD,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAwB,EAAQ,EAAE;IAClD,MAAM,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,GAAG,mBAAmB,EAAE,CAAC;IAE1D,IAAI,CAAC;QACD,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC5B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,iBAAiB,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,MAAwB,EAAQ,EAAE;IACnE,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEvC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAC9B,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,YAAY,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACxF,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;IAEvC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QACzB,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,QAAgB,EAAE,MAAc,EAAQ,EAAE;IACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1C,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,UAAkB,EAAQ,EAAE;IACnE,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,QAAkB,EAAQ,EAAE;IACpE,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5F,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,QAAgB,EAAQ,EAAE;IACtD,MAAM,QAAQ,GAAG,GAAG,QAAQ,MAAM,CAAC;IACnC,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvB,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC1B,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAe,EAAW,EAAE;IAC/C,IAAI,CAAC;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtE,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAe,EAAQ,EAAE;IAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1E,OAAO;IACX,CAAC;IAED,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,KAAc,EAAU,EAAE,CACnE,uCAAuC,QAAQ,KAAK,YAAY,CAAC,KAAK,CAAC,IAAI;IAC3E,kFAAkF;IAClF,MAAM,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC;AAElD,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAU,EAAE;IACjD,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACvC,SAAS,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAE/B,OAAO,GAAG,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EACH,aAAa,EACb,aAAa,EACb,eAAe,EACf,eAAe,EACf,UAAU,GAGb,CAAC","sourcesContent":["import { errorMessage } from \"@gtkx/utils\";\nimport {\n    chmodSync,\n    existsSync,\n    mkdirSync,\n    realpathSync,\n    renameSync,\n    rmSync,\n    symlinkSync,\n    writeFileSync,\n} from \"node:fs\";\nimport { dirname, join, relative } from \"node:path\";\nimport { keepFailedProject, type SourceModule } from \"../compile.js\";\nimport { createStagingDir } from \"../staging.js\";\nimport { compileStore } from \"./compile-store.js\";\n\n/** Where one generated store is written and how it is reached. */\ntype StoreOptions = {\n    /** Directory the generated package is written to, replaced atomically on each run. */\n    storeDir: string;\n    /** Path the store is symlinked at, which is the specifier's resolution target under `node_modules`. */\n    linkDir: string;\n    /** Version stamped on the store's `package.json`, taken from the dependency the store is generated for. */\n    version: string;\n};\n\ntype StoreLink = Pick<StoreOptions, \"storeDir\" | \"linkDir\">;\n\ntype Manifest = {\n    name: string;\n    type: \"module\";\n    version: string;\n    sideEffects: true;\n    exports: Record<string, unknown>;\n    peerDependencies?: Record<string, string>;\n};\n\ntype ManifestInput = {\n    name: string;\n    version: string;\n    exports: Record<string, unknown>;\n    peerDependencies?: Record<string, string>;\n};\n\ntype RawFile = { relativePath: string; content: string };\n\ntype WriteStoreParams = {\n    storeDir: string;\n    linkDir: string;\n    files: SourceModule[];\n    manifest: Manifest;\n    rawFiles?: RawFile[];\n};\n\nconst STORE_DIR_MODE = 0o755;\nconst FAILED_STORE_SUFFIX = \".failed\";\n\nconst subpathExport = (stem: string): { types: string; default: string } => ({\n    types: `./${stem}.d.ts`,\n    default: `./${stem}.js`,\n});\n\nconst namespaceBarrel = (directory: string): { fileName: string; source: string } => ({\n    fileName: `${directory}/index.ts`,\n    source: `export * from \"./${directory}.js\";\\n`,\n});\n\nconst buildManifest = (input: ManifestInput): Manifest => {\n    const manifest: Manifest = {\n        name: input.name,\n        type: \"module\",\n        version: input.version,\n        sideEffects: true,\n        exports: { \"./package.json\": \"./package.json\", ...input.exports },\n    };\n\n    if (input.peerDependencies) {\n        manifest.peerDependencies = input.peerDependencies;\n    }\n\n    return manifest;\n};\n\nconst writeStore = (params: WriteStoreParams): void => {\n    const tmp = createTempStore(params.storeDir);\n    const keepAt = `${params.storeDir}${FAILED_STORE_SUFFIX}`;\n\n    try {\n        buildTempStore(tmp, params);\n        swapStore(tmp, params.storeDir);\n        ensureStoreLink(params);\n    } catch (error) {\n        throw keepFailedProject({ projectDir: tmp, keepAt, error });\n    }\n\n    rmSync(keepAt, { recursive: true, force: true });\n};\n\nconst buildTempStore = (tmp: string, params: WriteStoreParams): void => {\n    writePackageJson(tmp, params.manifest);\n\n    for (const file of params.files) {\n        writeSourceFile(tmp, file.fileName, file.source);\n    }\n\n    compileStore({ storeDir: tmp, files: params.files, packageName: params.manifest.name });\n    const rawFiles = params.rawFiles ?? [];\n\n    for (const raw of rawFiles) {\n        writeFileSync(join(tmp, raw.relativePath), raw.content);\n    }\n};\n\nconst writeSourceFile = (storeDir: string, fileName: string, source: string): void => {\n    const filePath = join(storeDir, fileName);\n    mkdirSync(dirname(filePath), { recursive: true });\n    writeFileSync(filePath, source);\n};\n\nconst symlinkRelative = (linkPath: string, realTarget: string): void => {\n    mkdirSync(dirname(linkPath), { recursive: true });\n    rmSync(linkPath, { recursive: true, force: true });\n    symlinkSync(relative(dirname(linkPath), realTarget), linkPath, \"dir\");\n};\n\nconst writePackageJson = (storeDir: string, manifest: Manifest): void => {\n    writeFileSync(join(storeDir, \"package.json\"), `${JSON.stringify(manifest, null, 2)}\\n`);\n};\n\nconst swapStore = (tmp: string, storeDir: string): void => {\n    const previous = `${storeDir}.old`;\n    rmSync(previous, { recursive: true, force: true });\n\n    if (existsSync(storeDir)) {\n        renameSync(storeDir, previous);\n    }\n\n    renameSync(tmp, storeDir);\n    rmSync(previous, { recursive: true, force: true });\n};\n\nconst isStoreLinked = (link: StoreLink): boolean => {\n    try {\n        return realpathSync(link.linkDir) === realpathSync(link.storeDir);\n    } catch {\n        return false;\n    }\n};\n\nconst ensureStoreLink = (link: StoreLink): void => {\n    if (!existsSync(join(link.storeDir, \"package.json\")) || isStoreLinked(link)) {\n        return;\n    }\n\n    symlinkRelative(link.linkDir, link.storeDir);\n};\n\nconst storeWriteMessage = (storeDir: string, error: unknown): string =>\n    `Cannot write the generated store to ${storeDir}: ${errorMessage(error)}. ` +\n    \"Codegen writes the store into the node_modules the @gtkx packages resolve from, \" +\n    `so ${dirname(storeDir)} has to be writable.`;\n\nconst createTempStore = (storeDir: string): string => {\n    try {\n        const tmp = createStagingDir(storeDir);\n        chmodSync(tmp, STORE_DIR_MODE);\n\n        return tmp;\n    } catch (error) {\n        throw new Error(storeWriteMessage(storeDir, error), { cause: error });\n    }\n};\n\nexport {\n    subpathExport,\n    buildManifest,\n    ensureStoreLink,\n    namespaceBarrel,\n    writeStore,\n    type StoreOptions,\n    type RawFile,\n};\n"]}

package/dist/xml.d.ts

@@ -3,6 +3,7 @@ type XmlFileInput = {
     parser: XMLParser;
     label: string;
     path: string;
+    malformedRemedy?: string;
 };
 declare const createXmlParser: (options: Partial<X2jOptions>) => XMLParser;
 declare const parseXmlFile: (input: XmlFileInput) => unknown;

package/dist/xml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI7D,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,QAAA,MAAM,eAAe,GAAI,SAAS,OAAO,CAAC,UAAU,CAAC,KAAG,SAOlD,CAAC;AA0CP,QAAA,MAAM,YAAY,GAAI,OAAO,YAAY,KAAG,OAS3C,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI7D,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAKF,QAAA,MAAM,eAAe,GAAI,SAAS,OAAO,CAAC,UAAU,CAAC,KAAG,SAOlD,CAAC;AAgFP,QAAA,MAAM,YAAY,GAAI,OAAO,YAAY,KAAG,OAS3C,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC"}

package/dist/xml.js

@@ -2,6 +2,8 @@ import { errorMessage, isRecord } from "@gtkx/utils";
 import { XMLParser } from "fast-xml-parser";
 import { SyntaxValidator } from "fast-xml-validator";
 import { readFileSync } from "node:fs";
+const HIGHEST_CONTROL_CODE = 0x1F;
+const LEGAL_CONTROL_CODES = new Set([0x09, 0x0A, 0x0D]);
 const createXmlParser = (options) => new XMLParser({
     ignoreAttributes: false,
     attributeNamePrefix: "@_",
@@ -29,13 +31,38 @@ const positionSuffix = (error) => {
     }
     return ` (line ${String(line)}, column ${String(col)})`;
 };
+const isIllegalControlCode = (code) => code <= HIGHEST_CONTROL_CODE && !LEGAL_CONTROL_CODES.has(code);
+const escapedCode = (code) => `[U+${code.toString(16).toUpperCase().padStart(4, "0")}]`;
+const escapeControlCodes = (text) => {
+    let escaped = "";
+    for (const character of text) {
+        const code = character.codePointAt(0) ?? 0;
+        escaped += isIllegalControlCode(code) ? escapedCode(code) : character;
+    }
+    return escaped;
+};
+const offendingLine = (xml, error) => {
+    const line = isRecord(error) ? error.line : undefined;
+    if (typeof line !== "number") {
+        return "";
+    }
+    const text = xml.split("\n")[line - 1];
+    if (text === undefined) {
+        return "";
+    }
+    return `\n    ${escapeControlCodes(text.replace(/^[ \t]+/, "").replace(/\r$/, ""))}`;
+};
+const remedySuffix = (input, xml, error) => {
+    const remedy = input.malformedRemedy;
+    return remedy === undefined ? "" : `${offendingLine(xml, error)}\n${remedy}`;
+};
 const assertWellFormed = (input, xml) => {
     try {
         SyntaxValidator.validate(xml);
     }
     catch (error) {
         throw new Error(`The ${input.label} at ${input.path} is not well-formed XML: ` +
-            `${errorMessage(error)}${positionSuffix(error)}`, { cause: error });
+            `${errorMessage(error)}${positionSuffix(error)}${remedySuffix(input, xml, error)}`, { cause: error });
     }
 };
 const parseXmlFile = (input) => {

package/dist/xml.js.map

@@ -1 +1 @@
-{"version":3,"file":"xml.js","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAmB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQvC,MAAM,eAAe,GAAG,CAAC,OAA4B,EAAa,EAAE,CAChE,IAAI,SAAS,CAAC;IACV,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,GAAG,OAAO;CACb,CAAC,CAAC;AAEP,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAE,MAAc,EAAE,KAAc,EAAS,EAAE,CAChF,IAAI,KAAK,CAAC,UAAU,MAAM,QAAQ,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAEhH,MAAM,WAAW,GAAG,CAAC,KAAmB,EAAU,EAAE;IAChD,IAAI,CAAC;QACD,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAAa,EAAE,GAAY,EAAW,EAAE,CACvD,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;AAEjF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAU,EAAE;IAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAE5B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,UAAU,MAAM,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAE,GAAW,EAAQ,EAAE;IAChE,IAAI,CAAC;QACD,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACX,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,2BAA2B;YAC9D,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,EAChD,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CAAC;IACN,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAW,EAAE;IAClD,MAAM,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAC/B,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAE7B,IAAI,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { errorMessage, isRecord } from \"@gtkx/utils\";\nimport { type X2jOptions, XMLParser } from \"fast-xml-parser\";\nimport { SyntaxValidator } from \"fast-xml-validator\";\nimport { readFileSync } from \"node:fs\";\n\ntype XmlFileInput = {\n    parser: XMLParser;\n    label: string;\n    path: string;\n};\n\nconst createXmlParser = (options: Partial<X2jOptions>): XMLParser =>\n    new XMLParser({\n        ignoreAttributes: false,\n        attributeNamePrefix: \"@_\",\n        parseAttributeValue: false,\n        parseTagValue: false,\n        ...options,\n    });\n\nconst xmlFileError = (input: XmlFileInput, action: string, error: unknown): Error =>\n    new Error(`Cannot ${action} the ${input.label} at ${input.path}: ${errorMessage(error)}`, { cause: error });\n\nconst readXmlFile = (input: XmlFileInput): string => {\n    try {\n        return readFileSync(input.path, \"utf8\");\n    } catch (error) {\n        throw xmlFileError(input, \"read\", error);\n    }\n};\n\nconst isLocated = (line: unknown, col: unknown): boolean =>\n    typeof line === \"number\" && typeof col === \"number\" && (line > 1 || col > 1);\n\nconst positionSuffix = (error: unknown): string => {\n    if (!isRecord(error)) {\n        return \"\";\n    }\n\n    const { line, col } = error;\n\n    if (!isLocated(line, col)) {\n        return \"\";\n    }\n\n    return ` (line ${String(line)}, column ${String(col)})`;\n};\n\nconst assertWellFormed = (input: XmlFileInput, xml: string): void => {\n    try {\n        SyntaxValidator.validate(xml);\n    } catch (error) {\n        throw new Error(\n            `The ${input.label} at ${input.path} is not well-formed XML: ` +\n            `${errorMessage(error)}${positionSuffix(error)}`,\n            { cause: error },\n        );\n    }\n};\n\nconst parseXmlFile = (input: XmlFileInput): unknown => {\n    const xml = readXmlFile(input);\n    assertWellFormed(input, xml);\n\n    try {\n        return input.parser.parse(xml);\n    } catch (error) {\n        throw xmlFileError(input, \"parse\", error);\n    }\n};\n\nexport { createXmlParser, parseXmlFile };\n"]}
+{"version":3,"file":"xml.js","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAmB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AASvC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAClC,MAAM,mBAAmB,GAAgB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAErE,MAAM,eAAe,GAAG,CAAC,OAA4B,EAAa,EAAE,CAChE,IAAI,SAAS,CAAC;IACV,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,GAAG,OAAO;CACb,CAAC,CAAC;AAEP,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAE,MAAc,EAAE,KAAc,EAAS,EAAE,CAChF,IAAI,KAAK,CAAC,UAAU,MAAM,QAAQ,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAEhH,MAAM,WAAW,GAAG,CAAC,KAAmB,EAAU,EAAE;IAChD,IAAI,CAAC;QACD,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAAa,EAAE,GAAY,EAAW,EAAE,CACvD,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;AAEjF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAU,EAAE;IAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAE5B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,UAAU,MAAM,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAW,EAAE,CACnD,IAAI,IAAI,oBAAoB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAEnE,MAAM,WAAW,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;AAExG,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAU,EAAE;IAChD,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,KAAc,EAAU,EAAE;IAC1D,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAEtD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IAEvC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,SAAS,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;AACzF,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAE,GAAW,EAAE,KAAc,EAAU,EAAE;IAC9E,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC;IAErC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,MAAM,EAAE,CAAC;AACjF,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAE,GAAW,EAAQ,EAAE;IAChE,IAAI,CAAC;QACD,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACX,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,2BAA2B;YAC9D,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,EAClF,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CAAC;IACN,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAW,EAAE;IAClD,MAAM,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAC/B,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAE7B,IAAI,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { errorMessage, isRecord } from \"@gtkx/utils\";\nimport { type X2jOptions, XMLParser } from \"fast-xml-parser\";\nimport { SyntaxValidator } from \"fast-xml-validator\";\nimport { readFileSync } from \"node:fs\";\n\ntype XmlFileInput = {\n    parser: XMLParser;\n    label: string;\n    path: string;\n    malformedRemedy?: string;\n};\n\nconst HIGHEST_CONTROL_CODE = 0x1F;\nconst LEGAL_CONTROL_CODES: Set<number> = new Set([0x09, 0x0A, 0x0D]);\n\nconst createXmlParser = (options: Partial<X2jOptions>): XMLParser =>\n    new XMLParser({\n        ignoreAttributes: false,\n        attributeNamePrefix: \"@_\",\n        parseAttributeValue: false,\n        parseTagValue: false,\n        ...options,\n    });\n\nconst xmlFileError = (input: XmlFileInput, action: string, error: unknown): Error =>\n    new Error(`Cannot ${action} the ${input.label} at ${input.path}: ${errorMessage(error)}`, { cause: error });\n\nconst readXmlFile = (input: XmlFileInput): string => {\n    try {\n        return readFileSync(input.path, \"utf8\");\n    } catch (error) {\n        throw xmlFileError(input, \"read\", error);\n    }\n};\n\nconst isLocated = (line: unknown, col: unknown): boolean =>\n    typeof line === \"number\" && typeof col === \"number\" && (line > 1 || col > 1);\n\nconst positionSuffix = (error: unknown): string => {\n    if (!isRecord(error)) {\n        return \"\";\n    }\n\n    const { line, col } = error;\n\n    if (!isLocated(line, col)) {\n        return \"\";\n    }\n\n    return ` (line ${String(line)}, column ${String(col)})`;\n};\n\nconst isIllegalControlCode = (code: number): boolean =>\n    code <= HIGHEST_CONTROL_CODE && !LEGAL_CONTROL_CODES.has(code);\n\nconst escapedCode = (code: number): string => `[U+${code.toString(16).toUpperCase().padStart(4, \"0\")}]`;\n\nconst escapeControlCodes = (text: string): string => {\n    let escaped = \"\";\n\n    for (const character of text) {\n        const code = character.codePointAt(0) ?? 0;\n        escaped += isIllegalControlCode(code) ? escapedCode(code) : character;\n    }\n\n    return escaped;\n};\n\nconst offendingLine = (xml: string, error: unknown): string => {\n    const line = isRecord(error) ? error.line : undefined;\n\n    if (typeof line !== \"number\") {\n        return \"\";\n    }\n\n    const text = xml.split(\"\\n\")[line - 1];\n\n    if (text === undefined) {\n        return \"\";\n    }\n\n    return `\\n    ${escapeControlCodes(text.replace(/^[ \\t]+/, \"\").replace(/\\r$/, \"\"))}`;\n};\n\nconst remedySuffix = (input: XmlFileInput, xml: string, error: unknown): string => {\n    const remedy = input.malformedRemedy;\n\n    return remedy === undefined ? \"\" : `${offendingLine(xml, error)}\\n${remedy}`;\n};\n\nconst assertWellFormed = (input: XmlFileInput, xml: string): void => {\n    try {\n        SyntaxValidator.validate(xml);\n    } catch (error) {\n        throw new Error(\n            `The ${input.label} at ${input.path} is not well-formed XML: ` +\n            `${errorMessage(error)}${positionSuffix(error)}${remedySuffix(input, xml, error)}`,\n            { cause: error },\n        );\n    }\n};\n\nconst parseXmlFile = (input: XmlFileInput): unknown => {\n    const xml = readXmlFile(input);\n    assertWellFormed(input, xml);\n\n    try {\n        return input.parser.parse(xml);\n    } catch (error) {\n        throw xmlFileError(input, \"parse\", error);\n    }\n};\n\nexport { createXmlParser, parseXmlFile };\n"]}

package/overrides/gobject/object.ts.ejs

@@ -52,6 +52,7 @@ declare module "../gobject.js" {
          * @param callback Handler invoked on each emission.
          * @param isAfter Run the handler after the default handler rather than before it.
          * @returns The same object, so calls chain.
+         * @deprecated Since 1.2. Use `on` instead. Removed in v2.
          */
         addEventListener(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
@@ -61,6 +62,7 @@ declare module "../gobject.js" {
          * @param sigName Signal the handler was connected to.
          * @param callback The handler that was connected.
          * @returns The same object, so calls chain.
+         * @deprecated Since 1.2. Use `off` instead. Removed in v2.
          */
         removeEventListener(sigName: string, callback: (...args: unknown[]) => unknown): Object;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gtkx/codegen",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Generates the typed GTKX bindings and API reference from GIR and OpenGL registry data",
   "keywords": [
     "gtkx",
@@ -58,8 +58,8 @@
     "fast-xml-parser": "^5.10.1",
     "fast-xml-validator": "^1.4.1",
     "typescript": "^6.0.3",
-    "@gtkx/react": "1.1.0",
-    "@gtkx/utils": "1.1.0"
+    "@gtkx/react": "1.2.0",
+    "@gtkx/utils": "1.2.0"
   },
   "scripts": {
     "release": "tsx ../../scripts/release-package.ts"

package/src/analysis/descriptor-render.ts

@@ -24,10 +24,12 @@ import { isRecordInout } from "../store/gi/param-marshal.js";
 import { computeRecordFieldSlots, recordInlineSize } from "../store/gi/record-layout.js";
 import { isValueMarshalable } from "../store/gi/value-marshalable.js";
 import {
+    type ArrayLayout,
     type ListDescriptorName,
     type Ownership,
     type ScalarDescriptorName,
     tArray,
+    tBiguint64,
     tBoxed,
     tByteArray,
     tCallback,
@@ -40,6 +42,7 @@ import {
     tHashTable,
     tInt32,
     tList,
+    tNumericByteArray,
     tObject,
     tRef,
     tScalar,
@@ -50,7 +53,7 @@ import {
     tUint64,
     tVoid,
 } from "./descriptor.js";
-import { carrayFor, isUnboundedArray, primitiveCategoryFor } from "./type-shape.js";
+import { carrayFor, isByteSequence, isUnboundedArray, primitiveCategoryFor } from "./type-shape.js";
 
 type PrimaryReturnKind = "surfaced" | "void" | "skipped";
 
@@ -220,7 +223,7 @@ const listExpression = (
     const ownership = transferOwnership(transfer);
 
     if (type.flavor === "gbytearray") {
-        return tByteArray(ownership);
+        return context.library.isByteArrayTyped ? tByteArray(ownership) : tNumericByteArray(ownership);
     }
 
     const element = renderDescriptor(context, type.element, deriveElementTransfer(transfer), indexOptions);
@@ -387,7 +390,7 @@ const primitiveExpression = (category: PrimitiveCategory, ownership: Ownership):
     }
 
     if (category === "pointer") {
-        return tUint64;
+        return tBiguint64;
     }
 
     if (category === "gtype") {
@@ -703,7 +706,7 @@ const cursorArrayExpression = (
     context: ModuleContext,
     ref: CArrayType,
     transfer: ParameterTransfer,
-    options: CursorArgIndexOptions,
+    options: CursorArgIndexOptions & { layout: ArrayLayout },
 ): string =>
     tCursorArray(
         elementExpression(context, ref, transfer, options),
@@ -712,9 +715,15 @@ const cursorArrayExpression = (
             lengthIndex: mapArgIndex(options, options.cursor.lengthIndex),
         },
         transferOwnership(transfer),
-        inlineElementSize(context, ref, options.hasOutIndirection),
+        options.layout,
     );
 
+const arrayLayout = (context: ModuleContext, ref: CArrayType, options: ArgIndexOptions): ArrayLayout => ({
+    elementSize: inlineElementSize(context, ref, options.hasOutIndirection),
+    isBytes:
+        context.library.isByteArrayTyped && !hasUnknownArrayLength(ref) && isByteSequence(context.library, ref),
+});
+
 const arrayExpression = (
     context: ModuleContext,
     ref: CArrayType,
@@ -722,9 +731,10 @@ const arrayExpression = (
     options: ArgIndexOptions,
 ): string => {
     const { cursor } = options;
+    const layout = arrayLayout(context, ref, options);
 
     if (cursor !== undefined) {
-        return cursorArrayExpression(context, ref, transfer, { ...options, cursor });
+        return cursorArrayExpression(context, ref, transfer, { ...options, cursor, layout });
     }
 
     if (hasUnknownArrayLength(ref)) {
@@ -733,17 +743,16 @@ const arrayExpression = (
 
     const ownership = transferOwnership(transfer);
     const element = elementExpression(context, ref, transfer, options);
-    const size = inlineElementSize(context, ref, options.hasOutIndirection);
 
     if (ref.lengthParameterIndex !== undefined) {
-        return tSizedArray(element, mapArgIndex(options, ref.lengthParameterIndex), ownership, size);
+        return tSizedArray(element, mapArgIndex(options, ref.lengthParameterIndex), ownership, layout);
     }
 
     if (ref.fixedSize !== undefined) {
-        return tFixedArray(element, ref.fixedSize, ownership, size);
+        return tFixedArray(element, ref.fixedSize, ownership, layout);
     }
 
-    return tArray(element, ownership, size);
+    return tArray(element, ownership, layout);
 };
 
 const elementPointerDepth = (elementCType: string | undefined, hasOutIndirection: boolean): number => {

package/src/analysis/descriptor.ts

@@ -87,6 +87,11 @@ type FundamentalOptions = {
 
 type ListDescriptorName = "list" | "slist" | "ptrArray" | "gArray";
 
+type ArrayLayout = {
+    elementSize?: number | undefined;
+    isBytes: boolean;
+};
+
 type BindArgs = {
     libExpr: string;
     symbolExpr: string;
@@ -156,6 +161,7 @@ const tUint8: string = T.uint8;
 const tUint32: string = T.uint32;
 const tInt32: string = T.int32;
 const tUint64: string = T.uint64;
+const tBiguint64: string = T.biguint64;
 const tGtype: string = T.gtype;
 const tBuffer: string = T.buffer;
 
@@ -229,44 +235,69 @@ const tFlags = (lib: string, typeFnName: string, isSigned: boolean): string =>
 
 const tByteArray = (ownership: Ownership): string => call("byteArray", [sourceStringLiteral(ownership)]);
 
+const tNumericByteArray = (ownership: Ownership): string =>
+    call("array", [
+        tUint8,
+        sourceStringLiteral("gbytearray"),
+        sourceStringLiteral(ownership),
+    ]);
+
 const tList = (name: ListDescriptorName, element: string, ownership: Ownership): string =>
     call(name, [element, sourceStringLiteral(ownership)]);
 
-const tArray = (element: string, ownership?: Ownership, elementSize?: number): string =>
+const arrayLayoutArg = (ownership: Ownership | undefined, layout: ArrayLayout): string | undefined => {
+    if (ownership === undefined) {
+        return undefined;
+    }
+
+    const entries = [
+        layout.elementSize === undefined ? undefined : `elementSize: ${String(layout.elementSize)}`,
+        layout.isBytes ? "isBytes: true" : undefined,
+    ].filter((entry): entry is string => entry !== undefined);
+
+    return entries.length === 0 ? undefined : `{ ${entries.join(", ")} }`;
+};
+
+const tArray = (element: string, ownership: Ownership | undefined, layout: ArrayLayout): string =>
     call("array", [
         element,
         ownership === undefined ? undefined : sourceStringLiteral("array"),
         ownership === undefined ? undefined : sourceStringLiteral(ownership),
-        elementSize === undefined ? undefined : `{ elementSize: ${String(elementSize)} }`,
+        arrayLayoutArg(ownership, layout),
     ]);
 
 const tSizedArray = (
     element: string,
     lengthIndex: number,
-    ownership?: Ownership,
-    elementSize?: number,
+    ownership: Ownership | undefined,
+    layout: ArrayLayout,
 ): string =>
     call("sizedArray", [
         element,
         String(lengthIndex),
         ownership === undefined ? undefined : sourceStringLiteral(ownership),
-        elementSize === undefined ? undefined : String(elementSize),
+        arrayLayoutArg(ownership, layout),
     ]);
 
-const tCursorArray = (element: string, bounds: GirCursorBounds, ownership?: Ownership, elementSize?: number): string =>
+const tCursorArray = (
+    element: string,
+    bounds: GirCursorBounds,
+    ownership: Ownership | undefined,
+    layout: ArrayLayout,
+): string =>
     call("cursorArray", [
         element,
         `{ baseParamIndex: ${String(bounds.baseIndex)}, sizeParamIndex: ${String(bounds.lengthIndex)} }`,
         ownership === undefined ? undefined : sourceStringLiteral(ownership),
-        elementSize === undefined ? undefined : String(elementSize),
+        arrayLayoutArg(ownership, layout),
     ]);
 
-const tFixedArray = (element: string, length: number, ownership?: Ownership, elementSize?: number): string =>
+const tFixedArray = (element: string, length: number, ownership: Ownership | undefined, layout: ArrayLayout): string =>
     call("fixedArray", [
         element,
         String(length),
         ownership === undefined ? undefined : sourceStringLiteral(ownership),
-        elementSize === undefined ? undefined : String(elementSize),
+        arrayLayoutArg(ownership, layout),
     ]);
 
 const tCallback = (spec: CallbackSpecParts): string => {
@@ -296,6 +327,7 @@ export {
     tUint32,
     tInt32,
     tUint64,
+    tBiguint64,
     tGtype,
     tBuffer,
     tScalar,
@@ -310,6 +342,7 @@ export {
     tEnum,
     tFlags,
     tByteArray,
+    tNumericByteArray,
     tList,
     tArray,
     tSizedArray,
@@ -318,6 +351,7 @@ export {
     tCallback,
     tBind,
     tFn,
+    type ArrayLayout,
     type Ownership,
     type ScalarDescriptorName,
     type ListDescriptorName,

package/src/analysis/interface-conflicts.ts

@@ -217,21 +217,19 @@ const prerequisiteConflicts = (library: Library, iface: GirClass, base: Resolved
     return names;
 };
 
-const omittedTypeRef = (typeRef: string, omissions: string[]): string => {
-    if (omissions.length === 0) {
-        return typeRef;
-    }
-
-    const keys = [...new Set(omissions)].map((name) => JSON.stringify(name)).join(" | ");
+const omittedKeys = (omissions: string[]): string =>
+    [...new Set(omissions)].map((name) => JSON.stringify(name)).join(" | ");
 
-    return `Omit<${typeRef}, ${keys}>`;
-};
+const omittedTypeRef = (typeRef: string, omissions: string[]): string =>
+    omissions.length === 0 ? typeRef : `Omit<${typeRef}, ${omittedKeys(omissions)}>`;
 
 export {
+    areCallablesAssignable,
     type ClaimedMembers,
     claimInterfaceMembers,
     inheritedMembers,
     interfaceConflicts,
+    omittedKeys,
     omittedTypeRef,
     prerequisiteConflicts,
 };

package/src/analysis/ts-type.ts

@@ -12,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;
@@ -21,11 +22,15 @@ type ReferenceName = {
 type TsTypeTarget = {
     containerStyle: "map" | "record";
     callbackType: string;
-    shouldRenderByteArrayAsNumber: boolean;
+    byteArrayType: string;
     renderNamed: (resolved: GirType | undefined, name: ReferenceName) => string;
     renderGtype: () => string;
 };
 
+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 => {
@@ -97,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)}[]`;
 };
 
@@ -120,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,
@@ -142,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
@@ -158,4 +177,4 @@ const recordTypeTarget = (
     return target;
 };
 
-export { renderBaseType, renderTsType, recordTypeTarget, type TsTypeTarget };
+export { renderBaseType, renderParameterTsType, renderTsType, recordTypeTarget, type TsTypeTarget };

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 };