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

package/dist/src/rlc-common/metadata/package-json/build-azure-monorepo-package.js

@@ -0,0 +1,155 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { getAzureCommonPackageInfo } from "./azure-package-common.js";
+import { getCommonPackageScripts, getPackageCommonInfo } from "./package-common.js";
+/**
+ * Builds the package.json for an Azure package that will be hosted in the azure-sdk-for-js mono repo.
+ */
+export function buildAzureMonorepoPackage(config) {
+    const packageInfo = {
+        ...getAzureMonorepoPackageInfo(config),
+        ...getAzureMonorepoDependencies(config),
+        scripts: getAzureMonorepoScripts(config),
+        ...getSampleMetadata(config),
+    };
+    return packageInfo;
+}
+/**
+ * Builds the dependencies for an Azure package that will be hosted in the azure-sdk-for-js mono repo.
+ */
+export function getAzureMonorepoDependencies(config) {
+    const { hasLro, dependencies, withTests } = config;
+    // revert this change after sdk repo update.
+    const runtimeDeps = {
+        ...dependencies,
+        "@azure-rest/core-client": "^2.3.1",
+        ...(hasLro && {
+            "@azure/abort-controller": "^2.1.2",
+        }),
+        "@azure/core-auth": "^1.9.0",
+        ...(hasLro && {
+            "@azure/core-lro": "^3.1.0",
+        }),
+        "@azure/core-rest-pipeline": "^1.20.0",
+        "@azure/core-util": "^1.12.0",
+        "@azure/logger": "^1.2.0",
+        tslib: "^2.8.1",
+    };
+    const testDeps = withTests
+        ? {
+            "@vitest/browser-playwright": "catalog:testing",
+            "@vitest/coverage-istanbul": "catalog:testing",
+            dotenv: "catalog:testing",
+            playwright: "catalog:testing",
+            typescript: "catalog:",
+            vitest: "catalog:testing",
+        }
+        : {
+            typescript: "catalog:",
+        };
+    return {
+        dependencies: runtimeDeps,
+        devDependencies: {
+            "@azure-tools/test-credential": "workspace:^",
+            "@azure-tools/test-recorder": "workspace:^",
+            "@azure-tools/test-utils-vitest": "workspace:^",
+            "@azure/dev-tool": "workspace:^",
+            "@azure/eslint-plugin-azure-sdk": "workspace:^",
+            "@azure/identity": "catalog:internal",
+            "@types/node": "catalog:",
+            "cross-env": "catalog:",
+            eslint: "catalog:",
+            prettier: "catalog:",
+            rimraf: "catalog:",
+            ...testDeps,
+        },
+    };
+}
+/**
+ * Build the common package.json config for an Azure package that will be hosted in the azure-sdk-for-js mono repo.
+ */
+export function getAzureMonorepoPackageInfo(config) {
+    const commonPackageInfo = getPackageCommonInfo(config);
+    const repositoryDirectory = config.monorepoPackageDirectory ?? "sdk/";
+    return {
+        ...commonPackageInfo,
+        ...getAzureCommonPackageInfo(config),
+        "sdk-type": `${config.azureArm ? "mgmt" : "client"}`,
+        repository: {
+            type: "git",
+            url: "git+https://github.com/Azure/azure-sdk-for-js",
+            directory: repositoryDirectory,
+        },
+        bugs: {
+            url: "https://github.com/Azure/azure-sdk-for-js/issues",
+        },
+        ...(config.monorepoPackageDirectory && {
+            homepage: `https://github.com/Azure/azure-sdk-for-js/tree/main/${config.monorepoPackageDirectory}/README.md`,
+        }),
+        prettier: "@azure/eslint-plugin-azure-sdk/prettier.json",
+        "//metadata": getMetadataInfo(config),
+    };
+}
+function getSampleMetadata({ name, version, withSamples }) {
+    if (!withSamples) {
+        return {};
+    }
+    let apiRefUrlQueryParameter = "";
+    if (version.includes("beta")) {
+        apiRefUrlQueryParameter = "?view=azure-node-preview";
+    }
+    return {
+        "//sampleConfiguration": {
+            productName: name,
+            productSlugs: ["azure"],
+            disableDocsMs: true,
+            apiRefLink: `https://learn.microsoft.com/javascript/api/${name}${apiRefUrlQueryParameter}`,
+        },
+    };
+}
+function getAzureMonorepoScripts(config) {
+    const esmScripts = getEsmScripts();
+    const skipLinting = config.azureArm;
+    const buildSampleScripts = config.azureArm
+        ? "tsc -p config/tsconfig.samples.json && dev-tool samples publish -f"
+        : "tsc -p config/tsconfig.samples.json";
+    return {
+        ...getCommonPackageScripts(),
+        "build:samples": config.withSamples ? buildSampleScripts : "echo skipped",
+        "check-format": `prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.{ts,cts,mts}" "test/**/*.{ts,cts,mts}" "*.{js,cjs,mjs,json}" ${config.withSamples ? '"samples-dev/*.ts"' : ""}`,
+        clean: "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+        "execute:samples": config.withSamples ? "dev-tool samples run samples-dev" : "echo skipped",
+        "extract-api": "rimraf review && dev-tool run extract-api",
+        format: `prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.{ts,cts,mts}" "test/**/*.{ts,cts,mts}" "*.{js,cjs,mjs,json}" ${config.withSamples ? '"samples-dev/*.ts"' : ""}`,
+        "generate:client": "echo skipped",
+        "test:browser": "dev-tool run test:vitest --browser",
+        "lint:fix": skipLinting
+            ? "echo skipped"
+            : "eslint package.json src test --fix --fix-type [problem,suggestion]",
+        lint: skipLinting ? "echo skipped" : "eslint package.json src test",
+        pack: `pnpm pack 2>&1`,
+        ...esmScripts,
+        "update-snippets": "dev-tool run update-snippets",
+    };
+}
+function getEsmScripts() {
+    return {
+        build: "npm run clean && dev-tool run build-package && dev-tool run extract-api",
+        "test:node": "dev-tool run test:vitest",
+        test: "tsc -b --noEmit && npm run test:node && npm run test:browser",
+    };
+}
+function getMetadataInfo(config) {
+    const metadata = {
+        constantPaths: [],
+    };
+    const paths = config.clientContextPaths;
+    for (const path of paths ?? []) {
+        metadata["constantPaths"].push({
+            path: path,
+            prefix: "userAgentInfo",
+        });
+    }
+    return metadata;
+}
+//# sourceMappingURL=build-azure-monorepo-package.js.map

