react-native-platform-override 0.0.0-canary.1016

package/README.md

@@ -0,0 +1,105 @@
+# react-native-platform-override
+Tools to manage "platform overrides" for out of tree React Native platforms.
+Facilities for inventorying changes and integrating new upstream changes are included.
+
+## Override Manifests
+
+`react-native-platform-override` operates on a JSON "override manifest" placed
+at the root of an npm package. It is expected that these are named
+`overrides.json`.
+
+An example override manifest
+```json
+{
+  "includePatterns": [
+    "src/**"
+  ],
+  "excludePatterns": [
+    "src/README.md"
+  ],
+  "baseVersion": "0.0.0-10b4b9505",
+  "overrides": [
+    {
+      "type": "derived",
+      "file": ".flowconfig",
+      "baseFile": ".flowconfig",
+      "baseVersion": "0.0.0-56cf99a96",
+      "baseHash": "8eab29258f5ad573e478324f10f850b7ccfb49c7"
+    },
+  ]
+}
+```
+
+| Name              | Required | Description                                                     | Default  |
+|-------------------|----------|-----------------------------------------------------------------|----------|
+| `includePatterns` | Optional | A list of globs of files to enforce are listed in the manifest. | `["**"]` |
+| `excludePatterns` | Optional | Globs to be excluded from the above list.                       | `[]`     |
+| `baseVersion`     | Optional | The default react-native version of an override                 |          |
+| `overrides`       | Required | List of registered overrides, added by the tooling              |          |
+
+## Override Types
+Overrides can be registered as different types, each with differing behavior.
+
+|          |                                                                                                                  |
+|----------|------------------------------------------------------------------------------------------------------------------|
+| Platform | Platform-specific logic that doesn't map to an upstream file                                                     |
+| Derived  | An override derived from an upstream file. Changes to the original file will be merged into the override.        |
+| Patch    | An upstream file with changes made to it. Changes to the original file will be merged into the override.         |
+| Copy     | An exact copy of an upstream file or directory. Overrides of this type will remain identical to their originals. |
+
+## CLI
+`react-native-platform-override` offers multiple commands to manipulate and verify the override manifest.
+
+### `validate`
+Verifies that overrides are recorded and up-to-date.
+
+| Option              | Required | Description                                        | Default                         |
+|---------------------|----------|----------------------------------------------------|---------------------------------|
+| `--manifest <file>` | Optional | Path to an override manifest to validate           | Package root above cwd          |
+| `--version <v>`     | Optional | A version of React Native to check against         | The currently installed version |
+
+
+### `add <override>`
+Adds an override to the manifest, prompting for details.
+
+| Option            | Required | Description               |
+|-------------------|----------|---------------------------|
+| `<override>`      | Required | The override to add       |
+
+### `remove <override>`
+Removes an override to the manifest.
+
+| Option            | Required | Description               |
+|-------------------|----------|---------------------------|
+| `<override>`      | Required | The override to remove    |
+
+### `upgrade`
+Attempts to automatically merge new changes into out-of-date overrides.
+
+| Option              | Required | Description                                                | Default                         |
+|---------------------|----------|------------------------------------------------------------|---------------------------------|
+| `--manifest <file>` | Optional | Path to an override manifest to validate                   | Package root above cwd          |
+| `--version <v>`     | Optional | A version of React Native to check against                 | The currently installed version |
+| `--no-conflicts`    | Optional | Whether to allow upgraded files to contain conlict markers | `--conflicts`                   |
+
+### `diff <override>`
+Diffs an override against its base file. It it compared to the base file of the override's current version, even if a newer verison of
+react-native is installed.
+
+| Option                 | Required | Description                                                                                                    | Default |
+|------------------------|----------|----------------------------------------------------------------------------------------------------------------|---------|
+| `<override>`           | Required | The override to diff against                                                                                   |         |
+
+## GitHub Tokens
+`react-native-platform-override` makes requests to GitHub's API. An OAuth token may optionally be provided by using the `--githubToken`
+parameter or setting the PLATFORM_OVERRIDE_GITHUB_TOKEN environment variable.
+
+## Programmatic Use
+`react-native-platform-override` offers a programmatic API with similar capabilities to the CLI. Take a look [here](./src/APi.ts) for details.
+
+E.g.
+```js
+import {validateManifest} from 'react-native-platform-override';
+
+const validationErrors = await validateManifest({manifestPath: 'src/overrides.json'});
+```

