@fluidframework/container-runtime 2.70.0-361092 → 2.70.0-361788

package/lib/summary/documentSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentSchema.js","sourceRoot":"","sources":["../../src/summary/documentSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAG7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAC/E,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAwJlD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAsC9C,MAAM,eAAe;IACb,GAAG,CAAC,eAAsB,EAAE,cAAqB;QACvD,OAAO,eAAe,KAAK,IAAI,IAAI,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,CAAC;IAEM,EAAE,CAAC,eAAsB,EAAE,cAAqB;QACtD,OAAO,eAAe,KAAK,IAAI,IAAI,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,CAAC;IAEM,QAAQ,CAAC,CAAU;QACzB,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC;IACtC,CAAC;CACD;AAED,MAAM,kBAAmB,SAAQ,eAAe;IACxC,GAAG,CAAC,eAAsB,EAAE,cAAqB;QACvD,OAAO,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;CACD;AAED,MAAM,WAAW;IAChB,YAA6B,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;IAAG,CAAC;IAE3C,GAAG,CAAC,eAAwB,EAAE,cAAuB;QAC3D,IAAI,eAAe,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACnE,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CACrF,CAAC;IACH,CAAC;IAEM,EAAE,CAAC,eAAwB,EAAE,cAAuB;QAC1D,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,cAAc,CAAC;QACvB,CAAC;QACD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,eAAe,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CACrF,CAAC;IACH,CAAC;IAEM,QAAQ,CAAC,CAAU;QACzB,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/E,CAAC;CACD;AAED,MAAM,oBAAqB,SAAQ,WAAW;IAC7C,+BAA+B;IACxB,GAAG,CAAC,eAAwB,EAAE,cAAuB;QAC3D,OAAO,eAAe,CAAC;IACxB,CAAC;CACD;AAED,MAAM,aAAa;IACX,EAAE,CACR,kBAA4B,EAAE,EAC9B,iBAA2B,EAAE;QAE7B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,eAAe,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC;QACrE,OAAO,WAAW,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,iDAAiD;IAC1C,GAAG,CACT,kBAA4B,EAAE,EAC9B,iBAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAEM,QAAQ,CAAC,CAAU;QACzB,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;IACzE,CAAC;CACD;AAED;;GAEG;AACH,MAAM,8BAA8B,GAAG;IACtC,qBAAqB,EAAE,IAAI,kBAAkB,EAAE,EAAE,0CAA0C;IAC3F,gBAAgB,EAAE,IAAI,oBAAoB,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC7D,iBAAiB,EAAE,IAAI,eAAe,EAAE;IACxC,cAAc,EAAE,IAAI,eAAe,EAAE;IACrC,wBAAwB,EAAE,IAAI,eAAe,EAAE;IAC/C,kBAAkB,EAAE,IAAI,aAAa,EAAE;CACvC,CAAC;AAEF;;;;GAIG;AACH,SAAS,yBAAyB,CACjC,cAA2C,EAC3C,UAAkB;IAElB,6DAA6D;IAC7D,gHAAgH;IAChH,mCAAmC;IACnC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO;IACR,CAAC;IAED,MAAM,GAAG,GAAG,2DAA2D,CAAC;IACxE,IAAI,cAAc,CAAC,OAAO,KAAK,4BAA4B,EAAE,CAAC;QAC7D,MAAM,mBAAmB,CAAC,MAAM,CAC/B,GAAG,EACH,qBAAqB,EACrB,SAAS,EAAE,UAAU;QACrB;YACC,oBAAoB,EAAE,cAAc,CAAC,OAAO;YAC5C,2BAA2B,EAAE,4BAA4B;YACzD,UAAU;SACV,CACD,CAAC;IACH,CAAC;IAED,IAAI,eAAmC,CAAC;IAExC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;IACrC,iHAAiH;IACjH,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,eAAe,GAAG,QAAQ,CAAC;IAC5B,CAAC;SAAM,IAAI,cAAc,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC1F,eAAe,GAAG,SAAS,CAAC;IAC7B,CAAC;SAAM,CAAC;QACP,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YACpE,MAAM,SAAS,GAAG,8BAA8B,CAAC,IAAI,CAA0B,CAAC;YAChF,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBAC5C,eAAe,GAAG,WAAW,IAAI,EAAE,CAAC;YACrC,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACnC,mEAAmE;QACnE,MAAM,KAAK,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;QAC9C,MAAM,mBAAmB,CAAC,MAAM,CAC/B,GAAG,EACH,qBAAqB,EACrB,SAAS,EAAE,UAAU;QACrB;YACC,WAAW,EAAE,4BAA4B;YACzC,QAAQ,EAAE,eAAe;YACzB,mEAAmE;YACnE,KAAK;YACL,UAAU;SACV,CACD,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,GAAG,CACX,eAA+C,EAC/C,cAAsC;IAEtC,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,IAAI,GAAG,CAAC;QACzB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;QACvC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;KACtC,CAAC,EAAE,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,GAAI,8BAA8B,CAAC,GAAG,CAAe,CAAC,GAAG,CACpE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,EAC5B,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAC3B,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,aAAa;IACb,MAAM,mBAAmB,GACxB,eAAe,CAAC,IAAI,EAAE,mBAAmB,IAAI,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAEtF,OAAO;QACN,OAAO,EAAE,4BAA4B;QACrC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,IAAI,EAAE,EAAE,mBAAmB,EAAE;QAC7B,OAAO;KACP,CAAC;AACH,CAAC;AAED,SAAS,EAAE,CACV,eAA+C,EAC/C,cAAsC;IAEtC,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,IAAI,GAAG,CAAC;QACzB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;QACvC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;KACtC,CAAC,EAAE,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,GAAI,8BAA8B,CAAC,GAAG,CAAe,CAAC,EAAE,CACnE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,EAC5B,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAC3B,CAAC;IACH,CAAC;IAED,oEAAoE;IACpE,MAAM,mBAAmB,GACxB,eAAe,CAAC,IAAI,KAAK,SAAS;QACjC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB;QACzC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC;YACtF,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAmB;YAC1C,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAE7C,OAAO;QACN,OAAO,EAAE,4BAA4B;QACrC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,IAAI,EAAE,EAAE,mBAAmB,EAAE;QAC7B,OAAO;KACP,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,IAAI,CACZ,eAA+C,EAC/C,cAAsC;IAEtC,IACC,eAAe,CAAC,IAAI,KAAK,SAAS;QAClC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC,EACpF,CAAC;QACF,gGAAgG;QAChG,iGAAiG;QACjG,OAAO,KAAK,CAAC;IACd,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,IAAI,GAAG,CAAC;QACzB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;QACvC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;KACtC,CAAC,EAAE,CAAC;QACJ,yFAAyF;QACzF,IACC,GAAG,KAAK,uBAAuB;YAC/B,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAC3D,CAAC;YACF,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,WAAW,CAAC,GAAa;IACjC,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,OAAO,yBAAyB;IA0BrC;;;;;;;;OAQG;IACH,YACC,QAAiB,EACjB,sBAA8B,EAC9B,sBAAmD,EACnD,QAAiC,EAChB,cAAwD,EACzE,IAAyB,EACzB,MAA2B;QAFV,mBAAc,GAAd,cAAc,CAA0C;QArC1E;;;WAGG;QACK,cAAS,GAAG,KAAK,CAAC;QAqCzB,0FAA0F;QAC1F,MAAM,CACL,QAAQ,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAC1E,KAAK,CAAC,mBAAmB,CACzB,CAAC;QAEF,iHAAiH;QACjH,oHAAoH;QACpH,wHAAwH;QACxH,yHAAyH;QACzH,0HAA0H;QAC1H,+GAA+G;QAC/G,qFAAqF;QACrF,MAAM,2BAA2B,GAAG,sBAAsB,EAAE,IAAI,EAAE,mBAAmB,CAAC;QACtF,IACC,2BAA2B,KAAK,SAAS;YACzC,EAAE,CAAC,2BAA2B,EAAE,UAAU,CAAC;YAC3C,4GAA4G;YAC5G,gFAAgF;YAChF,4CAA4C;YAC5C,CAAC,UAAU,CAAC,UAAU,CAAC,EACtB,CAAC;YACF,MAAM,OAAO,GAAG,gEAAgE,UAAU,kEAAkE,2BAA2B,oCAAoC,CAAC;YAC5N,MAAM,CAAC,kBAAkB,CAAC;gBACzB,SAAS,EAAE,4BAA4B;gBACvC,OAAO,EAAE,OAAO;aAChB,CAAC,CAAC;QACJ,CAAC;QAED,8EAA8E;QAC9E,IAAI,CAAC,aAAa,GAAG;YACpB,OAAO,EAAE,4BAA4B;YACrC,MAAM,EAAE,sBAAsB,EAAE,MAAM,IAAI,CAAC;YAC3C,IAAI;YACJ,OAAO,EAAE;gBACR,qBAAqB,EAAE,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC;gBACjE,cAAc,EAAE,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC;gBACnD,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;gBAC3C,iBAAiB,EAAE,UAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBACzD,wBAAwB,EAAE,QAAQ,CAAC,wBAAwB;gBAC3D,kBAAkB,EAAE,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;aAC5D;SACD,CAAC;QAEF,2FAA2F;QAC3F,yGAAyG;QACzG,6DAA6D;QAC7D,IAAI,CAAC,cAAc,GAAG,QAAQ;YAC7B,CAAC,CAAC,CAAC,sBAAsB;gBACxB,CAAC;oBACA,OAAO,EAAE,4BAA4B;oBACrC,sEAAsE;oBACtE,MAAM,EAAE,CAAC;oBACT,IAAI;oBACJ,wFAAwF;oBACxF,wEAAwE;oBACxE,OAAO,EAAE;wBACR,qBAAqB,EAAE,UAAU,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,qBAAqB,CAAC;qBAC9E;iBACgC,CAAC,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAEtB,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAC;QAEtF,+EAA+E;QAC/E,wCAAwC;QACxC,IAAI,CAAC,qBAAqB;YACzB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI;gBAC1D,QAAQ,CAAC,qBAAqB,CAAC;QAEhC,YAAY;QACZ,2EAA2E;QAC3E,mFAAmF;QACnF,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YACxC,MAAM,CACL,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC;gBACrC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,qBAAqB,EACjD,KAAK,CAAC,2BAA2B,CACjC,CAAC;YACF,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC/B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAClE,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;YACtF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;YACrF,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;YAC/B,CAAC;QACF,CAAC;QAED,6GAA6G;QAC7G,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACzD,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACzD,yBAAyB,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,uBAAuB,CAC7B,MAAc;QAEd,kEAAkE;QAClE,yHAAyH;QACzH,+HAA+H;QAC/H,sFAAsF;QACtF,8HAA8H;QAC9H,8CAA8C;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAErF,oHAAoH;QACpH,2GAA2G;QAC3G,mHAAmH;QACnH,oEAAoE;QACpE,MAAM,CACL,IAAI,CAAC,qBAAqB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EACjD,KAAK,CAAC,2BAA2B,CACjC,CAAC;QAEF,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,0BAA0B;QAChC,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACxD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,MAAM,CACL,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,EACtF,KAAK,CAAC,gBAAgB,CACtB,CAAC;YACF,OAAO,IAAI,CAAC,YAAY,CAAC;QAC1B,CAAC;IACF,CAAC;IAEO,iBAAiB,CACxB,eAAuB,EACvB,iBAAyB,EACzB,OAAe;QAEf,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,eAAe,IAAI,iBAAiB,CAAC,EAAE,CAAC;YACnF,MAAM,mBAAmB,CAAC,MAAM,CAC/B,sCAAsC,EACtC,qBAAqB,EACrB,SAAS,EAAE,UAAU;YACrB;gBACC,eAAe;gBACf,cAAc,EAAE,iBAAiB;gBACjC,OAAO;aACP,CACD,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,6BAA6B,CACnC,QAAgD,EAChD,KAAc,EACd,cAAsB;QAEtB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YACrF,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;YAC7E,uCAAuC;YACvC,MAAM,CACL,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,cAAc,EAC3C,KAAK,CAAC,oCAAoC,CAC1C,CAAC;YAEF,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBACnD,aAAa;gBACb,OAAO,KAAK,CAAC;YACd,CAAC;YAED,iEAAiE;YACjE,oIAAoI;YACpI,MAAM,CACL,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,EACzE,KAAK,CAAC,qBAAqB,CAC3B,CAAC;YAEF,sFAAsF;YACtF,yBAAyB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG;gBACd,GAAG,OAAO;gBACV,MAAM,EAAE,cAAc;aACmB,CAAC;YAC3C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;YAC7B,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,KAAK,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;YAEvE,yFAAyF;YACzF,4CAA4C;YAC5C,mFAAmF;YACnF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;YAElC,mCAAmC;YACnC,sEAAsE;YACtE,6DAA6D;YAC7D,2FAA2F;YAC3F,qGAAqG;YACrG,+DAA+D;YAC/D,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;YAE9B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,iBAAiB;QACvB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACxB,CAAC;CACD;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,OAAe;IAClC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9B,OAAO,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;AACrD,CAAC;AAED,2CAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { SemanticVersion } from \"@fluidframework/runtime-utils/internal\";\nimport type { ITelemetryLoggerExt } from \"@fluidframework/telemetry-utils/internal\";\nimport { DataProcessingError } from \"@fluidframework/telemetry-utils/internal\";\nimport { gt, lt, parse } from \"semver-ts\";\n\nimport { pkgVersion } from \"../packageVersion.js\";\n\n/**\n * Descripe allowed type for properties in document schema.\n * Please note that for all property types we should use undefined to indicate that particular capability is off.\n * Using false, or some string value (like \"off\") will result in clients who do not understand that property failing, whereas\n * we want them to continue to collaborate alongside clients who support that capability, but such capability is shipping dark for now.\n * @internal\n */\nexport type DocumentSchemaValueType = string | string[] | true | number | undefined;\n\n/**\n * ID Compressor mode.\n * \"on\" - compressor is On. It's loaded as part of container load. This mode is sticky - once on, compressor is On for all\n * sessions for a given document. This results in IContainerRuntime.idCompressor to be always available.\n * \"delayed\" - ID compressor bundle is loaded only on establishing of first delta connection, i.e. it does not impact boot of cotnainer.\n * In such mode IContainerRuntime.idCompressor is not made available (unless previous sessions of same document had it \"On\").\n * The only thing that is available is IContainerRuntime.generateDocumentUniqueId() that provides opportunistically short IDs.\n * undefined - ID compressor is not loaded.\n * While IContainerRuntime.generateDocumentUniqueId() is available, it will produce long IDs that are do not compress well.\n *\n * @legacy @beta\n */\nexport type IdCompressorMode = \"on\" | \"delayed\" | undefined;\n\n/**\n * Document schema information.\n * Describes overall shape of document schema, including unknown (to this version) properties.\n *\n * Used by runtime to make a call if it can understand document schema.\n * If it can't, it should not continue with document and immediately fail, preventing random (cryptic) failures\n * down the road and potentially corrupting documents.\n * For now this structure and appropriate interpretation / behavior is focused only on runtime features.\n * In the future that could be interpolated to more areas, including DDSs used, and even possibly - application\n * schema.\n *\n * Runtime will ignore any properties at the root that it does not understand (i.e. IDocumentSchema.app), but will\n * stop (and fail session) on any unknown properties within \"runtime\" sub-tree.\n *\n * In most cases values preserved in the document will not dictate if such features should be enabled in a given session.\n * I.e. if compression is mentioned in document schema, this means that runtime version that opens such document must know\n * how to interpret such ops, but does not need to actually use compression itself. That said, some options could be\n * sticky, i.e. influence feature selection for all runtimes opening a document. ID compression is one such example.\n * Currently there is no mechanism to remove feature from this property bag, i.e. once compression was used, even if it's\n * disabled (through feature gate or code deployment), all existing documents that used compression will continue to fail\n * if opened by clients who do not support compression.\n *\n * For now we are limiting it to just plain properties, and only really simple types, but that can be changed in the future.\n *\n * @internal\n */\nexport interface IDocumentSchema {\n\t// Note: Incoming schemas from other clients may have additional root-level properties (i.e. IDocumentSchema.app)\n\t// that this client does not understand. The runtime will ignore these properties, unless they are within the\n\t// \"runtime\" sub-tree, in which case it will fail if it is unable to understand any runtime properties.\n\n\t/**\n\t * Describes how data needed to understand the schema is stored in this structure.\n\t * If runtime sees a version it does not understand, it should immediately fail and not\n\t * attempt to interpret any further data.\n\t */\n\tversion: number;\n\n\t/**\n\t * Sequence number when this schema became active.\n\t */\n\trefSeq: number;\n\n\t/**\n\t * Runtime configurations that affect the document schema. Other clients must understand these\n\t * properties to be able to open the document.\n\t */\n\truntime: Record<string, DocumentSchemaValueType>;\n\n\t/**\n\t * Info about this document that can be updated via Document Schema change op, but isn't required\n\t * to be understood by all clients (unlike the rest of IDocumentSchema properties). Because of this,\n\t * some older documents may not have this property, so it's an optional property.\n\t */\n\tinfo?: IDocumentSchemaInfo;\n}\n\n/**\n * Informational properties of the document that are not subject to strict schema enforcement.\n *\n * @internal\n */\nexport interface IDocumentSchemaInfo {\n\t/**\n\t * The minimum version of the FF runtime that should be used to load this document.\n\t * Will likely be advanced over time as applications pick up later FF versions.\n\t *\n\t * We use this to issue telemetry warning events if a client tries to open a document\n\t * with a runtime version lower than this.\n\t *\n\t * See {@link @fluidframework/container-runtime#LoadContainerRuntimeParams} for additional details on `minVersionForCollab`.\n\t *\n\t * @remarks\n\t * We use `SemanticVersion` instead of `MinimumVersionForCollab` since we may open future documents that with a\n\t * minVersionForCollab version that `MinimumVersionForCollab` does not support.\n\t */\n\tminVersionForCollab: SemanticVersion;\n}\n\n/**\n * Content of the type=ContainerMessageType.DocumentSchemaChange ops.\n * The meaning of refSeq field is different in such messages (compared to other usages of IDocumentSchemaCurrent)\n * ContainerMessageType.DocumentSchemaChange messages use CAS (Compare-and-swap) semantics, and convey\n * regSeq of last known schema change (known to a client proposing schema change).\n * @see InboundContainerRuntimeDocumentSchemaMessage\n * @internal\n */\nexport type IDocumentSchemaChangeMessageIncoming = IDocumentSchema;\n\n/**\n * Similar to {@link IDocumentSchemaChangeMessageIncoming}, but used for outgoing schema messages.\n * @see OutboundContainerRuntimeDocumentSchemaMessage\n * @internal\n */\nexport type IDocumentSchemaChangeMessageOutgoing = IDocumentSchemaCurrent;\n\n/**\n * Settings that this session would like to have, based on options and feature gates.\n *\n * WARNING: This type is used to infer IDocumentSchemaCurrent type!\n * Any changes here (including renaming of properties) are potentially changing document format and should be considered carefully!\n *\n * @internal\n */\nexport interface IDocumentSchemaFeatures {\n\t// Tells if client uses legacy behavior of changing schema.\n\t// - Legacy behavior - changing schema without leveraging schema change ops.\n\t// - New behavior - changes in schema require ops and take into affect with delay.\n\texplicitSchemaControl: boolean;\n\tcompressionLz4: boolean;\n\tidCompressorMode: IdCompressorMode;\n\topGroupingEnabled: boolean;\n\tcreateBlobPayloadPending: true | undefined;\n\n\t/**\n\t * List of disallowed versions of the runtime.\n\t * This option is sticky. Once a version of runtime is added to this list (when supplied to DocumentsSchemaController's constructor)\n\t * it will be added to the list of disallowed versions and stored in document metadata.\n\t * Each runtime checks if its version is in this list on container open. If it is, it immediately exits with error message\n\t * indicating to the user that this version is no longer supported.\n\t * Currently there is no mechanism to remove version from this list. I.e. If it was once added to the list,\n\t * it gets added to any document metadata (documents that gets open by this runtime) and there is no way to clear it from document's\n\t * metadata.\n\t */\n\tdisallowedVersions: string[];\n}\n\n/**\n * Current version known properties that define document schema\n * This must be bumped whenever the format of document schema or protocol for changing the current document schema changes\n * in a way that all old/new clients are required to understand.\n * Ex: Adding a new configuration property (under IDocumentSchema.runtime) does not require changing this version since there is logic\n * in old clients for handling new/unknown properties.\n * Ex: Adding a new property to IDocumentSchema.info does not require changing this version, since info properties are not required to be\n * understood by all clients.\n * Ex: Changing the 'document schema acceptance' mechanism from convert-and-swap to one requiring consensus does require changing this version\n * since all clients need to understand the new protocol.\n * @internal\n */\nexport const currentDocumentVersionSchema = 1;\n\n/**\n * Current document schema.\n * This interface represents the schema that we currently understand and know the\n * structure of (which properties will be present).\n *\n * @internal\n */\nexport interface IDocumentSchemaCurrent extends Required<IDocumentSchema> {\n\t// This is the version of the schema that we currently understand.\n\tversion: typeof currentDocumentVersionSchema;\n\t// This narrows the runtime property to only include the properties in IDocumentSchemaFeatures (all as optional)\n\truntime: {\n\t\t[P in keyof IDocumentSchemaFeatures]?: IDocumentSchemaFeatures[P] extends boolean\n\t\t\t? true\n\t\t\t: IDocumentSchemaFeatures[P];\n\t};\n}\n\n/**\n * Document schema that is incoming from another client but validated to be \"current\".\n *\n * This interface represents when we have validated that an incoming IDocumentSchema object\n * is compatible with the current runtime (by calling `checkRuntimeCompatibility()`).\n * However, the `info` property is optional because some older documents may not have this property, but\n * `info` is not required to be understood by all clients to be compatible.\n */\ninterface IDocumentSchemaCurrentIncoming extends Omit<IDocumentSchemaCurrent, \"info\"> {\n\tinfo?: IDocumentSchemaInfo;\n}\n\ninterface IProperty<T = unknown> {\n\tand: (persistedSchema: T, providedSchema: T) => T;\n\tor: (persistedSchema: T, providedSchema: T) => T;\n\tvalidate(t: unknown): boolean;\n}\n\nclass TrueOrUndefined implements IProperty<true | undefined> {\n\tpublic and(persistedSchema?: true, providedSchema?: true): true | undefined {\n\t\treturn persistedSchema === true && providedSchema === true ? true : undefined;\n\t}\n\n\tpublic or(persistedSchema?: true, providedSchema?: true): true | undefined {\n\t\treturn persistedSchema === true || providedSchema === true ? true : undefined;\n\t}\n\n\tpublic validate(t: unknown): t is true | undefined {\n\t\treturn t === undefined || t === true;\n\t}\n}\n\nclass TrueOrUndefinedMax extends TrueOrUndefined {\n\tpublic and(persistedSchema?: true, providedSchema?: true): true | undefined {\n\t\treturn this.or(persistedSchema, providedSchema);\n\t}\n}\n\nclass MultiChoice implements IProperty<string | undefined> {\n\tconstructor(private readonly choices: string[]) {}\n\n\tpublic and(persistedSchema?: string, providedSchema?: string): string | undefined {\n\t\tif (persistedSchema === undefined || providedSchema === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn this.choices[\n\t\t\tMath.min(this.choices.indexOf(persistedSchema), this.choices.indexOf(providedSchema))\n\t\t];\n\t}\n\n\tpublic or(persistedSchema?: string, providedSchema?: string): string | undefined {\n\t\tif (persistedSchema === undefined) {\n\t\t\treturn providedSchema;\n\t\t}\n\t\tif (providedSchema === undefined) {\n\t\t\treturn persistedSchema;\n\t\t}\n\t\treturn this.choices[\n\t\t\tMath.max(this.choices.indexOf(persistedSchema), this.choices.indexOf(providedSchema))\n\t\t];\n\t}\n\n\tpublic validate(t: unknown): boolean {\n\t\treturn t === undefined || (typeof t === \"string\" && this.choices.includes(t));\n\t}\n}\n\nclass IdCompressorProperty extends MultiChoice {\n\t// document schema always wins!\n\tpublic and(persistedSchema?: string, providedSchema?: string): string | undefined {\n\t\treturn persistedSchema;\n\t}\n}\n\nclass CheckVersions implements IProperty<string[] | undefined> {\n\tpublic or(\n\t\tpersistedSchema: string[] = [],\n\t\tprovidedSchema: string[] = [],\n\t): string[] | undefined {\n\t\tconst set = new Set<string>([...persistedSchema, ...providedSchema]);\n\t\treturn arrayToProp([...set.values()]);\n\t}\n\n\t// Once version is there, it stays there forever.\n\tpublic and(\n\t\tpersistedSchema: string[] = [],\n\t\tprovidedSchema: string[] = [],\n\t): string[] | undefined {\n\t\treturn this.or(persistedSchema, providedSchema);\n\t}\n\n\tpublic validate(t: unknown): boolean {\n\t\treturn t === undefined || (Array.isArray(t) && !t.includes(pkgVersion));\n\t}\n}\n\n/**\n * Helper structure to valida if a schema is compatible with existing code.\n */\nconst documentSchemaSupportedConfigs = {\n\texplicitSchemaControl: new TrueOrUndefinedMax(), // once new behavior shows up, it's sticky\n\tidCompressorMode: new IdCompressorProperty([\"delayed\", \"on\"]),\n\topGroupingEnabled: new TrueOrUndefined(),\n\tcompressionLz4: new TrueOrUndefined(),\n\tcreateBlobPayloadPending: new TrueOrUndefined(),\n\tdisallowedVersions: new CheckVersions(),\n};\n\n/**\n * Checks if a given schema is compatible with current code, i.e. if current code can understand all the features of that schema.\n * If schema is not compatible with current code, it throws an exception.\n * @param documentSchema - current schema\n */\nfunction checkRuntimeCompatibility(\n\tdocumentSchema: IDocumentSchema | undefined,\n\tschemaName: string,\n): asserts documentSchema is IDocumentSchemaCurrentIncoming {\n\t// Back-compat - we can't do anything about legacy documents.\n\t// There is no way to validate them, so we are taking a guess that safe deployment processes used by a given app\n\t// do not run into compat problems.\n\tif (documentSchema === undefined) {\n\t\treturn;\n\t}\n\n\tconst msg = \"Document can't be opened with current version of the code\";\n\tif (documentSchema.version !== currentDocumentVersionSchema) {\n\t\tthrow DataProcessingError.create(\n\t\t\tmsg,\n\t\t\t\"checkRuntimeCompat1\",\n\t\t\tundefined, // message\n\t\t\t{\n\t\t\t\truntimeSchemaVersion: documentSchema.version,\n\t\t\t\tcurrentRuntimeSchemaVersion: currentDocumentVersionSchema,\n\t\t\t\tschemaName,\n\t\t\t},\n\t\t);\n\t}\n\n\tlet unknownProperty: string | undefined;\n\n\tconst regSeq = documentSchema.refSeq;\n\t// defence in depth - it should not be possible to get here anything other than integer, but worth validating it.\n\tif (typeof regSeq !== \"number\" || regSeq < 0 || !Number.isInteger(regSeq)) {\n\t\tunknownProperty = \"refSeq\";\n\t} else if (documentSchema.runtime === null || typeof documentSchema.runtime !== \"object\") {\n\t\tunknownProperty = \"runtime\";\n\t} else {\n\t\tfor (const [name, value] of Object.entries(documentSchema.runtime)) {\n\t\t\tconst validator = documentSchemaSupportedConfigs[name] as IProperty | undefined;\n\t\t\tif (!(validator?.validate(value) ?? false)) {\n\t\t\t\tunknownProperty = `runtime/${name}`;\n\t\t\t}\n\t\t}\n\t}\n\n\tif (unknownProperty !== undefined) {\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\tconst value = documentSchema[unknownProperty];\n\t\tthrow DataProcessingError.create(\n\t\t\tmsg,\n\t\t\t\"checkRuntimeCompat2\",\n\t\t\tundefined, // message\n\t\t\t{\n\t\t\t\tcodeVersion: currentDocumentVersionSchema,\n\t\t\t\tproperty: unknownProperty,\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\t\tvalue,\n\t\t\t\tschemaName,\n\t\t\t},\n\t\t);\n\t}\n}\n\nfunction and(\n\tpersistedSchema: IDocumentSchemaCurrentIncoming,\n\tprovidedSchema: IDocumentSchemaCurrent,\n): IDocumentSchemaCurrent {\n\tconst runtime = {};\n\tfor (const key of new Set([\n\t\t...Object.keys(persistedSchema.runtime),\n\t\t...Object.keys(providedSchema.runtime),\n\t])) {\n\t\truntime[key] = (documentSchemaSupportedConfigs[key] as IProperty).and(\n\t\t\tpersistedSchema.runtime[key],\n\t\t\tprovidedSchema.runtime[key],\n\t\t);\n\t}\n\n\t// We keep the persisted minVersionForCollab if present, even if the provided minVersionForCollab\n\t// is higher.\n\tconst minVersionForCollab =\n\t\tpersistedSchema.info?.minVersionForCollab ?? providedSchema.info.minVersionForCollab;\n\n\treturn {\n\t\tversion: currentDocumentVersionSchema,\n\t\trefSeq: persistedSchema.refSeq,\n\t\tinfo: { minVersionForCollab },\n\t\truntime,\n\t};\n}\n\nfunction or(\n\tpersistedSchema: IDocumentSchemaCurrentIncoming,\n\tprovidedSchema: IDocumentSchemaCurrent,\n): IDocumentSchemaCurrent {\n\tconst runtime = {};\n\tfor (const key of new Set([\n\t\t...Object.keys(persistedSchema.runtime),\n\t\t...Object.keys(providedSchema.runtime),\n\t])) {\n\t\truntime[key] = (documentSchemaSupportedConfigs[key] as IProperty).or(\n\t\t\tpersistedSchema.runtime[key],\n\t\t\tprovidedSchema.runtime[key],\n\t\t);\n\t}\n\n\t// We take the greater of the persisted/provided minVersionForCollab\n\tconst minVersionForCollab =\n\t\tpersistedSchema.info === undefined\n\t\t\t? providedSchema.info.minVersionForCollab\n\t\t\t: gt(persistedSchema.info.minVersionForCollab, providedSchema.info.minVersionForCollab)\n\t\t\t\t? persistedSchema.info.minVersionForCollab\n\t\t\t\t: providedSchema.info.minVersionForCollab;\n\n\treturn {\n\t\tversion: currentDocumentVersionSchema,\n\t\trefSeq: persistedSchema.refSeq,\n\t\tinfo: { minVersionForCollab },\n\t\truntime,\n\t};\n}\n\n/**\n * Determines if two schemas are the \"same\".\n * Schemas are considered **not** the same if a schema change op is required to make\n * the properties of `persistedSchema` match to the properties of `providedSchema`.\n */\nfunction same(\n\tpersistedSchema: IDocumentSchemaCurrentIncoming,\n\tprovidedSchema: IDocumentSchemaCurrent,\n): boolean {\n\tif (\n\t\tpersistedSchema.info === undefined ||\n\t\tlt(persistedSchema.info.minVersionForCollab, providedSchema.info.minVersionForCollab)\n\t) {\n\t\t// If the persisted schema's minVersionForCollab is undefined or less than the provided schema's\n\t\t// minVersionForCollab, then we should send a schema change op to update the minVersionForCollab.\n\t\treturn false;\n\t}\n\tfor (const key of new Set([\n\t\t...Object.keys(persistedSchema.runtime),\n\t\t...Object.keys(providedSchema.runtime),\n\t])) {\n\t\t// If schemas differ only by type of behavior, then we should not send schema change ops!\n\t\tif (\n\t\t\tkey !== \"explicitSchemaControl\" &&\n\t\t\tpersistedSchema.runtime[key] !== providedSchema.runtime[key]\n\t\t) {\n\t\t\treturn false;\n\t\t}\n\t}\n\treturn true;\n}\n\nfunction boolToProp(b: boolean): true | undefined {\n\treturn b ? true : undefined;\n}\n\nfunction arrayToProp(arr: string[]): string[] | undefined {\n\treturn arr.length === 0 ? undefined : arr;\n}\n\n/* eslint-disable jsdoc/check-indentation */\n\n/**\n * Controller of document schema.\n *\n * Recommended pre-reading: https://github.com/microsoft/FluidFramework/blob/main/packages/dds/SchemaVersioning.md\n *\n * This class manages current document schema and transitions between document schemas.\n * At the moment, it only focuses on subset of document schema, specifically - how FluidFramework runtime serializes data\n * (summary and op format), features & capabilities that a version of runtime has to support and understand in\n * order to collaborate on a document.\n * New features that modify document format have to be included in document schema definition.\n * Usage of such features could only happen after document schema has been updated to reflect such feature.\n *\n * This formality allows clients that do not understand such features to fail right away when they observe\n * document schema listing capabilities that such client does not understand.\n * Old clients will fail in predictable way. This allows us to\n * 1) Immediately see such issues and adjust if features are enabled too early, before changes have been saturated.\n * 2) There is no way to get to 100% saturation with new code. Even if we have 99.99% saturation, there are\n *    still 0.01% of clients who will fail. Failing early and predictably ensures they have no chance to limp along\n *    and potentially corrupt the document. This is especially true for summarizer client, who could simply \"undo\"\n *    changes it does not understands.\n *\n * It's important to note how it overlaps with feature gates and safe velocity.\n * If new feature was in use, that resulted in a number of documents referencing such feature in document schema.\n * But, developers (through code deployment or feature gates) could disable usage of such features.\n * That will stop a process of further document schema changes (for documents that were not using such feature).\n * And documents that already list such capability in their schema will continue to do so. Later ensures that old\n * clients who do not understand such feature will continue to fail to open such documents, as such documents very\n * likely contain data in a new format.\n *\n * Controller operates with 4 schemas:\n * - document schema: whatever we loaded from summary metadata + ops. It follows eventuall consistency rules (i.e. like DDS).\n * - desired schema - what client is asking for to have (i.e. all the desired settings, based on runtime options / feature gates).\n * - session schema - current session schema. It's \"and\" of the above two schemas.\n * - future schema - \"or\" of document and desires schemas.\n *\n * \"or\" & \"and\" operators are defined individually for each property. For Boolean properties it's literally &&, || operators.\n * But for other properties it's more nuanced.\n *\n * Whenver document schema does not match future schema, controller will send an op that attempts to changs documents schema to\n * future schema.\n *\n * Users of this class need to use DocumentsSchemaController.sessionSchema to determine what features can be used.\n *\n * There are two modes this class can operate:\n * 1) Legacy mode. In such mode it does not issue any ops to change document schema. Any changes happen implicitly,\n *    right away, and new features are available right away\n * 2) Non-legacy mode. In such mode any changes to schema require an op roundtrip. This class will manage such transitions.\n *    However code should assume that any new features that were not enabled in a given document will not be available\n *    for a given session. That's because this session may never send any ops (including read-only documents). Or it may\n *    fail to convert schema.\n *    This class promises eventual movement forward. I.e. if new feature is allowed (let's say - through feature gates),\n *    then eventually all documents that are modified will have that feature reflected in their schema. It could require\n *    multiple reloads / new sessions to get there (depends on if code reacts to schema changes right away, or only consults\n *    schema on document load).\n *\n * How schemas are changed (in non-legacy mode):\n * If a client needs to change a schema, it will attempt to do so as part of normal ops sending process.\n * Changes happen in CAS (Compare-and-swap) fashion, i.e. client tells current schema and schema it wants to change to.\n * When a number of clients race to change a schema, then only one of them will win, all others will fail because they will\n * reference old schema that is no longer in effect.\n * Clients can retry, but current implementation is simply - they will not (and will rely on next session / reload to do\n * recalc and decide if schema needs to be changed or not).\n *\n * @internal\n * @sealed\n */\nexport class DocumentsSchemaController {\n\tprivate explicitSchemaControl: boolean;\n\n\t/**\n\t * Have we generated a DocumentSchemaChange op and we're waiting for the ack?\n\t * This is used to ensure that we do not generate multiple schema change ops - this client should only ever send one (if any).\n\t */\n\tprivate opPending = false;\n\n\t// schema coming from document metadata (snapshot we loaded from)\n\tprivate documentSchema: IDocumentSchema;\n\n\t// desired schema, based on feature gates / runtime options.\n\t// This includes requests to enable to disable functionality\n\tprivate readonly desiredSchema: IDocumentSchemaCurrent;\n\n\t// OR() of document schema and desired schema. It enables all the features that are enabled in either of schemas.\n\tprivate futureSchema: IDocumentSchemaCurrent | undefined;\n\n\t// Current schema this session operates with.\n\t// 1) Legacy mode (explicitSchemaControl === false): this is same as desired schema - all options that were requested to be on are on, and all options requested to be off are off.\n\t// 2) Non-legacy mode (explicitSchemaControl === true): this is AND() of document schema and desired schema. Only options that are enabled in both are enabled here.\n\t//    If there are any options that are not enabled in document schema, but are enabled in desired schema, then attempt to change schema\n\t//    (and enable such options) will be made through the session.\n\tpublic sessionSchema: IDocumentSchemaCurrent;\n\n\t/**\n\t * Constructs DocumentsSchemaController that controls current schema and processes around it, including changes in schema.\n\t * @param existing - Is the document existing document, or a new doc.\n\t * @param documentMetadataSchema - current document's schema, if present.\n\t * @param features - features of the document schema that current session wants to see enabled.\n\t * @param onSchemaChange - callback that is called whenever schema is changed (not called on creation / load, only when processing document schema change ops)\n\t * @param info - Informational properties of the document that are not subject to strict schema enforcement\n\t * @param logger - telemetry logger from the runtime\n\t */\n\tconstructor(\n\t\texisting: boolean,\n\t\tsnapshotSequenceNumber: number,\n\t\tdocumentMetadataSchema: IDocumentSchema | undefined,\n\t\tfeatures: IDocumentSchemaFeatures,\n\t\tprivate readonly onSchemaChange: (schema: IDocumentSchemaCurrent) => void,\n\t\tinfo: IDocumentSchemaInfo,\n\t\tlogger: ITelemetryLoggerExt,\n\t) {\n\t\t// For simplicity, let's only support new schema features for explicit schema control mode\n\t\tassert(\n\t\t\tfeatures.disallowedVersions.length === 0 || features.explicitSchemaControl,\n\t\t\t0x949 /* not supported */,\n\t\t);\n\n\t\t// We check the document's metadata to see if there is a minVersionForCollab. If it's not an existing document or\n\t\t// if the document is older, then it won't have one. If it does have a minVersionForCollab, we check if it's greater\n\t\t// than this client's runtime version. If so, we log a telemetry event to warn the customer that the client is outdated.\n\t\t// Note: We only send a warning because we will confirm via `checkRuntimeCompatibility` if this client **can** understand\n\t\t// the existing document's schema. We still want to issue a warning regardless if this client can or cannot understand the\n\t\t// schema since it may be a sign that the customer is not properly waiting for saturation before updating their\n\t\t// `minVersionForCollab` value, which could cause disruptions to users in the future.\n\t\tconst existingMinVersionForCollab = documentMetadataSchema?.info?.minVersionForCollab;\n\t\tif (\n\t\t\texistingMinVersionForCollab !== undefined &&\n\t\t\tgt(existingMinVersionForCollab, pkgVersion) &&\n\t\t\t// We also want to avoid sending the telemetry warning for dev builds, since they currently are formatted as\n\t\t\t// `0.0.0-#####-test`. This will cause the telemetry warning to constantly fire.\n\t\t\t// TODO: This can be removed after ADO:41351\n\t\t\t!isDevBuild(pkgVersion)\n\t\t) {\n\t\t\tconst warnMsg = `WARNING: The version of Fluid Framework used by this client (${pkgVersion}) is not supported by this document! Please upgrade to version ${existingMinVersionForCollab} or later to ensure compatibility.`;\n\t\t\tlogger.sendTelemetryEvent({\n\t\t\t\teventName: \"MinVersionForCollabWarning\",\n\t\t\t\tmessage: warnMsg,\n\t\t\t});\n\t\t}\n\n\t\t// Desired schema by this session - almost all props are coming from arguments\n\t\tthis.desiredSchema = {\n\t\t\tversion: currentDocumentVersionSchema,\n\t\t\trefSeq: documentMetadataSchema?.refSeq ?? 0,\n\t\t\tinfo,\n\t\t\truntime: {\n\t\t\t\texplicitSchemaControl: boolToProp(features.explicitSchemaControl),\n\t\t\t\tcompressionLz4: boolToProp(features.compressionLz4),\n\t\t\t\tidCompressorMode: features.idCompressorMode,\n\t\t\t\topGroupingEnabled: boolToProp(features.opGroupingEnabled),\n\t\t\t\tcreateBlobPayloadPending: features.createBlobPayloadPending,\n\t\t\t\tdisallowedVersions: arrayToProp(features.disallowedVersions),\n\t\t\t},\n\t\t};\n\n\t\t// Schema coming from document metadata (snapshot we loaded from), or if no document exists\n\t\t// (this is a new document) then this is the same as desiredSchema (same as session schema in such case).\n\t\t// Latter is important sure that's what will go into summary.\n\t\tthis.documentSchema = existing\n\t\t\t? (documentMetadataSchema ??\n\t\t\t\t({\n\t\t\t\t\tversion: currentDocumentVersionSchema,\n\t\t\t\t\t// see comment in summarizeDocumentSchema() on why it has to stay zero\n\t\t\t\t\trefSeq: 0,\n\t\t\t\t\tinfo,\n\t\t\t\t\t// If it's existing document and it has no schema, then it was written by legacy client.\n\t\t\t\t\t// If it's a new document, then we define it's legacy-related behaviors.\n\t\t\t\t\truntime: {\n\t\t\t\t\t\texplicitSchemaControl: boolToProp(!existing && features.explicitSchemaControl),\n\t\t\t\t\t},\n\t\t\t\t} satisfies IDocumentSchemaCurrent))\n\t\t\t: this.desiredSchema;\n\n\t\tcheckRuntimeCompatibility(this.documentSchema, \"document\");\n\t\tthis.validateSeqNumber(this.documentSchema.refSeq, snapshotSequenceNumber, \"summary\");\n\n\t\t// Use legacy behavior only if both document and options tell us to use legacy.\n\t\t// Otherwise it's no longer legacy time!\n\t\tthis.explicitSchemaControl =\n\t\t\tthis.documentSchema.runtime.explicitSchemaControl === true ||\n\t\t\tfeatures.explicitSchemaControl;\n\n\t\t// Calculate\n\t\t// - current session schema (overlap of document schema and desired schema)\n\t\t// - future schema to propose (concatination of document schema and desired schema)\n\t\tif (!this.explicitSchemaControl || !existing) {\n\t\t\tthis.sessionSchema = this.desiredSchema;\n\t\t\tassert(\n\t\t\t\tboolToProp(this.explicitSchemaControl) ===\n\t\t\t\t\tthis.sessionSchema.runtime.explicitSchemaControl,\n\t\t\t\t0x94a /* explicitSchemaControl */,\n\t\t\t);\n\t\t\tthis.futureSchema = undefined;\n\t\t} else {\n\t\t\tthis.sessionSchema = and(this.documentSchema, this.desiredSchema);\n\t\t\tthis.futureSchema = or(this.documentSchema, this.desiredSchema);\n\t\t\tassert(this.sessionSchema.runtime.explicitSchemaControl === true, 0x94b /* legacy */);\n\t\t\tassert(this.futureSchema.runtime.explicitSchemaControl === true, 0x94c /* legacy */);\n\t\t\tif (same(this.documentSchema, this.futureSchema)) {\n\t\t\t\tthis.futureSchema = undefined;\n\t\t\t}\n\t\t}\n\n\t\t// Validate that schema we are operating in is actually a schema we consider compatible with current runtime.\n\t\tcheckRuntimeCompatibility(this.desiredSchema, \"desired\");\n\t\tcheckRuntimeCompatibility(this.sessionSchema, \"session\");\n\t\tcheckRuntimeCompatibility(this.futureSchema, \"future\");\n\t}\n\n\tpublic summarizeDocumentSchema(\n\t\trefSeq: number,\n\t): IDocumentSchema | IDocumentSchemaCurrent | undefined {\n\t\t// For legacy behavior, we could write nothing (return undefined).\n\t\t// It does not buy us anything, as whatever written in summary does not actually impact clients operating in legacy mode.\n\t\t// But writing current used config (and assuming most of the clients settle on same config over time) will help with transition\n\t\t// out of legacy mode, as clients transitioning out of it would be able to use all the\n\t\t// features that are mentioned in schema right away, without a need to go through schema transition (and thus for a session or\n\t\t// two losing ability to use all the features)\n\t\tconst schema = this.explicitSchemaControl ? this.documentSchema : this.desiredSchema;\n\n\t\t// It's important to keep refSeq at zero in legacy mode, such that transition out of it is simple and we do not have\n\t\t// race conditions. If we put any other number (including latest seq number), then we will have two clients\n\t\t// (loading from two different summaries) with different numbers, and eventual consistency will be broken as schema\n\t\t// change ops will be interpretted differently by those two clients.\n\t\tassert(\n\t\t\tthis.explicitSchemaControl || schema.refSeq === 0,\n\t\t\t0x94d /* refSeq should be zero */,\n\t\t);\n\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Called by Container runtime whenever it is about to send some op.\n\t * It gives opportunity for controller to issue its own ops - we do not want to send ops if there are no local changes in document.\n\t * Please consider note above constructor about race conditions - current design is to generate op only once in a session lifetime.\n\t * @returns Optional message to send.\n\t */\n\tpublic maybeGenerateSchemaMessage(): IDocumentSchemaChangeMessageOutgoing | undefined {\n\t\tif (this.futureSchema !== undefined && !this.opPending) {\n\t\t\tthis.opPending = true;\n\t\t\tassert(\n\t\t\t\tthis.explicitSchemaControl && this.futureSchema.runtime.explicitSchemaControl === true,\n\t\t\t\t0x94e /* not legacy */,\n\t\t\t);\n\t\t\treturn this.futureSchema;\n\t\t}\n\t}\n\n\tprivate validateSeqNumber(\n\t\tschemaSeqNumber: number,\n\t\tlastKnowSeqNumber: number,\n\t\tmessage: string,\n\t): void {\n\t\tif (!Number.isInteger(schemaSeqNumber) || !(schemaSeqNumber <= lastKnowSeqNumber)) {\n\t\t\tthrow DataProcessingError.create(\n\t\t\t\t\"DocSchema: Incorrect sequence number\",\n\t\t\t\t\"checkRuntimeCompat3\",\n\t\t\t\tundefined, // message\n\t\t\t\t{\n\t\t\t\t\tschemaSeqNumber,\n\t\t\t\t\tsequenceNumber: lastKnowSeqNumber,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Process document schema change messages\n\t * Called by ContainerRuntime whenever it sees document schema messages.\n\t * @param contents - contents of the messages\n\t * @param local - whether op is local\n\t * @param sequenceNumber - sequence number of the op\n\t * @returns - true if schema was accepted, otherwise false (rejected due to failed CAS)\n\t */\n\tpublic processDocumentSchemaMessages(\n\t\tcontents: IDocumentSchemaChangeMessageIncoming[],\n\t\tlocal: boolean,\n\t\tsequenceNumber: number,\n\t): boolean {\n\t\tfor (const content of contents) {\n\t\t\tthis.validateSeqNumber(content.refSeq, this.documentSchema.refSeq, \"content.refSeq\");\n\t\t\tthis.validateSeqNumber(this.documentSchema.refSeq, sequenceNumber, \"refSeq\");\n\t\t\t// validate is strickly less, not equal\n\t\t\tassert(\n\t\t\t\tthis.documentSchema.refSeq < sequenceNumber,\n\t\t\t\t0x950 /* time should move forward only! */,\n\t\t\t);\n\n\t\t\tif (content.refSeq !== this.documentSchema.refSeq) {\n\t\t\t\t// CAS failed\n\t\t\t\treturn false;\n\t\t\t}\n\n\t\t\t// This assert should be after checking for successful CAS above.\n\t\t\t// This will ensure we do not trip on our own messages that are no longer wanted as we processed someone else schema change message.\n\t\t\tassert(\n\t\t\t\t!local || (this.explicitSchemaControl && this.futureSchema !== undefined),\n\t\t\t\t0x951 /* not sending ops */,\n\t\t\t);\n\n\t\t\t// Changes are in effect. Immediately check that this client understands these changes\n\t\t\tcheckRuntimeCompatibility(content, \"change\");\n\t\t\tconst schema = {\n\t\t\t\t...content,\n\t\t\t\trefSeq: sequenceNumber,\n\t\t\t} satisfies IDocumentSchemaCurrentIncoming;\n\t\t\tthis.documentSchema = schema;\n\t\t\tthis.sessionSchema = and(schema, this.desiredSchema);\n\t\t\tassert(this.sessionSchema.refSeq === sequenceNumber, 0x97d /* seq# */);\n\n\t\t\t// legacy behavior is automatically off for the document once someone sends a schema op -\n\t\t\t// from now on it's fully controlled by ops.\n\t\t\t// This is very important, as summarizeDocumentSchema() should use this new schema!\n\t\t\tthis.explicitSchemaControl = true;\n\n\t\t\t// Stop attempting changing schema.\n\t\t\t// If it was local op, then we succeeded and do not need to try again.\n\t\t\t// If it was remote op, then some changes happened to schema.\n\t\t\t// We would need to recalculate this.futureSchema by merging changes that we just received.\n\t\t\t// Avoid this complexity for now - a new client session (loading from new summary with these changes)\n\t\t\t// will automatically do this recalculation and will figure out\n\t\t\tthis.futureSchema = undefined;\n\n\t\t\tthis.onSchemaChange(this.sessionSchema);\n\t\t}\n\t\treturn true;\n\t}\n\n\t/**\n\t * Indicates the pending op was not ack'd and we may try to send it again if needed.\n\t */\n\tpublic pendingOpNotAcked(): void {\n\t\tthis.opPending = false;\n\t}\n}\n\n/**\n * Determines if a given version is a dev-build (i.e. `0.0.0-#####-test`).\n */\nfunction isDevBuild(version: string): boolean {\n\tconst parsed = parse(version);\n\treturn parsed?.prerelease.includes(\"test\") ?? false;\n}\n\n/* eslint-enable jsdoc/check-indentation */\n"]}
+{"version":3,"file":"documentSchema.js","sourceRoot":"","sources":["../../src/summary/documentSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAG7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAC/E,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAwJlD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAsC9C,MAAM,eAAe;IACb,GAAG,CAAC,eAAsB,EAAE,cAAqB;QACvD,OAAO,eAAe,KAAK,IAAI,IAAI,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,CAAC;IAEM,EAAE,CAAC,eAAsB,EAAE,cAAqB;QACtD,OAAO,eAAe,KAAK,IAAI,IAAI,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,CAAC;IAEM,QAAQ,CAAC,CAAU;QACzB,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC;IACtC,CAAC;CACD;AAED,MAAM,kBAAmB,SAAQ,eAAe;IACxC,GAAG,CAAC,eAAsB,EAAE,cAAqB;QACvD,OAAO,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;CACD;AAED,MAAM,WAAW;IAChB,YAA6B,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;IAAG,CAAC;IAE3C,GAAG,CAAC,eAAwB,EAAE,cAAuB;QAC3D,IAAI,eAAe,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACnE,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CACrF,CAAC;IACH,CAAC;IAEM,EAAE,CAAC,eAAwB,EAAE,cAAuB;QAC1D,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,cAAc,CAAC;QACvB,CAAC;QACD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,eAAe,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CACrF,CAAC;IACH,CAAC;IAEM,QAAQ,CAAC,CAAU;QACzB,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/E,CAAC;CACD;AAED,MAAM,oBAAqB,SAAQ,WAAW;IAC7C,+BAA+B;IACxB,GAAG,CAAC,eAAwB,EAAE,cAAuB;QAC3D,OAAO,eAAe,CAAC;IACxB,CAAC;CACD;AAED,MAAM,aAAa;IACX,EAAE,CACR,kBAA4B,EAAE,EAC9B,iBAA2B,EAAE;QAE7B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,eAAe,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC;QACrE,OAAO,WAAW,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,iDAAiD;IAC1C,GAAG,CACT,kBAA4B,EAAE,EAC9B,iBAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAEM,QAAQ,CAAC,CAAU;QACzB,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;IACzE,CAAC;CACD;AAED;;GAEG;AACH,MAAM,8BAA8B,GAAG;IACtC,qBAAqB,EAAE,IAAI,kBAAkB,EAAE,EAAE,0CAA0C;IAC3F,gBAAgB,EAAE,IAAI,oBAAoB,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC7D,iBAAiB,EAAE,IAAI,eAAe,EAAE;IACxC,cAAc,EAAE,IAAI,eAAe,EAAE;IACrC,wBAAwB,EAAE,IAAI,eAAe,EAAE;IAC/C,kBAAkB,EAAE,IAAI,aAAa,EAAE;CACvC,CAAC;AAEF;;;;GAIG;AACH,SAAS,yBAAyB,CACjC,cAA2C,EAC3C,UAAkB;IAElB,6DAA6D;IAC7D,gHAAgH;IAChH,mCAAmC;IACnC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO;IACR,CAAC;IAED,MAAM,GAAG,GAAG,2DAA2D,CAAC;IACxE,IAAI,cAAc,CAAC,OAAO,KAAK,4BAA4B,EAAE,CAAC;QAC7D,MAAM,mBAAmB,CAAC,MAAM,CAC/B,GAAG,EACH,qBAAqB,EACrB,SAAS,EAAE,UAAU;QACrB;YACC,oBAAoB,EAAE,cAAc,CAAC,OAAO;YAC5C,2BAA2B,EAAE,4BAA4B;YACzD,UAAU;SACV,CACD,CAAC;IACH,CAAC;IAED,IAAI,eAAmC,CAAC;IAExC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;IACrC,iHAAiH;IACjH,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,eAAe,GAAG,QAAQ,CAAC;IAC5B,CAAC;SAAM,IAAI,cAAc,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC1F,eAAe,GAAG,SAAS,CAAC;IAC7B,CAAC;SAAM,CAAC;QACP,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YACpE,MAAM,SAAS,GAAG,8BAA8B,CAAC,IAAI,CAA0B,CAAC;YAChF,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBAC5C,eAAe,GAAG,WAAW,IAAI,EAAE,CAAC;YACrC,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACnC,mEAAmE;QACnE,MAAM,KAAK,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;QAC9C,MAAM,mBAAmB,CAAC,MAAM,CAC/B,GAAG,EACH,qBAAqB,EACrB,SAAS,EAAE,UAAU;QACrB;YACC,WAAW,EAAE,4BAA4B;YACzC,QAAQ,EAAE,eAAe;YACzB,mEAAmE;YACnE,KAAK;YACL,UAAU;SACV,CACD,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,GAAG,CACX,eAA+C,EAC/C,cAAsC;IAEtC,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,IAAI,GAAG,CAAC;QACzB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;QACvC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;KACtC,CAAC,EAAE,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,GAAI,8BAA8B,CAAC,GAAG,CAAe,CAAC,GAAG,CACpE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,EAC5B,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAC3B,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,aAAa;IACb,MAAM,mBAAmB,GACxB,eAAe,CAAC,IAAI,EAAE,mBAAmB,IAAI,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAEtF,OAAO;QACN,OAAO,EAAE,4BAA4B;QACrC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,IAAI,EAAE,EAAE,mBAAmB,EAAE;QAC7B,OAAO;KACP,CAAC;AACH,CAAC;AAED,SAAS,EAAE,CACV,eAA+C,EAC/C,cAAsC;IAEtC,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,IAAI,GAAG,CAAC;QACzB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;QACvC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;KACtC,CAAC,EAAE,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,GAAI,8BAA8B,CAAC,GAAG,CAAe,CAAC,EAAE,CACnE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,EAC5B,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAC3B,CAAC;IACH,CAAC;IAED,oEAAoE;IACpE,MAAM,mBAAmB,GACxB,eAAe,CAAC,IAAI,KAAK,SAAS;QACjC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB;QACzC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC;YACtF,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAmB;YAC1C,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAE7C,OAAO;QACN,OAAO,EAAE,4BAA4B;QACrC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,IAAI,EAAE,EAAE,mBAAmB,EAAE;QAC7B,OAAO;KACP,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,IAAI,CACZ,eAA+C,EAC/C,cAAsC;IAEtC,IACC,eAAe,CAAC,IAAI,KAAK,SAAS;QAClC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC,EACpF,CAAC;QACF,gGAAgG;QAChG,iGAAiG;QACjG,OAAO,KAAK,CAAC;IACd,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,IAAI,GAAG,CAAC;QACzB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;QACvC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;KACtC,CAAC,EAAE,CAAC;QACJ,yFAAyF;QACzF,IACC,GAAG,KAAK,uBAAuB;YAC/B,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAC3D,CAAC;YACF,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,WAAW,CAAC,GAAa;IACjC,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,OAAO,yBAAyB;IA0BrC;;;;;;;;OAQG;IACH,YACC,QAAiB,EACjB,sBAA8B,EAC9B,sBAAmD,EACnD,QAAiC,EAChB,cAAwD,EACzE,IAAyB,EACzB,MAA2B;QAFV,mBAAc,GAAd,cAAc,CAA0C;QArC1E;;;WAGG;QACK,cAAS,GAAG,KAAK,CAAC;QAqCzB,0FAA0F;QAC1F,MAAM,CACL,QAAQ,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAC1E,KAAK,CAAC,mBAAmB,CACzB,CAAC;QAEF,iHAAiH;QACjH,oHAAoH;QACpH,wHAAwH;QACxH,yHAAyH;QACzH,0HAA0H;QAC1H,+GAA+G;QAC/G,qFAAqF;QACrF,MAAM,2BAA2B,GAAG,sBAAsB,EAAE,IAAI,EAAE,mBAAmB,CAAC;QACtF,IACC,2BAA2B,KAAK,SAAS;YACzC,EAAE,CAAC,2BAA2B,EAAE,UAAU,CAAC;YAC3C,4GAA4G;YAC5G,gFAAgF;YAChF,4CAA4C;YAC5C,CAAC,UAAU,CAAC,UAAU,CAAC,EACtB,CAAC;YACF,MAAM,OAAO,GAAG,gEAAgE,UAAU,kEAAkE,2BAA2B,oCAAoC,CAAC;YAC5N,MAAM,CAAC,kBAAkB,CAAC;gBACzB,SAAS,EAAE,4BAA4B;gBACvC,OAAO,EAAE,OAAO;aAChB,CAAC,CAAC;QACJ,CAAC;QAED,8EAA8E;QAC9E,IAAI,CAAC,aAAa,GAAG;YACpB,OAAO,EAAE,4BAA4B;YACrC,MAAM,EAAE,sBAAsB,EAAE,MAAM,IAAI,CAAC;YAC3C,IAAI;YACJ,OAAO,EAAE;gBACR,qBAAqB,EAAE,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC;gBACjE,cAAc,EAAE,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC;gBACnD,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;gBAC3C,iBAAiB,EAAE,UAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBACzD,wBAAwB,EAAE,QAAQ,CAAC,wBAAwB;gBAC3D,kBAAkB,EAAE,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;aAC5D;SACD,CAAC;QAEF,2FAA2F;QAC3F,yGAAyG;QACzG,6DAA6D;QAC7D,IAAI,CAAC,cAAc,GAAG,QAAQ;YAC7B,CAAC,CAAC,CAAC,sBAAsB;gBACxB,CAAC;oBACA,OAAO,EAAE,4BAA4B;oBACrC,sEAAsE;oBACtE,MAAM,EAAE,CAAC;oBACT,IAAI;oBACJ,wFAAwF;oBACxF,wEAAwE;oBACxE,OAAO,EAAE;wBACR,qBAAqB,EAAE,UAAU,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,qBAAqB,CAAC;qBAC9E;iBACgC,CAAC,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAEtB,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAC;QAEtF,+EAA+E;QAC/E,wCAAwC;QACxC,IAAI,CAAC,qBAAqB;YACzB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI;gBAC1D,QAAQ,CAAC,qBAAqB,CAAC;QAEhC,YAAY;QACZ,2EAA2E;QAC3E,mFAAmF;QACnF,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YACxC,MAAM,CACL,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC;gBACrC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,qBAAqB,EACjD,KAAK,CAAC,2BAA2B,CACjC,CAAC;YACF,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC/B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAClE,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;YACtF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;YACrF,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;YAC/B,CAAC;QACF,CAAC;QAED,6GAA6G;QAC7G,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACzD,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACzD,yBAAyB,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,uBAAuB,CAC7B,MAAc;QAEd,kEAAkE;QAClE,yHAAyH;QACzH,+HAA+H;QAC/H,sFAAsF;QACtF,8HAA8H;QAC9H,8CAA8C;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAErF,oHAAoH;QACpH,2GAA2G;QAC3G,mHAAmH;QACnH,oEAAoE;QACpE,MAAM,CACL,IAAI,CAAC,qBAAqB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EACjD,KAAK,CAAC,2BAA2B,CACjC,CAAC;QAEF,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,0BAA0B;QAChC,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACxD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,MAAM,CACL,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,EACtF,KAAK,CAAC,gBAAgB,CACtB,CAAC;YACF,OAAO,IAAI,CAAC,YAAY,CAAC;QAC1B,CAAC;IACF,CAAC;IAEO,iBAAiB,CACxB,eAAuB,EACvB,iBAAyB,EACzB,OAAe;QAEf,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,eAAe,IAAI,iBAAiB,CAAC,EAAE,CAAC;YACnF,MAAM,mBAAmB,CAAC,MAAM,CAC/B,sCAAsC,EACtC,qBAAqB,EACrB,SAAS,EAAE,UAAU;YACrB;gBACC,eAAe;gBACf,cAAc,EAAE,iBAAiB;gBACjC,OAAO;aACP,CACD,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,6BAA6B,CACnC,QAAgD,EAChD,KAAc,EACd,cAAsB;QAEtB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YACrF,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;YAC7E,uCAAuC;YACvC,MAAM,CACL,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,cAAc,EAC3C,KAAK,CAAC,oCAAoC,CAC1C,CAAC;YAEF,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBACnD,aAAa;gBACb,OAAO,KAAK,CAAC;YACd,CAAC;YAED,iEAAiE;YACjE,oIAAoI;YACpI,MAAM,CACL,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,EACzE,KAAK,CAAC,qBAAqB,CAC3B,CAAC;YAEF,sFAAsF;YACtF,yBAAyB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG;gBACd,GAAG,OAAO;gBACV,MAAM,EAAE,cAAc;aACmB,CAAC;YAC3C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;YAC7B,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,KAAK,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;YAEvE,yFAAyF;YACzF,4CAA4C;YAC5C,mFAAmF;YACnF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;YAElC,mCAAmC;YACnC,sEAAsE;YACtE,6DAA6D;YAC7D,2FAA2F;YAC3F,qGAAqG;YACrG,+DAA+D;YAC/D,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;YAE9B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,iBAAiB;QACvB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACxB,CAAC;CACD;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,OAAe;IAClC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9B,OAAO,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;AACrD,CAAC;AAED,2CAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { SemanticVersion } from \"@fluidframework/runtime-utils/internal\";\nimport type { ITelemetryLoggerExt } from \"@fluidframework/telemetry-utils/internal\";\nimport { DataProcessingError } from \"@fluidframework/telemetry-utils/internal\";\nimport { gt, lt, parse } from \"semver-ts\";\n\nimport { pkgVersion } from \"../packageVersion.js\";\n\n/**\n * Descripe allowed type for properties in document schema.\n * Please note that for all property types we should use undefined to indicate that particular capability is off.\n * Using false, or some string value (like \"off\") will result in clients who do not understand that property failing, whereas\n * we want them to continue to collaborate alongside clients who support that capability, but such capability is shipping dark for now.\n * @internal\n */\nexport type DocumentSchemaValueType = string | string[] | true | number | undefined;\n\n/**\n * ID Compressor mode.\n * \"on\" - compressor is On. It's loaded as part of container load. This mode is sticky - once on, compressor is On for all\n * sessions for a given document. This results in IContainerRuntime.idCompressor to be always available.\n * \"delayed\" - ID compressor bundle is loaded only on establishing of first delta connection, i.e. it does not impact boot of cotnainer.\n * In such mode IContainerRuntime.idCompressor is not made available (unless previous sessions of same document had it \"On\").\n * The only thing that is available is IContainerRuntime.generateDocumentUniqueId() that provides opportunistically short IDs.\n * undefined - ID compressor is not loaded.\n * While IContainerRuntime.generateDocumentUniqueId() is available, it will produce long IDs that are do not compress well.\n *\n * @legacy @beta\n */\nexport type IdCompressorMode = \"on\" | \"delayed\" | undefined;\n\n/**\n * Document schema information.\n * Describes overall shape of document schema, including unknown (to this version) properties.\n *\n * Used by runtime to make a call if it can understand document schema.\n * If it can't, it should not continue with document and immediately fail, preventing random (cryptic) failures\n * down the road and potentially corrupting documents.\n * For now this structure and appropriate interpretation / behavior is focused only on runtime features.\n * In the future that could be interpolated to more areas, including DDSs used, and even possibly - application\n * schema.\n *\n * Runtime will ignore any properties at the root that it does not understand (i.e. IDocumentSchema.app), but will\n * stop (and fail session) on any unknown properties within \"runtime\" sub-tree.\n *\n * In most cases values preserved in the document will not dictate if such features should be enabled in a given session.\n * I.e. if compression is mentioned in document schema, this means that runtime version that opens such document must know\n * how to interpret such ops, but does not need to actually use compression itself. That said, some options could be\n * sticky, i.e. influence feature selection for all runtimes opening a document. ID compression is one such example.\n * Currently there is no mechanism to remove feature from this property bag, i.e. once compression was used, even if it's\n * disabled (through feature gate or code deployment), all existing documents that used compression will continue to fail\n * if opened by clients who do not support compression.\n *\n * For now we are limiting it to just plain properties, and only really simple types, but that can be changed in the future.\n *\n * @internal\n */\nexport interface IDocumentSchema {\n\t// Note: Incoming schemas from other clients may have additional root-level properties (i.e. IDocumentSchema.app)\n\t// that this client does not understand. The runtime will ignore these properties, unless they are within the\n\t// \"runtime\" sub-tree, in which case it will fail if it is unable to understand any runtime properties.\n\n\t/**\n\t * Describes how data needed to understand the schema is stored in this structure.\n\t * If runtime sees a version it does not understand, it should immediately fail and not\n\t * attempt to interpret any further data.\n\t */\n\tversion: number;\n\n\t/**\n\t * Sequence number when this schema became active.\n\t */\n\trefSeq: number;\n\n\t/**\n\t * Runtime configurations that affect the document schema. Other clients must understand these\n\t * properties to be able to open the document.\n\t */\n\truntime: Record<string, DocumentSchemaValueType>;\n\n\t/**\n\t * Info about this document that can be updated via Document Schema change op, but isn't required\n\t * to be understood by all clients (unlike the rest of IDocumentSchema properties). Because of this,\n\t * some older documents may not have this property, so it's an optional property.\n\t */\n\tinfo?: IDocumentSchemaInfo;\n}\n\n/**\n * Informational properties of the document that are not subject to strict schema enforcement.\n *\n * @internal\n */\nexport interface IDocumentSchemaInfo {\n\t/**\n\t * The minimum version of the FF runtime that should be used to load this document.\n\t * Will likely be advanced over time as applications pick up later FF versions.\n\t *\n\t * We use this to issue telemetry warning events if a client tries to open a document\n\t * with a runtime version lower than this.\n\t *\n\t * See {@link @fluidframework/container-runtime#LoadContainerRuntimeParams} for additional details on `minVersionForCollab`.\n\t *\n\t * @remarks\n\t * We use `SemanticVersion` instead of `MinimumVersionForCollab` since we may open future documents that with a\n\t * minVersionForCollab version that `MinimumVersionForCollab` does not support.\n\t */\n\tminVersionForCollab: SemanticVersion;\n}\n\n/**\n * Content of the type=ContainerMessageType.DocumentSchemaChange ops.\n * The meaning of refSeq field is different in such messages (compared to other usages of IDocumentSchemaCurrent)\n * ContainerMessageType.DocumentSchemaChange messages use CAS (Compare-and-swap) semantics, and convey\n * regSeq of last known schema change (known to a client proposing schema change).\n * @see InboundContainerRuntimeDocumentSchemaMessage\n * @internal\n */\nexport type IDocumentSchemaChangeMessageIncoming = IDocumentSchema;\n\n/**\n * Similar to {@link IDocumentSchemaChangeMessageIncoming}, but used for outgoing schema messages.\n * @see OutboundContainerRuntimeDocumentSchemaMessage\n * @internal\n */\nexport type IDocumentSchemaChangeMessageOutgoing = IDocumentSchemaCurrent;\n\n/**\n * Settings that this session would like to have, based on options and feature gates.\n *\n * WARNING: This type is used to infer IDocumentSchemaCurrent type!\n * Any changes here (including renaming of properties) are potentially changing document format and should be considered carefully!\n *\n * @internal\n */\nexport interface IDocumentSchemaFeatures {\n\t// Tells if client uses legacy behavior of changing schema.\n\t// - Legacy behavior - changing schema without leveraging schema change ops.\n\t// - New behavior - changes in schema require ops and take into affect with delay.\n\texplicitSchemaControl: boolean;\n\tcompressionLz4: boolean;\n\tidCompressorMode: IdCompressorMode;\n\topGroupingEnabled: boolean;\n\tcreateBlobPayloadPending: true | undefined;\n\n\t/**\n\t * List of disallowed versions of the runtime.\n\t * This option is sticky. Once a version of runtime is added to this list (when supplied to DocumentsSchemaController's constructor)\n\t * it will be added to the list of disallowed versions and stored in document metadata.\n\t * Each runtime checks if its version is in this list on container open. If it is, it immediately exits with error message\n\t * indicating to the user that this version is no longer supported.\n\t * Currently there is no mechanism to remove version from this list. I.e. If it was once added to the list,\n\t * it gets added to any document metadata (documents that gets open by this runtime) and there is no way to clear it from document's\n\t * metadata.\n\t */\n\tdisallowedVersions: string[];\n}\n\n/**\n * Current version known properties that define document schema\n * This must be bumped whenever the format of document schema or protocol for changing the current document schema changes\n * in a way that all old/new clients are required to understand.\n * Ex: Adding a new configuration property (under IDocumentSchema.runtime) does not require changing this version since there is logic\n * in old clients for handling new/unknown properties.\n * Ex: Adding a new property to IDocumentSchema.info does not require changing this version, since info properties are not required to be\n * understood by all clients.\n * Ex: Changing the 'document schema acceptance' mechanism from convert-and-swap to one requiring consensus does require changing this version\n * since all clients need to understand the new protocol.\n * @internal\n */\nexport const currentDocumentVersionSchema = 1;\n\n/**\n * Current document schema.\n * This interface represents the schema that we currently understand and know the\n * structure of (which properties will be present).\n *\n * @internal\n */\nexport interface IDocumentSchemaCurrent extends Required<IDocumentSchema> {\n\t// This is the version of the schema that we currently understand.\n\tversion: typeof currentDocumentVersionSchema;\n\t// This narrows the runtime property to only include the properties in IDocumentSchemaFeatures (all as optional)\n\truntime: {\n\t\t[P in keyof IDocumentSchemaFeatures]?: IDocumentSchemaFeatures[P] extends boolean\n\t\t\t? true\n\t\t\t: IDocumentSchemaFeatures[P];\n\t};\n}\n\n/**\n * Document schema that is incoming from another client but validated to be \"current\".\n *\n * This interface represents when we have validated that an incoming IDocumentSchema object\n * is compatible with the current runtime (by calling `checkRuntimeCompatibility()`).\n * However, the `info` property is optional because some older documents may not have this property, but\n * `info` is not required to be understood by all clients to be compatible.\n */\ninterface IDocumentSchemaCurrentIncoming extends Omit<IDocumentSchemaCurrent, \"info\"> {\n\tinfo?: IDocumentSchemaInfo;\n}\n\ninterface IProperty<T = unknown> {\n\tand: (persistedSchema: T, providedSchema: T) => T;\n\tor: (persistedSchema: T, providedSchema: T) => T;\n\tvalidate(t: unknown): boolean;\n}\n\nclass TrueOrUndefined implements IProperty<true | undefined> {\n\tpublic and(persistedSchema?: true, providedSchema?: true): true | undefined {\n\t\treturn persistedSchema === true && providedSchema === true ? true : undefined;\n\t}\n\n\tpublic or(persistedSchema?: true, providedSchema?: true): true | undefined {\n\t\treturn persistedSchema === true || providedSchema === true ? true : undefined;\n\t}\n\n\tpublic validate(t: unknown): t is true | undefined {\n\t\treturn t === undefined || t === true;\n\t}\n}\n\nclass TrueOrUndefinedMax extends TrueOrUndefined {\n\tpublic and(persistedSchema?: true, providedSchema?: true): true | undefined {\n\t\treturn this.or(persistedSchema, providedSchema);\n\t}\n}\n\nclass MultiChoice implements IProperty<string | undefined> {\n\tconstructor(private readonly choices: string[]) {}\n\n\tpublic and(persistedSchema?: string, providedSchema?: string): string | undefined {\n\t\tif (persistedSchema === undefined || providedSchema === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn this.choices[\n\t\t\tMath.min(this.choices.indexOf(persistedSchema), this.choices.indexOf(providedSchema))\n\t\t];\n\t}\n\n\tpublic or(persistedSchema?: string, providedSchema?: string): string | undefined {\n\t\tif (persistedSchema === undefined) {\n\t\t\treturn providedSchema;\n\t\t}\n\t\tif (providedSchema === undefined) {\n\t\t\treturn persistedSchema;\n\t\t}\n\t\treturn this.choices[\n\t\t\tMath.max(this.choices.indexOf(persistedSchema), this.choices.indexOf(providedSchema))\n\t\t];\n\t}\n\n\tpublic validate(t: unknown): boolean {\n\t\treturn t === undefined || (typeof t === \"string\" && this.choices.includes(t));\n\t}\n}\n\nclass IdCompressorProperty extends MultiChoice {\n\t// document schema always wins!\n\tpublic and(persistedSchema?: string, providedSchema?: string): string | undefined {\n\t\treturn persistedSchema;\n\t}\n}\n\nclass CheckVersions implements IProperty<string[] | undefined> {\n\tpublic or(\n\t\tpersistedSchema: string[] = [],\n\t\tprovidedSchema: string[] = [],\n\t): string[] | undefined {\n\t\tconst set = new Set<string>([...persistedSchema, ...providedSchema]);\n\t\treturn arrayToProp([...set.values()]);\n\t}\n\n\t// Once version is there, it stays there forever.\n\tpublic and(\n\t\tpersistedSchema: string[] = [],\n\t\tprovidedSchema: string[] = [],\n\t): string[] | undefined {\n\t\treturn this.or(persistedSchema, providedSchema);\n\t}\n\n\tpublic validate(t: unknown): boolean {\n\t\treturn t === undefined || (Array.isArray(t) && !t.includes(pkgVersion));\n\t}\n}\n\n/**\n * Helper structure to valida if a schema is compatible with existing code.\n */\nconst documentSchemaSupportedConfigs = {\n\texplicitSchemaControl: new TrueOrUndefinedMax(), // once new behavior shows up, it's sticky\n\tidCompressorMode: new IdCompressorProperty([\"delayed\", \"on\"]),\n\topGroupingEnabled: new TrueOrUndefined(),\n\tcompressionLz4: new TrueOrUndefined(),\n\tcreateBlobPayloadPending: new TrueOrUndefined(),\n\tdisallowedVersions: new CheckVersions(),\n};\n\n/**\n * Checks if a given schema is compatible with current code, i.e. if current code can understand all the features of that schema.\n * If schema is not compatible with current code, it throws an exception.\n * @param documentSchema - current schema\n */\nfunction checkRuntimeCompatibility(\n\tdocumentSchema: IDocumentSchema | undefined,\n\tschemaName: string,\n): asserts documentSchema is IDocumentSchemaCurrentIncoming {\n\t// Back-compat - we can't do anything about legacy documents.\n\t// There is no way to validate them, so we are taking a guess that safe deployment processes used by a given app\n\t// do not run into compat problems.\n\tif (documentSchema === undefined) {\n\t\treturn;\n\t}\n\n\tconst msg = \"Document can't be opened with current version of the code\";\n\tif (documentSchema.version !== currentDocumentVersionSchema) {\n\t\tthrow DataProcessingError.create(\n\t\t\tmsg,\n\t\t\t\"checkRuntimeCompat1\",\n\t\t\tundefined, // message\n\t\t\t{\n\t\t\t\truntimeSchemaVersion: documentSchema.version,\n\t\t\t\tcurrentRuntimeSchemaVersion: currentDocumentVersionSchema,\n\t\t\t\tschemaName,\n\t\t\t},\n\t\t);\n\t}\n\n\tlet unknownProperty: string | undefined;\n\n\tconst regSeq = documentSchema.refSeq;\n\t// defence in depth - it should not be possible to get here anything other than integer, but worth validating it.\n\tif (typeof regSeq !== \"number\" || regSeq < 0 || !Number.isInteger(regSeq)) {\n\t\tunknownProperty = \"refSeq\";\n\t} else if (documentSchema.runtime === null || typeof documentSchema.runtime !== \"object\") {\n\t\tunknownProperty = \"runtime\";\n\t} else {\n\t\tfor (const [name, value] of Object.entries(documentSchema.runtime)) {\n\t\t\tconst validator = documentSchemaSupportedConfigs[name] as IProperty | undefined;\n\t\t\tif (!(validator?.validate(value) ?? false)) {\n\t\t\t\tunknownProperty = `runtime/${name}`;\n\t\t\t}\n\t\t}\n\t}\n\n\tif (unknownProperty !== undefined) {\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\tconst value = documentSchema[unknownProperty];\n\t\tthrow DataProcessingError.create(\n\t\t\tmsg,\n\t\t\t\"checkRuntimeCompat2\",\n\t\t\tundefined, // message\n\t\t\t{\n\t\t\t\tcodeVersion: currentDocumentVersionSchema,\n\t\t\t\tproperty: unknownProperty,\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\t\tvalue,\n\t\t\t\tschemaName,\n\t\t\t},\n\t\t);\n\t}\n}\n\nfunction and(\n\tpersistedSchema: IDocumentSchemaCurrentIncoming,\n\tprovidedSchema: IDocumentSchemaCurrent,\n): IDocumentSchemaCurrent {\n\tconst runtime = {};\n\tfor (const key of new Set([\n\t\t...Object.keys(persistedSchema.runtime),\n\t\t...Object.keys(providedSchema.runtime),\n\t])) {\n\t\truntime[key] = (documentSchemaSupportedConfigs[key] as IProperty).and(\n\t\t\tpersistedSchema.runtime[key],\n\t\t\tprovidedSchema.runtime[key],\n\t\t);\n\t}\n\n\t// We keep the persisted minVersionForCollab if present, even if the provided minVersionForCollab\n\t// is higher.\n\tconst minVersionForCollab =\n\t\tpersistedSchema.info?.minVersionForCollab ?? providedSchema.info.minVersionForCollab;\n\n\treturn {\n\t\tversion: currentDocumentVersionSchema,\n\t\trefSeq: persistedSchema.refSeq,\n\t\tinfo: { minVersionForCollab },\n\t\truntime,\n\t};\n}\n\nfunction or(\n\tpersistedSchema: IDocumentSchemaCurrentIncoming,\n\tprovidedSchema: IDocumentSchemaCurrent,\n): IDocumentSchemaCurrent {\n\tconst runtime = {};\n\tfor (const key of new Set([\n\t\t...Object.keys(persistedSchema.runtime),\n\t\t...Object.keys(providedSchema.runtime),\n\t])) {\n\t\truntime[key] = (documentSchemaSupportedConfigs[key] as IProperty).or(\n\t\t\tpersistedSchema.runtime[key],\n\t\t\tprovidedSchema.runtime[key],\n\t\t);\n\t}\n\n\t// We take the greater of the persisted/provided minVersionForCollab\n\tconst minVersionForCollab =\n\t\tpersistedSchema.info === undefined\n\t\t\t? providedSchema.info.minVersionForCollab\n\t\t\t: gt(persistedSchema.info.minVersionForCollab, providedSchema.info.minVersionForCollab)\n\t\t\t\t? persistedSchema.info.minVersionForCollab\n\t\t\t\t: providedSchema.info.minVersionForCollab;\n\n\treturn {\n\t\tversion: currentDocumentVersionSchema,\n\t\trefSeq: persistedSchema.refSeq,\n\t\tinfo: { minVersionForCollab },\n\t\truntime,\n\t};\n}\n\n/**\n * Determines if two schemas are the \"same\".\n * Schemas are considered **not** the same if a schema change op is required to make\n * the properties of `persistedSchema` match to the properties of `providedSchema`.\n */\nfunction same(\n\tpersistedSchema: IDocumentSchemaCurrentIncoming,\n\tprovidedSchema: IDocumentSchemaCurrent,\n): boolean {\n\tif (\n\t\tpersistedSchema.info === undefined ||\n\t\tlt(persistedSchema.info.minVersionForCollab, providedSchema.info.minVersionForCollab)\n\t) {\n\t\t// If the persisted schema's minVersionForCollab is undefined or less than the provided schema's\n\t\t// minVersionForCollab, then we should send a schema change op to update the minVersionForCollab.\n\t\treturn false;\n\t}\n\tfor (const key of new Set([\n\t\t...Object.keys(persistedSchema.runtime),\n\t\t...Object.keys(providedSchema.runtime),\n\t])) {\n\t\t// If schemas differ only by type of behavior, then we should not send schema change ops!\n\t\tif (\n\t\t\tkey !== \"explicitSchemaControl\" &&\n\t\t\tpersistedSchema.runtime[key] !== providedSchema.runtime[key]\n\t\t) {\n\t\t\treturn false;\n\t\t}\n\t}\n\treturn true;\n}\n\nfunction boolToProp(b: boolean): true | undefined {\n\treturn b ? true : undefined;\n}\n\nfunction arrayToProp(arr: string[]): string[] | undefined {\n\treturn arr.length === 0 ? undefined : arr;\n}\n\n/* eslint-disable jsdoc/check-indentation */\n\n/**\n * Controller of document schema.\n *\n * Recommended pre-reading: https://github.com/microsoft/FluidFramework/blob/main/packages/dds/SchemaVersioning.md\n *\n * This class manages current document schema and transitions between document schemas.\n * At the moment, it only focuses on subset of document schema, specifically - how FluidFramework runtime serializes data\n * (summary and op format), features & capabilities that a version of runtime has to support and understand in\n * order to collaborate on a document.\n * New features that modify document format have to be included in document schema definition.\n * Usage of such features could only happen after document schema has been updated to reflect such feature.\n *\n * This formality allows clients that do not understand such features to fail right away when they observe\n * document schema listing capabilities that such client does not understand.\n * Old clients will fail in predictable way. This allows us to\n * 1) Immediately see such issues and adjust if features are enabled too early, before changes have been saturated.\n * 2) There is no way to get to 100% saturation with new code. Even if we have 99.99% saturation, there are\n *    still 0.01% of clients who will fail. Failing early and predictably ensures they have no chance to limp along\n *    and potentially corrupt the document. This is especially true for summarizer client, who could simply \"undo\"\n *    changes it does not understands.\n *\n * It's important to note how it overlaps with feature gates and safe velocity.\n * If new feature was in use, that resulted in a number of documents referencing such feature in document schema.\n * But, developers (through code deployment or feature gates) could disable usage of such features.\n * That will stop a process of further document schema changes (for documents that were not using such feature).\n * And documents that already list such capability in their schema will continue to do so. Later ensures that old\n * clients who do not understand such feature will continue to fail to open such documents, as such documents very\n * likely contain data in a new format.\n *\n * Controller operates with 4 schemas:\n * - document schema: whatever we loaded from summary metadata + ops. It follows eventuall consistency rules (i.e. like DDS).\n * - desired schema - what client is asking for to have (i.e. all the desired settings, based on runtime options / feature gates).\n * - session schema - current session schema. It's \"and\" of the above two schemas.\n * - future schema - \"or\" of document and desires schemas.\n *\n * \"or\" & \"and\" operators are defined individually for each property. For Boolean properties it's literally &&, || operators.\n * But for other properties it's more nuanced.\n *\n * Whenver document schema does not match future schema, controller will send an op that attempts to changs documents schema to\n * future schema.\n *\n * Users of this class need to use DocumentsSchemaController.sessionSchema to determine what features can be used.\n *\n * There are two modes this class can operate:\n * 1) Legacy mode. In such mode it does not issue any ops to change document schema. Any changes happen implicitly,\n *    right away, and new features are available right away\n * 2) Non-legacy mode. In such mode any changes to schema require an op roundtrip. This class will manage such transitions.\n *    However code should assume that any new features that were not enabled in a given document will not be available\n *    for a given session. That's because this session may never send any ops (including read-only documents). Or it may\n *    fail to convert schema.\n *    This class promises eventual movement forward. I.e. if new feature is allowed (let's say - through feature gates),\n *    then eventually all documents that are modified will have that feature reflected in their schema. It could require\n *    multiple reloads / new sessions to get there (depends on if code reacts to schema changes right away, or only consults\n *    schema on document load).\n *\n * How schemas are changed (in non-legacy mode):\n * If a client needs to change a schema, it will attempt to do so as part of normal ops sending process.\n * Changes happen in CAS (Compare-and-swap) fashion, i.e. client tells current schema and schema it wants to change to.\n * When a number of clients race to change a schema, then only one of them will win, all others will fail because they will\n * reference old schema that is no longer in effect.\n * Clients can retry, but current implementation is simply - they will not (and will rely on next session / reload to do\n * recalc and decide if schema needs to be changed or not).\n *\n * @internal\n * @sealed\n */\nexport class DocumentsSchemaController {\n\tprivate explicitSchemaControl: boolean;\n\n\t/**\n\t * Have we generated a DocumentSchemaChange op and we're waiting for the ack?\n\t * This is used to ensure that we do not generate multiple schema change ops - this client should only ever send one (if any).\n\t */\n\tprivate opPending = false;\n\n\t// schema coming from document metadata (snapshot we loaded from)\n\tprivate documentSchema: IDocumentSchema;\n\n\t// desired schema, based on feature gates / runtime options.\n\t// This includes requests to enable to disable functionality\n\tprivate readonly desiredSchema: IDocumentSchemaCurrent;\n\n\t// OR() of document schema and desired schema. It enables all the features that are enabled in either of schemas.\n\tprivate futureSchema: IDocumentSchemaCurrent | undefined;\n\n\t// Current schema this session operates with.\n\t// 1) Legacy mode (explicitSchemaControl === false): this is same as desired schema - all options that were requested to be on are on, and all options requested to be off are off.\n\t// 2) Non-legacy mode (explicitSchemaControl === true): this is AND() of document schema and desired schema. Only options that are enabled in both are enabled here.\n\t//    If there are any options that are not enabled in document schema, but are enabled in desired schema, then attempt to change schema\n\t//    (and enable such options) will be made through the session.\n\tpublic sessionSchema: IDocumentSchemaCurrent;\n\n\t/**\n\t * Constructs DocumentsSchemaController that controls current schema and processes around it, including changes in schema.\n\t * @param existing - Is the document existing document, or a new doc.\n\t * @param documentMetadataSchema - current document's schema, if present.\n\t * @param features - features of the document schema that current session wants to see enabled.\n\t * @param onSchemaChange - callback that is called whenever schema is changed (not called on creation / load, only when processing document schema change ops)\n\t * @param info - Informational properties of the document that are not subject to strict schema enforcement\n\t * @param logger - telemetry logger from the runtime\n\t */\n\tconstructor(\n\t\texisting: boolean,\n\t\tsnapshotSequenceNumber: number,\n\t\tdocumentMetadataSchema: IDocumentSchema | undefined,\n\t\tfeatures: IDocumentSchemaFeatures,\n\t\tprivate readonly onSchemaChange: (schema: IDocumentSchemaCurrent) => void,\n\t\tinfo: IDocumentSchemaInfo,\n\t\tlogger: ITelemetryLoggerExt,\n\t) {\n\t\t// For simplicity, let's only support new schema features for explicit schema control mode\n\t\tassert(\n\t\t\tfeatures.disallowedVersions.length === 0 || features.explicitSchemaControl,\n\t\t\t0x949 /* not supported */,\n\t\t);\n\n\t\t// We check the document's metadata to see if there is a minVersionForCollab. If it's not an existing document or\n\t\t// if the document is older, then it won't have one. If it does have a minVersionForCollab, we check if it's greater\n\t\t// than this client's runtime version. If so, we log a telemetry event to warn the customer that the client is outdated.\n\t\t// Note: We only send a warning because we will confirm via `checkRuntimeCompatibility` if this client **can** understand\n\t\t// the existing document's schema. We still want to issue a warning regardless if this client can or cannot understand the\n\t\t// schema since it may be a sign that the customer is not properly waiting for saturation before updating their\n\t\t// `minVersionForCollab` value, which could cause disruptions to users in the future.\n\t\tconst existingMinVersionForCollab = documentMetadataSchema?.info?.minVersionForCollab;\n\t\tif (\n\t\t\texistingMinVersionForCollab !== undefined &&\n\t\t\tgt(existingMinVersionForCollab, pkgVersion) &&\n\t\t\t// We also want to avoid sending the telemetry warning for dev builds, since they currently are formatted as\n\t\t\t// `0.0.0-#####-test`. This will cause the telemetry warning to constantly fire.\n\t\t\t// TODO: This can be removed after ADO:41351\n\t\t\t!isDevBuild(pkgVersion)\n\t\t) {\n\t\t\tconst warnMsg = `WARNING: The version of Fluid Framework used by this client (${pkgVersion}) is not supported by this document! Please upgrade to version ${existingMinVersionForCollab} or later to ensure compatibility.`;\n\t\t\tlogger.sendTelemetryEvent({\n\t\t\t\teventName: \"MinVersionForCollabWarning\",\n\t\t\t\tmessage: warnMsg,\n\t\t\t});\n\t\t}\n\n\t\t// Desired schema by this session - almost all props are coming from arguments\n\t\tthis.desiredSchema = {\n\t\t\tversion: currentDocumentVersionSchema,\n\t\t\trefSeq: documentMetadataSchema?.refSeq ?? 0,\n\t\t\tinfo,\n\t\t\truntime: {\n\t\t\t\texplicitSchemaControl: boolToProp(features.explicitSchemaControl),\n\t\t\t\tcompressionLz4: boolToProp(features.compressionLz4),\n\t\t\t\tidCompressorMode: features.idCompressorMode,\n\t\t\t\topGroupingEnabled: boolToProp(features.opGroupingEnabled),\n\t\t\t\tcreateBlobPayloadPending: features.createBlobPayloadPending,\n\t\t\t\tdisallowedVersions: arrayToProp(features.disallowedVersions),\n\t\t\t},\n\t\t};\n\n\t\t// Schema coming from document metadata (snapshot we loaded from), or if no document exists\n\t\t// (this is a new document) then this is the same as desiredSchema (same as session schema in such case).\n\t\t// Latter is important sure that's what will go into summary.\n\t\tthis.documentSchema = existing\n\t\t\t? (documentMetadataSchema ??\n\t\t\t\t({\n\t\t\t\t\tversion: currentDocumentVersionSchema,\n\t\t\t\t\t// see comment in summarizeDocumentSchema() on why it has to stay zero\n\t\t\t\t\trefSeq: 0,\n\t\t\t\t\tinfo,\n\t\t\t\t\t// If it's existing document and it has no schema, then it was written by legacy client.\n\t\t\t\t\t// If it's a new document, then we define it's legacy-related behaviors.\n\t\t\t\t\truntime: {\n\t\t\t\t\t\texplicitSchemaControl: boolToProp(!existing && features.explicitSchemaControl),\n\t\t\t\t\t},\n\t\t\t\t} satisfies IDocumentSchemaCurrent))\n\t\t\t: this.desiredSchema;\n\n\t\tcheckRuntimeCompatibility(this.documentSchema, \"document\");\n\t\tthis.validateSeqNumber(this.documentSchema.refSeq, snapshotSequenceNumber, \"summary\");\n\n\t\t// Use legacy behavior only if both document and options tell us to use legacy.\n\t\t// Otherwise it's no longer legacy time!\n\t\tthis.explicitSchemaControl =\n\t\t\tthis.documentSchema.runtime.explicitSchemaControl === true ||\n\t\t\tfeatures.explicitSchemaControl;\n\n\t\t// Calculate\n\t\t// - current session schema (overlap of document schema and desired schema)\n\t\t// - future schema to propose (concatination of document schema and desired schema)\n\t\tif (!this.explicitSchemaControl || !existing) {\n\t\t\tthis.sessionSchema = this.desiredSchema;\n\t\t\tassert(\n\t\t\t\tboolToProp(this.explicitSchemaControl) ===\n\t\t\t\t\tthis.sessionSchema.runtime.explicitSchemaControl,\n\t\t\t\t0x94a /* explicitSchemaControl */,\n\t\t\t);\n\t\t\tthis.futureSchema = undefined;\n\t\t} else {\n\t\t\tthis.sessionSchema = and(this.documentSchema, this.desiredSchema);\n\t\t\tthis.futureSchema = or(this.documentSchema, this.desiredSchema);\n\t\t\tassert(this.sessionSchema.runtime.explicitSchemaControl === true, 0x94b /* legacy */);\n\t\t\tassert(this.futureSchema.runtime.explicitSchemaControl === true, 0x94c /* legacy */);\n\t\t\tif (same(this.documentSchema, this.futureSchema)) {\n\t\t\t\tthis.futureSchema = undefined;\n\t\t\t}\n\t\t}\n\n\t\t// Validate that schema we are operating in is actually a schema we consider compatible with current runtime.\n\t\tcheckRuntimeCompatibility(this.desiredSchema, \"desired\");\n\t\tcheckRuntimeCompatibility(this.sessionSchema, \"session\");\n\t\tcheckRuntimeCompatibility(this.futureSchema, \"future\");\n\t}\n\n\tpublic summarizeDocumentSchema(\n\t\trefSeq: number,\n\t): IDocumentSchema | IDocumentSchemaCurrent | undefined {\n\t\t// For legacy behavior, we could write nothing (return undefined).\n\t\t// It does not buy us anything, as whatever written in summary does not actually impact clients operating in legacy mode.\n\t\t// But writing current used config (and assuming most of the clients settle on same config over time) will help with transition\n\t\t// out of legacy mode, as clients transitioning out of it would be able to use all the\n\t\t// features that are mentioned in schema right away, without a need to go through schema transition (and thus for a session or\n\t\t// two losing ability to use all the features)\n\t\tconst schema = this.explicitSchemaControl ? this.documentSchema : this.desiredSchema;\n\n\t\t// It's important to keep refSeq at zero in legacy mode, such that transition out of it is simple and we do not have\n\t\t// race conditions. If we put any other number (including latest seq number), then we will have two clients\n\t\t// (loading from two different summaries) with different numbers, and eventual consistency will be broken as schema\n\t\t// change ops will be interpretted differently by those two clients.\n\t\tassert(\n\t\t\tthis.explicitSchemaControl || schema.refSeq === 0,\n\t\t\t0x94d /* refSeq should be zero */,\n\t\t);\n\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Called by Container runtime whenever it is about to send some op.\n\t * It gives opportunity for controller to issue its own ops - we do not want to send ops if there are no local changes in document.\n\t * Please consider note above constructor about race conditions - current design is to generate op only once in a session lifetime.\n\t * @returns Optional message to send.\n\t */\n\tpublic maybeGenerateSchemaMessage(): IDocumentSchemaChangeMessageOutgoing | undefined {\n\t\tif (this.futureSchema !== undefined && !this.opPending) {\n\t\t\tthis.opPending = true;\n\t\t\tassert(\n\t\t\t\tthis.explicitSchemaControl && this.futureSchema.runtime.explicitSchemaControl === true,\n\t\t\t\t0x94e /* not legacy */,\n\t\t\t);\n\t\t\treturn this.futureSchema;\n\t\t}\n\t}\n\n\tprivate validateSeqNumber(\n\t\tschemaSeqNumber: number,\n\t\tlastKnowSeqNumber: number,\n\t\tmessage: string,\n\t): void {\n\t\tif (!Number.isInteger(schemaSeqNumber) || !(schemaSeqNumber <= lastKnowSeqNumber)) {\n\t\t\tthrow DataProcessingError.create(\n\t\t\t\t\"DocSchema: Incorrect sequence number\",\n\t\t\t\t\"checkRuntimeCompat3\",\n\t\t\t\tundefined, // message\n\t\t\t\t{\n\t\t\t\t\tschemaSeqNumber,\n\t\t\t\t\tsequenceNumber: lastKnowSeqNumber,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Process document schema change messages\n\t * Called by ContainerRuntime whenever it sees document schema messages.\n\t * @param contents - contents of the messages\n\t * @param local - whether op is local\n\t * @param sequenceNumber - sequence number of the op\n\t * @returns true if schema was accepted, otherwise false (rejected due to failed CAS)\n\t */\n\tpublic processDocumentSchemaMessages(\n\t\tcontents: IDocumentSchemaChangeMessageIncoming[],\n\t\tlocal: boolean,\n\t\tsequenceNumber: number,\n\t): boolean {\n\t\tfor (const content of contents) {\n\t\t\tthis.validateSeqNumber(content.refSeq, this.documentSchema.refSeq, \"content.refSeq\");\n\t\t\tthis.validateSeqNumber(this.documentSchema.refSeq, sequenceNumber, \"refSeq\");\n\t\t\t// validate is strickly less, not equal\n\t\t\tassert(\n\t\t\t\tthis.documentSchema.refSeq < sequenceNumber,\n\t\t\t\t0x950 /* time should move forward only! */,\n\t\t\t);\n\n\t\t\tif (content.refSeq !== this.documentSchema.refSeq) {\n\t\t\t\t// CAS failed\n\t\t\t\treturn false;\n\t\t\t}\n\n\t\t\t// This assert should be after checking for successful CAS above.\n\t\t\t// This will ensure we do not trip on our own messages that are no longer wanted as we processed someone else schema change message.\n\t\t\tassert(\n\t\t\t\t!local || (this.explicitSchemaControl && this.futureSchema !== undefined),\n\t\t\t\t0x951 /* not sending ops */,\n\t\t\t);\n\n\t\t\t// Changes are in effect. Immediately check that this client understands these changes\n\t\t\tcheckRuntimeCompatibility(content, \"change\");\n\t\t\tconst schema = {\n\t\t\t\t...content,\n\t\t\t\trefSeq: sequenceNumber,\n\t\t\t} satisfies IDocumentSchemaCurrentIncoming;\n\t\t\tthis.documentSchema = schema;\n\t\t\tthis.sessionSchema = and(schema, this.desiredSchema);\n\t\t\tassert(this.sessionSchema.refSeq === sequenceNumber, 0x97d /* seq# */);\n\n\t\t\t// legacy behavior is automatically off for the document once someone sends a schema op -\n\t\t\t// from now on it's fully controlled by ops.\n\t\t\t// This is very important, as summarizeDocumentSchema() should use this new schema!\n\t\t\tthis.explicitSchemaControl = true;\n\n\t\t\t// Stop attempting changing schema.\n\t\t\t// If it was local op, then we succeeded and do not need to try again.\n\t\t\t// If it was remote op, then some changes happened to schema.\n\t\t\t// We would need to recalculate this.futureSchema by merging changes that we just received.\n\t\t\t// Avoid this complexity for now - a new client session (loading from new summary with these changes)\n\t\t\t// will automatically do this recalculation and will figure out\n\t\t\tthis.futureSchema = undefined;\n\n\t\t\tthis.onSchemaChange(this.sessionSchema);\n\t\t}\n\t\treturn true;\n\t}\n\n\t/**\n\t * Indicates the pending op was not ack'd and we may try to send it again if needed.\n\t */\n\tpublic pendingOpNotAcked(): void {\n\t\tthis.opPending = false;\n\t}\n}\n\n/**\n * Determines if a given version is a dev-build (i.e. `0.0.0-#####-test`).\n */\nfunction isDevBuild(version: string): boolean {\n\tconst parsed = parse(version);\n\treturn parsed?.prerelease.includes(\"test\") ?? false;\n}\n\n/* eslint-enable jsdoc/check-indentation */\n"]}

