@typespec/openapi3 0.62.0-dev.1 → 0.62.0-dev.11

package/dist/src/xml-module.js

@@ -0,0 +1,160 @@
+import { isArrayModelType, resolveEncodedName, } from "@typespec/compiler";
+import { ArrayBuilder, ObjectBuilder } from "@typespec/compiler/emitter-framework";
+import { reportDiagnostic } from "./lib.js";
+import { getSchemaForStdScalars } from "./std-scalar-schemas.js";
+export async function resolveXmlModule() {
+    const xml = await tryImportXml();
+    if (xml === undefined)
+        return undefined;
+    return {
+        attachXmlObjectForScalarOrModel: (program, type, emitObject) => {
+            const isXmlModel = isXmlModelChecker(program, type, []);
+            if (!isXmlModel) {
+                return;
+            }
+            const xmlObject = {};
+            // Resolve XML name
+            const xmlName = resolveEncodedName(program, type, "application/xml");
+            if (xmlName !== type.name) {
+                xmlObject.name = xmlName;
+            }
+            // Get and set XML namespace if present
+            const currNs = xml.getNs(program, type);
+            if (currNs) {
+                xmlObject.prefix = currNs.prefix;
+                xmlObject.namespace = currNs.namespace;
+            }
+            // Attach xml schema to emitObject if not empty
+            if (Object.keys(xmlObject).length !== 0) {
+                emitObject.xml = xmlObject;
+            }
+        },
+        attachXmlObjectForModelProperty: (program, options, prop, emitObject, refSchema) => {
+            if (!isXmlModelChecker(program, prop.model, []))
+                return;
+            const xmlObject = {};
+            // Resolve XML name
+            const xmlName = resolveEncodedName(program, prop, "application/xml");
+            const jsonName = resolveEncodedName(program, prop, "application/json");
+            if (xmlName !== prop.name && xmlName !== jsonName) {
+                xmlObject.name = xmlName;
+            }
+            // Get and set XML namespace if present
+            const currNs = xml.getNs(program, prop);
+            if (currNs) {
+                xmlObject.prefix = currNs.prefix;
+                xmlObject.namespace = currNs.namespace;
+            }
+            // Set XML attribute if present
+            const isAttribute = xml.isAttribute(program, prop);
+            if (isAttribute) {
+                if (prop.type?.kind === "Model") {
+                    reportDiagnostic(program, {
+                        code: "xml-attribute-invalid-property-type",
+                        format: { name: prop.name },
+                        target: prop,
+                    });
+                    emitObject.type = "string";
+                    delete refSchema.items;
+                }
+                xmlObject.attribute = true;
+            }
+            // Handle array wrapping if necessary
+            const hasUnwrappedDecorator = xml.isUnwrapped(program, prop);
+            const isArrayProperty = prop.type?.kind === "Model" && isArrayModelType(program, prop.type);
+            if (!isArrayProperty && hasUnwrappedDecorator) {
+                reportDiagnostic(program, {
+                    code: "xml-unwrapped-invalid-property-type",
+                    format: { name: prop.name },
+                    target: prop,
+                });
+            }
+            if (isArrayProperty && refSchema.items && !isAttribute) {
+                const propValue = prop.type.indexer.value;
+                const propXmlName = hasUnwrappedDecorator
+                    ? xmlName
+                    : resolveEncodedName(program, propValue, "application/xml");
+                if (propValue.kind === "Scalar") {
+                    let scalarSchema = {};
+                    const isStd = program.checker.isStdType(propValue);
+                    if (isStd) {
+                        scalarSchema = getSchemaForStdScalars(propValue, options);
+                    }
+                    else if (propValue.baseScalar) {
+                        scalarSchema = getSchemaForStdScalars(propValue.baseScalar, options);
+                    }
+                    scalarSchema.xml = { name: propXmlName };
+                    refSchema.items = scalarSchema;
+                }
+                else {
+                    refSchema.items = new ObjectBuilder({
+                        allOf: new ArrayBuilder(refSchema.items),
+                        xml: { name: propXmlName },
+                    });
+                }
+                // handel unwrapped decorator
+                if (!hasUnwrappedDecorator) {
+                    xmlObject.wrapped = true;
+                }
+            }
+            if (!isArrayProperty && !refSchema.type && !isAttribute) {
+                emitObject.allOf = new ArrayBuilder(refSchema);
+                xmlObject.name = xmlName;
+            }
+            if (isArrayProperty && hasUnwrappedDecorator) {
+                // if wrapped is false, xml.name of the wrapping element is ignored.
+                delete xmlObject.name;
+            }
+            // Attach xml schema to emitObject if not empty
+            if (Object.keys(xmlObject).length !== 0) {
+                emitObject.xml = xmlObject;
+            }
+        },
+    };
+}
+function isXmlModelChecker(program, model, checked) {
+    if (model.decorators && model.decorators.some((d) => d.definition?.namespace.name === "Xml")) {
+        return true;
+    }
+    const xmlName = resolveEncodedName(program, model, "application/xml");
+    if (xmlName && xmlName !== model.name) {
+        return true;
+    }
+    if (model.kind === "ModelProperty") {
+        const propModel = model.type;
+        if (propModel && !checked.includes(propModel.name)) {
+            checked.push(propModel.name);
+            if (isXmlModelChecker(program, propModel, checked)) {
+                return true;
+            }
+        }
+    }
+    if (model.kind === "Model") {
+        for (const prop of model.properties.values()) {
+            if (isXmlModelChecker(program, prop, checked)) {
+                return true;
+            }
+            if (prop.type?.kind === "Model" && isArrayModelType(program, prop.type)) {
+                const propValue = prop.type.indexer.value;
+                const propModel = propValue;
+                if (propModel && !checked.includes(propModel.name)) {
+                    checked.push(propModel.name);
+                    if (isXmlModelChecker(program, propModel, checked)) {
+                        return true;
+                    }
+                }
+            }
+        }
+    }
+    return false;
+}
+async function tryImportXml() {
+    try {
+        const module = await import("@typespec/xml");
+        return module;
+    }
+    catch {
+        return undefined;
+    }
+}
+//# sourceMappingURL=xml-module.js.map

