@azure-tools/typespec-ts 0.11.0

package/test/integration/generated/models/propertyOptional/src/index.ts

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

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

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Template type for testing models with optional property. Pass in the type of the property you are looking for */
+export interface StringProperty {
+  /** Property */
+  property?: string;
+}
+
+/** Template type for testing models with optional property. Pass in the type of the property you are looking for */
+export interface BytesProperty {
+  /** Property */
+  property?: string;
+}
+
+/** Model with a datetime property */
+export interface DatetimeProperty {
+  /** Property */
+  property?: Date | string;
+}
+
+/** Model with a duration property */
+export interface DurationProperty {
+  /** Property */
+  property?: string;
+}
+
+/** Model with collection bytes properties */
+export interface CollectionsByteProperty {
+  /** Property */
+  property?: string[];
+}
+
+/** Model with collection models properties */
+export interface CollectionsModelProperty {
+  /** Property */
+  property?: Array<StringProperty>;
+}
+
+/** Model with required and optional properties */
+export interface RequiredAndOptionalProperty {
+  /** optional string property */
+  optionalProperty?: string;
+  /** required int property */
+  requiredProperty: number;
+}

package/test/integration/generated/models/propertyOptional/src/modelsPropertyOptional.ts

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { ModelsPropertyOptionalClient } from "./clientDefinitions";
+
+/**
+ * Initialize a new instance of `ModelsPropertyOptionalClient`
+ * @param options type: ClientOptions, the parameter for all optional parameters
+ */
+export default function createClient(
+  options: ClientOptions = {}
+): ModelsPropertyOptionalClient {
+  const baseUrl = options.baseUrl ?? `http://localhost:3000`;
+  options.apiVersion = options.apiVersion ?? "1.0.0";
+  const userAgentInfo = `azsdk-js-optional-property-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 ModelsPropertyOptionalClient;
+
+  return client;
+}

package/test/integration/generated/models/propertyOptional/src/outputModels.ts

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Template type for testing models with optional property. Pass in the type of the property you are looking for */
+export interface StringPropertyOutput {
+  /** Property */
+  property?: string;
+}
+
+/** Template type for testing models with optional property. Pass in the type of the property you are looking for */
+export interface BytesPropertyOutput {
+  /** Property */
+  property?: string;
+}
+
+/** Model with a datetime property */
+export interface DatetimePropertyOutput {
+  /** Property */
+  property?: string;
+}
+
+/** Model with a duration property */
+export interface DurationPropertyOutput {
+  /** Property */
+  property?: string;
+}
+
+/** Model with collection bytes properties */
+export interface CollectionsBytePropertyOutput {
+  /** Property */
+  property?: string[];
+}
+
+/** Model with collection models properties */
+export interface CollectionsModelPropertyOutput {
+  /** Property */
+  property?: Array<StringPropertyOutput>;
+}
+
+/** Model with required and optional properties */
+export interface RequiredAndOptionalPropertyOutput {
+  /** optional string property */
+  optionalProperty?: string;
+  /** required int property */
+  requiredProperty: number;
+}

package/test/integration/generated/models/propertyOptional/src/parameters.ts

@@ -0,0 +1,124 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+import {
+  StringProperty,
+  BytesProperty,
+  DatetimeProperty,
+  DurationProperty,
+  CollectionsByteProperty,
+  CollectionsModelProperty,
+  RequiredAndOptionalProperty,
+} from "./models";
+
+export type StringGetAllParameters = RequestParameters;
+export type StringGetDefaultParameters = RequestParameters;
+
+export interface StringPutAllBodyParam {
+  body: StringProperty;
+}
+
+export type StringPutAllParameters = StringPutAllBodyParam & RequestParameters;
+
+export interface StringPutDefaultBodyParam {
+  body: StringProperty;
+}
+
+export type StringPutDefaultParameters = StringPutDefaultBodyParam &
+  RequestParameters;
+export type BytesGetAllParameters = RequestParameters;
+export type BytesGetDefaultParameters = RequestParameters;
+
+export interface BytesPutAllBodyParam {
+  body: BytesProperty;
+}
+
+export type BytesPutAllParameters = BytesPutAllBodyParam & RequestParameters;
+
+export interface BytesPutDefaultBodyParam {
+  body: BytesProperty;
+}
+
+export type BytesPutDefaultParameters = BytesPutDefaultBodyParam &
+  RequestParameters;
+export type DatetimeGetAllParameters = RequestParameters;
+export type DatetimeGetDefaultParameters = RequestParameters;
+
+export interface DatetimePutAllBodyParam {
+  body: DatetimeProperty;
+}
+
+export type DatetimePutAllParameters = DatetimePutAllBodyParam &
+  RequestParameters;
+
+export interface DatetimePutDefaultBodyParam {
+  body: DatetimeProperty;
+}
+
+export type DatetimePutDefaultParameters = DatetimePutDefaultBodyParam &
+  RequestParameters;
+export type DurationGetAllParameters = RequestParameters;
+export type DurationGetDefaultParameters = RequestParameters;
+
+export interface DurationPutAllBodyParam {
+  body: DurationProperty;
+}
+
+export type DurationPutAllParameters = DurationPutAllBodyParam &
+  RequestParameters;
+
+export interface DurationPutDefaultBodyParam {
+  body: DurationProperty;
+}
+
+export type DurationPutDefaultParameters = DurationPutDefaultBodyParam &
+  RequestParameters;
+export type CollectionsByteGetAllParameters = RequestParameters;
+export type CollectionsByteGetDefaultParameters = RequestParameters;
+
+export interface CollectionsBytePutAllBodyParam {
+  body: CollectionsByteProperty;
+}
+
+export type CollectionsBytePutAllParameters = CollectionsBytePutAllBodyParam &
+  RequestParameters;
+
+export interface CollectionsBytePutDefaultBodyParam {
+  body: CollectionsByteProperty;
+}
+
+export type CollectionsBytePutDefaultParameters =
+  CollectionsBytePutDefaultBodyParam & RequestParameters;
+export type CollectionsModelGetAllParameters = RequestParameters;
+export type CollectionsModelGetDefaultParameters = RequestParameters;
+
+export interface CollectionsModelPutAllBodyParam {
+  body: CollectionsModelProperty;
+}
+
+export type CollectionsModelPutAllParameters = CollectionsModelPutAllBodyParam &
+  RequestParameters;
+
+export interface CollectionsModelPutDefaultBodyParam {
+  body: CollectionsModelProperty;
+}
+
+export type CollectionsModelPutDefaultParameters =
+  CollectionsModelPutDefaultBodyParam & RequestParameters;
+export type RequiredAndOptionalGetAllParameters = RequestParameters;
+export type RequiredAndOptionalGetRequiredOnlyParameters = RequestParameters;
+
+export interface RequiredAndOptionalPutAllBodyParam {
+  body: RequiredAndOptionalProperty;
+}
+
+export type RequiredAndOptionalPutAllParameters =
+  RequiredAndOptionalPutAllBodyParam & RequestParameters;
+
+export interface RequiredAndOptionalPutRequiredOnlyBodyParam {
+  body: RequiredAndOptionalProperty;
+}
+
+export type RequiredAndOptionalPutRequiredOnlyParameters =
+  RequiredAndOptionalPutRequiredOnlyBodyParam & RequestParameters;

package/test/integration/generated/models/propertyOptional/src/responses.ts

@@ -0,0 +1,169 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { HttpResponse } from "@azure-rest/core-client";
+import {
+  StringPropertyOutput,
+  BytesPropertyOutput,
+  DatetimePropertyOutput,
+  DurationPropertyOutput,
+  CollectionsBytePropertyOutput,
+  CollectionsModelPropertyOutput,
+  RequiredAndOptionalPropertyOutput,
+} from "./outputModels";
+
+/** The request has succeeded. */
+export interface StringGetAll200Response extends HttpResponse {
+  status: "200";
+  body: StringPropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface StringGetDefault200Response extends HttpResponse {
+  status: "200";
+  body: StringPropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface StringPutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface StringPutDefault204Response extends HttpResponse {
+  status: "204";
+}
+
+/** The request has succeeded. */
+export interface BytesGetAll200Response extends HttpResponse {
+  status: "200";
+  body: BytesPropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface BytesGetDefault200Response extends HttpResponse {
+  status: "200";
+  body: BytesPropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface BytesPutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface BytesPutDefault204Response extends HttpResponse {
+  status: "204";
+}
+
+/** The request has succeeded. */
+export interface DatetimeGetAll200Response extends HttpResponse {
+  status: "200";
+  body: DatetimePropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface DatetimeGetDefault200Response extends HttpResponse {
+  status: "200";
+  body: DatetimePropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface DatetimePutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface DatetimePutDefault204Response extends HttpResponse {
+  status: "204";
+}
+
+/** The request has succeeded. */
+export interface DurationGetAll200Response extends HttpResponse {
+  status: "200";
+  body: DurationPropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface DurationGetDefault200Response extends HttpResponse {
+  status: "200";
+  body: DurationPropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface DurationPutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface DurationPutDefault204Response extends HttpResponse {
+  status: "204";
+}
+
+/** The request has succeeded. */
+export interface CollectionsByteGetAll200Response extends HttpResponse {
+  status: "200";
+  body: CollectionsBytePropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface CollectionsByteGetDefault200Response extends HttpResponse {
+  status: "200";
+  body: CollectionsBytePropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface CollectionsBytePutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface CollectionsBytePutDefault204Response extends HttpResponse {
+  status: "204";
+}
+
+/** The request has succeeded. */
+export interface CollectionsModelGetAll200Response extends HttpResponse {
+  status: "200";
+  body: CollectionsModelPropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface CollectionsModelGetDefault200Response extends HttpResponse {
+  status: "200";
+  body: CollectionsModelPropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface CollectionsModelPutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface CollectionsModelPutDefault204Response extends HttpResponse {
+  status: "204";
+}
+
+/** The request has succeeded. */
+export interface RequiredAndOptionalGetAll200Response extends HttpResponse {
+  status: "200";
+  body: RequiredAndOptionalPropertyOutput;
+}
+
+/** The request has succeeded. */
+export interface RequiredAndOptionalGetRequiredOnly200Response
+  extends HttpResponse {
+  status: "200";
+  body: RequiredAndOptionalPropertyOutput;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface RequiredAndOptionalPutAll204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface RequiredAndOptionalPutRequiredOnly204Response
+  extends HttpResponse {
+  status: "204";
+}

package/test/integration/generated/models/propertyOptional/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "module": "es6",
+    "lib": [],
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "strict": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "outDir": "./dist-esm",
+    "declarationDir": "./types"
+  },
+  "include": ["./src/**/*.ts"]
+}

package/test/integration/generated/models/propertyOptional/tspconfig.yaml

@@ -0,0 +1,11 @@
+emitters:
+  "../../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+    generateMetadata: true
+    generateTest: false
+    addCredentials: false
+    azureSdkForJs: false
+    isCadlTest: true
+    packageDetails:
+      name: "@msinternal/optional-property"
+      description: "Optional Property Test Service"
+      version: "1.0.0"

package/test/integration/generated/models/propertyTypes/.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/models/propertyTypes/README.md

@@ -0,0 +1,56 @@
+# ModelsPropertyTypes REST client library for JavaScript
+
+Illustrates various property types for models
+
+**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/property-types)
+
+## 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/property-types` package
+
+Install the ModelsPropertyTypes REST client REST client library for JavaScript with `npm`:
+
+```bash
+npm install @msinternal/property-types
+```
+
+### Create and authenticate a `ModelsPropertyTypesClient`
+
+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/models/propertyTypes/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/property-types.d.ts"
+  },
+  "messages": {
+    "tsdocMessageReporting": { "default": { "logLevel": "none" } },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": { "logLevel": "none" },
+      "ae-unresolved-link": { "logLevel": "none" }
+    }
+  }
+}

package/test/integration/generated/models/propertyTypes/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@msinternal/property-types",
+  "sdk-type": "client",
+  "author": "Microsoft Corporation",
+  "version": "1.0.0",
+  "description": "Property Types Test Service",
+  "keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "./dist-esm/index.js",
+  "types": "./types/property-types.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/property-types.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"
+}