@codex-ts/core-lib 1.1.6 → 2.0.0

package/lib/components/base-task-dashboard.component.d.ts

@@ -10,6 +10,11 @@ import * as i0 from "@angular/core";
  * Base component for all task dashboard components in the application.
  * Provides common functionality for task management operations while
  * inheriting table functionality from BaseTableComponent.
+ *
+ * @deprecated Depends on {@link TaskEntityService}, which targets a Java controller
+ * (`BaseTaskController`) that no longer exists — see that interface's `@deprecated` note. Build
+ * queue/dashboard UIs against `WorkflowEngineApiService` from `workflow-engine/` instead, which
+ * targets `workflow-engine-lib`'s actual `/workflow/queue` endpoints.
  */
 export declare abstract class BaseTaskDashboardComponent<T extends BaseTask, S extends string = string, E extends string = string> extends BaseTableComponent<T> {
     protected entityService: TaskEntityService<T, S, E>;

package/lib/models/base-task.model.d.ts

@@ -1,5 +1,10 @@
 import { Workflow } from './workflow.model';
 import { BaseComment } from './base.comment.model';
+/**
+ * @deprecated Models `io.codex.library.core.task.BaseTaskDto`, paired with the same removed
+ * controller as {@link Workflow} — see that interface's `@deprecated` note. Use `WorkflowTask`
+ * from `workflow-engine/` instead.
+ */
 export interface BaseTask<S = string, C = BaseComment> extends Workflow<S, C> {
     title: string;
     description: string;

package/lib/models/workflow.model.d.ts

@@ -1,5 +1,14 @@
 import { BaseEntity } from './base.entity.model';
 import { BaseComment } from './base.comment.model';
+/**
+ * @deprecated Models `io.codex.library.core.task.WorkflowDto`, which paired with
+ * `microservice-starter-lib`'s Spring-State-Machine-based `BaseWorkflowController`. That
+ * controller was deleted (see `WORKFLOW_ENGINE_MIGRATION.md`) in favor of `workflow-engine-lib`,
+ * a completely different engine with its own REST API and its own Angular client — see
+ * `WorkflowTask`/`WorkflowInstance`/`WorkflowEngineApiService` in `workflow-engine/`. Nothing in
+ * this codebase serves the endpoints this interface's shape assumes; kept only for source
+ * compatibility with any existing consumer, not as a working feature.
+ */
 export interface Workflow<S = string, C = BaseComment> extends BaseEntity {
     status: S;
     comments: C[];

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

@@ -11,6 +11,13 @@ import * as i0 from "@angular/core";
 /**
  * Base service for task-related operations that extends the BaseCrudService.
  * Implements endpoints defined in Java BaseTaskController.
+ *
+ * @deprecated `BaseTaskController` (the Java controller this service's `sendEvent`/`PUT
+ * /{uuid}/event/{event}` call targets) no longer exists — it was deleted along with
+ * `microservice-starter-lib`'s Spring-State-Machine-based workflow subsystem in favor of
+ * `workflow-engine-lib`. Calling `sendEvent` against any current backend will 404. Use
+ * `WorkflowEngineApiService` from `workflow-engine/` instead, which targets the actual current
+ * engine API (`claim`/`unclaim`/`start`/`complete`/`reject`/`reassign` on `/workflow/tasks`).
  */
 export declare abstract class BaseTaskService<T extends BaseTask, AU = any, S extends string = string, E extends string = string> extends BaseEntityService<T> implements TaskEntityService<T, S, E> {
     protected httpUtility: HttpUtilityService;

package/lib/services/http-utility.service.d.ts

@@ -16,7 +16,10 @@ export declare class HttpUtilityService {
     private messageService?;
     private loading;
     loading$: Observable<boolean>;
+    private inFlight;
     constructor(http: HttpClient, messageService?: MessageService | undefined);
+    private startLoading;
+    private endLoading;
     /**
      * Perform a GET request with enhanced options
      * @param url The endpoint URL

package/lib/services/task-entity-service.interface.d.ts

@@ -6,6 +6,9 @@ import { BaseTask } from "../models/base-task.model";
  * @template T - The entity type (must extend BaseTaskModel)
  * @template S - The status enum type (for task status)
  * @template E - The event enum type (for task events)
+ *
+ * @deprecated Paired with {@link BaseTaskService}, which targets a Java controller that no
+ * longer exists — see that class's `@deprecated` note. Use `WorkflowEngineApiService` instead.
  */
 export interface TaskEntityService<T extends BaseTask, S extends string = string, E extends string = string> extends EntityService<T> {
     /**

package/lib/workflow-engine/workflow-engine-api.service.d.ts

@@ -0,0 +1,104 @@
+import { Observable } from 'rxjs';
+import { MessageService } from 'primeng/api';
+import { HttpUtilityService } from '../services/http-utility.service';
+import { UtilsService } from '../services/utils.service';
+import { BusinessObject, CancelInstanceRequest, CompleteTaskRequest, DeployWorkflowRequest, QueueSearchCriteria, QueueView, ReassignTaskRequest, RegisterBusinessObjectRequest, RegisterFormRequest, SetVariablesRequest, SignalEventRequest, StartInstanceRequest, WorkflowAuditEntry, WorkflowDefinitionSummary, WorkflowForm, WorkflowInstance, WorkflowPage, WorkflowTask, WorkflowVersionDetail, WorkflowVersionSummary } from './workflow-engine.models';
+/**
+ * Client for `workflow-engine-lib`'s REST API — the data-driven engine that replaced
+ * `microservice-starter-lib`'s Spring-State-Machine-based workflow subsystem.
+ *
+ * Follows this library's established DI convention (see {@link BaseEntityService}): not
+ * `providedIn: 'root'`, constructed with the backend base URL by the consuming application —
+ * *
+ * ```ts
+ * providers: [{
+ *   provide: WorkflowEngineApiService,
+ *   useFactory: (http: HttpUtilityService, utils: UtilsService, msg: MessageService) =>
+ *     new WorkflowEngineApiService(http, utils, 'https://api.example.com/workflow', msg),
+ *   deps: [HttpUtilityService, UtilsService, MessageService],
+ * }]
+ * ```
+ *
+ * Every method maps one-to-one onto an engine endpoint; nothing here is business-specific.
+ *
+ * Deliberately not decorated with {@code @Injectable()} — like {@link BaseEntityService}, this
+ * class is always provided via an explicit `useFactory`/`useClass` provider (see above), never
+ * auto-constructed by Angular's injector, so its constructor isn't required to be fully
+ * DI-resolvable (`backendBaseUrl: string` isn't a valid injection token on its own).
+ */
+export declare class WorkflowEngineApiService {
+    protected httpUtility: HttpUtilityService;
+    protected utilsService: UtilsService;
+    protected backendBaseUrl: string;
+    protected messageService: MessageService | undefined;
+    protected apiUrl: string;
+    /**
+     * Creates the client.
+     *
+     * @param httpUtility     HTTP requests, loading state, standardised error handling
+     * @param utilsService    UUID validation
+     * @param backendBaseUrl  base URL of the service hosting `workflow-engine-lib`, e.g.
+     *                        `https://api.example.com/workflow`
+     * @param messageService  optional, shown on client-side validation failures
+     */
+    constructor(httpUtility: HttpUtilityService, utilsService: UtilsService, backendBaseUrl: string, messageService: MessageService | undefined);
+    private requireUuid;
+    /** Finds a task by id. `GET /tasks/{id}` */
+    getTask(id: string): Observable<WorkflowTask>;
+    /** Claims a task out of a shared queue. `POST /tasks/{id}/claim` */
+    claimTask(id: string): Observable<WorkflowTask>;
+    /** Releases a claim, returning the task to its queue. `POST /tasks/{id}/unclaim` */
+    unclaimTask(id: string): Observable<WorkflowTask>;
+    /** Marks work on a task as actively started. `POST /tasks/{id}/start` */
+    startTask(id: string): Observable<WorkflowTask>;
+    /** Completes a task and resumes its workflow. `POST /tasks/{id}/complete` */
+    completeTask(id: string, request?: CompleteTaskRequest): Observable<WorkflowTask>;
+    /** Rejects a task, resuming its workflow down a different path. `POST /tasks/{id}/reject` */
+    rejectTask(id: string, request?: CompleteTaskRequest): Observable<WorkflowTask>;
+    /** Reassigns a task to a different subject. `POST /tasks/{id}/reassign` */
+    reassignTask(id: string, request: ReassignTaskRequest): Observable<WorkflowTask>;
+    /** Starts a new workflow instance. `POST /instances` */
+    startInstance(request: StartInstanceRequest): Observable<WorkflowInstance>;
+    /** Finds an instance by id. `GET /instances/{id}` */
+    getInstance(id: string): Observable<WorkflowInstance>;
+    /** Finds instances by business key. `GET /instances?businessKey=...` */
+    findInstancesByBusinessKey(businessKey: string): Observable<WorkflowInstance[]>;
+    /** Loads an instance's audit history, oldest first. `GET /instances/{id}/history` */
+    instanceHistory(id: string): Observable<WorkflowAuditEntry[]>;
+    /** Reads an instance's current variables. `GET /instances/{id}/variables` */
+    getInstanceVariables(id: string): Observable<Record<string, unknown>>;
+    /** Sets or replaces instance variables outside of any node execution. `PUT /instances/{id}/variables` */
+    setInstanceVariables(id: string, request: SetVariablesRequest): Observable<WorkflowInstance>;
+    /** Signals an external event to a waiting instance. `POST /instances/{id}/signal` */
+    signalInstance(id: string, request: SignalEventRequest): Observable<WorkflowInstance>;
+    /** Cancels a running instance and withdraws its open tasks. `POST /instances/{id}/cancel` */
+    cancelInstance(id: string, request?: CancelInstanceRequest): Observable<WorkflowInstance>;
+    /** Deploys a workflow definition, creating a new immutable version. `POST /definitions` */
+    deployDefinition(request: DeployWorkflowRequest): Observable<WorkflowVersionSummary>;
+    /** Lists every workflow definition. `GET /definitions` */
+    listDefinitions(): Observable<WorkflowDefinitionSummary[]>;
+    /** Finds a definition by key. `GET /definitions/{key}` */
+    getDefinition(key: string): Observable<WorkflowDefinitionSummary>;
+    /** Lists every deployed version of a definition. `GET /definitions/{key}/versions` */
+    listVersions(key: string): Observable<WorkflowVersionSummary[]>;
+    /** Loads the active version's authored document. `GET /definitions/{key}/versions/active` */
+    activeVersion(key: string): Observable<WorkflowVersionDetail>;
+    /** Activates a specific version. `POST /definitions/{key}/versions/{versionNumber}/activate` */
+    activateVersion(key: string, versionNumber: number): Observable<WorkflowVersionSummary>;
+    /** Loads one of the queue views. `GET /queue/{view}` */
+    queue(view: QueueView, page?: number, size?: number): Observable<WorkflowPage<WorkflowTask>>;
+    /** Searches the queue with structured criteria. `POST /queue/search` */
+    searchQueue(criteria?: QueueSearchCriteria, page?: number, size?: number): Observable<WorkflowPage<WorkflowTask>>;
+    /** Registers a business object type, or updates one with the same code. `POST /business-objects` */
+    registerBusinessObject(request: RegisterBusinessObjectRequest): Observable<BusinessObject>;
+    /** Lists every registered business object. `GET /business-objects` */
+    listBusinessObjects(): Observable<BusinessObject[]>;
+    /** Finds one business object, including the workflows bound to it. `GET /business-objects/{code}` */
+    getBusinessObject(code: string): Observable<BusinessObject>;
+    /** Registers a new version of a form under a business object. `POST /business-objects/{code}/forms` */
+    registerForm(code: string, request: RegisterFormRequest): Observable<WorkflowForm>;
+    /** Lists every form registered under a business object. `GET /business-objects/{code}/forms` */
+    listForms(code: string): Observable<WorkflowForm[]>;
+    /** Finds the active form version a new task would render. `GET /business-objects/{code}/forms/{formKey}` */
+    activeForm(code: string, formKey: string): Observable<WorkflowForm>;
+}

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.6",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "peerDependencies": {

package/public-api.d.ts

@@ -56,3 +56,5 @@ 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';