package/bin.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+
+require('source-map-support').install();
+require('./lib-commonjs/Cli');

package/lib-commonjs/Api.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+import OverrideFactory from './OverrideFactory';
+import Override from './Override';
+import { UpgradeResult } from './UpgradeStrategy';
+import { ValidationError } from './ValidationStrategy';
+export * from './OverrideFactory';
+export * from './Override';
+export * from './refFromVersion';
+export { UpgradeResult, ValidationError };
+/**
+ * Check that the given manifest correctly describe overrides and that all
+ * overrides are up to date
+ */
+export declare function validateManifest(manifestPath: string, opts?: {
+    reactNativeVersion?: string;
+}): Promise<ValidationError[]>;
+/**
+ * Return whether the override exists in the manifest
+ */
+export declare function hasOverride(overrideName: string, manifestPath: string): Promise<boolean>;
+/**
+ * Removes an override from the manifest if it exists.
+ * @returns whether the override was removed
+ */
+export declare function removeOverride(overrideName: string, manifestPath: string): Promise<boolean>;
+/**
+ * Returns a factory to create overrides which may be added to the manifest
+ */
+export declare function getOverrideFactory(manifestPath: string, opts?: {
+    reactNativeVersion?: string;
+}): Promise<OverrideFactory>;
+/**
+ * Adds an override to the manifest
+ */
+export declare function addOverride(override: Override, manifestPath: string): Promise<void>;
+/**
+ * Outputs a patch-style diff of an override compared to its original source
+ */
+export declare function diffOverride(overrideName: string, manifestPath: string): Promise<string>;
+/**
+ * Receives notifications on progress during override upgrades
+ */
+export type UpgradeProgressListener = (currentOverride: number, totalOverrides: number) => void;
+/**
+ * Attempts to automatically merge changes from the current version into
+ * out-of-date overrides.
+ */
+export declare function upgradeOverrides(manifestPath: string, opts: {
+    allowConflicts: boolean;
+    reactNativeVersion?: string;
+    progressListener?: UpgradeProgressListener;
+}): Promise<UpgradeResult[]>;

package/lib-commonjs/Api.js

