@fluidframework/fluid-runner 2.0.0-dev.1.3.0.96595

package/.eslintrc.js

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    "extends": [
+        require.resolve("@fluidframework/eslint-config-fluid")
+    ],
+    "parserOptions": {
+        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
+    },
+    "rules": {
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/strict-boolean-expressions": "off",
+    }
+}

package/.mocharc.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+'use strict';
+
+const getFluidTestMochaConfig = require('@fluidframework/mocha-test-setup/mocharc-common');
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @fluidframework/fluid-runner
+This package contains utility for running various functionality inside a Fluid Framework environment.
+
+## Export File
+Allows some execution to be made on a container given a provided ODSP snapshot.
+
+### Sample command
+If package is installed globally:
+`node fluid-runner exportFile --codeLoader=compiledBundle.js --inputFile=inputFileName.fluid --outputFile=result.txt --telemetryFile=telemetryFile.txt`
+
+If working directly on this package:
+```node bin/fluid-runner exportFile --codeLoader=compiledBundle.js --inputFile=inputFileName.fluid --outputFile=result.txt --telemetryFile=telemetryFile.txt```
+
+### Code Loader bundle format
+The Code Loader bundle should provide defined exports required for this functionality.
+For more details on what exports are needed, see [codeLoaderBundle.ts](./src/codeLoaderBundle.ts).
+
+#### "codeLoader" vs "IFluidFileConverter" argument
+You may notice the command line argument `codeLoader` is optional. If you choose not to provide a value for `codeLoader`, you must extend this library
+and provide a [`IFluidFileConverter`](./src/codeLoaderBundle.ts) implementation to the [`fluidRunner(...)`](./src/fluidRunner.ts) method.
+
+```
+import { fluidRunner } from "@fluidframework/fluid-runner";
+
+fluidRunner({ /* IFluidFileConverter implementation here */ });
+```
+
+> **Note**: Only one of `codeLoader` or `fluidRunner(...)` argument is allowed. If both or none are provided, an error will be thrown at the start of execution.
+
+### Input file format
+The input file is expected to be an ODSP snapshot.
+For some examples, see the files in the [localOdspSnapshots folder](./src/test/localOdspSnapshots).
+
+### Telemetry format
+There is an optional command line option `telemetryFormat` that allows you to specify the telemetry output format. The naming provided to this option is strict and must match an option in [OutputFormat](./src/logger/fileLogger.ts).
+The default format is currently `JSON`
+
+### Additional telemetry properties
+There is an optional command line option `telemetryProp` that allows you to specify additional properties that will be added to every telemetry entry. The format follows these rules:
+- every key must be a string
+- values may be either a string or a number
+- a value may not be empty
+
+Example of valid usages:
+```
+--telemetryProp prop1 value1 --telemetryProp prop2 10.5
+--telemetryProp "  prop1 " "   value1 " prop2 value2
+--telemetryProp=prop1 value1 --telemetryProp prop2 value2
+--telemetryProp
+```
+
+Example of invalid usages:
+```
+--telemetryProp "10" value1
+--telemetryProp prop1
+--telemetryProp=             // this will be treated as ['']
+```
+
+### Consumption
+The code around `exportFile` can be consumed in multiple different layers. It is not necessary to run all this code fully as is, and the following are some interesting code bits involved in this workflow:
+- [`createLogger(...)`](./src/logger/fileLogger.ts)
+    - Creates and wraps an `IFileLogger` and adds some useful telemetry data to every entry
+- [`createContainerAndExecute(...)`](./src/exportFile.ts)
+    - This is the core logic for running some action based on a local ODSP snapshot
+- [`getSnapshotFileContent(...)`](./src/utils.ts)
+    - Reads a local ODSP snapshot from both JSON and binary formats for usage in `createContainerAndExecute(...)`
+
+For an example of a consumption path that differs slightly to [`exportFile(...)`](./src/exportFile.ts), see [`parseBundleAndExportFile(...)`](./src/parseBundleAndExportFile.ts). In addition to running the same logic as [`exportFile`](./src/exportFile.ts) method, it implements the logic around parsing a dynamically provided bundle path into an `IFluidFileConverter` object.

package/bin/fluid-runner

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/fluidRunner.js");

