@fluidframework/fluid-runner 2.0.0-dev-rc.1.0.0.224419

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,EACN,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAM5C;;;GAGG;AACH,qBAAa,eAAgB,YAAW,YAAY;IACtC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAyB9D,cAAc,CAC1B,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,qBAAqB,GACxC,OAAO,CAAC,MAAM,CAAC;CAGlB"}

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;;;AAUH,MAAM,MAAM,GAAG,iBAAiB,CAAC;AACjC,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAEpC;;;GAGG;AACH,MAAa,eAAe;IACpB,KAAK,CAAC,OAAO,CAAC,QAAkB;QACtC,MAAM,mBAAmB,GAAqB;YAC7C,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;gBACV,kBAAkB,EAAE,OAAO;gBAC3B,wBAAwB,EAAE,OAAO;gBACjC,uBAAuB,EAAE,OAAO;gBAChC,eAAe,EAAE,OAAO;aACxB;YACD,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,MAAM;YAChB,UAAU,EAAE,KAAK;YACjB,WAAW,EAAE,MAAM;SACnB,CAAC;QAEF,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,cAAc,CAC1B,YAA0B,EAC1B,YAAoB,EACpB,kBAA0C;QAE1C,OAAO,EAAE,CAAC;IACX,CAAC;CACD;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 {\n\tIContainerPackageInfo,\n\tIResolvedUrl,\n\tIUrlResolver,\n} 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\tpublic async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {\n\t\tconst fakeOdspResolvedUrl: IOdspResolvedUrl = {\n\t\t\ttype: \"fluid\",\n\t\t\todspResolvedUrl: true,\n\t\t\tid: fakeId,\n\t\t\tsiteUrl: fakeUrl,\n\t\t\tdriveId: fakeId,\n\t\t\titemId: fakeId,\n\t\t\turl: fakeUrl,\n\t\t\thashedDocumentId: fakeId,\n\t\t\tendpoints: {\n\t\t\t\tsnapshotStorageUrl: fakeUrl,\n\t\t\t\tattachmentPOSTStorageUrl: fakeUrl,\n\t\t\t\tattachmentGETStorageUrl: fakeUrl,\n\t\t\t\tdeltaStorageUrl: fakeUrl,\n\t\t\t},\n\t\t\ttokens: {},\n\t\t\tfileName: fakeId,\n\t\t\tsummarizer: false,\n\t\t\tfileVersion: fakeId,\n\t\t};\n\n\t\treturn fakeOdspResolvedUrl;\n\t}\n\n\tpublic async getAbsoluteUrl(\n\t\t_resolvedUrl: IResolvedUrl,\n\t\t_relativeUrl: string,\n\t\t_packageInfoSource?: IContainerPackageInfo,\n\t): Promise<string> {\n\t\treturn \"\";\n\t}\n}\n"]}

package/dist/fluid-runner-alpha.d.ts

@@ -0,0 +1,79 @@
+/// <reference types="node" />
+
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
+import { IContainer } from '@fluidframework/container-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+
+/* Excluded from this release type: createContainerAndExecute */
+
+/* Excluded from this release type: createLogger */
+
+/* Excluded from this release type: exportFile */
+
+/* Excluded from this release type: fluidRunner */
+
+/* Excluded from this release type: getSnapshotFileContent */
+
+/* Excluded from this release type: getTelemetryFileValidationError */
+
+/* Excluded from this release type: ICodeLoaderBundle */
+
+/**
+ * @alpha
+ */
+export declare type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;
+
+declare interface IExportFileResponseFailure {
+    success: false;
+    eventName: string;
+    errorMessage: string;
+    error?: any;
+}
+
+declare interface IExportFileResponseSuccess {
+    success: true;
+}
+
+/* Excluded from this release type: IFileLogger */
+
+/**
+ * Instance that holds all the details for Fluid file conversion
+ * @alpha
+ */
+export declare 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>;
+    /**
+     * Get scope object to provide at Loader creation
+     * @param logger - created logger object to pass to scope object
+     */
+    getScope?(logger: ITelemetryBaseLogger): Promise<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>;
+}
+
+/* Excluded from this release type: ITelemetryOptions */
+
+/**
+ * Desired output format for the telemetry
+ * @alpha
+ */
+export declare enum OutputFormat {
+    JSON = 0,
+    CSV = 1
+}
+
+/* Excluded from this release type: parseBundleAndExportFile */
+
+/* Excluded from this release type: validateAndParseTelemetryOptions */
+
+export { }

