@itwin/core-backend 4.3.0-dev.2 → 4.3.0-dev.21

package/CHANGELOG.md

@@ -1,6 +1,49 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Fri, 06 Oct 2023 04:02:58 GMT and should not be manually modified.
+This log was last generated on Mon, 06 Nov 2023 14:03:28 GMT and should not be manually modified.
+
+## 4.2.3
+Mon, 06 Nov 2023 14:01:52 GMT
+
+_Version update only_
+
+## 4.2.2
+Thu, 02 Nov 2023 15:36:20 GMT
+
+_Version update only_
+
+## 4.2.1
+Tue, 24 Oct 2023 15:09:13 GMT
+
+_Version update only_
+
+## 4.2.0
+Tue, 17 Oct 2023 15:14:32 GMT
+
+### Updates
+
+- Add ECSqlExpr api
+- Add support for schema synchronization
+- Fixed a null reference error when upgrading schemas to EC3
+- Adds logging for checkpoint application and V2 checkpoint downloads
+- add exportGraphics test to verify uv-parameter output
+- ECDb.createQueryReader and IModelDb.createQueryReader are now public
+- restart default txn after 10 minutes inactivity on v2 checkpoints
+- Add TxnManager events raised when applying external txns.
+- Fix RenderMaterialElement using the wrong CodeSpec.
+- Fix two potential bugs when closing and reopening an iModel while pulling changes."
+- Make watching for briefcase changes more reliable.
+- As instance access no longer an experimental feature, removed experimental features option from relevant ecsql.
+- Use instance query to get aspects for abstract classes
+- ViewStore.ViewDb.getViewGroups select statement was referring to ParentId when parent was meant
+- Remove `storageType` from `BlobContainer.RequestTokenProps`.
+- Add 'provider' to 'BlobContainer.CreatedContainerProps' 
+- add TileStorage.getCachedTilesGenerator
+
+## 4.1.9
+Tue, 10 Oct 2023 18:48:12 GMT
+
+_Version update only_
 
 ## 4.1.8
 Fri, 06 Oct 2023 04:00:18 GMT
@@ -137,6 +180,16 @@ Mon, 22 May 2023 15:34:14 GMT
 - allow passing a custom schema read context to IModelDb.importSchemas
 - Added test to verify Id serialization to hex for system properties.
 
+## 3.7.16
+Mon, 16 Oct 2023 12:49:07 GMT
+
+_Version update only_
+
+## 3.7.15
+Tue, 10 Oct 2023 19:58:35 GMT
+
+_Version update only_
+
 ## 3.7.14
 Fri, 29 Sep 2023 16:57:16 GMT
 

package/lib/cjs/ChangesetECAdaptor.d.ts

