@techspokes/typescript-wsdl-client 0.6.2 → 0.7.0

package/dist/xsd/primitives.js

@@ -1,15 +1,39 @@
-// Centralized XSD → TypeScript primitive mapping with safe defaults.
-// Rationale:
-// - 64-bit integers (long/unsignedLong) can overflow JS number → default to string
-// - Arbitrary-precision decimal (money) may lose precision in JS number → default to string
-// - Dates/times stay as string by default (no runtime Date parsing in a generator)
+/**
+ * XSD to TypeScript Primitive Type Mapping
+ *
+ * This module defines how XML Schema (XSD) primitive types are mapped to TypeScript types.
+ * It provides a configurable mapping system with safe defaults that prioritizes
+ * data integrity over convenience:
+ *
+ * Key design decisions:
+ * - 64-bit integers (long/unsignedLong) default to string to prevent overflow in JavaScript number
+ * - Arbitrary-precision decimal types default to string to prevent loss of precision
+ * - Date/time types default to string (no automatic Date parsing/conversion)
+ * - Configurable options allow users to override defaults when appropriate for their use case
+ */
+/**
+ * Default primitive mapping options that prioritize data integrity over convenience
+ *
+ * These defaults ensure that no data is lost in the TypeScript representation, even
+ * for edge cases like very large integers or high-precision decimals.
+ */
 const DEFAULTS = {
     int64As: "string",
     bigIntegerAs: "string",
     decimalAs: "string",
     dateAs: "string",
 };
-// Helper to choose ts type for integer families depending on magnitude
+/**
+ * Determines the appropriate TypeScript type for XSD integer families
+ *
+ * This function categorizes integer types by their potential size range:
+ * - 64-bit or arbitrary-precision integers use the configured type (default: string)
+ * - 32-bit or smaller integers use the native number type
+ *
+ * @param {string} local - Local name of the XSD type (e.g., "int", "long", "integer")
+ * @param {Required<PrimitiveOptions>} opts - Primitive mapping options
+ * @returns {string} - Appropriate TypeScript type for the integer type
+ */
 function intFamily(local, opts) {
     // 64-bit or unbounded families → configurable
     const int64 = new Set(["long", "unsignedLong"]);
@@ -34,14 +58,28 @@ function intFamily(local, opts) {
         return "number";
     return "number";
 }
+/**
+ * Determines the appropriate TypeScript type for XSD decimal types
+ *
+ * @param {string} local - Local name of the XSD type (e.g., "decimal")
+ * @param {Required<PrimitiveOptions>} opts - Primitive mapping options
+ * @returns {string} - Appropriate TypeScript type for the decimal type
+ */
 function decimalFamily(local, opts) {
     // xs:decimal and derived decimals (if any) → configurable
     if (local === "decimal")
         return opts.decimalAs;
     return "number";
 }
+/**
+ * Determines the appropriate TypeScript type for XSD date/time types
+ *
+ * @param {string} local - Local name of the XSD type (e.g., "date", "dateTime")
+ * @param {Required<PrimitiveOptions>} opts - Primitive mapping options
+ * @returns {string} - Appropriate TypeScript type for the date/time type
+ */
 function dateFamily(local, opts) {
-    // You can choose "Date", but generator won’t parse at runtime; it’s just type-level.
+    // You can choose "Date", but generator won't parse at runtime; it's just type-level.
     const s = opts.dateAs;
     switch (local) {
         case "date":
@@ -61,6 +99,9 @@ function dateFamily(local, opts) {
             return "string";
     }
 }
+/**
+ * Set of XSD types that map to string in TypeScript
+ */
 const STRING_LIKE = new Set([
     "string",
     "normalizedString",
@@ -77,6 +118,17 @@ const STRING_LIKE = new Set([
     "hexBinary",
     "base64Binary", // could be "string" or a branded type
 ]);
+/**
+ * Maps an XSD QName to the corresponding TypeScript primitive type
+ *
+ * This function is the main entry point for determining the TypeScript type
+ * corresponding to an XSD primitive type. It uses the local part of the QName
+ * and the configured mapping options to return the correct TypeScript type.
+ *
+ * @param {string} xsdQName - The XSD QName to map (e.g., "xs:int")
+ * @param {PrimitiveOptions} [options] - Optional custom mapping options
+ * @returns {string} - The corresponding TypeScript primitive type
+ */
 export function xsdToTsPrimitive(xsdQName, options) {
     const opts = { ...DEFAULTS, ...(options || {}) };
     // Expect formats like "xs:int". Fall back to string if unknown.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techspokes/typescript-wsdl-client",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "TypeScript WSDL → SOAP client generator with full xs:attribute support, complex types, sequences, inheritance, and namespace-collision merging.",
   "keywords": [
     "wsdl",
@@ -47,6 +47,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
+    "clean:tmp": "rimraf tmp",
     "dev": "tsx src/cli.ts",
     "watch": "tsx watch src/cli.ts",
     "typecheck": "tsc --noEmit",
@@ -54,9 +55,11 @@
     "test": "exit 0",
     "smoke": "tsx src/cli.ts --help",
     "smoke:gen": "rimraf tmp && tsx src/cli.ts --wsdl examples/minimal/weather.wsdl --out tmp && tsc -p tsconfig.smoke.json",
-    "ci": "npm run build && npm run typecheck && npm run smoke && npm run smoke:gen"
+    "smoke:pipeline": "tsx src/cli.ts pipeline --wsdl examples/minimal/weather.wsdl --out tmp --clean --format both --tag-style service --openapi-out tmp/openapi",
+    "ci": "npm run build && npm run typecheck && npm run smoke && npm run smoke:gen && npm run smoke:pipeline"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^24.3.0",
     "@types/yargs": "^17.0.33",
     "rimraf": "^6.0.0",
@@ -64,7 +67,9 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
+    "@apidevtools/swagger-parser": "^10.0.3",
     "fast-xml-parser": "^5.2.5",
+    "js-yaml": "^4.1.0",
     "soap": "^1.3.0",
     "yargs": "^18.0.0"
   },