@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAEhE;;GAEG;AACH,MAAM,OAAO,MAAM;IACjB;;;;OAIG;IACI,MAAM,KAAK,UAAU,KAAa,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAElH;;OAEG;IACI,MAAM,KAAK,SAAS;QACzB,mGAAmG;QACnG,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,0FAA0F;IACzJ,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,uBAAuB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtE;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,aAAqB;QAChD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,IAAI,cAAc;YAChB,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,gBAA0B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/G;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IACH,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE3D,gBAAgB;IACT,GAAG,CAAC,UAAkB;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,UAAkB,EAAE,MAAqB;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACxD,CAAC;IAEH;;;OAGG;IACI,cAAc,CAAC,MAAqB;QACzC,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YACf,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IACV,MAAM,CAAU,cAAc,GAAG,IAAI,SAAS,EAAE,CAAC;IACzD,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,MAAqB;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,SAAS,KAAK,MAAM;YACtB,aAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,UAAkB,IAA+B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC","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 Schema\n */\n\nimport { IModelStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport { ECVersion, SchemaKey } from \"@itwin/ecschema-metadata\";\n\n/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).\n * @public\n */\nexport class Schema {\n  /** The name of the BIS schema handled by this Schema.\n   * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.\n   * Failure to do so will ordinarily result in an error when the schema is registered, since there may only\n   * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)\n   */\n  public static get schemaName(): string { throw new Error(`you must override static schemaName in ${this.name}`); }\n\n  /** Unique identifier for this schema, typed variant of [[schemaName]].\n   * @internal\n   */\n  public static get schemaKey(): SchemaKey {\n    // We cannot cache this here because the schemaName may be overridden without this being overridden\n    return new SchemaKey(this.schemaName, ECVersion.NO_VERSION); // backend cares little for versions right now, as only one version can exist in an imodel\n  }\n\n  /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.\n   * Classes generated for this Schema will disallow protected operations.\n   * @internal\n   */\n  public static get missingRequiredBehavior(): boolean { return false; }\n\n  /** Get a semver-compatible string from a padded version string.\n   * works on unpadded version strings as well\n   * if there is no write version, it will be added\n   * @example Schema.toSemverString(\"1.02.03\") === \"1.2.3\"\n   * @example Schema.toSemverString(\"1.01\") === \"1.0.1\" // write version was added\n   * @beta\n   */\n  public static toSemverString(paddedVersion: string): string {\n    const tuple = paddedVersion.split(\".\").map(Number);\n    const noWriteVersion = tuple.length === 2;\n    if (noWriteVersion)\n      tuple.splice(1, 0, 0); // insert 0 before the second element\n    return tuple.join(\".\");\n  }\n\n  /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an\n   * error if it is ever called.\n   * @internal\n   */\n  protected constructor() { throw new Error(`cannot create an instance of a Schema ${this.constructor.name}`); }\n}\n\n/**\n * Holds a map of registered schemas.\n * @public\n */\nexport class SchemaMap {\n  private readonly _schemas = new Map<string, typeof Schema>();\n\n    /** @internal */\n    public get(schemaName: string): typeof Schema | undefined {\n      return this._schemas.get(schemaName.toLowerCase());\n    }\n\n    /** @internal */\n    public set(schemaName: string, schema: typeof Schema): void {\n      this._schemas.set(schemaName.toLowerCase(), schema);\n    }\n\n    /** @internal */\n    public delete(schemaName: string): boolean {\n      return this._schemas.delete(schemaName.toLowerCase());\n    }\n\n  /** Register a schema prior to using it.\n   * @throws [[IModelError]] if a schema of the same name is already registered.\n   * @public\n   */\n  public registerSchema(schema: typeof Schema) {\n    const key = schema.schemaName.toLowerCase();\n    if (this.get(key))\n      throw new IModelError(IModelStatus.DuplicateName, `Schema \"${schema.schemaName}\" is already registered`);\n    this.set(key, schema);\n  }\n}\n\n/** Manages registered schemas\n * @public\n */\nexport class Schemas {\n  private static readonly _globalSchemas = new SchemaMap();\n  private constructor() { } // this is a singleton\n\n  /** Register a schema prior to using it.\n   * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.\n   * @throws [[IModelError]] if a schema of the same name is already registered.\n   */\n  public static registerSchema(schema: typeof Schema) {\n    this._globalSchemas.registerSchema(schema);\n  }\n\n  /** Unregister a schema, by name, if one is already registered.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\n   * @param schemaName Name of the schema to unregister\n   * @return true if the schema was unregistered\n   */\n  public static unregisterSchema(schemaName: string): boolean {\n    const schema = this.getRegisteredSchema(schemaName);\n    if (undefined !== schema)\n      ClassRegistry.unregisterClassesFrom(schema);\n\n    return this._globalSchemas.delete(schemaName.toLowerCase());\n  }\n\n  /** Look up a previously registered schema\n   * @param schemaName The name of the schema\n   * @returns the previously registered schema or undefined if not registered.\n   */\n  public static getRegisteredSchema(schemaName: string): typeof Schema | undefined { return this._globalSchemas.get(schemaName.toLowerCase()); }\n}\n"]}

