Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions packages/node-type-registry/src/data/event-referral.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import { conditionDefs, conditionProperties } from '../conditions';
import type { NodeTypeDefinition } from '../types';

export const EventReferral: NodeTypeDefinition = {
name: 'EventReferral',
slug: 'event_referral',
category: 'event',
display_name: 'Event Referral',
description:
'Creates triggers that record events for the referrer (inviter) when their ' +
'invitees perform actions on a watched table. Resolves the referrer automatically ' +
'via the invites module\'s claimed_invites table using the membership_type context. ' +
'Supports the same compound condition system as EventTracker. Use with achievements ' +
'to unlock levels and grant credits based on invitee activity.',
parameter_schema: {
type: 'object',
$defs: conditionDefs,
properties: {
event_name: {
type: 'string',
description: 'Event type name to record for the referrer (e.g., "invitee_uploaded_avatar", "invitee_completed_onboarding")'
},
events: {
type: 'array',
items: {
type: 'string',
enum: [
'INSERT',
'UPDATE',
'DELETE'
]
},
description: 'DML events that trigger recording',
default: ['INSERT']
},
actor_field: {
type: 'string',
format: 'column-ref',
description: 'Column containing the invitee (actor) ID on the source table — used to look up the referrer via claimed_invites.receiver_id',
default: 'owner_id'
},
entity_field: {
type: 'string',
format: 'column-ref',
description: 'Column containing the entity ID (org/group) for entity-scoped referral events. Omit for user-only events.'
},
auto_register_type: {
type: 'boolean',
description: 'Automatically register the event_name in event_types during provisioning',
default: true
},
...conditionProperties
},
required: [
'event_name'
]
},
tags: [
'events',
'referral',
'invites',
'analytics',
'tracking'
]
};
1 change: 1 addition & 0 deletions packages/node-type-registry/src/data/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export { ProcessChunks } from './data-chunks';
export { DataCompositeField } from './data-composite-field';
export { DataDirectOwner } from './data-direct-owner';
export { DataEntityMembership } from './data-entity-membership';
export { EventReferral } from './event-referral';
export { EventTracker } from './event-tracker';
export { ProcessFileEmbedding } from './data-file-embedding';
export { LimitEnforceFeature } from './data-feature-flag';
Expand Down
Loading