@azure-tools/typespec-ts 0.54.0 → 0.54.2

package/src/rlc-common/buildClient.ts

@@ -1,561 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import {
-  InterfaceDeclarationStructure,
-  OptionalKind,
-  Project,
-  StatementStructures,
-  StructureKind,
-  VariableDeclarationKind,
-  VariableStatementStructure,
-  WriterFunction
-} from "ts-morph";
-import * as path from "path";
-import { NameType, normalizeName } from "./helpers/nameUtils.js";
-import { buildMethodShortcutImplementation } from "./buildMethodShortcuts.js";
-import { RLCModel, File, PathParameter } from "./interfaces.js";
-import {
-  getClientName,
-  getImportModuleName
-} from "./helpers/nameConstructors.js";
-import { getImportSpecifier } from "./helpers/importsUtil.js";
-import { isAzurePackage } from "./helpers/packageUtil.js";
-
-function getClientOptionsInterface(
-  model: RLCModel,
-  clientName: string,
-  optionalUrlParameters?: PathParameter[]
-): OptionalKind<InterfaceDeclarationStructure> | undefined {
-  if (
-    (!optionalUrlParameters || optionalUrlParameters.length === 0) &&
-    !model.apiVersionInfo
-  ) {
-    return undefined;
-  }
-
-  const properties =
-    optionalUrlParameters?.map((param) => {
-      return {
-        name: param.name,
-        type: param.type,
-        hasQuestionToken: true,
-        docs: [
-          param.description ?? "client level optional parameter " + param.name
-        ]
-      };
-    }) ?? [];
-
-  if (
-    model.apiVersionInfo?.isCrossedVersion === false &&
-    !model.urlInfo?.urlParameters?.find((p) => p.name === "apiVersion") &&
-    (model.apiVersionInfo.defaultValue || !model.apiVersionInfo?.required)
-  ) {
-    properties.push({
-      name: "apiVersion",
-      type: "string",
-      hasQuestionToken: true,
-      docs: ["The api version option of the client"]
-    });
-  }
-  return {
-    name: `${clientName}Options`,
-    extends: ["ClientOptions"],
-    isExported: true,
-    properties,
-    docs: ["The optional parameters for the client"]
-  };
-}
-
-export function buildClient(model: RLCModel): File | undefined {
-  const name = normalizeName(model.libraryName, NameType.File);
-  const { srcPath } = model;
-  const project = new Project();
-  const filePath = path.join(srcPath, `${name}.ts`);
-  const clientFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true
-  });
-
-  // Get all paths
-  const clientInterfaceName = getClientName(model);
-
-  normalizeUrlInfo(model);
-  const urlParameters = model?.urlInfo?.urlParameters?.filter(
-    // Do not include parameters with constant values in the signature, these should go in the options bag
-    (p) => p.value === undefined
-  );
-
-  const optionalUrlParameters = model?.urlInfo?.urlParameters?.filter(
-    // Do not include parameters with constant values in the signature, these should go in the options bag
-    (p) => Boolean(p.value)
-  );
-
-  const clientOptionsInterface = getClientOptionsInterface(
-    model,
-    clientInterfaceName,
-    optionalUrlParameters
-  );
-
-  if (clientOptionsInterface) {
-    clientFile.addInterface(clientOptionsInterface);
-  }
-
-  if (!model.options) {
-    return undefined;
-  }
-  const { multiClient, batch } = model.options;
-  const {
-    addCredentials,
-    credentialScopes,
-    credentialKeyHeaderName,
-    customHttpAuthHeaderName,
-    customHttpAuthSharedKeyPrefix
-  } = model.options;
-  const credentialTypes = credentialScopes ? ["TokenCredential"] : [];
-
-  if (credentialKeyHeaderName || customHttpAuthHeaderName) {
-    credentialTypes.push("KeyCredential");
-  }
-
-  const commonClientParams = [
-    ...(urlParameters ?? []),
-    ...(addCredentials === false ||
-    !isSecurityInfoDefined(
-      credentialScopes,
-      credentialKeyHeaderName,
-      customHttpAuthHeaderName
-    )
-      ? []
-      : [
-          {
-            name: "credentials",
-            type: credentialTypes.join(" | "),
-            description: `uniquely identify client credential`
-          }
-        ])
-  ];
-
-  let apiVersionStatement: string = "";
-  // Set the default api-version when we have a default AND its position is query
-  if (
-    model.apiVersionInfo?.isCrossedVersion === false &&
-    !!model.apiVersionInfo?.defaultValue
-  ) {
-    apiVersionStatement = `
-    apiVersion = "${model.apiVersionInfo?.defaultValue}"`;
-  } else if (
-    model.apiVersionInfo?.isCrossedVersion === false &&
-    !model.apiVersionInfo.required
-  ) {
-    apiVersionStatement = `
-    apiVersion`;
-  }
-
-  const allClientParams = [
-    ...commonClientParams,
-    {
-      name:
-        apiVersionStatement === ""
-          ? "options"
-          : `{${apiVersionStatement}, ...options}`,
-      documentName: "options",
-      type: `${clientOptionsInterface?.name ?? "ClientOptions"} = {}`,
-      description: "the parameter for all optional parameters"
-    }
-  ];
-  const functionStatement = {
-    isExported: true,
-    name: `createClient`,
-    parameters: allClientParams,
-    docs: [
-      {
-        description:
-          `Initialize a new instance of \`${clientInterfaceName}\`\n` +
-          allClientParams
-            .map((param) => {
-              return `@param ${param.documentName ?? param.name} - ${
-                param.description ?? "The parameter " + param.name
-              }`;
-            })
-            .join("\n")
-      }
-    ],
-    returnType: clientInterfaceName,
-    isDefaultExport: false,
-    statements: getClientFactoryBody(model, clientInterfaceName, {
-      isMultipleCredential: credentialTypes.length > 1
-    })
-  };
-
-  if (!multiClient || !batch || batch.length === 1) {
-    functionStatement.isDefaultExport = true;
-  }
-  clientFile.addFunction(functionStatement);
-
-  const paths = srcPath.replace(/\//g, path.sep).split(path.sep);
-  while (paths.length > 0 && paths[paths.length - 1] === "") {
-    paths.pop();
-  }
-  const parentPath =
-    paths.lastIndexOf("src") > -1
-      ? paths.length - 1 - paths.lastIndexOf("src")
-      : 0;
-
-  const loggerPath = `${
-    parentPath > 0 ? "../".repeat(parentPath) : "./"
-  }logger`;
-  clientFile.addImportDeclarations([
-    {
-      isTypeOnly: true,
-      namedImports: ["ClientOptions"],
-      moduleSpecifier: getImportSpecifier(
-        "restClient",
-        model.importInfo.runtimeImports
-      )
-    }
-  ]);
-  clientFile.addImportDeclarations([
-    {
-      namedImports: ["getClient"],
-      moduleSpecifier: getImportSpecifier(
-        "restClient",
-        model.importInfo.runtimeImports
-      )
-    }
-  ]);
-  if (isAzurePackage(model)) {
-    clientFile.addImportDeclarations([
-      {
-        namedImports: ["logger"],
-        moduleSpecifier: getImportModuleName(
-          {
-            cjsName: loggerPath,
-            esModulesName: `${loggerPath}.js`
-          },
-          model
-        )
-      }
-    ]);
-  }
-
-  const includeKeyCredentialHelper =
-    customHttpAuthHeaderName &&
-    customHttpAuthSharedKeyPrefix &&
-    credentialTypes.length > 1 &&
-    credentialTypes.includes("KeyCredential");
-  if (
-    addCredentials &&
-    isSecurityInfoDefined(
-      credentialScopes,
-      credentialKeyHeaderName,
-      customHttpAuthHeaderName
-    )
-  ) {
-    clientFile.addImportDeclarations([
-      {
-        isTypeOnly: true,
-        namedImports: credentialTypes,
-        moduleSpecifier: getImportSpecifier(
-          "coreAuth",
-          model.importInfo.runtimeImports
-        )
-      }
-    ]);
-    if (includeKeyCredentialHelper) {
-      clientFile.addImportDeclarations([
-        {
-          namedImports: ["isKeyCredential"],
-          moduleSpecifier: getImportSpecifier(
-            "coreAuth",
-            model.importInfo.runtimeImports
-          )
-        }
-      ]);
-    }
-  }
-  clientFile.addImportDeclarations([
-    {
-      isTypeOnly: true,
-      namedImports: [`${clientInterfaceName}`],
-      moduleSpecifier: getImportModuleName(
-        {
-          cjsName: "./clientDefinitions",
-          esModulesName: "./clientDefinitions.js"
-        },
-        model
-      )
-    }
-  ]);
-  if (
-    (model.importInfo.internalImports?.rlcClientFactory?.importsSet?.size ??
-      0) > 0
-  ) {
-    clientFile.addImportDeclarations([
-      {
-        isTypeOnly: true,
-        namedImports: Array.from(
-          model.importInfo.internalImports.rlcClientFactory.importsSet!
-        ),
-        moduleSpecifier: getImportModuleName(
-          {
-            cjsName: `./models`,
-            esModulesName: `./models.js`
-          },
-          model
-        )
-      }
-    ]);
-  }
-  return { path: filePath, content: clientFile.getFullText() };
-}
-
-function isSecurityInfoDefined(
-  credentialScopes?: string[],
-  credentialKeyHeaderName?: string,
-  customHttpAuthHeaderName?: string
-) {
-  return (
-    credentialScopes || credentialKeyHeaderName || customHttpAuthHeaderName
-  );
-}
-
-interface GetClientFactoryOptions {
-  isMultipleCredential: boolean;
-}
-
-export function getClientFactoryBody(
-  model: RLCModel,
-  clientTypeName: string,
-  options: GetClientFactoryOptions = { isMultipleCredential: false }
-): string | WriterFunction | (string | WriterFunction | StatementStructures)[] {
-  if (!model.options || !model.options.packageDetails || !model.urlInfo) {
-    return "";
-  }
-  const { includeShortcuts, packageDetails, addCredentials } = model.options;
-  let clientPackageName =
-    packageDetails!.nameWithoutScope ?? packageDetails?.name ?? "";
-  const packageVersion = packageDetails.version;
-  const { endpoint, urlParameters } = model.urlInfo;
-
-  const optionalUrlParameters: string[] = [];
-
-  for (const param of urlParameters ?? []) {
-    if (param.name === "apiVersion") {
-      continue;
-    }
-    if (param.value) {
-      const value =
-        typeof param.value === "string" ? `"${param.value}"` : param.value;
-      optionalUrlParameters.push(
-        `const ${param.name} = options.${param.name} ?? ${value};`
-      );
-    }
-  }
-
-  let endpointUrl: string;
-  if (urlParameters && endpoint) {
-    let parsedEndpoint = endpoint;
-    urlParameters.forEach((urlParameter) => {
-      parsedEndpoint = parsedEndpoint.replace(
-        `{${urlParameter.name}}`,
-        `\${${urlParameter.name}}`
-      );
-    });
-    endpointUrl = `options.endpoint ?? \`${parsedEndpoint}\``;
-  } else {
-    endpointUrl = `options.endpoint ?? "${endpoint}"`;
-  }
-
-  if (!model.options.isModularLibrary && !clientPackageName.endsWith("-rest")) {
-    clientPackageName += "-rest";
-  }
-
-  const userAgentInfoStatement =
-    "const userAgentInfo = `azsdk-js-" +
-    clientPackageName +
-    "/" +
-    packageVersion +
-    "`;";
-  const userAgentPrefix =
-    "options.userAgentOptions && options.userAgentOptions.userAgentPrefix ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`: `${userAgentInfo}`;";
-  const userAgentStatement: VariableStatementStructure = {
-    kind: StructureKind.VariableStatement,
-    declarationKind: VariableDeclarationKind.Const,
-    declarations: [{ name: "userAgentPrefix", initializer: userAgentPrefix }]
-  };
-
-  const customHeaderOptions = model.telemetryOptions?.customRequestIdHeaderName
-    ? `,
-    telemetryOptions: {
-      clientRequestIdHeaderName:
-        options.telemetryOptions?.clientRequestIdHeaderName ??
-        "${model.telemetryOptions?.customRequestIdHeaderName}"
-    }`
-    : "";
-
-  const endpointUrlStatement: VariableStatementStructure = {
-    kind: StructureKind.VariableStatement,
-    declarationKind: VariableDeclarationKind.Const,
-    declarations: [{ name: "endpointUrl", initializer: endpointUrl }]
-  };
-
-  const { credentialScopes, credentialKeyHeaderName } = model.options;
-  const scopesString = credentialScopes
-    ? credentialScopes.map((cs) => `"${cs}"`).join(", ") ||
-      "`${endpointUrl}/.default`"
-    : "";
-  const scopes = scopesString
-    ? `scopes: options.credentials?.scopes ?? [${scopesString}],`
-    : "";
-
-  const apiKeyHeaderName = credentialKeyHeaderName
-    ? `apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? "${credentialKeyHeaderName}",`
-    : "";
-  const loggerOptions = isAzurePackage(model)
-    ? `,
-  loggingOptions: {
-    logger: options.loggingOptions?.logger ?? logger.info
-  }`
-    : "";
-
-  const credentialsOptions =
-    (scopes || apiKeyHeaderName) && addCredentials
-      ? `,
-      credentials: {
-        ${scopes}
-        ${apiKeyHeaderName}
-      }`
-      : "";
-  const overrideOptionsStatement = `options = {
-        ...options,
-        userAgentOptions: {
-          userAgentPrefix
-        }${loggerOptions}${customHeaderOptions}${credentialsOptions}
-      };`;
-  const getClient = `const client = getClient(
-        endpointUrl, ${credentialsOptions ? "credentials," : ""} options
-      ) as ${clientTypeName};
-      `;
-  const { customHttpAuthHeaderName, customHttpAuthSharedKeyPrefix } =
-    model.options;
-  let customHttpAuthStatement = "";
-  if (customHttpAuthHeaderName && customHttpAuthSharedKeyPrefix) {
-    if (options.isMultipleCredential) {
-      customHttpAuthStatement = `if (isKeyCredential(credentials)) {
-        client.pipeline.addPolicy({
-          name: "customKeyCredentialPolicy",
-          async sendRequest(request, next) {
-            request.headers.set("Authorization", "Bearer " + credentials.key);
-            return next(request);
-          },
-        });
-      }`;
-    } else {
-      customHttpAuthStatement = `
-      client.pipeline.addPolicy({
-        name: "customKeyCredentialPolicy",
-        async sendRequest(request, next) {
-          request.headers.set("${customHttpAuthHeaderName}", "${customHttpAuthSharedKeyPrefix} " + credentials.key);
-          return next(request);
-        }
-      });`;
-    }
-  }
-
-  let apiVersionPolicyStatement = `client.pipeline.removePolicy({ name: "ApiVersionPolicy" });`;
-  if (
-    isAzurePackage(model) &&
-    model.apiVersionInfo?.isCrossedVersion !== false
-  ) {
-    apiVersionPolicyStatement += `
-      if (options.apiVersion) {
-        logger.warning("This client does not support client api-version, please change it at the operation level");
-      }`;
-  } else if (
-    isAzurePackage(model) &&
-    !model.apiVersionInfo?.defaultValue &&
-    model.apiVersionInfo?.required
-  ) {
-    apiVersionPolicyStatement += `
-      if (options.apiVersion) {
-        logger.warning("This client does not support to set api-version in options, please change it at positional argument");
-      }`;
-  }
-  if (
-    model.apiVersionInfo?.isCrossedVersion === false &&
-    model.apiVersionInfo?.definedPosition === "query"
-  ) {
-    apiVersionPolicyStatement += `
-      client.pipeline.addPolicy({
-        name: 'ClientApiVersionPolicy',
-        sendRequest: (req, next) => {
-          // Use the apiVersion defined in request url directly
-          // Append one if there is no apiVersion and we have one at client options
-          const url = new URL(req.url);
-          if (!url.searchParams.get("api-version") && apiVersion) {
-            req.url = \`\${req.url}\${
-              Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"
-            }api-version=\${apiVersion}\`;
-          }
-    
-          return next(req);
-        },
-      });`;
-  }
-  let returnStatement = `return client;`;
-
-  if (includeShortcuts) {
-    const shortcutImplementations = buildMethodShortcutImplementation(
-      model.paths
-    );
-    const shortcutBody = Object.keys(shortcutImplementations).map((key) => {
-      // If the operation group has an empty name, it means its operations are client
-      // level operations so we need to spread the definitions. Otherwise they are
-      // within an operation group so we add them as key: value
-      const shortcuts = shortcutImplementations[key];
-      return `${
-        key && key !== "client" ? `"${key}":` : "..."
-      } {${shortcuts ? shortcuts.join() : ""}}`;
-    });
-    returnStatement = `return { ...client, ${shortcutBody.join()} };`;
-  }
-
-  return [
-    ...optionalUrlParameters,
-    endpointUrlStatement,
-    userAgentInfoStatement,
-    userAgentStatement,
-    overrideOptionsStatement,
-    getClient,
-    apiVersionPolicyStatement,
-    customHttpAuthStatement,
-    returnStatement
-  ];
-}
-
-function normalizeUrlInfo(model: RLCModel) {
-  if (
-    !model ||
-    !model.urlInfo ||
-    !model.urlInfo.endpoint ||
-    !model.urlInfo.urlParameters ||
-    model.urlInfo.urlParameters.length === 0
-  ) {
-    return;
-  }
-
-  let parsedEndpoint = model.urlInfo.endpoint;
-  const urlParameters = model.urlInfo.urlParameters;
-  urlParameters.forEach((urlParameter) => {
-    const name = urlParameter.name;
-    const normalizedName = normalizeName(name, NameType.Parameter);
-    if (name !== normalizedName) {
-      urlParameter.name = normalizedName;
-      parsedEndpoint = parsedEndpoint.replace(
-        `{${name}}`,
-        `{${normalizedName}}`
-      );
-    }
-  });
-  model.urlInfo.endpoint = parsedEndpoint;
-}