feat(core,react): add targetActivityId property (#502)

daangn · Aug 14, 2024 · 667570b · 667570b
1 parent 7c53d78
commit 667570b
Show file tree

Hide file tree

Showing 43 changed files with 503 additions and 178 deletions.
diff --git a/.changeset/light-dragons-bow.md b/.changeset/light-dragons-bow.md
@@ -0,0 +1,6 @@
+---
+"@stackflow/react": minor
+"@stackflow/core": minor
+---
+
+feat(core,react): add `targetActivityId` option
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -0,0 +1,28 @@
+{
+  "mode": "exit",
+  "tag": "canary",
+  "initialVersions": {
+    "@stackflow/config": "1.1.0",
+    "@stackflow/core": "1.1.0-canary.0",
+    "@stackflow/demo": "1.3.1-canary.0",
+    "@stackflow/docs": "1.2.26-canary.0",
+    "@stackflow/compat-await-push": "1.1.12-canary.0",
+    "@stackflow/link": "1.4.4-canary.0",
+    "@stackflow/plugin-basic-ui": "1.9.1-canary.0",
+    "@stackflow/plugin-devtools": "0.1.11-canary.0",
+    "@stackflow/plugin-google-analytics-4": "1.1.14-canary.0",
+    "@stackflow/plugin-history-sync": "1.6.2-canary.0",
+    "@stackflow/plugin-map-initial-activity": "1.0.10-canary.0",
+    "@stackflow/plugin-preload": "1.4.1-canary.0",
+    "@stackflow/plugin-renderer-basic": "1.1.12-canary.0",
+    "@stackflow/plugin-renderer-web": "1.1.12-canary.0",
+    "@stackflow/plugin-stack-depth-change": "1.1.5-canary.0",
+    "@stackflow/react-ui-core": "1.1.1-canary.0",
+    "@stackflow/react": "1.3.0-canary.0",
+    "@stackflow/esbuild-config": "1.0.3"
+  },
+  "changesets": [
+    "light-dragons-bow",
+    "silly-doors-eat"
+  ]
+}
diff --git a/.changeset/silly-doors-eat.md b/.changeset/silly-doors-eat.md
@@ -0,0 +1,5 @@
+---
+"@stackflow/react": patch
+---
+
+feat(react): add `targetActivityId` param for future api
diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @stackflow/core
 
+## 1.1.0-canary.0
+
+### Minor Changes
+
+- feat(core,react): add `targetActivityId` option
+
 ## 1.0.14
 
 ### Patch Changes

diff --git a/core/package.json b/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stackflow/core",
-  "version": "1.0.14",
+  "version": "1.1.0-canary.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/daangn/stackflow.git",

diff --git a/core/src/activity-utils/findTargetActivityIndexes.ts b/core/src/activity-utils/findTargetActivityIndexes.ts
@@ -74,6 +74,12 @@ export default function findTargetActivityIndexes(
       const latestActivity = findLatestActiveActivity(activities);
 
       if (latestActivity) {
+        if (
+          event.targetActivityId &&
+          event.targetActivityId !== latestActivity.id
+        ) {
+          break;
+        }
         targetActivities.push(activities.indexOf(latestActivity));
       }
       break;
@@ -82,6 +88,12 @@ export default function findTargetActivityIndexes(
       const latestActivity = findLatestActiveActivity(activities);
 
       if (latestActivity && latestActivity.steps.length > 1) {
+        if (
+          event.targetActivityId &&
+          event.targetActivityId !== latestActivity.id
+        ) {
+          break;
+        }
         targetActivities.push(activities.indexOf(latestActivity));
       }
 

diff --git a/core/src/aggregate.spec.ts b/core/src/aggregate.spec.ts
@@ -3846,3 +3846,88 @@ test("aggregate - After Push > Push > Pop > Replace, first pushed activity shoul
     globalTransitionState: "idle",
   });
 });
