@owlmeans/flow 0.1.18-rc.9 → 0.1.18

package/src/helper.ts

@@ -1,5 +1,5 @@
 import type { CommonConfig } from '@owlmeans/config'
-import { toConfigRecord } from '@owlmeans/config'
+import { configHelper } from '@owlmeans/config'
 import type { FlowConfig, ShallowFlow, WithFlowConfig } from './types.js'
 import { CFG_FLOW_PREFIX, FLOW_RECORD } from './consts.js'
 
@@ -7,7 +7,7 @@ export const flow = <C extends CommonConfig>(cfg: C, flow: ShallowFlow): C => {
   if (cfg.records == null) {
     cfg.records = []
   }
-  cfg.records.push({ ...toConfigRecord(flow), id: `${CFG_FLOW_PREFIX}:${flow.flow}`, recordType: FLOW_RECORD })
+  cfg.records.push({ ...configHelper.toConfigRecord(flow), id: `${CFG_FLOW_PREFIX}:${flow.flow}`, recordType: FLOW_RECORD })
 
   return cfg
 }

package/src/i18n/fr.json

@@ -0,0 +1,8 @@
+{
+  "_oa": {
+    "signup": "S’inscrire",
+    "signin": "Se connecter",
+    "new": "Créer une organisation",
+    "existing": "Utiliser une organisation existante"
+  }
+}

package/src/i18n.ts

@@ -1,4 +1,4 @@
-import { addI18nLib } from '@owlmeans/i18n'
+import { i18nHelper } from '@owlmeans/i18n'
 
 import en from './i18n/en.json' with { type: 'json' }
 import pl from './i18n/pl.json' with { type: 'json' }
@@ -7,11 +7,13 @@ import be from './i18n/be.json' with { type: 'json' }
 import uk from './i18n/uk.json' with { type: 'json' }
 import es from './i18n/es.json' with { type: 'json' }
 import de from './i18n/de.json' with { type: 'json' }
+import fr from './i18n/fr.json' with { type: 'json' }
 
-addI18nLib('en', 'flow', en)
-addI18nLib('pl', 'flow', pl)
-addI18nLib('ru', 'flow', ru)
-addI18nLib('be', 'flow', be)
-addI18nLib('uk', 'flow', uk)
-addI18nLib('es', 'flow', es)
-addI18nLib('de', 'flow', de)
+i18nHelper.addI18nLib('en', 'flow', en)
+i18nHelper.addI18nLib('pl', 'flow', pl)
+i18nHelper.addI18nLib('ru', 'flow', ru)
+i18nHelper.addI18nLib('be', 'flow', be)
+i18nHelper.addI18nLib('uk', 'flow', uk)
+i18nHelper.addI18nLib('es', 'flow', es)
+i18nHelper.addI18nLib('de', 'flow', de)
+i18nHelper.addI18nLib('fr', 'flow', fr)

package/src/state.ts

@@ -1,6 +1,6 @@
 import { FlowStepError, UnknownFlow, UnknownFlowStep, UnknownTransition } from './errors.js'
 import type { FlowModel, FlowProvider, FlowState, ShallowFlow } from './types.js'
-import { serializeState, unserializeState } from './utils/flow.js'
+import { flowUtils } from './utils/flow.js'
 
 export const makeFlowModel = async (flow: string | ShallowFlow, provider?: FlowProvider): Promise<FlowModel> => {
   let state: FlowState | null = null
@@ -17,7 +17,7 @@ export const makeFlowModel = async (flow: string | ShallowFlow, provider?: FlowP
         ok: true
       }
     } catch {
-      state = await unserializeState(flow as string, provider)
+      state = await flowUtils.unserializeState(flow as string, provider)
       flow = await provider(state.flow)
     }
   } else {
@@ -140,10 +140,10 @@ export const makeFlowModel = async (flow: string | ShallowFlow, provider?: FlowP
         delete state!.payload
       }*/
 
-      return serializeState(flow, state!)
+      return flowUtils.serializeState(flow, state!)
     },
 
