@tolgee/core 4.7.0 → 4.7.2

package/src/toolsManager/PluginManager.ts

@@ -0,0 +1,129 @@
+import { Properties } from '../Properties';
+import { Messages } from './Messages';
+import { EventService } from '../services/EventService';
+import { ElementRegistrar } from '../services/ElementRegistrar';
+import { TolgeeConfig } from '../TolgeeConfig';
+import { TranslationService } from '../services/TranslationService';
+import { TranslationData } from '../types/DTOs';
+import { sleep } from '../helpers/sleep';
+
+export class PluginManager {
+  public handshakeSucceed = false;
+
+  constructor(
+    private messages: Messages,
+    private properties: Properties,
+    private eventService: EventService,
+    private elementRegistrar: ElementRegistrar,
+    private translationService: TranslationService
+  ) {}
+
+  run() {
+    try {
+      this.messages.startListening();
+      this.handshake();
+    } catch (e) {
+      // eslint-disable-next-line no-console
+      console.warn(e);
+      // eslint-disable-next-line no-console
+      console.warn(
+        'Can not start communication with browser plugin. Check waning above.'
+      );
+    }
+  }
+
+  stop() {
+    this.messages.stopListening();
+  }
+
+  public readonly takeScreenshot = (
+    translationData: TranslationData
+  ): Promise<string> => {
+    return new Promise((resolve, reject) => {
+      this.translationService
+        .changeTranslations(translationData)
+        .then(async (revertChange) => {
+          try {
+            this.highlightAllByKey(translationData.key);
+            await sleep(100);
+            this.messages.send('TOLGEE_TAKE_SCREENSHOT');
+            const cancel = this.messages.listen(
+              'TOLGEE_SCREENSHOT_TAKEN',
+              (data) => {
+                this.unhighlightAllByKey(translationData.key);
+                resolve(data);
+                revertChange();
+                cancel();
+              }
+            );
+          } catch (e) {
+            revertChange();
+            reject(e);
+          }
+        })
+        .catch((e) => {
+          reject(e);
+        });
+    });
+  };
+
+  private highlightAllByKey(key: string) {
+    this.elementRegistrar
+      .findAllByKey(key)
+      .forEach((el) => el._tolgee.highlight());
+  }
+
+  private unhighlightAllByKey(key: string) {
+    this.elementRegistrar
+      .findAllByKey(key)
+      .forEach((el) => el._tolgee.unhighlight());
+  }
+
+  private readonly handshake = () => {
+    const sharedConfiguration: Partial<Properties> & {
+      config: Partial<TolgeeConfig>;
+      uiPresent: boolean;
+      uiVersion: string | undefined;
+    } = {
+      ...this.properties,
+      config: {
+        ...this.properties.config,
+        //remove properties, which cannot be sent by window.postMessage
+        staticData: undefined,
+        targetElement: undefined,
+        _targetElement: undefined,
+        ui: undefined,
+      } as any as TolgeeConfig,
+      uiPresent: Boolean(this.properties.config.ui),
+      uiVersion: process.env.TOLGEE_UI_VERSION,
+    };
+
+    let timer: NodeJS.Timer = null;
+
+    const ping = () => {
+      this.messages.send('TOLGEE_READY', sharedConfiguration);
+    };
+    const finish = () => {
+      clearInterval(timer);
+    };
+
+    this.messages.listen('TOLGEE_PLUGIN_READY', () => {
+      this.handshakeSucceed = true;
+      this.messages.send('TOLGEE_READY', sharedConfiguration);
+      finish();
+    });
+
+    ping();
+
+    // try ping 5 times as sometimes extension doesn't respond right away
+    let counter = 0;
+    timer = setInterval(() => {
+      if (!this.handshakeSucceed && counter < 5) {
+        ping();
+        counter += 1;
+      } else {
+        finish();
+      }
+    }, 200);
+  };
+}

package/src/types/DTOs.ts

@@ -0,0 +1,25 @@
+import { components } from './apiSchema.generated';
+
+export class TranslationData {
+  constructor(
+    public key: string,
+    public translations: { [key: string]: string },
+    public id?: number
+  ) {}
+}
+
+export type ComplexEditKeyDto = components['schemas']['ComplexEditKeyDto'];
+export type KeyWithDataModel = components['schemas']['KeyWithDataModel'];
+export type CreateKeyDto = components['schemas']['CreateKeyDto'];
+export type SetTranslationsWithKeyDto =
+  components['schemas']['SetTranslationsWithKeyDto'];
+export type SetTranslationsResponseModel =
+  components['schemas']['SetTranslationsResponseModel'];
+export type KeyWithTranslationsModel =
+  components['schemas']['KeyWithTranslationsModel'];
+
+export type UploadedImageModel = components['schemas']['UploadedImageModel'];
+
+export type PagedModelLanguageModel =
+  components['schemas']['PagedModelLanguageModel'];
+export type LanguageModel = components['schemas']['LanguageModel'];