@fluidframework/driver-definitions 0.47.1000-69949 → 1.0.0

package/api-extractor.json

@@ -1,12 +1,4 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json",
-  "apiReport": {
-    "enabled": true,
-    "reportFolder": "<projectFolder>/api-report/"
-  },
-  "docModel": {
-    "enabled": true,
-    "apiJsonFilePath": "<projectFolder>/_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
-  }
+  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
 }

package/dist/driverError.d.ts

@@ -39,10 +39,10 @@ export declare enum DriverErrorType {
      */
     writeError = "writeError",
     /**
-     * Generic fetch failure.
-     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to
-     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.
-     * This can also indicate no response from server.
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
      */
     fetchFailure = "fetchFailure",
     /**

package/dist/driverError.js

@@ -46,10 +46,10 @@ var DriverErrorType;
      */
     DriverErrorType["writeError"] = "writeError";
     /**
-     * Generic fetch failure.
-     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to
-     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.
-     * This can also indicate no response from server.
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
      */
     DriverErrorType["fetchFailure"] = "fetchFailure";
     /**

package/dist/driverError.js.map

@@ -1 +1 @@
-{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;GAGG;AACH,IAAY,eAoEX;AApED,WAAY,eAAe;IACvB;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACF,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;AACtE,CAAC,EApEW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAoE1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Driver Error types\n * Lists types that are likely to be used by all drivers\n */\nexport enum DriverErrorType {\n    /**\n     * A fatal error with no specific interpretation covered by other DriverErrorType values\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Some non-categorized (below) networking error\n     * Include errors like  fatal server error (usually 500).\n     */\n    genericNetworkError = \"genericNetworkError\",\n\n    /**\n     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n     */\n    authorizationError = \"authorizationError\",\n\n    /**\n     * File not found, or file deleted during session\n     */\n    fileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * We can not reach server due to computer being offline.\n     */\n    offlineError = \"offlineError\",\n\n    /*\n     * Unsupported client protocol\n     */\n    unsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n    /**\n     * User does not have write permissions to a file, but is changing content of a file.\n     * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n     */\n    writeError = \"writeError\",\n\n    /**\n     * Generic fetch failure.\n     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to\n     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.\n     * This can also indicate no response from server.\n     */\n    fetchFailure = \"fetchFailure\",\n\n    /**\n     * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n     */\n    incorrectServerResponse = \"incorrectServerResponse\",\n\n    /**\n     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n     * and storage / driver / loader detects such mismatch.\n     * When it's hit, client needs to forget all the knowlege about this file and start over.\n     */\n     fileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n     /**\n      * The document is read-only and delta stream connection is forbidden.\n      */\n     deltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n}\n\n/**\n * Base interface for all errors and warnings\n */\nexport interface IDriverErrorBase {\n    /** Classification of what type of error this is, used programmatically by consumers to interpret the error */\n    readonly errorType: DriverErrorType;\n    /** Free-form error message */\n    readonly message: string;\n    /** True indicates the caller may retry the failed action. False indicates it's a fatal error */\n    canRetry: boolean;\n    /**\n     * Best guess as to network conditions (online/offline) when the error arose.\n     * See OnlineStatus enum in driver-utils package for expected values.\n     */\n    online?: string;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.genericNetworkError;\n    readonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.authorizationError;\n    readonly claims?: string;\n    readonly tenantId?: string;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n    readonly errorType:\n    DriverErrorType.genericError\n    | DriverErrorType.fileNotFoundOrAccessDeniedError\n    | DriverErrorType.offlineError\n    | DriverErrorType.unsupportedClientProtocolVersion\n    | DriverErrorType.writeError\n    | DriverErrorType.fetchFailure\n    | DriverErrorType.incorrectServerResponse\n    | DriverErrorType.fileOverwrittenInStorage;\n    readonly statusCode?: number;\n}\n\nexport type DriverError =\n    | IThrottlingWarning\n    | IGenericNetworkError\n    | IAuthorizationError\n    | IDriverBasicError;\n"]}
+{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;GAGG;AACH,IAAY,eAoEX;AApED,WAAY,eAAe;IACvB;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACF,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;AACtE,CAAC,EApEW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAoE1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Driver Error types\n * Lists types that are likely to be used by all drivers\n */\nexport enum DriverErrorType {\n    /**\n     * A fatal error with no specific interpretation covered by other DriverErrorType values\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Some non-categorized (below) networking error\n     * Include errors like  fatal server error (usually 500).\n     */\n    genericNetworkError = \"genericNetworkError\",\n\n    /**\n     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n     */\n    authorizationError = \"authorizationError\",\n\n    /**\n     * File not found, or file deleted during session\n     */\n    fileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * We can not reach server due to computer being offline.\n     */\n    offlineError = \"offlineError\",\n\n    /*\n     * Unsupported client protocol\n     */\n    unsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n    /**\n     * User does not have write permissions to a file, but is changing content of a file.\n     * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n     */\n    writeError = \"writeError\",\n\n    /**\n     * A generic fetch failure that indicates we were not able to get a response from the server.\n     * This may be due to the client being offline (though, if we are able to detect offline state it will be\n     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,\n     * CSP violation, etc.\n     */\n    fetchFailure = \"fetchFailure\",\n\n    /**\n     * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n     */\n    incorrectServerResponse = \"incorrectServerResponse\",\n\n    /**\n     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n     * and storage / driver / loader detects such mismatch.\n     * When it's hit, client needs to forget all the knowlege about this file and start over.\n     */\n     fileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n     /**\n      * The document is read-only and delta stream connection is forbidden.\n      */\n     deltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n}\n\n/**\n * Base interface for all errors and warnings\n */\nexport interface IDriverErrorBase {\n    /** Classification of what type of error this is, used programmatically by consumers to interpret the error */\n    readonly errorType: DriverErrorType;\n    /** Free-form error message */\n    readonly message: string;\n    /** True indicates the caller may retry the failed action. False indicates it's a fatal error */\n    canRetry: boolean;\n    /**\n     * Best guess as to network conditions (online/offline) when the error arose.\n     * See OnlineStatus enum in driver-utils package for expected values.\n     */\n    online?: string;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.genericNetworkError;\n    readonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.authorizationError;\n    readonly claims?: string;\n    readonly tenantId?: string;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n    readonly errorType:\n    DriverErrorType.genericError\n    | DriverErrorType.fileNotFoundOrAccessDeniedError\n    | DriverErrorType.offlineError\n    | DriverErrorType.unsupportedClientProtocolVersion\n    | DriverErrorType.writeError\n    | DriverErrorType.fetchFailure\n    | DriverErrorType.incorrectServerResponse\n    | DriverErrorType.fileOverwrittenInStorage;\n    readonly statusCode?: number;\n}\n\nexport type DriverError =\n    | IThrottlingWarning\n    | IGenericNetworkError\n    | IAuthorizationError\n    | IDriverBasicError;\n"]}

