@gi.ts/parser 4.0.0-beta.25 → 4.0.0-beta.27

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./gir-types.ts";
+export * as parser from "./parser.ts";

package/src/parser.ts

@@ -0,0 +1,118 @@
+import { XMLParser } from "fast-xml-parser";
+import type { GirXML } from "./gir-types.ts";
+
+//  TODO: Treat properties that contain only one element like `repository`, 'namespace', 'package', ...  as an object instead of an array
+const isArrayProperty = [
+	"type",
+	"include",
+	"c:include",
+	"member",
+	"parameter",
+	"parameters",
+	"return-value",
+	"class",
+	"constructor",
+	"constructors",
+	"method",
+	"virtual-method",
+	"property",
+	"field",
+	"constant",
+	"enumeration",
+	"bitfield",
+	"alias",
+	"function",
+	"callback",
+	"record",
+	"union",
+	"interface",
+	"namespace",
+	"repository",
+	"package",
+	"glib:boxed",
+	"implements",
+	"prerequisite",
+	"doc",
+	"doc-deprecated",
+	"signal",
+	"glib:signal",
+	"annotation",
+	"stability",
+	"doc-version",
+	"doc-stability",
+	"source-position",
+	"column",
+	"array",
+	"moved-to",
+	"varargs",
+	"instance-parameter",
+];
+
+/**
+ * Attributes that should be converted from strings to numbers during parsing.
+ * This maintains type safety while handling XML's string-only attribute values.
+ */
+const numericAttributes = ["fixed-size", "length", "closure", "destroy", "bits"] as const;
+
+const parser = new XMLParser({
+	attributeNamePrefix: "",
+	attributesGroupName: "$", // default is 'false',
+	textNodeName: "_",
+	ignoreAttributes: false,
+	removeNSPrefix: false,
+	allowBooleanAttributes: true,
+	parseTagValue: true,
+	parseAttributeValue: false,
+	trimValues: true,
+	isArray: (name, _jpath, isLeafNode, _isAttribute) => {
+		// Restore previous behaviour...
+		if (isArrayProperty.includes(name)) {
+			return true;
+		}
+		return !isLeafNode;
+	},
+});
+
+/**
+ * Recursively transforms numeric string attributes to actual numbers.
+ * This ensures type safety while maintaining clean separation of concerns:
+ * the parser handles data transformation, not the consuming lib.
+ */
+function transformNumericAttributes(obj: unknown): unknown {
+	if (obj === null || typeof obj !== "object") {
+		return obj;
+	}
+
+	if (Array.isArray(obj)) {
+		return obj.map(transformNumericAttributes);
+	}
+
+	const result = { ...obj } as Record<string, unknown>;
+
+	// Transform attributes in the $ object (XML attributes)
+	if (result.$ && typeof result.$ === "object") {
+		const attrs = result.$ as Record<string, unknown>;
+		for (const attr of numericAttributes) {
+			if (attr in attrs && typeof attrs[attr] === "string") {
+				const numValue = Number.parseInt(attrs[attr] as string, 10);
+				if (!Number.isNaN(numValue)) {
+					attrs[attr] = numValue;
+				}
+			}
+		}
+	}
+
+	// Recursively transform nested objects
+	for (const key in result) {
+		if (key !== "$" && result[key] !== null && typeof result[key] === "object") {
+			result[key] = transformNumericAttributes(result[key]);
+		}
+	}
+
+	return result;
+}
+
+export function parseGir(contents: string): GirXML {
+	const parsed = parser.parse(contents);
+	return transformNumericAttributes(parsed) as GirXML;
+}

package/dist/lib.d.ts

@@ -1,2 +0,0 @@
-export * as parser from "./parser.js";
-export * from "./xml.js";

package/dist/lib.js

@@ -1,2 +0,0 @@
-export * as parser from "./parser.js";
-export * from "./xml.js";

package/dist/parser.d.ts

