convex-cms 0.0.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 (379) hide show
  1. package/dist/cli/commands/admin.d.ts +16 -0
  2. package/dist/cli/commands/admin.d.ts.map +1 -0
  3. package/dist/cli/commands/admin.js +88 -0
  4. package/dist/cli/commands/admin.js.map +1 -0
  5. package/dist/cli/index.d.ts +3 -0
  6. package/dist/cli/index.d.ts.map +1 -0
  7. package/dist/cli/index.js +18 -0
  8. package/dist/cli/index.js.map +1 -0
  9. package/dist/cli/utils/detectConvexUrl.d.ts +13 -0
  10. package/dist/cli/utils/detectConvexUrl.d.ts.map +1 -0
  11. package/dist/cli/utils/detectConvexUrl.js +48 -0
  12. package/dist/cli/utils/detectConvexUrl.js.map +1 -0
  13. package/dist/cli/utils/openBrowser.d.ts +7 -0
  14. package/dist/cli/utils/openBrowser.d.ts.map +1 -0
  15. package/dist/cli/utils/openBrowser.js +17 -0
  16. package/dist/cli/utils/openBrowser.js.map +1 -0
  17. package/dist/client/admin-config.d.ts +126 -0
  18. package/dist/client/admin-config.d.ts.map +1 -0
  19. package/dist/client/admin-config.js +117 -0
  20. package/dist/client/admin-config.js.map +1 -0
  21. package/dist/client/adminApi.d.ts +2273 -0
  22. package/dist/client/adminApi.d.ts.map +1 -0
  23. package/dist/client/adminApi.js +716 -0
  24. package/dist/client/adminApi.js.map +1 -0
  25. package/dist/client/agentTools.d.ts +933 -0
  26. package/dist/client/agentTools.d.ts.map +1 -0
  27. package/dist/client/agentTools.js +1004 -0
  28. package/dist/client/agentTools.js.map +1 -0
  29. package/dist/client/argTypes.d.ts +212 -0
  30. package/dist/client/argTypes.d.ts.map +1 -0
  31. package/dist/client/argTypes.js +5 -0
  32. package/dist/client/argTypes.js.map +1 -0
  33. package/dist/client/field-types.d.ts +55 -0
  34. package/dist/client/field-types.d.ts.map +1 -0
  35. package/dist/client/field-types.js +152 -0
  36. package/dist/client/field-types.js.map +1 -0
  37. package/dist/client/index.d.ts +189 -0
  38. package/dist/client/index.d.ts.map +1 -0
  39. package/dist/client/index.js +668 -0
  40. package/dist/client/index.js.map +1 -0
  41. package/dist/client/queryBuilder.d.ts +765 -0
  42. package/dist/client/queryBuilder.d.ts.map +1 -0
  43. package/dist/client/queryBuilder.js +970 -0
  44. package/dist/client/queryBuilder.js.map +1 -0
  45. package/dist/client/schema/codegen.d.ts +128 -0
  46. package/dist/client/schema/codegen.d.ts.map +1 -0
  47. package/dist/client/schema/codegen.js +318 -0
  48. package/dist/client/schema/codegen.js.map +1 -0
  49. package/dist/client/schema/defineContentType.d.ts +221 -0
  50. package/dist/client/schema/defineContentType.d.ts.map +1 -0
  51. package/dist/client/schema/defineContentType.js +380 -0
  52. package/dist/client/schema/defineContentType.js.map +1 -0
  53. package/dist/client/schema/index.d.ts +85 -0
  54. package/dist/client/schema/index.d.ts.map +1 -0
  55. package/dist/client/schema/index.js +92 -0
  56. package/dist/client/schema/index.js.map +1 -0
  57. package/dist/client/schema/schemaDrift.d.ts +199 -0
  58. package/dist/client/schema/schemaDrift.d.ts.map +1 -0
  59. package/dist/client/schema/schemaDrift.js +340 -0
  60. package/dist/client/schema/schemaDrift.js.map +1 -0
  61. package/dist/client/schema/typedClient.d.ts +401 -0
  62. package/dist/client/schema/typedClient.d.ts.map +1 -0
  63. package/dist/client/schema/typedClient.js +269 -0
  64. package/dist/client/schema/typedClient.js.map +1 -0
  65. package/dist/client/schema/types.d.ts +477 -0
  66. package/dist/client/schema/types.d.ts.map +1 -0
  67. package/dist/client/schema/types.js +39 -0
  68. package/dist/client/schema/types.js.map +1 -0
  69. package/dist/client/types.d.ts +449 -0
  70. package/dist/client/types.d.ts.map +1 -0
  71. package/dist/client/types.js +149 -0
  72. package/dist/client/types.js.map +1 -0
  73. package/dist/client/workflows.d.ts +51 -0
  74. package/dist/client/workflows.d.ts.map +1 -0
  75. package/dist/client/workflows.js +103 -0
  76. package/dist/client/workflows.js.map +1 -0
  77. package/dist/client/wrapper.d.ts +2198 -0
  78. package/dist/client/wrapper.d.ts.map +1 -0
  79. package/dist/client/wrapper.js +2651 -0
  80. package/dist/client/wrapper.js.map +1 -0
  81. package/dist/component/_generated/api.d.ts +124 -0
  82. package/dist/component/_generated/api.d.ts.map +1 -0
  83. package/dist/component/_generated/api.js +31 -0
  84. package/dist/component/_generated/api.js.map +1 -0
  85. package/dist/component/_generated/component.d.ts +4321 -0
  86. package/dist/component/_generated/component.d.ts.map +1 -0
  87. package/dist/component/_generated/component.js +11 -0
  88. package/dist/component/_generated/component.js.map +1 -0
  89. package/dist/component/_generated/dataModel.d.ts +46 -0
  90. package/dist/component/_generated/dataModel.d.ts.map +1 -0
  91. package/dist/component/_generated/dataModel.js +11 -0
  92. package/dist/component/_generated/dataModel.js.map +1 -0
  93. package/dist/component/_generated/server.d.ts +121 -0
  94. package/dist/component/_generated/server.d.ts.map +1 -0
  95. package/dist/component/_generated/server.js +78 -0
  96. package/dist/component/_generated/server.js.map +1 -0
  97. package/dist/component/auditLog.d.ts +410 -0
  98. package/dist/component/auditLog.d.ts.map +1 -0
  99. package/dist/component/auditLog.js +607 -0
  100. package/dist/component/auditLog.js.map +1 -0
  101. package/dist/component/authorization.d.ts +323 -0
  102. package/dist/component/authorization.d.ts.map +1 -0
  103. package/dist/component/authorization.js +464 -0
  104. package/dist/component/authorization.js.map +1 -0
  105. package/dist/component/authorizationHooks.d.ts +184 -0
  106. package/dist/component/authorizationHooks.d.ts.map +1 -0
  107. package/dist/component/authorizationHooks.js +521 -0
  108. package/dist/component/authorizationHooks.js.map +1 -0
  109. package/dist/component/bulkOperations.d.ts +200 -0
  110. package/dist/component/bulkOperations.d.ts.map +1 -0
  111. package/dist/component/bulkOperations.js +568 -0
  112. package/dist/component/bulkOperations.js.map +1 -0
  113. package/dist/component/contentEntries.d.ts +719 -0
  114. package/dist/component/contentEntries.d.ts.map +1 -0
  115. package/dist/component/contentEntries.js +1617 -0
  116. package/dist/component/contentEntries.js.map +1 -0
  117. package/dist/component/contentEntryMutations.d.ts +505 -0
  118. package/dist/component/contentEntryMutations.d.ts.map +1 -0
  119. package/dist/component/contentEntryMutations.js +1009 -0
  120. package/dist/component/contentEntryMutations.js.map +1 -0
  121. package/dist/component/contentEntryValidation.d.ts +115 -0
  122. package/dist/component/contentEntryValidation.d.ts.map +1 -0
  123. package/dist/component/contentEntryValidation.js +546 -0
  124. package/dist/component/contentEntryValidation.js.map +1 -0
  125. package/dist/component/contentLock.d.ts +328 -0
  126. package/dist/component/contentLock.d.ts.map +1 -0
  127. package/dist/component/contentLock.js +471 -0
  128. package/dist/component/contentLock.js.map +1 -0
  129. package/dist/component/contentTypeMigration.d.ts +411 -0
  130. package/dist/component/contentTypeMigration.d.ts.map +1 -0
  131. package/dist/component/contentTypeMigration.js +805 -0
  132. package/dist/component/contentTypeMigration.js.map +1 -0
  133. package/dist/component/contentTypeMutations.d.ts +975 -0
  134. package/dist/component/contentTypeMutations.d.ts.map +1 -0
  135. package/dist/component/contentTypeMutations.js +768 -0
  136. package/dist/component/contentTypeMutations.js.map +1 -0
  137. package/dist/component/contentTypes.d.ts +538 -0
  138. package/dist/component/contentTypes.d.ts.map +1 -0
  139. package/dist/component/contentTypes.js +304 -0
  140. package/dist/component/contentTypes.js.map +1 -0
  141. package/dist/component/convex.config.d.ts +42 -0
  142. package/dist/component/convex.config.d.ts.map +1 -0
  143. package/dist/component/convex.config.js +43 -0
  144. package/dist/component/convex.config.js.map +1 -0
  145. package/dist/component/documentTypes.d.ts +186 -0
  146. package/dist/component/documentTypes.d.ts.map +1 -0
  147. package/dist/component/documentTypes.js +23 -0
  148. package/dist/component/documentTypes.js.map +1 -0
  149. package/dist/component/eventEmitter.d.ts +281 -0
  150. package/dist/component/eventEmitter.d.ts.map +1 -0
  151. package/dist/component/eventEmitter.js +300 -0
  152. package/dist/component/eventEmitter.js.map +1 -0
  153. package/dist/component/exportImport.d.ts +1120 -0
  154. package/dist/component/exportImport.d.ts.map +1 -0
  155. package/dist/component/exportImport.js +931 -0
  156. package/dist/component/exportImport.js.map +1 -0
  157. package/dist/component/index.d.ts +28 -0
  158. package/dist/component/index.d.ts.map +1 -0
  159. package/dist/component/index.js +142 -0
  160. package/dist/component/index.js.map +1 -0
  161. package/dist/component/lib/deepReferenceResolver.d.ts +252 -0
  162. package/dist/component/lib/deepReferenceResolver.d.ts.map +1 -0
  163. package/dist/component/lib/deepReferenceResolver.js +601 -0
  164. package/dist/component/lib/deepReferenceResolver.js.map +1 -0
  165. package/dist/component/lib/errors.d.ts +306 -0
  166. package/dist/component/lib/errors.d.ts.map +1 -0
  167. package/dist/component/lib/errors.js +407 -0
  168. package/dist/component/lib/errors.js.map +1 -0
  169. package/dist/component/lib/index.d.ts +10 -0
  170. package/dist/component/lib/index.d.ts.map +1 -0
  171. package/dist/component/lib/index.js +33 -0
  172. package/dist/component/lib/index.js.map +1 -0
  173. package/dist/component/lib/mediaReferenceResolver.d.ts +217 -0
  174. package/dist/component/lib/mediaReferenceResolver.d.ts.map +1 -0
  175. package/dist/component/lib/mediaReferenceResolver.js +326 -0
  176. package/dist/component/lib/mediaReferenceResolver.js.map +1 -0
  177. package/dist/component/lib/metadataExtractor.d.ts +245 -0
  178. package/dist/component/lib/metadataExtractor.d.ts.map +1 -0
  179. package/dist/component/lib/metadataExtractor.js +548 -0
  180. package/dist/component/lib/metadataExtractor.js.map +1 -0
  181. package/dist/component/lib/mutationAuth.d.ts +95 -0
  182. package/dist/component/lib/mutationAuth.d.ts.map +1 -0
  183. package/dist/component/lib/mutationAuth.js +146 -0
  184. package/dist/component/lib/mutationAuth.js.map +1 -0
  185. package/dist/component/lib/queries.d.ts +17 -0
  186. package/dist/component/lib/queries.d.ts.map +1 -0
  187. package/dist/component/lib/queries.js +49 -0
  188. package/dist/component/lib/queries.js.map +1 -0
  189. package/dist/component/lib/ragContentChunker.d.ts +423 -0
  190. package/dist/component/lib/ragContentChunker.d.ts.map +1 -0
  191. package/dist/component/lib/ragContentChunker.js +897 -0
  192. package/dist/component/lib/ragContentChunker.js.map +1 -0
  193. package/dist/component/lib/referenceResolver.d.ts +175 -0
  194. package/dist/component/lib/referenceResolver.d.ts.map +1 -0
  195. package/dist/component/lib/referenceResolver.js +293 -0
  196. package/dist/component/lib/referenceResolver.js.map +1 -0
  197. package/dist/component/lib/slugGenerator.d.ts +71 -0
  198. package/dist/component/lib/slugGenerator.d.ts.map +1 -0
  199. package/dist/component/lib/slugGenerator.js +207 -0
  200. package/dist/component/lib/slugGenerator.js.map +1 -0
  201. package/dist/component/lib/slugUniqueness.d.ts +131 -0
  202. package/dist/component/lib/slugUniqueness.d.ts.map +1 -0
  203. package/dist/component/lib/slugUniqueness.js +229 -0
  204. package/dist/component/lib/slugUniqueness.js.map +1 -0
  205. package/dist/component/lib/softDelete.d.ts +18 -0
  206. package/dist/component/lib/softDelete.d.ts.map +1 -0
  207. package/dist/component/lib/softDelete.js +29 -0
  208. package/dist/component/lib/softDelete.js.map +1 -0
  209. package/dist/component/localeFallbackChain.d.ts +410 -0
  210. package/dist/component/localeFallbackChain.d.ts.map +1 -0
  211. package/dist/component/localeFallbackChain.js +467 -0
  212. package/dist/component/localeFallbackChain.js.map +1 -0
  213. package/dist/component/localeFields.d.ts +508 -0
  214. package/dist/component/localeFields.d.ts.map +1 -0
  215. package/dist/component/localeFields.js +592 -0
  216. package/dist/component/localeFields.js.map +1 -0
  217. package/dist/component/mediaAssetMutations.d.ts +235 -0
  218. package/dist/component/mediaAssetMutations.d.ts.map +1 -0
  219. package/dist/component/mediaAssetMutations.js +558 -0
  220. package/dist/component/mediaAssetMutations.js.map +1 -0
  221. package/dist/component/mediaAssets.d.ts +168 -0
  222. package/dist/component/mediaAssets.d.ts.map +1 -0
  223. package/dist/component/mediaAssets.js +618 -0
  224. package/dist/component/mediaAssets.js.map +1 -0
  225. package/dist/component/mediaFolderMutations.d.ts +642 -0
  226. package/dist/component/mediaFolderMutations.d.ts.map +1 -0
  227. package/dist/component/mediaFolderMutations.js +849 -0
  228. package/dist/component/mediaFolderMutations.js.map +1 -0
  229. package/dist/component/mediaUploadMutations.d.ts +136 -0
  230. package/dist/component/mediaUploadMutations.d.ts.map +1 -0
  231. package/dist/component/mediaUploadMutations.js +205 -0
  232. package/dist/component/mediaUploadMutations.js.map +1 -0
  233. package/dist/component/mediaVariantMutations.d.ts +468 -0
  234. package/dist/component/mediaVariantMutations.d.ts.map +1 -0
  235. package/dist/component/mediaVariantMutations.js +737 -0
  236. package/dist/component/mediaVariantMutations.js.map +1 -0
  237. package/dist/component/mediaVariants.d.ts +525 -0
  238. package/dist/component/mediaVariants.d.ts.map +1 -0
  239. package/dist/component/mediaVariants.js +661 -0
  240. package/dist/component/mediaVariants.js.map +1 -0
  241. package/dist/component/ragContentIndexer.d.ts +595 -0
  242. package/dist/component/ragContentIndexer.d.ts.map +1 -0
  243. package/dist/component/ragContentIndexer.js +794 -0
  244. package/dist/component/ragContentIndexer.js.map +1 -0
  245. package/dist/component/rateLimitHooks.d.ts +266 -0
  246. package/dist/component/rateLimitHooks.d.ts.map +1 -0
  247. package/dist/component/rateLimitHooks.js +412 -0
  248. package/dist/component/rateLimitHooks.js.map +1 -0
  249. package/dist/component/roles.d.ts +649 -0
  250. package/dist/component/roles.d.ts.map +1 -0
  251. package/dist/component/roles.js +884 -0
  252. package/dist/component/roles.js.map +1 -0
  253. package/dist/component/scheduledPublish.d.ts +182 -0
  254. package/dist/component/scheduledPublish.d.ts.map +1 -0
  255. package/dist/component/scheduledPublish.js +304 -0
  256. package/dist/component/scheduledPublish.js.map +1 -0
  257. package/dist/component/schema.d.ts +4114 -0
  258. package/dist/component/schema.d.ts.map +1 -0
  259. package/dist/component/schema.js +469 -0
  260. package/dist/component/schema.js.map +1 -0
  261. package/dist/component/taxonomies.d.ts +476 -0
  262. package/dist/component/taxonomies.d.ts.map +1 -0
  263. package/dist/component/taxonomies.js +785 -0
  264. package/dist/component/taxonomies.js.map +1 -0
  265. package/dist/component/taxonomyMutations.d.ts +206 -0
  266. package/dist/component/taxonomyMutations.d.ts.map +1 -0
  267. package/dist/component/taxonomyMutations.js +1001 -0
  268. package/dist/component/taxonomyMutations.js.map +1 -0
  269. package/dist/component/trash.d.ts +265 -0
  270. package/dist/component/trash.d.ts.map +1 -0
  271. package/dist/component/trash.js +621 -0
  272. package/dist/component/trash.js.map +1 -0
  273. package/dist/component/types.d.ts +4 -0
  274. package/dist/component/types.d.ts.map +1 -0
  275. package/dist/component/types.js +2 -0
  276. package/dist/component/types.js.map +1 -0
  277. package/dist/component/userContext.d.ts +508 -0
  278. package/dist/component/userContext.d.ts.map +1 -0
  279. package/dist/component/userContext.js +615 -0
  280. package/dist/component/userContext.js.map +1 -0
  281. package/dist/component/validation.d.ts +387 -0
  282. package/dist/component/validation.d.ts.map +1 -0
  283. package/dist/component/validation.js +1052 -0
  284. package/dist/component/validation.js.map +1 -0
  285. package/dist/component/validators.d.ts +4645 -0
  286. package/dist/component/validators.d.ts.map +1 -0
  287. package/dist/component/validators.js +641 -0
  288. package/dist/component/validators.js.map +1 -0
  289. package/dist/component/versionMutations.d.ts +216 -0
  290. package/dist/component/versionMutations.d.ts.map +1 -0
  291. package/dist/component/versionMutations.js +321 -0
  292. package/dist/component/versionMutations.js.map +1 -0
  293. package/dist/component/webhookTrigger.d.ts +770 -0
  294. package/dist/component/webhookTrigger.d.ts.map +1 -0
  295. package/dist/component/webhookTrigger.js +1413 -0
  296. package/dist/component/webhookTrigger.js.map +1 -0
  297. package/dist/react/index.d.ts +316 -0
  298. package/dist/react/index.d.ts.map +1 -0
  299. package/dist/react/index.js +558 -0
  300. package/dist/react/index.js.map +1 -0
  301. package/dist/test.d.ts +2230 -0
  302. package/dist/test.d.ts.map +1 -0
  303. package/dist/test.js +1107 -0
  304. package/dist/test.js.map +1 -0
  305. package/package.json +95 -0
  306. package/src/cli/commands/admin.ts +104 -0
  307. package/src/cli/index.ts +21 -0
  308. package/src/cli/utils/detectConvexUrl.ts +54 -0
  309. package/src/cli/utils/openBrowser.ts +16 -0
  310. package/src/client/admin-config.ts +138 -0
  311. package/src/client/adminApi.ts +942 -0
  312. package/src/client/agentTools.ts +1311 -0
  313. package/src/client/argTypes.ts +316 -0
  314. package/src/client/field-types.ts +187 -0
  315. package/src/client/index.ts +1301 -0
  316. package/src/client/queryBuilder.ts +1100 -0
  317. package/src/client/schema/codegen.ts +500 -0
  318. package/src/client/schema/defineContentType.ts +501 -0
  319. package/src/client/schema/index.ts +169 -0
  320. package/src/client/schema/schemaDrift.ts +574 -0
  321. package/src/client/schema/typedClient.ts +688 -0
  322. package/src/client/schema/types.ts +666 -0
  323. package/src/client/types.ts +723 -0
  324. package/src/client/workflows.ts +141 -0
  325. package/src/client/wrapper.ts +4304 -0
  326. package/src/component/_generated/api.ts +140 -0
  327. package/src/component/_generated/component.ts +5029 -0
  328. package/src/component/_generated/dataModel.ts +60 -0
  329. package/src/component/_generated/server.ts +156 -0
  330. package/src/component/authorization.ts +647 -0
  331. package/src/component/authorizationHooks.ts +668 -0
  332. package/src/component/bulkOperations.ts +687 -0
  333. package/src/component/contentEntries.ts +1976 -0
  334. package/src/component/contentEntryMutations.ts +1223 -0
  335. package/src/component/contentEntryValidation.ts +707 -0
  336. package/src/component/contentLock.ts +550 -0
  337. package/src/component/contentTypeMigration.ts +1064 -0
  338. package/src/component/contentTypeMutations.ts +969 -0
  339. package/src/component/contentTypes.ts +346 -0
  340. package/src/component/convex.config.ts +44 -0
  341. package/src/component/documentTypes.ts +240 -0
  342. package/src/component/eventEmitter.ts +485 -0
  343. package/src/component/exportImport.ts +1169 -0
  344. package/src/component/index.ts +491 -0
  345. package/src/component/lib/deepReferenceResolver.ts +999 -0
  346. package/src/component/lib/errors.ts +816 -0
  347. package/src/component/lib/index.ts +145 -0
  348. package/src/component/lib/mediaReferenceResolver.ts +495 -0
  349. package/src/component/lib/metadataExtractor.ts +792 -0
  350. package/src/component/lib/mutationAuth.ts +199 -0
  351. package/src/component/lib/queries.ts +79 -0
  352. package/src/component/lib/ragContentChunker.ts +1371 -0
  353. package/src/component/lib/referenceResolver.ts +430 -0
  354. package/src/component/lib/slugGenerator.ts +262 -0
  355. package/src/component/lib/slugUniqueness.ts +333 -0
  356. package/src/component/lib/softDelete.ts +44 -0
  357. package/src/component/localeFallbackChain.ts +673 -0
  358. package/src/component/localeFields.ts +896 -0
  359. package/src/component/mediaAssetMutations.ts +725 -0
  360. package/src/component/mediaAssets.ts +932 -0
  361. package/src/component/mediaFolderMutations.ts +1046 -0
  362. package/src/component/mediaUploadMutations.ts +224 -0
  363. package/src/component/mediaVariantMutations.ts +900 -0
  364. package/src/component/mediaVariants.ts +793 -0
  365. package/src/component/ragContentIndexer.ts +1067 -0
  366. package/src/component/rateLimitHooks.ts +572 -0
  367. package/src/component/roles.ts +1360 -0
  368. package/src/component/scheduledPublish.ts +358 -0
  369. package/src/component/schema.ts +617 -0
  370. package/src/component/taxonomies.ts +949 -0
  371. package/src/component/taxonomyMutations.ts +1210 -0
  372. package/src/component/trash.ts +724 -0
  373. package/src/component/userContext.ts +898 -0
  374. package/src/component/validation.ts +1388 -0
  375. package/src/component/validators.ts +949 -0
  376. package/src/component/versionMutations.ts +392 -0
  377. package/src/component/webhookTrigger.ts +1922 -0
  378. package/src/react/index.ts +898 -0
  379. package/src/test.ts +1580 -0