package/dist/storage.d.ts

@@ -231,13 +231,27 @@ export interface IDocumentServiceFactory {
      */
     protocolName: string;
     /**
-     * Returns an instance of IDocumentService
+     * Creates the document service after extracting different endpoints URLs from a resolved URL.
+     *
+     * @param resolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.
+     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+     * @param clientIsSummarizer - Whether or not the client is the
+     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+     * `undefined` =\> false
+     *
+     * @returns An instance of {@link IDocumentService}.
      */
     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     /**
      * Creates a new document with the provided options. Returns the document service.
+     *
      * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary
      * should be posted later, before connecting to ordering service.
+     * @param createNewResolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.
+     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+     * @param clientIsSummarizer - Whether or not the client is the
+     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+     * `undefined` =\> false
      */
     createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACpH,OAAO,EACH,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;;;OASG;IACH,GAAG,CACC,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC;AAED,oBAAY,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAC;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;CAAE,CAAC;AAE5E;;GAEG;AACF,MAAM,WAAW,OAAO,CAAC,CAAC;IACvB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;;;;OASG;IACF,aAAa,CAAC,IAAI,EAAE,MAAM,EACvB,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,+BAA+B;IAC5C,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAIvC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACjE,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,CAAC;IAEpD;;OAEG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEnE;;OAEG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE1E;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,OAAE;IACvD,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,OAAE;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACpD;AAED,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,cAAc,CAAC,8BAA8B,CAAC;IACzG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,oBAAY,mBAAmB;IAC3B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACX;AAED,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAE7B,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACF,qBAAqB,CAClB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;OAIG;IACH,eAAe,CACX,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC5C"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACpH,OAAO,EACH,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;;;OASG;IACH,GAAG,CACC,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC;AAED,oBAAY,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAC;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;CAAE,CAAC;AAE5E;;GAEG;AACF,MAAM,WAAW,OAAO,CAAC,CAAC;IACvB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;;;;OASG;IACF,aAAa,CAAC,IAAI,EAAE,MAAM,EACvB,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,+BAA+B;IAC5C,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAIvC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACjE,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,CAAC;IAEpD;;OAEG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEnE;;OAEG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE1E;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,OAAE;IACvD,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,OAAE;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACpD;AAED,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,cAAc,CAAC,8BAA8B,CAAC;IACzG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,oBAAY,mBAAmB;IAC3B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACX;AAED,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAE7B,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;OAUG;IACF,qBAAqB,CAClB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CACX,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC5C"}