@@ -0,0 +1,188 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upgradeOverrides = exports.diffOverride = exports.addOverride = exports.getOverrideFactory = exports.removeOverride = exports.hasOverride = exports.validateManifest = void 0;
+// Typings for "async" confuse this rule
+/* eslint-disable @typescript-eslint/no-misused-promises */
+const Serialized = __importStar(require("./Serialized"));
+const lodash_1 = __importDefault(require("lodash"));
+const fs_1 = __importDefault(require("@react-native-windows/fs"));
+const path_1 = __importDefault(require("path"));
+const OverrideFactory_1 = require("./OverrideFactory");
+const FileRepository_1 = require("./FileRepository");
+const async_1 = require("async");
+const FileSystemRepository_1 = __importDefault(require("./FileSystemRepository"));
+const GitReactFileRepository_1 = __importDefault(require("./GitReactFileRepository"));
+const Manifest_1 = __importDefault(require("./Manifest"));
+const PackageUtils_1 = require("./PackageUtils");
+// Re-export types used in the public API so external packages don't have to
+// reach into our guts to import them.
+__exportStar(require("./OverrideFactory"), exports);
+__exportStar(require("./Override"), exports);
+__exportStar(require("./refFromVersion"), exports);
+const MAX_CONCURRENT_TASKS = 30;
+/**
+ * Check that the given manifest correctly describe overrides and that all
+ * overrides are up to date
+ */
+async function validateManifest(manifestPath, opts) {
+    const { manifest, overrideRepo, reactRepo } = await createManifestContext(manifestPath, opts);
+    return await manifest.validate(overrideRepo, reactRepo);
+}
+exports.validateManifest = validateManifest;
+/**
+ * Return whether the override exists in the manifest
+ */
+async function hasOverride(overrideName, manifestPath) {
+    const { manifest } = await createManifestContext(manifestPath);
+    return manifest.hasOverride(overrideName);
+}
+exports.hasOverride = hasOverride;
+/**
+ * Removes an override from the manifest if it exists.
+ * @returns whether the override was removed
+ */
+async function removeOverride(overrideName, manifestPath) {
+    const { manifest } = await createManifestContext(manifestPath);
+    const removed = manifest.removeOverride(overrideName);
+    if (removed) {
+        await Serialized.writeManifestToFile(manifest.serialize(), manifestPath);
+    }
+    return removed;
+}
+exports.removeOverride = removeOverride;
+/**
+ * Returns a factory to create overrides which may be added to the manifest
+ */
+async function getOverrideFactory(manifestPath, opts) {
+    return (await createManifestContext(manifestPath, opts)).overrideFactory;
+}
+exports.getOverrideFactory = getOverrideFactory;
+/**
+ * Adds an override to the manifest
+ */
+async function addOverride(override, manifestPath) {
+    const { manifest } = await createManifestContext(manifestPath);
+    manifest.addOverride(override);
+    await Serialized.writeManifestToFile(manifest.serialize(), manifestPath);
+}
+exports.addOverride = addOverride;
+/**
+ * Outputs a patch-style diff of an override compared to its original source
+ */
+async function diffOverride(overrideName, manifestPath) {
+    const ctx = await createManifestContext(manifestPath);
+    const override = ctx.manifest.findOverride(overrideName);
+    if (!override) {
+        throw new Error(`Could not find override with name "${overrideName}"`);
+    }
+    return override.diffStrategy().diff(ctx.gitReactRepo, ctx.overrideRepo);
+}
+exports.diffOverride = diffOverride;
+/**
+ * Attempts to automatically merge changes from the current version into
+ * out-of-date overrides.
+ */
+async function upgradeOverrides(manifestPath, opts) {
+    const ctx = await createManifestContext(manifestPath, opts);
+    const validationErrors = await ctx.manifest.validate(ctx.overrideRepo, ctx.reactRepo);
+    const outOfDateOverrides = validationErrors
+        .filter(err => err.type === 'outOfDate')
+        .map(err => ctx.manifest.findOverride(err.overrideName));
+    // Perform upgrades concurrently so we can take advantage of
+    // GitReactFileRepository optimizations when multiple requests are queued at
+    // once.
+    let i = 0;
+    const upgradeResults = await (0, async_1.mapLimit)(outOfDateOverrides, MAX_CONCURRENT_TASKS, async (override) => {
+        const upgradeResult = await override
+            .upgradeStrategy()
+            .upgrade(ctx.gitReactRepo, ctx.overrideRepo, ctx.reactNativeVersion, opts.allowConflicts);
+        if (opts.progressListener) {
+            opts.progressListener(++i, outOfDateOverrides.length);
+        }
+        return upgradeResult;
+    });
+    // Regenerate overrides that are already up to date to update the baseVersion
+    // to current. This helps to minimize the numbers of versions we have to
+    // check out for future upgrades.
+    const upToDateOverrides = [
+        ...lodash_1.default.difference(ctx.manifest.listOverrides(), validationErrors.map(err => ctx.manifest.findOverride(err.overrideName))).map(ovr => ovr.name()),
+        ...upgradeResults
+            .filter(res => res.filesWritten)
+            .map(res => res.overrideName),
+    ];
+    await (0, async_1.eachLimit)(upToDateOverrides, MAX_CONCURRENT_TASKS, async (name) => {
+        await ctx.manifest.markUpToDate(name, ctx.overrideFactory);
+    });
+    ctx.manifest.setBaseVersion(ctx.reactNativeVersion);
+    await Serialized.writeManifestToFile(ctx.manifest.serialize(), manifestPath);
+    return upgradeResults.sort((a, b) => a.overrideName.localeCompare(b.overrideName, 'en'));
+}
+exports.upgradeOverrides = upgradeOverrides;
+/**
+ * Throw if a file doesn't exist, printing an error message on the way
+ */
+async function checkFileExists(friendlyName, filePath) {
+    try {
+        await fs_1.default.access(filePath);
+    }
+    catch (ex) {
+        throw new Error(`Could not find ${friendlyName} at path '${filePath}'`);
+    }
+}
+/**
+ * Sets up state for a manifest describing overrides at a specified RN version
+ */
+async function createManifestContext(manifestPath, opts) {
+    await checkFileExists('manifest', manifestPath);
+    const reactNativeVersion = (opts === null || opts === void 0 ? void 0 : opts.reactNativeVersion) || (await (0, PackageUtils_1.getInstalledRNVersion)());
+    const overrideDir = path_1.default.dirname(manifestPath);
+    const overrideRepo = new FileSystemRepository_1.default(overrideDir);
+    const gitReactRepo = await GitReactFileRepository_1.default.createAndInit();
+    const reactRepo = (0, FileRepository_1.bindVersion)(gitReactRepo, reactNativeVersion);
+    const overrideFactory = new OverrideFactory_1.OverrideFactoryImpl(reactRepo, overrideRepo);
+    const manifest = Manifest_1.default.fromSerialized(await Serialized.readManifestFromFile(manifestPath));
+    return {
+        overrideRepo,
+        reactRepo,
+        gitReactRepo,
+        overrideFactory,
+        manifest,
+        reactNativeVersion,
+    };
+}
+//# sourceMappingURL=Api.js.map

