@azure-tools/typespec-ts 0.13.0 → 0.13.1-alpha.20230609.1

package/CONTRIBUTING.md

@@ -1,137 +0,0 @@
-# How to Contribute
-
-## Prerequisite
-
-Please follow the **[Prerequisite](../../CONTRIBUTING.md#prerequisites)** part to install the dependencies.
-
-## Steps to clone, build & test
-
-1. Use the following command to clone the Typescript/Javascript SDK generator repository:
-
-```
-git clone https://github.com/Azure/autorest.typescript.git
-```
-
-2. Use the following commands to build the SDK generator:
-
-```
-rush update
-rush rebuild
-```
-
-3. There are also 3 test-suites in the RLC generator:
-
-   1. Unit tests (which could be found at `test/unit/*`)
-   2. Integration tests (which could be found at `test/integration/*`)
-   3. Smoke tests (which could be found at `../../packages/typespec-test`)
-
-1. You can run the Unit tests & Integration tests using the following command:
-
-```
-npm run test
-```
-
-Running the command above will do the following things:
-
-- Start TestServer
-- Build Cadl Typescript
-- Generate all scenarios in parallel (i.e. Dictionary, Extensible Enums, Models, Resiliency)
-- Run all the tests under test/integration
-- Stop TestServer
-
-**_Note_**: If your development environment is Windows, then run the command `npm run start-test-server`(in a seperate window) before running `npm run test` and run the command `npm run stop-test-server` after. (In non windows machines, we could run the test-server in the background automatically. But, in Windows machines, it has to be done manually.)
-
-5. You can run the Smoke tests using the following command:
-
-```shell
-cd ../../packages/typespec-test
-npm run smoke-test
-```
-
-## How to add an integration test case
-
-Whenever you work on adding a feature/fixing a bug, this would probably be your first step. You create a test case and then run it through the generator, see the result, modify the generator, run it again and so on, until you get the desired output.
-
-1. Pick up a cadl as your test input in cadl-ranch. Below are some examples
-
-   Let us say your test input is `authentication/api-key/main.cadl` in @azure-tools/cadl-ranch-specs.
-
-1. Now add an entry to the CadlRanchConfig to the file [`cadl-ranch-list.ts`](./test/commands/cadl-ranch-list.ts). In the file, add the following to the array.
-
-   ```typescript
-     {
-       outputPath: "authentication/apiKey",
-       inputPath: "authentication/api-key"
-     },
-   ```
-
-1. Create a tspconfig.yaml in `./test/integration/generated/authentication/apiKey` folder and put the following content in it.
-
-   ```yaml
-   emit:
-     - "@azure-tools/typespec-ts"
-   options:
-     "@azure-tools/typespec-ts":
-       "emitter-output-dir": "{project-root}"
-       generateMetadata: true
-       generateTest: true
-       includeShortcuts: true
-       azureSdkForJs: false
-       addCredentials: false
-       isCadlTest: true
-       title: AuthApiKeyClient
-       packageDetails:
-         name: "@msinternal/auth-apikey"
-         description: "Auth api key Test Service"
-         version: "1.0.0"
-   ```
-
-1. Now, You can generate the RLC for your test case with the following command: (Initially, during your development, you do not want to run all the cases during every step of your development, you can comment out other test cases. But, once your code changes are complete for your case, then you need to run the entire suite to ensure that your changes did not cause any unwanted changes.)
-
-   ```shell
-   npm run generate-cadl-only
-   ```
-
-1. Once you are satisfied with the generated code, you can add a spec file such as `testUserCaseRest.spec.ts` file [here](./test/integration). You can find several examples in the same place.
-
-## How to debug
-
-### `generate-cadl-only` step
-
-If you would like to debug the `generate-cadl-only` step for our test input, Open the repository in VS Code -> Select `Generate code for CadlEmitter` section -> Click `Attach`.
-
-### Spec file
-
-If you would like to debug the `testUserCase.spec.ts` file (after the SDK is generated), Open the repository in VS Code -> Open the `testUserCase.spec.ts` file -> Select `Run and Debug` section -> Click `IntegrationTests - Current File`.
-
-### How to debug an unit test case
-
-- In VS Code, We have created a Debugging profile for UnitTests to start debugging:
-
-  1. Go to the debugger tab
-  2. Select the "[CADL] - Unit Test" Profile
-  3. Click the "Play" button
-
-- Your breakpoints will start hitting, you can set breakpoints in either Test or Generator code
-
-### Integration Tests
-
-- In order to debug integration tests you need to start the test server, by running:
-
-      npm run start-test-server:v1
-
-- Once the Test Server is running
-
-  1. In VSCode go to the debugger tab
-  2. Select the "[CADL] - Integration Test" profile from the drop down
-  3. Click the "Play" button
-
-- **\*\***IMPORTANT**\*\***: Running Integration Tests for debugging, does not re-generate the test clients so make sure that after each change you do:
-
-  - Re-generate all the test swaggers
-
-        npm run generate-cadl-only -- --build
-
-  - Re-generate a specific swagger
-
-        npm run generate-cadl-only -- -i bodyComplexRest -b

package/test/commands/cadl-ranch-list.ts

@@ -1,116 +0,0 @@
-export interface CadlRanchConfig {
-  outputPath: string;
-  inputPath: string;
-  debug?: boolean;
-}
-
-export const cadls: CadlRanchConfig[] = [
-  {
-    outputPath: "arrays/itemTypes",
-    inputPath: "type/array"
-  },
-  {
-    outputPath: "authentication/apiKey",
-    inputPath: "authentication/api-key"
-  },
-  {
-    outputPath: "authentication/oauth2",
-    inputPath: "authentication/oauth2"
-  },
-  {
-    outputPath: "authentication/union",
-    inputPath: "authentication/union"
-  },
-  {
-    outputPath: "dictionary",
-    inputPath: "type/dictionary"
-  },
-  {
-    outputPath: "enums/extensible",
-    inputPath: "type/enum/extensible"
-  },
-  {
-    outputPath: "enums/fixed",
-    inputPath: "type/enum/fixed"
-  },
-  {
-    outputPath: "lro/lroCore",
-    inputPath: "azure/core/lro/standard"
-  },
-  {
-    outputPath: "lro/lroRPC",
-    inputPath: "azure/core/lro/rpc"
-  },
-  {
-    outputPath: "models/inheritance",
-    inputPath: "type/model/inheritance"
-  },
-  {
-    outputPath: "models/propertyOptional",
-    inputPath: "type/property/optional"
-  },
-  {
-    outputPath: "models/propertyNullable",
-    inputPath: "type/property/nullable"
-  },
-  {
-    outputPath: "models/propertyTypes",
-    inputPath: "type/property/value-types"
-  },
-  {
-    outputPath: "models/visibility",
-    inputPath: "type/model/visibility"
-  },
-  {
-    outputPath: "models/usage",
-    inputPath: "type/model/usage"
-  },
-  {
-    outputPath: "resiliency/srvDriven1",
-    inputPath: "resiliency/srv-driven/old.tsp"
-  },
-  {
-    outputPath: "resiliency/srvDriven2",
-    inputPath: "resiliency/srv-driven/main.tsp"
-  },
-  {
-    outputPath: "specialWords",
-    inputPath: "special-words"
-  },
-  {
-    outputPath: "unions",
-    inputPath: "type/union"
-  },
-  {
-    outputPath: "parameters/collection-format",
-    inputPath: "parameters/collection-format"
-  },
-  {
-    outputPath: "parameters/spread",
-    inputPath: "parameters/spread"
-  },
-  {
-    outputPath: "projection",
-    inputPath: "projection/projected-name"
-  },
-  {
-    outputPath: "internal",
-    inputPath: "azure/client-generator-core/internal"
-  },
-  {
-    outputPath: "server/path/single",
-    inputPath: "server/path/single"
-  },
-  {
-    outputPath: "server/path/multiple",
-    inputPath: "server/path/multiple"
-  },
-  {
-    outputPath: "azure/core",
-    inputPath: "azure/core/basic"
-  },
-  {
-    outputPath: "azure/core-traits",
-    inputPath: "azure/core/traits"
-  }
-];

package/test/commands/check-clean-tree.ts

@@ -1,55 +0,0 @@
-import { spawn, ChildProcess } from "child_process";
-
-const onExit = (childProcess: ChildProcess): Promise<string[]> => {
-  let messages: string[] = [];
-  return new Promise((resolve, reject) => {
-    if (childProcess.stdout) {
-      childProcess.stdout.on("data", (message) => messages.push(message));
-    }
-    childProcess.once("exit", (code: number) => {
-      if (code === 0) {
-        resolve(messages);
-      }
-      reject(new Error(`Exit with code: ${code}`));
-    });
-
-    childProcess.once("error", (error: Error) => {
-      reject(error);
-    });
-  });
-};
-
-async function check_tree() {
-  await onExit(
-    spawn("git", ["add", "-A"], {
-      stdio: [process.stdin, process.stdout, process.stderr]
-    })
-  );
-
-  // If there is any output from this command it means that
-  // there are non committed changes so we need to handle
-  // stout
-  const messages = await onExit(
-    spawn("git", ["diff", "--staged", "--compact-summary"])
-  );
-
-  if (messages.length !== 0) {
-    // Once we have verified that there are non committed changes
-    // run git diff again, this time forwarding the stout to present
-    // a readable hint to the user
-    await onExit(
-      spawn("git", ["diff", "--staged", "--compact-summary"], {
-        stdio: [process.stdin, process.stdout, process.stderr]
-      })
-    );
-
-    throw new Error(
-      "Git tree is dirty, regenerate all test cadl files and make sure that there are no un-intended changes"
-    );
-  }
-}
-
-check_tree().catch((error) => {
-  console.error(error);
-  process.exit(-1);
-});

package/test/commands/childProcessOnExit.ts

@@ -1,16 +0,0 @@
-import { ChildProcess } from "child_process";
-
-export const onExit = (childProcess: ChildProcess) => {
-  return new Promise<void>((resolve, reject) => {
-    childProcess.once("exit", (code: number) => {
-      if (code === 0) {
-        resolve();
-      }
-      reject(new Error(`Exit with code: ${code}`));
-    });
-
-    childProcess.once("error", (error: Error) => {
-      reject(error);
-    });
-  });
-};

package/test/commands/gen-cadl-ranch.ts

@@ -1,25 +0,0 @@
-import { cadls } from "./cadl-ranch-list.js";
-import { runTypespec } from "./run.js";
-import pkg from "chalk";
-const { bold } = pkg;
-const logError = (str: string) => console.error(bold.red(str));
-
-async function generateCadls(isDebugging = false) {
-  const list = cadls;
-  for (const cadl of list) {
-    if (isDebugging === true && cadl.debug !== true) {
-      continue;
-    }
-    await runTypespec(cadl);
-  }
-}
-
-async function main() {
-  const isDebugging = process.argv.indexOf("--debug") !== -1;
-  await generateCadls(isDebugging);
-}
-
-main().catch((error) => {
-  logError(error);
-  process.exit(-1);
-});

package/test/commands/run.ts

@@ -1,31 +0,0 @@
-import { execSync } from "child_process";
-import { dirname, join as joinPath } from "path";
-import { fileURLToPath } from "url";
-import { CadlRanchConfig } from "./cadl-ranch-list.js";
-
-export async function runTypespec(config: CadlRanchConfig) {
-  const targetFolder = config.outputPath,
-    sourceTypespec = config.inputPath;
-  const __filename = fileURLToPath(import.meta.url);
-  const __dirname = dirname(__filename);
-  console.log(`=== Start ${targetFolder} ===`);
-
-  const typespecPath = joinPath(
-    `${__dirname}`,
-    "..",
-    "..",
-    `./temp/http/${sourceTypespec}`
-  );
-  const outputPath = joinPath(
-    `${__dirname}`,
-    "..",
-    `./integration/generated/${targetFolder}`
-  );
-  const typespecCommand = `cd ${outputPath} && npx tsp`;
-  const commandArguments: string[] = ["compile", `${typespecPath}`];
-  const command = `${typespecCommand} ${commandArguments.join(" ")}`;
-  console.log(command);
-  const result = execSync(command);
-  console.log(`=== End ${targetFolder} ===`);
-  return result;
-}

package/test/integration/arrayItemTypes.spec.ts

@@ -1,96 +0,0 @@
-import ArrayItemTypesClientFactory, {
-  ArrayItemTypesClient
-} from "./generated/arrays/itemTypes/src/index.js";
-import { assert } from "chai";
-import { matrix } from "../util/matrix.js";
-
-interface TypeDetail {
-  type: string;
-  defaultValue: any;
-  convertedToFn?: (_: any) => any;
-}
-
-const testedTypes: TypeDetail[] = [
-  {
-    type: "int32",
-    defaultValue: [1, 2]
-  },
-  {
-    type: "int64",
-    defaultValue: [Number.MAX_SAFE_INTEGER, Number.MIN_SAFE_INTEGER]
-  },
-  {
-    type: "boolean",
-    defaultValue: [true, false]
-  },
-  {
-    type: "string",
-    defaultValue: ["hello", ""]
-  },
-  {
-    type: "float32",
-    defaultValue: [42.42]
-  },
-  {
-    type: "datetime",
-    defaultValue: ["2022-08-26T18:38:00Z"]
-  },
-  {
-    type: "duration",
-    defaultValue: ["P123DT22H14M12.011S"]
-  },
-  {
-    type: "unknown",
-    defaultValue: [1, "hello", null]
-  },
-  {
-    type: "model",
-    defaultValue: [{ property: "hello" }, { property: "world" }]
-  },
-  {
-    type: "nullable-float",
-    defaultValue: [1.2, null, 3.0]
-  }
-];
-describe("Array Item-Types Client", () => {
-  let client: ArrayItemTypesClient;
-
-  beforeEach(() => {
-    client = ArrayItemTypesClientFactory({
-      allowInsecureConnection: true
-    });
-  });
-
-  matrix([testedTypes], async (params: TypeDetail) => {
-    it(`should get a ${params.type} value`, async () => {
-      try {
-        const result = await client
-          .path(`/type/array/${params.type}` as any)
-          .get();
-        assert.strictEqual(result.status, "200");
-        assert.deepEqual(result.body, params.defaultValue);
-      } catch (err) {
-        assert.fail(err as string);
-      }
-    });
-
-    it(`should put a ${params.type} value`, async () => {
-      try {
-        let property;
-        if (params.convertedToFn) {
-          property = params.convertedToFn(params.defaultValue);
-        } else {
-          property = params.defaultValue;
-        }
-        const result = await client
-          .path(`/type/array/${params.type}` as any)
-          .put({
-            body: property
-          });
-        assert.strictEqual(result.status, "204");
-      } catch (err) {
-        assert.fail(err as string);
-      }
-    });
-  });
-});

package/test/integration/authApiKey.spec.ts

@@ -1,38 +0,0 @@
-import ApiKeyClientFactory, {
-  AuthApiKeyClient
-} from "./generated/authentication/apiKey/src/index.js";
-import { assert } from "chai";
-describe("AuthApiKeyClient Rest Client", () => {
-  let client: AuthApiKeyClient;
-
-  beforeEach(() => {
-    client = ApiKeyClientFactory(
-      {
-        key: "valid-key"
-      },
-      { allowInsecureConnection: true }
-    );
-  });
-
-  it("should return 204 when the apiKey is valid", async () => {
-    try {
-      const result = await client.path("/authentication/api-key/valid").get();
-      assert.strictEqual(result.status, "204");
-    } catch (err) {
-      console.log(err);
-      assert.fail(err as string);
-    }
-  });
-
-  it("should return 403 when the apiKey is invalid", async () => {
-    try {
-      const result = await client.path("/authentication/api-key/invalid").get();
-      assert.strictEqual(result.status, "403");
-      if (result.status === "403") {
-        assert.strictEqual(result.body.error, "invalid-api-key");
-      }
-    } catch (err) {
-      assert.fail(err as string);
-    }
-  });
-});

package/test/integration/authOauth2.spec.ts

@@ -1,65 +0,0 @@
-import Outh2ClientFactory, {
-  AuthOauth2Client
-} from "./generated/authentication/oauth2/src/index.js";
-import { assert } from "chai";
-import {
-  bearerTokenAuthenticationPolicyName,
-  PipelinePolicy
-} from "@azure/core-rest-pipeline";
-import { customBearerTokenAuthenticationPolicy } from "../util/customBearerTokenTestingPolicy.js";
-
-describe("AuthOauth2Client Rest Client", () => {
-  let client: AuthOauth2Client;
-  let policy: PipelinePolicy;
-  const defaultScope = "https://security.microsoft.com/.default";
-
-  beforeEach(() => {
-    client = Outh2ClientFactory(
-      {
-        getToken: async () => Promise.resolve(null)
-      },
-      { allowInsecureConnection: true }
-    );
-    policy = customBearerTokenAuthenticationPolicy({
-      scopes: defaultScope,
-      credential: {
-        getToken: async () => {
-          return {
-            token: defaultScope,
-            expiresOnTimestamp: Date.now()
-          };
-        }
-      }
-    });
-    client.pipeline.removePolicy({
-      name: bearerTokenAuthenticationPolicyName
-    });
-    client.pipeline.addPolicy(policy);
-  });
-
-  it("should return 204 when the token is valid", async () => {
-    try {
-      const result = await client.path("/authentication/oauth2/valid").get();
-      assert.strictEqual(result.status, "204");
-    } catch (err) {
-      console.log(err);
-      assert.fail(err as string);
-    }
-  });
-
-  it("should return 403 when the token is invalid", async () => {
-    try {
-      client.pipeline.removePolicy({
-        name: bearerTokenAuthenticationPolicyName
-      });
-      const result = await client.path("/authentication/oauth2/invalid").get();
-      assert.strictEqual(result.status, "403");
-      if (result.status === "403") {
-        assert.strictEqual(result.body.error, "invalid-grant");
-      }
-    } catch (err) {
-      console.log(err);
-      assert.fail(err as string);
-    }
-  });
-});

package/test/integration/authUnion.spec.ts

@@ -1,72 +0,0 @@
-import { assert } from "chai";
-import {
-  bearerTokenAuthenticationPolicyName,
-  PipelinePolicy
-} from "@azure/core-rest-pipeline";
-import { customBearerTokenAuthenticationPolicy } from "../util/customBearerTokenTestingPolicy.js";
-import AuthUnionClientFactory, {
-  AuthUnionClient
-} from "./generated/authentication/union/src/index.js";
-
-describe("AuthUnionClient Rest Client", () => {
-  let client: AuthUnionClient;
-  let policy: PipelinePolicy;
-  const defaultScope = "https://security.microsoft.com/.default";
-
-  function prepareToken() {
-    client = AuthUnionClientFactory(
-      {
-        getToken: async () => Promise.resolve(null)
-      },
-      { allowInsecureConnection: true }
-    );
-    policy = customBearerTokenAuthenticationPolicy({
-      scopes: defaultScope,
-      credential: {
-        getToken: async () => {
-          return {
-            token: defaultScope,
-            expiresOnTimestamp: Date.now()
-          };
-        }
-      }
-    });
-    client.pipeline.removePolicy({
-      name: bearerTokenAuthenticationPolicyName
-    });
-    client.pipeline.addPolicy(policy);
-  }
-
-  function prepareKey() {
-    client = AuthUnionClientFactory(
-      {
-        key: "valid-key"
-      },
-      { allowInsecureConnection: true }
-    );
-  }
-
-  it("should return 204 when the token is valid", async () => {
-    prepareToken();
-    try {
-      const result = await client
-        .path("/authentication/union/validtoken")
-        .get();
-      assert.strictEqual(result.status, "204");
-    } catch (err) {
-      console.log(err);
-      assert.fail(err as string);
-    }
-  });
-
-  it("should return 204 when the key is valid", async () => {
-    prepareKey();
-    try {
-      const result = await client.path("/authentication/union/validkey").get();
-      assert.strictEqual(result.status, "204");
-    } catch (err) {
-      console.log(err);
-      assert.fail(err as string);
-    }
-  });
-});