@coast/core-types 0.0.59 → 0.0.60

package/dist/automations/TCreateAutomation.d.ts

@@ -0,0 +1,17 @@
+import { BusinessId } from '../business/BusinessId';
+import { WorkflowTemplateId } from '../workflow-template/WorkflowTemplateId';
+import { TSaveAnyAutomationAction } from './action/TSaveAnyAutomationAction';
+import { AutomationId } from './AutomationId';
+import { AutomationTriggerType } from './AutomationTriggerType';
+import { TCondition } from './condition/TCondition';
+export interface TCreateAutomation {
+    workflowTemplateId: WorkflowTemplateId;
+    businessId: BusinessId;
+    name: string;
+    enabled: boolean;
+    suppressAutomationChain: boolean;
+    trigger: AutomationTriggerType;
+    actions: TSaveAnyAutomationAction[];
+    conditions?: TCondition[];
+    parentId?: AutomationId;
+}

package/dist/automations/TCreateAutomation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TCreateAutomation.js.map

package/dist/automations/TCreateAutomation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TCreateAutomation.js","sourceRoot":"","sources":["../../src/automations/TCreateAutomation.ts"],"names":[],"mappings":""}

package/dist/automations/TUpdateAutomation.d.ts

@@ -0,0 +1,18 @@
+import { BusinessId } from '../business/BusinessId';
+import { WorkflowTemplateId } from '../workflow-template/WorkflowTemplateId';
+import { TSaveAnyAutomationAction } from './action/TSaveAnyAutomationAction';
+import { AutomationId } from './AutomationId';
+import { AutomationTriggerType } from './AutomationTriggerType';
+import { TCondition } from './condition/TCondition';
+export interface TUpdateAutomation {
+    id: AutomationId;
+    businessId: BusinessId;
+    workflowTemplateId: WorkflowTemplateId;
+    name: string;
+    enabled: boolean;
+    suppressAutomationChain: boolean;
+    trigger: AutomationTriggerType;
+    actions: TSaveAnyAutomationAction[];
+    conditions?: TCondition[];
+    parentId?: AutomationId;
+}

package/dist/automations/TUpdateAutomation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TUpdateAutomation.js.map

package/dist/automations/TUpdateAutomation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TUpdateAutomation.js","sourceRoot":"","sources":["../../src/automations/TUpdateAutomation.ts"],"names":[],"mappings":""}

package/dist/automations/ValidatableAutomation.d.ts

@@ -0,0 +1,4 @@
+import { TAutomation } from './TAutomation';
+import { TCreateAutomation } from './TCreateAutomation';
+import { TUpdateAutomation } from './TUpdateAutomation';
+export type ValidatableAutomation = TAutomation | TCreateAutomation | TUpdateAutomation;

package/dist/automations/ValidatableAutomation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ValidatableAutomation.js.map

package/dist/automations/ValidatableAutomation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidatableAutomation.js","sourceRoot":"","sources":["../../src/automations/ValidatableAutomation.ts"],"names":[],"mappings":""}

package/dist/automations/action/TCreateAnyAutomationAction.d.ts

@@ -0,0 +1,3 @@
+import { DistributiveOmit } from '../../utils/DistributiveOmit';
+import { TAnyAutomationAction } from './TAnyAutomationAction';
+export type TCreateAnyAutomationAction = DistributiveOmit<TAnyAutomationAction, 'id'>;

package/dist/automations/action/TCreateAnyAutomationAction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TCreateAnyAutomationAction.js.map

package/dist/automations/action/TCreateAnyAutomationAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TCreateAnyAutomationAction.js","sourceRoot":"","sources":["../../../src/automations/action/TCreateAnyAutomationAction.ts"],"names":[],"mappings":""}

package/dist/automations/action/TSaveAnyAutomationAction.d.ts

@@ -0,0 +1,3 @@
+import { TAnyAutomationAction } from './TAnyAutomationAction';
+import { TCreateAnyAutomationAction } from './TCreateAnyAutomationAction';
+export type TSaveAnyAutomationAction = TAnyAutomationAction | TCreateAnyAutomationAction;

package/dist/automations/action/TSaveAnyAutomationAction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TSaveAnyAutomationAction.js.map

package/dist/automations/action/TSaveAnyAutomationAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TSaveAnyAutomationAction.js","sourceRoot":"","sources":["../../../src/automations/action/TSaveAnyAutomationAction.ts"],"names":[],"mappings":""}

