@azure-tools/typespec-autorest 0.42.0-dev.4 → 0.42.0-dev.6

package/dist/src/openapi.js

@@ -1,44 +1,14 @@
 import { extractLroStates, getArmResourceIdentifierConfig, getAsEmbeddingVector, getLroMetadata, getPagedResult, getUnionAsEnum, isFixed, } from "@azure-tools/typespec-azure-core";
-import { createSdkContext, getClientNameOverride, shouldFlattenProperty, } from "@azure-tools/typespec-client-generator-core";
-import { NoTarget, SyntaxKind, TwoLevelMap, compilerAssert, emitFile, getAllTags, getDirectoryPath, getDiscriminator, getDoc, getEncode, getFormat, getKnownValues, getMaxItems, getMaxLength, getMaxValue, getMinItems, getMinLength, getMinValue, getNamespaceFullName, getPattern, getProjectedName, getProperty, getPropertyType, getRelativePathFromDirectory, getRootLength, getService, getSummary, getVisibility, ignoreDiagnostics, interpolatePath, isArrayModelType, isDeprecated, isErrorModel, isErrorType, isGlobalNamespace, isNeverType, isNullType, isNumericType, isRecordModelType, isSecret, isService, isStringType, isTemplateDeclaration, isTemplateDeclarationOrInstance, isVoidType, listServices, navigateTypesInNamespace, projectProgram, resolveEncodedName, resolvePath, stringTemplateToString, } from "@typespec/compiler";
+import { shouldFlattenProperty } from "@azure-tools/typespec-client-generator-core";
+import { NoTarget, SyntaxKind, compilerAssert, createDiagnosticCollector, getAllTags, getDirectoryPath, getDiscriminator, getDoc, getEncode, getFormat, getKnownValues, getMaxItems, getMaxLength, getMaxValue, getMinItems, getMinLength, getMinValue, getPattern, getProjectedName, getProperty, getPropertyType, getRelativePathFromDirectory, getRootLength, getSummary, getVisibility, ignoreDiagnostics, interpolatePath, isArrayModelType, isDeprecated, isErrorModel, isErrorType, isGlobalNamespace, isNeverType, isNullType, isNumericType, isRecordModelType, isSecret, isService, isStringType, isTemplateDeclaration, isTemplateDeclarationOrInstance, isVoidType, navigateTypesInNamespace, resolveEncodedName, resolvePath, stringTemplateToString, } from "@typespec/compiler";
+import { TwoLevelMap } from "@typespec/compiler/utils";
 import { Visibility, createMetadataInfo, getAllHttpServices, getAuthentication, getHeaderFieldOptions, getQueryParamOptions, getServers, getStatusCodeDescription, getVisibilitySuffix, isContentTypeHeader, isSharedRoute, reportIfNoRoutes, resolveRequestVisibility, } from "@typespec/http";
 import { checkDuplicateTypeName, getExtensions, getExternalDocs, getOpenAPITypeName, getParameterKey, isReadonlyProperty, resolveInfo, shouldInline, } from "@typespec/openapi";
-import { buildVersionProjections } from "@typespec/versioning";
 import { AutorestOpenAPISchema } from "./autorest-openapi-schema.js";
 import { getExamples, getRef } from "./decorators.js";
 import { sortWithJsonSchema } from "./json-schema-sorter/sorter.js";
