@azure-tools/typespec-ts 0.11.0 → 0.12.0-alpha.20230501.1

package/test/integration/generated/resiliency/srvDriven2/tspconfig.yaml

@@ -1,10 +1,14 @@
-emitters:
-  "../../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     generateMetadata: true
     generateTest: false
     addCredentials: false
     azureSdkForJs: false
     isCadlTest: true
+    title: ServiceDrivenNewClient
     packageDetails:
       name: "@msinternal/srv-driven-2"
       description: "Srv Driven 2 Test Service"

package/test/integration/generated/server/path/multiple/src/clientDefinitions.ts

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  NoOperationParamsParameters,
+  WithOperationPathParamParameters,
+} from "./parameters";
+import {
+  NoOperationParams204Response,
+  WithOperationPathParam204Response,
+} from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface NoOperationParams {
+  get(
+    options?: NoOperationParamsParameters
+  ): StreamableMethod<NoOperationParams204Response>;
+}
+
+export interface WithOperationPathParam {
+  get(
+    options?: WithOperationPathParamParameters
+  ): StreamableMethod<WithOperationPathParam204Response>;
+}
+
+export interface Routes {
+  /** Resource for '/' has methods for the following verbs: get */
+  (path: "/"): NoOperationParams;
+  /** Resource for '/\{keyword\}' has methods for the following verbs: get */
+  (path: "/{keyword}", keyword: string): WithOperationPathParam;
+}
+
+export type MultipleParamInServerPathClient = Client & {
+  path: Routes;
+};

package/test/integration/generated/server/path/multiple/src/index.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import MultipleParamInServerPathClient from "./multipleParamInServerPathClient";
+
+export * from "./multipleParamInServerPathClient";
+export * from "./parameters";
+export * from "./responses";
+export * from "./clientDefinitions";
+
+export default MultipleParamInServerPathClient;

package/test/integration/generated/server/path/multiple/src/multipleParamInServerPathClient.ts

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { MultipleParamInServerPathClient } from "./clientDefinitions";
+
+export interface MultipleParamInServerPathClientOptions extends ClientOptions {
+  apiVersion?: string;
+}
+
+/**
+ * Initialize a new instance of `MultipleParamInServerPathClient`
+ * @param endpoint type: string, Pass in http://localhost:3000 for endpoint.
+ * @param options type: MultipleParamInServerPathClientOptions, the parameter for all optional parameters
+ */
+export default function createClient(
+  endpoint: string,
+  options: MultipleParamInServerPathClientOptions = {}
+): MultipleParamInServerPathClient {
+  const apiVersion = options.apiVersion ?? "v1.0";
+  const baseUrl =
+    options.baseUrl ?? `${endpoint}/server/path/multiple/${apiVersion}`;
+
+  const userAgentInfo = `azsdk-js-multipleparam-rest/1.0.0-beta.1`;
+  const userAgentPrefix =
+    options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+      : `${userAgentInfo}`;
+  options = {
+    ...options,
+    userAgentOptions: {
+      userAgentPrefix,
+    },
+  };
+
+  const client = getClient(baseUrl, options) as MultipleParamInServerPathClient;
+
+  return client;
+}

package/test/integration/generated/server/path/multiple/src/parameters.ts

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+
+export type NoOperationParamsParameters = RequestParameters;
+export type WithOperationPathParamParameters = RequestParameters;

