@azure-tools/typespec-ts 0.11.0-alpha.20230413.3

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/azureCoreOperationsGenerator.spec.ts

@@ -0,0 +1,71 @@
+import { assert } from "chai";
+import {
+  emitParameterFromCadl,
+  emitResponsesFromCadl
+} from "./util/emitUtil.js";
+
+describe("typespec-azure-core: operation templates", () => {
+  it("ResourceCreateWithServiceProvidedName", async () => {
+    const { parameters, responses } = await compileResourceOperation(
+      `@test op create is Azure.Core.ResourceCreateWithServiceProvidedName<TestModel, Customizations>;`
+    );
+    assert.ok(parameters);
+    assert.ok(responses);
+  });
+});
+
+async function compileResourceOperation(code: string) {
+  const content = `
+    #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+    model TestModel {
+      @key
+      @visibility("read")
+      @segment("test")
+      name: string;
+      value: int32;
+    }
+
+    #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+    model CustomParameters {
+      #suppress "@azure-tools/typespec-azure-core/casing-style" "for test"
+      @header
+      "x-ms-foobar": string;
+
+      @query
+      nameHint: string;
+
+      customBodyParam: string;
+    }
+
+    #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+    model CustomResponseProperties {
+      #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+      #suppress "@azure-tools/typespec-azure-core/casing-style" "for test"
+      @header
+      "x-ms-response-id": int32;
+      #suppress "@azure-tools/typespec-azure-core/casing-style" "for test"
+      @doc("A timestamp when this job or item was created (in unix epochs).")
+      @visibility("read")
+      created_at?: int32;
+    }
+
+    #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+    model Customizations {
+      parameters: CustomParameters;
+      response: CustomResponseProperties;
+    }
+
+    #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+    model CustomizationsNoBody {
+      parameters: OmitProperties<CustomParameters, "customBodyParam">;
+      response: CustomResponseProperties;
+    }
+
+    #suppress "@azure-tools/typespec-azure-core/documentation-required" "for test"
+    ${code}
+    `;
+  const parameters = await emitParameterFromCadl(content, true);
+  const responses = await emitResponsesFromCadl(content, true);
+
+  return { parameters, responses };
+}

package/test/unit/clientDefinitionGenerator.spec.ts

@@ -0,0 +1,73 @@
+import { assert } from "chai";
+import { emitClientDefinitionFromCadl } from "./util/emitUtil.js";
+import { assertEqualContent } from "./util/testUtil.js";
+
+describe("Client definition generation", () => {
+  it("should generate method-level parameter", async () => {
+    const clientDef = await emitClientDefinitionFromCadl(
+      `
+      @route("/{id}")
+      @doc("This is the longer description")
+      op read(@path id: string): {};
+      `
+    );
+    assert.ok(clientDef);
+    // console.log(clientDef);
+    assertEqualContent(
+      clientDef?.content!,
+      `
+      import { ReadParameters } from "./parameters";
+      import { Read200Response } from "./responses";
+      import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+      export interface Read {
+          /** This is the longer description */
+          get(options?: ReadParameters): StreamableMethod<Read200Response>;
+      }
+
+      export interface Routes {
+          /** Resource for '/\\{id\\}' has methods for the following verbs: get */
+          (path: "/{id}", id: string): Read;
+      }
+      
+      export type testClient = Client & {
+              path: Routes;
+      };
+    `
+    );
+  });
+
+  it("should normalize method-level parameter", async () => {
+    const clientDef = await emitClientDefinitionFromCadl(
+      `
+      @route("/{TransactionID}")
+      @doc("This is the longer description")
+      op read(@path TransactionID: string): {};
+      `
+    );
+    assert.ok(clientDef);
+    // console.log(clientDef);
+    assertEqualContent(
+      clientDef?.content!,
+      `
+      import { ReadParameters } from "./parameters";
+      import { Read200Response } from "./responses";
+      import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+      export interface Read {
+          /** This is the longer description */
+          get(options?: ReadParameters): StreamableMethod<Read200Response>;
+      }
+
+      export interface Routes {
+          /** Resource for '/\\{TransactionID\\}' has methods for the following verbs: get */
+          (path: "/{TransactionID}", transactionID: string): Read;
+      }
+      
+      export type testClient = Client & {
+              path: Routes;
+      };
+    `
+    );
+  });
+});