package/dist/codeLoaderBundle.d.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { ICodeDetailsLoader, IContainer } from "@fluidframework/container-definitions";
+import { FluidObject } from "@fluidframework/core-interfaces";
+/**
+ * Contract that defines the necessary exports for the bundle provided at runtime
+ * For an example, see "src/test/sampleCodeLoaders/sampleCodeLoader.ts"
+ */
+export interface ICodeLoaderBundle {
+    /**
+     * Fluid export of all the required objects and functions
+     */
+    fluidExport: Promise<IFluidFileConverter>;
+}
+/**
+ * Instance that holds all the details for Fluid file conversion
+ */
+export interface IFluidFileConverter {
+    /**
+     * Get code loader details to provide at Loader creation
+     * @param logger - created logger object to pass to code loader
+     */
+    getCodeLoader(logger: ITelemetryBaseLogger): Promise<ICodeDetailsLoader>;
+    /**
+     * Scope object to provide at Loader creation
+     */
+    scope?: FluidObject;
+    /**
+     * Executes code on container and returns the result
+     * @param container - container created by this application
+     * @param options - additional options
+     */
+    execute(container: IContainer, options?: string): Promise<string>;
+}
+/**
+ * Type cast to ensure necessary methods are present in the provided bundle
+ * @param bundle - bundle provided to this application
+ */
+export declare function isCodeLoaderBundle(bundle: any): bundle is ICodeLoaderBundle;
+export declare function isFluidFileConverter(obj: any): obj is IFluidFileConverter;
+//# sourceMappingURL=codeLoaderBundle.d.ts.map

package/dist/codeLoaderBundle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codeLoaderBundle.d.ts","sourceRoot":"","sources":["../src/codeLoaderBundle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACrE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,iBAAiB,CAG3E;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,mBAAmB,CAIzE"}

package/dist/codeLoaderBundle.js

@@ -0,0 +1,23 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFluidFileConverter = exports.isCodeLoaderBundle = void 0;
+/**
+ * Type cast to ensure necessary methods are present in the provided bundle
+ * @param bundle - bundle provided to this application
+ */
+function isCodeLoaderBundle(bundle) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return (bundle === null || bundle === void 0 ? void 0 : bundle.fluidExport) && typeof bundle.fluidExport === "object";
+}
+exports.isCodeLoaderBundle = isCodeLoaderBundle;
+function isFluidFileConverter(obj) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return (obj === null || obj === void 0 ? void 0 : obj.getCodeLoader) && typeof obj.getCodeLoader === "function"
+        && obj.execute && typeof obj.execute === "function";
+}
+exports.isFluidFileConverter = isFluidFileConverter;
+//# sourceMappingURL=codeLoaderBundle.js.map

package/dist/codeLoaderBundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codeLoaderBundle.js","sourceRoot":"","sources":["../src/codeLoaderBundle.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwCH;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,MAAW;IAC1C,+DAA+D;IAC/D,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,KAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,CAAC;AACzE,CAAC;AAHD,gDAGC;AAED,SAAgB,oBAAoB,CAAC,GAAQ;IACzC,+DAA+D;IAC/D,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAa,KAAI,OAAO,GAAG,CAAC,aAAa,KAAK,UAAU;WAC7D,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,CAAC;AAC5D,CAAC;AAJD,oDAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { ICodeDetailsLoader, IContainer } from \"@fluidframework/container-definitions\";\nimport { FluidObject } from \"@fluidframework/core-interfaces\";\n\n/**\n * Contract that defines the necessary exports for the bundle provided at runtime\n * For an example, see \"src/test/sampleCodeLoaders/sampleCodeLoader.ts\"\n */\nexport interface ICodeLoaderBundle {\n    /**\n     * Fluid export of all the required objects and functions\n     */\n    fluidExport: Promise<IFluidFileConverter>;\n}\n\n/**\n * Instance that holds all the details for Fluid file conversion\n */\nexport interface IFluidFileConverter {\n    /**\n     * Get code loader details to provide at Loader creation\n     * @param logger - created logger object to pass to code loader\n     */\n    getCodeLoader(logger: ITelemetryBaseLogger): Promise<ICodeDetailsLoader>;\n\n    /**\n     * Scope object to provide at Loader creation\n     */\n    scope?: FluidObject;\n\n    /**\n     * Executes code on container and returns the result\n     * @param container - container created by this application\n     * @param options - additional options\n     */\n    execute(container: IContainer, options?: string): Promise<string>;\n}\n\n/**\n * Type cast to ensure necessary methods are present in the provided bundle\n * @param bundle - bundle provided to this application\n */\nexport function isCodeLoaderBundle(bundle: any): bundle is ICodeLoaderBundle {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return bundle?.fluidExport && typeof bundle.fluidExport === \"object\";\n}\n\nexport function isFluidFileConverter(obj: any): obj is IFluidFileConverter {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return obj?.getCodeLoader && typeof obj.getCodeLoader === \"function\"\n        && obj.execute && typeof obj.execute === \"function\";\n}\n"]}

