@unireq/xml 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Olivier Orabona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { Policy, BodyDescriptor } from '@unireq/core';
+
+/**
+ * @unireq/xml - XML parser policy using fast-xml-parser
+ */
+
+/** XML parser options (fast-xml-parser X2jOptions) */
+interface XMLParserOptions {
+    readonly ignoreAttributes?: boolean;
+    readonly attributeNamePrefix?: string;
+    readonly textNodeName?: string;
+    readonly [key: string]: unknown;
+}
+/** XML builder options (fast-xml-parser XmlBuilderOptions) */
+interface XMLBuilderOptions {
+    readonly ignoreAttributes?: boolean;
+    readonly attributeNamePrefix?: string;
+    readonly textNodeName?: string;
+    readonly format?: boolean;
+    readonly indentBy?: string;
+    readonly [key: string]: unknown;
+}
+/**
+ * Creates an XML parser policy
+ * @param options - fast-xml-parser options
+ * @returns Policy that parses XML responses
+ *
+ * @example
+ * ```ts
+ * const xmlPolicy = xml({
+ *   ignoreAttributes: false,
+ *   attributeNamePrefix: '@_'
+ * });
+ * ```
+ */
+declare function xml(options?: XMLParserOptions): Policy;
+/**
+ * Create an XML body descriptor
+ * Serializes an object to XML string using fast-xml-parser
+ *
+ * @param data - Data to serialize as XML
+ * @param options - fast-xml-parser builder options
+ * @returns BodyDescriptor for XML content
+ *
+ * @example
+ * ```ts
+ * import { xmlBody } from '@unireq/xml';
+ * import { client } from '@unireq/core';
+ * import { http } from '@unireq/http';
+ *
+ * const api = client(http('https://api.example.com'));
+ * const response = await api.post('/users', xmlBody({ user: { name: 'John', email: 'john@example.com' } }));
+ * ```
+ */
+declare function xmlBody<T>(data: T, options?: XMLBuilderOptions): BodyDescriptor;
+
+export { type XMLBuilderOptions, type XMLParserOptions, xml, xmlBody };

package/dist/index.js