package/lib/esm/SchemaSync.d.ts

@@ -0,0 +1,47 @@
+/** @packageDocumentation
+ * @module SQLiteDb
+ */
+import { CloudSqlite } from "./CloudSqlite";
+import { VersionedSqliteDb } from "./SQLiteDb";
+import { IModelDb } from "./IModelDb";
+import { OpenMode } from "@itwin/core-bentley";
+import { LocalFileName } from "@itwin/core-common";
+/** @internal */
+export declare namespace SchemaSync {
+    /** A CloudSqlite database for synchronizing schema changes across briefcases.  */
+    class SchemaSyncDb extends VersionedSqliteDb {
+        readonly myVersion = "4.0.0";
+        protected createDDL(): void;
+    }
+    const setTestCache: (iModel: IModelDb, cacheName?: string) => void;
+    const withLockedAccess: (iModel: IModelDb | {
+        readonly fileName: LocalFileName;
+    }, args: {
+        operationName: string;
+        openMode?: OpenMode;
+        user?: string;
+    }, operation: (access: CloudAccess) => Promise<void>) => Promise<void>;
+    const withReadonlyAccess: (iModel: IModelDb | {
+        readonly fileName: LocalFileName;
+    }, operation: (access: CloudAccess) => Promise<void>) => Promise<void>;
+    const isEnabled: (iModel: IModelDb) => boolean;
+    /** Synchronize local briefcase schemas with cloud container */
+    const pull: (iModel: IModelDb) => Promise<void>;
+    const initializeForIModel: (arg: {
+        iModel: IModelDb;
+        containerProps: CloudSqlite.ContainerProps;
+        overrideContainer?: boolean;
+    }) => Promise<void>;
+    /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */
+    class CloudAccess extends CloudSqlite.DbAccess<SchemaSyncDb> {
+        constructor(props: CloudSqlite.ContainerAccessProps);
+        getUri(): string;
+        /**
+       * Initialize a cloud container for use as a SchemaSync. The container must first be created via its storage supplier api (e.g. Azure, or AWS).
+       * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty ChannelDb into the container.
+       * @note this deletes any existing content in the container.
+       */
+        static initializeDb(props: CloudSqlite.ContainerProps): Promise<void>;
+    }
+}
+//# sourceMappingURL=SchemaSync.d.ts.map

package/lib/esm/SchemaSync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaSync.d.ts","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAe,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAY,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAe,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKhE,gBAAgB;AAChB,yBAAiB,UAAU,CAAC;IAG1B,kFAAkF;IAClF,MAAa,YAAa,SAAQ,iBAAiB;QACjD,SAAyB,SAAS,WAAW;kBAC1B,SAAS;KAC7B;IAMM,MAAM,YAAY,WAAY,QAAQ,cAAc,MAAM,SAKhE,CAAC;IA+BK,MAAM,gBAAgB,WAAkB,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,QAAQ;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,aAAa,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,KAAG,OAAO,CAAC,IAAI,CAOpO,CAAC;IAEK,MAAM,kBAAkB,WAAkB,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,aAAa,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,KAAG,OAAO,CAAC,IAAI,CASjK,CAAC;IAEK,MAAM,SAAS,WAAY,QAAQ,YAEzC,CAAC;IAEF,+DAA+D;IACxD,MAAM,IAAI,WAAkB,QAAQ,kBAS1C,CAAC;IAEK,MAAM,mBAAmB,QAAe;QAAE,MAAM,EAAE,QAAQ,CAAC;QAAC,cAAc,EAAE,WAAW,CAAC,cAAc,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE,kBA6B3I,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;oBAC9C,KAAK,EAAE,WAAW,CAAC,oBAAoB;QAInD,MAAM;QAGb;;;;SAIC;eACmB,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc;KAGnE;CACF"}

