@azure-tools/typespec-ts 0.55.0-dev.6 → 0.55.0-dev.7

package/dist/src/rlc-common/metadata/build-readme-file.js

@@ -0,0 +1,413 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { getClientName } from "../helpers/name-constructors.js";
+import { NameType, normalizeName } from "../helpers/name-utils.js";
+const azureReadmeRLCTemplate = `# {{ clientDescriptiveName }} library for JavaScript
+
+{{ description }}
+
+{{#if azureArm}}
+**If you are not familiar with our REST client, please spend 5 minutes to take a look at {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library, the REST client provides a light-weighted & developer friendly way to call azure rest api
+{{else}}
+**Please rely heavily on {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+{{/if}}
+
+Key links:
+
+{{#if packageSourceURL}}
+- [Source code]({{ packageSourceURL }})
+{{/if}}
+{{#if packageNPMURL}}
+- [Package (NPM)]({{ packageNPMURL }})
+{{/if}}
+{{#if apiRefURL}}
+- [API reference documentation]({{ apiRefURL }})
+{{/if}}
+{{#if serviceDocURL}}
+- [Product documentation]({{ serviceDocURL }})
+{{/if}}
+{{#if samplesURL}}
+- [Samples]({{ samplesURL }})
+{{/if}}
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/){{#if dependencyLink}} and follow [these]({{ dependencyLink }}) instructions{{/if}} to use this package.
+
+### Install the \`{{ clientPackageName }}\` package
+
+Install the {{ clientDescriptiveName }} REST client library for JavaScript with \`npm\`:
+
+\`\`\`bash
+npm install {{ clientPackageName }}
+\`\`\`
+
+### Create and authenticate a \`{{ clientClassName }}\`
+
+To use a [Microsoft Entra token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
+provide an instance of the desired credential type obtained from the
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with Microsoft Entra ID, you must first \`npm\` install [\`@azure/identity\`](https://www.npmjs.com/package/@azure/identity) {{#if dependencyLink}}and
+[{{dependencyDescription }}]({{ dependencyLink }}){{/if}}
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from \`@azure/identity\` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the \`AZURE_LOG_LEVEL\` environment variable to \`info\`. Alternatively, logging can be enabled at runtime by calling \`setLogLevel\` in the \`@azure/logger\`:
+
+\`\`\`ts {{#if generateTest}}snippet:SetLogLevel{{/if}}
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+\`\`\`
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
+`;
+const azureReadmeModularTemplate = `# {{ clientDescriptiveName }} library for JavaScript
+
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for {{ clientDescriptiveName }}.
+
+{{ description }}
+
+Key links:
+
+{{#if packageSourceURL}}
+- [Source code]({{ packageSourceURL }})
+{{/if}}
+{{#if packageNPMURL}}
+- [Package (NPM)]({{ packageNPMURL }})
+{{/if}}
+{{#if apiRefURL}}
+- [API reference documentation]({{ apiRefURL }})
+{{/if}}
+{{#if samplesURL}}
+- [Samples]({{samplesURL}})
+{{/if}}
+
+## Getting started
+
+### Currently supported environments
+
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
+- Latest versions of Safari, Chrome, Edge and Firefox.
+
+See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
+
+{{#if azure}}
+### Prerequisites
+
+- An [Azure subscription][azure_sub].
+{{/if}}
+
+{{#if isReleasablePackage}}
+### Install the \`{{ clientPackageName }}\` package
+
+Install the {{ clientDescriptiveName }} library for JavaScript with \`npm\`:
+
+\`\`\`bash
+npm install {{ clientPackageName }}
+\`\`\`
+{{/if}}
+
+{{#if azure}}
+{{#if addCredentials}}
+### Create and authenticate a \`{{ clientClassName}}\`
+
+To create a client object to access the {{ serviceName }} API, you will need the \`endpoint\` of your {{ serviceName }} resource and a \`credential\`. The {{ clientDescriptiveName }} can use Microsoft Entra credentials to authenticate.
+You can find the endpoint for your {{ serviceName }} resource in the [Azure Portal][azure_portal].
+
+You can authenticate with Microsoft Entra ID using a credential from the [@azure/identity][azure_identity] library or [an existing Microsoft Entra token](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
+
+To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the \`@azure/identity\` package:
+
+\`\`\`bash
+npm install @azure/identity
+\`\`\`
+
+You will also need to **register a new Microsoft Entra application and grant access to {{ serviceName}}** by assigning the suitable role to your service principal (note: roles such as \`"Owner"\` will not grant the necessary permissions).
+
+For more information about how to create a Microsoft Entra application check out [this guide](https://learn.microsoft.com/entra/identity-platform/howto-create-service-principal-portal).
+
+{{#if azureArm}}
+Using Node.js and Node-like environments, you can use the \`DefaultAzureCredential\` class to authenticate the client.
+
+\`\`\`ts {{#if generateTest}}snippet:ReadmeSampleCreateClient_Node{{/if}}
+import { {{ clientClassName }} } from "{{ clientPackageName }}";
+import { DefaultAzureCredential } from "@azure/identity";
+
+{{#if hasSubscriptionId}}
+const subscriptionId = "00000000-0000-0000-0000-000000000000";
+const client = new {{ clientClassName }}(new DefaultAzureCredential(), subscriptionId);
+{{else}}
+const client = new {{ clientClassName }}(new DefaultAzureCredential());
+{{/if}}
+\`\`\`
+
+For browser environments, use the \`InteractiveBrowserCredential\` from the \`@azure/identity\` package to authenticate.
+
+\`\`\`ts {{#if generateTest}}snippet:ReadmeSampleCreateClient_Browser{{/if}}
+import { InteractiveBrowserCredential } from "@azure/identity";
+import { {{ clientClassName }} } from "{{ clientPackageName }}";
+
+const credential = new InteractiveBrowserCredential({
+  tenantId: "<YOUR_TENANT_ID>",
+  clientId: "<YOUR_CLIENT_ID>",
+ });
+
+{{#if hasSubscriptionId}}
+const subscriptionId = "00000000-0000-0000-0000-000000000000";
+const client = new {{ clientClassName }}(credential, subscriptionId);
+{{else}}
+const client = new {{ clientClassName }}(credential);
+{{/if}}
+\`\`\`
+{{else}}
+Using Node.js and Node-like environments, you can use the \`DefaultAzureCredential\` class to authenticate the client.
+
+\`\`\`ts {{#if generateTest}}snippet:ReadmeSampleCreateClient_Node{{/if}}
+import { {{ clientClassName }} } from "{{ clientPackageName }}";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredential());
+\`\`\`
+
+For browser environments, use the \`InteractiveBrowserCredential\` from the \`@azure/identity\` package to authenticate.
+
+\`\`\`ts {{#if generateTest}}snippet:ReadmeSampleCreateClient_Browser{{/if}}
+import { InteractiveBrowserCredential } from "@azure/identity";
+import { {{ clientClassName }} } from "{{ clientPackageName }}";
+
+const credential = new InteractiveBrowserCredential({
+  tenantId: "<YOUR_TENANT_ID>",
+  clientId: "<YOUR_CLIENT_ID>"
+ });
+const client = new {{ clientClassName }}("<endpoint>", credential);
+\`\`\`
+{{/if}}
+{{/if}}{{/if}}
+
+### JavaScript Bundle
+To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
+
+## Key concepts
+
+### {{ clientClassName }}
+
+\`{{ clientClassName }}\` is the primary interface for developers using the {{ clientDescriptiveName }} library. Explore the methods on this client object to understand the different features of the {{ serviceName }} service that you can access.
+
+{{#if azure}}
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the \`AZURE_LOG_LEVEL\` environment variable to \`info\`. Alternatively, logging can be enabled at runtime by calling \`setLogLevel\` in the \`@azure/logger\`:
+
+\`\`\`ts {{#if generateTest}}snippet:SetLogLevel{{/if}}
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+\`\`\`
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs]({{ repoURL }}/tree/main/sdk/core/logger).
+
+{{#if samplesURL}}
+## Next steps
+
+Please take a look at the [samples]({{ samplesURL }}) directory for detailed examples on how to use this library.
+{{/if}}
+
+## Contributing
+
+If you'd like to contribute to this library, please read the [contributing guide]({{ contributingGuideURL }}) to learn more about how to build and test the code.
+
+## Related projects
+
+- [{{ projectName }}]({{ repoURL }})
+
+[azure_sub]: https://azure.microsoft.com/free/
+[azure_portal]: https://portal.azure.com
+{{#if identityPackageURL}}[azure_identity]: {{ identityPackageURL }}
+{{/if}}[defaultazurecredential]: {{ identityPackageURL }}#defaultazurecredential
+{{/if}}
+`;
+const nonBrandedReadmeTemplate = `# {{ clientDescriptiveName }} library for JavaScript
+
+{{ description }}
+
+Key links:
+
+{{#if packageSourceURL}}
+- [Source code]({{ packageSourceURL }})
+{{/if}}
+{{#if packageNPMURL}}
+- [Package (NPM)]({{ packageNPMURL }})
+{{/if}}
+{{#if apiRefURL}}
+- [API reference documentation]({{ apiRefURL }})
+{{/if}}
+{{#if serviceDocURL}}
+- [Product documentation]({{ serviceDocURL }})
+{{/if}}
+{{#if samplesURL}}
+- [Samples]({{ samplesURL }})
+{{/if}}
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Install the \`{{ clientPackageName }}\` package
+
+Install the {{ clientDescriptiveName }} library for JavaScript with \`npm\`:
+
+\`\`\`bash
+npm install {{ clientPackageName }}
+\`\`\`
+`;
+const apiReferenceTemplate = `{{#if apiRefURL}}
+- [API reference documentation]({{ apiRefURL }})
+{{/if}}
+`;
+export function buildReadmeFile(model) {
+    const metadata = createMetadata(model) ?? {};
+    const readmeFileContents = hbs.compile(model.options
+        ? model.options.isModularLibrary
+            ? azureReadmeModularTemplate
+            : azureReadmeRLCTemplate
+        : nonBrandedReadmeTemplate, { noEscape: true });
+    return {
+        path: "README.md",
+        content: readmeFileContents(metadata),
+    };
+}
+export function hasClientNameChanged(model, existingReadmeContent) {
+    try {
+        const importMatch = existingReadmeContent.match(/import\s*\{\s*([A-Za-z0-9_]+)\s*\}\s*from\s*["'][^"']*["']/);
+        const existingClientName = importMatch?.[1];
+        const newClientName = getClientName(model);
+        return !!existingClientName && existingClientName !== newClientName;
+    }
+    catch {
+        return false;
+    }
+}
+export function updateReadmeFile(model, existingReadmeContent) {
+    try {
+        const metadata = createMetadata(model) ?? {};
+        const newApiRefLink = hbs.compile(apiReferenceTemplate, { noEscape: true })(metadata).trim();
+        if (!newApiRefLink) {
+            return { path: "README.md", content: existingReadmeContent };
+        }
+        const apiRefRegex = /^- \[API reference documentation\]\(https:\/\/learn\.microsoft\.com\/javascript\/api\/[^)]+\)$/m;
+        const updatedContent = existingReadmeContent.replace(apiRefRegex, (match) => match ? newApiRefLink : match);
+        return { path: "README.md", content: updatedContent };
+    }
+    catch {
+        return;
+    }
+}
+/**
+ * Returns meta data information about the service, the package, and the client.
+ * @param codeModel - include the client details
+ * @returns inferred metadata about the service, the package, and the client
+ */
+function createMetadata(model) {
+    if (!model.options || !model.options.packageDetails) {
+        return;
+    }
+    // const packageDetails = model.options.packageDetails;
+    const { packageDetails, azureOutputDirectory, productDocLink, dependencyInfo, multiClient, batch, serviceInfo, isTypeSpecTest, } = model.options;
+    const azureHuh = packageDetails?.scopeName === "azure" || packageDetails?.scopeName === "azure-rest";
+    const repoURL = "https://github.com/Azure/azure-sdk-for-js";
+    const relativePackageSourcePath = azureOutputDirectory;
+    const packageSourceURL = relativePackageSourcePath && repoURL && `${repoURL}/tree/main/${relativePackageSourcePath}`;
+    const clientPackageName = packageDetails?.name;
+    const clientClassName = getClientName(model);
+    const serviceName = getServiceName(model);
+    let apiRefUrlQueryParameter = "";
+    if (!packageDetails?.isVersionUserProvided && model.apiVersionInfo?.defaultValue) {
+        if (model.apiVersionInfo?.defaultValue?.toLowerCase().includes("preview")) {
+            apiRefUrlQueryParameter = "?view=azure-node-preview";
+        }
+    }
+    else {
+        packageDetails.version = packageDetails.version ?? "1.0.0-beta.1";
+        if (packageDetails?.version.includes("beta")) {
+            apiRefUrlQueryParameter = "?view=azure-node-preview";
+        }
+    }
+    return {
+        serviceName,
+        clientClassName,
+        clientPackageName: clientPackageName,
+        clientDescriptiveName: model.options.isModularLibrary
+            ? `${serviceName} client`
+            : `${serviceName} REST client`,
+        description: serviceInfo?.description ?? packageDetails.description,
+        serviceDocURL: productDocLink,
+        packageSourceURL: packageSourceURL,
+        packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
+        samplesURL: model.options.generateSample && packageSourceURL ? `${packageSourceURL}/samples` : undefined,
+        apiRefURL: azureHuh
+            ? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
+            : undefined,
+        dependencyDescription: dependencyInfo?.description,
+        dependencyLink: dependencyInfo?.link,
+        hasMultiClients: multiClient && batch && batch.length > 1,
+        azureArm: Boolean(model.options.azureArm),
+        azure: azureHuh,
+        isReleasablePackage: !isTypeSpecTest,
+        repoURL: repoURL,
+        projectName: azureHuh ? "Microsoft Azure SDK for JavaScript" : undefined,
+        identityPackageURL: repoURL && `${repoURL}/tree/main/sdk/identity/identity`,
+        addCredentials: model.options.addCredentials,
+        contributingGuideURL: repoURL && `${repoURL}/blob/main/CONTRIBUTING.md`,
+        generateTest: model.options.generateTest,
+        hasSubscriptionId: model.options.hasSubscriptionId,
+    };
+}
+function getServiceName(model) {
+    const azureHuh = model?.options?.packageDetails?.scopeName === "azure" ||
+        model?.options?.packageDetails?.scopeName === "azure-rest";
+    const libraryName = model.libraryName;
+    const serviceTitle = model.options?.isModularLibrary
+        ? model.libraryName
+        : (model.options?.serviceInfo?.title ?? model.libraryName);
+    const batch = model?.options?.batch, packageDetails = model?.options?.packageDetails;
+    let simpleServiceName = batch && batch.length > 1
+        ? normalizeName(packageDetails.nameWithoutScope ?? packageDetails?.name ?? "", NameType.Class)
+        : normalizeName(serviceTitle, NameType.Class);
+    simpleServiceName =
+        /**
+         * It is a required convention in Azure swaggers for their titles to end with
+         * "Client".
+         */
+        serviceTitle.match(/(.*) Client/)?.[1] ??
+            serviceTitle.match(/(.*)Client/)?.[1] ??
+            libraryName.match(/(.*)Client/)?.[1] ??
+            serviceTitle.match(/(.*) Service/)?.[1] ??
+            simpleServiceName;
+    return azureHuh
+        ? simpleServiceName.startsWith("Azure")
+            ? simpleServiceName
+            : `Azure ${simpleServiceName}`
+        : simpleServiceName;
+}
+//# sourceMappingURL=build-readme-file.js.map

