@erxes/core-contract 0.1.0-v2.0 → 0.1.0-v2.2

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 (102) hide show
  1. package/dist/activities.d.ts +1394 -139
  2. package/dist/activities.js +96 -40
  3. package/dist/audit.d.ts +1092 -48
  4. package/dist/audit.js +37 -23
  5. package/dist/auth.d.ts +2867 -61
  6. package/dist/auth.js +55 -25
  7. package/dist/automationRuns.d.ts +12 -13
  8. package/dist/automationRuns.js +15 -30
  9. package/dist/automations.d.ts +2474 -93
  10. package/dist/automations.js +56 -44
  11. package/dist/client.d.ts +30704 -0
  12. package/dist/client.js +62 -0
  13. package/dist/common.d.ts +28 -16
  14. package/dist/common.js +30 -22
  15. package/dist/companies.d.ts +1154 -44
  16. package/dist/companies.js +33 -17
  17. package/dist/contract/routes.json.js +1810 -0
  18. package/dist/customerAuth.d.ts +1661 -0
  19. package/dist/customerAuth.js +197 -0
  20. package/dist/customers.d.ts +1283 -65
  21. package/dist/customers.js +35 -25
  22. package/dist/{automationDefinition.d.ts → db/src/automationDefinition.d.ts} +4 -3
  23. package/dist/{automationDefinition.js → db/src/automationDefinition.js} +10 -32
  24. package/dist/db/src/enums.d.ts +8 -0
  25. package/dist/db/src/enums.js +334 -0
  26. package/dist/db/src/schema/auditStreams.js +6 -14
  27. package/dist/db/src/schema/authTokens.js +4 -6
  28. package/dist/db/src/schema/automations.d.ts +1 -0
  29. package/dist/db/src/schema/automations.js +15 -31
  30. package/dist/db/src/schema/common.d.ts +2 -6
  31. package/dist/db/src/schema/common.js +1 -24
  32. package/dist/db/src/schema/companies.js +6 -5
  33. package/dist/db/src/schema/customerAuth.js +101 -0
  34. package/dist/db/src/schema/customers.js +6 -6
  35. package/dist/db/src/schema/events.js +12 -60
  36. package/dist/db/src/schema/fieldValues.js +2 -2
  37. package/dist/db/src/schema/fields.js +10 -28
  38. package/dist/db/src/schema/index.d.ts +3 -0
  39. package/dist/db/src/schema/index.js +22 -20
  40. package/dist/db/src/schema/leadStages.js +5 -10
  41. package/dist/db/src/schema/leads.js +6 -11
  42. package/dist/db/src/schema/notes.js +92 -0
  43. package/dist/db/src/schema/oauth.js +3 -3
  44. package/dist/db/src/schema/payments.js +13 -23
  45. package/dist/db/src/schema/platform.js +11 -31
  46. package/dist/db/src/schema/plugins.js +10 -5
  47. package/dist/db/src/schema/products.js +7 -8
  48. package/dist/db/src/schema/rateLimits.js +7 -0
  49. package/dist/db/src/schema/saas.js +3 -9
  50. package/dist/db/src/schema/tags.js +6 -5
  51. package/dist/db/src/schema/transfer.js +13 -33
  52. package/dist/db/src/schema/trash.js +6 -7
  53. package/dist/db/src/schema/users.js +6 -10
  54. package/dist/db/src/schema/views.js +5 -13
  55. package/dist/db/src/schema/webhooks.js +7 -14
  56. package/dist/db/src/table.js +16 -2
  57. package/dist/errors.d.ts +516 -0
  58. package/dist/errors.js +218 -0
  59. package/dist/events.d.ts +585 -140
  60. package/dist/events.js +57 -42
  61. package/dist/fields.d.ts +1478 -66
  62. package/dist/fields.js +33 -47
  63. package/dist/files.d.ts +766 -62
  64. package/dist/files.js +34 -22
  65. package/dist/index.d.ts +25707 -902
  66. package/dist/index.js +22 -20
  67. package/dist/leads.d.ts +1108 -22
  68. package/dist/leads.js +39 -20
  69. package/dist/notifications.d.ts +691 -94
  70. package/dist/notifications.js +45 -91
  71. package/dist/organizations.d.ts +263 -5
  72. package/dist/organizations.js +21 -2
  73. package/dist/payments.d.ts +1794 -120
  74. package/dist/payments.js +58 -60
  75. package/dist/platform.d.ts +12 -20
  76. package/dist/platform.js +8 -21
  77. package/dist/plugins.d.ts +808 -71
  78. package/dist/plugins.js +66 -35
  79. package/dist/products.d.ts +1411 -53
  80. package/dist/products.js +40 -23
  81. package/dist/roles.d.ts +560 -8
  82. package/dist/roles.js +25 -11
  83. package/dist/routes.d.ts +8 -0
  84. package/dist/routes.js +13 -0
  85. package/dist/saas.d.ts +164 -8
  86. package/dist/saas.js +14 -29
  87. package/dist/tags.d.ts +344 -8
  88. package/dist/tags.js +16 -8
  89. package/dist/transfer.d.ts +1361 -36
  90. package/dist/transfer.js +47 -49
  91. package/dist/trash.d.ts +299 -23
  92. package/dist/trash.js +27 -20
  93. package/dist/users.d.ts +1233 -59
  94. package/dist/users.js +48 -39
  95. package/dist/values.d.ts +150 -0
  96. package/dist/values.js +139 -0
  97. package/dist/views.d.ts +404 -13
  98. package/dist/views.js +18 -28
  99. package/dist/webhooks.d.ts +791 -29
  100. package/dist/webhooks.js +36 -21
  101. package/package.json +9 -2
  102. package/dist/db/src/schema/jobs.js +0 -44
