@squiz/resource-browser 3.2.3 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 3.3.0
+
+### Minor Changes
+
+-   9e6268d: Allow users to restrict plugin usage
+
 ## 3.2.3
 
 ### Patch Changes

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { ResourceBrowserContext, ResourceBrowserContextProvider } from './ResourceBrowserContext/ResourceBrowserContext';
-import { InlineType, ResourceBrowserUnresolvedResource, ResourceBrowserResource } from './types';
+import { InlineType, ResourceBrowserUnresolvedResource, ResourceBrowserResource, ResourceBrowserPluginType } from './types';
 import { AuthProvider, useAuthContext, AuthContext } from './ResourceBrowserContext/AuthProvider';
 import BrowseToSource from './BrowseToSource/BrowseToSource';
 import SourceDropdown from './SourceDropdown/SourceDropdown';
@@ -10,6 +10,7 @@ export * from './types';
 export type ResourceBrowserProps = {
     modalTitle: string;
     allowedTypes?: string[];
+    allowedPlugins?: ResourceBrowserPluginType[];
     isDisabled?: boolean;
     value: ResourceBrowserUnresolvedResource | null;
     inline?: boolean;

package/lib/index.js

@@ -48,11 +48,19 @@ const SourceDropdownContainer_1 = __importDefault(require("./SourceDropdownConta
 exports.SourceDropdownContainer = SourceDropdownContainer_1.default;
 __exportStar(require("./types"), exports);
 const ResourceBrowser = (props) => {
-    const { value, inline, inlineType } = props;
+    const { value, inline, inlineType, allowedPlugins } = props;
     const [error, setError] = (0, react_1.useState)(null);
-    const { onRequestSources, searchEnabled, plugins } = (0, react_1.useContext)(ResourceBrowserContext_1.ResourceBrowserContext);
+    const { onRequestSources, searchEnabled, plugins: allPlugins } = (0, react_1.useContext)(ResourceBrowserContext_1.ResourceBrowserContext);
     const [isModalOpen, setIsModalOpen] = (0, react_1.useState)(false);
     const [source, setSource] = (0, react_1.useState)(null);
+    const plugins = (0, react_1.useMemo)(() => {
+        // Allow some usages e.g. plugin specific like MatrixAssetWidget restrict what plugins show
+        if (!allowedPlugins)
+            return allPlugins; // No restrictions, return all
+        return allPlugins.filter((plugin) => {
+            return allowedPlugins.includes(plugin.type); // Restrict based on plugin type
+        });
+    }, [allowedPlugins, allPlugins]);
     const [mode, setMode] = (0, react_1.useState)(null);
     const { data: sources, isLoading, error: sourcesError, reload: reloadSources } = (0, useSources_1.useSources)({ onRequestSources, plugins });
     const plugin = source?.plugin || null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@squiz/resource-browser",
-    "version": "3.2.3",
+    "version": "3.3.0",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
     "private": false,

package/src/index.spec.tsx

@@ -10,6 +10,9 @@ jest.spyOn(RBI, 'ResourceBrowserInput');
 
 import * as Plugin from './Plugin/Plugin';
 
+import * as useSources from './Hooks/useSources';
+jest.spyOn(useSources, 'useSources');
+
 var useSourceReloadMock = jest.fn();
 jest.mock('./Hooks/useSources', () => {
     const actual = jest.requireActual('./Hooks/useSources');
@@ -57,12 +60,14 @@ describe('Resource browser input', () => {
         renderResourceLauncher: jest.fn(),
     } as ResourceBrowserPlugin;
 
+    const plugins = [mockMatrixPlugin, mockDamPlugin];
+
     const renderComponent = (props: Partial<ResourceBrowserProps> = {}, searchEnabled?: boolean) => {
         return renderWithContext(
             <ResourceBrowser modalTitle="Asset picker" value={null} onChange={mockChange} onClear={mockOnClear} {...props} />,
             {
                 onRequestSources: mockRequestSources,
-                plugins: [mockMatrixPlugin, mockDamPlugin],
+                plugins,
                 searchEnabled: !!searchEnabled,
             },
         );
@@ -76,6 +81,32 @@ describe('Resource browser input', () => {
         };
     };
 
+    it('allowedPlugins will restrict which plugins are used', async () => {
+        // Works as expected with no restriction
+        (useSources.useSources as jest.Mock).mockClear();
+        renderComponent();
+        let expectedPlugins = plugins;
+        await waitFor(() => {
+            expect(useSources.useSources).toHaveBeenLastCalledWith(
+                expect.objectContaining({
+                    plugins: expectedPlugins,
+                }),
+            );
+        });
+
+        // Works as expected with restrictions
+        (useSources.useSources as jest.Mock).mockClear();
+        renderComponent({ allowedPlugins: ['matrix'] });
+        expectedPlugins = plugins.filter((plugin) => plugin.type === 'matrix');
+        await waitFor(() => {
+            expect(useSources.useSources).toHaveBeenLastCalledWith(
+                expect.objectContaining({
+                    plugins: expectedPlugins,
+                }),
+            );
+        });
+    });
+
     it('If only one valid source is provided will default to its Source and Plugin', async () => {
         const source = mockSource({ type: 'dam' });
         mockRequestSources.mockResolvedValueOnce([source]);

package/src/index.stories.tsx

@@ -86,6 +86,13 @@ SingleSource.args = {
     singleSource: true,
 };
 
+export const RestrictedSource = Template.bind({});
+RestrictedSource.args = {
+    ...Primary.args,
+    allowedPlugins: ['matrix'],
+    searchEnabled: true,
+};
+
 export const SearchEnabled = Template.bind({});
 SearchEnabled.args = {
     ...Primary.args,

package/src/index.tsx

@@ -1,4 +1,4 @@
-import React, { useState, useContext, useEffect, useCallback } from 'react';
+import React, { useState, useContext, useEffect, useCallback, useMemo } from 'react';
 
 import { ResourceBrowserContext, ResourceBrowserContextProvider } from './ResourceBrowserContext/ResourceBrowserContext';
 import {
@@ -7,6 +7,7 @@ import {
     ResourceBrowserUnresolvedResource,
     ResourceBrowserResource,
     ResourceBrowserSourceWithPlugin,
+    ResourceBrowserPluginType,
 } from './types';
 import { useSources } from './Hooks/useSources';
 import { PluginRender } from './Plugin/Plugin';
@@ -31,6 +32,7 @@ export * from './types';
 export type ResourceBrowserProps = {
     modalTitle: string;
     allowedTypes?: string[];
+    allowedPlugins?: ResourceBrowserPluginType[];
     isDisabled?: boolean;
     value: ResourceBrowserUnresolvedResource | null;
     inline?: boolean; // Will render open button only, no input / showing of existing selection
@@ -40,12 +42,19 @@ export type ResourceBrowserProps = {
 };
 
 export const ResourceBrowser = (props: ResourceBrowserProps) => {
-    const { value, inline, inlineType } = props;
+    const { value, inline, inlineType, allowedPlugins } = props;
     const [error, setError] = useState<Error | null>(null);
-    const { onRequestSources, searchEnabled, plugins } = useContext(ResourceBrowserContext);
+    const { onRequestSources, searchEnabled, plugins: allPlugins } = useContext(ResourceBrowserContext);
 
     const [isModalOpen, setIsModalOpen] = useState<boolean>(false);
     const [source, setSource] = useState<ResourceBrowserSourceWithPlugin | null>(null);
+    const plugins = useMemo(() => {
+        // Allow some usages e.g. plugin specific like MatrixAssetWidget restrict what plugins show
+        if (!allowedPlugins) return allPlugins; // No restrictions, return all
+        return allPlugins.filter((plugin) => {
+            return allowedPlugins.includes(plugin.type); // Restrict based on plugin type
+        });
+    }, [allowedPlugins, allPlugins]);
     const [mode, setMode] = useState<PluginLaunchMode | null>(null);
     const { data: sources, isLoading, error: sourcesError, reload: reloadSources } = useSources({ onRequestSources, plugins });
     const plugin = source?.plugin || null;