package/lib/esm/SchemaSync.js

@@ -0,0 +1,148 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module SQLiteDb
+ */
+import { CloudSqlite } from "./CloudSqlite";
+import { VersionedSqliteDb } from "./SQLiteDb";
+import { BriefcaseDb, IModelDb } from "./IModelDb";
+import { DbResult, OpenMode } from "@itwin/core-bentley";
+import { IModelError } from "@itwin/core-common";
+import { IModelNative } from "./internal/NativePlatform";
+import { _nativeDb } from "./internal/Symbols";
+/** @internal */
+export var SchemaSync;
+(function (SchemaSync) {
+    const lockParams = { retryDelayMs: 1000, nRetries: 30 };
+    /** A CloudSqlite database for synchronizing schema changes across briefcases.  */
+    class SchemaSyncDb extends VersionedSqliteDb {
+        myVersion = "4.0.0";
+        createDDL() { }
+    }
+    SchemaSync.SchemaSyncDb = SchemaSyncDb;
+    const syncProperty = { namespace: "itwinjs", name: "SchemaSync" };
+    const defaultDbName = "SchemaSyncDb";
+    const testSyncCachePropKey = "test.schema_sync.cache_name";
+    // for tests only
+    SchemaSync.setTestCache = (iModel, cacheName) => {
+        if (cacheName)
+            iModel[_nativeDb].saveLocalValue(testSyncCachePropKey, cacheName);
+        else
+            iModel[_nativeDb].deleteLocalValue(testSyncCachePropKey);
+    };
+    const getCloudAccess = async (arg) => {
+        let nativeDb;
+        const argIsIModelDb = arg instanceof IModelDb;
+        if (argIsIModelDb) {
+            nativeDb = arg[_nativeDb];
+        }
+        else {
+            nativeDb = new IModelNative.platform.DgnDb();
+            nativeDb.openIModel(arg.fileName, OpenMode.Readonly);
+        }
+        const propsString = nativeDb.queryFileProperty(syncProperty, true);
+        if (!propsString)
+            throw new Error("iModel does not have a SchemaSyncDb");
+        try {
+            const props = JSON.parse(propsString);
+            const accessToken = await CloudSqlite.requestToken(props);
+            const access = new CloudAccess({ ...props, accessToken });
+            Object.assign(access.lockParams, lockParams);
+            const testSyncCache = nativeDb.queryLocalValue(testSyncCachePropKey);
+            if (testSyncCache)
+                access.setCache(CloudSqlite.CloudCaches.getCache({ cacheName: testSyncCache }));
+            return access;
+        }
+        finally {
+            if (!argIsIModelDb) {
+                nativeDb.closeFile();
+            }
+        }
+    };
+    SchemaSync.withLockedAccess = async (iModel, args, operation) => {
+        const access = await getCloudAccess(iModel);
+        try {
+            await access.withLockedDb(args, async () => operation(access));
+        }
+        finally {
+            access.close();
+        }
+    };
+    SchemaSync.withReadonlyAccess = async (iModel, operation) => {
+        const access = await getCloudAccess(iModel);
+        access.synchronizeWithCloud();
+        access.openForRead();
+        try {
+            await operation(access);
+        }
+        finally {
+            access.close();
+        }
+    };
+    SchemaSync.isEnabled = (iModel) => {
+        return iModel[_nativeDb].schemaSyncEnabled();
+    };
+    /** Synchronize local briefcase schemas with cloud container */
+    SchemaSync.pull = async (iModel) => {
+        if (iModel[_nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {
+            await SchemaSync.withReadonlyAccess(iModel, async (syncAccess) => {
+                const schemaSyncDbUri = syncAccess.getUri();
+                iModel.clearCaches();
+                iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);
+                iModel.saveChanges("schema synchronized with cloud container");
+            });
+        }
+    };
+    SchemaSync.initializeForIModel = async (arg) => {
+        const props = { baseUri: arg.containerProps.baseUri, containerId: arg.containerProps.containerId, storageType: arg.containerProps.storageType }; // sanitize to only known properties
+        const iModel = arg.iModel;
+        const briefcase = iModel instanceof BriefcaseDb ? iModel : undefined;
+        await iModel.acquireSchemaLock();
+        if (briefcase) {
+            if (briefcase.txns.hasLocalChanges) {
+                throw new IModelError(DbResult.BE_SQLITE_ERROR, "Enabling SchemaSync for iModel failed. There are unsaved or un-pushed local changes.");
+            }
+            await briefcase.pullChanges();
+        }
+        try {
+            iModel.saveFileProperty(syncProperty, JSON.stringify(props));
+            await SchemaSync.withLockedAccess(arg.iModel, { operationName: "initialize schemaSync", openMode: OpenMode.Readonly }, async (syncAccess) => {
+                iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);
+                iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);
+            });
+        }
+        catch (err) {
+            throw err;
+        }
+        finally {
+            iModel.abandonChanges();
+        }
+        if (briefcase) {
+            if (arg.overrideContainer)
+                await briefcase.pushChanges({ description: `Overriding SchemaSync for iModel with container-id: ${props.containerId}` });
+            else
+                await briefcase.pushChanges({ description: `Enable SchemaSync for iModel with container-id: ${props.containerId}` });
+        }
+    };
+    /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */
+    class CloudAccess extends CloudSqlite.DbAccess {
+        constructor(props) {
+            super({ dbType: SchemaSyncDb, props, dbName: defaultDbName });
+        }
+        getUri() {
+            return `${this.getCloudDb()[_nativeDb].getFilePath()}?vfs=${this.container.cache?.name}&writable=${this.container.isWriteable ? 1 : 0}`;
+        }
+        /**
+       * Initialize a cloud container for use as a SchemaSync. The container must first be created via its storage supplier api (e.g. Azure, or AWS).
+       * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty ChannelDb into the container.
+       * @note this deletes any existing content in the container.
+       */
+        static async initializeDb(props) {
+            return super._initializeDb({ props, dbType: SchemaSyncDb, dbName: defaultDbName });
+        }
+    }
+    SchemaSync.CloudAccess = CloudAccess;
+})(SchemaSync || (SchemaSync = {}));
+//# sourceMappingURL=SchemaSync.js.map