package/dist/exportFile.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IFluidFileConverter } from "./codeLoaderBundle";
+import { ITelemetryOptions } from "./logger/fileLogger";
+export declare type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;
+interface IExportFileResponseSuccess {
+    success: true;
+}
+interface IExportFileResponseFailure {
+    success: false;
+    eventName: string;
+    errorMessage: string;
+    error?: any;
+}
+/**
+ * Execute code on Container based on ODSP snapshot and write result to file
+ */
+export declare function exportFile(fluidFileConverter: IFluidFileConverter, inputFile: string, outputFile: string, telemetryFile: string, options?: string, telemetryOptions?: ITelemetryOptions): Promise<IExportFileResponse>;
+/**
+ * Create the container based on an ODSP snapshot and execute code on it
+ * @returns result of execution
+ */
+export declare function createContainerAndExecute(localOdspSnapshot: string | Uint8Array, fluidFileConverter: IFluidFileConverter, logger: ITelemetryLogger, options?: string): Promise<string>;
+export {};
+//# sourceMappingURL=exportFile.d.ts.map

package/dist/exportFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportFile.d.ts","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAMtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAIzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,oBAAY,mBAAmB,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAE1F,UAAU,0BAA0B;IAChC,OAAO,EAAE,IAAI,CAAC;CACjB;AAED,UAAU,0BAA0B;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAID;;GAEG;AACH,wBAAsB,UAAU,CAC5B,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,EAChB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,mBAAmB,CAAC,CAiC9B;AAED;;;GAGG;AACH,wBAAsB,yBAAyB,CAC3C,iBAAiB,EAAE,MAAM,GAAG,UAAU,EACtC,kBAAkB,EAAE,mBAAmB,EACvC,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,CAcjB"}

package/dist/exportFile.js

@@ -0,0 +1,87 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createContainerAndExecute = exports.exportFile = void 0;
+const fs = __importStar(require("fs"));
+const container_definitions_1 = require("@fluidframework/container-definitions");
+const container_loader_1 = require("@fluidframework/container-loader");
+const odsp_driver_1 = require("@fluidframework/odsp-driver");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const getArgsValidationError_1 = require("./getArgsValidationError");
+const fakeUrlResolver_1 = require("./fakeUrlResolver");
+const utils_1 = require("./utils");
+const loggerUtils_1 = require("./logger/loggerUtils");
+const clientArgsValidationError = "Client_ArgsValidationError";
+/**
+ * Execute code on Container based on ODSP snapshot and write result to file
+ */
+async function exportFile(fluidFileConverter, inputFile, outputFile, telemetryFile, options, telemetryOptions) {
+    const telemetryArgError = (0, loggerUtils_1.getTelemetryFileValidationError)(telemetryFile);
+    if (telemetryArgError) {
+        const eventName = clientArgsValidationError;
+        return { success: false, eventName, errorMessage: telemetryArgError };
+    }
+    const { fileLogger, logger } = (0, loggerUtils_1.createLogger)(telemetryFile, telemetryOptions);
+    try {
+        return await telemetry_utils_1.PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
+            const argsValidationError = (0, getArgsValidationError_1.getArgsValidationError)(inputFile, outputFile);
+            if (argsValidationError) {
+                const eventName = clientArgsValidationError;
+                logger.sendErrorEvent({ eventName, message: argsValidationError });
+                return { success: false, eventName, errorMessage: argsValidationError };
+            }
+            fs.writeFileSync(outputFile, await createContainerAndExecute((0, utils_1.getSnapshotFileContent)(inputFile), fluidFileConverter, logger, options));
+            return { success: true };
+        });
+    }
+    catch (error) {
+        const eventName = "Client_UnexpectedError";
+        logger.sendErrorEvent({ eventName }, error);
+        return { success: false, eventName, errorMessage: "Unexpected error", error };
+    }
+    finally {
+        await fileLogger.close();
+    }
+}
+exports.exportFile = exportFile;
+/**
+ * Create the container based on an ODSP snapshot and execute code on it
+ * @returns result of execution
+ */
+async function createContainerAndExecute(localOdspSnapshot, fluidFileConverter, logger, options) {
+    const loader = new container_loader_1.Loader({
+        urlResolver: new fakeUrlResolver_1.FakeUrlResolver(),
+        documentServiceFactory: (0, odsp_driver_1.createLocalOdspDocumentServiceFactory)(localOdspSnapshot),
+        codeLoader: await fluidFileConverter.getCodeLoader(logger),
+        scope: fluidFileConverter.scope,
+        logger,
+    });
+    const container = await loader.resolve({ url: "/fakeUrl/", headers: {
+            [container_definitions_1.LoaderHeader.loadMode]: { opsBeforeReturn: "cached" }
+        } });
+    return telemetry_utils_1.PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => fluidFileConverter.execute(container, options));
+}
+exports.createContainerAndExecute = createContainerAndExecute;
+//# sourceMappingURL=exportFile.js.map

