@sublay/js 7.9.0 → 7.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (272) hide show
  1. package/LICENSE +202 -0
  2. package/NOTICE +9 -0
  3. package/README.md +23 -14
  4. package/dist/index.d.mts +38 -7
  5. package/dist/index.d.ts +4363 -35
  6. package/dist/index.js +1 -1
  7. package/dist/index.mjs +1 -1
  8. package/package.json +29 -18
  9. package/dist/core/client.d.ts +0 -64
  10. package/dist/core/multipart.d.ts +0 -22
  11. package/dist/core/spaceReputationParams.d.ts +0 -57
  12. package/dist/interfaces/AppNotification.d.ts +0 -258
  13. package/dist/interfaces/ChatMessage.d.ts +0 -40
  14. package/dist/interfaces/Collection.d.ts +0 -10
  15. package/dist/interfaces/Comment.d.ts +0 -50
  16. package/dist/interfaces/Connection.d.ts +0 -67
  17. package/dist/interfaces/Conversation.d.ts +0 -27
  18. package/dist/interfaces/ConversationMember.d.ts +0 -17
  19. package/dist/interfaces/Entity.d.ts +0 -63
  20. package/dist/interfaces/Event.d.ts +0 -66
  21. package/dist/interfaces/File.d.ts +0 -39
  22. package/dist/interfaces/Follow.d.ts +0 -19
  23. package/dist/interfaces/HostedApp.d.ts +0 -11
  24. package/dist/interfaces/IPaginatedResponse.d.ts +0 -11
  25. package/dist/interfaces/ImageProcessing.d.ts +0 -62
  26. package/dist/interfaces/Mention.d.ts +0 -12
  27. package/dist/interfaces/OAuthIdentity.d.ts +0 -14
  28. package/dist/interfaces/Project.d.ts +0 -14
  29. package/dist/interfaces/Push.d.ts +0 -74
  30. package/dist/interfaces/Reaction.d.ts +0 -23
  31. package/dist/interfaces/Report.d.ts +0 -38
  32. package/dist/interfaces/ReputationGrant.d.ts +0 -85
  33. package/dist/interfaces/Rule.d.ts +0 -22
  34. package/dist/interfaces/Space.d.ts +0 -130
  35. package/dist/interfaces/SpaceMember.d.ts +0 -29
  36. package/dist/interfaces/SpaceReputation.d.ts +0 -100
  37. package/dist/interfaces/Table.d.ts +0 -63
  38. package/dist/interfaces/User.d.ts +0 -46
  39. package/dist/interfaces/UserSearch.d.ts +0 -13
  40. package/dist/interfaces/Workspace.d.ts +0 -178
  41. package/dist/modules/app-notifications/countUnreadNotifications.d.ts +0 -2
  42. package/dist/modules/app-notifications/fetchNotifications.d.ts +0 -8
  43. package/dist/modules/app-notifications/index.d.ts +0 -4
  44. package/dist/modules/app-notifications/markAllNotificationsAsRead.d.ts +0 -5
  45. package/dist/modules/app-notifications/markNotificationAsRead.d.ts +0 -5
  46. package/dist/modules/auth/changePassword.d.ts +0 -34
  47. package/dist/modules/auth/confirmAccountDeletion.d.ts +0 -11
  48. package/dist/modules/auth/index.d.ts +0 -13
  49. package/dist/modules/auth/requestAccountDeletion.d.ts +0 -14
  50. package/dist/modules/auth/requestNewAccessToken.d.ts +0 -16
  51. package/dist/modules/auth/requestPasswordReset.d.ts +0 -5
  52. package/dist/modules/auth/resetPassword.d.ts +0 -6
  53. package/dist/modules/auth/sendVerificationEmail.d.ts +0 -13
  54. package/dist/modules/auth/setPassword.d.ts +0 -9
  55. package/dist/modules/auth/signIn.d.ts +0 -12
  56. package/dist/modules/auth/signOut.d.ts +0 -103
  57. package/dist/modules/auth/signUp.d.ts +0 -24
  58. package/dist/modules/auth/verifyEmail.d.ts +0 -5
  59. package/dist/modules/auth/verifyExternalUser.d.ts +0 -11
  60. package/dist/modules/chat/addMember.d.ts +0 -8
  61. package/dist/modules/chat/changeMemberRole.d.ts +0 -9
  62. package/dist/modules/chat/createDirectConversation.d.ts +0 -7
  63. package/dist/modules/chat/createGroupConversation.d.ts +0 -10
  64. package/dist/modules/chat/deleteConversation.d.ts +0 -8
  65. package/dist/modules/chat/deleteMessage.d.ts +0 -11
  66. package/dist/modules/chat/editMessage.d.ts +0 -14
  67. package/dist/modules/chat/getConversation.d.ts +0 -6
  68. package/dist/modules/chat/getMessage.d.ts +0 -13
  69. package/dist/modules/chat/getUnreadCount.d.ts +0 -6
  70. package/dist/modules/chat/index.d.ts +0 -21
  71. package/dist/modules/chat/leaveConversation.d.ts +0 -7
  72. package/dist/modules/chat/listConversations.d.ts +0 -17
  73. package/dist/modules/chat/listMembers.d.ts +0 -11
  74. package/dist/modules/chat/listMessages.d.ts +0 -44
  75. package/dist/modules/chat/listReactions.d.ts +0 -24
  76. package/dist/modules/chat/markAsRead.d.ts +0 -9
  77. package/dist/modules/chat/muteConversation.d.ts +0 -23
  78. package/dist/modules/chat/removeMember.d.ts +0 -9
  79. package/dist/modules/chat/reportMessage.d.ts +0 -12
  80. package/dist/modules/chat/sendMessage.d.ts +0 -22
  81. package/dist/modules/chat/toggleReaction.d.ts +0 -16
  82. package/dist/modules/chat/updateConversation.d.ts +0 -12
  83. package/dist/modules/collections/addEntityToCollection.d.ts +0 -13
  84. package/dist/modules/collections/createNewCollection.d.ts +0 -8
  85. package/dist/modules/collections/deleteCollection.d.ts +0 -5
  86. package/dist/modules/collections/fetchCollectionEntities.d.ts +0 -13
  87. package/dist/modules/collections/fetchRootCollection.d.ts +0 -3
  88. package/dist/modules/collections/fetchSubCollections.d.ts +0 -6
  89. package/dist/modules/collections/index.d.ts +0 -8
  90. package/dist/modules/collections/removeEntityFromCollection.d.ts +0 -7
  91. package/dist/modules/collections/updateCollection.d.ts +0 -7
  92. package/dist/modules/comments/addReaction.d.ts +0 -8
  93. package/dist/modules/comments/createComment.d.ts +0 -15
  94. package/dist/modules/comments/deleteComment.d.ts +0 -5
  95. package/dist/modules/comments/fetchComment.d.ts +0 -8
  96. package/dist/modules/comments/fetchCommentByForeignId.d.ts +0 -7
  97. package/dist/modules/comments/fetchManyComments.d.ts +0 -26
  98. package/dist/modules/comments/fetchReactions.d.ts +0 -16
  99. package/dist/modules/comments/getUserReaction.d.ts +0 -9
  100. package/dist/modules/comments/index.d.ts +0 -10
  101. package/dist/modules/comments/removeReaction.d.ts +0 -6
  102. package/dist/modules/comments/updateComment.d.ts +0 -10
  103. package/dist/modules/connections/acceptConnection.d.ts +0 -6
  104. package/dist/modules/connections/declineConnection.d.ts +0 -6
  105. package/dist/modules/connections/fetchConnections.d.ts +0 -9
  106. package/dist/modules/connections/fetchConnectionsCount.d.ts +0 -3
  107. package/dist/modules/connections/fetchReceivedPendingConnections.d.ts +0 -8
  108. package/dist/modules/connections/fetchSentPendingConnections.d.ts +0 -8
  109. package/dist/modules/connections/index.d.ts +0 -7
  110. package/dist/modules/connections/removeConnection.d.ts +0 -5
  111. package/dist/modules/entities/addReaction.d.ts +0 -8
  112. package/dist/modules/entities/createEntity.d.ts +0 -23
  113. package/dist/modules/entities/deleteEntity.d.ts +0 -5
  114. package/dist/modules/entities/fetchDrafts.d.ts +0 -11
  115. package/dist/modules/entities/fetchEntity.d.ts +0 -8
  116. package/dist/modules/entities/fetchEntityByForeignId.d.ts +0 -8
  117. package/dist/modules/entities/fetchEntityByShortId.d.ts +0 -7
  118. package/dist/modules/entities/fetchManyEntities.d.ts +0 -65
  119. package/dist/modules/entities/fetchReactions.d.ts +0 -16
  120. package/dist/modules/entities/fetchTopComment.d.ts +0 -6
  121. package/dist/modules/entities/getUserReaction.d.ts +0 -9
  122. package/dist/modules/entities/index.d.ts +0 -15
  123. package/dist/modules/entities/isEntitySaved.d.ts +0 -12
  124. package/dist/modules/entities/publishDraft.d.ts +0 -6
  125. package/dist/modules/entities/removeReaction.d.ts +0 -6
  126. package/dist/modules/entities/updateEntity.d.ts +0 -18
  127. package/dist/modules/events/addHost.d.ts +0 -8
  128. package/dist/modules/events/addInvite.d.ts +0 -8
  129. package/dist/modules/events/cancelEvent.d.ts +0 -6
  130. package/dist/modules/events/createEvent.d.ts +0 -49
  131. package/dist/modules/events/deleteEvent.d.ts +0 -5
  132. package/dist/modules/events/fetchEvent.d.ts +0 -8
  133. package/dist/modules/events/fetchEventRsvps.d.ts +0 -19
  134. package/dist/modules/events/fetchInvitees.d.ts +0 -12
  135. package/dist/modules/events/fetchManyEvents.d.ts +0 -42
  136. package/dist/modules/events/index.d.ts +0 -14
  137. package/dist/modules/events/removeHost.d.ts +0 -8
  138. package/dist/modules/events/removeInvite.d.ts +0 -8
  139. package/dist/modules/events/setRsvp.d.ts +0 -7
  140. package/dist/modules/events/updateEvent.d.ts +0 -43
  141. package/dist/modules/events/withdrawRsvp.d.ts +0 -6
  142. package/dist/modules/follows/deleteFollow.d.ts +0 -5
  143. package/dist/modules/follows/fetchFollowers.d.ts +0 -9
  144. package/dist/modules/follows/fetchFollowersCount.d.ts +0 -5
  145. package/dist/modules/follows/fetchFollowing.d.ts +0 -9
  146. package/dist/modules/follows/fetchFollowingCount.d.ts +0 -5
  147. package/dist/modules/follows/index.d.ts +0 -5
  148. package/dist/modules/oauth/authorize.d.ts +0 -25
  149. package/dist/modules/oauth/index.d.ts +0 -4
  150. package/dist/modules/oauth/linkIdentity.d.ts +0 -14
  151. package/dist/modules/oauth/listIdentities.d.ts +0 -4
  152. package/dist/modules/oauth/unlinkIdentity.d.ts +0 -12
  153. package/dist/modules/push/getNotificationPreferences.d.ts +0 -11
  154. package/dist/modules/push/index.d.ts +0 -2
  155. package/dist/modules/push/updateNotificationPreferences.d.ts +0 -16
  156. package/dist/modules/reports/createReport.d.ts +0 -9
  157. package/dist/modules/reports/fetchModeratedReports.d.ts +0 -13
  158. package/dist/modules/reports/index.d.ts +0 -2
  159. package/dist/modules/reputation/createGrant.d.ts +0 -45
  160. package/dist/modules/reputation/index.d.ts +0 -2
  161. package/dist/modules/reputation/listGrants.d.ts +0 -45
  162. package/dist/modules/search/askContent.d.ts +0 -58
  163. package/dist/modules/search/index.d.ts +0 -5
  164. package/dist/modules/search/matchUsers.d.ts +0 -36
  165. package/dist/modules/search/searchContent.d.ts +0 -24
  166. package/dist/modules/search/searchSpaces.d.ts +0 -11
  167. package/dist/modules/search/searchUsers.d.ts +0 -11
  168. package/dist/modules/spaces/approveMembership.d.ts +0 -7
  169. package/dist/modules/spaces/banMember.d.ts +0 -13
  170. package/dist/modules/spaces/checkMyMembership.d.ts +0 -6
  171. package/dist/modules/spaces/checkSlugAvailability.d.ts +0 -8
  172. package/dist/modules/spaces/createRule.d.ts +0 -8
  173. package/dist/modules/spaces/createSpace.d.ts +0 -29
  174. package/dist/modules/spaces/declineMembership.d.ts +0 -7
  175. package/dist/modules/spaces/deleteRule.d.ts +0 -7
  176. package/dist/modules/spaces/deleteSpace.d.ts +0 -6
  177. package/dist/modules/spaces/fetchChildSpaces.d.ts +0 -11
  178. package/dist/modules/spaces/fetchDigestConfig.d.ts +0 -6
  179. package/dist/modules/spaces/fetchManyRules.d.ts +0 -6
  180. package/dist/modules/spaces/fetchManySpaces.d.ts +0 -17
  181. package/dist/modules/spaces/fetchMutualSpaces.d.ts +0 -11
  182. package/dist/modules/spaces/fetchRule.d.ts +0 -7
  183. package/dist/modules/spaces/fetchSpace.d.ts +0 -6
  184. package/dist/modules/spaces/fetchSpaceBreadcrumb.d.ts +0 -6
  185. package/dist/modules/spaces/fetchSpaceByShortId.d.ts +0 -6
  186. package/dist/modules/spaces/fetchSpaceBySlug.d.ts +0 -6
  187. package/dist/modules/spaces/fetchSpaceMembers.d.ts +0 -11
  188. package/dist/modules/spaces/fetchSpaceTeam.d.ts +0 -7
  189. package/dist/modules/spaces/fetchUserSpaces.d.ts +0 -17
  190. package/dist/modules/spaces/getSpaceConversation.d.ts +0 -6
  191. package/dist/modules/spaces/handleCommentReport.d.ts +0 -14
  192. package/dist/modules/spaces/handleEntityReport.d.ts +0 -17
  193. package/dist/modules/spaces/handleSpaceChatReport.d.ts +0 -18
  194. package/dist/modules/spaces/index.d.ts +0 -36
  195. package/dist/modules/spaces/joinSpace.d.ts +0 -6
  196. package/dist/modules/spaces/leaveSpace.d.ts +0 -6
  197. package/dist/modules/spaces/moderateSpaceChatMessage.d.ts +0 -12
  198. package/dist/modules/spaces/moderateSpaceComment.d.ts +0 -9
  199. package/dist/modules/spaces/moderateSpaceEntity.d.ts +0 -12
  200. package/dist/modules/spaces/reorderRules.d.ts +0 -7
  201. package/dist/modules/spaces/setSpaceEntityNsfw.d.ts +0 -16
  202. package/dist/modules/spaces/unbanMember.d.ts +0 -13
  203. package/dist/modules/spaces/updateDigestConfig.d.ts +0 -11
  204. package/dist/modules/spaces/updateMemberRole.d.ts +0 -8
  205. package/dist/modules/spaces/updateRule.d.ts +0 -9
  206. package/dist/modules/spaces/updateSpace.d.ts +0 -22
  207. package/dist/modules/storage/deleteFile.d.ts +0 -5
  208. package/dist/modules/storage/getFile.d.ts +0 -34
  209. package/dist/modules/storage/index.d.ts +0 -4
  210. package/dist/modules/storage/uploadFile.d.ts +0 -30
  211. package/dist/modules/storage/uploadImage.d.ts +0 -42
  212. package/dist/modules/tables/bulkCreate.d.ts +0 -4
  213. package/dist/modules/tables/bulkDelete.d.ts +0 -7
  214. package/dist/modules/tables/create.d.ts +0 -4
  215. package/dist/modules/tables/createTableAccessor.d.ts +0 -9
  216. package/dist/modules/tables/deleteRow.d.ts +0 -9
  217. package/dist/modules/tables/find.d.ts +0 -8
  218. package/dist/modules/tables/findOne.d.ts +0 -7
  219. package/dist/modules/tables/index.d.ts +0 -9
  220. package/dist/modules/tables/restore.d.ts +0 -6
  221. package/dist/modules/tables/update.d.ts +0 -4
  222. package/dist/modules/users/checkUsernameAvailability.d.ts +0 -8
  223. package/dist/modules/users/createBlock.d.ts +0 -19
  224. package/dist/modules/users/createFollow.d.ts +0 -7
  225. package/dist/modules/users/deleteBlock.d.ts +0 -13
  226. package/dist/modules/users/deleteFollow.d.ts +0 -6
  227. package/dist/modules/users/fetchBlockStatus.d.ts +0 -23
  228. package/dist/modules/users/fetchBlockedUsers.d.ts +0 -19
  229. package/dist/modules/users/fetchConnectionStatus.d.ts +0 -10
  230. package/dist/modules/users/fetchConnectionsByUserId.d.ts +0 -11
  231. package/dist/modules/users/fetchConnectionsCountByUserId.d.ts +0 -6
  232. package/dist/modules/users/fetchFollowStatus.d.ts +0 -14
  233. package/dist/modules/users/fetchFollowersByUserId.d.ts +0 -11
  234. package/dist/modules/users/fetchFollowersCountByUserId.d.ts +0 -8
  235. package/dist/modules/users/fetchFollowingByUserId.d.ts +0 -11
  236. package/dist/modules/users/fetchFollowingCountByUserId.d.ts +0 -8
  237. package/dist/modules/users/fetchUserByForeignId.d.ts +0 -8
  238. package/dist/modules/users/fetchUserById.d.ts +0 -8
  239. package/dist/modules/users/fetchUserByUsername.d.ts +0 -8
  240. package/dist/modules/users/fetchUserSuggestions.d.ts +0 -7
  241. package/dist/modules/users/index.d.ts +0 -22
  242. package/dist/modules/users/removeConnectionByUserId.d.ts +0 -10
  243. package/dist/modules/users/requestConnection.d.ts +0 -11
  244. package/dist/modules/users/updateUser.d.ts +0 -32
  245. package/dist/modules/workspaces/acceptInvite.d.ts +0 -13
  246. package/dist/modules/workspaces/acceptWorkspaceInvite.d.ts +0 -13
  247. package/dist/modules/workspaces/createInvite.d.ts +0 -17
  248. package/dist/modules/workspaces/createWorkspace.d.ts +0 -12
  249. package/dist/modules/workspaces/createWorkspaceInvite.d.ts +0 -66
  250. package/dist/modules/workspaces/declineInvite.d.ts +0 -12
  251. package/dist/modules/workspaces/declineWorkspaceInvite.d.ts +0 -14
  252. package/dist/modules/workspaces/deleteWorkspace.d.ts +0 -13
  253. package/dist/modules/workspaces/fetchManyWorkspaces.d.ts +0 -17
  254. package/dist/modules/workspaces/fetchMembers.d.ts +0 -13
  255. package/dist/modules/workspaces/fetchMyInvites.d.ts +0 -11
  256. package/dist/modules/workspaces/fetchMyWorkspaceInvites.d.ts +0 -15
  257. package/dist/modules/workspaces/fetchWorkspace.d.ts +0 -7
  258. package/dist/modules/workspaces/fetchWorkspaceAuthority.d.ts +0 -16
  259. package/dist/modules/workspaces/fetchWorkspaceInvites.d.ts +0 -17
  260. package/dist/modules/workspaces/fetchWorkspaceMemberStanding.d.ts +0 -15
  261. package/dist/modules/workspaces/fetchWorkspaceMembers.d.ts +0 -18
  262. package/dist/modules/workspaces/getAuthority.d.ts +0 -11
  263. package/dist/modules/workspaces/index.d.ts +0 -21
  264. package/dist/modules/workspaces/leaveWorkspace.d.ts +0 -12
  265. package/dist/modules/workspaces/removeWorkspaceMember.d.ts +0 -12
  266. package/dist/modules/workspaces/removeWorkspaceMemberFromSubtree.d.ts +0 -16
  267. package/dist/modules/workspaces/resendWorkspaceInvite.d.ts +0 -12
  268. package/dist/modules/workspaces/revokeWorkspaceInvite.d.ts +0 -13
  269. package/dist/modules/workspaces/transferWorkspaceOwnership.d.ts +0 -15
  270. package/dist/modules/workspaces/updateWorkspace.d.ts +0 -12
  271. package/dist/modules/workspaces/updateWorkspaceInheritFlag.d.ts +0 -13
  272. package/dist/modules/workspaces/updateWorkspaceMember.d.ts +0 -35
