@azure-tools/typespec-ts 0.55.0-dev.1 → 0.55.0-dev.2

package/src/rlc-common/metadata/packageJson/azurePackageCommon.ts

@@ -1,152 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import { PackageCommonInfoConfig, getCommonPackageDevDependencies } from "./packageCommon.js";
-
-export interface AzurePackageInfoConfig extends PackageCommonInfoConfig {
-  hasLro: boolean;
-  specSource: "Swagger" | "TypeSpec";
-}
-
-/**
- * Build the common package.json config for an Azure package.
- */
-export function getAzureCommonPackageInfo(config: AzurePackageInfoConfig) {
-  return {
-    keywords: ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
-    author: "Microsoft Corporation",
-    license: "MIT",
-    ...getAzureCjsCommonInfo(config),
-    ...getAzureEsmCommonInfo(config),
-  };
-}
-
-/**
- * Builds the common dependencies for an Azure package.
- */
-export function getAzurePackageDependencies({
-  hasLro,
-  specSource,
-  dependencies,
-}: AzurePackageInfoConfig) {
-  let azureDependencies: Record<string, string> = {
-    ...dependencies,
-    "@azure-rest/core-client": specSource === "Swagger" ? "^1.4.0" : "^2.3.1",
-    "@azure/core-auth": "^1.6.0",
-    "@azure/core-rest-pipeline": "^1.5.0",
-    "@azure/logger": "^1.0.0",
-    tslib: "^2.6.2",
-  };
-
-  if (hasLro) {
-    azureDependencies = {
-      ...azureDependencies,
-      "@azure/core-lro": "^3.1.0",
-      "@azure/abort-controller": "^2.1.2",
-    };
-  }
-
-  return azureDependencies;
-}
-
-function getAzureCjsCommonInfo({
-  withTests,
-  withSamples,
-  name,
-  nameWithoutScope,
-  moduleKind,
-}: AzurePackageInfoConfig) {
-  if (moduleKind !== "cjs") {
-    return {};
-  }
-
-  return {
-    files: [
-      "dist/",
-      "!dist/**/*.d.*ts.map",
-      withTests || withSamples ? "dist-esm/src/" : "dist-esm/",
-      `types/${nameWithoutScope ?? name}.d.ts`,
-      "README.md",
-      "LICENSE",
-    ],
-  };
-}
-
-function getAzureEsmCommonInfo({ moduleKind }: AzurePackageInfoConfig) {
-  if (moduleKind !== "esm") {
-    return {};
-  }
-  return {
-    files: ["dist/", "!dist/**/*.d.*ts.map", "README.md", "LICENSE"],
-  };
-}
-
-function getAzurePackageCjsDevDependencies({ moduleKind, withTests }: AzurePackageInfoConfig) {
-  if (moduleKind !== "cjs") {
-    return {};
-  }
-  const testDevDependencies = {
-    "@azure-tools/test-credential": "^1.1.0",
-    "@azure-tools/test-recorder": "^3.0.0",
-    nyc: "^15.1.0",
-    mocha: "^11.0.2",
-    "@types/mocha": "^10.0.0",
-    "@types/chai": "^4.2.8",
-    chai: "^4.2.0",
-    "karma-chrome-launcher": "^3.0.0",
-    "karma-coverage": "^2.0.0",
-    "karma-env-preprocessor": "^0.1.1",
-    "karma-firefox-launcher": "^2.1.3",
-    "karma-junit-reporter": "^2.0.1",
-    "karma-mocha-reporter": "^2.2.5",
-    "karma-mocha": "^2.0.1",
-    "karma-source-map-support": "~1.4.0",
-    "karma-sourcemap-loader": "^0.4.0",
-    karma: "^6.2.0",
-  };
-
-  return {
-    ...(withTests && testDevDependencies),
-    "source-map-support": "^0.5.9",
-  };
-}
-
-function getAzurePackageEsmDevDependencies({ moduleKind, withTests }: AzurePackageInfoConfig) {
-  if (moduleKind !== "esm") {
-    return {};
-  }
-
-  let devDependencies: Record<string, string> = {};
-
-  if (withTests) {
-    devDependencies = {
-      ...devDependencies,
-      "@vitest/browser-playwright": "^4.0.6",
-      "@vitest/coverage-istanbul": "^4.0.6",
-      playwright: "^1.41.2",
-      vitest: "^4.0.6",
-      "@azure-tools/test-credential": "^2.0.0",
-      "@azure-tools/test-recorder": "^4.0.0",
-    };
-  }
-
-  return devDependencies;
-}
-
-export function getAzurePackageDevDependencies(config: AzurePackageInfoConfig) {
-  const esmDevDependencies = getAzurePackageEsmDevDependencies(config);
-  const cjsDevDependencies = getAzurePackageCjsDevDependencies(config);
-
-  const testDevDependencies = {
-    "@azure/identity": "^4.2.1",
-  };
-
-  return {
-    dotenv: "^16.0.0",
-    ...getCommonPackageDevDependencies(config),
-    ...(config.withTests && testDevDependencies),
-    ...(config.specSource === "Swagger" && { autorest: "latest" }),
-    ...esmDevDependencies,
-    ...cjsDevDependencies,
-  };
-}

