@fluidframework/fluid-runner 2.0.0-dev.1.3.0.96595

package/dist/parseBundleAndExportFile.js

@@ -0,0 +1,84 @@
+"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.parseBundleAndExportFile = void 0;
+const fs = __importStar(require("fs"));
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const codeLoaderBundle_1 = require("./codeLoaderBundle");
+const exportFile_1 = require("./exportFile");
+const getArgsValidationError_1 = require("./getArgsValidationError");
+const loggerUtils_1 = require("./logger/loggerUtils");
+/* eslint-enable import/no-internal-modules */
+const utils_1 = require("./utils");
+const clientArgsValidationError = "Client_ArgsValidationError";
+/**
+ * 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)
+ */
+async function parseBundleAndExportFile(codeLoader, 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: "ParseBundleAndExportFile" }, async () => {
+            // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+            const codeLoaderBundle = require(codeLoader);
+            if (!(0, codeLoaderBundle_1.isCodeLoaderBundle)(codeLoaderBundle)) {
+                const eventName = clientArgsValidationError;
+                const errorMessage = "Code loader bundle is not of type ICodeLoaderBundle";
+                logger.sendErrorEvent({ eventName, message: errorMessage });
+                return { success: false, eventName, errorMessage };
+            }
+            const fluidExport = await codeLoaderBundle.fluidExport;
+            if (!(0, codeLoaderBundle_1.isFluidFileConverter)(fluidExport)) {
+                const eventName = clientArgsValidationError;
+                const errorMessage = "Fluid export from CodeLoaderBundle is not of type IFluidFileConverter";
+                logger.sendErrorEvent({ eventName, message: errorMessage });
+                return { success: false, eventName, errorMessage };
+            }
+            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 (0, exportFile_1.createContainerAndExecute)((0, utils_1.getSnapshotFileContent)(inputFile), fluidExport, 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.parseBundleAndExportFile = parseBundleAndExportFile;
+//# sourceMappingURL=parseBundleAndExportFile.js.map

package/dist/parseBundleAndExportFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseBundleAndExportFile.js","sourceRoot":"","sources":["../src/parseBundleAndExportFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,qEAAmE;AACnE,yDAA8E;AAC9E,6CAA8E;AAC9E,qEAAkE;AAGlE,sDAAqF;AACrF,8CAA8C;AAC9C,mCAAiD;AAEjD,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAE/D;;;GAGG;AACI,KAAK,UAAU,wBAAwB,CAC1C,UAAkB,EAClB,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,0BAA0B,EAAE,EAAE,KAAK,IAAI,EAAE;YACvG,qGAAqG;YACrG,MAAM,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAA,qCAAkB,EAAC,gBAAgB,CAAC,EAAE;gBACvC,MAAM,SAAS,GAAG,yBAAyB,CAAC;gBAC5C,MAAM,YAAY,GAAG,qDAAqD,CAAC;gBAC3E,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;aACtD;YAED,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,WAAW,CAAC;YACvD,IAAI,CAAC,IAAA,uCAAoB,EAAC,WAAW,CAAC,EAAE;gBACpC,MAAM,SAAS,GAAG,yBAAyB,CAAC;gBAC5C,MAAM,YAAY,GAAG,uEAAuE,CAAC;gBAC7F,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;aACtD;YAED,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,IAAA,sCAAyB,EACxD,IAAA,8BAAsB,EAAC,SAAS,CAAC,EACjC,WAAW,EACX,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;AAzDD,4DAyDC","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 { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { isCodeLoaderBundle, isFluidFileConverter } from \"./codeLoaderBundle\";\nimport { createContainerAndExecute, IExportFileResponse } from \"./exportFile\";\nimport { getArgsValidationError } from \"./getArgsValidationError\";\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 */\nimport { getSnapshotFileContent } from \"./utils\";\n\nconst clientArgsValidationError = \"Client_ArgsValidationError\";\n\n/**\n * Parse a provided JS bundle, execute code on Container based on ODSP snapshot, and write result to file\n * @param codeLoader - path to provided JS bundle that implements ICodeLoaderBundle (see codeLoaderBundle.ts)\n */\nexport async function parseBundleAndExportFile(\n    codeLoader: string,\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: \"ParseBundleAndExportFile\" }, async () => {\n            // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires\n            const codeLoaderBundle = require(codeLoader);\n            if (!isCodeLoaderBundle(codeLoaderBundle)) {\n                const eventName = clientArgsValidationError;\n                const errorMessage = \"Code loader bundle is not of type ICodeLoaderBundle\";\n                logger.sendErrorEvent({ eventName, message: errorMessage });\n                return { success: false, eventName, errorMessage };\n            }\n\n            const fluidExport = await codeLoaderBundle.fluidExport;\n            if (!isFluidFileConverter(fluidExport)) {\n                const eventName = clientArgsValidationError;\n                const errorMessage = \"Fluid export from CodeLoaderBundle is not of type IFluidFileConverter\";\n                logger.sendErrorEvent({ eventName, message: errorMessage });\n                return { success: false, eventName, errorMessage };\n            }\n\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                fluidExport,\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"]}

package/dist/utils.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/// <reference types="node" />
+import { IFluidFileConverter } from "./codeLoaderBundle";
+/**
+ * Is the given snapshot in JSON format
+ * @param content - snapshot file content
+ * @internal
+ */
+export declare function isJsonSnapshot(content: Buffer): boolean;
+/**
+ * Get the ODSP snapshot file content
+ * Works on both JSON and binary snapshot formats
+ * @param filePath - path to the ODSP snapshot file
+ */
+export declare function getSnapshotFileContent(filePath: string): string | Buffer;
+/**
+ * Validate provided command line arguments
+ * @internal
+ */
+export declare function validateCommandLineArgs(codeLoader?: string, fluidFileConverter?: IFluidFileConverter): string | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEzD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAIxE;AAED;;;GAGG;AACF,wBAAgB,uBAAuB,CACpC,UAAU,CAAC,EAAE,MAAM,EACnB,kBAAkB,CAAC,EAAE,mBAAmB,GACzC,MAAM,GAAG,SAAS,CASpB"}

package/dist/utils.js

@@ -0,0 +1,63 @@
+"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.validateCommandLineArgs = exports.getSnapshotFileContent = exports.isJsonSnapshot = void 0;
+const fs = __importStar(require("fs"));
+/**
+ * Is the given snapshot in JSON format
+ * @param content - snapshot file content
+ * @internal
+ */
+function isJsonSnapshot(content) {
+    return content.toString(undefined, 0, 1) === "{";
+}
+exports.isJsonSnapshot = isJsonSnapshot;
+/**
+ * Get the ODSP snapshot file content
+ * Works on both JSON and binary snapshot formats
+ * @param filePath - path to the ODSP snapshot file
+ */
+function getSnapshotFileContent(filePath) {
+    // TODO: read file stream
+    const content = fs.readFileSync(filePath);
+    return isJsonSnapshot(content) ? content.toString() : content;
+}
+exports.getSnapshotFileContent = getSnapshotFileContent;
+/**
+ * Validate provided command line arguments
+ * @internal
+ */
+function validateCommandLineArgs(codeLoader, fluidFileConverter) {
+    if (codeLoader && fluidFileConverter !== undefined) {
+        return "\"codeLoader\" and \"fluidFileConverter\" cannot both be provided. See README for details.";
+    }
+    if (!codeLoader && fluidFileConverter === undefined) {
+        // eslint-disable-next-line max-len
+        return "\"codeLoader\" must be provided if there is no explicit \"fluidFileConverter\". See README for details.";
+    }
+    return undefined;
+}
+exports.validateCommandLineArgs = validateCommandLineArgs;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAGzB;;;;GAIG;AACH,SAAgB,cAAc,CAAC,OAAe;IAC1C,OAAO,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC;AACrD,CAAC;AAFD,wCAEC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,QAAgB;IACnD,yBAAyB;IACzB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAClE,CAAC;AAJD,wDAIC;AAED;;;GAGG;AACF,SAAgB,uBAAuB,CACpC,UAAmB,EACnB,kBAAwC;IAExC,IAAI,UAAU,IAAI,kBAAkB,KAAK,SAAS,EAAE;QAChD,OAAO,4FAA4F,CAAC;KACvG;IACD,IAAI,CAAC,UAAU,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACjD,mCAAmC;QACnC,OAAO,yGAAyG,CAAC;KACpH;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAZA,0DAYA","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 { IFluidFileConverter } from \"./codeLoaderBundle\";\n\n/**\n * Is the given snapshot in JSON format\n * @param content - snapshot file content\n * @internal\n */\nexport function isJsonSnapshot(content: Buffer): boolean {\n    return content.toString(undefined, 0, 1) === \"{\";\n}\n\n/**\n * Get the ODSP snapshot file content\n * Works on both JSON and binary snapshot formats\n * @param filePath - path to the ODSP snapshot file\n */\nexport function getSnapshotFileContent(filePath: string): string | Buffer {\n    // TODO: read file stream\n    const content = fs.readFileSync(filePath);\n    return isJsonSnapshot(content) ? content.toString() : content;\n}\n\n/**\n * Validate provided command line arguments\n * @internal\n */\n export function validateCommandLineArgs(\n    codeLoader?: string,\n    fluidFileConverter?: IFluidFileConverter,\n): string | undefined {\n    if (codeLoader && fluidFileConverter !== undefined) {\n        return \"\\\"codeLoader\\\" and \\\"fluidFileConverter\\\" cannot both be provided. See README for details.\";\n    }\n    if (!codeLoader && fluidFileConverter === undefined) {\n        // eslint-disable-next-line max-len\n        return \"\\\"codeLoader\\\" must be provided if there is no explicit \\\"fluidFileConverter\\\". See README for details.\";\n    }\n    return undefined;\n}\n"]}