package/dist/src/rlc-common/metadata/package-json/build-azure-monorepo-package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-azure-monorepo-package.js","sourceRoot":"","sources":["../../../../../src/rlc-common/metadata/package-json/build-azure-monorepo-package.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAA0B,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC9F,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAOpF;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAA+B;IACvE,MAAM,WAAW,GAAG;QAClB,GAAG,2BAA2B,CAAC,MAAM,CAAC;QACtC,GAAG,4BAA4B,CAAC,MAAM,CAAC;QACvC,OAAO,EAAE,uBAAuB,CAAC,MAAM,CAAC;QACxC,GAAG,iBAAiB,CAAC,MAAM,CAAC;KAC7B,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAA+B;IAC1E,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAEnD,4CAA4C;IAC5C,MAAM,WAAW,GAAG;QAClB,GAAG,YAAY;QACf,yBAAyB,EAAE,QAAQ;QACnC,GAAG,CAAC,MAAM,IAAI;YACZ,yBAAyB,EAAE,QAAQ;SACpC,CAAC;QACF,kBAAkB,EAAE,QAAQ;QAC5B,GAAG,CAAC,MAAM,IAAI;YACZ,iBAAiB,EAAE,QAAQ;SAC5B,CAAC;QACF,2BAA2B,EAAE,SAAS;QACtC,kBAAkB,EAAE,SAAS;QAC7B,eAAe,EAAE,QAAQ;QACzB,KAAK,EAAE,QAAQ;KAChB,CAAC;IAEF,MAAM,QAAQ,GAAG,SAAS;QACxB,CAAC,CAAC;YACE,4BAA4B,EAAE,iBAAiB;YAC/C,2BAA2B,EAAE,iBAAiB;YAC9C,MAAM,EAAE,iBAAiB;YACzB,UAAU,EAAE,iBAAiB;YAC7B,UAAU,EAAE,UAAU;YACtB,MAAM,EAAE,iBAAiB;SAC1B;QACH,CAAC,CAAC;YACE,UAAU,EAAE,UAAU;SACvB,CAAC;IAEN,OAAO;QACL,YAAY,EAAE,WAAW;QACzB,eAAe,EAAE;YACf,8BAA8B,EAAE,aAAa;YAC7C,4BAA4B,EAAE,aAAa;YAC3C,gCAAgC,EAAE,aAAa;YAC/C,iBAAiB,EAAE,aAAa;YAChC,gCAAgC,EAAE,aAAa;YAC/C,iBAAiB,EAAE,kBAAkB;YACrC,aAAa,EAAE,UAAU;YACzB,WAAW,EAAE,UAAU;YACvB,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,UAAU;YAClB,GAAG,QAAQ;SACZ;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,2BAA2B,CAAC,MAA+B;IACzE,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,mBAAmB,GAAG,MAAM,CAAC,wBAAwB,IAAI,MAAM,CAAC;IAEtE,OAAO;QACL,GAAG,iBAAiB;QACpB,GAAG,yBAAyB,CAAC,MAAM,CAAC;QACpC,UAAU,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;QACpD,UAAU,EAAE;YACV,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,+CAA+C;YACpD,SAAS,EAAE,mBAAmB;SAC/B;QACD,IAAI,EAAE;YACJ,GAAG,EAAE,kDAAkD;SACxD;QACD,GAAG,CAAC,MAAM,CAAC,wBAAwB,IAAI;YACrC,QAAQ,EAAE,uDAAuD,MAAM,CAAC,wBAAwB,YAAY;SAC7G,CAAC;QACF,QAAQ,EAAE,8CAA8C;QACxD,YAAY,EAAE,eAAe,CAAC,MAAM,CAAC;KACtC,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAA2B;IAChF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,uBAAuB,GAAW,EAAE,CAAC;IACzC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,uBAAuB,GAAG,0BAA0B,CAAC;IACvD,CAAC;IAED,OAAO;QACL,uBAAuB,EAAE;YACvB,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,CAAC,OAAO,CAAC;YACvB,aAAa,EAAE,IAAI;YACnB,UAAU,EAAE,8CAA8C,IAAI,GAAG,uBAAuB,EAAE;SAC3F;KACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,MAA+B;IAC9D,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;IACnC,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC;IACpC,MAAM,kBAAkB,GAAG,MAAM,CAAC,QAAQ;QACxC,CAAC,CAAC,oEAAoE;QACtE,CAAC,CAAC,qCAAqC,CAAC;IAC1C,OAAO;QACL,GAAG,uBAAuB,EAAE;QAC5B,eAAe,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,cAAc;QACzE,cAAc,EAAE,8KACd,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAC9C,EAAE;QACF,KAAK,EAAE,2EAA2E;QAClF,iBAAiB,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,kCAAkC,CAAC,CAAC,CAAC,cAAc;QAC3F,aAAa,EAAE,2CAA2C;QAC1D,MAAM,EAAE,qKACN,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAC9C,EAAE;QACF,iBAAiB,EAAE,cAAc;QACjC,cAAc,EAAE,oCAAoC;QACpD,UAAU,EAAE,WAAW;YACrB,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,oEAAoE;QACxE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,8BAA8B;QACnE,IAAI,EAAE,gBAAgB;QACtB,GAAG,UAAU;QACb,iBAAiB,EAAE,8BAA8B;KAClD,CAAC;AACJ,CAAC;AAED,SAAS,aAAa;IACpB,OAAO;QACL,KAAK,EAAE,yEAAyE;QAChF,WAAW,EAAE,0BAA0B;QACvC,IAAI,EAAE,8DAA8D;KACrE,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,MAA+B;IACtD,MAAM,QAAQ,GAAwB;QACpC,aAAa,EAAE,EAAE;KAClB,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,kBAAkB,CAAC;IACxC,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAC/B,QAAQ,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC;YAC7B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,eAAe;SACxB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/src/rlc-common/metadata/package-json/package-common.d.ts