package/src/rlc-common/metadata/packageJson/buildAzureMonorepoPackage.ts

@@ -1,199 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import { AzurePackageInfoConfig, getAzureCommonPackageInfo } from "./azurePackageCommon.js";
-import { getCommonPackageScripts, getPackageCommonInfo } from "./packageCommon.js";
-
-export interface AzureMonorepoInfoConfig extends AzurePackageInfoConfig {
-  monorepoPackageDirectory?: string;
-  clientFilePaths: string[];
-  clientContextPaths?: string[];
-}
-
-/**
- * Builds the package.json for an Azure package that will be hosted in the azure-sdk-for-js mono repo.
- */
-export function buildAzureMonorepoPackage(config: AzureMonorepoInfoConfig) {
-  const packageInfo = {
-    ...getAzureMonorepoPackageInfo(config),
-    ...getAzureMonorepoDependencies(config),
-    scripts: getAzureMonorepoScripts(config),
-    ...getSampleMetadata(config),
-  };
-
-  return packageInfo;
-}
-
-/**
- * Builds the dependencies for an Azure package that will be hosted in the azure-sdk-for-js mono repo.
- */
-export function getAzureMonorepoDependencies(config: AzureMonorepoInfoConfig) {
-  const { hasLro, dependencies, withTests } = config;
-
-  // revert this change after sdk repo update.
-  const runtimeDeps = {
-    ...dependencies,
-    "@azure-rest/core-client": "^2.3.1",
-    ...(hasLro && {
-      "@azure/abort-controller": "^2.1.2",
-    }),
-    "@azure/core-auth": "^1.9.0",
-    ...(hasLro && {
-      "@azure/core-lro": "^3.1.0",
-    }),
-    "@azure/core-rest-pipeline": "^1.20.0",
-    "@azure/core-util": "^1.12.0",
-    "@azure/logger": "^1.2.0",
-    tslib: "^2.8.1",
-  };
-
-  const testDeps = withTests
-    ? {
-        "@vitest/browser-playwright": "catalog:testing",
-        "@vitest/coverage-istanbul": "catalog:testing",
-        dotenv: "catalog:testing",
-        playwright: "catalog:testing",
-        typescript: "catalog:",
-        vitest: "catalog:testing",
-      }
-    : {
-        typescript: "catalog:",
-      };
-
-  return {
-    dependencies: runtimeDeps,
-    devDependencies: {
-      "@azure-tools/test-credential": "workspace:^",
-      "@azure-tools/test-recorder": "workspace:^",
-      "@azure-tools/test-utils-vitest": "workspace:^",
-      "@azure/dev-tool": "workspace:^",
-      "@azure/eslint-plugin-azure-sdk": "workspace:^",
-      "@azure/identity": "catalog:internal",
-      "@types/node": "catalog:",
-      "cross-env": "catalog:",
-      eslint: "catalog:",
-      prettier: "catalog:",
-      rimraf: "catalog:",
-      ...(config.specSource === "Swagger" && {
-        autorest: "catalog:",
-      }),
-      ...testDeps,
-    },
-  };
-}
-
-/**
- * Build the common package.json config for an Azure package that will be hosted in the azure-sdk-for-js mono repo.
- */
-export function getAzureMonorepoPackageInfo(config: AzureMonorepoInfoConfig): Record<string, any> {
-  const commonPackageInfo = getPackageCommonInfo(config);
-  const repositoryDirectory = config.monorepoPackageDirectory ?? "sdk/";
-
-  return {
-    ...commonPackageInfo,
-    ...getAzureCommonPackageInfo(config),
-    "sdk-type": `${config.azureArm ? "mgmt" : "client"}`,
-    repository: {
-      type: "git",
-      url: "git+https://github.com/Azure/azure-sdk-for-js",
-      directory: repositoryDirectory,
-    },
-    bugs: {
-      url: "https://github.com/Azure/azure-sdk-for-js/issues",
-    },
-    ...(config.monorepoPackageDirectory && {
-      homepage: `https://github.com/Azure/azure-sdk-for-js/tree/main/${config.monorepoPackageDirectory}/README.md`,
-    }),
-    prettier: "@azure/eslint-plugin-azure-sdk/prettier.json",
-    "//metadata": getMetadataInfo(config),
-  };
-}
-
-function getSampleMetadata({ name, version, withSamples }: AzureMonorepoInfoConfig) {
-  if (!withSamples) {
-    return {};
-  }
-
-  let apiRefUrlQueryParameter: string = "";
-  if (version.includes("beta")) {
-    apiRefUrlQueryParameter = "?view=azure-node-preview";
-  }
-
-  return {
-    "//sampleConfiguration": {
-      productName: name,
-      productSlugs: ["azure"],
-      disableDocsMs: true,
-      apiRefLink: `https://learn.microsoft.com/javascript/api/${name}${apiRefUrlQueryParameter}`,
-    },
-  };
-}
-
-function addSwaggerMetadata(metadata: Record<string, any>, specSource: "Swagger" | "TypeSpec") {
-  if (specSource !== "Swagger") {
-    return;
-  }
-
-  metadata["constantPaths"].push({
-    path: "swagger/README.md",
-    prefix: "package-version",
-  });
-}
-
-function getAzureMonorepoScripts(config: AzureMonorepoInfoConfig) {
-  const esmScripts = getEsmScripts(config);
-  const skipLinting = config.azureArm && config.isModularLibrary;
-  const buildSampleScripts = config.azureArm
-    ? "tsc -p config/tsconfig.samples.json && dev-tool samples publish -f"
-    : "tsc -p config/tsconfig.samples.json";
-  return {
-    ...getCommonPackageScripts(),
-    "build:samples": config.withSamples ? buildSampleScripts : "echo skipped",
-    "check-format": `prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.{ts,cts,mts}" "test/**/*.{ts,cts,mts}" "*.{js,cjs,mjs,json}" ${
-      config.withSamples ? '"samples-dev/*.ts"' : ""
-    }`,
-    clean: "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
-    "execute:samples": config.withSamples ? "dev-tool samples run samples-dev" : "echo skipped",
-    "extract-api": "rimraf review && dev-tool run extract-api",
-    format: `prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.{ts,cts,mts}" "test/**/*.{ts,cts,mts}" "*.{js,cjs,mjs,json}" ${
-      config.withSamples ? '"samples-dev/*.ts"' : ""
-    }`,
-    "generate:client": "echo skipped",
-    "test:browser": "dev-tool run test:vitest --browser",
-    "lint:fix": skipLinting
-      ? "echo skipped"
-      : "eslint package.json src test --fix --fix-type [problem,suggestion]",
-    lint: skipLinting ? "echo skipped" : "eslint package.json src test",
-    pack: `pnpm pack 2>&1`,
-    ...esmScripts,
-    "update-snippets": "dev-tool run update-snippets",
-  };
-}
-
-function getEsmScripts({ moduleKind }: AzureMonorepoInfoConfig) {
-  if (moduleKind !== "esm") {
-    return {};
-  }
-
-  return {
-    build: "npm run clean && dev-tool run build-package && dev-tool run extract-api",
-    "test:node": "dev-tool run test:vitest",
-    test: "tsc -b --noEmit && npm run test:node && npm run test:browser",
-  };
-}
-
-function getMetadataInfo(config: AzureMonorepoInfoConfig) {
-  const metadata: Record<string, any> = {
-    constantPaths: [],
-  };
-  const paths = config.isModularLibrary ? config.clientContextPaths : config.clientFilePaths;
-  addSwaggerMetadata(metadata, config.specSource);
-  for (const path of paths ?? []) {
-    metadata["constantPaths"].push({
-      path: path,
-      prefix: "userAgentInfo",
-    });
-  }
-
-  return metadata;
-}