package/dist/src/rlc-common/metadata/build-readme-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-readme-file.js","sourceRoot":"","sources":["../../../../src/rlc-common/metadata/build-readme-file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,6DAA6D;AAC7D,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGnE,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwE9B,CAAC;AAEF,MAAM,0BAA0B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsKlC,CAAC;AAEF,MAAM,wBAAwB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmChC,CAAC;AAEF,MAAM,oBAAoB,GAAG;;;CAG5B,CAAC;AAqDF,MAAM,UAAU,eAAe,CAAC,KAAe;IAC7C,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7C,MAAM,kBAAkB,GAAG,GAAG,CAAC,OAAO,CACpC,KAAK,CAAC,OAAO;QACX,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB;YAC9B,CAAC,CAAC,0BAA0B;YAC5B,CAAC,CAAC,sBAAsB;QAC1B,CAAC,CAAC,wBAAwB,EAC5B,EAAE,QAAQ,EAAE,IAAI,EAAE,CACnB,CAAC;IACF,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC;KACtC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAe,EAAE,qBAA6B;IACjF,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,qBAAqB,CAAC,KAAK,CAC7C,4DAA4D,CAC7D,CAAC;QACF,MAAM,kBAAkB,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,CAAC,CAAC,kBAAkB,IAAI,kBAAkB,KAAK,aAAa,CAAC;IACtE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,KAAe,EACf,qBAA6B;IAE7B,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAE7C,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QAE7F,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC;QAC/D,CAAC;QAED,MAAM,WAAW,GACf,iGAAiG,CAAC;QACpG,MAAM,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAC1E,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAC9B,CAAC;QAEF,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IACxD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,KAAe;IACrC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO;IACT,CAAC;IACD,uDAAuD;IACvD,MAAM,EACJ,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,WAAW,EACX,KAAK,EACL,WAAW,EACX,cAAc,GACf,GAAG,KAAK,CAAC,OAAO,CAAC;IAElB,MAAM,QAAQ,GACZ,cAAc,EAAE,SAAS,KAAK,OAAO,IAAI,cAAc,EAAE,SAAS,KAAK,YAAY,CAAC;IACtF,MAAM,OAAO,GAAG,2CAA2C,CAAC;IAC5D,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;IACvD,MAAM,gBAAgB,GACpB,yBAAyB,IAAI,OAAO,IAAI,GAAG,OAAO,cAAc,yBAAyB,EAAE,CAAC;IAE9F,MAAM,iBAAiB,GAAG,cAAc,EAAE,IAAI,CAAC;IAC/C,MAAM,eAAe,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,uBAAuB,GAAW,EAAE,CAAC;IACzC,IAAI,CAAC,cAAc,EAAE,qBAAqB,IAAI,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,CAAC;QACjF,IAAI,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1E,uBAAuB,GAAG,0BAA0B,CAAC;QACvD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC;QAClE,IAAI,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,uBAAuB,GAAG,0BAA0B,CAAC;QACvD,CAAC;IACH,CAAC;IAED,OAAO;QACL,WAAW;QACX,eAAe;QACf,iBAAiB,EAAE,iBAAiB;QACpC,qBAAqB,EAAE,KAAK,CAAC,OAAO,CAAC,gBAAgB;YACnD,CAAC,CAAC,GAAG,WAAW,SAAS;YACzB,CAAC,CAAC,GAAG,WAAW,cAAc;QAChC,WAAW,EAAE,WAAW,EAAE,WAAW,IAAI,cAAc,CAAC,WAAW;QACnE,aAAa,EAAE,cAAc;QAC7B,gBAAgB,EAAE,gBAAgB;QAClC,aAAa,EAAE,iCAAiC,iBAAiB,EAAE;QACnE,UAAU,EACR,KAAK,CAAC,OAAO,CAAC,cAAc,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG,gBAAgB,UAAU,CAAC,CAAC,CAAC,SAAS;QAC9F,SAAS,EAAE,QAAQ;YACjB,CAAC,CAAC,8CAA8C,iBAAiB,GAAG,uBAAuB,EAAE;YAC7F,CAAC,CAAC,SAAS;QACb,qBAAqB,EAAE,cAAc,EAAE,WAAW;QAClD,cAAc,EAAE,cAAc,EAAE,IAAI;QACpC,eAAe,EAAE,WAAW,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QACzD,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzC,KAAK,EAAE,QAAQ;QACf,mBAAmB,EAAE,CAAC,cAAc;QACpC,OAAO,EAAE,OAAO;QAChB,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,oCAAoC,CAAC,CAAC,CAAC,SAAS;QACxE,kBAAkB,EAAE,OAAO,IAAI,GAAG,OAAO,kCAAkC;QAC3E,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,cAAc;QAC5C,oBAAoB,EAAE,OAAO,IAAI,GAAG,OAAO,4BAA4B;QACvE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY;QACxC,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC,iBAAiB;KACnD,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,KAAe;IACrC,MAAM,QAAQ,GACZ,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,KAAK,OAAO;QACrD,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,KAAK,YAAY,CAAC;IAC7D,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACtC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,EAAE,gBAAgB;QAClD,CAAC,CAAC,KAAK,CAAC,WAAW;QACnB,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IAC7D,MAAM,KAAK,GAAG,KAAK,EAAE,OAAO,EAAE,KAAK,EACjC,cAAc,GAAG,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC;IAClD,IAAI,iBAAiB,GACnB,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QACvB,CAAC,CAAC,aAAa,CACX,cAAe,CAAC,gBAAgB,IAAI,cAAc,EAAE,IAAI,IAAI,EAAE,EAC9D,QAAQ,CAAC,KAAK,CACf;QACH,CAAC,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,iBAAiB;QACf;;;WAGG;QACH,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;YACtC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACpC,YAAY,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;YACvC,iBAAiB,CAAC;IAEpB,OAAO,QAAQ;QACb,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,OAAO,CAAC;YACrC,CAAC,CAAC,iBAAiB;YACnB,CAAC,CAAC,SAAS,iBAAiB,EAAE;QAChC,CAAC,CAAC,iBAAiB,CAAC;AACxB,CAAC"}

