feat: default tags for new keys (#3339)

tolgee · May 30, 2024 · 7d2cac8 · 7d2cac8
1 parent 7ea64c1
commit 7d2cac8
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 18 deletions.
diff --git a/packages/core/src/Controller/Plugins/Plugins.ts b/packages/core/src/Controller/Plugins/Plugins.ts
@@ -187,7 +187,7 @@ export function Plugins(
     addPlugin,
     findPositions: findPositions,
     run() {
-      const { apiKey, apiUrl, projectId, observerOptions } =
+      const { apiKey, apiUrl, projectId, observerOptions, tagNewKeys } =
         getInitialOptions();
       instances.ui = plugins.ui?.({
         apiKey: apiKey!,
@@ -197,6 +197,7 @@ export function Plugins(
         changeTranslation,
         findPositions,
         onPermanentChange: (data) => events.onPermanentChange.emit(data),
+        tagNewKeys,
       });
 
       instances.observer?.run({

diff --git a/packages/core/src/Controller/State/initState.ts b/packages/core/src/Controller/State/initState.ts
@@ -114,6 +114,11 @@ export type TolgeeOptionsInternal = {
    * Define custom fetch function, used for fetching the translations
    */
   fetch: FetchFn;
+
+  /**
+   * Specify tags that will be preselected for non-existant keys.
+   */
+  tagNewKeys?: string[];
 };
 
 export type TolgeeOptions = Partial<

diff --git a/packages/core/src/types/plugin.ts b/packages/core/src/types/plugin.ts
@@ -159,6 +159,7 @@ export type UiProps = {
   findPositions: (key?: string | undefined, ns?: NsFallback) => KeyPosition[];
   changeTranslation: ChangeTranslationInterface;
   onPermanentChange: (props: TranslationDescriptor) => void;
+  tagNewKeys?: string[];
 };
 
 export type UiKeyOption = {

diff --git a/packages/web/src/app/App.tsx b/packages/web/src/app/App.tsx
@@ -25,6 +25,9 @@ export const App = () => {
       <div style={{ pointerEvents: 'none' }}>
         <div>{tolgee.t('app-title')}</div>
       </div>
+      <div>
+        <div>{tolgee.t('new-key')}</div>
+      </div>
     </StyledContainer>
   );
 };
diff --git a/packages/web/src/app/basicTolgee.ts b/packages/web/src/app/basicTolgee.ts
@@ -14,6 +14,7 @@ export const tolgee = Tolgee()
     ...secrets,
     availableLanguages: ['en', 'cs', 'fr', 'de'],
     defaultLanguage: 'en',
+    tagNewKeys: ['draft'],
   });
 
 export const useTolgee = (events?: TolgeeEvent[]): TolgeeInstance => {

diff --git a/packages/web/src/package/ui/KeyDialog/dialogContext/index.ts b/packages/web/src/package/ui/KeyDialog/dialogContext/index.ts
@@ -176,7 +176,11 @@ export const [DialogProvider, useDialogActions, useDialogContext] =
             setPluralArgName(firstKey?.keyPluralArgName);
           }
           _setTranslationsForm(result);
-          setTags(firstKey?.keyTags?.map((t) => t.name) || []);
+          if (firstKey) {
+            setTags(firstKey?.keyTags?.map((t) => t.name) || []);
+          } else {
+            setTags(props.uiProps.tagNewKeys ?? []);
+          }
           setScreenshots(
             firstKey?.screenshots?.map((sc) => ({
               ...sc,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/testapps/next-app/package.json b/testapps/next-app/package.json
@@ -15,7 +15,7 @@
     "@tolgee/react": "5.26.0",
     "@tolgee/web": "5.26.0",
     "next": "14.1.4",
-    "next-intl": "^3.2.3",
+    "next-intl": "3.2.3",
     "react": "18.2.0",
     "react-dom": "18.2.0"
   },