package/dist/exportFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportFile.js","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,iFAAqE;AACrE,uEAA0D;AAC1D,6DAAoF;AACpF,qEAAmE;AACnE,qEAAkE;AAElE,uDAAoD;AACpD,mCAAiD;AAGjD,sDAAqF;AAgBrF,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAE/D;;GAEG;AACI,KAAK,UAAU,UAAU,CAC5B,kBAAuC,EACvC,SAAiB,EACjB,UAAkB,EAClB,aAAqB,EACrB,OAAgB,EAChB,gBAAoC;IAEpC,MAAM,iBAAiB,GAAG,IAAA,6CAA+B,EAAC,aAAa,CAAC,CAAC;IACzE,IAAI,iBAAiB,EAAE;QACnB,MAAM,SAAS,GAAG,yBAAyB,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC;KACzE;IACD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAA,0BAAY,EAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAE7E,IAAI;QACA,OAAO,MAAM,kCAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE;YACzF,MAAM,mBAAmB,GAAG,IAAA,+CAAsB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC1E,IAAI,mBAAmB,EAAE;gBACrB,MAAM,SAAS,GAAG,yBAAyB,CAAC;gBAC5C,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;gBACnE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,mBAAmB,EAAE,CAAC;aAC3E;YAED,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,yBAAyB,CACxD,IAAA,8BAAsB,EAAC,SAAS,CAAC,EACjC,kBAAkB,EAClB,MAAM,EACN,OAAO,CACV,CAAC,CAAC;YAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;KACN;IAAC,OAAO,KAAK,EAAE;QACZ,MAAM,SAAS,GAAG,wBAAwB,CAAC;QAC3C,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;KACjF;YAAS;QACN,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;KAC5B;AACL,CAAC;AAxCD,gCAwCC;AAED;;;GAGG;AACI,KAAK,UAAU,yBAAyB,CAC3C,iBAAsC,EACtC,kBAAuC,EACvC,MAAwB,EACxB,OAAgB;IAEhB,MAAM,MAAM,GAAG,IAAI,yBAAM,CAAC;QACtB,WAAW,EAAE,IAAI,iCAAe,EAAE;QAClC,sBAAsB,EAAE,IAAA,mDAAqC,EAAC,iBAAiB,CAAC;QAChF,UAAU,EAAE,MAAM,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC;QAC1D,KAAK,EAAE,kBAAkB,CAAC,KAAK;QAC/B,MAAM;KACT,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE;YAChE,CAAC,oCAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE;SAAE,EAAE,CAAC,CAAC;IAEhE,OAAO,kCAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACxD,CAAC;AAnBD,8DAmBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { LoaderHeader } from \"@fluidframework/container-definitions\";\nimport { Loader } from \"@fluidframework/container-loader\";\nimport { createLocalOdspDocumentServiceFactory } from \"@fluidframework/odsp-driver\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { getArgsValidationError } from \"./getArgsValidationError\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\nimport { FakeUrlResolver } from \"./fakeUrlResolver\";\nimport { getSnapshotFileContent } from \"./utils\";\n/* eslint-disable import/no-internal-modules */\nimport { ITelemetryOptions } from \"./logger/fileLogger\";\nimport { createLogger, getTelemetryFileValidationError } from \"./logger/loggerUtils\";\n/* eslint-enable import/no-internal-modules */\n\nexport type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;\n\ninterface IExportFileResponseSuccess {\n    success: true;\n}\n\ninterface IExportFileResponseFailure {\n    success: false;\n    eventName: string;\n    errorMessage: string;\n    error?: any;\n}\n\nconst clientArgsValidationError = \"Client_ArgsValidationError\";\n\n/**\n * Execute code on Container based on ODSP snapshot and write result to file\n */\nexport async function exportFile(\n    fluidFileConverter: IFluidFileConverter,\n    inputFile: string,\n    outputFile: string,\n    telemetryFile: string,\n    options?: string,\n    telemetryOptions?: ITelemetryOptions,\n): Promise<IExportFileResponse> {\n    const telemetryArgError = getTelemetryFileValidationError(telemetryFile);\n    if (telemetryArgError) {\n        const eventName = clientArgsValidationError;\n        return { success: false, eventName, errorMessage: telemetryArgError };\n    }\n    const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);\n\n    try {\n        return await PerformanceEvent.timedExecAsync(logger, { eventName: \"ExportFile\" }, async () => {\n            const argsValidationError = getArgsValidationError(inputFile, outputFile);\n            if (argsValidationError) {\n                const eventName = clientArgsValidationError;\n                logger.sendErrorEvent({ eventName, message: argsValidationError });\n                return { success: false, eventName, errorMessage: argsValidationError };\n            }\n\n            fs.writeFileSync(outputFile, await createContainerAndExecute(\n                getSnapshotFileContent(inputFile),\n                fluidFileConverter,\n                logger,\n                options,\n            ));\n\n            return { success: true };\n        });\n    } catch (error) {\n        const eventName = \"Client_UnexpectedError\";\n        logger.sendErrorEvent({ eventName }, error);\n        return { success: false, eventName, errorMessage: \"Unexpected error\", error };\n    } finally {\n        await fileLogger.close();\n    }\n}\n\n/**\n * Create the container based on an ODSP snapshot and execute code on it\n * @returns result of execution\n */\nexport async function createContainerAndExecute(\n    localOdspSnapshot: string | Uint8Array,\n    fluidFileConverter: IFluidFileConverter,\n    logger: ITelemetryLogger,\n    options?: string,\n): Promise<string> {\n    const loader = new Loader({\n        urlResolver: new FakeUrlResolver(),\n        documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),\n        codeLoader: await fluidFileConverter.getCodeLoader(logger),\n        scope: fluidFileConverter.scope,\n        logger,\n    });\n\n    const container = await loader.resolve({ url: \"/fakeUrl/\", headers: {\n        [LoaderHeader.loadMode]: { opsBeforeReturn: \"cached\" } } });\n\n    return PerformanceEvent.timedExecAsync(logger, { eventName: \"ExportFile\" }, async () =>\n        fluidFileConverter.execute(container, options));\n}\n"]}

