@owlmeans/flow 0.1.0

package/build/index.js

@@ -0,0 +1,7 @@
+export * from './errors.js';
+export * from './consts.js';
+export * from './state.js';
+export * from './helper.js';
+export * from './i18n.js';
+export * from './flows/index.js';
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,kBAAkB,CAAA"}

package/build/state.d.ts

@@ -0,0 +1,3 @@
+import type { FlowModel, FlowProvider, ShallowFlow } from './types.js';
+export declare const makeFlowModel: (flow: string | ShallowFlow, provider?: FlowProvider) => Promise<FlowModel>;
+//# sourceMappingURL=state.d.ts.map

package/build/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAa,WAAW,EAAE,MAAM,YAAY,CAAA;AAGjF,eAAO,MAAM,aAAa,SAAgB,MAAM,GAAG,WAAW,aAAa,YAAY,KAAG,OAAO,CAAC,SAAS,CAqI1G,CAAA"}

package/build/state.js

@@ -0,0 +1,118 @@
+import { FlowStepError, UnknownFlow, UnknownFlowStep, UnknownTransition } from './errors.js';
+import { serializeState, unserializeState } from './utils/flow.js';
+export const makeFlowModel = async (flow, provider) => {
+    let state = null;
+    if (typeof flow === 'string') {
+        if (provider == null) {
+            throw new UnknownFlow('_provider');
+        }
+        try {
+            flow = await provider(flow);
+            state = {
+                flow: flow.flow,
+                step: flow.initialStep,
+                service: '',
+                ok: true
+            };
+        }
+        catch {
+            state = await unserializeState(flow, provider);
+            flow = await provider(state.flow);
+        }
+    }
+    else {
+        state = {
+            flow: flow.flow,
+            step: flow.initialStep,
+            service: '',
+            ok: true
+        };
+    }
+    const model = {
+        target: service => {
+            state.service = service;
+            return model;
+        },
+        entity: entityId => {
+            state.entityId = entityId;
+            return model;
+        },
+        state: () => state,
+        setState: _state => {
+            state = _state;
+            return model;
+        },
+        payload: () => state.payload ?? {},
+        step: step => flow.steps[step ?? state.step],
+        enter: step => {
+            step = step ?? flow.initialStep;
+            const info = flow.steps[step];
+            if (info.initial !== true) {
+                throw new FlowStepError(`initial:${step}`);
+            }
+            state.step = step;
+            return model;
+        },
+        steps: enter => {
+            if (enter == null) {
+                return Object.values(flow.steps);
+            }
+            if (enter) {
+                return Object.values(flow.steps).filter(s => s.initial);
+            }
+            return Object.values(flow.steps).filter(s => !s.initial);
+        },
+        transitions: explicit => {
+            if (explicit == null) {
+                return Object.values(flow.steps[state.step].transitions);
+            }
+            if (explicit) {
+                return Object.values(flow.steps[state.step].transitions).filter(t => t.explicit);
+            }
+            return Object.values(flow.steps[state.step].transitions).filter(t => !t.explicit);
+        },
+        transition: transition => {
+            const t = flow.steps[state.step].transitions[transition];
+            if (t == null) {
+                throw new UnknownTransition(transition);
+            }
+            return t;
+        },
+        next: () => {
+            const transition = model.transitions().find(t => t.explicit !== true);
+            if (transition == null) {
+                throw new UnknownFlowStep('next');
+            }
+            return transition;
+        },
+        transit: (transition, ok, message, payload) => {
+            const t = model.transition(transition);
+            state.previous = state.step;
+            if (t.reversible !== true) {
+                delete state.previous;
+            }
+            state.step = t.step;
+            state.ok = ok;
+            if (typeof message !== 'string') {
+                payload = message;
+                message = undefined;
+            }
+            if (message != null) {
+                state.message = message;
+            }
+            else if (state.message != null) {
+                delete state.message;
+            }
+            if (payload != null) {
+                state.payload = payload;
+            }
+            else if (state.payload != null) {
+                delete state.payload;
+            }
+            return serializeState(flow, state);
+        },
+        serialize: () => serializeState(flow, state)
+    };
+    return model;
+};
+//# sourceMappingURL=state.js.map

