@engine9/schemas 1.10.1 → 1.11.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.
package/README.md CHANGED
@@ -7,7 +7,7 @@ this code as-is.
7
7
 
8
8
  ## Documentation
9
9
 
10
- Each schema plugin is documented in its own `README.md`. That file is the human-readable contract: what the schema plugin is for, the data model, inbound/outbound behavior, search, **predefined segments**, and UI. Keep implementation details in code comments; keep audience and membership rules in the README. Dashboards live on `@engine9/plugins/reports/<area>`, not in this package.
10
+ Each schema plugin is documented in its own `README.md`. That file is the human-readable contract: what the schema plugin is for, the data model, inbound/outbound behavior, segment definition clauses, **predefined segments**, and UI. Keep implementation details in code comments; keep audience and membership rules in the README. Dashboards live on `@engine9/plugins/reports/<area>`, not in this package.
11
11
 
12
12
  Schema plugins with predefined segments:
13
13
 
@@ -22,9 +22,9 @@ See [`skills/create-engine9-plugin/SKILL.md`](../skills/create-engine9-plugin/SK
22
22
 
23
23
  - **Plugin uniqueness:** `SchemaWorker.install` reuses an existing `plugin` row when the path is unique: `metadata.unique` if set, otherwise `@engine9/schemas/*` (except `person_custom`, which is `unique: false`). Native plugins that set `unique: true` behave the same. Third-party plugins and `person_custom` may have more than one instance per path; pass `id` to update an existing non-unique row.
24
24
 
25
- - **Public module surface:** Export only the standard building blocks documented in [`skills/create-engine9-plugin/SKILL.md`](../skills/create-engine9-plugin/SKILL.md): for example `metadata`, optional `schema`, `transforms`, `search`, `segments`, `metrics`, and the default object that aggregates them. Do **not** export `reports` from schema plugins — dashboards belong on `@engine9/plugins/reports/<area>`. Do **not** export ad hoc hooks (such as custom install helpers or segment–plugin wiring) from schema plugins; the server is responsible for any special install-time behavior tied to a specific schema plugin path.
25
+ - **Public module surface:** Export only the standard building blocks documented in [`skills/create-engine9-plugin/SKILL.md`](../skills/create-engine9-plugin/SKILL.md): for example `metadata`, optional `schema`, `transforms`, `segmentDefinitionClauses`, `segments`, `metrics`, and the default object that aggregates them. Do **not** export `reports` from schema plugins — dashboards belong on `@engine9/plugins/reports/<area>`. Do **not** export ad hoc hooks (such as custom install helpers or segment–plugin wiring) from schema plugins; the server is responsible for any special install-time behavior tied to a specific schema plugin path.
26
26
 
27
- - **Segments, universes, and `plugin_id`:** Saved segments use `segment.plugin_id` = the schema plugin (or plugin) that **owns the definition**. A definition’s **`universe`** describes the span of source data searched across; input EQL entries select timeline stores, while person/table entries can restrict eligible people. Explicit `pluginId` values inside `search` options may narrow that span further, so a segment can evaluate data tied to other deployed plugins without changing its owning `plugin_id`. Export bundles use the same universe vocabulary for table and input-file artifacts.
27
+ - **Segments, universes, and `plugin_id`:** Saved segments use `segment.plugin_id` = the schema plugin (or plugin) that **owns the definition**. A definition’s **`universe`** describes the span of source data searched across; input EQL entries select timeline stores, while person/table entries can restrict eligible people. Explicit `pluginId` values inside a clause's options may narrow that span further, so a segment can evaluate data tied to other deployed plugins without changing its owning `plugin_id`. Export bundles use the same universe vocabulary for table and input-file artifacts.
28
28
 
29
29
  ## License
30
30
 
@@ -1,10 +1,10 @@
1
1
  # Email Channel Schema Plugin
2
2
 
3
- The `@engine9/schemas/channels/email` plugin defines email-channel search and engagement segments. It does not create its own tables. Segment builds read `global_message`, `input`, and `timeline` rows produced by email message plugins.
3
+ The `@engine9/schemas/channels/email` plugin defines the email-channel segment definition clause and engagement segments. It does not create its own tables. Segment builds read `global_message`, `input`, and `timeline` rows produced by email message plugins.
4
4
 
5
5
  It depends on `@engine9/schemas/person` because membership is always a set of people.
6
6
 
7
- ## Search
7
+ ## Segment definition clauses
8
8
 
9
9
  `emailEngagement` finds people who opened or clicked email in a rolling window.
10
10
 
@@ -14,13 +14,13 @@ It depends on `@engine9/schemas/person` because membership is always a set of pe
14
14
  | `timelineEntryType` | `EMAIL_OPEN` or `EMAIL_CLICK` |
15
15
  | `pluginId` | Optional. When set, only that plugin's inputs are included. When empty, scope comes from the segment universe instead |
16
16
 
17
- The search looks at `timeline` rows whose `entry_type_id` matches the engagement type and whose `ts` is in the window. It always joins `timeline.input_id = input.id`, so only timeline entries for inputs present in the build are counted.
17
+ The clause looks at `timeline` rows whose `entry_type_id` matches the engagement type and whose `ts` is in the window. It always joins `timeline.input_id = input.id`, so only timeline entries for inputs present in the build are counted.
18
18
 
19
19
  ## Segments
20
20
 
21
21
  Predefined audiences shipped with this schema plugin. On install, each key becomes a `segment` row whose definition path is `@engine9/schemas/channels/email:segments:<key>`.
22
22
 
23
- Every segment here uses the same **universe** and the `emailEngagement` search. The universe and the search do different jobs, and both are required:
23
+ Every segment here uses the same **universe** and the `emailEngagement` clause. The universe and the clause do different jobs, and both are required:
24
24
 
25
25
  - **Universe** chooses *which email sends* can contribute entries: messages on the email channel published in the last **90 days** (`global_message.channel = 'email'` and `publish_date` within 90 days). Those message ids become the `input` rows for the build.
26
26
  - **Search** chooses *which people* from those sends belong in the audience: a recent open or click on the timeline, inside the segment's rolling window.
@@ -1,4 +1,4 @@
1
- import search from './search.js';
1
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
2
2
  import segments, { personSegmentTableName, universeEmailPublished90d } from './segments.js';
3
3
 
4
4
  const metadata = {
@@ -9,13 +9,13 @@ const metadata = {
9
9
  };
10
10
 
11
11
  export { metadata };
12
- export { search };
12
+ export { segmentDefinitionClauses };
13
13
  export { segments };
14
14
  export { personSegmentTableName };
15
15
  export { universeEmailPublished90d };
16
16
  export default {
17
17
  metadata,
18
- search,
18
+ segmentDefinitionClauses,
19
19
  segments,
20
20
  personSegmentTableName,
21
21
  universeEmailPublished90d
@@ -3,7 +3,7 @@ import { TIMELINE_ENTRY_TYPES } from '@engine9/input-tools';
3
3
  /**
4
4
  * Build EQL for email engagement (opens / clicks) within a rolling window.
5
5
  *
6
- * The search always joins `timeline` → `input` on `timeline.input_id = input.id`.
6
+ * The clause always joins `timeline` → `input` on `timeline.input_id = input.id`.
7
7
  * During a segment build the DuckDB `input` table is populated exclusively with
8
8
  * the input ids discovered by the segment's `universe` entry (e.g.
9
9
  * `universeEmailPublished90d`), so the join scopes results to the universe even
@@ -81,6 +81,7 @@ export const emailEngagement = {
81
81
  }
82
82
  };
83
83
 
84
+ export const segmentDefinitionClauses = { emailEngagement };
84
85
  export default {
85
- emailEngagement
86
+ segmentDefinitionClauses
86
87
  };
@@ -1,4 +1,4 @@
1
- const SEGMENT_SEARCH_PATH = '@engine9/schemas/channels/email:search:emailEngagement';
1
+ const EMAIL_ENGAGEMENT_CLAUSE_PATH = '@engine9/schemas/channels/email:segment_definition_clause:emailEngagement';
2
2
 
3
3
  /**
4
4
  * EQL over the message table: rows published in the last 90 days on the email channel.
@@ -6,12 +6,12 @@ const SEGMENT_SEARCH_PATH = '@engine9/schemas/channels/email:search:emailEngagem
6
6
  * scanned for timeline parquet.
7
7
  *
8
8
  * During a segment build the input ids returned here are copied into the DuckDB `input`
9
- * table. The search EQL (see `emailEngagement` in `search.js`) always joins
9
+ * table. The clause EQL (see `emailEngagement` in `segmentDefinitionClauses.js`) always joins
10
10
  * `timeline.input_id = input.id`, so only timeline rows whose input is in **this**
11
11
  * universe are considered — even when `pluginId` is empty. This means:
12
12
  *
13
13
  * - The **universe** controls *which* message/input stores supply timeline data.
14
- * - The **search** applies time-window and entry-type filters *within* that scope.
14
+ * - The **clause** applies time-window and entry-type filters *within* that scope.
15
15
  *
16
16
  * Both layers are required for correct segment membership counts.
17
17
  */
@@ -35,7 +35,7 @@ export function personSegmentTableName(tablePrefix, segmentName) {
35
35
  /**
36
36
  * Build a segment definition for email engagement (opens or clicks).
37
37
  *
38
- * `pluginId` is left empty intentionally: the search handler in `search.js`
38
+ * `pluginId` is left empty intentionally: the `emailEngagement` clause
39
39
  * always joins `timeline` → `input`, and the segment `universe` determines
40
40
  * which input rows are present in DuckDB. This scopes the time-window query
41
41
  * to the correct set of message inputs without hard-coding a plugin id.
@@ -44,10 +44,10 @@ function emailEngagementSegment(name, windowDays, timelineEntryType) {
44
44
  return {
45
45
  name,
46
46
  universe: [universeEmailPublished90d],
47
- search: {
47
+ definition: {
48
48
  and: [
49
49
  {
50
- path: SEGMENT_SEARCH_PATH,
50
+ path: EMAIL_ENGAGEMENT_CLAUSE_PATH,
51
51
  options: {
52
52
  pluginId: '',
53
53
  windowDays,
@@ -61,7 +61,7 @@ function emailEngagementSegment(name, windowDays, timelineEntryType) {
61
61
 
62
62
  /**
63
63
  * Rolling-window engagement segments. `pluginId` is empty so scope follows the
64
- * segment `universe` (the `input` table join in the search EQL restricts to
64
+ * segment `universe` (the `input` table join in the clause EQL restricts to
65
65
  * universe-provided message input ids).
66
66
  */
67
67
  export const email_openers_30d = emailEngagementSegment('30-day email openers', 30, 'EMAIL_OPEN');
package/event/README.md CHANGED
@@ -56,11 +56,11 @@ None in this package. Native event / calendar plugins should upsert `event` and
56
56
 
57
57
  None.
58
58
 
59
- ## Search
59
+ ## Segment definition clauses
60
60
 
61
61
  | Key | Path | Purpose |
62
62
  | --- | --- | --- |
63
- | `responses` | `@engine9/schemas/event:search:responses` | Filter people by `person_event.response` and optional `eventId`. |
63
+ | `responses` | `@engine9/schemas/event:segment_definition_clause:responses` | Filter people by `person_event.response` and optional `eventId`. |
64
64
 
65
65
  ## Segments
66
66
 
package/event/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import schema from './schema.js';
2
- import search from './search.js';
2
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
3
3
 
4
4
  const metadata = {
5
5
  name: '@engine9/schemas/event',
@@ -9,9 +9,9 @@ const metadata = {
9
9
  schemas: ['schema.js']
10
10
  };
11
11
 
12
- export { metadata, schema, search };
12
+ export { metadata, schema, segmentDefinitionClauses };
13
13
  export default {
14
14
  metadata,
15
15
  schema,
16
- search
16
+ segmentDefinitionClauses
17
17
  };
@@ -46,6 +46,7 @@ export const responses = {
46
46
  }
47
47
  };
48
48
 
49
+ export const segmentDefinitionClauses = { responses };
49
50
  export default {
50
- responses
51
+ segmentDefinitionClauses
51
52
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@engine9/schemas",
3
- "version": "1.10.1",
3
+ "version": "1.11.0",
4
4
  "type": "module",
5
5
  "description": "Engine9 standard schemas: shared tables, transforms, searches, and segments",
6
6
  "main": "index.js",
package/person/index.js CHANGED
@@ -21,8 +21,7 @@ const transforms = {
21
21
  // Saved export definitions still call @engine9/schemas/person:transforms:appendName.
22
22
  appendName
23
23
  };
24
- export const search = {
25
- person: {
24
+ const person = {
26
25
  title: 'Primary Info',
27
26
  form: {
28
27
  title: 'Primary Info',
@@ -71,8 +70,8 @@ export const search = {
71
70
  }
72
71
  };
73
72
  }
74
- }
75
- };
73
+ };
74
+ export const segmentDefinitionClauses = { person };
76
75
  export { metadata };
77
76
  export { schema };
78
77
  export { transforms };
@@ -82,5 +81,5 @@ export default {
82
81
  schema,
83
82
  transforms,
84
83
  metrics,
85
- search
84
+ segmentDefinitionClauses
86
85
  };
@@ -51,9 +51,9 @@ The plugin provides outbound transforms for appending email data to batches:
51
51
  - `appendEmail` looks up `person_email` rows by `person_id` and appends `email` to each batch row. It can be filtered by `subscriptionStatus`, and it preserves any existing `email` value already on the row.
52
52
  - `appendEmailHash` appends `email_hash_v1` by hashing the row's trimmed, lowercased `email` when the hash is not already present.
53
53
 
54
- ## Search
54
+ ## Segment definition clauses
55
55
 
56
- The `emails` search lets users find people who have an email address, optionally filtered by:
56
+ The `emails` clause selects people who have an email address, optionally filtered by:
57
57
 
58
58
  - `subscriptionStatus`, using the same values as `subscription_status`
59
59
  - `emailMatch`, matched against the `email` column with `LIKE`
@@ -70,7 +70,7 @@ Predefined audiences shipped with this schema plugin. On install, each key becom
70
70
  | **Definition path** | `@engine9/schemas/person_email:segments:subscribers` |
71
71
  | **Who is included** | People with at least one email whose `subscription_status` is `Subscribed` |
72
72
  | **Who is excluded** | People whose emails are only `Not Subscribed`, `Unsubscribed`, `Bouncing`, or `Spam` |
73
- | **How it is built** | The `emails` search with `subscriptionStatus: Subscribed` |
73
+ | **How it is built** | The `emails` clause with `subscriptionStatus: Subscribed` |
74
74
  | **Universe** | None — membership is current `person_email` rows, not a time window or message input set |
75
75
 
76
76
  A person with mixed statuses is included if any of their addresses is `Subscribed`.
@@ -1,7 +1,7 @@
1
1
  import schema from './schema.js';
2
2
  import extractEmailHashes from './transforms/inbound/extract_identifiers.js';
3
3
  import upsertPersonEmail from './transforms/inbound/upsert_tables.js';
4
- import search from './search.js';
4
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
5
5
  import appendEmail from './transforms/outbound/appendEmail.js';
6
6
  import appendEmailHash from './transforms/outbound/appendEmailHash.js';
7
7
  import segments from './segments.js';
@@ -24,12 +24,12 @@ export const transforms = {
24
24
  };
25
25
  export { metadata };
26
26
  export { schema };
27
- export { search };
27
+ export { segmentDefinitionClauses };
28
28
  export { segments };
29
29
  export default {
30
30
  metadata,
31
31
  schema,
32
- search,
32
+ segmentDefinitionClauses,
33
33
  segments,
34
34
  transforms
35
35
  };
@@ -56,6 +56,7 @@ export const emails = {
56
56
  };
57
57
  }
58
58
  };
59
+ export const segmentDefinitionClauses = { emails };
59
60
  export default {
60
- emails
61
+ segmentDefinitionClauses
61
62
  };
@@ -1,9 +1,9 @@
1
1
  export const subscribers = {
2
2
  name: 'Email Subscribers',
3
- search: {
3
+ definition: {
4
4
  and: [
5
5
  {
6
- path: '@engine9/schemas/person_email:search:emails',
6
+ path: '@engine9/schemas/person_email:segment_definition_clause:emails',
7
7
  options: {
8
8
  subscriptionStatus: 'Subscribed'
9
9
  }
@@ -65,6 +65,6 @@ The `upsertPersonHash` transform writes only hash columns to `person_hash_email`
65
65
 
66
66
  `PersonWorker.search` `emails` / `phones` match `person_email` / `person_phone` when those tables exist, and also hash the query (or accept SHA-256 / MD5 hex) against `person_hash_email` / `person_hash_phone`. If the caller passed emails or phones and neither table exists, the clause matches nobody (`1=0`). Related summaries include `email_hashes` / `phone_hashes` when those tables are present.
67
67
 
68
- The plugin also exports `search.emailHashes` / `search.phoneHashes` for the plugin search tree (`@engine9/schemas/person_hash:search:emailHashes`).
68
+ The plugin exports `segmentDefinitionClauses.emailHashes` and `segmentDefinitionClauses.phoneHashes` for segment definitions (`@engine9/schemas/person_hash:segment_definition_clause:emailHashes`).
69
69
 
70
70
  Default warehouse export includes the hash tables (export skips them when they do not exist). When utilities/limited-pii `exclude_pii` is set and `tables` is not explicit, `person_name` / `person_email` / `person_phone` / `person_address` are omitted from that default list.
@@ -1,5 +1,5 @@
1
1
  import schema from './schema.js';
2
- import search from './search.js';
2
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
3
3
  import extractContactHashes from './transforms/inbound/extract_identifiers.js';
4
4
  import upsertPersonHash from './transforms/inbound/upsert_tables.js';
5
5
  import appendEmailHash from './transforms/outbound/appendEmailHash.js';
@@ -28,10 +28,10 @@ export const transforms = {
28
28
 
29
29
  export { metadata };
30
30
  export { schema };
31
- export { search };
31
+ export { segmentDefinitionClauses };
32
32
  export default {
33
33
  metadata,
34
34
  schema,
35
35
  transforms,
36
- search
36
+ segmentDefinitionClauses
37
37
  };
@@ -80,7 +80,7 @@ export const phoneHashes = {
80
80
  }
81
81
  };
82
82
 
83
+ export const segmentDefinitionClauses = { emailHashes, phoneHashes };
83
84
  export default {
84
- emailHashes,
85
- phoneHashes
85
+ segmentDefinitionClauses
86
86
  };
@@ -54,9 +54,9 @@ Primary key: `person_id`.
54
54
 
55
55
  `@engine9/schemas/person:transforms:appendName` is the same transform, kept so saved export definitions keep working.
56
56
 
57
- ## Search
57
+ ## Segment definition clauses
58
58
 
59
- `names` matches people by `given_name` and/or `family_name` with `LIKE`. Searching with neither finds everyone who has a name row.
59
+ `names` matches people by `given_name` and/or `family_name` with `LIKE`. With neither, it selects everyone who has a name row.
60
60
 
61
61
  ## Upgrading accounts created before this plugin
62
62
 
@@ -66,4 +66,4 @@ Before this plugin, the names were `person.given_name` and `person.family_name`.
66
66
  - `npx e9core upgrade --db <connection>` for a SQLite or MySQL database
67
67
  - `npx e9core upgrade --url https://<site>` for a Cloudflare site (it posts to `/api/admin/upgrade` with `E9_ADMIN_API_KEY`)
68
68
 
69
- The upgrade installs this plugin and copies every non-blank name into `person_name`. It then refreshes the `person` plugin's inbound snapshot and drops both columns from `person`. On a PII-free account it does not install this plugin. It drops the columns only when they are empty, or when you pass `discard_names`.
69
+ The upgrade installs this plugin and copies every non-blank name into `person_name`. It then refreshes the `person` plugin's inbound snapshot, so later loads write `person_name` only. The columns stay on `person` with the names as of the upgrade. Dropping them is a separate, opt-in step (`drop_name_columns`), for when nothing reads them. On a PII-free account the upgrade does not install this plugin, and the opt-in drop removes the columns only when they are empty, or when you also pass `discard_names`.
@@ -1,7 +1,7 @@
1
1
  import schema from './schema.js';
2
2
  import upsertPersonName from './transforms/inbound/upsert_tables.js';
3
3
  import appendName from './transforms/outbound/appendName.js';
4
- import search from './search.js';
4
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
5
5
  const metadata = {
6
6
  name: '@engine9/schemas/person_name',
7
7
  unique: true,
@@ -19,10 +19,10 @@ export const transforms = {
19
19
  };
20
20
  export { metadata };
21
21
  export { schema };
22
- export { search };
22
+ export { segmentDefinitionClauses };
23
23
  export default {
24
24
  metadata,
25
25
  schema,
26
- search,
26
+ segmentDefinitionClauses,
27
27
  transforms
28
28
  };
@@ -42,6 +42,7 @@ export const names = {
42
42
  };
43
43
  }
44
44
  };
45
+ export const segmentDefinitionClauses = { names };
45
46
  export default {
46
- names
47
+ segmentDefinitionClauses
47
48
  };
@@ -49,9 +49,9 @@ The inbound `upsert` transform writes rows to `person_phone`.
49
49
 
50
50
  `appendPhoneHash` hashes the row's normalized `phone` into `phone_hash_v1` when the hash is not already present.
51
51
 
52
- ## Search
52
+ ## Segment definition clauses
53
53
 
54
- The `phones` search lets users find people who have a phone number, optionally filtered by:
54
+ The `phones` clause selects people who have a phone number, optionally filtered by:
55
55
 
56
56
  - `smsStatus`, using the same values as `sms_status`
57
57
  - `callStatus`, using the same values as `call_status`
@@ -1,5 +1,5 @@
1
1
  import schema from './schema.js';
2
- import search from './search.js';
2
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
3
3
  import segments from './segments.js';
4
4
  import extractPhoneHashes from './transforms/inbound/extract_identifiers.js';
5
5
  import upsertPersonPhone from './transforms/inbound/upsert_tables.js';
@@ -22,12 +22,12 @@ export const transforms = {
22
22
  };
23
23
  export { metadata };
24
24
  export { schema };
25
- export { search };
25
+ export { segmentDefinitionClauses };
26
26
  export { segments };
27
27
  export default {
28
28
  metadata,
29
29
  schema,
30
30
  transforms,
31
- search,
31
+ segmentDefinitionClauses,
32
32
  segments
33
33
  };
@@ -74,6 +74,7 @@ export const phones = {
74
74
  };
75
75
  }
76
76
  };
77
+ export const segmentDefinitionClauses = { phones };
77
78
  export default {
78
- phones
79
+ segmentDefinitionClauses
79
80
  };
@@ -1,6 +1,6 @@
1
1
  export const textable = {
2
2
  name: 'Textable People',
3
- search: {
3
+ definition: {
4
4
  and: [
5
5
  {
6
6
  table: 'person_phone',
@@ -14,8 +14,7 @@ const metadata = {
14
14
  upsert: ['upsertPersonRemote']
15
15
  }
16
16
  };
17
- export const search = {
18
- all: {
17
+ const all = {
19
18
  title: 'Remote people',
20
19
  name: 'All remote people',
21
20
  form: {
@@ -39,8 +38,8 @@ export const search = {
39
38
  }
40
39
  ]
41
40
  })
42
- }
43
- };
41
+ };
42
+ export const segmentDefinitionClauses = { all };
44
43
  export const transforms = {
45
44
  extractRemotePersonIds,
46
45
  upsertPersonRemote,
@@ -53,6 +52,6 @@ export default {
53
52
  metadata,
54
53
  schema,
55
54
  metrics,
56
- search,
55
+ segmentDefinitionClauses,
57
56
  transforms
58
57
  };
package/segment/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import schema from './schema.js';
2
- import search from './search.js';
2
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
3
3
  import upsert from './transforms/inbound/upsert.js';
4
4
  const metadata = {
5
5
  name: '@engine9/schemas/segment',
@@ -12,10 +12,10 @@ export const transforms = {
12
12
  };
13
13
  export { metadata };
14
14
  export { schema };
15
- export { search };
15
+ export { segmentDefinitionClauses };
16
16
  export default {
17
17
  metadata,
18
18
  schema,
19
- search,
19
+ segmentDefinitionClauses,
20
20
  transforms
21
21
  };
package/segment/schema.js CHANGED
@@ -23,15 +23,15 @@ export const tables = [
23
23
  category: 'string', // A arbitrary type, user facing, not to be used for logic
24
24
  definition_path: 'string', // a definition file path, will be used for configuring
25
25
  stars: 'int', //number of stars, good for UI organizing
26
- search: 'json',
26
+ definition: 'json',
27
27
  build_type: {
28
28
  type: 'enum',
29
29
  nullable: false,
30
30
  default_value: 'list',
31
31
  values: [
32
32
  'list', //static list of people
33
- 'search', // built by the defined search
34
- 'scheduled_search', // built on a schedule by the search
33
+ 'definition', // built by the segment definition
34
+ 'scheduled_definition', // built on a schedule by the segment definition
35
35
  'remote_count', // no person records, just counts, pulled from remote site
36
36
  'remote', // pulled from remote plugin site
37
37
  'manual' // created outside normal processing
@@ -59,6 +59,7 @@ export const segment = {
59
59
  return { text, eql };
60
60
  }
61
61
  };
62
+ export const segmentDefinitionClauses = { segment };
62
63
  export default {
63
- segment
64
+ segmentDefinitionClauses
64
65
  };
@@ -1,6 +1,6 @@
1
1
  # Transaction Core Schema Plugin
2
2
 
3
- The `@engine9/schemas/transaction/core` plugin stores payment and gift transactions for people and provides the common transaction search, metrics, and segment used by imports, reports, and exports.
3
+ The `@engine9/schemas/transaction/core` plugin stores payment and gift transactions for people and provides the common transaction segment definition clauses, metrics, and segment used by imports, reports, and exports.
4
4
 
5
5
  It depends on `@engine9/schemas/person` because every transaction belongs to a person through `person_id`.
6
6
 
@@ -53,10 +53,10 @@ The inbound `upsert` transform writes rows to `transaction`.
53
53
 
54
54
  `appendTransactionSummary` looks up a person's transactions and attaches summary fields such as count, revenue, first/last/smallest/largest gifts, and recurring totals.
55
55
 
56
- ## Search
56
+ ## Segment definition clauses
57
57
 
58
- - `all` finds people who have any transaction, optionally filtered by `plugin_id` and a `start` / `end` window on `ts` (ISO datetimes or relative expressions such as `-30d`).
59
- - `minimum` finds people who have a transaction of at least a given `amount`.
58
+ - `all` selects people who have any transaction, optionally filtered by `plugin_id` and a `start` / `end` window on `ts` (ISO datetimes or relative expressions such as `-30d`).
59
+ - `minimum` selects people who have a transaction of at least a given `amount`.
60
60
 
61
61
  ## Metrics
62
62
 
@@ -74,7 +74,7 @@ Predefined audiences shipped with this schema plugin. On install, each key becom
74
74
  | **Definition path** | `@engine9/schemas/transaction/core:segments:customers` |
75
75
  | **Who is included** | People who have at least one row in `transaction` |
76
76
  | **Who is excluded** | People with no transactions |
77
- | **How it is built** | A `transaction` table search that selects `person_id` with no extra filters |
77
+ | **How it is built** | The `all` clause, which selects `person_id` from `transaction` with no extra filters |
78
78
  | **Universe** | None — any transaction from any plugin, date, or amount counts |
79
79
 
80
80
  Refunds, recurring gifts, and $0 rows are not filtered out. If a person has ever appeared on a transaction row, they are a customer.
@@ -1,5 +1,5 @@
1
1
  import schema from './schema.js';
2
- import search from './search.js';
2
+ import { segmentDefinitionClauses } from './segmentDefinitionClauses.js';
3
3
  import metrics from './metrics.js';
4
4
  import segments from './segments.js';
5
5
  import upsert from './transforms/inbound/upsert_tables.js';
@@ -19,13 +19,13 @@ export const transforms = {
19
19
  export { metadata };
20
20
  export { schema };
21
21
  export { metrics };
22
- export { search };
22
+ export { segmentDefinitionClauses };
23
23
  export { segments };
24
24
  export default {
25
25
  metadata,
26
26
  schema,
27
27
  metrics,
28
28
  transforms,
29
- search,
29
+ segmentDefinitionClauses,
30
30
  segments
31
31
  };
@@ -81,7 +81,7 @@ export const minimum = {
81
81
  conditions: [`amount>=${parseFloat(options.amount)}`]
82
82
  })
83
83
  };
84
+ export const segmentDefinitionClauses = { all, minimum };
84
85
  export default {
85
- all,
86
- minimum
86
+ segmentDefinitionClauses
87
87
  };
@@ -1,6 +1,6 @@
1
1
  export const customers = {
2
2
  name: 'Customers',
3
- search: {
3
+ definition: {
4
4
  and: [
5
5
  {
6
6
  table: 'transaction',