package/lib/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/lib/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/lib/codeLoaderBundle.js

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Type cast to ensure necessary methods are present in the provided bundle
+ * @param bundle - bundle provided to this application
+ */
+export 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";
+}
+export 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";
+}
+//# sourceMappingURL=codeLoaderBundle.js.map

package/lib/codeLoaderBundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codeLoaderBundle.js","sourceRoot":"","sources":["../src/codeLoaderBundle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwCH;;;GAGG;AACH,MAAM,UAAU,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;AAED,MAAM,UAAU,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","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/lib/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/lib/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/lib/exportFile.js

@@ -0,0 +1,63 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import * as fs from "fs";
+import { LoaderHeader } from "@fluidframework/container-definitions";
+import { Loader } from "@fluidframework/container-loader";
+import { createLocalOdspDocumentServiceFactory } from "@fluidframework/odsp-driver";
+import { PerformanceEvent } from "@fluidframework/telemetry-utils";
+import { getArgsValidationError } from "./getArgsValidationError";
+import { FakeUrlResolver } from "./fakeUrlResolver";
+import { getSnapshotFileContent } from "./utils";
+import { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
+const clientArgsValidationError = "Client_ArgsValidationError";
+/**
+ * Execute code on Container based on ODSP snapshot and write result to file
+ */
+export async function exportFile(fluidFileConverter, inputFile, outputFile, telemetryFile, options, telemetryOptions) {
+    const telemetryArgError = getTelemetryFileValidationError(telemetryFile);
+    if (telemetryArgError) {
+        const eventName = clientArgsValidationError;
+        return { success: false, eventName, errorMessage: telemetryArgError };
+    }
+    const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);
+    try {
+        return await PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
+            const argsValidationError = getArgsValidationError(inputFile, outputFile);
+            if (argsValidationError) {
+                const eventName = clientArgsValidationError;
+                logger.sendErrorEvent({ eventName, message: argsValidationError });
+                return { success: false, eventName, errorMessage: argsValidationError };
+            }
+            fs.writeFileSync(outputFile, await createContainerAndExecute(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();
+    }
+}
+/**
+ * Create the container based on an ODSP snapshot and execute code on it
+ * @returns result of execution
+ */
+export async function createContainerAndExecute(localOdspSnapshot, fluidFileConverter, logger, options) {
+    const loader = new Loader({
+        urlResolver: new FakeUrlResolver(),
+        documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),
+        codeLoader: await fluidFileConverter.getCodeLoader(logger),
+        scope: fluidFileConverter.scope,
+        logger,
+    });
+    const container = await loader.resolve({ url: "/fakeUrl/", headers: {
+            [LoaderHeader.loadMode]: { opsBeforeReturn: "cached" }
+        } });
+    return PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => fluidFileConverter.execute(container, options));
+}
+//# sourceMappingURL=exportFile.js.map

