Remove deprecated 3.x APIs in core-common

core/common/src/BackgroundMapSettings.ts

@@ -6,7 +6,7 @@
  * @module DisplayStyles
  */
 
-import { BackgroundMapProvider, BackgroundMapType } from "./BackgroundMapProvider";
+import { BackgroundMapProvider } from "./BackgroundMapProvider";
 import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
 import { TerrainProps, TerrainSettings } from "./TerrainSettings";
 
@@ -58,32 +58,6 @@ export interface BackgroundMapProps {
   providerData?: never;
 }
 
-/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.
- * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in
- * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.
- * @public
- * @extensions
- */
-export interface DeprecatedBackgroundMapProps {
-  /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
-   * Default value: "BingProvider"
-   * @deprecated in 3.x. use MapImageryProps.backgroundBase.
-   */
-  providerName?: string;
-  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.
-   * @deprecated in 3.x. use MapImageryProps.backgroundBase
-   */
-  providerData?: {
-    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */
-    mapType?: BackgroundMapType;
-  };
-}
-
-/** Persistent JSON representation of a [[BackgroundMapSettings]].
- * @public
- * @extensions
- */
-export type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;
 
 function normalizeGlobeMode(mode?: GlobeMode): GlobeMode {
   return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;
@@ -138,7 +112,7 @@ export class BackgroundMapSettings {
   /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
   public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }
 
-  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {
+  private constructor(props: BackgroundMapProps) {
     this.groundBias = props.groundBias ?? 0;
     this.transparency = normalizeTransparency(props.transparency);
     this.useDepthBuffer = props.useDepthBuffer ?? false;
@@ -150,13 +124,6 @@ export class BackgroundMapSettings {
     this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);
   }
 
-  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
-   * the iModel - otherwise, prefer [[fromJSON]].
-   */
-  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {
-    return new this(json ?? {});
-  }
-
   /** Construct from JSON, performing validation and applying default values for undefined fields.
    * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
    */
@@ -196,31 +163,12 @@ export class BackgroundMapSettings {
     return props;
   }
 
-  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
-   * the iModel - otherwise, prefer [[toJSON]].
-   */
-  public toPersistentJSON(): PersistentBackgroundMapProps {
-    const props = this.toJSON() as PersistentBackgroundMapProps;
-
-    // Preserve deprecated imagery provider properties.
-    if ("BingProvider" !== this._provider.name)
-      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated
-    if (BackgroundMapType.Hybrid !== this._provider.type)
-      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated
-
-    return props;
-  }
 
   /** Returns true if these settings are equivalent to the supplied JSON settings. */
   public equalsJSON(json?: BackgroundMapProps): boolean {
     return this.equals(BackgroundMapSettings.fromJSON(json));
   }
 
-  /** Returns true if the persistent representation of these settings is equivalent to `json`. */
-  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {
-    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));
-  }
-
   /** Returns true if these settings are equivalent to `other`. */
   public equals(other: BackgroundMapSettings): boolean {
     return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency
@@ -246,10 +194,8 @@ export class BackgroundMapSettings {
       applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,
       terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),
       planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),
-      providerName: this._provider.name,
-      providerData: { mapType: this._provider.type },
     };
 
-    return BackgroundMapSettings.fromPersistentJSON(props);
+    return BackgroundMapSettings.fromJSON(props);
   }
 }

core/common/src/Code.ts

@@ -333,17 +333,4 @@ export class CodeSpec {
     else
       this.properties.scopeSpec.fGuidRequired = undefined;
   }
-
-  /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.
-   * @deprecated in 3.6 Use scopeReq instead.
-   */
-  public get isManagedWithIModel(): boolean {
-    return this.properties.spec?.isManagedWithDgnDb ?? true;
-  }
-  public set isManagedWithIModel(value: boolean) {
-    if (!this.properties.spec)
-      this.properties.spec = {};
-
-    this.properties.spec.isManagedWithDgnDb = value;
-  }
 }

