| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249 |
- import { IUser, pagePathUtils } from '@growi/core';
- import { HtmlElementNode } from 'rehype-toc';
- import { Key, SWRResponse, useSWRConfig } from 'swr';
- import useSWRImmutable from 'swr/immutable';
- import { SupportedActionType } from '~/interfaces/activity';
- import { EditorConfig } from '~/interfaces/editor-settings';
- // import { CustomWindow } from '~/interfaces/global';
- import { RendererConfig } from '~/interfaces/services/renderer';
- import { GrowiThemes } from '~/interfaces/theme';
- import InterceptorManager from '~/services/interceptor-manager';
- import { TargetAndAncestors } from '../interfaces/page-listing-results';
- import { useContextSWR } from './use-context-swr';
- import { useStaticSWR } from './use-static-swr';
- type Nullable<T> = T | null;
- export const useInterceptorManager = (): SWRResponse<InterceptorManager, Error> => {
- return useContextSWR<InterceptorManager, Error>('interceptorManager', undefined, { fallbackData: new InterceptorManager() });
- };
- export const useCsrfToken = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR<string, Error>('csrfToken', initialData);
- };
- export const useAppTitle = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('appTitle', initialData);
- };
- export const useSiteUrl = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR<string, Error>('siteUrl', initialData);
- };
- export const useConfidential = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('confidential', initialData);
- };
- export const useGrowiTheme = (initialData?: GrowiThemes): SWRResponse<GrowiThemes, Error> => {
- return useContextSWR('theme', initialData);
- };
- export const useCurrentUser = (initialData?: Nullable<IUser>): SWRResponse<Nullable<IUser>, Error> => {
- return useContextSWR<Nullable<IUser>, Error>('currentUser', initialData);
- };
- export const useCurrentPathname = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('currentPathname', initialData);
- };
- export const useCurrentPageId = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
- return useStaticSWR<Nullable<string>, Error>('currentPageId', initialData);
- };
- export const useIsIdenticalPath = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isIdenticalPath', initialData, { fallbackData: false });
- };
- export const useIsForbidden = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isForbidden', initialData, { fallbackData: false });
- };
- export const useIsNotFound = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isNotFound', initialData, { fallbackData: false });
- };
- export const useTemplateTagData = (initialData?: string[]): SWRResponse<string[], Error> => {
- return useContextSWR<string[], Error>('templateTagData', initialData);
- };
- export const useIsSharedUser = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isSharedUser', initialData);
- };
- export const useShareLinkId = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
- return useContextSWR<Nullable<string>, Error>('shareLinkId', initialData);
- };
- export const useDisableLinkSharing = (initialData?: Nullable<boolean>): SWRResponse<Nullable<boolean>, Error> => {
- return useContextSWR<Nullable<boolean>, Error>('disableLinkSharing', initialData);
- };
- export const useRegistrationWhiteList = (initialData?: Nullable<string[]>): SWRResponse<Nullable<string[]>, Error> => {
- return useContextSWR<Nullable<string[]>, Error>('registrationWhiteList', initialData);
- };
- export const useDrawioUri = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('drawioUri', initialData, { fallbackData: 'https://embed.diagrams.net/' });
- };
- export const useHackmdUri = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
- return useContextSWR<Nullable<string>, Error>('hackmdUri', initialData);
- };
- export const useIsSearchPage = (initialData?: Nullable<boolean>) : SWRResponse<Nullable<boolean>, Error> => {
- return useContextSWR<Nullable<any>, Error>('isSearchPage', initialData);
- };
- export const useTargetAndAncestors = (initialData?: TargetAndAncestors): SWRResponse<TargetAndAncestors, Error> => {
- return useContextSWR<TargetAndAncestors, Error>('targetAndAncestors', initialData);
- };
- export const useIsAclEnabled = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isAclEnabled', initialData);
- };
- export const useIsSearchServiceConfigured = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isSearchServiceConfigured', initialData);
- };
- export const useIsSearchServiceReachable = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isSearchServiceReachable', initialData);
- };
- export const useIsMailerSetup = (initialData?: boolean): SWRResponse<boolean, any> => {
- return useContextSWR('isMailerSetup', initialData);
- };
- export const useIsSearchScopeChildrenAsDefault = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isSearchScopeChildrenAsDefault', initialData, { fallbackData: false });
- };
- export const useIsSlackConfigured = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isSlackConfigured', initialData);
- };
- export const useIsEnabledAttachTitleHeader = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isEnabledAttachTitleHeader', initialData);
- };
- export const useIsIndentSizeForced = (initialData?: boolean) : SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('isIndentSizeForced', initialData, { fallbackData: false });
- };
- export const useDefaultIndentSize = (initialData?: number) : SWRResponse<number, Error> => {
- return useContextSWR<number, Error>('defaultIndentSize', initialData, { fallbackData: 4 });
- };
- export const useAuditLogEnabled = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR<boolean, Error>('auditLogEnabled', initialData, { fallbackData: false });
- };
- // TODO: initialize in [[..path]].page.tsx?
- export const useActivityExpirationSeconds = (initialData?: number) : SWRResponse<number, Error> => {
- return useContextSWR<number, Error>('activityExpirationSeconds', initialData);
- };
- export const useAuditLogAvailableActions = (initialData?: Array<SupportedActionType>) : SWRResponse<Array<SupportedActionType>, Error> => {
- return useContextSWR<Array<SupportedActionType>, Error>('auditLogAvailableActions', initialData);
- };
- export const useGrowiVersion = (initialData?: string): SWRResponse<string, any> => {
- return useContextSWR('growiVersion', initialData);
- };
- export const useIsEnabledStaleNotification = (initialData?: boolean): SWRResponse<boolean, any> => {
- return useContextSWR('isEnabledStaleNotification', initialData);
- };
- export const useIsLatestRevision = (initialData?: boolean): SWRResponse<boolean, any> => {
- return useContextSWR('isLatestRevision', initialData);
- };
- export const useEditorConfig = (initialData?: EditorConfig): SWRResponse<EditorConfig, Error> => {
- return useContextSWR<EditorConfig, Error>('editorConfig', initialData);
- };
- export const useRendererConfig = (initialData?: RendererConfig): SWRResponse<RendererConfig, any> => {
- return useContextSWR('growiRendererConfig', initialData);
- };
- export const useIsAllReplyShown = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR('isAllReplyShown', initialData);
- };
- export const useIsBlinkedHeaderAtBoot = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR('isBlinkedAtBoot', initialData, { fallbackData: false });
- };
- export const useEditingMarkdown = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('currentMarkdown', initialData);
- };
- export const useIsUploadableImage = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR('isUploadableImage', initialData);
- };
- export const useIsUploadableFile = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useContextSWR('isUploadableFile', initialData);
- };
- export const useShowPageLimitationL = (initialData?: number): SWRResponse<number, Error> => {
- return useContextSWR('showPageLimitationL', initialData);
- };
- export const useShowPageLimitationXL = (initialData?: number): SWRResponse<number, Error> => {
- return useContextSWR('showPageLimitationXL', initialData);
- };
- export const useCustomizeTitle = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('CustomizeTitle', initialData);
- };
- export const useCustomizedLogoSrc = (initialData?: string): SWRResponse<string, Error> => {
- return useContextSWR('customizedLogoSrc', initialData);
- };
- export const useGrowiCloudUri = (initialData?: string): SWRResponse<string, Error> => {
- return useStaticSWR('growiCloudUri', initialData);
- };
- export const useGrowiAppIdForGrowiCloud = (initialData?: number): SWRResponse<number, Error> => {
- return useStaticSWR('growiAppIdForGrowiCloud', initialData);
- };
- export const useIsContainerFluid = (initialData?: boolean): SWRResponse<boolean, Error> => {
- return useStaticSWR('isContainerFluid', initialData);
- };
- /** **********************************************************
- * Computed contexts
- *********************************************************** */
- export const useIsGuestUser = (): SWRResponse<boolean, Error> => {
- const { data: currentUser } = useCurrentUser();
- return useSWRImmutable(
- ['isGuestUser', currentUser],
- (key: Key, currentUser: IUser) => currentUser == null,
- { fallbackData: currentUser == null },
- );
- };
- export const useIsEditable = (): SWRResponse<boolean, Error> => {
- const { data: isGuestUser } = useIsGuestUser();
- const { data: isForbidden } = useIsForbidden();
- const { data: isIdenticalPath } = useIsIdenticalPath();
- return useSWRImmutable(
- ['isEditable', isGuestUser, isForbidden, isIdenticalPath],
- (key: Key, isGuestUser: boolean, isForbidden: boolean, isIdenticalPath: boolean) => {
- return (!isForbidden && !isIdenticalPath && !isGuestUser);
- },
- );
- };
|