package/dist/roles.d.ts CHANGED
@@ -130,9 +130,6 @@ export type CorePermission = (typeof CORE_PERMISSIONS)[number]['action'];
130
130
  export declare const OWNER_ONLY_PERMISSIONS: readonly string[];
131
131
  /** `contacts.delete`, `hr.leave.approve`, or `*` (everything grantable). */
132
132
  export declare const PermissionAction: z.ZodString;
133
- /** `owner`, `admin`, `member`, or a custom role's `r_<id>`. */
134
- export declare const RoleKey: z.ZodString;
135
- export type RoleKey = z.infer<typeof RoleKey>;
136
133
  export declare const Role: z.ZodObject<{
137
134
  key: z.ZodString;
138
135
  name: z.ZodString;
@@ -169,7 +166,118 @@ export declare const rolesContract: {
169
166
  out: {};
170
167
  in: {};
171
168
  }>>;
172
- }, z.core.$strip>, Record<never, never>, Record<never, never>>;
169
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
170
+ UNAUTHORIZED: {
171
+ status: number;
172
+ };
173
+ NOT_ALLOWED: {
174
+ status: number;
175
+ data: z.ZodOptional<z.ZodObject<{
176
+ permission: z.ZodString;
177
+ }, z.core.$strip>>;
178
+ };
179
+ PLUGIN_ONLY: {
180
+ status: number;
181
+ };
182
+ MEMBERS_ONLY: {
183
+ status: number;
184
+ };
185
+ ORG_REQUIRED: {
186
+ status: number;
187
+ };
188
+ SCOPE_REQUIRED: {
189
+ status: number;
190
+ };
191
+ SERVICE_TOKEN_REQUIRED: {
192
+ status: number;
193
+ };
194
+ ORGANIZATION_DISABLED: {
195
+ status: number;
196
+ data: z.ZodObject<{
197
+ manageUrl: z.ZodNullable<z.ZodString>;
198
+ }, z.core.$strip>;
199
+ };
200
+ NOT_IN_PLAN: {
201
+ status: number;
202
+ data: z.ZodOptional<z.ZodObject<{
203
+ manageUrl: z.ZodNullable<z.ZodString>;
204
+ }, z.core.$strip>>;
205
+ };
206
+ READ_ONLY: {
207
+ status: number;
208
+ };
209
+ TOO_MANY_REQUESTS: {
210
+ status: number;
211
+ };
212
+ INVALID_INPUT: {
213
+ status: number;
214
+ data: z.ZodObject<{
215
+ issues: z.ZodArray<z.ZodObject<{
216
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
217
+ message: z.ZodString;
218
+ }, z.core.$strip>>;
219
+ }, z.core.$strip>;
220
+ };
221
+ NOT_FOUND: {
222
+ status: number;
223
+ };
224
+ TAKEN: {
225
+ status: number;
226
+ data: z.ZodObject<{
227
+ field: z.ZodString;
228
+ id: z.ZodOptional<z.ZodString>;
229
+ values: z.ZodOptional<z.ZodArray<z.ZodString>>;
230
+ }, z.core.$strip>;
231
+ };
232
+ INVALID_CURSOR: {
233
+ status: number;
234
+ };
235
+ INVALID_REFERENCE: {
236
+ status: number;
237
+ data: z.ZodObject<{
238
+ field: z.ZodString;
239
+ }, z.core.$strip>;
240
+ };
241
+ INVALID_FILTER: {
242
+ status: number;
243
+ };
244
+ FILTER_TOO_SLOW: {
245
+ status: number;
246
+ };
247
+ BEYOND_OWN_PERMISSIONS: {
248
+ status: number;
249
+ data: z.ZodOptional<z.ZodObject<{
250
+ permissions: z.ZodArray<z.ZodString>;
251
+ }, z.core.$strip>>;
252
+ };
253
+ BUILTIN_ROLE: {
254
+ status: number;
255
+ };
256
+ FIXED_ROLE: {
257
+ status: number;
258
+ };
259
+ LIMIT_EXCEEDED: {
260
+ status: number;
261
+ };
262
+ OWNER_ONLY_PERMISSION: {
263
+ status: number;
264
+ data: z.ZodObject<{
265
+ permissions: z.ZodArray<z.ZodString>;
266
+ }, z.core.$strip>;
267
+ };
268
+ ROLE_IN_USE: {
269
+ status: number;
270
+ };
271
+ ROLE_NOT_FOUND: {
272
+ status: number;
273
+ };
274
+ UNKNOWN_PERMISSION: {
275
+ status: number;
276
+ data: z.ZodObject<{
277
+ permissions: z.ZodArray<z.ZodString>;
278
+ }, z.core.$strip>;
279
+ };
280
+ }>, Record<never, never>>;
173
281
  permissions: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