@@ -0,0 +1,2 @@
+import {XMLParser,XMLBuilder}from'fast-xml-parser';function p(r={}){return async(t,o)=>{let e=await o(t);if(!(e.headers["content-type"]||e.headers["Content-Type"]||"").includes("xml"))return e;let n;if(typeof e.data=="string")n=e.data;else if(e.data instanceof ArrayBuffer)n=new TextDecoder().decode(e.data);else return e;let i=new XMLParser(r).parse(n);return {...e,data:i}}}function c(r,t={}){return {__brand:"BodyDescriptor",data:r,contentType:"application/xml",serialize:()=>new XMLBuilder(t).build(r)}}export{p as xml,c as xmlBody};//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["xml","options","ctx","next","response","xmlText","parsed","XMLParser","xmlBody","data","XMLBuilder"],"mappings":"mDAsCO,SAASA,CAAAA,CAAIC,CAAAA,CAA4B,EAAC,CAAW,CAC1D,OAAO,MAAOC,CAAAA,CAAKC,IAAS,CAC1B,IAAMC,EAAW,MAAMD,CAAAA,CAAKD,CAAG,CAAA,CAK/B,GAAI,CAAA,CAFgBE,EAAS,OAAA,CAAQ,cAAc,GAAKA,CAAAA,CAAS,OAAA,CAAQ,cAAc,CAAA,EAAK,EAAA,EAE3E,QAAA,CAAS,KAAK,CAAA,CAC7B,OAAOA,EAIT,IAAIC,CAAAA,CACJ,GAAI,OAAOD,CAAAA,CAAS,IAAA,EAAS,SAC3BC,CAAAA,CAAUD,CAAAA,CAAS,IAAA,CAAA,KAAA,GACVA,CAAAA,CAAS,IAAA,YAAgB,WAAA,CAClCC,EAAU,IAAI,WAAA,GAAc,MAAA,CAAOD,CAAAA,CAAS,IAAI,CAAA,CAAA,KAEhD,OAAOA,CAAAA,CAKT,IAAME,CAAAA,CADS,IAAIC,UAAUN,CAAO,CAAA,CACd,KAAA,CAAMI,CAAO,CAAA,CAEnC,OAAO,CACL,GAAGD,CAAAA,CACH,IAAA,CAAME,CACR,CACF,CACF,CAoBO,SAASE,CAAAA,CAAWC,EAASR,CAAAA,CAA6B,GAAoB,CACnF,OAAO,CACL,OAAA,CAAS,gBAAA,CACT,IAAA,CAAAQ,EACA,WAAA,CAAa,iBAAA,CACb,SAAA,CAAW,IACO,IAAIC,UAAAA,CAAWT,CAAO,CAAA,CACvB,KAAA,CAAMQ,CAAI,CAE7B,CACF","file":"index.js","sourcesContent":["/**\n * @unireq/xml - XML parser policy using fast-xml-parser\n */\n\nimport type { BodyDescriptor, Policy } from '@unireq/core';\nimport { XMLBuilder, XMLParser } from 'fast-xml-parser';\n\n/** XML parser options (fast-xml-parser X2jOptions) */\nexport interface XMLParserOptions {\n  readonly ignoreAttributes?: boolean;\n  readonly attributeNamePrefix?: string;\n  readonly textNodeName?: string;\n  readonly [key: string]: unknown;\n}\n\n/** XML builder options (fast-xml-parser XmlBuilderOptions) */\nexport interface XMLBuilderOptions {\n  readonly ignoreAttributes?: boolean;\n  readonly attributeNamePrefix?: string;\n  readonly textNodeName?: string;\n  readonly format?: boolean;\n  readonly indentBy?: string;\n  readonly [key: string]: unknown;\n}\n\n/**\n * Creates an XML parser policy\n * @param options - fast-xml-parser options\n * @returns Policy that parses XML responses\n *\n * @example\n * ```ts\n * const xmlPolicy = xml({\n *   ignoreAttributes: false,\n *   attributeNamePrefix: '@_'\n * });\n * ```\n */\nexport function xml(options: XMLParserOptions = {}): Policy {\n  return async (ctx, next) => {\n    const response = await next(ctx);\n\n    // Only parse if content-type is XML\n    const contentType = response.headers['content-type'] || response.headers['Content-Type'] || '';\n\n    if (!contentType.includes('xml')) {\n      return response;\n    }\n\n    // Get XML text\n    let xmlText: string;\n    if (typeof response.data === 'string') {\n      xmlText = response.data;\n    } else if (response.data instanceof ArrayBuffer) {\n      xmlText = new TextDecoder().decode(response.data);\n    } else {\n      return response;\n    }\n\n    // Parse XML\n    const parser = new XMLParser(options);\n    const parsed = parser.parse(xmlText);\n\n    return {\n      ...response,\n      data: parsed,\n    };\n  };\n}\n\n/**\n * Create an XML body descriptor\n * Serializes an object to XML string using fast-xml-parser\n *\n * @param data - Data to serialize as XML\n * @param options - fast-xml-parser builder options\n * @returns BodyDescriptor for XML content\n *\n * @example\n * ```ts\n * import { xmlBody } from '@unireq/xml';\n * import { client } from '@unireq/core';\n * import { http } from '@unireq/http';\n *\n * const api = client(http('https://api.example.com'));\n * const response = await api.post('/users', xmlBody({ user: { name: 'John', email: 'john@example.com' } }));\n * ```\n */\nexport function xmlBody<T>(data: T, options: XMLBuilderOptions = {}): BodyDescriptor {\n  return {\n    __brand: 'BodyDescriptor',\n    data,\n    contentType: 'application/xml',\n    serialize: () => {\n      const builder = new XMLBuilder(options);\n      return builder.build(data);\n    },\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@unireq/xml",
+  "version": "0.0.1",
+  "description": "XML parser policy for unireq",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Olivier Orabona",
+  "license": "MIT",
+  "dependencies": {
+    "@unireq/core": "0.0.1"
+  },
+  "peerDependencies": {
+    "fast-xml-parser": "^4.5.0"
+  },
+  "peerDependenciesMeta": {
+    "fast-xml-parser": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "tsup": "^8.5.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oorabona/unireq",
+    "directory": "packages/xml"
+  },
+  "bugs": {
+    "url": "https://github.com/oorabona/unireq/issues"
+  },
+  "homepage": "https://github.com/oorabona/unireq/tree/main/packages/xml",
+  "scripts": {
+    "build": "tsup",
+    "type-check": "tsc --noEmit",
+    "test": "vitest run",
+    "clean": "rm -rf dist *.tsbuildinfo"
+  }
+}