package/dist/fakeUrlResolver.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IRequest } from "@fluidframework/core-interfaces";
+import { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
+/**
+ * Fake URL resolver that returns hard coded values on every request
+ * @internal
+ */
+export declare class FakeUrlResolver implements IUrlResolver {
+    resolve(_request: IRequest): Promise<IResolvedUrl | undefined>;
+    getAbsoluteUrl(_resolvedUrl: IResolvedUrl, _relativeUrl: string, _packageInfoSource?: IContainerPackageInfo): Promise<string>;
+}
+//# sourceMappingURL=fakeUrlResolver.d.ts.map

package/dist/fakeUrlResolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fakeUrlResolver.d.ts","sourceRoot":"","sources":["../src/fakeUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAMvG;;;GAGG;AACH,qBAAa,eAAgB,YAAW,YAAY;IACnC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAyB9D,cAAc,CACvB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,qBAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC;CAGrB"}

package/dist/fakeUrlResolver.js

@@ -0,0 +1,43 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FakeUrlResolver = void 0;
+const fakeId = "FakeUrlResolver";
+const fakeUrl = "/FakeUrlResolver/";
+/**
+ * Fake URL resolver that returns hard coded values on every request
+ * @internal
+ */
+class FakeUrlResolver {
+    async resolve(_request) {
+        const fakeOdspResolvedUrl = {
+            type: "fluid",
+            odspResolvedUrl: true,
+            id: fakeId,
+            siteUrl: fakeUrl,
+            driveId: fakeId,
+            itemId: fakeId,
+            url: fakeUrl,
+            hashedDocumentId: fakeId,
+            endpoints: {
+                snapshotStorageUrl: fakeUrl,
+                attachmentPOSTStorageUrl: fakeUrl,
+                attachmentGETStorageUrl: fakeUrl,
+                deltaStorageUrl: fakeUrl,
+            },
+            tokens: {},
+            fileName: fakeId,
+            summarizer: false,
+            fileVersion: fakeId,
+        };
+        return fakeOdspResolvedUrl;
+    }
+    async getAbsoluteUrl(_resolvedUrl, _relativeUrl, _packageInfoSource) {
+        return "";
+    }
+}
+exports.FakeUrlResolver = FakeUrlResolver;
+//# sourceMappingURL=fakeUrlResolver.js.map

package/dist/fakeUrlResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fakeUrlResolver.js","sourceRoot":"","sources":["../src/fakeUrlResolver.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH,MAAM,MAAM,GAAG,iBAAiB,CAAC;AACjC,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAEpC;;;GAGG;AACH,MAAa,eAAe;IACjB,KAAK,CAAC,OAAO,CAAC,QAAkB;QACnC,MAAM,mBAAmB,GAAqB;YAC1C,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,EAAE,EAAE,MAAM;YACV,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,OAAO;YACZ,gBAAgB,EAAE,MAAM;YACxB,SAAS,EAAE;gBACP,kBAAkB,EAAE,OAAO;gBAC3B,wBAAwB,EAAE,OAAO;gBACjC,uBAAuB,EAAE,OAAO;gBAChC,eAAe,EAAE,OAAO;aAC3B;YACD,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,MAAM;YAChB,UAAU,EAAE,KAAK;YACjB,WAAW,EAAE,MAAM;SACtB,CAAC;QAEF,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,YAA0B,EAC1B,YAAoB,EACpB,kBAA0C;QAE1C,OAAO,EAAE,CAAC;IACd,CAAC;CACJ;AAjCD,0CAiCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\n\nconst fakeId = \"FakeUrlResolver\";\nconst fakeUrl = \"/FakeUrlResolver/\";\n\n/**\n * Fake URL resolver that returns hard coded values on every request\n * @internal\n */\nexport class FakeUrlResolver implements IUrlResolver {\n    public async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {\n        const fakeOdspResolvedUrl: IOdspResolvedUrl = {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            id: fakeId,\n            siteUrl: fakeUrl,\n            driveId: fakeId,\n            itemId: fakeId,\n            url: fakeUrl,\n            hashedDocumentId: fakeId,\n            endpoints: {\n                snapshotStorageUrl: fakeUrl,\n                attachmentPOSTStorageUrl: fakeUrl,\n                attachmentGETStorageUrl: fakeUrl,\n                deltaStorageUrl: fakeUrl,\n            },\n            tokens: {},\n            fileName: fakeId,\n            summarizer: false,\n            fileVersion: fakeId,\n        };\n\n        return fakeOdspResolvedUrl;\n    }\n\n    public async getAbsoluteUrl(\n        _resolvedUrl: IResolvedUrl,\n        _relativeUrl: string,\n        _packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        return \"\";\n    }\n}\n"]}