174
282
  data: z.ZodArray<z.ZodObject<{
175
283
  action: z.ZodString;
@@ -179,7 +287,118 @@ export declare const rolesContract: {
179
287
  source: z.ZodString;
180
288
  ownerOnly: z.ZodBoolean;
181
289
  }, z.core.$strip>>;
182
- }, z.core.$strip>, Record<never, never>, Record<never, never>>;
290
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
291
+ UNAUTHORIZED: {
292
+ status: number;
293
+ };
294
+ NOT_ALLOWED: {
295
+ status: number;
296
+ data: z.ZodOptional<z.ZodObject<{
297
+ permission: z.ZodString;
298
+ }, z.core.$strip>>;
299
+ };
300
+ PLUGIN_ONLY: {
301
+ status: number;
302
+ };
303
+ MEMBERS_ONLY: {
304
+ status: number;
305
+ };
306
+ ORG_REQUIRED: {
307
+ status: number;
308
+ };
309
+ SCOPE_REQUIRED: {
310
+ status: number;
311
+ };
312
+ SERVICE_TOKEN_REQUIRED: {
313
+ status: number;
314
+ };
315
+ ORGANIZATION_DISABLED: {
316
+ status: number;
317
+ data: z.ZodObject<{
318
+ manageUrl: z.ZodNullable<z.ZodString>;
319
+ }, z.core.$strip>;
320
+ };
321
+ NOT_IN_PLAN: {
322
+ status: number;
323
+ data: z.ZodOptional<z.ZodObject<{
324
+ manageUrl: z.ZodNullable<z.ZodString>;
325
+ }, z.core.$strip>>;
326
+ };
327
+ READ_ONLY: {
328
+ status: number;
329
+ };
330
+ TOO_MANY_REQUESTS: {
331
+ status: number;
332
+ };
333
+ INVALID_INPUT: {
334
+ status: number;
335
+ data: z.ZodObject<{
336
+ issues: z.ZodArray<z.ZodObject<{
337
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
338
+ message: z.ZodString;
339
+ }, z.core.$strip>>;
340
+ }, z.core.$strip>;
341
+ };
342
+ NOT_FOUND: {
343
+ status: number;
344
+ };
345
+ TAKEN: {
346
+ status: number;
347
+ data: z.ZodObject<{
348
+ field: z.ZodString;
349
+ id: z.ZodOptional<z.ZodString>;
350
+ values: z.ZodOptional<z.ZodArray<z.ZodString>>;
351
+ }, z.core.$strip>;
352
+ };
353
+ INVALID_CURSOR: {
354
+ status: number;
355
+ };
356
+ INVALID_REFERENCE: {
357
+ status: number;
358
+ data: z.ZodObject<{
359
+ field: z.ZodString;
360
+ }, z.core.$strip>;
361
+ };
362
+ INVALID_FILTER: {
363
+ status: number;
364
+ };
365
+ FILTER_TOO_SLOW: {
366
+ status: number;
367
+ };
368
+ BEYOND_OWN_PERMISSIONS: {
369
+ status: number;
370
+ data: z.ZodOptional<z.ZodObject<{
371
+ permissions: z.ZodArray<z.ZodString>;
372
+ }, z.core.$strip>>;
373
+ };
374
+ BUILTIN_ROLE: {
375
+ status: number;
376
+ };
377
+ FIXED_ROLE: {
378
+ status: number;
379
+ };
380
+ LIMIT_EXCEEDED: {
381
+ status: number;
382
+ };
383
+ OWNER_ONLY_PERMISSION: {
384
+ status: number;
385
+ data: z.ZodObject<{
386
+ permissions: z.ZodArray<z.ZodString>;
387
+ }, z.core.$strip>;
388
+ };
389
+ ROLE_IN_USE: {
390
+ status: number;
391
+ };
392
+ ROLE_NOT_FOUND: {
393
+ status: number;
394
+ };
395
+ UNKNOWN_PERMISSION: {
396
+ status: number;
397
+ data: z.ZodObject<{
398
+ permissions: z.ZodArray<z.ZodString>;
399
+ }, z.core.$strip>;
400
+ };
401
+ }>, Record<never, never>>;
183
402
  create: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
