@codex-ts/core-lib 1.1.5 → 2.0.0

package/lib/workflow-engine/workflow-engine.models.d.ts

@@ -0,0 +1,236 @@
+/**
+ * Types mirroring `workflow-engine-lib`'s REST contract (`WorkflowDtos.java`), field-for-field.
+ *
+ * This is a separate concept from this library's older `Workflow`/`BaseTask` models, which
+ * targeted a different, now-removed Java controller (`microservice-starter-lib`'s
+ * Spring-State-Machine-based `BaseWorkflowController`/`BaseTaskController`, deleted in favor of
+ * `workflow-engine-lib`). See those models' `@deprecated` notices for the distinction.
+ */
+/** Lifecycle state of a task (`domain/task/TaskState.java`). */
+export type TaskState = 'CREATED' | 'ASSIGNED' | 'CLAIMED' | 'STARTED' | 'COMPLETED' | 'REJECTED' | 'CANCELLED';
+/** Queue ordering. */
+export type TaskPriority = 'LOW' | 'NORMAL' | 'HIGH' | 'CRITICAL';
+/** Lifecycle status of a workflow instance (`domain/instance/InstanceStatus.java`). */
+export type InstanceStatus = 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
+/** How urgently an attribute's value should read. */
+export type Severity = 'critical' | 'warn' | 'ok';
+/** Which queue view to load. */
+export type QueueView = 'my' | 'team' | 'completed' | 'overdue';
+/** The group name whose attributes belong in the queue row rather than a detail panel. */
+export declare const WORKFLOW_PRIMARY_GROUP = "primary";
+/**
+ * One display attribute captured on a task when it was raised, or declared on a business object
+ * type (`WorkflowDtos.AttributeResponse`). `value` is only ever populated on a task snapshot —
+ * declaration-only attributes (e.g. from `BusinessObject.attributes`) always carry `value: null`.
+ */
+export interface WorkflowTaskAttribute {
+    key: string;
+    label: string;
+    value: string | null;
+    type: 'TEXT' | 'NUMBER' | 'MONEY' | 'DATE' | 'DATETIME' | 'BOOLEAN' | 'ENUM';
+    group: string;
+    order: number;
+    severity: Severity | null;
+}
+/** A unit of work (`WorkflowDtos.TaskResponse`). */
+export interface WorkflowTask {
+    id: string;
+    instanceId: string;
+    nodeKey: string;
+    type: 'HUMAN' | 'SYSTEM';
+    state: TaskState;
+    name: string;
+    formKey: string | null;
+    assigneeType: string | null;
+    assignee: string | null;
+    claimedBy: string | null;
+    priority: TaskPriority;
+    dueDate: string | null;
+    slaMinutes: number | null;
+    outcome: string | null;
+    createdAt: string;
+    claimedAt: string | null;
+    startedAt: string | null;
+    completedAt: string | null;
+    completedBy: string | null;
+    definitionKey: string | null;
+    category: string | null;
+    subject: string | null;
+    businessObject: string | null;
+    businessKey: string | null;
+    /** Worst severity across all attributes, for a single row-level indicator. */
+    severity: Severity | null;
+    attributes: WorkflowTaskAttribute[];
+}
+/** One execution of a workflow (`WorkflowDtos.InstanceResponse`). */
+export interface WorkflowInstance {
+    id: string;
+    definitionKey: string;
+    versionNumber: number;
+    businessKey: string | null;
+    status: InstanceStatus;
+    currentNodeKey: string | null;
+    variables: Record<string, unknown>;
+    startedBy: string | null;
+    startedAt: string;
+    completedAt: string | null;
+    failureReason: string | null;
+}
+/** One entry in the audit trail (`WorkflowDtos.AuditResponse`). */
+export interface WorkflowAuditEntry {
+    id: string;
+    instanceId: string;
+    taskId: string | null;
+    nodeKey: string | null;
+    action: string;
+    actor: string | null;
+    occurredAt: string;
+    detail: Record<string, unknown>;
+}
+/** A workflow definition (`WorkflowDtos.DefinitionResponse`). */
+export interface WorkflowDefinitionSummary {
+    id: string;
+    key: string;
+    name: string;
+    description: string | null;
+    category: string | null;
+    businessObject: string | null;
+}
+/** One deployed version of a workflow, without its authored document (`WorkflowDtos.VersionResponse`). */
+export interface WorkflowVersionSummary {
+    id: string;
+    definitionKey: string;
+    versionNumber: number;
+    status: string;
+    nodeCount: number;
+    deployedBy: string | null;
+    deployedAt: string;
+}
+/** One deployed version of a workflow, including its authored document (`WorkflowDtos.VersionDetailResponse`). */
+export interface WorkflowVersionDetail {
+    id: string;
+    definitionKey: string;
+    versionNumber: number;
+    status: string;
+    definition: string;
+    deployedBy: string | null;
+    deployedAt: string;
+}
+/** A registered business object type (`WorkflowDtos.BusinessObjectResponse`). */
+export interface BusinessObject {
+    id: string;
+    code: string;
+    name: string;
+    description: string | null;
+    category: string | null;
+    keyLabel: string;
+    active: boolean;
+    attributes: WorkflowTaskAttribute[];
+    workflows: string[];
+}
+/** A registered form under a business object (`WorkflowDtos.FormResponse`). */
+export interface WorkflowForm {
+    id: string;
+    businessObject: string | null;
+    formKey: string;
+    name: string;
+    version: number;
+    schema: string | null;
+    active: boolean;
+    createdBy: string | null;
+    createdAt: string;
+}
+/** A page of results, as returned by the engine's queue endpoints (`WorkflowDtos.PageResponse`). */
+export interface WorkflowPage<T> {
+    content: T[];
+    pageNumber: number;
+    pageSize: number;
+    totalElements: number;
+    totalPages: number;
+}
+/** An engine error response (`WorkflowDtos.ErrorResponse`). */
+export interface WorkflowErrorResponse {
+    error: string;
+    message: string;
+    timestamp: string;
+}
+/** Request body for deploying a workflow definition. */
+export interface DeployWorkflowRequest {
+    key: string;
+    name?: string;
+    description?: string;
+    category?: string;
+    definition: string;
+    businessObject?: string;
+    activate?: boolean;
+}
+/** Request body for starting a new instance. */
+export interface StartInstanceRequest {
+    definitionKey: string;
+    versionNumber?: number;
+    businessKey?: string;
+    variables?: Record<string, unknown>;
+}
+/** Request body for completing or rejecting a task. */
+export interface CompleteTaskRequest {
+    outcome?: string;
+    variables?: Record<string, unknown>;
+    comment?: string;
+}
+/** Request body for reassigning a task. */
+export interface ReassignTaskRequest {
+    assigneeType: string;
+    assignee: string;
+}
+/** Request body for cancelling an instance. */
+export interface CancelInstanceRequest {
+    reason?: string;
+}
+/** Request body for signalling an external event to an instance. */
+export interface SignalEventRequest {
+    eventName: string;
+    variables?: Record<string, unknown>;
+}
+/** Request body for setting instance variables directly. */
+export interface SetVariablesRequest {
+    variables?: Record<string, unknown>;
+}
+/** Search criteria for `POST /workflow/queue/search`. */
+export interface QueueSearchCriteria {
+    definitionKey?: string;
+    nodeKey?: string;
+    claimedBy?: string;
+    searchText?: string;
+    /** ISO instant. */
+    dueBefore?: string;
+    minPriority?: TaskPriority;
+    states?: TaskState[];
+    types?: Array<'HUMAN' | 'SYSTEM'>;
+    assignees?: string[];
+}
+/** One declared attribute in a business-object registration request. */
+export interface RegisterAttributeRequest {
+    key: string;
+    label?: string;
+    type?: string;
+    group?: string;
+    order?: number;
+    valueTemplate?: string;
+    severityExpression?: string;
+}
+/** Request body for registering a business object type. */
+export interface RegisterBusinessObjectRequest {
+    code: string;
+    name?: string;
+    description?: string;
+    category?: string;
+    keyLabel?: string;
+    attributes?: RegisterAttributeRequest[];
+}
+/** Request body for registering a form under a business object. */
+export interface RegisterFormRequest {
+    formKey: string;
+    name?: string;
+    schema?: string;
+    activate?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codex-ts/core-lib",
-  "version": "1.1.5",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "peerDependencies": {
@@ -26,4 +26,4 @@
       "default": "./fesm2022/codex-ts-core-lib.mjs"
     }
   }
