@akemona-org/strapi-plugin-i18n 3.7.0

package/admin/src/middlewares/localePermissionMiddleware.js

@@ -0,0 +1,39 @@
+import get from 'lodash/get';
+
+const filterPermissionWithLocale = locale => permission =>
+  get(permission, 'properties.locales', []).indexOf(locale) !== -1;
+
+const localePermissionMiddleware = () => () => next => action => {
+  if (action.type !== 'ContentManager/RBACManager/SET_PERMISSIONS') {
+    return next(action);
+  }
+
+  const containerName = get(action, '__meta__.containerName', null);
+
+  if (!['editView', 'listView'].includes(containerName)) {
+    return next(action);
+  }
+
+  const locale = get(action, '__meta__.plugins.i18n.locale', null);
+
+  if (!locale) {
+    return next(action);
+  }
+
+  const permissions = action.permissions;
+
+  const nextPermissions = Object.keys(permissions).reduce((acc, key) => {
+    const currentPermission = permissions[key];
+    const filteredPermissions = currentPermission.filter(filterPermissionWithLocale(locale));
+
+    if (filteredPermissions.length) {
+      acc[key] = filteredPermissions;
+    }
+
+    return acc;
+  }, {});
+
+  return next({ ...action, permissions: nextPermissions });
+};
+
+export default localePermissionMiddleware;

package/admin/src/middlewares/tests/addCommonFieldsToInitialDataMiddleware.test.js

@@ -0,0 +1,97 @@
+import addCommonFieldsToInitialDataMiddleware from '../addCommonFieldsToInitialDataMiddleware';
+
+jest.mock('strapi-helper-plugin', () => ({
+  request: () => ({
+    nonLocalizedFields: { common: 'test' },
+    localizations: ['test'],
+  }),
+  formatComponentData: data => data,
+  contentManagementUtilRemoveFieldsFromData: data => data,
+}));
+
+describe('i18n | middlewares | addCommonFieldsToInitialDataMiddleware', () => {
+  let getState;
+  const dispatch = jest.fn();
+
+  beforeEach(() => {
+    const store = new Map();
+
+    store.set('content-manager_editViewCrudReducer', {
+      contentTypeDataStructure: { name: 'test', common: 'common default value' },
+    });
+    store.set('content-manager_editViewLayoutManager', {
+      currentLayout: {
+        components: {},
+        contentType: {
+          uid: 'article',
+          attributes: {
+            name: { type: 'string' },
+            common: { type: 'string' },
+          },
+        },
+      },
+    });
+
+    getState = () => store;
+  });
+
+  it('should forward the action when the type is undefined', () => {
+    const action = { test: true, type: undefined };
+
+    const next = jest.fn();
+    const middleware = addCommonFieldsToInitialDataMiddleware()({ getState, dispatch });
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should forward the action when the rawQuery is empty', () => {
+    const action = { type: 'ContentManager/CrudReducer/INIT_FORM', rawQuery: '' };
+
+    const next = jest.fn();
+    const middleware = addCommonFieldsToInitialDataMiddleware()({ getState, dispatch });
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should forward the action when the relatedEntityId is not defined', () => {
+    const action = {
+      type: 'ContentManager/CrudReducer/INIT_FORM',
+      rawQuery: '?plugins[i18n][locale]=en',
+    };
+
+    const next = jest.fn();
+    const middleware = addCommonFieldsToInitialDataMiddleware()({ getState, dispatch });
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should makes a request to retrieve the common field when the relatedEntityId is defined', async () => {
+    const action = {
+      type: 'ContentManager/CrudReducer/INIT_FORM',
+      rawQuery: '?plugins[i18n][relatedEntityId]=1',
+    };
+
+    const next = jest.fn(x => x);
+    const middleware = addCommonFieldsToInitialDataMiddleware()({ getState, dispatch });
+
+    const nextAction = await middleware(next)(action);
+
+    expect(dispatch).toHaveBeenCalledWith({ type: 'ContentManager/CrudReducer/GET_DATA' });
+
+    expect(nextAction).toEqual({
+      type: 'ContentManager/CrudReducer/INIT_FORM',
+      rawQuery: '?plugins[i18n][relatedEntityId]=1',
+      data: {
+        name: 'test',
+        localizations: ['test'],
+        common: 'test',
+      },
+    });
+  });
+});

package/admin/src/middlewares/tests/addLocaleColumnToListViewMiddleware.test.js