@@ -0,0 +1,2273 @@
1
+ /**
2
+ * Admin API Helper for Convex CMS
3
+ *
4
+ * This module provides the `defineAdminAPI` function that creates typed
5
+ * Convex functions for the admin UI to call. Users export these functions
6
+ * from their `convex/` directory, which the admin UI then calls.
7
+ *
8
+ * This follows the standard Convex component pattern used by:
9
+ * - @convex-dev/agent's `definePlaygroundAPI`
10
+ * - template-component's `exposeApi`
11
+ * - @dodopayments/convex's class-based API
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * // convex/admin.ts
16
+ * import { defineAdminAPI } from "@convex-cms/core";
17
+ * import { components } from "./_generated/api";
18
+ *
19
+ * export const {
20
+ * contentTypes,
21
+ * entries,
22
+ * media,
23
+ * stats,
24
+ * } = defineAdminAPI(components.convexCms, {
25
+ * auth: async (ctx, operation) => {
26
+ * // Optional: validate user has admin access
27
+ * const identity = await ctx.auth.getUserIdentity();
28
+ * if (!identity) throw new Error("Unauthorized");
29
+ * return identity.subject;
30
+ * },
31
+ * });
32
+ * ```
33
+ */
34
+ import { type Auth } from "convex/server";
35
+ import type { ComponentApi } from "../component/_generated/component.js";
36
+ /**
37
+ * Operation context passed to the auth callback.
38
+ */
39
+ export type AdminOperation = {
40
+ type: "contentTypes.list";
41
+ } | {
42
+ type: "contentTypes.get";
43
+ id: string;
44
+ } | {
45
+ type: "contentTypes.create";
46
+ } | {
47
+ type: "contentTypes.update";
48
+ id: string;
49
+ } | {
50
+ type: "contentTypes.delete";
51
+ id: string;
52
+ } | {
53
+ type: "entries.list";
54
+ contentTypeId: string;
55
+ } | {
56
+ type: "entries.get";
57
+ id: string;
58
+ } | {
59
+ type: "entries.create";
60
+ contentTypeId: string;
61
+ } | {
62
+ type: "entries.update";
63
+ id: string;
64
+ } | {
65
+ type: "entries.publish";
66
+ id: string;
67
+ } | {
68
+ type: "entries.unpublish";
69
+ id: string;
70
+ } | {
71
+ type: "entries.delete";
72
+ id: string;
73
+ } | {
74
+ type: "entries.duplicate";
75
+ id: string;
76
+ } | {
77
+ type: "entries.schedule";
78
+ id: string;
79
+ } | {
80
+ type: "entries.cancelSchedule";
81
+ id: string;
82
+ } | {
83
+ type: "entries.getScheduled";
84
+ } | {
85
+ type: "media.assets.list";
86
+ } | {
87
+ type: "media.assets.get";
88
+ id: string;
89
+ } | {
90
+ type: "media.assets.create";
91
+ } | {
92
+ type: "media.assets.update";
93
+ id: string;
94
+ } | {
95
+ type: "media.assets.delete";
96
+ id: string;
97
+ } | {
98
+ type: "media.assets.restore";
99
+ id: string;
100
+ } | {
101
+ type: "media.assets.move";
102
+ } | {
103
+ type: "media.folders.list";
104
+ } | {
105
+ type: "media.folders.get";
106
+ id: string;
107
+ } | {
108
+ type: "media.folders.getTree";
109
+ } | {
110
+ type: "media.folders.create";
111
+ } | {
112
+ type: "media.folders.update";
113
+ id: string;
114
+ } | {
115
+ type: "media.folders.move";
116
+ id: string;
117
+ } | {
118
+ type: "media.folders.delete";
119
+ id: string;
120
+ } | {
121
+ type: "media.folders.restore";
122
+ id: string;
123
+ } | {
124
+ type: "media.generateUploadUrl";
125
+ } | {
126
+ type: "stats.getDashboardStats";
127
+ };
128
+ /**
129
+ * Options for configuring the admin API.
130
+ */
131
+ export interface AdminApiOptions {
132
+ /**
133
+ * Optional authentication callback.
134
+ *
135
+ * Called before each operation to validate access. Should throw if
136
+ * unauthorized. Returns the authenticated user's ID (or null for anonymous).
137
+ *
138
+ * If not provided, all operations are allowed (useful for development).
139
+ *
140
+ * @example
141
+ * ```typescript
142
+ * auth: async (ctx, operation) => {
143
+ * const identity = await ctx.auth.getUserIdentity();
144
+ * if (!identity) throw new Error("Unauthorized");
145
+ * // Could also check operation.type for fine-grained access control
146
+ * return identity.subject;
147
+ * }
148
+ * ```
149
+ */
150
+ auth?: (ctx: {
151
+ auth: Auth;
152
+ }, operation: AdminOperation) => Promise<string | null>;
153
+ }
154
+ /**
155
+ * Creates typed Convex functions for the CMS admin UI.
156
+ *
157
+ * This function returns an object containing query and mutation functions
158
+ * that the admin UI calls. Users export these from their `convex/` directory.
159
+ *
160
+ * @param component - The CMS component API from `components.convexCms`
161
+ * @param options - Optional configuration including auth callback
162
+ * @returns Object with namespaced admin functions
163
+ *
164
+ * @example
165
+ * ```typescript
166
+ * // convex/admin.ts
167
+ * import { defineAdminAPI } from "@convex-cms/core";
168
+ * import { components } from "./_generated/api";
169
+ *
170
+ * export const { contentTypes, entries, media, stats } = defineAdminAPI(
171
+ * components.convexCms
172
+ * );
173
+ * ```
174
+ */
175
+ export declare function defineAdminAPI(component: ComponentApi, options?: AdminApiOptions): {
176
+ contentTypes: {
177
+ list: import("convex/server").RegisteredQuery<"public", {
178
+ isActive?: boolean | undefined;
179
+ }, Promise<{
180
+ continueCursor: string | null;
181
+ isDone: boolean;
182
+ page: Array<{
183
+ _creationTime: number;
184
+ _id: string;
185
+ createdBy: string;
186
+ deletedAt?: number;
187
+ description?: string;
188
+ displayName: string;
189
+ fields: Array<{
190
+ defaultValue?: any;
191
+ description?: string;
192
+ label: string;
193
+ localized?: boolean;
194
+ name: string;
195
+ options?: {
196
+ maxLength?: number;
197
+ minLength?: number;
198
+ pattern?: string;
199
+ };
200
+ required: boolean;
201
+ searchable?: boolean;
202
+ type: "text";
203
+ } | {
204
+ defaultValue?: any;
205
+ description?: string;
206
+ label: string;
207
+ localized?: boolean;
208
+ name: string;
209
+ options?: {
210
+ max?: number;
211
+ min?: number;
212
+ precision?: number;
213
+ step?: number;
214
+ };
215
+ required: boolean;
216
+ searchable?: boolean;
217
+ type: "number";
218
+ } | {
219
+ defaultValue?: any;
220
+ description?: string;
221
+ label: string;
222
+ localized?: boolean;
223
+ name: string;
224
+ options?: {
225
+ falseLabel?: string;
226
+ trueLabel?: string;
227
+ };
228
+ required: boolean;
229
+ searchable?: boolean;
230
+ type: "boolean";
231
+ } | {
232
+ defaultValue?: any;
233
+ description?: string;
234
+ label: string;
235
+ localized?: boolean;
236
+ name: string;
237
+ options?: {
238
+ allowedBlocks?: Array<string>;
239
+ allowedMarks?: Array<string>;
240
+ };
241
+ required: boolean;
242
+ searchable?: boolean;
243
+ type: "richText";
244
+ } | {
245
+ defaultValue?: any;
246
+ description?: string;
247
+ label: string;
248
+ localized?: boolean;
249
+ name: string;
250
+ options?: {
251
+ allowedMimeTypes?: Array<string>;
252
+ maxFileSize?: number;
253
+ mediaType?: "image" | "video" | "audio" | "document" | "other";
254
+ multiple?: boolean;
255
+ };
256
+ required: boolean;
257
+ searchable?: boolean;
258
+ type: "media";
259
+ } | {
260
+ defaultValue?: any;
261
+ description?: string;
262
+ label: string;
263
+ localized?: boolean;
264
+ name: string;
265
+ options?: {
266
+ options?: Array<{
267
+ label: string;
268
+ value: string;
269
+ }>;
270
+ };
271
+ required: boolean;
272
+ searchable?: boolean;
273
+ type: "select";
274
+ } | {
275
+ defaultValue?: any;
276
+ description?: string;
277
+ label: string;
278
+ localized?: boolean;
279
+ name: string;
280
+ options?: {
281
+ options?: Array<{
282
+ label: string;
283
+ value: string;
284
+ }>;
285
+ };
286
+ required: boolean;
287
+ searchable?: boolean;
288
+ type: "multiSelect";
289
+ } | {
290
+ defaultValue?: any;
291
+ description?: string;
292
+ label: string;
293
+ localized?: boolean;
294
+ name: string;
295
+ options?: {
296
+ allowCreate?: boolean;
297
+ maxTags?: number;
298
+ minTags?: number;
299
+ taxonomyId?: string;
300
+ };
301
+ required: boolean;
302
+ searchable?: boolean;
303
+ type: "tags";
304
+ } | {
305
+ defaultValue?: any;
306
+ description?: string;
307
+ label: string;
308
+ localized?: boolean;
309
+ name: string;
310
+ options?: {
311
+ allowMultiple?: boolean;
312
+ };
313
+ required: boolean;
314
+ searchable?: boolean;
315
+ type: "category";
316
+ } | {
317
+ defaultValue?: any;
318
+ description?: string;
319
+ label: string;
320
+ localized?: boolean;
321
+ name: string;
322
+ options?: {
323
+ schema?: any;
324
+ };
325
+ required: boolean;
326
+ searchable?: boolean;
327
+ type: "json";
328
+ } | {
329
+ defaultValue?: any;
330
+ description?: string;
331
+ label: string;
332
+ localized?: boolean;
333
+ name: string;
334
+ options?: {
335
+ max?: number;
336
+ min?: number;
337
+ };
338
+ required: boolean;
339
+ searchable?: boolean;
340
+ type: "date";
341
+ } | {
342
+ defaultValue?: any;
343
+ description?: string;
344
+ label: string;
345
+ localized?: boolean;
346
+ name: string;
347
+ options?: {
348
+ max?: number;
349
+ min?: number;
350
+ };
351
+ required: boolean;
352
+ searchable?: boolean;
353
+ type: "datetime";
354
+ } | {
355
+ defaultValue?: any;
356
+ description?: string;
357
+ label: string;
358
+ localized?: boolean;
359
+ name: string;
360
+ options?: {
361
+ allowedContentTypes?: Array<string>;
362
+ minItems?: number;
363
+ multiple?: boolean;
364
+ };
365
+ required: boolean;
366
+ searchable?: boolean;
367
+ type: "reference";
368
+ }>;
369
+ icon?: string;
370
+ isActive: boolean;
371
+ name: string;
372
+ singleton?: boolean;
373
+ slugField?: string;
374
+ sortOrder?: number;
375
+ titleField?: string;
376
+ updatedBy?: string;
377
+ }>;
378
+ }>>;
379
+ get: import("convex/server").RegisteredQuery<"public", {
380
+ id?: string | undefined;
381
+ name?: string | undefined;
382
+ }, Promise<{
383
+ _creationTime: number;
384
+ _id: string;
385
+ createdBy: string;
386
+ deletedAt?: number;
387
+ description?: string;
388
+ displayName: string;
389
+ fields: Array<{
390
+ defaultValue?: any;
391
+ description?: string;
392
+ label: string;
393
+ localized?: boolean;
394
+ name: string;
395
+ options?: {
396
+ maxLength?: number;
397
+ minLength?: number;
398
+ pattern?: string;
399
+ };
400
+ required: boolean;
401
+ searchable?: boolean;
402
+ type: "text";
403
+ } | {
404
+ defaultValue?: any;
405
+ description?: string;
406
+ label: string;
407
+ localized?: boolean;
408
+ name: string;
409
+ options?: {
410
+ max?: number;
411
+ min?: number;
412
+ precision?: number;
413
+ step?: number;
414
+ };
415
+ required: boolean;
416
+ searchable?: boolean;
417
+ type: "number";
418
+ } | {
419
+ defaultValue?: any;
420
+ description?: string;
421
+ label: string;
422
+ localized?: boolean;
423
+ name: string;
424
+ options?: {
425
+ falseLabel?: string;
426
+ trueLabel?: string;
427
+ };
428
+ required: boolean;
429
+ searchable?: boolean;
430
+ type: "boolean";
431
+ } | {
432
+ defaultValue?: any;
433
+ description?: string;
434
+ label: string;
435
+ localized?: boolean;
436
+ name: string;
437
+ options?: {
438
+ allowedBlocks?: Array<string>;
439
+ allowedMarks?: Array<string>;
440
+ };
441
+ required: boolean;
442
+ searchable?: boolean;
443
+ type: "richText";
444
+ } | {
445
+ defaultValue?: any;
446
+ description?: string;
447
+ label: string;
448
+ localized?: boolean;
449
+ name: string;
450
+ options?: {
451
+ allowedMimeTypes?: Array<string>;
452
+ maxFileSize?: number;
453
+ mediaType?: "image" | "video" | "audio" | "document" | "other";
454
+ multiple?: boolean;
455
+ };
456
+ required: boolean;
457
+ searchable?: boolean;
458
+ type: "media";
459
+ } | {
460
+ defaultValue?: any;
461
+ description?: string;
462
+ label: string;
463
+ localized?: boolean;
464
+ name: string;
465
+ options?: {
466
+ options?: Array<{
467
+ label: string;
468
+ value: string;
469
+ }>;
470
+ };
471
+ required: boolean;
472
+ searchable?: boolean;
473
+ type: "select";
474
+ } | {
475
+ defaultValue?: any;
476
+ description?: string;
477
+ label: string;
478
+ localized?: boolean;
479
+ name: string;
480
+ options?: {
481
+ options?: Array<{
482
+ label: string;
483
+ value: string;
484
+ }>;
485
+ };
486
+ required: boolean;
487
+ searchable?: boolean;
488
+ type: "multiSelect";
489
+ } | {
490
+ defaultValue?: any;
491
+ description?: string;
492
+ label: string;
493
+ localized?: boolean;
494
+ name: string;
495
+ options?: {
496
+ allowCreate?: boolean;
497
+ maxTags?: number;
498
+ minTags?: number;
499
+ taxonomyId?: string;
500
+ };
501
+ required: boolean;
502
+ searchable?: boolean;
503
+ type: "tags";
504
+ } | {
505
+ defaultValue?: any;
506
+ description?: string;
507
+ label: string;
508
+ localized?: boolean;
509
+ name: string;
510
+ options?: {
511
+ allowMultiple?: boolean;
512
+ };
513
+ required: boolean;
514
+ searchable?: boolean;
515
+ type: "category";
516
+ } | {
517
+ defaultValue?: any;
518
+ description?: string;
519
+ label: string;
520
+ localized?: boolean;
521
+ name: string;
522
+ options?: {
523
+ schema?: any;
524
+ };
525
+ required: boolean;
526
+ searchable?: boolean;
527
+ type: "json";
528
+ } | {
529
+ defaultValue?: any;
530
+ description?: string;
531
+ label: string;
532
+ localized?: boolean;
533
+ name: string;
534
+ options?: {
535
+ max?: number;
536
+ min?: number;
537
+ };
538
+ required: boolean;
539
+ searchable?: boolean;
540
+ type: "date";
541
+ } | {
542
+ defaultValue?: any;
543
+ description?: string;
544
+ label: string;
545
+ localized?: boolean;
546
+ name: string;
547
+ options?: {
548
+ max?: number;
549
+ min?: number;
550
+ };
551
+ required: boolean;
552
+ searchable?: boolean;
553
+ type: "datetime";
554
+ } | {
555
+ defaultValue?: any;
556
+ description?: string;
557
+ label: string;
558
+ localized?: boolean;
559
+ name: string;
560
+ options?: {
561
+ allowedContentTypes?: Array<string>;
562
+ minItems?: number;
563
+ multiple?: boolean;
564
+ };
565
+ required: boolean;
566
+ searchable?: boolean;
567
+ type: "reference";
568
+ }>;
569
+ icon?: string;
570
+ isActive: boolean;
571
+ name: string;
572
+ singleton?: boolean;
573
+ slugField?: string;
574
+ sortOrder?: number;
575
+ titleField?: string;
576
+ updatedBy?: string;
577
+ } | null>>;
578
+ create: import("convex/server").RegisteredMutation<"public", {
579
+ description?: string | undefined;
580
+ sortOrder?: number | undefined;
581
+ icon?: string | undefined;
582
+ singleton?: boolean | undefined;
583
+ slugField?: string | undefined;
584
+ titleField?: string | undefined;
585
+ fields: ({
586
+ options?: {
587
+ minLength?: number | undefined;
588
+ maxLength?: number | undefined;
589
+ pattern?: string | undefined;
590
+ } | undefined;
591
+ searchable?: boolean | undefined;
592
+ localized?: boolean | undefined;
593
+ description?: string | undefined;
594
+ defaultValue?: any;
595
+ required: boolean;
596
+ type: "text";
597
+ name: string;
598
+ label: string;
599
+ } | {
600
+ options?: {
601
+ min?: number | undefined;
602
+ max?: number | undefined;
603
+ step?: number | undefined;
604
+ precision?: number | undefined;
605
+ } | undefined;
606
+ searchable?: boolean | undefined;
607
+ localized?: boolean | undefined;
608
+ description?: string | undefined;
609
+ defaultValue?: any;
610
+ required: boolean;
611
+ type: "number";
612
+ name: string;
613
+ label: string;
614
+ } | {
615
+ options?: {
616
+ trueLabel?: string | undefined;
617
+ falseLabel?: string | undefined;
618
+ } | undefined;
619
+ searchable?: boolean | undefined;
620
+ localized?: boolean | undefined;
621
+ description?: string | undefined;
622
+ defaultValue?: any;
623
+ required: boolean;
624
+ type: "boolean";
625
+ name: string;
626
+ label: string;
627
+ } | {
628
+ options?: {
629
+ allowedBlocks?: string[] | undefined;
630
+ allowedMarks?: string[] | undefined;
631
+ } | undefined;
632
+ searchable?: boolean | undefined;
633
+ localized?: boolean | undefined;
634
+ description?: string | undefined;
635
+ defaultValue?: any;
636
+ required: boolean;
637
+ type: "richText";
638
+ name: string;
639
+ label: string;
640
+ } | {
641
+ options?: {
642
+ mediaType?: "image" | "video" | "audio" | "document" | "other" | undefined;
643
+ allowedMimeTypes?: string[] | undefined;
644
+ maxFileSize?: number | undefined;
645
+ multiple?: boolean | undefined;
646
+ } | undefined;
647
+ searchable?: boolean | undefined;
648
+ localized?: boolean | undefined;
649
+ description?: string | undefined;
650
+ defaultValue?: any;
651
+ required: boolean;
652
+ type: "media";
653
+ name: string;
654
+ label: string;
655
+ } | {
656
+ options?: {
657
+ options?: {
658
+ label: string;
659
+ value: string;
660
+ }[] | undefined;
661
+ } | undefined;
662
+ searchable?: boolean | undefined;
663
+ localized?: boolean | undefined;
664
+ description?: string | undefined;
665
+ defaultValue?: any;
666
+ required: boolean;
667
+ type: "select";
668
+ name: string;
669
+ label: string;
670
+ } | {
671
+ options?: {
672
+ taxonomyId?: import("convex/values").GenericId<"taxonomies"> | undefined;
673
+ allowCreate?: boolean | undefined;
674
+ maxTags?: number | undefined;
675
+ minTags?: number | undefined;
676
+ } | undefined;
677
+ searchable?: boolean | undefined;
678
+ localized?: boolean | undefined;
679
+ description?: string | undefined;
680
+ defaultValue?: any;
681
+ required: boolean;
682
+ type: "tags";
683
+ name: string;
684
+ label: string;
685
+ } | {
686
+ options?: {
687
+ allowMultiple?: boolean | undefined;
688
+ } | undefined;
689
+ searchable?: boolean | undefined;
690
+ localized?: boolean | undefined;
691
+ description?: string | undefined;
692
+ defaultValue?: any;
693
+ required: boolean;
694
+ type: "category";
695
+ name: string;
696
+ label: string;
697
+ } | {
698
+ options?: {
699
+ schema?: any;
700
+ } | undefined;
701
+ searchable?: boolean | undefined;
702
+ localized?: boolean | undefined;
703
+ description?: string | undefined;
704
+ defaultValue?: any;
705
+ required: boolean;
706
+ type: "json";
707
+ name: string;
708
+ label: string;
709
+ } | {
710
+ options?: {
711
+ multiple?: boolean | undefined;
712
+ allowedContentTypes?: string[] | undefined;
713
+ minItems?: number | undefined;
714
+ } | undefined;
715
+ searchable?: boolean | undefined;
716
+ localized?: boolean | undefined;
717
+ description?: string | undefined;
718
+ defaultValue?: any;
719
+ required: boolean;
720
+ type: "reference";
721
+ name: string;
722
+ label: string;
723
+ } | {
724
+ options?: {
725
+ options?: {
726
+ label: string;
727
+ value: string;
728
+ }[] | undefined;
729
+ } | undefined;
730
+ searchable?: boolean | undefined;
731
+ localized?: boolean | undefined;
732
+ description?: string | undefined;
733
+ defaultValue?: any;
734
+ required: boolean;
735
+ type: "multiSelect";
736
+ name: string;
737
+ label: string;
738
+ } | {
739
+ options?: {
740
+ min?: number | undefined;
741
+ max?: number | undefined;
742
+ } | undefined;
743
+ searchable?: boolean | undefined;
744
+ localized?: boolean | undefined;
745
+ description?: string | undefined;
746
+ defaultValue?: any;
747
+ required: boolean;
748
+ type: "date";
749
+ name: string;
750
+ label: string;
751
+ } | {
752
+ options?: {
753
+ min?: number | undefined;
754
+ max?: number | undefined;
755
+ } | undefined;
756
+ searchable?: boolean | undefined;
757
+ localized?: boolean | undefined;
758
+ description?: string | undefined;
759
+ defaultValue?: any;
760
+ required: boolean;
761
+ type: "datetime";
762
+ name: string;
763
+ label: string;
764
+ })[];
765
+ name: string;
766
+ createdBy: string;
767
+ displayName: string;
768
+ }, Promise<{
769
+ _creationTime: number;
770
+ _id: string;
771
+ createdBy: string;
772
+ deletedAt?: number;
773
+ description?: string;
774
+ displayName: string;
775
+ fields: Array<{
776
+ defaultValue?: any;
777
+ description?: string;
778
+ label: string;
779
+ localized?: boolean;
780
+ name: string;
781
+ options?: {
782
+ maxLength?: number;
783
+ minLength?: number;
784
+ pattern?: string;
785
+ };
786
+ required: boolean;
787
+ searchable?: boolean;
788
+ type: "text";
789
+ } | {
790
+ defaultValue?: any;
791
+ description?: string;
792
+ label: string;
793
+ localized?: boolean;
794
+ name: string;
795
+ options?: {
796
+ max?: number;
797
+ min?: number;
798
+ precision?: number;
799
+ step?: number;
800
+ };
801
+ required: boolean;
802
+ searchable?: boolean;
803
+ type: "number";
804
+ } | {
805
+ defaultValue?: any;
806
+ description?: string;
807
+ label: string;
808
+ localized?: boolean;
809
+ name: string;
810
+ options?: {
811
+ falseLabel?: string;
812
+ trueLabel?: string;
813
+ };
814
+ required: boolean;
815
+ searchable?: boolean;
816
+ type: "boolean";
817
+ } | {
818
+ defaultValue?: any;
819
+ description?: string;
820
+ label: string;
821
+ localized?: boolean;
822
+ name: string;
823
+ options?: {
824
+ allowedBlocks?: Array<string>;
825
+ allowedMarks?: Array<string>;
826
+ };
827
+ required: boolean;
828
+ searchable?: boolean;
829
+ type: "richText";
830
+ } | {
831
+ defaultValue?: any;
832
+ description?: string;
833
+ label: string;
834
+ localized?: boolean;
835
+ name: string;
836
+ options?: {
837
+ allowedMimeTypes?: Array<string>;
838
+ maxFileSize?: number;
839
+ mediaType?: "image" | "video" | "audio" | "document" | "other";
840
+ multiple?: boolean;
841
+ };
842
+ required: boolean;
843
+ searchable?: boolean;
844
+ type: "media";
845
+ } | {
846
+ defaultValue?: any;
847
+ description?: string;
848
+ label: string;
849
+ localized?: boolean;
850
+ name: string;
851
+ options?: {
852
+ options?: Array<{
853
+ label: string;
854
+ value: string;
855
+ }>;
856
+ };
857
+ required: boolean;
858
+ searchable?: boolean;
859
+ type: "select";
860
+ } | {
861
+ defaultValue?: any;
862
+ description?: string;
863
+ label: string;
864
+ localized?: boolean;
865
+ name: string;
866
+ options?: {
867
+ options?: Array<{
868
+ label: string;
869
+ value: string;
870
+ }>;
871
+ };
872
+ required: boolean;
873
+ searchable?: boolean;
874
+ type: "multiSelect";
875
+ } | {
876
+ defaultValue?: any;
877
+ description?: string;
878
+ label: string;
879
+ localized?: boolean;
880
+ name: string;
881
+ options?: {
882
+ allowCreate?: boolean;
883
+ maxTags?: number;
884
+ minTags?: number;
885
+ taxonomyId?: string;
886
+ };
887
+ required: boolean;
888
+ searchable?: boolean;
889
+ type: "tags";
890
+ } | {
891
+ defaultValue?: any;
892
+ description?: string;
893
+ label: string;
894
+ localized?: boolean;
895
+ name: string;
896
+ options?: {
897
+ allowMultiple?: boolean;
898
+ };
899
+ required: boolean;
900
+ searchable?: boolean;
901
+ type: "category";
902
+ } | {
903
+ defaultValue?: any;
904
+ description?: string;
905
+ label: string;
906
+ localized?: boolean;
907
+ name: string;
908
+ options?: {
909
+ schema?: any;
910
+ };
911
+ required: boolean;
912
+ searchable?: boolean;
913
+ type: "json";
914
+ } | {
915
+ defaultValue?: any;
916
+ description?: string;
917
+ label: string;
918
+ localized?: boolean;
919
+ name: string;
920
+ options?: {
921
+ max?: number;
922
+ min?: number;
923
+ };
924
+ required: boolean;
925
+ searchable?: boolean;
926
+ type: "date";
927
+ } | {
928
+ defaultValue?: any;
929
+ description?: string;
930
+ label: string;
931
+ localized?: boolean;
932
+ name: string;
933
+ options?: {
934
+ max?: number;
935
+ min?: number;
936
+ };
937
+ required: boolean;
938
+ searchable?: boolean;
939
+ type: "datetime";
940
+ } | {
941
+ defaultValue?: any;
942
+ description?: string;
943
+ label: string;
944
+ localized?: boolean;
945
+ name: string;
946
+ options?: {
947
+ allowedContentTypes?: Array<string>;
948
+ minItems?: number;
949
+ multiple?: boolean;
950
+ };
951
+ required: boolean;
952
+ searchable?: boolean;
953
+ type: "reference";
954
+ }>;
955
+ icon?: string;
956
+ isActive: boolean;
957
+ name: string;
958
+ singleton?: boolean;
959
+ slugField?: string;
960
+ sortOrder?: number;
961
+ titleField?: string;
962
+ updatedBy?: string;
963
+ }>>;
964
+ update: import("convex/server").RegisteredMutation<"public", {
965
+ fields?: ({
966
+ options?: {
967
+ minLength?: number | undefined;
968
+ maxLength?: number | undefined;
969
+ pattern?: string | undefined;
970
+ } | undefined;
971
+ searchable?: boolean | undefined;
972
+ localized?: boolean | undefined;
973
+ description?: string | undefined;
974
+ defaultValue?: any;
975
+ required: boolean;
976
+ type: "text";
977
+ name: string;
978
+ label: string;
979
+ } | {
980
+ options?: {
981
+ min?: number | undefined;
982
+ max?: number | undefined;
983
+ step?: number | undefined;
984
+ precision?: number | undefined;
985
+ } | undefined;
986
+ searchable?: boolean | undefined;
987
+ localized?: boolean | undefined;
988
+ description?: string | undefined;
989
+ defaultValue?: any;
990
+ required: boolean;
991
+ type: "number";
992
+ name: string;
993
+ label: string;
994
+ } | {
995
+ options?: {
996
+ trueLabel?: string | undefined;
997
+ falseLabel?: string | undefined;
998
+ } | undefined;
999
+ searchable?: boolean | undefined;
1000
+ localized?: boolean | undefined;
1001
+ description?: string | undefined;
1002
+ defaultValue?: any;
1003
+ required: boolean;
1004
+ type: "boolean";
1005
+ name: string;
1006
+ label: string;
1007
+ } | {
1008
+ options?: {
1009
+ allowedBlocks?: string[] | undefined;
1010
+ allowedMarks?: string[] | undefined;
1011
+ } | undefined;
1012
+ searchable?: boolean | undefined;
1013
+ localized?: boolean | undefined;
1014
+ description?: string | undefined;
1015
+ defaultValue?: any;
1016
+ required: boolean;
1017
+ type: "richText";
1018
+ name: string;
1019
+ label: string;
1020
+ } | {
1021
+ options?: {
1022
+ mediaType?: "image" | "video" | "audio" | "document" | "other" | undefined;
1023
+ allowedMimeTypes?: string[] | undefined;
1024
+ maxFileSize?: number | undefined;
1025
+ multiple?: boolean | undefined;
1026
+ } | undefined;
1027
+ searchable?: boolean | undefined;
1028
+ localized?: boolean | undefined;
1029
+ description?: string | undefined;
1030
+ defaultValue?: any;
1031
+ required: boolean;
1032
+ type: "media";
1033
+ name: string;
1034
+ label: string;
1035
+ } | {
1036
+ options?: {
1037
+ options?: {
1038
+ label: string;
1039
+ value: string;
1040
+ }[] | undefined;
1041
+ } | undefined;
1042
+ searchable?: boolean | undefined;
1043
+ localized?: boolean | undefined;
1044
+ description?: string | undefined;
1045
+ defaultValue?: any;
1046
+ required: boolean;
1047
+ type: "select";
1048
+ name: string;
1049
+ label: string;
1050
+ } | {
1051
+ options?: {
1052
+ taxonomyId?: import("convex/values").GenericId<"taxonomies"> | undefined;
1053
+ allowCreate?: boolean | undefined;
1054
+ maxTags?: number | undefined;
1055
+ minTags?: number | undefined;
1056
+ } | undefined;
1057
+ searchable?: boolean | undefined;
1058
+ localized?: boolean | undefined;
1059
+ description?: string | undefined;
1060
+ defaultValue?: any;
1061
+ required: boolean;
1062
+ type: "tags";
1063
+ name: string;
1064
+ label: string;
1065
+ } | {
1066
+ options?: {
1067
+ allowMultiple?: boolean | undefined;
1068
+ } | undefined;
1069
+ searchable?: boolean | undefined;
1070
+ localized?: boolean | undefined;
1071
+ description?: string | undefined;
1072
+ defaultValue?: any;
1073
+ required: boolean;
1074
+ type: "category";
1075
+ name: string;
1076
+ label: string;
1077
+ } | {
1078
+ options?: {
1079
+ schema?: any;
1080
+ } | undefined;
1081
+ searchable?: boolean | undefined;
1082
+ localized?: boolean | undefined;
1083
+ description?: string | undefined;
1084
+ defaultValue?: any;
1085
+ required: boolean;
1086
+ type: "json";
1087
+ name: string;
1088
+ label: string;
1089
+ } | {
1090
+ options?: {
1091
+ multiple?: boolean | undefined;
1092
+ allowedContentTypes?: string[] | undefined;
1093
+ minItems?: number | undefined;
1094
+ } | undefined;
1095
+ searchable?: boolean | undefined;
1096
+ localized?: boolean | undefined;
1097
+ description?: string | undefined;
1098
+ defaultValue?: any;
1099
+ required: boolean;
1100
+ type: "reference";
1101
+ name: string;
1102
+ label: string;
1103
+ } | {
1104
+ options?: {
1105
+ options?: {
1106
+ label: string;
1107
+ value: string;
1108
+ }[] | undefined;
1109
+ } | undefined;
1110
+ searchable?: boolean | undefined;
1111
+ localized?: boolean | undefined;
1112
+ description?: string | undefined;
1113
+ defaultValue?: any;
1114
+ required: boolean;
1115
+ type: "multiSelect";
1116
+ name: string;
1117
+ label: string;
1118
+ } | {
1119
+ options?: {
1120
+ min?: number | undefined;
1121
+ max?: number | undefined;
1122
+ } | undefined;
1123
+ searchable?: boolean | undefined;
1124
+ localized?: boolean | undefined;
1125
+ description?: string | undefined;
1126
+ defaultValue?: any;
1127
+ required: boolean;
1128
+ type: "date";
1129
+ name: string;
1130
+ label: string;
1131
+ } | {
1132
+ options?: {
1133
+ min?: number | undefined;
1134
+ max?: number | undefined;
1135
+ } | undefined;
1136
+ searchable?: boolean | undefined;
1137
+ localized?: boolean | undefined;
1138
+ description?: string | undefined;
1139
+ defaultValue?: any;
1140
+ required: boolean;
1141
+ type: "datetime";
1142
+ name: string;
1143
+ label: string;
1144
+ })[] | undefined;
1145
+ description?: string | undefined;
1146
+ updatedBy?: string | undefined;
1147
+ sortOrder?: number | undefined;
1148
+ displayName?: string | undefined;
1149
+ icon?: string | undefined;
1150
+ singleton?: boolean | undefined;
1151
+ slugField?: string | undefined;
1152
+ titleField?: string | undefined;
1153
+ isActive?: boolean | undefined;
1154
+ id: string;
1155
+ }, Promise<{
1156
+ _creationTime: number;
1157
+ _id: string;
1158
+ breakingChanges?: Array<{
1159
+ affectedEntriesCount: number;
1160
+ fieldName: string;
1161
+ message: string;
1162
+ type: "FIELD_REMOVED" | "FIELD_TYPE_CHANGED" | "FIELD_MADE_REQUIRED" | "SELECT_OPTIONS_REMOVED" | "REFERENCE_TYPES_RESTRICTED" | "VALIDATION_TIGHTENED";
1163
+ }>;
1164
+ createdBy: string;
1165
+ deletedAt?: number;
1166
+ description?: string;
1167
+ displayName: string;
1168
+ fields: Array<{
1169
+ defaultValue?: any;
1170
+ description?: string;
1171
+ label: string;
1172
+ localized?: boolean;
1173
+ name: string;
1174
+ options?: {
1175
+ maxLength?: number;
1176
+ minLength?: number;
1177
+ pattern?: string;
1178
+ };
1179
+ required: boolean;
1180
+ searchable?: boolean;
1181
+ type: "text";
1182
+ } | {
1183
+ defaultValue?: any;
1184
+ description?: string;
1185
+ label: string;
1186
+ localized?: boolean;
1187
+ name: string;
1188
+ options?: {
1189
+ max?: number;
1190
+ min?: number;
1191
+ precision?: number;
1192
+ step?: number;
1193
+ };
1194
+ required: boolean;
1195
+ searchable?: boolean;
1196
+ type: "number";
1197
+ } | {
1198
+ defaultValue?: any;
1199
+ description?: string;
1200
+ label: string;
1201
+ localized?: boolean;
1202
+ name: string;
1203
+ options?: {
1204
+ falseLabel?: string;
1205
+ trueLabel?: string;
1206
+ };
1207
+ required: boolean;
1208
+ searchable?: boolean;
1209
+ type: "boolean";
1210
+ } | {
1211
+ defaultValue?: any;
1212
+ description?: string;
1213
+ label: string;
1214
+ localized?: boolean;
1215
+ name: string;
1216
+ options?: {
1217
+ allowedBlocks?: Array<string>;
1218
+ allowedMarks?: Array<string>;
1219
+ };
1220
+ required: boolean;
1221
+ searchable?: boolean;
1222
+ type: "richText";
1223
+ } | {
1224
+ defaultValue?: any;
1225
+ description?: string;
1226
+ label: string;
1227
+ localized?: boolean;
1228
+ name: string;
1229
+ options?: {
1230
+ allowedMimeTypes?: Array<string>;
1231
+ maxFileSize?: number;
1232
+ mediaType?: "image" | "video" | "audio" | "document" | "other";
1233
+ multiple?: boolean;
1234
+ };
1235
+ required: boolean;
1236
+ searchable?: boolean;
1237
+ type: "media";
1238
+ } | {
1239
+ defaultValue?: any;
1240
+ description?: string;
1241
+ label: string;
1242
+ localized?: boolean;
1243
+ name: string;
1244
+ options?: {
1245
+ options?: Array<{
1246
+ label: string;
1247
+ value: string;
1248
+ }>;
1249
+ };
1250
+ required: boolean;
1251
+ searchable?: boolean;
1252
+ type: "select";
1253
+ } | {
1254
+ defaultValue?: any;
1255
+ description?: string;
1256
+ label: string;
1257
+ localized?: boolean;
1258
+ name: string;
1259
+ options?: {
1260
+ options?: Array<{
1261
+ label: string;
1262
+ value: string;
1263
+ }>;
1264
+ };
1265
+ required: boolean;
1266
+ searchable?: boolean;
1267
+ type: "multiSelect";
1268
+ } | {
1269
+ defaultValue?: any;
1270
+ description?: string;
1271
+ label: string;
1272
+ localized?: boolean;
1273
+ name: string;
1274
+ options?: {
1275
+ allowCreate?: boolean;
1276
+ maxTags?: number;
1277
+ minTags?: number;
1278
+ taxonomyId?: string;
1279
+ };
1280
+ required: boolean;
1281
+ searchable?: boolean;
1282
+ type: "tags";
1283
+ } | {
1284
+ defaultValue?: any;
1285
+ description?: string;
1286
+ label: string;
1287
+ localized?: boolean;
1288
+ name: string;
1289
+ options?: {
1290
+ allowMultiple?: boolean;
1291
+ };
1292
+ required: boolean;
1293
+ searchable?: boolean;
1294
+ type: "category";
1295
+ } | {
1296
+ defaultValue?: any;
1297
+ description?: string;
1298
+ label: string;
1299
+ localized?: boolean;
1300
+ name: string;
1301
+ options?: {
1302
+ schema?: any;
1303
+ };
1304
+ required: boolean;
1305
+ searchable?: boolean;
1306
+ type: "json";
1307
+ } | {
1308
+ defaultValue?: any;
1309
+ description?: string;
1310
+ label: string;
1311
+ localized?: boolean;
1312
+ name: string;
1313
+ options?: {
1314
+ max?: number;
1315
+ min?: number;
1316
+ };
1317
+ required: boolean;
1318
+ searchable?: boolean;
1319
+ type: "date";
1320
+ } | {
1321
+ defaultValue?: any;
1322
+ description?: string;
1323
+ label: string;
1324
+ localized?: boolean;
1325
+ name: string;
1326
+ options?: {
1327
+ max?: number;
1328
+ min?: number;
1329
+ };
1330
+ required: boolean;
1331
+ searchable?: boolean;
1332
+ type: "datetime";
1333
+ } | {
1334
+ defaultValue?: any;
1335
+ description?: string;
1336
+ label: string;
1337
+ localized?: boolean;
1338
+ name: string;
1339
+ options?: {
1340
+ allowedContentTypes?: Array<string>;
1341
+ minItems?: number;
1342
+ multiple?: boolean;
1343
+ };
1344
+ required: boolean;
1345
+ searchable?: boolean;
1346
+ type: "reference";
1347
+ }>;
1348
+ icon?: string;
1349
+ isActive: boolean;
1350
+ name: string;
1351
+ singleton?: boolean;
1352
+ slugField?: string;
1353
+ sortOrder?: number;
1354
+ titleField?: string;
1355
+ updatedBy?: string;
1356
+ }>>;
1357
+ delete: import("convex/server").RegisteredMutation<"public", {
1358
+ cascade?: boolean | undefined;
1359
+ hardDelete?: boolean | undefined;
1360
+ deletedBy?: string | undefined;
1361
+ id: string;
1362
+ }, Promise<{
1363
+ deletedEntriesCount: number;
1364
+ deletedId: string;
1365
+ deletedVersionsCount: number;
1366
+ success: boolean;
1367
+ wasHardDelete: boolean;
1368
+ }>>;
1369
+ };
1370
+ entries: {
1371
+ list: import("convex/server").RegisteredQuery<"public", {
1372
+ contentTypeId?: string | undefined;
1373
+ status?: string | undefined;
1374
+ locale?: string | undefined;
1375
+ search?: string | undefined;
1376
+ paginationOpts: {
1377
+ numItems: number;
1378
+ cursor: string | null;
1379
+ };
1380
+ }, Promise<{
1381
+ continueCursor: string | null;
1382
+ isDone: boolean;
1383
+ page: Array<{
1384
+ _creationTime: number;
1385
+ _id: string;
1386
+ contentTypeId: string;
1387
+ createdBy?: string;
1388
+ data: any;
1389
+ deletedAt?: number;
1390
+ firstPublishedAt?: number;
1391
+ lastPublishedAt?: number;
1392
+ locale?: string;
1393
+ lockExpiresAt?: number;
1394
+ lockedBy?: string;
1395
+ primaryEntryId?: string;
1396
+ scheduledPublishAt?: number;
1397
+ searchText?: string;
1398
+ slug: string;
1399
+ status: string;
1400
+ updatedBy?: string;
1401
+ version: number;
1402
+ }>;
1403
+ }>>;
1404
+ get: import("convex/server").RegisteredQuery<"public", {
1405
+ id: string;
1406
+ }, Promise<{
1407
+ _creationTime: number;
1408
+ _id: string;
1409
+ contentTypeId: string;
1410
+ createdBy?: string;
1411
+ data: any;
1412
+ deletedAt?: number;
1413
+ firstPublishedAt?: number;
1414
+ lastPublishedAt?: number;
1415
+ latestVersion?: {
1416
+ _creationTime: number;
1417
+ _id: string;
1418
+ changeDescription?: string;
1419
+ createdBy?: string;
1420
+ data: any;
1421
+ entryId: string;
1422
+ publishedAt?: number;
1423
+ slug: string;
1424
+ status: string;
1425
+ versionNumber: number;
1426
+ wasPublished: boolean;
1427
+ };
1428
+ locale?: string;
1429
+ lockExpiresAt?: number;
1430
+ lockedBy?: string;
1431
+ primaryEntryId?: string;
1432
+ scheduledPublishAt?: number;
1433
+ searchText?: string;
1434
+ slug: string;
1435
+ status: string;
1436
+ updatedBy?: string;
1437
+ version: number;
1438
+ } | null>>;
1439
+ create: import("convex/server").RegisteredMutation<"public", {
1440
+ createdBy?: string | undefined;
1441
+ slug?: string | undefined;
1442
+ status?: string | undefined;
1443
+ locale?: string | undefined;
1444
+ primaryEntryId?: string | undefined;
1445
+ contentTypeId: string;
1446
+ data: any;
1447
+ }, Promise<{
1448
+ _creationTime: number;
1449
+ _id: string;
1450
+ contentTypeId: string;
1451
+ createdBy?: string;
1452
+ data: any;
1453
+ deletedAt?: number;
1454
+ firstPublishedAt?: number;
1455
+ lastPublishedAt?: number;
1456
+ locale?: string;
1457
+ lockExpiresAt?: number;
1458
+ lockedBy?: string;
1459
+ primaryEntryId?: string;
1460
+ scheduledPublishAt?: number;
1461
+ searchText?: string;
1462
+ slug: string;
1463
+ status: string;
1464
+ updatedBy?: string;
1465
+ version: number;
1466
+ }>>;
1467
+ update: import("convex/server").RegisteredMutation<"public", {
1468
+ updatedBy?: string | undefined;
1469
+ slug?: string | undefined;
1470
+ status?: string | undefined;
1471
+ data?: any;
1472
+ scheduledPublishAt?: number | undefined;
1473
+ regenerateSlug?: boolean | undefined;
1474
+ id: string;
1475
+ }, Promise<{
1476
+ _creationTime: number;
1477
+ _id: string;
1478
+ contentTypeId: string;
1479
+ createdBy?: string;
1480
+ data: any;
1481
+ deletedAt?: number;
1482
+ firstPublishedAt?: number;
1483
+ lastPublishedAt?: number;
1484
+ locale?: string;
1485
+ lockExpiresAt?: number;
1486
+ lockedBy?: string;
1487
+ primaryEntryId?: string;
1488
+ scheduledPublishAt?: number;
1489
+ searchText?: string;
1490
+ slug: string;
1491
+ status: string;
1492
+ updatedBy?: string;
1493
+ version: number;
1494
+ }>>;
1495
+ publish: import("convex/server").RegisteredMutation<"public", {
1496
+ updatedBy?: string | undefined;
1497
+ changeDescription?: string | undefined;
1498
+ id: string;
1499
+ }, Promise<{
1500
+ _creationTime: number;
1501
+ _id: string;
1502
+ contentTypeId: string;
1503
+ createdBy?: string;
1504
+ data: any;
1505
+ deletedAt?: number;
1506
+ firstPublishedAt?: number;
1507
+ lastPublishedAt?: number;
1508
+ locale?: string;
1509
+ lockExpiresAt?: number;
1510
+ lockedBy?: string;
1511
+ primaryEntryId?: string;
1512
+ scheduledPublishAt?: number;
1513
+ searchText?: string;
1514
+ slug: string;
1515
+ status: string;
1516
+ updatedBy?: string;
1517
+ version: number;
1518
+ }>>;
1519
+ unpublish: import("convex/server").RegisteredMutation<"public", {
1520
+ updatedBy?: string | undefined;
1521
+ id: string;
1522
+ }, Promise<{
1523
+ _creationTime: number;
1524
+ _id: string;
1525
+ contentTypeId: string;
1526
+ createdBy?: string;
1527
+ data: any;
1528
+ deletedAt?: number;
1529
+ firstPublishedAt?: number;
1530
+ lastPublishedAt?: number;
1531
+ locale?: string;
1532
+ lockExpiresAt?: number;
1533
+ lockedBy?: string;
1534
+ primaryEntryId?: string;
1535
+ scheduledPublishAt?: number;
1536
+ searchText?: string;
1537
+ slug: string;
1538
+ status: string;
1539
+ updatedBy?: string;
1540
+ version: number;
1541
+ }>>;
1542
+ delete: import("convex/server").RegisteredMutation<"public", {
1543
+ hardDelete?: boolean | undefined;
1544
+ deletedBy?: string | undefined;
1545
+ id: string;
1546
+ }, Promise<{
1547
+ _creationTime: number;
1548
+ _id: string;
1549
+ contentTypeId: string;
1550
+ createdBy?: string;
1551
+ data: any;
1552
+ deletedAt?: number;
1553
+ deletedVersionsCount?: number;
1554
+ firstPublishedAt?: number;
1555
+ lastPublishedAt?: number;
1556
+ locale?: string;
1557
+ lockExpiresAt?: number;
1558
+ lockedBy?: string;
1559
+ primaryEntryId?: string;
1560
+ scheduledPublishAt?: number;
1561
+ searchText?: string;
1562
+ slug: string;
1563
+ status: string;
1564
+ updatedBy?: string;
1565
+ version: number;
1566
+ }>>;
1567
+ duplicate: import("convex/server").RegisteredMutation<"public", {
1568
+ createdBy?: string | undefined;
1569
+ copyMediaReferences?: boolean | undefined;
1570
+ id: string;
1571
+ }, Promise<{
1572
+ _creationTime: number;
1573
+ _id: string;
1574
+ contentTypeId: string;
1575
+ createdBy?: string;
1576
+ data: any;
1577
+ deletedAt?: number;
1578
+ firstPublishedAt?: number;
1579
+ lastPublishedAt?: number;
1580
+ locale?: string;
1581
+ lockExpiresAt?: number;
1582
+ lockedBy?: string;
1583
+ primaryEntryId?: string;
1584
+ scheduledPublishAt?: number;
1585
+ searchText?: string;
1586
+ slug: string;
1587
+ status: string;
1588
+ updatedBy?: string;
1589
+ version: number;
1590
+ }>>;
1591
+ schedule: import("convex/server").RegisteredMutation<"public", {
1592
+ updatedBy?: string | undefined;
1593
+ id: string;
1594
+ publishAt: number;
1595
+ }, Promise<{
1596
+ _creationTime: number;
1597
+ _id: string;
1598
+ contentTypeId: string;
1599
+ createdBy?: string;
1600
+ data: any;
1601
+ deletedAt?: number;
1602
+ firstPublishedAt?: number;
1603
+ lastPublishedAt?: number;
1604
+ locale?: string;
1605
+ lockExpiresAt?: number;
1606
+ lockedBy?: string;
1607
+ primaryEntryId?: string;
1608
+ scheduledPublishAt?: number;
1609
+ searchText?: string;
1610
+ slug: string;
1611
+ status: string;
1612
+ updatedBy?: string;
1613
+ version: number;
1614
+ }>>;
1615
+ cancelSchedule: import("convex/server").RegisteredMutation<"public", {
1616
+ updatedBy?: string | undefined;
1617
+ id: string;
1618
+ }, Promise<{
1619
+ _creationTime: number;
1620
+ _id: string;
1621
+ contentTypeId: string;
1622
+ createdBy?: string;
1623
+ data: any;
1624
+ deletedAt?: number;
1625
+ firstPublishedAt?: number;
1626
+ lastPublishedAt?: number;
1627
+ locale?: string;
1628
+ lockExpiresAt?: number;
1629
+ lockedBy?: string;
1630
+ primaryEntryId?: string;
1631
+ scheduledPublishAt?: number;
1632
+ searchText?: string;
1633
+ slug: string;
1634
+ status: string;
1635
+ updatedBy?: string;
1636
+ version: number;
1637
+ }>>;
1638
+ getScheduled: import("convex/server").RegisteredQuery<"public", {}, Promise<any>>;
1639
+ };
1640
+ media: {
1641
+ listAssets: import("convex/server").RegisteredQuery<"public", {
1642
+ type?: "image" | "video" | "audio" | "document" | "other" | undefined;
1643
+ search?: string | undefined;
1644
+ folderId?: string | undefined;
1645
+ paginationOpts: {
1646
+ numItems: number;
1647
+ cursor: string | null;
1648
+ };
1649
+ }, Promise<{
1650
+ continueCursor: string | null;
1651
+ isDone: boolean;
1652
+ page: Array<{
1653
+ _creationTime: number;
1654
+ _id: string;
1655
+ altText?: string;
1656
+ createdBy?: string;
1657
+ deletedAt?: number;
1658
+ description?: string;
1659
+ duration?: number;
1660
+ height?: number;
1661
+ kind: "asset";
1662
+ metadata?: Record<string, any>;
1663
+ mimeType: string;
1664
+ name: string;
1665
+ optimizationHints: {
1666
+ aspectRatio?: number;
1667
+ durationSeconds?: number;
1668
+ hasTransparency?: boolean;
1669
+ isResizable: boolean;
1670
+ isVector?: boolean;
1671
+ suggestedMaxWidth?: number;
1672
+ };
1673
+ parentId?: string;
1674
+ path: string;
1675
+ searchText?: string;
1676
+ size?: number;
1677
+ storageId: string;
1678
+ tags?: Array<string>;
1679
+ title?: string;
1680
+ updatedBy?: string;
1681
+ url: string | null;
1682
+ width?: number;
1683
+ }>;
1684
+ }>>;
1685
+ getAsset: import("convex/server").RegisteredQuery<"public", {
1686
+ id: string;
1687
+ }, Promise<{
1688
+ _creationTime: number;
1689
+ _id: string;
1690
+ altText?: string;
1691
+ createdBy?: string;
1692
+ deletedAt?: number;
1693
+ description?: string;
1694
+ duration?: number;
1695
+ height?: number;
1696
+ kind: "asset";
1697
+ metadata?: Record<string, any>;
1698
+ mimeType: string;
1699
+ name: string;
1700
+ optimizationHints: {
1701
+ aspectRatio?: number;
1702
+ durationSeconds?: number;
1703
+ hasTransparency?: boolean;
1704
+ isResizable: boolean;
1705
+ isVector?: boolean;
1706
+ suggestedMaxWidth?: number;
1707
+ };
1708
+ parentId?: string;
1709
+ path: string;
1710
+ searchText?: string;
1711
+ size?: number;
1712
+ storageId: string;
1713
+ tags?: Array<string>;
1714
+ title?: string;
1715
+ updatedBy?: string;
1716
+ url: string | null;
1717
+ width?: number;
1718
+ } | null>>;
1719
+ createAsset: import("convex/server").RegisteredMutation<"public", {
1720
+ description?: string | undefined;
1721
+ width?: number | undefined;
1722
+ height?: number | undefined;
1723
+ altText?: string | undefined;
1724
+ title?: string | undefined;
1725
+ parentId?: string | undefined;
1726
+ createdBy?: string | undefined;
1727
+ name: string;
1728
+ storageId: string;
1729
+ mimeType: string;
1730
+ size: number;
1731
+ }, Promise<{
1732
+ _creationTime: number;
1733
+ _id: string;
1734
+ altText?: string;
1735
+ createdBy?: string;
1736
+ deletedAt?: number;
1737
+ description?: string;
1738
+ duration?: number;
1739
+ height?: number;
1740
+ kind: "asset";
1741
+ metadata?: Record<string, any>;
1742
+ mimeType: string;
1743
+ name: string;
1744
+ parentId?: string;
1745
+ path: string;
1746
+ searchText?: string;
1747
+ size?: number;
1748
+ storageId: string;
1749
+ tags?: Array<string>;
1750
+ title?: string;
1751
+ updatedBy?: string;
1752
+ width?: number;
1753
+ } | {
1754
+ _creationTime: number;
1755
+ _id: string;
1756
+ createdBy?: string;
1757
+ deletedAt?: number;
1758
+ description?: string;
1759
+ kind: "folder";
1760
+ metadata?: Record<string, any>;
1761
+ name: string;
1762
+ parentId?: string;
1763
+ path: string;
1764
+ searchText?: string;
1765
+ size?: number;
1766
+ sortOrder?: number;
1767
+ tags?: Array<string>;
1768
+ title?: string;
1769
+ updatedBy?: string;
1770
+ }>>;
1771
+ updateAsset: import("convex/server").RegisteredMutation<"public", {
1772
+ tags?: string[] | undefined;
1773
+ name?: string | undefined;
1774
+ description?: string | undefined;
1775
+ altText?: string | undefined;
1776
+ title?: string | undefined;
1777
+ parentId?: string | undefined;
1778
+ id: string;
1779
+ }, Promise<{
1780
+ _creationTime: number;
1781
+ _id: string;
1782
+ altText?: string;
1783
+ createdBy?: string;
1784
+ deletedAt?: number;
1785
+ description?: string;
1786
+ duration?: number;
1787
+ height?: number;
1788
+ kind: "asset";
1789
+ metadata?: Record<string, any>;
1790
+ mimeType: string;
1791
+ name: string;
1792
+ parentId?: string;
1793
+ path: string;
1794
+ searchText?: string;
1795
+ size?: number;
1796
+ storageId: string;
1797
+ tags?: Array<string>;
1798
+ title?: string;
1799
+ updatedBy?: string;
1800
+ width?: number;
1801
+ } | {
1802
+ _creationTime: number;
1803
+ _id: string;
1804
+ createdBy?: string;
1805
+ deletedAt?: number;
1806
+ description?: string;
1807
+ kind: "folder";
1808
+ metadata?: Record<string, any>;
1809
+ name: string;
1810
+ parentId?: string;
1811
+ path: string;
1812
+ searchText?: string;
1813
+ size?: number;
1814
+ sortOrder?: number;
1815
+ tags?: Array<string>;
1816
+ title?: string;
1817
+ updatedBy?: string;
1818
+ }>>;
1819
+ deleteAsset: import("convex/server").RegisteredMutation<"public", {
1820
+ hardDelete?: boolean | undefined;
1821
+ deletedBy?: string | undefined;
1822
+ id: string;
1823
+ }, Promise<{
1824
+ _creationTime: number;
1825
+ _id: string;
1826
+ altText?: string;
1827
+ createdBy?: string;
1828
+ deletedAt?: number;
1829
+ description?: string;
1830
+ duration?: number;
1831
+ height?: number;
1832
+ kind: "asset";
1833
+ metadata?: Record<string, any>;
1834
+ mimeType: string;
1835
+ name: string;
1836
+ parentId?: string;
1837
+ path: string;
1838
+ searchText?: string;
1839
+ size?: number;
1840
+ storageFileDeleted?: boolean;
1841
+ storageId: string;
1842
+ tags?: Array<string>;
1843
+ title?: string;
1844
+ updatedBy?: string;
1845
+ width?: number;
1846
+ }>>;
1847
+ restoreAsset: import("convex/server").RegisteredMutation<"public", {
1848
+ id: string;
1849
+ }, Promise<{
1850
+ _creationTime: number;
1851
+ _id: string;
1852
+ altText?: string;
1853
+ createdBy?: string;
1854
+ deletedAt?: number;
1855
+ description?: string;
1856
+ duration?: number;
1857
+ height?: number;
1858
+ kind: "asset";
1859
+ metadata?: Record<string, any>;
1860
+ mimeType: string;
1861
+ name: string;
1862
+ parentId?: string;
1863
+ path: string;
1864
+ searchText?: string;
1865
+ size?: number;
1866
+ storageId: string;
1867
+ tags?: Array<string>;
1868
+ title?: string;
1869
+ updatedBy?: string;
1870
+ width?: number;
1871
+ } | {
1872
+ _creationTime: number;
1873
+ _id: string;
1874
+ createdBy?: string;
1875
+ deletedAt?: number;
1876
+ description?: string;
1877
+ kind: "folder";
1878
+ metadata?: Record<string, any>;
1879
+ name: string;
1880
+ parentId?: string;
1881
+ path: string;
1882
+ searchText?: string;
1883
+ size?: number;
1884
+ sortOrder?: number;
1885
+ tags?: Array<string>;
1886
+ title?: string;
1887
+ updatedBy?: string;
1888
+ }>>;
1889
+ moveAssets: import("convex/server").RegisteredMutation<"public", {
1890
+ targetFolderId?: string | undefined;
1891
+ assetIds: string[];
1892
+ }, Promise<{
1893
+ failed: number;
1894
+ results: Array<{
1895
+ error?: string;
1896
+ id: string;
1897
+ previousFolderId?: string;
1898
+ success: boolean;
1899
+ }>;
1900
+ succeeded: number;
1901
+ targetFolderId?: string;
1902
+ targetFolderPath?: string;
1903
+ total: number;
1904
+ }>>;
1905
+ listFolders: import("convex/server").RegisteredQuery<"public", {
1906
+ parentId?: string | undefined;
1907
+ }, Promise<({
1908
+ _creationTime: number;
1909
+ _id: string;
1910
+ altText?: string;
1911
+ createdBy?: string;
1912
+ deletedAt?: number;
1913
+ description?: string;
1914
+ duration?: number;
1915
+ height?: number;
1916
+ kind: "asset";
1917
+ metadata?: Record<string, any>;
1918
+ mimeType: string;
1919
+ name: string;
1920
+ parentId?: string;
1921
+ path: string;
1922
+ searchText?: string;
1923
+ size?: number;
1924
+ storageId: string;
1925
+ tags?: Array<string>;
1926
+ title?: string;
1927
+ updatedBy?: string;
1928
+ width?: number;
1929
+ } | {
1930
+ _creationTime: number;
1931
+ _id: string;
1932
+ createdBy?: string;
1933
+ deletedAt?: number;
1934
+ description?: string;
1935
+ kind: "folder";
1936
+ metadata?: Record<string, any>;
1937
+ name: string;
1938
+ parentId?: string;
1939
+ path: string;
1940
+ searchText?: string;
1941
+ size?: number;
1942
+ sortOrder?: number;
1943
+ tags?: Array<string>;
1944
+ title?: string;
1945
+ updatedBy?: string;
1946
+ })[]>>;
1947
+ getFolder: import("convex/server").RegisteredQuery<"public", {
1948
+ id: string;
1949
+ }, Promise<{
1950
+ _creationTime: number;
1951
+ _id: string;
1952
+ altText?: string;
1953
+ createdBy?: string;
1954
+ deletedAt?: number;
1955
+ description?: string;
1956
+ duration?: number;
1957
+ height?: number;
1958
+ kind: "asset";
1959
+ metadata?: Record<string, any>;
1960
+ mimeType: string;
1961
+ name: string;
1962
+ parentId?: string;
1963
+ path: string;
1964
+ searchText?: string;
1965
+ size?: number;
1966
+ storageId: string;
1967
+ tags?: Array<string>;
1968
+ title?: string;
1969
+ updatedBy?: string;
1970
+ width?: number;
1971
+ } | {
1972
+ _creationTime: number;
1973
+ _id: string;
1974
+ createdBy?: string;
1975
+ deletedAt?: number;
1976
+ description?: string;
1977
+ kind: "folder";
1978
+ metadata?: Record<string, any>;
1979
+ name: string;
1980
+ parentId?: string;
1981
+ path: string;
1982
+ searchText?: string;
1983
+ size?: number;
1984
+ sortOrder?: number;
1985
+ tags?: Array<string>;
1986
+ title?: string;
1987
+ updatedBy?: string;
1988
+ } | null>>;
1989
+ getFolderTree: import("convex/server").RegisteredQuery<"public", {}, Promise<({
1990
+ _creationTime: number;
1991
+ _id: string;
1992
+ altText?: string;
1993
+ createdBy?: string;
1994
+ deletedAt?: number;
1995
+ description?: string;
1996
+ duration?: number;
1997
+ height?: number;
1998
+ kind: "asset";
1999
+ metadata?: Record<string, any>;
2000
+ mimeType: string;
2001
+ name: string;
2002
+ parentId?: string;
2003
+ path: string;
2004
+ searchText?: string;
2005
+ size?: number;
2006
+ storageId: string;
2007
+ tags?: Array<string>;
2008
+ title?: string;
2009
+ updatedBy?: string;
2010
+ width?: number;
2011
+ } | {
2012
+ _creationTime: number;
2013
+ _id: string;
2014
+ createdBy?: string;
2015
+ deletedAt?: number;
2016
+ description?: string;
2017
+ kind: "folder";
2018
+ metadata?: Record<string, any>;
2019
+ name: string;
2020
+ parentId?: string;
2021
+ path: string;
2022
+ searchText?: string;
2023
+ size?: number;
2024
+ sortOrder?: number;
2025
+ tags?: Array<string>;
2026
+ title?: string;
2027
+ updatedBy?: string;
2028
+ })[]>>;
2029
+ createFolder: import("convex/server").RegisteredMutation<"public", {
2030
+ description?: string | undefined;
2031
+ parentId?: string | undefined;
2032
+ createdBy?: string | undefined;
2033
+ name: string;
2034
+ }, Promise<{
2035
+ _creationTime: number;
2036
+ _id: string;
2037
+ altText?: string;
2038
+ createdBy?: string;
2039
+ deletedAt?: number;
2040
+ description?: string;
2041
+ duration?: number;
2042
+ height?: number;
2043
+ kind: "asset";
2044
+ metadata?: Record<string, any>;
2045
+ mimeType: string;
2046
+ name: string;
2047
+ parentId?: string;
2048
+ path: string;
2049
+ searchText?: string;
2050
+ size?: number;
2051
+ storageId: string;
2052
+ tags?: Array<string>;
2053
+ title?: string;
2054
+ updatedBy?: string;
2055
+ width?: number;
2056
+ } | {
2057
+ _creationTime: number;
2058
+ _id: string;
2059
+ createdBy?: string;
2060
+ deletedAt?: number;
2061
+ description?: string;
2062
+ kind: "folder";
2063
+ metadata?: Record<string, any>;
2064
+ name: string;
2065
+ parentId?: string;
2066
+ path: string;
2067
+ searchText?: string;
2068
+ size?: number;
2069
+ sortOrder?: number;
2070
+ tags?: Array<string>;
2071
+ title?: string;
2072
+ updatedBy?: string;
2073
+ }>>;
2074
+ updateFolder: import("convex/server").RegisteredMutation<"public", {
2075
+ name?: string | undefined;
2076
+ description?: string | undefined;
2077
+ sortOrder?: number | undefined;
2078
+ id: string;
2079
+ }, Promise<{
2080
+ _creationTime: number;
2081
+ _id: string;
2082
+ altText?: string;
2083
+ createdBy?: string;
2084
+ deletedAt?: number;
2085
+ description?: string;
2086
+ duration?: number;
2087
+ height?: number;
2088
+ kind: "asset";
2089
+ metadata?: Record<string, any>;
2090
+ mimeType: string;
2091
+ name: string;
2092
+ parentId?: string;
2093
+ path: string;
2094
+ searchText?: string;
2095
+ size?: number;
2096
+ storageId: string;
2097
+ tags?: Array<string>;
2098
+ title?: string;
2099
+ updatedBy?: string;
2100
+ width?: number;
2101
+ } | {
2102
+ _creationTime: number;
2103
+ _id: string;
2104
+ createdBy?: string;
2105
+ deletedAt?: number;
2106
+ description?: string;
2107
+ kind: "folder";
2108
+ metadata?: Record<string, any>;
2109
+ name: string;
2110
+ parentId?: string;
2111
+ path: string;
2112
+ searchText?: string;
2113
+ size?: number;
2114
+ sortOrder?: number;
2115
+ tags?: Array<string>;
2116
+ title?: string;
2117
+ updatedBy?: string;
2118
+ }>>;
2119
+ moveFolder: import("convex/server").RegisteredMutation<"public", {
2120
+ newParentId?: string | undefined;
2121
+ id: string;
2122
+ }, Promise<{
2123
+ _creationTime: number;
2124
+ _id: string;
2125
+ altText?: string;
2126
+ createdBy?: string;
2127
+ deletedAt?: number;
2128
+ description?: string;
2129
+ duration?: number;
2130
+ height?: number;
2131
+ kind: "asset";
2132
+ metadata?: Record<string, any>;
2133
+ mimeType: string;
2134
+ name: string;
2135
+ parentId?: string;
2136
+ path: string;
2137
+ searchText?: string;
2138
+ size?: number;
2139
+ storageId: string;
2140
+ tags?: Array<string>;
2141
+ title?: string;
2142
+ updatedBy?: string;
2143
+ width?: number;
2144
+ } | {
2145
+ _creationTime: number;
2146
+ _id: string;
2147
+ createdBy?: string;
2148
+ deletedAt?: number;
2149
+ description?: string;
2150
+ kind: "folder";
2151
+ metadata?: Record<string, any>;
2152
+ name: string;
2153
+ parentId?: string;
2154
+ path: string;
2155
+ searchText?: string;
2156
+ size?: number;
2157
+ sortOrder?: number;
2158
+ tags?: Array<string>;
2159
+ title?: string;
2160
+ updatedBy?: string;
2161
+ }>>;
2162
+ deleteFolder: import("convex/server").RegisteredMutation<"public", {
2163
+ hardDelete?: boolean | undefined;
2164
+ deletedBy?: string | undefined;
2165
+ recursive?: boolean | undefined;
2166
+ id: string;
2167
+ }, Promise<{
2168
+ _creationTime: number;
2169
+ _id: string;
2170
+ altText?: string;
2171
+ createdBy?: string;
2172
+ deletedAt?: number;
2173
+ description?: string;
2174
+ duration?: number;
2175
+ height?: number;
2176
+ kind: "asset";
2177
+ metadata?: Record<string, any>;
2178
+ mimeType: string;
2179
+ name: string;
2180
+ parentId?: string;
2181
+ path: string;
2182
+ searchText?: string;
2183
+ size?: number;
2184
+ storageId: string;
2185
+ tags?: Array<string>;
2186
+ title?: string;
2187
+ updatedBy?: string;
2188
+ width?: number;
2189
+ } | {
2190
+ _creationTime: number;
2191
+ _id: string;
2192
+ createdBy?: string;
2193
+ deletedAt?: number;
2194
+ description?: string;
2195
+ kind: "folder";
2196
+ metadata?: Record<string, any>;
2197
+ name: string;
2198
+ parentId?: string;
2199
+ path: string;
2200
+ searchText?: string;
2201
+ size?: number;
2202
+ sortOrder?: number;
2203
+ tags?: Array<string>;
2204
+ title?: string;
2205
+ updatedBy?: string;
2206
+ }>>;
2207
+ restoreFolder: import("convex/server").RegisteredMutation<"public", {
2208
+ recursive?: boolean | undefined;
2209
+ id: string;
2210
+ }, Promise<{
2211
+ _creationTime: number;
2212
+ _id: string;
2213
+ altText?: string;
2214
+ createdBy?: string;
2215
+ deletedAt?: number;
2216
+ description?: string;
2217
+ duration?: number;
2218
+ height?: number;
2219
+ kind: "asset";
2220
+ metadata?: Record<string, any>;
2221
+ mimeType: string;
2222
+ name: string;
2223
+ parentId?: string;
2224
+ path: string;
2225
+ searchText?: string;
2226
+ size?: number;
2227
+ storageId: string;
2228
+ tags?: Array<string>;
2229
+ title?: string;
2230
+ updatedBy?: string;
2231
+ width?: number;
2232
+ } | {
2233
+ _creationTime: number;
2234
+ _id: string;
2235
+ createdBy?: string;
2236
+ deletedAt?: number;
2237
+ description?: string;
2238
+ kind: "folder";
2239
+ metadata?: Record<string, any>;
2240
+ name: string;
2241
+ parentId?: string;
2242
+ path: string;
2243
+ searchText?: string;
2244
+ size?: number;
2245
+ sortOrder?: number;
2246
+ tags?: Array<string>;
2247
+ title?: string;
2248
+ updatedBy?: string;
2249
+ }>>;
2250
+ generateUploadUrl: import("convex/server").RegisteredMutation<"public", {}, Promise<string>>;
2251
+ };
2252
+ stats: {
2253
+ getDashboardStats: import("convex/server").RegisteredQuery<"public", {}, Promise<{
2254
+ contentTypes: {
2255
+ total: number;
2256
+ active: number;
2257
+ };
2258
+ entries: {
2259
+ total: number;
2260
+ published: number;
2261
+ draft: number;
2262
+ scheduled: number;
2263
+ };
2264
+ media: {
2265
+ total: number;
2266
+ images: number;
2267
+ videos: number;
2268
+ documents: number;
2269
+ };
2270
+ }>>;
2271
+ };
2272
+ };
2273
+ //# sourceMappingURL=adminApi.d.ts.map