184
403
  name: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
185
404
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -198,7 +417,118 @@ export declare const rolesContract: {
198
417
  }, {
199
418
  out: {};
200
419
  in: {};
201
- }>, Record<never, never>, Record<never, never>>;
420
+ }>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
421
+ UNAUTHORIZED: {
422
+ status: number;
423
+ };
424
+ NOT_ALLOWED: {
425
+ status: number;
426
+ data: z.ZodOptional<z.ZodObject<{
427
+ permission: z.ZodString;
428
+ }, z.core.$strip>>;
429
+ };
430
+ PLUGIN_ONLY: {
431
+ status: number;
432
+ };
433
+ MEMBERS_ONLY: {
434
+ status: number;
435
+ };
436
+ ORG_REQUIRED: {
437
+ status: number;
438
+ };
439
+ SCOPE_REQUIRED: {
440
+ status: number;
441
+ };
442
+ SERVICE_TOKEN_REQUIRED: {
443
+ status: number;
444
+ };
445
+ ORGANIZATION_DISABLED: {
446
+ status: number;
447
+ data: z.ZodObject<{
448
+ manageUrl: z.ZodNullable<z.ZodString>;
449
+ }, z.core.$strip>;
450
+ };
451
+ NOT_IN_PLAN: {
452
+ status: number;
453
+ data: z.ZodOptional<z.ZodObject<{
454
+ manageUrl: z.ZodNullable<z.ZodString>;
455
+ }, z.core.$strip>>;
456
+ };
457
+ READ_ONLY: {
458
+ status: number;
459
+ };
460
+ TOO_MANY_REQUESTS: {
461
+ status: number;
462
+ };
463
+ INVALID_INPUT: {
464
+ status: number;
465
+ data: z.ZodObject<{
466
+ issues: z.ZodArray<z.ZodObject<{
467
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
468
+ message: z.ZodString;
469
+ }, z.core.$strip>>;
470
+ }, z.core.$strip>;
471
+ };
472
+ NOT_FOUND: {
473
+ status: number;
474
+ };
475
+ TAKEN: {
476
+ status: number;
477
+ data: z.ZodObject<{
478
+ field: z.ZodString;
479
+ id: z.ZodOptional<z.ZodString>;
480
+ values: z.ZodOptional<z.ZodArray<z.ZodString>>;
481
+ }, z.core.$strip>;
482
+ };
483
+ INVALID_CURSOR: {
484
+ status: number;
485
+ };
486
+ INVALID_REFERENCE: {
487
+ status: number;
488
+ data: z.ZodObject<{
489
+ field: z.ZodString;
490
+ }, z.core.$strip>;
491
+ };
492
+ INVALID_FILTER: {
493
+ status: number;
494
+ };
495
+ FILTER_TOO_SLOW: {
496
+ status: number;
497
+ };
498
+ BEYOND_OWN_PERMISSIONS: {
499
+ status: number;
500
+ data: z.ZodOptional<z.ZodObject<{
501
+ permissions: z.ZodArray<z.ZodString>;
502
+ }, z.core.$strip>>;
503
+ };
504
+ BUILTIN_ROLE: {
505
+ status: number;
506
+ };
507
+ FIXED_ROLE: {
508
+ status: number;
509
+ };
510
+ LIMIT_EXCEEDED: {
511
+ status: number;
512
+ };
513
+ OWNER_ONLY_PERMISSION: {
514
+ status: number;
515
+ data: z.ZodObject<{
516
+ permissions: z.ZodArray<z.ZodString>;
517
+ }, z.core.$strip>;
518
+ };
519
+ ROLE_IN_USE: {
520
+ status: number;
521
+ };
522
+ ROLE_NOT_FOUND: {
523
+ status: number;
524
+ };
525
+ UNKNOWN_PERMISSION: {
526
+ status: number;
527
+ data: z.ZodObject<{
528
+ permissions: z.ZodArray<z.ZodString>;
529
+ }, z.core.$strip>;
530
+ };
531
+ }>, Record<never, never>>;
202
532
  update: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