@@ -0,0 +1,43 @@
+export interface PackageCommonInfoConfig {
+    name: string;
+    nameWithoutScope?: string;
+    version: string;
+    description: string;
+    withTests: boolean;
+    withSamples: boolean;
+    exports?: Record<string, any>;
+    dependencies?: Record<string, string>;
+    azureArm?: boolean;
+    /**
+     * When true, generates React Native build targets (dist/react-native, exports condition).
+     * Defaults to false.
+     */
+    generateReactNativeTarget?: boolean;
+}
+/**
+ * Common package.json config for a package.
+ */
+export declare function getPackageCommonInfo(config: PackageCommonInfoConfig): {
+    name: string;
+    version: string;
+    description: string;
+    engines: {
+        node: string;
+    };
+    sideEffects: boolean;
+    autoPublish: boolean;
+};
+/**
+ * Resolve source-level exports to dist-level exports for warp.
+ * Converts { ".": "./src/index.ts" } to the nested condition map with
+ * browser/import/require conditions pointing to dist/ paths.
+ */
+export declare function resolveWarpExports(sourceExports?: Record<string, any>, includeReactNative?: boolean): Record<string, any>;
+export declare function getCommonPackageScripts(): {
+    clean: string;
+    "extract-api": string;
+    pack: string;
+    lint: string;
+    "lint:fix": string;
+};
+//# sourceMappingURL=package-common.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"package-common.d.ts","sourceRoot":"","sources":["../../../../../src/rlc-common/metadata/package-json/package-common.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,uBAAuB;;;;;;;;;EAcnE;AAmCD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnC,kBAAkB,CAAC,EAAE,OAAO,GAC3B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA8CrB;AAED,wBAAgB,uBAAuB;;;;;;EAQtC"}