package/dist/src/xml-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml-module.js","sourceRoot":"","sources":["../../src/xml-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAmBjE,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,MAAM,GAAG,GAAG,MAAM,YAAY,EAAE,CAAC;IACjC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAExC,OAAO;QACL,+BAA+B,EAAE,CAC/B,OAAgB,EAChB,IAAoB,EACpB,UAA0B,EAC1B,EAAE;YACF,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACxD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAsB,EAAE,CAAC;YAExC,mBAAmB;YACnB,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACrE,IAAI,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC1B,SAAS,CAAC,IAAI,GAAG,OAAO,CAAC;YAC3B,CAAC;YAED,uCAAuC;YACvC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACxC,IAAI,MAAM,EAAE,CAAC;gBACX,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBACjC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;YACzC,CAAC;YAED,+CAA+C;YAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxC,UAAU,CAAC,GAAG,GAAG,SAAS,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,+BAA+B,EAAE,CAC/B,OAAgB,EAChB,OAAuC,EACvC,IAAmB,EACnB,UAA0B,EAC1B,SAAyB,EACzB,EAAE;YACF,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,KAAM,EAAE,EAAE,CAAC;gBAAE,OAAO;YAEzD,MAAM,SAAS,GAAsB,EAAE,CAAC;YAExC,mBAAmB;YACnB,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACrE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;YACvE,IAAI,OAAO,KAAK,IAAI,CAAC,IAAI,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAClD,SAAS,CAAC,IAAI,GAAG,OAAO,CAAC;YAC3B,CAAC;YAED,uCAAuC;YACvC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACxC,IAAI,MAAM,EAAE,CAAC;gBACX,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBACjC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;YACzC,CAAC;YAED,+BAA+B;YAC/B,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACnD,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;oBAChC,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,qCAAqC;wBAC3C,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;wBAC3B,MAAM,EAAE,IAAI;qBACb,CAAC,CAAC;oBAEH,UAAU,CAAC,IAAI,GAAG,QAAQ,CAAC;oBAC3B,OAAO,SAAS,CAAC,KAAK,CAAC;gBACzB,CAAC;gBACD,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC;YAC7B,CAAC;YAED,qCAAqC;YACrC,MAAM,qBAAqB,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC7D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5F,IAAI,CAAC,eAAe,IAAI,qBAAqB,EAAE,CAAC;gBAC9C,gBAAgB,CAAC,OAAO,EAAE;oBACxB,IAAI,EAAE,qCAAqC;oBAC3C,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;oBAC3B,MAAM,EAAE,IAAI;iBACb,CAAC,CAAC;YACL,CAAC;YAED,IAAI,eAAe,IAAI,SAAS,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;gBACvD,MAAM,SAAS,GAAI,IAAI,CAAC,IAAuB,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC9D,MAAM,WAAW,GAAG,qBAAqB;oBACvC,CAAC,CAAC,OAAO;oBACT,CAAC,CAAC,kBAAkB,CAAC,OAAO,EAAE,SAA2B,EAAE,iBAAiB,CAAC,CAAC;gBAChF,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAChC,IAAI,YAAY,GAAmB,EAAE,CAAC;oBACtC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;oBACnD,IAAI,KAAK,EAAE,CAAC;wBACV,YAAY,GAAG,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBAC5D,CAAC;yBAAM,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;wBAChC,YAAY,GAAG,sBAAsB,CACnC,SAAS,CAAC,UAAoD,EAC9D,OAAO,CACR,CAAC;oBACJ,CAAC;oBACD,YAAY,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;oBACzC,SAAS,CAAC,KAAK,GAAG,YAAY,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,SAAS,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC;wBAClC,KAAK,EAAE,IAAI,YAAY,CAAC,SAAS,CAAC,KAAY,CAAC;wBAC/C,GAAG,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;qBAC3B,CAAC,CAAC;gBACL,CAAC;gBAED,6BAA6B;gBAC7B,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAC3B,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;gBAC3B,CAAC;YACH,CAAC;YAED,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACxD,UAAU,CAAC,KAAK,GAAG,IAAI,YAAY,CAAC,SAAgB,CAAC,CAAC;gBACtD,SAAS,CAAC,IAAI,GAAG,OAAO,CAAC;YAC3B,CAAC;YAED,IAAI,eAAe,IAAI,qBAAqB,EAAE,CAAC;gBAC7C,oEAAoE;gBACpE,OAAO,SAAS,CAAC,IAAI,CAAC;YACxB,CAAC;YAED,+CAA+C;YAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxC,UAAU,CAAC,GAAG,GAAG,SAAS,CAAC;YAC7B,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,OAAgB,EAChB,KAAqC,EACrC,OAAiB;IAEjB,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;IACtE,IAAI,OAAO,IAAI,OAAO,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAsB,CAAC;QAC/C,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,iBAAiB,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;gBACnD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YAC7C,IAAI,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC9C,OAAO,IAAI,CAAC;YACd,CAAC;YAED,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,MAAM,SAAS,GAAI,IAAI,CAAC,IAAuB,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC9D,MAAM,SAAS,GAAG,SAAkB,CAAC;gBACrC,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBAC7B,IAAI,iBAAiB,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;wBACnD,OAAO,IAAI,CAAC;oBACd,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,YAAY;IACzB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/openapi3",
-  "version": "0.62.0-dev.1",
+  "version": "0.62.0-dev.11",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec",
   "homepage": "https://typespec.io",