package/dist/fluid-runner-beta.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
+import { IContainer } from '@fluidframework/container-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+
+/* Excluded from this release type: createContainerAndExecute */
+
+/* Excluded from this release type: createLogger */
+
+/* Excluded from this release type: exportFile */
+
+/* Excluded from this release type: fluidRunner */
+
+/* Excluded from this release type: getSnapshotFileContent */
+
+/* Excluded from this release type: getTelemetryFileValidationError */
+
+/* Excluded from this release type: ICodeDetailsLoader */
+
+/* Excluded from this release type: ICodeLoaderBundle */
+
+/* Excluded from this release type: IContainer */
+
+/* Excluded from this release type: IExportFileResponse */
+
+declare interface IExportFileResponseFailure {
+    success: false;
+    eventName: string;
+    errorMessage: string;
+    error?: any;
+}
+
+declare interface IExportFileResponseSuccess {
+    success: true;
+}
+
+/* Excluded from this release type: IFileLogger */
+
+/* Excluded from this release type: IFluidFileConverter */
+
+/* Excluded from this release type: ITelemetryOptions */
+
+/* Excluded from this release type: OutputFormat */
+
+/* Excluded from this release type: parseBundleAndExportFile */
+
+/* Excluded from this release type: validateAndParseTelemetryOptions */
+
+export { }

package/dist/fluid-runner-public.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
+import { IContainer } from '@fluidframework/container-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+
+/* Excluded from this release type: createContainerAndExecute */
+
+/* Excluded from this release type: createLogger */
+
+/* Excluded from this release type: exportFile */
+
+/* Excluded from this release type: fluidRunner */
+
+/* Excluded from this release type: getSnapshotFileContent */
+
+/* Excluded from this release type: getTelemetryFileValidationError */
+
+/* Excluded from this release type: ICodeDetailsLoader */
+
+/* Excluded from this release type: ICodeLoaderBundle */
+
+/* Excluded from this release type: IContainer */
+
+/* Excluded from this release type: IExportFileResponse */
+
+declare interface IExportFileResponseFailure {
+    success: false;
+    eventName: string;
+    errorMessage: string;
+    error?: any;
+}
+
+declare interface IExportFileResponseSuccess {
+    success: true;
+}
+
+/* Excluded from this release type: IFileLogger */
+
+/* Excluded from this release type: IFluidFileConverter */
+
+/* Excluded from this release type: ITelemetryOptions */
+
+/* Excluded from this release type: OutputFormat */
+
+/* Excluded from this release type: parseBundleAndExportFile */
+
+/* Excluded from this release type: validateAndParseTelemetryOptions */
+
+export { }

package/dist/fluid-runner-untrimmed.d.ts

