extract-api

Author: kring

common/api/core-backend.api.md

@@ -457,7 +457,9 @@ export interface BackendHubAccess {
     queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;
     queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;
     releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;
+    releaseAllLocksAfterAbandon?: (arg: BriefcaseIdArg) => Promise<void>;
     releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;
+    releaseLocksAfterAbandon?: (arg: BriefcaseIdArg, locks: LockMap) => Promise<void>;
 }
 
 // @public
@@ -1416,7 +1418,7 @@ export namespace CloudSqlite {
         busyHandler?: WriteLockBusyHandler;
     }, operation: () => Promise<T>): Promise<T>;
     export type WriteLockBusyHandler = (lockedBy: string, expires: string) => Promise<void | "stop">;
-    export {};
+        {};
 }
 
 // @alpha
@@ -1667,7 +1669,7 @@ export interface ComputeGraphemeOffsetsArgs extends LayoutTextArgs {
 }
 
 // @beta
-export function computeIntervalPoints(input: ComputeIntervalPointsArgs): Point3d[] | undefined;
+export function computeIntervalPoints({ frame, range, transform, lineIntervalFactor, arcIntervalFactor }: ComputeIntervalPointsArgs): Point3d[] | undefined;
 
 // @beta
 export interface ComputeIntervalPointsArgs extends ComputeFrameArgs {
@@ -4762,13 +4764,17 @@ export class LocalHub {
         briefcaseId: BriefcaseId;
         changesetIndex: ChangesetIndex;
     }): void;
+    // (undocumented)
+    releaseAllLocksAfterAbandon(arg: BriefcaseIdArg): void;
     releaseBriefcaseId(id: BriefcaseId): void;
     // (undocumented)
     releaseLocks(locks: LockProps[], arg: {
         briefcaseId: BriefcaseId;
         changesetIndex: ChangesetIndex;
     }): void;
     // (undocumented)
+    releaseLocksAfterAbandon(locks: LockMap, arg: BriefcaseIdArg): void;
+    // (undocumented)
     removeDir(dirName: string): void;
     // (undocumented)
     readonly rootDir: LocalDirName;
@@ -4801,12 +4807,15 @@ export interface LockControl {
         shared?: Id64Arg;
         exclusive?: Id64Arg;
     }): Promise<void>;
+    acquireLocksForReinstatingTxn(txnId: Id64String): Promise<void>;
     checkExclusiveLock(id: Id64String, type: string, operation: string): void;
     checkSharedLock(id: Id64String, type: string, operation: string): void;
     holdsExclusiveLock(id: Id64String): boolean;
     holdsSharedLock(id: Id64String): boolean;
     readonly isServerBased: boolean;
     releaseAllLocks(): Promise<void>;
+    releaseAllLocksAfterAbandon(): Promise<void>;
+    releaseLocksForReversedTxn(txnId: Id64String): Promise<void>;
 }
 
 // @public
@@ -7722,7 +7731,7 @@ export namespace ViewStore {
         modelSel?: RowId;
     }
     export type ViewStoreCtorProps = CloudSqlite.ContainerAccessProps & ViewDbCtorArgs;
-    export {};
+        {};
 }
 
 // @public @preview

common/api/core-frontend.api.md

@@ -1513,9 +1513,9 @@ export abstract class BaseUnitFormattingSettingsProvider implements UnitFormatti
     abstract retrieveUnitSystem(defaultKey: UnitSystemKey): Promise<UnitSystemKey>;
     abstract store(quantityTypeKey: QuantityTypeKey, overrideProps: OverrideFormatEntry): Promise<boolean>;
     // (undocumented)
-    storeFormatOverrides: (input: QuantityFormatOverridesChangedArgs) => Promise<void>;
+    storeFormatOverrides: ({ typeKey, overrideEntry, unitSystem }: QuantityFormatOverridesChangedArgs) => Promise<void>;
     abstract storeUnitSystemKey(unitSystemKey: UnitSystemKey): Promise<boolean>;
-    storeUnitSystemSetting: (input: FormattingUnitSystemChangedArgs) => Promise<void>;
+    storeUnitSystemSetting: ({ system }: FormattingUnitSystemChangedArgs) => Promise<void>;
 }
 
 // @public

common/api/ecschema-metadata.api.md

@@ -1530,7 +1530,7 @@ export enum PropertyType {
 }
 
 // @internal (undocumented)
-export function propertyTypeToString(type: PropertyType): "PrimitiveProperty" | "StructProperty" | "StructArrayProperty" | "NavigationProperty" | "PrimitiveArrayProperty";
+export function propertyTypeToString(type: PropertyType): "PrimitiveProperty" | "PrimitiveArrayProperty" | "StructProperty" | "StructArrayProperty" | "NavigationProperty";
 
 // @internal (undocumented)
 export namespace PropertyTypeUtils {

core/backend/src/BackendHubAccess.ts

@@ -226,16 +226,16 @@ export interface BackendHubAccess {
 
   /**
    * Releases the specified locks when none of the associated elements have
-   * been or will be modified. Depending on the {@link CommonLockState} specified for the lock,
-   * it may be returned to the {@link CommonLockState.Shared} state or released entirely. It is only
+   * been or will be modified. Depending on the {@link LockState} specified for the lock,
+   * it may be returned to the {@link LockState.Shared} state or released entirely. It is only
    * valid to call this method when none of the elements protected by the locks have been edited, or if all edits
    * have been reversed or abandoned without pushing them.
    *
    * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
-   * This is equivalent to calling {@link acquireLocks} with an invalid {@link ChangesetIdWithIndex}.
+   * This is equivalent to calling {@link BackendHubAccess.acquireLocks} with an invalid changeset index.
    *
-   * It is an error to specify {@link CommonLockState.Exclusive}. It is also an error to specify
-   * {@link CommonLockState.Shared} for a lock that is not currently held exclusively, but an
+   * It is an error to specify {@link LockState.Exclusive}. It is also an error to specify
+   * {@link LockState.Shared} for a lock that is not currently held exclusively, but an
    * implementation may choose whether to throw an exception in this scenario or simply ignore it.
    *
    * This method is optional, so not all IModelHubs will implement it.
@@ -254,7 +254,7 @@ export interface BackendHubAccess {
    * or if all edits have been reversed or abandoned without pushing them.
    *
    * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
-   * This is equivalent to calling {@link releaseAllLocks} with an invalid {@link ChangesetIdWithIndex}.
+   * This is equivalent to calling {@link BackendHubAccess.releaseAllLocks} with an invalid changeset index.
    *
    * This method is optional, so not all IModelHubs will implement it.
    */

core/backend/src/LockControl.ts

@@ -86,8 +86,8 @@ export interface LockControl {
    * the currently-held locks have been edited, or if all edits have been reversed or abandoned without
    * pushing them.
    *
-   * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
-   * This is equivalent to calling {@link releaseAllLocks} with an invalid {@link ChangesetIdWithIndex}.
+   * The locks are released on the IModelHub, but the changeset associated with the locks is not updated,
+   * reflecting the fact that the associated elements were not edited.
    */
   releaseAllLocksAfterAbandon(): Promise<void>;
 
@@ -110,7 +110,7 @@ export interface LockControl {
 
   /**
    * Re-acquire the locks that were previously acquired during a given Txn and then released with
-   * {@link releaseLocksForReversedTxn}. This is used just before reinstating a previously-reversed
+   * {@link LockControl.releaseLocksForReversedTxn}. This is used just before reinstating a previously-reversed
    * Txn to ensure that the necessary locks are held. It is possible that the locks may no longer be available,
    * in which case this method will throw an exception.
    *