@standardbeagle/data-router 1.1.0

package/dist/types.d.ts

@@ -0,0 +1,135 @@
+export interface AsyncState {
+    readonly status: 'idle' | 'loading' | 'success' | 'error';
+    readonly error?: Error;
+    readonly timestamp?: number;
+    readonly requestId?: string;
+}
+export interface AsyncCommand {
+    readonly id: string;
+    readonly xpath: string;
+    readonly operation: 'fetch' | 'mutate';
+    readonly abortController: AbortController;
+    readonly promise: Promise<any>;
+    readonly timestamp: number;
+    readonly priority: 'low' | 'normal' | 'high';
+}
+export interface CommandQueue {
+    readonly pending: readonly AsyncCommand[];
+    readonly executing: ReadonlyMap<string, AsyncCommand>;
+    readonly maxConcurrent: number;
+}
+export interface OptimisticUpdate {
+    readonly id: string;
+    readonly xpath: string;
+    readonly originalData: any;
+    readonly optimisticData: any;
+    readonly rollbackOnError: boolean;
+}
+export interface DataContext {
+    readonly data: Record<string, any>;
+    readonly xpath: string;
+    readonly history: readonly string[];
+    readonly location: number;
+    readonly asyncStates: Record<string, AsyncState>;
+    readonly pendingOperations: ReadonlySet<string>;
+    readonly commandQueue: CommandQueue;
+    readonly optimisticUpdates: Record<string, OptimisticUpdate>;
+}
+export interface XPathParams {
+    [key: string]: string | number | undefined;
+}
+export interface DataRouteContext {
+    readonly xpath: string;
+    readonly data: Record<string, any>;
+    readonly targetData: any;
+    readonly params: XPathParams;
+}
+export type DataOperationType = 'merge' | 'replace' | 'append' | 'delete';
+export type NavigateAction = {
+    readonly type: 'NAVIGATE';
+    readonly payload: string;
+};
+export type BackAction = {
+    readonly type: 'BACK';
+    readonly payload: number;
+};
+export type ForwardAction = {
+    readonly type: 'FORWARD';
+    readonly payload: number;
+};
+export type DataAction = {
+    readonly type: 'DATA_OPERATION';
+    readonly payload: {
+        xpath: string;
+        operation: DataOperationType;
+        data: any;
+    };
+};
+export type AsyncStartAction = {
+    readonly type: 'ASYNC_START';
+    readonly payload: {
+        xpath: string;
+        requestId: string;
+        operation: 'fetch' | 'mutate';
+        priority?: 'low' | 'normal' | 'high';
+        optimisticData?: any;
+    };
+};
+export type AsyncSuccessAction = {
+    readonly type: 'ASYNC_SUCCESS';
+    readonly payload: {
+        xpath: string;
+        requestId: string;
+        data: any;
+        timestamp: number;
+    };
+};
+export type AsyncErrorAction = {
+    readonly type: 'ASYNC_ERROR';
+    readonly payload: {
+        xpath: string;
+        requestId: string;
+        error: Error;
+        shouldRollback: boolean;
+    };
+};
+export type AsyncCancelAction = {
+    readonly type: 'ASYNC_CANCEL';
+    readonly payload: {
+        xpath: string;
+        requestId: string;
+    };
+};
+export type CommandQueueAction = {
+    readonly type: 'COMMAND_QUEUE_UPDATE';
+    readonly payload: {
+        operation: 'add' | 'remove' | 'execute';
+        command?: AsyncCommand;
+        commandId?: string;
+    };
+};
+export type DataRouterAction = NavigateAction | BackAction | ForwardAction | DataAction | AsyncStartAction | AsyncSuccessAction | AsyncErrorAction | AsyncCancelAction | CommandQueueAction;
+export interface Action<T> {
+    readonly type: string;
+    readonly payload: T;
+}
+export interface NavigationObject {
+    readonly navigate: (xpath: string) => void;
+    readonly back: (count?: number) => void;
+    readonly forward: (count?: number) => void;
+    readonly hasBack: boolean;
+    readonly hasForward: boolean;
+    readonly xpath: string;
+    readonly history: readonly string[];
+    readonly location: number;
+}
+export interface FormData {
+    [key: string]: FormDataEntryValue | FormDataEntryValue[];
+}
+export interface DataManipulationHook {
+    readonly setData: (xpath: string, data: any, operation?: DataOperationType) => void;
+    readonly mergeData: (xpath: string, data: any) => void;
+    readonly replaceData: (xpath: string, data: any) => void;
+    readonly appendData: (xpath: string, data: any) => void;
+    readonly deleteData: (xpath: string) => void;
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@standardbeagle/data-router",
+  "private": false,
+  "version": "1.1.0",
+  "type": "module",
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/index.umd.cjs",
+  "module": "dist/index.es.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.es.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.umd.cjs"
+      }
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/standardbeagle/beagle-core",
+    "directory": "data-router"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "ts": "tsc",
+    "test": "vitest",
+    "prepublish": "npm run build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "redux-actions": "^3.0.0"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^14.2.0",
+    "@testing-library/user-event": "^14.5.2",
+    "@types/jsdom": "^21.1.6",
+    "@types/react": "^18.2.43",
+    "@types/react-dom": "^18.2.17",
+    "@types/redux-actions": "^2.6.5",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "@vitejs/plugin-react-swc": "^3.5.0",
+    "eslint": "^8.55.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "jsdom": "^24.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "terser": "^5.43.1",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8",
+    "vite-plugin-dts": "^3.7.2",
+    "vitest": "^1.2.2"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  }
+}