package/src/rlc-common/metadata/packageJson/buildAzureStandalonePackage.ts

@@ -1,123 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import {
-  AzurePackageInfoConfig,
-  getAzureCommonPackageInfo,
-  getAzurePackageDependencies,
-  getAzurePackageDevDependencies,
-} from "./azurePackageCommon.js";
-import { getCommonPackageScripts, getPackageCommonInfo } from "./packageCommon.js";
-
-/**
- * Builds the package.json for an Azure package that won't be hosted in the azure-sdk-for-js repo.
- */
-export function buildAzureStandalonePackage(config: AzurePackageInfoConfig) {
-  const packageInfo = {
-    ...getAzureStandalonePackageInfo(config),
-    ...getAzureStandaloneDependencies(config),
-    scripts: getAzureStandaloneScripts(config),
-  };
-
-  return packageInfo;
-}
-
-function getAzureStandalonePackageInfo(config: AzurePackageInfoConfig): Record<string, any> {
-  const commonPackageInfo = getPackageCommonInfo(config);
-
-  return {
-    ...commonPackageInfo,
-    ...getAzureCommonPackageInfo(config),
-  };
-}
-
-function getAzureStandaloneDependencies(config: AzurePackageInfoConfig): Record<string, any> {
-  return {
-    dependencies: {
-      ...getAzurePackageDependencies(config),
-    },
-    devDependencies: {
-      ...getStandaloneDevDependencies(config),
-      "@microsoft/api-extractor": "^7.40.3",
-      rimraf: "^5.0.5",
-      mkdirp: "^3.0.1",
-    },
-  };
-}
-
-function getStandaloneDevDependencies(config: AzurePackageInfoConfig) {
-  return {
-    ...getAzurePackageDevDependencies(config),
-    "@microsoft/api-extractor": "^7.40.3",
-    ...getStandaloneCjsDevDependencies(config),
-  };
-}
-
-function getStandaloneCjsDevDependencies(config: AzurePackageInfoConfig) {
-  if (config.moduleKind !== "cjs") {
-    return {};
-  }
-
-  return {
-    "@rollup/plugin-commonjs": "^24.0.0",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-multi-entry": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^13.1.3",
-    ...(config.moduleKind === "cjs" && config.withTests && { "cross-env": "^7.0.2" }),
-    rollup: "^2.66.1",
-    "rollup-plugin-sourcemaps": "^0.6.3",
-    "uglify-js": "^3.4.9",
-  };
-}
-
-function getAzureStandaloneScripts(config: AzurePackageInfoConfig): Record<string, any> {
-  const testScripts = {
-    "test:browser": "karma start --single-run",
-    "test:node": `nyc mocha -r esm --require source-map-support/register --timeout 5000000 --full-trace "dist-esm/test/{,!(browser)/**/}*.spec.js"`,
-    test: "npm run test:node && npm run test:browser",
-  };
-  return {
-    ...getCommonPackageScripts(),
-    clean: "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
-    ...(config.withTests && testScripts),
-    ...getCjsScripts(config),
-    ...getEsmScripts(config),
-  };
-}
-
-function getCjsScripts(config: AzurePackageInfoConfig): Record<string, any> {
-  if (config.moduleKind !== "cjs") {
-    return {};
-  }
-
-  const testScripts = {
-    "build:test": "tsc -p . && rollup -c 2>&1",
-    "build:browser": "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1",
-    "build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1",
-  };
-
-  return {
-    build:
-      "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
-    ...(config.withTests && testScripts),
-    minify:
-      "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
-  };
-}
-
-function getEsmScripts(config: AzurePackageInfoConfig): Record<string, any> {
-  if (config.moduleKind !== "esm") {
-    return {};
-  }
-
-  const testScripts = {
-    test: "npm run clean && tshy && npm run unit-test:node && npm run unit-test:browser && npm run integration-test",
-    "test:node": "vitest -c vitest.config.ts",
-    "test:browser": "vitest -c vitest.browser.config.ts",
-  };
-
-  return {
-    build: "npm run clean && tshy && npm run extract-api",
-    ...(config.withTests && testScripts),
-  };
-}