203
533
  name: z.ZodOptional<z.ZodString>;
204
534
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -218,10 +548,232 @@ export declare const rolesContract: {
218
548
  }, {
219
549
  out: {};
220
550
  in: {};
221
- }>, Record<never, never>, Record<never, never>>;
551
+ }>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
552
+ UNAUTHORIZED: {
553
+ status: number;
554
+ };
555
+ NOT_ALLOWED: {
556
+ status: number;
557
+ data: z.ZodOptional<z.ZodObject<{
558
+ permission: z.ZodString;
559
+ }, z.core.$strip>>;
560
+ };
561
+ PLUGIN_ONLY: {
562
+ status: number;
563
+ };
564
+ MEMBERS_ONLY: {
565
+ status: number;
566
+ };
567
+ ORG_REQUIRED: {
568
+ status: number;
569
+ };
570
+ SCOPE_REQUIRED: {
571
+ status: number;
572
+ };
573
+ SERVICE_TOKEN_REQUIRED: {
574
+ status: number;
575
+ };
576
+ ORGANIZATION_DISABLED: {
577
+ status: number;
578
+ data: z.ZodObject<{
579
+ manageUrl: z.ZodNullable<z.ZodString>;
580
+ }, z.core.$strip>;
581
+ };
582
+ NOT_IN_PLAN: {
583
+ status: number;
584
+ data: z.ZodOptional<z.ZodObject<{
585
+ manageUrl: z.ZodNullable<z.ZodString>;
586
+ }, z.core.$strip>>;
587
+ };
588
+ READ_ONLY: {
589
+ status: number;
590
+ };
591
+ TOO_MANY_REQUESTS: {
592
+ status: number;
593
+ };
594
+ INVALID_INPUT: {
595
+ status: number;
596
+ data: z.ZodObject<{
597
+ issues: z.ZodArray<z.ZodObject<{
598
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
599
+ message: z.ZodString;
600
+ }, z.core.$strip>>;
601
+ }, z.core.$strip>;
602
+ };
603
+ NOT_FOUND: {
604
+ status: number;
605
+ };
606
+ TAKEN: {
607
+ status: number;
608
+ data: z.ZodObject<{
609
+ field: z.ZodString;
610
+ id: z.ZodOptional<z.ZodString>;
611
+ values: z.ZodOptional<z.ZodArray<z.ZodString>>;
612
+ }, z.core.$strip>;
613
+ };
614
+ INVALID_CURSOR: {
615
+ status: number;
616
+ };
617
+ INVALID_REFERENCE: {
618
+ status: number;
619
+ data: z.ZodObject<{
620
+ field: z.ZodString;
621
+ }, z.core.$strip>;
622
+ };
623
+ INVALID_FILTER: {
624
+ status: number;
625
+ };
626
+ FILTER_TOO_SLOW: {
627
+ status: number;
628
+ };
629
+ BEYOND_OWN_PERMISSIONS: {
630
+ status: number;
631
+ data: z.ZodOptional<z.ZodObject<{
632
+ permissions: z.ZodArray<z.ZodString>;
633
+ }, z.core.$strip>>;
634
+ };
635
+ BUILTIN_ROLE: {
636
+ status: number;
637
+ };
638
+ FIXED_ROLE: {
639
+ status: number;
640
+ };
641
+ LIMIT_EXCEEDED: {
642
+ status: number;
643
+ };
644
+ OWNER_ONLY_PERMISSION: {
645
+ status: number;
646
+ data: z.ZodObject<{
647
+ permissions: z.ZodArray<z.ZodString>;
648
+ }, z.core.$strip>;
649
+ };
650
+ ROLE_IN_USE: {
651
+ status: number;
652
+ };
653
+ ROLE_NOT_FOUND: {
654
+ status: number;
655
+ };
656
+ UNKNOWN_PERMISSION: {
657
+ status: number;
658
+ data: z.ZodObject<{
659
+ permissions: z.ZodArray<z.ZodString>;
660
+ }, z.core.$strip>;
661
+ };
662
+ }>, Record<never, never>>;
222
663
  remove: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
