@azure-tools/rlc-common 0.12.0 → 0.13.0

package/src/interfaces.ts

@@ -10,7 +10,7 @@ export interface RLCModel {
   parameters?: OperationParameter[];
   responses?: OperationResponse[];
   importSet?: Map<ImportKind, Set<string>>;
-  annotations?: AnnotationDetails;
+  helperDetails?: HelperFunctionDetails;
   urlInfo?: UrlInfo;
 }
 
@@ -31,9 +31,10 @@ export interface ApiVersionInfo {
 }
 
 export type ApiVersionPosition = "path" | "query" | "both" | "none";
-export interface AnnotationDetails {
+export interface HelperFunctionDetails {
   hasPaging?: boolean;
   hasLongRunning?: boolean;
+  clientLroOverload?: boolean;
   pageDetails?: PagingDetails;
   hasMultiCollection?: boolean;
   hasPipeCollection?: boolean;
@@ -64,7 +65,7 @@ export interface OperationMethod {
   successStatus: string[];
   responseTypes: ResponseTypes;
   operationName: string;
-  annotations?: OperationAnnotations;
+  operationHelperDetail?: OperationHelperDetail;
 }
 export interface PathMetadata {
   name: string;
@@ -83,11 +84,23 @@ export type PathParameter = {
   value?: string | number | boolean;
 };
 
-export interface OperationAnnotations {
-  isLongRunning?: boolean;
+export interface OperationHelperDetail {
+  lroDetails?: OperationLroDetail;
   isPageable?: boolean;
 }
 
+export const OPERATION_LRO_HIGH_PRIORITY = 0,
+  OPERATION_LRO_LOW_PRIORITY = 1;
+export interface OperationLroDetail {
+  isLongRunning?: boolean;
+  logicalResponseTypes?: ResponseTypes;
+  operationLroOverload?: boolean;
+  /**
+   * This is used to sort the overload order, sorted in descending order
+   */
+  precedence?: number;
+}
+
 export interface RLCOptions {
   includeShortcuts?: boolean;
   multiClient?: boolean;
@@ -224,6 +237,7 @@ export interface ResponseMetadata {
   description?: string;
   headers?: ResponseHeaderSchema[];
   body?: ResponseBodySchema;
+  predefinedName?: string;
 }
 
 export type ResponseHeaderSchema = Schema;

package/src/metadata/buildPackageFile.ts

@@ -153,7 +153,7 @@ function restLevelPackage(model: RLCModel, hasSamplesGenerated: boolean) {
     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",
@@ -161,7 +161,7 @@ function restLevelPackage(model: RLCModel, hasSamplesGenerated: boolean) {
         "@azure/core-paging": "^1.5.0"
       }),
       ...(hasLRO && {
-        "@azure/core-lro": "^2.5.0",
+        "@azure/core-lro": "^2.5.3",
         "@azure/abort-controller": "^1.0.0"
       })
     },

package/src/static/pollingContent.ts

@@ -18,6 +18,13 @@ import {
   SimplePollerLike,
   createHttpPoller
 } from "@azure/core-lro";
+{{#if clientOverload}}
+import {
+  {{#each importedResponses}}
+  {{this}},
+  {{/each}}
+} from "./responses";
+{{/if}}
 {{/if}}
 /**
  * Helper function that builds a Poller object to help polling a long running operation.
@@ -26,6 +33,17 @@ import {
  * @param options - Options to set a resume state or custom polling interval.
  * @returns - A poller object to poll for operation state updates and eventually get the final response.
  */
+{{#if clientOverload}}
+{{#each overloadMap}}
+export async function getLongRunningPoller<
+  TResult extends {{ this.finalResponses }}
+>(
+  client: Client,
+  initialResponse: {{ this.initalResponses }},
+  options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>
+): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
+{{/each}}
+{{/if}}
 export {{#unless useLegacyLro}}async {{/unless}}function getLongRunningPoller<TResult extends HttpResponse>(
   client: Client,
   initialResponse: TResult,

package/types/buildLogger.d.ts

@@ -0,0 +1,5 @@
+import { RLCModel } from "./interfaces.js";
+export declare function buildLogger(model: RLCModel): {
+    path: string;
+    content: string;
+} | undefined;

package/types/helpers/nameConstructors.d.ts

@@ -5,6 +5,7 @@ import { RLCModel } from "../interfaces.js";
  */
 export declare function getResponseTypeName(baseResponseName: string): string;
 export declare function getResponseTypeName(operationGroup: string, operationName: string, statusCode: string): string;
+export declare function getLroLogicalResponseName(operationGroup: string, operationName: string): string;
 /**
  * The prefix of all response types
  * @param operationGroup operation group name e.g string_PutEmpty

package/types/index.d.ts

@@ -25,3 +25,4 @@ export * from "./metadata/buildESLintConfig.js";
 export * from "./metadata/buildLicenseFile.js";
 export * from "./buildSerializeHelper.js";
 export * from "./helpers/apiVersionUtil.js";
+export * from "./buildLogger.js";

package/types/interfaces.d.ts

@@ -8,7 +8,7 @@ export interface RLCModel {
     parameters?: OperationParameter[];
     responses?: OperationResponse[];
     importSet?: Map<ImportKind, Set<string>>;
-    annotations?: AnnotationDetails;
+    helperDetails?: HelperFunctionDetails;
     urlInfo?: UrlInfo;
 }
 export interface PathTemplateApiVersion {
@@ -25,9 +25,10 @@ export interface ApiVersionInfo {
     isCrossedVersion?: boolean;
 }
 export type ApiVersionPosition = "path" | "query" | "both" | "none";
-export interface AnnotationDetails {
+export interface HelperFunctionDetails {
     hasPaging?: boolean;
     hasLongRunning?: boolean;
+    clientLroOverload?: boolean;
     pageDetails?: PagingDetails;
     hasMultiCollection?: boolean;
     hasPipeCollection?: boolean;
@@ -54,7 +55,7 @@ export interface OperationMethod {
     successStatus: string[];
     responseTypes: ResponseTypes;
     operationName: string;
-    annotations?: OperationAnnotations;
+    operationHelperDetail?: OperationHelperDetail;
 }
 export interface PathMetadata {
     name: string;
@@ -70,10 +71,20 @@ export type PathParameter = {
     description?: string;
     value?: string | number | boolean;
 };
-export interface OperationAnnotations {
-    isLongRunning?: boolean;
+export interface OperationHelperDetail {
+    lroDetails?: OperationLroDetail;
     isPageable?: boolean;
 }
+export declare const OPERATION_LRO_HIGH_PRIORITY = 0, OPERATION_LRO_LOW_PRIORITY = 1;
+export interface OperationLroDetail {
+    isLongRunning?: boolean;
+    logicalResponseTypes?: ResponseTypes;
+    operationLroOverload?: boolean;
+    /**
+     * This is used to sort the overload order, sorted in descending order
+     */
+    precedence?: number;
+}
 export interface RLCOptions {
     includeShortcuts?: boolean;
     multiClient?: boolean;
@@ -197,6 +208,7 @@ export interface ResponseMetadata {
     description?: string;
     headers?: ResponseHeaderSchema[];
     body?: ResponseBodySchema;
+    predefinedName?: string;
 }
 export type ResponseHeaderSchema = Schema;
 export type ResponseBodySchema = Schema;

package/types/static/pollingContent.d.ts

@@ -1 +1 @@
-export declare const pollingContent = "\nimport { Client, HttpResponse } from \"@azure-rest/core-client\";\n{{#if useLegacyLro}}\nimport {\n  LongRunningOperation,\n  LroEngine,\n  LroEngineOptions,\n  LroResponse,\n  PollerLike,\n  PollOperationState\n} from \"@azure/core-lro\";\n{{else}}\nimport {\n  CreateHttpPollerOptions,\n  LongRunningOperation,\n  LroResponse,\n  OperationState,\n  SimplePollerLike,\n  createHttpPoller\n} from \"@azure/core-lro\";\n{{/if}}\n/**\n * Helper function that builds a Poller object to help polling a long running operation.\n * @param client - Client to use for sending the request to get additional pages.\n * @param initialResponse - The initial response.\n * @param options - Options to set a resume state or custom polling interval.\n * @returns - A poller object to poll for operation state updates and eventually get the final response.\n */\nexport {{#unless useLegacyLro}}async {{/unless}}function getLongRunningPoller<TResult extends HttpResponse>(\n  client: Client,\n  initialResponse: TResult,\n  {{#if useLegacyLro}}\n  options: LroEngineOptions<TResult, PollOperationState<TResult>> = {}\n  ): PollerLike<PollOperationState<TResult>, TResult> {\n    {{else}}\n    options: CreateHttpPollerOptions<TResult, OperationState<TResult>> = {}\n    ): Promise<SimplePollerLike<OperationState<TResult>, TResult>> {\n    {{/if}}  \n    const poller: LongRunningOperation<TResult> = {\n    requestMethod: initialResponse.request.method,\n    requestPath: initialResponse.request.url,\n    sendInitialRequest: async () => {\n      // In the case of Rest Clients we are building the LRO poller object from a response that's the reason\n      // we are not triggering the initial request here, just extracting the information from the\n      // response we were provided.\n      return getLroResponse(initialResponse);\n    },\n    sendPollRequest: async path => {\n      // This is the callback that is going to be called to poll the service\n      // to get the latest status. We use the client provided and the polling path\n      // which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location\n      // depending on the lro pattern that the service implements. If non is provided we default to the initial path.\n      const response = await client\n        .pathUnchecked(path ?? initialResponse.request.url)\n        .get();\n      const lroResponse = getLroResponse(response as TResult);\n      lroResponse.rawResponse.headers[\"x-ms-original-url\"] =\n        initialResponse.request.url;\n      return lroResponse;\n    }\n  };\n\n  {{#if useLegacyLro}}\n  return new LroEngine(poller, options);\n  {{else}}\n  options.resolveOnUnsuccessful = options.resolveOnUnsuccessful ?? true;\n  return await createHttpPoller(poller, options);\n  {{/if}}\n}\n\n/**\n * Converts a Rest Client response to a response that the LRO implementation understands\n * @param response - a rest client http response\n * @returns - An LRO response that the LRO implementation understands\n */\nfunction getLroResponse<TResult extends HttpResponse>(\n  response: TResult\n): LroResponse<TResult> {\n  if (Number.isNaN(response.status)) {\n    throw new TypeError(\n      `Status code of the response is not a number. Value: ${response.status}`\n    );\n  }\n\n  return {\n    flatResponse: response,\n    rawResponse: {\n      ...response,\n      statusCode: Number.parseInt(response.status),\n      body: response.body\n    }\n  };\n}\n";
+export declare const pollingContent = "\nimport { Client, HttpResponse } from \"@azure-rest/core-client\";\n{{#if useLegacyLro}}\nimport {\n  LongRunningOperation,\n  LroEngine,\n  LroEngineOptions,\n  LroResponse,\n  PollerLike,\n  PollOperationState\n} from \"@azure/core-lro\";\n{{else}}\nimport {\n  CreateHttpPollerOptions,\n  LongRunningOperation,\n  LroResponse,\n  OperationState,\n  SimplePollerLike,\n  createHttpPoller\n} from \"@azure/core-lro\";\n{{#if clientOverload}}\nimport {\n  {{#each importedResponses}}\n  {{this}},\n  {{/each}}\n} from \"./responses\";\n{{/if}}\n{{/if}}\n/**\n * Helper function that builds a Poller object to help polling a long running operation.\n * @param client - Client to use for sending the request to get additional pages.\n * @param initialResponse - The initial response.\n * @param options - Options to set a resume state or custom polling interval.\n * @returns - A poller object to poll for operation state updates and eventually get the final response.\n */\n{{#if clientOverload}}\n{{#each overloadMap}}\nexport async function getLongRunningPoller<\n  TResult extends {{ this.finalResponses }}\n>(\n  client: Client,\n  initialResponse: {{ this.initalResponses }},\n  options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>\n): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;\n{{/each}}\n{{/if}}\nexport {{#unless useLegacyLro}}async {{/unless}}function getLongRunningPoller<TResult extends HttpResponse>(\n  client: Client,\n  initialResponse: TResult,\n  {{#if useLegacyLro}}\n  options: LroEngineOptions<TResult, PollOperationState<TResult>> = {}\n  ): PollerLike<PollOperationState<TResult>, TResult> {\n    {{else}}\n    options: CreateHttpPollerOptions<TResult, OperationState<TResult>> = {}\n    ): Promise<SimplePollerLike<OperationState<TResult>, TResult>> {\n    {{/if}}  \n    const poller: LongRunningOperation<TResult> = {\n    requestMethod: initialResponse.request.method,\n    requestPath: initialResponse.request.url,\n    sendInitialRequest: async () => {\n      // In the case of Rest Clients we are building the LRO poller object from a response that's the reason\n      // we are not triggering the initial request here, just extracting the information from the\n      // response we were provided.\n      return getLroResponse(initialResponse);\n    },\n    sendPollRequest: async path => {\n      // This is the callback that is going to be called to poll the service\n      // to get the latest status. We use the client provided and the polling path\n      // which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location\n      // depending on the lro pattern that the service implements. If non is provided we default to the initial path.\n      const response = await client\n        .pathUnchecked(path ?? initialResponse.request.url)\n        .get();\n      const lroResponse = getLroResponse(response as TResult);\n      lroResponse.rawResponse.headers[\"x-ms-original-url\"] =\n        initialResponse.request.url;\n      return lroResponse;\n    }\n  };\n\n  {{#if useLegacyLro}}\n  return new LroEngine(poller, options);\n  {{else}}\n  options.resolveOnUnsuccessful = options.resolveOnUnsuccessful ?? true;\n  return await createHttpPoller(poller, options);\n  {{/if}}\n}\n\n/**\n * Converts a Rest Client response to a response that the LRO implementation understands\n * @param response - a rest client http response\n * @returns - An LRO response that the LRO implementation understands\n */\nfunction getLroResponse<TResult extends HttpResponse>(\n  response: TResult\n): LroResponse<TResult> {\n  if (Number.isNaN(response.status)) {\n    throw new TypeError(\n      `Status code of the response is not a number. Value: ${response.status}`\n    );\n  }\n\n  return {\n    flatResponse: response,\n    rawResponse: {\n      ...response,\n      statusCode: Number.parseInt(response.status),\n      body: response.body\n    }\n  };\n}\n";