@azure-tools/rlc-common 0.11.0

package/dist-esm/metadata/buildPackageFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildPackageFile.js","sourceRoot":"","sources":["../../src/metadata/buildPackageFile.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAGrE,IAAI,SAAS,GAAG,KAAK,CAAC;AACtB,IAAI,MAAM,GAAG,KAAK,CAAC;AACnB,IAAI,eAAe,GAAa,EAAE,CAAC;AAEnC,MAAM,UAAU,gBAAgB,CAAC,KAAe,EAAE,mBAAmB,GAAG,KAAK;IAC3E,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAClE,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO;KACR;IACD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,cAAc,CAAC;IAChC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;IACzE,0CAA0C;IAC1C,IAAI,CAAC,mBAAmB,EAAE;QACxB,OAAO;KACR;IAED,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAC1C,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,EACnC;QACE,SAAS,EAAE,IAAI;KAChB,CACF,CAAC;IACF,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,WAAW,CAAC,WAAW,EAAE;KACnC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,KAAe,EAAE,mBAA4B;IACrE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE;QACnD,OAAO;KACR;IAED,eAAe,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,SAAS,GAAG,SAAS,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,GAAG,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE/C,MAAM,EACJ,cAAc,EACd,YAAY,EACZ,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,UAAU,EACV,UAAU,EACV,WAAW,EACX,KAAK,EACN,GAAG,KAAK,CAAC,OAAO,CAAC;IAClB,IACE,WAAW;QACX,KAAK;QACL,KAAK,CAAC,MAAM,GAAG,CAAC;QAChB,eAAe,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EACrC;QACA,OAAO;KACR;IAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,IAAI,CAAC;IAC9C,IAAI,uBAAuB,GAAW,EAAE,CAAC;IACzC,IAAI,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC3C,uBAAuB,GAAG,0BAA0B,CAAC;KACtD;IAED,MAAM,WAAW,GAAwB;QACvC,IAAI,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE;QAC9B,UAAU,EAAE,QAAQ;QACpB,MAAM,EAAE,uBAAuB;QAC/B,OAAO,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE;QACpC,WAAW,EACT,GAAG,cAAc,CAAC,WAAW,EAAE;YAC/B,uBAAuB,KAAK,CAAC,WAAW,GAAG;QAC7C,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,CAAC;QAC3E,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,qBAAqB;QACxE,KAAK,EAAE,WAAW,cAAc,CAAC,gBAAgB,OAAO;QACxD,UAAU,EAAE,+BAA+B;QAC3C,IAAI,EAAE;YACJ,GAAG,EAAE,kDAAkD;SACxD;QACD,KAAK,EAAE;YACL,OAAO;YACP,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,WAAW;YAC5C,SAAS,cAAc,CAAC,gBAAgB,OAAO;YAC/C,WAAW;YACX,SAAS;YACT,UAAU;SACX;QACD,OAAO,EAAE;YACP,IAAI,EAAE,UAAU;SACjB;QACD,OAAO,EAAE;YACP,KAAK,EACH,oIAAoI;YACtI,eAAe,EAAE,eAAe;YAChC,YAAY,EAAE,eAAe;YAC7B,eAAe,EAAE,eAAe;YAChC,YAAY,EAAE,eAAe;YAC7B,aAAa,EAAE,eAAe;YAC9B,cAAc,EAAE,mIAAmI,oBAAoB,CACrK,YAAY,EACZ,cAAc,CACf,EAAE;YACH,KAAK,EACH,oEAAoE;YACtE,iBAAiB,EAAE,cAAc;YACjC,aAAa,EACX,+DAA+D;YACjE,MAAM,EAAE,0HAA0H,oBAAoB,CACpJ,YAAY,EACZ,cAAc,CACf,EAAE;YACH,iBAAiB,EACf,UAAU,KAAK,SAAS;gBACtB,CAAC,CAAC,2DAA2D;gBAC7D,CAAC,CAAC,cAAc;YACpB,0BAA0B,EAAE,cAAc;YAC1C,uBAAuB,EAAE,cAAc;YACvC,kBAAkB,EAAE,cAAc;YAClC,UAAU,EAAE,8CAA8C,kBAAkB,CAC1E,YAAY,CACb,kDAAkD;YACnD,IAAI,EAAE,8CAA8C,kBAAkB,CACpE,YAAY,CACb,YAAY;YACb,IAAI,EAAE,eAAe;YACrB,cAAc,EAAE,cAAc;YAC9B,WAAW,EAAE,cAAc;YAC3B,IAAI,EAAE,2CAA2C;YACjD,WAAW,EAAE,cAAc;YAC3B,gBAAgB,EAAE,cAAc;YAChC,mBAAmB,EAAE,cAAc;SACpC;QACD,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,kBAAkB,EAAE,QAAQ;YAC5B,yBAAyB,EAAE,QAAQ;YACnC,2BAA2B,EAAE,QAAQ;YACrC,eAAe,EAAE,QAAQ;YACzB,KAAK,EAAE,QAAQ;YACf,GAAG,CAAC,SAAS,IAAI;gBACf,oBAAoB,EAAE,QAAQ;aAC/B,CAAC;YACF,GAAG,CAAC,MAAM,IAAI;gBACZ,iBAAiB,EAAE,QAAQ;gBAC3B,yBAAyB,EAAE,QAAQ;aACpC,CAAC;SACH;QACD,eAAe,EAAE;YACf,0BAA0B,EAAE,SAAS;YACrC,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,SAAS;YACxB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,oBAAoB,EAAE,QAAQ;YAC9B,UAAU,EAAE,QAAQ;SACrB;KACF,CAAC;IAEF,IAAI,oBAAoB,EAAE;QACxB,WAAW,CAAC,QAAQ,GAAG,uDAAuD,oBAAoB,YAAY,CAAC;KAChH;IAED,IAAI,aAAa,EAAE;QACjB,WAAW,CAAC,YAAY,CAAC,GAAG;YAC1B,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/B,WAAW,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;gBAC3C,IAAI;gBACJ,MAAM,EAAE,eAAe;aACxB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,uCAAuC;QACvC,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,WAAW,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;gBAC3C,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,iBAAiB;aAC1B,CAAC,CAAC;SACJ;QACD,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC;YAC1B,kGAAkG,CAAC;QACrG,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC;YAChC,8DAA8D,CAAC;QACjE,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,iCAAiC,CAAC;QACzE,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,iCAAiC,CAAC;QACtE,WAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,GAAG,QAAQ,CAAC;QAC1D,WAAW,CAAC,eAAe,CAAC,gCAAgC,CAAC,GAAG,QAAQ,CAAC;KAC1E;SAAM;QACL,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC;YAC1B,oGAAoG,CAAC;QACvG,WAAW,CAAC,OAAO,CACjB,QAAQ,CACT,GAAG,+GAA+G,CAAC;QACpH,WAAW,CAAC,eAAe,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC;QACnE,WAAW,CAAC,eAAe,CAAC,qBAAqB,CAAC,GAAG,QAAQ,CAAC;QAC9D,WAAW,CAAC,eAAe,CAAC,4BAA4B,CAAC,GAAG,QAAQ,CAAC;QACrE,WAAW,CAAC,eAAe,CAAC,6BAA6B,CAAC,GAAG,SAAS,CAAC;QACvE,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;QAClD,WAAW,CAAC,eAAe,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC;QACnE,WAAW,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;KACrD;IAED,IAAI,UAAU,EAAE;QACd,WAAW,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;KAChC;IAED,IAAI,YAAY,EAAE;QAChB,WAAW,CAAC,MAAM,GAAG,yBAAyB,CAAC;QAC/C,WAAW,CAAC,eAAe,CAAC,8BAA8B,CAAC,GAAG,QAAQ,CAAC;QACvE,WAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,GAAG,QAAQ,CAAC;QAC1D,WAAW,CAAC,eAAe,CAAC,4BAA4B,CAAC,GAAG,QAAQ,CAAC;QACrE,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;QAChD,WAAW,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,QAAQ,CAAC;QACvD,WAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAAC;QAChE,WAAW,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;QACpD,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;QACtD,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QAC/C,WAAW,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;QACpD,WAAW,CAAC,eAAe,CAAC,uBAAuB,CAAC,GAAG,QAAQ,CAAC;QAChE,WAAW,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,QAAQ,CAAC;QACzD,WAAW,CAAC,eAAe,CAAC,wBAAwB,CAAC,GAAG,QAAQ,CAAC;QACjE,WAAW,CAAC,eAAe,CAAC,wBAAwB,CAAC,GAAG,QAAQ,CAAC;QACjE,WAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,GAAG,QAAQ,CAAC;QAC/D,WAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,GAAG,QAAQ,CAAC;QAC/D,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;QACtD,WAAW,CAAC,eAAe,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC;QACnE,WAAW,CAAC,eAAe,CAAC,wBAAwB,CAAC,GAAG,QAAQ,CAAC;QACjE,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;QAChD,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QAC/C,WAAW,CAAC,eAAe,CAAC,oBAAoB,CAAC,GAAG,QAAQ,CAAC;QAC7D,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;YACzB,0DAA0D,CAAC;QAC7D,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC;YAC9B,+DAA+D,CAAC;QAClE,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC;YACjC,kEAAkE,CAAC;QACrE,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC;YAClC,wDAAwD,CAAC;QAC3D,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC;YAC/B,qDAAqD,CAAC;QACxD,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,4BAA4B,CAAC;QACjE,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC;YAC9B,qDAAqD,CAAC;QACxD,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC;YACnC,mKAAmK,CAAC;QACtK,WAAW,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,0BAA0B,CAAC;QACtE,WAAW,CAAC,OAAO,CAAC,0BAA0B,CAAC;YAC7C,0BAA0B,CAAC;QAC7B,WAAW,CAAC,OAAO,CAAC,uBAAuB,CAAC;YAC1C,2LAA2L,CAAC;QAC9L,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACrC,mEAAmE,CAAC;QACtE,IAAI,aAAa,EAAE;YACjB,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,iCAAiC,CAAC;YACtE,WAAW,CAAC,OAAO,CAAC,0BAA0B,CAAC;gBAC7C,2BAA2B,CAAC;YAC9B,WAAW,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,2BAA2B,CAAC;YACvE,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC;gBACnC,gHAAgH,CAAC;YACnH,WAAW,CAAC,OAAO,CAAC,uBAAuB,CAAC;gBAC1C,mFAAmF,CAAC;SACvF;QAED,WAAW,CAAC,SAAS,CAAC,GAAG;YACvB,qCAAqC,EACnC,6CAA6C;SAChD,CAAC;KACH;IAED,IAAI,cAAc,IAAI,mBAAmB,EAAE;QACzC,WAAW,CAAC,uBAAuB,CAAC,GAAG;YACrC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,IAAI,KAAK,CAAC,WAAW;YAClE,YAAY,EAAE,CAAC,OAAO,CAAC;YACvB,aAAa,EAAE,IAAI;YACnB,UAAU,EAAE,6CAA6C,iBAAiB,GAAG,uBAAuB,EAAE;SACvG,CAAC;QACF,IAAI,aAAa,EAAE;YACjB,WAAW,CAAC,OAAO,CAAC,iBAAiB,CAAC;gBACpC,kCAAkC,CAAC;SACtC;KACF;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,oBAAoB,CAC3B,YAAsB,EACtB,cAAwB;IAExB,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,YAAY,EAAE;QAChB,IAAI,GAAG,IAAI,GAAG,iBAAiB,CAAC;KACjC;IACD,IAAI,cAAc,EAAE;QAClB,IAAI,GAAG,IAAI,GAAG,wBAAwB,CAAC;KACxC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,kBAAkB,CAAC,YAAsB;IAChD,OAAO,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAe;IACxC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAC1B,MAAM,eAAe,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC5D,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvE,OAAO,eAAe;QACpB,CAAC,CAAC,OAAO,eAAe,IAAI,cAAc,KAAK;QAC/C,CAAC,CAAC,OAAO,cAAc,KAAK,CAAC;AACjC,CAAC"}

