@azure-tools/typespec-autorest-canonical 0.1.0

package/dist/src/lib.js

@@ -0,0 +1,150 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+const EmitterOptionsSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        "output-file": {
+            type: "string",
+            nullable: true,
+            description: [
+                "Name of the output file.",
+                "Output file will interpolate the following values:",
+                " - service-name: Name of the service if multiple",
+                " - azure-resource-provider-folder: Value of the azure-resource-provider-folder option",
+                "",
+                "Default: `{azure-resource-provider-folder}/{service-name}/{version}/openapi.json`",
+                "",
+                "",
+                "Example: Single service",
+                " - `canonical.openapi.json`",
+                "",
+                "Example: Multiple services",
+                " - `Service1.canonical.openapi.json`",
+                " - `Service2.canonical.openapi.json`",
+            ].join("\n"),
+        },
+        "azure-resource-provider-folder": { type: "string", nullable: true },
+        "new-line": {
+            type: "string",
+            enum: ["crlf", "lf"],
+            nullable: true,
+            default: "lf",
+            description: "Set the newline character for emitting files.",
+        },
+        "omit-unreachable-types": {
+            type: "boolean",
+            nullable: true,
+            description: "Omit unreachable types. By default all types declared under the service namespace will be included. With this flag on only types references in an operation will be emitted.",
+        },
+        "include-x-typespec-name": {
+            type: "string",
+            enum: ["inline-only", "never"],
+            nullable: true,
+            default: "never",
+            description: "If the generated openapi types should have the `x-typespec-name` extension set with the name of the TypeSpec type that created it.\nThis extension is meant for debugging and should not be depended on.",
+        },
+    },
+    required: [],
+};
+const libDef = {
+    name: "@azure-tools/typespec-autorest-canonical",
+    diagnostics: {
+        "duplicate-body-types": {
+            severity: "error",
+            messages: {
+                default: "Request has multiple body types",
+            },
+        },
+        "invalid-schema": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Couldn't get schema for type ${"type"}`,
+            },
+        },
+        "union-null": {
+            severity: "error",
+            messages: {
+                default: "Cannot have a union containing only null types.",
+            },
+        },
+        "union-unsupported": {
+            severity: "warning",
+            messages: {
+                default: "Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.",
+                empty: "Empty unions are not supported for OpenAPI v2 - enums must have at least one value.",
+            },
+        },
+        "invalid-default": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Invalid type '${"type"}' for a default value`,
+            },
+        },
+        "invalid-multi-collection-format": {
+            severity: "error",
+            messages: {
+                default: "The 'multi' should be applied to parameter in 'query', 'header' or 'formData'.",
+            },
+        },
+        "inline-cycle": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Cycle detected in '${"type"}'. Use @friendlyName decorator to assign an OpenAPI definition name and make it non-inline.`,
+            },
+        },
+        "nonspecific-scalar": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Scalar type '${"type"}' is not specific enough. The more specific type '${"chosenType"}' has been chosen.`,
+            },
+        },
+        "unsupported-http-auth-scheme": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `The specified HTTP authentication scheme is not supported by this emitter: ${"scheme"}.`,
+            },
+        },
+        "unsupported-status-code-range": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Status code range '${"start"} to '${"end"}' is not supported. OpenAPI 2.0 can only represent range 1XX, 2XX, 3XX, 4XX and 5XX. Example: \`@minValue(400) @maxValue(499)\` for 4XX.`,
+            },
+        },
+        "unsupported-multipart-type": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Multipart parts can only be represented as primitive types in swagger 2.0. Information is lost for part '${"part"}'.`,
+            },
+        },
+        "unsupported-param-type": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Parameter can only be represented as primitive types in swagger 2.0. Information is lost for part '${"part"}'.`,
+            },
+        },
+        "invalid-format": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `'${"schema"}' format '${"format"}' is not supported in AutorestCanonical. It will not be emitted.`,
+            },
+        },
+        "unsupported-auth": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Authentication "${"authType"}" is not a known authentication by the AutorestCanonical emitter, it will be ignored.`,
+            },
+        },
+        "unsupported-versioning-decorator": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Decorator @${"decorator"} is not supported in AutorestCanonical.`,
+            },
+        },
+    },
+    emitter: {
+        options: EmitterOptionsSchema,
+    },
+};
+export const $lib = createTypeSpecLibrary(libDef);
+export const { reportDiagnostic, createStateSymbol, getTracer } = $lib;
+//# sourceMappingURL=lib.js.map