package/lib/exportFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportFile.js","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,qCAAqC,EAAE,MAAM,6BAA6B,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAC;AAgBrF,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC5B,kBAAuC,EACvC,SAAiB,EACjB,UAAkB,EAClB,aAAqB,EACrB,OAAgB,EAChB,gBAAoC;IAEpC,MAAM,iBAAiB,GAAG,+BAA+B,CAAC,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,YAAY,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAE7E,IAAI;QACA,OAAO,MAAM,gBAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE;YACzF,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,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,sBAAsB,CAAC,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;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC3C,iBAAsC,EACtC,kBAAuC,EACvC,MAAwB,EACxB,OAAgB;IAEhB,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACtB,WAAW,EAAE,IAAI,eAAe,EAAE;QAClC,sBAAsB,EAAE,qCAAqC,CAAC,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,YAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE;SAAE,EAAE,CAAC,CAAC;IAEhE,OAAO,gBAAgB,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","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/lib/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/lib/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/lib/fakeUrlResolver.js

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const fakeId = "FakeUrlResolver";
+const fakeUrl = "/FakeUrlResolver/";
+/**
+ * Fake URL resolver that returns hard coded values on every request
+ * @internal
+ */
+export 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 "";
+    }
+}
+//# sourceMappingURL=fakeUrlResolver.js.map