@@ -0,0 +1,196 @@
+/** @packageDocumentation
+ * @module ECDb
+ */
+import { Id64String, IDisposable } from "@itwin/core-bentley";
+import { SqliteChangeOp, SqliteChangesetReader, SqliteValueStage } from "./SqliteChangesetReader";
+/**
+ * Record meta data for the change.
+ * @beta
+ * */
+export interface ChangeMetaData {
+    /** list of tables making up this EC change */
+    tables: string[];
+    /** full name of the class of this EC change */
+    className?: string;
+    /** sqlite operation that caused the change */
+    op: SqliteChangeOp;
+    /** version of the value read from sqlite change */
+    stage: SqliteValueStage;
+    /** if classId for the change was not found in db then fallback class for the table */
+    fallbackClassId?: Id64String;
+    /** list of change index making up this change (one per table) */
+    changeIndexes: number[];
+}
+/**
+ * Represent EC change derived from low level sqlite change
+ * @beta
+ */
+export interface ChangedECInstance {
+    ECInstanceId: Id64String;
+    ECClassId?: Id64String;
+    $meta?: ChangeMetaData;
+    [key: string]: any;
+}
+/**
+ * Combine partial changed instance into single instance.
+ * Partial changes is per table and a single instance can
+ * span multiple tables.
+ * @beta
+ */
+export declare class PartialECChangeUnifier {
+    private _cache;
+    private _readonly;
+    /**
+     * Combine partial instance with instance with same key if already exists.
+     * @param rhs partial instance
+     */
+    private combine;
+    /**
+     * Build key from EC change.
+     * @param change EC change
+     * @returns key created from EC change.
+     */
+    private static buildKey;
+    /**
+     * Append partial changes which will be combine using there instance key.
+     * @note $meta property must be present on partial change as information
+     * in it is used to combine partial instances.
+     * @param adaptor changeset adaptor is use to read the partial EC change.
+     * @beta
+     */
+    appendFrom(adaptor: ChangesetECAdaptor): void;
+    /**
+     * Delete $meta from all the instances.
+     */
+    stripMetaData(): void;
+    /**
+     * Returns complete EC change instances.
+     * @beta
+     */
+    get instances(): IterableIterator<ChangedECInstance>;
+}
+/**
+ * Transform sqlite change to ec change. EC change is partial change as
+ * it is per table while a single instance can span multiple table.
+ * @note PrimitiveArray and StructArray are not supported types.
+ * @beta
+ *
+*/
+export declare class ChangesetECAdaptor implements IDisposable {
+    readonly reader: SqliteChangesetReader;
+    readonly disableMetaData: boolean;
+    private readonly _mapCache;
+    private readonly _tableFilter;
+    private readonly _opFilter;
+    private readonly _classFilter;
+    private _allowedClasses;
+    /**
+     * set debug flags
+     */
+    readonly debugFlags: {
+        replaceBlobWithEllipsis: boolean;
+        replaceGeomWithEllipsis: boolean;
+        replaceGuidWithEllipsis: boolean;
+    };
+    /**
+     * Return partial inserted instance
+     * For updates inserted represent new version of instance after update.
+     */
+    inserted?: ChangedECInstance;
+    /**
+     * Return partial deleted instance.
+     * For updates deleted represent old version of instance before update.
+     */
+    deleted?: ChangedECInstance;
+    /**
+     * Setup filter that will result in change enumeration restricted to
+     * list of tables added by acceptTable().
+     * @param table Name of the table
+     * @returns Fluent reference to ChangesetAdaptor.
+     */
+    acceptTable(table: string): ChangesetECAdaptor;
+    /**
+     * Setup filter that will result in change enumeration restricted to
+     * list of op added by acceptOp().
+     * @param op
+     * @returns Fluent reference to ChangesetAdaptor.
+     */
+    acceptOp(op: SqliteChangeOp): ChangesetECAdaptor;
+    /**
+     * Setup filter that will result in change enumeration restricted to
+     * list of class and its derived classes added by acceptClass().
+     * @param classFullName
+     * @returns
+     */
+    acceptClass(classFullName: string): ChangesetECAdaptor;
+    private buildClassFilter;
+    /**
+     * Construct adaptor with a initialized reader.
+     * @note the changeset reader must have disableSchemaCheck
+     * set to false and db must also be set.
+     * @param reader wrap changeset reader.
+     */
+    constructor(reader: SqliteChangesetReader, disableMetaData?: boolean);
+    /**
+     * dispose current instance and it will also dispose the changeset reader.
+     */
+    dispose(): void;
+    /**
+     * close current instance and it will also close the changeset reader.
+     */
+    close(): void;
+    /**
+     * Convert binary GUID into string GUID.
+     * @param binaryGUID binary version of guid.
+     * @returns GUID string.
+     */
+    private static convertBinaryToGuid;
+    /**
+     * Set value use access string in a JS object.
+     * @param targetObj object that will be updated.
+     * @param accessString access string token separated by '.'.
+     */
+    private static setValue;
+    /**
+     * Check if sqlite change table is a EC data table
+     * @param tableName name of the table.
+     * @returns true if table has EC data.
+     */
+    isECTable(tableName: string): boolean;
+    /**
+     * Attempt find ECClassId from ECInstanceId for a change of type 'updated'.
+     * @param tableName name of the table to find ECClassId from given ECInstanceId
+     * @param instanceId instance id for which we need ECClassId for.
+     * @returns if successful returns ECClassId else return undefined.
+     */
+    private getClassIdFromDb;
+    /** helper method around reader.op */
+    get op(): SqliteChangeOp;
+    /** Return true if current change is of type "Inserted" */
+    get isInserted(): boolean;
+    /** Return true if current change is of type "Deleted" */
+    get isDeleted(): boolean;
+    /** Return true if current change is of type "Updated" */
+    get isUpdated(): boolean;
+    /**
+     * Advance reader to next change or a change that meets the filter set in the current adaptor
+     * @returns return false if no more changes to read.
+     */
+    step(): boolean;
+    /**
+     * Transform nav change column into navigation EC property
+     * @param prop navigation property definition.
+     * @param change sqlite change.
+     * @param out ec instance that will be updated with navigation property.
+     */
+    private transformNavigationProperty;
+    /**
+     * Transform sqlite change into EC change.
+     * @param classMap classMap use to deserialize sqlite change into EC change.
+     * @param change sqlite change from changeset.
+     * @param table table definition of sqlite change provided.
+     * @param out EC changeset that will be updated with properties.
+     */
+    private transform;
+}
+//# sourceMappingURL=ChangesetECAdaptor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetECAdaptor.d.ts","sourceRoot":"","sources":["../../src/ChangesetECAdaptor.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAwB,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAuB,cAAc,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AA+UvH;;;KAGK;AACL,MAAM,WAAW,cAAc;IAC7B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,EAAE,EAAE,cAAc,CAAC;IACnB,mDAAmD;IACnD,KAAK,EAAE,gBAAgB,CAAC;IACxB,sFAAsF;IACtF,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,iEAAiE;IACjE,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC,YAAY,EAAE,UAAU,CAAC;IAEzB,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AA4BD;;;;;GAKG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAwC;IACtD,OAAO,CAAC,SAAS,CAAS;IAC1B;;;OAGG;IACH,OAAO,CAAC,OAAO;IAiBf;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAGvB;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAgBpD;;OAEG;IACI,aAAa,IAAI,IAAI;IAQ5B;;;OAGG;IACH,IAAW,SAAS,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,CAAiC;CAC7F;AAED;;;;;;EAME;AACF,qBAAa,kBAAmB,YAAW,WAAW;aA4EjB,MAAM,EAAE,qBAAqB;aAAkB,eAAe;IA3EjG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,eAAe,CAAqB;IAC5C;;OAEG;IACH,SAAgB,UAAU;;;;MAIxB;IACF;;;OAGG;IACI,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACI,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAEnC;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB;IAKrD;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,kBAAkB;IAKvD;;;;;OAKG;IACI,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,kBAAkB;IAO7D,OAAO,CAAC,gBAAgB;IAUxB;;;;;OAKG;gBACgC,MAAM,EAAE,qBAAqB,EAAkB,eAAe,UAAQ;IASzG;;OAEG;IACI,OAAO,IAAI,IAAI;IAGtB;;OAEG;IACI,KAAK,IAAI,IAAI;IAGpB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAoBvB;;;;OAIG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM;IAGlC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAUxB,qCAAqC;IACrC,IAAW,EAAE,mBAA6B;IAC1C,0DAA0D;IAC1D,IAAW,UAAU,YAAqC;IAC1D,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IACxD,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IAExD;;;OAGG;IACI,IAAI,IAAI,OAAO;IA8GtB;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IAuBnC;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;CA6ClB"}