@squiz/resource-browser 3.2.1 → 3.2.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 3.2.3
+
+### Patch Changes
+
+-   fe57830: fix for refresh token clering by other plugins
+
+## 3.2.2
+
+### Patch Changes
+
+-   168c317: Pass all preselected info to resolvers, dam resolve variant
+-   168c317: Added optional extra fields to pass dam variant information
+
 ## 3.2.1
 
 ### Patch Changes

package/lib/Plugin/Plugin.js

@@ -9,11 +9,10 @@ const ResourceBrowserInput_1 = require("../ResourceBrowserInput/ResourceBrowserI
 const ResourceBrowserInlineButton_1 = require("../ResourceBrowserInlineButton/ResourceBrowserInlineButton");
 const AuthProvider_1 = require("../ResourceBrowserContext/AuthProvider");
 const PluginRender = ({ render, inline, inlineType, ...props }) => {
-    if (render) {
-        return (react_1.default.createElement(AuthProvider_1.AuthProvider, { authConfig: props.source }, inline && inlineType ? (react_1.default.createElement(ResourceBrowserInlineButton_1.ResourceBrowserInlineButton, { inlineType: inlineType, ...props })) : (react_1.default.createElement(ResourceBrowserInput_1.ResourceBrowserInput, { ...props }))));
-    }
-    else {
+    if (!render)
         return react_1.default.createElement(react_1.default.Fragment, null);
-    }
+    const requiresAuth = Boolean(props.source?.configuration?.authUrl);
+    const content = inline && inlineType ? react_1.default.createElement(ResourceBrowserInlineButton_1.ResourceBrowserInlineButton, { inlineType: inlineType, ...props }) : react_1.default.createElement(ResourceBrowserInput_1.ResourceBrowserInput, { ...props });
+    return requiresAuth ? react_1.default.createElement(AuthProvider_1.AuthProvider, { authConfig: props.source }, content) : content;
 };
 exports.PluginRender = PluginRender;

package/lib/ResourceBrowserInlineButton/ResourceBrowserInlineButton.js

@@ -12,7 +12,7 @@ const ImageInline_1 = require("../Icons/ImageInline");
 const LinkInline_1 = require("../Icons/LinkInline");
 const ResourceBrowserInlineButton = ({ inlineType, modalTitle, allowedTypes, onChange, onRetry, value, useResource, isDisabled, plugin, pluginMode, searchEnabled, source, sources, isLoading, error, setSource, isModalOpen, onModalStateChange, }) => {
     // If an error happens loading the resource the inline browser just opens without it as if no preselectedResource is provided
-    const { data: resource, isLoading: isResourceLoading } = useResource(value?.resourceId || null, source);
+    const { data: resource, isLoading: isResourceLoading } = useResource(value || null, source);
     const isImagePicker = inlineType === 'image';
     return (react_1.default.createElement("div", { className: "inline-launch-button" },
         react_1.default.createElement(resource_browser_ui_lib_1.ModalTrigger, { overlayTriggerState: {

package/lib/ResourceBrowserInput/ResourceBrowserInput.d.ts

@@ -5,7 +5,7 @@ export type ResourceBrowserInputProps = {
     allowedTypes?: string[];
     isDisabled?: boolean;
     value: ResourceBrowserUnresolvedResource | null;
-    useResource(referenceId: string | null, source: ResourceBrowserSource | null): useResolveResourceResponse;
+    useResource(reference: ResourceBrowserUnresolvedResource | null, source: ResourceBrowserSource | null): useResolveResourceResponse;
     onChange(resource: ResourceBrowserResource | null): void;
     onClear?(): void;
     plugin: ResourceBrowserPlugin | null;

package/lib/ResourceBrowserInput/ResourceBrowserInput.js

@@ -8,7 +8,7 @@ const react_1 = __importDefault(require("react"));
 const MainContainer_1 = __importDefault(require("../MainContainer/MainContainer"));
 const ResourcePicker_1 = require("../ResourcePicker/ResourcePicker");
 const ResourceBrowserInput = ({ modalTitle, allowedTypes, onChange, value, useResource, isDisabled, onClear, plugin, pluginMode, searchEnabled, source, sources, isLoading, isOtherSourceValue, error, setSource, isModalOpen, onModalStateChange, }) => {
-    const { data: resource, error: resourceError, isLoading: isResourceLoading } = useResource(value?.resourceId || null, source);
+    const { data: resource, error: resourceError, isLoading: isResourceLoading } = useResource(value || null, source);
     const defaultOnClear = () => onChange(null);
     const onClearFunction = onClear ?? defaultOnClear;
     return (react_1.default.createElement(ResourcePicker_1.ResourcePicker, { resource: resource, plugin: plugin, allowedTypes: allowedTypes, error: resourceError || error, isLoading: isResourceLoading || isLoading, isOtherSourceValue: isOtherSourceValue, isDisabled: isDisabled, onClear: onClearFunction, isModalOpen: isModalOpen, onModalStateChange: onModalStateChange }, (onClose, titleProps) => (react_1.default.createElement(MainContainer_1.default, { selectedSource: source, sources: sources, preselectedResource: resource, plugin: plugin, pluginMode: pluginMode, searchEnabled: searchEnabled, title: modalTitle, titleAriaProps: titleProps, allowedTypes: allowedTypes, onSourceSelect: setSource, onClose: onClose, onChange: onChange }))));

package/lib/index.css

@@ -6127,20 +6127,22 @@
 }
 .squiz-rb-scope .image-info:not(.squiz-rb-plugin *) {
   align-items: center;
-  border-top: 1px solid #e0e0e0;
   color: #707070;
   display: flex;
   flex-direction: column;
-  height: calc(50vh - 60px);
-  overflow-y: auto;
 }
 .squiz-rb-scope .image-info__image-container:not(.squiz-rb-plugin *) {
   position: relative;
   width: 250px;
   height: 150px;
-  margin: 1.25rem;
+  min-height: 150px;
+  margin: 1.25rem 0;
   background-color: #ededed;
 }
+.squiz-rb-scope .image-info__divider:not(.squiz-rb-plugin *) {
+  width: 100%;
+  padding: 0 1.25rem;
+}
 .squiz-rb-scope .checkered-bg:not(.squiz-rb-plugin *) {
   --tw-bg-opacity: 1;
   background-color: rgb(255 255 255 / var(--tw-bg-opacity));
@@ -6186,10 +6188,13 @@
   display: flex;
   flex-direction: column;
   margin: 1rem 0;
+  width: 100%;
+  padding: 0 1.25rem;
 }
 .squiz-rb-scope .image-info__details-item:not(.squiz-rb-plugin *) {
   display: flex;
   margin-bottom: 0.5rem;
+  padding-left: 0.25rem;
 }
 .squiz-rb-scope .image-info__details-label:not(.squiz-rb-plugin *) {
   color: #707070;
@@ -6201,7 +6206,8 @@
   color: #3d3d3d;
 }
 .squiz-rb-scope .image-variant__list:not(.squiz-rb-plugin *) {
-  width: 280px;
+  width: 100%;
+  padding: 0 1.25rem;
   margin-bottom: 1rem;
 }
 .squiz-rb-scope .image-variant__item:not(.squiz-rb-plugin *) {
@@ -6257,21 +6263,6 @@
 .squiz-rb-scope .image-info__loading:not(.squiz-rb-plugin *) {
   margin-top: 80px;
 }
-@media (min-width: 768px) {
-  .squiz-rb-scope .image-info:not(.squiz-rb-plugin *) {
-    height: calc(100vh - 60px);
-  }
-}
-@media (min-width: 1024px) {
-  .squiz-rb-scope .image-info:not(.squiz-rb-plugin *) {
-    height: calc(100vh - 14rem);
-    overflow-y: auto;
-  }
-}
-.squiz-rb-scope .divider-container:not(.squiz-rb-plugin *) {
-  padding: 0 1.25rem;
-  width: 100%;
-}
 .squiz-rb-scope .resource-picker:not(.squiz-rb-plugin *) {
   display: grid;
   grid-template-columns: 24px 1fr;

package/lib/types.d.ts

@@ -31,6 +31,7 @@ export type PluginLaunchMode = {
 export type ResourceBrowserUnresolvedResource = {
     sourceId: string;
     resourceId: string;
+    [k: string]: unknown;
 };
 export type ResourceBrowserResource = {
     id: string;
@@ -93,6 +94,6 @@ export interface ResourceBrowserPlugin {
     /** Function to provde the the summary information to show what resource is currently selected */
     renderSelectedResource: (resource: ResourceBrowserResource) => Promise<ResourceBrowserSelectedState>;
     /** Function to resolve a resource and source id into a fully resolved output reference */
-    useResolveResource: (resourceId: string | null, source: ResourceBrowserSource | null) => useResolveResourceResponse;
+    useResolveResource: (resource: ResourceBrowserUnresolvedResource | null, source: ResourceBrowserSource | null) => useResolveResourceResponse;
 }
 export {};

package/package.json

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

package/src/Plugin/Plugin.spec.tsx

@@ -2,10 +2,35 @@ import React from 'react';
 import { render, waitFor } from '@testing-library/react';
 
 import { PluginRender } from './Plugin';
+import { ResourceBrowserPluginType } from '../types';
 import * as RBI from '../ResourceBrowserInput/ResourceBrowserInput';
 import * as RBInlineButton from '../ResourceBrowserInlineButton/ResourceBrowserInlineButton';
+import * as AuthContext from '../ResourceBrowserContext/AuthProvider';
+
 jest.spyOn(RBI, 'ResourceBrowserInput');
 jest.spyOn(RBInlineButton, 'ResourceBrowserInlineButton');
+jest.spyOn(AuthContext, 'AuthProvider');
+
+const baseProps = {
+    type: null,
+    modalTitle: 'Asset picker',
+    value: null,
+    isOtherSourceValue: false,
+    onChange: jest.fn(),
+    onClear: jest.fn(),
+    useResource: () => ({ data: null, error: null, isLoading: false }),
+    plugin: null,
+    pluginMode: null,
+    searchEnabled: false,
+    source: null,
+    sources: [],
+    isLoading: false,
+    error: null,
+    setSource: jest.fn(),
+    isModalOpen: false,
+    onModalStateChange: jest.fn(),
+    onRetry: jest.fn(),
+};
 
 describe('Plugin', () => {
     it('Does not render ResourceBrowserInput if render is false', async () => {
@@ -18,32 +43,7 @@ describe('Plugin', () => {
     });
 
     it('Does render ResourceBrowserInput if render is true', async () => {
-        const props = {
-            type: null,
-            modalTitle: 'Asset picker',
-            value: null,
-            isOtherSourceValue: false,
-            onChange: jest.fn(),
-            onClear: jest.fn(),
-            useResource: () => {
-                return {
-                    data: null,
-                    error: null,
-                    isLoading: false,
-                };
-            },
-            plugin: null,
-            pluginMode: null,
-            searchEnabled: false,
-            source: null,
-            sources: [],
-            isLoading: false,
-            error: null,
-            setSource: () => {},
-            isModalOpen: false,
-            onModalStateChange: () => {},
-            onRetry: () => {},
-        };
+        const props = baseProps;
         render(<PluginRender render={true} inline={false} {...props} />);
 
         await waitFor(() => {
@@ -52,36 +52,31 @@ describe('Plugin', () => {
     });
 
     it('Does render ResourceBrowserInlineButton if inline is true', async () => {
-        const props = {
-            type: null,
-            modalTitle: 'Asset picker',
-            value: null,
-            isOtherSourceValue: false,
-            onChange: jest.fn(),
-            onClear: jest.fn(),
-            useResource: () => {
-                return {
-                    data: null,
-                    error: null,
-                    isLoading: false,
-                };
-            },
-            plugin: null,
-            pluginMode: null,
-            searchEnabled: false,
-            source: null,
-            sources: [],
-            isLoading: false,
-            error: null,
-            setSource: () => {},
-            isModalOpen: false,
-            onModalStateChange: () => {},
-            onRetry: () => {},
-        };
+        const props = baseProps;
         render(<PluginRender render={true} inline={true} inlineType="image" {...props} />);
 
         await waitFor(() => {
             expect(RBInlineButton.ResourceBrowserInlineButton).toHaveBeenCalledWith({ ...props, inlineType: 'image' }, {});
         });
     });
+
+    it('Wraps content in AuthProvider when source requires auth', async () => {
+        const sourceWithAuth = {
+            id: '123',
+            type: 'dam' as ResourceBrowserPluginType,
+            configuration: {
+                authUrl: 'https://example.com/auth',
+                redirectUrl: 'https://example.com/redirect',
+                clientId: 'abc123',
+                scope: 'scope1',
+            },
+        };
+
+        const props = { ...baseProps, source: sourceWithAuth };
+        render(<PluginRender render={true} inline={false} {...props} />);
+
+        await waitFor(() => {
+            expect(AuthContext.AuthProvider).toHaveBeenCalledWith({ authConfig: sourceWithAuth, children: expect.anything() }, {});
+        });
+    });
 });

package/src/Plugin/Plugin.stories.tsx

@@ -0,0 +1,94 @@
+import React from 'react';
+import { StoryFn, Meta } from '@storybook/react';
+import { PluginRender, PluginRenderType } from './Plugin';
+
+export default {
+    title: 'Plugin renderer',
+    component: PluginRender,
+} as Meta<typeof PluginRender>;
+
+const noop = () => {};
+
+const Template: StoryFn<PluginRenderType> = (args) => <PluginRender {...args} />;
+
+export const WithoutAuth = Template.bind({});
+WithoutAuth.args = {
+    render: true,
+    inline: false,
+    type: null,
+    modalTitle: 'Test Plugin (No Auth)',
+    onRetry: noop,
+    useResource: () => ({ data: null, error: null, isLoading: false }),
+    source: {
+        id: 'source-no-auth',
+        type: 'dummy',
+        configuration: {},
+    },
+};
+
+export const WithAuth = Template.bind({});
+WithAuth.args = {
+    render: true,
+    inline: false,
+    type: null,
+    modalTitle: 'Test Plugin (With Auth)',
+    onRetry: noop,
+    useResource: () => ({ data: null, error: null, isLoading: false }),
+    source: {
+        id: 'source-with-auth',
+        type: 'dummy',
+        configuration: {
+            authUrl: 'https://example.com/auth',
+            redirectUrl: 'https://example.com/redirect',
+            clientId: 'client123',
+            scope: 'scope1 scope2',
+        },
+    },
+};
+
+export const InlineWithoutAuth = Template.bind({});
+InlineWithoutAuth.args = {
+    render: true,
+    inline: true,
+    inlineType: 'image',
+    type: null,
+    modalTitle: 'Test Inline Plugin (No Auth)',
+    onRetry: noop,
+    useResource: () => ({ data: null, error: null, isLoading: false }),
+    source: {
+        id: 'inline-source-no-auth',
+        type: 'dummy',
+        configuration: {},
+    },
+};
+
+export const InlineWithAuth = Template.bind({});
+InlineWithAuth.args = {
+    render: true,
+    inline: true,
+    inlineType: 'image',
+    type: null,
+    modalTitle: 'Test Inline Plugin (With Auth)',
+    onRetry: noop,
+    useResource: () => ({ data: null, error: null, isLoading: false }),
+    source: {
+        id: 'inline-source-with-auth',
+        type: 'dummy',
+        configuration: {
+            authUrl: 'https://example.com/auth',
+            redirectUrl: 'https://example.com/redirect',
+            clientId: 'client123',
+            scope: 'scope1 scope2',
+        },
+    },
+};
+
+export const NotRendered = Template.bind({});
+NotRendered.args = {
+    render: false,
+    inline: false,
+    type: null,
+    modalTitle: 'Should Not Render',
+    onRetry: noop,
+    source: null,
+};

package/src/Plugin/Plugin.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import { ResourceBrowserInput, ResourceBrowserInputProps } from '../ResourceBrowserInput/ResourceBrowserInput';
 import { ResourceBrowserInlineButton } from '../ResourceBrowserInlineButton/ResourceBrowserInlineButton';
 import { AuthProvider } from '../ResourceBrowserContext/AuthProvider';
-import { ResourceBrowserPluginType, InlineType } from '../types';
+import { ResourceBrowserPluginType, InlineType, ResourceBrowserSourceWithConfig } from '../types';
 
 /**
  *  This plugin component exsits to deal with React rules of Hooks stupidity.
@@ -19,17 +19,12 @@ export type PluginRenderType = ResourceBrowserInputProps & {
     onRetry: () => void;
 };
 export const PluginRender = ({ render, inline, inlineType, ...props }: PluginRenderType) => {
-    if (render) {
-        return (
-            <AuthProvider authConfig={props.source}>
-                {inline && inlineType ? (
-                    <ResourceBrowserInlineButton inlineType={inlineType} {...props} />
-                ) : (
-                    <ResourceBrowserInput {...props} />
-                )}
-            </AuthProvider>
-        );
-    } else {
-        return <></>;
-    }
+    if (!render) return <></>;
+
+    const requiresAuth = Boolean((props.source as ResourceBrowserSourceWithConfig)?.configuration?.authUrl);
+
+    const content =
+        inline && inlineType ? <ResourceBrowserInlineButton inlineType={inlineType} {...props} /> : <ResourceBrowserInput {...props} />;
+
+    return requiresAuth ? <AuthProvider authConfig={props.source}>{content}</AuthProvider> : content;
 };

package/src/ResourceBrowserInlineButton/ResourceBrowserInlineButton.tsx

@@ -33,7 +33,7 @@ export const ResourceBrowserInlineButton = ({
     onModalStateChange,
 }: ResourceBrowserInlineButtonProps) => {
     // If an error happens loading the resource the inline browser just opens without it as if no preselectedResource is provided
-    const { data: resource, isLoading: isResourceLoading } = useResource(value?.resourceId || null, source);
+    const { data: resource, isLoading: isResourceLoading } = useResource(value || null, source);
 
     const isImagePicker = inlineType === 'image';
 

package/src/ResourceBrowserInput/ResourceBrowserInput.tsx

@@ -16,7 +16,7 @@ export type ResourceBrowserInputProps = {
     allowedTypes?: string[];
     isDisabled?: boolean;
     value: ResourceBrowserUnresolvedResource | null;
-    useResource(referenceId: string | null, source: ResourceBrowserSource | null): useResolveResourceResponse;
+    useResource(reference: ResourceBrowserUnresolvedResource | null, source: ResourceBrowserSource | null): useResolveResourceResponse;
     onChange(resource: ResourceBrowserResource | null): void;
     onClear?(): void;
     plugin: ResourceBrowserPlugin | null;
@@ -52,7 +52,7 @@ export const ResourceBrowserInput = ({
     isModalOpen,
     onModalStateChange,
 }: ResourceBrowserInputProps) => {
-    const { data: resource, error: resourceError, isLoading: isResourceLoading } = useResource(value?.resourceId || null, source);
+    const { data: resource, error: resourceError, isLoading: isResourceLoading } = useResource(value || null, source);
 
     const defaultOnClear = () => onChange(null);
     const onClearFunction = onClear ?? defaultOnClear;

package/src/index.spec.tsx

@@ -222,7 +222,7 @@ describe('Resource browser input', () => {
         });
 
         await waitFor(() => {
-            expect(mockUseResolveResource).toHaveBeenCalledWith(resource.resourceId, calculateExpectedSource(source));
+            expect(mockUseResolveResource).toHaveBeenCalledWith(resource, calculateExpectedSource(source));
         });
     });
 

package/src/types.ts

@@ -43,6 +43,7 @@ export type PluginLaunchMode = {
 export type ResourceBrowserUnresolvedResource = {
     sourceId: string;
     resourceId: string;
+    [k: string]: unknown; // Additional props as needed by the plugin type to resolve the asset
 };
 
 export type ResourceBrowserResource = {
@@ -120,5 +121,8 @@ export interface ResourceBrowserPlugin {
     renderSelectedResource: (resource: ResourceBrowserResource) => Promise<ResourceBrowserSelectedState>;
 
     /** Function to resolve a resource and source id into a fully resolved output reference */
-    useResolveResource: (resourceId: string | null, source: ResourceBrowserSource | null) => useResolveResourceResponse;
+    useResolveResource: (
+        resource: ResourceBrowserUnresolvedResource | null,
+        source: ResourceBrowserSource | null,
+    ) => useResolveResourceResponse;
 }