package/dist/src/rlc-common/metadata/build-sample-env-file.d.ts

@@ -0,0 +1,6 @@
+import { RLCModel } from "../interfaces.js";
+export declare function buildSampleEnvFile(model: RLCModel): {
+    path: string;
+    content: string;
+} | undefined;
+//# sourceMappingURL=build-sample-env-file.d.ts.map

package/dist/src/rlc-common/metadata/build-sample-env-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-sample-env-file.d.ts","sourceRoot":"","sources":["../../../../src/rlc-common/metadata/build-sample-env-file.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAM5C,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,QAAQ;;;cASjD"}

package/dist/src/rlc-common/metadata/build-sample-env-file.js

@@ -0,0 +1,14 @@
+const sampleEnvText = `
+# Feel free to add your own environment variables.
+`;
+export function buildSampleEnvFile(model) {
+    if (model.options?.generateMetadata === true || model.options?.generateSample === true) {
+        const filePath = "sample.env";
+        return {
+            path: filePath,
+            content: sampleEnvText.trim(),
+        };
+    }
+    return undefined;
+}
+//# sourceMappingURL=build-sample-env-file.js.map

package/dist/src/rlc-common/metadata/build-sample-env-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-sample-env-file.js","sourceRoot":"","sources":["../../../../src/rlc-common/metadata/build-sample-env-file.ts"],"names":[],"mappings":"AAIA,MAAM,aAAa,GAAG;;CAErB,CAAC;AAEF,MAAM,UAAU,kBAAkB,CAAC,KAAe;IAChD,IAAI,KAAK,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,EAAE,CAAC;QACvF,MAAM,QAAQ,GAAG,YAAY,CAAC;QAC9B,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa,CAAC,IAAI,EAAE;SAC9B,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/src/rlc-common/metadata/build-test-config.d.ts

