@akemona-org/strapi-plugin-i18n 3.7.0

package/admin/src/utils/getDefaultLocale.js

@@ -0,0 +1,60 @@
+import get from 'lodash/get';
+
+const hasLocalePermission = (permissions, localeCode) => {
+  if (permissions) {
+    const hasPermission = permissions.some(permission =>
+      get(permission, 'properties.locales', []).includes(localeCode)
+    );
+
+    if (hasPermission) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
+const getFirstLocale = permissions => {
+  if (permissions && permissions.length > 0) {
+    const firstAuthorizedNonDefaultLocale = get(permissions, [0, 'properties', 'locales', 0], null);
+
+    if (firstAuthorizedNonDefaultLocale) {
+      return firstAuthorizedNonDefaultLocale;
+    }
+  }
+
+  return null;
+};
+
+/**
+ * Entry point of the module
+ */
+const getDefaultLocale = (ctPermissions, locales = []) => {
+  const defaultLocale = locales.find(locale => locale.isDefault);
+
+  if (!defaultLocale) {
+    return null;
+  }
+
+  const readPermissions = ctPermissions['plugins::content-manager.explorer.read'];
+  const createPermissions = ctPermissions['plugins::content-manager.explorer.create'];
+
+  if (hasLocalePermission(readPermissions, defaultLocale.code)) {
+    return defaultLocale.code;
+  }
+
+  if (hasLocalePermission(createPermissions, defaultLocale.code)) {
+    return defaultLocale.code;
+  }
+
+  // When the default locale is not authorized, we return the first authorized locale
+  const firstAuthorizedForReadNonDefaultLocale = getFirstLocale(readPermissions);
+
+  if (firstAuthorizedForReadNonDefaultLocale) {
+    return firstAuthorizedForReadNonDefaultLocale;
+  }
+
+  return getFirstLocale(createPermissions);
+};
+
+export default getDefaultLocale;

package/admin/src/utils/getInitialLocale.js

@@ -0,0 +1,14 @@
+import getLocaleFromQuery from './getLocaleFromQuery';
+
+const getInitialLocale = (query, locales = []) => {
+  const localeFromQuery = getLocaleFromQuery(query);
+
+  if (localeFromQuery) {
+    return locales.find(locale => locale.code === localeFromQuery);
+  }
+
+  // Returns the default locale when nothing is in the query
+  return locales.find(locale => locale.isDefault);
+};
+
+export default getInitialLocale;

package/admin/src/utils/getLocaleFromQuery.js

@@ -0,0 +1,7 @@
+import get from 'lodash/get';
+
+const getLocaleFromQuery = query => {
+  return get(query, 'plugins.i18n.locale', undefined);
+};
+
+export default getLocaleFromQuery;

package/admin/src/utils/getTrad.js

@@ -0,0 +1,5 @@
+import pluginId from '../pluginId';
+
+const getTrad = id => `${pluginId}.${id}`;
+
+export default getTrad;

package/admin/src/utils/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/prefer-default-export
+export { default as getTrad } from './getTrad';

package/admin/src/utils/localizedFields.js

@@ -0,0 +1,23 @@
+const LOCALIZED_FIELDS = [
+  'biginteger',
+  'boolean',
+  'component',
+  'date',
+  'datetime',
+  'decimal',
+  'dynamiczone',
+  'email',
+  'enumeration',
+  'float',
+  'integer',
+  'json',
+  'media',
+  'number',
+  'password',
+  'richtext',
+  'string',
+  'text',
+  'time',
+];
+
+export default LOCALIZED_FIELDS;

package/admin/src/utils/mutateCTBContentTypeSchema.js

@@ -0,0 +1,66 @@
+import { has, get, omit } from 'lodash';
+import LOCALIZED_FIELDS from './localizedFields';
+
+const localizedPath = ['pluginOptions', 'i18n', 'localized'];
+
+const addLocalisationToFields = attributes =>
+  Object.keys(attributes).reduce((acc, current) => {
+    const currentAttribute = attributes[current];
+
+    if (LOCALIZED_FIELDS.includes(currentAttribute.type)) {
+      const i18n = { localized: true };
+
+      const pluginOptions = currentAttribute.pluginOptions
+        ? { ...currentAttribute.pluginOptions, i18n }
+        : { i18n };
+
+      acc[current] = { ...currentAttribute, pluginOptions };
+
+      return acc;
+    }
+
+    acc[current] = currentAttribute;
+
+    return acc;
+  }, {});
+
+const disableAttributesLocalisation = attributes =>
+  Object.keys(attributes).reduce((acc, current) => {
+    acc[current] = omit(attributes[current], 'pluginOptions.i18n');
+
+    return acc;
+  }, {});
+
+const mutateCTBContentTypeSchema = (nextSchema, prevSchema) => {
+  // Don't perform mutations components
+  if (!has(nextSchema, localizedPath)) {
+    return nextSchema;
+  }
+
+  const isNextSchemaLocalized = get(nextSchema, localizedPath, false);
+  const isPrevSchemaLocalized = get(prevSchema, ['schema', ...localizedPath], false);
+
+  // No need to perform modification on the schema, if the i18n feature was not changed
+  // at the ct level
+  if (isNextSchemaLocalized && isPrevSchemaLocalized) {
+    return nextSchema;
+  }
+
+  if (isNextSchemaLocalized) {
+    const attributes = addLocalisationToFields(nextSchema.attributes);
+
+    return { ...nextSchema, attributes };
+  }
+
+  // Remove the i18n object from the pluginOptions
+  if (!isNextSchemaLocalized) {
+    const pluginOptions = omit(nextSchema.pluginOptions, 'i18n');
+    const attributes = disableAttributesLocalisation(nextSchema.attributes);
+
+    return { ...nextSchema, pluginOptions, attributes };
+  }
+
+  return nextSchema;
+};
+export default mutateCTBContentTypeSchema;
+export { addLocalisationToFields, disableAttributesLocalisation };

package/admin/src/utils/tests/getDefaultLocale.test.js

@@ -0,0 +1,337 @@
+import getDefaultLocale from '../getDefaultLocale';
+
+describe('getDefaultLocale', () => {
+  it('gives fr-FR when it s the default locale and that it has read access to it', () => {
+    const locales = [
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: false,
+      },
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: true,
+      },
+    ];
+
+    const ctPermissions = {
+      'plugins::content-manager.explorer.create': [
+        {
+          id: 1325,
+          action: 'plugins::content-manager.explorer.create',
+          subject: 'application::address.address',
+          properties: {
+            fields: [
+              'postal_coder',
+              'categories',
+              'cover',
+              'images',
+              'city',
+              'likes',
+              'json',
+              'slug',
+            ],
+            locales: [],
+          },
+          conditions: [],
+        },
+      ],
+      'plugins::content-manager.explorer.read': [
+        {
+          id: 1326,
+          action: 'plugins::content-manager.explorer.read',
+          subject: 'application::address.address',
+          properties: {
+            fields: [],
+            locales: ['en', 'fr-FR'],
+          },
+          conditions: [],
+        },
+      ],
+    };
+
+    const expected = 'fr-FR';
+    const actual = getDefaultLocale(ctPermissions, locales);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('gives fr-FR when it s the default locale and that it has create access to it', () => {
+    const locales = [
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: false,
+      },
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: true,
+      },
+    ];
+
+    const ctPermissions = {
+      'plugins::content-manager.explorer.create': [
+        {
+          id: 1325,
+          action: 'plugins::content-manager.explorer.create',
+          subject: 'application::address.address',
+          properties: {
+            fields: [
+              'postal_coder',
+              'categories',
+              'cover',
+              'images',
+              'city',
+              'likes',
+              'json',
+              'slug',
+            ],
+            locales: ['fr-FR'],
+          },
+          conditions: [],
+        },
+      ],
+      'plugins::content-manager.explorer.read': [
+        {
+          id: 1326,
+          action: 'plugins::content-manager.explorer.read',
+          subject: 'application::address.address',
+          properties: {
+            fields: [],
+            locales: ['en'],
+          },
+          conditions: [],
+        },
+      ],
+    };
+
+    const expected = 'fr-FR';
+    const actual = getDefaultLocale(ctPermissions, locales);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('gives gives the first locale with read permission ("en") when the locale is allowed', () => {
+    const locales = [
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: false,
+      },
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: true,
+      },
+      {
+        id: 3,
+        name: 'Another lang',
+        code: 'de',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: false,
+      },
+    ];
+
+    const ctPermissions = {
+      'plugins::content-manager.explorer.create': [
+        {
+          id: 1325,
+          action: 'plugins::content-manager.explorer.create',
+          subject: 'application::address.address',
+          properties: {
+            fields: [
+              'postal_coder',
+              'categories',
+              'cover',
+              'images',
+              'city',
+              'likes',
+              'json',
+              'slug',
+            ],
+            locales: [],
+          },
+          conditions: [],
+        },
+      ],
+      'plugins::content-manager.explorer.read': [
+        {
+          id: 1326,
+          action: 'plugins::content-manager.explorer.read',
+          subject: 'application::address.address',
+          properties: {
+            fields: [],
+            locales: ['en', 'de'],
+          },
+          conditions: [],
+        },
+      ],
+    };
+
+    const expected = 'en';
+    const actual = getDefaultLocale(ctPermissions, locales);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('gives gives the first locale with create permission ("en") when the locale is allowed', () => {
+    const locales = [
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: false,
+      },
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: true,
+      },
+      {
+        id: 3,
+        name: 'Another lang',
+        code: 'de',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: false,
+      },
+    ];
+
+    const ctPermissions = {
+      'plugins::content-manager.explorer.create': [
+        {
+          id: 1325,
+          action: 'plugins::content-manager.explorer.create',
+          subject: 'application::address.address',
+          properties: {
+            fields: [
+              'postal_coder',
+              'categories',
+              'cover',
+              'images',
+              'city',
+              'likes',
+              'json',
+              'slug',
+            ],
+            locales: ['en', 'de'],
+          },
+          conditions: [],
+        },
+      ],
+      'plugins::content-manager.explorer.read': [
+        {
+          id: 1326,
+          action: 'plugins::content-manager.explorer.read',
+          subject: 'application::address.address',
+          properties: {
+            fields: [],
+            locales: [],
+          },
+          conditions: [],
+        },
+      ],
+    };
+
+    const expected = 'en';
+    const actual = getDefaultLocale(ctPermissions, locales);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('gives null when the user has no permission on any locale', () => {
+    const locales = [
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: false,
+      },
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: true,
+      },
+      {
+        id: 3,
+        name: 'Another lang',
+        code: 'de',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-17T13:01:03.569Z',
+        isDefault: false,
+      },
+    ];
+
+    const ctPermissions = {
+      'plugins::content-manager.explorer.create': [
+        {
+          id: 1325,
+          action: 'plugins::content-manager.explorer.create',
+          subject: 'application::address.address',
+          properties: {
+            fields: [
+              'postal_coder',
+              'categories',
+              'cover',
+              'images',
+              'city',
+              'likes',
+              'json',
+              'slug',
+            ],
+            locales: [],
+          },
+          conditions: [],
+        },
+      ],
+      'plugins::content-manager.explorer.read': [
+        {
+          id: 1326,
+          action: 'plugins::content-manager.explorer.read',
+          subject: 'application::address.address',
+          properties: {
+            fields: [],
+            locales: [],
+          },
+          conditions: [],
+        },
+      ],
+    };
+
+    const expected = null;
+    const actual = getDefaultLocale(ctPermissions, locales);
+
+    expect(actual).toEqual(expected);
+  });
+});

