@itwin/core-backend 3.6.0-dev.52 → 3.6.0-dev.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/lib/cjs/AliCloudStorageService.d.ts +2 -2
  2. package/lib/cjs/AliCloudStorageService.js +1 -1
  3. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  4. package/lib/cjs/BackendHubAccess.d.ts +2 -2
  5. package/lib/cjs/BackendHubAccess.js.map +1 -1
  6. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  7. package/lib/cjs/BriefcaseManager.js +1 -0
  8. package/lib/cjs/BriefcaseManager.js.map +1 -1
  9. package/lib/cjs/ChangeSummaryManager.d.ts +2 -2
  10. package/lib/cjs/ChangeSummaryManager.js +1 -1
  11. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  12. package/lib/cjs/ClassRegistry.d.ts.map +1 -1
  13. package/lib/cjs/ClassRegistry.js +2 -1
  14. package/lib/cjs/ClassRegistry.js.map +1 -1
  15. package/lib/cjs/CloudStorageBackend.d.ts +4 -4
  16. package/lib/cjs/CloudStorageBackend.js +3 -3
  17. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  18. package/lib/cjs/Element.d.ts +2 -2
  19. package/lib/cjs/Element.js +2 -2
  20. package/lib/cjs/Element.js.map +1 -1
  21. package/lib/cjs/ElementAspect.d.ts +1 -1
  22. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  23. package/lib/cjs/ElementAspect.js +1 -1
  24. package/lib/cjs/ElementAspect.js.map +1 -1
  25. package/lib/cjs/IModelCloneContext.d.ts +2 -2
  26. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  27. package/lib/cjs/IModelCloneContext.js +1 -1
  28. package/lib/cjs/IModelCloneContext.js.map +1 -1
  29. package/lib/cjs/IModelDb.d.ts +10 -1
  30. package/lib/cjs/IModelDb.d.ts.map +1 -1
  31. package/lib/cjs/IModelDb.js +16 -2
  32. package/lib/cjs/IModelDb.js.map +1 -1
  33. package/lib/cjs/IModelHost.d.ts +4 -4
  34. package/lib/cjs/IModelHost.d.ts.map +1 -1
  35. package/lib/cjs/IModelHost.js.map +1 -1
  36. package/lib/cjs/LocalHub.d.ts.map +1 -1
  37. package/lib/cjs/LocalHub.js +1 -3
  38. package/lib/cjs/LocalHub.js.map +1 -1
  39. package/lib/cjs/Material.d.ts +49 -21
  40. package/lib/cjs/Material.d.ts.map +1 -1
  41. package/lib/cjs/Material.js +41 -7
  42. package/lib/cjs/Material.js.map +1 -1
  43. package/lib/cjs/domains/FunctionalSchema.d.ts +1 -1
  44. package/lib/cjs/domains/FunctionalSchema.d.ts.map +1 -1
  45. package/lib/cjs/domains/FunctionalSchema.js +1 -1
  46. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  47. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +1 -1
  48. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +1 -1
  49. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  50. package/package.json +12 -12