core/common/src/FeatureSymbology.ts

@@ -817,42 +817,6 @@ export class FeatureOverrides implements FeatureAppearanceSource {
     map.set(idLo, idHi, app);
   }
 
-  /** Specify overrides for all elements within the specified model.
-   * @param id The Id of the model.
-   * @param app The symbology overrides.
-   * @param replaceExisting Specifies whether to replace a pre-existing override for the same model.
-   * @note These overrides take priority over all other overrides.
-   * @note If [[defaultOverrides]] are defined, they will not apply to any element within this model, even if the supplied appearance overrides nothing.
-   * @deprecated in 3.x. Use [[FeatureOverrides.override]].
-   */
-  public overrideModel(id: Id64String, app: FeatureAppearance, replaceExisting: boolean = true): void {
-    this.override({ modelId: id, appearance: app, onConflict: replaceExisting ? "replace" : "skip" });
-  }
-
-  /** Specify overrides for all geometry belonging to the specified [SubCategory]($backend).
-   * @param id The Id of the subcategory.
-   * @param app The symbology overrides.
-   * @param replaceExisting Specifies whether to replace a pre-existing override for the same subcategory.
-   * @note These overrides have lower priority than element and model overrides.
-   * @note If [[defaultOverrides]] are defined, they will not apply to any geometry within this subcategory, even if the supplied appearance overrides nothing.
-   * @deprecated in 3.x. Use [[FeatureOverrides.override]].
-   */
-  public overrideSubCategory(id: Id64String, app: FeatureAppearance, replaceExisting: boolean = true): void {
-    this.override({ subCategoryId: id, appearance: app, onConflict: replaceExisting ? "replace" : "skip" });
-  }
-
-  /** Specify overrides for all geometry originating from the specified element.
-   * @param id The Id of the element.
-   * @param app The symbology overrides.
-   * @param replaceExisting Specifies whether to replace a pre-existing override for the same element.
-   * @note These overrides take precedence over subcategory overrides, but not over model overrides.
-   * @note If [[defaultOverrides]] are defined, they will not apply to this element, even if the supplied appearance overrides nothing.
-   * @deprecated in 3.x. Use [[FeatureOverrides.override]].
-   */
-  public overrideElement(id: Id64String, app: FeatureAppearance, replaceExisting: boolean = true): void {
-    this.override({ elementId: id, appearance: app, onConflict: replaceExisting ? "replace" : "skip" });
-  }
-
   /** Specify overrides for all geometry originating from the specified animation node.
    * @param id The Id of the animation node.
    * @param app The symbology overrides.

core/common/src/Localization.ts

@@ -60,15 +60,6 @@ export interface Localization {
    * @throws Error if no keys resolve to a string.
    */
   getLocalizedString(key: string | string[], options?: TranslationOptions): string;
-  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.
-   * @param namespace - the namespace that identifies the particular localization file that contains the property.
-   * @param key - the key that matches a property in the JSON localization file.
-   * @returns The string corresponding to the first key that resolves.
-   * @throws Error if no keys resolve to a string.
-   * @deprecated in 3.x. Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or
-   * including `{ ns: <namespace> }` in the options.
-   */
-  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;
   /** get the English string for a key. */
   getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;
   /** Replace all instances of `%{key}` within a string with the translations of those keys.

core/common/src/TerrainSettings.ts

@@ -8,14 +8,6 @@
 
 import { BackgroundMapProps } from "./BackgroundMapSettings";
 
-/** Identifies a [TerrainProvider]($frontend).
- * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].
- * @public
- * @extensions
- * @deprecated in 3.x. Use string instead.
- */
-export type TerrainProviderName = string;
-
 /** Ids of [Cesium ION assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
  * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
  * You may alternatively use the Id of any ION asset to which you have access.

core/common/src/ViewProps.ts

@@ -71,8 +71,6 @@ export interface SubCategoryResultRow {
 export interface HydrateViewStateRequestProps {
   acsId?: string;
   notLoadedModelSelectorStateModels?: CompressedId64Set;
-  /** @deprecated in 3.x. If loading categoryIds is necessary, see [IModelConnection.SubCategoriesCache.load]($frontend)*/
-  notLoadedCategoryIds?: CompressedId64Set;
   sheetViewAttachmentIds?: CompressedId64Set;
   viewStateLoadProps?: ViewStateLoadProps;
   baseModelId?: Id64String;