package/dist/src/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAkB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAmDzF,MAAM,oBAAoB,GAAoD;IAC5E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE;gBACX,0BAA0B;gBAC1B,oDAAoD;gBACpD,kDAAkD;gBAClD,uFAAuF;gBACvF,EAAE;gBACF,mFAAmF;gBACnF,EAAE;gBACF,EAAE;gBACF,yBAAyB;gBACzB,6BAA6B;gBAC7B,EAAE;gBACF,4BAA4B;gBAC5B,sCAAsC;gBACtC,sCAAsC;aACvC,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;QACD,gCAAgC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;YACpB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,+CAA+C;SAC7D;QACD,wBAAwB,EAAE;YACxB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,8KAA8K;SACjL;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC;YAC9B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,OAAO;YAChB,WAAW,EACT,0MAA0M;SAC7M;KACF;IACD,QAAQ,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,0CAA0C;IAChD,WAAW,EAAE;QACX,sBAAsB,EAAE;YACtB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,iCAAiC;aAC3C;SACF;QACD,gBAAgB,EAAE;YAChB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,gCAAgC,MAAM,EAAE;aAC9D;SACF;QACD,YAAY,EAAE;YACZ,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,iDAAiD;aAC3D;SACF;QACD,mBAAmB,EAAE;YACnB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EACL,0FAA0F;gBAC5F,KAAK,EACH,qFAAqF;aACxF;SACF;QACD,iBAAiB,EAAE;YACjB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,iBAAiB,MAAM,uBAAuB;aACpE;SACF;QACD,iCAAiC,EAAE;YACjC,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,gFAAgF;aAC1F;SACF;QACD,cAAc,EAAE;YACd,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,sBAAsB,MAAM,6FAA6F;aAC/I;SACF;QACD,oBAAoB,EAAE;YACpB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,gBAAgB,MAAM,qDAAqD,YAAY,oBAAoB;aACjI;SACF;QACD,8BAA8B,EAAE;YAC9B,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,8EAA8E,QAAQ,GAAG;aAC/G;SACF;QACD,+BAA+B,EAAE;YAC/B,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,sBAAsB,OAAO,QAAQ,KAAK,0IAA0I;aAC1M;SACF;QACD,4BAA4B,EAAE;YAC5B,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,4GAA4G,MAAM,IAAI;aAC5I;SACF;QACD,wBAAwB,EAAE;YACxB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,sGAAsG,MAAM,IAAI;aACtI;SACF;QACD,gBAAgB,EAAE;YAChB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,IAAI,QAAQ,aAAa,QAAQ,kEAAkE;aACzH;SACF;QACD,kBAAkB,EAAE;YAClB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,mBAAmB,UAAU,uFAAuF;aAC1I;SACF;QACD,kCAAkC,EAAE;YAClC,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,cAAc,WAAW,yCAAyC;aACxF;SACF;KACF;IACD,OAAO,EAAE;QACP,OAAO,EAAE,oBAAuE;KACjF;CACO,CAAC;AAEX,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAClD,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC"}

package/dist/src/openapi.d.ts

@@ -0,0 +1,31 @@
+import { EmitContext } from "@typespec/compiler";
+import { AutorestCanonicalEmitterOptions } from "./lib.js";
+import { OpenAPI2Document } from "./types.js";
+export declare const namespace = "AutorestCanonical";
+export declare const canonicalVersion = "canonical";
+export declare function $onEmit(context: EmitContext<AutorestCanonicalEmitterOptions>): Promise<void>;
+export interface ResolvedAutorestCanonicalEmitterOptions {
+    outputDir: string;
+    outputFile: string;
+    azureResourceProviderFolder?: string;
+    /**
+     * Set the newline character for emitting files.
+     * @default lf
+     */
+    newLine?: "crlf" | "lf";
+    /**
+     * Omit unreachable types.
+     * By default all types declared under the service namespace will be included. With this flag on only types references in an operation will be emitted.
+     */
+    omitUnreachableTypes?: boolean;
+    /**
+     * If the x-typespec-name extension should be included
+     */
+    includeXTypeSpecName: "inline-only" | "never";
+    /**
+     * Arm types dir
+     */
+    armTypesDir: string;
+}
+export declare function sortOpenAPIDocument(doc: OpenAPI2Document): OpenAPI2Document;
+//# sourceMappingURL=openapi.d.ts.map

package/dist/src/openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/openapi.ts"],"names":[],"mappings":"AAeA,OAAO,EAIL,WAAW,EAkEZ,MAAM,oBAAoB,CAAC;AA2C5B,OAAO,EAAE,+BAA+B,EAA+B,MAAM,UAAU,CAAC;AACxF,OAAO,EACL,gBAAgB,EAgBjB,MAAM,YAAY,CAAC;AAepB,eAAO,MAAM,SAAS,sBAAsB,CAAC;AAC7C,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C,wBAAsB,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,+BAA+B,CAAC,iBAmBlF;AAUD,MAAM,WAAW,uCAAuC;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,oBAAoB,EAAE,aAAa,GAAG,OAAO,CAAC;IAE9C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAo5DD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,gBAAgB,GAAG,gBAAgB,CAS3E"}