package/test/integration/generated/server/path/multiple/src/responses.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { HttpResponse } from "@azure-rest/core-client";
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface NoOperationParams204Response extends HttpResponse {
+  status: "204";
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface WithOperationPathParam204Response extends HttpResponse {
+  status: "204";
+}

package/test/integration/generated/server/path/multiple/tspconfig.yaml

@@ -0,0 +1,14 @@
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
+    generateMetadata: false
+    generateTest: false
+    addCredentials: false
+    azureSdkForJs: false
+    isCadlTest: true
+    title: MultipleParamInServerPathClient
+    packageDetails:
+      name: "@msinternal/multipleparam"
+      description: "MultipleParameter Test Service"

package/test/integration/generated/server/path/single/src/clientDefinitions.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { MyOpParameters } from "./parameters";
+import { MyOp200Response } from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface MyOp {
+  head(options?: MyOpParameters): StreamableMethod<MyOp200Response>;
+}
+
+export interface Routes {
+  /** Resource for '/server/path/single/myOp' has methods for the following verbs: head */
+  (path: "/server/path/single/myOp"): MyOp;
+}
+
+export type SingleParamInServerPathClient = Client & {
+  path: Routes;
+};

package/test/integration/generated/server/path/single/src/index.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import SingleParamInServerPathClient from "./singleParamInServerPathClient";
+
+export * from "./singleParamInServerPathClient";
+export * from "./parameters";
+export * from "./responses";
+export * from "./clientDefinitions";
+
+export default SingleParamInServerPathClient;

package/test/integration/generated/server/path/single/src/parameters.ts

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+
+export type MyOpParameters = RequestParameters;

package/test/integration/generated/server/path/single/src/responses.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { HttpResponse } from "@azure-rest/core-client";
+
+/** The request has succeeded. */
+export interface MyOp200Response extends HttpResponse {
+  status: "200";
+}

package/test/integration/generated/server/path/single/src/singleParamInServerPathClient.ts

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

package/test/integration/generated/server/path/single/tspconfig.yaml

@@ -0,0 +1,14 @@
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
+    generateMetadata: false
+    generateTest: false
+    addCredentials: false
+    azureSdkForJs: false
+    isCadlTest: true
+    title: SingleParamInServerPathClient
+    packageDetails:
+      name: "@msinternal/singleparam"
+      description: "SingleParameter Test Service"

package/test/integration/generated/specialWords/tspconfig.yaml

@@ -1,5 +1,8 @@
-emitters:
-  "../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     generateMetadata: false
     generateTest: false
     addCredentials: false

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

@@ -38,14 +38,14 @@ export interface SendSecondNamedUnionValue {
 }
 
 export interface Routes {
-  /** Resource for '/unions/int' has methods for the following verbs: post */
-  (path: "/unions/int"): SendInt;
-  /** Resource for '/unions/int-array' has methods for the following verbs: post */
-  (path: "/unions/int-array"): SendIntArray;
-  /** Resource for '/unions/model1' has methods for the following verbs: post */
-  (path: "/unions/model1"): SendFirstNamedUnionValue;
-  /** Resource for '/unions/model2' has methods for the following verbs: post */
-  (path: "/unions/model2"): SendSecondNamedUnionValue;
+  /** Resource for '/type/union/int' has methods for the following verbs: post */
+  (path: "/type/union/int"): SendInt;
+  /** Resource for '/type/union/int-array' has methods for the following verbs: post */
+  (path: "/type/union/int-array"): SendIntArray;
+  /** Resource for '/type/union/model1' has methods for the following verbs: post */
+  (path: "/type/union/model1"): SendFirstNamedUnionValue;
+  /** Resource for '/type/union/model2' has methods for the following verbs: post */
+  (path: "/type/union/model2"): SendSecondNamedUnionValue;
 }
 
 export type UnionsClient = Client & {

package/test/integration/generated/unions/tspconfig.yaml

@@ -1,5 +1,8 @@
-emitters:
-  "../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     generateMetadata: false
     generateTest: false
     addCredentials: false

package/test/integration/internal.spec.ts

@@ -0,0 +1,43 @@
+import { assert } from "chai";
+import InternalClientFactory, {
+  InternalClient
+} from "./generated/internal/src/index.js";
+describe("Internal Rest Client", () => {
+  let client: InternalClient;
+
+  beforeEach(() => {
+    client = InternalClientFactory({
+      allowInsecureConnection: true,
+      retryOptions: {
+        maxRetries: 0
+      }
+    });
+  });
+
+  it("should get internal", async () => {
+    try {
+      const result = await client.path("/azure/client-generator-core/internal/getInternal").get({
+        queryParameters: {
+          name: "get internal"
+        }
+      });
+      assert.strictEqual(result.status, "200");
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should post internal", async () => {
+    try {
+      const result = await client.path("/azure/client-generator-core/internal/postInternal").post({
+        body: {
+          id: 1 as any,
+          name: "post internal name"
+        }
+      });
+      assert.strictEqual(result.status, "200");
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+});

package/test/integration/lroCore.spec.ts

@@ -0,0 +1,89 @@
+import SpecsAzureCoreLroStandardClientFactory, {
+  SpecsAzureCoreLroStandardClient,
+  getLongRunningPoller,
+  isUnexpected
+} from "./generated/lro/lroCore/src/index.js";
+import { assert } from "chai";
+describe("AzureLroCoreClient Rest Client", () => {
+  let client: SpecsAzureCoreLroStandardClient;
+
+  beforeEach(() => {
+    client = SpecsAzureCoreLroStandardClientFactory({
+      allowInsecureConnection: true
+    });
+  });
+
+  it("should put LRO response", async () => {
+    try {
+      const initalResponse = await client
+        .path("/azure/core/lro/standard/users/{name}", "madge")
+        .put({
+          body: {
+            role: "contributor"
+          }
+        });
+      const poller = await getLongRunningPoller(client, initalResponse);
+      const result = await poller.pollUntilDone();
+      assert.equal(result.status, "200");
+      assert.strictEqual(initalResponse.status, "201");
+      if (isUnexpected(result)) {
+        throw Error("Unexpected status code");
+      }
+      assert.equal(result.status, "200");
+      if (result.status === "200") {
+        assert.equal(result.body.name, "madge");
+      }
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should delete LRO response", async () => {
+    try {
+      const initalResponse = await client
+        .path("/azure/core/lro/standard/users/{name}", "madge")
+        .delete({
+          body: {
+            role: "contributor"
+          }
+        });
+      const poller = await getLongRunningPoller(client, initalResponse);
+      const result = await poller.pollUntilDone();
+      assert.equal(result.status, "200");
+      assert.strictEqual(initalResponse.status, "202");
+      if (isUnexpected(result)) {
+        throw Error("Unexpected status code");
+      }
+      if (result.status === "200") {
+        assert.equal(result.body.status, "Succeeded");
+      }
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should export LRO response", async () => {
+    try {
+      const initalResponse = await client
+        .path("/azure/core/lro/standard/users/{name}:export", "madge")
+        .post({
+          queryParameters: {
+            format: "json"
+          }
+        });
+      const poller = await getLongRunningPoller(client, initalResponse);
+      const result = await poller.pollUntilDone();
+      assert.equal(result.status, "200");
+      assert.strictEqual(initalResponse.status, "202");
+      if (isUnexpected(result)) {
+        throw Error("Unexpected status code");
+      }
+      assert.equal(result.status, "200", "final status code");
+      if (result.status === "200") {
+        assert.equal(result.body.result?.name, "madge");
+      }
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+});

package/test/integration/modelInheritance.spec.ts

@@ -1,15 +1,15 @@
-import ModelsInheritanceClientFactory, {
-  ModelsInheritanceClient,
+import TypeModelInheritanceClientFactory, {
+  TypeModelInheritanceClient,
   Salmon,
   SharkOutput
 } from "./generated/models/inheritance/src/index.js";
 import { assert } from "chai";
 
 describe("ModelsInheritance Rest Client", () => {
-  let client: ModelsInheritanceClient;
+  let client: TypeModelInheritanceClient;
 
   beforeEach(() => {
-    client = ModelsInheritanceClientFactory({
+    client = TypeModelInheritanceClientFactory({
       allowInsecureConnection: true
     });
   });
@@ -17,7 +17,7 @@ describe("ModelsInheritance Rest Client", () => {
   const validBody = { name: "abc", age: 32, smart: true };
   it("should get valid", async () => {
     try {
-      const result = await client.path("/models/inheritance/valid").get();
+      const result = await client.path("/type/model/inheritance/valid").get();
       assert.strictEqual(result.status, "200");
       assert.strictEqual(result.body.age, 32);
       assert.strictEqual(result.body.name, "abc");
@@ -29,7 +29,7 @@ describe("ModelsInheritance Rest Client", () => {
 
   it("should put valid", async () => {
     try {
-      const result = await client.path("/models/inheritance/valid").put({
+      const result = await client.path("/type/model/inheritance/valid").put({
         body: validBody
       });
       assert.strictEqual(result.status, "200");
@@ -43,7 +43,7 @@ describe("ModelsInheritance Rest Client", () => {
 
   it("should post valid", async () => {
     try {
-      const result = await client.path("/models/inheritance/valid").post({
+      const result = await client.path("/type/model/inheritance/valid").post({
         body: validBody
       });
       assert.strictEqual(result.status, "200");
@@ -55,7 +55,7 @@ describe("ModelsInheritance Rest Client", () => {
   it("should get polymorphic body", async () => {
     try {
       const result = await client
-        .path("/models/inheritance/discriminated/model")
+        .path("/type/model/inheritance/discriminated/model")
         .get();
       assert.strictEqual(result.status, "200");
       assert.strictEqual(result.body.age, 1);
@@ -69,7 +69,7 @@ describe("ModelsInheritance Rest Client", () => {
   it("should put polymorphic body", async () => {
     try {
       const result = await client
-        .path("/models/inheritance/discriminated/model")
+        .path("/type/model/inheritance/discriminated/model")
         .put({
           body: {
             age: 1,
@@ -143,7 +143,7 @@ describe("ModelsInheritance Rest Client", () => {
   it("should get recursive body", async () => {
     try {
       const result = await client
-        .path("/models/inheritance/discriminated/recursivemodel")
+        .path("/type/model/inheritance/discriminated/recursivemodel")
         .get();
       assert.strictEqual(result.status, "200");
       assert.strictEqual(JSON.stringify(result.body), JSON.stringify(validRecursiveBody));
@@ -155,7 +155,7 @@ describe("ModelsInheritance Rest Client", () => {
   it("should put recursive body", async () => {
     try {
       const result = await client
-        .path("/models/inheritance/discriminated/recursivemodel")
+        .path("/type/model/inheritance/discriminated/recursivemodel")
         .put({
             body: validRecursiveBody as Salmon
         });
@@ -168,7 +168,7 @@ describe("ModelsInheritance Rest Client", () => {
   it("should get missing discriminator body", async () => {
     try {
       const result = await client
-        .path("/models/inheritance/discriminated/missingdiscriminator")
+        .path("/type/model/inheritance/discriminated/missingdiscriminator")
         .get();
       assert.strictEqual(result.status, "200");
       assert.strictEqual(result.body.age, 1);
@@ -180,7 +180,7 @@ describe("ModelsInheritance Rest Client", () => {
   it("should get wrong discriminator body", async () => {
     try {
       const result = await client
-        .path("/models/inheritance/discriminated/wrongdiscriminator")
+        .path("/type/model/inheritance/discriminated/wrongdiscriminator")
         .get();
       assert.strictEqual(result.status, "200");
       assert.strictEqual(result.body.age, 1);

package/test/integration/modelPropertyNullable.spec.ts

@@ -0,0 +1,115 @@
+import { assert } from "chai";
+import TypePropertyNullableClientFactory, {
+  TypePropertyNullableClient
+} from "./generated/models/propertyNullable/src/index.js";
+import { matrix } from "../util/matrix.js";
+
+interface TypeDetail {
+  type: string;
+  defaultValue: any;
+  convertedToFn?: (_: any) => any;
+}
+
+const testedTypes: TypeDetail[] = [
+  {
+    type: "string",
+    defaultValue: "hello"
+  },
+  {
+    type: "bytes",
+    defaultValue: "aGVsbG8sIHdvcmxkIQ=="
+  },
+  {
+    type: "datetime",
+    defaultValue: "2022-08-26T18:38:00Z"
+  },
+  {
+    type: "duration",
+    defaultValue: "P123DT22H14M12.011S"
+  },
+  {
+    type: "collections/bytes",
+    defaultValue: ["aGVsbG8sIHdvcmxkIQ==", "aGVsbG8sIHdvcmxkIQ=="]
+  },
+  {
+    type: "collections/model",
+    defaultValue: [{ property: "hello" }, { property: "world" }]
+  }
+];
+describe("ModelsPropertyNullableClient Rest Client", () => {
+  let client: TypePropertyNullableClient;
+
+  beforeEach(() => {
+    client = TypePropertyNullableClientFactory({
+      allowInsecureConnection: true
+    });
+  });
+
+  matrix([testedTypes], async (params: TypeDetail) => {
+    it(`should get a null value for nullable ${params.type}`, async () => {
+      try {
+        const result = await client
+          .path(`/type/property/nullable/${params.type}/null` as any)
+          .get();
+        assert.strictEqual(result.status, "200");
+        assert.strictEqual(result.body.nullableProperty, null);
+        assert.deepEqual(result.body.requiredProperty, "foo");
+      } catch (err) {
+        assert.fail(err as string);
+      }
+    });
+
+    it(`should get a non-null value for nullable ${params.type}`, async () => {
+      try {
+        const result = await client
+          .path(`/type/property/nullable/${params.type}/non-null` as any)
+          .get();
+        assert.strictEqual(result.status, "200");
+        assert.deepEqual(result.body.nullableProperty, params.defaultValue);
+        assert.deepEqual(result.body.requiredProperty, "foo");
+      } catch (err) {
+        assert.fail(err as string);
+      }
+    });
+
+    it(`should patch a null value for nullable ${params.type}`, async () => {
+      try {
+        const result = await client
+          .path(`/type/property/nullable/${params.type}/null` as any)
+          .patch({
+            contentType: "application/merge-patch+json",
+            body: {
+              requiredProperty: "foo",
+              nullableProperty: null
+            }
+          });
+        assert.strictEqual(result.status, "204");
+      } catch (err) {
+        assert.fail(err as string);
+      }
+    });
+
+    it(`should patch a non-null value for nullable ${params.type}`, async () => {
+      try {
+        let property;
+        if (params.convertedToFn) {
+          property = params.convertedToFn(params.defaultValue);
+        } else {
+          property = params.defaultValue;
+        }
+        const result = await client
+          .path(`/type/property/nullable/${params.type}/non-null` as any)
+          .patch({
+            contentType: "application/merge-patch+json",
+            body: {
+              requiredProperty: "foo",
+              nullableProperty: property || null
+            }
+          });
+        assert.strictEqual(result.status, "204");
+      } catch (err) {
+        assert.fail(err as string);
+      }
+    });
+  });
+});