package/admin/src/utils/tests/getInitialLocale.test.js

@@ -0,0 +1,106 @@
+import getInitialLocale from '../getInitialLocale';
+
+describe('getInitialLocale', () => {
+  it('gives "fr-FR" when the query.plugins.locale is "fr-FR"', () => {
+    const query = {
+      page: '1',
+      pageSize: '10',
+      _sort: 'Name:ASC',
+      plugins: {
+        i18n: { locale: 'fr-FR' },
+      },
+    };
+
+    const locales = [
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: true,
+      },
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-09T15:03:06.996Z',
+        isDefault: false,
+      },
+    ];
+
+    const expected = {
+      id: 2,
+      name: 'French (France) (fr-FR)',
+      code: 'fr-FR',
+      created_at: '2021-03-09T15:03:06.992Z',
+      updated_at: '2021-03-09T15:03:06.996Z',
+      isDefault: false,
+    };
+    const actual = getInitialLocale(query, locales);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('gives the default locale ("en") when there s no locale in the query', () => {
+    const query = {
+      page: '1',
+      pageSize: '10',
+      _sort: 'Name:ASC',
+      plugins: {
+        something: 'great',
+      },
+    };
+
+    const locales = [
+      {
+        id: 2,
+        name: 'French (France) (fr-FR)',
+        code: 'fr-FR',
+        created_at: '2021-03-09T15:03:06.992Z',
+        updated_at: '2021-03-09T15:03:06.996Z',
+        isDefault: false,
+      },
+      {
+        id: 1,
+        name: 'English',
+        code: 'en',
+        created_at: '2021-03-09T14:57:03.016Z',
+        updated_at: '2021-03-09T14:57:03.016Z',
+        isDefault: true,
+      },
+    ];
+
+    const expected = {
+      id: 1,
+      name: 'English',
+      code: 'en',
+      created_at: '2021-03-09T14:57:03.016Z',
+      updated_at: '2021-03-09T14:57:03.016Z',
+      isDefault: true,
+    };
+
+    const actual = getInitialLocale(query, locales);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('gives "undefined" when theres no locale. IMPORTANT: such case should not exist since at least one locale is created on the backend when plug-in i18n', () => {
+    const query = {
+      page: '1',
+      pageSize: '10',
+      _sort: 'Name:ASC',
+      plugins: {
+        something: 'great',
+      },
+    };
+
+    const locales = [];
+
+    const expected = undefined;
+    const actual = getInitialLocale(query, locales);
+
+    expect(actual).toEqual(expected);
+  });
+});