@azure-tools/typespec-ts 0.11.0

package/test/integration/generated/dictionary/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "plugins": ["@azure/azure-sdk"],
+  "extends": ["plugin:@azure/azure-sdk/azure-sdk-base"],
+  "rules": {
+    "@azure/azure-sdk/ts-modules-only-named": "warn",
+    "@azure/azure-sdk/ts-apiextractor-json-types": "warn",
+    "@azure/azure-sdk/ts-package-json-types": "warn",
+    "@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
+    "tsdoc/syntax": "warn"
+  }
+}

package/test/integration/generated/dictionary/README.md

@@ -0,0 +1,56 @@
+# Dict REST client library for JavaScript
+
+Illustrates various of dictionaries.
+
+**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/dictionary)
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
+
+### Install the `@msinternal/dictionary` package
+
+Install the Dict REST client REST client library for JavaScript with `npm`:
+
+```bash
+npm install @msinternal/dictionary
+```
+
+### Create and authenticate a `DictClient`
+
+To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
+provide an instance of the desired credential type obtained from the
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) 
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```javascript
+const { setLogLevel } = require("@azure/logger");
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

package/test/integration/generated/dictionary/api-extractor.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "./types/index.d.ts",
+  "docModel": { "enabled": true },
+  "apiReport": { "enabled": true, "reportFolder": "./review" },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "./types/dictionary.d.ts"
+  },
+  "messages": {
+    "tsdocMessageReporting": { "default": { "logLevel": "none" } },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": { "logLevel": "none" },
+      "ae-unresolved-link": { "logLevel": "none" }
+    }
+  }
+}

package/test/integration/generated/dictionary/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@msinternal/dictionary",
+  "sdk-type": "client",
+  "author": "Microsoft Corporation",
+  "version": "1.0.0",
+  "description": "Dictionary Test Service",
+  "keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "./dist-esm/index.js",
+  "types": "./types/dictionary.d.ts",
+  "repository": "github:Azure/azure-sdk-for-js",
+  "bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
+  "files": [
+    "dist/",
+    "dist-esm/",
+    "types/dictionary.d.ts",
+    "README.md",
+    "LICENSE",
+    "review/*"
+  ],
+  "engines": { "node": ">=14.0.0" },
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build:browser": "echo skipped.",
+    "build:node": "echo skipped.",
+    "build:samples": "echo skipped.",
+    "build:test": "echo skipped.",
+    "build:debug": "echo skipped.",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\" ",
+    "clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+    "execute:samples": "echo skipped",
+    "extract-api": "rimraf review && mkdirp ./review && api-extractor run --local",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\" ",
+    "generate:client": "echo skipped",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "echo skipped",
+    "integration-test": "echo skipped",
+    "lint:fix": "eslint package.json api-extractor.json src  --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json src  --ext .ts",
+    "pack": "npm pack 2>&1",
+    "test:browser": "echo skipped",
+    "test:node": "echo skipped",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "unit-test": "echo skipped",
+    "unit-test:node": "echo skipped",
+    "unit-test:browser": "echo skipped",
+    "build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
+    "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js"
+  },
+  "sideEffects": false,
+  "autoPublish": false,
+  "dependencies": {
+    "@azure/core-auth": "^1.3.0",
+    "@azure-rest/core-client": "^1.1.0",
+    "@azure/core-rest-pipeline": "^1.8.0",
+    "@azure/logger": "^1.0.0",
+    "tslib": "^2.2.0"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.31.1",
+    "autorest": "latest",
+    "@types/node": "^14.0.0",
+    "dotenv": "^16.0.0",
+    "eslint": "^8.0.0",
+    "mkdirp": "^2.1.2",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.0",
+    "source-map-support": "^0.5.9",
+    "typescript": "~4.8.0",
+    "@rollup/plugin-commonjs": "^24.0.0",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-multi-entry": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "rollup": "^2.66.1",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "uglify-js": "^3.4.9"
+  },
+  "type": "module"
+}

package/test/integration/generated/dictionary/rollup.config.js

@@ -0,0 +1,118 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollup warning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEval(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+    (warning.id.includes("node_modules/nise") ||
+      warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependency(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer &&
+    warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"],
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true,
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"],
+      }),
+      cjs(),
+      json(),
+      sourcemaps(),
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false,
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false,
+};
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {}),
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies),
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve()],
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/test/integration/generated/dictionary/src/clientDefinitions.ts

@@ -0,0 +1,165 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  Int32ValueGetParameters,
+  Int32ValuePutParameters,
+  Int64ValueGetParameters,
+  Int64ValuePutParameters,
+  BooleanValueGetParameters,
+  BooleanValuePutParameters,
+  StringValueGetParameters,
+  StringValuePutParameters,
+  Float32ValueGetParameters,
+  Float32ValuePutParameters,
+  DatetimeValueGetParameters,
+  DatetimeValuePutParameters,
+  DurationValueGetParameters,
+  DurationValuePutParameters,
+  UnknownValueGetParameters,
+  UnknownValuePutParameters,
+  ModelValueGetParameters,
+  ModelValuePutParameters,
+  RecursiveModelValueGetParameters,
+  RecursiveModelValuePutParameters,
+} from "./parameters";
+import {
+  Int32ValueGet200Response,
+  Int32ValuePut204Response,
+  Int64ValueGet200Response,
+  Int64ValuePut204Response,
+  BooleanValueGet200Response,
+  BooleanValuePut204Response,
+  StringValueGet200Response,
+  StringValuePut204Response,
+  Float32ValueGet200Response,
+  Float32ValuePut204Response,
+  DatetimeValueGet200Response,
+  DatetimeValuePut204Response,
+  DurationValueGet200Response,
+  DurationValuePut204Response,
+  UnknownValueGet200Response,
+  UnknownValuePut204Response,
+  ModelValueGet200Response,
+  ModelValuePut204Response,
+  RecursiveModelValueGet200Response,
+  RecursiveModelValuePut204Response,
+} from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface Int32ValueGet {
+  get(
+    options?: Int32ValueGetParameters
+  ): StreamableMethod<Int32ValueGet200Response>;
+  put(
+    options: Int32ValuePutParameters
+  ): StreamableMethod<Int32ValuePut204Response>;
+}
+
+export interface Int64ValueGet {
+  get(
+    options?: Int64ValueGetParameters
+  ): StreamableMethod<Int64ValueGet200Response>;
+  put(
+    options: Int64ValuePutParameters
+  ): StreamableMethod<Int64ValuePut204Response>;
+}
+
+export interface BooleanValueGet {
+  get(
+    options?: BooleanValueGetParameters
+  ): StreamableMethod<BooleanValueGet200Response>;
+  put(
+    options: BooleanValuePutParameters
+  ): StreamableMethod<BooleanValuePut204Response>;
+}
+
+export interface StringValueGet {
+  get(
+    options?: StringValueGetParameters
+  ): StreamableMethod<StringValueGet200Response>;
+  put(
+    options: StringValuePutParameters
+  ): StreamableMethod<StringValuePut204Response>;
+}
+
+export interface Float32ValueGet {
+  get(
+    options?: Float32ValueGetParameters
+  ): StreamableMethod<Float32ValueGet200Response>;
+  put(
+    options: Float32ValuePutParameters
+  ): StreamableMethod<Float32ValuePut204Response>;
+}
+
+export interface DatetimeValueGet {
+  get(
+    options?: DatetimeValueGetParameters
+  ): StreamableMethod<DatetimeValueGet200Response>;
+  put(
+    options: DatetimeValuePutParameters
+  ): StreamableMethod<DatetimeValuePut204Response>;
+}
+
+export interface DurationValueGet {
+  get(
+    options?: DurationValueGetParameters
+  ): StreamableMethod<DurationValueGet200Response>;
+  put(
+    options: DurationValuePutParameters
+  ): StreamableMethod<DurationValuePut204Response>;
+}
+
+export interface UnknownValueGet {
+  get(
+    options?: UnknownValueGetParameters
+  ): StreamableMethod<UnknownValueGet200Response>;
+  put(
+    options: UnknownValuePutParameters
+  ): StreamableMethod<UnknownValuePut204Response>;
+}
+
+export interface ModelValueGet {
+  get(
+    options?: ModelValueGetParameters
+  ): StreamableMethod<ModelValueGet200Response>;
+  put(
+    options: ModelValuePutParameters
+  ): StreamableMethod<ModelValuePut204Response>;
+}
+
+export interface RecursiveModelValueGet {
+  get(
+    options?: RecursiveModelValueGetParameters
+  ): StreamableMethod<RecursiveModelValueGet200Response>;
+  put(
+    options: RecursiveModelValuePutParameters
+  ): StreamableMethod<RecursiveModelValuePut204Response>;
+}
+
+export interface Routes {
+  /** Resource for '/dictionary/int32' has methods for the following verbs: get, put */
+  (path: "/dictionary/int32"): Int32ValueGet;
+  /** Resource for '/dictionary/int64' has methods for the following verbs: get, put */
+  (path: "/dictionary/int64"): Int64ValueGet;
+  /** Resource for '/dictionary/boolean' has methods for the following verbs: get, put */
+  (path: "/dictionary/boolean"): BooleanValueGet;
+  /** Resource for '/dictionary/string' has methods for the following verbs: get, put */
+  (path: "/dictionary/string"): StringValueGet;
+  /** Resource for '/dictionary/float32' has methods for the following verbs: get, put */
+  (path: "/dictionary/float32"): Float32ValueGet;
+  /** Resource for '/dictionary/datetime' has methods for the following verbs: get, put */
+  (path: "/dictionary/datetime"): DatetimeValueGet;
+  /** Resource for '/dictionary/duration' has methods for the following verbs: get, put */
+  (path: "/dictionary/duration"): DurationValueGet;
+  /** Resource for '/dictionary/unknown' has methods for the following verbs: get, put */
+  (path: "/dictionary/unknown"): UnknownValueGet;
+  /** Resource for '/dictionary/model' has methods for the following verbs: get, put */
+  (path: "/dictionary/model"): ModelValueGet;
+  /** Resource for '/dictionary/model/recursive' has methods for the following verbs: get, put */
+  (path: "/dictionary/model/recursive"): RecursiveModelValueGet;
+}
+
+export type DictClient = Client & {
+  path: Routes;
+};

package/test/integration/generated/dictionary/src/dictClient.ts

@@ -0,0 +1,29 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { DictClient } from "./clientDefinitions";
+
+/**
+ * Initialize a new instance of `DictClient`
+ * @param options type: ClientOptions, the parameter for all optional parameters
+ */
+export default function createClient(options: ClientOptions = {}): DictClient {
+  const baseUrl = options.baseUrl ?? `http://localhost:3000`;
+  options.apiVersion = options.apiVersion ?? "1.0.0";
+  const userAgentInfo = `azsdk-js-dictionary-rest/1.0.0`;
+  const userAgentPrefix =
+    options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+      : `${userAgentInfo}`;
+  options = {
+    ...options,
+    userAgentOptions: {
+      userAgentPrefix,
+    },
+  };
+
+  const client = getClient(baseUrl, options) as DictClient;
+
+  return client;
+}