package/dist-esm/metadata/buildReadmeFile.js

@@ -0,0 +1,167 @@
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { NameType, normalizeName } from "../helpers/nameUtils.js";
+const readmeTemplate = `# {{ 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 an [Azure Active Directory (AAD) 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 AAD, 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.
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+
+## 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\`:
+
+\`\`\`javascript
+const { setLogLevel } = require("@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).
+`;
+export function buildReadmeFile(model) {
+    const generateMetadata = Boolean(model.options?.generateMetadata);
+    if (!generateMetadata) {
+        return;
+    }
+    const metadata = createMetadata(model) ?? {};
+    const readmeFileContents = hbs.compile(readmeTemplate, { noEscape: true });
+    return {
+        path: "README.md",
+        content: readmeFileContents(metadata)
+    };
+}
+/**
+ * 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 } = 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?.version.includes("beta")) {
+        apiRefUrlQueryParameter = "?view=azure-node-preview";
+    }
+    return {
+        serviceName,
+        clientClassName,
+        clientPackageName: clientPackageName,
+        clientDescriptiveName: `${serviceName} REST client`,
+        description: serviceInfo?.description ?? packageDetails.description,
+        serviceDocURL: productDocLink,
+        packageSourceURL: packageSourceURL,
+        packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
+        samplesURL: packageSourceURL && `${packageSourceURL}/samples`,
+        apiRefURL: azureHuh
+            ? `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
+            : undefined,
+        dependencyDescription: dependencyInfo?.description,
+        dependencyLink: dependencyInfo?.link,
+        hasMultiClients: multiClient && batch && batch.length > 1,
+        azureArm: Boolean(model.options.azureArm)
+    };
+}
+function getServiceName(model) {
+    const azureHuh = model?.options?.packageDetails?.scopeName === "azure" ||
+        model?.options?.packageDetails?.scopeName === "azure-rest";
+    const libraryName = model.libraryName;
+    const serviceTitle = model.options?.serviceInfo?.title ?? model.libraryName;
+    const batch = model?.options?.batch, packageDetails = model?.options?.packageDetails;
+    let simpleServiceName = batch && batch.length > 1
+        ? normalizeName(packageDetails.nameWithoutScope || "", 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;
+}
+function getClientName(model) {
+    const clientName = model.libraryName;
+    return clientName.endsWith("Client")
+        ? `${clientName}`
+        : `${clientName}Client`;
+}
+//# sourceMappingURL=buildReadmeFile.js.map

package/dist-esm/metadata/buildReadmeFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildReadmeFile.js","sourceRoot":"","sources":["../../src/metadata/buildReadmeFile.ts"],"names":[],"mappings":"AACA,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAElE,MAAM,cAAc,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2EtB,CAAC;AA2CF,MAAM,UAAU,eAAe,CAAC,KAAe;IAC7C,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAClE,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7C,MAAM,kBAAkB,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3E,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC;KACtC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,KAAe;IACrC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE;QACnD,OAAO;KACR;IACD,uDAAuD;IACvD,MAAM,EACJ,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,WAAW,EACX,KAAK,EACL,WAAW,EACZ,GAAG,KAAK,CAAC,OAAO,CAAC;IAElB,MAAM,QAAQ,GACZ,cAAc,EAAE,SAAS,KAAK,OAAO;QACrC,cAAc,EAAE,SAAS,KAAK,YAAY,CAAC;IAC7C,MAAM,OAAO,GAAG,2CAA2C,CAAC;IAC5D,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;IACvD,MAAM,gBAAgB,GACpB,yBAAyB;QACzB,OAAO;QACP,GAAG,OAAO,cAAc,yBAAyB,EAAE,CAAC;IAEtD,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,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC5C,uBAAuB,GAAG,0BAA0B,CAAC;KACtD;IAED,OAAO;QACL,WAAW;QACX,eAAe;QACf,iBAAiB,EAAE,iBAAiB;QACpC,qBAAqB,EAAE,GAAG,WAAW,cAAc;QACnD,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,EAAE,gBAAgB,IAAI,GAAG,gBAAgB,UAAU;QAC7D,SAAS,EAAE,QAAQ;YACjB,CAAC,CAAC,6CAA6C,iBAAiB,GAAG,uBAAuB,EAAE;YAC5F,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;KAC1C,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,WAAW,EAAE,KAAK,IAAI,KAAK,CAAC,WAAW,CAAC;IAC5E,MAAM,KAAK,GAAG,KAAK,EAAE,OAAO,EAAE,KAAK,EACjC,cAAc,GAAG,KAAK,EAAE,OAAO,EAAE,cAAe,CAAC;IACnD,IAAI,iBAAiB,GACnB,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QACvB,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,gBAAgB,IAAI,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC;QACtE,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;AAED,SAAS,aAAa,CAAC,KAAe;IACpC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC;IACrC,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAClC,CAAC,CAAC,GAAG,UAAU,EAAE;QACjB,CAAC,CAAC,GAAG,UAAU,QAAQ,CAAC;AAC5B,CAAC"}

package/dist-esm/metadata/buildRollupConfig.js

@@ -0,0 +1,139 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { Project } from "ts-morph";
+export function buildRollupConfig(model) {
+    const generateMetadata = Boolean(model.options?.generateMetadata), azureSdkForJs = Boolean(model.options?.azureSdkForJs);
+    // when it's generating rlc codes, only generate rollup config in codegen test
+    if (!generateMetadata || azureSdkForJs) {
+        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()
+    };
+}
+//# sourceMappingURL=buildRollupConfig.js.map

package/dist-esm/metadata/buildRollupConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildRollupConfig.js","sourceRoot":"","sources":["../../src/metadata/buildRollupConfig.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnC,MAAM,UAAU,iBAAiB,CAAC,KAAe;IAC/C,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,EAC/D,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IACxD,8EAA8E;IAC9E,IAAI,CAAC,gBAAgB,IAAI,aAAa,EAAE;QACtC,OAAO;KACR;IAED,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,kBAAkB,CAAC;IACpC,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,EAAE;QAC/D,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,UAAU,CAAC,aAAa,CACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0DAsHsD,CACvD,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,UAAU,CAAC,WAAW,EAAE;KAClC,CAAC;AACJ,CAAC"}

package/dist-esm/metadata/buildTsConfig.js

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { Project } from "ts-morph";
+const restLevelTsConfigInAzureSdkForJs = {
+    extends: "../../../tsconfig.package",
+    compilerOptions: {
+        outDir: "./dist-esm",
+        declarationDir: "./types"
+    },
+    include: ["src/**/*.ts"]
+};
+const restLevelTsConfigNotInAzureSdkForJs = {
+    compilerOptions: {
+        target: "ES2017",
+        module: "es6",
+        lib: [],
+        declaration: true,
+        declarationMap: true,
+        inlineSources: true,
+        sourceMap: true,
+        importHelpers: true,
+        strict: true,
+        alwaysStrict: true,
+        noUnusedLocals: true,
+        noUnusedParameters: true,
+        noImplicitReturns: true,
+        noFallthroughCasesInSwitch: true,
+        forceConsistentCasingInFileNames: true,
+        moduleResolution: "node",
+        allowSyntheticDefaultImports: true,
+        esModuleInterop: true,
+        outDir: "./dist-esm",
+        declarationDir: "./types"
+    },
+    include: ["./src/**/*.ts"]
+};
+export function buildTsConfig(model, hasSamplesGenerated = false) {
+    const generateMetadata = Boolean(model.options?.generateMetadata);
+    if (!generateMetadata) {
+        return;
+    }
+    const { generateTest, packageDetails, generateSample, azureSdkForJs } = model.options || {};
+    const clientPackageName = packageDetails?.name ?? "";
+    const project = new Project();
+    const restLevelTsConfig = azureSdkForJs
+        ? restLevelTsConfigInAzureSdkForJs
+        : restLevelTsConfigNotInAzureSdkForJs;
+    if (generateTest) {
+        restLevelTsConfig.include.push("./test/**/*.ts");
+    }
+    if (generateSample && hasSamplesGenerated) {
+        restLevelTsConfig.include.push("samples-dev/**/*.ts");
+        restLevelTsConfig.compilerOptions["paths"] = {};
+        restLevelTsConfig.compilerOptions["paths"][clientPackageName] = [
+            "./src/index"
+        ];
+    }
+    const filePath = "tsconfig.json";
+    const configFile = project.createSourceFile(filePath, JSON.stringify(restLevelTsConfig), {
+        overwrite: true
+    });
+    return {
+        path: filePath,
+        content: configFile.getFullText()
+    };
+}
+//# sourceMappingURL=buildTsConfig.js.map