-}
+}

package/public-api.d.ts

@@ -1,40 +1,60 @@
-export * from './lib/constants/app.constants';
-export * from './lib/constants/app.messages';
-export * from './lib/enums/component-context.enum';
-export * from './lib/enums/tabbed-form-type.enum';
-export * from './lib/enums/task-role.enum';
+export * from './lib/components/base-form.component';
+export * from './lib/components/base-list-page.component';
+export * from './lib/components/base-list-tabbed-form.component';
+export * from './lib/components/base-page.component';
+export * from './lib/components/base-tabbed-form.component';
+export * from './lib/components/base-table.component';
+export * from './lib/components/base-task-dashboard.component';
+export * from './lib/components/base-task-details.component';
+export * from './lib/keycloak/keycloak-config.interface';
+export * from './lib/keycloak/keycloak.interface';
+export * from './lib/keycloak/keycloak-service.token';
+export * from './lib/keycloak/keycloak.guard';
+export * from './lib/keycloak/keycloak.providers';
+export * from './lib/keycloak/keycloak.service';
+export * from './lib/keycloak/keycloak.token';
+export * from './lib/models/department.interface';
+export * from './lib/services/master-data-service.interface';
+export * from './lib/services/base-error.service';
+export * from './lib/services/base-entity.service';
+export * from './lib/services/base-task.service';
+export * from './lib/services/entity-service.interface';
+export * from './lib/services/task-entity-service.interface';
+export * from './lib/services/entity-service.interface';
+export * from './lib/services/entity-registry.service';
+export * from './lib/services/enum-registry.service';
+export * from './lib/services/form.service';
+export * from './lib/services/formly-config.service';
+export * from './lib/services/http-utility.service';
+export * from './lib/services/notification.service';
+export * from './lib/services/reference-data-provider.service';
+export * from './lib/services/utils.service';
+export * from './lib/pipes/indian-date.pipe';
 export * from './lib/models/base.model';
