context.tsx 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. import { pagePathUtils } from '@growi/core';
  2. import { Key, SWRResponse } from 'swr';
  3. import useSWRImmutable from 'swr/immutable';
  4. import { TargetAndAncestors, IsNotFoundPermalink } from '../interfaces/page-listing-results';
  5. import { IUser } from '../interfaces/user';
  6. import { useStaticSWR } from './use-static-swr';
  7. type Nullable<T> = T | null;
  8. export const useCsrfToken = (initialData?: string): SWRResponse<string, Error> => {
  9. return useStaticSWR<string, Error>('csrfToken', initialData);
  10. };
  11. export const useSiteUrl = (initialData?: string): SWRResponse<string, Error> => {
  12. return useStaticSWR<string, Error>('siteUrl', initialData);
  13. };
  14. export const useCurrentUser = (initialData?: Nullable<IUser>): SWRResponse<Nullable<IUser>, Error> => {
  15. return useStaticSWR<Nullable<IUser>, Error>('currentUser', initialData);
  16. };
  17. export const useRevisionId = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  18. return useStaticSWR<Nullable<any>, Error>('revisionId', initialData);
  19. };
  20. export const useCurrentPagePath = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
  21. return useStaticSWR<Nullable<string>, Error>('currentPagePath', initialData);
  22. };
  23. export const useCurrentPageId = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
  24. return useStaticSWR<Nullable<string>, Error>('currentPageId', initialData);
  25. };
  26. export const useEmptyPageId = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
  27. return useStaticSWR<Nullable<string>, Error>('emptyPageId', initialData);
  28. };
  29. export const useRevisionCreatedAt = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  30. return useStaticSWR<Nullable<any>, Error>('revisionCreatedAt', initialData);
  31. };
  32. export const useCurrentCreatedAt = (initialData?: Nullable<Date>): SWRResponse<Nullable<Date>, Error> => {
  33. return useStaticSWR<Nullable<Date>, Error>('createdAt', initialData);
  34. };
  35. export const useCurrentUpdatedAt = (initialData?: Nullable<Date>): SWRResponse<Nullable<Date>, Error> => {
  36. return useStaticSWR<Nullable<Date>, Error>('updatedAt', initialData);
  37. };
  38. export const useDeletedAt = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  39. return useStaticSWR<Nullable<any>, Error>('deletedAt', initialData);
  40. };
  41. export const useIsIdenticalPath = (initialData?: boolean): SWRResponse<boolean, Error> => {
  42. return useStaticSWR<boolean, Error>('isIdenticalPath', initialData, { fallbackData: false });
  43. };
  44. export const useIsUserPage = (initialData?: boolean): SWRResponse<boolean, Error> => {
  45. return useStaticSWR<boolean, Error>('isUserPage', initialData, { fallbackData: false });
  46. };
  47. export const useIsTrashPage = (initialData?: boolean): SWRResponse<boolean, Error> => {
  48. return useStaticSWR<boolean, Error>('isTrashPage', initialData, { fallbackData: false });
  49. };
  50. export const useIsDeleted = (initialData?: boolean): SWRResponse<boolean, Error> => {
  51. return useStaticSWR<boolean, Error>('isDeleted', initialData, { fallbackData: false });
  52. };
  53. export const useIsNotCreatable = (initialData?: boolean): SWRResponse<boolean, Error> => {
  54. return useStaticSWR<boolean, Error>('isNotCreatable', initialData, { fallbackData: false });
  55. };
  56. export const useIsForbidden = (initialData?: boolean): SWRResponse<boolean, Error> => {
  57. return useStaticSWR<boolean, Error>('isForbidden', initialData, { fallbackData: false });
  58. };
  59. export const usePageUser = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  60. return useStaticSWR<Nullable<any>, Error>('pageUser', initialData);
  61. };
  62. export const useHasChildren = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  63. return useStaticSWR<Nullable<any>, Error>('hasChildren', initialData);
  64. };
  65. export const useTemplateTagData = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  66. return useStaticSWR<Nullable<any>, Error>('templateTagData', initialData);
  67. };
  68. export const useShareLinksNumber = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  69. return useStaticSWR<Nullable<any>, Error>('shareLinksNumber', initialData);
  70. };
  71. export const useShareLinkId = (initialData?: Nullable<string>): SWRResponse<Nullable<string>, Error> => {
  72. return useStaticSWR<Nullable<string>, Error>('shareLinkId', initialData);
  73. };
  74. export const useRevisionIdHackmdSynced = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  75. return useStaticSWR<Nullable<any>, Error>('revisionIdHackmdSynced', initialData);
  76. };
  77. export const useLastUpdateUsername = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  78. return useStaticSWR<Nullable<any>, Error>('lastUpdateUsername', initialData);
  79. };
  80. export const useDeleteUsername = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  81. return useStaticSWR<Nullable<any>, Error>('deleteUsername', initialData);
  82. };
  83. export const usePageIdOnHackmd = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  84. return useStaticSWR<Nullable<any>, Error>('pageIdOnHackmd', initialData);
  85. };
  86. export const useHasDraftOnHackmd = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  87. return useStaticSWR<Nullable<any>, Error>('hasDraftOnHackmd', initialData);
  88. };
  89. export const useCreator = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  90. return useStaticSWR<Nullable<any>, Error>('creator', initialData);
  91. };
  92. export const useRevisionAuthor = (initialData?: Nullable<any>): SWRResponse<Nullable<any>, Error> => {
  93. return useStaticSWR<Nullable<any>, Error>('revisionAuthor', initialData);
  94. };
  95. export const useIsSearchPage = (initialData?: Nullable<any>) : SWRResponse<Nullable<any>, Error> => {
  96. return useStaticSWR<Nullable<any>, Error>('isSearchPage', initialData);
  97. };
  98. export const useTargetAndAncestors = (initialData?: TargetAndAncestors): SWRResponse<TargetAndAncestors, Error> => {
  99. return useStaticSWR<TargetAndAncestors, Error>('targetAndAncestors', initialData);
  100. };
  101. export const useNotFoundTargetPathOrId = (initialData?: string): SWRResponse<string, Error> => {
  102. return useStaticSWR<string, Error>('notFoundTargetPathOrId', initialData);
  103. };
  104. export const useIsNotFoundPermalink = (initialData?: Nullable<IsNotFoundPermalink>): SWRResponse<Nullable<IsNotFoundPermalink>, Error> => {
  105. return useStaticSWR<Nullable<IsNotFoundPermalink>, Error>('isNotFoundPermalink', initialData);
  106. };
  107. export const useIsAclEnabled = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  108. return useStaticSWR<boolean, Error>('isAclEnabled', initialData);
  109. };
  110. export const useIsSearchServiceConfigured = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  111. return useStaticSWR<boolean, Error>('isSearchServiceConfigured', initialData);
  112. };
  113. export const useIsSearchServiceReachable = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  114. return useStaticSWR<boolean, Error>('isSearchServiceReachable', initialData);
  115. };
  116. export const useIsEnabledAttachTitleHeader = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  117. return useStaticSWR<boolean, Error>('isEnabledAttachTitleHeader', initialData);
  118. };
  119. export const useIsEmptyPage = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  120. return useStaticSWR<boolean, Error>('isEmptyPage', initialData);
  121. };
  122. export const useHasParent = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  123. return useStaticSWR<boolean, Error>('hasParent', initialData);
  124. };
  125. export const useIsIndentSizeForced = (initialData?: boolean) : SWRResponse<boolean, Error> => {
  126. return useStaticSWR<boolean, Error>('isIndentSizeForced', initialData);
  127. };
  128. export const useDefaultIndentSize = (initialData?: number) : SWRResponse<number, Error> => {
  129. return useStaticSWR<number, Error>('defaultIndentSize', initialData, { fallbackData: 4 });
  130. };
  131. export const useGrowiVersion = (initialData?: string): SWRResponse<string, any> => {
  132. return useStaticSWR('growiVersion', initialData);
  133. };
  134. /** **********************************************************
  135. * Computed contexts
  136. *********************************************************** */
  137. export const useIsGuestUser = (): SWRResponse<boolean, Error> => {
  138. const { data: currentUser } = useCurrentUser();
  139. return useSWRImmutable(
  140. ['isGuestUser', currentUser],
  141. (key: Key, currentUser: IUser) => currentUser == null,
  142. );
  143. };
  144. export const useIsEditable = (): SWRResponse<boolean, Error> => {
  145. const { data: isGuestUser } = useIsGuestUser();
  146. const { data: isNotCreatable } = useIsNotCreatable();
  147. const { data: isTrashPage } = useIsTrashPage();
  148. return useSWRImmutable(
  149. ['isEditable', isGuestUser, isTrashPage, isNotCreatable],
  150. (key: Key, isGuestUser: boolean, isTrashPage: boolean, isNotCreatable: boolean) => {
  151. return (!isNotCreatable && !isTrashPage && !isGuestUser);
  152. },
  153. );
  154. };
  155. export const useIsSharedUser = (): SWRResponse<boolean, Error> => {
  156. const { data: isGuestUser } = useIsGuestUser();
  157. const pathname = window.location.pathname;
  158. return useSWRImmutable(
  159. ['isSharedUser', isGuestUser, pathname],
  160. (key: Key, isGuestUser: boolean, pathname: string) => {
  161. return isGuestUser && pagePathUtils.isSharedPage(pathname);
  162. },
  163. );
  164. };