cogfy-data-exchange 1.0.8 → 1.0.10

package/dist/create-flow.d.ts

@@ -1,6 +1,6 @@
-import type { ExtractScreen, FlowJson, NextResult, ScreenData, ScreenName, ScreenTrigger } from './types';
+import type { ExtractScreen, FlowJson, NextResult, PayloadByScreenId, ScreenName, ScreenTrigger } from './types';
 type Handlers<F extends FlowJson> = {
-    [K in ScreenName<F>]: (data: ScreenData<F, K>) => Promise<NextResult<F, K>>;
+    [K in ScreenName<F>]: (data: PayloadByScreenId<F, K>) => Promise<NextResult<F, K>>;
 };
 /**
  * Creates a flow engine based on the provided flow definition and handlers.
@@ -9,7 +9,7 @@ type Handlers<F extends FlowJson> = {
  * @returns An object with a `dispatch` method to trigger screen handlers and the original flow definition.
  */
 export declare function createFlow<F extends FlowJson>(flow: F, handlers: Handlers<F>): {
-    dispatch<T extends ScreenTrigger<ScreenName<F>>>(trigger: T, data: ScreenData<F, ExtractScreen<T, F>>): Promise<NextResult<F, ExtractScreen<T, F>>>;
+    dispatch<T extends ScreenTrigger<ScreenName<F>>>(trigger: T, payload: PayloadByScreenId<F, ExtractScreen<T, F>>): Promise<NextResult<F, ExtractScreen<T, F>>>;
     flow: F;
 };
 export {};

package/dist/create-flow.js

@@ -9,9 +9,9 @@ exports.createFlow = createFlow;
  */
 function createFlow(flow, handlers) {
     return {
-        dispatch(trigger, data) {
+        dispatch(trigger, payload) {
             const screen = trigger.replace('screen.', '');
-            return handlers[screen](data);
+            return handlers[screen](payload);
         },
         flow
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cogfy-data-exchange",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/__tests__/create-flow.test.ts

@@ -10,7 +10,27 @@ const flow = {
     SCREEN_D: []
   },
   screens: [
-    { data: { name: { __example__: 'John', type: 'string' } }, id: 'SCREEN_A', title: 'Screen A' },
+    {
+      data: { name: { __example__: 'John', type: 'string' } },
+      id: 'SCREEN_A',
+      layout: {
+        children: [
+          {
+            label: 'Continuar',
+            'on-click-action': {
+              name: 'data_exchange',
+              payload: {
+                age: 30,
+                trigger: 'screen.SCREEN_A'
+              }
+            },
+            type: 'Footer'
+          }
+        ],
+        type: 'SingleColumnLayout'
+      },
+      title: 'Screen A'
+    },
     { data: { age: { __example__: 30, type: 'number' } }, id: 'SCREEN_B', title: 'Screen B' },
     { data: { isActive: { __example__: true, type: 'boolean' } }, id: 'SCREEN_C', title: 'Screen C' },
     {
@@ -60,7 +80,7 @@ describe('createFlow', () => {
       }
     })
 
-    const result = await engine.dispatch('screen.SCREEN_A', { name: 'John' })
+    const result = await engine.dispatch('screen.SCREEN_A', { age: 30, trigger: 'screen.SCREEN_A' })
 
     expect(result).toEqual({
       data: { age: 30 },

package/src/create-flow.ts

@@ -1,7 +1,7 @@
-import type { ExtractScreen, FlowJson, NextResult, ScreenData, ScreenName, ScreenTrigger } from './types'
+import type { ExtractScreen, FlowJson, NextResult, PayloadByScreenId, ScreenName, ScreenTrigger } from './types'
 
 type Handlers<F extends FlowJson> = {
-  [K in ScreenName<F>]: (data: ScreenData<F, K>) => Promise<NextResult<F, K>>
+  [K in ScreenName<F>]: (data: PayloadByScreenId<F, K>) => Promise<NextResult<F, K>>
 }
 
 /**
@@ -14,11 +14,11 @@ export function createFlow<F extends FlowJson>(flow: F, handlers: Handlers<F>) {
   return {
     dispatch<T extends ScreenTrigger<ScreenName<F>>>(
       trigger: T,
-      data: ScreenData<F, ExtractScreen<T, F>>
+      payload: PayloadByScreenId<F, ExtractScreen<T, F>>
     ): Promise<NextResult<F, ExtractScreen<T, F>>> {
       const screen = trigger.replace('screen.', '') as ExtractScreen<T, F>
 
-      return handlers[screen](data)
+      return handlers[screen](payload)
     },
 
     flow

package/src/types/flow-json.ts

@@ -1,8 +1,8 @@
 export type FlowJsonDataValue =
-  | { type: 'string'; __example__?: string }
-  | { type: 'number'; __example__?: number }
-  | { type: 'boolean'; __example__?: boolean }
-  | { type: 'object'; properties: Record<string, FlowJsonDataValue>; __example__?: Record<string, unknown> }
+  | { type: 'string'; __example__: string }
+  | { type: 'number'; __example__: number }
+  | { type: 'boolean'; __example__: boolean }
+  | { type: 'object'; properties?: Record<string, FlowJsonDataValue>; __example__?: Record<string, unknown> }
   | { type: 'array'; items: FlowJsonDataValue; __example__?: unknown[] }
 
 export type FlowJsonData = Record<string, FlowJsonDataValue>