@flowrunner/cli 0.1.14 → 0.1.16

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 (48) hide show
  1. package/ai-docs/instructions/service-code-format/02-zod-types.md +59 -15
  2. package/ai-docs/instructions/service-code-format/04-http-requests.md +9 -0
  3. package/ai-docs/instructions/service-code-format/06-oauth2.md +59 -9
  4. package/ai-docs/instructions/service-code-format/07-actions.md +1 -1
  5. package/ai-docs/instructions/service-code-format/08-polling-triggers.md +13 -0
  6. package/ai-docs/instructions/service-code-format/09-realtime-triggers.md +110 -4
  7. package/ai-docs/instructions/service-code-format/16-gotchas.md +28 -0
  8. package/ai-docs/instructions/service-code-format/18-test-recipes.md +16 -0
  9. package/ai-docs/instructions/service-code-format/19-security.md +121 -0
  10. package/ai-docs/instructions/service-code-format/README.md +3 -2
  11. package/ai-docs/providers/claude/agents/flowrunner-service-code-engineer.md +1 -1
  12. package/dist/cli.js +104 -16
  13. package/dist/cli.js.map +2 -2
  14. package/dist/index.js +103 -15
  15. package/dist/index.js.map +2 -2
  16. package/dist/types/flow-extension-runner/src/v2/oauth/types.d.ts +9 -7
  17. package/dist/types/flow-extension-runner/src/v2/params/schema/field-plan.d.ts +9 -4
  18. package/dist/types/flow-extension-runner/src/v2/params/zod.d.ts +12 -0
  19. package/dist/types/flow-extension-runner/src/v2/realtime-triggers/types.d.ts +2 -1
  20. package/dist/types/shared/src/constants/activity-log.d.ts +77 -0
  21. package/dist/types/shared/src/constants/app.d.ts +0 -1
  22. package/dist/types/shared/src/constants/notification-types.d.ts +117 -6
  23. package/dist/types/shared/src/scheme/account/dto.d.ts +3 -0
  24. package/dist/types/shared/src/scheme/crm/dto.d.ts +6 -0
  25. package/dist/types/shared/src/scheme/index.d.ts +1 -0
  26. package/dist/types/shared/src/scheme/integration-connection/dto.d.ts +27 -15
  27. package/dist/types/shared/src/scheme/notifications/dto.d.ts +3 -0
  28. package/dist/types/shared/src/scheme/notifications/rest.d.ts +6 -0
  29. package/dist/types/shared/src/scheme/onboarding/dto.d.ts +29 -0
  30. package/dist/types/shared/src/scheme/onboarding/index.d.ts +1 -0
  31. package/package.json +1 -1
  32. package/runtime/index.js +103 -15
  33. package/runtime/index.js.map +2 -2
  34. package/runtime/types/flow-extension-runner/src/v2/oauth/types.d.ts +9 -7
  35. package/runtime/types/flow-extension-runner/src/v2/params/schema/field-plan.d.ts +9 -4
  36. package/runtime/types/flow-extension-runner/src/v2/params/zod.d.ts +12 -0
  37. package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/types.d.ts +2 -1
  38. package/runtime/types/shared/src/constants/activity-log.d.ts +77 -0
  39. package/runtime/types/shared/src/constants/app.d.ts +0 -1
  40. package/runtime/types/shared/src/constants/notification-types.d.ts +117 -6
  41. package/runtime/types/shared/src/scheme/account/dto.d.ts +3 -0
  42. package/runtime/types/shared/src/scheme/crm/dto.d.ts +6 -0
  43. package/runtime/types/shared/src/scheme/index.d.ts +1 -0
  44. package/runtime/types/shared/src/scheme/integration-connection/dto.d.ts +27 -15
  45. package/runtime/types/shared/src/scheme/notifications/dto.d.ts +3 -0
  46. package/runtime/types/shared/src/scheme/notifications/rest.d.ts +6 -0
  47. package/runtime/types/shared/src/scheme/onboarding/dto.d.ts +29 -0
  48. package/runtime/types/shared/src/scheme/onboarding/index.d.ts +1 -0
@@ -18,11 +18,17 @@ export interface OAuthRefreshResult {
18
18
  expirationInSeconds?: number;
19
19
  refreshToken?: string;
20
20
  }
21
+ export interface OAuthStoredToken<TUserData = unknown> {
22
+ accessToken: string;
23
+ refreshToken?: string;
24
+ userData?: TUserData;
25
+ }
21
26
  export interface OAuthBag<TToken = unknown> {
22
27
  accessToken?: string;
23
28
  token?: TToken;
29
+ userData?: unknown;
24
30
  }