@@ -1,2 +0,0 @@
-import { GirXML } from "./xml.js";
-export declare function parseGir(contents: string): GirXML;

package/dist/parser.js

@@ -1,66 +0,0 @@
-import { XMLParser } from "fast-xml-parser";
-const isArrayProperty = [
-    "type",
-    "include",
-    "c:include",
-    "member",
-    "parameter",
-    "parameters",
-    "return-value",
-    "class",
-    "constructor",
-    "constructors",
-    "method",
-    "virtual-method",
-    "property",
-    "field",
-    "constant",
-    "enumeration",
-    "bitfield",
-    "alias",
-    "function",
-    "callback",
-    "record",
-    "union",
-    "interface",
-    "namespace",
-    "repository",
-    "package",
-    "glib:boxed",
-    "implements",
-    "prerequisite",
-    "doc",
-    "doc-deprecated",
-    "signal",
-    "glib:signal",
-    "annotation",
-    "stability",
-    "doc-version",
-    "doc-stability",
-    "source-position",
-    "column",
-    "array",
-    "moved-to",
-    "varargs",
-    "instance-parameter",
-];
-const parser = new XMLParser({
-    attributeNamePrefix: "",
-    attributesGroupName: "$",
-    textNodeName: "_",
-    ignoreAttributes: false,
-    removeNSPrefix: false,
-    allowBooleanAttributes: true,
-    parseTagValue: true,
-    parseAttributeValue: false,
-    trimValues: true,
-    isArray: (name, _jpath, isLeafNode, _isAttribute) => {
-        if (isArrayProperty.includes(name)) {
-            return true;
-        }
-        return !isLeafNode;
-    },
-});
-export function parseGir(contents) {
-    return parser.parse(contents);
-}

package/dist/xml.d.ts

