Remove localization. Let consumers supply the two strings we need. (#404

) * Remove localization. Let consumers supply the two strings we need. * change
iTwin · Feb 7, 2024 · 6e8aa1a · 6e8aa1a
1 parent 4d177c7
commit 6e8aa1a
Show file tree

Hide file tree

Showing 24 changed files with 117 additions and 223 deletions.
diff --git a/.changeset/beige-suns-explode.md b/.changeset/beige-suns-explode.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/core-interop/api/presentation-core-interop.api.md b/packages/core-interop/api/presentation-core-interop.api.md
@@ -15,8 +15,6 @@ import { IMetadataProvider } from '@itwin/presentation-hierarchy-builder';
 import { InstancesNodeKey } from '@itwin/presentation-hierarchy-builder';
 import { IPrimitiveValueFormatter } from '@itwin/presentation-hierarchy-builder';
 import { KeySet } from '@itwin/presentation-common';
-import { Localization } from '@itwin/core-common';
-import { LocalizationFunction } from '@itwin/presentation-hierarchy-builder';
 import { QueryBinder } from '@itwin/core-common';
 import { QueryOptions } from '@itwin/core-common';
 import { RulesetVariable } from '@itwin/presentation-common';
@@ -45,9 +43,6 @@ export interface CreateHierarchyLevelDescriptorProps<TIModel extends ICoreECSqlR
     }) | undefined;
 }
 
-// @beta
-export function createLocalizationFunction(localization: Localization): Promise<LocalizationFunction>;
-
 // @beta
 export function createLogger(): ILogger;
 

diff --git a/packages/core-interop/api/presentation-core-interop.exports.csv b/packages/core-interop/api/presentation-core-interop.exports.csv
@@ -3,7 +3,6 @@ Release Tag;API Item
 beta;createECSqlQueryExecutor(imodel: ICoreECSqlReaderFactory): IECSqlQueryExecutor
 beta;createHierarchyLevelDescriptor
 beta;CreateHierarchyLevelDescriptorProps
-beta;createLocalizationFunction(localization: Localization): Promise
 beta;createLogger(): ILogger
 beta;createMetadataProvider(schemaContext: SchemaContext): IMetadataProvider
 beta;createValueFormatter(schemaContext: SchemaContext, unitSystem?: UnitSystemKey, baseFormatter?: IPrimitiveValueFormatter): IPrimitiveValueFormatter

diff --git a/packages/core-interop/src/core-interop/Localization.ts b/packages/core-interop/src/core-interop/Localization.ts
diff --git a/packages/core-interop/src/presentation-core-interop.ts b/packages/core-interop/src/presentation-core-interop.ts
@@ -5,7 +5,6 @@
 
 export * from "./core-interop/Formatting";
 export * from "./core-interop/HierarchyLevelDescriptor";
-export * from "./core-interop/Localization";
 export * from "./core-interop/Logging";
 export * from "./core-interop/Metadata";
 export * from "./core-interop/QueryExecutor";