@@ -0,0 +1,16 @@
+import { RLCModel } from "../interfaces.js";
+/**
+ * Builds config/tsconfig.test.browser.json — extends eng/tsconfigs/test.browser.json
+ */
+export declare function buildTestBrowserTsConfig(model: RLCModel): {
+    path: string;
+    content: string;
+} | undefined;
+/**
+ * Builds config/tsconfig.test.node.json — extends eng/tsconfigs/test.node.json
+ */
+export declare function buildTestNodeTsConfig(model: RLCModel): {
+    path: string;
+    content: string;
+} | undefined;
+//# sourceMappingURL=build-test-config.d.ts.map

package/dist/src/rlc-common/metadata/build-test-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-test-config.d.ts","sourceRoot":"","sources":["../../../../src/rlc-common/metadata/build-test-config.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAO5C;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,QAAQ;;;cAwBvD;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,QAAQ;;;cAwBpD"}

package/dist/src/rlc-common/metadata/build-test-config.js

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { getPackageName } from "./utils.js";
+function shouldGenerateTestConfig(model) {
+    return !(model.options?.generateMetadata === false || model.options?.generateTest === false);
+}
+/**
+ * Builds config/tsconfig.test.browser.json — extends eng/tsconfigs/test.browser.json
+ */
+export function buildTestBrowserTsConfig(model) {
+    if (!shouldGenerateTestConfig(model)) {
+        return;
+    }
+    const name = getPackageName(model);
+    return {
+        path: "config/tsconfig.test.browser.json",
+        content: JSON.stringify({
+            extends: "../../../../eng/tsconfigs/test.browser.json",
+            compilerOptions: {
+                paths: {
+                    [name]: ["../src/index.ts"],
+                    [`${name}/*`]: ["../src/*"],
+                    "$internal/*": ["../src/*"],
+                },
+            },
+        }, null, 2),
+    };
+}
+/**
+ * Builds config/tsconfig.test.node.json — extends eng/tsconfigs/test.node.json
+ */
+export function buildTestNodeTsConfig(model) {
+    if (!shouldGenerateTestConfig(model)) {
+        return;
+    }
+    const name = getPackageName(model);
+    return {
+        path: "config/tsconfig.test.node.json",
+        content: JSON.stringify({
+            extends: "../../../../eng/tsconfigs/test.node.json",
+            compilerOptions: {
+                paths: {
+                    [name]: ["../src/index.ts"],
+                    [`${name}/*`]: ["../src/*"],
+                    "$internal/*": ["../src/*"],
+                },
+            },
+        }, null, 2),
+    };
+}
+//# sourceMappingURL=build-test-config.js.map

