@flusys/nestjs-entity-builder 9.1.0 → 9.1.1

package/dtos/definition-bundle.dto.d.ts

@@ -0,0 +1,57 @@
+import { EntityStatus } from '../enums/entity-status.enum.js';
+import { FieldType } from '../enums/field-type.enum.js';
+import { type IFlowEdge, type IFlowNode } from '../flow-engine/flow.types.js';
+import { DEFINITION_BUNDLE_FORMAT, DEFINITION_BUNDLE_VERSION } from '../interfaces/definition-bundle.interface.js';
+export declare class BundleFieldDto {
+    id: string;
+    code: string;
+    label: string;
+    fieldType: FieldType;
+    nullable: boolean;
+    unique: boolean;
+    isIndexed: boolean;
+    defaultValue: unknown;
+    validationRules: Record<string, unknown> | null;
+    selectOptions: unknown[] | null;
+    relationTarget: string | null;
+    order: number;
+    uiConfig: Record<string, unknown> | null;
+    isSearchable: boolean;
+    deprecated: boolean;
+}
+export declare class BundleEntityDto {
+    id: string;
+    code: string;
+    label: string;
+    description: string | null;
+    status: EntityStatus;
+    isSoftDeleteEnabled: boolean;
+    isAuditEnabled: boolean;
+    uiConfig: Record<string, unknown> | null;
+    fields: BundleFieldDto[];
+}
+export declare class BundleFlowDto {
+    name: string;
+    slug: string;
+    description: string | null;
+    isActive: boolean;
+    retainExecutions: number;
+    nodes: IFlowNode[];
+    edges: IFlowEdge[];
+}
+export declare class DefinitionBundleDto {
+    format: typeof DEFINITION_BUNDLE_FORMAT;
+    version: typeof DEFINITION_BUNDLE_VERSION;
+    entities: BundleEntityDto[];
+    flows: BundleFlowDto[];
+}
+export declare class ExportBundleDto {
+    entityCodes?: string[];
+    flowSlugs?: string[];
+}
+export declare class ImportBundleOptionsDto {
+    deprecateMissingFields?: boolean;
+    confirm?: boolean;
+    expectedChecksum?: string;
+    expectedPlanChecksum?: string;
+}

package/dtos/flow.dto.d.ts

@@ -1,19 +1,12 @@
 import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
-import { type FlowAuthMode, type FlowBodyType, type FlowInput, type FlowRunAs, type IFlowEdge, type IFlowInputField, type IFlowNode } from '../flow-engine/flow.types.js';
+import { type IFlowSnapshot } from '../interfaces/flow-definition.interface.js';
+import { type FlowInput, type IFlowEdge, type IFlowNode } from '../flow-engine/flow.types.js';
 export declare class CreateFlowDefinitionDto {
     name: string;
     slug: string;
     description?: string;
     isActive?: boolean;
-    authMode?: FlowAuthMode;
-    permissionCode?: string;
-    runAs?: FlowRunAs;
-    isTransactional?: boolean;
-    timeoutMs?: number;
-    rateLimitPerMinute?: number;
     retainExecutions?: number;
-    bodyType?: FlowBodyType;
-    inputSchema?: IFlowInputField[];
     nodes: IFlowNode[];
     edges: IFlowEdge[];
 }
