Rename package name to @azure/quantum-jobs and client name to QuantumJobClient (Azure#13353)

sarangan12 · web-flow · commit c431d5319cd4 · 2021-01-25T21:56:00.000Z
Based on the request from Victor, I am creating this small PR: 1. Change the name of the package to @azure/quantum-jobs 2. Change the Client Name to QuantumJobClient. @ramya-rao-a Please approve the PR
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/rush.json b/rush.json
@@ -363,8 +363,8 @@
       "versionPolicyName": "client"
     },
     {
-      "packageName": "@azure/quantum",
-      "projectFolder": "sdk/quantum/quantum",
+      "packageName": "@azure/quantum-jobs",
+      "projectFolder": "sdk/quantum/quantum-jobs",
       "versionPolicyName": "client"
     },
     {
diff --git a/sdk/quantum/quantum-jobs/LICENSE.txt b/sdk/quantum/quantum-jobs/LICENSE.txt
diff --git a/sdk/quantum/quantum-jobs/README.md b/sdk/quantum/quantum-jobs/README.md
@@ -1,13 +1,13 @@
-## Azure QuantumClient client library for JavaScript
+## Azure QuantumJobClient client library for JavaScript
 
-This package contains an isomorphic SDK for QuantumClient.
+This package contains an isomorphic SDK for QuantumJobClient.
 
 ## Getting started
 
 ### Install the package
 
 ```bash
-npm install @azure/quantum
+npm install @azure/quantum-jobs
 ```
 
 ### Prerequisites
diff --git a/sdk/quantum/quantum-jobs/api-extractor.json b/sdk/quantum/quantum-jobs/api-extractor.json
diff --git a/sdk/quantum/quantum-jobs/package.json b/sdk/quantum/quantum-jobs/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@azure/quantum",
+  "name": "@azure/quantum-jobs",
   "author": "Microsoft Corporation",
   "description": "Azure Quantum REST API client",
   "version": "1.0.0-beta.1",
@@ -16,7 +16,7 @@
     "isomorphic"
   ],
   "license": "MIT",