package/src/rlc-common/metadata/packageJson/buildFlavorlessPackage.ts

@@ -1,68 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import {
-  PackageCommonInfoConfig,
-  commonPackageDependencies,
-  getCommonPackageDevDependencies,
-  getCommonPackageScripts,
-  getPackageCommonInfo,
-} from "./packageCommon.js";
-
-/**
- * Builds the package.json for a flavorless package.
- */
-export function buildFlavorlessPackage(config: PackageCommonInfoConfig) {
-  const packageInfo = {
-    ...getFlavorlessPackageInfo(config),
-    scripts: getFlavorlessScripts(config),
-    devDependencies: {
-      ...getCommonPackageDevDependencies(config),
-      "@microsoft/api-extractor": "^7.40.3",
-      rimraf: "^5.0.5",
-      mkdirp: "^3.0.1",
-    },
-    dependencies: {
-      ...commonPackageDependencies,
-      "@typespec/ts-http-runtime": "0.1.0",
-    },
-  };
-
-  return packageInfo;
-}
-
-function getFlavorlessPackageInfo(config: PackageCommonInfoConfig): Record<string, any> {
-  const commonPackageInfo = getPackageCommonInfo(config);
-
-  return {
-    ...commonPackageInfo,
-  };
-}
-
-function getFlavorlessScripts(config: PackageCommonInfoConfig) {
-  return {
-    ...getCommonPackageScripts(),
-    ...getCjsScripts(config),
-    ...getEsmScripts(config),
-  };
-}
-
-function getCjsScripts({ moduleKind }: PackageCommonInfoConfig) {
-  if (moduleKind !== "cjs") {
-    return {};
-  }
-
-  return {
-    build: "npm run clean && tsc && npm run extract-api",
-  };
-}
-
-function getEsmScripts({ moduleKind }: PackageCommonInfoConfig) {
-  if (moduleKind !== "esm") {
-    return {};
-  }
-
-  return {
-    build: "npm run clean && tshy && npm run extract-api",
-  };
-}

package/src/rlc-common/test/buildSnippets.ts

@@ -1,29 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
-import { getClientName } from "../helpers/nameConstructors.js";
-import { RLCModel } from "../interfaces.js";
-import { snippetsContent } from "./template.js";
-
-export function buildSnippets(model: RLCModel, clientName?: string, azureSdkForJs?: boolean) {
-  const azureSdkForJsInfo = azureSdkForJs ? azureSdkForJs : model.options?.azureSdkForJs;
-  // to keep the same config for azure scope in buildReadmeFile.ts
-  if (
-    (model?.options?.packageDetails?.scopeName === "azure" ||
-      model?.options?.packageDetails?.scopeName === "azure-rest") &&
-    model.options.addCredentials &&
-    azureSdkForJsInfo
-  ) {
-    return {
-      path: "test/snippets.spec.ts",
-      content: hbs.compile(snippetsContent, { noEscape: true })({
-        clientClassName: clientName ? clientName : getClientName(model),
-        azureArm: model.options?.azureArm,
-        azureSdkForJs: azureSdkForJsInfo,
-        isModularLibrary: model.options.isModularLibrary,
-        hasSubscriptionId: model.options.hasSubscriptionId,
-      }),
-    };
-  }
-  return undefined;
-}