@@ -26,6 +19,7 @@ export declare class FlowDraftDto extends FlowDraftDto_base {
     name?: string;
     id?: string;
     version?: unknown;
+    draft?: unknown;
     createdAt?: unknown;
     updatedAt?: unknown;
     deletedAt?: unknown;
@@ -52,9 +46,12 @@ export declare class ValidateFlowDto {
 export declare class FlowIdDto {
     flowId: string;
 }
-export declare class CreateFlowApiKeyDto extends FlowIdDto {
-    name: string;
-    expiresAt?: string;
+export declare class PublishFlowDto {
+    id: string;
+    note?: string;
+}
+export declare class FlowVersionRefDto extends FlowIdDto {
+    version: number;
 }
 export declare class IdBodyDto {
     id: string;
@@ -62,6 +59,8 @@ export declare class IdBodyDto {
 export declare class ListFlowExecutionsDto {
     flowId?: string;
     status?: string;
+    trigger?: string;
+    endpointNodeId?: string;
     page?: number;
     pageSize?: number;
 }
@@ -70,17 +69,10 @@ export declare class FlowDefinitionResponseDto extends IdentityResponseDto {
     slug: string;
     description: string | null;
     isActive: boolean;
-    authMode: FlowAuthMode;
-    permissionCode: string | null;
-    runAs: FlowRunAs;
-    isTransactional: boolean;
-    timeoutMs: number;
-    rateLimitPerMinute: number;
     retainExecutions: number;
-    bodyType: FlowBodyType;
-    inputSchema: IFlowInputField[];
     nodes: IFlowNode[];
     edges: IFlowEdge[];
     version: number;
+    draft: IFlowSnapshot | null;
 }
 export {};

package/dtos/index.d.ts

@@ -1,3 +1,4 @@
 export * from './entity-definition.dto.js';
 export * from './field-definition.dto.js';
 export * from './schema-change.dto.js';
+export * from './definition-bundle.dto.js';

package/entities/flow-definition.entity.d.ts

@@ -1,20 +1,14 @@
 import { Identity } from '@flusys/nestjs-shared';
-import type { FlowAuthMode, FlowBodyType, FlowRunAs, IFlowEdge, IFlowInputField, IFlowNode } from '../flow-engine/flow.types.js';
+import type { IFlowEdge, IFlowNode } from '../flow-engine/flow.types.js';
+import type { IFlowSnapshot } from '../interfaces/flow-definition.interface.js';
 export declare class FlowDefinition extends Identity {
     name: string;
     slug: string;
     description: string | null;
     isActive: boolean;
-    authMode: FlowAuthMode;
-    permissionCode: string | null;
-    runAs: FlowRunAs;
-    isTransactional: boolean;
-    timeoutMs: number;
-    rateLimitPerMinute: number;
     retainExecutions: number;
-    bodyType: FlowBodyType;
-    inputSchema: IFlowInputField[];
     nodes: IFlowNode[];
     edges: IFlowEdge[];
     version: number;
+    draft: IFlowSnapshot | null;
 }

package/entities/flow-execution.entity.d.ts

@@ -3,8 +3,11 @@ import type { IFlowTraceEntry } from '../flow-engine/flow-run.types.js';
 export declare class FlowExecution extends Identity {
     flowId: string | null;
     flowSlug: string;
+    flowVersion: number | null;
     status: string;
     trigger: string;
+    endpointNodeId: string | null;
+    endpointPath: string | null;
     mode: string;
     statusCode: number;
     input: Record<string, unknown> | null;

package/entities/flow-version.entity.d.ts

@@ -0,0 +1,10 @@
+import { Identity } from '@flusys/nestjs-shared';
+import type { IFlowSnapshot } from '../interfaces/flow-definition.interface.js';
+export declare class FlowVersion extends Identity {
+    flowId: string;
+    version: number;
+    definition: IFlowSnapshot;
+    note: string | null;
+    publishedAt: Date;
+    publishedById: string | null;
+}

package/entities/index.d.ts

@@ -2,13 +2,13 @@ export * from './entity-definition.entity.js';
 export * from './field-definition.entity.js';
 export * from './schema-change-log.entity.js';
 export * from './flow-definition.entity.js';
-export * from './flow-api-key.entity.js';
 export * from './flow-execution.entity.js';
+export * from './flow-version.entity.js';
 import { EntityDefinition } from './entity-definition.entity.js';
 import { FieldDefinition } from './field-definition.entity.js';
 import { SchemaChangeLog } from './schema-change-log.entity.js';
 import { FlowDefinition } from './flow-definition.entity.js';
-import { FlowApiKey } from './flow-api-key.entity.js';
 import { FlowExecution } from './flow-execution.entity.js';
-export declare const EntityBuilderEntities: (typeof EntityDefinition | typeof FieldDefinition | typeof SchemaChangeLog | typeof FlowDefinition | typeof FlowApiKey | typeof FlowExecution)[];
+import { FlowVersion } from './flow-version.entity.js';
+export declare const EntityBuilderEntities: (typeof EntityDefinition | typeof FieldDefinition | typeof SchemaChangeLog | typeof FlowDefinition | typeof FlowExecution | typeof FlowVersion)[];
 export declare function getEntityBuilderEntities(): typeof EntityBuilderEntities;

package/fesm/21.js

@@ -262,15 +262,9 @@ const FLOW_MESSAGES = {
     SLUG_TAKEN: 'entity_builder.flow.slug.taken',
     RATE_LIMITED: 'entity_builder.flow.rate.limited',
     API_KEY_INVALID: 'entity_builder.flow.api.key.invalid',
-    API_KEY_NOT_FOUND: 'entity_builder.flow.api.key.not.found',
-    API_KEY_CREATE_SUCCESS: 'entity_builder.flow.api.key.create.success',
-    API_KEY_LIST_SUCCESS: 'entity_builder.flow.api.key.list.success',
-    API_KEY_REVOKE_SUCCESS: 'entity_builder.flow.api.key.revoke.success',
-    API_KEY_DELETE_SUCCESS: 'entity_builder.flow.api.key.delete.success',
-    API_KEY_EXPIRED: 'entity_builder.flow.api.key.expired',
-    API_KEY_EXPIRY_IN_PAST: 'entity_builder.flow.api.key.expiry.in.past',
     CALLED_BY_OTHER_FLOWS: 'entity_builder.flow.called.by.other.flows',
     ENDPOINT_CALLED_BY_OTHER_FLOWS: 'entity_builder.flow.endpoint.called.by.other.flows',
+    CALLERS_BROKEN: 'entity_builder.flow.callers.broken',
     EXECUTION_NOT_FOUND: 'entity_builder.flow.execution.not.found',
     EXECUTIONS_SUCCESS: 'entity_builder.flow.executions.success',
     EXECUTION_SUCCESS: 'entity_builder.flow.execution.success',
@@ -287,7 +281,15 @@ const FLOW_MESSAGES = {
     INPUT_BODY_NOT_LIST: 'entity_builder.flow.input.body.not.list',
     INPUT_BODY_ITEM_NOT_OBJECT: 'entity_builder.flow.input.body.item.not.object',
     CHECKS_FAILED: 'entity_builder.flow.checks.failed',
-    PERMISSION_DENIED: 'entity_builder.flow.permission.denied'
+    PERMISSION_DENIED: 'entity_builder.flow.permission.denied',
+    PUBLISH_SUCCESS: 'entity_builder.flow.publish.success',
+    NOTHING_TO_PUBLISH: 'entity_builder.flow.nothing.to.publish',
+    VERSIONS_SUCCESS: 'entity_builder.flow.versions.success',
+    VERSION_SUCCESS: 'entity_builder.flow.version.success',
+    VERSION_NOT_FOUND: 'entity_builder.flow.version.not.found',
+    VERSION_RESTORED: 'entity_builder.flow.version.restored',
+    DRAFT_DISCARDED: 'entity_builder.flow.draft.discarded',
+    NO_DRAFT: 'entity_builder.flow.no.draft'
 };
 /** Why a run was stopped or a node failed (`trace[].error`, `body.messageKey`). */ const FLOW_ERROR_MESSAGES = {
     NO_TRIGGER: 'entity_builder.flow.error.no.trigger',
@@ -323,21 +325,34 @@ const FLOW_MESSAGES = {
     CALLED_FLOW_TOO_DEEP: 'entity_builder.flow.error.called.flow.too.deep',
     CALLED_FLOW_FAILED: 'entity_builder.flow.error.called.flow.failed',
     CALLED_FLOW_FAILED_AT_NODE: 'entity_builder.flow.error.called.flow.failed.at.node',
-    RUN_AS_NOT_ALLOWED: 'entity_builder.flow.error.run.as.not.allowed',
-    FILTER_VALUE_MISSING: 'entity_builder.flow.error.filter.value.missing'
+    FILTER_VALUE_MISSING: 'entity_builder.flow.error.filter.value.missing',
+    TOO_MANY_MESSAGES: 'entity_builder.flow.error.too.many.messages',
+    TOO_MANY_RECIPIENTS: 'entity_builder.flow.error.too.many.recipients',
+    NOTIFICATION_UNAVAILABLE: 'entity_builder.flow.error.notification.unavailable',
+    NOTIFICATION_RECIPIENT_INVALID: 'entity_builder.flow.error.notification.recipient.invalid',
+    NOTIFICATION_COMPANY_INVALID: 'entity_builder.flow.error.notification.company.invalid',
+    NOTIFICATION_BRANCH_INVALID: 'entity_builder.flow.error.notification.branch.invalid',
+    NOTIFICATION_COMPANY_UNAVAILABLE: 'entity_builder.flow.error.notification.company.unavailable',
+    NOTIFICATION_TITLE_EMPTY: 'entity_builder.flow.error.notification.title.empty',
+    NOTIFICATION_FAILED: 'entity_builder.flow.error.notification.failed',
+    EMAIL_UNAVAILABLE: 'entity_builder.flow.error.email.unavailable',
+    EMAIL_ADDRESS_INVALID: 'entity_builder.flow.error.email.address.invalid',
+    EMAIL_SUBJECT_EMPTY: 'entity_builder.flow.error.email.subject.empty',
+    EMAIL_BODY_EMPTY: 'entity_builder.flow.error.email.body.empty',
+    EMAIL_FAILED: 'entity_builder.flow.error.email.failed'
 };
 /** Why a node was not executed in a test run (`output.reasonKey`). */ const FLOW_SKIP_MESSAGES = {
     HTTP: 'entity_builder.flow.skip.http',
     EVENTS: 'entity_builder.flow.skip.events',
+    NOTIFICATION: 'entity_builder.flow.skip.notification',
+    EMAIL: 'entity_builder.flow.skip.email',
+    NO_RECIPIENTS: 'entity_builder.flow.skip.no.recipients',
     COMMIT_DRY_RUN: 'entity_builder.flow.skip.commit.dry.run',
     COMMIT_NO_TRANSACTION: 'entity_builder.flow.skip.commit.no.transaction',
     COMMIT_JOINED: 'entity_builder.flow.skip.commit.joined'
 };
 /** Save-time findings about a flow (`validateFlow`). */ const FLOW_VALIDATION_MESSAGES = {
     SLUG_INVALID: 'entity_builder.flow.validation.slug.invalid',
-    RUN_AS_CALLER_NEEDS_AUTH: 'entity_builder.flow.validation.run.as.caller.needs.auth',
-    RUN_AS_INVALID: 'entity_builder.flow.validation.run.as.invalid',
-    AUTH_MODE_INVALID: 'entity_builder.flow.validation.auth.mode.invalid',
     NO_NODES: 'entity_builder.flow.validation.no.nodes',
     TOO_MANY_NODES: 'entity_builder.flow.validation.too.many.nodes',
     TOO_MANY_EDGES: 'entity_builder.flow.validation.too.many.edges',
@@ -362,8 +377,17 @@ const FLOW_MESSAGES = {
     COMMIT_NOT_TRANSACTIONAL: 'entity_builder.flow.validation.commit.not.transactional',
     COMMIT_IN_LOOP: 'entity_builder.flow.validation.commit.in.loop',
     COMMIT_IN_CALLED_FLOW: 'entity_builder.flow.validation.commit.in.called.flow',
-    PUBLIC_SYSTEM_ENTITY: 'entity_builder.flow.validation.public.system.entity',
     PERMISSION_WITHOUT_USER: 'entity_builder.flow.validation.permission.without.user',
+    KEYLESS_ENTITY: 'entity_builder.flow.validation.keyless.entity',
+    TRIGGER_AUTH_INVALID: 'entity_builder.flow.validation.trigger.auth.invalid',
+    TRIGGER_TRANSACTION_INVALID: 'entity_builder.flow.validation.trigger.transaction.invalid',
+    TRIGGER_TIMEOUT_RANGE: 'entity_builder.flow.validation.trigger.timeout.range',
+    TRIGGER_RATE_LIMIT_RANGE: 'entity_builder.flow.validation.trigger.rate.limit.range',
+    TRIGGER_API_KEY_REQUIRED: 'entity_builder.flow.validation.trigger.api.key.required',
+    TRIGGER_API_KEY_INVALID: 'entity_builder.flow.validation.trigger.api.key.invalid',
+    NODE_FORWARDS_TOKEN: 'entity_builder.flow.validation.node.forwards.token',
+    NODE_ACCESS_TARGET_REQUIRED: 'entity_builder.flow.validation.node.access.target.required',
+    NODE_ACCESS_USER_REQUIRED: 'entity_builder.flow.validation.node.access.user.required',
     INPUT_TOO_MANY: 'entity_builder.flow.validation.input.too.many',
     INPUT_NAME_INVALID: 'entity_builder.flow.validation.input.name.invalid',
     INPUT_NAME_DUPLICATE: 'entity_builder.flow.validation.input.name.duplicate',
@@ -385,6 +409,7 @@ const FLOW_MESSAGES = {
     NODE_CASE_DUPLICATE: 'entity_builder.flow.validation.node.case.duplicate',
     NODE_MAX_ITEMS_RANGE: 'entity_builder.flow.validation.node.max.items.range',
     NODE_LIMIT_RANGE: 'entity_builder.flow.validation.node.limit.range',
+    NODE_SORT_INVALID: 'entity_builder.flow.validation.node.sort.invalid',
     NODE_WRITE_TARGET_INVALID: 'entity_builder.flow.validation.node.write.target.invalid',
     NODE_NOT_FOUND_INVALID: 'entity_builder.flow.validation.node.not.found.invalid',
     NODE_FILTER_REQUIRED: 'entity_builder.flow.validation.node.filter.required',
@@ -409,6 +434,15 @@ const FLOW_MESSAGES = {
     NODE_CHOOSE_METHOD: 'entity_builder.flow.validation.node.choose.method',
     NODE_TIMEOUT_RANGE: 'entity_builder.flow.validation.node.timeout.range',
     NODE_EVENT_NAME_INVALID: 'entity_builder.flow.validation.node.event.name.invalid',
+    NODE_NOTIFICATION_UNAVAILABLE: 'entity_builder.flow.validation.node.notification.unavailable',
+    NODE_NOTIFICATION_OPTION_INVALID: 'entity_builder.flow.validation.node.notification.option.invalid',
+    NODE_NOTIFICATION_COMPANY_UNAVAILABLE: 'entity_builder.flow.validation.node.notification.company.unavailable',
+    NODE_MESSAGE_TARGET_INVALID: 'entity_builder.flow.validation.node.message.target.invalid',
+    NODE_EMAIL_UNAVAILABLE: 'entity_builder.flow.validation.node.email.unavailable',
+    NODE_EMAIL_OPTION_INVALID: 'entity_builder.flow.validation.node.email.option.invalid',
+    NODE_EMAIL_TEMPLATE_REQUIRED: 'entity_builder.flow.validation.node.email.template.required',
+    MESSAGE_AFTER_COMMIT: 'entity_builder.flow.validation.message.after.commit',
+    PUBLIC_MESSAGE: 'entity_builder.flow.validation.public.message',
     NODE_STATUS_2XX_5XX: 'entity_builder.flow.validation.node.status.2xx.5xx',
     REF_BAD_SCOPE: 'entity_builder.flow.validation.ref.bad.scope',
     REF_NODE_MISSING: 'entity_builder.flow.validation.ref.node.missing',
@@ -476,6 +510,22 @@ const FLOW_MESSAGES = {
     THE_URL: 'entity_builder.flow.subject.the.url',
     THE_INPUT_LIST: 'entity_builder.flow.subject.the.input.list',
     THE_RESPONSE: 'entity_builder.flow.subject.the.response',
+    THE_RECIPIENTS: 'entity_builder.flow.subject.the.recipients',
+    THE_TITLE: 'entity_builder.flow.subject.the.title',
+    THE_MESSAGE: 'entity_builder.flow.subject.the.message',
+    THE_COMPANY: 'entity_builder.flow.subject.the.company',
+    THE_COMPANIES: 'entity_builder.flow.subject.the.companies',
+    THE_BRANCHES: 'entity_builder.flow.subject.the.branches',
+    THE_USER: 'entity_builder.flow.subject.the.user',
+    THE_CC: 'entity_builder.flow.subject.the.cc',
+    THE_BCC: 'entity_builder.flow.subject.the.bcc',
+    THE_REPLY_TO: 'entity_builder.flow.subject.the.reply.to',
+    THE_SUBJECT: 'entity_builder.flow.subject.the.subject',
+    THE_BODY: 'entity_builder.flow.subject.the.body',
+    DATA_VALUES: 'entity_builder.flow.subject.data.values',
+    DATA_VALUE: 'entity_builder.flow.subject.data.value',
+    TEMPLATE_VALUES: 'entity_builder.flow.subject.template.values',
+    TEMPLATE_VALUE: 'entity_builder.flow.subject.template.value',
     VARIABLES: 'entity_builder.flow.subject.variables',
     VARIABLE: 'entity_builder.flow.subject.variable',
     FIELDS: 'entity_builder.flow.subject.fields',
@@ -493,6 +543,37 @@ const FLOW_MESSAGES = {
     RESPONSE_VALUES: 'entity_builder.flow.subject.response.values',
     RESPONSE_VALUE: 'entity_builder.flow.subject.response.value'
 };
+/** Promoting entity and flow definitions between environments (export / plan-import / apply-import). */ const BUNDLE_MESSAGES = {
+    SETTINGS_SUCCESS: 'entity_builder.bundle.settings.success',
+    EXPORT_SUCCESS: 'entity_builder.bundle.export.success',
+    PLAN_SUCCESS: 'entity_builder.bundle.plan.success',
+    APPLY_SUCCESS: 'entity_builder.bundle.apply.success',
+    APPLY_PARTIAL: 'entity_builder.bundle.apply.partial',
+    APPLY_BLOCKED: 'entity_builder.bundle.apply.blocked',
+    CHECKSUM_MISMATCH: 'entity_builder.bundle.checksum.mismatch',
+    PLAN_CHANGED: 'entity_builder.bundle.plan.changed',
+    PLAN_CHECKSUM_REQUIRED: 'entity_builder.bundle.plan.checksum.required',
+    ENTITY_DRAFT_IN_BUNDLE: 'entity_builder.bundle.entity.draft.in.bundle',
+    ENTITY_DRAFT_HERE: 'entity_builder.bundle.entity.draft.here',
+    ENTITY_DRAFT_SKIPPED: 'entity_builder.bundle.entity.draft.skipped',
+    RENAME_VIA_TEMPORARY: 'entity_builder.bundle.rename.via.temporary',
+    FILE_REQUIRED: 'entity_builder.bundle.file.required',
+    FILE_INVALID: 'entity_builder.bundle.file.invalid',
+    CONFIRM_REQUIRED: 'entity_builder.bundle.confirm.required',
+    DUPLICATE_ENTITY: 'entity_builder.bundle.duplicate.entity',
+    DUPLICATE_FIELD: 'entity_builder.bundle.duplicate.field',
+    DUPLICATE_FLOW: 'entity_builder.bundle.duplicate.flow',
+    RELATION_TARGET_UNKNOWN: 'entity_builder.bundle.relation.target.unknown',
+    ENTITY_CODE_CHANGED: 'entity_builder.bundle.entity.code.changed',
+    VARIABLE_MISSING: 'entity_builder.bundle.variable.missing',
+    FLOW_SLUG_DELETED: 'entity_builder.bundle.flow.slug.deleted',
+    FLOW_UNPUBLISHED_SKIPPED: 'entity_builder.bundle.flow.unpublished.skipped',
+    FLOW_DRAFT_REPLACED: 'entity_builder.bundle.flow.draft.replaced',
+    FLOW_API_KEY_GENERATED: 'entity_builder.bundle.flow.api.key.generated',
+    STEP_AFTER_EARLIER: 'entity_builder.bundle.step.after.earlier',
+    FLOWS_CHECKED_ON_APPLY: 'entity_builder.bundle.flows.checked.on.apply',
+    DESIGNER_READ_ONLY: 'entity_builder.designer.read.only'
+};
 
 __webpack_require__.d(__webpack_exports__, {
 }, {
@@ -508,6 +589,7 @@ __webpack_require__.d(__webpack_exports__, {
   Vu: SCHEMA_FINDING_MESSAGES,
   aB: SCHEMA_IMPACT_MESSAGES,
   bc: FLOW_SUBJECT_MESSAGES,
+  iX: BUNDLE_MESSAGES,
   j4: GENERIC_RECORD_MESSAGES,
   oc: FIELD_DEFINITION_MESSAGES,
   pL: ENTITY_DEFINITION_MESSAGES,