package/dist/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwOH,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC3B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACZ,CAAC,EAVW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAU9B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IErrorEvent, ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClient,\n    IClientConfiguration,\n    ICreateBlobResponse,\n    IDocumentMessage,\n    INack,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITokenClaims,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"./urlResolver\";\n\nexport interface IDeltasFetchResult {\n    /**\n     * Sequential set of messages starting from 'from' sequence number.\n     * May be partial result, i.e. not fulfill original request in full.\n     */\n    messages: ISequencedDocumentMessage[];\n\n    /**\n     * If true, storage only partially fulfilled request, but has more ops\n     * If false, the request was fulfilled. If less ops were returned then\n     * requested, then storage does not have more ops in this range.\n     */\n    partialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the inclusive sequence number range\n     * @param tenantId - Id of the tenant.\n     * @param id - document id.\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n    get(\n        tenantId: string,\n        id: string,\n        from: number, // inclusive\n        to: number, // exclusive\n        fetchReason?: string,\n    ): Promise<IDeltasFetchResult>;\n}\n\nexport type IStreamResult<T> = { done: true; } | { done: false; value: T; };\n\n/**\n * Read interface for the Queue\n */\n export interface IStream<T> {\n    read(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDocumentDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the exclusive sequence number range\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param abortSignal - signal that aborts operation\n     * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n     fetchMessages(from: number,\n        to: number | undefined,\n        abortSignal?: AbortSignal,\n        cachedOnly?: boolean,\n        fetchReason?: string,\n    ): IStream<ISequencedDocumentMessage[]>;\n}\n\nexport interface IDocumentStorageServicePolicies {\n    readonly caching?: LoaderCachingPolicy;\n\n    // If this policy is provided, it tells runtime on ideal size for blobs\n    // Blobs that are smaller than that size should be aggregated into bigger blobs\n    readonly minBlobSize?: number;\n\n    /**\n     * This policy tells the runtime that the driver will not use cached snapshots older than this value.\n     */\n    readonly maximumCacheDurationMs?: number;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n    repositoryUrl: string;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    readonly policies?: IDocumentStorageServicePolicies;\n\n    /**\n     * Returns the snapshot tree.\n     */\n    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;\n\n    /**\n     * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n     */\n    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;\n\n    /**\n     * Creates a blob out of the given buffer\n     */\n    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n    /**\n     * Reads the object with the given ID, returns content in arrayBufferLike\n     */\n    readBlob(id: string): Promise<ArrayBufferLike>;\n\n    /**\n     * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n     * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n     * referencing from the previously acked summary.\n     * Returns the uploaded summary handle.\n     */\n    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n    /**\n     * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n     * server has deleted it this call may result in a broken promise.\n     */\n    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n    (event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n    (event: \"disconnect\", listener: (reason: any) => void);\n    (event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n    (event: \"signal\", listener: (message: ISignalMessage) => void);\n    (event: \"pong\", listener: (latency: number) => void);\n    (event: \"error\", listener: (error: any) => void);\n}\n\nexport interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {\n    /**\n     * ClientID for the connection\n     */\n    clientId: string;\n\n    /**\n     * Claims for the client\n     */\n    claims: ITokenClaims;\n\n    /**\n     * Mode of the client\n     */\n    mode: ConnectionMode;\n\n    /**\n     * Whether the connection was made to a new or existing document\n     */\n    existing: boolean;\n\n    /**\n     * Protocol version being used with the service\n     */\n    version: string;\n\n    /**\n     * Messages sent during the connection\n     */\n    initialMessages: ISequencedDocumentMessage[];\n\n    /**\n     * Signals sent during the connection\n     */\n    initialSignals: ISignalMessage[];\n\n    /**\n     * Prior clients already connected.\n     */\n    initialClients: ISignalClient[];\n\n    /**\n     * Configuration details provided by the service\n     */\n    serviceConfiguration: IClientConfiguration;\n\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber?: number;\n\n    /**\n     * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n     * it could contain info like build version, environment, region etc. These properties can be logged by client\n     * to better understand server environment etc. and use it in case error occurs.\n     * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n     */\n    relayServiceAgent?: string;\n\n    /**\n     * Submit a new message to the server\n     */\n    submit(messages: IDocumentMessage[]): void;\n\n    /**\n     * Submit a new signal to the server\n     */\n    submitSignal(message: any): void;\n}\n\nexport enum LoaderCachingPolicy {\n    /**\n     * The loader should not implement any prefetching or caching policy.\n     */\n    NoCaching,\n\n    /**\n     * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n     */\n    Prefetch,\n}\n\nexport interface IDocumentServicePolicies {\n    /**\n     * Do not connect to delta stream\n     */\n    readonly storageOnly?: boolean;\n}\n\nexport interface IDocumentService {\n\n    resolvedUrl: IResolvedUrl;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    policies?: IDocumentServicePolicies;\n\n    /**\n     * Access to storage associated with the document...\n     */\n    connectToStorage(): Promise<IDocumentStorageService>;\n\n    /**\n     * Access to delta storage associated with the document\n     */\n    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n    /**\n     * Subscribes to the document delta stream\n     */\n    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n    /**\n     * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n     * Useful for storage to commit any pending state if any (including any local caching).\n     * Please note that it does not remove the need for caller to close all active delta connections,\n     * as storage may not be tracking such objects.\n     * @param error - tells if container (and storage) are closed due to critical error.\n     * Error might be due to disconnect between client & server knowlege about file, like file being overwritten\n     * in storage, but client having stale local cache.\n     * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n     */\n    dispose(error?: any): void;\n}\n\nexport interface IDocumentServiceFactory {\n    /**\n     * Name of the protocol used by factory\n     */\n    protocolName: string;\n\n    /**\n     * Returns an instance of IDocumentService\n     */\n     createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n\n    /**\n     * Creates a new document with the provided options. Returns the document service.\n     * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n     * should be posted later, before connecting to ordering service.\n     */\n    createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n */\nexport interface ISummaryContext {\n    /**\n     * Parent summary proposed handle (from summary op)\n     */\n    readonly proposalHandle: string | undefined;\n\n    /**\n     * Parent summary acked handle (from summary ack)\n     */\n    readonly ackHandle: string | undefined;\n\n    readonly referenceSequenceNumber: number;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwOH,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC3B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACZ,CAAC,EAVW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAU9B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IErrorEvent, ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClient,\n    IClientConfiguration,\n    ICreateBlobResponse,\n    IDocumentMessage,\n    INack,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITokenClaims,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"./urlResolver\";\n\nexport interface IDeltasFetchResult {\n    /**\n     * Sequential set of messages starting from 'from' sequence number.\n     * May be partial result, i.e. not fulfill original request in full.\n     */\n    messages: ISequencedDocumentMessage[];\n\n    /**\n     * If true, storage only partially fulfilled request, but has more ops\n     * If false, the request was fulfilled. If less ops were returned then\n     * requested, then storage does not have more ops in this range.\n     */\n    partialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the inclusive sequence number range\n     * @param tenantId - Id of the tenant.\n     * @param id - document id.\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n    get(\n        tenantId: string,\n        id: string,\n        from: number, // inclusive\n        to: number, // exclusive\n        fetchReason?: string,\n    ): Promise<IDeltasFetchResult>;\n}\n\nexport type IStreamResult<T> = { done: true; } | { done: false; value: T; };\n\n/**\n * Read interface for the Queue\n */\n export interface IStream<T> {\n    read(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDocumentDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the exclusive sequence number range\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param abortSignal - signal that aborts operation\n     * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n     fetchMessages(from: number,\n        to: number | undefined,\n        abortSignal?: AbortSignal,\n        cachedOnly?: boolean,\n        fetchReason?: string,\n    ): IStream<ISequencedDocumentMessage[]>;\n}\n\nexport interface IDocumentStorageServicePolicies {\n    readonly caching?: LoaderCachingPolicy;\n\n    // If this policy is provided, it tells runtime on ideal size for blobs\n    // Blobs that are smaller than that size should be aggregated into bigger blobs\n    readonly minBlobSize?: number;\n\n    /**\n     * This policy tells the runtime that the driver will not use cached snapshots older than this value.\n     */\n    readonly maximumCacheDurationMs?: number;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n    repositoryUrl: string;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    readonly policies?: IDocumentStorageServicePolicies;\n\n    /**\n     * Returns the snapshot tree.\n     */\n    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;\n\n    /**\n     * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n     */\n    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;\n\n    /**\n     * Creates a blob out of the given buffer\n     */\n    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n    /**\n     * Reads the object with the given ID, returns content in arrayBufferLike\n     */\n    readBlob(id: string): Promise<ArrayBufferLike>;\n\n    /**\n     * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n     * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n     * referencing from the previously acked summary.\n     * Returns the uploaded summary handle.\n     */\n    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n    /**\n     * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n     * server has deleted it this call may result in a broken promise.\n     */\n    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n    (event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n    (event: \"disconnect\", listener: (reason: any) => void);\n    (event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n    (event: \"signal\", listener: (message: ISignalMessage) => void);\n    (event: \"pong\", listener: (latency: number) => void);\n    (event: \"error\", listener: (error: any) => void);\n}\n\nexport interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {\n    /**\n     * ClientID for the connection\n     */\n    clientId: string;\n\n    /**\n     * Claims for the client\n     */\n    claims: ITokenClaims;\n\n    /**\n     * Mode of the client\n     */\n    mode: ConnectionMode;\n\n    /**\n     * Whether the connection was made to a new or existing document\n     */\n    existing: boolean;\n\n    /**\n     * Protocol version being used with the service\n     */\n    version: string;\n\n    /**\n     * Messages sent during the connection\n     */\n    initialMessages: ISequencedDocumentMessage[];\n\n    /**\n     * Signals sent during the connection\n     */\n    initialSignals: ISignalMessage[];\n\n    /**\n     * Prior clients already connected.\n     */\n    initialClients: ISignalClient[];\n\n    /**\n     * Configuration details provided by the service\n     */\n    serviceConfiguration: IClientConfiguration;\n\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber?: number;\n\n    /**\n     * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n     * it could contain info like build version, environment, region etc. These properties can be logged by client\n     * to better understand server environment etc. and use it in case error occurs.\n     * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n     */\n    relayServiceAgent?: string;\n\n    /**\n     * Submit a new message to the server\n     */\n    submit(messages: IDocumentMessage[]): void;\n\n    /**\n     * Submit a new signal to the server\n     */\n    submitSignal(message: any): void;\n}\n\nexport enum LoaderCachingPolicy {\n    /**\n     * The loader should not implement any prefetching or caching policy.\n     */\n    NoCaching,\n\n    /**\n     * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n     */\n    Prefetch,\n}\n\nexport interface IDocumentServicePolicies {\n    /**\n     * Do not connect to delta stream\n     */\n    readonly storageOnly?: boolean;\n}\n\nexport interface IDocumentService {\n\n    resolvedUrl: IResolvedUrl;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    policies?: IDocumentServicePolicies;\n\n    /**\n     * Access to storage associated with the document...\n     */\n    connectToStorage(): Promise<IDocumentStorageService>;\n\n    /**\n     * Access to delta storage associated with the document\n     */\n    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n    /**\n     * Subscribes to the document delta stream\n     */\n    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n    /**\n     * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n     * Useful for storage to commit any pending state if any (including any local caching).\n     * Please note that it does not remove the need for caller to close all active delta connections,\n     * as storage may not be tracking such objects.\n     * @param error - tells if container (and storage) are closed due to critical error.\n     * Error might be due to disconnect between client & server knowlege about file, like file being overwritten\n     * in storage, but client having stale local cache.\n     * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n     */\n    dispose(error?: any): void;\n}\n\nexport interface IDocumentServiceFactory {\n    /**\n     * Name of the protocol used by factory\n     */\n    protocolName: string;\n\n    /**\n     * Creates the document service after extracting different endpoints URLs from a resolved URL.\n     *\n     * @param resolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.\n     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n     * @param clientIsSummarizer - Whether or not the client is the\n     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n     * `undefined` =\\> false\n     *\n     * @returns An instance of {@link IDocumentService}.\n     */\n     createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n\n    /**\n     * Creates a new document with the provided options. Returns the document service.\n     *\n     * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n     * should be posted later, before connecting to ordering service.\n     * @param createNewResolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.\n     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n     * @param clientIsSummarizer - Whether or not the client is the\n     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n     * `undefined` =\\> false\n     */\n    createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n */\nexport interface ISummaryContext {\n    /**\n     * Parent summary proposed handle (from summary op)\n     */\n    readonly proposalHandle: string | undefined;\n\n    /**\n     * Parent summary acked handle (from summary ack)\n     */\n    readonly ackHandle: string | undefined;\n\n    readonly referenceSequenceNumber: number;\n}\n"]}