package/lib-commonjs/Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../src/Api.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,wCAAwC;AACxC,2DAA2D;AAE3D,yDAA2C;AAC3C,oDAAuB;AACvB,kEAA0C;AAC1C,gDAAwB;AAExB,uDAAuE;AACvE,qDAI0B;AAC1B,iCAA0C;AAC1C,kFAA0D;AAC1D,sFAA8D;AAC9D,0DAAkC;AAIlC,iDAAqD;AAErD,4EAA4E;AAC5E,sCAAsC;AACtC,oDAAkC;AAClC,6CAA2B;AAC3B,mDAAiC;AAGjC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEhC;;;GAGG;AACI,KAAK,UAAU,gBAAgB,CACpC,YAAoB,EACpB,IAEC;IAED,MAAM,EAAC,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAC,GAAG,MAAM,qBAAqB,CACrE,YAAY,EACZ,IAAI,CACL,CAAC;IACF,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;AAC1D,CAAC;AAXD,4CAWC;AAED;;GAEG;AACI,KAAK,UAAU,WAAW,CAC/B,YAAoB,EACpB,YAAoB;IAEpB,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC7D,OAAO,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;AAC5C,CAAC;AAND,kCAMC;AAED;;;GAGG;AACI,KAAK,UAAU,cAAc,CAClC,YAAoB,EACpB,YAAoB;IAEpB,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE;QACX,MAAM,UAAU,CAAC,mBAAmB,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAC;KAC1E;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAXD,wCAWC;AAED;;GAEG;AACI,KAAK,UAAU,kBAAkB,CACtC,YAAoB,EACpB,IAEC;IAED,OAAO,CAAC,MAAM,qBAAqB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC;AAC3E,CAAC;AAPD,gDAOC;AAED;;GAEG;AACI,KAAK,UAAU,WAAW,CAC/B,QAAkB,EAClB,YAAoB;IAEpB,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC7D,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/B,MAAM,UAAU,CAAC,mBAAmB,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAC;AAC3E,CAAC;AAPD,kCAOC;AAED;;GAEG;AACI,KAAK,UAAU,YAAY,CAChC,YAAoB,EACpB,YAAoB;IAEpB,MAAM,GAAG,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAEtD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,sCAAsC,YAAY,GAAG,CAAC,CAAC;KACxE;IAED,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;AAC1E,CAAC;AAZD,oCAYC;AAUD;;;GAGG;AACI,KAAK,UAAU,gBAAgB,CACpC,YAAoB,EACpB,IAIC;IAED,MAAM,GAAG,GAAG,MAAM,qBAAqB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAE5D,MAAM,gBAAgB,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAClD,GAAG,CAAC,YAAY,EAChB,GAAG,CAAC,SAAS,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,gBAAgB;SACxC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC;SACvC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAE,CAAC,CAAC;IAE5D,4DAA4D;IAC5D,4EAA4E;IAC5E,QAAQ;IACR,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,cAAc,GAAG,MAAM,IAAA,gBAAQ,EACnC,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,EAAE,QAAa,EAAE,EAAE;QACtB,MAAM,aAAa,GAAG,MAAM,QAAQ;aACjC,eAAe,EAAE;aACjB,OAAO,CACN,GAAG,CAAC,YAAY,EAChB,GAAG,CAAC,YAAY,EAChB,GAAG,CAAC,kBAAkB,EACtB,IAAI,CAAC,cAAc,CACpB,CAAC;QAEJ,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;SACvD;QAED,OAAO,aAAa,CAAC;IACvB,CAAC,CACF,CAAC;IAEF,6EAA6E;IAC7E,wEAAwE;IACxE,iCAAiC;IACjC,MAAM,iBAAiB,GAAG;QACxB,GAAG,gBAAC,CAAC,UAAU,CACb,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,EAC5B,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAE,CAAC,CAC1E,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAExB,GAAG,cAAc;aACd,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC;aAC/B,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC;KAChC,CAAC;IAEF,MAAM,IAAA,iBAAS,EAAC,iBAAiB,EAAE,oBAAoB,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;QACpE,MAAM,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACpD,MAAM,UAAU,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAC;IAE7E,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAClC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,EAAE,IAAI,CAAC,CACnD,CAAC;AACJ,CAAC;AApED,4CAoEC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAAC,YAAoB,EAAE,QAAgB;IACnE,IAAI;QACF,MAAM,YAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;KAC3B;IAAC,OAAO,EAAE,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,kBAAkB,YAAY,aAAa,QAAQ,GAAG,CAAC,CAAC;KACzE;AACH,CAAC;AAcD;;GAEG;AACH,KAAK,UAAU,qBAAqB,CAClC,YAAoB,EACpB,IAEC;IAED,MAAM,eAAe,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAChD,MAAM,kBAAkB,GACtB,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,KAAI,CAAC,MAAM,IAAA,oCAAqB,GAAE,CAAC,CAAC;IAE9D,MAAM,WAAW,GAAG,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,IAAI,8BAAoB,CAAC,WAAW,CAAC,CAAC;IAE3D,MAAM,YAAY,GAAG,MAAM,gCAAsB,CAAC,aAAa,EAAE,CAAC;IAClE,MAAM,SAAS,GAAG,IAAA,4BAAW,EAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAEhE,MAAM,eAAe,GAAG,IAAI,qCAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACzE,MAAM,QAAQ,GAAG,kBAAQ,CAAC,cAAc,CACtC,MAAM,UAAU,CAAC,oBAAoB,CAAC,YAAY,CAAC,CACpD,CAAC;IAEF,OAAO;QACL,YAAY;QACZ,SAAS;QACT,YAAY;QACZ,eAAe;QACf,QAAQ;QACR,kBAAkB;KACnB,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * @format\n */\n\n// Typings for \"async\" confuse this rule\n/* eslint-disable @typescript-eslint/no-misused-promises */\n\nimport * as Serialized from './Serialized';\nimport _ from 'lodash';\nimport fs from '@react-native-windows/fs';\nimport path from 'path';\n\nimport OverrideFactory, {OverrideFactoryImpl} from './OverrideFactory';\nimport {\n  ReactFileRepository,\n  WritableFileRepository,\n  bindVersion,\n} from './FileRepository';\nimport {eachLimit, mapLimit} from 'async';\nimport FileSystemRepository from './FileSystemRepository';\nimport GitReactFileRepository from './GitReactFileRepository';\nimport Manifest from './Manifest';\nimport Override from './Override';\nimport {UpgradeResult} from './UpgradeStrategy';\nimport {ValidationError} from './ValidationStrategy';\nimport {getInstalledRNVersion} from './PackageUtils';\n\n// Re-export types used in the public API so external packages don't have to\n// reach into our guts to import them.\nexport * from './OverrideFactory';\nexport * from './Override';\nexport * from './refFromVersion';\nexport {UpgradeResult, ValidationError};\n\nconst MAX_CONCURRENT_TASKS = 30;\n\n/**\n * Check that the given manifest correctly describe overrides and that all\n * overrides are up to date\n */\nexport async function validateManifest(\n  manifestPath: string,\n  opts?: {\n    reactNativeVersion?: string;\n  },\n): Promise<ValidationError[]> {\n  const {manifest, overrideRepo, reactRepo} = await createManifestContext(\n    manifestPath,\n    opts,\n  );\n  return await manifest.validate(overrideRepo, reactRepo);\n}\n\n/**\n * Return whether the override exists in the manifest\n */\nexport async function hasOverride(\n  overrideName: string,\n  manifestPath: string,\n): Promise<boolean> {\n  const {manifest} = await createManifestContext(manifestPath);\n  return manifest.hasOverride(overrideName);\n}\n\n/**\n * Removes an override from the manifest if it exists.\n * @returns whether the override was removed\n */\nexport async function removeOverride(\n  overrideName: string,\n  manifestPath: string,\n): Promise<boolean> {\n  const {manifest} = await createManifestContext(manifestPath);\n  const removed = manifest.removeOverride(overrideName);\n  if (removed) {\n    await Serialized.writeManifestToFile(manifest.serialize(), manifestPath);\n  }\n\n  return removed;\n}\n\n/**\n * Returns a factory to create overrides which may be added to the manifest\n */\nexport async function getOverrideFactory(\n  manifestPath: string,\n  opts?: {\n    reactNativeVersion?: string;\n  },\n): Promise<OverrideFactory> {\n  return (await createManifestContext(manifestPath, opts)).overrideFactory;\n}\n\n/**\n * Adds an override to the manifest\n */\nexport async function addOverride(\n  override: Override,\n  manifestPath: string,\n): Promise<void> {\n  const {manifest} = await createManifestContext(manifestPath);\n  manifest.addOverride(override);\n  await Serialized.writeManifestToFile(manifest.serialize(), manifestPath);\n}\n\n/**\n * Outputs a patch-style diff of an override compared to its original source\n */\nexport async function diffOverride(\n  overrideName: string,\n  manifestPath: string,\n): Promise<string> {\n  const ctx = await createManifestContext(manifestPath);\n\n  const override = ctx.manifest.findOverride(overrideName);\n  if (!override) {\n    throw new Error(`Could not find override with name \"${overrideName}\"`);\n  }\n\n  return override.diffStrategy().diff(ctx.gitReactRepo, ctx.overrideRepo);\n}\n\n/**\n * Receives notifications on progress during override upgrades\n */\nexport type UpgradeProgressListener = (\n  currentOverride: number,\n  totalOverrides: number,\n) => void;\n\n/**\n * Attempts to automatically merge changes from the current version into\n * out-of-date overrides.\n */\nexport async function upgradeOverrides(\n  manifestPath: string,\n  opts: {\n    allowConflicts: boolean;\n    reactNativeVersion?: string;\n    progressListener?: UpgradeProgressListener;\n  },\n): Promise<UpgradeResult[]> {\n  const ctx = await createManifestContext(manifestPath, opts);\n\n  const validationErrors = await ctx.manifest.validate(\n    ctx.overrideRepo,\n    ctx.reactRepo,\n  );\n\n  const outOfDateOverrides = validationErrors\n    .filter(err => err.type === 'outOfDate')\n    .map(err => ctx.manifest.findOverride(err.overrideName)!);\n\n  // Perform upgrades concurrently so we can take advantage of\n  // GitReactFileRepository optimizations when multiple requests are queued at\n  // once.\n  let i = 0;\n  const upgradeResults = await mapLimit<Override, UpgradeResult>(\n    outOfDateOverrides,\n    MAX_CONCURRENT_TASKS,\n    async (override: any) => {\n      const upgradeResult = await override\n        .upgradeStrategy()\n        .upgrade(\n          ctx.gitReactRepo,\n          ctx.overrideRepo,\n          ctx.reactNativeVersion,\n          opts.allowConflicts,\n        );\n\n      if (opts.progressListener) {\n        opts.progressListener(++i, outOfDateOverrides.length);\n      }\n\n      return upgradeResult;\n    },\n  );\n\n  // Regenerate overrides that are already up to date to update the baseVersion\n  // to current. This helps to minimize the numbers of versions we have to\n  // check out for future upgrades.\n  const upToDateOverrides = [\n    ..._.difference(\n      ctx.manifest.listOverrides(),\n      validationErrors.map(err => ctx.manifest.findOverride(err.overrideName)!),\n    ).map(ovr => ovr.name()),\n\n    ...upgradeResults\n      .filter(res => res.filesWritten)\n      .map(res => res.overrideName),\n  ];\n\n  await eachLimit(upToDateOverrides, MAX_CONCURRENT_TASKS, async name => {\n    await ctx.manifest.markUpToDate(name, ctx.overrideFactory);\n  });\n\n  ctx.manifest.setBaseVersion(ctx.reactNativeVersion);\n  await Serialized.writeManifestToFile(ctx.manifest.serialize(), manifestPath);\n\n  return upgradeResults.sort((a, b) =>\n    a.overrideName.localeCompare(b.overrideName, 'en'),\n  );\n}\n\n/**\n * Throw if a file doesn't exist, printing an error message on the way\n */\nasync function checkFileExists(friendlyName: string, filePath: string) {\n  try {\n    await fs.access(filePath);\n  } catch (ex) {\n    throw new Error(`Could not find ${friendlyName} at path '${filePath}'`);\n  }\n}\n\n/**\n * Context describing state centered around a single manifest\n */\ninterface ManifestContext {\n  overrideRepo: WritableFileRepository;\n  reactRepo: ReactFileRepository;\n  gitReactRepo: GitReactFileRepository;\n  overrideFactory: OverrideFactory;\n  manifest: Manifest;\n  reactNativeVersion: string;\n}\n\n/**\n * Sets up state for a manifest describing overrides at a specified RN version\n */\nasync function createManifestContext(\n  manifestPath: string,\n  opts?: {\n    reactNativeVersion?: string;\n  },\n): Promise<ManifestContext> {\n  await checkFileExists('manifest', manifestPath);\n  const reactNativeVersion =\n    opts?.reactNativeVersion || (await getInstalledRNVersion());\n\n  const overrideDir = path.dirname(manifestPath);\n  const overrideRepo = new FileSystemRepository(overrideDir);\n\n  const gitReactRepo = await GitReactFileRepository.createAndInit();\n  const reactRepo = bindVersion(gitReactRepo, reactNativeVersion);\n\n  const overrideFactory = new OverrideFactoryImpl(reactRepo, overrideRepo);\n  const manifest = Manifest.fromSerialized(\n    await Serialized.readManifestFromFile(manifestPath),\n  );\n\n  return {\n    overrideRepo,\n    reactRepo,\n    gitReactRepo,\n    overrideFactory,\n    manifest,\n    reactNativeVersion,\n  };\n}\n"]}

