@fluidframework/fluid-runner 2.0.0-dev-rc.3.0.0.254274 → 2.0.0-dev-rc.3.0.0.254674

package/dist/alpha.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// alpha APIs
+	IExportFileResponse, 
+	IExportFileResponseFailure, 
+	IExportFileResponseSuccess, 
+	IFluidFileConverter, 
+	OutputFormat
+} from "./index.js";

package/dist/beta.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/dist/public.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/alpha.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// alpha APIs
+	IExportFileResponse, 
+	IExportFileResponseFailure, 
+	IExportFileResponseSuccess, 
+	IFluidFileConverter, 
+	OutputFormat
+} from "./index.js";

package/lib/beta.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/public.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-runner",
-  "version": "2.0.0-dev-rc.3.0.0.254274",
+  "version": "2.0.0-dev-rc.3.0.0.254674",
   "description": "Utility for running various functionality inside a Fluid Framework environment",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -24,21 +24,21 @@
     },
     "./public": {
       "import": {
-        "types": "./lib/fluid-runner-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/fluid-runner-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
     "./alpha": {
       "import": {
-        "types": "./lib/fluid-runner-alpha.d.ts",
+        "types": "./lib/alpha.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/fluid-runner-alpha.d.ts",
+        "types": "./dist/alpha.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -79,24 +79,24 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/container-loader": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/odsp-driver": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/odsp-driver-definitions": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.3.0.0.254274",
+    "@fluidframework/aqueduct": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/container-loader": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/odsp-driver": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/odsp-driver-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.3.0.0.254674",
     "json2csv": "^5.0.7",
     "yargs": "17.7.2"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254274",
-    "@fluid-tools/build-cli": "^0.34.0",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluid-tools/build-cli": "^0.35.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/build-tools": "^0.35.0",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
     "@fluidframework/fluid-runner-previous": "npm:@fluidframework/fluid-runner@2.0.0-internal.8.0.0",
     "@microsoft/api-extractor": "^7.42.3",
@@ -115,29 +115,17 @@
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
-  "fluidBuild": {
-    "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      }
-    }
-  },
   "typeValidation": {
     "broken": {}
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
-    "api-extractor:esnext": "api-extractor run --local",
+    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "fluid-build . --task api",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}

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

@@ -1,85 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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;
-
-/**
- * @alpha
- */
-export declare interface IExportFileResponseFailure {
-    success: false;
-    eventName: string;
-    errorMessage: string;
-    error?: any;
-}
-
-/**
- * @alpha
- */
-export 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

@@ -1,45 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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 */
-
-/* Excluded from this release type: IExportFileResponseFailure */
-
-/* Excluded from this release type: IExportFileResponseSuccess */
-
-/* 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

@@ -1,45 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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 */
-
-/* Excluded from this release type: IExportFileResponseFailure */
-
-/* Excluded from this release type: IExportFileResponseSuccess */
-
-/* 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

@@ -1,181 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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): Promise<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;
-
-/**
- * @alpha
- */
-export declare interface IExportFileResponseFailure {
-    success: false;
-    eventName: string;
-    errorMessage: string;
-    error?: any;
-}
-
-/**
- * @alpha
- */
-export declare interface IExportFileResponseSuccess {
-    success: true;
-}
-
-/**
- * Contract for logger that writes telemetry to a file
- * @internal
- */
-export 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/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
-    }
-  ]
-}

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

@@ -1,85 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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;
-
-/**
- * @alpha
- */
-export declare interface IExportFileResponseFailure {
-    success: false;
-    eventName: string;
-    errorMessage: string;
-    error?: any;
-}
-
-/**
- * @alpha
- */
-export 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/lib/fluid-runner-beta.d.ts

@@ -1,45 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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 */
-
-/* Excluded from this release type: IExportFileResponseFailure */
-
-/* Excluded from this release type: IExportFileResponseSuccess */
-
-/* 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/lib/fluid-runner-public.d.ts

@@ -1,45 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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 */
-
-/* Excluded from this release type: IExportFileResponseFailure */
-
-/* Excluded from this release type: IExportFileResponseSuccess */
-
-/* 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/lib/fluid-runner-untrimmed.d.ts

@@ -1,181 +0,0 @@
-/// <reference types="node" />
-
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-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): Promise<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;
-
-/**
- * @alpha
- */
-export declare interface IExportFileResponseFailure {
-    success: false;
-    eventName: string;
-    errorMessage: string;
-    error?: any;
-}
-
-/**
- * @alpha
- */
-export declare interface IExportFileResponseSuccess {
-    success: true;
-}
-
-/**
- * Contract for logger that writes telemetry to a file
- * @internal
- */
-export 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 { }