@@ -24,6 +24,7 @@
   "tspMain": "lib/main.tsp",
   "exports": {
     ".": {
+      "typespec": "./lib/main.tsp",
       "types": "./dist/src/index.d.ts",
       "default": "./dist/src/index.js"
     },
@@ -45,20 +46,26 @@
     "yaml": "~2.5.1"
   },
   "peerDependencies": {
-    "@typespec/compiler": "~0.61.0 || >=0.62.0-dev <0.62.0",
+    "@typespec/compiler": "~0.61.2 || >=0.62.0-dev <0.62.0",
     "@typespec/http": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@typespec/openapi": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@typespec/versioning": "~0.61.0 || >=0.62.0-dev <0.62.0"
   },
+  "peerDependenciesMeta": {
+    "@typespec/xml": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@types/node": "~22.7.5",
     "@types/yargs": "~17.0.33",
-    "@typespec/compiler": "~0.61.0 || >=0.62.0-dev <0.62.0",
+    "@typespec/compiler": "~0.61.2 || >=0.62.0-dev <0.62.0",
     "@typespec/http": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@typespec/library-linter": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@typespec/openapi": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@typespec/rest": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@typespec/versioning": "~0.61.0 || >=0.62.0-dev <0.62.0",
+    "@typespec/xml": "~0.61.0 || >=0.62.0-dev <0.62.0",
     "@vitest/coverage-v8": "^2.1.2",
     "@vitest/ui": "^2.1.2",
     "c8": "^10.1.2",
@@ -80,7 +87,7 @@
     "test:ci": "vitest run --coverage --reporter=junit --reporter=default",
     "lint": "eslint . --max-warnings=0",
     "lint:fix": "eslint . --fix",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/emitters/openapi3/reference",
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/emitters/openapi3/reference",
     "regen-specs": "cross-env RECORD=true vitest run",
     "gen-version": "node scripts/generate-version.js"
   }