package/lib-commonjs/BatchingQueue.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+/**
+ * Executes actions, attempting to group by a given key
+ */
+export default class BatchingQueue<TKey> {
+    private readonly keyedQueues;
+    private currentKey?;
+    enqueue<T>(key: TKey, action: () => Promise<T>): Promise<T>;
+    private pumpQueue;
+}

package/lib-commonjs/BatchingQueue.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Executes actions, attempting to group by a given key
+ */
+class BatchingQueue {
+    constructor() {
+        this.keyedQueues = new Map();
+    }
+    enqueue(key, action) {
+        return new Promise((resolve, reject) => {
+            if (!this.keyedQueues.has(key)) {
+                this.keyedQueues.set(key, []);
+            }
+            this.keyedQueues.get(key).push(async () => {
+                try {
+                    resolve(await action());
+                }
+                catch (ex) {
+                    reject(ex);
+                }
+            });
+            if (!this.currentKey) {
+                this.currentKey = key;
+                void this.pumpQueue();
+            }
+        });
+    }
+    async pumpQueue() {
+        const currentQueue = this.keyedQueues.get(this.currentKey);
+        while (currentQueue.length > 0) {
+            await currentQueue.shift()();
+        }
+        this.keyedQueues.delete(this.currentKey);
+        this.currentKey = undefined;
+        // If we have more batches, pick the next greedily based on size
+        if (this.keyedQueues.size > 0) {
+            let nextKey;
+            let maxLength = 0;
+            this.keyedQueues.forEach((queue, key) => {
+                if (queue.length > maxLength) {
+                    maxLength = queue.length;
+                    nextKey = key;
+                }
+            });
+            this.currentKey = nextKey;
+            return this.pumpQueue();
+        }
+    }
+}
+exports.default = BatchingQueue;
+//# sourceMappingURL=BatchingQueue.js.map