@@ -0,0 +1,175 @@
+/// <reference types="node" />
+
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
+import { IContainer } from '@fluidframework/container-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+
+/**
+ * Create the container based on an ODSP snapshot and execute code on it
+ * @returns result of execution
+ * @internal
+ */
+export declare function createContainerAndExecute(localOdspSnapshot: string | Uint8Array, fluidFileConverter: IFluidFileConverter, logger: ITelemetryLoggerExt, options?: string, timeout?: number, disableNetworkFetch?: boolean): Promise<string>;
+
+/**
+ * Create an {@link @fluidframework/telemetry-utils#ITelemetryLoggerExt} wrapped around provided {@link IFileLogger}.
+ *
+ * @remarks
+ *
+ * It is expected that all events be sent through the returned "logger" value.
+ *
+ * The "fileLogger" value should have its "close()" method called at the end of execution.
+ *
+ * Note: if an output format is not supplied, default is JSON.
+ *
+ * @returns Both the `IFileLogger` implementation and `ITelemetryLoggerExt` wrapper to be called.
+ * @internal
+ */
+export declare function createLogger(filePath: string, options?: ITelemetryOptions): {
+    logger: ITelemetryLoggerExt;
+    fileLogger: IFileLogger;
+};
+
+/**
+ * Execute code on Container based on ODSP snapshot and write result to file
+ * @internal
+ */
+export declare function exportFile(fluidFileConverter: IFluidFileConverter, inputFile: string, outputFile: string, telemetryFile: string, options?: string, telemetryOptions?: ITelemetryOptions, timeout?: number, disableNetworkFetch?: boolean): Promise<IExportFileResponse>;
+
+/**
+ * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
+ * @internal
+ */
+export declare function fluidRunner(fluidFileConverter?: IFluidFileConverter): void;
+
+/**
+ * Get the ODSP snapshot file content
+ * Works on both JSON and binary snapshot formats
+ * @param filePath - path to the ODSP snapshot file
+ * @internal
+ */
+export declare function getSnapshotFileContent(filePath: string): string | Buffer;
+
+/**
+ * Validate the telemetryFile command line argument
+ * @param telemetryFile - path where telemetry will be written
+ * @internal
+ */
+export declare function getTelemetryFileValidationError(telemetryFile: string): string | undefined;
+
+/**
+ * Contract that defines the necessary exports for the bundle provided at runtime
+ * For an example, see "src/test/sampleCodeLoaders/sampleCodeLoader.ts"
+ * @internal
+ */
+export declare interface ICodeLoaderBundle {
+    /**
+     * Fluid export of all the required objects and functions
+     */
+    fluidExport: Promise<IFluidFileConverter>;
+}
+
+/**
+ * @alpha
+ */
+export declare type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;
+
+declare interface IExportFileResponseFailure {
+    success: false;
+    eventName: string;
+    errorMessage: string;
+    error?: any;
+}
+
+declare interface IExportFileResponseSuccess {
+    success: true;
+}
+
+/**
+ * Contract for logger that writes telemetry to a file
+ * @internal
+ */
+declare interface IFileLogger extends ITelemetryBaseLogger {
+    /**
+     * This method acts as a "dispose" and should be explicitly called at the end of execution
+     */
+    close(): Promise<void>;
+}
+
+/**
+ * Instance that holds all the details for Fluid file conversion
+ * @alpha
+ */
+export declare 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>;
+    /**
+     * Get scope object to provide at Loader creation
+     * @param logger - created logger object to pass to scope object
+     */
+    getScope?(logger: ITelemetryBaseLogger): Promise<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>;
+}
+
+/**
+ * Options to provide upon creation of IFileLogger
+ * @internal
+ */
+export declare interface ITelemetryOptions {
+    /** Desired output format used to create a specific IFileLogger implementation */
+    outputFormat?: OutputFormat;
+    /**
+     * Properties that should be added to every telemetry event
+     *
+     * @example
+     *
+     * ```JSON
+     * { "prop1": "value1", "prop2": 10.0 }
+     * ```
+     */
+    defaultProps?: Record<string, string | number>;
+    /** Number of telemetry events per flush to telemetry file */
+    eventsPerFlush?: number;
+}
+
+/**
+ * Desired output format for the telemetry
+ * @alpha
+ */
+export declare enum OutputFormat {
+    JSON = 0,
+    CSV = 1
+}
+
+/**
+ * Parse a provided JS bundle, execute code on Container based on ODSP snapshot, and write result to file
+ * @param codeLoader - path to provided JS bundle that implements ICodeLoaderBundle (see codeLoaderBundle.ts)
+ * @internal
+ */
+export declare function parseBundleAndExportFile(codeLoader: string, inputFile: string, outputFile: string, telemetryFile: string, options?: string, telemetryOptions?: ITelemetryOptions, timeout?: number, disableNetworkFetch?: boolean): Promise<IExportFileResponse>;
+
+/**
+ * Validate the provided output format and default properties
+ * @param format - desired output format of the telemetry
+ * @param props - default properties to be added to every telemetry entry
+ * @internal
+ */
+export declare function validateAndParseTelemetryOptions(format?: string, props?: (string | number)[], eventsPerFlush?: number): {
+    success: false;
+    error: string;
+} | {
+    success: true;
+    telemetryOptions: ITelemetryOptions;
+};
+
+export { }

package/dist/fluidRunner.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * 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
+ * @internal
+ */
+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;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAMzD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,QAqHnE"}

package/dist/fluidRunner.js