package/dist/fluidRunner.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IFluidFileConverter } from "./codeLoaderBundle";
+/**
+ * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
+ */
+export declare function fluidRunner(fluidFileConverter?: IFluidFileConverter): void;
+//# sourceMappingURL=fluidRunner.d.ts.map

package/dist/fluidRunner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluidRunner.d.ts","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAMzD;;GAEG;AACH,wBAAgB,WAAW,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,QAqFnE"}

package/dist/fluidRunner.js

@@ -0,0 +1,106 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fluidRunner = void 0;
+/* eslint-disable max-len */
+const yargs = __importStar(require("yargs"));
+const exportFile_1 = require("./exportFile");
+const parseBundleAndExportFile_1 = require("./parseBundleAndExportFile");
+// eslint-disable-next-line import/no-internal-modules
+const loggerUtils_1 = require("./logger/loggerUtils");
+const utils_1 = require("./utils");
+/**
+ * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
+ */
+function fluidRunner(fluidFileConverter) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    yargs
+        .strict()
+        .version(false)
+        .command("exportFile", "Generate an output for a local ODSP snapshot", 
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    (yargs) => yargs
+        .option("codeLoader", {
+        describe: "Path to code loader bundle. Required if this application is being called without modification.\nSee \"README.md\" for more details.",
+        type: "string",
+        demandOption: false,
+    })
+        .option("inputFile", {
+        describe: "Path to local ODSP snapshot",
+        type: "string",
+        demandOption: true,
+    })
+        .option("outputFile", {
+        describe: "Path of output file (cannot already exist).\nExecution result will be written here",
+        type: "string",
+        demandOption: true,
+    })
+        .option("telemetryFile", {
+        describe: "Path of telemetry file for config and session data (cannot already exist)",
+        type: "string",
+        demandOption: true,
+    })
+        .option("options", {
+        describe: "Additional options passed to container on execution",
+        type: "string",
+        demandOption: false,
+    })
+        .option("telemetryFormat", {
+        describe: "Output format for telemetry. Current options are: [\"JSON\", \"CSV\"]",
+        type: "string",
+        demandOption: false,
+        default: "JSON",
+    })
+        .option("telemetryProp", {
+        describe: "Property to add to every telemetry entry. Formatted like \"--telemetryProp prop1 value1 --telemetryProp prop2 \\\"value 2\\\"\".",
+        type: "array",
+        demandOption: false,
+    }), 
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    async (argv) => {
+        const argsError = (0, utils_1.validateCommandLineArgs)(argv.codeLoader, fluidFileConverter);
+        if (argsError) {
+            console.error(argsError);
+            process.exit(1);
+        }
+        const telemetryOptionsResult = (0, loggerUtils_1.validateAndParseTelemetryOptions)(argv.telemetryFormat, argv.telemetryProp);
+        if (!telemetryOptionsResult.success) {
+            console.error(telemetryOptionsResult.error);
+            process.exit(1);
+        }
+        const result = await (argv.codeLoader
+            ? (0, parseBundleAndExportFile_1.parseBundleAndExportFile)(argv.codeLoader, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options, telemetryOptionsResult.telemetryOptions) : (0, exportFile_1.exportFile)(fluidFileConverter, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options, telemetryOptionsResult.telemetryOptions));
+        if (!result.success) {
+            console.error(`${result.eventName}: ${result.errorMessage}`);
+            process.exit(1);
+        }
+    })
+        .help()
+        .demandCommand().argv;
+}
+exports.fluidRunner = fluidRunner;
+fluidRunner();
+/* eslint-enable max-len */
+//# sourceMappingURL=fluidRunner.js.map

