Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Code" badge to code-configured data sources #264

Merged
merged 3 commits into from
Dec 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/data-sources/DataSourceList.scss
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ table.data-source-list {
}
}


.data-source-actions {

button.components-button {
Expand All @@ -67,3 +66,12 @@ table.data-source-list {
}
}

.data-source-badge {
background-color: rgba(56, 88, 233, 0.04);
border-radius: 4px;
display: inline-block;
font-weight: 500;
margin: 0 8px 0 -8px;
padding: 4px 8px;
vertical-align: baseline;
}
43 changes: 3 additions & 40 deletions src/data-sources/DataSourceList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ import {
} from '@wordpress/dataviews/wp';
import { useState } from '@wordpress/element';
import { __, sprintf } from '@wordpress/i18n';
import { chevronRightSmall, info } from '@wordpress/icons';
import { info } from '@wordpress/icons';
import { store as noticesStore, NoticeStoreActions, WPNotice } from '@wordpress/notices';

import { SUPPORTED_SERVICES, SUPPORTED_SERVICES_LABELS } from './constants';
import DataSourceMetaTags from '@/data-sources/DataSourceMetaTags';
import { useDataSources } from '@/data-sources/hooks/useDataSources';
import { DataSourceConfig } from '@/data-sources/types';
import { useSettingsContext } from '@/settings/hooks/useSettingsNav';
Expand Down Expand Up @@ -55,44 +56,6 @@ const DataSourceList = () => {
await fetchDataSources().catch( () => null );
};

const renderDataSourceMeta = ( source: DataSourceConfig ) => {
const tags: { key: string; primaryValue: string; secondaryValue?: string }[] = [];
switch ( source.service ) {
case 'airtable':
tags.push( {
key: 'base',
primaryValue: source.service_config.base?.name,
secondaryValue: source.service_config.tables?.[ 0 ]?.name,
} );
break;
case 'shopify':
tags.push( { key: 'store', primaryValue: source.service_config.store_name } );
break;
case 'google-sheets':
tags.push( {
key: 'spreadsheet',
primaryValue: source.service_config.spreadsheet.name ?? 'Google Sheet',
secondaryValue: source.service_config.sheets[ 0 ]?.name,
} );
break;
}

return tags.filter( Boolean ).map( tag => (
<span key={ tag.key } className="data-source-meta">
{ tag.primaryValue }
{ tag.secondaryValue && (
<>
<Icon
icon={ chevronRightSmall }
style={ { fill: '#949494', verticalAlign: 'middle' } }
/>
{ tag.secondaryValue }
</>
) }
</span>
) );
};

const getServiceLabel = ( service: ( typeof SUPPORTED_SERVICES )[ number ] ) => {
// eslint-disable-next-line security/detect-object-injection
return SUPPORTED_SERVICES_LABELS[ service ] ?? 'HTTP';
Expand Down Expand Up @@ -168,7 +131,7 @@ const DataSourceList = () => {
id: 'meta',
label: __( 'Meta', 'remote-data-blocks' ),
enableGlobalSearch: true,
render: ( { item }: { item: DataSourceConfig } ) => renderDataSourceMeta( item ),
render: ( { item }: { item: DataSourceConfig } ) => <DataSourceMetaTags source={ item } />,
},
];

Expand Down
75 changes: 75 additions & 0 deletions src/data-sources/DataSourceMetaTags.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import { Icon, Tooltip } from '@wordpress/components';
import { __ } from '@wordpress/i18n';
import { chevronRightSmall } from '@wordpress/icons';

import { DataSourceConfig } from '@/data-sources/types';
import './DataSourceList.scss';

interface DataSourceMetaTagsProps {
source: DataSourceConfig;
}

interface DataSourceMetaTag {
key: string;
primaryValue: string;
secondaryValue?: string;
}

const DataSourceDescriptor = ( props: DataSourceMetaTagsProps ) => {
let tag: DataSourceMetaTag | undefined;

switch ( props.source.service ) {
case 'airtable':
tag = {
key: 'base',
primaryValue: props.source.service_config.base?.name,
secondaryValue: props.source.service_config.tables?.[ 0 ]?.name,
};
break;
case 'shopify':
tag = { key: 'store', primaryValue: props.source.service_config.store_name };
break;
case 'google-sheets':
tag = {
key: 'spreadsheet',
primaryValue: props.source.service_config.spreadsheet.name ?? 'Google Sheet',
secondaryValue: props.source.service_config.sheets[ 0 ]?.name,
};
break;
}

if ( ! tag ) {
return null;
}

return (
<span key={ tag.key } className="data-source-meta">
{ tag.primaryValue }
{ tag.secondaryValue && (
<>
<Icon icon={ chevronRightSmall } style={ { fill: '#949494', verticalAlign: 'middle' } } />
{ tag.secondaryValue }
</>
) }
</span>
);
};

const CodeBadge = () => {
return (
<Tooltip text={ __( 'This data source is configured in code.', 'remote-data-blocks' ) }>
<span className="data-source-badge">Code</span>
</Tooltip>
);
};

const DataSourceMetaTags = ( props: DataSourceMetaTagsProps ) => {
return (
<>
{ ! props.source.uuid && <CodeBadge /> }
<DataSourceDescriptor source={ props.source } />
</>
);
};

export default DataSourceMetaTags;
Loading