package/lib/driverError.d.ts

@@ -39,10 +39,10 @@ export declare enum DriverErrorType {
      */
     writeError = "writeError",
     /**
-     * Generic fetch failure.
-     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to
-     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.
-     * This can also indicate no response from server.
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
      */
     fetchFailure = "fetchFailure",
     /**

package/lib/driverError.js

@@ -43,10 +43,10 @@ export var DriverErrorType;
      */
     DriverErrorType["writeError"] = "writeError";
     /**
-     * Generic fetch failure.
-     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to
-     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.
-     * This can also indicate no response from server.
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
      */
     DriverErrorType["fetchFailure"] = "fetchFailure";
     /**

package/lib/driverError.js.map

@@ -1 +1 @@
-{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,CAAN,IAAY,eAoEX;AApED,WAAY,eAAe;IACvB;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACF,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;AACtE,CAAC,EApEW,eAAe,KAAf,eAAe,QAoE1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Driver Error types\n * Lists types that are likely to be used by all drivers\n */\nexport enum DriverErrorType {\n    /**\n     * A fatal error with no specific interpretation covered by other DriverErrorType values\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Some non-categorized (below) networking error\n     * Include errors like  fatal server error (usually 500).\n     */\n    genericNetworkError = \"genericNetworkError\",\n\n    /**\n     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n     */\n    authorizationError = \"authorizationError\",\n\n    /**\n     * File not found, or file deleted during session\n     */\n    fileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * We can not reach server due to computer being offline.\n     */\n    offlineError = \"offlineError\",\n\n    /*\n     * Unsupported client protocol\n     */\n    unsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n    /**\n     * User does not have write permissions to a file, but is changing content of a file.\n     * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n     */\n    writeError = \"writeError\",\n\n    /**\n     * Generic fetch failure.\n     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to\n     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.\n     * This can also indicate no response from server.\n     */\n    fetchFailure = \"fetchFailure\",\n\n    /**\n     * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n     */\n    incorrectServerResponse = \"incorrectServerResponse\",\n\n    /**\n     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n     * and storage / driver / loader detects such mismatch.\n     * When it's hit, client needs to forget all the knowlege about this file and start over.\n     */\n     fileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n     /**\n      * The document is read-only and delta stream connection is forbidden.\n      */\n     deltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n}\n\n/**\n * Base interface for all errors and warnings\n */\nexport interface IDriverErrorBase {\n    /** Classification of what type of error this is, used programmatically by consumers to interpret the error */\n    readonly errorType: DriverErrorType;\n    /** Free-form error message */\n    readonly message: string;\n    /** True indicates the caller may retry the failed action. False indicates it's a fatal error */\n    canRetry: boolean;\n    /**\n     * Best guess as to network conditions (online/offline) when the error arose.\n     * See OnlineStatus enum in driver-utils package for expected values.\n     */\n    online?: string;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.genericNetworkError;\n    readonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.authorizationError;\n    readonly claims?: string;\n    readonly tenantId?: string;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n    readonly errorType:\n    DriverErrorType.genericError\n    | DriverErrorType.fileNotFoundOrAccessDeniedError\n    | DriverErrorType.offlineError\n    | DriverErrorType.unsupportedClientProtocolVersion\n    | DriverErrorType.writeError\n    | DriverErrorType.fetchFailure\n    | DriverErrorType.incorrectServerResponse\n    | DriverErrorType.fileOverwrittenInStorage;\n    readonly statusCode?: number;\n}\n\nexport type DriverError =\n    | IThrottlingWarning\n    | IGenericNetworkError\n    | IAuthorizationError\n    | IDriverBasicError;\n"]}
+{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,CAAN,IAAY,eAoEX;AApED,WAAY,eAAe;IACvB;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACF,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;AACtE,CAAC,EApEW,eAAe,KAAf,eAAe,QAoE1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Driver Error types\n * Lists types that are likely to be used by all drivers\n */\nexport enum DriverErrorType {\n    /**\n     * A fatal error with no specific interpretation covered by other DriverErrorType values\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Some non-categorized (below) networking error\n     * Include errors like  fatal server error (usually 500).\n     */\n    genericNetworkError = \"genericNetworkError\",\n\n    /**\n     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n     */\n    authorizationError = \"authorizationError\",\n\n    /**\n     * File not found, or file deleted during session\n     */\n    fileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * We can not reach server due to computer being offline.\n     */\n    offlineError = \"offlineError\",\n\n    /*\n     * Unsupported client protocol\n     */\n    unsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n    /**\n     * User does not have write permissions to a file, but is changing content of a file.\n     * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n     */\n    writeError = \"writeError\",\n\n    /**\n     * A generic fetch failure that indicates we were not able to get a response from the server.\n     * This may be due to the client being offline (though, if we are able to detect offline state it will be\n     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,\n     * CSP violation, etc.\n     */\n    fetchFailure = \"fetchFailure\",\n\n    /**\n     * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n     */\n    incorrectServerResponse = \"incorrectServerResponse\",\n\n    /**\n     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n     * and storage / driver / loader detects such mismatch.\n     * When it's hit, client needs to forget all the knowlege about this file and start over.\n     */\n     fileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n     /**\n      * The document is read-only and delta stream connection is forbidden.\n      */\n     deltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n}\n\n/**\n * Base interface for all errors and warnings\n */\nexport interface IDriverErrorBase {\n    /** Classification of what type of error this is, used programmatically by consumers to interpret the error */\n    readonly errorType: DriverErrorType;\n    /** Free-form error message */\n    readonly message: string;\n    /** True indicates the caller may retry the failed action. False indicates it's a fatal error */\n    canRetry: boolean;\n    /**\n     * Best guess as to network conditions (online/offline) when the error arose.\n     * See OnlineStatus enum in driver-utils package for expected values.\n     */\n    online?: string;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.genericNetworkError;\n    readonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n    readonly errorType: DriverErrorType.authorizationError;\n    readonly claims?: string;\n    readonly tenantId?: string;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n    readonly errorType:\n    DriverErrorType.genericError\n    | DriverErrorType.fileNotFoundOrAccessDeniedError\n    | DriverErrorType.offlineError\n    | DriverErrorType.unsupportedClientProtocolVersion\n    | DriverErrorType.writeError\n    | DriverErrorType.fetchFailure\n    | DriverErrorType.incorrectServerResponse\n    | DriverErrorType.fileOverwrittenInStorage;\n    readonly statusCode?: number;\n}\n\nexport type DriverError =\n    | IThrottlingWarning\n    | IGenericNetworkError\n    | IAuthorizationError\n    | IDriverBasicError;\n"]}

