@fluidframework/driver-definitions 0.45.1000 → 0.45.2000-58205

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

@@ -139,8 +139,8 @@ export interface IDocumentService {
 
 // @public (undocumented)
 export interface IDocumentServiceFactory {
-    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     protocolName: string;
 }
 

package/dist/storage.d.ts

@@ -237,13 +237,13 @@ export interface IDocumentServiceFactory {
     /**
      * Returns an instance of IDocumentService
      */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<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.
      */
-    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 /**
  * Context for uploading a summary to storage.

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,KAAK,EACL,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,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvF;;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;IACH,qBAAqB,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE3G;;;;OAIG;IACH,eAAe,CACX,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,GAC9B,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,KAAK,EACL,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,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvF;;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"}

package/dist/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA8OH,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    ITree,\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     * Writes to the object with the given ID\n     */\n    write(root: ITree, parents: string[], message: string, ref: string): 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(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): 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    ): 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;;;AA8OH,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    ITree,\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     * Writes to the object with the given ID\n     */\n    write(root: ITree, parents: string[], message: string, ref: string): 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"]}

package/lib/storage.d.ts

@@ -237,13 +237,13 @@ export interface IDocumentServiceFactory {
     /**
      * Returns an instance of IDocumentService
      */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<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.
      */
-    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 /**
  * Context for uploading a summary to storage.

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,KAAK,EACL,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,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvF;;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;IACH,qBAAqB,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE3G;;;;OAIG;IACH,eAAe,CACX,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,GAC9B,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,KAAK,EACL,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,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvF;;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"}

package/lib/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8OH,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    ITree,\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     * Writes to the object with the given ID\n     */\n    write(root: ITree, parents: string[], message: string, ref: string): 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(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): 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    ): 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;AA8OH,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    ITree,\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     * Writes to the object with the given ID\n     */\n    write(root: ITree, parents: string[], message: string, ref: string): 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"]}

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@fluidframework/driver-definitions",
-  "version": "0.45.1000",
+  "version": "0.45.2000-58205",
   "description": "Fluid driver definitions",
   "homepage": "https://fluidframework.com",
-  "repository": "https://github.com/microsoft/FluidFramework",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "common/lib/driver-definitions"
+  },
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
@@ -40,14 +44,14 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.54658",
+    "@fluidframework/build-tools": "^0.2.58041",
     "@fluidframework/driver-definitions-0.39.8": "npm:@fluidframework/driver-definitions@0.39.8",
     "@fluidframework/driver-definitions-0.40.0": "npm:@fluidframework/driver-definitions@0.40.0",
     "@fluidframework/driver-definitions-0.41.0": "npm:@fluidframework/driver-definitions@0.41.0",
     "@fluidframework/driver-definitions-0.42.0": "npm:@fluidframework/driver-definitions@0.42.0",
     "@fluidframework/driver-definitions-0.43.0": "npm:@fluidframework/driver-definitions@0.43.0",
     "@fluidframework/driver-definitions-0.44.0": "npm:@fluidframework/driver-definitions@0.44.0",
-    "@fluidframework/eslint-config-fluid": "^0.26.0",
+    "@fluidframework/eslint-config-fluid": "^0.27.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@typescript-eslint/eslint-plugin": "~5.9.0",

package/src/storage.ts

@@ -304,7 +304,11 @@ export interface IDocumentServiceFactory {
     /**
      * Returns an instance of IDocumentService
      */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+     createDocumentService(
+        resolvedUrl: IResolvedUrl,
+        logger?: ITelemetryBaseLogger,
+        clientIsSummarizer?: boolean,
+    ): Promise<IDocumentService>;
 
     /**
      * Creates a new document with the provided options. Returns the document service.
@@ -315,6 +319,7 @@ export interface IDocumentServiceFactory {
         createNewSummary: ISummaryTree | undefined,
         createNewResolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService>;
 }