package/dist/fluidRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluidRunner.js","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,4BAA4B;AAC5B,6CAA+B;AAC/B,6CAA0C;AAE1C,yEAAsE;AACtE,sDAAsD;AACtD,sDAAwE;AACxE,mCAAkD;AAElD;;GAEG;AACH,SAAgB,WAAW,CAAC,kBAAwC;IAChE,oEAAoE;IACpE,KAAK;SACA,MAAM,EAAE;SACR,OAAO,CAAC,KAAK,CAAC;SACd,OAAO,CACJ,YAAY,EACZ,8CAA8C;IAC9C,wDAAwD;IACxD,CAAC,KAAK,EAAE,EAAE,CACN,KAAK;SACA,MAAM,CAAC,YAAY,EAAE;QAClB,QAAQ,EAAE,qIAAqI;QAC/I,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACtB,CAAC;SACD,MAAM,CAAC,WAAW,EAAE;QACjB,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,YAAY,EAAE;QAClB,QAAQ,EAAE,oFAAoF;QAC9F,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACrB,QAAQ,EAAE,2EAA2E;QACrF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QACf,QAAQ,EAAE,qDAAqD;QAC/D,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACtB,CAAC;SACD,MAAM,CAAC,iBAAiB,EAAE;QACvB,QAAQ,EAAE,uEAAuE;QACjF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,MAAM;KAClB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACrB,QAAQ,EAAE,kIAAkI;QAC5I,IAAI,EAAE,OAAO;QACb,YAAY,EAAE,KAAK;KACtB,CAAC;IACV,kEAAkE;IAClE,KAAK,EAAE,IAAI,EAAE,EAAE;QACX,MAAM,SAAS,GAAG,IAAA,+BAAuB,EAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QAC/E,IAAI,SAAS,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;QACD,MAAM,sBAAsB,GAAG,IAAA,8CAAgC,EAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1G,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE;YACjC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU;YACjC,CAAC,CAAC,IAAA,mDAAwB,EACtB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,EACZ,sBAAsB,CAAC,gBAAgB,CAC1C,CAAC,CAAC,CAAC,IAAA,uBAAU,EACV,kBAAmB,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,EACZ,sBAAsB,CAAC,gBAAgB,CAC1C,CAAC,CAAC;QAEP,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACjB,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,SAAS,KAAK,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;IACL,CAAC,CACJ;SACA,IAAI,EAAE;SACN,aAAa,EAAE,CAAC,IAAI,CAAC;AAC9B,CAAC;AArFD,kCAqFC;AAED,WAAW,EAAE,CAAC;AACd,2BAA2B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable max-len */\nimport * as yargs from \"yargs\";\nimport { exportFile } from \"./exportFile\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\nimport { parseBundleAndExportFile } from \"./parseBundleAndExportFile\";\n// eslint-disable-next-line import/no-internal-modules\nimport { validateAndParseTelemetryOptions } from \"./logger/loggerUtils\";\nimport { validateCommandLineArgs } from \"./utils\";\n\n/**\n * @param fluidFileConverter - needs to be provided if \"codeLoaderBundle\" is not and vice versa\n */\nexport function fluidRunner(fluidFileConverter?: IFluidFileConverter) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n    yargs\n        .strict()\n        .version(false)\n        .command(\n            \"exportFile\",\n            \"Generate an output for a local ODSP snapshot\",\n            // eslint-disable-next-line @typescript-eslint/no-shadow\n            (yargs) =>\n                yargs\n                    .option(\"codeLoader\", {\n                        describe: \"Path to code loader bundle. Required if this application is being called without modification.\\nSee \\\"README.md\\\" for more details.\",\n                        type: \"string\",\n                        demandOption: false,\n                    })\n                    .option(\"inputFile\", {\n                        describe: \"Path to local ODSP snapshot\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"outputFile\", {\n                        describe: \"Path of output file (cannot already exist).\\nExecution result will be written here\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"telemetryFile\", {\n                        describe: \"Path of telemetry file for config and session data (cannot already exist)\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"options\", {\n                        describe: \"Additional options passed to container on execution\",\n                        type: \"string\",\n                        demandOption: false,\n                    })\n                    .option(\"telemetryFormat\", {\n                        describe: \"Output format for telemetry. Current options are: [\\\"JSON\\\", \\\"CSV\\\"]\",\n                        type: \"string\",\n                        demandOption: false,\n                        default: \"JSON\",\n                    })\n                    .option(\"telemetryProp\", {\n                        describe: \"Property to add to every telemetry entry. Formatted like \\\"--telemetryProp prop1 value1 --telemetryProp prop2 \\\\\\\"value 2\\\\\\\"\\\".\",\n                        type: \"array\",\n                        demandOption: false,\n                    }),\n            // eslint-disable-next-line @typescript-eslint/no-misused-promises\n            async (argv) => {\n                const argsError = validateCommandLineArgs(argv.codeLoader, fluidFileConverter);\n                if (argsError) {\n                    console.error(argsError);\n                    process.exit(1);\n                }\n                const telemetryOptionsResult = validateAndParseTelemetryOptions(argv.telemetryFormat, argv.telemetryProp);\n                if (!telemetryOptionsResult.success) {\n                    console.error(telemetryOptionsResult.error);\n                    process.exit(1);\n                }\n\n                const result = await (argv.codeLoader\n                    ? parseBundleAndExportFile(\n                        argv.codeLoader,\n                        argv.inputFile,\n                        argv.outputFile,\n                        argv.telemetryFile,\n                        argv.options,\n                        telemetryOptionsResult.telemetryOptions,\n                    ) : exportFile(\n                        fluidFileConverter!,\n                        argv.inputFile,\n                        argv.outputFile,\n                        argv.telemetryFile,\n                        argv.options,\n                        telemetryOptionsResult.telemetryOptions,\n                    ));\n\n                if (!result.success) {\n                    console.error(`${result.eventName}: ${result.errorMessage}`);\n                    process.exit(1);\n                }\n            },\n        )\n        .help()\n        .demandCommand().argv;\n}\n\nfluidRunner();\n/* eslint-enable max-len */\n"]}

