@tolgee/core 5.4.4 → 5.6.0-prerelease.b5ab209e.0

package/lib/types/plugin.d.ts

@@ -37,6 +37,7 @@ export declare type WrapperAttributeXPathGetter = (props: {
     attribute: string;
 }) => string;
 export declare type HighlightInterface = (key?: string, ns?: NsFallback) => Highlighter;
+export declare type FindPositionsInterface = (key?: string, ns?: NsFallback) => KeyPosition[];
 export declare type ObserverRunProps = {
     mouseHighlight: boolean;
     options: ObserverOptionsInternal;
@@ -51,6 +52,7 @@ export declare type ObserverMiddleware = () => {
     run: (props: ObserverRunProps) => void;
     highlight: HighlightInterface;
     outputNotFormattable: boolean;
+    findPositions: FindPositionsInterface;
 };
 export declare type LanguageDetectorProps = {
     availableLanguages: string[];
@@ -91,11 +93,22 @@ export declare type Highlighter = {
 export declare type FinalFormatterMiddleware = {
     format: (props: FormatterMiddlewareFormatParams) => any;
 };
+export declare type KeyPosition = {
+    position: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    keyName: string;
+    keyNamespace: string;
+};
 export declare type UiProps = {
     apiUrl: string;
     apiKey: string;
     projectId: number | string | undefined;
     highlight: HighlightInterface;
+    findPositions: (key?: string | undefined, ns?: NsFallback) => KeyPosition[];
     changeTranslation: ChangeTranslationInterface;
 };
 export declare type UiKeyOption = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolgee/core",
-  "version": "5.4.4",
+  "version": "5.6.0-prerelease.b5ab209e.0",
   "description": "Library providing ability to translate messages directly in context of developed application.",
   "main": "./dist/tolgee.cjs.js",
   "module": "./dist/tolgee.esm.js",
@@ -67,5 +67,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "de1a0c320f5a712c5bfa3ecceb086dc3d2b1d057"
+  "gitHead": "bfb41a3dc1c220d02a17a485e7f062d4e2a19dca"
 }

package/src/Controller/Plugins/Plugins.ts

@@ -21,6 +21,7 @@ import {
   TolgeeInstance,
   TolgeeOptionsInternal,
   FormatErrorHandler,
+  FindPositionsInterface,
 } from '../../types';
 import { DEFAULT_FORMAT_ERROR } from '../State/initState';
 
@@ -73,6 +74,10 @@ export const Plugins = (
     return instances.observer?.highlight?.(key, ns) || { unhighlight() {} };
   };
 
+  const findPositions: FindPositionsInterface = (key, ns) => {
+    return instances.observer?.findPositions(key, ns) || [];
+  };
+
   const translate = (props: TranslatePropsInternal) => {
     const translation = getTranslation({
       key: props.key,
@@ -178,6 +183,7 @@ export const Plugins = (
       projectId,
       highlight,
       changeTranslation,
+      findPositions,
     });
 
     instances.observer?.run({

package/src/__test/plugins.test.ts

@@ -31,6 +31,7 @@ const testObserver =
       stop,
       retranslate,
       highlight: () => ({ unhighlight: () => {} }),
+      findPositions: () => [],
       outputNotFormattable,
     });
   };

package/src/types/plugin.ts

@@ -57,6 +57,10 @@ export type WrapperAttributeXPathGetter = (props: {
 }) => string;
 
 export type HighlightInterface = (key?: string, ns?: NsFallback) => Highlighter;
+export type FindPositionsInterface = (
+  key?: string,
+  ns?: NsFallback
+) => KeyPosition[];
 
 export type ObserverRunProps = {
   mouseHighlight: boolean;
@@ -73,6 +77,7 @@ export type ObserverMiddleware = () => {
   run: (props: ObserverRunProps) => void;
   highlight: HighlightInterface;
   outputNotFormattable: boolean;
+  findPositions: FindPositionsInterface;
 };
 
 export type LanguageDetectorProps = {
@@ -127,11 +132,23 @@ export type FinalFormatterMiddleware = {
   format: (props: FormatterMiddlewareFormatParams) => any;
 };
 
+export type KeyPosition = {
+  position: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  };
+  keyName: string;
+  keyNamespace: string;
+};
+
 export type UiProps = {
   apiUrl: string;
   apiKey: string;
   projectId: number | string | undefined;
   highlight: HighlightInterface;
+  findPositions: (key?: string | undefined, ns?: NsFallback) => KeyPosition[];
   changeTranslation: ChangeTranslationInterface;
 };