@erxes/core-contract 0.1.0-v2.1 → 0.1.0-v2.3

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 (77) hide show
  1. package/dist/activities.d.ts +1387 -139
  2. package/dist/activities.js +90 -30
  3. package/dist/audit.d.ts +1081 -33
  4. package/dist/audit.js +28 -14
  5. package/dist/auth.d.ts +2834 -26
  6. package/dist/auth.js +47 -18
  7. package/dist/automationRuns.d.ts +7 -9
  8. package/dist/automationRuns.js +12 -13
  9. package/dist/automations.d.ts +2443 -61
  10. package/dist/automations.js +41 -21
  11. package/dist/client.d.ts +30704 -0
  12. package/dist/client.js +62 -0
  13. package/dist/common.d.ts +0 -13
  14. package/dist/common.js +1 -13
  15. package/dist/companies.d.ts +1120 -10
  16. package/dist/companies.js +27 -12
  17. package/dist/contract/routes.json.js +17 -1
  18. package/dist/customerAuth.d.ts +1456 -17
  19. package/dist/customerAuth.js +33 -16
  20. package/dist/customers.d.ts +1232 -11
  21. package/dist/customers.js +28 -13
  22. package/dist/{automationDefinition.d.ts → db/src/automationDefinition.d.ts} +2 -2
  23. package/dist/{automationDefinition.js → db/src/automationDefinition.js} +2 -2
  24. package/dist/db/src/enums.js +1 -3
  25. package/dist/db/src/schema/automations.d.ts +1 -0
  26. package/dist/db/src/schema/automations.js +3 -3
  27. package/dist/db/src/schema/index.d.ts +3 -0
  28. package/dist/db/src/schema/index.js +3 -2
  29. package/dist/db/src/schema/leads.js +2 -2
  30. package/dist/db/src/schema/notes.js +92 -0
  31. package/dist/db/src/schema/payments.js +2 -2
  32. package/dist/db/src/schema/platform.js +0 -5
  33. package/dist/db/src/schema/plugins.js +7 -2
  34. package/dist/db/src/schema/transfer.js +2 -2
  35. package/dist/errors.d.ts +516 -0
  36. package/dist/errors.js +218 -0
  37. package/dist/events.d.ts +570 -121
  38. package/dist/events.js +41 -24
  39. package/dist/fields.d.ts +1456 -16
  40. package/dist/fields.js +27 -19
  41. package/dist/files.d.ts +761 -62
  42. package/dist/files.js +32 -21
  43. package/dist/index.d.ts +25187 -618
  44. package/dist/index.js +8 -7
  45. package/dist/leads.d.ts +1105 -21
  46. package/dist/leads.js +31 -13
  47. package/dist/notifications.d.ts +689 -48
  48. package/dist/notifications.js +38 -18
  49. package/dist/organizations.d.ts +260 -2
  50. package/dist/organizations.js +21 -2
  51. package/dist/payments.d.ts +1766 -62
  52. package/dist/payments.js +48 -26
  53. package/dist/platform.d.ts +12 -21
  54. package/dist/platform.js +7 -17
  55. package/dist/plugins.d.ts +802 -71
  56. package/dist/plugins.js +48 -27
  57. package/dist/products.d.ts +1380 -17
  58. package/dist/products.js +32 -16
  59. package/dist/roles.d.ts +560 -5
  60. package/dist/roles.js +20 -6
  61. package/dist/saas.d.ts +164 -2
  62. package/dist/saas.js +9 -2
  63. package/dist/tags.d.ts +340 -4
  64. package/dist/tags.js +14 -6
  65. package/dist/transfer.d.ts +1299 -12
  66. package/dist/transfer.js +32 -13
  67. package/dist/trash.d.ts +278 -21
  68. package/dist/trash.js +23 -16
  69. package/dist/users.d.ts +1206 -18
  70. package/dist/users.js +35 -13
  71. package/dist/values.d.ts +0 -9
  72. package/dist/values.js +2 -7
  73. package/dist/views.d.ts +396 -5
  74. package/dist/views.js +10 -7
  75. package/dist/webhooks.d.ts +765 -9
  76. package/dist/webhooks.js +18 -10
  77. package/package.json +6 -2
package/dist/leads.js CHANGED
@@ -2,10 +2,11 @@ import { CONTENT_TYPES, CUSTOMER_STATES, LEAD_STAGE_KINDS } from "./db/src/enums
2
2
  import { leadStages } from "./db/src/schema/leadStages.js";
3
3
  import { leadEvents } from "./db/src/schema/leads.js";
4
4
  import "./db/src/schema/index.js";
5
+ import { COMMON_ERRORS, ERRORS } from "./errors.js";
5
6
  import { Id, isoDate, listOf } from "./common.js";
6
7
  import { oc } from "@orpc/contract";
7
- import { createSelectSchema, createUpdateSchema } from "drizzle-zod";
8
8
  import { z } from "zod";
9
+ import { createSelectSchema, createUpdateSchema } from "drizzle-zod";
9
10
  // src/leads.ts
10
11
  /** `open`: still being worked; `qualified`: ready to become a customer; `disqualified`: lost. */
11
12
  const LeadStageKind = z.enum(LEAD_STAGE_KINDS);