+
+test("aggregate - StepPushedEvent must be ignored when top activity is not target activity", () => {
+  const t = nowTime();
+
+  let pushedEvent1: PushedEvent;
+  let pushedEvent2: PushedEvent;
+  let stepPushedEvent: StepPushedEvent;
+
+  const events = [
+    initializedEvent({
+      transitionDuration: 300,
+    }),
+    registeredEvent({
+      activityName: "sample",
+    }),
+    (pushedEvent1 = makeEvent("Pushed", {
+      activityId: "A",
+      activityName: "sample",
+      activityParams: {},
+      eventDate: enoughPastTime(),
+    })),
+    (pushedEvent2 = makeEvent("Pushed", {
+      activityId: "B",
+      activityName: "sample",
+      activityParams: {},
+      eventDate: enoughPastTime(),
+    })),
+    (stepPushedEvent = makeEvent("StepPushed", {
+      stepId: "s1",
+      stepParams: {},
+      targetActivityId: pushedEvent1.activityId,
+      eventDate: enoughPastTime(),
+    })),
+  ];
+
+  const output = aggregate(events, t + 300);
+
+  expect(output).toStrictEqual({
+    activities: [
+      activity({
+        id: "A",
+        name: "sample",
+        transitionState: "enter-done",
+        params: {},
+        steps: [
+          {
+            id: "A",
+            params: {},
+            enteredBy: pushedEvent1,
+          },
+        ],
+        enteredBy: pushedEvent1,
+        isActive: false,
+        isTop: false,
+        isRoot: true,
+        zIndex: 0,
+      }),
+      activity({
+        id: "B",
+        name: "sample",
+        transitionState: "enter-done",
+        params: {},
+        steps: [
+          {
+            id: "B",
+            params: {},
+            enteredBy: pushedEvent2,
+          },
+        ],
+        enteredBy: pushedEvent2,
+        isActive: true,
+        isTop: true,
+        isRoot: false,
+        zIndex: 1,
+      }),
+    ],
+    registeredActivities: [
+      {
+        name: "sample",
+      },
+    ],
+    transitionDuration: 300,
+    globalTransitionState: "idle",
+  });
+});
diff --git a/core/src/event-types/StepPoppedEvent.ts b/core/src/event-types/StepPoppedEvent.ts
@@ -1,3 +1,8 @@
 import type { BaseDomainEvent } from "./_base";
 
-export type StepPoppedEvent = BaseDomainEvent<"StepPopped", {}>;
+export type StepPoppedEvent = BaseDomainEvent<
+  "StepPopped",
+  {
+    targetActivityId?: string;
+  }
+>;
diff --git a/core/src/event-types/StepPushedEvent.ts b/core/src/event-types/StepPushedEvent.ts
@@ -7,5 +7,6 @@ export type StepPushedEvent = BaseDomainEvent<
     stepParams: {
       [key: string]: string | undefined;
     };
+    targetActivityId?: string;
   }
 >;
diff --git a/core/src/event-types/StepReplacedEvent.ts b/core/src/event-types/StepReplacedEvent.ts
@@ -7,5 +7,6 @@ export type StepReplacedEvent = BaseDomainEvent<
     stepParams: {
       [key: string]: string | undefined;
     };
+    targetActivityId?: string;
   }
 >;
diff --git a/demo/CHANGELOG.md b/demo/CHANGELOG.md
@@ -1,5 +1,22 @@
 # @stackflow/demo
 
+## 1.3.1-canary.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @stackflow/react@1.3.0-canary.0
+  - @stackflow/core@1.1.0-canary.0
+  - @stackflow/compat-await-push@1.1.12-canary.0
+  - @stackflow/link@1.4.4-canary.0
+  - @stackflow/plugin-basic-ui@1.9.1-canary.0
+  - @stackflow/plugin-history-sync@1.6.2-canary.0
+  - @stackflow/plugin-map-initial-activity@1.0.10-canary.0
+  - @stackflow/plugin-preload@1.4.1-canary.0
+  - @stackflow/plugin-renderer-basic@1.1.12-canary.0
+  - @stackflow/plugin-devtools@0.1.11-canary.0
+  - @stackflow/plugin-stack-depth-change@1.1.5-canary.0
+
 ## 1.3.0
 
 ### Minor Changes

diff --git a/demo/package.json b/demo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stackflow/demo",
-  "version": "1.3.0",
+  "version": "1.3.1-canary.0",
   "private": true,
   "license": "MIT",
   "type": "module",