package/lib/esm/SchemaSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAiB,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,gBAAgB;AAChB,MAAM,KAAW,UAAU,CAsI1B;AAtID,WAAiB,UAAU;IACzB,MAAM,UAAU,GAAiC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEtF,kFAAkF;IAClF,MAAa,YAAa,SAAQ,iBAAiB;QACxB,SAAS,GAAG,OAAO,CAAC;QAC1B,SAAS,KAAK,CAAC;KACnC;IAHY,uBAAY,eAGxB,CAAA;IAED,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAClE,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,MAAM,oBAAoB,GAAG,6BAA6B,CAAC;IAC3D,iBAAiB;IACJ,uBAAY,GAAG,CAAC,MAAgB,EAAE,SAAkB,EAAE,EAAE;QACnE,IAAI,SAAS;YACX,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,KAAK,EAAE,GAAoD,EAAE,EAAE;QACpF,IAAI,QAA0C,CAAC;QAC/C,MAAM,aAAa,GAAG,GAAG,YAAY,QAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAuB,CAAC;QACzF,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAA+B,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;YACrE,IAAI,aAAa;gBACf,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAClF,OAAO,MAAM,CAAC;QAChB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEW,2BAAgB,GAAG,KAAK,EAAE,MAAuD,EAAE,IAAmE,EAAE,SAAiD,EAAiB,EAAE;QACvO,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,6BAAkB,GAAG,KAAK,EAAE,MAAuD,EAAE,SAAiD,EAAiB,EAAE;QACpK,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAC9B,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,oBAAS,GAAG,CAAC,MAAgB,EAAE,EAAE;QAC5C,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAChE,MAAM,UAAU,CAAC,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC5C,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAClD,MAAM,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEW,8BAAmB,GAAG,KAAK,EAAE,GAAkG,EAAE,EAAE;QAC9I,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,oCAAoC;QACrL,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,MAAM,YAAY,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACjC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBACnC,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,sFAAsF,CAAC,CAAC;YAC1I,CAAC;YACD,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,MAAM,WAAA,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,uBAAuB,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;gBACzG,MAAM,CAAC,WAAW,CAAC,qCAAqC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,GAAG,CAAC,iBAAiB;gBACvB,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,uDAAuD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;;gBAEzH,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,mDAAmD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACzH,CAAC;IACH,CAAC,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAsB;QACjE,YAAmB,KAAuC;YACxD,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAChE,CAAC;QAEM,MAAM;YACX,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,aAAa,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1I,CAAC;QACD;;;;SAIC;QACM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAiC;YAChE,OAAO,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,CAAC;KACF;IAhBY,sBAAW,cAgBvB,CAAA;AACH,CAAC,EAtIgB,UAAU,KAAV,UAAU,QAsI1B","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\n/** @packageDocumentation\n * @module SQLiteDb\n */\n\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\nimport { BriefcaseDb, IModelDb } from \"./IModelDb\";\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\nimport { IModelError, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** @internal */\nexport namespace SchemaSync {\n  const lockParams: CloudSqlite.ObtainLockParams = { retryDelayMs: 1000, nRetries: 30 };\n\n  /** A CloudSqlite database for synchronizing schema changes across briefcases.  */\n  export class SchemaSyncDb extends VersionedSqliteDb {\n    public override readonly myVersion = \"4.0.0\";\n    protected override createDDL() { }\n  }\n\n  const syncProperty = { namespace: \"itwinjs\", name: \"SchemaSync\" };\n  const defaultDbName = \"SchemaSyncDb\";\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\";\n  // for tests only\n  export const setTestCache = (iModel: IModelDb, cacheName?: string) => {\n    if (cacheName)\n      iModel[_nativeDb].saveLocalValue(testSyncCachePropKey, cacheName);\n    else\n      iModel[_nativeDb].deleteLocalValue(testSyncCachePropKey);\n  };\n\n  const getCloudAccess = async (arg: IModelDb | { readonly fileName: LocalFileName }) => {\n    let nativeDb: IModelJsNative.DgnDb | undefined;\n    const argIsIModelDb = arg instanceof IModelDb;\n    if (argIsIModelDb) {\n      nativeDb = arg[_nativeDb];\n    } else {\n      nativeDb = new IModelNative.platform.DgnDb();\n      nativeDb.openIModel(arg.fileName, OpenMode.Readonly);\n    }\n\n    const propsString = nativeDb.queryFileProperty(syncProperty, true) as string | undefined;\n    if (!propsString)\n      throw new Error(\"iModel does not have a SchemaSyncDb\");\n    try {\n      const props = JSON.parse(propsString) as CloudSqlite.ContainerProps;\n      const accessToken = await CloudSqlite.requestToken(props);\n      const access = new CloudAccess({ ...props, accessToken });\n      Object.assign(access.lockParams, lockParams);\n      const testSyncCache = nativeDb.queryLocalValue(testSyncCachePropKey);\n      if (testSyncCache)\n        access.setCache(CloudSqlite.CloudCaches.getCache({ cacheName: testSyncCache }));\n      return access;\n    } finally {\n      if (!argIsIModelDb) {\n        nativeDb.closeFile();\n      }\n    }\n  };\n\n  export const withLockedAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, args: { operationName: string, openMode?: OpenMode, user?: string }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\n    const access = await getCloudAccess(iModel);\n    try {\n      await access.withLockedDb(args, async () => operation(access));\n    } finally {\n      access.close();\n    }\n  };\n\n  export const withReadonlyAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\n    const access = await getCloudAccess(iModel);\n    access.synchronizeWithCloud();\n    access.openForRead();\n    try {\n      await operation(access);\n    } finally {\n      access.close();\n    }\n  };\n\n  export const isEnabled = (iModel: IModelDb) => {\n    return iModel[_nativeDb].schemaSyncEnabled();\n  };\n\n  /** Synchronize local briefcase schemas with cloud container */\n  export const pull = async (iModel: IModelDb) => {\n    if (iModel[_nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {\n      await SchemaSync.withReadonlyAccess(iModel, async (syncAccess) => {\n        const schemaSyncDbUri = syncAccess.getUri();\n        iModel.clearCaches();\n        iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);\n        iModel.saveChanges(\"schema synchronized with cloud container\");\n      });\n    }\n  };\n\n  export const initializeForIModel = async (arg: { iModel: IModelDb, containerProps: CloudSqlite.ContainerProps, overrideContainer?: boolean }) => {\n    const props = { baseUri: arg.containerProps.baseUri, containerId: arg.containerProps.containerId, storageType: arg.containerProps.storageType }; // sanitize to only known properties\n    const iModel = arg.iModel;\n    const briefcase = iModel instanceof BriefcaseDb ? iModel : undefined;\n    await iModel.acquireSchemaLock();\n    if (briefcase) {\n      if (briefcase.txns.hasLocalChanges) {\n        throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Enabling SchemaSync for iModel failed. There are unsaved or un-pushed local changes.\");\n      }\n      await briefcase.pullChanges();\n    }\n    try {\n      iModel.saveFileProperty(syncProperty, JSON.stringify(props));\n      await withLockedAccess(arg.iModel, { operationName: \"initialize schemaSync\", openMode: OpenMode.Readonly }, async (syncAccess) => {\n        iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);\n        iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);\n      });\n    } catch (err) {\n      throw err;\n    } finally {\n      iModel.abandonChanges();\n    }\n\n    if (briefcase) {\n      if (arg.overrideContainer)\n        await briefcase.pushChanges({ description: `Overriding SchemaSync for iModel with container-id: ${props.containerId}` });\n      else\n        await briefcase.pushChanges({ description: `Enable SchemaSync for iModel with container-id: ${props.containerId}` });\n    }\n  };\n\n  /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */\n  export class CloudAccess extends CloudSqlite.DbAccess<SchemaSyncDb> {\n    public constructor(props: CloudSqlite.ContainerAccessProps) {\n      super({ dbType: SchemaSyncDb, props, dbName: defaultDbName });\n    }\n\n    public getUri() {\n      return `${this.getCloudDb()[_nativeDb].getFilePath()}?vfs=${this.container.cache?.name}&writable=${this.container.isWriteable ? 1 : 0}`;\n    }\n    /**\n   * Initialize a cloud container for use as a SchemaSync. The container must first be created via its storage supplier api (e.g. Azure, or AWS).\n   * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty ChannelDb into the container.\n   * @note this deletes any existing content in the container.\n   */\n    public static async initializeDb(props: CloudSqlite.ContainerProps) {\n      return super._initializeDb({ props, dbType: SchemaSyncDb, dbName: defaultDbName });\n    }\n  }\n}\n\n"]}

