@itwin/core-backend 5.1.0-dev.3 → 5.1.0-dev.32

package/lib/cjs/CatalogDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"CatalogDb.js","sourceRoot":"","sources":["../../src/CatalogDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,+BAA4B;AAC5B,+CAA4C;AAC5C,6CAA0D;AAC1D,oDAAiI;AACjI,uCAAuC;AACvC,yCAA0C;AAC1C,sDAAqD;AACrD,gDAA+C;AAC/C,8DAAyD;AAQzD,IAAI,kBAAiD,CAAC;AACtD,IAAI,mBAAkD,CAAC;AACvD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAE9C,mHAAmH;AACnH,SAAS,cAAc,CAAC,GAAoC,EAAE,SAAkB;IAC9E,MAAM,KAAK,GAAG,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAsB,CAAC;IACzE,qEAAqE;IACrE,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1C,yBAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,GAAG,EAAsC,CAAC,CAAC;QACzG,yBAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kGAAkG;AAClG,KAAK,UAAU,sBAAsB,CAAC,KAAwB,EAAE,WAAmB;IACjF,MAAM,cAAc,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAChE,IAAI,SAAS,KAAK,cAAc;QAC9B,OAAO,cAAc,CAAC;IAExB,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,yBAAW,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC/I,MAAM,SAAS,GAAG,yBAAW,CAAC,oBAAoB,CAAC;QACjD,WAAW;QACX,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,WAAW;QACX,WAAW,EAAE,UAAU,CAAC,QAAQ;QAChC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,UAAU,CAAC,KAAK;KAC9B,CAAC,CAAC;IACH,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,qEAAqE;IAC1H,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,KAAK,OAAO,kBAAkB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACtI,SAAS,qBAAqB,KAAK,OAAO,mBAAmB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAC/I,KAAK,UAAU,oBAAoB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACjI,KAAK,UAAU,qBAAqB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAElI,8EAA8E;AAC9E,SAAS,YAAY,CAAC,SAAqC,EAAE,MAAc;IACzE,IAAI,CAAC,SAAS,CAAC,YAAY;QACzB,8BAAgB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,8BAA8B,MAAM,EAAE,EAAE,CAAC,CAAC;AAC5G,CAAC;AACD,mEAAmE;AACnE,SAAS,cAAc,CAAC,QAA8B,EAAE,QAAgC;IACtF,QAAQ,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;AAC1C,CAAC;AACD,SAAS,wBAAwB,CAAC,MAAe;IAC/C,OAAO,MAAM,IAAI,YAAY,CAAC;AAChC,CAAC;AA0BD,gDAAgD;AAChD,MAAM,aAAc,SAAQ,uBAAY;IAC/B,UAAU;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,WAAW;QAChB,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAS,CAAC,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;QAC5E,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO,SAAS,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAA2B,CAAC;IAC9D,CAAC;IAEM,UAAU;QACf,OAAO,yBAAW,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC;IAC5E,CAAC;IAEM,OAAO;QACZ,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;IACtE,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,qBAAsB,SAAQ,aAAa;IAC/B,UAAU;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,qBAAqB,CAAC,QAAgC;QAC3D,cAAc,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,kFAAkF;IAClE,WAAW;QACzB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC;YACtC,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;gBAC1B,QAAQ,CAAC,YAAY,GAAG,yBAAW,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBAClE,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;YACvC,CAAC;YAED,sHAAsH;YACtH,IAAI,CAAC,mBAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAEjD,kCAAkC;QAClC,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,GAAW;IACnC,OAAO,aAAa,CAAC,SAAS,CAAC,GAAG,CAAsC,CAAC;AAC3E,CAAC;AAED,YAAY;AACZ,IAAiB,SAAS,CAuIzB;AAvID,WAAiB,SAAS;IACxB;;;MAGE;IACK,KAAK,UAAU,kBAAkB,CAAC,IAA0C;QACjF,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,yBAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACnC,yBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,2BAAc,CAAC,MAAM,EAAE,QAAQ,MAAM,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,6EAA6E;YAC7E,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnD,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;YACjD,QAAQ,CAAC,UAAU,CAAC,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAkC;YACnE,QAAQ,CAAC,WAAW,CAAC,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,mCAAmC;YAC7E,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wCAAwC;YACjF,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,yFAAyF;YACnH,QAAQ,CAAC,gBAAgB,CAAC,8BAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,uCAAuC;YAC/F,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,6BAA6B;YACrD,QAAQ,CAAC,MAAM,EAAE,CAAC;YAClB,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,0BAAY,CAAC,UAAU,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,iFAAiF;QACjF,MAAM,mBAAmB,GAAG,MAAM,yBAAW,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAEvL,yDAAyD;QACzD,MAAM,SAAS,GAAG,yBAAW,CAAC,oBAAoB,CAAC;YACjD,WAAW,EAAE,MAAM,yBAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC;YAChE,WAAW,EAAE,OAAO;YACpB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,WAAW,EAAE,mBAAmB,CAAC,QAAQ;SAC1C,CAAC,CAAC;QAEH,kDAAkD;QAClD,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;QAC9D,SAAS,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE3C,4CAA4C;QAC5C,MAAM,yBAAW,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,yBAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,yBAAW,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;YAC5H,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAmC;QAC7D,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAhDqB,4BAAkB,qBAgDvC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAQtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;IAXqB,0BAAgB,mBAWrC,CAAA;IAED,mKAAmK;IAC5J,KAAK,UAAU,gBAAgB,CAAC,IAKtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,OAAO;YACd,SAAS,CAAC,cAAc,EAAE,CAAC;QAC7B,yBAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IAVqB,0BAAgB,mBAUrC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,EAAE,IAAI,CAA0B,CAAC;QAEnG,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC,CAAC,2CAA2C;QAElG,qCAAqC;QACrC,MAAM,UAAU,GAAG,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;QACrG,IAAI,CAAC,yBAAW,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAC;YACtD,8BAAgB,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE,OAAO,EAAE,mFAAmF,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QAE7J,IAAI,IAAI,CAAC,QAAQ;YACf,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,UAAU,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAA0B,CAAC;IACzH,CAAC;IAjBqB,sBAAY,eAiBjC,CAAA;IAED,iDAAiD;IAC1C,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAkB,CAAC;QAElF,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,aAAa;YACpB,SAAS,CAAC,eAAe,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ;YACf,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAkB,CAAC;IACxG,CAAC;IAdqB,sBAAY,eAcjC,CAAA;IAED;;;;OAIG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAAwC;QAC7E,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QAChD,OAAO,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAClJ,CAAC;IAJqB,0BAAgB,mBAIrC,CAAA;AACH,CAAC,EAvIgB,SAAS,yBAAT,SAAS,QAuIzB;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,oBAAU;IAClD,IAAW,WAAW,KAA+B,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAE3E,KAAK,CAAC,kBAAkB,CAAC,IAA0C;QACxE,OAAO,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAgD;QAC5E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAA8C;QAC1E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACnE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAwC;QACpE,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,GAAW,EAAE,QAAgC;QAC9E,gBAAgB,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF;AA3BD,oDA2BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport * as fs from \"fs\";\nimport { join } from \"path\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\nimport { BriefcaseIdValue, CatalogError, type CatalogIModel, CloudSqliteError, IModelConnectionProps } from \"@itwin/core-common\";\nimport { IpcHandler } from \"./IpcHost\";\nimport { StandaloneDb } from \"./IModelDb\";\nimport { Guid, OpenMode } from \"@itwin/core-bentley\";\nimport { _nativeDb } from \"./internal/Symbols\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\n\ninterface CatalogCloudCache extends CloudSqlite.CloudCache {\n  writeable: boolean;\n  catalogContainers: Map<string, CloudSqlite.CloudContainer>;\n}\n\nlet readonlyCloudCache: CatalogCloudCache | undefined;\nlet writeableCloudCache: CatalogCloudCache | undefined;\nconst catalogManifestName = \"CatalogManifest\";\n\n// we make a readonly CloudCache and a writeable CloudCache. That way the access token authorizations are distinct.\nfunction makeCloudCache(arg: CloudSqlite.CreateCloudCacheArg, writeable: boolean) {\n  const cache = CloudSqlite.CloudCaches.getCache(arg) as CatalogCloudCache;\n  // if the cache was just created, add the \"catalog\" members as hidden\n  if (undefined === cache.catalogContainers) {\n    CloudSqlite.addHiddenProperty(cache, \"catalogContainers\", new Map<string, CloudSqlite.CloudContainer>());\n    CloudSqlite.addHiddenProperty(cache, \"writeable\", writeable);\n  }\n  return cache;\n}\n\n// find an existing CloudContainer for accessing a CatalogIModel, or make a new one and connect it\nasync function getCatalogContainerObj(cache: CatalogCloudCache, containerId: string): Promise<CloudSqlite.CloudContainer> {\n  const cloudContainer = cache.catalogContainers.get(containerId);\n  if (undefined !== cloudContainer)\n    return cloudContainer;\n\n  const accessLevel = cache.writeable ? \"write\" : \"read\";\n  const tokenProps = await CloudSqlite.getBlobService().requestToken({ containerId, accessLevel, userToken: await IModelHost.getAccessToken() });\n  const container = CloudSqlite.createCloudContainer({\n    accessLevel,\n    baseUri: tokenProps.baseUri,\n    containerId,\n    storageType: tokenProps.provider,\n    writeable: cache.writeable,\n    accessToken: tokenProps.token\n  });\n  cache.catalogContainers.set(containerId, container); // save the container in the map of ContainerIds so we can reuse them\n  container.connect(cache);\n  return container;\n}\n\nfunction getReadonlyCloudCache() { return readonlyCloudCache ??= makeCloudCache({ cacheName: \"catalogs\", cacheSize: \"10G\" }, false) };\nfunction getWritableCloudCache() { return writeableCloudCache ??= makeCloudCache({ cacheName: \"writeableCatalogs\", cacheSize: \"10G\" }, true) };\nasync function getReadonlyContainer(containerId: string) { return getCatalogContainerObj(getReadonlyCloudCache(), containerId) };\nasync function getWriteableContainer(containerId: string) { return getCatalogContainerObj(getWritableCloudCache(), containerId) };\n\n/** Throw an error if the write lock is not held for the supplied container */\nfunction ensureLocked(container: CloudSqlite.CloudContainer, reason: string) {\n  if (!container.hasWriteLock)\n    CloudSqliteError.throwError(\"write-lock-not-held\", { message: `Write lock must be held to ${reason}` });\n}\n/** update the manifest in a CatalogIModel (calls `saveChanges`) */\nfunction updateManifest(nativeDb: IModelJsNative.DgnDb, manifest: CatalogIModel.Manifest) {\n  nativeDb.saveLocalValue(catalogManifestName, JSON.stringify(manifest));\n  nativeDb.saveChanges(\"update manifest\");\n}\nfunction catalogDbNameWithDefault(dbName?: string): string {\n  return dbName ?? \"catalog-db\";\n}\n\n/** A [[StandaloneDb]] that provides read-only access to the contents of a [CatalogIModel]($common).\n * @see [[CatalogDb.openReadonly]] to instantiate this type.\n * @beta\n */\nexport interface CatalogDb extends StandaloneDb {\n  /** Get the catalog's manifest. */\n  getManifest(): CatalogIModel.Manifest | undefined;\n  /** Get the catalog's version information. */\n  getVersion(): string;\n  /** Get the catalog's manifest and version. */\n  getInfo(): { manifest?: CatalogIModel.Manifest, version: string };\n  /** Returns true if the catalog was opened in read-write mode. */\n  isEditable(): this is EditableCatalogDb;\n}\n\n/** A writable [[CatalogDb]].\n * @see [[CatalogDb.openEditable]] to instantiate this type.\n * @beta\n */\nexport interface EditableCatalogDb extends CatalogDb {\n  /** Update the contents of the catalog manifest.  */\n  updateCatalogManifest(manifest: CatalogIModel.Manifest): void;\n}\n\n/** A StandaloneDb that holds a CatalogIModel */\nclass CatalogDbImpl extends StandaloneDb implements CatalogDb {\n  public isEditable(): this is EditableCatalogDb {\n    return false;\n  }\n\n  public getManifest(): CatalogIModel.Manifest | undefined {\n    const manifestString = this[_nativeDb].queryLocalValue(catalogManifestName);\n    if (undefined === manifestString)\n      return undefined;\n    return JSON.parse(manifestString) as CatalogIModel.Manifest;\n  }\n\n  public getVersion(): string {\n    return CloudSqlite.parseDbFileName(this[_nativeDb].getFilePath()).version;\n  }\n\n  public getInfo() {\n    return { manifest: this.getManifest(), version: this.getVersion() };\n  }\n}\n\n/**\n * A CatalogDb that permits editing.\n * This class ensures that CatalogIModels never have a Txn table when they are published.\n * It also automatically updates the `lastEditedBy` field in the CatalogManifest.\n */\nclass EditableCatalogDbImpl extends CatalogDbImpl implements EditableCatalogDb {\n  public override isEditable(): this is EditableCatalogDb {\n    return true;\n  }\n\n  public updateCatalogManifest(manifest: CatalogIModel.Manifest): void {\n    updateManifest(this[_nativeDb], manifest);\n  }\n\n  // Make sure the txn table is deleted and update the manifest every time we close.\n  public override beforeClose(): void {\n    try {\n      const manifest = this.getManifest();\n      const container = this.cloudContainer;\n      if (container && manifest) {\n        manifest.lastEditedBy = CloudSqlite.getWriteLockHeldBy(container);\n        this.updateCatalogManifest(manifest);\n      }\n\n      // when saved, CatalogIModels should never have any Txns. If we wanted to create a changeset, we'd have to do it here.\n      this[_nativeDb].deleteAllTxns();\n    } catch { } // ignore errors attempting to update\n\n    // might also want to vacuum here?\n    super.beforeClose();\n  }\n}\n\nfunction findCatalogByKey(key: string): CatalogDbImpl & EditableCatalogDb {\n  return CatalogDbImpl.findByKey(key) as CatalogDbImpl & EditableCatalogDb;\n}\n\n/** @beta */\nexport namespace CatalogDb {\n  /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].\n   * @returns The properties of the newly created container.\n   * @note creating new containers requires \"admin\" authorization.\n  */\n  export async function createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    CloudSqlite.validateDbName(dbName);\n    CloudSqlite.validateDbVersion(args.version);\n\n    const tmpName = join(KnownLocations.tmpdir, `temp-${dbName}`);\n    try {\n      // make a copy of the file they supplied so we can modify its contents safely\n      fs.copyFileSync(args.localCatalogFile, tmpName);\n      const nativeDb = new IModelNative.platform.DgnDb();\n      nativeDb.openIModel(tmpName, OpenMode.ReadWrite);\n      nativeDb.setITwinId(Guid.empty); // catalogs must be a StandaloneDb\n      nativeDb.setIModelId(Guid.createValue()); // make sure its iModelId is unique\n      updateManifest(nativeDb, args.manifest); // store the manifest inside the Catalog\n      nativeDb.deleteAllTxns(); // Catalogs should never have Txns (and, this must be empty before resetting BriefcaseId)\n      nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned); // catalogs should always be unassigned\n      nativeDb.saveChanges(); // save change to briefcaseId\n      nativeDb.vacuum();\n      nativeDb.closeFile();\n    } catch (e: unknown) {\n      CatalogError.throwError(\"invalid-seed-catalog\", { message: \"Illegal seed catalog\", ...args, cause: e });\n    }\n\n    const userToken = await IModelHost.getAccessToken();\n    // create tne new container from the blob service, requires \"admin\" authorization\n    const cloudContainerProps = await CloudSqlite.getBlobService().create({ scope: { iTwinId: args.iTwinId }, metadata: { ...args.metadata, containerType: \"CatalogIModel\" }, userToken });\n\n    // now create a CloudSqlite container object to access it\n    const container = CloudSqlite.createCloudContainer({\n      accessToken: await CloudSqlite.requestToken(cloudContainerProps),\n      accessLevel: \"admin\",\n      writeable: true,\n      baseUri: cloudContainerProps.baseUri,\n      containerId: cloudContainerProps.containerId,\n      storageType: cloudContainerProps.provider,\n    });\n\n    // initialize the container for use by CloudSqlite\n    container.initializeContainer({ blockSize: 4 * 1024 * 1024 });\n    container.connect(getWritableCloudCache());\n\n    // upload the initial version of the Catalog\n    await CloudSqlite.withWriteLock({ user: \"initialize\", container }, async () => {\n      await CloudSqlite.uploadDb(container, { dbName: CloudSqlite.makeSemverName(dbName, args.version), localFileName: tmpName });\n      fs.unlinkSync(tmpName); // delete temporary copy of catalog\n    });\n    container.disconnect();\n    return cloudContainerProps;\n  }\n\n  /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.\n   * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].\n   * @note This requires \"write\" authorization to the container\n   */\n  export async function acquireWriteLock(args: {\n    /** The id of the container */\n    containerId: string,\n    /**\n     * The name of the individual acquiring the lock. This will be shown to others who attempt to acquire the lock while it is held.\n     * It is also stored in the \"lastEditedBy\" field of the manifest of any new version edited while the lock is held.\n     */\n    username: string;\n  }): Promise<void> {\n    const container = await getWriteableContainer(args.containerId);\n    return CloudSqlite.acquireWriteLock({ container, user: args.username });\n  }\n\n  /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */\n  export async function releaseWriteLock(args: {\n    /** The id of the container */\n    containerId: string,\n    /** If true, abandon all local changes before releasing the lock */\n    abandon?: true\n  }): Promise<void> {\n    const container = await getWriteableContainer(args.containerId);\n    if (args.abandon)\n      container.abandonChanges();\n    CloudSqlite.releaseWriteLock(container);\n  }\n\n  /** Open an [[EditableCatalogDb]] for write access.\n   * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.\n   * @note The write lock must be held for this operation to succeed\n   */\n  export async function openEditable(args: CatalogIModel.OpenArgs): Promise<EditableCatalogDb> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    if (undefined === args.containerId) // local file?\n      return EditableCatalogDbImpl.openFile(dbName, OpenMode.ReadWrite, args) as EditableCatalogDbImpl;\n\n    const container = await getWriteableContainer(args.containerId);\n    ensureLocked(container, \"open a Catalog for editing\"); // editing Catalogs requires the write lock\n\n    // look up the full name with version\n    const dbFullName = CloudSqlite.querySemverMatch({ container, dbName, version: args.version ?? \"*\" });\n    if (!CloudSqlite.isSemverEditable(dbFullName, container))\n      CloudSqliteError.throwError(\"already-published\", { message: \"Catalog has already been published and is not editable. Make a new version first.\", ...args })\n\n    if (args.prefetch)\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\n\n    return EditableCatalogDbImpl.openFile(dbFullName, OpenMode.ReadWrite, { container, ...args }) as EditableCatalogDbImpl;\n  }\n\n  /** Open a [[CatalogDb]] for read-only access. */\n  export async function openReadonly(args: CatalogIModel.OpenArgs): Promise<CatalogDb> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    if (undefined === args.containerId) // local file?\n      return CatalogDbImpl.openFile(dbName, OpenMode.Readonly, args) as CatalogDbImpl;\n\n    const container = await getReadonlyContainer(args.containerId);\n    if (args.syncWithCloud)\n      container.checkForChanges();\n\n    const dbFullName = CloudSqlite.querySemverMatch({ container, ...args, dbName });\n    if (args.prefetch)\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\n\n    return CatalogDbImpl.openFile(dbFullName, OpenMode.Readonly, { container, ...args }) as CatalogDbImpl;\n  }\n\n  /**\n   * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy\n   * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.\n   * @note The write lock must be held for this operation to succeed\n   */\n  export async function createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\n    const container = await getWriteableContainer(args.containerId);\n    ensureLocked(container, \"create a new version\");\n    return CloudSqlite.createNewDbVersion(container, { ...args, fromDb: { ...args.fromDb, dbName: catalogDbNameWithDefault(args.fromDb.dbName) } });\n  }\n}\n\n/**\n * Handler for Ipc access to CatalogIModels. Registered by NativeHost.\n * @internal\n */\nexport class CatalogIModelHandler extends IpcHandler implements CatalogIModel.IpcMethods {\n  public get channelName(): CatalogIModel.IpcChannel { return \"catalogIModel/ipc\"; }\n\n  public async createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\n    return CatalogDb.createNewContainer(args);\n  }\n  public async acquireWriteLock(args: { containerId: string, username: string; }): Promise<void> {\n    return CatalogDb.acquireWriteLock(args);\n  }\n  public async releaseWriteLock(args: { containerId: string, abandon?: true; }): Promise<void> {\n    return CatalogDb.releaseWriteLock(args);\n  }\n  public async openReadonly(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\n    return ((await CatalogDb.openReadonly(args)).getConnectionProps());\n  }\n  public async openEditable(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\n    return (await CatalogDb.openEditable(args)).getConnectionProps();\n  }\n  public async createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\n    return CatalogDb.createNewVersion(args);\n  }\n  public async getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }> {\n    return findCatalogByKey(key).getInfo();\n  }\n  public async updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void> {\n    findCatalogByKey(key).updateCatalogManifest(manifest);\n  }\n}\n"]}
+{"version":3,"file":"CatalogDb.js","sourceRoot":"","sources":["../../src/CatalogDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,+BAA4B;AAC5B,+CAA4C;AAC5C,6CAA0D;AAC1D,oDAAiI;AACjI,uCAAuC;AACvC,yCAA0C;AAC1C,sDAAqD;AACrD,gDAA+C;AAC/C,8DAAyD;AAQzD,IAAI,kBAAiD,CAAC;AACtD,IAAI,mBAAkD,CAAC;AACvD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAE9C,mHAAmH;AACnH,SAAS,cAAc,CAAC,GAAoC,EAAE,SAAkB;IAC9E,MAAM,KAAK,GAAG,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAsB,CAAC;IACzE,qEAAqE;IACrE,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1C,yBAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,GAAG,EAAsC,CAAC,CAAC;QACzG,yBAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kGAAkG;AAClG,KAAK,UAAU,sBAAsB,CAAC,KAAwB,EAAE,WAAmB;IACjF,MAAM,cAAc,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAChE,IAAI,SAAS,KAAK,cAAc;QAC9B,OAAO,cAAc,CAAC;IAExB,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,yBAAW,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC/I,MAAM,SAAS,GAAG,yBAAW,CAAC,oBAAoB,CAAC;QACjD,WAAW;QACX,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,WAAW;QACX,WAAW,EAAE,UAAU,CAAC,QAAQ;QAChC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,UAAU,CAAC,KAAK;KAC9B,CAAC,CAAC;IACH,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,qEAAqE;IAC1H,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,KAAK,OAAO,kBAAkB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACtI,SAAS,qBAAqB,KAAK,OAAO,mBAAmB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAC/I,KAAK,UAAU,oBAAoB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACjI,KAAK,UAAU,qBAAqB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAElI,8EAA8E;AAC9E,SAAS,YAAY,CAAC,SAAqC,EAAE,MAAc;IACzE,IAAI,CAAC,SAAS,CAAC,YAAY;QACzB,8BAAgB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,8BAA8B,MAAM,EAAE,EAAE,CAAC,CAAC;AAC5G,CAAC;AACD,mEAAmE;AACnE,SAAS,cAAc,CAAC,QAA8B,EAAE,QAAgC;IACtF,QAAQ,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;AAC1C,CAAC;AACD,SAAS,wBAAwB,CAAC,MAAe;IAC/C,OAAO,MAAM,IAAI,YAAY,CAAC;AAChC,CAAC;AA0BD,gDAAgD;AAChD,MAAM,aAAc,SAAQ,uBAAY;IAC/B,UAAU;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,WAAW;QAChB,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAS,CAAC,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;QAC5E,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO,SAAS,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAA2B,CAAC;IAC9D,CAAC;IAEM,UAAU;QACf,OAAO,yBAAW,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC;IAC5E,CAAC;IAEM,OAAO;QACZ,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;IACtE,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,qBAAsB,SAAQ,aAAa;IAC/B,UAAU;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,qBAAqB,CAAC,QAAgC;QAC3D,cAAc,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,kFAAkF;IAClE,WAAW;QACzB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC;YACtC,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;gBAC1B,QAAQ,CAAC,YAAY,GAAG,yBAAW,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBAClE,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;YACvC,CAAC;YAED,sHAAsH;YACtH,IAAI,CAAC,mBAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAEjD,kCAAkC;QAClC,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,GAAW;IACnC,OAAO,aAAa,CAAC,SAAS,CAAC,GAAG,CAAsC,CAAC;AAC3E,CAAC;AAED,YAAY;AACZ,IAAiB,SAAS,CAuIzB;AAvID,WAAiB,SAAS;IACxB;;;MAGE;IACK,KAAK,UAAU,kBAAkB,CAAC,IAA0C;QACjF,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,yBAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACnC,yBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,2BAAc,CAAC,MAAM,EAAE,QAAQ,MAAM,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,6EAA6E;YAC7E,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnD,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;YACjD,QAAQ,CAAC,UAAU,CAAC,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAkC;YACnE,QAAQ,CAAC,WAAW,CAAC,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,mCAAmC;YAC7E,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wCAAwC;YACjF,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,yFAAyF;YACnH,QAAQ,CAAC,gBAAgB,CAAC,8BAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,uCAAuC;YAC/F,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,6BAA6B;YACrD,QAAQ,CAAC,MAAM,EAAE,CAAC;YAClB,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,0BAAY,CAAC,UAAU,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,iFAAiF;QACjF,MAAM,mBAAmB,GAAG,MAAM,yBAAW,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAEvL,yDAAyD;QACzD,MAAM,SAAS,GAAG,yBAAW,CAAC,oBAAoB,CAAC;YACjD,WAAW,EAAE,MAAM,yBAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC;YAChE,WAAW,EAAE,OAAO;YACpB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,WAAW,EAAE,mBAAmB,CAAC,QAAQ;SAC1C,CAAC,CAAC;QAEH,kDAAkD;QAClD,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;QAC9D,SAAS,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE3C,4CAA4C;QAC5C,MAAM,yBAAW,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,yBAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,yBAAW,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;YAC5H,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAmC;QAC7D,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAhDqB,4BAAkB,qBAgDvC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAQtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;IAXqB,0BAAgB,mBAWrC,CAAA;IAED,mKAAmK;IAC5J,KAAK,UAAU,gBAAgB,CAAC,IAKtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,OAAO;YACd,SAAS,CAAC,cAAc,EAAE,CAAC;QAC7B,yBAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IAVqB,0BAAgB,mBAUrC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,EAAE,IAAI,CAA0B,CAAC;QAEnG,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC,CAAC,2CAA2C;QAElG,qCAAqC;QACrC,MAAM,UAAU,GAAG,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;QACrG,IAAI,CAAC,yBAAW,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAC;YACtD,8BAAgB,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE,OAAO,EAAE,mFAAmF,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QAE7J,IAAI,IAAI,CAAC,QAAQ;YACf,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,UAAU,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAA0B,CAAC;IACzH,CAAC;IAjBqB,sBAAY,eAiBjC,CAAA;IAED,iDAAiD;IAC1C,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAkB,CAAC;QAElF,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,aAAa;YACpB,SAAS,CAAC,eAAe,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ;YACf,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAkB,CAAC;IACxG,CAAC;IAdqB,sBAAY,eAcjC,CAAA;IAED;;;;OAIG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAAwC;QAC7E,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QAChD,OAAO,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAClJ,CAAC;IAJqB,0BAAgB,mBAIrC,CAAA;AACH,CAAC,EAvIgB,SAAS,yBAAT,SAAS,QAuIzB;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,oBAAU;IAClD,IAAW,WAAW,KAA+B,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAE3E,KAAK,CAAC,kBAAkB,CAAC,IAA0C;QACxE,OAAO,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAgD;QAC5E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAA8C;QAC1E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACnE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAwC;QACpE,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,GAAW,EAAE,QAAgC;QAC9E,gBAAgB,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF;AA3BD,oDA2BC","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 * as fs from \"fs\";\r\nimport { join } from \"path\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\r\nimport { BriefcaseIdValue, CatalogError, type CatalogIModel, CloudSqliteError, IModelConnectionProps } from \"@itwin/core-common\";\r\nimport { IpcHandler } from \"./IpcHost\";\r\nimport { StandaloneDb } from \"./IModelDb\";\r\nimport { Guid, OpenMode } from \"@itwin/core-bentley\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\n\r\ninterface CatalogCloudCache extends CloudSqlite.CloudCache {\r\n  writeable: boolean;\r\n  catalogContainers: Map<string, CloudSqlite.CloudContainer>;\r\n}\r\n\r\nlet readonlyCloudCache: CatalogCloudCache | undefined;\r\nlet writeableCloudCache: CatalogCloudCache | undefined;\r\nconst catalogManifestName = \"CatalogManifest\";\r\n\r\n// we make a readonly CloudCache and a writeable CloudCache. That way the access token authorizations are distinct.\r\nfunction makeCloudCache(arg: CloudSqlite.CreateCloudCacheArg, writeable: boolean) {\r\n  const cache = CloudSqlite.CloudCaches.getCache(arg) as CatalogCloudCache;\r\n  // if the cache was just created, add the \"catalog\" members as hidden\r\n  if (undefined === cache.catalogContainers) {\r\n    CloudSqlite.addHiddenProperty(cache, \"catalogContainers\", new Map<string, CloudSqlite.CloudContainer>());\r\n    CloudSqlite.addHiddenProperty(cache, \"writeable\", writeable);\r\n  }\r\n  return cache;\r\n}\r\n\r\n// find an existing CloudContainer for accessing a CatalogIModel, or make a new one and connect it\r\nasync function getCatalogContainerObj(cache: CatalogCloudCache, containerId: string): Promise<CloudSqlite.CloudContainer> {\r\n  const cloudContainer = cache.catalogContainers.get(containerId);\r\n  if (undefined !== cloudContainer)\r\n    return cloudContainer;\r\n\r\n  const accessLevel = cache.writeable ? \"write\" : \"read\";\r\n  const tokenProps = await CloudSqlite.getBlobService().requestToken({ containerId, accessLevel, userToken: await IModelHost.getAccessToken() });\r\n  const container = CloudSqlite.createCloudContainer({\r\n    accessLevel,\r\n    baseUri: tokenProps.baseUri,\r\n    containerId,\r\n    storageType: tokenProps.provider,\r\n    writeable: cache.writeable,\r\n    accessToken: tokenProps.token\r\n  });\r\n  cache.catalogContainers.set(containerId, container); // save the container in the map of ContainerIds so we can reuse them\r\n  container.connect(cache);\r\n  return container;\r\n}\r\n\r\nfunction getReadonlyCloudCache() { return readonlyCloudCache ??= makeCloudCache({ cacheName: \"catalogs\", cacheSize: \"10G\" }, false) };\r\nfunction getWritableCloudCache() { return writeableCloudCache ??= makeCloudCache({ cacheName: \"writeableCatalogs\", cacheSize: \"10G\" }, true) };\r\nasync function getReadonlyContainer(containerId: string) { return getCatalogContainerObj(getReadonlyCloudCache(), containerId) };\r\nasync function getWriteableContainer(containerId: string) { return getCatalogContainerObj(getWritableCloudCache(), containerId) };\r\n\r\n/** Throw an error if the write lock is not held for the supplied container */\r\nfunction ensureLocked(container: CloudSqlite.CloudContainer, reason: string) {\r\n  if (!container.hasWriteLock)\r\n    CloudSqliteError.throwError(\"write-lock-not-held\", { message: `Write lock must be held to ${reason}` });\r\n}\r\n/** update the manifest in a CatalogIModel (calls `saveChanges`) */\r\nfunction updateManifest(nativeDb: IModelJsNative.DgnDb, manifest: CatalogIModel.Manifest) {\r\n  nativeDb.saveLocalValue(catalogManifestName, JSON.stringify(manifest));\r\n  nativeDb.saveChanges(\"update manifest\");\r\n}\r\nfunction catalogDbNameWithDefault(dbName?: string): string {\r\n  return dbName ?? \"catalog-db\";\r\n}\r\n\r\n/** A [[StandaloneDb]] that provides read-only access to the contents of a [CatalogIModel]($common).\r\n * @see [[CatalogDb.openReadonly]] to instantiate this type.\r\n * @beta\r\n */\r\nexport interface CatalogDb extends StandaloneDb {\r\n  /** Get the catalog's manifest. */\r\n  getManifest(): CatalogIModel.Manifest | undefined;\r\n  /** Get the catalog's version information. */\r\n  getVersion(): string;\r\n  /** Get the catalog's manifest and version. */\r\n  getInfo(): { manifest?: CatalogIModel.Manifest, version: string };\r\n  /** Returns true if the catalog was opened in read-write mode. */\r\n  isEditable(): this is EditableCatalogDb;\r\n}\r\n\r\n/** A writable [[CatalogDb]].\r\n * @see [[CatalogDb.openEditable]] to instantiate this type.\r\n * @beta\r\n */\r\nexport interface EditableCatalogDb extends CatalogDb {\r\n  /** Update the contents of the catalog manifest.  */\r\n  updateCatalogManifest(manifest: CatalogIModel.Manifest): void;\r\n}\r\n\r\n/** A StandaloneDb that holds a CatalogIModel */\r\nclass CatalogDbImpl extends StandaloneDb implements CatalogDb {\r\n  public isEditable(): this is EditableCatalogDb {\r\n    return false;\r\n  }\r\n\r\n  public getManifest(): CatalogIModel.Manifest | undefined {\r\n    const manifestString = this[_nativeDb].queryLocalValue(catalogManifestName);\r\n    if (undefined === manifestString)\r\n      return undefined;\r\n    return JSON.parse(manifestString) as CatalogIModel.Manifest;\r\n  }\r\n\r\n  public getVersion(): string {\r\n    return CloudSqlite.parseDbFileName(this[_nativeDb].getFilePath()).version;\r\n  }\r\n\r\n  public getInfo() {\r\n    return { manifest: this.getManifest(), version: this.getVersion() };\r\n  }\r\n}\r\n\r\n/**\r\n * A CatalogDb that permits editing.\r\n * This class ensures that CatalogIModels never have a Txn table when they are published.\r\n * It also automatically updates the `lastEditedBy` field in the CatalogManifest.\r\n */\r\nclass EditableCatalogDbImpl extends CatalogDbImpl implements EditableCatalogDb {\r\n  public override isEditable(): this is EditableCatalogDb {\r\n    return true;\r\n  }\r\n\r\n  public updateCatalogManifest(manifest: CatalogIModel.Manifest): void {\r\n    updateManifest(this[_nativeDb], manifest);\r\n  }\r\n\r\n  // Make sure the txn table is deleted and update the manifest every time we close.\r\n  public override beforeClose(): void {\r\n    try {\r\n      const manifest = this.getManifest();\r\n      const container = this.cloudContainer;\r\n      if (container && manifest) {\r\n        manifest.lastEditedBy = CloudSqlite.getWriteLockHeldBy(container);\r\n        this.updateCatalogManifest(manifest);\r\n      }\r\n\r\n      // when saved, CatalogIModels should never have any Txns. If we wanted to create a changeset, we'd have to do it here.\r\n      this[_nativeDb].deleteAllTxns();\r\n    } catch { } // ignore errors attempting to update\r\n\r\n    // might also want to vacuum here?\r\n    super.beforeClose();\r\n  }\r\n}\r\n\r\nfunction findCatalogByKey(key: string): CatalogDbImpl & EditableCatalogDb {\r\n  return CatalogDbImpl.findByKey(key) as CatalogDbImpl & EditableCatalogDb;\r\n}\r\n\r\n/** @beta */\r\nexport namespace CatalogDb {\r\n  /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].\r\n   * @returns The properties of the newly created container.\r\n   * @note creating new containers requires \"admin\" authorization.\r\n  */\r\n  export async function createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\r\n    const dbName = catalogDbNameWithDefault(args.dbName);\r\n    CloudSqlite.validateDbName(dbName);\r\n    CloudSqlite.validateDbVersion(args.version);\r\n\r\n    const tmpName = join(KnownLocations.tmpdir, `temp-${dbName}`);\r\n    try {\r\n      // make a copy of the file they supplied so we can modify its contents safely\r\n      fs.copyFileSync(args.localCatalogFile, tmpName);\r\n      const nativeDb = new IModelNative.platform.DgnDb();\r\n      nativeDb.openIModel(tmpName, OpenMode.ReadWrite);\r\n      nativeDb.setITwinId(Guid.empty); // catalogs must be a StandaloneDb\r\n      nativeDb.setIModelId(Guid.createValue()); // make sure its iModelId is unique\r\n      updateManifest(nativeDb, args.manifest); // store the manifest inside the Catalog\r\n      nativeDb.deleteAllTxns(); // Catalogs should never have Txns (and, this must be empty before resetting BriefcaseId)\r\n      nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned); // catalogs should always be unassigned\r\n      nativeDb.saveChanges(); // save change to briefcaseId\r\n      nativeDb.vacuum();\r\n      nativeDb.closeFile();\r\n    } catch (e: unknown) {\r\n      CatalogError.throwError(\"invalid-seed-catalog\", { message: \"Illegal seed catalog\", ...args, cause: e });\r\n    }\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    // create tne new container from the blob service, requires \"admin\" authorization\r\n    const cloudContainerProps = await CloudSqlite.getBlobService().create({ scope: { iTwinId: args.iTwinId }, metadata: { ...args.metadata, containerType: \"CatalogIModel\" }, userToken });\r\n\r\n    // now create a CloudSqlite container object to access it\r\n    const container = CloudSqlite.createCloudContainer({\r\n      accessToken: await CloudSqlite.requestToken(cloudContainerProps),\r\n      accessLevel: \"admin\",\r\n      writeable: true,\r\n      baseUri: cloudContainerProps.baseUri,\r\n      containerId: cloudContainerProps.containerId,\r\n      storageType: cloudContainerProps.provider,\r\n    });\r\n\r\n    // initialize the container for use by CloudSqlite\r\n    container.initializeContainer({ blockSize: 4 * 1024 * 1024 });\r\n    container.connect(getWritableCloudCache());\r\n\r\n    // upload the initial version of the Catalog\r\n    await CloudSqlite.withWriteLock({ user: \"initialize\", container }, async () => {\r\n      await CloudSqlite.uploadDb(container, { dbName: CloudSqlite.makeSemverName(dbName, args.version), localFileName: tmpName });\r\n      fs.unlinkSync(tmpName); // delete temporary copy of catalog\r\n    });\r\n    container.disconnect();\r\n    return cloudContainerProps;\r\n  }\r\n\r\n  /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.\r\n   * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].\r\n   * @note This requires \"write\" authorization to the container\r\n   */\r\n  export async function acquireWriteLock(args: {\r\n    /** The id of the container */\r\n    containerId: string,\r\n    /**\r\n     * The name of the individual acquiring the lock. This will be shown to others who attempt to acquire the lock while it is held.\r\n     * It is also stored in the \"lastEditedBy\" field of the manifest of any new version edited while the lock is held.\r\n     */\r\n    username: string;\r\n  }): Promise<void> {\r\n    const container = await getWriteableContainer(args.containerId);\r\n    return CloudSqlite.acquireWriteLock({ container, user: args.username });\r\n  }\r\n\r\n  /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */\r\n  export async function releaseWriteLock(args: {\r\n    /** The id of the container */\r\n    containerId: string,\r\n    /** If true, abandon all local changes before releasing the lock */\r\n    abandon?: true\r\n  }): Promise<void> {\r\n    const container = await getWriteableContainer(args.containerId);\r\n    if (args.abandon)\r\n      container.abandonChanges();\r\n    CloudSqlite.releaseWriteLock(container);\r\n  }\r\n\r\n  /** Open an [[EditableCatalogDb]] for write access.\r\n   * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.\r\n   * @note The write lock must be held for this operation to succeed\r\n   */\r\n  export async function openEditable(args: CatalogIModel.OpenArgs): Promise<EditableCatalogDb> {\r\n    const dbName = catalogDbNameWithDefault(args.dbName);\r\n    if (undefined === args.containerId) // local file?\r\n      return EditableCatalogDbImpl.openFile(dbName, OpenMode.ReadWrite, args) as EditableCatalogDbImpl;\r\n\r\n    const container = await getWriteableContainer(args.containerId);\r\n    ensureLocked(container, \"open a Catalog for editing\"); // editing Catalogs requires the write lock\r\n\r\n    // look up the full name with version\r\n    const dbFullName = CloudSqlite.querySemverMatch({ container, dbName, version: args.version ?? \"*\" });\r\n    if (!CloudSqlite.isSemverEditable(dbFullName, container))\r\n      CloudSqliteError.throwError(\"already-published\", { message: \"Catalog has already been published and is not editable. Make a new version first.\", ...args })\r\n\r\n    if (args.prefetch)\r\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\r\n\r\n    return EditableCatalogDbImpl.openFile(dbFullName, OpenMode.ReadWrite, { container, ...args }) as EditableCatalogDbImpl;\r\n  }\r\n\r\n  /** Open a [[CatalogDb]] for read-only access. */\r\n  export async function openReadonly(args: CatalogIModel.OpenArgs): Promise<CatalogDb> {\r\n    const dbName = catalogDbNameWithDefault(args.dbName);\r\n    if (undefined === args.containerId) // local file?\r\n      return CatalogDbImpl.openFile(dbName, OpenMode.Readonly, args) as CatalogDbImpl;\r\n\r\n    const container = await getReadonlyContainer(args.containerId);\r\n    if (args.syncWithCloud)\r\n      container.checkForChanges();\r\n\r\n    const dbFullName = CloudSqlite.querySemverMatch({ container, ...args, dbName });\r\n    if (args.prefetch)\r\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\r\n\r\n    return CatalogDbImpl.openFile(dbFullName, OpenMode.Readonly, { container, ...args }) as CatalogDbImpl;\r\n  }\r\n\r\n  /**\r\n   * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy\r\n   * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.\r\n   * @note The write lock must be held for this operation to succeed\r\n   */\r\n  export async function createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\r\n    const container = await getWriteableContainer(args.containerId);\r\n    ensureLocked(container, \"create a new version\");\r\n    return CloudSqlite.createNewDbVersion(container, { ...args, fromDb: { ...args.fromDb, dbName: catalogDbNameWithDefault(args.fromDb.dbName) } });\r\n  }\r\n}\r\n\r\n/**\r\n * Handler for Ipc access to CatalogIModels. Registered by NativeHost.\r\n * @internal\r\n */\r\nexport class CatalogIModelHandler extends IpcHandler implements CatalogIModel.IpcMethods {\r\n  public get channelName(): CatalogIModel.IpcChannel { return \"catalogIModel/ipc\"; }\r\n\r\n  public async createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\r\n    return CatalogDb.createNewContainer(args);\r\n  }\r\n  public async acquireWriteLock(args: { containerId: string, username: string; }): Promise<void> {\r\n    return CatalogDb.acquireWriteLock(args);\r\n  }\r\n  public async releaseWriteLock(args: { containerId: string, abandon?: true; }): Promise<void> {\r\n    return CatalogDb.releaseWriteLock(args);\r\n  }\r\n  public async openReadonly(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\r\n    return ((await CatalogDb.openReadonly(args)).getConnectionProps());\r\n  }\r\n  public async openEditable(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\r\n    return (await CatalogDb.openEditable(args)).getConnectionProps();\r\n  }\r\n  public async createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\r\n    return CatalogDb.createNewVersion(args);\r\n  }\r\n  public async getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }> {\r\n    return findCatalogByKey(key).getInfo();\r\n  }\r\n  public async updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void> {\r\n    findCatalogByKey(key).updateCatalogManifest(manifest);\r\n  }\r\n}\r\n"]}