@@ -90,8 +88,6 @@ export interface HydrateViewStateResponseProps {
   sheetViewViews?: (ViewStateProps | undefined)[];
   baseModelProps?: ModelProps;
   spatialViewProps?: ViewStateProps;
-  /** @deprecated in 3.x. If loading categoryIds is necessary, see [IModelConnection.SubCategoriesCache.load]($frontend)*/
-  categoryIdsResult?: SubCategoryResultRow[];
 }
 
 /** Returned from [IModelDb.Views.getViewStateData]($backend).

docs/changehistory/NextVersion.md

@@ -21,6 +21,7 @@ Table of contents:
     - [ECMAScript](#ecmascript)
   - [Deprecated API removals](#deprecated-api-removals)
     - [@itwin/core-backend](#itwincore-backend-1)
+    - [@itwin/core-common](#itwincore-common-1)
     - [@itwin/appui-abstract](#itwinappui-abstract)
     - [@itwin/core-electron](#itwincore-electron)
   - [API removals](#api-removals)
@@ -109,6 +110,17 @@ The following previously-deprecated APIs have been removed:
 
 All three `nativeDb` fields and `IModelHost.platform` have always been `@internal`. Use the `@public` APIs instead. If some functionality is missing from those APIs, [let us know](https://github.com/iTwin/itwinjs-core/issues/new?template=feature_request.md).
 
+#### @itwin/core-common
+
+| Removed                                        | Replacement                       |
+| ---------------------------------------------- | --------------------------------- |
+| `CodeSpec.isManagedWithIModel`                 | `CodeSpec.scopeReq`               |
+| `FeatureOverrides.overrideModel`               | `FeatureOverrides.override`       |
+| `FeatureOverrides.overrideSubCategory`         | `FeatureOverrides.override`       |
+| `FeatureOverrides.overrideElement`             | `FeatureOverrides.override`       |
+| `Localization.getLocalizedStringWithNamespace` | `Localization.getLocalizedString` |
+| `TerrainProviderName`                          | N/A                               |
+
 #### @itwin/appui-abstract
 
 | Removed                     | Replacement |
@@ -149,7 +161,7 @@ As of iTwin.js 5.0, the following packages have been removed and are no longer a
 | Removed                        | Replacement                                                                                                            |
 | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
 | `@itwin/core-webpack-tools`    | We no longer recommend using [webpack](https://webpack.js.org/) and instead recommend using [Vite](https://vite.dev/). |
-| `@itwin/backend-webpack-tools` | We no longer recommend webpack-ing backends, which was previously recommended to shrink the size of backends. |
+| `@itwin/backend-webpack-tools` | We no longer recommend webpack-ing backends, which was previously recommended to shrink the size of backends.          |
 
 ### Change to pullMerge
 
@@ -163,7 +175,7 @@ Starting from version 5.x, iTwin.js has transitioned from using the merge method
 
 The merging process in this method follows these steps:
 
-1. Initially, each incoming change is attempted to be applied using the *fastforward* method. If successful, the process is complete.
+1. Initially, each incoming change is attempted to be applied using the _fastforward_ method. If successful, the process is complete.
 2. If the fast-forward method fails for any incoming change, that changeset is abandoned and the rebase method is used instead.
 3. The rebase process is executed as follows:
    - All local transactions are reversed.
@@ -179,4 +191,3 @@ This method offers several advantages:
 4. In the future, this method will be essential for lock-less editing as it enables applications to merge changes with domain intelligence.
 
 For more information read [Pull merge & conflict resolution](../learning/backend/PullMerge.md)
-