package/lib/storage.d.ts

@@ -231,13 +231,27 @@ export interface IDocumentServiceFactory {
      */
     protocolName: string;
     /**
-     * Returns an instance of IDocumentService
+     * Creates the document service after extracting different endpoints URLs from a resolved URL.
+     *
+     * @param resolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.
+     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+     * @param clientIsSummarizer - Whether or not the client is the
+     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+     * `undefined` =\> false
+     *
+     * @returns An instance of {@link IDocumentService}.
      */
     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     /**
      * Creates a new document with the provided options. Returns the document service.
+     *
      * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary
      * should be posted later, before connecting to ordering service.
+     * @param createNewResolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.
+     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+     * @param clientIsSummarizer - Whether or not the client is the
+     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+     * `undefined` =\> false
      */
     createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }

package/lib/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACpH,OAAO,EACH,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;;;OASG;IACH,GAAG,CACC,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC;AAED,oBAAY,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAC;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;CAAE,CAAC;AAE5E;;GAEG;AACF,MAAM,WAAW,OAAO,CAAC,CAAC;IACvB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;;;;OASG;IACF,aAAa,CAAC,IAAI,EAAE,MAAM,EACvB,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,+BAA+B;IAC5C,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAIvC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACjE,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,CAAC;IAEpD;;OAEG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEnE;;OAEG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE1E;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,OAAE;IACvD,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,OAAE;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACpD;AAED,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,cAAc,CAAC,8BAA8B,CAAC;IACzG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,oBAAY,mBAAmB;IAC3B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACX;AAED,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAE7B,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACF,qBAAqB,CAClB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;OAIG;IACH,eAAe,CACX,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC5C"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACpH,OAAO,EACH,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;;;OASG;IACH,GAAG,CACC,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC;AAED,oBAAY,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAC;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;CAAE,CAAC;AAE5E;;GAEG;AACF,MAAM,WAAW,OAAO,CAAC,CAAC;IACvB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;;;;OASG;IACF,aAAa,CAAC,IAAI,EAAE,MAAM,EACvB,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,+BAA+B;IAC5C,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAIvC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACjE,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,CAAC;IAEpD;;OAEG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEnE;;OAEG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE1E;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,OAAE;IACvD,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,OAAE;IAC/D,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACpD;AAED,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,cAAc,CAAC,8BAA8B,CAAC;IACzG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,oBAAY,mBAAmB;IAC3B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACX;AAED,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAE7B,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;OAUG;IACF,qBAAqB,CAClB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CACX,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC5C"}