package/dist-esm/metadata/buildTsConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildTsConfig.js","sourceRoot":"","sources":["../../src/metadata/buildTsConfig.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnC,MAAM,gCAAgC,GAAwB;IAC5D,OAAO,EAAE,2BAA2B;IACpC,eAAe,EAAE;QACf,MAAM,EAAE,YAAY;QACpB,cAAc,EAAE,SAAS;KAC1B;IACD,OAAO,EAAE,CAAC,aAAa,CAAC;CACzB,CAAC;AAEF,MAAM,mCAAmC,GAAwB;IAC/D,eAAe,EAAE;QACf,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,KAAK;QACb,GAAG,EAAE,EAAE;QACP,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;QACnB,SAAS,EAAE,IAAI;QACf,aAAa,EAAE,IAAI;QACnB,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;QAClB,cAAc,EAAE,IAAI;QACpB,kBAAkB,EAAE,IAAI;QACxB,iBAAiB,EAAE,IAAI;QACvB,0BAA0B,EAAE,IAAI;QAChC,gCAAgC,EAAE,IAAI;QACtC,gBAAgB,EAAE,MAAM;QACxB,4BAA4B,EAAE,IAAI;QAClC,eAAe,EAAE,IAAI;QACrB,MAAM,EAAE,YAAY;QACpB,cAAc,EAAE,SAAS;KAC1B;IACD,OAAO,EAAE,CAAC,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,UAAU,aAAa,CAAC,KAAe,EAAE,mBAAmB,GAAG,KAAK;IACxE,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAClE,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO;KACR;IACD,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,GACnE,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;IACtB,MAAM,iBAAiB,GAAG,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,MAAM,iBAAiB,GAAG,aAAa;QACrC,CAAC,CAAC,gCAAgC;QAClC,CAAC,CAAC,mCAAmC,CAAC;IAExC,IAAI,YAAY,EAAE;QAChB,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;KAClD;IACD,IAAI,cAAc,IAAI,mBAAmB,EAAE;QACzC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACtD,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QAChD,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,GAAG;YAC9D,aAAa;SACd,CAAC;KACH;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC;IACjC,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CACzC,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,EACjC;QACE,SAAS,EAAE,IAAI;KAChB,CACF,CAAC;IACF,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,UAAU,CAAC,WAAW,EAAE;KAClC,CAAC;AACJ,CAAC"}

