@itwin/presentation-shared 2.0.0-alpha.9 → 2.0.0

package/lib/{cjs/shared → shared}/InstanceLabelSelectClauseFactory.d.ts

@@ -1,11 +1,11 @@
 import type { ConcatenatedValue } from "./ConcatenatedValue.js";
 import type { TypedValueSelectClauseProps } from "./ecsql-snippets/ECSqlValueSelectorSnippets.js";
-import type { EC, ECClassHierarchyInspector } from "./Metadata.js";
+import type { EC } from "./Metadata.js";
 /**
  * Props for `IInstanceLabelSelectClauseFactory.createSelectClause`.
  * @public
  */
-interface CreateInstanceLabelSelectClauseProps {
+export interface CreateInstanceLabelSelectClauseProps {
     /**
      * Alias of an ECSQL class referring to the target instance whose label should be selected.
      *
@@ -26,7 +26,7 @@ interface CreateInstanceLabelSelectClauseProps {
      * implementations may be able to create a more efficient select clause (e.g. drop some pieces of clause
      * that don't apply for given class).
      */
-    className?: EC.FullClassName;
+    className?: EC.FullClassNameDotNotation;
     /**
      * An optional function for concatenating multiple `TypedValueSelectClauseProps`. Selectors' concatenation
      * is used when a label consists of multiple pieces, e.g.:
@@ -70,64 +70,4 @@ export interface IInstanceLabelSelectClauseFactory {
  * @public
  */
 export declare function parseInstanceLabel(value: string | undefined): ConcatenatedValue | string;
-/**
- * Creates a label select clause in a format `Class label [base36(briefcase id)-base36(local id)]`, where
- * local and briefcase IDs are calculated based on ECInstance ID:
- * - `{briefcase id} = ECInstanceId >> 40`
- * - `{local id} = ECInstanceId & (1 << 40 - 1)`
- *
- * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
- * @public
- */
-export declare function createDefaultInstanceLabelSelectClauseFactory(): IInstanceLabelSelectClauseFactory;
-/**
- * An association of a class and an instance label select clause factory method.
- * @public
- */
-interface ClassBasedLabelSelectClause {
-    /** Full class name */
-    className: EC.FullClassName;
-    /** A factory method to create an instance label select clause */
-    clause: (props: CreateInstanceLabelSelectClauseProps) => Promise<string>;
-}
-/**
- * Props for `createClassBasedInstanceLabelSelectClauseFactory`.
- * @public
- */
-interface ClassBasedInstanceLabelSelectClauseFactoryProps {
-    /** Access to ECClass hierarchy in the iModel. */
-    classHierarchyInspector: ECClassHierarchyInspector;
-    /**
-     * A prioritized list of instance label selectors associated to classes they should be applied to.
-     *
-     * Because the list may contain clauses for classes in the same class hierarchy, and the factory
-     * handles them in given order, the order of clauses should be from the most specific class to the
-     * most general one.
-     */
-    clauses: ClassBasedLabelSelectClause[];
-    /**
-     * A fallback label clause factory for when class-based factory doesn't produce a label.
-     * Defaults to the result of `createDefaultInstanceLabelSelectClauseFactory`.
-     */
-    defaultClauseFactory?: IInstanceLabelSelectClauseFactory;
-}
-/**
- * Creates an instance label select clause based on its class.
- * @public
- */
-export declare function createClassBasedInstanceLabelSelectClauseFactory(props: ClassBasedInstanceLabelSelectClauseFactoryProps): IInstanceLabelSelectClauseFactory;
-/**
- * Props for `createBisInstanceLabelSelectClauseFactory`.
- * @public
- */
-interface BisInstanceLabelSelectClauseFactoryProps {
-    classHierarchyInspector: ECClassHierarchyInspector;
-}
-/**
- * Creates a label select clause according to BIS instance label rules.
- * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
- * @public
- */
-export declare function createBisInstanceLabelSelectClauseFactory(props: BisInstanceLabelSelectClauseFactoryProps): IInstanceLabelSelectClauseFactory;
-export {};
 //# sourceMappingURL=InstanceLabelSelectClauseFactory.d.ts.map

package/lib/shared/InstanceLabelSelectClauseFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceLabelSelectClauseFactory.d.ts","sourceRoot":"","sources":["../../src/shared/InstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,oCAAoC;IACnD;;;;;;;;;;OAUG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,wBAAwB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;CACtG;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAChD,qDAAqD;IACrD,kBAAkB,CAAC,KAAK,EAAE,oCAAoC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAClF;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,iBAAiB,GAAG,MAAM,CAaxF"}

package/lib/shared/InstanceLabelSelectClauseFactory.js

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * Parses an instance label from query result into a string or a `ConcatenatedValue`. The latter type of result
+ * is expected when label selector is created using `IInstanceLabelSelectClauseFactory.createSelectClause` with
+ * `createConcatenatedValueJsonSelector`.
+ *
+ * @public
+ */
+export function parseInstanceLabel(value) {
+    if (!value) {
+        return "";
+    }
+    if ((value.startsWith("[") && value.endsWith("]")) || (value.startsWith("{") && value.endsWith("}"))) {
+        try {
+            return JSON.parse(value);
+        }
+        catch {
+            // fall through
+        }
+    }
+    // not a JSON object/array
+    return value;
+}
+//# sourceMappingURL=InstanceLabelSelectClauseFactory.js.map

package/lib/shared/InstanceLabelSelectClauseFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceLabelSelectClauseFactory.js","sourceRoot":"","sources":["../../src/shared/InstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAuEhG;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAyB;IAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACrG,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,eAAe;QACjB,CAAC;IACH,CAAC;IACD,0BAA0B;IAC1B,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/shared/Logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.d.ts","sourceRoot":"","sources":["../../src/shared/Logging.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;IAC1D,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,WAAW,CAAC;IACxB,OAAO,EAAE,WAAW,CAAC;IACrB,QAAQ,EAAE,WAAW,CAAC;CACvB;AAED;;;GAGG;AAEH,eAAO,MAAM,WAAW,EAAE,OAMzB,CAAC"}

package/lib/{esm/shared → shared}/Logging.js

@@ -6,7 +6,7 @@
  * A logger implementation that does nothing.
  * @public
  */
-/* c8 ignore next 7 */
+/* v8 ignore start */
 export const NOOP_LOGGER = {
     isEnabled: () => false,
     logError: () => { },
@@ -14,4 +14,5 @@ export const NOOP_LOGGER = {
     logInfo: () => { },
     logTrace: () => { },
 };
+/* v8 ignore stop */
 //# sourceMappingURL=Logging.js.map

package/lib/shared/Logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.js","sourceRoot":"","sources":["../../src/shared/Logging.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AA0BhG;;;GAGG;AACH,qBAAqB;AACrB,MAAM,CAAC,MAAM,WAAW,GAAY;IAClC,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK;IACtB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;IAClB,UAAU,EAAE,GAAG,EAAE,GAAE,CAAC;IACpB,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC;IACjB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;CACnB,CAAC;AACF,oBAAoB"}

package/lib/shared/MappedTypes.d.ts

@@ -0,0 +1,55 @@
+/**
+ * An utility `Omit` type which works with union types.
+ * @public
+ */
+export type OmitOverUnion<T, K extends PropertyKey> = T extends T ? Omit<T, K> : never;
+/**
+ * An utility generic type to get array element's type.
+ * @public
+ */
+export type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
+/**
+ * Extracts the union of parameter tuples from a function type, including all of its
+ * overload signatures.
+ *
+ * `Parameters` from the standard library only ever reflects the last overload signature,
+ * so this helper matches against up to four call signatures to recover the full set.
+ * @public
+ */
+type OverloadParameters<TFunc> = TFunc extends {
+    (...args: infer A1): any;
+    (...args: infer A2): any;
+    (...args: infer A3): any;
+    (...args: infer A4): any;
+} ? A1 | A2 | A3 | A4 : TFunc extends {
+    (...args: infer A1): any;
+    (...args: infer A2): any;
+    (...args: infer A3): any;
+} ? A1 | A2 | A3 : TFunc extends {
+    (...args: infer A1): any;
+    (...args: infer A2): any;
+} ? A1 | A2 : TFunc extends (...args: infer A1) => any ? A1 : never;
+/**
+ * Maps a single parameter tuple to the type of its lone object argument, preserving
+ * `undefined` when the argument is optional.
+ * @public
+ */
+type PropsFromParameters<TParams> = TParams extends [infer TProps] ? Exclude<TProps, undefined> extends object ? TProps : never : TParams extends [(infer TProps)?] ? Exclude<TProps, undefined> extends object ? TProps | undefined : never : never;
+/**
+ * Returns type of `TFunc` parameter, when `TFunc` accepts exactly one object argument
+ * that can also be `undefined` / optional.
+ *
+ * When `TFunc` is an overloaded function, the result is a union of the parameter types
+ * across all of its overload signatures.
+ * @public
+ */
+export type Props<TFunc extends (...args: any[]) => any> = PropsFromParameters<OverloadParameters<TFunc>>;
+/**
+ * Recursively marks all properties as readonly with no depth limit.
+ * @public
+ */
+export type DeepReadonly<T> = T extends (...args: any[]) => any ? T : T extends (infer U)[] ? ReadonlyArray<DeepReadonly<U>> : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
+export {};
+//# sourceMappingURL=MappedTypes.d.ts.map

package/lib/shared/MappedTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MappedTypes.d.ts","sourceRoot":"","sources":["../../src/shared/MappedTypes.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;AAEvF;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,IAAI,SAAS,SAAS,SAAS,CAAC,MAAM,WAAW,CAAC,EAAE,GAC7G,WAAW,GACX,KAAK,CAAC;AAEV;;;;;;;GAOG;AACH,KAAK,kBAAkB,CAAC,KAAK,IAAI,KAAK,SAAS;IAC7C,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACzB,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACzB,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACzB,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;CAC1B,GACG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GACjB,KAAK,SAAS;IAAE,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAAC,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAAC,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;CAAE,GAC5F,EAAE,GAAG,EAAE,GAAG,EAAE,GACZ,KAAK,SAAS;IAAE,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAAC,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;CAAE,GAClE,EAAE,GAAG,EAAE,GACP,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,GAAG,GACtC,EAAE,GACF,KAAK,CAAC;AAEhB;;;;GAIG;AACH,KAAK,mBAAmB,CAAC,OAAO,IAAI,OAAO,SAAS,CAAC,MAAM,MAAM,CAAC,GAC9D,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,MAAM,GACvC,MAAM,GACN,KAAK,GACP,OAAO,SAAS,CAAC,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,MAAM,GACvC,MAAM,GAAG,SAAS,GAClB,KAAK,GACP,KAAK,CAAC;AAEZ;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,IAAI,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1G;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAC3D,CAAC,GACD,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAC9B,CAAC,SAAS,MAAM,GACd;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAC/C,CAAC,CAAC"}

package/lib/shared/MappedTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MappedTypes.js","sourceRoot":"","sources":["../../src/shared/MappedTypes.ts"],"names":[],"mappings":"AAAA;;;gGAGgG"}