@clivly/core 0.1.0 → 0.3.0-next.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 (44) hide show
  1. package/README.md +57 -0
  2. package/dist/adapter.cjs +0 -0
  3. package/dist/adapter.d.cts +46 -0
  4. package/dist/adapter.d.mts +16 -3
  5. package/dist/auth-adapter.cjs +7 -0
  6. package/dist/auth-adapter.d.cts +30 -0
  7. package/dist/drizzle.cjs +32 -0
  8. package/dist/drizzle.d.cts +21 -0
  9. package/dist/drizzle.d.mts +21 -0
  10. package/dist/drizzle.mjs +31 -0
  11. package/dist/entity-config.cjs +350 -0
  12. package/dist/entity-config.d.cts +296 -0
  13. package/dist/entity-config.d.mts +46 -8
  14. package/dist/entity-config.mjs +86 -13
  15. package/dist/entity-heuristics.cjs +442 -0
  16. package/dist/entity-heuristics.d.cts +68 -0
  17. package/dist/entity-heuristics.d.mts +68 -0
  18. package/dist/entity-heuristics.mjs +431 -0
  19. package/dist/index.cjs +27 -0
  20. package/dist/index.d.cts +9 -0
  21. package/dist/index.d.mts +4 -4
  22. package/dist/index.mjs +3 -3
  23. package/dist/mapping-form.cjs +50 -0
  24. package/dist/mapping-form.d.cts +35 -0
  25. package/dist/mapping-score.cjs +97 -0
  26. package/dist/mapping-score.d.cts +49 -0
  27. package/dist/mapping-score.d.mts +49 -0
  28. package/dist/mapping-score.mjs +87 -0
  29. package/dist/mappings-config.cjs +100 -0
  30. package/dist/mappings-config.d.cts +42 -0
  31. package/dist/mappings-config.d.mts +1 -0
  32. package/dist/mappings-config.mjs +21 -1
  33. package/dist/sync-engine.cjs +211 -0
  34. package/dist/sync-engine.d.cts +183 -0
  35. package/dist/sync-engine.d.mts +54 -9
  36. package/dist/sync-engine.mjs +91 -22
  37. package/dist/types.cjs +0 -0
  38. package/dist/types.d.cts +159 -0
  39. package/dist/types.d.mts +12 -1
  40. package/dist/view-compiler.cjs +188 -0
  41. package/dist/view-compiler.d.cts +71 -0
  42. package/dist/view-compiler.d.mts +29 -1
  43. package/dist/view-compiler.mjs +31 -1
  44. package/package.json +116 -23