package/lib/cjs/ChangeSummaryManager.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ChangeSummaryManager.js","sourceRoot":"","sources":["../../src/ChangeSummaryManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqI;AACrI,oDAAiH;AACjH,6BAA6B;AAC7B,mEAAgE;AAChE,yDAAsD;AACtD,iCAA4C;AAE5C,yCAA6D;AAC7D,6CAA0D;AAC1D,6CAA0C;AAE1C,MAAM,cAAc,GAAW,6CAAqB,CAAC,IAAI,CAAC;AAgE1D;;;;;GAKG;AACH,MAAa,oBAAoB;IAG/B;;;OAGG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAgB;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,OAAO,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpD,OAAO;QAET,MAAM,oBAAoB,GAAW,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9F,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE;YAChD,IAAA,oBAAK,EAAC,IAAI,WAAI,EAAE,EAAE,CAAC,eAAqB,EAAE,EAAE;gBAC1C,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;SACJ;QAED,IAAA,qBAAM,EAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACpD,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;QAC9E,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,yCAAyC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC1D,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,2CAA2C,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,WAAwB,EAAE,MAAmB,EAAE,OAAqC;QAC7H,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3C,IAAA,qBAAM,EAAC,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAEpC,IAAI,gBAAgB,GAAG,EAAE,CAAC;QAC1B,IAAI,OAAO,EAAE;YACX,IAAI,OAAO,CAAC,YAAY,EAAE;gBACxB,gBAAgB,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtI;iBAAM,IAAI,OAAO,CAAC,kBAAkB,EAAE;gBACrC,gBAAgB,GAAG,cAAc,CAAC;aACnC;SACF;QAED,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAC/H,MAAM,SAAS,GAAG,IAAI,yBAAU,CAAC,4DAA4D,gBAAgB,YAAY,cAAc,aAAa,QAAQ,GAAG,CAAC,CAAC;QAEjK,6GAA6G;QAC7G,IAAI,UAAU,GAAG,IAAI,yBAAU,CAAC,sGAAsG,CAAC,CAAC;QAExI,MAAM,KAAK,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChI,MAAM,GAAG,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC5H,MAAM,cAAc,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,mCAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChL,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8DAA8D,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAEpL,iFAAiF;QACjF,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE;YACtC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,iDAAiD,CAAC,CAAC;SACpG;QAED,UAAU,GAAG,IAAI,yBAAU,CAAC,oFAAoF,CAAC,CAAC;QAClH,MAAM,WAAW,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACzE,IAAA,qBAAM,EAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,wEAAwE,CAAC,CAAC;QACrH,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAEhI,IAAI;YACF,2GAA2G;YAC3G,MAAM,cAAc,GAAW,cAAc,CAAC,MAAM,CAAC;YACrD,MAAM,cAAc,GAAW,cAAc,GAAG,CAAC,CAAC;YAClD,MAAM,SAAS,GAAiB,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;gBACxC,MAAM,oBAAoB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;gBAC/C,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,EAAE,CAAC;gBACnD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oDAAoD,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;gBAEtJ,MAAM,iBAAiB,GAA2B,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;gBAClI,IAAI,CAAC,CAAC,iBAAiB,EAAE;oBACvB,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,iCAAiC,CAAC,GAAG,CAAC,6CAA6C,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;oBAC3K,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBAClC,SAAS;iBACV;gBAED,4DAA4D;gBAC5D,IAAI,CAAC,KAAK,cAAc,EAAE;oBACxB,UAAU,GAAG,IAAI,yBAAU,CAAC,+EAA+E,CAAC,CAAC;oBAE7G,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,oBAAoB,CAAC,KAAK,EAAE,CAAC,CAAC;oBAC/E,UAAU,CAAC,OAAO,EAAE,CAAC;oBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8BAA8B,CAAC,GAAG,CAAC,2BAA2B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;iBACxJ;gBAED,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,QAAQ,CAAC;gBACxD,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,iBAAiB,CAAC;oBAC3C,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,qDAAqD,iBAAiB,mBAAmB,CAAC,CAAC;gBAE9I,UAAU,GAAG,IAAI,yBAAU,CAAC,mEAAmE,CAAC,CAAC;gBACjG,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;gBAC3F,UAAU,CAAC,OAAO,EAAE,CAAC;gBACrB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY;oBAC3D,MAAM,IAAI,yBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE/D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wDAAwD,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;gBAEzJ,UAAU,GAAG,IAAI,yBAAU,CAAC,iFAAiF,CAAC,CAAC;gBAC/G,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;gBACpC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAChC,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,WAAW,EAAE,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAC;gBAC1N,UAAU,CAAC,OAAO,EAAE,CAAC;gBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yDAAyD,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;gBAE1J,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,qDAAqD,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;aACtJ;YAED,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,OAAO,SAAS,CAAC;SAClB;gBAAS;YACR,WAAW,CAAC,OAAO,EAAE,CAAC;YAEtB,UAAU,GAAG,IAAI,yBAAU,CAAC,+EAA+E,CAAC,CAAC;YAC7G,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,cAAc;gBACxC,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;YAC5C,UAAU,CAAC,OAAO,EAAE,CAAC;YACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wDAAwD,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;YAElJ,SAAS,CAAC,OAAO,EAAE,CAAC;YACpB,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,qCAAqC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;SAC/H;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,MAAmB;QACxD,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,IAAI,WAAI,EAAE,CAAC;QAC/B,MAAM,mBAAmB,GAAG,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrF,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE;YAC9C,oBAAoB,CAAC,mBAAmB,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAC3E,OAAO,WAAW,CAAC;SACpB;QAED,IAAI;YACF,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACrF,OAAO,WAAW,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,0EAA0E;YAC1E,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC5C,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;YAE7C,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,WAAiB,EAAE,mBAA2B;QACnG,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,IAAI,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACpG,IAAI,IAAI,KAAK,uBAAQ,CAAC,YAAY;YAChC,MAAM,IAAI,yBAAW,CAAC,IAAI,EAAE,0CAA0C,mBAAmB,IAAI,CAAC,CAAC;QAEjG,iGAAiG;QACjG,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAiB,EAAE,mBAA2B;QAC/E,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,mBAAY,CAAC,WAAW,CAAC,CAAC;QAElE,MAAM,mBAAmB,GAAmD,WAAW,CAAC,qBAAqB,CAAC,gHAAgH,EAC5N,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,wCAAwC,CAAC,CAAC;YAE5F,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEL,IAAI,mBAAmB,CAAC,IAAI,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,IAAI;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,OAAO;QAET,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,qBAAqB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,gBAAgB,EAAE,oCAAoC,CAAC,CAAC,CAAC,CAAC;IAEnI,MAAM,CAAC,yBAAyB,CAAC,WAAiB,EAAE,WAAuB;QACjF,OAAO,WAAW,CAAC,qBAAqB,CAAC,uEAAuE,EAC9G,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAChC,IAAI,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE;gBACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAElC,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,WAAiB,EAAE,eAA2B,EAAE,cAA0B,EAAE,oBAAiC,EAAE,WAAoB,EAAE,iBAA0B,EAAE,oBAAiC;QAChO,WAAW,CAAC,qBAAqB,CAAC,uHAAuH,EACvJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YACnC,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,IAAI,WAAW;gBACb,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAElC,IAAI,iBAAiB;gBACnB,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAE1C,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,MAAM,CAAC,GAAa,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,uBAAQ,CAAC,cAAc;gBAC/B,MAAM,IAAI,yBAAW,CAAC,CAAC,EAAE,mEAAmE,eAAe,EAAE,CAAC,CAAC;QACnH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,kBAAkB,CAAC,MAAmB,EAAE,eAA2B;QAC/E,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,OAAO,MAAM,CAAC,qBAAqB,CAAC,mHAAmH,EACrJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oDAAoD,eAAe,GAAG,CAAC,CAAC;YAErH,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;QACpL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAmB,EAAE,gBAA4B;QACjF,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,yBAAyB;QACzB,MAAM,cAAc,GAAmB,MAAM,CAAC,qBAAqB,CAAC;;8FAEsB,EAAE,CAAC,IAAoB,EAAE,EAAE;YACnH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,kCAAkC,gBAAgB,GAAG,CAAC,CAAC;YAEpG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,iBAAiB,GAAe,GAAG,CAAC,iBAAiB,CAAC;YAC5D,MAAM,wBAAwB,GAAW,IAAI,GAAG,CAAC,yBAAyB,MAAM,GAAG,CAAC,wBAAwB,GAAG,CAAC;YAChH,MAAM,EAAE,GAAiB,GAAG,CAAC,MAAsB,CAAC;YAEpD,OAAO;gBACL,EAAE,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAE,wBAAwB,EAAE;gBAC/H,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU;aACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAgB,EAAE,gBAA4B;QACvF,OAAO,MAAM,CAAC,qBAAqB,CAAC,wFAAwF,EAC1H,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YAEjC,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,EAAE;gBAC7C,uGAAuG;gBACvG,MAAM,YAAY,GAAW,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC1D,MAAM,kBAAkB,GAAa,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC7D,IAAA,qBAAM,EAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtC,IAAI,YAAY,GAAY,IAAI,CAAC;gBACjC,IAAI,IAAI,GAAW,EAAE,CAAC;gBACtB,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE;oBACtC,IAAI,CAAC,YAAY;wBACf,IAAI,IAAI,GAAG,CAAC;oBAEd,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC;oBACrB,YAAY,GAAG,KAAK,CAAC;iBACtB;gBACD,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC9B;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,8BAA8B,CAAC,MAAgB,EAAE,kBAAqH,EAAE,iBAAoC,EAAE,oBAA+B;QACzP,IAAI,iBAA2B,CAAC;QAChC,IAAI,CAAC,oBAAoB,EAAE;YACzB,0GAA0G;YAC1G,iBAAiB,GAAG,oBAAoB,CAAC,4BAA4B,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;SACtG;;YACC,iBAAiB,GAAG,oBAAoB,CAAC;QAE3C,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;YAChC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,sDAAsD,kBAAkB,CAAC,EAAE,GAAG,CAAC,CAAC;QAE7H,IAAI,KAAK,GAAW,SAAS,CAAC;QAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;YACpD,IAAI,KAAK,KAAK,CAAC;gBACb,KAAK,IAAI,GAAG,CAAC;YAEf,KAAK,IAAI,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,sGAAsG;QACtG,gDAAgD;QAChD,KAAK,IAAI,cAAc,kBAAkB,CAAC,eAAe,CAAC,SAAS,YAAY,kBAAkB,CAAC,SAAS,IAAI,iBAAiB,wBAAwB,kBAAkB,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;QAChM,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,WAAwB,EAAE,MAAmB;QACnF,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,yCAAyC,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,iDAAiD,CAAC,CAAC;QAEpG,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,gBAAgB,GAAW,mCAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAE/J,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC5C,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,kCAAkC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3G,IAAI,WAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACnE,IAAA,qBAAM,EAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,qDAAqD,CAAC,CAAC;YAElG,IAAI,eAAe,GAAG,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC/F,IAAI,eAAe,KAAK,SAAS,EAAE;gBACjC,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,yEAAyE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC1J,OAAO,eAAe,CAAC;aACxB;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC5F,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY;gBAC3D,MAAM,IAAI,yBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE/D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;YAC9B,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;YAEvK,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,OAAO,eAAe,CAAC;SACxB;gBAAS;YACR,IAAI,WAAW,KAAK,SAAS;gBAC3B,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SAC3C;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAA6B;;QACrE,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,WAAW,mCAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,mCAAI,EAAE,CAAC;QAChF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC1C,KAAK,CAAC,GAAG,GAAG,MAAA,KAAK,CAAC,GAAG,mCAAI,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChJ,IAAI,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG;YACzB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAC5E,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC;YACtC,OAAO,EAAE,CAAC,CAAC,uDAAuD;QAEpE,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAEhG,uEAAuE;QACvE,MAAM,aAAa,GAAG,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;QAChF,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,IAAI,MAA+B,CAAC;QACpC,IAAI;YACF,2DAA2D;YAC3D,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnK,MAAM,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE9D,MAAM,UAAU,GAAG,IAAI,KAAK,EAAc,CAAC;YAC3C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACtD,kCAAkC;gBAClC,IAAI,KAAK,GAAG,CAAC;oBACX,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;gBAE9E,mEAAmE;gBACnE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACtE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC5B;YACD,OAAO,UAAU,CAAC;SACnB;gBAAS;YACR,IAAI,MAAM,KAAK,SAAS;gBACtB,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACjC;IACH,CAAC;;AAhfH,oDAifC;AAhfyB,sDAAiC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { AccessToken, assert, DbResult, GuidString, Id64String, IModelStatus, Logger, PerfLogger, using } from \"@itwin/core-bentley\";\r\nimport { ChangedValueState, ChangeOpCode, ChangesetRange, IModelError, IModelVersion } from \"@itwin/core-common\";\r\nimport * as path from \"path\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { ECDb, ECDbOpenMode } from \"./ECDb\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { BriefcaseDb, IModelDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.ECDb;\r\n\r\n/** Represents an instance of the `ChangeSummary` ECClass from the `ECDbChange` ECSchema\r\n * combined with the information from the related `Changeset` instance (from the `IModelChange` ECSchema) from\r\n * which the Change Summary was extracted.\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryChangeSummary]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface ChangeSummary {\r\n id: Id64String;\r\n changeSet: { wsgId: GuidString, parentWsgId: GuidString, description: string, pushDate: string, userCreated: GuidString };\r\n}\r\n\r\n/** Represents an instance of the `InstanceChange` ECClass from the `ECDbChange` ECSchema\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryInstanceChange]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface InstanceChange {\r\n id: Id64String;\r\n summaryId: Id64String;\r\n changedInstance: { id: Id64String, className: string };\r\n opCode: ChangeOpCode;\r\n isIndirect: boolean;\r\n}\r\n\r\n/** Options for [ChangeSummaryManager.extractChangeSummaries]($backend).\r\n * @beta\r\n * @deprecated Use [CreateChangeSummaryArgs]($core-backend) instead\r\n */\r\nexport interface ChangeSummaryExtractOptions {\r\n /** If specified, change summaries are extracted from the start version to the current version as of which the iModel\r\n * was opened. If undefined, the extraction starts at the first version of the iModel.\r\n */\r\n startVersion?: IModelVersion;\r\n /** If specified, the change summary will be extracted only for current version as of which the iModel\r\n * was opened.\r\n */\r\n currentVersionOnly?: boolean;\r\n}\r\n\r\n/** Options for [ChangeSummaryManager.createChangeSummaries]($backend).\r\n * @beta\r\n */\r\nexport interface CreateChangeSummaryArgs extends TokenArg {\r\n /** Id of the iTwin that contains the iModel */\r\n iTwinId: GuidString;\r\n\r\n /** Id of the iModel */\r\n iModelId: GuidString;\r\n\r\n /**\r\n * Range of change sets\r\n * - the Change Summary for the first and last versions are also included\r\n * - if unspecified, all change sets until the latest version are processed\r\n */\r\n range: ChangesetRange;\r\n}\r\n\r\n/** Class to extract Change Summaries for a briefcase.\r\n *\r\n * See also:\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport class ChangeSummaryManager {\r\n private static readonly _currentIModelChangeSchemaVersion = { read: 2, write: 0, minor: 0 };\r\n\r\n /** Determines whether the *Change Cache file* is attached to the specified iModel or not\r\n * @param iModel iModel to check whether a *Change Cache file* is attached\r\n * @returns Returns true if the *Change Cache file* is attached to the iModel. false otherwise\r\n */\r\n public static isChangeCacheAttached(iModel: IModelDb): boolean {\r\n if (!iModel || !iModel.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n return iModel.nativeDb.isChangeCacheAttached();\r\n }\r\n\r\n /** Attaches the *Change Cache file* to the specified iModel if it hasn't been attached yet.\r\n * A new *Change Cache file* will be created for the iModel if it hasn't existed before.\r\n * @param iModel iModel to attach the *Change Cache file* file to\r\n * @throws [IModelError]($common)\r\n */\r\n public static attachChangeCache(iModel: IModelDb): void {\r\n if (!iModel || !iModel.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n if (ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n return;\r\n\r\n const changesCacheFilePath: string = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n if (!IModelJsFs.existsSync(changesCacheFilePath)) {\r\n using(new ECDb(), (changeCacheFile: ECDb) => {\r\n ChangeSummaryManager.createChangeCacheFile(iModel, changeCacheFile, changesCacheFilePath);\r\n });\r\n }\r\n\r\n assert(IModelJsFs.existsSync(changesCacheFilePath));\r\n const res: DbResult = iModel.nativeDb.attachChangeCache(changesCacheFilePath);\r\n if (res !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(res, `Failed to attach Change Cache file to ${iModel.pathName}.`);\r\n }\r\n\r\n /** Detaches the *Change Cache file* from the specified iModel.\r\n * - note that this method will cause any pending (currently running or queued) queries to fail\r\n * @param iModel iModel to detach the *Change Cache file* to\r\n * @throws [IModelError]($common) in case of errors, e.g. if no *Change Cache file* was attached before.\r\n */\r\n public static detachChangeCache(iModel: IModelDb): void {\r\n if (!iModel || !iModel.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n iModel.clearCaches();\r\n const res: DbResult = iModel.nativeDb.detachChangeCache();\r\n if (res !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(res, `Failed to detach Change Cache file from ${iModel.pathName}.`);\r\n }\r\n\r\n /** Extracts change summaries from the specified iModel.\r\n * Change summaries are extracted from the version the iModel was opened with up through the specified start version.\r\n * If no start version has been specified, the first version will be used.\r\n * @param accessToken A valid access token string\r\n * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel.\r\n * Note: For every version to extract a summary from, the method moves the iModel to that version before extraction. After\r\n * the extraction has completed, the iModel is moved back to the original version.\r\n * @param options Extraction options\r\n * @return the Ids of the extracted change summaries.\r\n * @throws [IModelError]($common) if the iModel is standalone\r\n * @deprecated Use [ChangeSummaryManager.createChangeSummaries]($core-backend) instead\r\n */\r\n public static async extractChangeSummaries(accessToken: AccessToken, iModel: BriefcaseDb, options?: ChangeSummaryExtractOptions): Promise<Id64String[]> { // eslint-disable-line deprecation/deprecation\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n const iModelId = iModel.iModelId;\r\n const endChangeSetId = iModel.changeset.id;\r\n assert(endChangeSetId.length !== 0);\r\n\r\n let startChangeSetId = \"\";\r\n if (options) {\r\n if (options.startVersion) {\r\n startChangeSetId = (await IModelHost.hubAccess.getChangesetFromVersion({ version: options.startVersion, accessToken, iModelId })).id;\r\n } else if (options.currentVersionOnly) {\r\n startChangeSetId = endChangeSetId;\r\n }\r\n }\r\n\r\n Logger.logInfo(loggerCategory, \"Started Change Summary extraction...\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n const totalPerf = new PerfLogger(`ChangeSummaryManager.extractChangeSummaries [ChangeSets: ${startChangeSetId} through ${endChangeSetId}, iModel: ${iModelId}]`);\r\n\r\n // download necessary changesets if they were not downloaded before and retrieve infos about those changesets\r\n let perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Retrieve ChangeSetInfos and download Changesets from Hub\");\r\n\r\n const first = (await IModelHost.hubAccess.queryChangeset({ iModelId, changeset: { id: startChangeSetId }, accessToken })).index;\r\n const end = (await IModelHost.hubAccess.queryChangeset({ iModelId, changeset: { id: endChangeSetId }, accessToken })).index;\r\n const changeSetInfos = await IModelHost.hubAccess.downloadChangesets({ accessToken, iModelId, range: { first, end }, targetDir: BriefcaseManager.getChangeSetsPath(iModelId) });\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, \"Retrieved changesets to extract from from cache or from hub.\", () => ({ iModelId, startChangeSetId, endChangeSetId, changeSets: changeSetInfos }));\r\n\r\n // Ensure change cache is detached as it's being written to during the extraction\r\n if (this.isChangeCacheAttached(iModel)) {\r\n throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Change cache must be detached before extraction\");\r\n }\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Open or create local Change Cache file\");\r\n const changesFile = ChangeSummaryManager.openOrCreateChangesFile(iModel);\r\n assert(changesFile.nativeDb !== undefined, \"Should not happen as an exception should have been thrown in that case\");\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, \"Opened or created Changes Cachefile.\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n\r\n try {\r\n // extract summaries from end changeset through start changeset, so that we only have to go back in history\r\n const changeSetCount: number = changeSetInfos.length;\r\n const endChangeSetIx: number = changeSetCount - 1;\r\n const summaries: Id64String[] = [];\r\n for (let i = endChangeSetIx; i >= 0; i--) {\r\n const currentChangeSetInfo = changeSetInfos[i];\r\n const currentChangeSetId = currentChangeSetInfo.id;\r\n Logger.logInfo(loggerCategory, `Started Change Summary extraction for changeset #${i + 1}...`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n\r\n const existingSummaryId: Id64String | undefined = ChangeSummaryManager.isSummaryAlreadyExtracted(changesFile, currentChangeSetId);\r\n if (!!existingSummaryId) {\r\n Logger.logInfo(loggerCategory, `Change Summary for changeset #${i + 1} already exists. It is not extracted again.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n summaries.push(existingSummaryId);\r\n continue;\r\n }\r\n\r\n // iModel is at end changeset, so no need to reverse for it.\r\n if (i !== endChangeSetIx) {\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Roll iModel to previous changeset\");\r\n\r\n await iModel.pullChanges({ accessToken, toIndex: currentChangeSetInfo.index });\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, `Moved iModel to changeset #${i + 1} to extract summary from.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n }\r\n\r\n const changeSetFilePath = currentChangeSetInfo.pathname;\r\n if (!IModelJsFs.existsSync(changeSetFilePath))\r\n throw new IModelError(IModelStatus.FileNotFound, `Failed to extract change summary: ChangeSet file \"${changeSetFilePath}\" does not exist.`);\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Extract ChangeSummary\");\r\n const stat = iModel.nativeDb.extractChangeSummary(changesFile.nativeDb, changeSetFilePath);\r\n perfLogger.dispose();\r\n if (stat.error && stat.error.status !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(stat.error.status, stat.error.message);\r\n\r\n Logger.logTrace(loggerCategory, `Actual Change summary extraction done for changeset #${i + 1}.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Add ChangeSet info to ChangeSummary\");\r\n assert(undefined !== stat.result);\r\n const changeSummaryId = stat.result;\r\n summaries.push(changeSummaryId);\r\n ChangeSummaryManager.addExtendedInfos(changesFile, changeSummaryId, currentChangeSetId, currentChangeSetInfo.parentId, currentChangeSetInfo.description, currentChangeSetInfo.pushDate, currentChangeSetInfo.userCreated);\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, `Added extended infos to Change Summary for changeset #${i + 1}.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n\r\n Logger.logInfo(loggerCategory, `Finished Change Summary extraction for changeset #${i + 1}.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n }\r\n\r\n changesFile.saveChanges();\r\n return summaries;\r\n } finally {\r\n changesFile.dispose();\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Move iModel to original changeset\");\r\n if (iModel.changeset.id !== endChangeSetId)\r\n await iModel.pullChanges({ accessToken });\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, \"Moved iModel to initial changeset (the end changeset).\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n\r\n totalPerf.dispose();\r\n Logger.logInfo(loggerCategory, \"Finished Change Summary extraction.\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n }\r\n }\r\n\r\n private static openOrCreateChangesFile(iModel: BriefcaseDb): ECDb {\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadArg, \"Invalid iModel handle. iModel must be open.\");\r\n\r\n const changesFile = new ECDb();\r\n const changeCacheFilePath = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n if (IModelJsFs.existsSync(changeCacheFilePath)) {\r\n ChangeSummaryManager.openChangeCacheFile(changesFile, changeCacheFilePath);\r\n return changesFile;\r\n }\r\n\r\n try {\r\n ChangeSummaryManager.createChangeCacheFile(iModel, changesFile, changeCacheFilePath);\r\n return changesFile;\r\n } catch (e) {\r\n // delete cache file again in case it was created but schema import failed\r\n if (IModelJsFs.existsSync(changeCacheFilePath))\r\n IModelJsFs.removeSync(changeCacheFilePath);\r\n\r\n throw e;\r\n }\r\n }\r\n\r\n private static createChangeCacheFile(iModel: IModelDb, changesFile: ECDb, changeCacheFilePath: string): void {\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadArg, \"Invalid iModel object. iModel must be open.\");\r\n\r\n const stat: DbResult = iModel.nativeDb.createChangeCache(changesFile.nativeDb, changeCacheFilePath);\r\n if (stat !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(stat, `Failed to create Change Cache file at \"${changeCacheFilePath}\".`);\r\n\r\n // Extended information like changeset ids, push dates are persisted in the IModelChange ECSchema\r\n changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n }\r\n\r\n private static openChangeCacheFile(changesFile: ECDb, changeCacheFilePath: string): void {\r\n changesFile.openDb(changeCacheFilePath, ECDbOpenMode.FileUpgrade);\r\n\r\n const actualSchemaVersion: { read: number, write: number, minor: number } = changesFile.withPreparedStatement(\"SELECT VersionMajor read,VersionWrite write,VersionMinor minor FROM meta.ECSchemaDef WHERE Name='IModelChange'\",\r\n (stmt: ECSqlStatement) => {\r\n if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n throw new IModelError(DbResult.BE_SQLITE_ERROR, \"File is not a valid Change Cache file.\");\r\n\r\n return stmt.getRow();\r\n });\r\n\r\n if (actualSchemaVersion.read === ChangeSummaryManager._currentIModelChangeSchemaVersion.read &&\r\n actualSchemaVersion.write === ChangeSummaryManager._currentIModelChangeSchemaVersion.write &&\r\n actualSchemaVersion.minor === ChangeSummaryManager._currentIModelChangeSchemaVersion.minor)\r\n return;\r\n\r\n changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n }\r\n\r\n private static getExtendedSchemaPath(): string { return path.join(KnownLocations.packageAssetsDir, \"IModelChange.02.00.00.ecschema.xml\"); }\r\n\r\n private static isSummaryAlreadyExtracted(changesFile: ECDb, changeSetId: GuidString): Id64String | undefined {\r\n return changesFile.withPreparedStatement(\"SELECT Summary.Id summaryid FROM imodelchange.ChangeSet WHERE WsgId=?\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindString(1, changeSetId);\r\n if (DbResult.BE_SQLITE_ROW === stmt.step())\r\n return stmt.getValue(0).getId();\r\n\r\n return undefined;\r\n });\r\n }\r\n\r\n private static addExtendedInfos(changesFile: ECDb, changeSummaryId: Id64String, changesetWsgId: GuidString, changesetParentWsgId?: GuidString, description?: string, changesetPushDate?: string, changeSetUserCreated?: GuidString): void {\r\n changesFile.withPreparedStatement(\"INSERT INTO imodelchange.ChangeSet(Summary.Id,WsgId,ParentWsgId,Description,PushDate,UserCreated) VALUES(?,?,?,?,?,?)\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, changeSummaryId);\r\n stmt.bindString(2, changesetWsgId);\r\n if (changesetParentWsgId)\r\n stmt.bindString(3, changesetParentWsgId);\r\n\r\n if (description)\r\n stmt.bindString(4, description);\r\n\r\n if (changesetPushDate)\r\n stmt.bindDateTime(5, changesetPushDate);\r\n\r\n if (changeSetUserCreated)\r\n stmt.bindString(6, changeSetUserCreated);\r\n\r\n const r: DbResult = stmt.step();\r\n if (r !== DbResult.BE_SQLITE_DONE)\r\n throw new IModelError(r, `Failed to add changeset information to extracted change summary ${changeSummaryId}`);\r\n });\r\n }\r\n\r\n /** Queries the ChangeSummary for the specified change summary id\r\n *\r\n * See also\r\n * - `ECDbChange.ChangeSummary` ECClass in the *ECDbChange* ECSchema\r\n * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param changeSummaryId ECInstanceId of the ChangeSummary\r\n * @returns Returns the requested ChangeSummary object\r\n * @throws [IModelError]($common) If change summary does not exist for the specified id, or if the\r\n * change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static queryChangeSummary(iModel: BriefcaseDb, changeSummaryId: Id64String): ChangeSummary {\r\n if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n return iModel.withPreparedStatement(\"SELECT WsgId,ParentWsgId,Description,PushDate,UserCreated FROM ecchange.imodelchange.ChangeSet WHERE Summary.Id=?\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, changeSummaryId);\r\n if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n throw new IModelError(IModelStatus.BadArg, `No ChangeSet information found for ChangeSummary ${changeSummaryId}.`);\r\n\r\n const row = stmt.getRow();\r\n return { id: changeSummaryId, changeSet: { wsgId: row.wsgId, parentWsgId: row.parentWsgId, description: row.description, pushDate: row.pushDate, userCreated: row.userCreated } };\r\n });\r\n }\r\n\r\n /** Queries the InstanceChange for the specified instance change id.\r\n *\r\n * See also\r\n * - `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema\r\n * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param instanceChangeId ECInstanceId of the InstanceChange (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n * @returns Returns the requested InstanceChange object (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n * @throws [IModelError]($common) if instance change does not exist for the specified id, or if the\r\n * change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static queryInstanceChange(iModel: BriefcaseDb, instanceChangeId: Id64String): InstanceChange {\r\n if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n // query instance changes\r\n const instanceChange: InstanceChange = iModel.withPreparedStatement(`SELECT ic.Summary.Id summaryId, s.Name changedInstanceSchemaName, c.Name changedInstanceClassName, ic.ChangedInstance.Id changedInstanceId,\r\n ic.OpCode, ic.IsIndirect FROM ecchange.change.InstanceChange ic JOIN main.meta.ECClassDef c ON c.ECInstanceId = ic.ChangedInstance.ClassId\r\n JOIN main.meta.ECSchemaDef s ON c.Schema.Id = s.ECInstanceId WHERE ic.ECInstanceId =? `, (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, instanceChangeId);\r\n if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n throw new IModelError(IModelStatus.BadArg, `No InstanceChange found for id ${instanceChangeId}.`);\r\n\r\n const row = stmt.getRow();\r\n const changedInstanceId: Id64String = row.changedInstanceId;\r\n const changedInstanceClassName: string = `[${row.changedInstanceSchemaName}].[${row.changedInstanceClassName}]`;\r\n const op: ChangeOpCode = row.opCode as ChangeOpCode;\r\n\r\n return {\r\n id: instanceChangeId, summaryId: row.summaryId, changedInstance: { id: changedInstanceId, className: changedInstanceClassName },\r\n opCode: op, isIndirect: row.isIndirect,\r\n };\r\n });\r\n\r\n return instanceChange;\r\n }\r\n\r\n /** Retrieves the names of the properties whose values have changed for the given instance change\r\n *\r\n * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param instanceChangeId Id of the InstanceChange to query the properties whose values have changed\r\n * @returns Returns names of the properties whose values have changed for the given instance change\r\n * @throws [IModelError]($common) if the change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static getChangedPropertyValueNames(iModel: IModelDb, instanceChangeId: Id64String): string[] {\r\n return iModel.withPreparedStatement(\"SELECT AccessString FROM ecchange.change.PropertyValueChange WHERE InstanceChange.Id=?\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, instanceChangeId);\r\n\r\n const selectClauseItems: string[] = [];\r\n while (stmt.step() === DbResult.BE_SQLITE_ROW) {\r\n // access string tokens need to be escaped as they might collide with reserved words in ECSQL or SQLite\r\n const accessString: string = stmt.getValue(0).getString();\r\n const accessStringTokens: string[] = accessString.split(\".\");\r\n assert(accessStringTokens.length > 0);\r\n\r\n let isFirstToken: boolean = true;\r\n let item: string = \"\";\r\n for (const token of accessStringTokens) {\r\n if (!isFirstToken)\r\n item += \".\";\r\n\r\n item += `[${token}]`;\r\n isFirstToken = false;\r\n }\r\n selectClauseItems.push(item);\r\n }\r\n\r\n return selectClauseItems;\r\n });\r\n }\r\n\r\n /** Builds the ECSQL to query the property value changes for the specified instance change and the specified ChangedValueState.\r\n *\r\n * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param instanceChangeInfo InstanceChange to query the property value changes for\r\n * changedInstance.className must be fully qualified and schema and class name must be escaped with square brackets if they collide with reserved ECSQL words: `[schema name].[class name]`\r\n * @param changedValueState The Changed State to query the values for. This must correspond to the [InstanceChange.OpCode]($backend) of the InstanceChange.\r\n * @param changedPropertyNames List of the property names for which values have changed for the specified instance change.\r\n * The list can be obtained by calling [ChangeSummaryManager.getChangedPropertyValueNames]($core-backend).\r\n * If omitted, the method will call the above method by itself. The parameter allows for checking first whether\r\n * an instance change has any property value changes at all. If there are no property value changes, this method\r\n * should not be called, as it will throw an error.\r\n * @returns Returns the ECSQL that will retrieve the property value changes\r\n * @throws [IModelError]($common) if instance change does not exist, if there are not property value changes for the instance change,\r\n * if the change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static buildPropertyValueChangesECSql(iModel: IModelDb, instanceChangeInfo: { id: Id64String, summaryId: Id64String, changedInstance: { id: Id64String, className: string } }, changedValueState: ChangedValueState, changedPropertyNames?: string[]): string {\r\n let selectClauseItems: string[];\r\n if (!changedPropertyNames) {\r\n // query property value changes just to build a SELECT statement against the class of the changed instance\r\n selectClauseItems = ChangeSummaryManager.getChangedPropertyValueNames(iModel, instanceChangeInfo.id);\r\n } else\r\n selectClauseItems = changedPropertyNames;\r\n\r\n if (selectClauseItems.length === 0)\r\n throw new IModelError(IModelStatus.BadArg, `No property value changes found for InstanceChange ${instanceChangeInfo.id}.`);\r\n\r\n let ecsql: string = \"SELECT \";\r\n selectClauseItems.map((item: string, index: number) => {\r\n if (index !== 0)\r\n ecsql += \",\";\r\n\r\n ecsql += item;\r\n });\r\n\r\n // Avoiding parameters in the Changes function speeds up performance because ECDb can do optimizations\r\n // if it knows the function args at prepare time\r\n ecsql += ` FROM main.${instanceChangeInfo.changedInstance.className}.Changes(${instanceChangeInfo.summaryId},${changedValueState}) WHERE ECInstanceId=${instanceChangeInfo.changedInstance.id}`;\r\n return ecsql;\r\n }\r\n\r\n /**\r\n * Creates a change summary for the last applied change set to the iModel\r\n * @param accessToken A valid access token string\r\n * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel, and must have at least one change set applied to it.\r\n * @returns The id of the extracted change summary.\r\n * @beta\r\n */\r\n public static async createChangeSummary(accessToken: AccessToken, iModel: BriefcaseDb): Promise<Id64String> {\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n const changesetId = iModel.changeset.id;\r\n if (!changesetId)\r\n throw new IModelError(IModelStatus.BadRequest, \"No change set was applied to the iModel\");\r\n if (this.isChangeCacheAttached(iModel))\r\n throw new IModelError(IModelStatus.BadRequest, \"Change cache must be detached before extraction\");\r\n\r\n const iModelId = iModel.iModelId;\r\n const changesetsFolder: string = BriefcaseManager.getChangeSetsPath(iModelId);\r\n const changeset = await IModelHost.hubAccess.downloadChangeset({ accessToken, iModelId, changeset: { id: iModel.changeset.id }, targetDir: changesetsFolder });\r\n\r\n if (!IModelJsFs.existsSync(changeset.pathname))\r\n throw new IModelError(IModelStatus.FileNotFound, `Failed to download change set: ${changeset.pathname}`);\r\n\r\n let changesFile: ECDb | undefined;\r\n try {\r\n changesFile = ChangeSummaryManager.openOrCreateChangesFile(iModel);\r\n assert(changesFile.nativeDb !== undefined, \"Invalid changesFile - should've caused an exception\");\r\n\r\n let changeSummaryId = ChangeSummaryManager.isSummaryAlreadyExtracted(changesFile, changesetId);\r\n if (changeSummaryId !== undefined) {\r\n Logger.logInfo(loggerCategory, `Change Summary for changeset already exists. It is not extracted again.`, () => ({ iModelId, changeSetId: changesetId }));\r\n return changeSummaryId;\r\n }\r\n\r\n const stat = iModel.nativeDb.extractChangeSummary(changesFile.nativeDb, changeset.pathname);\r\n if (stat.error && stat.error.status !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(stat.error.status, stat.error.message);\r\n\r\n assert(undefined !== stat.result);\r\n changeSummaryId = stat.result;\r\n ChangeSummaryManager.addExtendedInfos(changesFile, changeSummaryId, changesetId, changeset.parentId, changeset.description, changeset.pushDate, changeset.userCreated);\r\n\r\n changesFile.saveChanges();\r\n return changeSummaryId;\r\n } finally {\r\n if (changesFile !== undefined)\r\n changesFile.dispose();\r\n IModelJsFs.unlinkSync(changeset.pathname);\r\n }\r\n }\r\n\r\n /**\r\n * Creates change summaries for the specified iModel and a specified range of versions\r\n * @note This may be an expensive operation - downloads the first version and starts applying the change sets, extracting summaries one by one\r\n * @param args Arguments including the range of versions for which Change Summaries are to be created, and other necessary input for creation\r\n */\r\n public static async createChangeSummaries(args: CreateChangeSummaryArgs): Promise<Id64String[]> {\r\n const accessToken = args.accessToken ?? await IModelHost.getAccessToken() ?? \"\";\r\n const { iModelId, iTwinId, range } = args;\r\n range.end = range.end ?? (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.latest() })).index;\r\n if (range.first > range.end)\r\n throw new IModelError(IModelStatus.BadArg, \"Invalid range of changesets\");\r\n if (range.first === 0 && range.end === 0)\r\n return []; // no changesets exist, so the inclusive range is empty\r\n\r\n const changesets = await IModelHost.hubAccess.queryChangesets({ accessToken, iModelId, range });\r\n\r\n // Setup a temporary briefcase to help with extracting change summaries\r\n const briefcasePath = BriefcaseManager.getBriefcaseBasePath(iModelId);\r\n const fileName: string = path.join(briefcasePath, `ChangeSummaryBriefcase.bim`);\r\n if (IModelJsFs.existsSync(fileName))\r\n IModelJsFs.removeSync(fileName);\r\n\r\n let iModel: BriefcaseDb | undefined;\r\n try {\r\n // Download a version that has the first change set applied\r\n const props = await BriefcaseManager.downloadBriefcase({ accessToken, iTwinId, iModelId, asOf: { afterChangeSetId: changesets[0].id }, briefcaseId: 0, fileName });\r\n iModel = await BriefcaseDb.open({ fileName: props.fileName });\r\n\r\n const summaryIds = new Array<Id64String>();\r\n for (let index = 0; index < changesets.length; index++) {\r\n // Apply a change set if necessary\r\n if (index > 0)\r\n await iModel.pullChanges({ accessToken, toIndex: changesets[index].index });\r\n\r\n // Create a change summary for the last change set that was applied\r\n const summaryId = await this.createChangeSummary(accessToken, iModel);\r\n summaryIds.push(summaryId);\r\n }\r\n return summaryIds;\r\n } finally {\r\n if (iModel !== undefined)\r\n iModel.close();\r\n IModelJsFs.removeSync(fileName);\r\n }\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ChangeSummaryManager.js","sourceRoot":"","sources":["../../src/ChangeSummaryManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqI;AACrI,oDAAiH;AACjH,6BAA6B;AAC7B,mEAAgE;AAChE,yDAAsD;AACtD,iCAA4C;AAE5C,yCAA6D;AAC7D,6CAA0D;AAC1D,6CAA0C;AAE1C,MAAM,cAAc,GAAW,6CAAqB,CAAC,IAAI,CAAC;AAgE1D;;;;;GAKG;AACH,MAAa,oBAAoB;IAG/B;;;OAGG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAgB;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,OAAO,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpD,OAAO;QAET,MAAM,oBAAoB,GAAW,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9F,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE;YAChD,IAAA,oBAAK,EAAC,IAAI,WAAI,EAAE,EAAE,CAAC,eAAqB,EAAE,EAAE;gBAC1C,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;SACJ;QAED,IAAA,qBAAM,EAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACpD,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;QAC9E,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,yCAAyC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC1D,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,2CAA2C,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,WAAwB,EAAE,MAAmB,EAAE,OAAqC;QAC7H,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3C,IAAA,qBAAM,EAAC,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAEpC,IAAI,gBAAgB,GAAG,EAAE,CAAC;QAC1B,IAAI,OAAO,EAAE;YACX,IAAI,OAAO,CAAC,YAAY,EAAE;gBACxB,gBAAgB,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtI;iBAAM,IAAI,OAAO,CAAC,kBAAkB,EAAE;gBACrC,gBAAgB,GAAG,cAAc,CAAC;aACnC;SACF;QAED,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAC/H,MAAM,SAAS,GAAG,IAAI,yBAAU,CAAC,4DAA4D,gBAAgB,YAAY,cAAc,aAAa,QAAQ,GAAG,CAAC,CAAC;QAEjK,6GAA6G;QAC7G,IAAI,UAAU,GAAG,IAAI,yBAAU,CAAC,sGAAsG,CAAC,CAAC;QAExI,MAAM,KAAK,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChI,MAAM,GAAG,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC5H,MAAM,cAAc,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,mCAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChL,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8DAA8D,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAEpL,iFAAiF;QACjF,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE;YACtC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,iDAAiD,CAAC,CAAC;SACpG;QAED,UAAU,GAAG,IAAI,yBAAU,CAAC,oFAAoF,CAAC,CAAC;QAClH,MAAM,WAAW,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACzE,IAAA,qBAAM,EAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,wEAAwE,CAAC,CAAC;QACrH,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAEhI,IAAI;YACF,2GAA2G;YAC3G,MAAM,cAAc,GAAW,cAAc,CAAC,MAAM,CAAC;YACrD,MAAM,cAAc,GAAW,cAAc,GAAG,CAAC,CAAC;YAClD,MAAM,SAAS,GAAiB,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;gBACxC,MAAM,oBAAoB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;gBAC/C,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,EAAE,CAAC;gBACnD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oDAAoD,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;gBAEtJ,MAAM,iBAAiB,GAA2B,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;gBAClI,IAAI,CAAC,CAAC,iBAAiB,EAAE;oBACvB,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,iCAAiC,CAAC,GAAG,CAAC,6CAA6C,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;oBAC3K,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBAClC,SAAS;iBACV;gBAED,4DAA4D;gBAC5D,IAAI,CAAC,KAAK,cAAc,EAAE;oBACxB,UAAU,GAAG,IAAI,yBAAU,CAAC,+EAA+E,CAAC,CAAC;oBAE7G,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,oBAAoB,CAAC,KAAK,EAAE,CAAC,CAAC;oBAC/E,UAAU,CAAC,OAAO,EAAE,CAAC;oBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8BAA8B,CAAC,GAAG,CAAC,2BAA2B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;iBACxJ;gBAED,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,QAAQ,CAAC;gBACxD,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,iBAAiB,CAAC;oBAC3C,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,qDAAqD,iBAAiB,mBAAmB,CAAC,CAAC;gBAE9I,UAAU,GAAG,IAAI,yBAAU,CAAC,mEAAmE,CAAC,CAAC;gBACjG,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;gBAC3F,UAAU,CAAC,OAAO,EAAE,CAAC;gBACrB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY;oBAC3D,MAAM,IAAI,yBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE/D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wDAAwD,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;gBAEzJ,UAAU,GAAG,IAAI,yBAAU,CAAC,iFAAiF,CAAC,CAAC;gBAC/G,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;gBACpC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAChC,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,WAAW,EAAE,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAC;gBAC1N,UAAU,CAAC,OAAO,EAAE,CAAC;gBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yDAAyD,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;gBAE1J,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,qDAAqD,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;aACtJ;YAED,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,OAAO,SAAS,CAAC;SAClB;gBAAS;YACR,WAAW,CAAC,OAAO,EAAE,CAAC;YAEtB,UAAU,GAAG,IAAI,yBAAU,CAAC,+EAA+E,CAAC,CAAC;YAC7G,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,cAAc;gBACxC,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;YAC5C,UAAU,CAAC,OAAO,EAAE,CAAC;YACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wDAAwD,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;YAElJ,SAAS,CAAC,OAAO,EAAE,CAAC;YACpB,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,qCAAqC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;SAC/H;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,MAAmB;QACxD,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,IAAI,WAAI,EAAE,CAAC;QAC/B,MAAM,mBAAmB,GAAG,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrF,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE;YAC9C,oBAAoB,CAAC,mBAAmB,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAC3E,OAAO,WAAW,CAAC;SACpB;QAED,IAAI;YACF,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACrF,OAAO,WAAW,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,0EAA0E;YAC1E,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC5C,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;YAE7C,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,WAAiB,EAAE,mBAA2B;QACnG,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,IAAI,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACpG,IAAI,IAAI,KAAK,uBAAQ,CAAC,YAAY;YAChC,MAAM,IAAI,yBAAW,CAAC,IAAI,EAAE,0CAA0C,mBAAmB,IAAI,CAAC,CAAC;QAEjG,iGAAiG;QACjG,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAiB,EAAE,mBAA2B;QAC/E,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,mBAAY,CAAC,WAAW,CAAC,CAAC;QAElE,MAAM,mBAAmB,GAAmD,WAAW,CAAC,qBAAqB,CAAC,gHAAgH,EAC5N,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,wCAAwC,CAAC,CAAC;YAE5F,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEL,IAAI,mBAAmB,CAAC,IAAI,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,IAAI;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,OAAO;QAET,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,qBAAqB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,gBAAgB,EAAE,oCAAoC,CAAC,CAAC,CAAC,CAAC;IAEnI,MAAM,CAAC,yBAAyB,CAAC,WAAiB,EAAE,WAAuB;QACjF,OAAO,WAAW,CAAC,qBAAqB,CAAC,uEAAuE,EAC9G,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAChC,IAAI,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE;gBACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAElC,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,WAAiB,EAAE,eAA2B,EAAE,cAA0B,EAAE,oBAAiC,EAAE,WAAoB,EAAE,iBAA0B,EAAE,oBAAiC;QAChO,WAAW,CAAC,qBAAqB,CAAC,uHAAuH,EACvJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YACnC,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,IAAI,WAAW;gBACb,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAElC,IAAI,iBAAiB;gBACnB,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAE1C,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,MAAM,CAAC,GAAa,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,uBAAQ,CAAC,cAAc;gBAC/B,MAAM,IAAI,yBAAW,CAAC,CAAC,EAAE,mEAAmE,eAAe,EAAE,CAAC,CAAC;QACnH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,kBAAkB,CAAC,MAAmB,EAAE,eAA2B;QAC/E,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,OAAO,MAAM,CAAC,qBAAqB,CAAC,mHAAmH,EACrJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oDAAoD,eAAe,GAAG,CAAC,CAAC;YAErH,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;QACpL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAmB,EAAE,gBAA4B;QACjF,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,yBAAyB;QACzB,MAAM,cAAc,GAAmB,MAAM,CAAC,qBAAqB,CAAC;;8FAEsB,EAAE,CAAC,IAAoB,EAAE,EAAE;YACnH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,kCAAkC,gBAAgB,GAAG,CAAC,CAAC;YAEpG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,iBAAiB,GAAe,GAAG,CAAC,iBAAiB,CAAC;YAC5D,MAAM,wBAAwB,GAAW,IAAI,GAAG,CAAC,yBAAyB,MAAM,GAAG,CAAC,wBAAwB,GAAG,CAAC;YAChH,MAAM,EAAE,GAAiB,GAAG,CAAC,MAAsB,CAAC;YAEpD,OAAO;gBACL,EAAE,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAE,wBAAwB,EAAE;gBAC/H,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU;aACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAgB,EAAE,gBAA4B;QACvF,OAAO,MAAM,CAAC,qBAAqB,CAAC,wFAAwF,EAC1H,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YAEjC,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,EAAE;gBAC7C,uGAAuG;gBACvG,MAAM,YAAY,GAAW,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC1D,MAAM,kBAAkB,GAAa,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC7D,IAAA,qBAAM,EAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtC,IAAI,YAAY,GAAY,IAAI,CAAC;gBACjC,IAAI,IAAI,GAAW,EAAE,CAAC;gBACtB,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE;oBACtC,IAAI,CAAC,YAAY;wBACf,IAAI,IAAI,GAAG,CAAC;oBAEd,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC;oBACrB,YAAY,GAAG,KAAK,CAAC;iBACtB;gBACD,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC9B;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,8BAA8B,CAAC,MAAgB,EAAE,kBAAqH,EAAE,iBAAoC,EAAE,oBAA+B;QACzP,IAAI,iBAA2B,CAAC;QAChC,IAAI,CAAC,oBAAoB,EAAE;YACzB,0GAA0G;YAC1G,iBAAiB,GAAG,oBAAoB,CAAC,4BAA4B,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;SACtG;;YACC,iBAAiB,GAAG,oBAAoB,CAAC;QAE3C,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;YAChC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,sDAAsD,kBAAkB,CAAC,EAAE,GAAG,CAAC,CAAC;QAE7H,IAAI,KAAK,GAAW,SAAS,CAAC;QAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;YACpD,IAAI,KAAK,KAAK,CAAC;gBACb,KAAK,IAAI,GAAG,CAAC;YAEf,KAAK,IAAI,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,sGAAsG;QACtG,gDAAgD;QAChD,KAAK,IAAI,cAAc,kBAAkB,CAAC,eAAe,CAAC,SAAS,YAAY,kBAAkB,CAAC,SAAS,IAAI,iBAAiB,wBAAwB,kBAAkB,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;QAChM,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,WAAwB,EAAE,MAAmB;QACnF,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,yCAAyC,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,iDAAiD,CAAC,CAAC;QAEpG,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,gBAAgB,GAAW,mCAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAE/J,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC5C,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,kCAAkC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3G,IAAI,WAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACnE,IAAA,qBAAM,EAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,qDAAqD,CAAC,CAAC;YAElG,IAAI,eAAe,GAAG,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC/F,IAAI,eAAe,KAAK,SAAS,EAAE;gBACjC,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,yEAAyE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC1J,OAAO,eAAe,CAAC;aACxB;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC5F,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY;gBAC3D,MAAM,IAAI,yBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE/D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;YAC9B,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;YAEvK,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,OAAO,eAAe,CAAC;SACxB;gBAAS;YACR,IAAI,WAAW,KAAK,SAAS;gBAC3B,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SAC3C;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAA6B;;QACrE,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,WAAW,mCAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,mCAAI,EAAE,CAAC;QAChF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC1C,KAAK,CAAC,GAAG,GAAG,MAAA,KAAK,CAAC,GAAG,mCAAI,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChJ,IAAI,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG;YACzB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAC5E,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC;YACtC,OAAO,EAAE,CAAC,CAAC,uDAAuD;QAEpE,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAEhG,uEAAuE;QACvE,MAAM,aAAa,GAAG,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;QAChF,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,IAAI,MAA+B,CAAC;QACpC,IAAI;YACF,2DAA2D;YAC3D,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnK,MAAM,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE9D,MAAM,UAAU,GAAG,IAAI,KAAK,EAAc,CAAC;YAC3C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACtD,kCAAkC;gBAClC,IAAI,KAAK,GAAG,CAAC;oBACX,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;gBAE9E,mEAAmE;gBACnE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACtE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC5B;YACD,OAAO,UAAU,CAAC;SACnB;gBAAS;YACR,IAAI,MAAM,KAAK,SAAS;gBACtB,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACjC;IACH,CAAC;;AAhfH,oDAifC;AAhfyB,sDAAiC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { AccessToken, assert, DbResult, GuidString, Id64String, IModelStatus, Logger, PerfLogger, using } from \"@itwin/core-bentley\";\r\nimport { ChangedValueState, ChangeOpCode, ChangesetRange, IModelError, IModelVersion } from \"@itwin/core-common\";\r\nimport * as path from \"path\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { ECDb, ECDbOpenMode } from \"./ECDb\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { BriefcaseDb, IModelDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.ECDb;\r\n\r\n/** Represents an instance of the `ChangeSummary` ECClass from the `ECDbChange` ECSchema\r\n * combined with the information from the related `Changeset` instance (from the `IModelChange` ECSchema) from\r\n * which the Change Summary was extracted.\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryChangeSummary]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface ChangeSummary {\r\n id: Id64String;\r\n changeSet: { wsgId: GuidString, parentWsgId: GuidString, description: string, pushDate: string, userCreated: GuidString };\r\n}\r\n\r\n/** Represents an instance of the `InstanceChange` ECClass from the `ECDbChange` ECSchema\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryInstanceChange]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface InstanceChange {\r\n id: Id64String;\r\n summaryId: Id64String;\r\n changedInstance: { id: Id64String, className: string };\r\n opCode: ChangeOpCode;\r\n isIndirect: boolean;\r\n}\r\n\r\n/** Options for [ChangeSummaryManager.extractChangeSummaries]($backend).\r\n * @beta\r\n * @deprecated in 2.x. Use [CreateChangeSummaryArgs]($core-backend) instead\r\n */\r\nexport interface ChangeSummaryExtractOptions {\r\n /** If specified, change summaries are extracted from the start version to the current version as of which the iModel\r\n * was opened. If undefined, the extraction starts at the first version of the iModel.\r\n */\r\n startVersion?: IModelVersion;\r\n /** If specified, the change summary will be extracted only for current version as of which the iModel\r\n * was opened.\r\n */\r\n currentVersionOnly?: boolean;\r\n}\r\n\r\n/** Options for [ChangeSummaryManager.createChangeSummaries]($backend).\r\n * @beta\r\n */\r\nexport interface CreateChangeSummaryArgs extends TokenArg {\r\n /** Id of the iTwin that contains the iModel */\r\n iTwinId: GuidString;\r\n\r\n /** Id of the iModel */\r\n iModelId: GuidString;\r\n\r\n /**\r\n * Range of change sets\r\n * - the Change Summary for the first and last versions are also included\r\n * - if unspecified, all change sets until the latest version are processed\r\n */\r\n range: ChangesetRange;\r\n}\r\n\r\n/** Class to extract Change Summaries for a briefcase.\r\n *\r\n * See also:\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport class ChangeSummaryManager {\r\n private static readonly _currentIModelChangeSchemaVersion = { read: 2, write: 0, minor: 0 };\r\n\r\n /** Determines whether the *Change Cache file* is attached to the specified iModel or not\r\n * @param iModel iModel to check whether a *Change Cache file* is attached\r\n * @returns Returns true if the *Change Cache file* is attached to the iModel. false otherwise\r\n */\r\n public static isChangeCacheAttached(iModel: IModelDb): boolean {\r\n if (!iModel || !iModel.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n return iModel.nativeDb.isChangeCacheAttached();\r\n }\r\n\r\n /** Attaches the *Change Cache file* to the specified iModel if it hasn't been attached yet.\r\n * A new *Change Cache file* will be created for the iModel if it hasn't existed before.\r\n * @param iModel iModel to attach the *Change Cache file* file to\r\n * @throws [IModelError]($common)\r\n */\r\n public static attachChangeCache(iModel: IModelDb): void {\r\n if (!iModel || !iModel.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n if (ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n return;\r\n\r\n const changesCacheFilePath: string = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n if (!IModelJsFs.existsSync(changesCacheFilePath)) {\r\n using(new ECDb(), (changeCacheFile: ECDb) => {\r\n ChangeSummaryManager.createChangeCacheFile(iModel, changeCacheFile, changesCacheFilePath);\r\n });\r\n }\r\n\r\n assert(IModelJsFs.existsSync(changesCacheFilePath));\r\n const res: DbResult = iModel.nativeDb.attachChangeCache(changesCacheFilePath);\r\n if (res !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(res, `Failed to attach Change Cache file to ${iModel.pathName}.`);\r\n }\r\n\r\n /** Detaches the *Change Cache file* from the specified iModel.\r\n * - note that this method will cause any pending (currently running or queued) queries to fail\r\n * @param iModel iModel to detach the *Change Cache file* to\r\n * @throws [IModelError]($common) in case of errors, e.g. if no *Change Cache file* was attached before.\r\n */\r\n public static detachChangeCache(iModel: IModelDb): void {\r\n if (!iModel || !iModel.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n iModel.clearCaches();\r\n const res: DbResult = iModel.nativeDb.detachChangeCache();\r\n if (res !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(res, `Failed to detach Change Cache file from ${iModel.pathName}.`);\r\n }\r\n\r\n /** Extracts change summaries from the specified iModel.\r\n * Change summaries are extracted from the version the iModel was opened with up through the specified start version.\r\n * If no start version has been specified, the first version will be used.\r\n * @param accessToken A valid access token string\r\n * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel.\r\n * Note: For every version to extract a summary from, the method moves the iModel to that version before extraction. After\r\n * the extraction has completed, the iModel is moved back to the original version.\r\n * @param options Extraction options\r\n * @return the Ids of the extracted change summaries.\r\n * @throws [IModelError]($common) if the iModel is standalone\r\n * @deprecated in 2.x. Use [ChangeSummaryManager.createChangeSummaries]($core-backend) instead\r\n */\r\n public static async extractChangeSummaries(accessToken: AccessToken, iModel: BriefcaseDb, options?: ChangeSummaryExtractOptions): Promise<Id64String[]> { // eslint-disable-line deprecation/deprecation\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n const iModelId = iModel.iModelId;\r\n const endChangeSetId = iModel.changeset.id;\r\n assert(endChangeSetId.length !== 0);\r\n\r\n let startChangeSetId = \"\";\r\n if (options) {\r\n if (options.startVersion) {\r\n startChangeSetId = (await IModelHost.hubAccess.getChangesetFromVersion({ version: options.startVersion, accessToken, iModelId })).id;\r\n } else if (options.currentVersionOnly) {\r\n startChangeSetId = endChangeSetId;\r\n }\r\n }\r\n\r\n Logger.logInfo(loggerCategory, \"Started Change Summary extraction...\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n const totalPerf = new PerfLogger(`ChangeSummaryManager.extractChangeSummaries [ChangeSets: ${startChangeSetId} through ${endChangeSetId}, iModel: ${iModelId}]`);\r\n\r\n // download necessary changesets if they were not downloaded before and retrieve infos about those changesets\r\n let perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Retrieve ChangeSetInfos and download Changesets from Hub\");\r\n\r\n const first = (await IModelHost.hubAccess.queryChangeset({ iModelId, changeset: { id: startChangeSetId }, accessToken })).index;\r\n const end = (await IModelHost.hubAccess.queryChangeset({ iModelId, changeset: { id: endChangeSetId }, accessToken })).index;\r\n const changeSetInfos = await IModelHost.hubAccess.downloadChangesets({ accessToken, iModelId, range: { first, end }, targetDir: BriefcaseManager.getChangeSetsPath(iModelId) });\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, \"Retrieved changesets to extract from from cache or from hub.\", () => ({ iModelId, startChangeSetId, endChangeSetId, changeSets: changeSetInfos }));\r\n\r\n // Ensure change cache is detached as it's being written to during the extraction\r\n if (this.isChangeCacheAttached(iModel)) {\r\n throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Change cache must be detached before extraction\");\r\n }\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Open or create local Change Cache file\");\r\n const changesFile = ChangeSummaryManager.openOrCreateChangesFile(iModel);\r\n assert(changesFile.nativeDb !== undefined, \"Should not happen as an exception should have been thrown in that case\");\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, \"Opened or created Changes Cachefile.\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n\r\n try {\r\n // extract summaries from end changeset through start changeset, so that we only have to go back in history\r\n const changeSetCount: number = changeSetInfos.length;\r\n const endChangeSetIx: number = changeSetCount - 1;\r\n const summaries: Id64String[] = [];\r\n for (let i = endChangeSetIx; i >= 0; i--) {\r\n const currentChangeSetInfo = changeSetInfos[i];\r\n const currentChangeSetId = currentChangeSetInfo.id;\r\n Logger.logInfo(loggerCategory, `Started Change Summary extraction for changeset #${i + 1}...`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n\r\n const existingSummaryId: Id64String | undefined = ChangeSummaryManager.isSummaryAlreadyExtracted(changesFile, currentChangeSetId);\r\n if (!!existingSummaryId) {\r\n Logger.logInfo(loggerCategory, `Change Summary for changeset #${i + 1} already exists. It is not extracted again.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n summaries.push(existingSummaryId);\r\n continue;\r\n }\r\n\r\n // iModel is at end changeset, so no need to reverse for it.\r\n if (i !== endChangeSetIx) {\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Roll iModel to previous changeset\");\r\n\r\n await iModel.pullChanges({ accessToken, toIndex: currentChangeSetInfo.index });\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, `Moved iModel to changeset #${i + 1} to extract summary from.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n }\r\n\r\n const changeSetFilePath = currentChangeSetInfo.pathname;\r\n if (!IModelJsFs.existsSync(changeSetFilePath))\r\n throw new IModelError(IModelStatus.FileNotFound, `Failed to extract change summary: ChangeSet file \"${changeSetFilePath}\" does not exist.`);\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Extract ChangeSummary\");\r\n const stat = iModel.nativeDb.extractChangeSummary(changesFile.nativeDb, changeSetFilePath);\r\n perfLogger.dispose();\r\n if (stat.error && stat.error.status !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(stat.error.status, stat.error.message);\r\n\r\n Logger.logTrace(loggerCategory, `Actual Change summary extraction done for changeset #${i + 1}.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Add ChangeSet info to ChangeSummary\");\r\n assert(undefined !== stat.result);\r\n const changeSummaryId = stat.result;\r\n summaries.push(changeSummaryId);\r\n ChangeSummaryManager.addExtendedInfos(changesFile, changeSummaryId, currentChangeSetId, currentChangeSetInfo.parentId, currentChangeSetInfo.description, currentChangeSetInfo.pushDate, currentChangeSetInfo.userCreated);\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, `Added extended infos to Change Summary for changeset #${i + 1}.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n\r\n Logger.logInfo(loggerCategory, `Finished Change Summary extraction for changeset #${i + 1}.`, () => ({ iModelId, changeSetId: currentChangeSetId }));\r\n }\r\n\r\n changesFile.saveChanges();\r\n return summaries;\r\n } finally {\r\n changesFile.dispose();\r\n\r\n perfLogger = new PerfLogger(\"ChangeSummaryManager.extractChangeSummaries>Move iModel to original changeset\");\r\n if (iModel.changeset.id !== endChangeSetId)\r\n await iModel.pullChanges({ accessToken });\r\n perfLogger.dispose();\r\n Logger.logTrace(loggerCategory, \"Moved iModel to initial changeset (the end changeset).\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n\r\n totalPerf.dispose();\r\n Logger.logInfo(loggerCategory, \"Finished Change Summary extraction.\", () => ({ iModelId, startChangeSetId, endChangeSetId }));\r\n }\r\n }\r\n\r\n private static openOrCreateChangesFile(iModel: BriefcaseDb): ECDb {\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadArg, \"Invalid iModel handle. iModel must be open.\");\r\n\r\n const changesFile = new ECDb();\r\n const changeCacheFilePath = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n if (IModelJsFs.existsSync(changeCacheFilePath)) {\r\n ChangeSummaryManager.openChangeCacheFile(changesFile, changeCacheFilePath);\r\n return changesFile;\r\n }\r\n\r\n try {\r\n ChangeSummaryManager.createChangeCacheFile(iModel, changesFile, changeCacheFilePath);\r\n return changesFile;\r\n } catch (e) {\r\n // delete cache file again in case it was created but schema import failed\r\n if (IModelJsFs.existsSync(changeCacheFilePath))\r\n IModelJsFs.removeSync(changeCacheFilePath);\r\n\r\n throw e;\r\n }\r\n }\r\n\r\n private static createChangeCacheFile(iModel: IModelDb, changesFile: ECDb, changeCacheFilePath: string): void {\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadArg, \"Invalid iModel object. iModel must be open.\");\r\n\r\n const stat: DbResult = iModel.nativeDb.createChangeCache(changesFile.nativeDb, changeCacheFilePath);\r\n if (stat !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(stat, `Failed to create Change Cache file at \"${changeCacheFilePath}\".`);\r\n\r\n // Extended information like changeset ids, push dates are persisted in the IModelChange ECSchema\r\n changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n }\r\n\r\n private static openChangeCacheFile(changesFile: ECDb, changeCacheFilePath: string): void {\r\n changesFile.openDb(changeCacheFilePath, ECDbOpenMode.FileUpgrade);\r\n\r\n const actualSchemaVersion: { read: number, write: number, minor: number } = changesFile.withPreparedStatement(\"SELECT VersionMajor read,VersionWrite write,VersionMinor minor FROM meta.ECSchemaDef WHERE Name='IModelChange'\",\r\n (stmt: ECSqlStatement) => {\r\n if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n throw new IModelError(DbResult.BE_SQLITE_ERROR, \"File is not a valid Change Cache file.\");\r\n\r\n return stmt.getRow();\r\n });\r\n\r\n if (actualSchemaVersion.read === ChangeSummaryManager._currentIModelChangeSchemaVersion.read &&\r\n actualSchemaVersion.write === ChangeSummaryManager._currentIModelChangeSchemaVersion.write &&\r\n actualSchemaVersion.minor === ChangeSummaryManager._currentIModelChangeSchemaVersion.minor)\r\n return;\r\n\r\n changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n }\r\n\r\n private static getExtendedSchemaPath(): string { return path.join(KnownLocations.packageAssetsDir, \"IModelChange.02.00.00.ecschema.xml\"); }\r\n\r\n private static isSummaryAlreadyExtracted(changesFile: ECDb, changeSetId: GuidString): Id64String | undefined {\r\n return changesFile.withPreparedStatement(\"SELECT Summary.Id summaryid FROM imodelchange.ChangeSet WHERE WsgId=?\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindString(1, changeSetId);\r\n if (DbResult.BE_SQLITE_ROW === stmt.step())\r\n return stmt.getValue(0).getId();\r\n\r\n return undefined;\r\n });\r\n }\r\n\r\n private static addExtendedInfos(changesFile: ECDb, changeSummaryId: Id64String, changesetWsgId: GuidString, changesetParentWsgId?: GuidString, description?: string, changesetPushDate?: string, changeSetUserCreated?: GuidString): void {\r\n changesFile.withPreparedStatement(\"INSERT INTO imodelchange.ChangeSet(Summary.Id,WsgId,ParentWsgId,Description,PushDate,UserCreated) VALUES(?,?,?,?,?,?)\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, changeSummaryId);\r\n stmt.bindString(2, changesetWsgId);\r\n if (changesetParentWsgId)\r\n stmt.bindString(3, changesetParentWsgId);\r\n\r\n if (description)\r\n stmt.bindString(4, description);\r\n\r\n if (changesetPushDate)\r\n stmt.bindDateTime(5, changesetPushDate);\r\n\r\n if (changeSetUserCreated)\r\n stmt.bindString(6, changeSetUserCreated);\r\n\r\n const r: DbResult = stmt.step();\r\n if (r !== DbResult.BE_SQLITE_DONE)\r\n throw new IModelError(r, `Failed to add changeset information to extracted change summary ${changeSummaryId}`);\r\n });\r\n }\r\n\r\n /** Queries the ChangeSummary for the specified change summary id\r\n *\r\n * See also\r\n * - `ECDbChange.ChangeSummary` ECClass in the *ECDbChange* ECSchema\r\n * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param changeSummaryId ECInstanceId of the ChangeSummary\r\n * @returns Returns the requested ChangeSummary object\r\n * @throws [IModelError]($common) If change summary does not exist for the specified id, or if the\r\n * change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static queryChangeSummary(iModel: BriefcaseDb, changeSummaryId: Id64String): ChangeSummary {\r\n if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n return iModel.withPreparedStatement(\"SELECT WsgId,ParentWsgId,Description,PushDate,UserCreated FROM ecchange.imodelchange.ChangeSet WHERE Summary.Id=?\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, changeSummaryId);\r\n if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n throw new IModelError(IModelStatus.BadArg, `No ChangeSet information found for ChangeSummary ${changeSummaryId}.`);\r\n\r\n const row = stmt.getRow();\r\n return { id: changeSummaryId, changeSet: { wsgId: row.wsgId, parentWsgId: row.parentWsgId, description: row.description, pushDate: row.pushDate, userCreated: row.userCreated } };\r\n });\r\n }\r\n\r\n /** Queries the InstanceChange for the specified instance change id.\r\n *\r\n * See also\r\n * - `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema\r\n * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param instanceChangeId ECInstanceId of the InstanceChange (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n * @returns Returns the requested InstanceChange object (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n * @throws [IModelError]($common) if instance change does not exist for the specified id, or if the\r\n * change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static queryInstanceChange(iModel: BriefcaseDb, instanceChangeId: Id64String): InstanceChange {\r\n if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n // query instance changes\r\n const instanceChange: InstanceChange = iModel.withPreparedStatement(`SELECT ic.Summary.Id summaryId, s.Name changedInstanceSchemaName, c.Name changedInstanceClassName, ic.ChangedInstance.Id changedInstanceId,\r\n ic.OpCode, ic.IsIndirect FROM ecchange.change.InstanceChange ic JOIN main.meta.ECClassDef c ON c.ECInstanceId = ic.ChangedInstance.ClassId\r\n JOIN main.meta.ECSchemaDef s ON c.Schema.Id = s.ECInstanceId WHERE ic.ECInstanceId =? `, (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, instanceChangeId);\r\n if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n throw new IModelError(IModelStatus.BadArg, `No InstanceChange found for id ${instanceChangeId}.`);\r\n\r\n const row = stmt.getRow();\r\n const changedInstanceId: Id64String = row.changedInstanceId;\r\n const changedInstanceClassName: string = `[${row.changedInstanceSchemaName}].[${row.changedInstanceClassName}]`;\r\n const op: ChangeOpCode = row.opCode as ChangeOpCode;\r\n\r\n return {\r\n id: instanceChangeId, summaryId: row.summaryId, changedInstance: { id: changedInstanceId, className: changedInstanceClassName },\r\n opCode: op, isIndirect: row.isIndirect,\r\n };\r\n });\r\n\r\n return instanceChange;\r\n }\r\n\r\n /** Retrieves the names of the properties whose values have changed for the given instance change\r\n *\r\n * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param instanceChangeId Id of the InstanceChange to query the properties whose values have changed\r\n * @returns Returns names of the properties whose values have changed for the given instance change\r\n * @throws [IModelError]($common) if the change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static getChangedPropertyValueNames(iModel: IModelDb, instanceChangeId: Id64String): string[] {\r\n return iModel.withPreparedStatement(\"SELECT AccessString FROM ecchange.change.PropertyValueChange WHERE InstanceChange.Id=?\",\r\n (stmt: ECSqlStatement) => {\r\n stmt.bindId(1, instanceChangeId);\r\n\r\n const selectClauseItems: string[] = [];\r\n while (stmt.step() === DbResult.BE_SQLITE_ROW) {\r\n // access string tokens need to be escaped as they might collide with reserved words in ECSQL or SQLite\r\n const accessString: string = stmt.getValue(0).getString();\r\n const accessStringTokens: string[] = accessString.split(\".\");\r\n assert(accessStringTokens.length > 0);\r\n\r\n let isFirstToken: boolean = true;\r\n let item: string = \"\";\r\n for (const token of accessStringTokens) {\r\n if (!isFirstToken)\r\n item += \".\";\r\n\r\n item += `[${token}]`;\r\n isFirstToken = false;\r\n }\r\n selectClauseItems.push(item);\r\n }\r\n\r\n return selectClauseItems;\r\n });\r\n }\r\n\r\n /** Builds the ECSQL to query the property value changes for the specified instance change and the specified ChangedValueState.\r\n *\r\n * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n * @param iModel iModel\r\n * @param instanceChangeInfo InstanceChange to query the property value changes for\r\n * changedInstance.className must be fully qualified and schema and class name must be escaped with square brackets if they collide with reserved ECSQL words: `[schema name].[class name]`\r\n * @param changedValueState The Changed State to query the values for. This must correspond to the [InstanceChange.OpCode]($backend) of the InstanceChange.\r\n * @param changedPropertyNames List of the property names for which values have changed for the specified instance change.\r\n * The list can be obtained by calling [ChangeSummaryManager.getChangedPropertyValueNames]($core-backend).\r\n * If omitted, the method will call the above method by itself. The parameter allows for checking first whether\r\n * an instance change has any property value changes at all. If there are no property value changes, this method\r\n * should not be called, as it will throw an error.\r\n * @returns Returns the ECSQL that will retrieve the property value changes\r\n * @throws [IModelError]($common) if instance change does not exist, if there are not property value changes for the instance change,\r\n * if the change cache file hasn't been attached, or in case of other errors.\r\n */\r\n public static buildPropertyValueChangesECSql(iModel: IModelDb, instanceChangeInfo: { id: Id64String, summaryId: Id64String, changedInstance: { id: Id64String, className: string } }, changedValueState: ChangedValueState, changedPropertyNames?: string[]): string {\r\n let selectClauseItems: string[];\r\n if (!changedPropertyNames) {\r\n // query property value changes just to build a SELECT statement against the class of the changed instance\r\n selectClauseItems = ChangeSummaryManager.getChangedPropertyValueNames(iModel, instanceChangeInfo.id);\r\n } else\r\n selectClauseItems = changedPropertyNames;\r\n\r\n if (selectClauseItems.length === 0)\r\n throw new IModelError(IModelStatus.BadArg, `No property value changes found for InstanceChange ${instanceChangeInfo.id}.`);\r\n\r\n let ecsql: string = \"SELECT \";\r\n selectClauseItems.map((item: string, index: number) => {\r\n if (index !== 0)\r\n ecsql += \",\";\r\n\r\n ecsql += item;\r\n });\r\n\r\n // Avoiding parameters in the Changes function speeds up performance because ECDb can do optimizations\r\n // if it knows the function args at prepare time\r\n ecsql += ` FROM main.${instanceChangeInfo.changedInstance.className}.Changes(${instanceChangeInfo.summaryId},${changedValueState}) WHERE ECInstanceId=${instanceChangeInfo.changedInstance.id}`;\r\n return ecsql;\r\n }\r\n\r\n /**\r\n * Creates a change summary for the last applied change set to the iModel\r\n * @param accessToken A valid access token string\r\n * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel, and must have at least one change set applied to it.\r\n * @returns The id of the extracted change summary.\r\n * @beta\r\n */\r\n public static async createChangeSummary(accessToken: AccessToken, iModel: BriefcaseDb): Promise<Id64String> {\r\n if (!iModel?.isOpen)\r\n throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n const changesetId = iModel.changeset.id;\r\n if (!changesetId)\r\n throw new IModelError(IModelStatus.BadRequest, \"No change set was applied to the iModel\");\r\n if (this.isChangeCacheAttached(iModel))\r\n throw new IModelError(IModelStatus.BadRequest, \"Change cache must be detached before extraction\");\r\n\r\n const iModelId = iModel.iModelId;\r\n const changesetsFolder: string = BriefcaseManager.getChangeSetsPath(iModelId);\r\n const changeset = await IModelHost.hubAccess.downloadChangeset({ accessToken, iModelId, changeset: { id: iModel.changeset.id }, targetDir: changesetsFolder });\r\n\r\n if (!IModelJsFs.existsSync(changeset.pathname))\r\n throw new IModelError(IModelStatus.FileNotFound, `Failed to download change set: ${changeset.pathname}`);\r\n\r\n let changesFile: ECDb | undefined;\r\n try {\r\n changesFile = ChangeSummaryManager.openOrCreateChangesFile(iModel);\r\n assert(changesFile.nativeDb !== undefined, \"Invalid changesFile - should've caused an exception\");\r\n\r\n let changeSummaryId = ChangeSummaryManager.isSummaryAlreadyExtracted(changesFile, changesetId);\r\n if (changeSummaryId !== undefined) {\r\n Logger.logInfo(loggerCategory, `Change Summary for changeset already exists. It is not extracted again.`, () => ({ iModelId, changeSetId: changesetId }));\r\n return changeSummaryId;\r\n }\r\n\r\n const stat = iModel.nativeDb.extractChangeSummary(changesFile.nativeDb, changeset.pathname);\r\n if (stat.error && stat.error.status !== DbResult.BE_SQLITE_OK)\r\n throw new IModelError(stat.error.status, stat.error.message);\r\n\r\n assert(undefined !== stat.result);\r\n changeSummaryId = stat.result;\r\n ChangeSummaryManager.addExtendedInfos(changesFile, changeSummaryId, changesetId, changeset.parentId, changeset.description, changeset.pushDate, changeset.userCreated);\r\n\r\n changesFile.saveChanges();\r\n return changeSummaryId;\r\n } finally {\r\n if (changesFile !== undefined)\r\n changesFile.dispose();\r\n IModelJsFs.unlinkSync(changeset.pathname);\r\n }\r\n }\r\n\r\n /**\r\n * Creates change summaries for the specified iModel and a specified range of versions\r\n * @note This may be an expensive operation - downloads the first version and starts applying the change sets, extracting summaries one by one\r\n * @param args Arguments including the range of versions for which Change Summaries are to be created, and other necessary input for creation\r\n */\r\n public static async createChangeSummaries(args: CreateChangeSummaryArgs): Promise<Id64String[]> {\r\n const accessToken = args.accessToken ?? await IModelHost.getAccessToken() ?? \"\";\r\n const { iModelId, iTwinId, range } = args;\r\n range.end = range.end ?? (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.latest() })).index;\r\n if (range.first > range.end)\r\n throw new IModelError(IModelStatus.BadArg, \"Invalid range of changesets\");\r\n if (range.first === 0 && range.end === 0)\r\n return []; // no changesets exist, so the inclusive range is empty\r\n\r\n const changesets = await IModelHost.hubAccess.queryChangesets({ accessToken, iModelId, range });\r\n\r\n // Setup a temporary briefcase to help with extracting change summaries\r\n const briefcasePath = BriefcaseManager.getBriefcaseBasePath(iModelId);\r\n const fileName: string = path.join(briefcasePath, `ChangeSummaryBriefcase.bim`);\r\n if (IModelJsFs.existsSync(fileName))\r\n IModelJsFs.removeSync(fileName);\r\n\r\n let iModel: BriefcaseDb | undefined;\r\n try {\r\n // Download a version that has the first change set applied\r\n const props = await BriefcaseManager.downloadBriefcase({ accessToken, iTwinId, iModelId, asOf: { afterChangeSetId: changesets[0].id }, briefcaseId: 0, fileName });\r\n iModel = await BriefcaseDb.open({ fileName: props.fileName });\r\n\r\n const summaryIds = new Array<Id64String>();\r\n for (let index = 0; index < changesets.length; index++) {\r\n // Apply a change set if necessary\r\n if (index > 0)\r\n await iModel.pullChanges({ accessToken, toIndex: changesets[index].index });\r\n\r\n // Create a change summary for the last change set that was applied\r\n const summaryId = await this.createChangeSummary(accessToken, iModel);\r\n summaryIds.push(summaryId);\r\n }\r\n return summaryIds;\r\n } finally {\r\n if (iModel !== undefined)\r\n iModel.close();\r\n IModelJsFs.removeSync(fileName);\r\n }\r\n }\r\n}\r\n"]}
package/lib/cjs/ClassRegistry.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAsB,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAM3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM;IAe9E;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAyGrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}
1
+ {"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAsB,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAM3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM;IAkB9E;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAyGrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}
package/lib/cjs/ClassRegistry.js CHANGED
@@ -65,7 +65,8 @@ class ClassRegistry {
65
65
  const [classSchema, className] = ecTypeQualifier.split(".");
66
66
  const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);
67
67
  if (schemaItemJson.error)
68
- throw new core_common_1.IModelError(schemaItemJson.error, `failed to get schema item '${ecTypeQualifier}'`);
68
+ throw new core_common_1.IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);
69
+ assert(undefined !== schemaItemJson.result);
69
70
  const schemaItem = JSON.parse(schemaItemJson.result);