@@ -0,0 +1,126 @@
+"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;
+    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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fluidRunner = void 0;
+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
+ * @internal
+ */
+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,
+    })
+        .option("eventsPerFlush", {
+        describe: "Number of telemetry events per flush to telemetryFile (only applicable for JSON format)",
+        type: "number",
+        demandOption: false,
+    })
+        .option("timeout", {
+        describe: "Allowed timeout in ms before process is automatically cancelled",
+        type: "number",
+        demandOption: false,
+    })
+        .option("disableNetworkFetch", {
+        describe: "Should network fetch calls be explicitly disabled?",
+        type: "boolean",
+        demandOption: false,
+        default: 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, argv.eventsPerFlush);
+        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, argv.timeout, argv.disableNetworkFetch)
+            : (0, exportFile_1.exportFile)(fluidFileConverter, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options, telemetryOptionsResult.telemetryOptions, argv.timeout, argv.disableNetworkFetch));
+        if (!result.success) {
+            console.error(`${result.eventName}: ${result.errorMessage}`);
+            process.exit(1);
+        }
+        process.exit(0);
+    })
+        .help()
+        .demandCommand().argv;
+}
+exports.fluidRunner = fluidRunner;
+//# 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,6CAA+B;AAC/B,6CAA0C;AAE1C,yEAAsE;AACtE,sDAAsD;AACtD,sDAAwE;AACxE,mCAAkD;AAElD;;;GAGG;AACH,SAAgB,WAAW,CAAC,kBAAwC;IACnE,oEAAoE;IACpE,KAAK;SACH,MAAM,EAAE;SACR,OAAO,CAAC,KAAK,CAAC;SACd,OAAO,CACP,YAAY,EACZ,8CAA8C;IAC9C,wDAAwD;IACxD,CAAC,KAAK,EAAE,EAAE,CACT,KAAK;SACH,MAAM,CAAC,YAAY,EAAE;QACrB,QAAQ,EACP,mIAAmI;QACpI,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACnB,CAAC;SACD,MAAM,CAAC,WAAW,EAAE;QACpB,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KAClB,CAAC;SACD,MAAM,CAAC,YAAY,EAAE;QACrB,QAAQ,EACP,oFAAoF;QACrF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KAClB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACxB,QAAQ,EACP,2EAA2E;QAC5E,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KAClB,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QAClB,QAAQ,EAAE,qDAAqD;QAC/D,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACnB,CAAC;SACD,MAAM,CAAC,iBAAiB,EAAE;QAC1B,QAAQ,EACP,mEAAmE;QACpE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,MAAM;KACf,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACxB,QAAQ,EACP,8HAA8H;QAC/H,IAAI,EAAE,OAAO;QACb,YAAY,EAAE,KAAK;KACnB,CAAC;SACD,MAAM,CAAC,gBAAgB,EAAE;QACzB,QAAQ,EACP,yFAAyF;QAC1F,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACnB,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QAClB,QAAQ,EAAE,iEAAiE;QAC3E,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACnB,CAAC;SACD,MAAM,CAAC,qBAAqB,EAAE;QAC9B,QAAQ,EAAE,oDAAoD;QAC9D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACd,CAAC;IACJ,kEAAkE;IAClE,KAAK,EAAE,IAAI,EAAE,EAAE;QACd,MAAM,SAAS,GAAG,IAAA,+BAAuB,EAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QAC/E,IAAI,SAAS,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAChB;QACD,MAAM,sBAAsB,GAAG,IAAA,8CAAgC,EAC9D,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,CACnB,CAAC;QACF,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE;YACpC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAChB;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU;YACpC,CAAC,CAAC,IAAA,mDAAwB,EACxB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,EACZ,sBAAsB,CAAC,gBAAgB,EACvC,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,mBAAmB,CACvB;YACH,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,EACvC,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,mBAAmB,CACvB,CAAC,CAAC;QAEN,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACpB,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,SAAS,KAAK,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAChB;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC,CACD;SACA,IAAI,EAAE;SACN,aAAa,EAAE,CAAC,IAAI,CAAC;AACxB,CAAC;AArHD,kCAqHC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\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 * @internal\n */\nexport function fluidRunner(fluidFileConverter?: IFluidFileConverter) {\n\t// eslint-disable-next-line @typescript-eslint/no-unused-expressions\n\tyargs\n\t\t.strict()\n\t\t.version(false)\n\t\t.command(\n\t\t\t\"exportFile\",\n\t\t\t\"Generate an output for a local ODSP snapshot\",\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-shadow\n\t\t\t(yargs) =>\n\t\t\t\tyargs\n\t\t\t\t\t.option(\"codeLoader\", {\n\t\t\t\t\t\tdescribe:\n\t\t\t\t\t\t\t'Path to code loader bundle. Required if this application is being called without modification.\\nSee \"README.md\" for more details.',\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"inputFile\", {\n\t\t\t\t\t\tdescribe: \"Path to local ODSP snapshot\",\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdemandOption: true,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"outputFile\", {\n\t\t\t\t\t\tdescribe:\n\t\t\t\t\t\t\t\"Path of output file (cannot already exist).\\nExecution result will be written here\",\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdemandOption: true,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"telemetryFile\", {\n\t\t\t\t\t\tdescribe:\n\t\t\t\t\t\t\t\"Path of telemetry file for config and session data (cannot already exist)\",\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdemandOption: true,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"options\", {\n\t\t\t\t\t\tdescribe: \"Additional options passed to container on execution\",\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"telemetryFormat\", {\n\t\t\t\t\t\tdescribe:\n\t\t\t\t\t\t\t'Output format for telemetry. Current options are: [\"JSON\", \"CSV\"]',\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t\tdefault: \"JSON\",\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"telemetryProp\", {\n\t\t\t\t\t\tdescribe:\n\t\t\t\t\t\t\t'Property to add to every telemetry entry. Formatted like \"--telemetryProp prop1 value1 --telemetryProp prop2 \\\\\"value 2\\\\\"\".',\n\t\t\t\t\t\ttype: \"array\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"eventsPerFlush\", {\n\t\t\t\t\t\tdescribe:\n\t\t\t\t\t\t\t\"Number of telemetry events per flush to telemetryFile (only applicable for JSON format)\",\n\t\t\t\t\t\ttype: \"number\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"timeout\", {\n\t\t\t\t\t\tdescribe: \"Allowed timeout in ms before process is automatically cancelled\",\n\t\t\t\t\t\ttype: \"number\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t})\n\t\t\t\t\t.option(\"disableNetworkFetch\", {\n\t\t\t\t\t\tdescribe: \"Should network fetch calls be explicitly disabled?\",\n\t\t\t\t\t\ttype: \"boolean\",\n\t\t\t\t\t\tdemandOption: false,\n\t\t\t\t\t\tdefault: false,\n\t\t\t\t\t}),\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-misused-promises\n\t\t\tasync (argv) => {\n\t\t\t\tconst argsError = validateCommandLineArgs(argv.codeLoader, fluidFileConverter);\n\t\t\t\tif (argsError) {\n\t\t\t\t\tconsole.error(argsError);\n\t\t\t\t\tprocess.exit(1);\n\t\t\t\t}\n\t\t\t\tconst telemetryOptionsResult = validateAndParseTelemetryOptions(\n\t\t\t\t\targv.telemetryFormat,\n\t\t\t\t\targv.telemetryProp,\n\t\t\t\t\targv.eventsPerFlush,\n\t\t\t\t);\n\t\t\t\tif (!telemetryOptionsResult.success) {\n\t\t\t\t\tconsole.error(telemetryOptionsResult.error);\n\t\t\t\t\tprocess.exit(1);\n\t\t\t\t}\n\n\t\t\t\tconst result = await (argv.codeLoader\n\t\t\t\t\t? parseBundleAndExportFile(\n\t\t\t\t\t\t\targv.codeLoader,\n\t\t\t\t\t\t\targv.inputFile,\n\t\t\t\t\t\t\targv.outputFile,\n\t\t\t\t\t\t\targv.telemetryFile,\n\t\t\t\t\t\t\targv.options,\n\t\t\t\t\t\t\ttelemetryOptionsResult.telemetryOptions,\n\t\t\t\t\t\t\targv.timeout,\n\t\t\t\t\t\t\targv.disableNetworkFetch,\n\t\t\t\t\t  )\n\t\t\t\t\t: exportFile(\n\t\t\t\t\t\t\tfluidFileConverter!,\n\t\t\t\t\t\t\targv.inputFile,\n\t\t\t\t\t\t\targv.outputFile,\n\t\t\t\t\t\t\targv.telemetryFile,\n\t\t\t\t\t\t\targv.options,\n\t\t\t\t\t\t\ttelemetryOptionsResult.telemetryOptions,\n\t\t\t\t\t\t\targv.timeout,\n\t\t\t\t\t\t\targv.disableNetworkFetch,\n\t\t\t\t\t  ));\n\n\t\t\t\tif (!result.success) {\n\t\t\t\t\tconsole.error(`${result.eventName}: ${result.errorMessage}`);\n\t\t\t\t\tprocess.exit(1);\n\t\t\t\t}\n\t\t\t\tprocess.exit(0);\n\t\t\t},\n\t\t)\n\t\t.help()\n\t\t.demandCommand().argv;\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 { createContainerAndExecute, exportFile, IExportFileResponse } from "./exportFile";
+export { fluidRunner } from "./fluidRunner";
+export { OutputFormat, ITelemetryOptions } from "./logger/fileLogger";
+export { createLogger, getTelemetryFileValidationError, validateAndParseTelemetryOptions, } from "./logger/loggerUtils";
+export { parseBundleAndExportFile } from "./parseBundleAndExportFile";
+export { getSnapshotFileContent } from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC1F,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EACN,YAAY,EACZ,+BAA+B,EAC/B,gCAAgC,GAChC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSnapshotFileContent = exports.parseBundleAndExportFile = exports.validateAndParseTelemetryOptions = exports.getTelemetryFileValidationError = exports.createLogger = exports.OutputFormat = exports.fluidRunner = exports.exportFile = exports.createContainerAndExecute = void 0;
+var exportFile_1 = require("./exportFile");
+Object.defineProperty(exports, "createContainerAndExecute", { enumerable: true, get: function () { return exportFile_1.createContainerAndExecute; } });
+Object.defineProperty(exports, "exportFile", { enumerable: true, get: function () { return exportFile_1.exportFile; } });
+var fluidRunner_1 = require("./fluidRunner");
+Object.defineProperty(exports, "fluidRunner", { enumerable: true, get: function () { return fluidRunner_1.fluidRunner; } });
+var fileLogger_1 = require("./logger/fileLogger");
+Object.defineProperty(exports, "OutputFormat", { enumerable: true, get: function () { return fileLogger_1.OutputFormat; } });
+var loggerUtils_1 = require("./logger/loggerUtils");
+Object.defineProperty(exports, "createLogger", { enumerable: true, get: function () { return loggerUtils_1.createLogger; } });
+Object.defineProperty(exports, "getTelemetryFileValidationError", { enumerable: true, get: function () { return loggerUtils_1.getTelemetryFileValidationError; } });
+Object.defineProperty(exports, "validateAndParseTelemetryOptions", { enumerable: true, get: function () { return loggerUtils_1.validateAndParseTelemetryOptions; } });
+var parseBundleAndExportFile_1 = require("./parseBundleAndExportFile");
+Object.defineProperty(exports, "parseBundleAndExportFile", { enumerable: true, get: function () { return parseBundleAndExportFile_1.parseBundleAndExportFile; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getSnapshotFileContent", { enumerable: true, get: function () { return utils_1.getSnapshotFileContent; } });
+/* eslint-enable import/no-internal-modules */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,2CAA0F;AAAjF,uHAAA,yBAAyB,OAAA;AAAE,wGAAA,UAAU,OAAA;AAC9C,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,kDAAsE;AAA7D,0GAAA,YAAY,OAAA;AACrB,oDAI8B;AAH7B,2GAAA,YAAY,OAAA;AACZ,8HAAA,+BAA+B,OAAA;AAC/B,+HAAA,gCAAgC,OAAA;AAEjC,uEAAsE;AAA7D,oIAAA,wBAAwB,OAAA;AACjC,iCAAiD;AAAxC,+GAAA,sBAAsB,OAAA;AAC/B,8CAA8C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable import/no-internal-modules */\nexport { ICodeLoaderBundle, IFluidFileConverter } from \"./codeLoaderBundle\";\nexport { createContainerAndExecute, exportFile, IExportFileResponse } from \"./exportFile\";\nexport { fluidRunner } from \"./fluidRunner\";\nexport { OutputFormat, ITelemetryOptions } from \"./logger/fileLogger\";\nexport {\n\tcreateLogger,\n\tgetTelemetryFileValidationError,\n\tvalidateAndParseTelemetryOptions,\n} from \"./logger/loggerUtils\";\nexport { parseBundleAndExportFile } from \"./parseBundleAndExportFile\";\nexport { getSnapshotFileContent } from \"./utils\";\n/* eslint-enable import/no-internal-modules */\n"]}