@azure-tools/typespec-ts 0.12.0-alpha.20230502.1 → 0.13.0

package/src/transform/transformParameters.ts

@@ -84,13 +84,18 @@ export function transformToParameterTypes(
     // transform path param
     const pathParams = transformPathParameters();
     // transform header param includeing content-type
-    const headerParams = transformHeaderParameters(program, parameters);
+    const headerParams = transformHeaderParameters(
+      program,
+      dpgContext,
+      parameters
+    );
     // transform body
     const bodyType = getBodyType(program, route);
     let bodyParameter = undefined;
     if (bodyType) {
       bodyParameter = transformBodyParameters(
         program,
+        dpgContext,
         parameters,
         headerParams,
         outputImportedSet,
@@ -108,13 +113,18 @@ export function transformToParameterTypes(
 
 function getParameterMetadata(
   program: Program,
+  dpgContext: SdkContext,
   paramType: "query" | "path" | "header",
   parameter: HttpOperationParameter
 ): ParameterMetadata {
-  const schema = getSchemaForType(program, parameter.param.type, [
-    SchemaContext.Input,
-    SchemaContext.Exception
-  ]) as Schema;
+  const schema = getSchemaForType(
+    program,
+    dpgContext,
+    parameter.param.type,
+    [SchemaContext.Exception, SchemaContext.Input],
+    false,
+    parameter.param
+  ) as Schema;
   let type = getTypeName(schema);
   const name = getParameterName(parameter.name);
   let description =
@@ -175,7 +185,7 @@ function transformQueryParameters(
     return [];
   }
   return queryParameters.map((qp) =>
-    getParameterMetadata(program, "query", qp)
+    getParameterMetadata(program, dpgContext, "query", qp)
   );
 }
 
@@ -191,6 +201,7 @@ function transformPathParameters() {
 
 function transformHeaderParameters(
   program: Program,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters
 ): ParameterMetadata[] {
   const headerParameters = parameters.parameters.filter(
@@ -200,12 +211,13 @@ function transformHeaderParameters(
     return [];
   }
   return headerParameters.map((qp) =>
-    getParameterMetadata(program, "header", qp)
+    getParameterMetadata(program, dpgContext, "header", qp)
   );
 }
 
 function transformBodyParameters(
   program: Program,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters,
   headers: ParameterMetadata[],
   importedModels: Set<string>,
@@ -224,6 +236,7 @@ function transformBodyParameters(
     // Case 1: Handle the normal case without binary or form data
     return transformNormalBody(
       program,
+      dpgContext,
       bodyType,
       parameters,
       importedModels,
@@ -236,6 +249,7 @@ function transformBodyParameters(
     // Case 3: Handle the form data
     return transformMultiFormBody(
       program,
+      dpgContext,
       bodyType,
       parameters,
       importedModels
@@ -245,6 +259,7 @@ function transformBodyParameters(
 
 function transformNormalBody(
   program: Program,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>,
@@ -252,16 +267,18 @@ function transformNormalBody(
 ) {
   const description = extractDescriptionsFromBody(
     program,
+    dpgContext,
     bodyType,
     parameters
   ).join("\n\n");
   const type = extractNameFromCadlType(
     program,
+    dpgContext,
     bodyType,
     importedModels,
     headers
   );
-  const schema = getSchemaForType(program, bodyType);
+  const schema = getSchemaForType(program, dpgContext, bodyType);
   return {
     isPartialBody: false,
     body: [
@@ -304,6 +321,7 @@ function transformBinaryBody(
 
 function transformMultiFormBody(
   program: Program,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>
@@ -311,9 +329,15 @@ function transformMultiFormBody(
   const isModelBody = bodyType.kind === "Model";
 
   if (!isModelBody) {
-    const type = extractNameFromCadlType(program, bodyType, importedModels);
+    const type = extractNameFromCadlType(
+      program,
+      dpgContext,
+      bodyType,
+      importedModels
+    );
     const description = extractDescriptionsFromBody(
       program,
+      dpgContext,
       bodyType,
       parameters
     ).join("\n\n");
@@ -338,10 +362,14 @@ function transformMultiFormBody(
 
   for (const [paramName, paramType] of bodyType.properties) {
     let type: string;
-    const bodySchema = getSchemaForType(program, paramType.type, [
-      SchemaContext.Input,
-      SchemaContext.Exception
-    ]) as any;
+    const bodySchema = getSchemaForType(
+      program,
+      dpgContext,
+      paramType.type,
+      [SchemaContext.Exception, SchemaContext.Input],
+      false,
+      paramType
+    ) as any;
     if (bodySchema?.format === "byte") {
       type = getBinaryType([SchemaContext.Input, SchemaContext.Exception]);
     } else if (bodySchema?.items?.format === "byte") {
@@ -350,7 +378,12 @@ function transformMultiFormBody(
         SchemaContext.Exception
       ])}>`;
     } else {
-      type = extractNameFromCadlType(program, paramType.type, importedModels);
+      type = extractNameFromCadlType(
+        program,
+        dpgContext,
+        paramType.type,
+        importedModels
+      );
     }
     bodyParameters.body!.push({
       name: paramName,
@@ -375,11 +408,12 @@ function getBodyDetail(bodyType: Type, headers: ParameterMetadata[]) {
 
 function extractNameFromCadlType(
   program: Program,
+  dpgContext: SdkContext,
   cadlType: Type,
   importedModels: Set<string>,
   headers?: ParameterMetadata[]
 ) {
-  const bodySchema = getSchemaForType(program, cadlType, [
+  const bodySchema = getSchemaForType(program, dpgContext, cadlType, [
     SchemaContext.Input,
     SchemaContext.Exception
   ]) as Schema;
@@ -437,6 +471,7 @@ function generateAnomymousModelSigniture(
 
 function extractDescriptionsFromBody(
   program: Program,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters
 ) {
@@ -445,7 +480,7 @@ function extractDescriptionsFromBody(
     getFormattedPropertyDoc(
       program,
       parameters.bodyParameter,
-      getSchemaForType(program, bodyType, [
+      getSchemaForType(program, dpgContext, bodyType, [
         SchemaContext.Input,
         SchemaContext.Exception
       ])

package/src/transform/transformPaths.ts

@@ -48,13 +48,13 @@ export function transformPaths(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
-      transformOperation(program, route, paths, dpgContext, operationGroup);
+      transformOperation(program, dpgContext, route, paths, operationGroup);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
-    transformOperation(program, route, paths, dpgContext);
+    transformOperation(program, dpgContext, route, paths);
   }
   return paths;
 }
@@ -97,9 +97,10 @@ function getResponseTypes(
 
 function transformOperation(
   program: Program,
+  dpgContext: SdkContext,
   route: HttpOperation,
   paths: Paths,
-  dpgContext: SdkContext,
+
   operationGroup?: SdkOperationGroup
 ) {
   const respNames = [];
@@ -148,8 +149,12 @@ function transformOperation(
           return {
             name: p.name,
             type: p.param.sourceProperty
-              ? getSchemaForType(program, p.param.sourceProperty?.type).type
-              : getSchemaForType(program, p.param.type).type,
+              ? getSchemaForType(
+                  program,
+                  dpgContext,
+                  p.param.sourceProperty?.type
+                ).type
+              : getSchemaForType(program, dpgContext, p.param.type).type,
             description: getDoc(program, p.param)
           };
         }),

package/src/transform/transformResponses.ts

@@ -79,9 +79,9 @@ export function transformToResponseTypes(
         description: resp.description
       };
       // transform header
-      const headers = transformHeaders(program, resp);
+      const headers = transformHeaders(program, dpgContext, resp);
       // transform body
-      const body = transformBody(program, resp, inputImportedSet);
+      const body = transformBody(program, dpgContext, resp, inputImportedSet);
       rlcOperationUnit.responses.push({
         ...rlcResponseUnit,
         headers,
@@ -110,6 +110,7 @@ export function transformToResponseTypes(
  */
 function transformHeaders(
   program: Program,
+  dpgContext: SdkContext,
   response: HttpOperationResponse
 ): ResponseHeaderSchema[] | undefined {
   if (!response.responses.length) {
@@ -131,7 +132,7 @@ function transformHeaders(
       if (!value) {
         continue;
       }
-      const typeSchema = getSchemaForType(program, value!.type, [
+      const typeSchema = getSchemaForType(program, dpgContext, value!.type, [
         SchemaContext.Output
       ]) as Schema;
       const type = getTypeName(typeSchema);
@@ -150,6 +151,7 @@ function transformHeaders(
 
 function transformBody(
   program: Program,
+  dpgContext: SdkContext,
   response: HttpOperationResponse,
   importedModels: Set<string>
 ) {
@@ -174,7 +176,7 @@ function transformBody(
       descriptions.add("Value may contain any sequence of octets");
       continue;
     }
-    const bodySchema = getSchemaForType(program, body!.type, [
+    const bodySchema = getSchemaForType(program, dpgContext, body!.type, [
       SchemaContext.Output
     ]) as Schema;
     if (bodySchema.fromCore) {

package/src/transform/transformSchemas.ts

@@ -68,7 +68,7 @@ export function transformSchemas(
     }
   }
   program.stateMap(modelKey).forEach((context, cadlModel) => {
-    const model = getSchemaForType(program, cadlModel, context);
+    const model = getSchemaForType(program, dpgContext, cadlModel, context);
     if (model) {
       model.usage = context;
     }

package/test/integration/azurecore.spec.ts

@@ -1,12 +1,19 @@
 import { assert } from "chai";
 import AzureCoreClientFactory, {
-  AzureCoreClient, buildMultiCollection
+  AzureCoreClient,
+  buildMultiCollection,
+  isUnexpected
 } from "./generated/azure/core/src/index.js";
 import AzureCoreTraitsClientFactory, {
   AzureCoreTraitsClient
 } from "./generated/azure/core-traits/src/index.js";
 describe("Azure Core Rest Client", () => {
   let client: AzureCoreClient;
+  const validUser = {
+    id: 1,
+    name: "Madge",
+    etag: "11bdc430-65e8-45ad-81d9-8ffa60d55b59"
+  };
 
   beforeEach(() => {
     client = AzureCoreClientFactory({
@@ -32,12 +39,14 @@ describe("Azure Core Rest Client", () => {
   });
   it("should patch user", async () => {
     try {
-      const result = await client.path("/azure/core/basic/users/{id}", 1).patch({
-        contentType: "application/merge-patch+json",
-        body: {
-          name: "Madge"
-        }
-      });
+      const result = await client
+        .path("/azure/core/basic/users/{id}", 1)
+        .patch({
+          contentType: "application/merge-patch+json",
+          body: {
+            name: "Madge"
+          }
+        });
       assert.strictEqual(result.status, "200");
     } catch (err) {
       assert.fail(err as string);
@@ -55,7 +64,9 @@ describe("Azure Core Rest Client", () => {
 
   it("should delete user", async () => {
     try {
-      const result = await client.path("/azure/core/basic/users/{id}", 1).delete();
+      const result = await client
+        .path("/azure/core/basic/users/{id}", 1)
+        .delete();
       assert.strictEqual(result.status, "204");
     } catch (err) {
       assert.fail(err as string);
@@ -89,6 +100,35 @@ describe("Azure Core Rest Client", () => {
       assert.fail(err as string);
     }
   });
+
+  it("should list with custom pages", async () => {
+    try {
+      const result = await client.path("/azure/core/basic/custom-page").get();
+      if (isUnexpected(result)) {
+        assert.fail("Unexpected status " + result.status);
+      }
+      assert.strictEqual(result.status, "200");
+      assert.isNotEmpty(result.body.items);
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
+
+  it("should export a user", async () => {
+    try {
+      const result = await client
+        .path("/azure/core/basic/users/{id}:export", 1)
+        .post({
+          queryParameters: {
+            format: "json"
+          }
+        });
+      assert.strictEqual(result.status, "200");
+      assert.deepEqual(result.body, validUser);
+    } catch (err) {
+      assert.fail(err as string);
+    }
+  });
 });
 
 describe("Azure Core Traits Rest Client", () => {
@@ -108,12 +148,12 @@ describe("Azure Core Traits Rest Client", () => {
       const result = await client.path("/azure/core/traits/user/{id}", 1).get({
         headers: {
           foo: "123",
-          "If-Match": "valid",
-          "If-None-Match": "invalid",
+          "If-Match": '"valid"',
+          "If-None-Match": '"invalid"',
           "If-Modified-Since": "Thu, 26 Aug 2021 14:38:00 GMT",
           "If-Unmodified-Since": "Fri, 26 Aug 2022 14:38:00 GMT"
         }
-      })
+      });
       assert.strictEqual(result.status, "200");
     } catch (err) {
       assert.fail(err as string);

package/test/integration/generated/arrays/itemTypes/src/arrayItemTypesClient.ts

@@ -2,11 +2,12 @@
 // Licensed under the MIT license.
 
 import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { logger } from "./logger";
 import { ArrayItemTypesClient } from "./clientDefinitions";
 
 /**
  * Initialize a new instance of `ArrayItemTypesClient`
- * @param options type: ClientOptions, the parameter for all optional parameters
+ * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   options: ClientOptions = {}
@@ -23,6 +24,9 @@ export default function createClient(
     userAgentOptions: {
       userAgentPrefix,
     },
+    loggingOptions: {
+      logger: options.loggingOptions?.logger ?? logger.info,
+    },
   };
 
   const client = getClient(baseUrl, options) as ArrayItemTypesClient;

package/test/integration/generated/arrays/itemTypes/src/logger.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("array-itemtypes");

package/test/integration/generated/authentication/apiKey/package.json

@@ -52,7 +52,7 @@
   "autoPublish": false,
   "dependencies": {
     "@azure/core-auth": "^1.3.0",
-    "@azure-rest/core-client": "^1.1.2",
+    "@azure-rest/core-client": "^1.1.3",
     "@azure/core-rest-pipeline": "^1.8.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0"

package/test/integration/generated/authentication/apiKey/src/authApiKeyClient.ts

@@ -2,13 +2,14 @@
 // Licensed under the MIT license.
 
 import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { logger } from "./logger";
 import { KeyCredential } from "@azure/core-auth";
 import { AuthApiKeyClient } from "./clientDefinitions";
 
 /**
  * Initialize a new instance of `AuthApiKeyClient`
- * @param credentials type: KeyCredential, uniquely identify client credential
- * @param options type: ClientOptions, the parameter for all optional parameters
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   credentials: KeyCredential,
@@ -33,6 +34,9 @@ export default function createClient(
     userAgentOptions: {
       userAgentPrefix,
     },
+    loggingOptions: {
+      logger: options.loggingOptions?.logger ?? logger.info,
+    },
   };
 
   const client = getClient(baseUrl, credentials, options) as AuthApiKeyClient;

package/test/integration/generated/authentication/apiKey/src/logger.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("auth-apikey");

package/test/integration/generated/authentication/oauth2/src/authOauth2Client.ts

@@ -2,13 +2,14 @@
 // Licensed under the MIT license.
 
 import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { logger } from "./logger";
 import { TokenCredential } from "@azure/core-auth";
 import { AuthOauth2Client } from "./clientDefinitions";
 
 /**
  * Initialize a new instance of `AuthOauth2Client`
- * @param credentials type: TokenCredential, uniquely identify client credential
- * @param options type: ClientOptions, the parameter for all optional parameters
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   credentials: TokenCredential,
@@ -33,6 +34,9 @@ export default function createClient(
     userAgentOptions: {
       userAgentPrefix,
     },
+    loggingOptions: {
+      logger: options.loggingOptions?.logger ?? logger.info,
+    },
   };
 
   const client = getClient(baseUrl, credentials, options) as AuthOauth2Client;

package/test/integration/generated/authentication/oauth2/src/logger.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("auth-oauth2");

package/test/integration/generated/authentication/union/src/authUnionClient.ts

@@ -2,13 +2,14 @@
 // Licensed under the MIT license.
 
 import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { logger } from "./logger";
 import { TokenCredential, KeyCredential } from "@azure/core-auth";
 import { AuthUnionClient } from "./clientDefinitions";
 
 /**
  * Initialize a new instance of `AuthUnionClient`
- * @param credentials type: TokenCredential|KeyCredential, uniquely identify client credential
- * @param options type: ClientOptions, the parameter for all optional parameters
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   credentials: TokenCredential | KeyCredential,
@@ -34,6 +35,9 @@ export default function createClient(
     userAgentOptions: {
       userAgentPrefix,
     },
+    loggingOptions: {
+      logger: options.loggingOptions?.logger ?? logger.info,
+    },
   };
 
   const client = getClient(baseUrl, credentials, options) as AuthUnionClient;

package/test/integration/generated/authentication/union/src/logger.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("auth-union");

package/test/integration/generated/azure/core/package.json

@@ -52,7 +52,7 @@
   "autoPublish": false,
   "dependencies": {
     "@azure/core-auth": "^1.3.0",
-    "@azure-rest/core-client": "^1.1.2",
+    "@azure-rest/core-client": "^1.1.3",
     "@azure/core-rest-pipeline": "^1.8.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0",

package/test/integration/generated/azure/core/src/azureCoreClient.ts

@@ -2,11 +2,12 @@
 // Licensed under the MIT license.
 
 import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { logger } from "./logger";
 import { AzureCoreClient } from "./clientDefinitions";
 
 /**
  * Initialize a new instance of `AzureCoreClient`
- * @param options type: ClientOptions, the parameter for all optional parameters
+ * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   options: ClientOptions = {}
@@ -23,6 +24,9 @@ export default function createClient(
     userAgentOptions: {
       userAgentPrefix,
     },
+    loggingOptions: {
+      logger: options.loggingOptions?.logger ?? logger.info,
+    },
   };
 
   const client = getClient(baseUrl, options) as AzureCoreClient;

package/test/integration/generated/azure/core/src/logger.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("azurecore");

package/test/integration/generated/azure/core/src/outputModels.ts

@@ -25,8 +25,14 @@ export interface UserOrderOutput {
   detail: string;
 }
 
+export interface UserListResultsOutput {
+  /** List of items. */
+  items: Array<UserOutput>;
+  /** Link to fetch more items. */
+  nextLink?: string;
+}
+
 /** Paged collection of User items */
 export type UserListOutput = Paged<UserOutput>;
 /** Paged collection of User items */
 export type PagedUserOutput = Paged<UserOutput>;
-export type UserListResultsOutput = Paged<UserOutput>;

package/test/integration/generated/azure/core-traits/package.json

@@ -52,7 +52,7 @@
   "autoPublish": false,
   "dependencies": {
     "@azure/core-auth": "^1.3.0",
-    "@azure-rest/core-client": "^1.1.2",
+    "@azure-rest/core-client": "^1.1.3",
     "@azure/core-rest-pipeline": "^1.8.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0"

package/test/integration/generated/azure/core-traits/src/azureCoreTraitsClient.ts

@@ -2,11 +2,12 @@
 // Licensed under the MIT license.
 
 import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { logger } from "./logger";
 import { AzureCoreTraitsClient } from "./clientDefinitions";
 
 /**
  * Initialize a new instance of `AzureCoreTraitsClient`
- * @param options type: ClientOptions, the parameter for all optional parameters
+ * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   options: ClientOptions = {}
@@ -23,6 +24,9 @@ export default function createClient(
     userAgentOptions: {
       userAgentPrefix,
     },
+    loggingOptions: {
+      logger: options.loggingOptions?.logger ?? logger.info,
+    },
   };
 
   const client = getClient(baseUrl, options) as AzureCoreTraitsClient;

package/test/integration/generated/azure/core-traits/src/logger.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("azurecoretraits");

package/test/integration/generated/azure/core-traits/src/outputModels.ts

@@ -1,6 +1,21 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+/** Provides the 'Repeatability-*' headers to enable repeatable requests. */
+export interface RepeatabilityRequestHeadersOutput {}
+
+/** Provides the 'Repeatability-*' headers to enable repeatable requests. */
+export interface RepeatabilityResponseHeadersOutput {}
+
+/** Provides the 'If-*' headers to enable conditional (cached) responses */
+export interface ConditionalRequestHeadersOutput {}
+
+/** Provides the 'ETag' header to enable conditional (cached) requests */
+export interface EtagResponseEnvelopeOutput {}
+
+/** Provides the 'x-ms-client-request-id' header to enable request correlation in requests and responses. */
+export interface ClientRequestIdHeaderOutput {}
+
 /** Sample Model */
 export interface UserOutput {
   /** The user's id. */