-import { getTracer, reportDiagnostic } from "./lib.js";
-import { resolveOperationId } from "./utils.js";
-const defaultOptions = {
-    "output-file": "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json",
-    "new-line": "lf",
-    "include-x-typespec-name": "never",
-};
-export async function $onEmit(context) {
-    const resolvedOptions = { ...defaultOptions, ...context.options };
-    const tcgcSdkContext = createSdkContext(context, "@azure-tools/typespec-autorest");
-    const armTypesDir = interpolatePath(resolvedOptions["arm-types-dir"] ?? "{project-root}/../../common-types/resource-management", {
-        "project-root": context.program.projectRoot,
-        "emitter-output-dir": context.emitterOutputDir,
-    });
-    const options = {
-        outputFile: resolvedOptions["output-file"],
-        outputDir: context.emitterOutputDir,
-        azureResourceProviderFolder: resolvedOptions["azure-resource-provider-folder"],
-        examplesDirectory: resolvedOptions["examples-directory"],
-        version: resolvedOptions["version"],
-        newLine: resolvedOptions["new-line"],
-        omitUnreachableTypes: resolvedOptions["omit-unreachable-types"],
-        includeXTypeSpecName: resolvedOptions["include-x-typespec-name"],
-        armTypesDir,
-        useReadOnlyStatusSchema: resolvedOptions["use-read-only-status-schema"],
-    };
-    const emitter = createOAPIEmitter(context.program, tcgcSdkContext, options);
-    await emitter.emitOpenAPI();
-}
-function getEmitterDetails(program) {
-    return [{ emitter: "@azure-tools/typespec-autorest" }];
-}
+import { createDiagnostic, reportDiagnostic } from "./lib.js";
+import { getClientName, resolveOperationId } from "./utils.js";
 /**
  * Represents a node that will hold a JSON reference. The value is computed
  * at the end so that we can defer decisions about the name that is
@@ -51,113 +21,111 @@ class Ref {
         return this.value;
     }
 }
-function createOAPIEmitter(program, tcgcSdkContext, options) {
-    const tracer = getTracer(program);
-    tracer.trace("options", JSON.stringify(options, null, 2));
+export async function getOpenAPIForService(context, options) {
+    const { program, service } = context;
     const typeNameOptions = {
         // shorten type names by removing TypeSpec and service namespace
         namespaceFilter(ns) {
             return !isService(program, ns);
         },
     };
-    let root;
-    let currentService;
+    const info = resolveInfo(program, service.type);
+    const auth = processAuth(service.type);
+    const root = {
+        swagger: "2.0",
+        info: {
+            title: "(title)",
+            ...info,
+            version: context.version ?? info?.version ?? "0000-00-00",
+            "x-typespec-generated": [{ emitter: "@azure-tools/typespec-autorest" }],
+        },
+        schemes: ["https"],
+        ...resolveHost(program, service.type),
+        externalDocs: getExternalDocs(program, service.type),
+        produces: [], // Pre-initialize produces and consumes so that
+        consumes: [], // they show up at the top of the document
+        security: auth?.security,
+        securityDefinitions: auth?.securitySchemes ?? {},
+        tags: [],
+        paths: {},
+        "x-ms-paths": {},
+        definitions: {},
+        parameters: {},
+    };
     let currentEndpoint;
     let currentConsumes;
     let currentProduces;
-    let metadataInfo;
+    const metadataInfo = createMetadataInfo(program, {
+        canonicalVisibility: Visibility.Read,
+        canShareProperty: canSharePropertyUsingReadonlyOrXMSMutability,
+    });
     // Keep a map of all Types+Visibility combinations that were encountered
     // that need schema definitions.
-    let pendingSchemas = new TwoLevelMap();
+    const pendingSchemas = new TwoLevelMap();
     // Reuse a single ref object per Type+Visibility combination.
-    let refs = new TwoLevelMap();
+    const refs = new TwoLevelMap();
     // Keep track of inline types still in the process of having their schema computed
     // This is used to detect cycles in inline types, which is an
-    let inProgressInlineTypes = new Set();
+    const inProgressInlineTypes = new Set();
     // Map model properties that represent shared parameters to their parameter
     // definition that will go in #/parameters. Inlined parameters do not go in
     // this map.
-    let params;
+    const params = new Map();
     // Keep track of models that have had properties spread into parameters. We won't
     // consider these unreferenced when emitting unreferenced types.
-    let paramModels;
+    const paramModels = new Set();
     // De-dupe the per-endpoint tags that will be added into the #/tags
-    let tags;
+    const tags = new Set();
     // The set of produces/consumes values found in all operations
     const globalProduces = new Set(["application/json"]);
     const globalConsumes = new Set(["application/json"]);
-    let operationExamplesMap;
-    let operationIdsWithExample;
-    let outputFile;
-    let context;
-    async function emitOpenAPI() {
-        const services = listServices(program);
-        if (services.length === 0) {
-            services.push({ type: program.getGlobalNamespaceType() });
-        }
-        for (const service of services) {
-            currentService = service;
-            const originalProgram = program;
-            const versions = buildVersionProjections(program, service.type).filter((v) => !options.version || options.version === v.version);
-            for (const record of versions) {
-                let projectedProgram;
-                if (record.projections.length > 0) {
-                    projectedProgram = program = projectProgram(originalProgram, record.projections);
-                }
-                context = {
-                    program,
-                    service,
-                    version: record.version,
-                    getClientName,
-                };
-                const projectedServiceNs = projectedProgram
-                    ? projectedProgram.projector.projectedTypes.get(service.type)
-                    : service.type;
-                await emitOpenAPIFromVersion(projectedServiceNs === program.getGlobalNamespaceType()
-                    ? { type: program.getGlobalNamespaceType() }
-                    : getService(program, projectedServiceNs), services.length > 1, record.version);
-            }
-        }
-    }
-    return { emitOpenAPI };
-    function initializeEmitter(service, multipleService, version) {
-        const auth = processAuth(service.type);
-        const info = resolveInfo(program, service.type);
-        root = {
-            swagger: "2.0",
-            info: {
-                title: "(title)",
-                ...info,
-                version: version ?? info?.version ?? "0000-00-00",
-                "x-typespec-generated": getEmitterDetails(program),
-            },
-            schemes: ["https"],
-            ...resolveHost(program, service.type),
-            externalDocs: getExternalDocs(program, service.type),
-            produces: [], // Pre-initialize produces and consumes so that
-            consumes: [], // they show up at the top of the document
-            security: auth?.security,
-            securityDefinitions: auth?.securitySchemes ?? {},
-            tags: [],
-            paths: {},
-            "x-ms-paths": {},
-            definitions: {},
-            parameters: {},
-        };
-        pendingSchemas = new TwoLevelMap();
-        refs = new TwoLevelMap();
-        metadataInfo = createMetadataInfo(program, {
-            canonicalVisibility: Visibility.Read,
-            canShareProperty: canSharePropertyUsingReadonlyOrXMSMutability,
-        });
-        inProgressInlineTypes = new Set();
-        params = new Map();
-        paramModels = new Set();
-        tags = new Set();
-        operationExamplesMap = new Map();
-        operationIdsWithExample = new Set();
-        outputFile = resolveOutputFile(program, service, multipleService, options, version);
-    }
+    const operationIdsWithExample = new Set();
+    const [exampleMap, diagnostics] = await loadExamples(program.host, options, context.version);
+    program.reportDiagnostics(diagnostics);
+    const services = ignoreDiagnostics(getAllHttpServices(program));
+    const routes = services[0].operations;
+    reportIfNoRoutes(program, routes);
+    routes.forEach(emitOperation);
+    emitParameters();
+    emitSchemas(service.type);
+    emitTags();
+    // Finalize global produces/consumes
+    if (globalProduces.size > 0) {
+        root.produces = [...globalProduces.values()];
+    }
+    else {
+        delete root.produces;
+    }
+    if (globalConsumes.size > 0) {
+        root.consumes = [...globalConsumes.values()];
+    }
+    else {
+        delete root.consumes;
+    }
+    // Clean up empty entries
+    if (root["x-ms-paths"] && Object.keys(root["x-ms-paths"]).length === 0) {
+        delete root["x-ms-paths"];
+    }
+    if (root.security && Object.keys(root.security).length === 0) {
+        delete root["security"];
+    }
+    if (root.securityDefinitions && Object.keys(root.securityDefinitions).length === 0) {
+        delete root["securityDefinitions"];
+    }
+    return {
+        document: root,
+        operationExamples: [...operationIdsWithExample]
+            .map((operationId) => {
+            const data = exampleMap.get(operationId);
+            if (data) {
+                return { operationId, examples: Object.values(data) };
+            }
+            else {
+                return undefined;
+            }
+        })
+            .filter((x) => x),
+    };
     function resolveHost(program, namespace) {
         const servers = getServers(program, namespace);
         if (servers === undefined) {
@@ -210,83 +178,6 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
             },
         };
     }
-    async function emitOpenAPIFromVersion(service, multipleService, version) {
-        initializeEmitter(service, multipleService, version);
-        try {
-            await loadExamples(version);
-            const services = ignoreDiagnostics(getAllHttpServices(program));
-            const routes = services[0].operations;
-            reportIfNoRoutes(program, routes);
-            routes.forEach(emitOperation);
-            emitParameters();
-            emitSchemas(service.type);
-            emitTags();
-            // Finalize global produces/consumes
-            if (globalProduces.size > 0) {
-                root.produces = [...globalProduces.values()];
-            }
-            else {
-                delete root.produces;
-            }
-            if (globalConsumes.size > 0) {
-                root.consumes = [...globalConsumes.values()];
-            }
-            else {
-                delete root.consumes;
-            }
-            // Clean up empty entries
-            if (root["x-ms-paths"] && Object.keys(root["x-ms-paths"]).length === 0) {
-                delete root["x-ms-paths"];
-            }
-            if (root.security && Object.keys(root.security).length === 0) {
-                delete root["security"];
-            }
-            if (root.securityDefinitions && Object.keys(root.securityDefinitions).length === 0) {
-                delete root["securityDefinitions"];
-            }
-            if (!program.compilerOptions.noEmit && !program.hasError()) {
-                // Sort the document
-                const sortedRoot = sortOpenAPIDocument(root);
-                // Write out the OpenAPI document to the output path
-                await emitFile(program, {
-                    path: outputFile,
-                    content: prettierOutput(JSON.stringify(sortedRoot, null, 2)),
-                    newLine: options.newLine,
-                });
-                // Copy examples to the output directory
-                if (options.examplesDirectory && operationIdsWithExample.size > 0) {
-                    const examplesPath = resolvePath(getDirectoryPath(outputFile), "examples");
-                    const exampleDir = version
-                        ? resolvePath(options.examplesDirectory, version)
-                        : resolvePath(options.examplesDirectory);
-                    await program.host.mkdirp(examplesPath);
-                    for (const operationId of operationIdsWithExample) {
-                        const examples = operationExamplesMap.get(operationId);
-                        if (examples) {
-                            for (const [_, fileName] of Object.entries(examples)) {
-                                const content = await program.host.readFile(resolvePath(exampleDir, fileName));
-                                await emitFile(program, {
-                                    path: resolvePath(examplesPath, fileName),
-                                    content: content.text,
-                                    newLine: options.newLine,
-                                });
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        catch (err) {
-            if (err instanceof ErrorTypeFoundError) {
-                // Return early, there must be a parse error if an ErrorType was
-                // inserted into the TypeSpec output
-                return;
-            }
-            else {
-                throw err;
-            }
-        }
-    }
     function parseNextLinkName(paged) {
         const pathComponents = paged.nextLinkSegments;
         if (pathComponents) {
@@ -418,12 +309,12 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
             currentEndpoint["x-ms-examples"] = examples.reduce((acc, example) => ({ ...acc, [example.title]: { $ref: example.pathOrUri } }), {});
         }
         if (options.examplesDirectory) {
-            const examples = operationExamplesMap.get(currentEndpoint.operationId);
+            const examples = exampleMap.get(currentEndpoint.operationId);
             if (examples && currentEndpoint.operationId) {
                 operationIdsWithExample.add(currentEndpoint.operationId);
                 currentEndpoint["x-ms-examples"] = currentEndpoint["x-ms-examples"] || {};
-                for (const [title, fileName] of Object.entries(examples)) {
-                    currentEndpoint["x-ms-examples"][title] = { $ref: `./examples/${fileName}` };
+                for (const [title, example] of Object.entries(examples)) {
+                    currentEndpoint["x-ms-examples"][title] = { $ref: `./examples/${example.relativePath}` };
                 }
             }
         }
@@ -581,7 +472,7 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
         if (getRootLength(absoluteRef) === 0) {
             return absoluteRef; // It is already relative.
         }
-        return getRelativePathFromDirectory(getDirectoryPath(outputFile), absoluteRef, false);
+        return getRelativePathFromDirectory(getDirectoryPath(context.outputFile), absoluteRef, false);
     }
     function getSchemaOrRef(type, schemaContext) {
         const refUrl = getRef(program, type, { version: context.version, service: context.service });
@@ -696,11 +587,6 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
         // `resolveEncodedName` will return the original name if no @encodedName so we have to do that check
         return encodedName === type.name ? viaProjection ?? type.name : encodedName;
     }
-    function getClientName(type) {
-        const viaProjection = getProjectedName(program, type, "client");
-        const clientName = getClientNameOverride(tcgcSdkContext, type);
-        return clientName ?? viaProjection ?? type.name;
-    }
     function emitEndpointParameters(methodParams, visibility) {
         const consumes = methodParams.body?.contentTypes ?? [];
         for (const httpOpParam of methodParams.parameters) {
@@ -956,66 +842,6 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
             root.tags.push({ name: tag });
         }
     }
-    async function loadExamples(version) {
-        if (options.examplesDirectory) {
-            const exampleDir = version
-                ? resolvePath(options.examplesDirectory, version)
-                : resolvePath(options.examplesDirectory);
-            try {
-                if (!(await program.host.stat(exampleDir)).isDirectory())
-                    return;
-            }
-            catch (err) {
-                reportDiagnostic(program, {
-                    code: "example-loading",
-                    messageId: "noDirectory",
-                    format: { directory: exampleDir },
-                    target: NoTarget,
-                });
-                return;
-            }
-            const exampleFiles = await program.host.readDir(exampleDir);
-            for (const fileName of exampleFiles) {
-                try {
-                    const exampleFile = await program.host.readFile(resolvePath(exampleDir, fileName));
-                    const example = JSON.parse(exampleFile.text);
-                    if (!example.operationId || !example.title) {
-                        reportDiagnostic(program, {
-                            code: "example-loading",
-                            messageId: "noOperationId",
-                            format: { filename: fileName },
-                            target: NoTarget,
-                        });
-                        continue;
-                    }
-                    if (!operationExamplesMap.has(example.operationId)) {
-                        operationExamplesMap.set(example.operationId, {});
-                    }
-                    const examples = operationExamplesMap.get(example.operationId);
-                    if (example.title in examples) {
-                        reportDiagnostic(program, {
-                            code: "duplicate-example-file",
-                            target: NoTarget,
-                            format: {
-                                filename: fileName,
-                                operationId: example.operationId,
-                                title: example.title,
-                            },
-                        });
-                    }
-                    examples[example.title] = fileName;
-                }
-                catch (err) {
-                    reportDiagnostic(program, {
-                        code: "example-loading",
-                        messageId: "default",
-                        format: { filename: fileName, error: err?.toString() ?? "" },
-                        target: NoTarget,
-                    });
-                }
-            }
-        }
-    }
     function getSchemaForType(type, schemaContext) {
         const builtinType = getSchemaForLiterals(type);
         if (builtinType !== undefined) {
@@ -1288,7 +1114,7 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
                 continue;
             }
             const jsonName = getJsonName(prop);
-            const clientName = getClientName(prop);
+            const clientName = getClientName(context, prop);
             const description = getDoc(program, prop);
             // if this property is a discriminator property, remove it to keep autorest validation happy
             if (model.baseModel) {
@@ -1511,7 +1337,7 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
             }
         }
         if (typespecType.kind === "ModelProperty" &&
-            shouldFlattenProperty(tcgcSdkContext, typespecType)) {
+            shouldFlattenProperty(context.tcgcSdkContext, typespecType)) {
             newTarget["x-ms-client-flatten"] = true;
         }
         attachExtensions(typespecType, newTarget);
@@ -1788,7 +1614,7 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
                 reportDiagnostic(program, {
                     code: "unsupported-auth",
                     format: { authType: auth.type },
-                    target: currentService.type,
+                    target: service.type,
                 });
                 return undefined;
         }
@@ -1809,9 +1635,6 @@ function createOAPIEmitter(program, tcgcSdkContext, options) {
         }
     }
 }
-function prettierOutput(output) {
-    return output + "\n";
-}
 class ErrorTypeFoundError extends Error {
     constructor() {
         super("Error type found in evaluated TypeSpec output");
@@ -1823,24 +1646,72 @@ export function sortOpenAPIDocument(doc) {
     const sorted = sortWithJsonSchema(unsorted, AutorestOpenAPISchema, "#/$defs/AutorestOpenAPISchema");
     return sorted;
 }
-function resolveOutputFile(program, service, multipleServices, options, version) {
-    const azureResourceProviderFolder = options.azureResourceProviderFolder;
-    if (azureResourceProviderFolder) {
-        const info = resolveInfo(program, service.type);
-        version = version ?? info?.version ?? "0000-00-00";
-    }
-    const interpolated = interpolatePath(options.outputFile, {
-        "azure-resource-provider-folder": azureResourceProviderFolder,
-        "service-name": multipleServices || azureResourceProviderFolder
-            ? getNamespaceFullName(service.type)
-            : undefined,
-        "version-status": azureResourceProviderFolder
-            ? version?.includes("preview")
-                ? "preview"
-                : "stable"
-            : undefined,
-        version,
-    });
-    return resolvePath(options.outputDir, interpolated);
+async function loadExamples(host, options, version) {
+    const diagnostics = createDiagnosticCollector();
+    if (!options.examplesDirectory) {
+        return diagnostics.wrap(new Map());
+    }
+    const exampleDir = version
+        ? resolvePath(options.examplesDirectory, version)
+        : resolvePath(options.examplesDirectory);
+    try {
+        if (!(await host.stat(exampleDir)).isDirectory())
+            return diagnostics.wrap(new Map());
+    }
+    catch (err) {
+        diagnostics.add(createDiagnostic({
+            code: "example-loading",
+            messageId: "noDirectory",
+            format: { directory: exampleDir },
+            target: NoTarget,
+        }));
+        return diagnostics.wrap(new Map());
+    }
+    const map = new Map();
+    const exampleFiles = await host.readDir(exampleDir);
+    for (const fileName of exampleFiles) {
+        try {
+            const exampleFile = await host.readFile(resolvePath(exampleDir, fileName));
+            const example = JSON.parse(exampleFile.text);
+            if (!example.operationId || !example.title) {
+                diagnostics.add(createDiagnostic({
+                    code: "example-loading",
+                    messageId: "noOperationId",
+                    format: { filename: fileName },
+                    target: NoTarget,
+                }));
+                continue;
+            }
+            if (!map.has(example.operationId)) {
+                map.set(example.operationId, {});
+            }
+            const examples = map.get(example.operationId);
+            if (example.title in examples) {
+                diagnostics.add(createDiagnostic({
+                    code: "duplicate-example-file",
+                    target: NoTarget,
+                    format: {
+                        filename: fileName,
+                        operationId: example.operationId,
+                        title: example.title,
+                    },
+                }));
+            }
+            examples[example.title] = {
+                relativePath: fileName,
+                file: exampleFile,
+                data: example,
+            };
+        }
+        catch (err) {
+            diagnostics.add(createDiagnostic({
+                code: "example-loading",
+                messageId: "default",
+                format: { filename: fileName, error: err?.toString() ?? "" },
+                target: NoTarget,
+            }));
+        }
+    }
+    return diagnostics.wrap(map);
 }
 //# sourceMappingURL=openapi.js.map