package/dist/src/rlc-common/metadata/package-json/package-common.js

@@ -0,0 +1,103 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Common package.json config for a package.
+ */
+export function getPackageCommonInfo(config) {
+    const { name, version, description } = config;
+    return {
+        name,
+        version,
+        description,
+        engines: {
+            node: ">=22.0.0",
+        },
+        sideEffects: false,
+        autoPublish: false,
+        ...getEntryPointInformation(config),
+    };
+}
+function getEntryPointInformation(config) {
+    // Azure monorepo packages use warp.
+    const result = {
+        type: "module",
+        main: "./dist/commonjs/index.js",
+        module: "./dist/esm/index.js",
+        types: "./dist/commonjs/index.d.ts",
+        browser: "./dist/browser/index.js",
+        imports: {
+            "#platform/*": {
+                browser: "./src/*-browser.mts",
+                default: "./src/*.ts",
+            },
+        },
+        exports: resolveWarpExports(config.exports, config.generateReactNativeTarget),
+    };
+    if (config.generateReactNativeTarget) {
+        result["react-native"] = "./dist/react-native/index.js";
+        result["imports"]["#platform/*"]["react-native"] =
+            "./src/*-react-native.mts";
+        // Reorder so react-native comes before default
+        const importsEntry = result["imports"]["#platform/*"];
+        result["imports"]["#platform/*"] = {
+            browser: importsEntry["browser"],
+            "react-native": importsEntry["react-native"],
+            default: importsEntry["default"],
+        };
+    }
+    return result;
+}
+/**
+ * Resolve source-level exports to dist-level exports for warp.
+ * Converts { ".": "./src/index.ts" } to the nested condition map with
+ * browser/import/require conditions pointing to dist/ paths.
+ */
+export function resolveWarpExports(sourceExports, includeReactNative) {
+    const exports = {};
+    const allExports = {
+        "./package.json": "./package.json",
+        ".": "./src/index.ts",
+        ...sourceExports,
+    };
+    for (const [subpath, sourcePath] of Object.entries(allExports)) {
+        // Pass-through entries (e.g. "./package.json": "./package.json")
+        if (!/\.ts$/.test(sourcePath)) {
+            exports[subpath] = sourcePath;
+            continue;
+        }
+        // Convert source path to dist path: "./src/foo/index.ts" -> "foo/index"
+        const relPath = sourcePath.replace(/^\.\/src\//, "").replace(/\.ts$/, "");
+        const exportEntry = {
+            browser: {
+                types: `./dist/browser/${relPath}.d.ts`,
+                default: `./dist/browser/${relPath}.js`,
+            },
+        };
+        if (includeReactNative) {
+            exportEntry["react-native"] = {
+                types: `./dist/react-native/${relPath}.d.ts`,
+                default: `./dist/react-native/${relPath}.js`,
+            };
+        }
+        exportEntry["import"] = {
+            types: `./dist/esm/${relPath}.d.ts`,
+            default: `./dist/esm/${relPath}.js`,
+        };
+        exportEntry["require"] = {
+            types: `./dist/commonjs/${relPath}.d.ts`,
+            default: `./dist/commonjs/${relPath}.js`,
+        };
+        exports[subpath] = exportEntry;
+    }
+    return exports;
+}
+export function getCommonPackageScripts() {
+    return {
+        clean: "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+        "extract-api": "rimraf review && mkdirp ./review && api-extractor run --local",
+        pack: "npm pack 2>&1",
+        lint: "eslint package.json api-extractor.json src",
+        "lint:fix": "eslint package.json api-extractor.json src --fix --fix-type [problem,suggestion]",
+    };
+}
+//# sourceMappingURL=package-common.js.map

package/dist/src/rlc-common/metadata/package-json/package-common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-common.js","sourceRoot":"","sources":["../../../../../src/rlc-common/metadata/package-json/package-common.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAmBlC;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAA+B;IAClE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAE9C,OAAO;QACL,IAAI;QACJ,OAAO;QACP,WAAW;QACX,OAAO,EAAE;YACP,IAAI,EAAE,UAAU;SACjB;QACD,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,KAAK;QAClB,GAAG,wBAAwB,CAAC,MAAM,CAAC;KACpC,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,MAA+B;IAC/D,oCAAoC;IACpC,MAAM,MAAM,GAAwB;QAClC,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,0BAA0B;QAChC,MAAM,EAAE,qBAAqB;QAC7B,KAAK,EAAE,4BAA4B;QACnC,OAAO,EAAE,yBAAyB;QAClC,OAAO,EAAE;YACP,aAAa,EAAE;gBACb,OAAO,EAAE,qBAAqB;gBAC9B,OAAO,EAAE,YAAY;aACI;SAC5B;QACD,OAAO,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,yBAAyB,CAAC;KAC9E,CAAC;IAEF,IAAI,MAAM,CAAC,yBAAyB,EAAE,CAAC;QACrC,MAAM,CAAC,cAAc,CAAC,GAAG,8BAA8B,CAAC;QACvD,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAA4B,CAAC,cAAc,CAAC;YAC1E,0BAA0B,CAAC;QAC7B,+CAA+C;QAC/C,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAA2B,CAAC;QAChF,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,GAAG;YACjC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC;YAChC,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC;YAC5C,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC;SACjC,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,aAAmC,EACnC,kBAA4B;IAE5B,MAAM,OAAO,GAAwB,EAAE,CAAC;IACxC,MAAM,UAAU,GAA2B;QACzC,gBAAgB,EAAE,gBAAgB;QAClC,GAAG,EAAE,gBAAgB;QACrB,GAAG,aAAa;KACjB,CAAC;IAEF,KAAK,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/D,iEAAiE;QACjE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,wEAAwE;QACxE,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAE1E,MAAM,WAAW,GAAwB;YACvC,OAAO,EAAE;gBACP,KAAK,EAAE,kBAAkB,OAAO,OAAO;gBACvC,OAAO,EAAE,kBAAkB,OAAO,KAAK;aACxC;SACF,CAAC;QAEF,IAAI,kBAAkB,EAAE,CAAC;YACvB,WAAW,CAAC,cAAc,CAAC,GAAG;gBAC5B,KAAK,EAAE,uBAAuB,OAAO,OAAO;gBAC5C,OAAO,EAAE,uBAAuB,OAAO,KAAK;aAC7C,CAAC;QACJ,CAAC;QAED,WAAW,CAAC,QAAQ,CAAC,GAAG;YACtB,KAAK,EAAE,cAAc,OAAO,OAAO;YACnC,OAAO,EAAE,cAAc,OAAO,KAAK;SACpC,CAAC;QAEF,WAAW,CAAC,SAAS,CAAC,GAAG;YACvB,KAAK,EAAE,mBAAmB,OAAO,OAAO;YACxC,OAAO,EAAE,mBAAmB,OAAO,KAAK;SACzC,CAAC;QAEF,OAAO,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,OAAO;QACL,KAAK,EAAE,2EAA2E;QAClF,aAAa,EAAE,+DAA+D;QAC9E,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,4CAA4C;QAClD,UAAU,EAAE,kFAAkF;KAC/F,CAAC;AACJ,CAAC"}

package/dist/src/rlc-common/static/paginate-content.d.ts

@@ -0,0 +1,2 @@
+export declare const paginateContent = "\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\n\n/**\n * returns an async iterator that iterates over results. It also has a `byPage`\n * method that returns pages of items at once.\n *\n * @param pagedResult - an object that specifies how to get pages.\n * @returns a paged async iterator that iterates over results.\n */\nfunction getPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings,\n  TLink = string,\n>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const iter = getItemAsyncIterator<TElement, TPage, TLink, TPageSettings>(pagedResult);\n  return {\n    next() {\n      return iter.next();\n    },\n    [Symbol.asyncIterator]() {\n      return this;\n    },\n    byPage:\n      pagedResult?.byPage ??\n      (((settings?: PageSettings) => {\n        const { continuationToken } = settings ?? {};\n        return getPageAsyncIterator(pagedResult, {\n          pageLink: continuationToken as unknown as TLink | undefined,\n        });\n      }) as unknown as (settings?: TPageSettings) => AsyncIterableIterator<TPage>),\n  };\n}\n\nasync function* getItemAsyncIterator<TElement, TPage, TLink, TPageSettings>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n): AsyncIterableIterator<TElement> {\n  const pages = getPageAsyncIterator(pagedResult);\n  const firstVal = await pages.next();\n  // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is\n  if (!Array.isArray(firstVal.value)) {\n    // can extract elements from this page\n    const { toElements } = pagedResult;\n    if (toElements) {\n      yield* toElements(firstVal.value) as TElement[];\n      for await (const page of pages) {\n        yield* toElements(page) as TElement[];\n      }\n    } else {\n      yield firstVal.value;\n      // `pages` is of type `AsyncIterableIterator<TPage>` but TPage = TElement in this case\n      yield* pages as unknown as AsyncIterableIterator<TElement>;\n    }\n  } else {\n    yield* firstVal.value;\n    for await (const page of pages) {\n      // pages is of type `AsyncIterableIterator<TPage>` so `page` is of type `TPage`. In this branch,\n      // it must be the case that `TPage = TElement[]`\n      yield* page as unknown as TElement[];\n    }\n  }\n}\n\nasync function* getPageAsyncIterator<TPage, TLink, TPageSettings>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n  options: {\n    pageLink?: TLink;\n  } = {},\n): AsyncIterableIterator<TPage> {\n  const { pageLink } = options;\n  let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);\n  if (!response) {\n    return;\n  }\n  yield response.page;\n  while (response.nextPageLink) {\n    response = await pagedResult.getPage(response.nextPageLink);\n    if (!response) {\n      return;\n    }\n    yield response.page;\n  }\n}\n\n/**\n * An interface that tracks the settings for paged iteration\n */\nexport interface PageSettings {\n  /**\n   * The token that keeps track of where to continue the iterator\n   */\n  continuationToken?: string;\n}\n\n/**\n * An interface that allows async iterable iteration both to completion and by page.\n */\nexport interface PagedAsyncIterableIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings,\n> {\n  /**\n   * The next method, part of the iteration protocol\n   */\n  next(): Promise<IteratorResult<TElement>>;\n  /**\n   * The connection to the async iterator, part of the iteration protocol\n   */\n  [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;\n  /**\n   * Return an AsyncIterableIterator that works a page at a time\n   */\n  byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\ninterface PagedResult<TPage, TPageSettings = PageSettings, TLink = string> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink: TLink;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (\n    pageLink: TLink,\n  ) => Promise<{ page: TPage; nextPageLink?: TLink } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => unknown[];\n}\n\n/**\n * Helper type to extract the type of an array\n */\nexport type GetArrayType<T> = T extends Array<infer TData> ? TData : never;\n\n/**\n * The type of a custom function that defines how to get a page and a link to the next one if any.\n */\nexport type GetPage<TPage> = (\n  pageLink: string,\n) => Promise<{\n  page: TPage;\n  nextPageLink?: string;\n}>;\n\n/**\n * Options for the paging helper\n */\nexport interface PagingOptions<TResponse> {\n  /**\n   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator\n  */\n  customGetPage?: GetPage<PaginateReturn<TResponse>[]>\n}\n\n/**\n * Helper type to infer the Type of the paged elements from the response type\n * This type is generated based on the swagger information for x-ms-pageable\n * specifically on the itemName property which indicates the property of the response\n * where the page items are found. The default value is `value`.\n * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter\n */\n export type PaginateReturn<TResult> = TResult extends  {{#each itemNames}}\n {\n \n  body: { {{this}}?: infer TPage } \n  \n} {{#if @last }}{{else}} | {{/if}}\n{{/each}}\n  ? GetArrayType<TPage>\n  : Array<unknown>;\n  \n  /**\n * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension\n * @param client - Client to use for sending the next page requests\n * @param initialResponse - Initial response containing the nextLink and current page of elements\n * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results\n * @returns - PagedAsyncIterableIterator to iterate the elements\n */\n   export function paginate<TResponse extends PathUncheckedResponse>(\n    client: Client,\n    initialResponse: TResponse,\n    options: PagingOptions<TResponse> = {}\n  ): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {\n    // Extract element type from initial response\n    type TElement = PaginateReturn<TResponse>;\n    let firstRun = true;\n    {{#if isComplexPaging}}\n    // We need to check the response for success before trying to inspect it looking for\n  // the properties to use for nextLink and itemName\n  checkPagingRequest(initialResponse);\n  const { itemName, nextLinkName } = getPaginationProperties(initialResponse);\n  {{else}}\n  const itemName = {{ quoteWrap itemNames }};\n  const nextLinkName = {{quoteWrap nextLinkNames}};\n  {{/if}}\n  const { customGetPage } = options;\n  const pagedResult: PagedResult<TElement[]> = {\n    firstPageLink: \"\",\n    getPage:\n      typeof customGetPage === \"function\"\n        ? customGetPage\n        : async (pageLink: string) => {\n            const result = firstRun\n              ? initialResponse\n              : await client.pathUnchecked(pageLink).get();\n            firstRun = false;\n            checkPagingRequest(result);\n            const nextLink = getNextLink(result.body, nextLinkName);\n            const values = getElements<TElement>(result.body, itemName);\n            return {\n              page: values,\n              nextPageLink: nextLink\n            };\n          }\n  };\n\n  return getPagedAsyncIterator(pagedResult);\n}\n\n/**\n * Gets for the value of nextLink in the body\n */\nfunction getNextLink(body: unknown, nextLinkName?: string): string | undefined {\n   if (!nextLinkName) {\n    return undefined;\n  }\n\n  const nextLink = (body as Record<string, unknown>)[nextLinkName];\n\n  if (typeof nextLink !== \"string\" && typeof nextLink !== \"undefined\") {\n    throw new Error(\n      `Body Property ${nextLinkName} should be a string or undefined`\n    );\n  }\n\n  return nextLink;\n}\n\n/**\n * Gets the elements of the current request in the body.\n */\nfunction getElements<T = unknown>(body: unknown, itemName: string): T[] {\n  const value = (body as Record<string, unknown>)[itemName] as T[];\n\n  // value has to be an array according to the x-ms-pageable extension.\n  // The fact that this must be an array is used above to calculate the\n  // type of elements in the page in PaginateReturn\n  if (!Array.isArray(value)) {\n    throw new Error(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${itemName}`\n    );\n  }\n\n  return value ?? [];\n}\n\n/**\n * Checks if a request failed\n */\nfunction checkPagingRequest(response: PathUncheckedResponse): void {\n  const Http2xxStatusCodes = [\n    \"200\",\n    \"201\",\n    \"202\",\n    \"203\",\n    \"204\",\n    \"205\",\n    \"206\",\n    \"207\",\n    \"208\",\n    \"226\"\n  ];\n  if (!Http2xxStatusCodes.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response\n    );\n  }\n}\n\n{{#if isComplexPaging}}\n/**\n * Extracts the itemName and nextLinkName from the initial response to use them for pagination\n */\nfunction getPaginationProperties(initialResponse: PathUncheckedResponse) {\n  // Build a set with the passed custom nextLinkNames\n  const nextLinkNames = new Set([{{ quoteWrap nextLinkNames }}]);\n\n  // Build a set with the passed custom set of itemNames\n  const itemNames = new Set([{{ quoteWrap itemNames }}]);\n\n  let nextLinkName: string | undefined;\n  let itemName: string | undefined;\n\n  for (const name of nextLinkNames) {\n    const nextLink = (initialResponse.body as Record<string, unknown>)[\n      name\n    ] as string;\n    if (nextLink) {\n      nextLinkName = name;\n      break;\n    }\n  }\n\n  for (const name of itemNames) {\n    const item = (initialResponse.body as Record<string, unknown>)[\n      name\n    ] as string;\n    if (item) {\n      itemName = name;\n      break;\n    }\n  }\n\n  if (!itemName) {\n    throw new Error(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${[\n        ...itemNames\n      ].join(\" OR \")}`\n    );\n  }\n\n  return { itemName, nextLinkName };\n}\n{{/if}}\n";
+//# sourceMappingURL=paginate-content.d.ts.map

package/dist/src/rlc-common/static/paginate-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginate-content.d.ts","sourceRoot":"","sources":["../../../../src/rlc-common/static/paginate-content.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,eAAe,25UAqV3B,CAAC"}