package/dist/getArgsValidationError.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export declare function getArgsValidationError(inputFile: string, outputFile: string): string | undefined;
+//# sourceMappingURL=getArgsValidationError.d.ts.map

package/dist/getArgsValidationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getArgsValidationError.d.ts","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,wBAAgB,sBAAsB,CAClC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACnB,MAAM,GAAG,SAAS,CAgBpB"}

package/dist/getArgsValidationError.js

@@ -0,0 +1,46 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getArgsValidationError = void 0;
+const fs = __importStar(require("fs"));
+function getArgsValidationError(inputFile, outputFile) {
+    // Validate input file
+    if (!inputFile) {
+        return "Input file name argument is missing.";
+    }
+    else if (!fs.existsSync(inputFile)) {
+        return "Input file does not exist.";
+    }
+    // Validate output file
+    if (!outputFile) {
+        return "Output file argument is missing.";
+    }
+    else if (fs.existsSync(outputFile)) {
+        return `Output file already exists [${outputFile}].`;
+    }
+    return undefined;
+}
+exports.getArgsValidationError = getArgsValidationError;
+//# sourceMappingURL=getArgsValidationError.js.map

package/dist/getArgsValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getArgsValidationError.js","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,SAAgB,sBAAsB,CAClC,SAAiB,EACjB,UAAkB;IAElB,sBAAsB;IACtB,IAAI,CAAC,SAAS,EAAE;QACZ,OAAO,sCAAsC,CAAC;KACjD;SAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAClC,OAAO,4BAA4B,CAAC;KACvC;IAED,uBAAuB;IACvB,IAAI,CAAC,UAAU,EAAE;QACb,OAAO,kCAAkC,CAAC;KAC7C;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;QAClC,OAAO,+BAA+B,UAAU,IAAI,CAAC;KACxD;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAnBD,wDAmBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\n\nexport function getArgsValidationError(\n    inputFile: string,\n    outputFile: string,\n): string | undefined {\n    // Validate input file\n    if (!inputFile) {\n        return \"Input file name argument is missing.\";\n    } else if (!fs.existsSync(inputFile)) {\n        return \"Input file does not exist.\";\n    }\n\n    // Validate output file\n    if (!outputFile) {\n        return \"Output file argument is missing.\";\n    } else if (fs.existsSync(outputFile)) {\n        return `Output file already exists [${outputFile}].`;\n    }\n\n    return undefined;\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { ICodeLoaderBundle, IFluidFileConverter } from "./codeLoaderBundle";
+export * from "./exportFile";
+export { fluidRunner } from "./fluidRunner";
+export { OutputFormat } from "./logger/fileLogger";
+export { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
+export * from "./parseBundleAndExportFile";
+export { getSnapshotFileContent } from "./utils";
+//# sourceMappingURL=index.d.ts.map