adula 2.1.0 → 2.3.0

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 (269) hide show
  1. package/README.md +149 -18
  2. package/build/agent/AGENTS.template.md +4 -4
  3. package/build/agent/capabilities.md +22 -12
  4. package/build/agent/skills/adula-frontend-design/SKILL.md +6 -4
  5. package/build/agent/skills/idea-review/SKILL.md +2 -2
  6. package/build/commands/adula_assistant_prune.d.ts +10 -0
  7. package/build/commands/adula_assistant_prune.js +12 -0
  8. package/build/commands/adula_outbox.d.ts +10 -0
  9. package/build/commands/adula_outbox.js +11 -0
  10. package/build/commands/adula_restore_reconcile.d.ts +10 -0
  11. package/build/commands/adula_restore_reconcile.js +34 -0
  12. package/build/commands/adula_runtime_health.d.ts +10 -0
  13. package/build/commands/adula_runtime_health.js +27 -0
  14. package/build/commands/adula_uploads_prune.d.ts +10 -0
  15. package/build/commands/adula_uploads_prune.js +16 -0
  16. package/build/commands/app.d.ts +10 -0
  17. package/build/commands/app.js +64 -0
  18. package/build/commands/backup_create.d.ts +11 -0
  19. package/build/commands/backup_create.js +99 -0
  20. package/build/commands/backup_open.d.ts +16 -0
  21. package/build/commands/backup_open.js +48 -0
  22. package/build/commands/backup_restore_files.d.ts +11 -0
  23. package/build/commands/backup_restore_files.js +44 -0
  24. package/build/commands/backup_restore_test.d.ts +12 -0
  25. package/build/commands/backup_restore_test.js +188 -0
  26. package/build/commands/backup_seal.d.ts +12 -0
  27. package/build/commands/backup_seal.js +36 -0
  28. package/build/commands/backup_services.d.ts +33 -0
  29. package/build/commands/backup_services.js +6 -0
  30. package/build/commands/backup_verify.d.ts +9 -0
  31. package/build/commands/backup_verify.js +59 -0
  32. package/build/commands/backup_verify_snapshot.d.ts +10 -0
  33. package/build/commands/backup_verify_snapshot.js +37 -0
  34. package/build/commands/client.d.ts +16 -0
  35. package/build/commands/client.js +71 -0
  36. package/build/commands/doctor.js +21 -1
  37. package/build/commands/install.d.ts +8 -0
  38. package/build/commands/install.js +69 -45
  39. package/build/commands/main.d.ts +3 -2
  40. package/build/commands/main.js +32 -0
  41. package/build/commands/module_add.js +4 -20
  42. package/build/commands/resource.d.ts +2 -0
  43. package/build/commands/resource.js +12 -3
  44. package/build/commands/resource_migration.d.ts +15 -0
  45. package/build/commands/resource_migration.js +81 -0
  46. package/build/commands/resource_snapshot.d.ts +2 -0
  47. package/build/commands/resource_snapshot.js +21 -4
  48. package/build/commands/sla_evaluate.d.ts +14 -0
  49. package/build/commands/sla_evaluate.js +16 -0
  50. package/build/commands/ui.js +4 -2
  51. package/build/commands/ui_css.d.ts +9 -0
  52. package/build/commands/ui_css.js +19 -0
  53. package/build/commands/upgrade.d.ts +1 -1
  54. package/build/commands/upgrade.js +1 -1
  55. package/build/configure.js +1 -1
  56. package/build/database/migrations/1770000000020_two_factor.d.ts +5 -0
  57. package/build/database/migrations/1770000000020_two_factor.js +10 -0
  58. package/build/database/migrations/1770000000041_import_modes.d.ts +5 -0
  59. package/build/database/migrations/1770000000041_import_modes.js +10 -0
  60. package/build/database/migrations/1770000000042_sync_jobs.d.ts +5 -0
  61. package/build/database/migrations/1770000000042_sync_jobs.js +10 -0
  62. package/build/database/migrations/1770000000043_notification_channels.d.ts +5 -0
  63. package/build/database/migrations/1770000000043_notification_channels.js +10 -0
  64. package/build/database/migrations/1770000000044_channel_confirmations.d.ts +5 -0
  65. package/build/database/migrations/1770000000044_channel_confirmations.js +10 -0
  66. package/build/database/migrations/1770000000045_import_leases.d.ts +5 -0
  67. package/build/database/migrations/1770000000045_import_leases.js +10 -0
  68. package/build/database/migrations/1770000000046_workflow_delegation_sla.d.ts +5 -0
  69. package/build/database/migrations/1770000000046_workflow_delegation_sla.js +10 -0
  70. package/build/database/migrations/1770000000049_print_templates.d.ts +5 -0
  71. package/build/database/migrations/1770000000049_print_templates.js +10 -0
  72. package/build/database/migrations/1770000000051_comment_notifications.d.ts +5 -0
  73. package/build/database/migrations/1770000000051_comment_notifications.js +10 -0
  74. package/build/database/migrations/1770000000054_cloud_backups.d.ts +5 -0
  75. package/build/database/migrations/1770000000054_cloud_backups.js +10 -0
  76. package/build/database/migrations/1770000000055_ai_assistant.d.ts +5 -0
  77. package/build/database/migrations/1770000000055_ai_assistant.js +10 -0
  78. package/build/database/migrations/1770000000056_appearance.d.ts +5 -0
  79. package/build/database/migrations/1770000000056_appearance.js +10 -0
  80. package/build/index.d.ts +87 -11
  81. package/build/index.js +50 -7
  82. package/build/providers/adula_provider.d.ts +2 -0
  83. package/build/providers/adula_provider.js +7 -0
  84. package/build/src/admin/contracts.js +1 -1
  85. package/build/src/admin/controller.d.ts +14 -1
  86. package/build/src/admin/controller.js +91 -13
  87. package/build/src/admin/errors.d.ts +32 -0
  88. package/build/src/admin/errors.js +63 -1
  89. package/build/src/admin/presentation.d.ts +21 -2
  90. package/build/src/admin/resource/editor.d.ts +60 -0
  91. package/build/src/admin/resource/editor.js +345 -0
  92. package/build/src/admin/resource/export.d.ts +54 -0
  93. package/build/src/admin/resource/export.js +262 -0
  94. package/build/src/admin/resource/lifecycle.d.ts +23 -0
  95. package/build/src/admin/resource/lifecycle.js +91 -0
  96. package/build/src/admin/resource/query.d.ts +111 -0
  97. package/build/src/admin/resource/query.js +595 -0
  98. package/build/src/admin/resource/read.d.ts +109 -0
  99. package/build/src/admin/resource/read.js +388 -0
  100. package/build/src/admin/resource/shared.d.ts +93 -0
  101. package/build/src/admin/resource/shared.js +265 -0
  102. package/build/src/admin/resource/trash.d.ts +10 -0
  103. package/build/src/admin/resource/trash.js +56 -0
  104. package/build/src/admin/resource/write.d.ts +57 -0
  105. package/build/src/admin/resource/write.js +603 -0
  106. package/build/src/admin/resource_service.d.ts +80 -193
  107. package/build/src/admin/resource_service.js +81 -1343
  108. package/build/src/admin/resource_tools.d.ts +111 -0
  109. package/build/src/admin/resource_tools.js +139 -0
  110. package/build/src/ai/assistant.d.ts +100 -0
  111. package/build/src/ai/assistant.js +487 -0
  112. package/build/src/ai/client.d.ts +49 -0
  113. package/build/src/ai/client.js +85 -0
  114. package/build/src/ai/prompt.d.ts +23 -0
  115. package/build/src/ai/prompt.js +83 -0
  116. package/build/src/ai/settings.d.ts +56 -0
  117. package/build/src/ai/settings.js +214 -0
  118. package/build/src/ai/usage.d.ts +16 -0
  119. package/build/src/ai/usage.js +33 -0
  120. package/build/src/appearance/appearance.d.ts +134 -0
  121. package/build/src/appearance/appearance.js +461 -0
  122. package/build/src/appearance/colors.d.ts +43 -0
  123. package/build/src/appearance/colors.js +99 -0
  124. package/build/src/appearance/logo.d.ts +32 -0
  125. package/build/src/appearance/logo.js +112 -0
  126. package/build/src/attachments/attachment_service.d.ts +46 -2
  127. package/build/src/attachments/attachment_service.js +96 -4
  128. package/build/src/auth/actor_store.d.ts +5 -1
  129. package/build/src/auth/actor_store.js +8 -4
  130. package/build/src/auth/conditions.d.ts +5 -0
  131. package/build/src/auth/conditions.js +26 -3
  132. package/build/src/auth/sql.js +17 -5
  133. package/build/src/auth/two_factor.d.ts +96 -0
  134. package/build/src/auth/two_factor.js +259 -0
  135. package/build/src/backups/archive.d.ts +52 -0
  136. package/build/src/backups/archive.js +362 -0
  137. package/build/src/backups/cloud_backups.d.ts +133 -0
  138. package/build/src/backups/cloud_backups.js +650 -0
  139. package/build/src/backups/doctor.d.ts +7 -0
  140. package/build/src/backups/doctor.js +55 -0
  141. package/build/src/backups/providers.d.ts +81 -0
  142. package/build/src/backups/providers.js +470 -0
  143. package/build/src/collaboration/assignments.d.ts +59 -2
  144. package/build/src/collaboration/assignments.js +196 -74
  145. package/build/src/collaboration/record_collaboration.d.ts +21 -4
  146. package/build/src/collaboration/record_collaboration.js +126 -51
  147. package/build/src/collaboration/shared.d.ts +24 -0
  148. package/build/src/collaboration/shared.js +34 -0
  149. package/build/src/commands/app_scaffold.d.ts +72 -0
  150. package/build/src/commands/app_scaffold.js +285 -0
  151. package/build/src/commands/capabilities.js +35 -9
  152. package/build/src/commands/doctor.d.ts +24 -2
  153. package/build/src/commands/doctor.js +81 -6
  154. package/build/src/commands/gap_report.d.ts +1 -1
  155. package/build/src/commands/gap_report.js +2 -2
  156. package/build/src/commands/generator.d.ts +37 -1
  157. package/build/src/commands/generator.js +61 -18
  158. package/build/src/commands/snapshot.d.ts +24 -13
  159. package/build/src/commands/snapshot.js +54 -14
  160. package/build/src/commands/source_markers.d.ts +10 -0
  161. package/build/src/commands/source_markers.js +29 -0
  162. package/build/src/core/activity.d.ts +2 -0
  163. package/build/src/core/activity.js +7 -1
  164. package/build/src/core/administrators.d.ts +38 -0
  165. package/build/src/core/administrators.js +145 -0
  166. package/build/src/core/avatar_image.d.ts +33 -0
  167. package/build/src/core/avatar_image.js +278 -0
  168. package/build/src/core/html_sanitizer.d.ts +20 -0
  169. package/build/src/core/html_sanitizer.js +261 -0
  170. package/build/src/core/like.d.ts +5 -0
  171. package/build/src/core/like.js +5 -0
  172. package/build/src/core/lookups.d.ts +80 -0
  173. package/build/src/core/lookups.js +319 -0
  174. package/build/src/core/mail_settings.d.ts +83 -0
  175. package/build/src/core/mail_settings.js +274 -0
  176. package/build/src/core/mail_test.d.ts +16 -0
  177. package/build/src/core/mail_test.js +81 -6
  178. package/build/src/core/message_templates.d.ts +15 -2
  179. package/build/src/core/message_templates.js +81 -11
  180. package/build/src/core/module_seed.js +2 -1
  181. package/build/src/core/notification_channels.d.ts +235 -0
  182. package/build/src/core/notification_channels.js +660 -0
  183. package/build/src/core/roles.js +26 -9
  184. package/build/src/core/saved_views.d.ts +8 -1
  185. package/build/src/core/saved_views.js +91 -26
  186. package/build/src/core/sequences.d.ts +32 -0
  187. package/build/src/core/sequences.js +97 -0
  188. package/build/src/core/settings.d.ts +5 -0
  189. package/build/src/core/settings.js +31 -3
  190. package/build/src/core/template_language.d.ts +61 -0
  191. package/build/src/core/template_language.js +141 -0
  192. package/build/src/core/ui_preferences.d.ts +10 -0
  193. package/build/src/core/ui_preferences.js +15 -1
  194. package/build/src/core/user_avatars.d.ts +79 -0
  195. package/build/src/core/user_avatars.js +186 -0
  196. package/build/src/core/user_invitations.d.ts +5 -1
  197. package/build/src/core/user_invitations.js +7 -1
  198. package/build/src/core/user_preferences.d.ts +36 -0
  199. package/build/src/core/user_preferences.js +125 -0
  200. package/build/src/core/users.d.ts +2 -0
  201. package/build/src/core/users.js +5 -3
  202. package/build/src/database/calendar_days.d.ts +19 -0
  203. package/build/src/database/calendar_days.js +36 -0
  204. package/build/src/database/schema.d.ts +201 -2
  205. package/build/src/database/schema.js +713 -59
  206. package/build/src/database/schema_diff.d.ts +70 -0
  207. package/build/src/database/schema_diff.js +190 -0
  208. package/build/src/events/record_mutation.d.ts +2 -1
  209. package/build/src/events/record_mutation.js +1 -0
  210. package/build/src/integrations/api_client.d.ts +37 -0
  211. package/build/src/integrations/api_client.js +567 -0
  212. package/build/src/integrations/import_adapters.d.ts +37 -0
  213. package/build/src/integrations/import_adapters.js +35 -0
  214. package/build/src/integrations/imports.d.ts +130 -16
  215. package/build/src/integrations/imports.js +434 -73
  216. package/build/src/integrations/openapi.d.ts +3 -1
  217. package/build/src/integrations/openapi.js +465 -31
  218. package/build/src/integrations/outbound.d.ts +94 -0
  219. package/build/src/integrations/outbound.js +276 -0
  220. package/build/src/integrations/print.d.ts +22 -1
  221. package/build/src/integrations/print.js +68 -22
  222. package/build/src/integrations/print_templates.d.ts +216 -0
  223. package/build/src/integrations/print_templates.js +1017 -0
  224. package/build/src/integrations/sync_jobs.d.ts +139 -0
  225. package/build/src/integrations/sync_jobs.js +416 -0
  226. package/build/src/integrations/webhooks.d.ts +12 -12
  227. package/build/src/integrations/webhooks.js +34 -43
  228. package/build/src/integrations/xlsx.d.ts +41 -0
  229. package/build/src/integrations/xlsx.js +519 -0
  230. package/build/src/languages/ar.d.ts +11 -0
  231. package/build/src/languages/ar.js +358 -0
  232. package/build/src/languages/ar_ui.d.ts +461 -0
  233. package/build/src/languages/ar_ui.js +464 -0
  234. package/build/src/languages/catalog.d.ts +66 -0
  235. package/build/src/languages/catalog.js +152 -0
  236. package/build/src/languages/en.d.ts +7 -0
  237. package/build/src/languages/en.js +352 -0
  238. package/build/src/languages/en_ui.d.ts +3 -0
  239. package/build/src/languages/en_ui.js +458 -0
  240. package/build/src/languages/validation.d.ts +26 -0
  241. package/build/src/languages/validation.js +60 -0
  242. package/build/src/lists/bulk_actions.d.ts +89 -0
  243. package/build/src/lists/bulk_actions.js +268 -0
  244. package/build/src/lists/dashboards.d.ts +138 -0
  245. package/build/src/lists/dashboards.js +290 -0
  246. package/build/src/mcp/tools.js +9 -104
  247. package/build/src/resource/define_resource.d.ts +18 -1
  248. package/build/src/resource/define_resource.js +212 -18
  249. package/build/src/resource/definition.d.ts +44 -0
  250. package/build/src/resource/definition.js +171 -0
  251. package/build/src/resource/registry.js +15 -4
  252. package/build/src/resource/types.d.ts +313 -16
  253. package/build/src/resource/values.d.ts +56 -1
  254. package/build/src/resource/values.js +237 -5
  255. package/build/src/services/settings.d.ts +2 -0
  256. package/build/src/services/settings.js +5 -1
  257. package/build/src/upgrade/legacy.js +2 -2
  258. package/build/src/workflows/calendar.d.ts +9 -0
  259. package/build/src/workflows/calendar.js +44 -0
  260. package/build/src/workflows/define_workflow.d.ts +48 -3
  261. package/build/src/workflows/define_workflow.js +57 -13
  262. package/build/src/workflows/delegations.d.ts +107 -0
  263. package/build/src/workflows/delegations.js +326 -0
  264. package/build/src/workflows/engine.d.ts +80 -4
  265. package/build/src/workflows/engine.js +466 -86
  266. package/build/src/workflows/sla.d.ts +15 -0
  267. package/build/src/workflows/sla.js +8 -0
  268. package/build/stubs/resource_contract.txt +12 -1
  269. package/package.json +9 -2