package/lib/cjs/Category.d.ts

@@ -5,8 +5,9 @@ import { Id64String } from "@itwin/core-bentley";
 import { CategoryProps, Code, CodeScopeProps, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps } from "@itwin/core-common";
 import { DefinitionElement } from "./Element";
 import { IModelDb } from "./IModelDb";
+import { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from "./Entity";
 /** Defines the appearance for graphics in Geometric elements
- * @public
+ * @public @preview
  */
 export declare class SubCategory extends DefinitionElement {
     static get className(): string;
@@ -15,6 +16,24 @@ export declare class SubCategory extends DefinitionElement {
     /** Optional description of this SubCategory. */
     description?: string;
     protected constructor(props: SubCategoryProps, iModel: IModelDb);
+    /**
+     * SubCategory custom HandledProps include 'description' and 'properties'.
+     * @inheritdoc
+     * @beta
+     */
+    protected static readonly _customHandledProps: CustomHandledProperty[];
+    /**
+     * SubCategory deserializes 'description' and 'properties'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props: DeserializeEntityArgs): SubCategoryProps;
+    /**
+     * SubCategory serialize 'description' and 'properties'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow;
     toJSON(): SubCategoryProps;
     /** Get the SubCategory's name (its Code value). */
     getSubCategoryName(): string;
@@ -50,13 +69,31 @@ export declare class SubCategory extends DefinitionElement {
     static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
 /** A Category element is the target of the `category` member of [[GeometricElement]].
- * @public
+ * @public @preview
  */
 export declare class Category extends DefinitionElement {
     static get className(): string;
     rank: Rank;
     description?: string;
     protected constructor(props: CategoryProps, iModel: IModelDb);
+    /**
+     * Category custom HandledProps include 'rank' and 'description'.
+     * @inheritdoc
+     * @beta
+     */
+    protected static readonly _customHandledProps: CustomHandledProperty[];
+    /**
+     * Category deserializes 'rank' and 'description'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props: DeserializeEntityArgs): CategoryProps;
+    /**
+     * Category serialize 'rank' and 'description'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow;
     toJSON(): CategoryProps;
     /** Get the Id of the default SubCategory for this Category. */
     myDefaultSubCategoryId(): Id64String;
@@ -64,7 +101,7 @@ export declare class Category extends DefinitionElement {
     setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;
 }
 /** Categorizes 2d GeometricElements.
- * @public
+ * @public @preview
  */
 export declare class DrawingCategory extends Category {
     static get className(): string;
@@ -99,7 +136,7 @@ export declare class DrawingCategory extends Category {
     static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
 /** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
- * @public
+ * @public @preview
  */
 export declare class SpatialCategory extends Category {
     static get className(): string;

package/lib/cjs/Category.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Category.d.ts","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACQ,aAAa,EAAE,IAAI,EAAE,cAAc,EAAY,YAAY,EAAE,IAAI,EAAE,qBAAqB,EAAE,gBAAgB,EACxH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA0B;IACxE,qDAAqD;IAC9C,UAAU,EAAE,qBAAqB,CAAC;IACzC,gDAAgD;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ;IAM/C,MAAM,IAAI,gBAAgB;IAQ1C,mDAAmD;IAC5C,kBAAkB,IAAI,MAAM;IACnC,qCAAqC;IAC9B,gBAAgB,IAAI,UAAU;IACrC,wDAAwD;IACjD,aAAa,IAAI,UAAU;IAClC,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,OAAO,CAA+F;IAEzI;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKrG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,WAAW;IAelK;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAIlK;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,iBAAiB;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAAuB;IAC9D,IAAI,EAAE,IAAI,CAAa;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ;IAM5C,MAAM,IAAI,aAAa;IAQvC,+DAA+D;IACxD,sBAAsB,IAAI,UAAU;IAE3C,sEAAsE;IAC/D,oBAAoB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,IAAI;CAQ9F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAO1K;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAM1K"}
+{"version":3,"file":"Category.d.ts","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACQ,aAAa,EAAE,IAAI,EAAE,cAAc,EAAY,YAAY,EAAE,IAAI,EAAE,qBAAqB,EAAE,gBAAgB,EACxH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAElF;;GAEG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA0B;IACxE,qDAAqD;IAC9C,UAAU,EAAE,qBAAqB,CAAC;IACzC,gDAAgD;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ;IAM/D;;;;OAIG;IACH,0BAAmC,mBAAmB,EAAE,qBAAqB,EAAE,CAG7E;IAEF;;;;OAIG;WACoB,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,gBAAgB;IAWlF;;;;OAIG;WACoB,SAAS,CAAC,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,GAAG,QAAQ;IAWrE,MAAM,IAAI,gBAAgB;IAQ1C,mDAAmD;IAC5C,kBAAkB,IAAI,MAAM;IACnC,qCAAqC;IAC9B,gBAAgB,IAAI,UAAU;IACrC,wDAAwD;IACjD,aAAa,IAAI,UAAU;IAClC,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,OAAO,CAA+F;IAEzI;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKrG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,WAAW;IAelK;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAIlK;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,iBAAiB;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAAuB;IAC9D,IAAI,EAAE,IAAI,CAAa;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ;IAM5D;;;;OAIG;IACH,0BAAmC,mBAAmB,EAAE,qBAAqB,EAAE,CAG7E;IAEF;;;;OAIG;WACoB,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,aAAa;IAO/E;;;;OAIG;WACoB,SAAS,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,GAAG,QAAQ;IAQlE,MAAM,IAAI,aAAa;IAQvC,+DAA+D;IACxD,sBAAsB,IAAI,UAAU;IAE3C,sEAAsE;IAC/D,oBAAoB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,IAAI;CAQ9F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAO1K;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAM1K"}

package/lib/cjs/Category.js

@@ -14,7 +14,7 @@ const Element_1 = require("./Element");
 const IModelDb_1 = require("./IModelDb");
 const NavigationRelationship_1 = require("./NavigationRelationship");
 /** Defines the appearance for graphics in Geometric elements
- * @public
+ * @public @preview
  */
 class SubCategory extends Element_1.DefinitionElement {
     static get className() { return "SubCategory"; }
@@ -27,6 +27,46 @@ class SubCategory extends Element_1.DefinitionElement {
         this.appearance = new core_common_1.SubCategoryAppearance(props.appearance);
         this.description = core_bentley_1.JsonUtils.asString(props.description);
     }
+    /**
+     * SubCategory custom HandledProps include 'description' and 'properties'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "description", source: "Class" },
+        { propertyName: "properties", source: "Class" },
+    ];
+    /**
+     * SubCategory deserializes 'description' and 'properties'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        elProps.description = core_bentley_1.JsonUtils.asString(props.row.description);
+        if (props.row.properties !== '') {
+            elProps.appearance = JSON.parse(props.row.properties);
+        }
+        else {
+            elProps.appearance = undefined;
+        }
+        return elProps;
+    }
+    /**
+     * SubCategory serialize 'description' and 'properties'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        if (props.description !== undefined) {
+            inst.description = props.description;
+        }
+        if (props.appearance !== undefined) {
+            inst.properties = JSON.stringify(props.appearance);
+        }
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         val.appearance = this.appearance.toJSON();
@@ -87,7 +127,7 @@ class SubCategory extends Element_1.DefinitionElement {
 }
 exports.SubCategory = SubCategory;
 /** A Category element is the target of the `category` member of [[GeometricElement]].
- * @public
+ * @public @preview
  */
 class Category extends Element_1.DefinitionElement {
     static get className() { return "Category"; }
@@ -98,6 +138,39 @@ class Category extends Element_1.DefinitionElement {
         this.rank = core_bentley_1.JsonUtils.asInt(props.rank);
         this.description = core_bentley_1.JsonUtils.asString(props.description);
     }
+    /**
+     * Category custom HandledProps include 'rank' and 'description'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "rank", source: "Class" },
+        { propertyName: "description", source: "Class" },
+    ];
+    /**
+     * Category deserializes 'rank' and 'description'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        elProps.description = core_bentley_1.JsonUtils.asString(props.row.description);
+        elProps.rank = core_bentley_1.JsonUtils.asInt(props.row.rank);
+        return elProps;
+    }
+    /**
+     * Category serialize 'rank' and 'description'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        if (undefined !== props.description) {
+            inst.description = props.description;
+        }
+        inst.rank = props.rank;
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         val.rank = this.rank;
@@ -118,7 +191,7 @@ class Category extends Element_1.DefinitionElement {
 }
 exports.Category = Category;
 /** Categorizes 2d GeometricElements.
- * @public
+ * @public @preview
  */
 class DrawingCategory extends Category {
     static get className() { return "DrawingCategory"; }
@@ -174,7 +247,7 @@ class DrawingCategory extends Category {
 }
 exports.DrawingCategory = DrawingCategory;
 /** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
- * @public
+ * @public @preview
  */
 class SpatialCategory extends Category {
     static get className() { return "SpatialCategory"; }

package/lib/cjs/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAC9C,yCAAsC;AACtC,qEAAqE;AAErE;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,mCAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,kDAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AA3ED,kCA2EC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,2BAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,kBAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,mCAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AA/BD,4BA+BC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,0CAyDC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAvDD,0CAuDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAC9C,yCAAsC;AACtC,qEAAqE;AAGrE;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,mCAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,kDAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AApHH,kCAqHC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,2BAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,kBAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,mCAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAjEH,4BAkEC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,0CAyDC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAvDD,0CAuDC","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 { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\r\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\r\n\r\n/** Defines the appearance for graphics in Geometric elements\r\n * @public @preview\r\n */\r\nexport class SubCategory extends DefinitionElement {\r\n  public static override get className(): string { return \"SubCategory\"; }\r\n  /** The Appearance parameters for this SubCategory */\r\n  public appearance: SubCategoryAppearance;\r\n  /** Optional description of this SubCategory. */\r\n  public description?: string;\r\n\r\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.appearance = new SubCategoryAppearance(props.appearance);\r\n    this.description = JsonUtils.asString(props.description);\r\n  }\r\n\r\n  /**\r\n   * SubCategory custom HandledProps include 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"description\", source: \"Class\" },\r\n    { propertyName: \"properties\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * SubCategory deserializes 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\r\n    const elProps = super.deserialize(props) as SubCategoryProps;\r\n    elProps.description = JsonUtils.asString(props.row.description);\r\n    if (props.row.properties !== '') {\r\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\r\n    } else {\r\n      elProps.appearance = undefined;\r\n    }\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * SubCategory serialize 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    if (props.description !== undefined) {\r\n      inst.description = props.description;\r\n    }\r\n    if (props.appearance !== undefined) {\r\n      inst.properties = JSON.stringify(props.appearance);\r\n    }\r\n    return inst;\r\n  }\r\n\r\n  public override toJSON(): SubCategoryProps {\r\n    const val = super.toJSON() as SubCategoryProps;\r\n    val.appearance = this.appearance.toJSON();\r\n    if (this.description && this.description.length > 0)\r\n      val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Get the SubCategory's name (its Code value). */\r\n  public getSubCategoryName(): string { return this.code.value; }\r\n  /** Get the Id of the SubCategory. */\r\n  public getSubCategoryId(): Id64String { return this.id; }\r\n  /** Get the Id of this SubCategory's parent Category. */\r\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\r\n  /** Check if this is the default SubCategory of its parent Category. */\r\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\r\n\r\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\r\n   * @param iModel  The IModel\r\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\r\n   * @param codeValue The name of the SubCategory\r\n   */\r\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\r\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new SubCategory\r\n   * @param iModelDb The iModel\r\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\r\n   * @param name The name of the SubCategory\r\n   * @param appearance The appearance settings to use for this SubCategory\r\n   * @returns The newly constructed SubCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\r\n    if (appearance instanceof SubCategoryAppearance)\r\n      appearance = appearance.toJSON();\r\n\r\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\r\n    const subCategoryProps: SubCategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: parentCategory.model,\r\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\r\n      code: this.createCode(iModelDb, parentCategoryId, name),\r\n      appearance,\r\n    };\r\n    return new SubCategory(subCategoryProps, iModelDb);\r\n  }\r\n\r\n  /** Insert a new SubCategory\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\r\n   * @param name The name of the SubCategory\r\n   * @param appearance The appearance settings to use for this SubCategory\r\n   * @returns The Id of the newly inserted SubCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\r\n    return iModelDb.elements.insertElement(subCategory.toJSON());\r\n  }\r\n}\r\n\r\n/** A Category element is the target of the `category` member of [[GeometricElement]].\r\n * @public @preview\r\n */\r\nexport class Category extends DefinitionElement {\r\n  public static override get className(): string { return \"Category\"; }\r\n  public rank: Rank = Rank.User;\r\n  public description?: string;\r\n\r\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.rank = JsonUtils.asInt(props.rank);\r\n    this.description = JsonUtils.asString(props.description);\r\n  }\r\n\r\n  /**\r\n   * Category custom HandledProps include 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"rank\", source: \"Class\" },\r\n    { propertyName: \"description\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * Category deserializes 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\r\n    const elProps = super.deserialize(props) as CategoryProps;\r\n    elProps.description = JsonUtils.asString(props.row.description);\r\n    elProps.rank = JsonUtils.asInt(props.row.rank);\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * Category serialize 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    if (undefined !== props.description) {\r\n      inst.description = props.description;\r\n    }\r\n    inst.rank = props.rank;\r\n    return inst;\r\n  }\r\n  public override toJSON(): CategoryProps {\r\n    const val = super.toJSON() as CategoryProps;\r\n    val.rank = this.rank;\r\n    if (this.description && this.description.length > 0)\r\n      val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Get the Id of the default SubCategory for this Category. */\r\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\r\n\r\n  /** Set the appearance of the default SubCategory for this Category */\r\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\r\n    if (props instanceof SubCategoryAppearance)\r\n      props = props.toJSON();\r\n\r\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\r\n    subCat.appearance = new SubCategoryAppearance(props);\r\n    this.iModel.elements.updateElement(subCat.toJSON());\r\n  }\r\n}\r\n\r\n/** Categorizes 2d GeometricElements.\r\n * @public @preview\r\n */\r\nexport class DrawingCategory extends Category {\r\n  public static override get className(): string { return \"DrawingCategory\"; }\r\n\r\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\r\n\r\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\r\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\r\n\r\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\r\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\r\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\r\n    return iModel.elements.queryElementIdByCode(code);\r\n  }\r\n\r\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\r\n   * @param codeValue The name of the category\r\n   * @return A drawing category Code\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new DrawingCategory\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name of the DrawingCategory\r\n   * @returns The newly constructed DrawingCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\r\n    const categoryProps: CategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      isPrivate: false,\r\n    };\r\n    return new DrawingCategory(categoryProps, iModelDb);\r\n  }\r\n\r\n  /** Insert a new DrawingCategory\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\r\n   * @param name The name of the DrawingCategory\r\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\r\n   * @returns The Id of the newly inserted DrawingCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const category = this.create(iModelDb, definitionModelId, name);\r\n    const elements = iModelDb.elements;\r\n    category.id = elements.insertElement(category.toJSON());\r\n    category.setDefaultAppearance(defaultAppearance);\r\n    return category.id;\r\n  }\r\n}\r\n\r\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\r\n * @public @preview\r\n */\r\nexport class SpatialCategory extends Category {\r\n  public static override get className(): string { return \"SpatialCategory\"; }\r\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\r\n\r\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\r\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\r\n\r\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\r\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\r\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\r\n    return iModel.elements.queryElementIdByCode(code);\r\n  }\r\n\r\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\r\n   * @param codeValue The name of the category\r\n   * @return A spatial category Code\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new SpatialCategory\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the SpatialCategory\r\n   * @returns The newly constructed SpatialCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\r\n    const categoryProps: CategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      isPrivate: false,\r\n    };\r\n    return new SpatialCategory(categoryProps, iModelDb);\r\n  }\r\n\r\n  /** Insert a new SpatialCategory\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\r\n   * @param name The name of the SpatialCategory\r\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\r\n   * @returns The Id of the newly inserted SpatialCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const category = this.create(iModelDb, definitionModelId, name);\r\n    category.id = iModelDb.elements.insertElement(category.toJSON());\r\n    category.setDefaultAppearance(defaultAppearance);\r\n    return category.id;\r\n  }\r\n}\r\n"]}

package/lib/cjs/ChangeSummaryManager.js

@@ -240,8 +240,8 @@ class ChangeSummaryManager {
             throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Change Cache file must be attached to iModel.");
         // query instance changes
         // eslint-disable-next-line @typescript-eslint/no-deprecated
-        const instanceChange = iModel.withPreparedStatement(`SELECT ic.Summary.Id summaryId, s.Name changedInstanceSchemaName, c.Name changedInstanceClassName, ic.ChangedInstance.Id changedInstanceId,
-       ic.OpCode, ic.IsIndirect FROM ecchange.change.InstanceChange ic JOIN main.meta.ECClassDef c ON c.ECInstanceId = ic.ChangedInstance.ClassId
+        const instanceChange = iModel.withPreparedStatement(`SELECT ic.Summary.Id summaryId, s.Name changedInstanceSchemaName, c.Name changedInstanceClassName, ic.ChangedInstance.Id changedInstanceId,
+       ic.OpCode, ic.IsIndirect FROM ecchange.change.InstanceChange ic JOIN main.meta.ECClassDef c ON c.ECInstanceId = ic.ChangedInstance.ClassId
        JOIN main.meta.ECSchemaDef s ON c.Schema.Id = s.ECInstanceId WHERE ic.ECInstanceId =? `, 
         // eslint-disable-next-line @typescript-eslint/no-deprecated
         (stmt) => {