package/dist/src/rlc-common/metadata/build-test-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-test-config.js","sourceRoot":"","sources":["../../../../src/rlc-common/metadata/build-test-config.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,SAAS,wBAAwB,CAAC,KAAe;IAC/C,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,KAAK,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,YAAY,KAAK,KAAK,CAAC,CAAC;AAC/F,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAe;IACtD,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAEnC,OAAO;QACL,IAAI,EAAE,mCAAmC;QACzC,OAAO,EAAE,IAAI,CAAC,SAAS,CACrB;YACE,OAAO,EAAE,6CAA6C;YACtD,eAAe,EAAE;gBACf,KAAK,EAAE;oBACL,CAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC;oBAC3B,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC;oBAC3B,aAAa,EAAE,CAAC,UAAU,CAAC;iBAC5B;aACF;SACF,EACD,IAAI,EACJ,CAAC,CACF;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAe;IACnD,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAEnC,OAAO;QACL,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE,IAAI,CAAC,SAAS,CACrB;YACE,OAAO,EAAE,0CAA0C;YACnD,eAAe,EAAE;gBACf,KAAK,EAAE;oBACL,CAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC;oBAC3B,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC;oBAC3B,aAAa,EAAE,CAAC,UAAU,CAAC;iBAC5B;aACF;SACF,EACD,IAAI,EACJ,CAAC,CACF;KACF,CAAC;AACJ,CAAC"}