@@ -1,29 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Space, ReadingPermission, PostingPermission, SpaceVisibility } from "../../interfaces/Space";
3
- import { ImageOptions } from "../../interfaces/ImageProcessing";
4
- /** A file plus the image-processing options the server requires alongside it. */
5
- export interface SpaceImageUpload {
6
- file: Blob | File;
7
- /** Image-processing config (must include `mode`) — see {@link ImageOptions}. */
8
- options: ImageOptions;
9
- }
10
- export interface CreateSpaceProps {
11
- name: string;
12
- slug?: string;
13
- description?: string;
14
- readingPermission?: ReadingPermission;
15
- postingPermission?: PostingPermission;
16
- visibility?: SpaceVisibility;
17
- requireJoinApproval?: boolean;
18
- parentSpaceId?: string;
19
- metadata?: Record<string, any>;
20
- nsfw?: boolean;
21
- /**
22
- * Avatar image. When present the request is sent as `multipart/form-data` and
23
- * the server processes the image per `options`.
24
- */
25
- avatarFile?: SpaceImageUpload;
26
- /** Banner image; same contract as {@link CreateSpaceProps.avatarFile}. */
27
- bannerFile?: SpaceImageUpload;
28
- }
29
- export declare function createSpace(client: SublayHttpClient, data: CreateSpaceProps): Promise<Space>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { DeclineMemberResponse } from "../../interfaces/Space";
3
- export interface DeclineMembershipProps {
4
- spaceId: string;
5
- memberId: string;
6
- }
7
- export declare function declineMembership(client: SublayHttpClient, data: DeclineMembershipProps): Promise<DeclineMemberResponse>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { DeleteRuleResponse } from "../../interfaces/Rule";
3
- export interface DeleteRuleProps {
4
- spaceId: string;
5
- ruleId: string;
6
- }
7
- export declare function deleteRule(client: SublayHttpClient, data: DeleteRuleProps): Promise<DeleteRuleResponse>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { DeleteSpaceResponse } from "../../interfaces/Space";
3
- export interface DeleteSpaceProps {
4
- spaceId: string;
5
- }
6
- export declare function deleteSpace(client: SublayHttpClient, data: DeleteSpaceProps): Promise<DeleteSpaceResponse>;
@@ -1,11 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Space } from "../../interfaces/Space";
3
- import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
4
- export interface FetchChildSpacesProps {
5
- spaceId: string;
6
- page?: number;
7
- limit?: number;
8
- sortBy?: "alphabetical" | "newest" | "members";
9
- include?: string;
10
- }
11
- export declare function fetchChildSpaces(client: SublayHttpClient, data: FetchChildSpacesProps): Promise<PaginatedResponse<Space>>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { DigestConfig } from "../../interfaces/Space";
3
- export interface FetchDigestConfigProps {
4
- spaceId: string;
5
- }
6
- export declare function fetchDigestConfig(client: SublayHttpClient, data: FetchDigestConfigProps): Promise<DigestConfig>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { FetchManyRulesResponse } from "../../interfaces/Rule";
3
- export interface FetchManyRulesProps {
4
- spaceId: string;
5
- }
6
- export declare function fetchManyRules(client: SublayHttpClient, data: FetchManyRulesProps): Promise<FetchManyRulesResponse>;
@@ -1,17 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Space } from "../../interfaces/Space";
3
- import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
4
- export interface FetchManySpacesProps {
5
- page?: number;
6
- limit?: number;
7
- sortBy?: "alphabetical" | "newest" | "members";
8
- searchSlug?: string;
9
- searchName?: string;
10
- searchDescription?: string;
11
- searchAny?: string;
12
- memberOf?: "true";
13
- parentSpaceId?: string | "null";
14
- nsfwFilter?: "include-all" | "exclude" | "only";
15
- include?: string;
16
- }
17
- export declare function fetchManySpaces(client: SublayHttpClient, data: FetchManySpacesProps): Promise<PaginatedResponse<Space>>;
@@ -1,11 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Space } from "../../interfaces/Space";
3
- import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
4
- export interface FetchMutualSpacesProps {
5
- /** The OTHER user — spaces shared with this user are returned. */
6
- userId: string;
7
- page?: number;
8
- limit?: number;
9
- include?: string;
10
- }
11
- export declare function fetchMutualSpaces(client: SublayHttpClient, { userId, ...params }: FetchMutualSpacesProps): Promise<PaginatedResponse<Space>>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Rule } from "../../interfaces/Rule";
3
- export interface FetchRuleProps {
4
- spaceId: string;
5
- ruleId: string;
6
- }
7
- export declare function fetchRule(client: SublayHttpClient, data: FetchRuleProps): Promise<Rule>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { SpaceDetailed } from "../../interfaces/Space";
3
- export interface FetchSpaceProps {
4
- spaceId: string;
5
- }
6
- export declare function fetchSpace(client: SublayHttpClient, data: FetchSpaceProps): Promise<SpaceDetailed>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { SpaceBreadcrumb } from "../../interfaces/Space";
3
- export interface FetchSpaceBreadcrumbProps {
4
- spaceId: string;
5
- }
6
- export declare function fetchSpaceBreadcrumb(client: SublayHttpClient, data: FetchSpaceBreadcrumbProps): Promise<SpaceBreadcrumb>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { SpaceDetailed } from "../../interfaces/Space";
3
- export interface FetchSpaceByShortIdProps {
4
- shortId: string;
5
- }
6
- export declare function fetchSpaceByShortId(client: SublayHttpClient, data: FetchSpaceByShortIdProps): Promise<SpaceDetailed>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { SpaceDetailed } from "../../interfaces/Space";
3
- export interface FetchSpaceBySlugProps {
4
- slug: string;
5
- }
6
- export declare function fetchSpaceBySlug(client: SublayHttpClient, data: FetchSpaceBySlugProps): Promise<SpaceDetailed>;
@@ -1,11 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { SpaceMembersResponse } from "../../interfaces/SpaceMember";
3
- import { SpaceReputationContextParams } from "../../interfaces/SpaceReputation";
4
- export interface FetchSpaceMembersProps extends SpaceReputationContextParams {
5
- spaceId: string;
6
- page?: number;
7
- limit?: number;
8
- role?: "admin" | "moderator" | "member";
9
- status?: "pending" | "active" | "banned" | "rejected";
10
- }
11
- export declare function fetchSpaceMembers(client: SublayHttpClient, data: FetchSpaceMembersProps): Promise<SpaceMembersResponse>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { SpaceTeamResponse } from "../../interfaces/SpaceMember";
3
- import { SpaceReputationContextParams } from "../../interfaces/SpaceReputation";
4
- export interface FetchSpaceTeamProps extends SpaceReputationContextParams {
5
- spaceId: string;
6
- }
7
- export declare function fetchSpaceTeam(client: SublayHttpClient, data: FetchSpaceTeamProps): Promise<SpaceTeamResponse>;
@@ -1,17 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { UserSpacesResponse } from "../../interfaces/Space";
3
- export interface FetchUserSpacesProps {
4
- page?: number;
5
- limit?: number;
6
- sortBy?: "alphabetical" | "newest" | "members";
7
- include?: string;
8
- role?: string;
9
- all?: "true" | "false";
10
- /**
11
- * Membership status to list. Defaults to `"active"` (spaces the user is in);
12
- * `"pending"` returns join requests awaiting approval, `"banned"` the spaces
13
- * they were removed from.
14
- */
15
- status?: "active" | "pending" | "banned";
16
- }
17
- export declare function fetchUserSpaces(client: SublayHttpClient, data: FetchUserSpacesProps): Promise<UserSpacesResponse>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Conversation } from "../../interfaces/Conversation";
3
- export interface GetSpaceConversationProps {
4
- spaceId: string;
5
- }
6
- export declare function getSpaceConversation(client: SublayHttpClient, data: GetSpaceConversationProps): Promise<Conversation>;
@@ -1,14 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { HandleReportResponse } from "./handleEntityReport";
3
- export type CommentReportAction = "remove-comment" | "ban-user" | "dismiss";
4
- export interface HandleCommentReportProps {
5
- spaceId: string;
6
- reportId: string;
7
- commentId: string;
8
- actions: CommentReportAction[];
9
- summary?: string;
10
- reason?: string;
11
- /** The user to ban (target), required when actions include "ban-user". */
12
- userId?: string;
13
- }
14
- export declare function handleCommentReport(client: SublayHttpClient, data: HandleCommentReportProps): Promise<HandleReportResponse>;
@@ -1,17 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export type EntityReportAction = "remove-entity" | "ban-user" | "dismiss";
3
- export interface HandleEntityReportProps {
4
- spaceId: string;
5
- reportId: string;
6
- entityId: string;
7
- actions: EntityReportAction[];
8
- summary?: string;
9
- reason?: string;
10
- /** The user to ban (target), required when actions include "ban-user". */
11
- userId?: string;
12
- }
13
- export interface HandleReportResponse {
14
- message: string;
15
- code: string;
16
- }
17
- export declare function handleEntityReport(client: SublayHttpClient, data: HandleEntityReportProps): Promise<HandleReportResponse>;
@@ -1,18 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export type SpaceChatReportAction = "remove-message" | "ban-user" | "dismiss";
3
- export interface HandleSpaceChatReportProps {
4
- spaceId: string;
5
- reportId: string;
6
- actions: SpaceChatReportAction[];
7
- summary?: string;
8
- /** The user to ban (target), required when actions include "ban-user". */
9
- userId?: string;
10
- reason?: string;
11
- /** The message to remove, required when actions include "remove-message". */
12
- messageId?: string;
13
- }
14
- export interface HandleSpaceChatReportResponse {
15
- message: string;
16
- code: string;
17
- }
18
- export declare function handleSpaceChatReport(client: SublayHttpClient, data: HandleSpaceChatReportProps): Promise<HandleSpaceChatReportResponse>;
@@ -1,36 +0,0 @@
1
- export { createSpace } from "./createSpace";
2
- export { fetchManySpaces } from "./fetchManySpaces";
3
- export { fetchSpace } from "./fetchSpace";
4
- export { fetchSpaceByShortId } from "./fetchSpaceByShortId";
5
- export { fetchSpaceBySlug } from "./fetchSpaceBySlug";
6
- export { fetchUserSpaces } from "./fetchUserSpaces";
7
- export { fetchMutualSpaces } from "./fetchMutualSpaces";
8
- export { checkSlugAvailability } from "./checkSlugAvailability";
9
- export { updateSpace } from "./updateSpace";
10
- export { deleteSpace } from "./deleteSpace";
11
- export { fetchChildSpaces } from "./fetchChildSpaces";
12
- export { fetchSpaceBreadcrumb } from "./fetchSpaceBreadcrumb";
13
- export { joinSpace } from "./joinSpace";
14
- export { leaveSpace } from "./leaveSpace";
15
- export { checkMyMembership } from "./checkMyMembership";
16
- export { fetchSpaceMembers } from "./fetchSpaceMembers";
17
- export { fetchSpaceTeam } from "./fetchSpaceTeam";
18
- export { updateMemberRole } from "./updateMemberRole";
19
- export { approveMembership } from "./approveMembership";
20
- export { declineMembership } from "./declineMembership";
21
- export { banMember } from "./banMember";
22
- export { unbanMember } from "./unbanMember";
23
- export { fetchManyRules } from "./fetchManyRules";
24
- export { fetchRule } from "./fetchRule";
25
- export { createRule } from "./createRule";
26
- export { updateRule } from "./updateRule";
27
- export { deleteRule } from "./deleteRule";
28
- export { reorderRules } from "./reorderRules";
29
- export { handleEntityReport } from "./handleEntityReport";
30
- export { handleCommentReport } from "./handleCommentReport";
31
- export { moderateSpaceEntity } from "./moderateSpaceEntity";
32
- export { setSpaceEntityNsfw } from "./setSpaceEntityNsfw";
33
- export { moderateSpaceComment } from "./moderateSpaceComment";
34
- export { getSpaceConversation } from "./getSpaceConversation";
35
- export { moderateSpaceChatMessage } from "./moderateSpaceChatMessage";
36
- export { handleSpaceChatReport } from "./handleSpaceChatReport";
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { JoinSpaceResponse } from "../../interfaces/Space";
3
- export interface JoinSpaceProps {
4
- spaceId: string;
5
- }
6
- export declare function joinSpace(client: SublayHttpClient, data: JoinSpaceProps): Promise<JoinSpaceResponse>;
@@ -1,6 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { LeaveSpaceResponse } from "../../interfaces/Space";
3
- export interface LeaveSpaceProps {
4
- spaceId: string;
5
- }
6
- export declare function leaveSpace(client: SublayHttpClient, data: LeaveSpaceProps): Promise<LeaveSpaceResponse>;
@@ -1,12 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export interface ModerateSpaceChatMessageProps {
3
- spaceId: string;
4
- messageId: string;
5
- moderationStatus: "removed";
6
- moderationReason?: string;
7
- }
8
- export interface ModerateSpaceChatMessageResponse {
9
- message: string;
10
- moderationStatus: string;
11
- }
12
- export declare function moderateSpaceChatMessage(client: SublayHttpClient, data: ModerateSpaceChatMessageProps): Promise<ModerateSpaceChatMessageResponse>;
@@ -1,9 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { ModerationResponse } from "./moderateSpaceEntity";
3
- export interface ModerateSpaceCommentProps {
4
- spaceId: string;
5
- commentId: string;
6
- action: "approve" | "remove";
7
- reason?: string;
8
- }
9
- export declare function moderateSpaceComment(client: SublayHttpClient, data: ModerateSpaceCommentProps): Promise<ModerationResponse>;
@@ -1,12 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export interface ModerateSpaceEntityProps {
3
- spaceId: string;
4
- entityId: string;
5
- action: "approve" | "remove";
6
- reason?: string;
7
- }
8
- export interface ModerationResponse {
9
- message: string;
10
- moderationStatus: "approved" | "removed";
11
- }
12
- export declare function moderateSpaceEntity(client: SublayHttpClient, data: ModerateSpaceEntityProps): Promise<ModerationResponse>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Rule } from "../../interfaces/Rule";
3
- export interface ReorderRulesProps {
4
- spaceId: string;
5
- ruleIds: string[];
6
- }
7
- export declare function reorderRules(client: SublayHttpClient, data: ReorderRulesProps): Promise<Rule[]>;
@@ -1,16 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export interface SetSpaceEntityNsfwProps {
3
- spaceId: string;
4
- entityId: string;
5
- nsfw: boolean;
6
- }
7
- export interface SetSpaceEntityNsfwResponse {
8
- message: string;
9
- nsfw: boolean;
10
- }
11
- /**
12
- * Space-moderator endpoint to set the NSFW flag on an entity within their space
13
- * (including other users' entities). Near-copy of `moderateSpaceEntity`, but it
14
- * writes the entity's own `nsfw` (the NSFW axis), not `moderationStatus`.
15
- */
16
- export declare function setSpaceEntityNsfw(client: SublayHttpClient, data: SetSpaceEntityNsfwProps): Promise<SetSpaceEntityNsfwResponse>;
@@ -1,13 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export interface UnbanMemberProps {
3
- spaceId: string;
4
- memberId: string;
5
- }
6
- export interface UnbanMemberResponse {
7
- message: string;
8
- membership: {
9
- id: string;
10
- status: "active";
11
- };
12
- }
13
- export declare function unbanMember(client: SublayHttpClient, data: UnbanMemberProps): Promise<UnbanMemberResponse>;
@@ -1,11 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { DigestConfig } from "../../interfaces/Space";
3
- export interface UpdateDigestConfigProps {
4
- spaceId: string;
5
- digestEnabled?: boolean;
6
- digestWebhookUrl?: string;
7
- digestWebhookSecret?: string;
8
- digestScheduleHour?: number;
9
- digestTimezone?: string;
10
- }
11
- export declare function updateDigestConfig(client: SublayHttpClient, data: UpdateDigestConfigProps): Promise<DigestConfig>;
@@ -1,8 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { UpdateMemberRoleResponse, SpaceMemberRole } from "../../interfaces/Space";
3
- export interface UpdateMemberRoleProps {
4
- spaceId: string;
5
- memberId: string;
6
- role: SpaceMemberRole;
7
- }
8
- export declare function updateMemberRole(client: SublayHttpClient, data: UpdateMemberRoleProps): Promise<UpdateMemberRoleResponse>;
@@ -1,9 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Rule } from "../../interfaces/Rule";
3
- export interface UpdateRuleProps {
4
- spaceId: string;
5
- ruleId: string;
6
- title?: string;
7
- description?: string;
8
- }
9
- export declare function updateRule(client: SublayHttpClient, data: UpdateRuleProps): Promise<Rule>;
@@ -1,22 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { Space, ReadingPermission, PostingPermission, SpaceVisibility } from "../../interfaces/Space";
3
- import type { SpaceImageUpload } from "./createSpace";
4
- export interface UpdateSpaceProps {
5
- spaceId: string;
6
- name?: string;
7
- slug?: string;
8
- description?: string;
9
- readingPermission?: ReadingPermission;
10
- postingPermission?: PostingPermission;
11
- visibility?: SpaceVisibility;
12
- metadata?: Record<string, any>;
13
- nsfw?: boolean;
14
- /**
15
- * New avatar image. When present the request is sent as `multipart/form-data`
16
- * and the server processes the image per `options`, replacing the old avatar.
17
- */
18
- avatarFile?: SpaceImageUpload;
19
- /** New banner image; same contract as {@link UpdateSpaceProps.avatarFile}. */
20
- bannerFile?: SpaceImageUpload;
21
- }
22
- export declare function updateSpace(client: SublayHttpClient, data: UpdateSpaceProps): Promise<Space>;
@@ -1,5 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export interface DeleteFileProps {
3
- fileId: string;
4
- }
5
- export declare function deleteFile(client: SublayHttpClient, data: DeleteFileProps): Promise<void>;
@@ -1,34 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { UploadedImageVariant } from "./uploadImage";
3
- export interface GetFileImage {
4
- originalWidth: number;
5
- originalHeight: number;
6
- variants: Record<string, UploadedImageVariant>;
7
- processingStatus: "completed" | "failed";
8
- format: string;
9
- quality: number;
10
- exifStripped: boolean;
11
- }
12
- /** Shape returned by `GET /storage/:fileId` (a flat projection, not the populated `File` model). */
13
- export interface GetFileResponse {
14
- fileId: string;
15
- type: string;
16
- originalPath: string;
17
- originalSize: number;
18
- originalMimeType: string;
19
- position: number | null;
20
- metadata: Record<string, any> | null;
21
- /** ISO-8601 timestamp. */
22
- createdAt: string;
23
- /** ISO-8601 timestamp. */
24
- updatedAt: string;
25
- userId?: string;
26
- entityId?: string;
27
- commentId?: string;
28
- spaceId?: string;
29
- image?: GetFileImage;
30
- }
31
- export interface GetFileProps {
32
- fileId: string;
33
- }
34
- export declare function getFile(client: SublayHttpClient, data: GetFileProps): Promise<GetFileResponse>;
@@ -1,4 +0,0 @@
1
- export { uploadImage } from "./uploadImage";
2
- export { uploadFile } from "./uploadFile";
3
- export { getFile } from "./getFile";
4
- export { deleteFile } from "./deleteFile";
@@ -1,30 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- export interface UploadFileResponse {
3
- fileId: string;
4
- type: string;
5
- relativePath: string;
6
- publicPath: string;
7
- size: number;
8
- mimeType: string;
9
- /** ISO-8601 timestamp. */
10
- createdAt: string;
11
- }
12
- export interface UploadFileProps {
13
- /** The file to upload, as a browser `File` or `Blob`. */
14
- file: Blob | File;
15
- /** Optional filename for the multipart part (defaults to the `File.name` or `"upload"`). */
16
- filename?: string;
17
- /**
18
- * Storage path segments for the file, e.g. ["avatars", userId]. Required by
19
- * the server (`uploadFileBodySchema.pathParts`).
20
- */
21
- pathParts: string[];
22
- /** Ordering within the associated entity/comment/space. */
23
- position?: number;
24
- metadata?: Record<string, any>;
25
- /** Only one of entityId/commentId/spaceId may be set. */
26
- entityId?: string;
27
- commentId?: string;
28
- spaceId?: string;
29
- }
30
- export declare function uploadFile(client: SublayHttpClient, data: UploadFileProps): Promise<UploadFileResponse>;
@@ -1,42 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { ImageOptions } from "../../interfaces/ImageProcessing";
3
- export interface UploadedImageVariant {
4
- path: string;
5
- width: number;
6
- height: number;
7
- size: number;
8
- format: string;
9
- publicPath: string;
10
- }
11
- export interface UploadImageResponse {
12
- fileId: string;
13
- type: "image";
14
- originalPath: string;
15
- originalSize: number;
16
- originalWidth: number;
17
- originalHeight: number;
18
- variants: Record<string, UploadedImageVariant>;
19
- format: string;
20
- quality: number;
21
- /** ISO-8601 timestamp. */
22
- createdAt: string;
23
- }
24
- export interface UploadImageProps {
25
- /** The image to upload, as a browser `File` or `Blob`. */
26
- file: Blob | File;
27
- /** Optional filename for the multipart part (defaults to the `File.name` or `"upload"`). */
28
- filename?: string;
29
- /**
30
- * Image-processing configuration. A discriminated union on `mode` mirroring
31
- * the server's `uploadImageBodySchema` — see {@link ImageOptions}.
32
- */
33
- imageOptions: ImageOptions;
34
- /** Storage path segments, e.g. ["spaces", spaceId, "banner"]. */
35
- pathParts?: string[];
36
- /** Only one of entityId/commentId/spaceId/eventId may be set. */
37
- entityId?: string;
38
- commentId?: string;
39
- spaceId?: string;
40
- eventId?: string;
41
- }
42
- export declare function uploadImage(client: SublayHttpClient, data: UploadImageProps): Promise<UploadImageResponse>;
@@ -1,4 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { TableRow } from "../../interfaces/Table";
3
- /** POST /db/:tableName/bulk — insert many rows (capped at 100 server-side). */
4
- export declare function bulkCreate<T = TableRow>(client: SublayHttpClient, tableName: string, rows: Array<Partial<T> | Record<string, unknown>>): Promise<T[]>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { BulkDeleteProps, BulkDeleteResult } from "../../interfaces/Table";
3
- /**
4
- * DELETE /db/:tableName — bulk delete by id list and/or `filters` predicate
5
- * (at least one required). Paranoid tables soft-delete unless `force: true`.
6
- */
7
- export declare function bulkDelete(client: SublayHttpClient, tableName: string, params: BulkDeleteProps): Promise<BulkDeleteResult>;
@@ -1,4 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { TableRow } from "../../interfaces/Table";
3
- /** POST /db/:tableName — insert one row. */
4
- export declare function create<T = TableRow>(client: SublayHttpClient, tableName: string, data: Partial<T> | Record<string, unknown>): Promise<T>;
@@ -1,9 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { TableAccessor, TableRow } from "../../interfaces/Table";
3
- /**
4
- * Build the per-table row-operations accessor returned by
5
- * `client.table<T>(name)`. A thin factory that closes over the HTTP client and
6
- * the table name — the one structural novelty over the flat `bindModule`
7
- * namespace, which can't capture a per-call table name.
8
- */
9
- export declare function createTableAccessor<T = TableRow>(client: SublayHttpClient, tableName: string): TableAccessor<T>;
@@ -1,9 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { DeleteResult } from "../../interfaces/Table";
3
- /**
4
- * DELETE /db/:tableName/:rowId — soft-delete on a paranoid table by default;
5
- * `force: true` hard-deletes.
6
- */
7
- export declare function deleteRow(client: SublayHttpClient, tableName: string, rowId: string, opts?: {
8
- force?: boolean;
9
- }): Promise<DeleteResult>;
@@ -1,8 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
3
- import { TableQuery, TableRow } from "../../interfaces/Table";
4
- /**
5
- * GET /db/:tableName — paginated rows with the `{ data, pagination }` envelope.
6
- * `filters` is serialized to a JSON query param; `includeDeleted` to "true"/"false".
7
- */
8
- export declare function find<T = TableRow>(client: SublayHttpClient, tableName: string, query?: TableQuery): Promise<PaginatedResponse<T>>;
@@ -1,7 +0,0 @@
1
- import { SublayHttpClient } from "../../core/client";
2
- import { TableRow } from "../../interfaces/Table";
3
- /**
4
- * GET /db/:tableName/:rowId — a single row (soft-deleted rows 404). Throws on
5
- * 404 (axios), consistent with the other fetch-one methods in the SDK.
6
- */
7
- export declare function findOne<T = TableRow>(client: SublayHttpClient, tableName: string, rowId: string): Promise<T>;