package/lib/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,MAAM,OAAO,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","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/lib/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/lib/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/lib/fluidRunner.js

@@ -0,0 +1,83 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint-disable max-len */
+import * as yargs from "yargs";
+import { exportFile } from "./exportFile";
+import { parseBundleAndExportFile } from "./parseBundleAndExportFile";
+// eslint-disable-next-line import/no-internal-modules
+import { validateAndParseTelemetryOptions } from "./logger/loggerUtils";
+import { validateCommandLineArgs } from "./utils";
+/**
+ * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
+ */
+export 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 = validateCommandLineArgs(argv.codeLoader, fluidFileConverter);
+        if (argsError) {
+            console.error(argsError);
+            process.exit(1);
+        }
+        const telemetryOptionsResult = validateAndParseTelemetryOptions(argv.telemetryFormat, argv.telemetryProp);
+        if (!telemetryOptionsResult.success) {
+            console.error(telemetryOptionsResult.error);
+            process.exit(1);
+        }
+        const result = await (argv.codeLoader
+            ? parseBundleAndExportFile(argv.codeLoader, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options, telemetryOptionsResult.telemetryOptions) : 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;
+}
+fluidRunner();
+/* eslint-enable max-len */
+//# sourceMappingURL=fluidRunner.js.map

package/lib/fluidRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluidRunner.js","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,4BAA4B;AAC5B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,sDAAsD;AACtD,OAAO,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD;;GAEG;AACH,MAAM,UAAU,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,uBAAuB,CAAC,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,gCAAgC,CAAC,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,wBAAwB,CACtB,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,UAAU,CACV,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;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/lib/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/lib/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/lib/getArgsValidationError.js

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import * as fs from "fs";
+export 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;
+}
+//# sourceMappingURL=getArgsValidationError.js.map

package/lib/getArgsValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getArgsValidationError.js","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB,MAAM,UAAU,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","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/lib/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