package/dist/src/rlc-common/metadata/build-ts-config.d.ts

@@ -0,0 +1,61 @@
+import { RLCModel } from "../interfaces.js";
+/**
+ * Builds the root tsconfig.json.
+ *
+ * Emits project references pointing into the `config/` subfolder
+ * (following the eng/tsconfigs pattern).
+ */
+export declare function buildTsConfig(model: RLCModel): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.src.esm.json — extends eng/tsconfigs/src.esm.json
+ */
+export declare function buildTsSrcEsmConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.src.browser.json — extends eng/tsconfigs/src.browser.json
+ */
+export declare function buildTsSrcBrowserConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.src.react-native.json — extends eng/tsconfigs/src.react-native.json
+ */
+export declare function buildTsSrcReactNativeConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.src.cjs.json — extends eng/tsconfigs/src.cjs.json
+ */
+export declare function buildTsSrcCjsConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.samples.json — extends eng/tsconfigs/samples.json
+ */
+export declare function buildTsSampleConfig(model: RLCModel): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.lint.json — used by eslint.config.mjs for type-aware linting
+ */
+export declare function buildTsLintConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.snippets.json — extends eng/tsconfigs/snippets.json
+ */
+export declare function buildTsSnippetsConfig(): {
+    path: string;
+    content: string;
+};
+//# sourceMappingURL=build-ts-config.d.ts.map

package/dist/src/rlc-common/metadata/build-ts-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-ts-config.d.ts","sourceRoot":"","sources":["../../../../src/rlc-common/metadata/build-ts-config.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,QAAQ;;;EAwC5C;AAED;;GAEG;AACH,wBAAgB,mBAAmB;;;EAYlC;AAED;;GAEG;AACH,wBAAgB,uBAAuB;;;EAYtC;AAED;;GAEG;AACH,wBAAgB,2BAA2B;;;EAY1C;AAED;;GAEG;AACH,wBAAgB,mBAAmB;;;EAYlC;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,QAAQ;;;EAkBlD;AAED;;GAEG;AACH,wBAAgB,iBAAiB;;;EAYhC;AAED;;GAEG;AACH,wBAAgB,qBAAqB;;;EAWpC"}