feat(): Introduce translation module and preliminary application of them

.eslintignore

@@ -26,6 +26,7 @@ packages/*
 !packages/create-medusa-app
 !packages/modules/product
 !packages/modules/locking
+!packages/modules/translation
 !packages/core/orchestration
 !packages/core/workflows-sdk
 !packages/core/core-flows

.eslintrc.js

@@ -93,56 +93,57 @@ module.exports = {
           "./packages/design-system/toolbox/tsconfig.json",
 
           "./packages/cli/create-medusa-app/tsconfig.json",
-          "./packages/cli/medusa-cli/tsconfig.spec.json",
-          "./packages/cli/oas/medusa-oas-cli/tsconfig.spec.json",
+          "./packages/cli/medusa-cli/tsconfig.json",
+          "./packages/cli/oas/medusa-oas-cli/tsconfig.json",
 
           "./packages/core/orchestration/tsconfig.json",
-          "./packages/core/workflows-sdk/tsconfig.spec.json",
+          "./packages/core/workflows-sdk/tsconfig.json",
           "./packages/core/modules-sdk/tsconfig.json",
           "./packages/core/js-sdk/tsconfig.json",
           "./packages/core/types/tsconfig.json",
-          "./packages/core/utils/tsconfig.spec.json",
+          "./packages/core/utils/tsconfig.json",
           "./packages/core/medusa-test-utils/tsconfig.json",
 
           "./packages/modules/product/tsconfig.json",
-          "./packages/modules/event-bus-local/tsconfig.spec.json",
-          "./packages/modules/event-bus-redis/tsconfig.spec.json",
-          "./packages/modules/cache-redis/tsconfig.spec.json",
-          "./packages/modules/cache-inmemory/tsconfig.spec.json",
-          "./packages/modules/caching/tsconfig.spec.json",
-          "./packages/modules/workflow-engine-redis/tsconfig.spec.json",
-          "./packages/modules/workflow-engine-inmemory/tsconfig.spec.json",
-          "./packages/modules/fulfillment/tsconfig.spec.json",
-          "./packages/modules/api-key/tsconfig.spec.json",
-          "./packages/modules/auth/tsconfig.spec.json",
-          "./packages/modules/cart/tsconfig.spec.json",
-          "./packages/modules/currency/tsconfig.spec.json",
-          "./packages/modules/index/tsconfig.spec.json",
-          "./packages/modules/customer/tsconfig.spec.json",
-          "./packages/modules/file/tsconfig.spec.json",
-          "./packages/modules/inventory-next/tsconfig.spec.json",
-          "./packages/modules/stock-location-next/tsconfig.spec.json",
-          "./packages/modules/order/tsconfig.spec.json",
-          "./packages/modules/payment/tsconfig.spec.json",
-          "./packages/modules/pricing/tsconfig.spec.json",
-          "./packages/modules/promotion/tsconfig.spec.json",
-          "./packages/modules/region/tsconfig.spec.json",
-          "./packages/modules/sales-channel/tsconfig.spec.json",
-          "./packages/modules/store/tsconfig.spec.json",
-          "./packages/modules/tax/tsconfig.spec.json",
-          "./packages/modules/workflow-engine-inmemory/tsconfig.spec.json",
-          "./packages/modules/workflow-engine-redis/tsconfig.spec.json",
-          "./packages/modules/link-modules/tsconfig.spec.json",
-          "./packages/modules/user/tsconfig.spec.json",
-          "./packages/modules/locking/tsconfig.spec.json",
+          "./packages/modules/event-bus-local/tsconfig.json",
+          "./packages/modules/event-bus-redis/tsconfig.json",
+          "./packages/modules/cache-redis/tsconfig.json",
+          "./packages/modules/cache-inmemory/tsconfig.json",
+          "./packages/modules/caching/tsconfig.json",
+          "./packages/modules/workflow-engine-redis/tsconfig.json",
+          "./packages/modules/workflow-engine-inmemory/tsconfig.json",
+          "./packages/modules/fulfillment/tsconfig.json",
+          "./packages/modules/api-key/tsconfig.json",
+          "./packages/modules/auth/tsconfig.json",
+          "./packages/modules/cart/tsconfig.json",
+          "./packages/modules/currency/tsconfig.json",
+          "./packages/modules/index/tsconfig.json",
+          "./packages/modules/customer/tsconfig.json",
+          "./packages/modules/file/tsconfig.json",
+          "./packages/modules/inventory-next/tsconfig.json",
+          "./packages/modules/stock-location-next/tsconfig.json",
+          "./packages/modules/order/tsconfig.json",
+          "./packages/modules/payment/tsconfig.json",
+          "./packages/modules/pricing/tsconfig.json",
+          "./packages/modules/promotion/tsconfig.json",
+          "./packages/modules/region/tsconfig.json",
+          "./packages/modules/sales-channel/tsconfig.json",
+          "./packages/modules/store/tsconfig.json",
+          "./packages/modules/tax/tsconfig.json",
+          "./packages/modules/workflow-engine-inmemory/tsconfig.json",
+          "./packages/modules/workflow-engine-redis/tsconfig.json",
+          "./packages/modules/link-modules/tsconfig.json",
+          "./packages/modules/user/tsconfig.json",
+          "./packages/modules/locking/tsconfig.json",
+          "./packages/modules/translation/tsconfig.json",
 
-          "./packages/modules/providers/file-local/tsconfig.spec.json",
-          "./packages/modules/providers/file-s3/tsconfig.spec.json",
-          "./packages/modules/providers/fulfillment-manual/tsconfig.spec.json",
-          "./packages/modules/providers/payment-stripe/tsconfig.spec.json",
-          "./packages/modules/providers/locking-postgres/tsconfig.spec.json",
-          "./packages/modules/providers/locking-redis/tsconfig.spec.json",
-          "./packages/modules/providers/caching-redis/tsconfig.spec.json",
+          "./packages/modules/providers/file-local/tsconfig.json",
+          "./packages/modules/providers/file-s3/tsconfig.json",
+          "./packages/modules/providers/fulfillment-manual/tsconfig.json",
+          "./packages/modules/providers/payment-stripe/tsconfig.json",
+          "./packages/modules/providers/locking-postgres/tsconfig.json",
+          "./packages/modules/providers/locking-redis/tsconfig.json",
+          "./packages/modules/providers/caching-redis/tsconfig.json",
 
           "./packages/framework/tsconfig.json",
         ],

CONTRIBUTING.md

@@ -5,6 +5,7 @@ Thank you for considering contributing to Medusa! This document will outline how
 If you're contributing to our documentation, make sure to also check out the [contribution guidelines on our documentation website](https://docs.medusajs.com/resources/contribution-guidelines/docs).
 
 ### Important
+
 Our core maintainers prioritize pull requests (PRs) from within our organization. External contributions are regularly triaged, but not at any fixed cadence. It varies depending on how busy the maintainers are. This is applicable to all types of PRs, so we kindly ask for your patience.
 
 If you, as a community contributor, wish to work on more extensive features, please reach out to CODEOWNERS instead of directly submitting a PR with all the changes. This approach saves us both time, especially if the PR is not accepted (which will be the case if it does not align with our roadmap), and helps us effectively review and evaluate your contribution if it is accepted.
@@ -26,11 +27,10 @@ If you, as a community contributor, wish to work on more extensive features, ple
 ## Local development
 
 > Prerequisites:
+>
 > 1. [Forked Medusa repository cloned locally](https://github.com/medusajs/medusa).
 > 2. [A local Medusa application for testing](https://docs.medusajs.com/learn/installation).
 
-
-
 The code snippets in this section assume that your forked Medusa project and the test project are sibling directories, and you optionally setup the starter storefront as part of the installation. For example:
 
 ```
@@ -42,8 +42,7 @@ The code snippets in this section assume that your forked Medusa project and the
 |__ test-project_storefront // (optional) storefront to interact with medusa application
 ```
 
-
-1. Replace the @medusajs/* dependencies and devDependencies in you test project's `package.json` to point to the corresponding local packages in your forked Medusa repository. You will also need to add the medusa packages in the resolutions section of the `package.json`, so that every dependency is resolved locally. For example, assuming your forked Medusa project and the test project are sibling directories:
+1. Replace the @medusajs/\* dependencies and devDependencies in you test project's `package.json` to point to the corresponding local packages in your forked Medusa repository. You will also need to add the medusa packages in the resolutions section of the `package.json`, so that every dependency is resolved locally. For example, assuming your forked Medusa project and the test project are sibling directories:
 
 ```json
 // test project package.json
@@ -117,7 +116,8 @@ The code snippets in this section assume that your forked Medusa project and the
     "@medusajs/draft-order": "file:../medusa/packages/plugins/draft-order",
     "@medusajs/deps": "file:../medusa/packages/deps",
     "@medusajs/caching-redis": "file:../medusa/packages/modules/providers/caching-redis",
-    "@medusajs/caching": "file:../medusa/packages/modules/caching"
+    "@medusajs/caching": "file:../medusa/packages/modules/caching",
+    "@medusajs/translation": "file:../medusa/packages/modules/translation",
 }
 ```
 
@@ -138,6 +138,7 @@ rm -R node_modules && yarn && yarn dev
 ### Branches
 
 There are currently two base branches:
+
 - `develop` - development of Medusa 2.0
 - `v1.x` - development of Medusa v1.x
 
@@ -157,7 +158,7 @@ Strive towards keeping your commits small and isolated - this helps the reviewer
 
 **Base branch**
 
-If you wish to patch v1.x your base branch should be `v1.x`. 
+If you wish to patch v1.x your base branch should be `v1.x`.
 
 If your changes should result in a new version of Medusa, you will need to generate a **changelog**. Follow [this guide](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) on how to generate a changeset.
 
@@ -192,5 +193,6 @@ All PRs should include tests for the changes that are included. We have two type
 ### Release
 
 The Medusa team will regularly create releases from two release branches:
+
 - `develop` - preview releases of Medusa 2.0
 - `v1.x` - official releases of Medusa 1.x

integration-tests/http/package.json

@@ -31,6 +31,7 @@
     "@medusajs/store": "workspace:^",
     "@medusajs/tax": "workspace:^",
     "@medusajs/test-utils": "workspace:*",
+    "@medusajs/translation": "workspace:*",
     "@medusajs/user": "workspace:^",
     "@medusajs/utils": "workspace:^",
     "@medusajs/workflow-engine-inmemory": "workspace:*",

packages/admin/dashboard/src/dashboard-app/routes/get-route.map.tsx

@@ -1009,6 +1009,10 @@ export function getRouteMap({
                   path: "currencies",
                   lazy: () => import("../../routes/store/store-add-currencies"),
                 },
+                {
+                  path: "locales",
+                  lazy: () => import("../../routes/store/store-add-locales"),
+                },
                 {
                   path: "metadata/edit",
                   lazy: () => import("../../routes/store/store-metadata"),

packages/admin/dashboard/src/hooks/api/feature-flags.tsx

@@ -3,20 +3,24 @@ import { sdk } from "../../lib/client"
 
 export type FeatureFlags = {
   view_configurations?: boolean
+  translation?: boolean
   [key: string]: boolean | undefined
 }
 
 export const useFeatureFlags = () => {
   return useQuery<FeatureFlags>({
     queryKey: ["admin", "feature-flags"],
     queryFn: async () => {
-      const response = await sdk.client.fetch<{ feature_flags: FeatureFlags }>("/admin/feature-flags", {
-        method: "GET",
-      })
-
+      const response = await sdk.client.fetch<{ feature_flags: FeatureFlags }>(
+        "/admin/feature-flags",
+        {
+          method: "GET",
+        }
+      )
+
       return response.feature_flags
     },
     staleTime: 5 * 60 * 1000, // Cache for 5 minutes
     cacheTime: 10 * 60 * 1000, // Keep in cache for 10 minutes
   })
-}
+}

packages/admin/dashboard/src/hooks/api/index.ts

@@ -11,6 +11,7 @@ export * from "./fulfillment-providers"
 export * from "./fulfillment-sets"
 export * from "./inventory"
 export * from "./invites"
+export * from "./locales"
 export * from "./notification"
 export * from "./orders"
 export * from "./payment-collections"

packages/admin/dashboard/src/hooks/api/locales.tsx

@@ -0,0 +1,52 @@
+import { FetchError } from "@medusajs/js-sdk"
+import { HttpTypes } from "@medusajs/types"
+import { QueryKey, UseQueryOptions, useQuery } from "@tanstack/react-query"
+
+import { sdk } from "../../lib/client"
+import { queryKeysFactory } from "../../lib/query-key-factory"
+
+const LOCALES_QUERY_KEY = "locales" as const
+const localesQueryKeys = queryKeysFactory(LOCALES_QUERY_KEY)
+
+export const useLocales = (
+  query?: HttpTypes.AdminLocaleListParams,
+  options?: Omit<
+    UseQueryOptions<
+      HttpTypes.AdminLocaleListResponse,
+      FetchError,
+      HttpTypes.AdminLocaleListResponse,
+      QueryKey
+    >,
+    "queryFn" | "queryKey"
+  >
+) => {
+  const { data, ...rest } = useQuery({
+    queryFn: () => sdk.admin.locale.list(query),
+    queryKey: localesQueryKeys.list(query),
+    ...options,
+  })
+
+  return { ...data, ...rest }
+}
+
+export const useLocale = (
+  id: string,
+  query?: HttpTypes.AdminLocaleParams,
+  options?: Omit<
+    UseQueryOptions<
+      HttpTypes.AdminLocaleResponse,
+      FetchError,
+      HttpTypes.AdminLocaleResponse,
+      QueryKey
+    >,
+    "queryFn" | "queryKey"
+  >
+) => {
+  const { data, ...rest } = useQuery({
+    queryKey: localesQueryKeys.detail(id),
+    queryFn: async () => sdk.admin.locale.retrieve(id, query),
+    ...options,
+  })
+
+  return { ...data, ...rest }
+}

packages/admin/dashboard/src/i18n/translations/$schema.json

@@ -9303,6 +9303,9 @@
         "defaultCurrency": {
           "type": "string"
         },
+        "defaultLocale": {
+          "type": "string"
+        },
         "defaultRegion": {
           "type": "string"
         },
@@ -9321,6 +9324,9 @@
         "inviteLinkTemplate": {
           "type": "string"
         },
+        "locales": {
+          "type": "string"
+        },
         "currencies": {
           "type": "string"
         },
@@ -9339,6 +9345,15 @@
         "removeCurrencyWarning_other": {
           "type": "string"
         },
+        "removeLocaleWarning_one": {
+          "type": "string"
+        },
+        "removeLocaleWarning_other": {
+          "type": "string"
+        },
+        "localeAlreadyAdded": {
+          "type": "string"
+        },
         "currencyAlreadyAdded": {
           "type": "string"
         },
@@ -9358,20 +9373,28 @@
             "update": {
               "type": "string"
             },
+            "localesUpdated": {
+              "type": "string"
+            },
             "currenciesUpdated": {
               "type": "string"
             },
             "currenciesRemoved": {
               "type": "string"
             },
+            "localesRemoved": {
+              "type": "string"
+            },
             "updatedTaxInclusivitySuccessfully": {
               "type": "string"
             }
           },
           "required": [
             "update",
+            "localesUpdated",
             "currenciesUpdated",
             "currenciesRemoved",
+            "localesRemoved",
             "updatedTaxInclusivitySuccessfully"
           ],
           "additionalProperties": false
@@ -9382,19 +9405,24 @@
         "manageYourStoresDetails",
         "editStore",
         "defaultCurrency",
+        "defaultLocale",
         "defaultRegion",
         "defaultSalesChannel",
         "defaultLocation",
         "swapLinkTemplate",
         "paymentLinkTemplate",
         "inviteLinkTemplate",
+        "locales",
         "currencies",
         "addCurrencies",
         "enableTaxInclusivePricing",
         "disableTaxInclusivePricing",
         "removeCurrencyWarning_one",
         "removeCurrencyWarning_other",
+        "removeLocaleWarning_one",
+        "removeLocaleWarning_other",
         "currencyAlreadyAdded",
+        "localeAlreadyAdded",
         "edit",
         "toast"
       ],