diff --git a/packages/core-interop/src/test/Localization.test.ts b/packages/core-interop/src/test/Localization.test.ts
diff --git a/packages/full-stack-tests/src/hierarchy-builder/HierarchyValidation.ts b/packages/full-stack-tests/src/hierarchy-builder/HierarchyValidation.ts
@@ -175,6 +175,7 @@ export namespace NodeValidators {
   }
 
   export function createForPropertyOtherValuesGroupingNode<TChildren extends ExpectedHierarchyDef[] | boolean>(props: {
+    label?: string;
     autoExpand?: boolean;
     children?: TChildren;
   }) {
@@ -188,7 +189,7 @@ export namespace NodeValidators {
         }
 
         validateBaseNodeAttributes(node, {
-          label: "Òthér",
+          label: props.label,
           autoExpand: props.autoExpand,
           children: props.children,
         });

diff --git a/packages/full-stack-tests/src/hierarchy-builder/Localization.test.ts b/packages/full-stack-tests/src/hierarchy-builder/Localization.test.ts
diff --git a/packages/full-stack-tests/src/hierarchy-builder/Utils.ts b/packages/full-stack-tests/src/hierarchy-builder/Utils.ts
@@ -12,6 +12,7 @@ import {
   createLimitingECSqlQueryExecutor,
   HierarchyNodeIdentifiersPath,
   HierarchyProvider,
+  HierarchyProviderLocalizedStrings,
   IHierarchyLevelDefinitionsFactory,
   IPrimitiveValueFormatter,
   parseFullClassName,
@@ -53,14 +54,16 @@ export function createProvider(props: {
   imodel: IModelConnection | IModelDb | ECDb;
   hierarchy: IHierarchyLevelDefinitionsFactory;
   formatterFactory?: (schemas: SchemaContext) => IPrimitiveValueFormatter;
+  localizedStrings?: HierarchyProviderLocalizedStrings;
   filteredNodePaths?: HierarchyNodeIdentifiersPath[];
 }) {
-  const { imodel, hierarchy, formatterFactory, filteredNodePaths } = props;
+  const { imodel, hierarchy, formatterFactory, localizedStrings, filteredNodePaths } = props;
   return new HierarchyProvider({
     metadataProvider: createMetadataProvider(imodel),
     hierarchyDefinition: hierarchy,
     queryExecutor: createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 123),
     formatter: formatterFactory ? formatterFactory(createSchemaContext(imodel)) : undefined,
+    localizedStrings,
     filtering: filteredNodePaths ? { paths: filteredNodePaths } : undefined,
   });
 }

diff --git a/packages/full-stack-tests/src/hierarchy-builder/grouping/PropertiesGrouping.test.ts b/packages/full-stack-tests/src/hierarchy-builder/grouping/PropertiesGrouping.test.ts
@@ -5,14 +5,8 @@
 
 import { Subject } from "@itwin/core-backend";
 import { IModel } from "@itwin/core-common";
-import { IModelApp, IModelConnection } from "@itwin/core-frontend";
-import { createLocalizationFunction } from "@itwin/presentation-core-interop";
-import {
-  ECSqlSelectClausePropertiesGroupingParams,
-  IHierarchyLevelDefinitionsFactory,
-  NodeSelectQueryFactory,
-  setLocalizationFunction,
-} from "@itwin/presentation-hierarchy-builder";
+import { IModelConnection } from "@itwin/core-frontend";
+import { ECSqlSelectClausePropertiesGroupingParams, IHierarchyLevelDefinitionsFactory, NodeSelectQueryFactory } from "@itwin/presentation-hierarchy-builder";
 import { buildIModel, importSchema, insertSubject, withECDb } from "../../IModelUtils";
 import { initialize, terminate } from "../../IntegrationTests";
 import { NodeValidators, validateHierarchy } from "../HierarchyValidation";
@@ -284,16 +278,18 @@ describe("Stateless hierarchy builder", () => {
         propertyGroups: [{ propertyName: "Description", propertyClassAlias: "this" }],
       };
 
-      const localizationFunction = await createLocalizationFunction(IModelApp.localization);
-      setLocalizationFunction(localizationFunction);
       await validateHierarchy({
-        provider: createProvider({ imodel, hierarchy: createHierarchyWithSpecifiedGrouping(imodel, groupingParams) }),
+        provider: createProvider({
+          imodel,
+          hierarchy: createHierarchyWithSpecifiedGrouping(imodel, groupingParams),
+          localizedStrings: { other: "", unspecified: "NOT SPECIFIED" },
+        }),
         expect: [
           NodeValidators.createForPropertyValueGroupingNode({
             propertyClassName: "BisCore.Subject",
             propertyName: "Description",
             formattedPropertyValue: "",
-            label: "Ñót spêçìfíêd",
+            label: "NOT SPECIFIED",
             children: [
               NodeValidators.createForInstanceNode({
                 instanceKeys: [keys.childSubject1],
@@ -414,13 +410,12 @@ describe("Stateless hierarchy builder", () => {
               return [];
             },
           };
-          const provider = createProvider({ imodel, hierarchy });
-          const localizationFunction = await createLocalizationFunction(IModelApp.localization);
-          setLocalizationFunction(localizationFunction);
+          const provider = createProvider({ imodel, hierarchy, localizedStrings: { other: "OTHER", unspecified: "" } });
           await validateHierarchy({
             provider,
             expect: [
               NodeValidators.createForPropertyOtherValuesGroupingNode({
+                label: "OTHER",
                 children: [NodeValidators.createForInstanceNode({ instanceKeys: [x1] }), NodeValidators.createForInstanceNode({ instanceKeys: [x2] })],
               }),
             ],

diff --git a/packages/hierarchy-builder/.npmignore b/packages/hierarchy-builder/.npmignore
@@ -7,8 +7,6 @@
 !lib/**/*.d.ts.map
 !lib/**/*.js
 !lib/**/*.js.map
-!lib/**/public/**/*
 
 # then ignore some stuff again
 lib/**/test/**
-lib/**/public/locales/en-PSEUDO/**
diff --git a/packages/hierarchy-builder/api/presentation-hierarchy-builder.api.md b/packages/hierarchy-builder/api/presentation-hierarchy-builder.api.md
@@ -730,13 +730,20 @@ export class HierarchyProvider {
     setFormatter(formatter: IPrimitiveValueFormatter | undefined): void;
 }
 
+// @beta
+export interface HierarchyProviderLocalizedStrings {
+    other: string;
+    unspecified: string;
+}
+
 // @beta
 export interface HierarchyProviderProps {
     filtering?: {
         paths: HierarchyNodeIdentifiersPath[];
     };
     formatter?: IPrimitiveValueFormatter;
     hierarchyDefinition: IHierarchyLevelDefinitionsFactory;
+    localizedStrings?: HierarchyProviderLocalizedStrings;
     metadataProvider: IMetadataProvider;
     queryConcurrency?: number;
     queryExecutor: ILimitingECSqlQueryExecutor;
@@ -846,12 +853,6 @@ export interface LabelGroupingNodeKey extends BaseGroupingNodeKey {
     type: "label-grouping";
 }
 
-// @beta
-export const LOCALIZATION_NAMESPACE = "PresentationHierarchyBuilder";
-
-// @beta
-export type LocalizationFunction = (input: string) => string;
-
 // @beta (undocumented)
 export type LogFunction = (category: string, message: string) => void;
 
@@ -1087,9 +1088,6 @@ export class RowsLimitExceededError extends Error {
     readonly limit: number;
 }
 
-// @beta
-export function setLocalizationFunction(localizationFunction?: LocalizationFunction): void;
-
 // @beta
 export function setLogger(logger: ILogger | undefined): void;
 

diff --git a/packages/hierarchy-builder/api/presentation-hierarchy-builder.exports.csv b/packages/hierarchy-builder/api/presentation-hierarchy-builder.exports.csv
@@ -97,6 +97,7 @@ beta;HierarchyNodePropertyValueRange
 beta;HierarchyNodesDefinition = CustomHierarchyNodeDefinition | InstanceNodesQueryDefinition
 beta;HierarchyNodesDefinition
 beta;HierarchyProvider
+beta;HierarchyProviderLocalizedStrings
 beta;HierarchyProviderProps
 beta;Id64String = string
 beta;IECSqlQueryExecutor
@@ -116,8 +117,6 @@ beta;InstancesNodeChildHierarchyLevelDefinition
 beta;InstancesNodeKey
 beta;IPrimitiveValueFormatter = (value: TypedPrimitiveValue) => Promise
 beta;LabelGroupingNodeKey 
-beta;LOCALIZATION_NAMESPACE = "PresentationHierarchyBuilder"
-beta;LocalizationFunction = (input: string) => string
 beta;LogFunction = (category: string, message: string) => void
 beta;NodeSelectClauseColumnNames
 beta;NodeSelectClauseProps
@@ -155,7 +154,6 @@ beta;RelatedInstanceDescription
 beta;RelationshipPath
 beta;RelationshipPathStep
 beta;RowsLimitExceededError 
-beta;setLocalizationFunction(localizationFunction?: LocalizationFunction): void
 beta;setLogger(logger: ILogger | undefined): void
 beta;StandardHierarchyNodeKey = InstancesNodeKey | GroupingNodeKey
 beta;TypedPrimitiveValue
diff --git a/packages/hierarchy-builder/package.json b/packages/hierarchy-builder/package.json
@@ -23,11 +23,10 @@
   "module": "lib/esm/presentation-hierarchy-builder.js",
   "types": "lib/cjs/presentation-hierarchy-builder.d.ts",
   "scripts": {
-    "build": "npm run -s copy:locale && npm run -s build:cjs && npm run -s build:esm",
+    "build": "npm run -s build:cjs && npm run -s build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "build:watch": "npm run -s copy:locale && npm run -s build:cjs -- -w",
-    "copy:locale": "cpx \"./public/**/*\" ./lib/public",
+    "build:watch": "npm run -s build:cjs -- -w",
     "clean": "rimraf lib",
     "cover": "nyc npm -s test",
     "lint": "eslint ./src/**/*.ts",

diff --git a/packages/hierarchy-builder/public/locales/en/PresentationHierarchyBuilder.json b/packages/hierarchy-builder/public/locales/en/PresentationHierarchyBuilder.json
diff --git a/packages/hierarchy-builder/src/hierarchy-builder/HierarchyProvider.ts b/packages/hierarchy-builder/src/hierarchy-builder/HierarchyProvider.ts
@@ -62,6 +62,24 @@ const DEFAULT_QUERY_CONCURRENCY = 10;
  */
 export type ParentHierarchyNode = Omit<HierarchyNode, "children">;
 
+/**
+ * Defines the strings used by hierarchy provider.
+ * @beta
+ */
+export interface HierarchyProviderLocalizedStrings {
+  /**
+   * A string for "Unspecified". Used for labels of property grouping nodes
+   * that group by an empty value.
+   */
+  unspecified: string;
+
+  /**
+   * A string for "Other". Used for label of a range property grouping node that
+   * groups values which don't fit into any other range.
+   */
+  other: string;
+}
+
 /**
  * Props for [[HierarchyProvider]].
  * @beta
@@ -86,6 +104,9 @@ export interface HierarchyProviderProps {
    */
   formatter?: IPrimitiveValueFormatter;
 
+  /** A set of localized strings to use. Defaults to English strings. */
+  localizedStrings?: HierarchyProviderLocalizedStrings;
+
   /** Props for filtering the hierarchy. */
   filtering?: {
     /** A list of node identifiers from root to target node. */
@@ -120,6 +141,7 @@ export class HierarchyProvider {
   private _metadataProvider: IMetadataProvider;
   private _queryReader: TreeQueryResultsReader;
   private _valuesFormatter: IPrimitiveValueFormatter;
+  private _localizedStrings: HierarchyProviderLocalizedStrings;
   private _queryScheduler: SubscriptionScheduler;
   private _nodesCache: ChildNodesCache;
 
@@ -153,6 +175,7 @@ export class HierarchyProvider {
       this._queryReader = new TreeQueryResultsReader({ parser: props.hierarchyDefinition.parseNode });
     }
     this._valuesFormatter = props?.formatter ?? createDefaultValueFormatter();
+    this._localizedStrings = props?.localizedStrings ?? { other: "Other", unspecified: "Not specified" };
     this._queryScheduler = new SubscriptionScheduler(props.queryConcurrency ?? DEFAULT_QUERY_CONCURRENCY);
     this._nodesCache = new ChildNodesCache();
     this.queryExecutor = props.queryExecutor;
@@ -228,7 +251,7 @@ export class HierarchyProvider {
   ): Observable<ProcessedHierarchyNode> {
     return preprocessedNodesObservable.pipe(
       sortNodesByLabelOperator,
-      createGroupingOperator(this._metadataProvider, this._valuesFormatter, (gn) => this.onGroupingNodeCreated(gn, props)),
+      createGroupingOperator(this._metadataProvider, this._valuesFormatter, this._localizedStrings, (gn) => this.onGroupingNodeCreated(gn, props)),
     );
   }