@@ -1,442 +0,0 @@
-export declare enum GirDirection {
-    In = "in",
-    Inout = "inout",
-    Out = "out",
-    InOut = "in-out"
-}
-export interface GirXML {
-    repository: GirRepository[];
-}
-export type GirUnparsedNumber = string;
-export type GirBoolean = "0" | "1";
-export interface GirRepository {
-    $: {
-        version?: string;
-        "c:identifier-prefixes"?: string;
-        "c:symbol-prefixes"?: string;
-    };
-    include?: GirInclude[];
-    "c:include": GirCInclude[];
-    package: GirPackage[];
-    namespace?: GirNamespace[];
-}
-export interface GirNamespace {
-    $: GirInfoAttrs & {
-        name: string;
-        version: string;
-        "c:identifier-prefixes"?: string;
-        "c:symbol-prefixes"?: string;
-        "c:prefix"?: string;
-        "shared-library"?: string;
-    };
-    alias?: GirAliasElement[];
-    class?: GirClassElement[];
-    interface?: GirInterfaceElement[];
-    record?: GirRecordElement[];
-    enumeration?: GirEnumElement[];
-    function?: GirFunctionElement[];
-    union?: GirUnionElement[];
-    bitfield?: GirBitfieldElement[];
-    callback?: GirCallbackElement[];
-    constant?: GirConstantElement[];
-    annotation?: GirAnnotation[];
-    ["glib:boxed"]?: GirBoxedElement[];
-}
-export interface GirAnnotation {
-    $: {
-        name: string;
-        value: string[];
-    };
-}
-export interface GirCInclude {
-    $: {
-        name: string;
-    };
-}
-export interface GirInclude {
-    $: {
-        name: string;
-        version?: string;
-    };
-}
-export interface GirPackage {
-    $: {
-        name: string;
-    };
-}
-export interface GirAliasElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "c:type"?: string;
-    };
-    type?: GirType[];
-}
-export interface GirInterfaceElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "glib:type-name": string;
-        "glib:get-type": string;
-        "c:symbol-prefix"?: string;
-        "c:type"?: string;
-        "glib:type-struct"?: string;
-    };
-    prerequisite?: GirPrerequisite[];
-    implements?: GirImplements[];
-    function?: GirFunctionElement[];
-    constructors?: GirConstructorElement[];
-    method?: GirMethodElement[];
-    "virtual-method"?: GirVirtualMethodElement[];
-    field?: GirFieldElement[];
-    property?: GirPropertyElement[];
-    signal?: GirSignalElement[];
-    "glib:signal"?: GirSignalElement[];
-    callback?: GirCallbackElement[];
-    constant?: GirConstantElement[];
-}
-export interface GirClassElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "glib:type-name": string;
-        "glib:get-type": string;
-        parent?: string;
-        "glib:type-struct"?: string;
-        "glib:ref-func"?: string;
-        "glib:unref-func"?: string;
-        "glib:set-value-func"?: string;
-        "glib:get-value-func"?: string;
-        "c:type"?: string;
-        "c:symbol-prefix"?: string;
-        abstract?: GirBoolean;
-        "glib:fundamental"?: GirBoolean;
-        final: GirBoolean;
-    };
-    implements?: GirImplements[];
-    constructor?: GirConstructorElement[];
-    method?: GirMethodElement[];
-    function?: GirFunctionElement[];
-    "virtual-method"?: GirVirtualMethodElement[];
-    field?: GirFieldElement[];
-    property?: GirPropertyElement[];
-    signal?: GirSignalElement[];
-    "glib:signal"?: GirSignalElement[];
-    union?: GirUnionElement[];
-    constant?: GirConstantElement[];
-    record?: GirRecordElement[];
-    callback?: GirCallbackElement[];
-}
-export interface GirBoxedElement {
-    $: GirInfoAttrs & {
-        "glib:name": string;
-        "c:symbol-prefix"?: string;
-        "glib:type-name"?: string;
-        "glib:get-type"?: string;
-    };
-    function?: GirFunctionElement[];
-}
-export interface GirRecordElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "c:type"?: string;
-        disguised?: GirBoolean;
-        opaque?: GirBoolean;
-        pointer?: GirBoolean;
-        "glib:type-name"?: string;
-        "glib:get-type"?: string;
-        "c:symbol-prefix"?: string;
-        foreign?: GirBoolean;
-        "glib:is-gtype-struct-for"?: string;
-    };
-    field?: GirFieldElement[];
-    function?: GirFunctionElement[];
-    union?: GirUnionElement[];
-    method?: GirMethodElement[];
-    constructor?: GirConstructorElement[];
-    property?: GirPropertyElement[];
-}
-export interface GirInfoAttrs {
-    introspectable?: GirBoolean;
-    deprecated?: string;
-    "deprecated-version"?: string;
-    version?: string;
-    stability?: string[];
-}
-export interface GirDocElement {
-    "doc-version"?: [
-        {
-            $: {
-                "xml:space"?: "preserve";
-                "xml:whitespace"?: "preserve";
-            };
-            _: string;
-        }
-    ];
-    "doc-stability"?: [
-        {
-            $: {
-                "xml:space"?: "preserve";
-                "xml:whitespace"?: "preserve";
-            };
-            _: string;
-        }
-    ];
-    doc: [
-        {
-            $: {
-                "xml:space"?: "preserve";
-                "xml:whitespace"?: "preserve";
-                filename: string;
-                line: string;
-                column: string;
-            };
-            _: string;
-        }
-    ];
-    "doc-deprecated": [
-        {
-            $: {
-                "xml:space"?: "preserve";
-                "xml:whitespace"?: "preserve";
-            };
-            _: string;
-        }
-    ];
-    "source-position": [
-        {
-            filename: string;
-            line: string;
-            column: string[];
-        }
-    ];
-}
-export interface GirInfoElements extends GirDocElement {
-    annotation: GirAnnotation[];
-}
-export interface GirConstantElement extends GirInfoElements, GirAnyType {
-    $: GirInfoAttrs & {
-        name: string;
-        value: string;
-        "c:type"?: string;
-        "c:identifier"?: string;
-    };
-}
-export interface GirPropertyElement extends GirInfoElements, GirAnyType {
-    $: GirInfoAttrs & {
-        name: string;
-        writable?: GirBoolean;
-        readable?: GirBoolean;
-        construct?: GirBoolean;
-        "construct-only"?: GirBoolean;
-        setter?: string;
-        getter?: string;
-        "default-value"?: string;
-    } & Partial<GirTransferOwnership>;
-}
-export interface GirSignalElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        detailed?: GirBoolean;
-        when?: "first" | "last" | "cleanup";
-        action?: GirBoolean;
-        "no-hooks"?: GirBoolean;
-        "no-recurse"?: GirBoolean;
-    };
-    parameters?: [GirCallableParams];
-    "return-value"?: GirCallableReturn[];
-}
-export interface GirFieldElement extends GirInfoElements, GirAnyType {
-    $: GirInfoAttrs & {
-        name: string;
-        writable?: GirBoolean;
-        readable?: GirBoolean;
-        private?: GirBoolean;
-        bits?: GirUnparsedNumber;
-    };
-    callback?: GirCallbackElement[];
-}
-export interface GirCallbackElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "c:type"?: string;
-        throws?: GirBoolean;
-        "glib:type-name"?: string;
-    };
-    parameters?: [GirCallableParams];
-    "return-value"?: GirCallableReturn[];
-}
-export interface GirImplements {
-    $: GirInfoAttrs & {
-        name: string;
-    };
-}
-export interface GirPrerequisite {
-    $: {
-        name?: string;
-    };
-}
-export interface GirAnyType {
-    type?: GirType[];
-    array?: GirArrayType[];
-}
-export interface GirType extends GirDocElement {
-    $: GirInfoAttrs & {
-        name?: string;
-        "c:type"?: string;
-        introspectable?: GirBoolean;
-    };
-    array?: GirArrayType[];
-    type: GirType[];
-}
-export interface GirArrayType {
-    $: GirInfoAttrs & {
-        name?: string;
-        "zero-terminated"?: GirBoolean;
-        "fixed-size"?: GirUnparsedNumber;
-        introspectable?: GirBoolean;
-        length?: GirUnparsedNumber;
-        "c:type"?: string;
-    };
-    array?: GirArrayType[];
-    type?: GirType[];
-}
-export declare enum GirTransferOwnershipType {
-    Container = "container",
-    Full = "full",
-    None = "none"
-}
-export interface GirTransferOwnership {
-    "transfer-ownership": GirTransferOwnershipType;
-}
-export interface GirConstructorElement {
-    $: GirInfoAttrs & GirCallableAttrs;
-    parameters?: [GirCallableParams];
-    "return-value"?: GirCallableReturn[];
-}
-export interface GirCallableAttrs {
-    name: string;
-    "c:identifier"?: string;
-    "shadowed-by"?: string;
-    shadows?: string;
-    throws?: GirBoolean;
-    "moved-to"?: string[];
-}
-export interface GirVarArgs {
-    $: GirInfoAttrs;
-}
-export interface GirCallableParamElement extends GirDocElement, GirAnyType {
-    $: GirInfoAttrs & Partial<GirTransferOwnership> & {
-        name?: string;
-        nullable?: GirBoolean;
-        "null-ok"?: GirBoolean;
-        "allow-none"?: GirBoolean;
-        introspectable?: GirBoolean;
-        closure?: GirUnparsedNumber;
-        destroy?: GirUnparsedNumber;
-        scope?: "notified" | "async" | "call";
-        direction?: GirDirection;
-        "caller-allocates"?: GirBoolean;
-        optional?: GirBoolean;
-        skip?: GirBoolean;
-    };
-    varargs?: GirVarArgs[];
-}
-export interface GirCallableParams {
-    parameter: GirCallableParamElement[];
-    "instance-parameter"?: GirInstanceParameter[];
-}
-export interface GirInstanceParameter extends GirAnyType {
-    $: Partial<{
-        name: string;
-        nullable?: GirBoolean;
-        "allow-none"?: GirBoolean;
-        "null-ok"?: GirBoolean;
-        direction?: GirDirection;
-        "caller-allocates"?: GirBoolean;
-    }> & Partial<GirTransferOwnership>;
-    type?: GirType[];
-}
-export interface GirCallableReturn extends GirAnyType, GirDocElement {
-    $: {
-        name?: string;
-        introspectable?: GirBoolean;
-        nullable?: GirBoolean;
-        closure?: GirUnparsedNumber;
-        scope?: "notified" | "async" | "call";
-        destroy?: GirUnparsedNumber;
-        skip?: GirBoolean;
-        "allow-none"?: GirBoolean;
-    } & Partial<GirTransferOwnership>;
-}
-export interface GirFunctionElement extends GirDocElement {
-    $: GirInfoAttrs & GirCallableAttrs;
-    parameters?: [GirCallableParams];
-    "return-value"?: GirCallableReturn[];
-}
-export interface GirMethodElement extends GirDocElement {
-    $: GirInfoAttrs & GirCallableAttrs & {
-        "glib:set-property": string;
-        "glib:get-property": string;
-    };
-    parameters?: [GirCallableParams];
-    "return-value"?: GirCallableReturn[];
-}
-export interface GirVirtualMethodElement extends GirDocElement {
-    $: GirInfoAttrs & GirCallableAttrs & {
-        invoker?: string;
-    };
-    parameters?: [GirCallableParams];
-    "return-value"?: GirCallableReturn[];
-}
-export interface GirUnionElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name?: string;
-        "c:type"?: string;
-        "c:symbol-prefix"?: string;
-        "glib:type-name"?: string;
-        "glib:get-type"?: string;
-    };
-    field?: GirFieldElement[];
-    constructor?: GirConstructorElement[];
-    method?: GirMethodElement[];
-    function?: GirFunctionElement[];
-    record?: GirRecordElement[];
-}
-export interface GirBitfieldElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "c:type": string;
-        "glib:type-name"?: string;
-        "glib:get-type"?: string;
-    };
-    member: GirMemberElement[];
-    function: GirFunctionElement[];
-}
-export interface GirEnumElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        "c:type": string;
-        "glib:type-name"?: string;
-        "glib:get-type"?: string;
-        "glib:error-domain"?: string;
-    };
-    member?: GirMemberElement[];
-    function?: GirFunctionElement[];
-}
-export interface GirFieldElement extends GirInfoElements, GirAnyType {
-    $: GirInfoAttrs & {
-        name: string;
-        writable?: GirBoolean;
-        readable?: GirBoolean;
-        private?: GirBoolean;
-        bits?: GirUnparsedNumber;
-    };
-    callback?: GirCallbackElement[];
-}
-export interface GirMemberElement extends GirInfoElements {
-    $: GirInfoAttrs & {
-        name: string;
-        value: string;
-        "c:identifier": string;
-        "glib:nick"?: string;
-        "glib:name"?: string;
-    };
-}

package/dist/xml.js

@@ -1,13 +0,0 @@
-export var GirDirection;
-(function (GirDirection) {
-    GirDirection["In"] = "in";
-    GirDirection["Inout"] = "inout";
-    GirDirection["Out"] = "out";
-    GirDirection["InOut"] = "in-out";
-})(GirDirection || (GirDirection = {}));
-export var GirTransferOwnershipType;
-(function (GirTransferOwnershipType) {
-    GirTransferOwnershipType["Container"] = "container";
-    GirTransferOwnershipType["Full"] = "full";
-    GirTransferOwnershipType["None"] = "none";
-})(GirTransferOwnershipType || (GirTransferOwnershipType = {}));