-export * from './lib/models/base-task.model';
 export * from './lib/models/base-request.model';
 export * from './lib/models/base-response.model';
+export * from './lib/models/base-task.model';
+export * from './lib/models/base.comment.model';
 export * from './lib/models/base-create-request.model';
 export * from './lib/models/base-update-request.model';
-export * from './lib/models/pagination/page.interface';
+export * from './lib/models/pagination/filter-criteria.interface';
+export * from './lib/models/pagination/table-column-datatype.enum';
 export * from './lib/models/pagination/page-request.interface';
-export { KEYCLOAK_CONFIG } from './lib/keycloak/keycloak.token';
-export * from './lib/keycloak/keycloak-config.interface';
-export * from './lib/keycloak/keycloak.service';
-export { provideKeycloak } from './lib/keycloak/keycloak.providers';
-export { KeycloakAuthGuard } from './lib/keycloak/keycloak.guard';
-export * from './lib/services/http-utility.service';
-export * from './lib/services/utils.service';
-export * from './lib/services/notification.service';
-export * from './lib/services/entity.service';
-export * from './lib/services/base-crud.service';
-export * from './lib/services/base-task.service';
-export * from './lib/services/formly-config.service';
-export * from './lib/services/form.service';
+export * from './lib/models/pagination/page.interface';
+export * from './lib/models/pagination/sort-criteria.interface';
+export * from './lib/enums/component-context.enum';
+export * from './lib/enums/tabbed-form-type.enum';
+export * from './lib/enums/task-role.enum';
+export * from './lib/constants/app.constants';
+export * from './lib/constants/app.messages';
 export * from './lib/components/formly/core-formly.module';
