@azure-tools/rlc-common 0.23.0 → 0.24.0

package/src/metadata/buildReadmeFile.ts

@@ -4,7 +4,7 @@ import { RLCModel } from "../interfaces.js";
 import hbs from "handlebars";
 import { NameType, normalizeName } from "../helpers/nameUtils.js";
 
-const readmeTemplate = `# {{ clientDescriptiveName }} library for JavaScript
+const azureReadmeTemplate = `# {{ clientDescriptiveName }} library for JavaScript
 
 {{ description }}
 
@@ -162,9 +162,9 @@ interface Metadata {
 export function buildReadmeFile(model: RLCModel) {
   const metadata = createMetadata(model) ?? {};
   const readmeFileContents = hbs.compile(
-    model.options?.branded === false
-      ? nonBrandedReadmeTemplate
-      : readmeTemplate,
+    model.options?.flavor === "azure"
+      ? azureReadmeTemplate
+      : nonBrandedReadmeTemplate,
     { noEscape: true }
   );
   return {

package/src/metadata/buildRollupConfig.ts

@@ -6,9 +6,11 @@ import { RLCModel } from "../interfaces.js";
 
 export function buildRollupConfig(model: RLCModel) {
   const azureSdkForJs = Boolean(model.options?.azureSdkForJs);
-  const isBranded = model.options?.branded ?? true;
   // Only generate the file when it is not in sdk repo
-  if (isBranded && (azureSdkForJs === true || azureSdkForJs === undefined)) {
+  if (
+    model.options?.flavor === "azure" &&
+    (azureSdkForJs === true || azureSdkForJs === undefined)
+  ) {
     return;
   }
 

package/test/helpers/importsUtil.spec.ts

@@ -7,7 +7,7 @@ import {
 
 describe("#buildRuntimeImports", () => {
   it("should return the correct import set for branded scope", () => {
-    const imports = buildRuntimeImports(true);
+    const imports = buildRuntimeImports("azure");
     expect(imports.commonFallback).to.be.undefined;
     expect(imports.restClient).to.deep.equal({
       type: "restClient",
@@ -17,7 +17,7 @@ describe("#buildRuntimeImports", () => {
   });
 
   it("should return the correct import set for non-branded scope", () => {
-    const imports = buildRuntimeImports(false);
+    const imports = buildRuntimeImports(undefined);
     expect(imports.commonFallback).to.deep.equal({
       type: "commonFallback",
       specifier: "@typespec/ts-http-runtime",
@@ -41,7 +41,7 @@ describe("#getImportSpecifier", () => {
   });
 
   describe("#branded", () => {
-    const branded = buildRuntimeImports(true);
+    const branded = buildRuntimeImports("azure");
     it("should return the correct import specifier for core auth", () => {
       expect(getImportSpecifier("coreAuth", branded)).to.equal(
         "@azure/core-auth"
@@ -54,7 +54,7 @@ describe("#getImportSpecifier", () => {
   });
 
   describe("#non-branded", () => {
-    const nonBranded = buildRuntimeImports(false);
+    const nonBranded = buildRuntimeImports(undefined);
     it("should return the correct import specifier for core auth", () => {
       expect(getImportSpecifier("coreAuth", nonBranded)).to.equal(
         "@typespec/ts-http-runtime"

package/types/helpers/importsUtil.d.ts

@@ -1,11 +1,11 @@
 import { SourceFile } from "ts-morph";
-import { ImportType, Imports } from "../interfaces.js";
+import { ImportType, Imports, PackageFlavor } from "../interfaces.js";
 /**
  * Build the common imports for generated SDK
- * @param branded whether to use azure-branded imports, the default value is true for azure branded
+ * @param flavor flavor of SDK to generate, if any. When set to "azure", Azure Core packages will be used. When unset, the generic `ts-http-runtime` package will be used.
  * @returns
  */
-export declare function buildRuntimeImports(branded?: boolean): Imports;
+export declare function buildRuntimeImports(flavor?: PackageFlavor): Imports;
 /**
  * Initialize the inner imports for parameter and response, the import set would be used for referred models
  * @returns

package/types/interfaces.d.ts

@@ -143,6 +143,10 @@ export interface OperationLroDetail {
      */
     precedence?: number;
 }
+/**
+ * Flavor of the package to generate. If "azure", an Azure-branded package should be generated. If left undefined, a package without Azure branding will be generated.
+ */
+export type PackageFlavor = "azure" | undefined;
 export interface RLCOptions {
     includeShortcuts?: boolean;
     multiClient?: boolean;
@@ -184,7 +188,7 @@ export interface RLCOptions {
     sourceFrom?: "TypeSpec" | "Swagger";
     isModularLibrary?: boolean;
     enableOperationGroup?: boolean;
-    branded?: boolean;
+    flavor?: PackageFlavor;
     enableModelNamespace?: boolean;
     hierarchyClient?: boolean;
 }