@azure-tools/typespec-autorest 0.27.0

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    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/README.md

@@ -0,0 +1,166 @@
+# TypeSpec AutoRest Library
+
+This is a TypeSpec library that will emit an enriched OpenAPI 2.0 specification that can be consumed by AutoRest.
+The generated OpenAPI spec will have custom `x-ms-` extensions properties and conform to standards required by AutoRest to generate a more accurate SDK.
+
+## Getting started
+
+1. Include `@azure-tools/typespec-autorest` dependencies in package.json
+
+```json
+{
+  ...
+  "dependencies": {
+    ...
+    "@azure-tools/typespec-autorest": "latest"
+  }
+}
+```
+
+2. Run `npm install` to install the dependency
+3. Import `@azure-tools/typespec-autorest` in your `main.tsp` file
+
+```typespec
+import "@azure-tools/typespec-autorest";
+```
+
+4. Run `tsp compile`. This will result in a `swagger.json` file crated in `./tsp-output/swagger.json`
+
+## Use in autorest
+
+### Manually
+
+Generate the OpenAPI spec as shown above then run autorest cli directly on it.
+
+### Via Autorest
+
+AutoRest provides a plugin that will directly take TypeSpec as input. Make sure to use `Autorest Core >=3.6.0`
+
+```bash
+autorest --typespec --input-file=./main.tsp
+```
+
+## Configuration
+
+### Output path
+
+Specify the `--output-path` option, this changes the directory where the OpenAPI specification (openapi.json) wil be omitted:
+
+```bash
+tsp compile --output-path=`./custom`
+```
+
+### Emitter options:
+
+Emitter options can be configured via the `tspconfig.yaml` configuration:
+
+```yaml
+emitters:
+  '@azure-tools/typespec-autorest':
+    <optionName>: <value>
+
+
+# For example
+emitters:
+  '@azure-tools/typespec-autorest':
+    output-file: my-custom-swagger.json
+```
+
+or via the command line with
+
+```bash
+--option "@azure-tools/typespec-autorest.<optionName>=<value>"
+
+# For example
+--option "@azure-tools/typespec-autorest.output-file=my-custom-swagger.json"
+```
+
+#### `output-dir`
+
+Override the compiler default `output-dir`
+
+#### `output-file`
+
+Configure the name of the swagger output file relative to the `output-dir`.
+
+#### `examples-directory`
+
+Directory where the x-ms-examples are located so the emitter can automatically link.
+
+#### `version`
+
+Select which version should be emitted if the spec support versioning. By default all the version with be emitted in this format `<outputFileName>.<version>.json`
+
+### `new-line`
+
+Set the newline character for emitting files. Can be either:
+
+- `lf`(Default)
+- `crlf`
+
+### `omit-unreachable-types`
+
+Only include types referenced via an operation.
+
+## Decorators
+
+- [@collectionFormat](#collectionformat)
+- [@example](#example)
+- [@useRef](#useref)
+
+### @collectionFormat
+
+Syntax:
+
+```
+@collectionFormat(formatString)
+```
+
+`@collectionFormat` specifies array property type serialization format. Valid format strings are "csv", "multi", "ssv", "tsv", "pipes" though "csv" or "multi" are recommended.
+
+`@collectionFormat` can only be specified on model properties that are arrays.
+
+### @example
+
+Syntax:
+
+```
+@example(pathOrUri, title)
+```
+
+`@example` attaches example files to an operation. Multiple examples can be specified.
+
+`@example` can only be specified on operations.
+
+### @useRef
+
+Syntax:
+
+```
+@useRef(urlString)
+```
+
+`@useRef` is used to replace the TypeSpec model type in emitter output with a pre-existing named OpenAPI schema such as ARM common types.
+
+## How to
+
+### Include `x-ms-skip-url-encoding` in `x-ms-parmaeterized-host` parameter
+
+Every parameter of type `uri` in `@server` will be marked with `x-ms-skip-url-encoding`.
+
+```typespec
+@server("{endpoint}/v2", "Account endpoint", {endpoint: url})
+```
+
+Result in
+
+```json5
+{
+  in: "path",
+  name: "endpoint",
+  required: true,
+  type: "string",
+  format: "uri",
+  "x-ms-skip-url-encoding": true,
+}
+```

package/dist/src/decorators.d.ts

@@ -0,0 +1,28 @@
+import { DecoratorContext, ModelProperty, Program, Type } from "@typespec/compiler";
+export declare const namespace = "Autorest";
+export interface Example {
+    pathOrUri: string;
+    title: string;
+}
+/**
+ * `@example` - attaches example files to an operation. Multiple examples can be specified.
+ *
+ * @param {string} param pathOrUri - path or Uri to the example file.
+ * @param {string} param title - name or description of the example file.
+ *
+ * `@example` can be specified on Operations.
+ */
+export declare function $example(context: DecoratorContext, entity: Type, pathOrUri: string, title: string): void;
+export declare function getExamples(program: Program, entity: Type): Example[] | undefined;
+/**
+ * `@useRef` - is used to replace the TypeSpec model type in emitter output with a pre-existing named OpenAPI schema such as ARM common types.
+ *
+ * @param {string} param jsonRef - path or Uri to an OpenAPI schema.
+ *
+ * `@useRef` can be specified on Models and ModelProperty.
+ */
+export declare function $useRef(context: DecoratorContext, entity: Type, jsonRef: string): void;
+export declare function getRef(program: Program, entity: Type): string | undefined;
+export declare function $collectionFormat(context: DecoratorContext, entity: ModelProperty, format: string): void;
+export declare function getCollectionFormat(program: Program, entity: Type): string | undefined;
+//# sourceMappingURL=decorators.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,EAGhB,aAAa,EACb,OAAO,EAEP,IAAI,EAGL,MAAM,oBAAoB,CAAC;AAG5B,eAAO,MAAM,SAAS,aAAa,CAAC;AAEpC,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAGD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,QA2Bd;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO,EAAE,GAAG,SAAS,CAEjF;AAGD;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAStF;AAED,wBAAgB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAEzE;AAQD,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,QAuCf;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAEtF"}

package/dist/src/decorators.js

@@ -0,0 +1,100 @@
+import { createDecoratorDefinition, isArrayModelType, isStringType, reportDeprecated, validateDecoratorParamType, validateDecoratorTarget, } from "@typespec/compiler";
+import { createStateSymbol, reportDiagnostic } from "./lib.js";
+export const namespace = "Autorest";
+const exampleKey = createStateSymbol("example");
+/**
+ * `@example` - attaches example files to an operation. Multiple examples can be specified.
+ *
+ * @param {string} param pathOrUri - path or Uri to the example file.
+ * @param {string} param title - name or description of the example file.
+ *
+ * `@example` can be specified on Operations.
+ */
+export function $example(context, entity, pathOrUri, title) {
+    const { program } = context;
+    if (!validateDecoratorTarget(context, entity, "@example", "Operation") ||
+        !validateDecoratorParamType(program, entity, pathOrUri, "String") ||
+        !validateDecoratorParamType(program, entity, title, "String")) {
+        return;
+    }
+    if (!program.stateMap(exampleKey).has(entity)) {
+        program.stateMap(exampleKey).set(entity, []);
+    }
+    else if (program
+        .stateMap(exampleKey)
+        .get(entity)
+        .find((e) => e.title === title || e.pathOrUri === pathOrUri)) {
+        reportDiagnostic(program, {
+            code: "duplicate-example",
+            target: entity,
+        });
+    }
+    program.stateMap(exampleKey).get(entity).push({
+        pathOrUri,
+        title,
+    });
+}
+export function getExamples(program, entity) {
+    return program.stateMap(exampleKey).get(entity);
+}
+const refTargetsKey = createStateSymbol("autorest.ref");
+/**
+ * `@useRef` - is used to replace the TypeSpec model type in emitter output with a pre-existing named OpenAPI schema such as ARM common types.
+ *
+ * @param {string} param jsonRef - path or Uri to an OpenAPI schema.
+ *
+ * `@useRef` can be specified on Models and ModelProperty.
+ */
+export function $useRef(context, entity, jsonRef) {
+    if (!validateDecoratorTarget(context, entity, "@useRef", ["Model", "ModelProperty"]) ||
+        !validateDecoratorParamType(context.program, entity, jsonRef, "String")) {
+        return;
+    }
+    context.program.stateMap(refTargetsKey).set(entity, jsonRef);
+}
+export function getRef(program, entity) {
+    return program.stateMap(refTargetsKey).get(entity);
+}
+const collectionFormatDecorator = createDecoratorDefinition({
+    name: "@collectionFormat",
+    target: "ModelProperty",
+    args: [{ kind: "String" }],
+});
+const collectionFormatKey = createStateSymbol("collectionFormat");
+export function $collectionFormat(context, entity, format) {
+    // Deprecated 1/12/2023
+    reportDeprecated(context.program, "The @collectionFormat decorator is deprecated. Use `format` option in @query/@header decorators instead.", context.decoratorTarget);
+    if (!collectionFormatDecorator.validate(context, entity, [format])) {
+        return;
+    }
+    if (entity.type.kind !== "Model" ||
+        !isArrayModelType(context.program, entity.type) ||
+        (entity.type.templateArguments &&
+            !isStringType(context.program, entity.type.templateArguments[0]))) {
+        reportDiagnostic(context.program, {
+            code: "invalid-property-type-for-collection-format",
+            target: context.decoratorTarget,
+        });
+        return;
+    }
+    const knownFormats = ["csv", "ssv", "tsv", "pipes", "multi"];
+    if (!knownFormats.includes(format)) {
+        reportDiagnostic(context.program, {
+            code: "invalid-collection-format",
+            target: context.decoratorTarget,
+        });
+        return;
+    }
+    const recommendations = ["csv", "multi"];
+    if (!recommendations.includes(format)) {
+        reportDiagnostic(context.program, {
+            code: "non-recommended-collection-format",
+            target: context.decoratorTarget,
+        });
+    }
+    context.program.stateMap(collectionFormatKey).set(entity, format);
+}
+export function getCollectionFormat(program, entity) {
+    return program.stateMap(collectionFormatKey).get(entity);
+}
+//# sourceMappingURL=decorators.js.map

package/dist/src/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EAEzB,gBAAgB,EAChB,YAAY,EAGZ,gBAAgB,EAEhB,0BAA0B,EAC1B,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE/D,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,CAAC;AAOpC,MAAM,UAAU,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;AAChD;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAyB,EACzB,MAAY,EACZ,SAAiB,EACjB,KAAa;IAEb,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,IACE,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC;QAClE,CAAC,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC;QACjE,CAAC,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,EAC7D;QACA,OAAO;KACR;IACD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;KAC9C;SAAM,IACL,OAAO;SACJ,QAAQ,CAAC,UAAU,CAAC;SACpB,GAAG,CAAC,MAAM,CAAC;SACX,IAAI,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,EACvE;QACA,gBAAgB,CAAC,OAAO,EAAE;YACxB,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;KACJ;IACD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;QAC5C,SAAS;QACT,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAgB,EAAE,MAAY;IACxD,OAAO,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,aAAa,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AACxD;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,OAAyB,EAAE,MAAY,EAAE,OAAe;IAC9E,IACE,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAChF,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EACvE;QACA,OAAO;KACR;IAED,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,OAAgB,EAAE,MAAY;IACnD,OAAO,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,yBAAyB,GAAG,yBAAyB,CAAC;IAC1D,IAAI,EAAE,mBAAmB;IACzB,MAAM,EAAE,eAAe;IACvB,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB,CAAC,CAAC;AACZ,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;AAClE,MAAM,UAAU,iBAAiB,CAC/B,OAAyB,EACzB,MAAqB,EACrB,MAAc;IAEd,uBAAuB;IACvB,gBAAgB,CACd,OAAO,CAAC,OAAO,EACf,0GAA0G,EAC1G,OAAO,CAAC,eAAe,CACxB,CAAC;IACF,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE;QAClE,OAAO;KACR;IACD,IACE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO;QAC5B,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC;QAC/C,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB;YAC5B,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,EACnE;QACA,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,OAAO,CAAC,eAAe;SAChC,CAAC,CAAC;QACH,OAAO;KACR;IACD,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAClC,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,2BAA2B;YACjC,MAAM,EAAE,OAAO,CAAC,eAAe;SAChC,CAAC,CAAC;QACH,OAAO;KACR;IACD,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACrC,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,OAAO,CAAC,eAAe;SAChC,CAAC,CAAC;KACJ;IACD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAgB,EAAE,MAAY;IAChE,OAAO,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./decorators.js";
+export { $lib } from "./lib.js";
+export * from "./openapi.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,4 @@
+export * from "./decorators.js";
+export { $lib } from "./lib.js";
+export * from "./openapi.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/src/lib.d.ts

@@ -0,0 +1,179 @@
+export interface AutorestEmitterOptions {
+    /**
+     * Override compiler output-dir
+     */
+    "output-dir"?: string;
+    "output-file"?: string;
+    "examples-directory"?: string;
+    version?: string;
+    "azure-resource-provider-folder"?: string;
+    /**
+     * Set the newline character for emitting files.
+     * @default lf
+     */
+    "new-line"?: "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.
+     */
+    "omit-unreachable-types"?: boolean;
+}
+export declare const $lib: import("@typespec/compiler").TypeSpecLibrary<{
+    "security-service-namespace": {
+        readonly default: "Cannot add security details to a namespace other than the service namespace.";
+    };
+    "resource-namespace": {
+        readonly default: "Resource goes on namespace";
+    };
+    "missing-path-param": {
+        readonly default: import("@typespec/compiler").CallableMessage<["param"]>;
+    };
+    "duplicate-body-types": {
+        readonly default: "Request has multiple body types";
+    };
+    "duplicate-header": {
+        readonly default: import("@typespec/compiler").CallableMessage<["header"]>;
+    };
+    "duplicate-example": {
+        readonly default: "Duplicate @example declarations on operation";
+    };
+    "invalid-schema": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "union-null": {
+        readonly default: "Cannot have a union containing only null types.";
+    };
+    "union-unsupported": {
+        readonly default: "Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.";
+        readonly null: "Unions containing multiple model types cannot be emitted to OpenAPI v2 unless the union is between one model type and 'null'.";
+    };
+    "invalid-default": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "invalid-property-type-for-collection-format": {
+        readonly default: "The collectionFormat can only be applied to model property with type 'string[]'.";
+    };
+    "invalid-collection-format": {
+        readonly default: "The format should be one of 'csv','ssv','tsv','pipes' and 'multi'.";
+    };
+    "non-recommended-collection-format": {
+        readonly default: "The recommendation of collection format are 'csv' and 'multi'.";
+    };
+    "invalid-multi-collection-format": {
+        readonly default: "The 'multi' should be applied to parameter in 'query', 'header' or 'formData'.";
+    };
+    "inline-cycle": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "example-loading": {
+        readonly default: import("@typespec/compiler").CallableMessage<["filename"]>;
+        readonly noDirectory: import("@typespec/compiler").CallableMessage<["directory"]>;
+        readonly noOperationId: import("@typespec/compiler").CallableMessage<["filename"]>;
+    };
+}, AutorestEmitterOptions>;
+export declare const reportDiagnostic: <C extends "security-service-namespace" | "resource-namespace" | "missing-path-param" | "duplicate-body-types" | "duplicate-header" | "duplicate-example" | "invalid-schema" | "union-null" | "union-unsupported" | "invalid-default" | "invalid-property-type-for-collection-format" | "invalid-collection-format" | "non-recommended-collection-format" | "invalid-multi-collection-format" | "inline-cycle" | "example-loading", M extends keyof {
+    "security-service-namespace": {
+        readonly default: "Cannot add security details to a namespace other than the service namespace.";
+    };
+    "resource-namespace": {
+        readonly default: "Resource goes on namespace";
+    };
+    "missing-path-param": {
+        readonly default: import("@typespec/compiler").CallableMessage<["param"]>;
+    };
+    "duplicate-body-types": {
+        readonly default: "Request has multiple body types";
+    };
+    "duplicate-header": {
+        readonly default: import("@typespec/compiler").CallableMessage<["header"]>;
+    };
+    "duplicate-example": {
+        readonly default: "Duplicate @example declarations on operation";
+    };
+    "invalid-schema": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "union-null": {
+        readonly default: "Cannot have a union containing only null types.";
+    };
+    "union-unsupported": {
+        readonly default: "Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.";
+        readonly null: "Unions containing multiple model types cannot be emitted to OpenAPI v2 unless the union is between one model type and 'null'.";
+    };
+    "invalid-default": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "invalid-property-type-for-collection-format": {
+        readonly default: "The collectionFormat can only be applied to model property with type 'string[]'.";
+    };
+    "invalid-collection-format": {
+        readonly default: "The format should be one of 'csv','ssv','tsv','pipes' and 'multi'.";
+    };
+    "non-recommended-collection-format": {
+        readonly default: "The recommendation of collection format are 'csv' and 'multi'.";
+    };
+    "invalid-multi-collection-format": {
+        readonly default: "The 'multi' should be applied to parameter in 'query', 'header' or 'formData'.";
+    };
+    "inline-cycle": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "example-loading": {
+        readonly default: import("@typespec/compiler").CallableMessage<["filename"]>;
+        readonly noDirectory: import("@typespec/compiler").CallableMessage<["directory"]>;
+        readonly noOperationId: import("@typespec/compiler").CallableMessage<["filename"]>;
+    };
+}[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{
+    "security-service-namespace": {
+        readonly default: "Cannot add security details to a namespace other than the service namespace.";
+    };
+    "resource-namespace": {
+        readonly default: "Resource goes on namespace";
+    };
+    "missing-path-param": {
+        readonly default: import("@typespec/compiler").CallableMessage<["param"]>;
+    };
+    "duplicate-body-types": {
+        readonly default: "Request has multiple body types";
+    };
+    "duplicate-header": {
+        readonly default: import("@typespec/compiler").CallableMessage<["header"]>;
+    };
+    "duplicate-example": {
+        readonly default: "Duplicate @example declarations on operation";
+    };
+    "invalid-schema": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "union-null": {
+        readonly default: "Cannot have a union containing only null types.";
+    };
+    "union-unsupported": {
+        readonly default: "Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.";
+        readonly null: "Unions containing multiple model types cannot be emitted to OpenAPI v2 unless the union is between one model type and 'null'.";
+    };
+    "invalid-default": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "invalid-property-type-for-collection-format": {
+        readonly default: "The collectionFormat can only be applied to model property with type 'string[]'.";
+    };
+    "invalid-collection-format": {
+        readonly default: "The format should be one of 'csv','ssv','tsv','pipes' and 'multi'.";
+    };
+    "non-recommended-collection-format": {
+        readonly default: "The recommendation of collection format are 'csv' and 'multi'.";
+    };
+    "invalid-multi-collection-format": {
+        readonly default: "The 'multi' should be applied to parameter in 'query', 'header' or 'formData'.";
+    };
+    "inline-cycle": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
+    };
+    "example-loading": {
+        readonly default: import("@typespec/compiler").CallableMessage<["filename"]>;
+        readonly noDirectory: import("@typespec/compiler").CallableMessage<["directory"]>;
+        readonly noOperationId: import("@typespec/compiler").CallableMessage<["filename"]>;
+    };
+}, C, M>) => void, createStateSymbol: (name: string) => symbol, getTracer: (program: import("@typespec/compiler").Program) => import("@typespec/compiler").Tracer;
+//# sourceMappingURL=lib.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AA8HD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAAgC,CAAC;AAClD,eAAO,MAAQ,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAAE,iBAAiB,4BAAE,SAAS,wFAAS,CAAC"}

package/dist/src/lib.js

@@ -0,0 +1,125 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+const EmitterOptionsSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        "output-dir": { type: "string", nullable: true },
+        "output-file": { type: "string", nullable: true },
+        "examples-directory": { type: "string", nullable: true },
+        version: { type: "string", nullable: true },
+        "azure-resource-provider-folder": { type: "string", nullable: true },
+        "new-line": { type: "string", enum: ["crlf", "lf"], nullable: true },
+        "omit-unreachable-types": { type: "boolean", nullable: true },
+    },
+    required: [],
+};
+const libDef = {
+    name: "@azure-tools/typespec-autorest",
+    diagnostics: {
+        "security-service-namespace": {
+            severity: "error",
+            messages: {
+                default: "Cannot add security details to a namespace other than the service namespace.",
+            },
+        },
+        "resource-namespace": {
+            severity: "error",
+            messages: {
+                default: "Resource goes on namespace",
+            },
+        },
+        "missing-path-param": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Path contains parameter ${"param"} but wasn't found in given parameters`,
+            },
+        },
+        "duplicate-body-types": {
+            severity: "error",
+            messages: {
+                default: "Request has multiple body types",
+            },
+        },
+        "duplicate-header": {
+            severity: "error",
+            messages: {
+                default: paramMessage `The header ${"header"} is defined across multiple content types`,
+            },
+        },
+        "duplicate-example": {
+            severity: "error",
+            messages: {
+                default: "Duplicate @example declarations on operation",
+            },
+        },
+        "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.",
+                null: "Unions containing multiple model types cannot be emitted to OpenAPI v2 unless the union is between one model type and 'null'.",
+            },
+        },
+        "invalid-default": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Invalid type '${"type"}' for a default value`,
+            },
+        },
+        "invalid-property-type-for-collection-format": {
+            severity: "error",
+            messages: {
+                default: "The collectionFormat can only be applied to model property with type 'string[]'.",
+            },
+        },
+        "invalid-collection-format": {
+            severity: "error",
+            messages: {
+                default: "The format should be one of 'csv','ssv','tsv','pipes' and 'multi'.",
+            },
+        },
+        "non-recommended-collection-format": {
+            severity: "warning",
+            messages: {
+                default: "The recommendation of collection format are 'csv' and 'multi'.",
+            },
+        },
+        "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.`,
+            },
+        },
+        "example-loading": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Skipped loading invalid example file: ${"filename"}.`,
+                noDirectory: paramMessage `Skipping example loading from ${"directory"} because there was an error reading the directory.`,
+                noOperationId: paramMessage `Skipping example file ${"filename"} because it does not contain an operationId and/or title.`,
+            },
+        },
+    },
+    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;AA0BzF,MAAM,oBAAoB,GAA2C;IACnE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACjD,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3C,gCAAgC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE,wBAAwB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC9D;IACD,QAAQ,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,gCAAgC;IACtC,WAAW,EAAE;QACX,4BAA4B,EAAE;YAC5B,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,8EAA8E;aACxF;SACF;QACD,oBAAoB,EAAE;YACpB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,4BAA4B;aACtC;SACF;QACD,oBAAoB,EAAE;YACpB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,2BAA2B,OAAO,uCAAuC;aAC/F;SACF;QACD,sBAAsB,EAAE;YACtB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,iCAAiC;aAC3C;SACF;QACD,kBAAkB,EAAE;YAClB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,cAAc,QAAQ,2CAA2C;aACvF;SACF;QACD,mBAAmB,EAAE;YACnB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,8CAA8C;aACxD;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,IAAI,EAAE,+HAA+H;aACtI;SACF;QACD,iBAAiB,EAAE;YACjB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,iBAAiB,MAAM,uBAAuB;aACpE;SACF;QACD,6CAA6C,EAAE;YAC7C,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,kFAAkF;aAC5F;SACF;QACD,2BAA2B,EAAE;YAC3B,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,oEAAoE;aAC9E;SACF;QACD,mCAAmC,EAAE;YACnC,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,gEAAgE;aAC1E;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,iBAAiB,EAAE;YACjB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,yCAAyC,UAAU,GAAG;gBAC3E,WAAW,EAAE,YAAY,CAAA,iCAAiC,WAAW,oDAAoD;gBACzH,aAAa,EAAE,YAAY,CAAA,yBAAyB,UAAU,2DAA2D;aAC1H;SACF;KACF;IACD,OAAO,EAAE;QACP,OAAO,EAAE,oBAA8D;KACxE;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"}