223
664
  key: z.ZodString;
224
665
  }, z.core.$strip>, z.ZodObject<{
225
666
  ok: z.ZodLiteral<true>;
226
- }, z.core.$strip>, Record<never, never>, Record<never, never>>;
667
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
668
+ UNAUTHORIZED: {
669
+ status: number;
670
+ };
671
+ NOT_ALLOWED: {
672
+ status: number;
673
+ data: z.ZodOptional<z.ZodObject<{
674
+ permission: z.ZodString;
675
+ }, z.core.$strip>>;
676
+ };
677
+ PLUGIN_ONLY: {
678
+ status: number;
679
+ };
680
+ MEMBERS_ONLY: {
681
+ status: number;
682
+ };
683
+ ORG_REQUIRED: {
684
+ status: number;
685
+ };
686
+ SCOPE_REQUIRED: {
687
+ status: number;
688
+ };
689
+ SERVICE_TOKEN_REQUIRED: {
690
+ status: number;
691
+ };
692
+ ORGANIZATION_DISABLED: {
693
+ status: number;
694
+ data: z.ZodObject<{
695
+ manageUrl: z.ZodNullable<z.ZodString>;
696
+ }, z.core.$strip>;
697
+ };
698
+ NOT_IN_PLAN: {
699
+ status: number;
700
+ data: z.ZodOptional<z.ZodObject<{
701
+ manageUrl: z.ZodNullable<z.ZodString>;
702
+ }, z.core.$strip>>;
703
+ };
704
+ READ_ONLY: {
705
+ status: number;
706
+ };
707
+ TOO_MANY_REQUESTS: {
708
+ status: number;
709
+ };
710
+ INVALID_INPUT: {
711
+ status: number;
712
+ data: z.ZodObject<{
713
+ issues: z.ZodArray<z.ZodObject<{
714
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
715
+ message: z.ZodString;
716
+ }, z.core.$strip>>;
717
+ }, z.core.$strip>;
718
+ };
719
+ NOT_FOUND: {
720
+ status: number;
721
+ };
722
+ TAKEN: {
723
+ status: number;
724
+ data: z.ZodObject<{
725
+ field: z.ZodString;
726
+ id: z.ZodOptional<z.ZodString>;
727
+ values: z.ZodOptional<z.ZodArray<z.ZodString>>;
728
+ }, z.core.$strip>;
729
+ };
730
+ INVALID_CURSOR: {
731
+ status: number;
732
+ };
733
+ INVALID_REFERENCE: {
734
+ status: number;
735
+ data: z.ZodObject<{
736
+ field: z.ZodString;
737
+ }, z.core.$strip>;
738
+ };
739
+ INVALID_FILTER: {
740
+ status: number;
741
+ };
742
+ FILTER_TOO_SLOW: {
743
+ status: number;
744
+ };
745
+ BEYOND_OWN_PERMISSIONS: {
746
+ status: number;
747
+ data: z.ZodOptional<z.ZodObject<{
748
+ permissions: z.ZodArray<z.ZodString>;
749
+ }, z.core.$strip>>;
750
+ };
751
+ BUILTIN_ROLE: {
752
+ status: number;
753
+ };
754
+ FIXED_ROLE: {
755
+ status: number;
756
+ };
757
+ LIMIT_EXCEEDED: {
758
+ status: number;
759
+ };
760
+ OWNER_ONLY_PERMISSION: {
761
+ status: number;
762
+ data: z.ZodObject<{
763
+ permissions: z.ZodArray<z.ZodString>;
764
+ }, z.core.$strip>;
765
+ };
766
+ ROLE_IN_USE: {
767
+ status: number;
768
+ };
769
+ ROLE_NOT_FOUND: {
770
+ status: number;
771
+ };
772
+ UNKNOWN_PERMISSION: {
773
+ status: number;
774
+ data: z.ZodObject<{
775
+ permissions: z.ZodArray<z.ZodString>;
776
+ }, z.core.$strip>;
777
+ };
778
+ }>, Record<never, never>>;
227
779
  };