-  "main": "./dist/quantum.js",
+  "main": "./dist/quantum-jobs.js",
   "module": "./esm/index.js",
   "types": "./esm/index.d.ts",
   "devDependencies": {
diff --git a/sdk/quantum/quantum-jobs/review/quantum-jobs.api.md b/sdk/quantum/quantum-jobs/review/quantum-jobs.api.md
@@ -1,4 +1,4 @@
-## API Report File for "@azure/quantum"
+## API Report File for "@azure/quantum-jobs"
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
@@ -54,7 +54,7 @@ export interface JobDetailsList {
 
 // @public
 export class Jobs {
-    constructor(client: QuantumClient);
+    constructor(client: QuantumJobClient);
     cancel(jobId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>;
     create(jobId: string, job: JobDetails, options?: coreHttp.OperationOptions): Promise<JobsCreateResponse>;
     get(jobId: string, options?: coreHttp.OperationOptions): Promise<JobsGetResponse>;
@@ -154,7 +154,7 @@ export type ProviderAvailability = string;
 
 // @public
 export class Providers {
-    constructor(client: QuantumClient);
+    constructor(client: QuantumJobClient);
     listStatus(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<ProviderStatus>;
 }
 
@@ -188,8 +188,8 @@ export interface ProviderStatusList {
 }
 
 // @public (undocumented)
-export class QuantumClient extends QuantumClientContext {
-    constructor(subscriptionId: string, resourceGroupName: string, workspaceName: string, options?: QuantumClientOptionalParams);
+export class QuantumJobClient extends QuantumJobClientContext {
+    constructor(subscriptionId: string, resourceGroupName: string, workspaceName: string, options?: QuantumJobClientOptionalParams);
     // (undocumented)
     jobs: Jobs;
     // (undocumented)
@@ -201,10 +201,10 @@ export class QuantumClient extends QuantumClientContext {
 }
 
 // @public (undocumented)
-export class QuantumClientContext extends coreHttp.ServiceClient {
+export class QuantumJobClientContext extends coreHttp.ServiceClient {
     // (undocumented)
     $host: string;
-    constructor(subscriptionId: string, resourceGroupName: string, workspaceName: string, options?: QuantumClientOptionalParams);
+    constructor(subscriptionId: string, resourceGroupName: string, workspaceName: string, options?: QuantumJobClientOptionalParams);
     // (undocumented)
     resourceGroupName: string;
     // (undocumented)
@@ -214,7 +214,7 @@ export class QuantumClientContext extends coreHttp.ServiceClient {
 }
 
 // @public
-export interface QuantumClientOptionalParams extends coreHttp.ServiceClientOptions {
+export interface QuantumJobClientOptionalParams extends coreHttp.ServiceClientOptions {
     $host?: string;
     endpoint?: string;
 }
@@ -238,7 +238,7 @@ export interface QuotaList {
 
 // @public
 export class Quotas {
-    constructor(client: QuantumClient);
+    constructor(client: QuantumJobClient);
     list(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<Quota>;
     }
 
@@ -270,7 +270,7 @@ export interface SasUriResponse {
 
 // @public
 export class Storage {
-    constructor(client: QuantumClient);
+    constructor(client: QuantumJobClient);
     sasUri(blobDetails: BlobDetails, options?: coreHttp.OperationOptions): Promise<StorageSasUriResponse>;
 }
 
diff --git a/sdk/quantum/quantum-jobs/rollup.config.js b/sdk/quantum/quantum-jobs/rollup.config.js
@@ -12,12 +12,12 @@ import sourcemaps from "rollup-plugin-sourcemaps";
 
 /** @type {rollup.RollupFileOptions} */
 const config = {
-  input: "./dist-esm/quantumClient.js",
+  input: "./dist-esm/quantumJobClient.js",
   external: ["@azure/core-http"],
   output: {
-    file: "./dist/quantum.js",
+    file: "./dist/quantum-jobs.js",
     format: "umd",
-    name: "Azure.Quantum",
+    name: "Azure.QuantumJobs",
     sourcemap: true,
     globals: {
       "@azure/core-http": "coreHttp"
diff --git a/sdk/quantum/quantum-jobs/src/index.ts b/sdk/quantum/quantum-jobs/src/index.ts
@@ -9,5 +9,5 @@
 /// <reference lib="esnext.asynciterable" />
 export * from "./models";
 export * from "./operations";
-export { QuantumClient } from "./quantumClient";
-export { QuantumClientContext } from "./quantumClientContext";
+export { QuantumJobClient } from "./quantumJobClient";
+export { QuantumJobClientContext } from "./quantumJobClientContext";
diff --git a/sdk/quantum/quantum-jobs/src/models/index.ts b/sdk/quantum/quantum-jobs/src/models/index.ts
@@ -384,7 +384,8 @@ export type QuotasListNextResponse = QuotaList & {
 };
 
 /** Optional parameters. */
-export interface QuantumClientOptionalParams extends coreHttp.ServiceClientOptions {
+export interface QuantumJobClientOptionalParams
+  extends coreHttp.ServiceClientOptions {
   /** server parameter */
   $host?: string;
   /** Overrides client endpoint. */
diff --git a/sdk/quantum/quantum-jobs/src/models/mappers.ts b/sdk/quantum/quantum-jobs/src/models/mappers.ts
diff --git a/sdk/quantum/quantum-jobs/src/models/parameters.ts b/sdk/quantum/quantum-jobs/src/models/parameters.ts
diff --git a/sdk/quantum/quantum-jobs/src/operations/index.ts b/sdk/quantum/quantum-jobs/src/operations/index.ts
diff --git a/sdk/quantum/quantum-jobs/src/operations/jobs.ts b/sdk/quantum/quantum-jobs/src/operations/jobs.ts
@@ -10,7 +10,7 @@ import { PagedAsyncIterableIterator } from "@azure/core-paging";
 import * as coreHttp from "@azure/core-http";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
-import { QuantumClient } from "../quantumClient";
+import { QuantumJobClient } from "../quantumJobClient";
 import {
   JobDetails,
   JobsListResponse,
@@ -21,13 +21,13 @@ import {
 
 /** Class representing a Jobs. */
 export class Jobs {
-  private readonly client: QuantumClient;
+  private readonly client: QuantumJobClient;
 
   /**
    * Initialize a new instance of the class Jobs class.
    * @param client Reference to the service client
    */
-  constructor(client: QuantumClient) {
+  constructor(client: QuantumJobClient) {
     this.client = client;
   }
 
diff --git a/sdk/quantum/quantum-jobs/src/operations/providers.ts b/sdk/quantum/quantum-jobs/src/operations/providers.ts
@@ -10,7 +10,7 @@ import { PagedAsyncIterableIterator } from "@azure/core-paging";
 import * as coreHttp from "@azure/core-http";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
-import { QuantumClient } from "../quantumClient";
+import { QuantumJobClient } from "../quantumJobClient";
 import {
   ProviderStatus,
   ProvidersGetStatusResponse,
@@ -19,13 +19,13 @@ import {
 
 /** Class representing a Providers. */
 export class Providers {
-  private readonly client: QuantumClient;
+  private readonly client: QuantumJobClient;
 
   /**
    * Initialize a new instance of the class Providers class.
    * @param client Reference to the service client
    */
-  constructor(client: QuantumClient) {
+  constructor(client: QuantumJobClient) {
     this.client = client;
   }
 
diff --git a/sdk/quantum/quantum-jobs/src/operations/quotas.ts b/sdk/quantum/quantum-jobs/src/operations/quotas.ts
@@ -10,18 +10,18 @@ import { PagedAsyncIterableIterator } from "@azure/core-paging";
 import * as coreHttp from "@azure/core-http";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
-import { QuantumClient } from "../quantumClient";
+import { QuantumJobClient } from "../quantumJobClient";
 import { Quota, QuotasListResponse, QuotasListNextResponse } from "../models";
 
 /** Class representing a Quotas. */
 export class Quotas {
-  private readonly client: QuantumClient;
+  private readonly client: QuantumJobClient;
 
   /**
    * Initialize a new instance of the class Quotas class.
    * @param client Reference to the service client
    */
-  constructor(client: QuantumClient) {
+  constructor(client: QuantumJobClient) {
     this.client = client;
   }
 
diff --git a/sdk/quantum/quantum-jobs/src/operations/storage.ts b/sdk/quantum/quantum-jobs/src/operations/storage.ts
@@ -9,18 +9,18 @@
 import * as coreHttp from "@azure/core-http";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
-import { QuantumClient } from "../quantumClient";
+import { QuantumJobClient } from "../quantumJobClient";
 import { BlobDetails, StorageSasUriResponse } from "../models";
 
 /** Class representing a Storage. */
 export class Storage {
-  private readonly client: QuantumClient;
+  private readonly client: QuantumJobClient;
 
   /**
    * Initialize a new instance of the class Storage class.
    * @param client Reference to the service client
    */
-  constructor(client: QuantumClient) {
+  constructor(client: QuantumJobClient) {
     this.client = client;
   }
 
diff --git a/sdk/quantum/quantum-jobs/src/quantumJobClient.ts b/sdk/quantum/quantum-jobs/src/quantumJobClient.ts
@@ -7,12 +7,12 @@
  */
 
 import { Jobs, Providers, Storage, Quotas } from "./operations";
-import { QuantumClientContext } from "./quantumClientContext";
-import { QuantumClientOptionalParams } from "./models";
+import { QuantumJobClientContext } from "./quantumJobClientContext";
+import { QuantumJobClientOptionalParams } from "./models";
 
-export class QuantumClient extends QuantumClientContext {
+export class QuantumJobClient extends QuantumJobClientContext {
   /**
-   * Initializes a new instance of the QuantumClient class.
+   * Initializes a new instance of the QuantumJobClient class.
    * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
    *                       00000000-0000-0000-0000-000000000000)
    * @param resourceGroupName Name of an Azure resource group.
@@ -23,7 +23,7 @@ export class QuantumClient extends QuantumClientContext {
     subscriptionId: string,
     resourceGroupName: string,
     workspaceName: string,
-    options?: QuantumClientOptionalParams
+    options?: QuantumJobClientOptionalParams
   ) {
     super(subscriptionId, resourceGroupName, workspaceName, options);
     this.jobs = new Jobs(this);
diff --git a/sdk/quantum/quantum-jobs/src/quantumJobClientContext.ts b/sdk/quantum/quantum-jobs/src/quantumJobClientContext.ts
@@ -7,19 +7,19 @@
  */
 
 import * as coreHttp from "@azure/core-http";
-import { QuantumClientOptionalParams } from "./models";
+import { QuantumJobClientOptionalParams } from "./models";
 
-const packageName = "@azure/quantum";
+const packageName = "@azure/quantum-jobs";
 const packageVersion = "1.0.0-beta.1";
 
-export class QuantumClientContext extends coreHttp.ServiceClient {
+export class QuantumJobClientContext extends coreHttp.ServiceClient {
   $host: string;
   subscriptionId: string;
   resourceGroupName: string;
   workspaceName: string;
 
   /**
-   * Initializes a new instance of the QuantumClientContext class.
+   * Initializes a new instance of the QuantumJobClientContext class.
    * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
    *                       00000000-0000-0000-0000-000000000000)
    * @param resourceGroupName Name of an Azure resource group.
@@ -30,7 +30,7 @@ export class QuantumClientContext extends coreHttp.ServiceClient {
     subscriptionId: string,
     resourceGroupName: string,
     workspaceName: string,
-    options?: QuantumClientOptionalParams
+    options?: QuantumJobClientOptionalParams
   ) {
     if (subscriptionId === undefined) {
       throw new Error("'subscriptionId' cannot be null");
diff --git a/sdk/quantum/quantum-jobs/swagger/readme.md b/sdk/quantum/quantum-jobs/swagger/readme.md
@@ -5,14 +5,14 @@
 ## Configuration
 
 ```yaml
-package-name: "@azure/quantum"
+package-name: "@azure/quantum-jobs"
 generate-metadata: false
 license-header: MICROSOFT_MIT_NO_VERSION
 output-folder: ../
 source-code-folder-path: ./src/
 input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/quantum/data-plane/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json
 add-credentials: false
-title: QuantumClient
+title: QuantumJobClient
 v3: true
 use-extension:
   "@autorest/typescript": "6.0.0-dev.20210121.2"
diff --git a/sdk/quantum/quantum-jobs/tsconfig.json b/sdk/quantum/quantum-jobs/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -363,8 +363,8 @@`
`363`	`363`	`"versionPolicyName": "client"`
`364`	`364`	`},`
`365`	`365`	`{`
`366`		`- "packageName": "@azure/quantum",`
`367`		`- "projectFolder": "sdk/quantum/quantum",`
	`366`	`+ "packageName": "@azure/quantum-jobs",`
	`367`	`+ "projectFolder": "sdk/quantum/quantum-jobs",`
`368`	`368`	`"versionPolicyName": "client"`
`369`	`369`	`},`
`370`	`370`	`{`