A full-featured CRM built with React, shadcn/ui, and Supabase.
Simplify config storage by using the Store
François Zaninottoa206c32bd8a1
diff --git a/registry.json b/registry.jsonindex f9ee6d6a..e651ec83 100644--- a/registry.json+++ b/registry.json@@ -155,10 +155,6 @@"path": "src/components/atomic-crm/root/useConfigurationLoader.ts","type": "registry:component"},- {- "path": "src/components/atomic-crm/root/storedConfiguration.ts",- "type": "registry:component"- },{"path": "src/components/atomic-crm/root/iconRegistry.ts","type": "registry:component"diff --git a/src/components/atomic-crm/contacts/ContactPersonalInfo.tsx b/src/components/atomic-crm/contacts/ContactPersonalInfo.tsxindex 99ff82f4..3ce70d91 100644--- a/src/components/atomic-crm/contacts/ContactPersonalInfo.tsx+++ b/src/components/atomic-crm/contacts/ContactPersonalInfo.tsx@@ -6,6 +6,7 @@ import { EmailField } from "@/components/admin/email-field";import { Mail, Phone, Linkedin } from "lucide-react";import type { ReactNode } from "react";import { useConfigurationContext } from "../root/ConfigurationContext";+import { genderIconRegistry } from "../root/iconRegistry";import type { Contact } from "../types";export const ContactPersonalInfo = () => {@@ -59,12 +60,12 @@ export const ContactPersonalInfo = () => {{contactGender.map((genderOption) => {if (record.gender === genderOption.value) {+ const Icon =+ genderIconRegistry[genderOption.icon] ?? genderIconRegistry.User;return (<PersonalInfoRowkey={genderOption.value}- icon={- <genderOption.icon className="w-4 h-4 text-muted-foreground" />- }+ icon={<Icon className="w-4 h-4 text-muted-foreground" />}primary={<div>{genderOption.label}</div>}/>);diff --git a/src/components/atomic-crm/providers/fakerest/dataGenerator/index.ts b/src/components/atomic-crm/providers/fakerest/dataGenerator/index.tsindex 373d36e0..bf04dd17 100644--- a/src/components/atomic-crm/providers/fakerest/dataGenerator/index.ts+++ b/src/components/atomic-crm/providers/fakerest/dataGenerator/index.ts@@ -19,7 +19,12 @@ export default (): Db => {db.deals = generateDeals(db);db.deal_notes = generateDealNotes(db);db.tasks = generateTasks(db);- db.configuration = [{ id: 1, config: {} }];+ db.configuration = [+ {+ id: 1,+ config: {} as Db["configuration"][number]["config"],+ },+ ];finalize(db);return db;diff --git a/src/components/atomic-crm/providers/fakerest/dataGenerator/types.ts b/src/components/atomic-crm/providers/fakerest/dataGenerator/types.tsindex bfa88617..8f018cb1 100644--- a/src/components/atomic-crm/providers/fakerest/dataGenerator/types.ts+++ b/src/components/atomic-crm/providers/fakerest/dataGenerator/types.ts@@ -8,7 +8,7 @@ import type {Tag,Task,} from "../../../types";-import type { StoredConfiguration } from "../../../root/storedConfiguration";+import type { ConfigurationContextValue } from "../../../root/ConfigurationContext";export interface Db {companies: Required<Company>[];@@ -19,5 +19,5 @@ export interface Db {sales: Sale[];tags: Tag[];tasks: Task[];- configuration: Array<{ id: number; config: StoredConfiguration }>;+ configuration: Array<{ id: number; config: ConfigurationContextValue }>;}diff --git a/src/components/atomic-crm/providers/fakerest/dataProvider.ts b/src/components/atomic-crm/providers/fakerest/dataProvider.tsindex 7481208e..cf3e3e7d 100644--- a/src/components/atomic-crm/providers/fakerest/dataProvider.ts+++ b/src/components/atomic-crm/providers/fakerest/dataProvider.ts@@ -17,7 +17,7 @@ import type {SignUpData,Task,} from "../../types";-import type { StoredConfiguration } from "../../root/storedConfiguration";+import type { ConfigurationContextValue } from "../../root/ConfigurationContext";import { getActivityLog } from "../commons/activity";import { getCompanyAvatar } from "../commons/getCompanyAvatar";import { getContactAvatar } from "../commons/getContactAvatar";@@ -225,13 +225,13 @@ const dataProviderWithCustomMethod: CrmDataProvider = {mergeContacts: async (sourceId: Identifier, targetId: Identifier) => {return mergeContacts(sourceId, targetId, baseDataProvider);},- getConfiguration: async (): Promise<StoredConfiguration> => {+ getConfiguration: async (): Promise<ConfigurationContextValue> => {const { data } = await baseDataProvider.getOne("configuration", { id: 1 });- return (data?.config as StoredConfiguration) ?? {};+ return (data?.config as ConfigurationContextValue) ?? {};},updateConfiguration: async (- config: StoredConfiguration,- ): Promise<StoredConfiguration> => {+ config: ConfigurationContextValue,+ ): Promise<ConfigurationContextValue> => {const { data: prev } = await baseDataProvider.getOne("configuration", {id: 1,});diff --git a/src/components/atomic-crm/providers/supabase/dataProvider.ts b/src/components/atomic-crm/providers/supabase/dataProvider.tsindex 1f6e5f63..2a43689b 100644--- a/src/components/atomic-crm/providers/supabase/dataProvider.ts+++ b/src/components/atomic-crm/providers/supabase/dataProvider.ts@@ -15,7 +15,7 @@ import type {SalesFormData,SignUpData,} from "../../types";-import type { StoredConfiguration } from "../../root/storedConfiguration";+import type { ConfigurationContextValue } from "../../root/ConfigurationContext";import { getActivityLog } from "../commons/activity";import { getIsInitialized } from "./authProvider";import { supabase } from "./supabase";@@ -213,19 +213,19 @@ const dataProviderWithCustomMethods = {return data;},- async getConfiguration(): Promise<StoredConfiguration> {+ async getConfiguration(): Promise<ConfigurationContextValue> {const { data } = await baseDataProvider.getOne("configuration", { id: 1 });- return (data?.config as StoredConfiguration) ?? {};+ return (data?.config as ConfigurationContextValue) ?? {};},async updateConfiguration(- config: StoredConfiguration,- ): Promise<StoredConfiguration> {+ config: ConfigurationContextValue,+ ): Promise<ConfigurationContextValue> {const { data } = await baseDataProvider.update("configuration", {id: 1,data: { config },previousData: { id: 1 },});- return data.config as StoredConfiguration;+ return data.config as ConfigurationContextValue;},} satisfies DataProvider;diff --git a/src/components/atomic-crm/root/CRM.tsx b/src/components/atomic-crm/root/CRM.tsxindex 101c21c8..b6bf239a 100644--- a/src/components/atomic-crm/root/CRM.tsx+++ b/src/components/atomic-crm/root/CRM.tsx@@ -32,10 +32,11 @@ import {import sales from "../sales";import { AppConfigPage } from "../settings/AppConfigPage";import { SettingsPage } from "../settings/SettingsPage";-import type { ConfigurationContextValue } from "./ConfigurationContext";-import { ConfigurationProvider } from "./ConfigurationContext";+import {+ CONFIGURATION_STORE_KEY,+ type ConfigurationContextValue,+} from "./ConfigurationContext";import type { CrmDataProvider } from "../providers/types";-import { CONFIGURATION_STORE_KEY } from "./storedConfiguration";import {defaultCompanySectors,defaultContactGender,@@ -71,7 +72,7 @@ export type CRMProps = {** This component sets up and renders the main CRM application using `ra-core`. It provides* default configurations and themes but allows for customization through props. The component- * wraps the application with a `ConfigurationProvider` to provide configuration values via context.+ * seeds the store with any custom prop values for backwards compatibility.** @param {Array<ContactGender>} contactGender - The gender options for contacts used in the application.* @param {string[]} companySectors - The list of company sectors used in the application.@@ -140,6 +141,25 @@ export const CRM = ({img.src = `https://atomic-crm-telemetry.marmelab.com/atomic-crm-telemetry?domain=${window.location.hostname}`;}, [disableTelemetry]);+ // Seed the store with CRM prop values if not already stored+ // (backwards compatibility for prop-based config)+ if (!store.getItem(CONFIGURATION_STORE_KEY)) {+ store.setItem(CONFIGURATION_STORE_KEY, {+ companySectors,+ dealCategories,+ dealPipelineStatuses,+ dealStages,+ noteStatuses,+ taskTypes,+ title,+ darkModeLogo,+ lightModeLogo,+ contactGender,+ googleWorkplaceDomain,+ disableEmailPasswordAuthentication,+ } satisfies ConfigurationContextValue);+ }+const isMobile = useIsMobile();// on login, pre-fetch the configuration to avoid a flickering@@ -151,7 +171,9 @@ export const CRM = ({const result = await authProvider.login(params);try {const config = await dataProvider.getConfiguration();- store.setItem(CONFIGURATION_STORE_KEY, config);+ if (Object.keys(config).length > 0) {+ store.setItem(CONFIGURATION_STORE_KEY, config);+ }} catch {// Non-critical: config will load via useConfigurationLoader}@@ -172,32 +194,16 @@ export const CRM = ({const ResponsiveAdmin = isMobile ? MobileAdmin : DesktopAdmin;return (- <ConfigurationProvider+ <ResponsiveAdmin+ dataProvider={dataProvider}+ authProvider={wrappedAuthProvider}+ i18nProvider={i18nProvider}store={store}- contactGender={contactGender}- companySectors={companySectors}- dealCategories={dealCategories}- dealPipelineStatuses={dealPipelineStatuses}- dealStages={dealStages}- darkModeLogo={darkModeLogo}- lightModeLogo={lightModeLogo}- noteStatuses={noteStatuses}- taskTypes={taskTypes}- title={title}- googleWorkplaceDomain={googleWorkplaceDomain}- disableEmailPasswordAuthentication={disableEmailPasswordAuthentication}- >- <ResponsiveAdmin- dataProvider={dataProvider}- authProvider={wrappedAuthProvider}- i18nProvider={i18nProvider}- store={store}- loginPage={StartPage}- requireAuth- disableTelemetry- {...rest}- />- </ConfigurationProvider>+ loginPage={StartPage}+ requireAuth+ disableTelemetry+ {...rest}+ />);};diff --git a/src/components/atomic-crm/root/ConfigurationContext.tsx b/src/components/atomic-crm/root/ConfigurationContext.tsxindex 083f6fd3..a580e033 100644--- a/src/components/atomic-crm/root/ConfigurationContext.tsx+++ b/src/components/atomic-crm/root/ConfigurationContext.tsx@@ -1,34 +1,9 @@-import {- createContext,- useCallback,- useContext,- useEffect,- useMemo,- useState,- type ReactNode,-} from "react";-import type { Store } from "ra-core";+import { useStore } from "ra-core";import type { ContactGender, DealStage, NoteStatus } from "../types";-import {- defaultCompanySectors,- defaultContactGender,- defaultDarkModeLogo,- defaultDealCategories,- defaultDealPipelineStatuses,- defaultDealStages,- defaultLightModeLogo,- defaultNoteStatuses,- defaultTaskTypes,- defaultTitle,-} from "./defaultConfiguration";-import {- CONFIGURATION_STORE_KEY,- mergeConfiguration,- type StoredConfiguration,-} from "./storedConfiguration";-// Define types for the context value+export const CONFIGURATION_STORE_KEY = "app.configuration";+export interface ConfigurationContextValue {companySectors: string[];dealCategories: string[];@@ -44,76 +19,14 @@ export interface ConfigurationContextValue {disableEmailPasswordAuthentication?: boolean;}-export interface ConfigurationProviderProps extends ConfigurationContextValue {- children: ReactNode;- store: Store;-}--// Create context with default value-// eslint-disable-next-line react-refresh/only-export-components-export const ConfigurationContext = createContext<ConfigurationContextValue>({- companySectors: defaultCompanySectors,- dealCategories: defaultDealCategories,- dealPipelineStatuses: defaultDealPipelineStatuses,- dealStages: defaultDealStages,- noteStatuses: defaultNoteStatuses,- taskTypes: defaultTaskTypes,- title: defaultTitle,- darkModeLogo: defaultDarkModeLogo,- lightModeLogo: defaultLightModeLogo,- contactGender: defaultContactGender,- disableEmailPasswordAuthentication: false,-});--const ConfigurationUpdaterContext = createContext<- (config: StoredConfiguration) => void->(() => {});--export const ConfigurationProvider = ({- children,- store,- ...codeDefaults-}: ConfigurationProviderProps) => {- const [localConfig, setLocalConfig] = useState<StoredConfiguration | null>(- () => store.getItem<StoredConfiguration>(CONFIGURATION_STORE_KEY) ?? null,- );-- // Subscribe to external store changes (e.g. config written during login)- useEffect(() => {- const unsubscribe = store.subscribe(- CONFIGURATION_STORE_KEY,- (value: StoredConfiguration) => {- setLocalConfig(value);- },- );- return unsubscribe;- }, [store]);-- const value = useMemo(- () => mergeConfiguration(codeDefaults, localConfig),- [codeDefaults, localConfig],- );-- const updateLocalConfig = useCallback(- (config: StoredConfiguration) => {- setLocalConfig(config);- store.setItem(CONFIGURATION_STORE_KEY, config);- },- [store],- );+export const useConfigurationContext = () => {+ const [config] = useStore<ConfigurationContextValue>(CONFIGURATION_STORE_KEY);+ return config;+};- return (- <ConfigurationUpdaterContext.Provider value={updateLocalConfig}>- <ConfigurationContext.Provider value={value}>- {children}- </ConfigurationContext.Provider>- </ConfigurationUpdaterContext.Provider>+export const useConfigurationUpdater = () => {+ const [, setConfig] = useStore<ConfigurationContextValue>(+ CONFIGURATION_STORE_KEY,);+ return setConfig;};--// eslint-disable-next-line react-refresh/only-export-components-export const useConfigurationContext = () => useContext(ConfigurationContext);--// eslint-disable-next-line react-refresh/only-export-components-export const useConfigurationUpdater = () =>- useContext(ConfigurationUpdaterContext);diff --git a/src/components/atomic-crm/root/defaultConfiguration.ts b/src/components/atomic-crm/root/defaultConfiguration.tsindex dda6f16a..45bc9255 100644--- a/src/components/atomic-crm/root/defaultConfiguration.ts+++ b/src/components/atomic-crm/root/defaultConfiguration.ts@@ -1,5 +1,3 @@-import { Mars, NonBinary, Venus } from "lucide-react";-export const defaultDarkModeLogo = "./logos/logo_atomic_crm_dark.svg";export const defaultLightModeLogo = "./logos/logo_atomic_crm_light.svg";@@ -58,7 +56,7 @@ export const defaultTaskTypes = [];export const defaultContactGender = [- { value: "male", label: "He/Him", icon: Mars },- { value: "female", label: "She/Her", icon: Venus },- { value: "nonbinary", label: "They/Them", icon: NonBinary },+ { value: "male", label: "He/Him", icon: "Mars" },+ { value: "female", label: "She/Her", icon: "Venus" },+ { value: "nonbinary", label: "They/Them", icon: "NonBinary" },];diff --git a/src/components/atomic-crm/root/storedConfiguration.ts b/src/components/atomic-crm/root/storedConfiguration.tsdeleted file mode 100644index 2db31683..00000000--- a/src/components/atomic-crm/root/storedConfiguration.ts+++ /dev/null@@ -1,74 +0,0 @@-import type { ContactGender, DealStage, NoteStatus } from "../types";-import type { ConfigurationContextValue } from "./ConfigurationContext";-import { genderIconRegistry } from "./iconRegistry";--export const CONFIGURATION_STORE_KEY = "app.configuration";--export interface StoredContactGender {- value: string;- label: string;- icon: string;-}--export interface StoredConfiguration {- companySectors?: string[];- dealCategories?: string[];- dealPipelineStatuses?: string[];- dealStages?: DealStage[];- noteStatuses?: NoteStatus[];- taskTypes?: string[];- title?: string;- darkModeLogo?: string;- lightModeLogo?: string;- contactGender?: StoredContactGender[];-}--export const hydrateContactGender = (- stored: StoredContactGender[],-): ContactGender[] =>- stored.map((g) => ({- value: g.value,- label: g.label,- icon: genderIconRegistry[g.icon] ?? genderIconRegistry.User,- }));--export const dehydrateContactGender = (- genders: ContactGender[],-): StoredContactGender[] =>- genders.map((g) => ({- value: g.value,- label: g.label,- icon:- Object.entries(genderIconRegistry).find(- ([, component]) => component === g.icon,- )?.[0] ?? "User",- }));--export const mergeConfiguration = (- codeDefaults: ConfigurationContextValue,- dbConfig: StoredConfiguration | null,-): ConfigurationContextValue => {- if (!dbConfig) return codeDefaults;-- return {- ...codeDefaults,- ...(dbConfig.companySectors && {- companySectors: dbConfig.companySectors,- }),- ...(dbConfig.dealCategories && {- dealCategories: dbConfig.dealCategories,- }),- ...(dbConfig.dealPipelineStatuses && {- dealPipelineStatuses: dbConfig.dealPipelineStatuses,- }),- ...(dbConfig.dealStages && { dealStages: dbConfig.dealStages }),- ...(dbConfig.noteStatuses && { noteStatuses: dbConfig.noteStatuses }),- ...(dbConfig.taskTypes && { taskTypes: dbConfig.taskTypes }),- ...(dbConfig.title && { title: dbConfig.title }),- ...(dbConfig.darkModeLogo && { darkModeLogo: dbConfig.darkModeLogo }),- ...(dbConfig.lightModeLogo && { lightModeLogo: dbConfig.lightModeLogo }),- ...(dbConfig.contactGender && {- contactGender: hydrateContactGender(dbConfig.contactGender),- }),- };-};diff --git a/src/components/atomic-crm/root/useConfigurationLoader.ts b/src/components/atomic-crm/root/useConfigurationLoader.tsindex bd95eb4e..798e100d 100644--- a/src/components/atomic-crm/root/useConfigurationLoader.ts+++ b/src/components/atomic-crm/root/useConfigurationLoader.ts@@ -3,14 +3,16 @@ import { useEffect } from "react";import { useDataProvider } from "ra-core";import type { CrmDataProvider } from "../providers/types";-import { useConfigurationUpdater } from "./ConfigurationContext";-import type { StoredConfiguration } from "./storedConfiguration";+import {+ useConfigurationUpdater,+ type ConfigurationContextValue,+} from "./ConfigurationContext";export const useConfigurationLoader = () => {const dataProvider = useDataProvider<CrmDataProvider>();const updateConfiguration = useConfigurationUpdater();- const { data } = useQuery<StoredConfiguration>({+ const { data } = useQuery<ConfigurationContextValue>({queryKey: ["configuration"],queryFn: () => dataProvider.getConfiguration(),staleTime: 1000 * 60 * 5, // 5 minutes@@ -18,7 +20,7 @@ export const useConfigurationLoader = () => {});useEffect(() => {- if (data) {+ if (data && Object.keys(data).length > 0) {updateConfiguration(data);}}, [data, updateConfiguration]);diff --git a/src/components/atomic-crm/settings/AppConfigPage.tsx b/src/components/atomic-crm/settings/AppConfigPage.tsxindex bed4589a..a6c90ea6 100644--- a/src/components/atomic-crm/settings/AppConfigPage.tsx+++ b/src/components/atomic-crm/settings/AppConfigPage.tsx@@ -15,10 +15,7 @@ import {useConfigurationUpdater,} from "../root/ConfigurationContext";import { genderIconRegistry } from "../root/iconRegistry";-import {- dehydrateContactGender,- type StoredConfiguration,-} from "../root/storedConfiguration";+import { type ConfigurationContextValue } from "../root/ConfigurationContext";const SECTIONS = [{ id: "branding", label: "Branding" },@@ -53,7 +50,7 @@ const transformFormValues = (data: Record<string, any>) => ({dealPipelineStatuses: data.dealPipelineStatuses,noteStatuses: data.noteStatuses,contactGender: data.contactGender,- } satisfies StoredConfiguration,+ } satisfies ConfigurationContextValue,});export const AppConfigPage = () => {@@ -98,7 +95,7 @@ const AppConfigForm = () => {dealStages: config.dealStages,dealPipelineStatuses: config.dealPipelineStatuses,noteStatuses: config.noteStatuses,- contactGender: dehydrateContactGender(config.contactGender),+ contactGender: config.contactGender,}),[config],);diff --git a/src/components/atomic-crm/types.ts b/src/components/atomic-crm/types.tsindex 1a90e747..42463ae2 100644--- a/src/components/atomic-crm/types.ts+++ b/src/components/atomic-crm/types.ts@@ -1,5 +1,4 @@import type { Identifier, RaRecord } from "ra-core";-import type { ComponentType } from "react";import type {COMPANY_CREATED,@@ -223,5 +222,5 @@ export interface NoteStatus {export interface ContactGender {value: string;label: string;- icon: ComponentType<{ className?: string }>;+ icon: string;}