@azure-tools/typespec-ts 0.54.2 → 0.55.0-dev.10

package/src/rlc-common/helpers/value-generation-util.ts

@@ -1,234 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import { getImmediateParentsNames } from "../build-object-types.js";
-import {
-  ArraySchema,
-  DictionarySchema,
-  ObjectSchema,
-  Schema,
-  SchemaContext,
-} from "../interfaces.js";
-import {
-  TypeScriptType,
-  getArrayObjectType,
-  getNativeArrayType,
-  getRecordType,
-  getUnionType,
-  isArrayObject,
-  isNativeArray,
-  leaveBracket,
-  leaveStringQuotes,
-  toTypeScriptTypeFromName,
-  toTypeScriptTypeFromSchema,
-} from "./type-util.js";
-
-/**
- * Generate parameter type value for the given type and parameter name
- * @param type the typescript type
- * @param parameterName the parameter name
- * @param schemaMap the schema info to help generate the value
- * @param path optional path to help detect self reference
- * @param _allowMockValue the flag to indicate whether to allow mock value, currently we always generate mock value
- * @returns
- */
-export function generateParameterTypeValue(
-  type: string,
-  parameterName: string,
-  schemaMap: Map<string, Schema>,
-  path: Set<string> = new Set(),
-  _allowMockValue = true,
-): string | undefined {
-  type = leaveBracket(type?.trim());
-  let tsType: TypeScriptType | undefined;
-  // Give priority to suggest the ts-type from schema
-  if (schemaMap.has(type)) {
-    tsType = toTypeScriptTypeFromSchema(schemaMap.get(type)!);
-  }
-  // Fallback to suggest ts-type from the type iteself
-  if (!tsType) {
-    tsType = toTypeScriptTypeFromName(type);
-  }
-  switch (tsType) {
-    case TypeScriptType.string:
-      return `"{Your ${leaveStringQuotes(parameterName)}}"`;
-    case TypeScriptType.number:
-      return "123";
-    case TypeScriptType.boolean:
-      return "true";
-    case TypeScriptType.date:
-      return "new Date()";
-    case TypeScriptType.unknown:
-      return `"Unknown Type"`;
-    case TypeScriptType.object: {
-      return generateObjectValues(type, parameterName, schemaMap, path);
-    }
-    case TypeScriptType.array: {
-      return generateArrayValues(type, parameterName, schemaMap, path);
-    }
-    case TypeScriptType.record: {
-      return generateRecordValues(type, parameterName, schemaMap, path);
-    }
-    case TypeScriptType.enum: {
-      return mockEnumValues(type, parameterName, schemaMap, path);
-    }
-    case TypeScriptType.union: {
-      return mockUnionValues(type, parameterName, schemaMap, path);
-    }
-    case TypeScriptType.constant:
-      return type;
-  }
-  return `undefined /**FIXME */`;
-}
-
-function mockEnumValues(
-  type: string,
-  parameterName: string,
-  schemaMap: Map<string, Schema>,
-  path: Set<string> = new Set(),
-) {
-  const schema = schemaMap.get(type);
-  if (schema && schema.enum && schema.enum.length > 0) {
-    return schema.enum[0].type;
-  }
-  return generateParameterTypeValue(getUnionType(type), parameterName, schemaMap, path);
-}
-
-function mockUnionValues(
-  type: string,
-  parameterName: string,
-  schemaMap: Map<string, Schema>,
-  path: Set<string> = new Set(),
-) {
-  const schema = schemaMap.get(type);
-  if (schema && schema.enum && schema.enum.length > 0) {
-    addToSchemaMap(schemaMap, schema.enum[0]);
-    return generateParameterTypeValue(
-      getAccurateTypeName(schema.enum[0]) ?? schema.enum[0],
-      parameterName,
-      schemaMap,
-      path,
-    );
-  }
-  return generateParameterTypeValue(getUnionType(type), parameterName, schemaMap, path);
-}
-
-function generateRecordValues(
-  type: string,
-  parameterName: string,
-  schemaMap: Map<string, Schema>,
-  path: Set<string> = new Set(),
-) {
-  let recordType = getRecordType(type);
-  const schema = schemaMap.get(type) as DictionarySchema;
-  if (schema && schema.additionalProperties) {
-    recordType = getAccurateTypeName(schema.additionalProperties);
-    addToSchemaMap(schemaMap, schema.additionalProperties);
-  }
-
-  return recordType
-    ? `{"key": ${generateParameterTypeValue(recordType, parameterName, schemaMap, path)}}`
-    : `{}`;
-}
-
-function generateArrayValues(
-  type: string,
-  parameterName: string,
-  schemaMap: Map<string, Schema>,
-  path: Set<string> = new Set(),
-) {
-  let arrayType;
-  const schema = schemaMap.get(type) as ArraySchema;
-  if (schema && schema.items) {
-    arrayType = getAccurateTypeName(schema.items);
-    addToSchemaMap(schemaMap, schema.items);
-  } else if (isArrayObject(type)) {
-    arrayType = getArrayObjectType(type);
-  } else if (isNativeArray(type)) {
-    arrayType = getNativeArrayType(type);
-  }
-  const itemValue = arrayType
-    ? generateParameterTypeValue(arrayType, parameterName, schemaMap, path)
-    : undefined;
-  return itemValue ? `[${itemValue}]` : `[]`;
-}
-
-function generateObjectValues(
-  type: string,
-  _parameterName: string,
-  schemaMap: Map<string, Schema>,
-  path: Set<string> = new Set(),
-) {
-  if (path.has(type)) {
-    // skip generating if self referenced
-    return `{} as any /**FIXME */`;
-  }
-  path.add(type);
-  // Extract all properties from the schema
-  const allProperties = getAllProperties(schemaMap.get(type), schemaMap);
-  const values = extractObjectProperties(allProperties, schemaMap, path);
-
-  path.delete(type);
-  return `{${values.join(", ")}}`;
-}
-
-function getAllProperties(
-  schema?: ObjectSchema,
-  schemaMap: Map<string, Schema> = new Map(),
-): Map<string, Schema> {
-  const propertiesMap: Map<string, Schema> = new Map();
-  if (!schema) {
-    return new Map();
-  }
-  getImmediateParentsNames(schema, [SchemaContext.Input])?.forEach((p) => {
-    const parentProperties = getAllProperties(schemaMap.get(p), schemaMap);
-    for (const prop of parentProperties.keys()) {
-      propertiesMap.set(prop, parentProperties.get(prop)!);
-    }
-  });
-  for (const prop in schema.properties) {
-    const propValue = schema.properties[prop];
-    if (propValue) {
-      propertiesMap.set(prop, propValue);
-    }
-  }
-  return propertiesMap;
-}
-
-function extractObjectProperties(
-  properties: Map<string, Schema>,
-  schemaMap: Map<string, Schema> = new Map(),
-  path: Set<string> = new Set(),
-) {
-  const values: string[] = [];
-  for (const name of properties.keys()) {
-    const property = properties.get(name);
-    if (!property || property.readOnly || property.type === "never") {
-      continue;
-    }
-    addToSchemaMap(schemaMap, property);
-    values.push(
-      `${name}: ` +
-        generateParameterTypeValue(getAccurateTypeName(property), name, schemaMap, path),
-    );
-  }
-  return values;
-}
-
-function getAccurateTypeName(schema: Schema) {
-  // For extensible enum, fallback to use the type
-  if (schema.typeName === "string" && schema.enum && schema.enum.length > 0) {
-    return schema.type;
-  }
-  return schema.typeName ?? schema.type;
-}
-
-function addToSchemaMap(schemaMap: Map<string, Schema>, schema: Schema) {
-  const type = getAccurateTypeName(schema);
-  if (!type) {
-    return;
-  }
-  if (!schemaMap.has(type) && !["string", "number", "boolean"].includes(schema.type)) {
-    schemaMap.set(type, schema);
-  }
-}