@@ -32,18 +32,18 @@
   "dependencies": {
     "@seed-design/design-token": "^1.0.3",
     "@seed-design/stylesheet": "^1.0.4",
-    "@stackflow/compat-await-push": "^1.1.11",
+    "@stackflow/compat-await-push": "^1.1.12-canary.0",
     "@stackflow/config": "^1.1.0",
-    "@stackflow/core": "^1.0.13",
-    "@stackflow/link": "^1.4.3",
-    "@stackflow/plugin-basic-ui": "^1.8.3",
-    "@stackflow/plugin-devtools": "^0.1.10",
-    "@stackflow/plugin-history-sync": "^1.6.0",
-    "@stackflow/plugin-map-initial-activity": "^1.0.9",
-    "@stackflow/plugin-preload": "^1.3.3",
-    "@stackflow/plugin-renderer-basic": "^1.1.11",
-    "@stackflow/plugin-stack-depth-change": "^1.1.4",
-    "@stackflow/react": "^1.2.0",
+    "@stackflow/core": "^1.1.0-canary.0",
+    "@stackflow/link": "^1.4.4-canary.0",
+    "@stackflow/plugin-basic-ui": "^1.9.1-canary.0",
+    "@stackflow/plugin-devtools": "^0.1.11-canary.0",
+    "@stackflow/plugin-history-sync": "^1.6.2-canary.0",
+    "@stackflow/plugin-map-initial-activity": "^1.0.10-canary.0",
+    "@stackflow/plugin-preload": "^1.4.1-canary.0",
+    "@stackflow/plugin-renderer-basic": "^1.1.12-canary.0",
+    "@stackflow/plugin-stack-depth-change": "^1.1.5-canary.0",
+    "@stackflow/react": "^1.3.0-canary.0",
     "lorem-ipsum": "^2.0.8",
     "lz-string": "^1.5.0",
     "normalize.css": "^8.0.1",

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,17 @@
 # @stackflow/docs
 
+## 1.2.26-canary.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @stackflow/react@1.3.0-canary.0
+  - @stackflow/core@1.1.0-canary.0
+  - @stackflow/demo@1.3.1-canary.0
+  - @stackflow/plugin-basic-ui@1.9.1-canary.0
+  - @stackflow/plugin-history-sync@1.6.2-canary.0
+  - @stackflow/plugin-renderer-basic@1.1.12-canary.0
+
 ## 1.2.25
 
 ### Patch Changes

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stackflow/docs",
-  "version": "1.2.25",
+  "version": "1.2.26-canary.0",
   "private": true,
   "description": "Mobile-first stack navigator framework with Composable Plugin System",
   "license": "MIT",
@@ -11,12 +11,12 @@
   },
   "dependencies": {
     "@mdx-js/react": "^3.0.1",
-    "@stackflow/core": "^1.0.13",
-    "@stackflow/demo": "^1.3.0",
-    "@stackflow/plugin-basic-ui": "^1.8.3",
-    "@stackflow/plugin-history-sync": "^1.6.0",
-    "@stackflow/plugin-renderer-basic": "^1.1.11",
-    "@stackflow/react": "^1.2.0",
+    "@stackflow/core": "^1.1.0-canary.0",
+    "@stackflow/demo": "^1.3.1-canary.0",
+    "@stackflow/plugin-basic-ui": "^1.9.1-canary.0",
+    "@stackflow/plugin-history-sync": "^1.6.2-canary.0",
+    "@stackflow/plugin-renderer-basic": "^1.1.12-canary.0",
+    "@stackflow/react": "^1.3.0-canary.0",
     "@types/react": "^18.3.3",
     "next": "^14.2.4",
     "nextra": "^2.13.4",

diff --git a/extensions/compat-await-push/CHANGELOG.md b/extensions/compat-await-push/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @stackflow/compat-await-push
 
+## 1.1.12-canary.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @stackflow/react@1.3.0-canary.0
+  - @stackflow/core@1.1.0-canary.0
+
 ## 1.1.11
 
 ## 1.1.11-canary.0

diff --git a/extensions/compat-await-push/package.json b/extensions/compat-await-push/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stackflow/compat-await-push",
-  "version": "1.1.11",
+  "version": "1.1.12-canary.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/daangn/stackflow.git",
@@ -31,18 +31,18 @@
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@stackflow/core": "^1.0.13",
+    "@stackflow/core": "^1.1.0-canary.0",
     "@stackflow/esbuild-config": "^1.0.3",
-    "@stackflow/react": "^1.2.0",
+    "@stackflow/react": "^1.3.0-canary.0",
     "@types/react": "^18.3.3",
     "esbuild": "^0.23.0",
     "react": "^18.3.1",
     "rimraf": "^3.0.2",
     "typescript": "^5.5.3"
   },
   "peerDependencies": {
-    "@stackflow/core": "^1",
-    "@stackflow/react": "^1.2.0-canary.0",
+    "@stackflow/core": "^1.1.0-canary.0",
+    "@stackflow/react": "^1.3.0-canary.0",
     "@types/react": ">=16.8.0",
     "react": ">=16.8.0"
   },

diff --git a/extensions/link/CHANGELOG.md b/extensions/link/CHANGELOG.md
@@ -1,5 +1,15 @@
 # @stackflow/link
 
+## 1.4.4-canary.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @stackflow/react@1.3.0-canary.0
+  - @stackflow/core@1.1.0-canary.0
+  - @stackflow/plugin-history-sync@1.6.2-canary.0
+  - @stackflow/plugin-preload@1.4.1-canary.0
+
 ## 1.4.3
 
 ## 1.4.3-canary.0