70
71
  if (!("appliesTo" in schemaItem) && schemaItem.baseClass === undefined) {
71
72
  return ecTypeQualifier;
package/lib/cjs/ClassRegistry.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2E;AAC3E,oDAAqG;AACrG,qCAAkC;AAElC,qCAA2C;AAC3C,yDAAsD;AACtD,iCAAiC;AAEjC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC7E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,yBAAW,CAAC,cAAc,CAAC,KAAK,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAChG,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAgB,CAAC,CAAC;QAC/D,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE;YACtE,OAAO,eAAe,CAAC;SACxB;QACD,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,MAAA,UAAU,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,kFAAkF;QAClF,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE;YACjD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAC9G,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,mCAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,6BAA6B,EAC7B;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;oBACtE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,mCAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;qBAC/B;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AA7OH,sCA8OC;AA7OyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AA+OvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { DbResult, Id64, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport { EntityReferences } from \"./EntityReferences\";\r\nimport * as assert from \"assert\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n private static readonly _classMap = new Map<string, typeof Entity>();\r\n /** @internal */\r\n public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n /** @internal */\r\n public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n /** @internal */\r\n public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n entityClass.schema = schema;\r\n const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n if (this._classMap.has(key)) {\r\n const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n throw new Error(errMsg);\r\n }\r\n\r\n this._classMap.set(key, entityClass);\r\n }\r\n\r\n /** Generate a proxy Schema for a domain that has not been registered. */\r\n private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n SELECT NULL FROM [ec_CustomAttribute] [c]\r\n JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n stmt.bindString(1, domain);\r\n stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n });\r\n\r\n const schemaClass = class extends Schema {\r\n public static override get schemaName() { return domain; }\r\n public static override get missingRequiredBehavior() { return hasBehavior; }\r\n };\r\n\r\n Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n return schemaClass;\r\n }\r\n\r\n /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\r\n * Then, gets its metadata and returns that.\r\n * @param iModel - iModel containing the metadata for this type\r\n * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\r\n * @returns the qualified full name of an ECEntityClass\r\n * @internal public for testing only\r\n */\r\n public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\r\n const [classSchema, className] = ecTypeQualifier.split(\".\");\r\n const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);\r\n if (schemaItemJson.error)\r\n throw new IModelError(schemaItemJson.error, `failed to get schema item '${ecTypeQualifier}'`);\r\n const schemaItem = JSON.parse(schemaItemJson.result as string);\r\n if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\r\n return ecTypeQualifier;\r\n }\r\n // typescript doesn't understand that the inverse of the above condition is\r\n // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\r\n const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\r\n return this.getRootEntity(iModel, parentItemQualifier);\r\n }\r\n\r\n /** Generate a JavaScript class from Entity metadata.\r\n * @param entityMetaData The Entity metadata that defines the class\r\n */\r\n private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n const name = entityMetaData.ecclass.split(\":\");\r\n const domainName = name[0];\r\n const className = name[1];\r\n\r\n if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n // make sure schema exists\r\n let schema = Schemas.getRegisteredSchema(domainName);\r\n if (undefined === schema)\r\n schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n if (undefined === superclass)\r\n throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n // be used to tell if there are any generated classes in the hierarchy\r\n let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n let currentSuperclass = superclass;\r\n const MAX_ITERS = 1000;\r\n for (let i = 0; i < MAX_ITERS; ++i) {\r\n if (currentSuperclass.schema.schemaName === \"BisCore\")\r\n break;\r\n\r\n if (!currentSuperclass.isGeneratedClass) {\r\n generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n break;\r\n }\r\n const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n if (superclassMetaData === undefined)\r\n throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n if (maybeNextSuperclass === undefined)\r\n throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n currentSuperclass = maybeNextSuperclass;\r\n }\r\n\r\n const generatedClass = class extends superclass {\r\n public static override get className() { return className; }\r\n private static [isGeneratedClassTag] = true;\r\n public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n };\r\n\r\n // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n Object.defineProperty(generatedClass, \"name\", { get: () => className }); // this is the (only) way to change that readonly property.\r\n\r\n // a class only gets an automatic `collectReferenceConcreteIds` implementation if:\r\n // - it is not in the `BisCore` schema\r\n // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n if (!generatedClassHasNonGeneratedNonCoreAncestor) {\r\n const navigationProps = Object.entries(entityMetaData.properties)\r\n .filter(([_name, prop]) => prop.isNavigation)\r\n // eslint-disable-next-line @typescript-eslint/no-shadow\r\n .map(([name, prop]) => {\r\n assert(prop.relationshipClass);\r\n const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\r\n assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\r\n const relMetaData = JSON.parse(maybeMetaData.result);\r\n const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\r\n // root class must be in BisCore so should be loaded since biscore classes will never get this\r\n // generated implementation\r\n const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\r\n const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\r\n assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\r\n return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\r\n });\r\n\r\n Object.defineProperty(\r\n generatedClass.prototype,\r\n \"collectReferenceConcreteIds\",\r\n {\r\n value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\r\n // eslint-disable-next-line @typescript-eslint/dot-notation\r\n const superImpl = superclass.prototype[\"collectReferenceConcreteIds\"];\r\n superImpl.call(this, referenceIds);\r\n for (const navProp of navigationProps) {\r\n const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\r\n if (!relatedElem || !Id64.isValid(relatedElem.id))\r\n continue;\r\n const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\r\n referenceIds.add(referenceId);\r\n }\r\n },\r\n // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n writable: true,\r\n configurable: true,\r\n }\r\n );\r\n }\r\n\r\n // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n if (schema.missingRequiredBehavior) {\r\n const throwError = () => {\r\n throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\r\n };\r\n\r\n superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n }\r\n\r\n this.register(generatedClass, schema); // register it before returning\r\n return generatedClass;\r\n }\r\n\r\n /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n * @param moduleObj The module to search for subclasses of Entity\r\n * @param schema The schema for all found classes\r\n */\r\n public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n const thisClass = moduleObj[thisMember];\r\n if (thisClass.prototype instanceof Entity)\r\n this.register(thisClass, schema);\r\n }\r\n }\r\n\r\n /**\r\n * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n */\r\n private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n if (metadata === undefined || metadata.ecclass === undefined)\r\n throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n // Make sure we have all base classes registered.\r\n if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n // Now we can generate the class from the classDef.\r\n return this.generateClassForEntity(metadata, iModel);\r\n }\r\n\r\n /** Find a registered class by classFullName.\r\n * @param classFullName class to find\r\n * @param iModel The IModel that contains the class definitions\r\n * @returns The Entity class or undefined\r\n */\r\n public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n return this._classMap.get(classFullName.toLowerCase());\r\n }\r\n\r\n /** Get the Entity class for the specified Entity className.\r\n * @param classFullName The full BIS class name of the Entity\r\n * @param iModel The IModel that contains the class definitions\r\n * @returns The Entity class\r\n */\r\n public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n const key = classFullName.toLowerCase();\r\n const ctor = this._classMap.get(key);\r\n return ctor ? ctor : this.generateClass(key, iModel);\r\n }\r\n\r\n /** Unregister a class, by name, if one is already registered.\r\n * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n * @param classFullName Name of the class to unregister\r\n * @return true if the class was unregistered\r\n * @internal\r\n */\r\n public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n /** Unregister all classes from a schema.\r\n * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n * @param schema Name of the schema to unregister\r\n * @internal\r\n */\r\n public static unregisterClassesFrom(schema: typeof Schema) {\r\n for (const entry of Array.from(this._classMap)) {\r\n if (entry[1].schema === schema)\r\n this.unregisterCLass(entry[0]);\r\n }\r\n }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n /** Get the specified Entity metadata */\r\n public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n /** Add metadata to the cache */\r\n public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}
1
+ {"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2E;AAC3E,oDAAqG;AACrG,qCAAkC;AAElC,qCAA2C;AAC3C,yDAAsD;AACtD,iCAAiC;AAEjC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC7E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,yBAAW,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAEvG,MAAM,CAAC,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE;YACtE,OAAO,eAAe,CAAC;SACxB;QAED,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,MAAA,UAAU,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,kFAAkF;QAClF,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE;YACjD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAC9G,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,mCAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,6BAA6B,EAC7B;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;oBACtE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,mCAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;qBAC/B;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AAhPH,sCAiPC;AAhPyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAkPvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { DbResult, Id64, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport { EntityReferences } from \"./EntityReferences\";\r\nimport * as assert from \"assert\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n private static readonly _classMap = new Map<string, typeof Entity>();\r\n /** @internal */\r\n public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n /** @internal */\r\n public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n /** @internal */\r\n public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n entityClass.schema = schema;\r\n const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n if (this._classMap.has(key)) {\r\n const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n throw new Error(errMsg);\r\n }\r\n\r\n this._classMap.set(key, entityClass);\r\n }\r\n\r\n /** Generate a proxy Schema for a domain that has not been registered. */\r\n private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n SELECT NULL FROM [ec_CustomAttribute] [c]\r\n JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n stmt.bindString(1, domain);\r\n stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n });\r\n\r\n const schemaClass = class extends Schema {\r\n public static override get schemaName() { return domain; }\r\n public static override get missingRequiredBehavior() { return hasBehavior; }\r\n };\r\n\r\n Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n return schemaClass;\r\n }\r\n\r\n /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\r\n * Then, gets its metadata and returns that.\r\n * @param iModel - iModel containing the metadata for this type\r\n * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\r\n * @returns the qualified full name of an ECEntityClass\r\n * @internal public for testing only\r\n */\r\n public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\r\n const [classSchema, className] = ecTypeQualifier.split(\".\");\r\n const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);\r\n if (schemaItemJson.error)\r\n throw new IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);\r\n\r\n assert(undefined !== schemaItemJson.result);\r\n const schemaItem = JSON.parse(schemaItemJson.result);\r\n if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\r\n return ecTypeQualifier;\r\n }\r\n\r\n // typescript doesn't understand that the inverse of the above condition is\r\n // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\r\n const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\r\n return this.getRootEntity(iModel, parentItemQualifier);\r\n }\r\n\r\n /** Generate a JavaScript class from Entity metadata.\r\n * @param entityMetaData The Entity metadata that defines the class\r\n */\r\n private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n const name = entityMetaData.ecclass.split(\":\");\r\n const domainName = name[0];\r\n const className = name[1];\r\n\r\n if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n // make sure schema exists\r\n let schema = Schemas.getRegisteredSchema(domainName);\r\n if (undefined === schema)\r\n schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n if (undefined === superclass)\r\n throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n // be used to tell if there are any generated classes in the hierarchy\r\n let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n let currentSuperclass = superclass;\r\n const MAX_ITERS = 1000;\r\n for (let i = 0; i < MAX_ITERS; ++i) {\r\n if (currentSuperclass.schema.schemaName === \"BisCore\")\r\n break;\r\n\r\n if (!currentSuperclass.isGeneratedClass) {\r\n generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n break;\r\n }\r\n const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n if (superclassMetaData === undefined)\r\n throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n if (maybeNextSuperclass === undefined)\r\n throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n currentSuperclass = maybeNextSuperclass;\r\n }\r\n\r\n const generatedClass = class extends superclass {\r\n public static override get className() { return className; }\r\n private static [isGeneratedClassTag] = true;\r\n public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n };\r\n\r\n // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n Object.defineProperty(generatedClass, \"name\", { get: () => className }); // this is the (only) way to change that readonly property.\r\n\r\n // a class only gets an automatic `collectReferenceConcreteIds` implementation if:\r\n // - it is not in the `BisCore` schema\r\n // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n if (!generatedClassHasNonGeneratedNonCoreAncestor) {\r\n const navigationProps = Object.entries(entityMetaData.properties)\r\n .filter(([_name, prop]) => prop.isNavigation)\r\n // eslint-disable-next-line @typescript-eslint/no-shadow\r\n .map(([name, prop]) => {\r\n assert(prop.relationshipClass);\r\n const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\r\n assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\r\n const relMetaData = JSON.parse(maybeMetaData.result);\r\n const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\r\n // root class must be in BisCore so should be loaded since biscore classes will never get this\r\n // generated implementation\r\n const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\r\n const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\r\n assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\r\n return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\r\n });\r\n\r\n Object.defineProperty(\r\n generatedClass.prototype,\r\n \"collectReferenceConcreteIds\",\r\n {\r\n value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\r\n // eslint-disable-next-line @typescript-eslint/dot-notation\r\n const superImpl = superclass.prototype[\"collectReferenceConcreteIds\"];\r\n superImpl.call(this, referenceIds);\r\n for (const navProp of navigationProps) {\r\n const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\r\n if (!relatedElem || !Id64.isValid(relatedElem.id))\r\n continue;\r\n const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\r\n referenceIds.add(referenceId);\r\n }\r\n },\r\n // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n writable: true,\r\n configurable: true,\r\n }\r\n );\r\n }\r\n\r\n // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n if (schema.missingRequiredBehavior) {\r\n const throwError = () => {\r\n throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\r\n };\r\n\r\n superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n }\r\n\r\n this.register(generatedClass, schema); // register it before returning\r\n return generatedClass;\r\n }\r\n\r\n /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n * @param moduleObj The module to search for subclasses of Entity\r\n * @param schema The schema for all found classes\r\n */\r\n public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n const thisClass = moduleObj[thisMember];\r\n if (thisClass.prototype instanceof Entity)\r\n this.register(thisClass, schema);\r\n }\r\n }\r\n\r\n /**\r\n * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n */\r\n private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n if (metadata === undefined || metadata.ecclass === undefined)\r\n throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n // Make sure we have all base classes registered.\r\n if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n // Now we can generate the class from the classDef.\r\n return this.generateClassForEntity(metadata, iModel);\r\n }\r\n\r\n /** Find a registered class by classFullName.\r\n * @param classFullName class to find\r\n * @param iModel The IModel that contains the class definitions\r\n * @returns The Entity class or undefined\r\n */\r\n public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n return this._classMap.get(classFullName.toLowerCase());\r\n }\r\n\r\n /** Get the Entity class for the specified Entity className.\r\n * @param classFullName The full BIS class name of the Entity\r\n * @param iModel The IModel that contains the class definitions\r\n * @returns The Entity class\r\n */\r\n public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n const key = classFullName.toLowerCase();\r\n const ctor = this._classMap.get(key);\r\n return ctor ? ctor : this.generateClass(key, iModel);\r\n }\r\n\r\n /** Unregister a class, by name, if one is already registered.\r\n * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n * @param classFullName Name of the class to unregister\r\n * @return true if the class was unregistered\r\n * @internal\r\n */\r\n public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n /** Unregister all classes from a schema.\r\n * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n * @param schema Name of the schema to unregister\r\n * @internal\r\n */\r\n public static unregisterClassesFrom(schema: typeof Schema) {\r\n for (const entry of Array.from(this._classMap)) {\r\n if (entry[1].schema === schema)\r\n this.unregisterCLass(entry[0]);\r\n }\r\n }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n /** Get the specified Entity metadata */\r\n public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n /** Add metadata to the cache */\r\n public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}
package/lib/cjs/CloudStorageBackend.d.ts CHANGED
@@ -9,7 +9,7 @@ export interface AzureBlobStorageCredentials {
9
9
  }
10
10
  /**
11
11
  * @beta
12
- * @deprecated
12
+ * @deprecated in 3.x.
13
13
  */
14
14
  export interface CloudStorageUploadOptions {
15
15
  type?: string;
@@ -18,7 +18,7 @@ export interface CloudStorageUploadOptions {
18
18
  }
19
19
  /**
20
20
  * @beta
21
- * @deprecated
21
+ * @deprecated in 3.x.
22
22
  */
23
23
  export declare abstract class CloudStorageService {
24
24
  initialize(): void;
@@ -34,7 +34,7 @@ export declare abstract class CloudStorageService {
34
34
  }
35
35
  /**
36
36
  * @beta
37
- * @deprecated
37
+ * @deprecated in 3.x.
38
38
  */
39
39
  export declare class AzureBlobStorage extends CloudStorageService {
40
40
  private _service;
@@ -48,7 +48,7 @@ export declare class AzureBlobStorage extends CloudStorageService {
48
48
  }
49
49
  /**
50
50
  * @beta
51
- * @deprecated
51
+ * @deprecated in 3.x.
52
52
  */
53
53
  export declare class CloudStorageTileUploader {
54
54
  private _activeUploads;
package/lib/cjs/CloudStorageBackend.js CHANGED
@@ -14,7 +14,7 @@ const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
14
14
  const IModelHost_1 = require("./IModelHost");
15
15
  /**
16
16
  * @beta
17
- * @deprecated
17
+ * @deprecated in 3.x.
18
18
  */
19
19
  class CloudStorageService {
20
20
  initialize() { }
@@ -27,7 +27,7 @@ class CloudStorageService {
27
27
  exports.CloudStorageService = CloudStorageService;
28
28
  /**
29
29
  * @beta
30
- * @deprecated
30
+ * @deprecated in 3.x.
31
31
  */
32
32
  class AzureBlobStorage extends CloudStorageService {
33
33
  constructor(credentials) {
@@ -130,7 +130,7 @@ class AzureBlobStorage extends CloudStorageService {
130
130
  exports.AzureBlobStorage = AzureBlobStorage;
131
131
  /**
132
132
  * @beta
133
- * @deprecated
133
+ * @deprecated in 3.x.
134
134
  */
135
135
  class CloudStorageTileUploader {
136
136
  constructor() {
package/lib/cjs/CloudStorageBackend.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"CloudStorageBackend.js","sourceRoot":"","sources":["../../src/CloudStorageBackend.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAA+C;AAC/C,6BAA6B;AAC7B,6CAA6C;AAC7C,sDAAyD;AACzD,oDAG4B;AAC5B,mEAAgE;AAChE,6CAA0C;AAqB1C;;;GAGG;AACH,MAAsB,mBAAmB;IAChC,UAAU,KAAW,CAAC;IACtB,SAAS,KAAW,CAAC;IAIrB,KAAK,CAAC,QAAQ,CAAC,KAAa,IAAmC,OAAO,SAAS,CAAC,CAAC,CAAC;IAE/E,cAAc,CAAC,EAAmC;QAC1D,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IAC9C,CAAC;CACF;AAXD,kDAWC;AAED;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,mBAAmB;IAKvD,YAAmB,WAAwC;;QACzD,KAAK,EAAE,CAAC;QAcM,OAAE,GAAG,kCAAoB,CAAC,KAAK,CAAC;QAZ9C,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE;YAClD,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,6CAA6C,CAAC,CAAC;SAC3F;QAED,IAAI,CAAC,QAAQ,GAAG,MAAA,WAAW,CAAC,OAAO,mCAAI,WAAW,WAAW,CAAC,OAAO,wBAAwB,CAAC;QAE9F,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,CAAC,0BAA0B,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QACpG,MAAM,OAAO,GAAiC,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvE,CAAC;IAIM,kBAAkB,CAAC,EAAmC,EAAE,MAAY,EAAE,QAAiB;QAC5F,MAAM,MAAM,GAAiC;YAC3C,aAAa,EAAE,EAAE,CAAC,IAAI;YACtB,WAAW,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC;YACtD,SAAS,EAAE,MAAM;SAClB,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,KAAK,EAAE;YAC1F,MAAM,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;SACtC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,8BAA8B,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,GAAG,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QAChE,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAE9B,MAAM,SAAS,GAA6B;YAC1C,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;YACzB,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;SACpB,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,IAAY;QACvC,IAAI;YACF,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzD,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;YACzB,OAAO;SACR;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI;gBACF,MAAM,GAAG,GAAG,QAA2B,CAAC;gBACxC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,wBAAwB,EAAE;oBACnE,OAAO;iBACR;aACF;YAAC,MAAM,GAAG;YAEX,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW,IAAI,QAAQ,EAAE;gBACjD,MAAM,QAAQ,CAAC;aAChB;YAED,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,+BAA+B,IAAI,IAAI,CAAC,CAAC;SACrF;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAgB,EAAE,OAAmC,EAAE,QAAiB;;QAC3H,IAAI;YACF,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAEtC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACpE,MAAM,MAAM,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG;gBACtB,eAAe,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,0BAA0B;gBAC5D,gBAAgB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,sCAAsC;aAClF,CAAC;YAEF,MAAM,WAAW,GAAuC,QAAQ,CAAC,CAAC;gBAChE;oBACE,eAAe;oBACf,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE;iBAC1B,CAAC,CAAC,CAAC;gBACF,eAAe;aAChB,CAAC;YAEJ,MAAM,UAAU,GAAG,IAAI,oBAAW,EAAE,CAAC;YACrC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAErB,IAAI,MAAgB,CAAC;YAErB,IAAI,OAAO,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,EAAE;gBACjD,IAAI,SAAS,KAAK,WAAW,CAAC,eAAe;oBAC3C,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,wCAAwC,CAAC,CAAC;gBAEvF,WAAW,CAAC,eAAe,CAAC,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;gBAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACtC;iBAAM;gBACL,MAAM,GAAG,UAAU,CAAC;aACrB;YAED,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;YACpC,MAAM,WAAW,GAAG,CAAC,CAAC;YACtB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YACtF,OAAO,MAAA,MAAM,CAAC,IAAI,mCAAI,EAAE,CAAC;SAC1B;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW,IAAI,QAAQ,EAAE;gBACjD,MAAM,QAAQ,CAAC;aAChB;YAED,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,qBAAqB,IAAI,IAAI,CAAC,CAAC;SAC3E;IACH,CAAC;CACF;AApHD,4CAoHC;AAED;;;GAGG;AACH,MAAa,wBAAwB;IAArC;QACU,mBAAc,GAA+B,IAAI,GAAG,EAAE,CAAC;IAyCjE,CAAC;IAvCC,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;IACtC,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,EAAyB,EAAE,OAAmB,EAAE,YAAoB,EAAE,WAAmB,EAAE,QAAiB;;QACtI,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpD,IAAI;YACF,MAAM,OAAO,GAA8B,EAAE,CAAC;YAC9C,IAAI,uBAAU,CAAC,mBAAmB,EAAE;gBAClC,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC;aAClC;YAED,MAAM,QAAQ,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,uBAAU,CAAC,mBAAmB,EAAE,CAAC;YACtJ,MAAM,UAAU,GAAG,IAAI,yBAAU,CAAC,uCAAuC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;YAC3F,MAAM,CAAA,MAAA,uBAAU,CAAC,gBAAgB,0CAAE,MAAM,CAAC,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA,CAAC;YACjG,UAAU,CAAC,OAAO,EAAE,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,gBAAgB,EAAE,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;SACxH;QAED,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,UAA0B,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAwB,EAAE,QAAiB;QACpJ,MAAM,EAAE,GAA0B,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAE1E,MAAM,KAAK,GAAG,mCAAqB,CAAC,QAAQ,EAAE,CAAC;QAC/C,MAAM,YAAY,GAAG,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,YAAY,GAAG,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YAC9B,OAAO;QAET,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QACrF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACtC,MAAM,OAAO,CAAC;IAChB,CAAC;CACF;AA1CD,4DA0CC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { PassThrough, Readable } from \"stream\";\r\nimport * as zlib from \"zlib\";\r\nimport * as Azure from \"@azure/storage-blob\";\r\nimport { Logger, PerfLogger } from \"@itwin/core-bentley\";\r\nimport {\r\n BentleyStatus, CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider, CloudStorageTileCache, IModelError, IModelRpcProps,\r\n TileContentIdentifier,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** @beta */\r\nexport interface AzureBlobStorageCredentials {\r\n account: string;\r\n accessKey: string;\r\n baseUrl?: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface CloudStorageUploadOptions {\r\n type?: string;\r\n cacheControl?: string;\r\n contentEncoding?: \"gzip\";\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport abstract class CloudStorageService {\r\n public initialize(): void { }\r\n public terminate(): void { }\r\n public abstract id: CloudStorageProvider;\r\n public abstract obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl;\r\n public abstract upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string>;\r\n public async download(_name: string): Promise<Readable | undefined> { return undefined; }\r\n\r\n protected makeDescriptor(id: CloudStorageContainerDescriptor) {\r\n return { name: id.name, provider: this.id };\r\n }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport class AzureBlobStorage extends CloudStorageService {\r\n private _service: Azure.BlobServiceClient;\r\n private _credential: Azure.StorageSharedKeyCredential;\r\n private _baseUrl: string;\r\n\r\n public constructor(credentials: AzureBlobStorageCredentials) {\r\n super();\r\n\r\n if (!credentials.account || !credentials.accessKey) {\r\n throw new IModelError(BentleyStatus.ERROR, \"Invalid credentials for Azure blob storage.\");\r\n }\r\n\r\n this._baseUrl = credentials.baseUrl ?? `https://${credentials.account}.blob.core.windows.net`;\r\n\r\n this._credential = new Azure.StorageSharedKeyCredential(credentials.account, credentials.accessKey);\r\n const options: Azure.StoragePipelineOptions = {};\r\n const pipeline = Azure.newPipeline(this._credential, options);\r\n this._service = new Azure.BlobServiceClient(this._baseUrl, pipeline);\r\n }\r\n\r\n public readonly id = CloudStorageProvider.Azure;\r\n\r\n public obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl {\r\n const policy: Azure.BlobSASSignatureValues = {\r\n containerName: id.name,\r\n permissions: Azure.ContainerSASPermissions.parse(\"rl\"),\r\n expiresOn: expiry,\r\n };\r\n\r\n if (clientIp && clientIp !== \"localhost\" && clientIp !== \"127.0.0.1\" && clientIp !== \"::1\") {\r\n policy.ipRange = { start: clientIp };\r\n }\r\n\r\n const token = Azure.generateBlobSASQueryParameters(policy, this._credential);\r\n const url = new URL(this._baseUrl);\r\n url.pathname = `${url.pathname.replace(/\\/*$/, \"\")}/${id.name}`;\r\n url.search = token.toString();\r\n\r\n const urlObject: CloudStorageContainerUrl = {\r\n descriptor: this.makeDescriptor(id),\r\n valid: 0,\r\n expires: expiry.getTime(),\r\n url: url.toString(),\r\n };\r\n\r\n return urlObject;\r\n }\r\n\r\n public async ensureContainer(name: string): Promise<void> {\r\n try {\r\n const container = this._service.getContainerClient(name);\r\n await container.create();\r\n return;\r\n } catch (maybeErr) {\r\n try {\r\n const err = maybeErr as Azure.RestError;\r\n if (err.statusCode === 409 && err.code === \"ContainerAlreadyExists\") {\r\n return;\r\n }\r\n } catch { }\r\n\r\n if (typeof (maybeErr) !== \"undefined\" && maybeErr) {\r\n throw maybeErr;\r\n }\r\n\r\n throw new IModelError(BentleyStatus.ERROR, `Unable to create container \"${name}\".`);\r\n }\r\n }\r\n\r\n public async upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string> {\r\n try {\r\n await this.ensureContainer(container);\r\n\r\n const containerClient = this._service.getContainerClient(container);\r\n const blocks = containerClient.getBlockBlobClient(name);\r\n const blobHTTPHeaders = {\r\n blobContentType: options?.type ?? \"application/octet-stream\",\r\n blobCacheControl: options?.cacheControl ?? \"private, max-age=31536000, immutable\",\r\n };\r\n\r\n const blobOptions: Azure.BlockBlobUploadStreamOptions = metadata ?\r\n {\r\n blobHTTPHeaders,\r\n metadata: { ...metadata },\r\n } : {\r\n blobHTTPHeaders,\r\n };\r\n\r\n const dataStream = new PassThrough();\r\n dataStream.end(data);\r\n\r\n let source: Readable;\r\n\r\n if (options && options.contentEncoding === \"gzip\") {\r\n if (undefined === blobOptions.blobHTTPHeaders)\r\n throw new IModelError(BentleyStatus.ERROR, \"Blob HTTP headers object is undefined.\");\r\n\r\n blobOptions.blobHTTPHeaders.blobContentEncoding = options.contentEncoding;\r\n const compressor = zlib.createGzip();\r\n source = dataStream.pipe(compressor);\r\n } else {\r\n source = dataStream;\r\n }\r\n\r\n const blockSize = 100 * 1024 * 1024;\r\n const concurrency = 1;\r\n const result = await blocks.uploadStream(source, blockSize, concurrency, blobOptions);\r\n return result.etag ?? \"\";\r\n } catch (maybeErr) {\r\n if (typeof (maybeErr) !== \"undefined\" && maybeErr) {\r\n throw maybeErr;\r\n }\r\n\r\n throw new IModelError(BentleyStatus.ERROR, `Unable to upload \"${name}\".`);\r\n }\r\n }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport class CloudStorageTileUploader {\r\n private _activeUploads: Map<string, Promise<void>> = new Map();\r\n\r\n public get activeUploads(): Iterable<Promise<void>> {\r\n return this._activeUploads.values();\r\n }\r\n\r\n private async uploadToCache(id: TileContentIdentifier, content: Uint8Array, containerKey: string, resourceKey: string, metadata?: object,) {\r\n await new Promise((resolve) => setTimeout(resolve));\r\n\r\n try {\r\n const options: CloudStorageUploadOptions = {};\r\n if (IModelHost.compressCachedTiles) {\r\n options.contentEncoding = \"gzip\";\r\n }\r\n\r\n const perfInfo = { ...id.tokenProps, treeId: id.treeId, contentId: id.contentId, size: content.byteLength, compress: IModelHost.compressCachedTiles };\r\n const perfLogger = new PerfLogger(\"Uploading tile to external tile cache\", () => perfInfo);\r\n await IModelHost.tileCacheService?.upload(containerKey, resourceKey, content, options, metadata);\r\n perfLogger.dispose();\r\n } catch (err) {\r\n Logger.logError(BackendLoggerCategory.IModelTileUpload, (err instanceof Error) ? err.toString() : JSON.stringify(err));\r\n }\r\n\r\n this._activeUploads.delete(containerKey + resourceKey);\r\n }\r\n\r\n public async cacheTile(tokenProps: IModelRpcProps, treeId: string, contentId: string, content: Uint8Array, guid: string | undefined, metadata?: object): Promise<void> {\r\n const id: TileContentIdentifier = { tokenProps, treeId, contentId, guid };\r\n\r\n const cache = CloudStorageTileCache.getCache();\r\n const containerKey = cache.formContainerName(id);\r\n const resourceKey = cache.formResourceName(id);\r\n const key = containerKey + resourceKey;\r\n\r\n if (this._activeUploads.has(key))\r\n return;\r\n\r\n const promise = this.uploadToCache(id, content, containerKey, resourceKey, metadata);\r\n this._activeUploads.set(key, promise);\r\n await promise;\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"CloudStorageBackend.js","sourceRoot":"","sources":["../../src/CloudStorageBackend.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAA+C;AAC/C,6BAA6B;AAC7B,6CAA6C;AAC7C,sDAAyD;AACzD,oDAG4B;AAC5B,mEAAgE;AAChE,6CAA0C;AAqB1C;;;GAGG;AACH,MAAsB,mBAAmB;IAChC,UAAU,KAAW,CAAC;IACtB,SAAS,KAAW,CAAC;IAIrB,KAAK,CAAC,QAAQ,CAAC,KAAa,IAAmC,OAAO,SAAS,CAAC,CAAC,CAAC;IAE/E,cAAc,CAAC,EAAmC;QAC1D,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IAC9C,CAAC;CACF;AAXD,kDAWC;AAED;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,mBAAmB;IAKvD,YAAmB,WAAwC;;QACzD,KAAK,EAAE,CAAC;QAcM,OAAE,GAAG,kCAAoB,CAAC,KAAK,CAAC;QAZ9C,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE;YAClD,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,6CAA6C,CAAC,CAAC;SAC3F;QAED,IAAI,CAAC,QAAQ,GAAG,MAAA,WAAW,CAAC,OAAO,mCAAI,WAAW,WAAW,CAAC,OAAO,wBAAwB,CAAC;QAE9F,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,CAAC,0BAA0B,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QACpG,MAAM,OAAO,GAAiC,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvE,CAAC;IAIM,kBAAkB,CAAC,EAAmC,EAAE,MAAY,EAAE,QAAiB;QAC5F,MAAM,MAAM,GAAiC;YAC3C,aAAa,EAAE,EAAE,CAAC,IAAI;YACtB,WAAW,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC;YACtD,SAAS,EAAE,MAAM;SAClB,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,KAAK,EAAE;YAC1F,MAAM,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;SACtC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,8BAA8B,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,GAAG,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QAChE,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAE9B,MAAM,SAAS,GAA6B;YAC1C,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;YACzB,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;SACpB,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,IAAY;QACvC,IAAI;YACF,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzD,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;YACzB,OAAO;SACR;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI;gBACF,MAAM,GAAG,GAAG,QAA2B,CAAC;gBACxC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,wBAAwB,EAAE;oBACnE,OAAO;iBACR;aACF;YAAC,MAAM,GAAG;YAEX,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW,IAAI,QAAQ,EAAE;gBACjD,MAAM,QAAQ,CAAC;aAChB;YAED,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,+BAA+B,IAAI,IAAI,CAAC,CAAC;SACrF;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAgB,EAAE,OAAmC,EAAE,QAAiB;;QAC3H,IAAI;YACF,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAEtC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACpE,MAAM,MAAM,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG;gBACtB,eAAe,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,0BAA0B;gBAC5D,gBAAgB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,sCAAsC;aAClF,CAAC;YAEF,MAAM,WAAW,GAAuC,QAAQ,CAAC,CAAC;gBAChE;oBACE,eAAe;oBACf,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE;iBAC1B,CAAC,CAAC,CAAC;gBACF,eAAe;aAChB,CAAC;YAEJ,MAAM,UAAU,GAAG,IAAI,oBAAW,EAAE,CAAC;YACrC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAErB,IAAI,MAAgB,CAAC;YAErB,IAAI,OAAO,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,EAAE;gBACjD,IAAI,SAAS,KAAK,WAAW,CAAC,eAAe;oBAC3C,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,wCAAwC,CAAC,CAAC;gBAEvF,WAAW,CAAC,eAAe,CAAC,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;gBAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACtC;iBAAM;gBACL,MAAM,GAAG,UAAU,CAAC;aACrB;YAED,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;YACpC,MAAM,WAAW,GAAG,CAAC,CAAC;YACtB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YACtF,OAAO,MAAA,MAAM,CAAC,IAAI,mCAAI,EAAE,CAAC;SAC1B;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW,IAAI,QAAQ,EAAE;gBACjD,MAAM,QAAQ,CAAC;aAChB;YAED,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,qBAAqB,IAAI,IAAI,CAAC,CAAC;SAC3E;IACH,CAAC;CACF;AApHD,4CAoHC;AAED;;;GAGG;AACH,MAAa,wBAAwB;IAArC;QACU,mBAAc,GAA+B,IAAI,GAAG,EAAE,CAAC;IAyCjE,CAAC;IAvCC,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;IACtC,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,EAAyB,EAAE,OAAmB,EAAE,YAAoB,EAAE,WAAmB,EAAE,QAAiB;;QACtI,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpD,IAAI;YACF,MAAM,OAAO,GAA8B,EAAE,CAAC;YAC9C,IAAI,uBAAU,CAAC,mBAAmB,EAAE;gBAClC,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC;aAClC;YAED,MAAM,QAAQ,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,uBAAU,CAAC,mBAAmB,EAAE,CAAC;YACtJ,MAAM,UAAU,GAAG,IAAI,yBAAU,CAAC,uCAAuC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;YAC3F,MAAM,CAAA,MAAA,uBAAU,CAAC,gBAAgB,0CAAE,MAAM,CAAC,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA,CAAC;YACjG,UAAU,CAAC,OAAO,EAAE,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,gBAAgB,EAAE,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;SACxH;QAED,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,UAA0B,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAwB,EAAE,QAAiB;QACpJ,MAAM,EAAE,GAA0B,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAE1E,MAAM,KAAK,GAAG,mCAAqB,CAAC,QAAQ,EAAE,CAAC;QAC/C,MAAM,YAAY,GAAG,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,YAAY,GAAG,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YAC9B,OAAO;QAET,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QACrF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACtC,MAAM,OAAO,CAAC;IAChB,CAAC;CACF;AA1CD,4DA0CC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { PassThrough, Readable } from \"stream\";\r\nimport * as zlib from \"zlib\";\r\nimport * as Azure from \"@azure/storage-blob\";\r\nimport { Logger, PerfLogger } from \"@itwin/core-bentley\";\r\nimport {\r\n BentleyStatus, CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider, CloudStorageTileCache, IModelError, IModelRpcProps,\r\n TileContentIdentifier,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** @beta */\r\nexport interface AzureBlobStorageCredentials {\r\n account: string;\r\n accessKey: string;\r\n baseUrl?: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport interface CloudStorageUploadOptions {\r\n type?: string;\r\n cacheControl?: string;\r\n contentEncoding?: \"gzip\";\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport abstract class CloudStorageService {\r\n public initialize(): void { }\r\n public terminate(): void { }\r\n public abstract id: CloudStorageProvider;\r\n public abstract obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl;\r\n public abstract upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string>;\r\n public async download(_name: string): Promise<Readable | undefined> { return undefined; }\r\n\r\n protected makeDescriptor(id: CloudStorageContainerDescriptor) {\r\n return { name: id.name, provider: this.id };\r\n }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport class AzureBlobStorage extends CloudStorageService {\r\n private _service: Azure.BlobServiceClient;\r\n private _credential: Azure.StorageSharedKeyCredential;\r\n private _baseUrl: string;\r\n\r\n public constructor(credentials: AzureBlobStorageCredentials) {\r\n super();\r\n\r\n if (!credentials.account || !credentials.accessKey) {\r\n throw new IModelError(BentleyStatus.ERROR, \"Invalid credentials for Azure blob storage.\");\r\n }\r\n\r\n this._baseUrl = credentials.baseUrl ?? `https://${credentials.account}.blob.core.windows.net`;\r\n\r\n this._credential = new Azure.StorageSharedKeyCredential(credentials.account, credentials.accessKey);\r\n const options: Azure.StoragePipelineOptions = {};\r\n const pipeline = Azure.newPipeline(this._credential, options);\r\n this._service = new Azure.BlobServiceClient(this._baseUrl, pipeline);\r\n }\r\n\r\n public readonly id = CloudStorageProvider.Azure;\r\n\r\n public obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl {\r\n const policy: Azure.BlobSASSignatureValues = {\r\n containerName: id.name,\r\n permissions: Azure.ContainerSASPermissions.parse(\"rl\"),\r\n expiresOn: expiry,\r\n };\r\n\r\n if (clientIp && clientIp !== \"localhost\" && clientIp !== \"127.0.0.1\" && clientIp !== \"::1\") {\r\n policy.ipRange = { start: clientIp };\r\n }\r\n\r\n const token = Azure.generateBlobSASQueryParameters(policy, this._credential);\r\n const url = new URL(this._baseUrl);\r\n url.pathname = `${url.pathname.replace(/\\/*$/, \"\")}/${id.name}`;\r\n url.search = token.toString();\r\n\r\n const urlObject: CloudStorageContainerUrl = {\r\n descriptor: this.makeDescriptor(id),\r\n valid: 0,\r\n expires: expiry.getTime(),\r\n url: url.toString(),\r\n };\r\n\r\n return urlObject;\r\n }\r\n\r\n public async ensureContainer(name: string): Promise<void> {\r\n try {\r\n const container = this._service.getContainerClient(name);\r\n await container.create();\r\n return;\r\n } catch (maybeErr) {\r\n try {\r\n const err = maybeErr as Azure.RestError;\r\n if (err.statusCode === 409 && err.code === \"ContainerAlreadyExists\") {\r\n return;\r\n }\r\n } catch { }\r\n\r\n if (typeof (maybeErr) !== \"undefined\" && maybeErr) {\r\n throw maybeErr;\r\n }\r\n\r\n throw new IModelError(BentleyStatus.ERROR, `Unable to create container \"${name}\".`);\r\n }\r\n }\r\n\r\n public async upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string> {\r\n try {\r\n await this.ensureContainer(container);\r\n\r\n const containerClient = this._service.getContainerClient(container);\r\n const blocks = containerClient.getBlockBlobClient(name);\r\n const blobHTTPHeaders = {\r\n blobContentType: options?.type ?? \"application/octet-stream\",\r\n blobCacheControl: options?.cacheControl ?? \"private, max-age=31536000, immutable\",\r\n };\r\n\r\n const blobOptions: Azure.BlockBlobUploadStreamOptions = metadata ?\r\n {\r\n blobHTTPHeaders,\r\n metadata: { ...metadata },\r\n } : {\r\n blobHTTPHeaders,\r\n };\r\n\r\n const dataStream = new PassThrough();\r\n dataStream.end(data);\r\n\r\n let source: Readable;\r\n\r\n if (options && options.contentEncoding === \"gzip\") {\r\n if (undefined === blobOptions.blobHTTPHeaders)\r\n throw new IModelError(BentleyStatus.ERROR, \"Blob HTTP headers object is undefined.\");\r\n\r\n blobOptions.blobHTTPHeaders.blobContentEncoding = options.contentEncoding;\r\n const compressor = zlib.createGzip();\r\n source = dataStream.pipe(compressor);\r\n } else {\r\n source = dataStream;\r\n }\r\n\r\n const blockSize = 100 * 1024 * 1024;\r\n const concurrency = 1;\r\n const result = await blocks.uploadStream(source, blockSize, concurrency, blobOptions);\r\n return result.etag ?? \"\";\r\n } catch (maybeErr) {\r\n if (typeof (maybeErr) !== \"undefined\" && maybeErr) {\r\n throw maybeErr;\r\n }\r\n\r\n throw new IModelError(BentleyStatus.ERROR, `Unable to upload \"${name}\".`);\r\n }\r\n }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport class CloudStorageTileUploader {\r\n private _activeUploads: Map<string, Promise<void>> = new Map();\r\n\r\n public get activeUploads(): Iterable<Promise<void>> {\r\n return this._activeUploads.values();\r\n }\r\n\r\n private async uploadToCache(id: TileContentIdentifier, content: Uint8Array, containerKey: string, resourceKey: string, metadata?: object,) {\r\n await new Promise((resolve) => setTimeout(resolve));\r\n\r\n try {\r\n const options: CloudStorageUploadOptions = {};\r\n if (IModelHost.compressCachedTiles) {\r\n options.contentEncoding = \"gzip\";\r\n }\r\n\r\n const perfInfo = { ...id.tokenProps, treeId: id.treeId, contentId: id.contentId, size: content.byteLength, compress: IModelHost.compressCachedTiles };\r\n const perfLogger = new PerfLogger(\"Uploading tile to external tile cache\", () => perfInfo);\r\n await IModelHost.tileCacheService?.upload(containerKey, resourceKey, content, options, metadata);\r\n perfLogger.dispose();\r\n } catch (err) {\r\n Logger.logError(BackendLoggerCategory.IModelTileUpload, (err instanceof Error) ? err.toString() : JSON.stringify(err));\r\n }\r\n\r\n this._activeUploads.delete(containerKey + resourceKey);\r\n }\r\n\r\n public async cacheTile(tokenProps: IModelRpcProps, treeId: string, contentId: string, content: Uint8Array, guid: string | undefined, metadata?: object): Promise<void> {\r\n const id: TileContentIdentifier = { tokenProps, treeId, contentId, guid };\r\n\r\n const cache = CloudStorageTileCache.getCache();\r\n const containerKey = cache.formContainerName(id);\r\n const resourceKey = cache.formResourceName(id);\r\n const key = containerKey + resourceKey;\r\n\r\n if (this._activeUploads.has(key))\r\n return;\r\n\r\n const promise = this.uploadToCache(id, content, containerKey, resourceKey, metadata);\r\n this._activeUploads.set(key, promise);\r\n await promise;\r\n }\r\n}\r\n"]}
package/lib/cjs/Element.d.ts CHANGED
@@ -257,7 +257,7 @@ export declare class Element extends Entity {
257
257
  */
258
258
  toJSON(): ElementProps;
259
259
  /** Collect the Ids of this element's *references* at this level of the class hierarchy.
260
- * @deprecated use [[collectReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
260
+ * @deprecated in 3.x. use [[collectReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
261
261
  * @beta
262
262
  */
263
263
  protected collectPredecessorIds(predecessorIds: Id64Set): void;
@@ -266,7 +266,7 @@ export declare class Element extends Entity {
266
266
  /** Get the Ids of this element's *references*. A *reference* is any element whose id is stored in the EC data of this element
267
267
  * This is important for cloning operations but can be useful in other situations as well.
268
268
  * @beta
269
- * @deprecated use [[getReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
269
+ * @deprecated in 3.x. use [[getReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
270
270
  */
271
271
  getPredecessorIds(): Id64Set;
272
272
  /** A *required reference* is an element that had to be inserted before this element could have been inserted.
package/lib/cjs/Element.js CHANGED
@@ -230,7 +230,7 @@ class Element extends Entity_1.Entity {
230
230
  return val;
231
231
  }
232
232
  /** Collect the Ids of this element's *references* at this level of the class hierarchy.
233
- * @deprecated use [[collectReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
233
+ * @deprecated in 3.x. use [[collectReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
234
234
  * @beta
235
235
  */
236
236
  collectPredecessorIds(predecessorIds) {
@@ -248,7 +248,7 @@ class Element extends Entity_1.Entity {
248
248
  /** Get the Ids of this element's *references*. A *reference* is any element whose id is stored in the EC data of this element
249
249
  * This is important for cloning operations but can be useful in other situations as well.
250
250
  * @beta
251
- * @deprecated use [[getReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
251
+ * @deprecated in 3.x. use [[getReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
252
252
  */
253
253
  getPredecessorIds() {
254
254
  return this.getReferenceIds();