package/dist/utils/DistributiveOmit.d.ts

@@ -0,0 +1 @@
+export type DistributiveOmit<T, K extends keyof never> = T extends unknown ? Omit<T, K> : never;

package/dist/utils/DistributiveOmit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DistributiveOmit.js.map

package/dist/utils/DistributiveOmit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DistributiveOmit.js","sourceRoot":"","sources":["../../src/utils/DistributiveOmit.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coast/core-types",
-  "version": "0.0.59",
+  "version": "0.0.60",
   "author": "Coast Engineering",
   "license": "MIT",
   "scripts": {

package/src/automations/TCreateAutomation.ts

@@ -0,0 +1,19 @@
+import { BusinessId } from '../business/BusinessId';
+import { WorkflowTemplateId } from '../workflow-template/WorkflowTemplateId';
+import { TSaveAnyAutomationAction } from './action/TSaveAnyAutomationAction';
+import { AutomationId } from './AutomationId';
+import { AutomationTriggerType } from './AutomationTriggerType';
+import { TCondition } from './condition/TCondition';
+
+export interface TCreateAutomation {
+    workflowTemplateId: WorkflowTemplateId;
+    businessId: BusinessId;
+    name: string;
+    enabled: boolean;
+    suppressAutomationChain: boolean;
+    trigger: AutomationTriggerType;
+    // Support actions with pre-generated ids so that clients can create Automations with references between actions
+    actions: TSaveAnyAutomationAction[];
+    conditions?: TCondition[];
+    parentId?: AutomationId;
+}

package/src/automations/TUpdateAutomation.ts

@@ -0,0 +1,19 @@
+import { BusinessId } from '../business/BusinessId';
+import { WorkflowTemplateId } from '../workflow-template/WorkflowTemplateId';
+import { TSaveAnyAutomationAction } from './action/TSaveAnyAutomationAction';
+import { AutomationId } from './AutomationId';
+import { AutomationTriggerType } from './AutomationTriggerType';
+import { TCondition } from './condition/TCondition';
+
+export interface TUpdateAutomation {
+    id: AutomationId;
+    businessId: BusinessId;
+    workflowTemplateId: WorkflowTemplateId;
+    name: string;
+    enabled: boolean;
+    suppressAutomationChain: boolean;
+    trigger: AutomationTriggerType;
+    actions: TSaveAnyAutomationAction[];
+    conditions?: TCondition[];
+    parentId?: AutomationId;
+}

package/src/automations/ValidatableAutomation.ts

@@ -0,0 +1,5 @@
+import { TAutomation } from './TAutomation';
+import { TCreateAutomation } from './TCreateAutomation';
+import { TUpdateAutomation } from './TUpdateAutomation';
+
+export type ValidatableAutomation = TAutomation | TCreateAutomation | TUpdateAutomation;

package/src/automations/action/TCreateAnyAutomationAction.ts

@@ -0,0 +1,9 @@
+import { DistributiveOmit } from '../../utils/DistributiveOmit';
+import { TAnyAutomationAction } from './TAnyAutomationAction';
+
+/**
+ * An action as submitted on *create*: identical to a read action, but with no `id` yet
+ * (action ids are DB-generated). `DistributiveOmit` (not `Omit`) keeps this a discriminated
+ * union so `switch (action.type)` still narrows.
+ */
+export type TCreateAnyAutomationAction = DistributiveOmit<TAnyAutomationAction, 'id'>;

package/src/automations/action/TSaveAnyAutomationAction.ts

@@ -0,0 +1,4 @@
+import { TAnyAutomationAction } from './TAnyAutomationAction';
+import { TCreateAnyAutomationAction } from './TCreateAnyAutomationAction';
+
+export type TSaveAnyAutomationAction = TAnyAutomationAction | TCreateAnyAutomationAction;

package/src/utils/DistributiveOmit.ts

@@ -0,0 +1,9 @@
+/**
+ * Like the built-in `Omit`, but distributes over the members of a union.
+ *
+ * `Omit<A | B, K>` collapses the union into a *single* merged object (losing the discriminant),
+ * which breaks `switch (x.type)` narrowing. `DistributiveOmit` applies `Omit` to each member
+ * individually, so `DistributiveOmit<A | B, K>` is `Omit<A, K> | Omit<B, K>` and the union
+ * (and its discriminant) survives.
+ */
+export type DistributiveOmit<T, K extends keyof never> = T extends unknown ? Omit<T, K> : never;