package/dist-esm/package.json

@@ -0,0 +1 @@
+{"name":"@azure-tools/rlc-common","version":"0.11.0","description":"","type":"module","main":"dist/index.js","module":"dist-esm/index.js","exports":{".":{"types":"./types/index.d.ts","require":"./dist/index.js","import":"./dist-esm/index.js"}},"types":"./types/index.d.ts","scripts":{"lint":"eslint src --ext .ts --max-warnings=0","lint:fix":"eslint src --fix --ext .ts","format":"npm run -s prettier -- --write","check-format":"npm run prettier -- --check","prettier":"prettier --config ./.prettierrc src/**/*.ts","build":"rimraf dist/* dist-esm/* types/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && node publishPackage.js","build:cjs":"rimraf dist/* dist-esm/* types/* && tsc -p tsconfig-cjs.json && node publishPackage.js","build:esm":"rimraf dist/* dist-esm/* types/* && tsc -p tsconfig.json && node publishPackage.js","test":"echo \"Error: no test specified\" && exit 1"},"keywords":[],"author":"","license":"ISC","dependencies":{"ts-morph":"^15.1.0","lodash":"^4.17.21","handlebars":"^4.7.7"},"devDependencies":{"@types/node":"^18.0.0","eslint":"^8.9.0","prettier":"~2.7.1","typescript":"~4.8.0","rimraf":"^3.0.2","@types/lodash":"^4.14.182","fs-extra":"^10.0.0","@types/fs-extra":"^8.1.0","ts-node":"^10.7.0"}}