25
- export interface OAuth2Props<TShape extends ExtensionShape = AnyShape, TToken = unknown> {
31
+ export interface OAuth2Props<TShape extends ExtensionShape = AnyShape, TToken = OAuthStoredToken> {
26
32
  scopes?: string[];
27
33
  authorizeUrl?: string;
28
34
  tokenUrl?: string;
@@ -36,12 +42,8 @@ export interface OAuth2Props<TShape extends ExtensionShape = AnyShape, TToken =
36
42
  imageUrl?: string | null;
37
43
  userData?: unknown;
38
44
  };
39
- serializeToken?: (data: {
40
- accessToken: string;
41
- refreshToken?: string;
42
- userData?: unknown;
43
- }) => string;
44
- deserializeToken?: (accessToken: string) => TToken;
45
+ serializeToken?: (stored: OAuthStoredToken) => string;
46
+ deserializeToken?: (token: string) => TToken;
45
47
  getConnectionURL?: (bag: HandlerBag<TShape> & {
46
48
  scopes: string[];
47
49
  }) => string | Promise<string>;
@@ -1,5 +1,11 @@
1
1
  import { type AnyZod } from './introspect';
2
2
  export type AbsencePolicy = 'as-received' | 'undefined' | 'null' | 'required';
3
+ export interface Absence {
4
+ absence: AbsencePolicy;
5
+ absorbsBlank: boolean;
6
+ keepsEmpty: boolean;
7
+ blankIsValue: boolean;
8
+ }
3
9
  export interface FieldPlan {
4
10
  name: string;
5
11
  schema: AnyZod;
@@ -16,6 +22,8 @@ export interface FieldPlan {
16
22
  isUnion: boolean;
17
23
  absence: AbsencePolicy;
18
24
  absorbsBlank: boolean;
25
+ keepsEmpty: boolean;
26
+ blankIsValue: boolean;
19
27
  /**
20
28
  * True for a `z.date()` whose value must reach the handler UNCHANGED — validated through a converted copy,
21
29
  * handed over as the host sent it. False for `z.coerce.date()`, which the author asked to convert.
@@ -26,8 +34,5 @@ export interface FieldPlan {
26
34
  restoresDates: boolean;
27
35
  }
28
36
  /** The absent forms a schema accepts, at any depth. Same question `planField` asks for a top-level field. */
29
- export declare function absenceOf(schema: AnyZod | undefined): {
30
- absence: AbsencePolicy;
31
- absorbsBlank: boolean;
32
- };
37
+ export declare function absenceOf(schema: AnyZod | undefined): Absence;
33
38
  export declare function planField(name: string, schema: AnyZod): FieldPlan;
@@ -83,6 +83,18 @@ declare module 'zod' {
83
83
  /** @deprecated Inverted and renamed — see `labels`. Throws, so the change cannot pass silently. */
84
84
  map(mapping: Record<string, unknown>): never;
85
85
  }
86
+ interface ZodUnknown {
87
+ /**
88
+ * Mark the field required — the same as zod's `.nonoptional()`. `z.unknown()` is optional unless marked;
89
+ * `z.unknown().required()` takes any value (text, number, boolean, `null`, an object, a list, a date) but
90
+ * refuses a missing one.
91
+ */
92
+ required(): this;
93
+ }
94
+ interface ZodAny {
95
+ /** Mark the field required — see `ZodUnknown.required`. */
96
+ required(): this;
97
+ }
86
98
  }
87
99
  declare function text(): baseZod.ZodString;
88
100
  /**
@@ -38,7 +38,7 @@ export interface RealtimeVerify<TShape extends ExtensionShape = AnyShape> {
38
38
  encoding: 'hex' | 'base64';
39
39
  secret: (config: TShape['config'], bag: {
40
40
  webhookData: ProviderPayload;
41
- }) => string;
41
+ }) => string | null | undefined;
42
42
  freshness?: number;
43
43
  timestampHeader?: string;
44
44
  }
@@ -66,6 +66,7 @@ export interface RealtimeSetupProps<TShape extends ExtensionShape = AnyShape> {
66
66
  verify?: RealtimeVerify<TShape>;
67
67
  handshake?: (bag: InboundBag<TShape> & {
68
68
  requestBody: ProviderPayload;
69
+ query: Record<string, unknown>;
69
70
  }) => HandshakeResult | boolean | void | Promise<HandshakeResult | boolean | void>;
70
71
  subscribe: (bag: HandlerBag<TShape> & {
71
72
  callbackUrl: string;
@@ -95,6 +95,9 @@ export declare enum ActivityLogOperation {
95
95
  WS_PANIC_MODE_DISABLED = "WS_PANIC_MODE_DISABLED",
96
96
  WS_HIPAA_COMPLIANCE_ENABLED = "WS_HIPAA_COMPLIANCE_ENABLED",
97
97
  WS_HIPAA_COMPLIANCE_DISABLED = "WS_HIPAA_COMPLIANCE_DISABLED",
98
+ WS_SSO_CONFIG_SAVED = "WS_SSO_CONFIG_SAVED",
99
+ WS_SSO_CONFIG_DELETED = "WS_SSO_CONFIG_DELETED",
100
+ WS_SSO_RELINK_PERMITTED = "WS_SSO_RELINK_PERMITTED",
98
101
  WS_ACCESS_KEY_ROTATED = "WS_ACCESS_KEY_ROTATED",
99
102
  WS_ACCOUNT_PERMISSIONS_CHANGED = "WS_ACCOUNT_PERMISSIONS_CHANGED",
100
103
  WS_OWNERSHIP_TRANSFER_STARTED = "WS_OWNERSHIP_TRANSFER_STARTED",
@@ -134,6 +137,9 @@ export declare enum ActivityLogOperation {
134
137
  ACC_FLOW_INSTANCES_EXPORT_COMPLETED = "ACC_FLOW_INSTANCES_EXPORT_COMPLETED",
135
138
  ACC_FLOW_INSTANCES_EXPORT_FAILED = "ACC_FLOW_INSTANCES_EXPORT_FAILED",
136
139
  ACC_PASSWORD_RESTORE_REQUESTED = "ACC_PASSWORD_RESTORE_REQUESTED",
140
+ ACC_ACTIVATED_BY_SSO = "ACC_ACTIVATED_BY_SSO",
141
+ ACC_SSO_RELINK_PERMITTED = "ACC_SSO_RELINK_PERMITTED",
142
+ ACC_SSO_SIGN_IN_LINKS_REQUESTED = "ACC_SSO_SIGN_IN_LINKS_REQUESTED",
137
143
  ACC_LOGIN_OTP_ISSUED = "ACC_LOGIN_OTP_ISSUED",
138
144
  ACC_EMAIL_CONFIRMATION_REQUESTED = "ACC_EMAIL_CONFIRMATION_REQUESTED",
139
145
  ACC_PAYMENT_CONFIRMATION_REQUIRED = "ACC_PAYMENT_CONFIRMATION_REQUIRED",
@@ -794,6 +800,32 @@ export declare const ActivityLogOperationsConfigs: {
794
800
  summary: string;
795
801
  detailsSchema: z.ZodObject<{}, z.core.$strict>;
796
802
  };
803
+ WS_SSO_CONFIG_SAVED: {
804
+ scope: ActivityLogScope.WORKSPACE;
805
+ severity: "warning";
806
+ category: ActivityLogCategory.WORKSPACE_MANAGE;
807
+ title: string;
808
+ summary: string;
809
+ detailsSchema: z.ZodObject<{}, z.core.$strict>;
810
+ };
811
+ WS_SSO_CONFIG_DELETED: {
812
+ scope: ActivityLogScope.WORKSPACE;
813
+ severity: "warning";
814
+ category: ActivityLogCategory.WORKSPACE_MANAGE;
815
+ title: string;
816
+ summary: string;
817
+ detailsSchema: z.ZodObject<{}, z.core.$strict>;
818
+ };
819
+ WS_SSO_RELINK_PERMITTED: {
820
+ scope: ActivityLogScope.WORKSPACE;
821
+ severity: "warning";
822
+ category: ActivityLogCategory.WORKSPACE_MANAGE;
823
+ title: ({ accountName }: Record<string, unknown>) => string;
824
+ summary: string;
825
+ detailsSchema: z.ZodObject<{
826
+ accountId: z.ZodOptional<z.ZodString>;
827
+ }, z.core.$strip>;
828
+ };
797
829
  WS_ACCESS_KEY_ROTATED: {
798
830
  scope: ActivityLogScope.WORKSPACE;
799
831
  severity: "critical";
@@ -1079,6 +1111,8 @@ export declare const ActivityLogOperationsConfigs: {
1079
1111
  version: z.ZodOptional<z.ZodNumber>;
1080
1112
  executionId: z.ZodOptional<z.ZodString>;
1081
1113
  reason: z.ZodOptional<z.ZodString>;
1114
+ terminationKind: z.ZodOptional<z.ZodEnum<typeof import("./notification-types").FlowTerminationKind>>;
1115
+ parentExecutionId: z.ZodOptional<z.ZodString>;
1082
1116
  }, z.core.$strip>;
1083
1117
  notify: {
1084
1118
  type: "FLOW_INSTANCE_TERMINATED";
@@ -1327,11 +1361,54 @@ export declare const ActivityLogOperationsConfigs: {
1327
1361
  summary: string;
1328
1362
  detailsSchema: z.ZodObject<{
1329
1363
  restorePwdId: z.ZodString;
1364
+ ssoWorkspaceIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
1330
1365
  }, z.core.$strip>;
1331
1366
  notify: {
1332
1367
  type: "PASSWORD_RESTORE_REQUESTED";
1333
1368
  };
1334
1369
  };
1370
+ ACC_ACTIVATED_BY_SSO: {
1371
+ scope: ActivityLogScope.ACCOUNT;
1372
+ severity: "warning";
1373
+ category: ActivityLogCategory.ACCOUNT;
1374
+ title: ({ workspaceName }: Record<string, unknown>) => string;
1375
+ summary: string;
1376
+ detailsSchema: z.ZodObject<{
1377
+ workspaceId: z.ZodString;
1378
+ }, z.core.$strip>;
1379
+ notify: {
1380
+ type: "ACTIVATED_BY_SSO";
1381
+ };
1382
+ };
1383
+ ACC_SSO_RELINK_PERMITTED: {
1384
+ scope: ActivityLogScope.ACCOUNT;
1385
+ severity: "warning";
1386
+ category: ActivityLogCategory.WORKSPACE_MANAGE;
1387
+ title: ({ workspaceName }: Record<string, unknown>) => string;
1388
+ summary: string;
1389
+ detailsSchema: z.ZodObject<{
1390
+ workspaceId: z.ZodString;
1391
+ }, z.core.$strip>;
1392
+ notify: {
1393
+ type: "SSO_RELINK_PERMITTED";
1394
+ };
1395
+ };
1396
+ ACC_SSO_SIGN_IN_LINKS_REQUESTED: {
1397
+ scope: ActivityLogScope.ACCOUNT;
1398
+ severity: "info";
1399
+ category: ActivityLogCategory.ACCOUNT;
1400
+ title: string;
1401
+ summary: string;
1402
+ detailsSchema: z.ZodObject<{
1403
+ links: z.ZodArray<z.ZodObject<{
1404
+ workspaceId: z.ZodString;
1405
+ signInUrl: z.ZodString;
1406
+ }, z.core.$strip>>;
1407
+ }, z.core.$strip>;
1408
+ notify: {
1409
+ type: "SSO_SIGN_IN_LINKS_REQUESTED";
1410
+ };
1411
+ };
1335
1412
  ACC_LOGIN_OTP_ISSUED: {
1336
1413
  scope: ActivityLogScope.ACCOUNT;
1337
1414
  severity: "info";
@@ -53,6 +53,5 @@ export declare const PRESERVED_SCREENS: {
53
53
  general: number;
54
54
  team: number;
55
55
  billing: number;
56
- 'log-management': number;
57
56
  };
58
57
  export type PreservedScreenType = keyof typeof PRESERVED_SCREENS;
@@ -37,6 +37,7 @@ export declare const FlowInstancesExportFailedDataSchema: z.ZodObject<{
37
37
  export declare const PasswordRestoreRequestedDataSchema: z.ZodObject<{
38
38
  devName: z.ZodString;
39
39
  restorePwdId: z.ZodString;
40
+ ssoWorkspaceNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
40
41
  }, z.core.$strip>;
41
42
  export declare const WorkspaceDevInvitationDataSchema: z.ZodObject<{
42
43
  inviterName: z.ZodString;
@@ -64,6 +65,20 @@ export declare const PaymentConfirmationRequiredDataSchema: z.ZodObject<{
64
65
  currency: z.ZodOptional<z.ZodString>;
65
66
  expiresInSeconds: z.ZodOptional<z.ZodNumber>;
66
67
  }, z.core.$strip>;
68
+ export declare const AccountActivatedBySsoDataSchema: z.ZodObject<{
69
+ workspaceName: z.ZodOptional<z.ZodString>;
70
+ }, z.core.$strip>;
71
+ export declare const SsoRelinkPermittedDataSchema: z.ZodObject<{
72
+ workspaceName: z.ZodOptional<z.ZodString>;
73
+ adminName: z.ZodOptional<z.ZodString>;
74
+ }, z.core.$strip>;
75
+ export declare const SsoSignInLinksRequestedDataSchema: z.ZodObject<{
76
+ links: z.ZodArray<z.ZodObject<{
77
+ workspaceId: z.ZodString;
78
+ workspaceName: z.ZodOptional<z.ZodString>;
79
+ signInUrl: z.ZodString;
80
+ }, z.core.$strip>>;
81
+ }, z.core.$strip>;
67
82
  export declare const AccountNotificationTypes: {
68
83
  readonly OWNERSHIP_TRANSFER_REQUEST: {
69
84
  readonly severity: "warning";
@@ -123,6 +138,45 @@ export declare const AccountNotificationTypes: {
123
138
  readonly dataSchema: z.ZodObject<{
124
139
  devName: z.ZodString;
125
140
  restorePwdId: z.ZodString;
141
+ ssoWorkspaceNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
142
+ }, z.core.$strip>;
143
+ };
144
+ readonly ACTIVATED_BY_SSO: {
145
+ readonly severity: "warning";
146
+ readonly title: "Your account was activated through single sign-on";
147
+ readonly message: (data: Record<string, unknown>) => string;
148
+ readonly emailTemplate: "account-activated-by-sso";
149
+ readonly tags: ["account", "security"];
150
+ readonly requireAccountId: true;
151
+ readonly dataSchema: z.ZodObject<{
152
+ workspaceName: z.ZodOptional<z.ZodString>;
153
+ }, z.core.$strip>;
154
+ };
155
+ readonly SSO_RELINK_PERMITTED: {
156
+ readonly severity: "warning";
157
+ readonly title: "Your single sign-on connection was reset";
158
+ readonly message: (data: Record<string, unknown>) => string;
159
+ readonly emailTemplate: "sso-connection-reset";
160
+ readonly tags: ["account", "security"];
161
+ readonly requireAccountId: true;
162
+ readonly dataSchema: z.ZodObject<{
163
+ workspaceName: z.ZodOptional<z.ZodString>;
164
+ adminName: z.ZodOptional<z.ZodString>;
165
+ }, z.core.$strip>;
166
+ };
167
+ readonly SSO_SIGN_IN_LINKS_REQUESTED: {
168
+ readonly severity: "info";
169
+ readonly title: "Your single sign-on links";
170
+ readonly message: "The workspaces you sign in to through single sign-on have been emailed to you.";
171
+ readonly emailTemplate: "sso-sign-in-links";
172
+ readonly tags: ["account"];
173
+ readonly requireAccountId: true;
174
+ readonly dataSchema: z.ZodObject<{
175
+ links: z.ZodArray<z.ZodObject<{
176
+ workspaceId: z.ZodString;
177
+ workspaceName: z.ZodOptional<z.ZodString>;
178
+ signInUrl: z.ZodString;
179
+ }, z.core.$strip>>;
126
180
  }, z.core.$strip>;
127
181
  };
128
182
  readonly WORKSPACE_DEV_INVITATION: {
@@ -207,13 +261,27 @@ export declare const AccountNotificationTypes: {
207
261
  readonly requireAccountId: true;
208
262
  };
209
263
  };
264
+ export declare enum FlowTerminationKind {
265
+ FAILURE = "FAILURE",
266
+ TIMEOUT = "TIMEOUT",
267
+ WORKSPACE_SUSPENSION = "WORKSPACE_SUSPENSION",
268
+ SYSTEM_LIFECYCLE = "SYSTEM_LIFECYCLE",
269
+ USER_INSTANCE_STOPPED = "USER_INSTANCE_STOPPED",
270
+ USER_FLOW_VERSION_STOPPED = "USER_FLOW_VERSION_STOPPED"
271
+ }
210
272
  export declare const FlowInstanceTerminatedDataSchema: z.ZodObject<{
211
273
  flowId: z.ZodOptional<z.ZodString>;
212
274
  flowName: z.ZodString;
213
275
  version: z.ZodOptional<z.ZodNumber>;
214
276
  executionId: z.ZodOptional<z.ZodString>;
215
277
  reason: z.ZodOptional<z.ZodString>;
278
+ terminationKind: z.ZodOptional<z.ZodEnum<typeof FlowTerminationKind>>;
279
+ parentExecutionId: z.ZodOptional<z.ZodString>;
216
280
  }, z.core.$strip>;
281
+ export declare function flowTerminationPhrasing(kind: unknown): {
282
+ verb: string;
283
+ clause: string;
284
+ };
217
285
  export declare const FlowExtensionPollingTriggerFailedDataSchema: z.ZodObject<{
218
286
  flowId: z.ZodOptional<z.ZodString>;
219
287
  flowName: z.ZodOptional<z.ZodString>;
@@ -375,7 +443,7 @@ export declare const WorkspaceNotificationTypes: {
375
443
  readonly FLOW_INSTANCE_TERMINATED: {
376
444
  readonly severity: "warning";
377
445
  readonly title: (data: Record<string, unknown>) => string;
378
- readonly message: "A flow instance was terminated.";
446
+ readonly message: (data: Record<string, unknown>) => string;
379
447
  readonly emailTemplate: "flow-instance-terminated";
380
448
  readonly tags: ["flow-execution"];
381
449
  readonly dataSchema: z.ZodObject<{
@@ -384,12 +452,14 @@ export declare const WorkspaceNotificationTypes: {
384
452
  version: z.ZodOptional<z.ZodNumber>;
385
453
  executionId: z.ZodOptional<z.ZodString>;
386
454
  reason: z.ZodOptional<z.ZodString>;
455
+ terminationKind: z.ZodOptional<z.ZodEnum<typeof FlowTerminationKind>>;
456
+ parentExecutionId: z.ZodOptional<z.ZodString>;
387
457
  }, z.core.$strip>;
388
458
  readonly grouping: {
389
- readonly keyFields: ["flowId"];
459
+ readonly keyFields: ["flowId", "terminationKind"];
390
460
  readonly windowMs: number;
391
461
  readonly title: (data: Record<string, unknown>) => string;
392
- readonly message: () => string;
462
+ readonly message: (data: Record<string, unknown>) => string;
393
463
  };
394
464
  };
395
465
  readonly FLOW_EXTENSION_POLLING_TRIGGER_FAILED: {
@@ -730,7 +800,7 @@ export declare const AllNotificationTypes: {
730
800
  readonly FLOW_INSTANCE_TERMINATED: {
731
801
  readonly severity: "warning";
732
802
  readonly title: (data: Record<string, unknown>) => string;
733
- readonly message: "A flow instance was terminated.";
803
+ readonly message: (data: Record<string, unknown>) => string;
734
804
  readonly emailTemplate: "flow-instance-terminated";
735
805
  readonly tags: ["flow-execution"];
736
806
  readonly dataSchema: z.ZodObject<{
@@ -739,12 +809,14 @@ export declare const AllNotificationTypes: {
739
809
  version: z.ZodOptional<z.ZodNumber>;
740
810
  executionId: z.ZodOptional<z.ZodString>;
741
811
  reason: z.ZodOptional<z.ZodString>;
812
+ terminationKind: z.ZodOptional<z.ZodEnum<typeof FlowTerminationKind>>;
813
+ parentExecutionId: z.ZodOptional<z.ZodString>;
742
814
  }, z.core.$strip>;
743
815
  readonly grouping: {
744
- readonly keyFields: ["flowId"];
816
+ readonly keyFields: ["flowId", "terminationKind"];
745
817
  readonly windowMs: number;
746
818
  readonly title: (data: Record<string, unknown>) => string;
747
- readonly message: () => string;
819
+ readonly message: (data: Record<string, unknown>) => string;
748
820
  };
749
821
  };
750
822
  readonly FLOW_EXTENSION_POLLING_TRIGGER_FAILED: {
@@ -1036,6 +1108,45 @@ export declare const AllNotificationTypes: {
1036
1108
  readonly dataSchema: z.ZodObject<{
1037
1109
  devName: z.ZodString;
1038
1110
  restorePwdId: z.ZodString;
1111
+ ssoWorkspaceNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
1112
+ }, z.core.$strip>;
1113
+ };
1114
+ readonly ACTIVATED_BY_SSO: {
1115
+ readonly severity: "warning";
1116
+ readonly title: "Your account was activated through single sign-on";
1117
+ readonly message: (data: Record<string, unknown>) => string;
1118
+ readonly emailTemplate: "account-activated-by-sso";
1119
+ readonly tags: ["account", "security"];
1120
+ readonly requireAccountId: true;
1121
+ readonly dataSchema: z.ZodObject<{
1122
+ workspaceName: z.ZodOptional<z.ZodString>;
1123
+ }, z.core.$strip>;
1124
+ };
1125
+ readonly SSO_RELINK_PERMITTED: {
1126
+ readonly severity: "warning";
1127
+ readonly title: "Your single sign-on connection was reset";
1128
+ readonly message: (data: Record<string, unknown>) => string;
1129
+ readonly emailTemplate: "sso-connection-reset";
1130
+ readonly tags: ["account", "security"];
1131
+ readonly requireAccountId: true;
1132
+ readonly dataSchema: z.ZodObject<{
1133
+ workspaceName: z.ZodOptional<z.ZodString>;
1134
+ adminName: z.ZodOptional<z.ZodString>;
1135
+ }, z.core.$strip>;
1136
+ };
1137
+ readonly SSO_SIGN_IN_LINKS_REQUESTED: {
1138
+ readonly severity: "info";
1139
+ readonly title: "Your single sign-on links";
1140
+ readonly message: "The workspaces you sign in to through single sign-on have been emailed to you.";
1141
+ readonly emailTemplate: "sso-sign-in-links";
1142
+ readonly tags: ["account"];
1143
+ readonly requireAccountId: true;
1144
+ readonly dataSchema: z.ZodObject<{
1145
+ links: z.ZodArray<z.ZodObject<{
1146
+ workspaceId: z.ZodString;
1147
+ workspaceName: z.ZodOptional<z.ZodString>;
1148
+ signInUrl: z.ZodString;
1149
+ }, z.core.$strip>>;
1039
1150
  }, z.core.$strip>;
1040
1151
  };
1041
1152
  readonly WORKSPACE_DEV_INVITATION: {
@@ -10,6 +10,7 @@ export declare const AccountDocSchema: z.ZodObject<{
10
10
  billingCustomerId: z.ZodOptional<z.ZodString>;
11
11
  workspaceIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
12
12
  registrationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
13
+ usedTrial: z.ZodOptional<z.ZodBoolean>;
13
14
  lastLogin: z.ZodOptional<z.ZodCoercedDate<unknown>>;
14
15
  metaInfo: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
15
16
  lastReadNotificationsAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
@@ -36,6 +37,7 @@ export declare const AccountDTOSchema: z.ZodObject<{
36
37
  billingCustomerId: z.ZodOptional<z.ZodString>;
37
38
  workspaceIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
38
39
  registrationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
40
+ usedTrial: z.ZodOptional<z.ZodBoolean>;
39
41
  lastLogin: z.ZodOptional<z.ZodCoercedDate<unknown>>;
40
42
  metaInfo: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
41
43
  lastReadNotificationsAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
@@ -48,6 +50,7 @@ export declare const AccountJavaDTOSchema: z.ZodObject<{
48
50
  billingCustomerId: z.ZodOptional<z.ZodString>;
49
51
  workspaceIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
50
52
  registrationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
53
+ usedTrial: z.ZodOptional<z.ZodBoolean>;
51
54
  lastLogin: z.ZodOptional<z.ZodCoercedDate<unknown>>;
52
55
  metaInfo: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
53
56
  id: z.ZodString;
@@ -11,6 +11,7 @@ declare const DeveloperInWorkspaceDTOSchema: z.ZodObject<{
11
11
  system: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
12
12
  billingCustomerId: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
13
13
  registrationDate: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
14
+ usedTrial: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
14
15
  lastLogin: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
15
16
  lastReadNotificationsAt: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
16
17
  id: z.ZodString;
@@ -36,6 +37,7 @@ export declare const WorkspaceDTOSchema: z.ZodObject<{
36
37
  system: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
37
38
  billingCustomerId: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
38
39
  registrationDate: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
40
+ usedTrial: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
39
41
  lastLogin: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
40
42
  lastReadNotificationsAt: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
41
43
  id: z.ZodString;
@@ -58,6 +60,7 @@ export declare const DeveloperSearchResponseSchema: z.ZodArray<z.ZodObject<{
58
60
  system: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
59
61
  billingCustomerId: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
60
62
  registrationDate: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
63
+ usedTrial: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
61
64
  lastLogin: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
62
65
  lastReadNotificationsAt: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
63
66
  id: z.ZodString;
@@ -70,6 +73,7 @@ export declare const CrmDeveloperDTOSchema: z.ZodObject<{
70
73
  system: z.ZodOptional<z.ZodBoolean>;
71
74
  billingCustomerId: z.ZodOptional<z.ZodString>;
72
75
  registrationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
76
+ usedTrial: z.ZodOptional<z.ZodBoolean>;
73
77
  lastLogin: z.ZodOptional<z.ZodCoercedDate<unknown>>;
74
78
  lastReadNotificationsAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
75
79
  id: z.ZodString;
@@ -108,6 +112,7 @@ export declare const CrmDevelopersResponseSchema: z.ZodObject<{
108
112
  system: z.ZodOptional<z.ZodBoolean>;
109
113
  billingCustomerId: z.ZodOptional<z.ZodString>;
110
114
  registrationDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
115
+ usedTrial: z.ZodOptional<z.ZodBoolean>;
111
116
  lastLogin: z.ZodOptional<z.ZodCoercedDate<unknown>>;
112
117
  lastReadNotificationsAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
113
118
  id: z.ZodString;
@@ -189,6 +194,7 @@ export declare const CrmWorkspacesResponseSchema: z.ZodObject<{
189
194
  system: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
190
195
  billingCustomerId: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
191
196
  registrationDate: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
197
+ usedTrial: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
192
198
  lastLogin: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
193
199
  lastReadNotificationsAt: z.ZodNonOptional<z.ZodOptional<z.ZodCoercedDate<unknown>>>;
194
200
  id: z.ZodString;
@@ -14,6 +14,7 @@ export * from './integration-connection';
14
14
  export * from './knowledge-base';
15
15
  export * from './mcp-oauth';
16
16
  export * from './notifications';
17
+ export * from './onboarding';
17
18
  export * from './properties';
18
19
  export * from './remote-mcp-server';
19
20
  export * from './shared-extensions';
@@ -4,9 +4,11 @@ export declare const ConnectionInfoSchema: z.ZodObject<{
4
4
  expirationInSeconds: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
5
5
  refreshToken: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6
6
  serviceId: z.ZodString;
7
- serviceName: z.ZodString;
8
- modelName: z.ZodOptional<z.ZodString>;
9
- hostType: z.ZodOptional<z.ZodString>;
7
+ serviceName: z.ZodOptional<z.ZodString>;
8
+ hostType: z.ZodEnum<{
9
+ APP: "APP";
10
+ SHARED: "SHARED";
11
+ }>;
10
12
  packageId: z.ZodOptional<z.ZodString>;
11
13
  connectionIdentityName: z.ZodOptional<z.ZodString>;
12
14
  connectionIdentityImageURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -15,11 +17,13 @@ export declare const ConnectionInfoSchema: z.ZodObject<{
15
17
  }, z.core.$strip>;
16
18
  export declare const ConnectionInfoDTOSchema: z.ZodObject<{
17
19
  serviceId: z.ZodString;
18
- serviceName: z.ZodString;
19
- hostType: z.ZodOptional<z.ZodString>;
20
+ serviceName: z.ZodOptional<z.ZodString>;
21
+ hostType: z.ZodEnum<{
22
+ APP: "APP";
23
+ SHARED: "SHARED";
24
+ }>;
20
25
  packageId: z.ZodOptional<z.ZodString>;
21
26
  expirationInSeconds: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
22
- modelName: z.ZodOptional<z.ZodString>;
23
27
  connectionIdentityName: z.ZodOptional<z.ZodString>;
24
28
  connectionIdentityImageURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
25
29
  overwrite: z.ZodOptional<z.ZodBoolean>;
@@ -46,24 +50,29 @@ export declare const OAuthConnectionErrorDTOSchema: z.ZodObject<{
46
50
  export declare const OAuthConnectionDTOSchema: z.ZodObject<{
47
51
  _id: z.ZodUUID;
48
52
  name: z.ZodString;
49
- connectionInfo: z.ZodNullable<z.ZodObject<{
53
+ connectionInfo: z.ZodObject<{
50
54
  serviceId: z.ZodString;
51
- serviceName: z.ZodString;
52
- hostType: z.ZodOptional<z.ZodString>;
55
+ serviceName: z.ZodOptional<z.ZodString>;
56
+ hostType: z.ZodEnum<{
57
+ APP: "APP";
58
+ SHARED: "SHARED";
59
+ }>;
53
60
  packageId: z.ZodOptional<z.ZodString>;
54
61
  expirationInSeconds: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
55
- modelName: z.ZodOptional<z.ZodString>;
56
62
  connectionIdentityName: z.ZodOptional<z.ZodString>;
57
63
  connectionIdentityImageURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
58
64
  overwrite: z.ZodOptional<z.ZodBoolean>;
59
65
  userData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
60
- }, z.core.$strip>>;
66
+ }, z.core.$strip>;
61
67
  created: z.ZodCoercedDate<unknown>;
62
68
  updated: z.ZodCoercedDate<unknown>;
63
69
  }, z.core.$strip>;
64
70
  export declare const ConnectionInfoListDTOSchema: z.ZodObject<{
65
71
  serviceId: z.ZodString;
66
- hostType: z.ZodOptional<z.ZodString>;
72
+ hostType: z.ZodEnum<{
73
+ APP: "APP";
74
+ SHARED: "SHARED";
75
+ }>;
67
76
  packageId: z.ZodOptional<z.ZodString>;
68
77
  connectionIdentityImageURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
69
78
  userData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -71,13 +80,16 @@ export declare const ConnectionInfoListDTOSchema: z.ZodObject<{
71
80
  export declare const OAuthConnectionListDTOSchema: z.ZodObject<{
72
81
  name: z.ZodString;
73
82
  _id: z.ZodUUID;
74
- connectionInfo: z.ZodNullable<z.ZodObject<{
83
+ connectionInfo: z.ZodObject<{
75
84
  serviceId: z.ZodString;
76
- hostType: z.ZodOptional<z.ZodString>;
85
+ hostType: z.ZodEnum<{
86
+ APP: "APP";
87
+ SHARED: "SHARED";
88
+ }>;
77
89
  packageId: z.ZodOptional<z.ZodString>;
78
90
  connectionIdentityImageURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
79
91
  userData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
80
- }, z.core.$strip>>;
92
+ }, z.core.$strip>;
81
93
  created: z.ZodNullable<z.ZodCoercedDate<unknown>>;
82
94
  expiresAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
83
95
  renewsAutomatically: z.ZodBoolean;
@@ -49,6 +49,9 @@ export declare const AccountNotificationDTOSchema: z.ZodObject<{
49
49
  FLOW_INSTANCES_EXPORT_COMPLETED: "FLOW_INSTANCES_EXPORT_COMPLETED";
50
50
  FLOW_INSTANCES_EXPORT_FAILED: "FLOW_INSTANCES_EXPORT_FAILED";
51
51
  PASSWORD_RESTORE_REQUESTED: "PASSWORD_RESTORE_REQUESTED";
52
+ ACTIVATED_BY_SSO: "ACTIVATED_BY_SSO";
53
+ SSO_RELINK_PERMITTED: "SSO_RELINK_PERMITTED";
54
+ SSO_SIGN_IN_LINKS_REQUESTED: "SSO_SIGN_IN_LINKS_REQUESTED";
52
55
  WORKSPACE_DEV_INVITATION: "WORKSPACE_DEV_INVITATION";
53
56
  ACCOUNT_STATUS_CHANGED: "ACCOUNT_STATUS_CHANGED";
54
57
  LOGIN_OTP_ISSUED: "LOGIN_OTP_ISSUED";
@@ -11,6 +11,9 @@ export declare const AccountNotificationRequestBodySchema: z.ZodObject<{
11
11
  FLOW_INSTANCES_EXPORT_COMPLETED: "FLOW_INSTANCES_EXPORT_COMPLETED";
12
12
  FLOW_INSTANCES_EXPORT_FAILED: "FLOW_INSTANCES_EXPORT_FAILED";
13
13
  PASSWORD_RESTORE_REQUESTED: "PASSWORD_RESTORE_REQUESTED";
14
+ ACTIVATED_BY_SSO: "ACTIVATED_BY_SSO";
15
+ SSO_RELINK_PERMITTED: "SSO_RELINK_PERMITTED";
16
+ SSO_SIGN_IN_LINKS_REQUESTED: "SSO_SIGN_IN_LINKS_REQUESTED";
14
17
  WORKSPACE_DEV_INVITATION: "WORKSPACE_DEV_INVITATION";
15
18
  ACCOUNT_STATUS_CHANGED: "ACCOUNT_STATUS_CHANGED";
16
19
  LOGIN_OTP_ISSUED: "LOGIN_OTP_ISSUED";
@@ -84,6 +87,9 @@ export declare const AccountNotificationsResponseSchema: z.ZodObject<{
84
87
  FLOW_INSTANCES_EXPORT_COMPLETED: "FLOW_INSTANCES_EXPORT_COMPLETED";
85
88
  FLOW_INSTANCES_EXPORT_FAILED: "FLOW_INSTANCES_EXPORT_FAILED";
86
89
  PASSWORD_RESTORE_REQUESTED: "PASSWORD_RESTORE_REQUESTED";
90
+ ACTIVATED_BY_SSO: "ACTIVATED_BY_SSO";
91
+ SSO_RELINK_PERMITTED: "SSO_RELINK_PERMITTED";
92
+ SSO_SIGN_IN_LINKS_REQUESTED: "SSO_SIGN_IN_LINKS_REQUESTED";
87
93
  WORKSPACE_DEV_INVITATION: "WORKSPACE_DEV_INVITATION";
88
94
  ACCOUNT_STATUS_CHANGED: "ACCOUNT_STATUS_CHANGED";
89
95
  LOGIN_OTP_ISSUED: "LOGIN_OTP_ISSUED";
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Onboarding DTO Schemas
3
+ *
4
+ * Per-(account, workspace) onboarding/guidance state, stored in a Console-owned main-DB collection.
5
+ * Generic keyed maps so new tours and dismissible hints are added by key, with no schema change:
6
+ * - `completedTours`: tourKey -> when the user completed/skipped that tour in this workspace.
7
+ * - `dismissedHints`: hintKey -> when the user dismissed that hint/invite in this workspace.
8
+ * All state is per user, per workspace.
9
+ */
10
+ import { z } from 'zod';
11
+ export declare const OnboardingStateDTOSchema: z.ZodObject<{
12
+ _id: z.ZodString;
13
+ accountId: z.ZodString;
14
+ workspaceId: z.ZodString;
15
+ completedTours: z.ZodRecord<z.ZodString, z.ZodCoercedDate<unknown>>;
16
+ dismissedHints: z.ZodRecord<z.ZodString, z.ZodCoercedDate<unknown>>;
17
+ createdAt: z.ZodCoercedDate<unknown>;
18
+ updatedAt: z.ZodCoercedDate<unknown>;
19
+ }, z.core.$strip>;
20
+ export type OnboardingStateDTO = z.infer<typeof OnboardingStateDTOSchema>;
21
+ /**
22
+ * Client-facing onboarding state: just the two keyed maps. Returned by the onboarding read/write
23
+ * endpoints. Both maps are always present (empty when nothing has happened yet).
24
+ */
25
+ export declare const OnboardingStateViewSchema: z.ZodObject<{
26
+ completedTours: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodCoercedDate<unknown>>>;
27
+ dismissedHints: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodCoercedDate<unknown>>>;
28
+ }, z.core.$strip>;
29
+ export type OnboardingStateView = z.infer<typeof OnboardingStateViewSchema>;
@@ -0,0 +1 @@
1
+ export * from './dto';