fix: add version number to the flow model

FrigadeHQ · Jan 10, 2025 · 3cd8d0b · 3cd8d0b
1 parent 9c269d9
commit 3cd8d0b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/.changeset/dull-buckets-yawn.md b/.changeset/dull-buckets-yawn.md
@@ -0,0 +1,6 @@
+---
+"@frigade/js": patch
+"@frigade/react": patch
+---
+
+Adds version number to the `Flow` model
diff --git a/packages/js-api/src/core/flow.ts b/packages/js-api/src/core/flow.ts
@@ -30,6 +30,10 @@ export class Flow extends Fetchable {
    * The Flow's ID.
    */
   public id: string
+  /**
+   * The version of the Flow.
+   */
+  public version: number
   /**
    * The Flow's component ID.
    */
@@ -125,7 +129,7 @@ export class Flow extends Fetchable {
     this.subtitle = statefulFlow?.data?.subtitle
     this.type = statefulFlow?.data?.type
     this.props = statefulFlow?.data?.props ?? {}
-
+    this.version = statefulFlow?.version
     this.isCompleted = statefulFlow.$state.completed
     this.isStarted = statefulFlow.$state.started
     this.isSkipped = statefulFlow.$state.skipped

diff --git a/packages/js-api/src/core/types.ts b/packages/js-api/src/core/types.ts
@@ -371,6 +371,7 @@ export interface StatefulFlow {
   flowSlug: string
   flowName: string
   flowType: FlowType
+  version: number
   /**
    * Contains the raw data of the Flow as defined in the YAML config as well as the user's state of each step.
    */

diff --git a/packages/js-api/test/frigade.int.test.ts b/packages/js-api/test/frigade.int.test.ts
@@ -44,6 +44,7 @@ describe('Basic Checklist integration test', () => {
       expect(step.id).toBeDefined()
       expect(step.title).toBeDefined()
     })
+    expect(flow.version).toBeDefined()
   })
 
   test('read and set flow state', async () => {
@@ -67,6 +68,7 @@ describe('Basic Checklist integration test', () => {
           flowSlug: 'some-flow',
           flowName: 'Some flow',
           flowType: FlowType.CHECKLIST,
+          version: 1,
           data: {
             steps: [
               {
@@ -125,6 +127,7 @@ describe('Basic Checklist integration test', () => {
         [madeUpFlowId]: {
           flowSlug: 'some-flow',
           flowName: 'Some flow',
+          version: 1,
           flowType: FlowType.CHECKLIST,
           data: {
             steps: [
@@ -180,6 +183,7 @@ describe('Basic Checklist integration test', () => {
       [madeUpFlowId]: {
         flowSlug: 'some-flow',
         flowName: 'Some flow',
+        version: 1,
         flowType: FlowType.CHECKLIST,
         data: {
           steps: [