package/dist-esm/static/paginateContent.js

@@ -0,0 +1,211 @@
+export const paginateContent = `
+import {
+  getPagedAsyncIterator,
+  PagedAsyncIterableIterator,
+  PagedResult
+} from "@azure/core-paging";
+import {
+  Client,
+  createRestError,
+  PathUncheckedResponse
+} from "@azure-rest/core-client";
+
+/**
+ * Helper type to extract the type of an array
+ */
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+
+/**
+ * The type of a custom function that defines how to get a page and a link to the next one if any.
+ */
+export type GetPage<TPage> = (
+  pageLink: string,
+  maxPageSize?: number
+) => Promise<{
+  page: TPage;
+  nextPageLink?: string;
+}>;
+
+/**
+ * Options for the paging helper
+ */
+export interface PagingOptions<TResponse> {
+  /**
+   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
+  */
+  customGetPage?: GetPage<PaginateReturn<TResponse>[]>
+}
+
+/**
+ * Helper type to infer the Type of the paged elements from the response type
+ * This type is generated based on the swagger information for x-ms-pageable
+ * specifically on the itemName property which indicates the property of the response
+ * where the page items are found. The default value is \`value\`.
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
+ */
+ export type PaginateReturn<TResult> = TResult extends  {{#each itemNames}}
+ {
+ 
+  body: { {{this}}?: infer TPage } 
+  
+} {{#if @last }}{{else}} | {{/if}}
+{{/each}}
+  ? GetArrayType<TPage>
+  : Array<unknown>;
+  
+  /**
+ * Helper to paginate results from an initial response that follows the specification of Autorest \`x-ms-pageable\` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+   export function paginate<TResponse extends PathUncheckedResponse>(
+    client: Client,
+    initialResponse: TResponse,
+    options: PagingOptions<TResponse> = {}
+  ): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {
+    // Extract element type from initial response
+    type TElement = PaginateReturn<TResponse>;
+    let firstRun = true;
+    {{#if isComplexPaging}}
+    // We need to check the response for success before trying to inspect it looking for
+  // the properties to use for nextLink and itemName
+  checkPagingRequest(initialResponse);
+  const { itemName, nextLinkName } = getPaginationProperties(initialResponse);
+  {{else}}
+  const itemName = {{ quoteWrap itemNames }};
+  const nextLinkName = {{quoteWrap nextLinkNames}};
+  {{/if}}
+  const { customGetPage } = options;
+  const pagedResult: PagedResult<TElement[]> = {
+    firstPageLink: "",
+    getPage:
+      typeof customGetPage === "function"
+        ? customGetPage
+        : async (pageLink: string) => {
+            const result = firstRun
+              ? initialResponse
+              : await client.pathUnchecked(pageLink).get();
+            firstRun = false;
+            checkPagingRequest(result);
+            const nextLink = getNextLink(result.body, nextLinkName);
+            const values = getElements<TElement>(result.body, itemName);
+            return {
+              page: values,
+              nextPageLink: nextLink
+            };
+          }
+  };
+
+  return getPagedAsyncIterator(pagedResult);
+}
+
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body: unknown, nextLinkName?: string): string | undefined {
+   if (!nextLinkName) {
+    return undefined;
+  }
+
+  const nextLink = (body as Record<string, unknown>)[nextLinkName];
+
+  if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+    throw new Error(
+      \`Body Property \${nextLinkName} should be a string or undefined\`
+    );
+  }
+
+  return nextLink;
+}
+
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements<T = unknown>(body: unknown, itemName: string): T[] {
+  const value = (body as Record<string, unknown>)[itemName] as T[];
+
+  // value has to be an array according to the x-ms-pageable extension.
+  // The fact that this must be an array is used above to calculate the
+  // type of elements in the page in PaginateReturn
+  if (!Array.isArray(value)) {
+    throw new Error(
+      \`Couldn't paginate response\\n Body doesn't contain an array property with name: \${itemName}\`
+    );
+  }
+
+  return value ?? [];
+}
+
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response: PathUncheckedResponse): void {
+  const Http2xxStatusCodes = [
+    "200",
+    "201",
+    "202",
+    "203",
+    "204",
+    "205",
+    "206",
+    "207",
+    "208",
+    "226"
+  ];
+  if (!Http2xxStatusCodes.includes(response.status)) {
+    throw createRestError(
+      \`Pagination failed with unexpected statusCode \${response.status}\`,
+      response
+    );
+  }
+}
+
+{{#if isComplexPaging}}
+/**
+ * Extracts the itemName and nextLinkName from the initial response to use them for pagination
+ */
+function getPaginationProperties(initialResponse: PathUncheckedResponse) {
+  // Build a set with the passed custom nextLinkNames
+  const nextLinkNames = new Set([{{ quoteWrap nextLinkNames }}]);
+
+  // Build a set with the passed custom set of itemNames
+  const itemNames = new Set([{{ quoteWrap itemNames }}]);
+
+  let nextLinkName: string | undefined;
+  let itemName: string | undefined;
+
+  for (const name of nextLinkNames) {
+    const nextLink = (initialResponse.body as Record<string, unknown>)[
+      name
+    ] as string;
+    if (nextLink) {
+      nextLinkName = name;
+      break;
+    }
+  }
+
+  for (const name of itemNames) {
+    const item = (initialResponse.body as Record<string, unknown>)[
+      name
+    ] as string;
+    if (item) {
+      itemName = name;
+      break;
+    }
+  }
+
+  if (!itemName) {
+    throw new Error(
+      \`Couldn't paginate response\\n Body doesn't contain an array property with name: \${[
+        ...itemNames
+      ].join(" OR ")}\`
+    );
+  }
+
+  return { itemName, nextLinkName };
+}
+{{/if}}
+`;
+//# sourceMappingURL=paginateContent.js.map

package/dist-esm/static/paginateContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateContent.js","sourceRoot":"","sources":["../../src/static/paginateContent.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiN9B,CAAC"}