@@ -106,6 +107,9 @@ const LeadEvent = createSelectSchema(leadEvents, {
106
107
  createdAt: isoDate
107
108
  }).pick({
108
109
  id: true,
110
+ /** The person, or (`companyId`) the company. */
111
+ customerId: true,
112
+ companyId: true,
109
113
  event: true,
110
114
  fromStageId: true,
111
115
  toStageId: true,
@@ -113,9 +117,6 @@ const LeadEvent = createSelectSchema(leadEvents, {
113
117
  actorType: true,
114
118
  actorId: true,
115
119
  createdAt: true
116
- }).extend({
117
- recordType: LeadRecordType,
118
- recordId: Id
119
120
  });
120
121
  const Count = z.object({ count: z.int() });
121
122
  const LeadReport = z.object({
@@ -157,27 +158,44 @@ const LeadReport = z.object({
157
158
  });
158
159
  const Ids = z.array(Id).min(1).max(100);
159
160
  const RecordTypeInput = { recordType: LeadRecordType.default("customer") };
161
+ const { INVALID_ACTOR, INVALID_FILE, INVALID_LEAD_STAGE, INVALID_OWNER, INVALID_TYPE, LAST_OPEN_STAGE, LEAD_STAGE_IN_USE, LIMIT_EXCEEDED, NOTHING_TO_RETRY, NOT_AUTHOR, NOT_A_LEAD, SUBJECT_REQUIRED } = ERRORS;
162
+ /** What these procedures answer with besides the common errors. */
163
+ const base = oc.errors({
164
+ ...COMMON_ERRORS,
165
+ INVALID_ACTOR,
166
+ INVALID_FILE,
167
+ INVALID_LEAD_STAGE,
168
+ INVALID_OWNER,
169
+ INVALID_TYPE,
170
+ LAST_OPEN_STAGE,
171
+ LEAD_STAGE_IN_USE,
172
+ LIMIT_EXCEEDED,
173
+ NOTHING_TO_RETRY,
174
+ NOT_AUTHOR,
175
+ NOT_A_LEAD,
176
+ SUBJECT_REQUIRED
177
+ });
160
178
  const leadsContract = {
161
- stages: oc.route({
179
+ stages: base.route({
162
180
  method: "GET",
163
181
  path: "/lead-stages",
164
182
  summary: "The lead stages, in order, with how many leads each holds"
165
183
  }).output(listOf(LeadStage)),
166
- createStage: oc.route({
184
+ createStage: base.route({
167
185
  method: "POST",
168
186
  path: "/lead-stages",
169
187
  successStatus: 201
170
188
  }).input(StageFields.required({ name: true })).output(LeadStage),
171
- updateStage: oc.route({
189
+ updateStage: base.route({
172
190
  method: "PATCH",
173
191
  path: "/lead-stages/{id}"
174
192
  }).input(StageFields.extend({ id: Id })).output(LeadStage),
175
- reorderStages: oc.route({
193
+ reorderStages: base.route({
176
194
  method: "POST",
177
195
  path: "/lead-stages/reorder",
178
196
  summary: "Every stage id, in the new order"
179
197
  }).input(z.object({ ids: z.array(Id).min(1).max(50) })).output(z.object({ ok: z.literal(true) })),
180
- removeStage: oc.route({
198
+ removeStage: base.route({
181
199
  method: "POST",
182
200
  path: "/lead-stages/{id}/remove",
183
201
  summary: "Delete a stage; its leads move to `moveTo` (required when it has any). The last open stage stays"
@@ -185,7 +203,7 @@ const leadsContract = {
185
203
  id: Id,
186
204
  moveTo: Id.optional()
187
205
  })).output(z.object({ moved: z.int() })),
188
- move: oc.route({
206
+ move: base.route({
189
207
  method: "POST",
190
208
  path: "/leads/move",
191
209
  summary: "Move leads to a stage (a disqualified stage takes a reason)"
@@ -195,7 +213,7 @@ const leadsContract = {
195
213
  stageId: Id,
196
214
  reason: z.string().trim().max(500).optional()
197
215
  })).output(z.object({ moved: z.int() })),
198
- convert: oc.route({
216
+ convert: base.route({
199
217
  method: "POST",
200
218
  path: "/leads/convert",
201
219
  summary: "Leads become customers: optionally given an owner, and (people) linked to a company"
@@ -205,7 +223,7 @@ const leadsContract = {
205
223
  ownerId: Id.optional(),
206
224
  companyId: Id.optional()
207
225
  })).output(z.object({ converted: z.int() })),
208
- history: oc.route({
226
+ history: base.route({
209
227
  method: "GET",
210
228
  path: "/leads/{id}/history",
211
229
  summary: "A lead's journey, its last 200 steps: created, every stage, converted"
@@ -213,7 +231,7 @@ const leadsContract = {
213
231
  ...RecordTypeInput,
214
232
  id: Id
215
233
  })).output(z.object({ data: z.array(LeadEvent).max(200) })),
216
- report: oc.route({
234
+ report: base.route({
217
235
  method: "GET",
218
236
  path: "/leads/report",
219
237
  summary: "Funnel, conversion, sources, owners and reasons for a period (default: last 30 days)"