package/lib-commonjs/BatchingQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BatchingQueue.js","sourceRoot":"","sources":["../src/BatchingQueue.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH;;GAEG;AACH,MAAqB,aAAa;IAAlC;QACmB,gBAAW,GAC1B,IAAI,GAAG,EAAE,CAAC;IAiDd,CAAC;IA9CC,OAAO,CAAI,GAAS,EAAE,MAAwB;QAC5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC9B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;aAC/B;YAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;gBACzC,IAAI;oBACF,OAAO,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;iBACzB;gBAAC,OAAO,EAAE,EAAE;oBACX,MAAM,CAAC,EAAE,CAAC,CAAC;iBACZ;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;gBACpB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;gBACtB,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;aACvB;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,SAAS;QACrB,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,UAAW,CAAE,CAAC;QAE7D,OAAO,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9B,MAAM,YAAY,CAAC,KAAK,EAAG,EAAE,CAAC;SAC/B;QAED,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,UAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,gEAAgE;QAChE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE;YAC7B,IAAI,OAAyB,CAAC;YAC9B,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,EAAE;oBAC5B,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;oBACzB,OAAO,GAAG,GAAG,CAAC;iBACf;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;YAC1B,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;SACzB;IACH,CAAC;CACF;AAnDD,gCAmDC","sourcesContent":["/**\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * @format\n */\n\n/**\n * Executes actions, attempting to group by a given key\n */\nexport default class BatchingQueue<TKey> {\n  private readonly keyedQueues: Map<TKey, Array<() => Promise<void>>> =\n    new Map();\n  private currentKey?: TKey;\n\n  enqueue<T>(key: TKey, action: () => Promise<T>): Promise<T> {\n    return new Promise((resolve, reject) => {\n      if (!this.keyedQueues.has(key)) {\n        this.keyedQueues.set(key, []);\n      }\n\n      this.keyedQueues.get(key)!.push(async () => {\n        try {\n          resolve(await action());\n        } catch (ex) {\n          reject(ex);\n        }\n      });\n\n      if (!this.currentKey) {\n        this.currentKey = key;\n        void this.pumpQueue();\n      }\n    });\n  }\n\n  private async pumpQueue(): Promise<void> {\n    const currentQueue = this.keyedQueues.get(this.currentKey!)!;\n\n    while (currentQueue.length > 0) {\n      await currentQueue.shift()!();\n    }\n\n    this.keyedQueues.delete(this.currentKey!);\n    this.currentKey = undefined;\n\n    // If we have more batches, pick the next greedily based on size\n    if (this.keyedQueues.size > 0) {\n      let nextKey: TKey | undefined;\n      let maxLength = 0;\n      this.keyedQueues.forEach((queue, key) => {\n        if (queue.length > maxLength) {\n          maxLength = queue.length;\n          nextKey = key;\n        }\n      });\n\n      this.currentKey = nextKey;\n      return this.pumpQueue();\n    }\n  }\n}\n"]}

package/lib-commonjs/Cli.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+export {};