-export * from './lib/components/base-form.component';
-export * from './lib/components/base-page.component';
-export * from './lib/components/base-list-page.component';
-export * from './lib/components/base-tabbed-form.component';
-export * from './lib/components/base-list-tabbed-form.component';
-export * from './lib/components/base-task-details.component';
-export * from './lib/components/base-task-dashboard.component';
-export * from './lib/states/form.state';
-export * from './lib/states/form-component.state';
-export * from './lib/states/tabbed-form.state';
-export * from './lib/states/list-tabbed-form.state';
-export * from './lib/services/reference-data-provider.service';
-export * from './lib/pipes/indian-date.pipe';
+export * from './lib/components/formly/field.interface';
+export * from './lib/components/formly/form-field.wrapper';
+export * from './lib/components/formly/formly.constants';
+export * from './lib/components/formly/primeng-formly.module';
+export * from './lib/validators/common-validators';
+export * from './lib/components/keycloak-error-banner/keycloak-error-page.component';
+export * from './lib/components/not-found/not-found.component';
+export * from './lib/components/unauthorized/unauthorized.component';
+export * from './lib/workflow-engine/workflow-engine.models';
+export * from './lib/workflow-engine/workflow-engine-api.service';

package/lib/services/base-crud.service.d.ts

@@ -1,36 +0,0 @@
-import { Observable } from 'rxjs';
-import { HttpUtilityService } from './http-utility.service';
-import { UtilsService } from './utils.service';
-import { MessageService } from 'primeng/api';
-import { Page } from '../models/pagination/page.interface';
-import { PageRequest } from '../models/pagination/page-request.interface';
-import { EntityService } from './entity.service';
-export declare abstract class BaseCrudService<T extends {
-    uuid: string;
-}> implements EntityService<T> {
-    protected httpUtility: HttpUtilityService;
-    protected utilsService: UtilsService;
-    protected resourcePath: string;
-    protected backendBaseUrl: string;
-    protected messageService: MessageService | undefined;
-    get loading$(): Observable<boolean>;
-    protected apiUrl: string;
-    /**
-     * Creates an instance of BaseCrudService.
-     * @param httpUtility - Service for making HTTP requests
-     * @param utilsService - Utility service for common operations
-     * @param resourcePath - API resource path (e.g., 'customers', 'products')
-     * @param backendBaseUrl - Base URL for the backend API
-     * @param messageService - Optional service for showing messages
-     */
-    protected constructor(httpUtility: HttpUtilityService, utilsService: UtilsService, resourcePath: string, backendBaseUrl: string, messageService: MessageService | undefined);
-    /**
-     * Joins URL parts ensuring no double slashes
-     */
-    private joinUrls;
-    getAll(pageRequest?: PageRequest): Observable<Page<T>>;
-    getById(uuid: string): Observable<T>;
-    create(entity: Omit<T, 'uuid'>): Observable<T>;
-    update(uuid: string, entity: Omit<T, 'uuid'>): Observable<T>;
-    delete(uuid: string): Observable<void>;
-}

package/lib/services/entity.service.d.ts

@@ -1,9 +0,0 @@
-import { Observable } from 'rxjs';
-/**
- * Interface for basic CRUD operations that all entity services must implement
- */
-export interface EntityService<T> {
-    create(data: Omit<T, 'uuid'>): Observable<T>;
-    update(uuid: string, data: Omit<T, 'uuid'>): Observable<T>;
-    getById(uuid: string): Observable<T>;
-}