package/dist/roles.js CHANGED
@@ -1,8 +1,11 @@
1
1
  import { roles } from "./db/src/schema/users.js";
2
2
  import "./db/src/schema/index.js";
3
+ import { COMMON_ERRORS, ERRORS } from "./errors.js";
4
+ import { listOf } from "./common.js";
5
+ import { RoleKey } from "./values.js";
3
6
  import { oc } from "@orpc/contract";
4
- import { createSelectSchema, createUpdateSchema } from "drizzle-zod";
5
7
  import { z } from "zod";
8
+ import { createSelectSchema, createUpdateSchema } from "drizzle-zod";
6
9
  // src/roles.ts
7
10
  /**
8
11
  * What a member may do, as actions (`contacts.delete`). Roles are named sets
@@ -164,8 +167,6 @@ const CORE_PERMISSIONS = [
164
167
  const OWNER_ONLY_PERMISSIONS = CORE_PERMISSIONS.filter((permission) => "ownerOnly" in permission && permission.ownerOnly).map((permission) => permission.action);
165
168
  /** `contacts.delete`, `hr.leave.approve`, or `*` (everything grantable). */
166
169
  const PermissionAction = z.string().trim().regex(/^(\*|[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)+)$/, "an action like contacts.delete");
167
- /** `owner`, `admin`, `member`, or a custom role's `r_<id>`. */
168
- const RoleKey = z.string().trim().regex(/^(owner|admin|member|r_[A-Za-z0-9]{6,40})$/, "a role");
169
170
  const Role = createSelectSchema(roles).pick({
170
171
  key: true,
171
172
  name: true,
@@ -195,18 +196,31 @@ const RoleFields = createUpdateSchema(roles, {
195
196
  description: true,
196
197
  permissions: true
197
198
  });
199
+ const { BEYOND_OWN_PERMISSIONS, BUILTIN_ROLE, FIXED_ROLE, LIMIT_EXCEEDED, OWNER_ONLY_PERMISSION, ROLE_IN_USE, ROLE_NOT_FOUND, UNKNOWN_PERMISSION } = ERRORS;
200
+ /** What these procedures answer with besides the common errors. */
201
+ const base = oc.errors({
202
+ ...COMMON_ERRORS,
203
+ BEYOND_OWN_PERMISSIONS,
204
+ BUILTIN_ROLE,
205
+ FIXED_ROLE,
206
+ LIMIT_EXCEEDED,
207
+ OWNER_ONLY_PERMISSION,
208
+ ROLE_IN_USE,
209
+ ROLE_NOT_FOUND,
210
+ UNKNOWN_PERMISSION
211
+ });
198
212
  const rolesContract = {
199
- list: oc.route({
213
+ list: base.route({
200
214
  method: "GET",
201
215
  path: "/roles",
202
216
  summary: "Roles of the organisation, with member counts"
203
- }).output(z.object({ data: z.array(Role) })),
204
- permissions: oc.route({
217
+ }).output(listOf(Role)),
218
+ permissions: base.route({
205
219
  method: "GET",
206
220
  path: "/permissions",
207
221
  summary: "Every action a role can include: core's and installed plugins'"
208
- }).output(z.object({ data: z.array(PermissionInfo) })),
209
- create: oc.route({
222
+ }).output(listOf(PermissionInfo)),
223
+ create: base.route({
210
224
  method: "POST",
211
225
  path: "/roles",
212
226
  successStatus: 201,
@@ -215,15 +229,15 @@ const rolesContract = {
215
229
  name: true,
216
230
  permissions: true
217
231
  })).output(Role),
218
- update: oc.route({
232
+ update: base.route({
219
233
  method: "PATCH",
220
234
  path: "/roles/{key}",
221
235
  summary: "Rename a role or change its permissions (roles.manage; not Owner or Admin)"
222
236
  }).input(RoleFields.extend({ key: RoleKey })).output(Role),
223
- remove: oc.route({
237
+ remove: base.route({
224
238
  method: "DELETE",
225
239
  path: "/roles/{key}",
226
240
  summary: "Delete a custom role nobody has (roles.manage); 409 ROLE_IN_USE"
227
241
  }).input(z.object({ key: RoleKey })).output(z.object({ ok: z.literal(true) }))
228
242
  };
229
- export { CORE_PERMISSIONS, OWNER_ONLY_PERMISSIONS, PermissionAction, PermissionInfo, Role, RoleKey, rolesContract };
243
+ export { CORE_PERMISSIONS, OWNER_ONLY_PERMISSIONS, PermissionAction, PermissionInfo, Role, rolesContract };
@@ -0,0 +1,8 @@
1
+ import { AnyContractRouter } from "@orpc/contract";
2
+ /**
3
+ * Every procedure's method and path, without its schemas (`pnpm openapi` writes
4
+ * routes.json). Pass it to `OpenAPILink` and type the client with
5
+ * `ContractRouterClient<typeof coreContract>` from an `import type`: the client
6
+ * then loads no table and no drizzle.
7
+ */
8
+ export declare const coreRoutes: AnyContractRouter;
package/dist/routes.js ADDED
@@ -0,0 +1,13 @@
1
+ import routes_default from "./contract/routes.json.js";
2
+ import { isContractProcedure } from "@orpc/contract";
3
+ // src/routes.ts
4
+ const isRouter = (value) => isContractProcedure(value) || typeof value === "object" && value !== null && Object.values(value).every(isRouter);
5
+ if (!isRouter(routes_default)) throw new Error("routes.json is not a contract router: run pnpm openapi");
6
+ /**
7
+ * Every procedure's method and path, without its schemas (`pnpm openapi` writes
8
+ * routes.json). Pass it to `OpenAPILink` and type the client with
9
+ * `ContractRouterClient<typeof coreContract>` from an `import type`: the client
10
+ * then loads no table and no drizzle.
11
+ */
12
+ const coreRoutes = routes_default;
13
+ export { coreRoutes };