@@ -0,0 +1,183 @@
1
+ import { ClivlyEntitiesConfig } from "./entity-config.cjs";
2
+ import { CompileOptions, CompiledView } from "./view-compiler.cjs";
3
+
4
+ //#region src/sync-engine.d.ts
5
+ /**
6
+ * Sync engine (Phase 3) — materializes the read-only entity views into Clivly's
7
+ * own mirror tables (`crm_companies`, `crm_contacts`).
8
+ *
9
+ * The reconciliation is the heart of the design: rows present in a view are
10
+ * created or updated in the mirror; rows that *leave* a view (e.g. an owner
11
+ * demoted to a member) are **archived, not deleted**, so their deals/activities
12
+ * survive. Identity fields are host-owned and overwritten each run; Clivly-owned
13
+ * CRM fields are never touched here.
14
+ *
15
+ * `reconcile()` is a pure function and independently testable. `runSync()`
16
+ * orchestrates: compile views → for each (companies first, so contact
17
+ * `company_ref`s resolve to a live `crm_companies.id`) read the view, reconcile
18
+ * against the current mirror, resolve company refs, and persist. All DB I/O is
19
+ * behind the `SyncStore` port — core stays ORM-agnostic; the SDK/drizzle
20
+ * package provides the concrete store.
21
+ */
22
+ /** A row read from a compiled view (what Postgres returns). */
23
+ interface SourceRow {
24
+ /** Host-side company key from `<relationship>_ref`; resolved before persist. */
25
+ companyRef?: string | null;
26
+ /** Mapped identity fields (clivly field → value). */
27
+ fields: Record<string, string | null>;
28
+ /** The source primary key — becomes the mirror row's `source_ref`. */
29
+ sourceRef: string;
30
+ }
31
+ /** An existing mirror row, as far as reconciliation needs to know. */
32
+ interface MirrorRecord {
33
+ archivedAt: Date | null;
34
+ /** Host-side company key; only consulted in composite (join-table) mode. */
35
+ companyRef: string | null;
36
+ id: string;
37
+ sourceRef: string;
38
+ }
39
+ type SyncAction = {
40
+ kind: "create";
41
+ sourceRef: string;
42
+ fields: Record<string, string | null>;
43
+ companyRef: string | null;
44
+ } | {
45
+ kind: "update";
46
+ id: string;
47
+ sourceRef: string;
48
+ fields: Record<string, string | null>;
49
+ companyRef: string | null;
50
+ } | {
51
+ kind: "restore";
52
+ id: string;
53
+ sourceRef: string;
54
+ fields: Record<string, string | null>;
55
+ companyRef: string | null;
56
+ } | {
57
+ kind: "archive";
58
+ id: string;
59
+ sourceRef: string;
60
+ };
61
+ /** A persist action with the company ref resolved to a `crm_companies.id`. */
62
+ type PersistAction = {
63
+ kind: "create";
64
+ sourceRef: string;
65
+ fields: Record<string, string | null>;
66
+ companyId: string | null;
67
+ companySourceRef: string | null;
68
+ } | {
69
+ kind: "update";
70
+ id: string;
71
+ sourceRef: string;
72
+ fields: Record<string, string | null>;
73
+ companyId: string | null;
74
+ companySourceRef: string | null;
75
+ } | {
76
+ kind: "restore";
77
+ id: string;
78
+ sourceRef: string;
79
+ fields: Record<string, string | null>;
80
+ companyId: string | null;
81
+ companySourceRef: string | null;
82
+ } | {
83
+ kind: "archive";
84
+ id: string;
85
+ sourceRef: string;
86
+ };
87
+ /**
88
+ * Diff a view's rows against the current mirror population for one entity.
89
+ *
90
+ * - source row with no mirror row → create
91
+ * - source row with a live mirror row → update (overwrite identity fields)
92
+ * - source row with an archived mirror → restore (re-activate + update)
93
+ * - live mirror row absent from source → archive (soft delete, keep history)
94
+ * - archived mirror row absent from source → no-op
95
+ *
96
+ * Source rows are de-duplicated by the reconciliation key (first wins). In
97
+ * simple mode (default) the key is `sourceRef`. In composite mode — used for
98
+ * `through` (join-table) entities, where the compiled view fans a person out
99
+ * into one row per membership — the key is `(sourceRef, companyRef)`, so a
100
+ * person in several companies materializes one mirror row per company and a
101
+ * single membership leaving archives only that one row.
102
+ */
103
+ declare function reconcile(source: SourceRow[], mirror: MirrorRecord[], opts?: {
104
+ composite?: boolean;
105
+ }): SyncAction[];
106
+ /** DB I/O port. The concrete store lives in the SDK/drizzle package. */
107
+ interface SyncStore {
108
+ /** Current mirror rows for a concept + role (including archived). */
109
+ listMirror(input: {
110
+ concept: string;
111
+ role: string; /** Target custom-object type id, for `concept: "custom"` entities. */
112
+ objectTypeId?: string;
113
+ }): Promise<MirrorRecord[]>;
114
+ /** Apply the resolved actions to the mirror table for this concept + role. */
115
+ persist(input: {
116
+ concept: string;
117
+ role: string; /** Target custom-object type id, for `concept: "custom"` entities. */
118
+ objectTypeId?: string;
119
+ actions: PersistAction[];
120
+ }): Promise<void>;
121
+ /**
122
+ * Execute the view's SQL and return its rows. `opts.limit`, when given,
123
+ * caps the number of rows returned (used by `runSync`'s sample mode).
124
+ */
125
+ readView(view: CompiledView, opts?: {
126
+ limit?: number;
127
+ }): Promise<SourceRow[]>;
128
+ /** Map host-side company refs → `crm_companies.id` (already-synced companies only). */
129
+ resolveCompanyRefs(refs: string[]): Promise<Map<string, string>>;
130
+ }
131
+ interface EntitySyncResult {
132
+ archived: number;
133
+ concept: string;
134
+ created: number;
135
+ entityKey: string;
136
+ restored: number;
137
+ role: string;
138
+ updated: number;
139
+ }
140
+ interface SyncResult {
141
+ entities: EntitySyncResult[];
142
+ totals: {
143
+ created: number;
144
+ updated: number;
145
+ restored: number;
146
+ archived: number;
147
+ };
148
+ }
149
+ /**
150
+ * Run a full sync: compile the config's views, then reconcile + persist each,
151
+ * companies first. Returns per-entity and total action counts.
152
+ */
153
+ declare function runSync(config: ClivlyEntitiesConfig, store: SyncStore, options?: CompileOptions): Promise<SyncResult>;
154
+ interface PreviewWarning {
155
+ field?: string;
156
+ message: string;
157
+ }
158
+ interface PreviewResult {
159
+ rows: SourceRow[];
160
+ sampledCount: number;
161
+ warnings: PreviewWarning[];
162
+ }
163
+ /**
164
+ * Sample-scoped data-quality warnings over projected preview rows. Each mapped
165
+ * (or required-but-unmapped) field yields at most one warning, by precedence:
166
+ * a required field empty in ≥1 row → `K/N` form; an optional field empty in
167
+ * ALL rows → all-empty form; zero source rows → a single table-level warning.
168
+ */
169
+ declare function computeSampleWarnings(rows: SourceRow[], requiredFields: string[], sourceTable: string): PreviewWarning[];
170
+ /**
171
+ * Zero-write preview: read ≤`limit` rows through the compiled view (a pure
172
+ * SELECT whose SQL already projects each row into its mapped fields) and
173
+ * compute sample warnings. Calls ONLY `store.readView` — never a write path —
174
+ * so it can never mutate the mirror. The distinct, write-one-row sibling is
175
+ * `runSync`'s sample mode (T13).
176
+ */
177
+ declare function previewSync(store: SyncStore, view: CompiledView, opts: {
178
+ limit: number;
179
+ requiredFields: string[];
180
+ sourceTable: string;
181
+ }): Promise<PreviewResult>;
182
+ //#endregion
183
+ export { EntitySyncResult, MirrorRecord, PersistAction, PreviewResult, PreviewWarning, SourceRow, SyncAction, SyncResult, SyncStore, computeSampleWarnings, previewSync, reconcile, runSync };
@@ -31,6 +31,8 @@ interface SourceRow {
31
31
  /** An existing mirror row, as far as reconciliation needs to know. */
32
32
  interface MirrorRecord {
33
33
  archivedAt: Date | null;
34
+ /** Host-side company key; only consulted in composite (join-table) mode. */
35
+ companyRef: string | null;
34
36
  id: string;
35
37
  sourceRef: string;
36
38
  }
@@ -62,18 +64,21 @@ type PersistAction = {
62
64
  sourceRef: string;
63
65
  fields: Record<string, string | null>;
64
66
  companyId: string | null;
67
+ companySourceRef: string | null;
65
68
  } | {
66
69
  kind: "update";
67
70
  id: string;
68
71
  sourceRef: string;
69
72
  fields: Record<string, string | null>;
70
73
  companyId: string | null;
74
+ companySourceRef: string | null;
71
75
  } | {
72
76
  kind: "restore";
73
77
  id: string;
74
78
  sourceRef: string;
75
79
  fields: Record<string, string | null>;
76
80
  companyId: string | null;
81
+ companySourceRef: string | null;
77
82
  } | {
78
83
  kind: "archive";
79
84
  id: string;
@@ -88,26 +93,38 @@ type PersistAction = {
88
93
  * - live mirror row absent from source → archive (soft delete, keep history)
89
94
  * - archived mirror row absent from source → no-op
90
95
  *
91
- * Source rows are de-duplicated by `sourceRef` (first wins). A person appearing
92
- * under multiple companies (many-to-many via a join table) collapses to their
93
- * first company here; richer many-to-many membership is deferred.
96
+ * Source rows are de-duplicated by the reconciliation key (first wins). In
97
+ * simple mode (default) the key is `sourceRef`. In composite mode — used for
98
+ * `through` (join-table) entities, where the compiled view fans a person out
99
+ * into one row per membership — the key is `(sourceRef, companyRef)`, so a
100
+ * person in several companies materializes one mirror row per company and a
101
+ * single membership leaving archives only that one row.
94
102
  */
95
- declare function reconcile(source: SourceRow[], mirror: MirrorRecord[]): SyncAction[];
103
+ declare function reconcile(source: SourceRow[], mirror: MirrorRecord[], opts?: {
104
+ composite?: boolean;
105
+ }): SyncAction[];
96
106
  /** DB I/O port. The concrete store lives in the SDK/drizzle package. */
97
107
  interface SyncStore {
98
108
  /** Current mirror rows for a concept + role (including archived). */
99
109
  listMirror(input: {
100
110
  concept: string;
101
- role: string;
111
+ role: string; /** Target custom-object type id, for `concept: "custom"` entities. */
112
+ objectTypeId?: string;
102
113
  }): Promise<MirrorRecord[]>;
103
114
  /** Apply the resolved actions to the mirror table for this concept + role. */
104
115
  persist(input: {
105
116
  concept: string;
106
- role: string;
117
+ role: string; /** Target custom-object type id, for `concept: "custom"` entities. */
118
+ objectTypeId?: string;
107
119
  actions: PersistAction[];
108
120
  }): Promise<void>;
109
- /** Execute the view's SQL and return its rows. */
110
- readView(view: CompiledView): Promise<SourceRow[]>;
121
+ /**
122
+ * Execute the view's SQL and return its rows. `opts.limit`, when given,
123
+ * caps the number of rows returned (used by `runSync`'s sample mode).
124
+ */
125
+ readView(view: CompiledView, opts?: {
126
+ limit?: number;
127
+ }): Promise<SourceRow[]>;
111
128
  /** Map host-side company refs → `crm_companies.id` (already-synced companies only). */
112
129
  resolveCompanyRefs(refs: string[]): Promise<Map<string, string>>;
113
130
  }
@@ -134,5 +151,33 @@ interface SyncResult {
134
151
  * companies first. Returns per-entity and total action counts.
135
152
  */
136
153
  declare function runSync(config: ClivlyEntitiesConfig, store: SyncStore, options?: CompileOptions): Promise<SyncResult>;
154
+ interface PreviewWarning {
155
+ field?: string;
156
+ message: string;
157
+ }
158
+ interface PreviewResult {
159
+ rows: SourceRow[];
160
+ sampledCount: number;
161
+ warnings: PreviewWarning[];
162
+ }
163
+ /**
164
+ * Sample-scoped data-quality warnings over projected preview rows. Each mapped
165
+ * (or required-but-unmapped) field yields at most one warning, by precedence:
166
+ * a required field empty in ≥1 row → `K/N` form; an optional field empty in
167
+ * ALL rows → all-empty form; zero source rows → a single table-level warning.
168
+ */
169
+ declare function computeSampleWarnings(rows: SourceRow[], requiredFields: string[], sourceTable: string): PreviewWarning[];
170
+ /**
171
+ * Zero-write preview: read ≤`limit` rows through the compiled view (a pure
172
+ * SELECT whose SQL already projects each row into its mapped fields) and
173
+ * compute sample warnings. Calls ONLY `store.readView` — never a write path —
174
+ * so it can never mutate the mirror. The distinct, write-one-row sibling is
175
+ * `runSync`'s sample mode (T13).
176
+ */
177
+ declare function previewSync(store: SyncStore, view: CompiledView, opts: {
178
+ limit: number;
179
+ requiredFields: string[];
180
+ sourceTable: string;
181
+ }): Promise<PreviewResult>;
137
182
  //#endregion
138
- export { EntitySyncResult, MirrorRecord, PersistAction, SourceRow, SyncAction, SyncResult, SyncStore, reconcile, runSync };
183
+ export { EntitySyncResult, MirrorRecord, PersistAction, PreviewResult, PreviewWarning, SourceRow, SyncAction, SyncResult, SyncStore, computeSampleWarnings, previewSync, reconcile, runSync };
@@ -9,24 +9,32 @@ import { compileEntityViews } from "./view-compiler.mjs";
9
9
  * - live mirror row absent from source → archive (soft delete, keep history)
10
10
  * - archived mirror row absent from source → no-op
11
11
  *
12
- * Source rows are de-duplicated by `sourceRef` (first wins). A person appearing
13
- * under multiple companies (many-to-many via a join table) collapses to their
14
- * first company here; richer many-to-many membership is deferred.
12
+ * Source rows are de-duplicated by the reconciliation key (first wins). In
13
+ * simple mode (default) the key is `sourceRef`. In composite mode — used for
14
+ * `through` (join-table) entities, where the compiled view fans a person out
15
+ * into one row per membership — the key is `(sourceRef, companyRef)`, so a
16
+ * person in several companies materializes one mirror row per company and a
17
+ * single membership leaving archives only that one row.
15
18
  */
16
- function reconcile(source, mirror) {
19
+ function reconcile(source, mirror, opts = {}) {
20
+ const keyOf = (sourceRef, companyRef) => opts.composite ? `${sourceRef}\0${companyRef ?? ""}` : sourceRef;
17
21
  const seen = /* @__PURE__ */ new Set();
18
22
  const rows = [];
19
- for (const row of source) if (!seen.has(row.sourceRef)) {
20
- seen.add(row.sourceRef);
21
- rows.push(row);
23
+ for (const row of source) {
24
+ const key = keyOf(row.sourceRef, row.companyRef ?? null);
25
+ if (!seen.has(key)) {
26
+ seen.add(key);
27
+ rows.push(row);
28
+ }
22
29
  }
23
- const byRef = new Map(mirror.map((m) => [m.sourceRef, m]));
24
- const liveRefs = /* @__PURE__ */ new Set();
30
+ const byKey = new Map(mirror.map((m) => [keyOf(m.sourceRef, m.companyRef), m]));
31
+ const liveKeys = /* @__PURE__ */ new Set();
25
32
  const actions = [];
26
33
  for (const row of rows) {
27
- liveRefs.add(row.sourceRef);
28
- const existing = byRef.get(row.sourceRef);
29
34
  const companyRef = row.companyRef ?? null;
35
+ const key = keyOf(row.sourceRef, companyRef);
36
+ liveKeys.add(key);
37
+ const existing = byKey.get(key);
30
38
  if (!existing) actions.push({
31
39
  kind: "create",
32
40
  sourceRef: row.sourceRef,
@@ -48,11 +56,14 @@ function reconcile(source, mirror) {
48
56
  companyRef
49
57
  });
50
58
  }
51
- for (const m of mirror) if (!(liveRefs.has(m.sourceRef) || m.archivedAt)) actions.push({
52
- kind: "archive",
53
- id: m.id,
54
- sourceRef: m.sourceRef
55
- });
59
+ for (const m of mirror) {
60
+ const key = keyOf(m.sourceRef, m.companyRef);
61
+ if (!(liveKeys.has(key) || m.archivedAt)) actions.push({
62
+ kind: "archive",
63
+ id: m.id,
64
+ sourceRef: m.sourceRef
65
+ });
66
+ }
56
67
  return actions;
57
68
  }
58
69
  const CONCEPT_ORDER = {
@@ -75,7 +86,8 @@ async function resolveActions(store, actions) {
75
86
  id: "id" in action ? action.id : "",
76
87
  sourceRef: action.sourceRef,
77
88
  fields: action.fields,
78
- companyId
89
+ companyId,
90
+ companySourceRef: action.companyRef ?? null
79
91
  };
80
92
  });
81
93
  }
@@ -88,11 +100,21 @@ function emptyTally() {
88
100
  };
89
101
  }
90
102
  /**
103
+ * An entity whose company relationship is a `through` (join-table) join fans out
104
+ * into one source row per membership, so its mirror must be keyed compositely.
105
+ */
106
+ function isCompositeEntity(config, entityKey) {
107
+ const entity = config.entities[entityKey];
108
+ if (!entity?.relationships) return false;
109
+ return Object.values(entity.relationships).some((rel) => "through" in rel.via);
110
+ }
111
+ /**
91
112
  * Run a full sync: compile the config's views, then reconcile + persist each,
92
113
  * companies first. Returns per-entity and total action counts.
93
114
  */
94
115
  async function runSync(config, store, options = {}) {
95
- const views = compileEntityViews(config, options).sort(syncOrder);
116
+ const allViews = compileEntityViews(config, options).sort(syncOrder);
117
+ const views = options.sample ? allViews.filter((v) => v.entityKey === options.sample?.entityKey) : allViews;
96
118
  const entities = [];
97
119
  const totals = {
98
120
  created: 0,
@@ -101,15 +123,18 @@ async function runSync(config, store, options = {}) {
101
123
  archived: 0
102
124
  };
103
125
  for (const view of views) {
104
- const [source, mirror] = await Promise.all([store.readView(view), store.listMirror({
126
+ const objectTypeId = config.entities[view.entityKey]?.targetObjectTypeId;
127
+ const [source, mirror] = await Promise.all([store.readView(view, options.sample ? { limit: 1 } : void 0), store.listMirror({
105
128
  concept: view.concept,
106
- role: view.role
129
+ role: view.role,
130
+ objectTypeId
107
131
  })]);
108
- const actions = reconcile(source, mirror);
132
+ const actions = reconcile(source, mirror, { composite: isCompositeEntity(config, view.entityKey) }).filter((a) => !(options.sample && a.kind === "archive"));
109
133
  const persistActions = await resolveActions(store, actions);
110
134
  await store.persist({
111
135
  concept: view.concept,
112
136
  role: view.role,
137
+ objectTypeId,
113
138
  actions: persistActions
114
139
  });
115
140
  const counts = emptyTally();
@@ -134,5 +159,49 @@ async function runSync(config, store, options = {}) {
134
159
  totals
135
160
  };
136
161
  }
162
+ function isEmptyValue(value) {
163
+ return value === null || value === void 0 || value === "";
164
+ }
165
+ /**
166
+ * Sample-scoped data-quality warnings over projected preview rows. Each mapped
167
+ * (or required-but-unmapped) field yields at most one warning, by precedence:
168
+ * a required field empty in ≥1 row → `K/N` form; an optional field empty in
169
+ * ALL rows → all-empty form; zero source rows → a single table-level warning.
170
+ */
171
+ function computeSampleWarnings(rows, requiredFields, sourceTable) {
172
+ if (rows.length === 0) return [{ message: `no rows found in ${sourceTable}` }];
173
+ const required = new Set(requiredFields);
174
+ const fields = new Set(requiredFields);
175
+ for (const row of rows) for (const key of Object.keys(row.fields)) fields.add(key);
176
+ const warnings = [];
177
+ for (const field of [...fields].sort()) {
178
+ const emptyCount = rows.filter((row) => isEmptyValue(row.fields[field])).length;
179
+ if (required.has(field)) {
180
+ if (emptyCount > 0) warnings.push({
181
+ field,
182
+ message: `${field} empty in ${emptyCount}/${rows.length} sampled`
183
+ });
184
+ } else if (emptyCount === rows.length) warnings.push({
185
+ field,
186
+ message: `${field} is empty in all ${rows.length} sampled rows`
187
+ });
188
+ }
189
+ return warnings;
190
+ }
191
+ /**
192
+ * Zero-write preview: read ≤`limit` rows through the compiled view (a pure
193
+ * SELECT whose SQL already projects each row into its mapped fields) and
194
+ * compute sample warnings. Calls ONLY `store.readView` — never a write path —
195
+ * so it can never mutate the mirror. The distinct, write-one-row sibling is
196
+ * `runSync`'s sample mode (T13).
197
+ */
198
+ async function previewSync(store, view, opts) {
199
+ const rows = await store.readView(view, { limit: opts.limit });
200
+ return {
201
+ rows,
202
+ sampledCount: rows.length,
203
+ warnings: computeSampleWarnings(rows, opts.requiredFields, opts.sourceTable)
204
+ };
205
+ }
137
206
  //#endregion
138
- export { reconcile, runSync };
207
+ export { computeSampleWarnings, previewSync, reconcile, runSync };
package/dist/types.cjs ADDED
File without changes
@@ -0,0 +1,159 @@
1
+ //#region src/types.d.ts
2
+ type ContactStatus = "lead" | "active" | "customer" | "churned";
3
+ type DealStage = "lead" | "qualified" | "proposal" | "negotiation" | "won" | "lost";
4
+ type TaskStatus = "todo" | "in_progress" | "done" | "cancelled";
5
+ type TaskPriority = "low" | "medium" | "high";
6
+ type TaskEntityType = "contact" | "company" | "deal";
7
+ type ActivityType = "note" | "email" | "task" | "deal" | "call";
8
+ type CrmRole = "owner" | "admin" | "member" | "developer" | "support_agent";
9
+ interface Contact {
10
+ companyId: string | null;
11
+ createdAt: Date;
12
+ email: string;
13
+ id: string;
14
+ lastActivityAt: Date | null;
15
+ name: string;
16
+ orgId: string;
17
+ status: ContactStatus;
18
+ title: string | null;
19
+ }
20
+ interface Company {
21
+ createdAt: Date;
22
+ domain: string | null;
23
+ id: string;
24
+ industry: string | null;
25
+ name: string;
26
+ orgId: string;
27
+ size: string | null;
28
+ }
29
+ interface Deal {
30
+ closeDate: Date | null;
31
+ contactId: string | null;
32
+ createdAt: Date;
33
+ id: string;
34
+ name: string;
35
+ orgId: string;
36
+ owner: string | null;
37
+ position: number | null;
38
+ stage: DealStage;
39
+ value: number;
40
+ }
41
+ interface Task {
42
+ archivedAt: Date | null;
43
+ assignee: string | null;
44
+ completedAt: Date | null;
45
+ contactId: string | null;
46
+ createdAt: Date;
47
+ createdBy: string | null;
48
+ description: string | null;
49
+ dueAt: Date | null;
50
+ entityId: string | null;
51
+ entityType: TaskEntityType | null;
52
+ id: string;
53
+ orgId: string;
54
+ priority: TaskPriority;
55
+ status: TaskStatus;
56
+ title: string;
57
+ }
58
+ interface Note {
59
+ archivedAt: Date | null;
60
+ author: string | null;
61
+ body: string;
62
+ contactId: string | null;
63
+ createdAt: Date;
64
+ createdBy: string | null;
65
+ entityId: string | null;
66
+ entityType: TaskEntityType | null;
67
+ id: string;
68
+ isTemplate: boolean;
69
+ orgId: string;
70
+ title: string;
71
+ updatedAt: Date;
72
+ }
73
+ interface Activity {
74
+ actor: string | null;
75
+ contactId: string | null;
76
+ createdAt: Date;
77
+ id: string;
78
+ orgId: string;
79
+ summary: string;
80
+ type: ActivityType;
81
+ }
82
+ interface CreateContactInput {
83
+ companyId?: string;
84
+ email: string;
85
+ name: string;
86
+ status?: ContactStatus;
87
+ title?: string;
88
+ }
89
+ interface UpdateContactInput {
90
+ companyId?: string | null;
91
+ email?: string;
92
+ name?: string;
93
+ status?: ContactStatus;
94
+ title?: string | null;
95
+ }
96
+ interface CreateCompanyInput {
97
+ domain?: string;
98
+ industry?: string;
99
+ name: string;
100
+ size?: string;
101
+ }
102
+ interface CreateDealInput {
103
+ contactId?: string;
104
+ name: string;
105
+ owner?: string;
106
+ stage?: DealStage;
107
+ value?: number;
108
+ }
109
+ interface UpdateDealInput {
110
+ closeDate?: Date | null;
111
+ contactId?: string | null;
112
+ name?: string;
113
+ owner?: string | null;
114
+ stage?: DealStage;
115
+ value?: number;
116
+ }
117
+ interface CreateTaskInput {
118
+ assignee?: string;
119
+ createdBy?: string;
120
+ description?: string;
121
+ dueAt?: Date;
122
+ entityId?: string;
123
+ entityType?: TaskEntityType;
124
+ priority?: TaskPriority;
125
+ title: string;
126
+ }
127
+ interface UpdateTaskInput {
128
+ assignee?: string | null;
129
+ description?: string | null;
130
+ dueAt?: Date | null;
131
+ entityId?: string | null;
132
+ entityType?: TaskEntityType | null;
133
+ priority?: TaskPriority;
134
+ title?: string;
135
+ }
136
+ interface CreateActivityInput {
137
+ actor?: string;
138
+ contactId?: string;
139
+ summary: string;
140
+ type: ActivityType;
141
+ }
142
+ type RecordSource = "all" | "synced";
143
+ interface ContactFilters {
144
+ companyId?: string;
145
+ search?: string;
146
+ source?: RecordSource;
147
+ status?: ContactStatus;
148
+ }
149
+ interface TaskFilters {
150
+ assignee?: string;
151
+ entityId?: string;
152
+ entityType?: TaskEntityType;
153
+ includeArchived?: boolean;
154
+ includeCompleted?: boolean;
155
+ priority?: TaskPriority;
156
+ status?: TaskStatus;
157
+ }
158
+ //#endregion
159
+ export { Activity, ActivityType, Company, Contact, ContactFilters, ContactStatus, CreateActivityInput, CreateCompanyInput, CreateContactInput, CreateDealInput, CreateTaskInput, CrmRole, Deal, DealStage, Note, RecordSource, Task, TaskEntityType, TaskFilters, TaskPriority, TaskStatus, UpdateContactInput, UpdateDealInput, UpdateTaskInput };
package/dist/types.d.mts CHANGED
@@ -34,6 +34,7 @@ interface Deal {
34
34
  name: string;
35
35
  orgId: string;
36
36
  owner: string | null;
37
+ position: number | null;
37
38
  stage: DealStage;
38
39
  value: number;
39
40
  }
@@ -105,6 +106,14 @@ interface CreateDealInput {
105
106
  stage?: DealStage;
106
107
  value?: number;
107
108
  }
109
+ interface UpdateDealInput {
110
+ closeDate?: Date | null;
111
+ contactId?: string | null;
112
+ name?: string;
113
+ owner?: string | null;
114
+ stage?: DealStage;
115
+ value?: number;
116
+ }
108
117
  interface CreateTaskInput {
109
118
  assignee?: string;
110
119
  createdBy?: string;
@@ -130,9 +139,11 @@ interface CreateActivityInput {
130
139
  summary: string;
131
140
  type: ActivityType;
132
141
  }
142
+ type RecordSource = "all" | "synced";
133
143
  interface ContactFilters {
134
144
  companyId?: string;
135
145
  search?: string;
146
+ source?: RecordSource;
136
147
  status?: ContactStatus;
137
148
  }
138
149
  interface TaskFilters {
@@ -145,4 +156,4 @@ interface TaskFilters {
145
156
  status?: TaskStatus;
146
157
  }
147
158
  //#endregion
148
- export { Activity, ActivityType, Company, Contact, ContactFilters, ContactStatus, CreateActivityInput, CreateCompanyInput, CreateContactInput, CreateDealInput, CreateTaskInput, CrmRole, Deal, DealStage, Note, Task, TaskEntityType, TaskFilters, TaskPriority, TaskStatus, UpdateContactInput, UpdateTaskInput };
159
+ export { Activity, ActivityType, Company, Contact, ContactFilters, ContactStatus, CreateActivityInput, CreateCompanyInput, CreateContactInput, CreateDealInput, CreateTaskInput, CrmRole, Deal, DealStage, Note, RecordSource, Task, TaskEntityType, TaskFilters, TaskPriority, TaskStatus, UpdateContactInput, UpdateDealInput, UpdateTaskInput };