package/lib/esm/SchemaUtils.d.ts

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { ECSchemaXmlContext } from "./ECSchemaXmlContext";
+/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.
+ * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.
+ * @returns EC3.2 Xml ECSchema(s).
+ * @throws [[IModelError]] if there is a problem converting the EC2 schemas.
+ * @beta
+ */
+export declare function convertEC2SchemasToEC3Schemas(ec2XmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[];
+/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName
+ * @param xmlSchemas The ECSchema Xml string(s).
+ * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.
+ * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.
+ * @beta
+ */
+export declare function upgradeCustomAttributesToEC3(xmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[];
+//# sourceMappingURL=SchemaUtils.d.ts.map

package/lib/esm/SchemaUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaUtils.d.ts","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG1D;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,kBAAkB,GAAG,MAAM,EAAE,CAOnH;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,kBAAkB,GAAG,MAAM,EAAE,CAO/G"}

package/lib/esm/SchemaUtils.js

@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+import { BentleyStatus } from "@itwin/core-bentley";
+import { IModelError } from "@itwin/core-common";
+import { IModelNative } from "./internal/NativePlatform";
+/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.
+ * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.
+ * @returns EC3.2 Xml ECSchema(s).
+ * @throws [[IModelError]] if there is a problem converting the EC2 schemas.
+ * @beta
+ */
+export function convertEC2SchemasToEC3Schemas(ec2XmlSchemas, schemaContext) {
+    const maybeNativeContext = schemaContext?.nativeContext;
+    const ec3XmlSchemas = IModelNative.platform.SchemaUtility.convertEC2XmlSchemas(ec2XmlSchemas, maybeNativeContext);
+    if (ec2XmlSchemas.length === 0)
+        throw new IModelError(BentleyStatus.ERROR, "Error converting EC2 Xml schemas");
+    return ec3XmlSchemas;
+}
+/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName
+ * @param xmlSchemas The ECSchema Xml string(s).
+ * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.
+ * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.
+ * @beta
+ */
+export function upgradeCustomAttributesToEC3(xmlSchemas, schemaContext) {
+    const maybeNativeContext = schemaContext?.nativeContext;
+    const schemasWithConvertedCA = IModelNative.platform.SchemaUtility.convertCustomAttributes(xmlSchemas, maybeNativeContext);
+    if (schemasWithConvertedCA.length === 0)
+        throw new IModelError(BentleyStatus.ERROR, "Error converting custom attributes of Xml schemas");
+    return schemasWithConvertedCA;
+}
+//# sourceMappingURL=SchemaUtils.js.map

package/lib/esm/SchemaUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,mDAAmD,CAAC,CAAC;IAElG,OAAO,sBAAsB,CAAC;AAChC,CAAC","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 Schema\n */\n\nimport { BentleyStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { ECSchemaXmlContext } from \"./ECSchemaXmlContext\";\nimport { IModelNative } from \"./internal/NativePlatform\";\n\n/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.\n * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.\n * @returns EC3.2 Xml ECSchema(s).\n * @throws [[IModelError]] if there is a problem converting the EC2 schemas.\n * @beta\n */\nexport function convertEC2SchemasToEC3Schemas(ec2XmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\n  const maybeNativeContext = schemaContext?.nativeContext;\n  const ec3XmlSchemas: string[] = IModelNative.platform.SchemaUtility.convertEC2XmlSchemas(ec2XmlSchemas, maybeNativeContext);\n  if (ec2XmlSchemas.length === 0)\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting EC2 Xml schemas\");\n\n  return ec3XmlSchemas;\n}\n\n/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName\n * @param xmlSchemas The ECSchema Xml string(s).\n * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.\n * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.\n * @beta\n */\nexport function upgradeCustomAttributesToEC3(xmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\n  const maybeNativeContext = schemaContext?.nativeContext;\n  const schemasWithConvertedCA: string[] = IModelNative.platform.SchemaUtility.convertCustomAttributes(xmlSchemas, maybeNativeContext);\n  if (schemasWithConvertedCA.length === 0)\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting custom attributes of Xml schemas\");\n\n  return schemasWithConvertedCA;\n}\n"]}

package/lib/esm/SheetIndex.d.ts

@@ -0,0 +1,148 @@
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Code, CodeScopeProps, EntityReferenceSet, RelatedElementProps, SheetIndexEntryProps, SheetIndexReferenceProps, SheetReferenceProps } from "@itwin/core-common";
+import { InformationReferenceElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+import { Id64String } from "@itwin/core-bentley";
+import { SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from "./NavigationRelationship";
+/** Arguments used to create a [[SheetIndexEntry]].
+ * @beta
+ */
+export interface SheetIndexEntryCreateArgs {
+    /** The iModel that will contain the sheet index entry. */
+    iModelDb: IModelDb;
+    /** The Id of the [[SheetIndexModel]] that will contain the sheet index entry. */
+    sheetIndexModelId: Id64String;
+    /** The [[SheetIndex]] or [[SheetIndexFolder]] that is parent to this SheetIndexEntry */
+    parentId: Id64String;
+    /** The name of the SheetIndexEntry */
+    name: string;
+    /** The priority of the SheetIndexEntry */
+    priority: number;
+}
+/** Arguments supplied when creating a [[SheetIndexReference]].
+ * @beta
+ */
+export interface SheetIndexReferenceCreateArgs extends SheetIndexEntryCreateArgs {
+    /** The [[SheetIndex]] to which the reference refers. */
+    sheetIndexId?: Id64String;
+}
+/** Arguments supplied when creating a [[SheetReference]].
+ * @beta
+ */
+export interface SheetReferenceCreateArgs extends SheetIndexEntryCreateArgs {
+    /** The [[Sheet]] to which the reference refers. */
+    sheetId?: Id64String;
+}
+/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.
+ * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating
+ * sub-trees via [[SheetIndexReference]]s.
+ * @beta
+ */
+export declare class SheetIndex extends InformationReferenceElement {
+    static get className(): string;
+    /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.
+     * @param iModel  The IModelDb
+     * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.
+     * @param codeValue The SheetIndex name
+     */
+    static createCode(iModel: IModelDb, scopeSheetIndexModelId: CodeScopeProps, codeValue: string): Code;
+    /** Create a SheetIndex
+     * @param iModelDb The IModelDb
+     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
+     * @param name The name (codeValue) of the SheetIndex
+     * @returns The newly constructed SheetIndex
+     * @throws [[IModelError]] if there is a problem creating the SheetIndex
+     */
+    static create(iModelDb: IModelDb, modelId: Id64String, name: string): SheetIndex;
+    /** Insert a SheetIndex
+     * @param iModelDb The IModelDb
+     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
+     * @param name The name (codeValue) of the SheetIndex
+     * @returns The Id of the newly inserted SheetIndex
+     * @throws [[IModelError]] if there is a problem inserting the SheetIndex
+     */
+    static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String;
+}
+/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.
+ * @beta
+*/
+export declare abstract class SheetIndexEntry extends InformationReferenceElement {
+    static get className(): string;
+    /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */
+    entryPriority: number;
+    protected constructor(props: SheetIndexEntryProps, iModel: IModelDb);
+    toJSON(): SheetIndexEntryProps;
+    /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.
+     * @param codeValue The name of the entry
+     */
+    static createCode(iModelDb: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+    protected static createParentRelationshipProps(iModelDb: IModelDb, id: Id64String): RelatedElementProps;
+    protected static createProps(arg: SheetIndexEntryCreateArgs): SheetIndexEntryProps;
+}
+/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].
+ * @beta
+ */
+export declare class SheetIndexFolder extends SheetIndexEntry {
+    static get className(): string;
+    /** Create a new SheetIndexFolder
+     * @returns The newly constructed SheetIndexFolder element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg: SheetIndexEntryCreateArgs): SheetIndexFolder;
+    /** Create a new SheetIndexFolder
+     * @returns The Id of the newly inserted SheetIndexFolder element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg: SheetIndexEntryCreateArgs): Id64String;
+}
+/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.
+ * @beta
+*/
+export declare class SheetIndexReference extends SheetIndexEntry {
+    static get className(): string;
+    /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */
+    sheetIndex?: SheetIndexReferenceRefersToSheetIndex;
+    protected constructor(props: SheetIndexReferenceProps, iModel: IModelDb);
+    protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps;
+    toJSON(): SheetIndexReferenceProps;
+    /** Create a new SheetIndexReference
+     * @returns The newly constructed SheetIndexReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg: SheetIndexReferenceCreateArgs): SheetIndexReference;
+    /** Create a new SheetIndexReference
+     * @returns The Id of the newly inserted SheetIndexReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg: SheetIndexReferenceCreateArgs): Id64String;
+    /** @alpha */
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+}
+/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].
+ * @beta
+*/
+export declare class SheetReference extends SheetIndexEntry {
+    static get className(): string;
+    /** The bis:Sheet that this bis:SheetReference is pointing to. */
+    sheet: SheetReferenceRefersToSheet | undefined;
+    protected constructor(props: SheetReferenceProps, iModel: IModelDb);
+    protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps;
+    toJSON(): SheetReferenceProps;
+    /** Create a new SheetReference
+     * @returns The newly constructed SheetReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg: SheetReferenceCreateArgs): SheetReference;
+    /** Insert a new SheetReference
+     * @returns The Id of the newly inserted SheetReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg: SheetReferenceCreateArgs): Id64String;
+    /** @alpha */
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+}
+//# sourceMappingURL=SheetIndex.d.ts.map

package/lib/esm/SheetIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SheetIndex.d.ts","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAe,IAAI,EAAE,cAAc,EAA0B,kBAAkB,EAAe,mBAAmB,EAAE,oBAAoB,EAAyB,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACjP,OAAO,EAAE,2BAA2B,EAAS,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAsD,qCAAqC,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAElK;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,QAAQ,EAAE,QAAQ,CAAC;IACnB,iFAAiF;IACjF,iBAAiB,EAAE,UAAU,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,EAAE,UAAU,CAAC;IACrB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC9E,wDAAwD;IACxD,YAAY,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,yBAAyB;IACzE,mDAAmD;IACnD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,2BAA2B;IACzD,WAA2B,SAAS,IAAI,MAAM,CAAyB;IAEvE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAK3G;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IASvF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAMxF;AAED;;EAEE;AACF,8BAAsB,eAAgB,SAAQ,2BAA2B;IACvE,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,0FAA0F;IACnF,aAAa,EAAE,MAAM,CAAC;IAE7B,SAAS,aAAa,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,QAAQ;IAKnD,MAAM,IAAI,oBAAoB;IAI9C;;;;OAIG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKnG,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAOvG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB;CAW5D;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB;IAKnD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB,GAAG,UAAU;CAMjE;AAED;;EAEE;AACF,qBAAa,mBAAoB,SAAQ,eAAe;IACtD,WAA2B,SAAS,IAAI,MAAM,CAAkC;IAEhF,2EAA2E;IACpE,UAAU,CAAC,EAAE,qCAAqC,CAAC;IAE1D,SAAS,aAAa,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,QAAQ;IAWvE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,wBAAwB;IAOlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B;IAQvD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B,GAAG,UAAU;IAOpE,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;EAEE;AACF,qBAAa,cAAe,SAAQ,eAAe;IACjD,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,iEAAiE;IAC1D,KAAK,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAEtD,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAWlE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,mBAAmB;IAO7C;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB;IAQlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,UAAU;IAO/D,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E"}