package/build/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAE5F,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAElE,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,IAA0B,EAAE,QAAuB,EAAsB,EAAE;IAC7G,IAAI,KAAK,GAAqB,IAAI,CAAA;IAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,IAAI,WAAW,CAAC,WAAW,CAAC,CAAA;QACpC,CAAC;QACD,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;YAC3B,KAAK,GAAG;gBACN,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,WAAW;gBACtB,OAAO,EAAE,EAAE;gBACX,EAAE,EAAE,IAAI;aACT,CAAA;QACH,CAAC;QAAC,MAAM,CAAC;YACP,KAAK,GAAG,MAAM,gBAAgB,CAAC,IAAc,EAAE,QAAQ,CAAC,CAAA;YACxD,IAAI,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,GAAG;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,OAAO,EAAE,EAAE;YACX,EAAE,EAAE,IAAI;SACT,CAAA;IACH,CAAC;IAED,MAAM,KAAK,GAAc;QACvB,MAAM,EAAE,OAAO,CAAC,EAAE;YAChB,KAAM,CAAC,OAAO,GAAG,OAAO,CAAA;YACxB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,EAAE,QAAQ,CAAC,EAAE;YACjB,KAAM,CAAC,QAAQ,GAAG,QAAQ,CAAA;YAE1B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,KAAK,EAAE,GAAG,EAAE,CAAC,KAAM;QAEnB,QAAQ,EAAE,MAAM,CAAC,EAAE;YACjB,KAAK,GAAG,MAAM,CAAA;YACd,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,EAAE,GAAG,EAAE,CAAC,KAAM,CAAC,OAAO,IAAI,EAAS;QAE1C,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,KAAM,CAAC,IAAI,CAAC;QAE7C,KAAK,EAAE,IAAI,CAAC,EAAE;YACZ,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,WAAW,CAAA;YAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC7B,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;YAC5C,CAAC;YAED,KAAM,CAAC,IAAI,GAAG,IAAI,CAAA;YAClB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,KAAK,EAAE,KAAK,CAAC,EAAE;YACb,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;YACzD,CAAC;YAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;QAC1D,CAAC;QAED,WAAW,EAAE,QAAQ,CAAC,EAAE;YACtB,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACrB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAA;YAC3D,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;YACnF,CAAC;YAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;QACpF,CAAC;QAED,UAAU,EAAE,UAAU,CAAC,EAAE;YACvB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;YACzD,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;gBACd,MAAM,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAA;YACzC,CAAC;YAED,OAAO,CAAC,CAAA;QACV,CAAC;QAED,IAAI,EAAE,GAAG,EAAE;YACT,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAA;YACrE,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAAA;YACnC,CAAC;YAED,OAAO,UAAU,CAAA;QACnB,CAAC;QAED,OAAO,EAAE,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;YAC5C,MAAM,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;YACtC,KAAM,CAAC,QAAQ,GAAG,KAAM,CAAC,IAAI,CAAA;YAE7B,IAAI,CAAC,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC1B,OAAO,KAAM,CAAC,QAAQ,CAAA;YACxB,CAAC;YAED,KAAM,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAA;YACpB,KAAM,CAAC,EAAE,GAAG,EAAE,CAAA;YACd,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,OAAO,GAAG,OAAO,CAAA;gBACjB,OAAO,GAAG,SAAS,CAAA;YACrB,CAAC;YACD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,KAAM,CAAC,OAAO,GAAG,OAAO,CAAA;YAC1B,CAAC;iBAAM,IAAI,KAAM,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBAClC,OAAO,KAAM,CAAC,OAAO,CAAA;YACvB,CAAC;YACD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,KAAM,CAAC,OAAO,GAAG,OAAO,CAAA;YAC1B,CAAC;iBAAM,IAAI,KAAM,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBAClC,OAAO,KAAM,CAAC,OAAO,CAAA;YACvB,CAAC;YAED,OAAO,cAAc,CAAC,IAAI,EAAE,KAAM,CAAC,CAAA;QACrC,CAAC;QAED,SAAS,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,KAAM,CAAC;KAC9C,CAAA;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,100 @@
+import type { ResourceRecord } from '@owlmeans/resource';
+import type { FLOW_RECORD } from './consts.js';
+export interface Flow extends ShallowFlow {
+    config: FlowConfig;
+    prefabs: {
+        [step: string]: string;
+    };
+}
+export interface ShallowFlow {
+    flow: string;
+    initialStep: string;
+    steps: {
+        [key: string]: FlowStep;
+    };
+}
+export interface FlowConfig {
+    queryParam?: string;
+    services?: {
+        [ref: string]: string;
+    };
+    modules?: {
+        [ref: string]: string;
+    };
+    pathes?: {
+        [ref: string]: string;
+    };
+    defaultFlow?: string;
+}
+export interface FlowStep {
+    index: number;
+    step: string;
+    service: string;
+    path?: string;
+    module?: string;
+    initial?: boolean;
+    payloadMap?: {
+        [key: string]: number;
+    };
+    transitions: {
+        [key: string]: FlowTransition;
+    };
+}
+export interface FlowTransition {
+    transition: string;
+    step: string;
+    /**
+     * Whether user can choose this transition as one of possibilities
+     */
+    explicit?: boolean;
+    /**
+     * Whether user may get back
+     */
+    reversible?: boolean;
+}
+export interface FlowState {
+    flow: string;
+    step: string;
+    previous?: string;
+    entityId?: string | null;
+    service: string;
+    payload?: FlowPayload;
+    message?: string;
+    ok: boolean;
+}
+export interface FlowPayload extends Record<symbol | string, string | number | boolean | undefined | null> {
+}
+export interface SerializedFlow {
+    f: string;
+    e?: string;
+    s: string;
+    p?: string;
+    m?: string;
+    o: number;
+}
+export interface FlowModel {
+    target: (service: string) => FlowModel;
+    entity: (entityId: string) => FlowModel;
+    enter: (step?: string) => FlowModel;
+    steps: (enter?: boolean) => FlowStep[];
+    state: () => FlowState;
+    setState: (state: FlowState | null) => FlowModel;
+    payload: <T extends FlowPayload>() => T;
+    step: (step?: string) => FlowStep;
+    transitions: (explicit?: boolean) => FlowTransition[];
+    transition: (transition: string) => FlowTransition;
+    next: () => FlowTransition;
+    transit: (transition: string, ok: boolean, message?: string | FlowPayload, payload?: FlowPayload) => string;
+    serialize: () => string;
+}
+export interface FlowProvider {
+    (flow: string): Promise<Flow>;
+}
+export interface WithFlowConfig {
+    flowConfig?: FlowConfig;
+}
+export interface FlowConfigRecord extends ResourceRecord, ShallowFlow {
+    id: string;
+    recordType: typeof FLOW_RECORD;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,MAAM,EAAE,UAAU,CAAA;IAClB,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAA;CACnC;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACpC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAClC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACtC,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAA;CAC/C;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IAEZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,EAAE,EAAE,OAAO,CAAA;CACZ;AAED,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;CAAI;AAE9G,MAAM,WAAW,cAAc;IAE7B,CAAC,EAAE,MAAM,CAAA;IAET,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV,CAAC,EAAE,MAAM,CAAA;IAET,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV,CAAC,EAAE,MAAM,CAAA;CACV;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,SAAS,CAAA;IACtC,MAAM,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,SAAS,CAAA;IACvC,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,SAAS,CAAA;IACnC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,QAAQ,EAAE,CAAA;IACtC,KAAK,EAAE,MAAM,SAAS,CAAA;IACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,KAAK,SAAS,CAAA;IAChD,OAAO,EAAE,CAAC,CAAC,SAAS,WAAW,OAAO,CAAC,CAAA;IACvC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,QAAQ,CAAA;IACjC,WAAW,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,KAAK,cAAc,EAAE,CAAA;IACrD,UAAU,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,cAAc,CAAA;IAClD,IAAI,EAAE,MAAM,cAAc,CAAA;IAC1B,OAAO,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,MAAM,CAAA;IAC3G,SAAS,EAAE,MAAM,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc,EAAE,WAAW;IACnE,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,OAAO,WAAW,CAAA;CAC/B"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

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

package/build/utils/flow.d.ts

@@ -0,0 +1,4 @@
+import type { FlowProvider, FlowState, ShallowFlow } from '../types.js';
+export declare const serializeState: (flow: ShallowFlow, state: FlowState) => string;
+export declare const unserializeState: (token: string, flowProvider: FlowProvider) => Promise<FlowState>;
+//# sourceMappingURL=flow.d.ts.map

package/build/utils/flow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../src/utils/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAkB,WAAW,EAAE,MAAM,aAAa,CAAA;AAKvF,eAAO,MAAM,cAAc,SAAU,WAAW,SAAS,SAAS,KAAG,MAgCpE,CAAA;AAED,eAAO,MAAM,gBAAgB,UAAiB,MAAM,gBAAgB,YAAY,KAAG,OAAO,CAAC,SAAS,CAkCnG,CAAA"}

package/build/utils/flow.js

@@ -0,0 +1,65 @@
+import { FLOW_SEP, PAYLOAD_SEP } from '../consts.js';
+import { utf8, base64urlnopad } from '@scure/base';
+import { UnknownFlowStep } from '../errors.js';
+export const serializeState = (flow, state) => {
+    const flowBlock = [
+        state.flow,
+        flow.steps[state.step].index.toString()
+    ];
+    if (state.previous != null) {
+        flowBlock.push(flow.steps[state.previous].index.toString());
+    }
+    const serialized = {
+        f: flowBlock.join(FLOW_SEP),
+        s: state.service,
+        o: state.ok ? 1 : 0,
+    };
+    if (state.entityId != null) {
+        serialized.e = state.entityId;
+    }
+    else if (state.entityId === null) {
+        serialized.e = '';
+    }
+    if (state.message != null) {
+        serialized.m = state.message;
+    }
+    if (state.payload != null) {
+        const step = flow.steps[state.step];
+        if (step.payloadMap != null) {
+            serialized.p = Object.entries(step.payloadMap).reduce((list, [key, index]) => {
+                list[index] = state.payload[key] != null ? state.payload[key].toString() : '';
+                return list;
+            }, Array(Object.keys(step.payloadMap).length)).join(PAYLOAD_SEP);
+        }
+    }
+    return base64urlnopad.encode(utf8.decode(JSON.stringify(serialized)));
+};
+export const unserializeState = async (token, flowProvider) => {
+    const serialized = JSON.parse(utf8.encode(base64urlnopad.decode(token)));
+    const [flowAlias, stepIndex, previousIdx] = serialized.f.split(FLOW_SEP, 3);
+    const flow = await flowProvider(flowAlias);
+    const step = Object.values(flow.steps).find(step => step.index === parseInt(stepIndex));
+    if (step == null) {
+        throw new UnknownFlowStep(stepIndex);
+    }
+    const previous = previousIdx != null ? Object.values(flow.steps).find(step => step.index === parseInt(previousIdx)) : undefined;
+    const state = {
+        flow: flow.flow,
+        step: step.step,
+        previous: previous?.step,
+        service: serialized.s,
+        ok: serialized.o === 1,
+    };
+    if (serialized.m != null) {
+        state.message = serialized.m;
+    }
+    if (serialized.e != null) {
+        state.entityId = serialized.e !== '' ? serialized.e : null;
+    }
+    if (serialized.p != null && step.payloadMap != null) {
+        const list = serialized.p.split(PAYLOAD_SEP);
+        state.payload = Object.fromEntries(Object.entries(step.payloadMap).map(([key, index]) => [key, list[index] != null ? list[index] : null]));
+    }
+    return state;
+};
+//# sourceMappingURL=flow.js.map

package/build/utils/flow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.js","sourceRoot":"","sources":["../../src/utils/flow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AACpD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAE9C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAiB,EAAE,KAAgB,EAAU,EAAE;IAC5E,MAAM,SAAS,GAAG;QAChB,KAAK,CAAC,IAAI;QACV,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE;KACxC,CAAA;IACD,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC3B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7D,CAAC;IACD,MAAM,UAAU,GAAmB;QACjC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC3B,CAAC,EAAE,KAAK,CAAC,OAAO;QAChB,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KACpB,CAAA;IACD,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC3B,UAAU,CAAC,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAA;IAC/B,CAAC;SAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QACnC,UAAU,CAAC,CAAC,GAAG,EAAE,CAAA;IACnB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;QAC1B,UAAU,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAA;IAC9B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACnC,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;YAC5B,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAW,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACrF,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,OAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;gBAC/E,OAAO,IAAI,CAAA;YACb,CAAC,EAAE,KAAK,CAAS,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAC1E,CAAC;IACH,CAAC;IAED,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AACvE,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,KAAa,EAAE,YAA0B,EAAsB,EAAE;IACtG,MAAM,UAAU,GAAmB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxF,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;IAC3E,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAA;IAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAA;IACvF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CAAC,SAAS,CAAC,CAAA;IACtC,CAAC;IACD,MAAM,QAAQ,GAAG,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAE/H,MAAM,KAAK,GAAc;QACvB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,QAAQ,EAAE,IAAI;QACxB,OAAO,EAAE,UAAU,CAAC,CAAC;QACrB,EAAE,EAAE,UAAU,CAAC,CAAC,KAAK,CAAC;KACvB,CAAA;IAED,IAAI,UAAU,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACzB,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC,CAAC,CAAA;IAC9B,CAAC;IAED,IAAI,UAAU,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACzB,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC5D,CAAC;IAED,IAAI,UAAU,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;QAC5C,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CACpE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAClE,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/build/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './flow.js';
+//# sourceMappingURL=index.d.ts.map

package/build/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,WAAW,CAAA"}

package/build/utils/index.js

@@ -0,0 +1,2 @@
+export * from './flow.js';
+//# sourceMappingURL=index.js.map

package/build/utils/index.js.map

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@owlmeans/flow",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 162 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@owlmeans/auth": "^0.1.0",
+    "@owlmeans/config": "^0.1.0",
+    "@owlmeans/error": "^0.1.0",
+    "@owlmeans/i18n": "^0.1.0",
+    "@owlmeans/resource": "^0.1.0",
+    "@scure/base": "^1.1.9"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.7",
+    "npm-check": "^6.0.1",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,18 @@
+
+export const FLOW_SEP = ':'
+
+export const PAYLOAD_SEP = ','
+
+export const STD_AUTH_FLOW = '_oa'
+
+export const STD_OIDC_FLOW = '_oidc'
+
+export const STD_STAB_FLOW = '_stb'
+
+export const STD_OIDP_FLOW = '_oidp'
+
+export const TARGET_SERVICE = '-'
+
+export const CFG_FLOW_PREFIX = 'flow'
+
+export const FLOW_RECORD = 'flow'

package/src/errors.ts

@@ -0,0 +1,82 @@
+
+import { ResilientError } from '@owlmeans/error'
+
+export class FlowError extends ResilientError {
+  public static override typeName: string = 'FlowError'
+
+  constructor(message: string = 'error') {
+    super(FlowError.typeName, `flow:${message}`)
+  }
+}
+
+export class FlowUnsupported extends FlowError {
+  public static override typeName: string = `${FlowError.typeName}Unsupported`
+
+  constructor(message: string = 'error') {
+    super(`unsupported:${message}`)
+    this.type = FlowUnsupported.typeName
+  }
+}
+
+export class FlowTargetError extends FlowError {
+  public static override typeName: string = `${FlowError.typeName}Target`
+
+  constructor(message: string = 'error') {
+    super(`target:${message}`)
+    this.type = FlowTargetError.typeName
+  }
+}
+
+export class UnknownFlow extends FlowError {
+  public static override typeName: string = `${FlowError.typeName}Unknown`
+
+  constructor(message: string = 'error') {
+    super(`unknown:${message}`)
+    this.type = UnknownFlow.typeName
+  }
+}
+
+export class FlowStepError extends FlowError {
+  public static override typeName: string = `${FlowError.typeName}Step`
+
+  constructor(message: string = 'error') {
+    super(`step:${message}`)
+    this.type = FlowStepError.typeName
+  }
+}
+
+export class FlowStepMissconfigured extends FlowStepError {
+  public static override typeName: string = `${FlowStepError.typeName}Missconfigured`
+
+  constructor(message: string = 'error') {
+    super(`missconfigured:${message}`)
+    this.type = FlowStepMissconfigured.typeName
+  }
+}
+
+export class UnknownFlowStep extends FlowStepError {
+  public static override typeName: string = `${FlowStepError.typeName}Unknown`
+
+  constructor(message: string = 'error') {
+    super(`unknown:${message}`)
+    this.type = UnknownFlowStep.typeName
+  }
+}
+
+export class UnknownTransition extends FlowStepError {
+  public static override typeName: string = `${FlowStepError.typeName}Transition`
+
+  constructor(message: string = 'error') {
+    super(`transition:${message}`)
+    this.type = UnknownTransition.typeName
+  }
+}
+
+ResilientError.registerErrorClass(FlowError)
+ResilientError.registerErrorClass(FlowUnsupported)
+ResilientError.registerErrorClass(FlowTargetError)
+ResilientError.registerErrorClass(UnknownFlow)
+ResilientError.registerErrorClass(FlowStepError)
+ResilientError.registerErrorClass(FlowStepMissconfigured)
+ResilientError.registerErrorClass(UnknownFlowStep)
+ResilientError.registerErrorClass(UnknownTransition)

package/src/flows/auth.ts

@@ -0,0 +1,157 @@
+import type { ShallowFlow } from '../types.js'
+import { STD_AUTH_FLOW } from '../consts.js'
+
+export enum StdAuthStep {
+  Choice = 'choice',
+  Signup = 'signup',
+  Signin = 'signin',
+  New = 'new',
+  Existing = 'existing',
+  Payment = 'payment',
+  Success = 'success',
+  Target = 'target'
+}
+
+// OwlMeans Authentication Standard Flow 
+/**
+ * @TODO Actually this thing is kept here for the iteration when
+ * OwlMeans ID account may be used without owlmeans.net account.
+ * 
+ * @deprecated
+ */
+export const stdAuthFlow: ShallowFlow = {
+  // naming - preserve space in serialized state
+  flow: STD_AUTH_FLOW,
+  initialStep: StdAuthStep.Choice,
+
+  steps: {
+
+    [StdAuthStep.Choice]: {
+      index: 0,
+      step: StdAuthStep.Choice,
+      service: '$auth',
+      initial: true,
+      module: '$auth.choice',
+      transitions: {
+        [StdAuthStep.Signup]: {
+          transition: StdAuthStep.Signup,
+          step: StdAuthStep.Signup,
+          explicit: true,
+          reversible: true
+        },
+        [StdAuthStep.Signin]: {
+          transition: StdAuthStep.Signin,
+          step: StdAuthStep.Signin,
+          explicit: true,
+          reversible: true
+        },
+      },
+    },
+
+    [StdAuthStep.Signup]: {
+      index: 1,
+      step: StdAuthStep.Signup,
+      service: '$auth',
+      module: '$auth.flow',
+      initial: true,
+      transitions: {
+        [StdAuthStep.New]: {
+          transition: StdAuthStep.New,
+          step: StdAuthStep.New,
+          explicit: true,
+          reversible: true,
+        },
+        [StdAuthStep.Existing]: {
+          transition: StdAuthStep.Existing,
+          step: StdAuthStep.Existing,
+          explicit: true,
+          reversible: true
+        },
+        [StdAuthStep.Signin]: {
+          transition: StdAuthStep.Signin,
+          step: StdAuthStep.Signin,
+          explicit: true,
+          reversible: true
+        },
+      }
+    },
+
+    [StdAuthStep.Signin]: {
+      index: 2,
+      step: StdAuthStep.Signin,
+      service: '$auth',
+      module: '$auth.flow',
+      initial: true,
+      transitions: {
+        [StdAuthStep.Target]: {
+          transition: StdAuthStep.Target,
+          step: StdAuthStep.Target,
+        }
+      }
+    },
+
+    [StdAuthStep.New]: {
+      index: 3,
+      step: StdAuthStep.New,
+      service: '$auth',
+      module: '$auth.flow',
+      initial: true,
+      transitions: {
+        [StdAuthStep.Payment]: {
+          transition: StdAuthStep.Payment,
+          step: StdAuthStep.Payment,
+        }
+      }
+    },
+
+    [StdAuthStep.Existing]: {
+      index: 4,
+      step: StdAuthStep.Existing,
+      service: '$auth',
+      module: '$auth.flow',
+      transitions: {
+        [StdAuthStep.Payment]: {
+          transition: StdAuthStep.Payment,
+          step: StdAuthStep.Payment,
+        }
+      }
+    },
+
+    [StdAuthStep.Payment]: {
+      index: 5,
+      step: StdAuthStep.Payment,
+      service: '$payment',
+      module: '$payment.plan',
+      transitions: {
+        [StdAuthStep.Success]: {
+          transition: StdAuthStep.Success,
+          step: StdAuthStep.Success,
+        }
+      }
+    },
+
+    [StdAuthStep.Success]: {
+      index: 6,
+      step: StdAuthStep.Success,
+      service: '$payment',
+      module: '$payment.success',
+      transitions: {
+        [StdAuthStep.Target]: {
+          transition: StdAuthStep.Target,
+          step: StdAuthStep.Target,
+        }
+      }
+    },
+
+    // @TODO This doesn't work anymore
+    // The auth dispatcher will require an additional step to proceed
+    [StdAuthStep.Target]: {
+      index: 7,
+      step: StdAuthStep.Target,
+      service: '$auth',
+      module: '$dispatcher',
+      transitions: {}
+    }
+
+  }
+}

package/src/flows/index.ts

@@ -0,0 +1,5 @@
+
+export * from './auth.js'
+export * from './stab.js'
+export * from './oidc.js'
+export * from './oidp.js'