@@ -0,0 +1,68 @@
+import addLocaleColumnToListViewMiddleware from '../addLocaleColumnToListViewMiddleware';
+
+describe('addLocaleColumnToListViewMiddleware', () => {
+  let getState;
+
+  beforeEach(() => {
+    const store = new Map();
+
+    store.set('i18n_locales', { locales: [] });
+
+    getState = () => store;
+  });
+
+  it('does nothing on unknown actions', () => {
+    const middleware = addLocaleColumnToListViewMiddleware()({ getState });
+    const nextFn = jest.fn();
+    const action = { type: 'UNKNOWN' };
+
+    middleware(nextFn)(action);
+
+    expect(nextFn).toBeCalledWith(action);
+    expect(action).toEqual({
+      type: 'UNKNOWN',
+    });
+  });
+
+  it('does nothing when there s no i18n.localized key in the action', () => {
+    const middleware = addLocaleColumnToListViewMiddleware()({ getState });
+    const nextFn = jest.fn();
+    const action = {
+      type: 'ContentManager/ListView/SET_LIST_LAYOUT ',
+      contentType: { pluginOptions: {} },
+    };
+
+    middleware(nextFn)(action);
+
+    expect(nextFn).toBeCalledWith(action);
+    expect(action).toEqual({
+      contentType: { pluginOptions: {} },
+      type: 'ContentManager/ListView/SET_LIST_LAYOUT ',
+    });
+  });
+
+  it('adds a header to the displayedHeaders array when the content type is localized', () => {
+    const middleware = addLocaleColumnToListViewMiddleware()({ getState });
+    const nextFn = jest.fn();
+    const action = {
+      type: 'ContentManager/ListView/SET_LIST_LAYOUT ',
+      displayedHeaders: [],
+      contentType: {
+        pluginOptions: {
+          i18n: { localized: true },
+        },
+      },
+    };
+
+    middleware(nextFn)(action);
+
+    expect(nextFn).toBeCalledWith(action);
+    // The anonymous function of cellFormatter creates problem, because it's anonymous
+    // In our scenario, it's even more tricky because we use a closure in order to pass
+    // the locales.
+    // Stringifying the action allows us to have a name inside the expectation for the "cellFormatter" key
+    expect(JSON.stringify(action)).toBe(
+      '{"type":"ContentManager/ListView/SET_LIST_LAYOUT ","displayedHeaders":[{"key":"__locale_key__","fieldSchema":{"type":"string"},"metadatas":{"label":"Content available in","searchable":false,"sortable":false},"name":"locales"}],"contentType":{"pluginOptions":{"i18n":{"localized":true}}}}'
+    );
+  });
+});

package/admin/src/middlewares/tests/addLocaleToCollectionTypesMiddleware.test.js

@@ -0,0 +1,200 @@
+import addLocaleToCollectionTypesMiddleware from '../addLocaleToCollectionTypesMiddleware';
+
+describe('i18n | middlewares | addLocaleToCollectionTypesMiddleware', () => {
+  let getState;
+
+  beforeEach(() => {
+    const store = new Map();
+    store.set('i18n_locales', { locales: [] });
+    store.set('permissionsManager', { userPermissions: [] });
+    store.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+
+    getState = () => store;
+  });
+
+  it('should forward the action when the type is undefined', () => {
+    const action = { test: true, type: undefined };
+
+    const next = jest.fn();
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState });
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should forward the action when the type is not StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS', () => {
+    const action = { test: true, type: 'TEST' };
+
+    const next = jest.fn();
+
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState });
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should forward when the authorizedStLinks array is empty', () => {
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [],
+      },
+    };
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should not add the search key to a single type link when i18n is not enabled on the single type', () => {
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [{ destination: 'cm/collectionType/test' }],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: false } } }],
+      },
+    };
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should add a search key with the default locale when the user has the right to read it', () => {
+    const tempStore = new Map();
+    tempStore.set('i18n_locales', { locales: [{ code: 'en', isDefault: true }] });
+    tempStore.set('permissionsManager', { userPermissions: [] });
+    tempStore.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [{ properties: { locales: ['en'] } }],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [{ destination: 'cm/collectionType/test', search: null }],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState: () => tempStore });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    const expected = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [
+          { destination: 'cm/collectionType/test', search: 'plugins[i18n][locale]=en' },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+
+    expect(next).toBeCalledWith(expected);
+  });
+
+  it('should set the isDisplayed key to false when the user does not have the right to read any locale', () => {
+    const tempStore = new Map();
+    tempStore.set('i18n_locales', { locales: [{ code: 'en', isDefault: true }] });
+    tempStore.set('permissionsManager', { userPermissions: [] });
+    tempStore.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [{ properties: { locales: [] } }],
+        },
+      },
+    });
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [
+          { destination: 'cm/collectionType/test', search: 'page=1&pageSize=10' },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState: () => tempStore });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    const expected = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [
+          {
+            destination: 'cm/collectionType/test',
+            isDisplayed: false,
+            search: 'page=1&pageSize=10',
+          },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+
+    expect(next).toBeCalledWith(expected);
+  });
+
+  it('should keep the previous search', () => {
+    const tempStore = new Map();
+    tempStore.set('i18n_locales', { locales: [{ code: 'en', isDefault: true }] });
+    tempStore.set('permissionsManager', { userPermissions: [] });
+    tempStore.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [{ properties: { locales: ['en'] } }],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [
+          { destination: 'cm/collectionType/test', search: 'plugins[plugin][test]=test' },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+    const middleware = addLocaleToCollectionTypesMiddleware()({ getState: () => tempStore });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    const expected = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedCtLinks: [
+          {
+            destination: 'cm/collectionType/test',
+            search: 'plugins[plugin][test]=test&plugins[i18n][locale]=en',
+          },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+
+    expect(next).toBeCalledWith(expected);
+  });
+});

package/admin/src/middlewares/tests/addLocaleToSingleTypesMiddleware.test.js

@@ -0,0 +1,193 @@
+import addLocaleToSingleTypesMiddleware from '../addLocaleToSingleTypesMiddleware';
+
+describe('i18n | middlewares | addLocaleToSingleTypesMiddleware', () => {
+  let getState;
+
+  beforeEach(() => {
+    const store = new Map();
+    store.set('i18n_locales', { locales: [] });
+    store.set('permissionsManager', { userPermissions: [] });
+    store.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+
+    getState = () => store;
+  });
+
+  it('should forward the action when the type is undefined', () => {
+    const action = { test: true, type: undefined };
+
+    const next = jest.fn();
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState });
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should forward the action when the type is not StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS', () => {
+    const action = { test: true, type: 'TEST' };
+
+    const next = jest.fn();
+
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState });
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should forward when the authorizedStLinks array is empty', () => {
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [],
+      },
+    };
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should not add the search key to a single type link when i18n is not enabled on the single type', () => {
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [{ destination: 'cm/singleType/test' }],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: false } } }],
+      },
+    };
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    expect(next).toBeCalledWith(action);
+  });
+
+  it('should add a search key with the default locale when the user has the right to read it', () => {
+    const tempStore = new Map();
+    tempStore.set('i18n_locales', { locales: [{ code: 'en', isDefault: true }] });
+    tempStore.set('permissionsManager', { userPermissions: [] });
+    tempStore.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [{ properties: { locales: ['en'] } }],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [{ destination: 'cm/singleType/test' }],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState: () => tempStore });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    const expected = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [
+          { destination: 'cm/singleType/test', search: 'plugins[i18n][locale]=en' },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+
+    expect(next).toBeCalledWith(expected);
+  });
+
+  it('should set the isDisplayed key to false when the user does not have the right to read any locale', () => {
+    const tempStore = new Map();
+    tempStore.set('i18n_locales', { locales: [{ code: 'en', isDefault: true }] });
+    tempStore.set('permissionsManager', { userPermissions: [] });
+    tempStore.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [{ properties: { locales: [] } }],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [{ destination: 'cm/singleType/test' }],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState: () => tempStore });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    const expected = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [{ destination: 'cm/singleType/test', isDisplayed: false }],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+
+    expect(next).toBeCalledWith(expected);
+  });
+
+  it('should keep the previous search', () => {
+    const tempStore = new Map();
+    tempStore.set('i18n_locales', { locales: [{ code: 'en', isDefault: true }] });
+    tempStore.set('permissionsManager', { userPermissions: [] });
+    tempStore.set('permissionsManager', {
+      collectionTypesRelatedPermissions: {
+        test: {
+          'plugins::content-manager.explorer.read': [{ properties: { locales: ['en'] } }],
+          'plugins::content-manager.explorer.create': [],
+        },
+      },
+    });
+    const action = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [
+          { destination: 'cm/singleType/test', search: 'plugins[plugin][test]=test' },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+    const middleware = addLocaleToSingleTypesMiddleware()({ getState: () => tempStore });
+
+    const next = jest.fn();
+
+    middleware(next)(action);
+
+    const expected = {
+      type: 'StrapiAdmin/LeftMenu/SET_CT_OR_ST_LINKS',
+      data: {
+        authorizedStLinks: [
+          {
+            destination: 'cm/singleType/test',
+            search: 'plugins[plugin][test]=test&plugins[i18n][locale]=en',
+          },
+        ],
+        contentTypeSchemas: [{ uid: 'test', pluginOptions: { i18n: { localized: true } } }],
+      },
+    };
+
+    expect(next).toBeCalledWith(expected);
+  });
+});