package/lib/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwOH,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC3B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACZ,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IErrorEvent, ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClient,\n    IClientConfiguration,\n    ICreateBlobResponse,\n    IDocumentMessage,\n    INack,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITokenClaims,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"./urlResolver\";\n\nexport interface IDeltasFetchResult {\n    /**\n     * Sequential set of messages starting from 'from' sequence number.\n     * May be partial result, i.e. not fulfill original request in full.\n     */\n    messages: ISequencedDocumentMessage[];\n\n    /**\n     * If true, storage only partially fulfilled request, but has more ops\n     * If false, the request was fulfilled. If less ops were returned then\n     * requested, then storage does not have more ops in this range.\n     */\n    partialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the inclusive sequence number range\n     * @param tenantId - Id of the tenant.\n     * @param id - document id.\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n    get(\n        tenantId: string,\n        id: string,\n        from: number, // inclusive\n        to: number, // exclusive\n        fetchReason?: string,\n    ): Promise<IDeltasFetchResult>;\n}\n\nexport type IStreamResult<T> = { done: true; } | { done: false; value: T; };\n\n/**\n * Read interface for the Queue\n */\n export interface IStream<T> {\n    read(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDocumentDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the exclusive sequence number range\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param abortSignal - signal that aborts operation\n     * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n     fetchMessages(from: number,\n        to: number | undefined,\n        abortSignal?: AbortSignal,\n        cachedOnly?: boolean,\n        fetchReason?: string,\n    ): IStream<ISequencedDocumentMessage[]>;\n}\n\nexport interface IDocumentStorageServicePolicies {\n    readonly caching?: LoaderCachingPolicy;\n\n    // If this policy is provided, it tells runtime on ideal size for blobs\n    // Blobs that are smaller than that size should be aggregated into bigger blobs\n    readonly minBlobSize?: number;\n\n    /**\n     * This policy tells the runtime that the driver will not use cached snapshots older than this value.\n     */\n    readonly maximumCacheDurationMs?: number;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n    repositoryUrl: string;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    readonly policies?: IDocumentStorageServicePolicies;\n\n    /**\n     * Returns the snapshot tree.\n     */\n    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;\n\n    /**\n     * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n     */\n    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;\n\n    /**\n     * Creates a blob out of the given buffer\n     */\n    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n    /**\n     * Reads the object with the given ID, returns content in arrayBufferLike\n     */\n    readBlob(id: string): Promise<ArrayBufferLike>;\n\n    /**\n     * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n     * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n     * referencing from the previously acked summary.\n     * Returns the uploaded summary handle.\n     */\n    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n    /**\n     * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n     * server has deleted it this call may result in a broken promise.\n     */\n    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n    (event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n    (event: \"disconnect\", listener: (reason: any) => void);\n    (event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n    (event: \"signal\", listener: (message: ISignalMessage) => void);\n    (event: \"pong\", listener: (latency: number) => void);\n    (event: \"error\", listener: (error: any) => void);\n}\n\nexport interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {\n    /**\n     * ClientID for the connection\n     */\n    clientId: string;\n\n    /**\n     * Claims for the client\n     */\n    claims: ITokenClaims;\n\n    /**\n     * Mode of the client\n     */\n    mode: ConnectionMode;\n\n    /**\n     * Whether the connection was made to a new or existing document\n     */\n    existing: boolean;\n\n    /**\n     * Protocol version being used with the service\n     */\n    version: string;\n\n    /**\n     * Messages sent during the connection\n     */\n    initialMessages: ISequencedDocumentMessage[];\n\n    /**\n     * Signals sent during the connection\n     */\n    initialSignals: ISignalMessage[];\n\n    /**\n     * Prior clients already connected.\n     */\n    initialClients: ISignalClient[];\n\n    /**\n     * Configuration details provided by the service\n     */\n    serviceConfiguration: IClientConfiguration;\n\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber?: number;\n\n    /**\n     * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n     * it could contain info like build version, environment, region etc. These properties can be logged by client\n     * to better understand server environment etc. and use it in case error occurs.\n     * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n     */\n    relayServiceAgent?: string;\n\n    /**\n     * Submit a new message to the server\n     */\n    submit(messages: IDocumentMessage[]): void;\n\n    /**\n     * Submit a new signal to the server\n     */\n    submitSignal(message: any): void;\n}\n\nexport enum LoaderCachingPolicy {\n    /**\n     * The loader should not implement any prefetching or caching policy.\n     */\n    NoCaching,\n\n    /**\n     * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n     */\n    Prefetch,\n}\n\nexport interface IDocumentServicePolicies {\n    /**\n     * Do not connect to delta stream\n     */\n    readonly storageOnly?: boolean;\n}\n\nexport interface IDocumentService {\n\n    resolvedUrl: IResolvedUrl;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    policies?: IDocumentServicePolicies;\n\n    /**\n     * Access to storage associated with the document...\n     */\n    connectToStorage(): Promise<IDocumentStorageService>;\n\n    /**\n     * Access to delta storage associated with the document\n     */\n    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n    /**\n     * Subscribes to the document delta stream\n     */\n    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n    /**\n     * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n     * Useful for storage to commit any pending state if any (including any local caching).\n     * Please note that it does not remove the need for caller to close all active delta connections,\n     * as storage may not be tracking such objects.\n     * @param error - tells if container (and storage) are closed due to critical error.\n     * Error might be due to disconnect between client & server knowlege about file, like file being overwritten\n     * in storage, but client having stale local cache.\n     * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n     */\n    dispose(error?: any): void;\n}\n\nexport interface IDocumentServiceFactory {\n    /**\n     * Name of the protocol used by factory\n     */\n    protocolName: string;\n\n    /**\n     * Returns an instance of IDocumentService\n     */\n     createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n\n    /**\n     * Creates a new document with the provided options. Returns the document service.\n     * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n     * should be posted later, before connecting to ordering service.\n     */\n    createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n */\nexport interface ISummaryContext {\n    /**\n     * Parent summary proposed handle (from summary op)\n     */\n    readonly proposalHandle: string | undefined;\n\n    /**\n     * Parent summary acked handle (from summary ack)\n     */\n    readonly ackHandle: string | undefined;\n\n    readonly referenceSequenceNumber: number;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwOH,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC3B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACZ,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IErrorEvent, ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClient,\n    IClientConfiguration,\n    ICreateBlobResponse,\n    IDocumentMessage,\n    INack,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITokenClaims,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"./urlResolver\";\n\nexport interface IDeltasFetchResult {\n    /**\n     * Sequential set of messages starting from 'from' sequence number.\n     * May be partial result, i.e. not fulfill original request in full.\n     */\n    messages: ISequencedDocumentMessage[];\n\n    /**\n     * If true, storage only partially fulfilled request, but has more ops\n     * If false, the request was fulfilled. If less ops were returned then\n     * requested, then storage does not have more ops in this range.\n     */\n    partialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the inclusive sequence number range\n     * @param tenantId - Id of the tenant.\n     * @param id - document id.\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n    get(\n        tenantId: string,\n        id: string,\n        from: number, // inclusive\n        to: number, // exclusive\n        fetchReason?: string,\n    ): Promise<IDeltasFetchResult>;\n}\n\nexport type IStreamResult<T> = { done: true; } | { done: false; value: T; };\n\n/**\n * Read interface for the Queue\n */\n export interface IStream<T> {\n    read(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n */\nexport interface IDocumentDeltaStorageService {\n    /**\n     * Retrieves all the delta operations within the exclusive sequence number range\n     * @param from - first op to retrieve (inclusive)\n     * @param to - first op not to retrieve (exclusive end)\n     * @param abortSignal - signal that aborts operation\n     * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number\n     *  of Op on wire and known seq number. It should not contain any PII. It can be logged by\n     *  spo which could help in debugging sessions if any issue occurs.\n     */\n     fetchMessages(from: number,\n        to: number | undefined,\n        abortSignal?: AbortSignal,\n        cachedOnly?: boolean,\n        fetchReason?: string,\n    ): IStream<ISequencedDocumentMessage[]>;\n}\n\nexport interface IDocumentStorageServicePolicies {\n    readonly caching?: LoaderCachingPolicy;\n\n    // If this policy is provided, it tells runtime on ideal size for blobs\n    // Blobs that are smaller than that size should be aggregated into bigger blobs\n    readonly minBlobSize?: number;\n\n    /**\n     * This policy tells the runtime that the driver will not use cached snapshots older than this value.\n     */\n    readonly maximumCacheDurationMs?: number;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n    repositoryUrl: string;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    readonly policies?: IDocumentStorageServicePolicies;\n\n    /**\n     * Returns the snapshot tree.\n     */\n    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;\n\n    /**\n     * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n     */\n    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;\n\n    /**\n     * Creates a blob out of the given buffer\n     */\n    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n    /**\n     * Reads the object with the given ID, returns content in arrayBufferLike\n     */\n    readBlob(id: string): Promise<ArrayBufferLike>;\n\n    /**\n     * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n     * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n     * referencing from the previously acked summary.\n     * Returns the uploaded summary handle.\n     */\n    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n    /**\n     * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n     * server has deleted it this call may result in a broken promise.\n     */\n    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n    (event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n    (event: \"disconnect\", listener: (reason: any) => void);\n    (event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n    (event: \"signal\", listener: (message: ISignalMessage) => void);\n    (event: \"pong\", listener: (latency: number) => void);\n    (event: \"error\", listener: (error: any) => void);\n}\n\nexport interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {\n    /**\n     * ClientID for the connection\n     */\n    clientId: string;\n\n    /**\n     * Claims for the client\n     */\n    claims: ITokenClaims;\n\n    /**\n     * Mode of the client\n     */\n    mode: ConnectionMode;\n\n    /**\n     * Whether the connection was made to a new or existing document\n     */\n    existing: boolean;\n\n    /**\n     * Protocol version being used with the service\n     */\n    version: string;\n\n    /**\n     * Messages sent during the connection\n     */\n    initialMessages: ISequencedDocumentMessage[];\n\n    /**\n     * Signals sent during the connection\n     */\n    initialSignals: ISignalMessage[];\n\n    /**\n     * Prior clients already connected.\n     */\n    initialClients: ISignalClient[];\n\n    /**\n     * Configuration details provided by the service\n     */\n    serviceConfiguration: IClientConfiguration;\n\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber?: number;\n\n    /**\n     * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n     * it could contain info like build version, environment, region etc. These properties can be logged by client\n     * to better understand server environment etc. and use it in case error occurs.\n     * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n     */\n    relayServiceAgent?: string;\n\n    /**\n     * Submit a new message to the server\n     */\n    submit(messages: IDocumentMessage[]): void;\n\n    /**\n     * Submit a new signal to the server\n     */\n    submitSignal(message: any): void;\n}\n\nexport enum LoaderCachingPolicy {\n    /**\n     * The loader should not implement any prefetching or caching policy.\n     */\n    NoCaching,\n\n    /**\n     * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n     */\n    Prefetch,\n}\n\nexport interface IDocumentServicePolicies {\n    /**\n     * Do not connect to delta stream\n     */\n    readonly storageOnly?: boolean;\n}\n\nexport interface IDocumentService {\n\n    resolvedUrl: IResolvedUrl;\n\n    /**\n     * Policies implemented/instructed by driver.\n     */\n    policies?: IDocumentServicePolicies;\n\n    /**\n     * Access to storage associated with the document...\n     */\n    connectToStorage(): Promise<IDocumentStorageService>;\n\n    /**\n     * Access to delta storage associated with the document\n     */\n    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n    /**\n     * Subscribes to the document delta stream\n     */\n    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n    /**\n     * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n     * Useful for storage to commit any pending state if any (including any local caching).\n     * Please note that it does not remove the need for caller to close all active delta connections,\n     * as storage may not be tracking such objects.\n     * @param error - tells if container (and storage) are closed due to critical error.\n     * Error might be due to disconnect between client & server knowlege about file, like file being overwritten\n     * in storage, but client having stale local cache.\n     * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n     */\n    dispose(error?: any): void;\n}\n\nexport interface IDocumentServiceFactory {\n    /**\n     * Name of the protocol used by factory\n     */\n    protocolName: string;\n\n    /**\n     * Creates the document service after extracting different endpoints URLs from a resolved URL.\n     *\n     * @param resolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.\n     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n     * @param clientIsSummarizer - Whether or not the client is the\n     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n     * `undefined` =\\> false\n     *\n     * @returns An instance of {@link IDocumentService}.\n     */\n     createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n\n    /**\n     * Creates a new document with the provided options. Returns the document service.\n     *\n     * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n     * should be posted later, before connecting to ordering service.\n     * @param createNewResolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.\n     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n     * @param clientIsSummarizer - Whether or not the client is the\n     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n     * `undefined` =\\> false\n     */\n    createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n */\nexport interface ISummaryContext {\n    /**\n     * Parent summary proposed handle (from summary op)\n     */\n    readonly proposalHandle: string | undefined;\n\n    /**\n     * Parent summary acked handle (from summary ack)\n     */\n    readonly ackHandle: string | undefined;\n\n    readonly referenceSequenceNumber: number;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-definitions",
-  "version": "0.47.1000-69949",
+  "version": "1.0.0",
   "description": "Fluid driver definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -17,12 +17,12 @@
   "scripts": {
     "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
     "build:compile": "concurrently npm:typetests:gen npm:tsc npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ./node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
     "ci:build": "npm run build:compile",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ./node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "ci:test": "echo No test for this package",
     "ci:test:coverage": "echo No test for this package",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
@@ -34,35 +34,23 @@
     "tsc:watch": "tsc --watch",
     "tsfmt": "tsfmt --verify",
     "tsfmt:fix": "tsfmt --replace",
-    "typetests:gen": "fluid-type-validator -d .",
-    "typetests:prepare": "fluid-type-validator -d . -p"
+    "typetests:gen": "fluid-type-validator -g -d ."
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000-0"
+    "@fluidframework/core-interfaces": "^1.0.0",
+    "@fluidframework/protocol-definitions": "^0.1028.2000"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.66793",
+    "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@0.46.1000",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000-0",
+    "@fluidframework/eslint-config-fluid": "^0.28.2000",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
-    "@typescript-eslint/eslint-plugin": "~5.9.0",
-    "@typescript-eslint/parser": "~5.9.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "eslint": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-jest": "~26.1.3",
-    "eslint-plugin-mocha": "~10.0.3",
-    "eslint-plugin-promise": "~6.0.0",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-tsdoc": "~0.2.14",
-    "eslint-plugin-unicorn": "~40.0.0",
     "rimraf": "^2.6.2",
     "typescript": "~4.5.5",
     "typescript-formatter": "7.1.0"

package/src/driverError.ts

@@ -51,10 +51,10 @@ export enum DriverErrorType {
     writeError = "writeError",
 
     /**
-     * Generic fetch failure.
-     * Most of such failures are due to client being offline, or DNS is not reachable, such errors map to
-     * DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error.
-     * This can also indicate no response from server.
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
      */
     fetchFailure = "fetchFailure",
 

package/src/storage.ts

@@ -296,7 +296,15 @@ export interface IDocumentServiceFactory {
     protocolName: string;
 
     /**
-     * Returns an instance of IDocumentService
+     * Creates the document service after extracting different endpoints URLs from a resolved URL.
+     *
+     * @param resolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.
+     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+     * @param clientIsSummarizer - Whether or not the client is the
+     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+     * `undefined` =\> false
+     *
+     * @returns An instance of {@link IDocumentService}.
      */
      createDocumentService(
         resolvedUrl: IResolvedUrl,
@@ -306,8 +314,14 @@ export interface IDocumentServiceFactory {
 
     /**
      * Creates a new document with the provided options. Returns the document service.
+     *
      * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary
      * should be posted later, before connecting to ordering service.
+     * @param createNewResolvedUrl - Endpoint URL data. @see {@link IResolvedUrl}.
+     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+     * @param clientIsSummarizer - Whether or not the client is the
+     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+     * `undefined` =\> false
      */
     createContainer(
         createNewSummary: ISummaryTree | undefined,

package/api-report/driver-definitions.api.md

@@ -1,285 +0,0 @@
-## API Report File for "@fluidframework/driver-definitions"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { IClient } from '@fluidframework/protocol-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/common-definitions';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IErrorEvent } from '@fluidframework/common-definitions';
-import { IEventProvider } from '@fluidframework/common-definitions';
-import { INack } from '@fluidframework/protocol-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryHandle } from '@fluidframework/protocol-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/common-definitions';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { IVersion } from '@fluidframework/protocol-definitions';
-
-// @public (undocumented)
-export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | IDriverBasicError;
-
-// @public
-export enum DriverErrorType {
-    authorizationError = "authorizationError",
-    deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden",
-    fetchFailure = "fetchFailure",
-    fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
-    fileOverwrittenInStorage = "fileOverwrittenInStorage",
-    genericError = "genericError",
-    genericNetworkError = "genericNetworkError",
-    incorrectServerResponse = "incorrectServerResponse",
-    offlineError = "offlineError",
-    throttlingError = "throttlingError",
-    // (undocumented)
-    unsupportedClientProtocolVersion = "unsupportedClientProtocolVersion",
-    writeError = "writeError"
-}
-
-// @public
-export enum DriverHeader {
-    // (undocumented)
-    createNew = "createNew",
-    // (undocumented)
-    summarizingClient = "fluid-client-summarizer"
-}
-
-// @public
-export interface DriverPreCheckInfo {
-    codeDetailsHint?: string;
-    criticalBootDomains?: string[];
-}
-
-// @public (undocumented)
-export interface IAuthorizationError extends IDriverErrorBase {
-    // (undocumented)
-    readonly claims?: string;
-    // (undocumented)
-    readonly errorType: DriverErrorType.authorizationError;
-    // (undocumented)
-    readonly tenantId?: string;
-}
-
-// @public
-export interface IContainerPackageInfo {
-    name: string;
-}
-
-// @public (undocumented)
-export interface IDeltasFetchResult {
-    messages: ISequencedDocumentMessage[];
-    partialResult: boolean;
-}
-
-// @public
-export interface IDeltaStorageService {
-    get(tenantId: string, id: string, from: number, // inclusive
-    to: number, // exclusive
-    fetchReason?: string): Promise<IDeltasFetchResult>;
-}
-
-// @public (undocumented)
-export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
-    checkpointSequenceNumber?: number;
-    claims: ITokenClaims;
-    clientId: string;
-    existing: boolean;
-    initialClients: ISignalClient[];
-    initialMessages: ISequencedDocumentMessage[];
-    initialSignals: ISignalMessage[];
-    mode: ConnectionMode;
-    relayServiceAgent?: string;
-    serviceConfiguration: IClientConfiguration;
-    submit(messages: IDocumentMessage[]): void;
-    submitSignal(message: any): void;
-    version: string;
-}
-
-// @public (undocumented)
-export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
-    // (undocumented)
-    (event: "nack", listener: (documentId: string, message: INack[]) => void): any;
-    // (undocumented)
-    (event: "disconnect", listener: (reason: any) => void): any;
-    // (undocumented)
-    (event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void): any;
-    // (undocumented)
-    (event: "signal", listener: (message: ISignalMessage) => void): any;
-    // (undocumented)
-    (event: "pong", listener: (latency: number) => void): any;
-    // (undocumented)
-    (event: "error", listener: (error: any) => void): any;
-}
-
-// @public
-export interface IDocumentDeltaStorageService {
-    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
-}
-
-// @public (undocumented)
-export interface IDocumentService {
-    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
-    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
-    connectToStorage(): Promise<IDocumentStorageService>;
-    dispose(error?: any): void;
-    policies?: IDocumentServicePolicies;
-    // (undocumented)
-    resolvedUrl: IResolvedUrl;
-}
-
-// @public (undocumented)
-export interface IDocumentServiceFactory {
-    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    protocolName: string;
-}
-
-// @public (undocumented)
-export interface IDocumentServicePolicies {
-    readonly storageOnly?: boolean;
-}
-
-// @public
-export interface IDocumentStorageService extends Partial<IDisposable> {
-    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
-    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
-    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    readonly policies?: IDocumentStorageServicePolicies;
-    readBlob(id: string): Promise<ArrayBufferLike>;
-    // (undocumented)
-    repositoryUrl: string;
-    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
-}
-
-// @public (undocumented)
-export interface IDocumentStorageServicePolicies {
-    // (undocumented)
-    readonly caching?: LoaderCachingPolicy;
-    readonly maximumCacheDurationMs?: number;
-    // (undocumented)
-    readonly minBlobSize?: number;
-}
-
-// @public
-export interface IDriverBasicError extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage;
-    // (undocumented)
-    readonly statusCode?: number;
-}
-
-// @public
-export interface IDriverErrorBase {
-    canRetry: boolean;
-    readonly errorType: DriverErrorType;
-    readonly message: string;
-    online?: string;
-}
-
-// @public (undocumented)
-export interface IDriverHeader {
-    // (undocumented)
-    [DriverHeader.summarizingClient]: boolean;
-    // (undocumented)
-    [DriverHeader.createNew]: any;
-}
-
-// @public (undocumented)
-export interface IFluidResolvedUrl extends IResolvedUrlBase {
-    // (undocumented)
-    endpoints: {
-        [name: string]: string;
-    };
-    id: string;
-    // (undocumented)
-    tokens: {
-        [name: string]: string;
-    };
-    // (undocumented)
-    type: "fluid";
-    // (undocumented)
-    url: string;
-}
-
-// @public (undocumented)
-export interface IGenericNetworkError extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: DriverErrorType.genericNetworkError;
-    // (undocumented)
-    readonly statusCode?: number;
-}
-
-// @public (undocumented)
-export type IResolvedUrl = IWebResolvedUrl | IFluidResolvedUrl;
-
-// @public (undocumented)
-export interface IResolvedUrlBase {
-    // (undocumented)
-    type: string;
-}
-
-// @public
-export interface IStream<T> {
-    // (undocumented)
-    read(): Promise<IStreamResult<T>>;
-}
-
-// @public (undocumented)
-export type IStreamResult<T> = {
-    done: true;
-} | {
-    done: false;
-    value: T;
-};
-
-// @public
-export interface ISummaryContext {
-    readonly ackHandle: string | undefined;
-    readonly proposalHandle: string | undefined;
-    // (undocumented)
-    readonly referenceSequenceNumber: number;
-}
-
-// @public (undocumented)
-export interface IThrottlingWarning extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: DriverErrorType.throttlingError;
-    // (undocumented)
-    readonly retryAfterSeconds: number;
-}
-
-// @public (undocumented)
-export interface IUrlResolver {
-    // (undocumented)
-    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
-    // (undocumented)
-    resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
-}
-
-// @public (undocumented)
-export interface IWebResolvedUrl extends IResolvedUrlBase {
-    // (undocumented)
-    data: string;
-    // (undocumented)
-    type: "web";
-}
-
-// @public (undocumented)
-export enum LoaderCachingPolicy {
-    NoCaching = 0,
-    Prefetch = 1
-}
-
-
-// (No @packageDocumentation comment for this package)
-
-```