-    serialize: () => serializeState(flow, state!)
+    serialize: () => flowUtils.serializeState(flow, state!)
   }
 
   return model

package/src/utils/flow/types.ts

@@ -0,0 +1,13 @@
+import type { FlowProvider, FlowState, ShallowFlow } from '../../types.js'
+
+/** The compact, URL-safe wire form of a flow state. */
+export interface FlowUtils {
+  /** The flow state as a base64url token: step indexes, service, ok flag, entity, message and mapped payload. */
+  serializeState: (flow: ShallowFlow, state: FlowState) => string
+  /**
+   * The flow state a token carries, its flow looked up through `flowProvider`.
+   *
+   * @throws {UnknownFlowStep} when the token names a step index the flow does not have
+   */
+  unserializeState: (token: string, flowProvider: FlowProvider) => Promise<FlowState>
+}

package/src/utils/flow.ts

@@ -2,73 +2,80 @@ import type { FlowProvider, FlowState, SerializedFlow, ShallowFlow } from '../ty
 import { FLOW_SEP, PAYLOAD_SEP } from '../consts.js'
 import { utf8, base64urlnopad } from '@scure/base'
 import { UnknownFlowStep } from '../errors.js'
+import type { FlowUtils } from './flow/types.js'
 
-export const serializeState = (flow: ShallowFlow, state: FlowState): string => {
-  const flowBlock = [
-    state.flow,
-    flow.steps[state.step].index.toString()
-  ]
-  if (state.previous != null) {
-    flowBlock.push(flow.steps[state.previous].index.toString())
-  }
-  const serialized: SerializedFlow = {
-    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<string[]>((list, [key, index]) => {
-        list[index] = state.payload![key] != null ? state.payload![key].toString() : ''
-        return list
-      }, Array<string>(Object.keys(step.payloadMap).length)).join(PAYLOAD_SEP)
+export const createFlowUtils = (): FlowUtils => {
+  const serializeState = (flow: ShallowFlow, state: FlowState): string => {
+    const flowBlock = [
+      state.flow,
+      flow.steps[state.step].index.toString()
+    ]
+    if (state.previous != null) {
+      flowBlock.push(flow.steps[state.previous].index.toString())
+    }
+    const serialized: SerializedFlow = {
+      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<string[]>((list, [key, index]) => {
+          list[index] = state.payload![key] != null ? state.payload![key].toString() : ''
+          return list
+        }, Array<string>(Object.keys(step.payloadMap).length)).join(PAYLOAD_SEP)
+      }
+    }
+
+    return base64urlnopad.encode(utf8.decode(JSON.stringify(serialized)))
   }
 
-  return base64urlnopad.encode(utf8.decode(JSON.stringify(serialized)))
-}
+  const unserializeState = async (token: string, flowProvider: FlowProvider): Promise<FlowState> => {
+    const serialized: SerializedFlow = 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
 
-export const unserializeState = async (token: string, flowProvider: FlowProvider): Promise<FlowState> => {
-  const serialized: SerializedFlow = 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: FlowState = {
+      flow: flow.flow,
+      step: step.step,
+      previous: previous?.step,
+      service: serialized.s,
+      ok: serialized.o === 1,
+    }
 
-  const state: FlowState = {
-    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.m != null) {
-    state.message = serialized.m
-  }
+    if (serialized.e != null) {
+      state.entityId = serialized.e !== '' ? serialized.e : null
+    }
 
-  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]
+      ))
+    }
 
-  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
   }
 
-  return state
+  return { serializeState, unserializeState }
 }
+
+export const flowUtils = createFlowUtils()

package/src/utils/index.ts

@@ -1,2 +1,3 @@
 
+export type * from './flow/types.js'
 export * from './flow.js'