feat: introduce CasePathResolver

[tbouffard]

This new class is dedicated to path resolution of a single instance/case of a process.

Given a set of elements considered as completed, it is currently able to compute the edges between the provided shapes and the shapes around the provided edges.
This is the first step towards the implementation of more intelligent computing in the future.

In addition

• refactor the constructor of PathResolver: it now only accepts a ElementsRegistry parameter Previously, it required a BpmnElementsRegistry object which is not needed as the implementation only needs to access to the methods related to the model.
• main README: add link to the sources of the demo

Covers #16
Closes #22
Covers #24

Notes about the types introduced in this PR

The types of the parameter and the returned value are defined to correspond to the state of the final implementation as it is known today. There should be no discussion of types in this PR as the API is not finalized.
What follows is the current proposal with an overview of the structure. It does not mean that the final implementation will be like this (in particular, do not debate now about a pseudo duplication in the type definition, it is too early as the types may change).

export type CasePathResolverInput = {
    /**
     * The IDs of elements (flowNodes/shapes and flows/edges) that are already completed. Non-existing ids will be silently ignored.
     *
     * `Completed` means that the element has been fully executed or definitively cancelled (for BPM engine that supports it and allow instance continuation of cancelled elements).
     * No further user action or automation will update the element.
     */
    completedIds: string[];

    // see see https://github.com/process-analytics/bv-experimental-add-ons/issues/16
    pendingIds?: string[];
};

export type CasePathResolverOutput = {
    /**
     * The `BpmnSemantic` objects retrieved from the model that relate to the ids passed in {@link CasePathResolverInput}.
     */
    provided: {
        completed: {
            shapes: ShapeBpmnSemantic[];
            edges: EdgeBpmnSemantic[];
        };
        // It is not sure that we will let configure pending edges, see https://github.com/process-analytics/bv-experimental-add-ons/issues/16
        pending?: {
            shapes: ShapeBpmnSemantic[];
            edges: EdgeBpmnSemantic[];
        };
    };
    computed: {
        completed: {
            shapes: ShapeBpmnSemantic[];
            edges: EdgeBpmnSemantic[];
        };
        // This may require a more complex type if we want to provide information about why the elements are considered as candidates only
        // We may also split pending and completed elements
        // See https://github.com/process-analytics/bv-experimental-add-ons/issues/24
        candidates: {
            shapes: ShapeBpmnSemantic[];
            edges: EdgeBpmnSemantic[];
        };
    };
};

[github-actions]

♻️ PR Preview d065c70 has been successfully destroyed since this PR has been closed.

_{🤖 By surge-preview}

[tbouffard]

thought: IMHO this is a bug in bpmn-visualization that we should fix. It applies to all methods of ElementsRegistry taking ids or kinds.
What do you think @csouchet?
If so, I will create an issue.

[csouchet]

Indeed, the bpmn-visualization APIs should check the uniqueness of the parameter

[tbouffard]

Fine, before merging this PR, I am going to create a dedicated issue in bpmn-visualization and another one in bv-experimental-add-ons to update the implementation when the fix is available in a new release of bpmn-visualization.

[tbouffard]

Bug created: process-analytics/bpmn-visualization-js#2921
Refactor task created: #150

[tbouffard]

Putting in draft, waiting for creating issues related to duplicated results returned by the bpmn-visualization API.
[UPDATE] issues created, so ready for merge.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication