@azure-tools/typespec-ts 0.56.0-dev.12 → 0.56.0-dev.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.56.0-dev.12",
+  "version": "0.56.0-dev.14",
   "description": "A TypeSpec emitter for TypeScript",
   "main": "dist/src/index.js",
   "type": "module",
@@ -25,8 +25,8 @@
     "@azure-tools/azure-http-specs": "^0.1.0-alpha.42 || >=0.1.0-alpha.43-dev <0.1.0-alpha.43",
     "@azure-tools/typespec-autorest": "^0.69.1 || >=0.70.0-dev <0.70.0",
     "@azure-tools/typespec-azure-core": "^0.69.0 || >=0.70.0-dev <0.70.0",
-    "@azure-tools/typespec-azure-resource-manager": "^0.69.1 || >=0.70.0-dev <0.70.0",
-    "@azure-tools/typespec-client-generator-core": "^0.69.1 || >=0.70.0-dev <0.70.0",
+    "@azure-tools/typespec-azure-resource-manager": "^0.69.2 || >=0.70.0-dev <0.70.0",
+    "@azure-tools/typespec-client-generator-core": "^0.69.2 || >=0.70.0-dev <0.70.0",
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.6.0",
     "@azure/core-lro": "^3.1.0",
@@ -51,7 +51,7 @@
   },
   "peerDependencies": {
     "@azure-tools/typespec-azure-core": "^0.69.0 || >=0.70.0-dev <0.70.0",
-    "@azure-tools/typespec-client-generator-core": "^0.69.1 || >=0.70.0-dev <0.70.0",
+    "@azure-tools/typespec-client-generator-core": "^0.69.2 || >=0.70.0-dev <0.70.0",
     "@typespec/compiler": "^1.13.0",
     "@typespec/http": "^1.13.0",
     "@typespec/rest": "^0.83.0 || >=0.84.0-dev <0.84.0",

package/src/lib.ts

@@ -6,6 +6,21 @@ import { Options } from "prettier";
 import { PackageDetails } from "./interfaces.js";
 
 export interface EmitterOptions {
+  /**
+   * Use this flag if you would like to generate the sdk only for a specific version.
+   * Also accepts values `latest` and `all`, or a map from service namespace full name to version for multi-service packages.
+   */
+  "api-version"?: string | Record<string, string>;
+  /**
+   * Specifies the directory where the emitter will look for example files.
+   * Defaults to an `examples` directory located at the project root.
+   */
+  "examples-dir"?: string;
+  /**
+   * Specifies the namespace you want to override for namespaces set in the spec.
+   * With this config, all namespace for the spec types will default to it.
+   */
+  namespace?: string;
   /**
    * Indicates whether to include response headers in the generated response type for modular operations.
    * When set to true, modular operation responses with model or void bodies will have their headers
@@ -50,8 +65,6 @@ export interface EmitterOptions {
   "ignore-property-name-normalize"?: boolean;
   "typespec-title-map"?: Record<string, string>;
   "ignore-enum-member-name-normalize"?: boolean;
-  //TODO should remove this after finish the release tool test
-  "should-use-pnpm-dep"?: boolean;
   "ignore-nullable-on-optional"?: boolean;
   /**
    * When set to true (default for Azure services), non-model return types (arrays, scalars, enums,
@@ -84,6 +97,31 @@ export const EmitterOptionsSchema: JSONSchemaType<EmitterOptions> = {
   type: "object",
   additionalProperties: true,
   properties: {
+    "api-version": {
+      oneOf: [
+        { type: "string", nullable: true },
+        {
+          type: "object",
+          additionalProperties: { type: "string" },
+          required: [],
+          nullable: true,
+        },
+      ],
+      description:
+        "Use this flag if you would like to generate the sdk only for a specific version. Default value is the latest version. Also accepts values `latest` and `all`. For multi-service packages, provide a map from each service namespace's full name to its desired version; services not listed default to their latest version.",
+    } as any,
+    "examples-dir": {
+      type: "string",
+      nullable: true,
+      description:
+        "Specifies the directory where the emitter will look for example files. If the flag isn't set, the emitter defaults to using an `examples` directory located at the project root.",
+    },
+    namespace: {
+      type: "string",
+      nullable: true,
+      description:
+        "Specifies the namespace you want to override for namespaces set in the spec. With this config, all namespace for the spec types will default to it.",
+    },
     "include-headers-in-response": {
       type: "boolean",
       nullable: true,
@@ -245,11 +283,6 @@ export const EmitterOptionsSchema: JSONSchemaType<EmitterOptions> = {
         "```",
       ].join("\n"),
     },
-    "should-use-pnpm-dep": {
-      type: "boolean",
-      nullable: true,
-      description: "Internal option for test.",
-    },
     "ignore-nullable-on-optional": {
       type: "boolean",
       nullable: true,

package/src/modular/build-classical-client.ts

@@ -5,7 +5,7 @@ import {
   SourceFile,
   StructureKind,
 } from "ts-morph";
-import { buildUserAgentOptions, getClientParametersDeclaration } from "./helpers/client-helpers.js";
+import { getClientParametersDeclaration } from "./helpers/client-helpers.js";
 import { getClassicalClientName, getClientName } from "./helpers/naming-helpers.js";
 import { ModularEmitterOptions } from "./interfaces.js";
 
@@ -127,11 +127,7 @@ export function buildClassicalClient(
     .map((p) => p.name)
     .map((x) => {
       if (x === "options") {
-        return `{...options, userAgentOptions: ${buildUserAgentOptions(
-          constructor,
-          emitterOptions,
-          "azsdk-js-client",
-        )}}`;
+        return `options`;
       } else if (x.toLowerCase() === "subscriptionid" && shouldSubscriptionIdOptional) {
         return `subscriptionId ?? ""`;
       } else {

package/src/modular/helpers/client-helpers.ts

@@ -241,7 +241,7 @@ export function buildGetClientOptionsParam(
   endpointParam: string,
   apiVersionParamName?: string,
 ): string {
-  const userAgentOptions = buildUserAgentOptions(context, emitterOptions, "azsdk-js-api");
+  const userAgentOptions = buildUserAgentOptions(context, emitterOptions);
   const loggingOptions = buildLoggingOptions();
   const credentials = buildCredentials(emitterOptions, endpointParam);
 
@@ -313,10 +313,14 @@ function buildLoggingOptions(): string | undefined {
   return `{ logger: options.loggingOptions?.logger ?? logger.info }`;
 }
 
+/**
+ * Builds the `userAgentOptions` for the generated client, producing a telemetry
+ * prefix of the form `[<application_id> ]azsdk-js-<package>/<version>` per the Azure
+ * Core telemetry policy: https://azure.github.io/azure-sdk/general_azurecore.html#telemetry-policy
+ */
 export function buildUserAgentOptions(
   context: StatementedNode,
   emitterOptions: ModularEmitterOptions,
-  sdkUserAgentPrefix: string,
 ): string {
   const userAgentStatements = [];
   const prefixFromOptions = "const prefixFromOptions = options?.userAgentOptions?.userAgentPrefix;";
@@ -329,21 +333,20 @@ export function buildUserAgentOptions(
   const packageVersion = emitterOptions.options.packageDetails?.version ?? "";
 
   const userAgentInfoStatement =
-    packageVersion && clientPackageName && sdkUserAgentPrefix.includes("api")
+    packageVersion && clientPackageName
       ? "const userAgentInfo = `azsdk-js-" + clientPackageName + "/" + packageVersion + "`;"
       : "";
 
-  if (userAgentInfoStatement) {
-    userAgentStatements.push(userAgentInfoStatement);
+  if (!userAgentInfoStatement) {
+    // Without package name/version we cannot build a meaningful telemetry token,
+    // so we leave the user agent untouched (the caller's userAgentOptions still flow
+    // through `...options`) and let core-rest-pipeline defaults apply.
+    return "";
   }
-  const userAgentPrefix = `const userAgentPrefix = ${
-    "prefixFromOptions ? `${prefixFromOptions} " +
-    sdkUserAgentPrefix +
-    `${userAgentInfoStatement ? " ${userAgentInfo}" : ""}` +
-    "` : `" +
-    `${sdkUserAgentPrefix}` +
-    `${userAgentInfoStatement ? " ${userAgentInfo}`" : "`"}`
-  };`;
+
+  userAgentStatements.push(userAgentInfoStatement);
+  const userAgentPrefix =
+    "const userAgentPrefix = prefixFromOptions ? `${prefixFromOptions} ${userAgentInfo}` : `${userAgentInfo}`;";
   userAgentStatements.push(userAgentPrefix);
 
   context.addStatements(userAgentStatements.join("\n"));