package/lib/summary/summaryFormat.d.ts

@@ -7,12 +7,12 @@ import { type ISummaryTreeWithStats, type IRuntimeStorageService } from "@fluidf
 import type { IGCMetadata } from "../gc/index.js";
 import type { IDocumentSchema } from "./documentSchema.js";
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export interface IFluidDataStoreAttributes0 {
@@ -27,7 +27,7 @@ export interface IFluidDataStoreAttributes0 {
     readonly isRootDataStore?: boolean;
 }
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export interface IFluidDataStoreAttributes1 extends OmitAttributesVersions<IFluidDataStoreAttributes0> {
@@ -35,7 +35,7 @@ export interface IFluidDataStoreAttributes1 extends OmitAttributesVersions<IFlui
     readonly summaryFormatVersion?: undefined;
 }
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFluidDataStoreAttributes1> {
@@ -57,7 +57,7 @@ export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFlui
  * store like the package, snapshotFormatVersion to take different decisions based on a particular
  * snapshotFormatVersion.
  *
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  *
  * @legacy @beta
  *
@@ -72,7 +72,7 @@ export declare function hasIsolatedChannels(attributes: ReadFluidDataStoreAttrib
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly summaryFormatVersion: 1;
     /**
-     * @deprecated - used by old (prior to 2.0 RC3) runtimes
+     * @deprecated used by old (prior to 2.0 RC3) runtimes
      */
     readonly message?: ISummaryMetadataMessage;
     /**

package/lib/summary/summaryFormat.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryFormat.js","sourceRoot":"","sources":["../../src/summary/summaryFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAKjE,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAEN,gBAAgB,EAChB,SAAS,GAET,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AA6ExD,MAAM,UAAU,0BAA0B,CAAC,UAAwC;IAClF,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC;QACrC;;;WAGG;QACH,OAAO,UAAU,CAAC,oBAAoB,CAAC;IACxC,CAAC;SAAM,IAAI,UAAU,CAAC,qBAAqB,KAAK,KAAK,EAAE,CAAC;QACvD;;;WAGG;QACH,OAAO,CAAC,CAAC;IACV,CAAC;IACD;;;OAGG;IACH,OAAO,CAAC,CAAC;AACV,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,UAAwC;IAC3E,OAAO,CAAC,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;AACjF,CAAC;AA6DD;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC5C,OAAmC,EACG,EAAE,CACxC,OAAO,KAAK,SAAS;IACpB,CAAC,CAAC,SAAS;IACX,CAAC,CAAC;QACA,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;QAClD,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;QACpD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;QACxD,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,IAAI,EAAE,OAAO,CAAC,IAAI;KAClB,CAAC;AAEL,MAAM,UAAU,wBAAwB,CAAC,QAAoC;IAC5E;;;;;;;;;OASG;IACH,OAAO,QAAQ,EAAE,oBAAoB,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AACxC,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAC5C,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAC;AACxC,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AAC1D,MAAM,CAAC,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAC9D,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAEpD,MAAM,UAAU,uBAAuB,CAAC,QAAoC;IAC3E,OAAO,CAAC,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;AACxD,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,gBAAgB;IAChB,UAAU;IACV,kBAAkB;IAClB,aAAa;IACb,SAAS;IACT,oBAAoB;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,YAAY,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,yBAAyB,CAAC,eAAsC;IAC/E,eAAe,CAAC,OAAO,GAAG;QACzB,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE;KACrD,CAAC;IACF,eAAe,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;AACvC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAChD,OAA+B,EAC/B,QAAuB;IAEvB,MAAM,UAAU,GAAG,MAAM,YAAY,CACpC,OAAO,EACP,QAAQ,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAC3C,CAAC;IACF,qFAAqF;IACrF,mGAAmG;IACnG,uFAAuF;IACvF,0FAA0F;IAC1F,MAAM,aAAa,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,CAAC,aAAa,GAAG,CAAC,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACnB,CAAC;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { SummaryType } from \"@fluidframework/driver-definitions\";\nimport type {\n\tISnapshotTree,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { readAndParse } from \"@fluidframework/driver-utils/internal\";\nimport {\n\ttype ISummaryTreeWithStats,\n\tchannelsTreeName,\n\tgcTreeKey,\n\ttype IRuntimeStorageService,\n} from \"@fluidframework/runtime-definitions/internal\";\n\nimport { blobsTreeName } from \"../blobManager/index.js\";\nimport type { IGCMetadata } from \"../gc/index.js\";\n\nimport type { IDocumentSchema } from \"./documentSchema.js\";\n\n/**\n * @deprecated - This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport type OmitAttributesVersions<T> = Omit<\n\tT,\n\t\"snapshotFormatVersion\" | \"summaryFormatVersion\"\n>;\n\n/**\n * @deprecated - This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport interface IFluidDataStoreAttributes0 {\n\treadonly snapshotFormatVersion?: undefined;\n\treadonly summaryFormatVersion?: undefined;\n\tpkg: string;\n\t/**\n\t * This tells whether a data store is root. Root data stores are never collected.\n\t * Non-root data stores may be collected if they are not used. If this is not present, default it to\n\t * true. This will ensure that older data stores are incorrectly collected.\n\t */\n\treadonly isRootDataStore?: boolean;\n}\n\n/**\n * @deprecated - This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport interface IFluidDataStoreAttributes1\n\textends OmitAttributesVersions<IFluidDataStoreAttributes0> {\n\treadonly snapshotFormatVersion: \"0.1\";\n\treadonly summaryFormatVersion?: undefined;\n}\n\n/**\n * @deprecated - This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport interface IFluidDataStoreAttributes2\n\textends OmitAttributesVersions<IFluidDataStoreAttributes1> {\n\t/**\n\t * Switch from snapshotFormatVersion to summaryFormatVersion\n\t */\n\treadonly snapshotFormatVersion?: undefined;\n\treadonly summaryFormatVersion: 2;\n\t/**\n\t * True if channels are not isolated in .channels subtrees, otherwise isolated.\n\t * This is required in both datastore attributes as well as the root container,\n\t * because reused summary handles may cause different format versions in each\n\t * datastore subtree within the summary.\n\t */\n\treadonly disableIsolatedChannels?: true;\n}\n/**\n * Added IFluidDataStoreAttributes similar to IChannelAttributes which will tell the attributes of a\n * store like the package, snapshotFormatVersion to take different decisions based on a particular\n * snapshotFormatVersion.\n *\n * @deprecated - This interface will no longer be exported in the future(AB#8004).\n *\n * @legacy @beta\n *\n */\nexport type ReadFluidDataStoreAttributes =\n\t| IFluidDataStoreAttributes0\n\t| IFluidDataStoreAttributes1\n\t| IFluidDataStoreAttributes2;\nexport type WriteFluidDataStoreAttributes =\n\t| IFluidDataStoreAttributes1\n\t| IFluidDataStoreAttributes2;\n\nexport function getAttributesFormatVersion(attributes: ReadFluidDataStoreAttributes): number {\n\tif (attributes.summaryFormatVersion) {\n\t\t/**\n\t\t * Version 2+: Introduces .channels trees for isolation of\n\t\t * channel trees from data store objects.\n\t\t */\n\t\treturn attributes.summaryFormatVersion;\n\t} else if (attributes.snapshotFormatVersion === \"0.1\") {\n\t\t/**\n\t\t * Version 1: from this version the pkg within the data store\n\t\t * attributes blob is a JSON array rather than a string.\n\t\t */\n\t\treturn 1;\n\t}\n\t/**\n\t * Version 0: format version is missing from summary.\n\t * This indicates it is an older version.\n\t */\n\treturn 0;\n}\n\nexport function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): boolean {\n\treturn !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;\n}\n\n/**\n * @internal\n */\n\nexport interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {\n\treadonly summaryFormatVersion: 1;\n\t/**\n\t * @deprecated - used by old (prior to 2.0 RC3) runtimes\n\t */\n\treadonly message?: ISummaryMetadataMessage;\n\t/**\n\t * The last message processed at the time of summary. Only primitive property types are added to the summary.\n\t */\n\treadonly lastMessage?: ISummaryMetadataMessage;\n\t/**\n\t * True if channels are not isolated in .channels subtrees, otherwise isolated.\n\t */\n\treadonly disableIsolatedChannels?: true;\n\t/**\n\t * The summary number for a container's summary. Incremented on summaries throughout its lifetime.\n\t */\n\treadonly summaryNumber?: number;\n\t/**\n\t * GUID to identify a document in telemetry\n\t */\n\treadonly telemetryDocumentId?: string;\n\n\treadonly documentSchema?: IDocumentSchema;\n}\n\n/**\n * @internal\n */\nexport interface ICreateContainerMetadata {\n\t/**\n\t * Runtime version of the container when it was first created\n\t */\n\tcreateContainerRuntimeVersion?: string;\n\t/**\n\t * Timestamp of the container when it was first created\n\t */\n\tcreateContainerTimestamp?: number;\n}\n\n/**\n * The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary.\n * @internal\n */\nexport type ISummaryMetadataMessage = Pick<\n\tISequencedDocumentMessage,\n\t| \"clientId\"\n\t| \"clientSequenceNumber\"\n\t| \"minimumSequenceNumber\"\n\t| \"referenceSequenceNumber\"\n\t| \"sequenceNumber\"\n\t| \"timestamp\"\n\t| \"type\"\n>;\n\n/**\n * Extracts the properties from an ISequencedDocumentMessage as defined by ISummaryMetadataMessage. This message is\n * added to the metadata blob in summary.\n */\nexport const extractSummaryMetadataMessage = (\n\tmessage?: ISequencedDocumentMessage,\n): ISummaryMetadataMessage | undefined =>\n\tmessage === undefined\n\t\t? undefined\n\t\t: {\n\t\t\t\tclientId: message.clientId,\n\t\t\t\tclientSequenceNumber: message.clientSequenceNumber,\n\t\t\t\tminimumSequenceNumber: message.minimumSequenceNumber,\n\t\t\t\treferenceSequenceNumber: message.referenceSequenceNumber,\n\t\t\t\tsequenceNumber: message.sequenceNumber,\n\t\t\t\ttimestamp: message.timestamp,\n\t\t\t\ttype: message.type,\n\t\t\t};\n\nexport function getMetadataFormatVersion(metadata?: IContainerRuntimeMetadata): number {\n\t/**\n\t * Version 2+: Introduces runtime sequence number for data verification.\n\t *\n\t * Version 1+: Introduces .metadata blob and .channels trees for isolation of\n\t * data store trees from container-level objects.\n\t * Also introduces enableGC option stored in the summary.\n\t *\n\t * Version 0: metadata blob missing; format version is missing from summary.\n\t * This indicates it is an older version.\n\t */\n\treturn metadata?.summaryFormatVersion ?? 0;\n}\n\nexport const aliasBlobName = \".aliases\";\nexport const metadataBlobName = \".metadata\";\nexport const chunksBlobName = \".chunks\";\nexport const recentBatchInfoBlobName = \".recentBatchInfo\";\nexport const electedSummarizerBlobName = \".electedSummarizer\";\nexport const idCompressorBlobName = \".idCompressor\";\n\nexport function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {\n\treturn !!metadata && !metadata.disableIsolatedChannels;\n}\n\nexport const protocolTreeName = \".protocol\";\n\n/**\n * List of tree IDs at the container level which are reserved.\n * This is for older versions of summaries that do not yet have an\n * isolated data stores namespace. Without the namespace, this must\n * be used to prevent name collisions with data store IDs.\n */\nexport const nonDataStorePaths = [\n\tprotocolTreeName,\n\t\".logTail\",\n\t\".serviceProtocol\",\n\tblobsTreeName,\n\tgcTreeKey,\n\tidCompressorBlobName,\n];\n\nexport const dataStoreAttributesBlobName = \".component\";\n\n/**\n * Modifies summary tree and stats to put tree under .channels tree.\n *\n * @param summarizeResult - Summary tree and stats to modify\n *\n * @example\n *\n * Converts from:\n *\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: { a: {...}, b: {...}, c: {...} },\n * }\n * ```\n *\n * to:\n *\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: {\n *         \".channels\": {\n *             type: SummaryType.Tree,\n *             tree: { a: {...}, b: {...}, c: {...} }\n *         },\n *     },\n * }\n * ```\n *\n * And adds +1 to treeNodeCount in stats.\n */\nexport function wrapSummaryInChannelsTree(summarizeResult: ISummaryTreeWithStats): void {\n\tsummarizeResult.summary = {\n\t\ttype: SummaryType.Tree,\n\t\ttree: { [channelsTreeName]: summarizeResult.summary },\n\t};\n\tsummarizeResult.stats.treeNodeCount++;\n}\n\nexport async function getFluidDataStoreAttributes(\n\tstorage: IRuntimeStorageService,\n\tsnapshot: ISnapshotTree,\n): Promise<ReadFluidDataStoreAttributes> {\n\tconst attributes = await readAndParse<ReadFluidDataStoreAttributes>(\n\t\tstorage,\n\t\tsnapshot.blobs[dataStoreAttributesBlobName],\n\t);\n\t// Use the snapshotFormatVersion to determine how the pkg is encoded in the snapshot.\n\t// For snapshotFormatVersion = \"0.1\" (1) or above, pkg is jsonified, otherwise it is just a string.\n\t// However the feature of loading a detached container from snapshot, is added when the\n\t// snapshotFormatVersion is at least \"0.1\" (1), so we don't expect it to be anything else.\n\tconst formatVersion = getAttributesFormatVersion(attributes);\n\tassert(formatVersion > 0, 0x1d5 /* Invalid snapshot format version */);\n\treturn attributes;\n}\n\nexport { blobHeadersBlobName } from \"@fluidframework/driver-utils/internal\";\n"]}
+{"version":3,"file":"summaryFormat.js","sourceRoot":"","sources":["../../src/summary/summaryFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAKjE,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAEN,gBAAgB,EAChB,SAAS,GAET,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AA6ExD,MAAM,UAAU,0BAA0B,CAAC,UAAwC;IAClF,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC;QACrC;;;WAGG;QACH,OAAO,UAAU,CAAC,oBAAoB,CAAC;IACxC,CAAC;SAAM,IAAI,UAAU,CAAC,qBAAqB,KAAK,KAAK,EAAE,CAAC;QACvD;;;WAGG;QACH,OAAO,CAAC,CAAC;IACV,CAAC;IACD;;;OAGG;IACH,OAAO,CAAC,CAAC;AACV,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,UAAwC;IAC3E,OAAO,CAAC,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;AACjF,CAAC;AA6DD;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC5C,OAAmC,EACG,EAAE,CACxC,OAAO,KAAK,SAAS;IACpB,CAAC,CAAC,SAAS;IACX,CAAC,CAAC;QACA,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;QAClD,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;QACpD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;QACxD,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,IAAI,EAAE,OAAO,CAAC,IAAI;KAClB,CAAC;AAEL,MAAM,UAAU,wBAAwB,CAAC,QAAoC;IAC5E;;;;;;;;;OASG;IACH,OAAO,QAAQ,EAAE,oBAAoB,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AACxC,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAC5C,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAC;AACxC,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AAC1D,MAAM,CAAC,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAC9D,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAEpD,MAAM,UAAU,uBAAuB,CAAC,QAAoC;IAC3E,OAAO,CAAC,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;AACxD,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,gBAAgB;IAChB,UAAU;IACV,kBAAkB;IAClB,aAAa;IACb,SAAS;IACT,oBAAoB;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,YAAY,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,yBAAyB,CAAC,eAAsC;IAC/E,eAAe,CAAC,OAAO,GAAG;QACzB,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE;KACrD,CAAC;IACF,eAAe,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;AACvC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAChD,OAA+B,EAC/B,QAAuB;IAEvB,MAAM,UAAU,GAAG,MAAM,YAAY,CACpC,OAAO,EACP,QAAQ,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAC3C,CAAC;IACF,qFAAqF;IACrF,mGAAmG;IACnG,uFAAuF;IACvF,0FAA0F;IAC1F,MAAM,aAAa,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,CAAC,aAAa,GAAG,CAAC,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACnB,CAAC;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { SummaryType } from \"@fluidframework/driver-definitions\";\nimport type {\n\tISnapshotTree,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { readAndParse } from \"@fluidframework/driver-utils/internal\";\nimport {\n\ttype ISummaryTreeWithStats,\n\tchannelsTreeName,\n\tgcTreeKey,\n\ttype IRuntimeStorageService,\n} from \"@fluidframework/runtime-definitions/internal\";\n\nimport { blobsTreeName } from \"../blobManager/index.js\";\nimport type { IGCMetadata } from \"../gc/index.js\";\n\nimport type { IDocumentSchema } from \"./documentSchema.js\";\n\n/**\n * @deprecated This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport type OmitAttributesVersions<T> = Omit<\n\tT,\n\t\"snapshotFormatVersion\" | \"summaryFormatVersion\"\n>;\n\n/**\n * @deprecated This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport interface IFluidDataStoreAttributes0 {\n\treadonly snapshotFormatVersion?: undefined;\n\treadonly summaryFormatVersion?: undefined;\n\tpkg: string;\n\t/**\n\t * This tells whether a data store is root. Root data stores are never collected.\n\t * Non-root data stores may be collected if they are not used. If this is not present, default it to\n\t * true. This will ensure that older data stores are incorrectly collected.\n\t */\n\treadonly isRootDataStore?: boolean;\n}\n\n/**\n * @deprecated This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport interface IFluidDataStoreAttributes1\n\textends OmitAttributesVersions<IFluidDataStoreAttributes0> {\n\treadonly snapshotFormatVersion: \"0.1\";\n\treadonly summaryFormatVersion?: undefined;\n}\n\n/**\n * @deprecated This interface will no longer be exported in the future(AB#8004).\n * @legacy @beta\n */\nexport interface IFluidDataStoreAttributes2\n\textends OmitAttributesVersions<IFluidDataStoreAttributes1> {\n\t/**\n\t * Switch from snapshotFormatVersion to summaryFormatVersion\n\t */\n\treadonly snapshotFormatVersion?: undefined;\n\treadonly summaryFormatVersion: 2;\n\t/**\n\t * True if channels are not isolated in .channels subtrees, otherwise isolated.\n\t * This is required in both datastore attributes as well as the root container,\n\t * because reused summary handles may cause different format versions in each\n\t * datastore subtree within the summary.\n\t */\n\treadonly disableIsolatedChannels?: true;\n}\n/**\n * Added IFluidDataStoreAttributes similar to IChannelAttributes which will tell the attributes of a\n * store like the package, snapshotFormatVersion to take different decisions based on a particular\n * snapshotFormatVersion.\n *\n * @deprecated This interface will no longer be exported in the future(AB#8004).\n *\n * @legacy @beta\n *\n */\nexport type ReadFluidDataStoreAttributes =\n\t| IFluidDataStoreAttributes0\n\t| IFluidDataStoreAttributes1\n\t| IFluidDataStoreAttributes2;\nexport type WriteFluidDataStoreAttributes =\n\t| IFluidDataStoreAttributes1\n\t| IFluidDataStoreAttributes2;\n\nexport function getAttributesFormatVersion(attributes: ReadFluidDataStoreAttributes): number {\n\tif (attributes.summaryFormatVersion) {\n\t\t/**\n\t\t * Version 2+: Introduces .channels trees for isolation of\n\t\t * channel trees from data store objects.\n\t\t */\n\t\treturn attributes.summaryFormatVersion;\n\t} else if (attributes.snapshotFormatVersion === \"0.1\") {\n\t\t/**\n\t\t * Version 1: from this version the pkg within the data store\n\t\t * attributes blob is a JSON array rather than a string.\n\t\t */\n\t\treturn 1;\n\t}\n\t/**\n\t * Version 0: format version is missing from summary.\n\t * This indicates it is an older version.\n\t */\n\treturn 0;\n}\n\nexport function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): boolean {\n\treturn !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;\n}\n\n/**\n * @internal\n */\n\nexport interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {\n\treadonly summaryFormatVersion: 1;\n\t/**\n\t * @deprecated used by old (prior to 2.0 RC3) runtimes\n\t */\n\treadonly message?: ISummaryMetadataMessage;\n\t/**\n\t * The last message processed at the time of summary. Only primitive property types are added to the summary.\n\t */\n\treadonly lastMessage?: ISummaryMetadataMessage;\n\t/**\n\t * True if channels are not isolated in .channels subtrees, otherwise isolated.\n\t */\n\treadonly disableIsolatedChannels?: true;\n\t/**\n\t * The summary number for a container's summary. Incremented on summaries throughout its lifetime.\n\t */\n\treadonly summaryNumber?: number;\n\t/**\n\t * GUID to identify a document in telemetry\n\t */\n\treadonly telemetryDocumentId?: string;\n\n\treadonly documentSchema?: IDocumentSchema;\n}\n\n/**\n * @internal\n */\nexport interface ICreateContainerMetadata {\n\t/**\n\t * Runtime version of the container when it was first created\n\t */\n\tcreateContainerRuntimeVersion?: string;\n\t/**\n\t * Timestamp of the container when it was first created\n\t */\n\tcreateContainerTimestamp?: number;\n}\n\n/**\n * The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary.\n * @internal\n */\nexport type ISummaryMetadataMessage = Pick<\n\tISequencedDocumentMessage,\n\t| \"clientId\"\n\t| \"clientSequenceNumber\"\n\t| \"minimumSequenceNumber\"\n\t| \"referenceSequenceNumber\"\n\t| \"sequenceNumber\"\n\t| \"timestamp\"\n\t| \"type\"\n>;\n\n/**\n * Extracts the properties from an ISequencedDocumentMessage as defined by ISummaryMetadataMessage. This message is\n * added to the metadata blob in summary.\n */\nexport const extractSummaryMetadataMessage = (\n\tmessage?: ISequencedDocumentMessage,\n): ISummaryMetadataMessage | undefined =>\n\tmessage === undefined\n\t\t? undefined\n\t\t: {\n\t\t\t\tclientId: message.clientId,\n\t\t\t\tclientSequenceNumber: message.clientSequenceNumber,\n\t\t\t\tminimumSequenceNumber: message.minimumSequenceNumber,\n\t\t\t\treferenceSequenceNumber: message.referenceSequenceNumber,\n\t\t\t\tsequenceNumber: message.sequenceNumber,\n\t\t\t\ttimestamp: message.timestamp,\n\t\t\t\ttype: message.type,\n\t\t\t};\n\nexport function getMetadataFormatVersion(metadata?: IContainerRuntimeMetadata): number {\n\t/**\n\t * Version 2+: Introduces runtime sequence number for data verification.\n\t *\n\t * Version 1+: Introduces .metadata blob and .channels trees for isolation of\n\t * data store trees from container-level objects.\n\t * Also introduces enableGC option stored in the summary.\n\t *\n\t * Version 0: metadata blob missing; format version is missing from summary.\n\t * This indicates it is an older version.\n\t */\n\treturn metadata?.summaryFormatVersion ?? 0;\n}\n\nexport const aliasBlobName = \".aliases\";\nexport const metadataBlobName = \".metadata\";\nexport const chunksBlobName = \".chunks\";\nexport const recentBatchInfoBlobName = \".recentBatchInfo\";\nexport const electedSummarizerBlobName = \".electedSummarizer\";\nexport const idCompressorBlobName = \".idCompressor\";\n\nexport function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {\n\treturn !!metadata && !metadata.disableIsolatedChannels;\n}\n\nexport const protocolTreeName = \".protocol\";\n\n/**\n * List of tree IDs at the container level which are reserved.\n * This is for older versions of summaries that do not yet have an\n * isolated data stores namespace. Without the namespace, this must\n * be used to prevent name collisions with data store IDs.\n */\nexport const nonDataStorePaths = [\n\tprotocolTreeName,\n\t\".logTail\",\n\t\".serviceProtocol\",\n\tblobsTreeName,\n\tgcTreeKey,\n\tidCompressorBlobName,\n];\n\nexport const dataStoreAttributesBlobName = \".component\";\n\n/**\n * Modifies summary tree and stats to put tree under .channels tree.\n *\n * @param summarizeResult - Summary tree and stats to modify\n *\n * @example\n *\n * Converts from:\n *\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: { a: {...}, b: {...}, c: {...} },\n * }\n * ```\n *\n * to:\n *\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: {\n *         \".channels\": {\n *             type: SummaryType.Tree,\n *             tree: { a: {...}, b: {...}, c: {...} }\n *         },\n *     },\n * }\n * ```\n *\n * And adds +1 to treeNodeCount in stats.\n */\nexport function wrapSummaryInChannelsTree(summarizeResult: ISummaryTreeWithStats): void {\n\tsummarizeResult.summary = {\n\t\ttype: SummaryType.Tree,\n\t\ttree: { [channelsTreeName]: summarizeResult.summary },\n\t};\n\tsummarizeResult.stats.treeNodeCount++;\n}\n\nexport async function getFluidDataStoreAttributes(\n\tstorage: IRuntimeStorageService,\n\tsnapshot: ISnapshotTree,\n): Promise<ReadFluidDataStoreAttributes> {\n\tconst attributes = await readAndParse<ReadFluidDataStoreAttributes>(\n\t\tstorage,\n\t\tsnapshot.blobs[dataStoreAttributesBlobName],\n\t);\n\t// Use the snapshotFormatVersion to determine how the pkg is encoded in the snapshot.\n\t// For snapshotFormatVersion = \"0.1\" (1) or above, pkg is jsonified, otherwise it is just a string.\n\t// However the feature of loading a detached container from snapshot, is added when the\n\t// snapshotFormatVersion is at least \"0.1\" (1), so we don't expect it to be anything else.\n\tconst formatVersion = getAttributesFormatVersion(attributes);\n\tassert(formatVersion > 0, 0x1d5 /* Invalid snapshot format version */);\n\treturn attributes;\n}\n\nexport { blobHeadersBlobName } from \"@fluidframework/driver-utils/internal\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "2.70.0-361092",
+  "version": "2.70.0-361788",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -119,18 +119,18 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.70.0-361092",
-    "@fluidframework/container-definitions": "2.70.0-361092",
-    "@fluidframework/container-runtime-definitions": "2.70.0-361092",
-    "@fluidframework/core-interfaces": "2.70.0-361092",
-    "@fluidframework/core-utils": "2.70.0-361092",
-    "@fluidframework/datastore": "2.70.0-361092",
-    "@fluidframework/driver-definitions": "2.70.0-361092",
-    "@fluidframework/driver-utils": "2.70.0-361092",
-    "@fluidframework/id-compressor": "2.70.0-361092",
-    "@fluidframework/runtime-definitions": "2.70.0-361092",
-    "@fluidframework/runtime-utils": "2.70.0-361092",
-    "@fluidframework/telemetry-utils": "2.70.0-361092",
+    "@fluid-internal/client-utils": "2.70.0-361788",
+    "@fluidframework/container-definitions": "2.70.0-361788",
+    "@fluidframework/container-runtime-definitions": "2.70.0-361788",
+    "@fluidframework/core-interfaces": "2.70.0-361788",
+    "@fluidframework/core-utils": "2.70.0-361788",
+    "@fluidframework/datastore": "2.70.0-361788",
+    "@fluidframework/driver-definitions": "2.70.0-361788",
+    "@fluidframework/driver-utils": "2.70.0-361788",
+    "@fluidframework/id-compressor": "2.70.0-361788",
+    "@fluidframework/runtime-definitions": "2.70.0-361788",
+    "@fluidframework/runtime-utils": "2.70.0-361788",
+    "@fluidframework/telemetry-utils": "2.70.0-361788",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "double-ended-queue": "^2.1.0-0",
     "lz4js": "^0.2.0",
@@ -140,16 +140,16 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.70.0-361092",
-    "@fluid-private/stochastic-test-utils": "2.70.0-361092",
-    "@fluid-private/test-pairwise-generator": "2.70.0-361092",
+    "@fluid-internal/mocha-test-setup": "2.70.0-361788",
+    "@fluid-private/stochastic-test-utils": "2.70.0-361788",
+    "@fluid-private/test-pairwise-generator": "2.70.0-361788",
     "@fluid-tools/benchmark": "^0.51.0",
     "@fluid-tools/build-cli": "^0.58.3",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
     "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.63.0",
     "@fluidframework/eslint-config-fluid": "^6.1.0",
-    "@fluidframework/test-runtime-utils": "2.70.0-361092",
+    "@fluidframework/test-runtime-utils": "2.70.0-361788",
     "@microsoft/api-extractor": "7.52.11",
     "@types/double-ended-queue": "^2.1.0",
     "@types/lz4js": "^0.2.0",
@@ -169,6 +169,9 @@
   },
   "typeValidation": {
     "broken": {
+      "Interface_LoadContainerRuntimeParams": {
+        "backCompat": false
+      },
       "TypeAlias_MinimumVersionForCollab": {
         "backCompat": false,
         "forwardCompat": false

package/src/blobManager/blobManager.ts

@@ -924,7 +924,6 @@ export class BlobManager {
 	public readonly sharePendingBlobs = async (): Promise<void> => {
 		const localIdsToUpload = [...this.pendingOnlyLocalIds];
 		this.pendingOnlyLocalIds.clear();
-		// TODO: Determine if Promise.all is ergonomic at the callsite. Would Promise.allSettled be better?
 		await Promise.all<void>(
 			localIdsToUpload.map(async (localId) => this.uploadAndAttach(localId)),
 		);

package/src/containerRuntime.ts

@@ -1215,6 +1215,8 @@ export class ContainerRuntime
 			recentBatchInfo,
 		);
 
+		runtime.sharePendingBlobs();
+
 		// Initialize the base state of the runtime before it's returned.
 		await runtime.initializeBaseState(context.loader);
 
@@ -1581,13 +1583,6 @@ export class ContainerRuntime
 
 		this.isSnapshotInstanceOfISnapshot = snapshotWithContents !== undefined;
 
-		// Validate that the Loader is compatible with this Runtime.
-		const maybeLoaderCompatDetailsForRuntime = context as FluidObject<ILayerCompatDetails>;
-		validateLoaderCompatibility(
-			maybeLoaderCompatDetailsForRuntime.ILayerCompatDetails,
-			this.disposeFn,
-		);
-
 		this.mc = createChildMonitoringContext({
 			logger: this.baseLogger,
 			namespace: "ContainerRuntime",
@@ -1598,6 +1593,14 @@ export class ContainerRuntime
 			},
 		});
 
+		// Validate that the Loader is compatible with this Runtime.
+		const maybeLoaderCompatDetailsForRuntime = context as FluidObject<ILayerCompatDetails>;
+		validateLoaderCompatibility(
+			maybeLoaderCompatDetailsForRuntime.ILayerCompatDetails,
+			this.disposeFn,
+			this.mc.logger,
+		);
+
 		// If we support multiple algorithms in the future, then we would need to manage it here carefully.
 		// We can use runtimeOptions.compressionOptions.compressionAlgorithm, but only if it's in the schema list!
 		// If it's not in the list, then we will need to either use no compression, or fallback to some other (supported by format)
@@ -2347,7 +2350,7 @@ export class ContainerRuntime
 	 * Api to fetch the snapshot from the service for a loadingGroupIds.
 	 * @param loadingGroupIds - LoadingGroupId for which the snapshot is asked for.
 	 * @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
-	 * @returns - snapshotTree and the sequence number of the snapshot.
+	 * @returns snapshotTree and the sequence number of the snapshot.
 	 */
 	public async getSnapshotForLoadingGroupId(
 		loadingGroupIds: string[],
@@ -2457,7 +2460,7 @@ export class ContainerRuntime
 	 * @param pathParts - Part of the path, which we want to extract from the snapshot tree.
 	 * @param hasIsolatedChannels - whether the channels are present inside ".channels" subtree. Older
 	 * snapshots will not have trees inside ".channels", so check that.
-	 * @returns - requested snapshot tree based on the path parts.
+	 * @returns requested snapshot tree based on the path parts.
 	 */
 	private getSnapshotTreeForPath(
 		snapshotTree: ISnapshotTree,
@@ -3421,7 +3424,7 @@ export class ContainerRuntime
 	/**
 	 * Flush the current batch of ops to the ordering service for sequencing
 	 * This method is not expected to be called in the middle of a batch.
-	 * @remarks - If it throws (e.g. if the batch is too large to send), the container will be closed.
+	 * @remarks If it throws (e.g. if the batch is too large to send), the container will be closed.
 	 *
 	 * @param resubmitInfo - If defined, indicates this is a resubmission of a batch with the given Batch info needed for resubmit.
 	 */
@@ -3778,7 +3781,7 @@ export class ContainerRuntime
 	/**
 	 * Builds the Summary tree including all the channels and the container state.
 	 *
-	 * @remarks - Unfortunately, this function is accessed in a non-typesafe way by a legacy first-party partner,
+	 * @remarks Unfortunately, this function is accessed in a non-typesafe way by a legacy first-party partner,
 	 * so until we can provide a proper API for their scenario, we need to ensure this function doesn't change.
 	 */
 	private async summarizeInternal(
@@ -4521,7 +4524,7 @@ export class ContainerRuntime
 	 * Emit "dirty" or "saved" event based on the current dirty state of the document.
 	 * This must be called every time the states underlying the dirty state change.
 	 *
-	 * @privateRemarks - It's helpful to think of this as an event handler registered
+	 * @privateRemarks It's helpful to think of this as an event handler registered
 	 * for hypothetical "changed" events for PendingStateManager, Outbox, and Container Attach machinery.
 	 * But those events don't exist so we manually call this wherever we know those changes happen.
 	 */
@@ -4548,7 +4551,6 @@ export class ContainerRuntime
 		contents: any,
 		localOpMetadata: unknown = undefined,
 	): void {
-		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 		this.submit({ type, contents }, localOpMetadata);
 	}
 
@@ -5133,6 +5135,43 @@ export class ContainerRuntime
 		);
 	}
 
+	/**
+	 * ContainerRuntime knows about additional restrictions on when blob sharing can be resumed as compared
+	 * to BlobManager. In particular, it wants to avoid sharing blobs while in readonly state, and it also
+	 * wants to avoid sharing blobs before connection completes (otherwise it may cause the sharing to happen
+	 * before processing shared ops).
+	 *
+	 * This method can be called safely before those conditions are met. In the background, it will wait until
+	 * it is safe before initiating sharing. It will close the container on any error.
+	 */
+	public sharePendingBlobs = (): void => {
+		new Promise<void>((resolve) => {
+			// eslint-disable-next-line unicorn/consistent-function-scoping
+			const canStartSharing = (): boolean =>
+				this.connected && this.deltaManager.readOnlyInfo.readonly !== true;
+
+			if (canStartSharing()) {
+				resolve();
+				return;
+			}
+
+			const checkCanShare = (readonly: boolean): void => {
+				if (canStartSharing()) {
+					this.deltaManager.off("readonly", checkCanShare);
+					this.off("connected", checkCanShare);
+					resolve();
+				}
+			};
+			this.deltaManager.on("readonly", checkCanShare);
+			this.on("connected", checkCanShare);
+		})
+			.then(this.blobManager.sharePendingBlobs)
+			// It may not be necessary to close the container on failures - this should just mean there's
+			// a handle in the container that is stuck pending, which is a scenario that customers need to
+			// handle anyway. Starting with this more aggressive/restrictive behavior to be cautious.
+			.catch(this.closeFn);
+	};
+
 	public summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults {
 		if (this._summarizer !== undefined) {
 			return this._summarizer.summarizeOnDemand(options);

package/src/dataStoreContext.ts

@@ -1004,6 +1004,7 @@ export abstract class FluidDataStoreContext
 		validateDatastoreCompatibility(
 			maybeDataStoreCompatDetails.ILayerCompatDetails,
 			this.dispose.bind(this),
+			this.mc.logger,
 		);
 
 		// And now mark the runtime active

package/src/messageTypes.ts

@@ -44,7 +44,7 @@ export enum ContainerMessageType {
 	/**
 	 * An op containing an IdRange of Ids allocated using the runtime's IdCompressor since
 	 * the last allocation op was sent.
-	 * See the [IdCompressor README](./id-compressor/README.md) for more details.
+	 * See the {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/id-compressor/README.md|IdCompressor README} for more details.
 	 */
 	IdAllocation = "idAllocation",
 

package/src/opLifecycle/duplicateBatchDetector.ts

@@ -39,7 +39,7 @@ export class DuplicateBatchDetector {
 	 * Records this batch's batchId, and checks if it's a duplicate of a batch we've already seen.
 	 * If it's a duplicate, also return the sequence number of the other batch for logging.
 	 *
-	 * @remarks - We also use the minimumSequenceNumber to clear out old batchIds that are no longer at risk for duplicates.
+	 * @remarks We also use the minimumSequenceNumber to clear out old batchIds that are no longer at risk for duplicates.
 	 */
 	public processInboundBatch(
 		batchStart: BatchStartInfo,
@@ -97,7 +97,7 @@ export class DuplicateBatchDetector {
 	 * Returns a snapshot of the state of the detector which can be included in a summary
 	 * and used to "rehydrate" this class when loading from a snapshot.
 	 *
-	 * @returns - A serializable object representing the state of the detector, or undefined if there is nothing to save.
+	 * @returns A serializable object representing the state of the detector, or undefined if there is nothing to save.
 	 */
 	public getRecentBatchInfoForSummary(
 		telemetryContext?: ITelemetryContext,