first commit

common/resources/client/core/settings/base-site-config.ts

@@ -0,0 +1,36 @@
+import {SiteConfigContextValue} from './site-config-context';
+import {WorkspaceInviteNotificationRenderer} from '../../workspace/notifications/workspace-invite-notification-renderer';
+import {message} from '../../i18n/message';
+
+const workspaceInviteNotif =
+  'Common\\Workspaces\\Notifications\\WorkspaceInvitation';
+
+export const BaseSiteConfig: SiteConfigContextValue = {
+  auth: {
+    redirectUri: '/',
+    adminRedirectUri: '/admin',
+  },
+  tags: {
+    types: [{name: 'custom'}],
+  },
+  customPages: {
+    types: [{type: 'default', label: message('Default')}],
+  },
+  notifications: {
+    renderMap: {
+      [workspaceInviteNotif]: WorkspaceInviteNotificationRenderer,
+    },
+  },
+  admin: {
+    ads: [],
+  },
+  demo: {
+    loginPageDefaults: 'singleAccount',
+  },
+  homepage: {
+    options: [
+      {label: message('Login page'), value: 'loginPage'},
+      {label: message('Registration page'), value: 'registerPage'},
+    ],
+  },
+};

common/resources/client/core/settings/settings.ts

@@ -0,0 +1,146 @@
+import {IconTree} from '../../icons/create-svg-icon';
+
+export type RecaptchaAction = 'contact' | 'register' | 'link_creation';
+
+export interface Settings {
+  version: string;
+  branding: {
+    logo_light: string;
+    logo_dark: string;
+    logo_light_mobile: string;
+    logo_dark_mobile: string;
+    site_name: string;
+    site_description: string;
+    favicon: string;
+  };
+  menus: MenuConfig[];
+  base_url: string;
+  asset_url?: string;
+  html_base_uri: string;
+  cookie_notice: {
+    enable: boolean;
+    position: 'top' | 'bottom';
+    button?: MenuItemConfig;
+  };
+  logging: {
+    sentry_public?: string;
+  };
+  themes?: {
+    default_id?: number | string | null;
+    user_change: boolean;
+  };
+  custom_domains?: {
+    default_host?: string;
+    allow_select?: boolean;
+    allow_all_option?: boolean;
+  };
+  dates: {
+    format: string;
+    default_timezone: string;
+  };
+  i18n: {
+    enable: boolean;
+    default_localization: string;
+  };
+  api?: {
+    integrated: boolean;
+  };
+  billing: {
+    integrated: boolean;
+    enable: boolean;
+    accepted_cards?: string | string[];
+    paypal_test_mode: boolean;
+    stripe_public_key?: string;
+    invoice: {
+      address?: string;
+      notes?: string;
+    };
+    paypal: {
+      public_key: string;
+      enable: boolean;
+    };
+    stripe: {
+      enable: boolean;
+    };
+  };
+  notifications: {
+    integrated: boolean;
+  };
+  notif: {
+    subs: {
+      integrated: boolean;
+    };
+  };
+  site: {
+    hide_docs_button: boolean;
+    has_mobile_app: boolean;
+    demo: boolean;
+  };
+  registration: {
+    disable: boolean;
+    policies?: MenuItemConfig[];
+  };
+  social: {
+    envato: {
+      enable: boolean;
+    };
+    google: {
+      enable: boolean;
+    };
+    twitter: {
+      enable: boolean;
+    };
+    facebook: {
+      enable: boolean;
+    };
+    compact_buttons: boolean;
+  };
+  workspaces: {
+    integrated: boolean;
+  };
+  uploads: {
+    chunk_size: number;
+    max_size: number;
+    available_space: number;
+    allowed_extensions?: string[];
+    blocked_extensions?: string[];
+    public_driver: string;
+    uploads_driver: string;
+    s3_direct_upload: boolean;
+    disable_tus: boolean;
+  };
+  require_email_confirmation: boolean;
+  single_device_login: boolean;
+  mail: {
+    contact_page_address: string;
+    handler: string;
+  };
+  recaptcha?: {
+    enable?: Record<RecaptchaAction, boolean>;
+    site_key: string;
+  };
+  analytics?: {
+    tracking_code?: string;
+    gchart_api_key?: string;
+  };
+}
+
+export interface MenuConfig {
+  id: string;
+  name: string;
+  positions: string[];
+  items: MenuItemConfig[];
+}
+
+export interface MenuItemConfig {
+  id: string;
+  type: 'route' | 'link';
+  order: number;
+  label: string;
+  action: string;
+  target?: '_blank' | '_self';
+  roles?: number[];
+  permissions?: string[];
+  settings?: Record<string, any>;
+  icon?: IconTree[] | null;
+}

common/resources/client/core/settings/site-config-context.ts

@@ -0,0 +1,72 @@
+import React, {ComponentType} from 'react';
+import type {NotificationListItemProps} from '../../notifications/notification-list';
+import {MessageDescriptor} from '../../i18n/message-descriptor';
+import {User} from '@common/auth/user';
+import {SvgIconProps} from '@common/icons/svg-icon';
+
+export interface AdConfig {
+  slot: string;
+  description: MessageDescriptor;
+  image: string;
+}
+
+export interface TagType {
+  name: string;
+  system?: boolean;
+}
+
+export interface CustomPageType {
+  type: string;
+  label: MessageDescriptor;
+}
+
+export interface HomepageOption {
+  label: MessageDescriptor;
+  value: string;
+}
+
+export interface SiteConfigContextValue {
+  auth: {
+    redirectUri: string;
+    // redirect uri to use when homepage is set to login page, to avoid infinite loop
+    secondaryRedirectUri?: string;
+    adminRedirectUri: string;
+    getUserProfileLink?: (user: User) => string;
+    registerFields?: ComponentType;
+    accountSettingsPanels?: {
+      icon: ComponentType<SvgIconProps>;
+      label: MessageDescriptor;
+      id: string;
+      component: ComponentType<{user: User}>;
+    }[];
+  };
+  notifications: {
+    renderMap?: Record<string, ComponentType<NotificationListItemProps>>;
+  };
+  tags: {
+    types: TagType[];
+  };
+  customPages: {
+    types: CustomPageType[];
+  };
+  settings?: {
+    showIncomingMailMethod?: boolean;
+    showRecaptchaLinkSwitch?: boolean;
+  };
+  admin: {
+    ads: AdConfig[];
+    channelsDocsLink?: string;
+  };
+  demo: {
+    loginPageDefaults: 'singleAccount' | 'randomAccount';
+    email?: string;
+    password?: string;
+  };
+  homepage: {
+    options: HomepageOption[];
+  };
+}
+
+export const SiteConfigContext = React.createContext<SiteConfigContextValue>(
+  null!,
+);

common/resources/client/core/settings/use-settings.ts

@@ -0,0 +1,9 @@
+import {Settings} from './settings';
+import {useBootstrapData} from '../bootstrap-data/bootstrap-data-context';
+
+export function useSettings(): Settings {
+  const {
+    data: {settings},
+  } = useBootstrapData();
+  return settings;
+}