@@ -0,0 +1,23 @@
1
+ import type { Knex } from 'knex';
2
+ import type { Action, RecordData, Resource } from '../../resource/types.js';
3
+ import type { Actor } from '../../auth/ability.js';
4
+ import { type FieldChange } from '../../events/record_mutation.js';
5
+ import { type ResourceContext } from './shared.js';
6
+ /** The parent record an inline write belongs to, with the action taken on that parent. */
7
+ export type ParentWrite = {
8
+ name: string;
9
+ id: number;
10
+ action: 'create' | 'update' | 'amend';
11
+ /** Set by the inline row's persist() when it created the row or changed a value. */
12
+ changed?: boolean;
13
+ };
14
+ /** Optimistic lock of versioned resources (409 E_VERSION_CONFLICT). */
15
+ export declare function requireVersion(resource: Resource, existing: RecordData, version: unknown): void;
16
+ /** Inline children share the parent's draft state, organization and update authority. */
17
+ export declare function requireInlineParents(ctx: ResourceContext, trx: Knex.Transaction, resource: Resource, actor: Actor, candidate: RecordData, existing?: RecordData, parentWrite?: ParentWrite, system?: boolean): Promise<void>;
18
+ /** Records one mutation in the activity log and the domain event stream. */
19
+ export declare function audit(ctx: ResourceContext, trx: Knex.Transaction, resource: Resource, actor: Actor, action: Action | 'restore', record: RecordData, fields: string[], changes?: FieldChange[], system?: {
20
+ reason?: string;
21
+ }): Promise<void>;
22
+ /** Soft delete, submit or cancel of one record; see ResourceService.transition. */
23
+ export declare function transition(ctx: ResourceContext, name: string, id: number, actor: Actor, action: 'delete' | 'submit' | 'cancel', version?: unknown, transaction?: Knex.Transaction): Promise<import("../../resource/types.js").SerializedRecord>;
@@ -0,0 +1,91 @@
1
+ import { subject } from '@casl/ability';
2
+ import { fromRow, serialize } from '../contracts.js';
3
+ import { AdulaError, documentLocked, forbiddenField, inlineScope, invalidDocumentState, } from '../errors.js';
4
+ import { recordMutation } from '../../events/record_mutation.js';
5
+ import { authorizeAction, fieldLevel, find, findAny, hydrateOne, requireRecord, withLinks, } from './shared.js';
6
+ /** Optimistic lock of versioned resources (409 E_VERSION_CONFLICT). */
7
+ export function requireVersion(resource, existing, version) {
8
+ if (resource.version && (!Number.isSafeInteger(version) || version !== existing.version))
9
+ throw new AdulaError(409, 'E_VERSION_CONFLICT', 'تم تعديل السجل بواسطة مستخدم آخر. حدّث الصفحة وحاول مجدداً.');
10
+ }
11
+ /** Inline children share the parent's draft state, organization and update authority. */
12
+ export async function requireInlineParents(ctx, trx, resource, actor, candidate, existing = {}, parentWrite, system = false) {
13
+ for (const parent of ctx.registry.all()) {
14
+ for (const [key, field] of Object.entries(parent.fields)) {
15
+ if (field.type !== 'hasMany' || !field.inline || field.resource !== resource.name)
16
+ continue;
17
+ const parentId = candidate[field.foreignKey];
18
+ if (parentId === undefined || parentId === null)
19
+ continue;
20
+ if (existing[field.foreignKey] !== undefined &&
21
+ Number(existing[field.foreignKey]) !== Number(parentId))
22
+ throw new AdulaError(422, 'E_INLINE_PARENT', 'Inline records cannot be moved to another parent');
23
+ const action = parentWrite?.name === parent.name && parentWrite.id === Number(parentId)
24
+ ? parentWrite.action
25
+ : 'update';
26
+ let record;
27
+ // amend() authorized the cancelled source; its new draft is checked for state and
28
+ // scope below, and each copied line by the child's own create rules.
29
+ if (system || action === 'amend')
30
+ record = await findAny(trx, parent, Number(parentId), true);
31
+ else {
32
+ const ability = authorizeAction(ctx, parent, actor, action);
33
+ record = await find(trx, parent, actor, ability, Number(parentId), true);
34
+ requireRecord(ability, actor, parent, action, record);
35
+ if (!ability.can(action, subject(parent.name, record), key) ||
36
+ actor.permissionLevel < fieldLevel(parent, key))
37
+ throw forbiddenField('ليس لديك صلاحية تعديل البنود');
38
+ }
39
+ if (parent.submittable && record.docStatus !== 0)
40
+ throw documentLocked('Only draft document lines can be edited');
41
+ if (parent.scoped &&
42
+ resource.scoped &&
43
+ Number(record.orgUnitId) !== Number(candidate.orgUnitId))
44
+ throw inlineScope('Inline records must use the parent organization');
45
+ }
46
+ }
47
+ }
48
+ /** Records one mutation in the activity log and the domain event stream. */
49
+ export async function audit(ctx, trx, resource, actor, action, record, fields, changes, system) {
50
+ await recordMutation(trx, {
51
+ ...(system ? { system: true, reason: system.reason } : {}),
52
+ module: ctx.registry.owner(resource.name),
53
+ resource: resource.name,
54
+ id: record.id,
55
+ actorId: actor.id,
56
+ impersonatorId: actor.impersonatorId,
57
+ action,
58
+ fields,
59
+ changes,
60
+ });
61
+ }
62
+ /** Soft delete, submit or cancel of one record; see ResourceService.transition. */
63
+ export async function transition(ctx, name, id, actor, action, version, transaction) {
64
+ const resource = ctx.registry.get(name);
65
+ const ability = authorizeAction(ctx, resource, actor, action);
66
+ const work = async (trx) => {
67
+ const record = await find(trx, resource, actor, ability, id, true);
68
+ requireRecord(ability, actor, resource, action, record);
69
+ requireVersion(resource, record, version);
70
+ await requireInlineParents(ctx, trx, resource, actor, record);
71
+ const values = { updated_by: actor.id, updated_at: trx.fn.now() };
72
+ if (resource.version)
73
+ values.version = Number(record.version) + 1;
74
+ if (action === 'delete') {
75
+ if (resource.submittable && record.docStatus !== 0)
76
+ throw documentLocked('Only drafts can be deleted');
77
+ values.deleted_at = trx.fn.now();
78
+ }
79
+ else {
80
+ if (!resource.submittable || record.docStatus !== (action === 'submit' ? 0 : 1))
81
+ throw invalidDocumentState('Invalid document transition');
82
+ values.doc_status = action === 'submit' ? 1 : 2;
83
+ }
84
+ const [row] = await trx(name).where({ id }).update(values).returning('*');
85
+ // manyToMany links are not columns; the response carries them like show().
86
+ const [saved] = await withLinks(trx, resource, [fromRow(row, resource)]);
87
+ await audit(ctx, trx, resource, actor, action, saved, []);
88
+ return serialize(resource, await hydrateOne(trx, resource, saved, ctx.attachments), ability, actor);
89
+ };
90
+ return transaction ? work(transaction) : ctx.db.transaction(work);
91
+ }
@@ -0,0 +1,111 @@
1
+ import type { Field, JsonValue, SerializedRecord } from '../../resource/types.js';
2
+ import { type Actor } from '../../auth/ability.js';
3
+ import { type Conditions } from '../../auth/conditions.js';
4
+ import { type ResourceContext } from './shared.js';
5
+ export type AggregateOptions = {
6
+ /** Up to three queryable fields (docStatus and orgUnitId are also accepted). */
7
+ groupBy?: string[];
8
+ /** Count rows per group (default true). */
9
+ count?: boolean;
10
+ /** Integer, money, decimal or percent fields to total per group; totals are decimal strings. */
11
+ sum?: string[];
12
+ /** Equality filters, as in list(). */
13
+ filters?: Record<string, unknown>;
14
+ /** Role-rule style conditions ($eq, $ne, $in, $lt, $gt, $like, "$actor.id"). */
15
+ where?: Conditions;
16
+ search?: string;
17
+ };
18
+ export type AggregateRow = {
19
+ group: Record<string, JsonValue>;
20
+ count?: number;
21
+ sum?: Record<string, string | null>;
22
+ };
23
+ export type ListOptions = {
24
+ limit?: number;
25
+ cursor?: string;
26
+ search?: string;
27
+ sort?: string;
28
+ direction?: 'asc' | 'desc';
29
+ filters?: Record<string, unknown>;
30
+ /** Only records carrying this tag (see RecordCollaboration.setTags). */
31
+ tag?: string;
32
+ estimate?: boolean;
33
+ /**
34
+ * Only soft-deleted records («المحذوفات»), for actors who may delete records of the
35
+ * resource (403 otherwise). Rows are those the actor's delete rules reach, and each
36
+ * row's permissions carry `restore` (ADR 046).
37
+ */
38
+ trashed?: boolean;
39
+ /**
40
+ * Only these records, under the same authorization as the whole list: the row a dialog just
41
+ * created, pinned at the top of the list it was created from.
42
+ */
43
+ ids?: number[];
44
+ };
45
+ /** A scalar filter operand: equality, or one value of an operator. */
46
+ export type ListFilterScalar = string | number | boolean | null;
47
+ /**
48
+ * A list or aggregate filter value (ADR 046): a scalar (equality, null = IS NULL) or one
49
+ * operator object. `in` takes 1–50 values (an array or a comma-separated string);
50
+ * `gte`/`lte` are an inclusive range and may be combined; `empty` matches NULL (and the
51
+ * empty string on text fields) when true and the opposite when false.
52
+ */
53
+ export type ListFilterValue = ListFilterScalar | {
54
+ in: ListFilterScalar[] | string;
55
+ } | {
56
+ gte?: ListFilterScalar;
57
+ lte?: ListFilterScalar;
58
+ } | {
59
+ empty: boolean | 'true' | 'false';
60
+ };
61
+ /** Most values an `in` filter accepts. */
62
+ export declare const FILTER_IN_LIMIT = 50;
63
+ /** A typed filter condition, after validation and coercion of every operand. */
64
+ export type FilterCondition = {
65
+ kind: 'eq';
66
+ value: unknown;
67
+ } | {
68
+ kind: 'in';
69
+ values: unknown[];
70
+ } | {
71
+ kind: 'range';
72
+ gte?: unknown;
73
+ lte?: unknown;
74
+ } | {
75
+ kind: 'empty';
76
+ empty: boolean;
77
+ };
78
+ /**
79
+ * Validates one filter value against its field and coerces every operand to the field's
80
+ * stored representation. Throws 422 E_FILTER for an unknown operator, an operator the
81
+ * field type does not support, or an operand that does not fit the field.
82
+ */
83
+ export declare function filterCondition(key: string, field: Field, value: unknown): FilterCondition;
84
+ /**
85
+ * How many records list() would return for these options, counting at most `max` + 1,
86
+ * so callers can refuse an oversized request with one bounded query.
87
+ */
88
+ export declare function countUpTo(ctx: ResourceContext, name: string, actor: Actor, options: ListOptions, max: number): Promise<number>;
89
+ /**
90
+ * Distinct tag names on records list() would return to the actor, for tag suggestions
91
+ * (RecordCollaboration.tagOptions): the same rules, organization scope and soft-delete
92
+ * filter apply, so a suggestion never names a tag found only on records the actor cannot see.
93
+ */
94
+ export declare function tagNames(ctx: ResourceContext, name: string, actor: Actor, limit: number): Promise<string[]>;
95
+ export declare function list(ctx: ResourceContext, name: string, actor: Actor, options?: ListOptions): Promise<{
96
+ data: SerializedRecord[];
97
+ permissions: {
98
+ [k: string]: Partial<Record<import("../../resource/types.js").Action | "restore", boolean>>;
99
+ };
100
+ meta: {
101
+ limit: number;
102
+ estimatedTotal: number | undefined;
103
+ nextCursor: string | null;
104
+ };
105
+ related: Record<string, SerializedRecord[]>;
106
+ }>;
107
+ /** Counts and totals over viewable records; see ResourceService.aggregate. */
108
+ export declare function aggregate(ctx: ResourceContext, name: string, actor: Actor, options?: AggregateOptions): Promise<{
109
+ rows: AggregateRow[];
110
+ truncated: boolean;
111
+ }>;