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

package/test/integration/spreadParameters.spec.ts

@@ -0,0 +1,82 @@
+import ParametersSpreadClientFactory, {
+  ParametersSpreadClient
+} from "./generated/parameters/spread/src/index.js";
+import { assert } from "chai";
+describe("HelloClient Rest Client", () => {
+  let client: ParametersSpreadClient;
+
+  beforeEach(() => {
+    client = ParametersSpreadClientFactory({ allowInsecureConnection: true });
+  });
+
+  it("should spread named model", async () => {
+    try {
+      const result = await client
+        .path("/parameters/spread/model/request-body")
+        .put({
+          body: {
+            name: "foo"
+          }
+        });
+      assert.strictEqual(result.status, "204");
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should spread alias with only body param", async () => {
+    try {
+      const result = await client
+        .path("/parameters/spread/alias/request-body")
+        .put({
+          body: {
+            name: "foo"
+          }
+        });
+      assert.strictEqual(result.status, "204");
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should spread alias with mixed params", async () => {
+    try {
+      const result = await client
+        .path("/parameters/spread/alias/request-parameter/{id}", "1")
+        .put({
+          body: {
+            name: "foo"
+          },
+          headers: {
+            "x-ms-test-header": "bar"
+          }
+        });
+      assert.strictEqual(result.status, "204");
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should spread alias with more than 5 params", async () => {
+    try {
+      const result = await client
+        .path("/parameters/spread/alias/multiple-parameters/{id}", "1")
+        .put({
+          body: {
+            prop1: "foo1",
+            prop2: "foo2",
+            prop3: "foo3",
+            prop4: "foo4",
+            prop5: "foo5",
+            prop6: "foo6"
+          },
+          headers: {
+            "x-ms-test-header": "bar"
+          }
+        });
+      assert.strictEqual(result.status, "204");
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+});

package/test/integration/unions.spec.ts

@@ -11,7 +11,7 @@ describe("UnionsClient Rest Client", () => {
 
   it("should post input simple number union", async () => {
     try {
-      const result = await client.path("/unions/int").post({
+      const result = await client.path("/type/union/int").post({
         body: {
           simpleUnion: 1
         }
@@ -24,7 +24,7 @@ describe("UnionsClient Rest Client", () => {
 
   it("should post simple number array union", async () => {
     try {
-      const result = await client.path("/unions/int-array").post({
+      const result = await client.path("/type/union/int-array").post({
         body: {
           simpleUnion: [1, 2]
         }
@@ -37,7 +37,7 @@ describe("UnionsClient Rest Client", () => {
 
   it("should post named union model1", async () => {
     try {
-      const result = await client.path("/unions/model1").post({
+      const result = await client.path("/type/union/model1").post({
         body: {
           namedUnion: {
             name: "model1",
@@ -53,7 +53,7 @@ describe("UnionsClient Rest Client", () => {
 
   it("should post named union model2", async () => {
     try {
-      const result = await client.path("/unions/model2").post({
+      const result = await client.path("/type/union/model2").post({
         body: {
           namedUnion: {
             name: "model2",

package/test/unit/apiVersion.spec.ts

@@ -0,0 +1,388 @@
+import { assert } from "chai";
+import { emitClientFactoryFromCadl } from "./util/emitUtil.js";
+import { assertEqualContent } from "./util/testUtil.js";
+
+interface DefinitionOptions {
+  "@service"?: boolean;
+  "@versioned"?: boolean;
+  crossVersion?: boolean;
+}
+
+const buildDefaultDefinition = (options: DefinitionOptions) => {
+  const serviceDefault = !options["@service"]
+    ? ``
+    : `version: "2022-05-15-preview"`;
+  const versionDef = !options["@versioned"]
+    ? ``
+    : `
+    @versioned(Versions)`;
+  return `
+  ${versionDef}
+  @server(
+    "{Endpoint}/language",
+    "Language Service",
+    {
+      Endpoint: Endpoint
+    }
+  )
+  @service({
+    title: "PetStoreClient",
+    ${serviceDefault}
+  })
+  namespace PetStore;
+  @doc("The endpoint to use.")
+  scalar Endpoint extends string;
+
+  enum Versions {
+    v2022_05_15_preview: "2022-05-15-preview"
+  }
+  `;
+};
+
+const buildQueryDefinition = (options: DefinitionOptions) => {
+  const crossVersionDef = options.crossVersion
+    ? `
+  enum VersionEnum {
+    v1,
+    v2,
+  }
+  model ApiVersion3Parameter {
+    @query
+    "api-version": VersionEnum;
+  }
+  @route("/baz")
+  op baz(...ApiVersion3Parameter): string;
+
+  model ApiVersion2Parameter {
+    @query
+    "api-version": "v1.1";
+  }
+  @route("/bar")
+  op bar(...ApiVersion2Parameter): string;`
+    : ``;
+  return `${buildDefaultDefinition(options)}
+  model ApiVersionParameter {
+    @query
+    "api-version": string;
+  }
+  @route("/foo")
+  op foo(...ApiVersionParameter): string;
+  ${crossVersionDef}
+  `;
+};
+
+const buildPathDefinition = (options: DefinitionOptions) => {
+  const serviceDefault = !options["@service"]
+    ? ``
+    : `version: "2022-05-15-preview"`;
+  const versionDef = !options["@versioned"]
+    ? ``
+    : `
+    @versioned(Versions)`;
+  return `
+  ${versionDef}
+  @server(
+    "{Endpoint}/anomalydetector/{apiVersion}",
+    "Language Service",
+    {
+      Endpoint: Endpoint,
+      @doc("Api Version")
+      @path
+      apiVersion: Versions,
+    }
+  )
+  @service({
+    title: "PetStoreClient",
+    ${serviceDefault}
+  })
+  namespace PetStore;
+  @doc("The endpoint to use.")
+  scalar Endpoint extends string;
+
+  enum Versions {
+    v2022_05_15_preview: "2022-05-15-preview"
+  }
+  `;
+};
+
+const buildMixedDefinition = (options: DefinitionOptions) => {
+  const crossVersionDef = options.crossVersion
+    ? `
+  model ApiVersion2Parameter {
+    @query
+    "api-version": "v1.1";
+  }
+  op foo(...ApiVersion2Parameter): string;`
+    : ``;
+  return `${buildPathDefinition(options)}
+  model ApiVersionParameter {
+    @query
+    "api-version": string;
+  }
+  op test(...ApiVersionParameter): string;
+  ${crossVersionDef}
+  `;
+};
+
+const buildDefaultReturn = (hasDefault: boolean) => {
+  const defaultDef = !hasDefault
+    ? ``
+    : `options.apiVersion = options.apiVersion ?? "2022-05-15-preview";`;
+  return `
+  import { getClient, ClientOptions } from "@azure-rest/core-client";
+  import { testClient } from "./clientDefinitions";
+  
+  /**
+   * Initialize a new instance of \`testClient\`
+   * @param endpoint type: string, The endpoint to use.
+   * @param options type: ClientOptions, the parameter for all optional parameters
+   */
+  export default function createClient(
+    endpoint: string,
+    options: ClientOptions = {}
+  ): testClient {
+    const baseUrl = options.baseUrl ?? \`\${endpoint}/language\`;
+    ${defaultDef}
+    
+    const userAgentInfo = \`azsdk-js--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 testClient;
+  
+    return client;
+  }`;
+};
+
+const buildPathReturn_WithDefault = () => {
+  return `
+  import { getClient, ClientOptions } from "@azure-rest/core-client";
+  import { testClient } from "./clientDefinitions";
+
+  export interface testClientOptions extends ClientOptions {
+    apiVersion?: string;
+  }
+  
+  /**
+   * Initialize a new instance of \`testClient\`
+   * @param endpoint type: string, The endpoint to use.
+   * @param options type: testClientOptions, the parameter for all optional parameters
+   */
+  export default function createClient(
+    endpoint: string,
+    options: testClientOptions = {}
+  ): testClient {
+    const apiVersion = options.apiVersion ?? "2022-05-15-preview";
+    const baseUrl = options.baseUrl ?? \`\${endpoint}/anomalydetector/\${apiVersion}\`;
+
+    const userAgentInfo = \`azsdk-js--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 testClient;
+  
+    return client;          
+  }`;
+};
+
+const buildPathReturn_WithoutDefault = () => {
+  return `
+  import { getClient, ClientOptions } from "@azure-rest/core-client";
+  import { testClient } from "./clientDefinitions";
+  
+  /**
+   * Initialize a new instance of \`testClient\`
+   * @param endpoint type: string, The endpoint to use.
+   * @param apiVersion type: string, Api Version Possible values: 2022-05-15-preview
+   * @param options type: ClientOptions, the parameter for all optional parameters
+   */
+  export default function createClient(
+    endpoint: string,
+    apiVersion: string,
+    options: ClientOptions = {}
+  ): testClient {
+    const baseUrl = options.baseUrl ?? \`\${endpoint}/anomalydetector/\${apiVersion}\`;
+
+    const userAgentInfo = \`azsdk-js--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 testClient;
+  
+    return client;          
+  }`;
+};
+
+describe("api-version", () => {
+  describe("defined in query position", () => {
+    describe("with default value", () => {
+      it("in @serivce", async () => {
+        const def = buildQueryDefinition({
+          "@service": true
+        });
+        const expectedRes = buildDefaultReturn(true);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+      it("in @versioned", async () => {
+        const def = buildQueryDefinition({
+          "@versioned": true
+        });
+        const expectedRes = buildDefaultReturn(true);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+    describe("without default value", () => {
+      it("due to cross version", async () => {
+        const def = buildQueryDefinition({
+          "@service": true,
+          "@versioned": false,
+          crossVersion: true
+        });
+        const expectedRes = buildDefaultReturn(false);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+      it("no @service or @versioned", async () => {
+        const def = buildQueryDefinition({
+          "@service": false,
+          "@versioned": false
+        });
+        const expectedRes = buildDefaultReturn(false);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+  });
+  describe("defined in url path", () => {
+    describe("with default value", () => {
+      it("in @serivce", async () => {
+        const def = buildPathDefinition({
+          "@service": true
+        });
+        const expectedRes = buildPathReturn_WithDefault();
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+      it("in @versioned", async () => {
+        const def = buildPathDefinition({
+          "@versioned": true
+        });
+        const expectedRes = buildPathReturn_WithDefault();
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+    describe("without default value", () => {
+      it("no @service or @versioned", async () => {
+        const def = buildPathDefinition({
+          "@service": false,
+          "@versioned": false
+        });
+        const expectedRes = buildPathReturn_WithoutDefault();
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+  });
+  describe("defined in both positions[path preferred]", () => {
+    describe("with default value", () => {
+      it("in @serivce", async () => {
+        const def = buildMixedDefinition({
+          "@service": true
+        });
+        const expectedRes = buildPathReturn_WithDefault();
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+      it("in @versioned", async () => {
+        const def = buildMixedDefinition({
+          "@versioned": true
+        });
+        const expectedRes = buildPathReturn_WithDefault();
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+    describe("without default value", () => {
+      it("no @service or @versioned", async () => {
+        const def = buildMixedDefinition({
+          "@service": false,
+          "@versioned": false
+        });
+        const expectedRes = buildPathReturn_WithoutDefault();
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+  });
+  describe("without definition", () => {
+    describe("with default value", () => {
+      it("in @serivce", async () => {
+        const def = buildDefaultDefinition({
+          "@service": true
+        });
+        const expectedRes = buildDefaultReturn(true);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+      it("in @versioned", async () => {
+        const def = buildDefaultDefinition({
+          "@versioned": true
+        });
+        const expectedRes = buildDefaultReturn(true);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+    describe("without default value", () => {
+      it("no @service or @versioned", async () => {
+        const def = buildDefaultDefinition({
+          "@service": false,
+          "@versioned": false
+        });
+        const expectedRes = buildDefaultReturn(false);
+        const models = await emitClientFactoryFromCadl(def);
+        assert.ok(models);
+        assertEqualContent(models!.content, expectedRes);
+      });
+    });
+  });
+});

package/test/unit/clientFactoryGenerator.spec.ts

@@ -227,137 +227,6 @@ describe("Client Factory generation", () => {
     });
   });
 
-  describe("should handle apiVersion correctly", () => {
-    describe("apiVersion as query parameter", () => {
-      it("should set the default value in options", async () => {
-        const models = await emitClientFactoryFromCadl(`
-            @server(
-              "{Endpoint}/language",
-              "Language Service",
-              {
-                Endpoint: Endpoint
-              }
-            )
-            @service({
-              title: "PetStoreClient",
-              version: "2022-05-15-preview",
-            })
-            namespace PetStore;
-            @doc("The endpoint to use.")
-            scalar Endpoint extends string;
-            `);
-        assert.ok(models);
-        assertEqualContent(
-          models!.content,
-          `
-            import { getClient, ClientOptions } from "@azure-rest/core-client";
-            import { testClient } from "./clientDefinitions";
-            
-            /**
-             * Initialize a new instance of \`testClient\`
-             * @param endpoint type: string, The endpoint to use.
-             * @param options type: ClientOptions, the parameter for all optional parameters
-             */
-            export default function createClient(
-              endpoint: string,
-              options: ClientOptions = {}
-            ): testClient {
-              const baseUrl = options.baseUrl ?? \`\${endpoint}/language\`;
-              options.apiVersion = options.apiVersion ?? "2022-05-15-preview";
-            
-              const userAgentInfo = \`azsdk-js--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 testClient;
-            
-              return client;
-          }
-          `
-        );
-      });
-    });
-    describe("apiVersion as path parameter", () => {
-      it("should set the default value in customized options", async () => {
-        const models = await emitClientFactoryFromCadl(`
-            @versioned(Versions)
-            @server(
-              "{Endpoint}/anomalydetector/{ApiVersion}",
-              "Language Service",
-              {
-                Endpoint: Endpoint,
-                @doc("Api Version")
-                @path
-                ApiVersion: APIVersion,
-              }
-            )
-            @service({
-              title: "PetStoreClient"
-            })
-            namespace PetStore;
-            @doc("The endpoint to use.")
-            scalar Endpoint extends string;
-
-            enum Versions {
-              v1_1: "v1.1",
-            }
-            @knownValues(Versions)
-            scalar APIVersion extends string;
-            `);
-        assert.ok(models);
-        assertEqualContent(
-          models!.content,
-          `
-            import { getClient, ClientOptions } from "@azure-rest/core-client";
-            import { testClient } from "./clientDefinitions";
-            
-            export interface testClientOptions extends ClientOptions {
-              apiVersion?: string;
-            }
-
-            /**
-             * Initialize a new instance of \`testClient\`
-             * @param endpoint type: string, The endpoint to use.
-             * @param options type: testClientOptions, the parameter for all optional parameters
-             */
-            export default function createClient(
-              endpoint: string,
-              options: testClientOptions = {}
-            ): testClient {
-              const apiVersion = options.apiVersion ?? "v1.1";
-              const baseUrl = options.baseUrl ?? \`\${endpoint}/anomalydetector/\${apiVersion}\`;
-            
-              const userAgentInfo = \`azsdk-js--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 testClient;
-            
-              return client;
-          }
-          `
-        );
-      });
-    });
-    describe("mixed apiVersion in path & query parameter", () => {});
-  });
-
   describe("should handle no @server definition", () => {
     it("should set default endpoint parameter when no @server", async () => {
       const models = await emitClientFactoryFromCadl(`

package/test/unit/modelsGenerator.spec.ts

@@ -737,10 +737,10 @@ describe("Input/output model type", () => {
         outputType
       });
     });
-    it("should handle zonedDateTime -> string in output model &  `Date | string` in input model", async () => {
+    it("should handle utcDateTime -> string in output model &  `Date | string` in input model", async () => {
       const inputType = "Date | string";
       const outputType = "string";
-      await verifyPropertyType("zonedDateTime", inputType, {
+      await verifyPropertyType("utcDateTime", inputType, {
         outputType
       });
     });

package/test/unit/parametersGenerator.spec.ts

@@ -448,7 +448,7 @@ describe("Parameters.ts", () => {
 
     it("datetime array request generation", async () => {
       const parameters = await emitParameterFromCadl(`
-      @post op read(@body body: zonedDateTime[]): void;
+      @post op read(@body body: utcDateTime[]): void;
       `);
       assert.ok(parameters);
       assertEqualContent(

package/test/unit/responsesGenerator.spec.ts

@@ -375,7 +375,7 @@ describe("Responses.ts", () => {
 
     it("verify datetime array from responses", async () => {
       const responses = await emitResponsesFromCadl(`
-      @get op read(): zonedDateTime[];
+      @get op read(): utcDateTime[];
       `);
       assert.ok(responses);
       assertEqualContent(