package/test/integration/generated/dictionary/src/index.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import DictClient from "./dictClient";
+
+export * from "./dictClient";
+export * from "./parameters";
+export * from "./responses";
+export * from "./clientDefinitions";
+export * from "./models";
+export * from "./outputModels";
+
+export default DictClient;

package/test/integration/generated/dictionary/src/models.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Dictionary inner model */
+export interface InnerModel {
+  /** Required string property */
+  property: string;
+  children?: Record<string, InnerModel>;
+}

package/test/integration/generated/dictionary/src/outputModels.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Dictionary inner model */
+export interface InnerModelOutput {
+  /** Required string property */
+  property: string;
+  children?: Record<string, InnerModelOutput>;
+}

package/test/integration/generated/dictionary/src/parameters.ts

@@ -0,0 +1,86 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+import { InnerModel } from "./models";
+
+export type Int32ValueGetParameters = RequestParameters;
+
+export interface Int32ValuePutBodyParam {
+  body: Record<string, number>;
+}
+
+export type Int32ValuePutParameters = Int32ValuePutBodyParam &
+  RequestParameters;
+export type Int64ValueGetParameters = RequestParameters;
+
+export interface Int64ValuePutBodyParam {
+  body: Record<string, number>;
+}
+
+export type Int64ValuePutParameters = Int64ValuePutBodyParam &
+  RequestParameters;
+export type BooleanValueGetParameters = RequestParameters;
+
+export interface BooleanValuePutBodyParam {
+  body: Record<string, boolean>;
+}
+
+export type BooleanValuePutParameters = BooleanValuePutBodyParam &
+  RequestParameters;
+export type StringValueGetParameters = RequestParameters;
+
+export interface StringValuePutBodyParam {
+  body: Record<string, string>;
+}
+
+export type StringValuePutParameters = StringValuePutBodyParam &
+  RequestParameters;
+export type Float32ValueGetParameters = RequestParameters;
+
+export interface Float32ValuePutBodyParam {
+  body: Record<string, number>;
+}
+
+export type Float32ValuePutParameters = Float32ValuePutBodyParam &
+  RequestParameters;
+export type DatetimeValueGetParameters = RequestParameters;
+
+export interface DatetimeValuePutBodyParam {
+  body: Record<string, string>;
+}
+
+export type DatetimeValuePutParameters = DatetimeValuePutBodyParam &
+  RequestParameters;
+export type DurationValueGetParameters = RequestParameters;
+
+export interface DurationValuePutBodyParam {
+  body: Record<string, string>;
+}
+
+export type DurationValuePutParameters = DurationValuePutBodyParam &
+  RequestParameters;
+export type UnknownValueGetParameters = RequestParameters;
+
+export interface UnknownValuePutBodyParam {
+  body: Record<string, unknown>;
+}
+
+export type UnknownValuePutParameters = UnknownValuePutBodyParam &
+  RequestParameters;
+export type ModelValueGetParameters = RequestParameters;
+
+export interface ModelValuePutBodyParam {
+  body: Record<string, InnerModel>;
+}
+
+export type ModelValuePutParameters = ModelValuePutBodyParam &
+  RequestParameters;
+export type RecursiveModelValueGetParameters = RequestParameters;
+
+export interface RecursiveModelValuePutBodyParam {
+  body: Record<string, InnerModel>;
+}
+
+export type RecursiveModelValuePutParameters = RecursiveModelValuePutBodyParam &
+  RequestParameters;