package/src/rlc-common/metadata/build-rollup-config.ts

@@ -1,147 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import { Project } from "ts-morph";
-import { isAzurePackage } from "../helpers/package-util.js";
-import { RLCModel } from "../interfaces.js";
-
-export function buildRollupConfig(model: RLCModel) {
-  const azureSdkForJs = Boolean(model.options?.azureSdkForJs);
-  // Only generate the file when it is not in sdk repo
-  if (isAzurePackage(model) && (azureSdkForJs === true || azureSdkForJs === undefined)) {
-    return;
-  }
-
-  const project = new Project();
-  const filePath = "rollup.config.js";
-  const rollupFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true,
-  });
-
-  rollupFile.addStatements(
-    `import nodeResolve from "@rollup/plugin-node-resolve";
-    import cjs from "@rollup/plugin-commonjs";
-    import sourcemaps from "rollup-plugin-sourcemaps";
-    import multiEntry from "@rollup/plugin-multi-entry";
-    import json from "@rollup/plugin-json";
-    
-    import nodeBuiltins from "builtin-modules";
-    
-    // #region Warning Handler
-    
-    /**
-     * A function that can determine whether a rollup warning should be ignored. If
-     * the function returns \`true\`, then the warning will not be displayed.
-     */
-    
-    function ignoreNiseSinonEval(warning) {
-      return (
-        warning.code === "EVAL" &&
-        (warning.id && ((warning.id.includes("node_modules/nise")) ||
-          warning.id.includes("node_modules/sinon")) === true)
-      );
-    }
-    
-    function ignoreChaiCircularDependency(warning) {
-      return (
-        warning.code === "CIRCULAR_DEPENDENCY" &&
-        (warning.importer && warning.importer.includes("node_modules/chai") === true)
-      );
-    }
-    
-    const warningInhibitors = [
-      ignoreChaiCircularDependency,
-      ignoreNiseSinonEval
-    ];
-    
-    /**
-     * Construct a warning handler for the shared rollup configuration
-     * that ignores certain warnings that are not relevant to testing.
-     */
-    function makeOnWarnForTesting() {
-      return (warning, warn) => {
-        // If every inhibitor returns false (i.e. no inhibitors), then show the warning
-        if (warningInhibitors.every(inhib => !inhib(warning))) {
-          warn(warning);
-        }
-      };
-    }
-    
-    // #endregion
-    
-    function makeBrowserTestConfig() {
-      const config = {
-        input: {
-          include: ["dist-esm/test/**/*.spec.js"],
-          exclude: ["dist-esm/test/**/node/**"]
-        },
-        output: {
-          file: \`dist-test/index.browser.js\`,
-          format: "umd",
-          sourcemap: true
-        },
-        preserveSymlinks: false,
-        plugins: [
-          multiEntry({ exports: false }),
-          nodeResolve({
-            mainFields: ["module", "browser"]
-          }),
-          cjs(),
-          json(),
-          sourcemaps()
-          //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
-        ],
-        onwarn: makeOnWarnForTesting(),
-        // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
-        // rollup started respecting the "sideEffects" field in package.json.  Since
-        // our package.json sets "sideEffects=false", this also applies to test
-        // code, which causes all tests to be removed by tree-shaking.
-        treeshake: false
-      };
-    
-      return config;
-    }
-    
-    const defaultConfigurationOptions = {
-      disableBrowserBundle: false
-    };
-    
-    export function makeConfig(
-      pkg,
-      options
-    ) {
-      options = {
-        ...defaultConfigurationOptions,
-        ...(options || {})
-      };
-    
-      const baseConfig = {
-        // Use the package's module field if it has one
-        input: pkg["module"] || "dist-esm/src/index.js",
-        external: [
-          ...nodeBuiltins,
-          ...Object.keys(pkg.dependencies),
-          ...Object.keys(pkg.devDependencies)
-        ],
-        output: { file: "dist/index.js", format: "cjs", sourcemap: true },
-        preserveSymlinks: false,
-        plugins: [sourcemaps(), nodeResolve()]
-      };
-    
-      const config = [baseConfig];
-    
-      if (!options.disableBrowserBundle) {
-        config.push(makeBrowserTestConfig());
-      }
-    
-      return config;
-    }
-    
-    export default makeConfig(require("./package.json"));`,
-  );
-
-  return {
-    path: filePath,
-    content: rollupFile.getFullText(),
-  };
-}

package/src/rlc-common/metadata/package-json/build-azure-standalone-package.ts

@@ -1,123 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import {
-  AzurePackageInfoConfig,
-  getAzureCommonPackageInfo,
-  getAzurePackageDependencies,
-  getAzurePackageDevDependencies,
-} from "./azure-package-common.js";
-import { getCommonPackageScripts, getPackageCommonInfo } from "./package-common.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/package-json/build-flavorless-package.ts

@@ -1,68 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import {
-  PackageCommonInfoConfig,
-  commonPackageDependencies,
-  getCommonPackageDevDependencies,
-  getCommonPackageScripts,
-  getPackageCommonInfo,
-} from "./package-common.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",
-  };
-}