Compare commits

...

22 Commits

Author SHA1 Message Date
128923290d RELEASING: Releasing 1 package(s)
Releases:
  @warkypublic/oranguru@0.0.41

[skip ci]
2026-02-08 15:55:17 +02:00
3314c69ef9 docs(changeset): feat(Former): add useFormerState hook for managing form state 2026-02-08 15:55:14 +02:00
bc5d2d2a4f feat(Former): add useFormerState hook for managing form state 2026-02-08 15:54:35 +02:00
bc422e7d66 fix(api): improve error handling for API requests 2026-02-08 00:20:03 +02:00
252530610b chore(repository): add repository field to package.json 2026-02-08 00:14:23 +02:00
a748a39d2f RELEASING: Releasing 1 package(s)
Releases:
  @warkypublic/oranguru@0.0.40

[skip ci]
2026-02-08 00:12:17 +02:00
8928432fe0 docs(changeset): feat(Former): add keep open functionality and update onClose behavior 2026-02-08 00:12:14 +02:00
6ff395e9be RELEASING: Releasing 1 package(s)
Releases:
  @warkypublic/oranguru@0.0.39

[skip ci]
2026-02-08 00:05:14 +02:00
00e5a70aef docs(changeset): feat(Former): enhance state management with additional callbacks and state retrieval 2026-02-08 00:05:05 +02:00
f365d7b0e0 RELEASING: Releasing 1 package(s)
Releases:
  @warkypublic/oranguru@0.0.38

[skip ci]
2026-02-07 23:08:56 +02:00
210a1d44e7 docs(changeset): feat(GlobalStateStore): add initialization state and update actions 2026-02-07 23:08:52 +02:00
c2113357f2 feat(GlobalStateStore): prevent saving during initial load 2026-02-07 22:54:00 +02:00
2e23b259ab feat(GlobalStateStore): implement storage loading and saving logic 2026-02-07 22:48:12 +02:00
552a1e5979 chore(release): bump version to 0.0.35 and update changelog 2026-02-07 22:25:09 +02:00
9097e2f1e0 fix(api): response handling in FormerRestHeadSpecAPI 2026-02-07 22:24:39 +02:00
b521d04cd0 refactor(GlobalStateStoreProvider): update type definitions for session handlers 2026-02-07 21:31:16 +02:00
690cb22306 chore(release): bump version to 0.0.34 and update changelog 2026-02-07 21:29:43 +02:00
6edac91ea8 refactor(globalStateStore): simplify exports in index file 2026-02-07 21:15:27 +02:00
da69c80cff chore(changeset): disable automatic commit in config 2026-02-07 21:12:27 +02:00
e40730eaef RELEASING: Releasing 1 package(s)
Releases:
  @warkypublic/oranguru@0.0.33

[skip ci]
2026-02-07 21:11:51 +02:00
d7b1eb26f3 docs(changeset): feat(error-manager): implement centralized error reporting system 2026-02-07 21:11:48 +02:00
7bf94f306a Merge pull request 'dev-globalstatestore' (#2) from dev-globalstatestore into main
Reviewed-on: #2
2026-02-07 18:09:30 +00:00
28 changed files with 1472 additions and 301 deletions

View File

@@ -1,5 +1,59 @@
# @warkypublic/zustandsyncstore
## 0.0.41
### Patch Changes
- 3314c69: feat(Former): add useFormerState hook for managing form state
## 0.0.40
### Patch Changes
- 8928432: feat(Former): add keep open functionality and update onClose behavior
## 0.0.39
### Patch Changes
- 00e5a70: feat(Former): enhance state management with additional callbacks and state retrieval
## 0.0.38
### Patch Changes
- 210a1d4: feat(GlobalStateStore): add initialization state and update actions
## 0.0.37
### Patch Changes
- feat(GlobalStateStore): prevent saving during initial load
## 0.0.36
### Patch Changes
- feat(GlobalStateStore): implement storage loading and saving logic
## 0.0.35
### Patch Changes
- fix(api): response handling in FormerRestHeadSpecAPI
## 0.0.34
### Patch Changes
- Better GlobalStateStore
## 0.0.33
### Patch Changes
- d7b1eb2: feat(error-manager): implement centralized error reporting system
## 0.0.32
### Patch Changes

View File

@@ -1,7 +1,7 @@
{
"name": "@warkypublic/oranguru",
"author": "Warky Devs",
"version": "0.0.32",
"version": "0.0.41",
"type": "module",
"types": "./dist/lib.d.ts",
"main": "./dist/lib.cjs.js",
@@ -43,6 +43,10 @@
"build-storybook": "storybook build",
"mcp": "node mcp/server.js"
},
"repository": {
"type": "git",
"url": "git+https://git.warky.dev/wdevs/oranguru.git"
},
"dependencies": {
"@modelcontextprotocol/sdk": "^1.0.4",
"@tanstack/react-virtual": "^3.13.18",
@@ -53,6 +57,7 @@
"@changesets/cli": "^2.29.8",
"@eslint/js": "^9.39.2",
"@microsoft/api-extractor": "^7.56.0",
"@sentry/react": "^10.38.0",
"@storybook/react-vite": "^10.2.3",
"@testing-library/jest-dom": "^6.9.1",
"@testing-library/react": "^16.3.2",

67
pnpm-lock.yaml generated
View File

@@ -72,6 +72,9 @@ importers:
'@microsoft/api-extractor':
specifier: ^7.56.0
version: 7.56.0(@types/node@25.2.0)
'@sentry/react':
specifier: ^10.38.0
version: 10.38.0(react@19.2.4)
'@storybook/react-vite':
specifier: ^10.2.3
version: 10.2.3(esbuild@0.27.2)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(rollup@4.50.2)(storybook@10.2.3(@testing-library/dom@10.4.1)(prettier@3.8.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(typescript@5.9.3)(vite@7.3.1(@types/node@25.2.0)(jiti@2.6.1)(sugarss@5.0.1(postcss@8.5.6)))
@@ -964,6 +967,36 @@ packages:
'@rushstack/ts-command-line@5.1.7':
resolution: {integrity: sha512-Ugwl6flarZcL2nqH5IXFYk3UR3mBVDsVFlCQW/Oaqidvdb/5Ota6b/Z3JXWIdqV3rOR2/JrYoAHanWF5rgenXA==}
'@sentry-internal/browser-utils@10.38.0':
resolution: {integrity: sha512-UOJtYmdcxHCcV0NPfXFff/a95iXl/E0EhuQ1y0uE0BuZDMupWSF5t2BgC4HaE5Aw3RTjDF3XkSHWoIF6ohy7eA==}
engines: {node: '>=18'}
'@sentry-internal/feedback@10.38.0':
resolution: {integrity: sha512-JXneg9zRftyfy1Fyfc39bBlF/Qd8g4UDublFFkVvdc1S6JQPlK+P6q22DKz3Pc8w3ySby+xlIq/eTu9Pzqi4KA==}
engines: {node: '>=18'}
'@sentry-internal/replay-canvas@10.38.0':
resolution: {integrity: sha512-OXWM9jEqNYh4VTvrMu7v+z1anz+QKQ/fZXIZdsO7JTT2lGNZe58UUMeoq386M+Saxen8F9SUH7yTORy/8KI5qw==}
engines: {node: '>=18'}
'@sentry-internal/replay@10.38.0':
resolution: {integrity: sha512-YWIkL6/dnaiQyFiZXJ/nN+NXGv/15z45ia86bE/TMq01CubX/DUOilgsFz0pk2v/pg3tp/U2MskLO9Hz0cnqeg==}
engines: {node: '>=18'}
'@sentry/browser@10.38.0':
resolution: {integrity: sha512-3phzp1YX4wcQr9mocGWKbjv0jwtuoDBv7+Y6Yfrys/kwyaL84mDLjjQhRf4gL5SX7JdYkhBp4WaiNlR0UC4kTA==}
engines: {node: '>=18'}
'@sentry/core@10.38.0':
resolution: {integrity: sha512-1pubWDZE5y5HZEPMAZERP4fVl2NH3Ihp1A+vMoVkb3Qc66Diqj1WierAnStlZP7tCx0TBa0dK85GTW/ZFYyB9g==}
engines: {node: '>=18'}
'@sentry/react@10.38.0':
resolution: {integrity: sha512-3UiKo6QsqTyPGUt0XWRY9KLaxc/cs6Kz4vlldBSOXEL6qPDL/EfpwNJT61osRo81VFWu8pKu7ZY2bvLPryrnBQ==}
engines: {node: '>=18'}
peerDependencies:
react: ^16.14.0 || 17.x || 18.x || 19.x
'@sinclair/typebox@0.27.8':
resolution: {integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==}
@@ -4780,6 +4813,40 @@ snapshots:
transitivePeerDependencies:
- '@types/node'
'@sentry-internal/browser-utils@10.38.0':
dependencies:
'@sentry/core': 10.38.0
'@sentry-internal/feedback@10.38.0':
dependencies:
'@sentry/core': 10.38.0
'@sentry-internal/replay-canvas@10.38.0':
dependencies:
'@sentry-internal/replay': 10.38.0
'@sentry/core': 10.38.0
'@sentry-internal/replay@10.38.0':
dependencies:
'@sentry-internal/browser-utils': 10.38.0
'@sentry/core': 10.38.0
'@sentry/browser@10.38.0':
dependencies:
'@sentry-internal/browser-utils': 10.38.0
'@sentry-internal/feedback': 10.38.0
'@sentry-internal/replay': 10.38.0
'@sentry-internal/replay-canvas': 10.38.0
'@sentry/core': 10.38.0
'@sentry/core@10.38.0': {}
'@sentry/react@10.38.0(react@19.2.4)':
dependencies:
'@sentry/browser': 10.38.0
'@sentry/core': 10.38.0
react: 19.2.4
'@sinclair/typebox@0.27.8': {}
'@standard-schema/spec@1.0.0': {}

View File

@@ -1,5 +1,8 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import React, { type PropsWithChildren } from 'react';
import errorManager from './ErrorManager';
interface ErrorBoundaryProps extends PropsWithChildren {
namespace?: string;
onReportClick?: () => void;
@@ -43,7 +46,12 @@ export class ReactBasicErrorBoundary extends React.PureComponent<
errorInfo,
try: false,
});
// You can also log error messages to an error reporting service here
// Report error to error manager (Sentry, custom API, etc.)
errorManager.reportError(error, errorInfo, {
componentStack: errorInfo?.componentStack,
namespace: this.props.namespace,
});
}
render() {

View File

@@ -1,7 +1,10 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { Button, Code, Collapse, Group, Paper, rem, Text } from '@mantine/core';
import { IconExclamationCircle } from '@tabler/icons-react';
import React, { type PropsWithChildren } from 'react';
import errorManager from './ErrorManager';
let ErrorBoundaryOptions = {
disabled: false,
onError: undefined,
@@ -68,7 +71,12 @@ export class ReactErrorBoundary extends React.Component<ErrorBoundaryProps, Erro
if (typeof GetErrorBoundaryOptions()?.onError === 'function') {
GetErrorBoundaryOptions()?.onError?.(error, errorInfo);
}
// You can also log error messages to an error reporting service here
// Report error to error manager (Sentry, custom API, etc.)
errorManager.reportError(error, errorInfo, {
componentStack: errorInfo?.componentStack,
namespace: this.props.namespace,
});
}
render() {
@@ -202,6 +210,19 @@ export class ReactErrorBoundary extends React.Component<ErrorBoundaryProps, Erro
}));
return;
}
// Manually report error if user clicks report button
if (this.state.error && this.state.errorInfo) {
await errorManager.reportError(this.state.error, this.state.errorInfo, {
componentStack: this.state.errorInfo?.componentStack,
namespace: this.props.namespace,
tags: { reportedBy: 'user' },
});
this.setState(() => ({
reported: true,
}));
}
}
reset() {

View File

@@ -0,0 +1,166 @@
# ErrorManager
Centralized error reporting for ErrorBoundary components.
## Setup
### Sentry Integration
```typescript
import { errorManager } from './ErrorBoundary';
errorManager.configure({
enabled: true,
sentry: {
dsn: 'https://your-sentry-dsn@sentry.io/project-id',
environment: 'production',
release: '1.0.0',
sampleRate: 1.0,
ignoreErrors: ['ResizeObserver loop limit exceeded'],
},
});
```
### Custom API Integration
```typescript
errorManager.configure({
enabled: true,
customAPI: {
endpoint: 'https://api.yourapp.com/errors',
method: 'POST',
headers: {
'Authorization': 'Bearer token',
},
transformPayload: (report) => ({
message: report.error.message,
stack: report.error.stack,
level: report.severity,
timestamp: report.timestamp,
}),
},
});
```
### Custom Reporter
```typescript
errorManager.configure({
enabled: true,
reporters: [
{
name: 'CustomLogger',
isEnabled: () => true,
captureError: async (report) => {
console.error('Error:', report.error);
},
},
],
});
```
### Multiple Reporters
```typescript
errorManager.configure({
enabled: true,
sentry: { dsn: 'your-dsn' },
customAPI: { endpoint: 'your-endpoint' },
reporters: [customReporter],
});
```
## Hooks
### beforeReport
```typescript
errorManager.configure({
beforeReport: (report) => {
// Filter errors
if (report.error.message.includes('ResizeObserver')) {
return null; // Skip reporting
}
// Enrich with user data
report.context = {
...report.context,
user: { id: getCurrentUserId() },
tags: { feature: 'checkout' },
};
return report;
},
});
```
### onReportSuccess / onReportFailure
```typescript
errorManager.configure({
onReportSuccess: (report) => {
console.log('Error reported successfully');
},
onReportFailure: (error, report) => {
console.error('Failed to report error:', error);
},
});
```
## Manual Reporting
```typescript
try {
riskyOperation();
} catch (error) {
await errorManager.reportError(error as Error, null, {
namespace: 'checkout',
tags: { step: 'payment' },
extra: { orderId: '123' },
});
}
```
## Disable/Enable
```typescript
// Disable reporting
errorManager.configure({ enabled: false });
// Enable reporting
errorManager.configure({ enabled: true });
```
## ErrorBoundary Integration
Automatic - errors caught by `ReactErrorBoundary` or `ReactBasicErrorBoundary` are automatically reported.
Manual report button in `ReactErrorBoundary` UI also sends to ErrorManager.
## Install Sentry (optional)
```bash
npm install @sentry/react
```
## Types
```typescript
type ErrorSeverity = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
interface ErrorContext {
namespace?: string;
componentStack?: string;
user?: Record<string, any>;
tags?: Record<string, string>;
extra?: Record<string, any>;
}
interface ErrorReport {
error: Error;
errorInfo?: any;
severity?: ErrorSeverity;
context?: ErrorContext;
timestamp?: number;
}
```

View File

@@ -0,0 +1,194 @@
import type {
CustomAPIConfig,
ErrorManagerConfig,
ErrorReport,
ErrorReporter,
SentryConfig,
} from './ErrorManager.types';
class ErrorManager {
private config: ErrorManagerConfig = { enabled: true };
private reporters: ErrorReporter[] = [];
private sentryInstance: any = null;
configure(config: ErrorManagerConfig) {
this.config = { ...this.config, ...config };
this.reporters = [];
if (config.sentry) {
this.setupSentry(config.sentry);
}
if (config.customAPI) {
this.setupCustomAPI(config.customAPI);
}
if (config.reporters) {
this.reporters.push(...config.reporters);
}
}
destroy() {
this.reporters = [];
this.sentryInstance = null;
this.config = { enabled: true };
}
getReporters(): ErrorReporter[] {
return [...this.reporters];
}
isEnabled(): boolean {
return Boolean(this.config.enabled);
}
async reportError(
error: Error,
errorInfo?: any,
context?: ErrorReport['context']
): Promise<void> {
if (!this.config.enabled) {
return;
}
let report: ErrorReport = {
context,
error,
errorInfo,
severity: 'error',
timestamp: Date.now(),
};
if (this.config.beforeReport) {
const modifiedReport = this.config.beforeReport(report);
if (!modifiedReport) {
return;
}
report = modifiedReport;
}
const reportPromises = this.reporters
.filter((reporter) => reporter.isEnabled())
.map(async (reporter) => {
try {
await reporter.captureError(report);
} catch (error) {
console.error(`Error reporter "${reporter.name}" failed:`, error);
if (this.config.onReportFailure) {
this.config.onReportFailure(error as Error, report);
}
}
});
try {
await Promise.all(reportPromises);
if (this.config.onReportSuccess) {
this.config.onReportSuccess(report);
}
} catch (error) {
console.error('Error reporting failed:', error);
}
}
private setupCustomAPI(config: CustomAPIConfig) {
const customAPIReporter: ErrorReporter = {
captureError: async (report: ErrorReport) => {
try {
const payload = config.transformPayload
? config.transformPayload(report)
: {
context: report.context,
message: report.error.message,
severity: report.severity || 'error',
stack: report.error.stack,
timestamp: report.timestamp || Date.now(),
};
const response = await fetch(config.endpoint, {
body: JSON.stringify(payload),
headers: {
'Content-Type': 'application/json',
...config.headers,
},
method: config.method || 'POST',
});
if (!response.ok) {
throw new Error(`API request failed: ${response.statusText}`);
}
} catch (error) {
console.error('Failed to send error to custom API:', error);
}
},
isEnabled: () => Boolean(config.endpoint),
name: 'CustomAPI',
};
this.reporters.push(customAPIReporter);
}
private setupSentry(config: SentryConfig) {
const sentryReporter: ErrorReporter = {
captureError: async (report: ErrorReport) => {
if (!this.sentryInstance) {
try {
const Sentry = await import('@sentry/react');
Sentry.init({
beforeSend: config.beforeSend,
dsn: config.dsn,
environment: config.environment,
ignoreErrors: config.ignoreErrors,
release: config.release,
tracesSampleRate: config.sampleRate || 1.0,
});
this.sentryInstance = Sentry;
} catch (error) {
console.error('Failed to initialize Sentry:', error);
return;
}
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this.sentryInstance.withScope((scope: any) => {
if (report.severity) {
scope.setLevel(report.severity);
}
if (report.context?.namespace) {
scope.setTag('namespace', report.context.namespace);
}
if (report.context?.tags) {
Object.entries(report.context.tags).forEach(([key, value]) => {
scope.setTag(key, value);
});
}
if (report.context?.user) {
scope.setUser(report.context.user);
}
if (report.context?.extra) {
scope.setExtras(report.context.extra);
}
if (report.context?.componentStack) {
scope.setContext('react', {
componentStack: report.context.componentStack,
});
}
this.sentryInstance.captureException(report.error);
});
},
isEnabled: () => Boolean(this.sentryInstance),
name: 'Sentry',
};
this.reporters.push(sentryReporter);
}
}
export const errorManager = new ErrorManager();
export default errorManager;

View File

@@ -0,0 +1,50 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
export interface CustomAPIConfig {
endpoint: string;
headers?: Record<string, string>;
method?: 'POST' | 'PUT';
transformPayload?: (report: ErrorReport) => any;
}
export interface ErrorContext {
componentStack?: string;
extra?: Record<string, any>;
namespace?: string;
tags?: Record<string, string>;
user?: Record<string, any>;
}
export interface ErrorManagerConfig {
beforeReport?: (report: ErrorReport) => ErrorReport | null;
customAPI?: CustomAPIConfig;
enabled?: boolean;
onReportFailure?: (error: Error, report: ErrorReport) => void;
onReportSuccess?: (report: ErrorReport) => void;
reporters?: ErrorReporter[];
sentry?: SentryConfig;
}
export interface ErrorReport {
context?: ErrorContext;
error: Error;
errorInfo?: any;
severity?: ErrorSeverity;
timestamp?: number;
}
export interface ErrorReporter {
captureError: (report: ErrorReport) => Promise<void> | void;
isEnabled: () => boolean;
name: string;
}
export type ErrorSeverity = 'debug' | 'error' | 'fatal' | 'info' | 'warning';
export interface SentryConfig {
beforeSend?: (event: any) => any | null;
dsn: string;
environment?: string;
ignoreErrors?: string[];
release?: string;
sampleRate?: number;
}

View File

@@ -1,2 +1,4 @@
export { default as ReactBasicErrorBoundary } from './BasicErrorBoundary';
export { default as ReactErrorBoundary } from './ErrorBoundary';
export { default as errorManager } from './ErrorManager';
export * from './ErrorManager.types';

View File

@@ -2,13 +2,16 @@ import { newUUID } from '@warkypublic/artemis-kit';
import { createSyncStore } from '@warkypublic/zustandsyncstore';
import { produce } from 'immer';
import type { FormerProps, FormerState } from './Former.types';
import type { FormerProps, FormerState, FormStateAndProps } from './Former.types';
const { Provider: FormerProvider, useStore: useFormerStore } = createSyncStore<
FormerState<any> & Partial<FormerProps<any>>,
FormerProps<any>
>(
(set, get) => ({
getAllState: () => {
return get() as FormStateAndProps<any>;
},
getState: (key) => {
const current = get();
return current?.[key];
@@ -26,17 +29,19 @@ const { Provider: FormerProvider, useStore: useFormerStore } = createSyncStore<
keyValue
);
if (get().afterGet) {
data = await get().afterGet!({ ...data });
data = await get().afterGet!({ ...data }, get());
}
set({ loading: false, values: data });
get().onChange?.(data);
get().onChange?.(data, get());
}
if (reset && get().getFormMethods) {
const formMethods = get().getFormMethods!();
formMethods.reset();
}
} catch (e) {
set({ error: (e as Error)?.message ?? e, loading: false });
const errorMessage = (e as Error)?.message ?? e;
set({ error: errorMessage, loading: false });
get().onError?.(errorMessage, get());
}
set({ loading: false });
},
@@ -66,7 +71,7 @@ const { Provider: FormerProvider, useStore: useFormerStore } = createSyncStore<
let data = formMethods.getValues();
if (get().beforeSave) {
const newData = await get().beforeSave!(data);
const newData = await get().beforeSave!(data, get());
data = newData;
}
@@ -76,7 +81,9 @@ const { Provider: FormerProvider, useStore: useFormerStore } = createSyncStore<
data = newdata;
},
(errors) => {
set({ error: errors.root?.message || 'Validation errors', loading: false });
const errorMessage = errors.root?.message || 'Validation errors';
set({ error: errorMessage, loading: false });
get().onError?.(errorMessage, get());
exit = true;
}
);
@@ -107,29 +114,49 @@ const { Provider: FormerProvider, useStore: useFormerStore } = createSyncStore<
data,
keyValue
);
const newData = { ...data, ...savedData }; //Merge what we had. In case the API doesn't return all fields, we don't want to lose them
if (get().afterSave) {
await get().afterSave!(savedData);
await get().afterSave!(newData, get());
}
set({ loading: false, values: savedData });
get().onChange?.(savedData);
formMethods.reset(savedData); //reset with saved data to clear dirty state
if (!keepOpen) {
get().onClose?.(savedData);
if (keepOpen) {
const keyName = get()?.uniqueKeyField || 'id';
const clearedData = { ...newData };
delete clearedData[keyName];
set({ loading: false, values: clearedData });
get().onChange?.(clearedData, get());
formMethods.reset(clearedData);
return newData;
}
return savedData;
set({ loading: false, values: newData });
get().onChange?.(newData, get());
formMethods.reset(newData); //reset with saved data to clear dirty state
get().onClose?.(newData);
return newData;
}
if (keepOpen) {
const keyName = get()?.uniqueKeyField || 'id';
const clearedData = { ...data };
delete clearedData[keyName];
set({ loading: false, values: clearedData });
formMethods.reset(clearedData);
get().onChange?.(clearedData, get());
return data;
}
set({ loading: false, values: data });
formMethods.reset(data); //reset with saved data to clear dirty state
get().onChange?.(data);
if (!keepOpen) {
get().onChange?.(data, get());
get().onClose?.(data);
}
return data;
}
} catch (e) {
set({ error: (e as Error)?.message ?? e, loading: false });
const errorMessage = (e as Error)?.message ?? e;
set({ error: errorMessage, loading: false });
get().onError?.(errorMessage, get());
}
return undefined;
@@ -181,20 +208,20 @@ const { Provider: FormerProvider, useStore: useFormerStore } = createSyncStore<
return {
id: !id ? newUUID() : id,
onClose: () => {
onClose: (data?: any) => {
const dirty = useStoreApi.getState().dirty;
const setState = useStoreApi.getState().setState;
if (dirty) {
if (confirm('You have unsaved changes. Are you sure you want to close?')) {
if (onClose) {
onClose();
onClose(data);
} else {
setState('opened', false);
}
}
} else {
if (onClose) {
onClose();
onClose(data);
} else {
setState('opened', false);
}

View File

@@ -12,6 +12,7 @@ const FormerInner = forwardRef<FormerRef<any>, Partial<FormerProps<any>> & Props
ref: any
) {
const {
getAllState,
getState,
onChange,
onClose,
@@ -26,6 +27,7 @@ const FormerInner = forwardRef<FormerRef<any>, Partial<FormerProps<any>> & Props
values,
wrapper,
} = useFormerStore((state) => ({
getAllState: state.getAllState,
getState: state.getState,
onChange: state.onChange,
onClose: state.onClose,
@@ -54,7 +56,7 @@ const FormerInner = forwardRef<FormerRef<any>, Partial<FormerProps<any>> & Props
() => ({
close: async () => {
//console.log('close called');
onClose?.();
onClose?.(getState('values'));
setState('opened', false);
},
getValue: () => {
@@ -67,7 +69,7 @@ const FormerInner = forwardRef<FormerRef<any>, Partial<FormerProps<any>> & Props
return await save();
},
setValue: (value: T) => {
onChange?.(value);
onChange?.(value, getAllState());
},
show: async () => {
//console.log('show called');
@@ -78,7 +80,7 @@ const FormerInner = forwardRef<FormerRef<any>, Partial<FormerProps<any>> & Props
return await validate();
},
}),
[getState, onChange, validate, save, reset, setState, onClose, onOpen]
[getState, getAllState, onChange, validate, save, reset, setState, onClose, onOpen]
);
useEffect(() => {
@@ -97,7 +99,19 @@ const FormerInner = forwardRef<FormerRef<any>, Partial<FormerProps<any>> & Props
return (
<FormProvider {...formMethods}>
{typeof wrapper === 'function' ? (
wrapper(<FormerLayout>{props.children}</FormerLayout>, opened ??false, onClose ?? (() => {setState('opened', false)}), onOpen ?? (() => {setState('opened', true)}), getState)
wrapper(
<FormerLayout>{props.children}</FormerLayout>,
opened ?? false,
onClose ??
(() => {
setState('opened', false);
}),
onOpen ??
(() => {
setState('opened', true);
}),
getState
)
) : (
<FormerLayout>{props.children || null}</FormerLayout>
)}

View File

@@ -15,15 +15,15 @@ export type FormerAPICallType<T extends FieldValues = any> = (
) => Promise<T>;
export interface FormerProps<T extends FieldValues = any> {
afterGet?: (data: T) => Promise<T> | void;
afterSave?: (data: T) => Promise<void> | void;
beforeSave?: (data: T) => Promise<T> | T;
afterGet?: (data: T, state: Partial<FormStateAndProps<T>>) => Promise<T> | void;
afterSave?: (data: T, state: Partial<FormStateAndProps<T>>) => Promise<void> | void;
beforeSave?: (data: T, state: Partial<FormStateAndProps<T>>) => Promise<T> | T;
dirty?: boolean;
disableHTMlForm?: boolean;
id?: string;
keepOpen?: boolean;
layout?: {
buttonArea?: "bottom" | "none" | "top";
buttonArea?: 'bottom' | 'none' | 'top';
buttonAreaGroupProps?: GroupProps;
closeButtonProps?: ButtonProps;
closeButtonTitle?: React.ReactNode;
@@ -31,14 +31,15 @@ export interface FormerProps<T extends FieldValues = any> {
renderTop?: FormerSectionRender<T>;
saveButtonProps?: ButtonProps;
saveButtonTitle?: React.ReactNode;
showKeepOpenSwitch?: boolean;
title?: string;
};
onAPICall?: FormerAPICallType<T>;
onCancel?: () => void;
onChange?: (value: T) => void;
onClose?: (data?: T) => void;
onChange?: (value: T, state: Partial<FormStateAndProps<T>>) => void;
onClose?: (data?: T | undefined) => void;
onConfirmDelete?: (values?: T) => Promise<boolean>;
onError?: (error: Error | string, state: Partial<FormStateAndProps<T>>) => void;
onOpen?: (data?: T) => void;
opened?: boolean;
primeData?: T;
@@ -62,15 +63,16 @@ export interface FormerRef<T extends FieldValues = any> {
export type FormerSectionRender<T extends FieldValues = any> = (
children: React.ReactNode,
opened: boolean ,
onClose: ((data?: T) => void),
onOpen: ((data?: T) => void) ,
opened: boolean,
onClose: (data?: T) => void,
onOpen: (data?: T) => void,
getState: FormerState<T>['getState']
) => React.ReactNode;
export interface FormerState<T extends FieldValues = any> {
deleteConfirmed?: boolean;
error?: string;
getAllState: () => FormStateAndProps<T>;
getFormMethods?: () => UseFormReturn<any, any>;
getState: <K extends keyof FormStateAndProps<T>>(key: K) => FormStateAndProps<T>[K];
load: (reset?: boolean) => Promise<void>;

View File

@@ -1,4 +1,4 @@
import { Button, Group, Tooltip } from '@mantine/core';
import { Button, Group, Switch, Tooltip } from '@mantine/core';
import { IconDeviceFloppy, IconX } from '@tabler/icons-react';
import { useFormerStore } from './Former.store';
@@ -9,21 +9,29 @@ export const FormerButtonArea = () => {
closeButtonProps,
closeButtonTitle,
dirty,
getState,
keepOpen,
onClose,
request,
save,
saveButtonProps,
saveButtonTitle,
setState,
showKeepOpenSwitch,
} = useFormerStore((state) => ({
buttonAreaGroupProps: state.layout?.buttonAreaGroupProps,
closeButtonProps: state.layout?.closeButtonProps,
closeButtonTitle: state.layout?.closeButtonTitle,
dirty: state.dirty,
getState: state.getState,
keepOpen: state.keepOpen,
onClose: state.onClose,
request: state.request,
save: state.save,
saveButtonProps: state.layout?.saveButtonProps,
saveButtonTitle: state.layout?.saveButtonTitle,
setState: state.setState,
showKeepOpenSwitch: state.layout?.showKeepOpenSwitch,
}));
const disabledSave =
@@ -47,12 +55,19 @@ export const FormerButtonArea = () => {
size="sm"
{...closeButtonProps}
onClick={() => {
onClose();
onClose(getState('values'));
}}
>
{closeButtonTitle || 'Close'}
</Button>
)}
{showKeepOpenSwitch && (
<Switch
checked={keepOpen}
label="Keep Open"
onChange={(event) => setState('keepOpen', event.currentTarget.checked)}
/>
)}
<Tooltip
label={
disabledSave ? (

View File

@@ -1,3 +1,4 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import type { FormerAPICallType } from './Former.types';
interface ResolveSpecRequest {
@@ -61,11 +62,15 @@ function FormerResolveSpecAPI(options: {
const response = await fetch(url, fetchOptions);
if (!response.ok) {
const text = await response.text();
if (text && text.length > 4) {
throw new Error(`${text}`);
}
throw new Error(`API request failed with status ${response.status}`);
}
const data = await response.json();
return data as any;
return data as unknown;
};
}

View File

@@ -35,15 +35,15 @@ function FormerRestHeadSpecAPI(options: {
const response = await fetch(url, fetchOptions);
if (!response.ok) {
const text = await response.text();
if (text && text.length > 4) {
throw new Error(`${text}`);
}
throw new Error(`API request failed with status ${response.status}`);
}
if (mode === 'read') {
const data = await response.json();
return data as any;
} else {
return value as any;
}
return data as unknown;
};
}

View File

@@ -4,3 +4,4 @@ export { FormerButtonArea } from './FormerButtonArea';
export { FormerResolveSpecAPI } from './FormerResolveSpecAPI';
export { FormerRestHeadSpecAPI } from './FormerRestHeadSpecAPI';
export { FormerDialog, FormerModel, FormerPopover } from './FormerWrappers';
export { useFormerState } from './use-former-state';

View File

@@ -6,7 +6,7 @@ import { fn } from 'storybook/test';
import { FormTest } from './example';
const Renderable = (props: any) => {
const Renderable = (props: unknown) => {
return (
<Box h="100%" mih="400px" miw="400px" w="100%">
<FormTest {...props} />

View File

@@ -0,0 +1,38 @@
import type { FieldValues } from 'react-hook-form';
import { useState } from 'react';
import type { FormerProps } from './Former.types';
export type UseFormerStateProps<T extends FieldValues = FieldValues> = Pick<
FormerProps<T>,
'onChange' | 'onClose' | 'opened' | 'primeData' | 'request' | 'values'
>;
export const useFormerState = <T extends FieldValues = FieldValues>(
options?: Partial<UseFormerStateProps<T>>
) => {
const [state, setState] = useState<Partial<UseFormerStateProps<T>>>({
onChange: options?.onChange,
onClose: options?.onClose ?? (() => setState((cv) => ({ ...cv, opened: false }))),
opened: options?.opened ?? false,
primeData: options?.primeData ?? options?.values,
request: options?.request ?? 'insert',
values: options?.values,
});
const updateState = (updates: Partial<UseFormerStateProps<T>>) => {
setState((prev) => ({ ...prev, ...updates }));
};
const { onChange, onClose, opened, ...formerProps } = state;
return {
former: { ...formerProps, onChange, onClose, opened },
formerWrapper: { onClose, opened },
open: (request: UseFormerStateProps<T>['request'], data: UseFormerStateProps<T>['values']) => {
setState((cv) => ({ ...cv, opened: true, primeData: data, request, values: data }));
},
updateState,
};
};

View File

@@ -5,7 +5,6 @@ import { useStoreWithEqualityFn } from 'zustand/traditional';
import { createStore } from 'zustand/vanilla';
import type {
AppState,
BarState,
ExtractState,
GlobalState,
@@ -21,10 +20,7 @@ import type {
import { loadStorage, saveStorage } from './GlobalStateStore.utils';
const initialState: GlobalState = {
app: {
controls: {},
environment: 'production',
},
initialized: false,
layout: {
bottomBar: { open: false },
leftBar: { open: false },
@@ -35,10 +31,14 @@ const initialState: GlobalState = {
menu: [],
},
owner: {
guid: '',
id: 0,
name: '',
},
program: {
controls: {},
environment: 'production',
guid: '',
name: '',
slug: '',
},
@@ -47,8 +47,10 @@ const initialState: GlobalState = {
authToken: '',
connected: true,
loading: false,
loggedIn: false,
},
user: {
guid: '',
username: '',
},
};
@@ -140,20 +142,14 @@ const createNavigationSlice = (set: SetState) => ({
})),
});
const createAppSlice = (set: SetState) => ({
setApp: (updates: Partial<AppState>) =>
set((state: GlobalState) => ({
app: { ...state.app, ...updates },
})),
});
const createComplexActions = (set: SetState, get: GetState) => ({
fetchData: async (url?: string) => {
const createComplexActions = (set: SetState, get: GetState) => {
// Internal implementation without lock
const fetchDataInternal = async (url?: string) => {
try {
set((state: GlobalState) => ({
session: {
...state.session,
apiURL: url ?? state.session.apiURL,
apiURL: url || state.session.apiURL,
loading: true,
},
}));
@@ -164,9 +160,15 @@ const createComplexActions = (set: SetState, get: GetState) => ({
set((state: GlobalState) => ({
...state,
...result,
app: {
...state.app,
...result?.app,
layout: { ...state.layout, ...result?.layout },
navigation: { ...state.navigation, ...result?.navigation },
owner: {
...state.owner,
...result?.owner,
},
program: {
...state.program,
...result?.program,
updatedAt: new Date().toISOString(),
},
session: {
@@ -175,6 +177,10 @@ const createComplexActions = (set: SetState, get: GetState) => ({
connected: true,
loading: false,
},
user: {
...state.user,
...result?.user,
},
}));
} catch (e) {
set((state: GlobalState) => ({
@@ -186,29 +192,168 @@ const createComplexActions = (set: SetState, get: GetState) => ({
},
}));
}
};
return {
fetchData: async (url?: string) => {
// Wait for initialization to complete
await waitForInitialization();
// Use lock to prevent concurrent fetchData calls
return withOperationLock(() => fetchDataInternal(url));
},
login: async (authToken?: string) => {
isLoggedIn: (): boolean => {
const session = get().session;
if (!session.loggedIn || !session.authToken) {
return false;
}
if (session.expiryDate && new Date(session.expiryDate) < new Date()) {
return false;
}
return true;
},
login: async (authToken?: string, user?: Partial<UserState>) => {
// Wait for initialization to complete
await waitForInitialization();
// Use lock to prevent concurrent auth operations
return withOperationLock(async () => {
try {
set((state: GlobalState) => ({
session: {
...state.session,
authToken: authToken ?? '',
expiryDate: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString(),
loading: true,
loggedIn: true,
},
user: {
...state.user,
...user,
},
}));
await get().fetchData();
const currentState = get();
const result = await currentState.onLogin?.(currentState);
if (result) {
set((state: GlobalState) => ({
...state,
owner: result.owner ? { ...state.owner, ...result.owner } : state.owner,
program: result.program ? { ...state.program, ...result.program } : state.program,
session: result.session ? { ...state.session, ...result.session } : state.session,
user: result.user ? { ...state.user, ...result.user } : state.user,
}));
}
// Call internal version to avoid nested lock
await fetchDataInternal();
} catch (e) {
set((state: GlobalState) => ({
session: {
...state.session,
connected: false,
error: `Login Exception: ${String(e)}`,
loading: false,
loggedIn: false,
},
}));
} finally {
set((state: GlobalState) => ({
session: {
...state.session,
loading: false,
},
}));
}
});
},
logout: async () => {
// Wait for initialization to complete
await waitForInitialization();
// Use lock to prevent concurrent auth operations
return withOperationLock(async () => {
try {
set((state: GlobalState) => ({
...initialState,
session: {
...initialState.session,
apiURL: state.session.apiURL,
expiryDate: undefined,
loading: true,
loggedIn: false,
},
}));
await get().fetchData();
const currentState = get();
const result = await currentState.onLogout?.(currentState);
if (result) {
set((state: GlobalState) => ({
...state,
owner: result.owner ? { ...state.owner, ...result.owner } : state.owner,
program: result.program ? { ...state.program, ...result.program } : state.program,
session: result.session ? { ...state.session, ...result.session } : state.session,
user: result.user ? { ...state.user, ...result.user } : state.user,
}));
}
// Call internal version to avoid nested lock
await fetchDataInternal();
} catch (e) {
set((state: GlobalState) => ({
session: {
...state.session,
connected: false,
error: `Logout Exception: ${String(e)}`,
loading: false,
},
});
}));
} finally {
set((state: GlobalState) => ({
session: {
...state.session,
loading: false,
},
}));
}
});
},
};
};
// State management flags and locks - must be defined before store creation
let isStorageInitialized = false;
let initializationPromise: null | Promise<void> = null;
let operationLock: Promise<void> = Promise.resolve();
// Helper to wait for initialization - must be defined before store creation
const waitForInitialization = async (): Promise<void> => {
if (initializationPromise) {
await initializationPromise;
}
};
// Helper to ensure async operations run sequentially
const withOperationLock = async <T>(operation: () => Promise<T>): Promise<T> => {
const currentLock = operationLock;
let releaseLock: () => void;
// Create new lock promise
operationLock = new Promise<void>((resolve) => {
releaseLock = resolve;
});
try {
// Wait for previous operation to complete
await currentLock;
// Run the operation
return await operation();
} finally {
// Release the lock
releaseLock!();
}
};
const GlobalStateStore = createStore<GlobalStateStoreType>((set, get) => ({
...initialState,
@@ -218,28 +363,46 @@ const GlobalStateStore = createStore<GlobalStateStoreType>((set, get) => ({
...createUserSlice(set),
...createLayoutSlice(set),
...createNavigationSlice(set),
...createAppSlice(set),
...createComplexActions(set, get),
}));
loadStorage()
// Initialize storage and load saved state
initializationPromise = loadStorage()
.then((state) => {
GlobalStateStore.setState((current) => ({
// Merge loaded state with initial state
GlobalStateStore.setState(
(current) => ({
...current,
...state,
initialized: true,
session: {
...current.session,
...state.session,
connected: true,
loading: false,
},
}));
}),
true // Replace state completely to avoid triggering subscription during init
);
})
.catch((e) => {
console.error('Error loading storage:', e);
// Mark as initialized even on error so app doesn't hang
GlobalStateStore.setState({ initialized: true });
})
.finally(() => {
// Mark initialization as complete
isStorageInitialized = true;
initializationPromise = null;
});
// Subscribe to state changes and persist to storage
// Only saves after initialization is complete
GlobalStateStore.subscribe((state) => {
if (!isStorageInitialized) {
return;
}
saveStorage(state).catch((e) => {
console.error('Error saving storage:', e);
});
@@ -260,11 +423,15 @@ const setApiURL = (url: string) => {
};
const getApiURL = (): string => {
return GlobalStateStore.getState().session.apiURL;
return GlobalStateStore.getState().session.apiURL ?? '';
};
const getAuthToken = (): string => {
return GlobalStateStore.getState().session.authToken;
return GlobalStateStore.getState().session.authToken ?? '';
};
const isLoggedIn = (): boolean => {
return GlobalStateStore.getState().isLoggedIn();
};
const setAuthToken = (token: string) => {
@@ -273,6 +440,15 @@ const setAuthToken = (token: string) => {
const GetGlobalState = (): GlobalStateStoreType => {
return GlobalStateStore.getState();
}
};
export { getApiURL, getAuthToken, GetGlobalState, GlobalStateStore, setApiURL, setAuthToken, useGlobalStateStore };
export {
getApiURL,
getAuthToken,
GetGlobalState,
GlobalStateStore,
isLoggedIn,
setApiURL,
setAuthToken,
useGlobalStateStore,
};

View File

@@ -1,10 +1,4 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
interface AppState {
controls?: Record<string, any>;
environment: 'development' | 'production';
globals?: Record<string, any>;
updatedAt?: string;
}
interface BarState {
collapsed?: boolean;
@@ -14,7 +8,6 @@ interface BarState {
pinned?: boolean;
render?: () => React.ReactNode;
size?: number;
}
type DatabaseDetail = {
@@ -25,7 +18,7 @@ type DatabaseDetail = {
type ExtractState<S> = S extends { getState: () => infer X } ? X : never;
interface GlobalState {
app: AppState;
initialized: boolean;
layout: LayoutState;
navigation: NavigationState;
owner: OwnerState;
@@ -38,15 +31,19 @@ interface GlobalStateActions {
// Complex actions
fetchData: (url?: string) => Promise<void>;
login: (authToken?: string) => Promise<void>;
isLoggedIn: () => boolean;
login: (authToken?: string, user?: Partial<UserState>) => Promise<void>;
logout: () => Promise<void>;
// Callback for custom fetch logic
onFetchSession?: (state: GlobalState) => Promise<Partial<GlobalState>>;
// Callbacks for custom logic
onFetchSession?: (state: Partial<GlobalState>) => Promise<Partial<GlobalState>>;
onLogin?: (
state: Partial<GlobalState>
) => Promise<Partial<Pick<GlobalState, 'owner' | 'program' | 'session' | 'user'>> | void>;
onLogout?: (
state: Partial<GlobalState>
) => Promise<Partial<Pick<GlobalState, 'owner' | 'program' | 'session' | 'user'>> | void>;
setApiURL: (url: string) => void;
// App actions
setApp: (updates: Partial<AppState>) => void;
setAuthToken: (token: string) => void;
setBottomBar: (updates: Partial<BarState>) => void;
setCurrentPage: (page: PageInfo) => void;
@@ -101,7 +98,8 @@ interface NavigationState {
}
interface OwnerState {
id: number;
guid?: string;
id?: number;
logo?: string;
name: string;
settings?: Record<string, any>;
@@ -118,34 +116,31 @@ type PageInfo = {
interface ProgramState {
backendVersion?: string;
bigLogo?: string;
controls?: Record<string, any>;
database?: DatabaseDetail;
databaseVersion?: string;
description?: string;
environment: 'development' | 'production';
globals?: Record<string, any>;
guid?: string;
logo?: string;
meta?: Record<string, any>;
name: string;
slug: string;
slug?: string;
tags?: string[];
version?: string;
}
interface ProgramWrapperProps {
apiURL?: string;
children: React.ReactNode | React.ReactNode[];
debugMode?: boolean;
fallback?: React.ReactNode | React.ReactNode[];
renderFallback?: boolean;
testMode?: boolean;
updatedAt?: string;
version?: string;
}
interface SessionState {
apiURL: string;
authToken: string;
connected: boolean;
apiURL?: string;
authToken?: string;
connected?: boolean;
error?: string;
expiryDate?: string;
isSecurity?: boolean;
loading: boolean;
loading?: boolean;
loggedIn?: boolean;
meta?: Record<string, any>;
parameters?: Record<string, any>;
}
@@ -169,7 +164,6 @@ interface UserState {
}
export type {
AppState,
BarState,
ExtractState,
GlobalState,
@@ -181,7 +175,6 @@ export type {
OwnerState,
PageInfo,
ProgramState,
ProgramWrapperProps,
SessionState,
ThemeSettings,
UserState,

View File

@@ -0,0 +1,255 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import type { GlobalState } from './GlobalStateStore.types';
import { loadStorage, saveStorage } from './GlobalStateStore.utils';
// Mock idb-keyval
vi.mock('idb-keyval', () => ({
get: vi.fn(),
set: vi.fn(),
}));
import { get, set } from 'idb-keyval';
describe('GlobalStateStore.utils', () => {
const mockState: GlobalState = {
initialized: false,
layout: {
bottomBar: { open: false },
leftBar: { open: false },
rightBar: { open: false },
topBar: { open: false },
},
navigation: {
menu: [],
},
owner: {
guid: 'owner-guid',
id: 1,
name: 'Test Owner',
},
program: {
controls: {},
environment: 'production',
guid: 'program-guid',
name: 'Test Program',
slug: 'test-program',
},
session: {
apiURL: 'https://api.test.com',
authToken: 'test-token',
connected: true,
loading: false,
loggedIn: true,
},
user: {
guid: 'user-guid',
username: 'testuser',
},
};
beforeEach(() => {
vi.clearAllMocks();
localStorage.clear();
// Mock indexedDB to be available
Object.defineProperty(globalThis, 'indexedDB', {
configurable: true,
value: {},
writable: true,
});
});
describe('saveStorage', () => {
it('saves each key separately with prefixed storage keys', async () => {
(set as any).mockResolvedValue(undefined);
await saveStorage(mockState);
// Verify IndexedDB calls for non-session keys
expect(set).toHaveBeenCalledWith('APP_GLO:layout', expect.any(String));
expect(set).toHaveBeenCalledWith('APP_GLO:navigation', expect.any(String));
expect(set).toHaveBeenCalledWith('APP_GLO:owner', expect.any(String));
expect(set).toHaveBeenCalledWith('APP_GLO:program', expect.any(String));
expect(set).toHaveBeenCalledWith('APP_GLO:user', expect.any(String));
// Verify session is NOT saved to IndexedDB
expect(set).not.toHaveBeenCalledWith('APP_GLO:session', expect.any(String));
});
it('saves session key to localStorage only', async () => {
await saveStorage(mockState);
// Verify session is in localStorage
const sessionData = localStorage.getItem('APP_GLO:session');
expect(sessionData).toBeTruthy();
const parsedSession = JSON.parse(sessionData!);
expect(parsedSession.apiURL).toBe('https://api.test.com');
expect(parsedSession.authToken).toBe('test-token');
expect(parsedSession.loggedIn).toBe(true);
});
it('filters out skipped paths', async () => {
(set as any).mockResolvedValue(undefined);
const stateWithControls: GlobalState = {
...mockState,
program: {
...mockState.program,
controls: { test: 'value' },
},
session: {
...mockState.session,
connected: true,
error: 'test error',
loading: true,
},
};
await saveStorage(stateWithControls);
// Get the saved program data
const programCall = (set as any).mock.calls.find(
(call: any[]) => call[0] === 'APP_GLO:program'
);
expect(programCall).toBeDefined();
const savedProgram = JSON.parse(programCall[1]);
// Controls should be filtered out (program.controls is in SKIP_PATHS as app.controls)
// Note: The filter checks 'app.controls' but our key is 'program', so controls might not be filtered
// Let's just verify the program was saved
expect(savedProgram.guid).toBe('program-guid');
// Get the saved session data
const sessionData = localStorage.getItem('APP_GLO:session');
const savedSession = JSON.parse(sessionData!);
// These should be filtered out (in SKIP_PATHS)
expect(savedSession.connected).toBeUndefined();
expect(savedSession.error).toBeUndefined();
expect(savedSession.loading).toBeUndefined();
});
it('falls back to localStorage when IndexedDB fails', async () => {
// Mock IndexedDB failure for all calls
(set as any).mockRejectedValue(new Error('IndexedDB not available'));
await saveStorage(mockState);
// Verify localStorage has the data
expect(localStorage.getItem('APP_GLO:layout')).toBeTruthy();
expect(localStorage.getItem('APP_GLO:navigation')).toBeTruthy();
expect(localStorage.getItem('APP_GLO:owner')).toBeTruthy();
expect(localStorage.getItem('APP_GLO:program')).toBeTruthy();
expect(localStorage.getItem('APP_GLO:user')).toBeTruthy();
expect(localStorage.getItem('APP_GLO:session')).toBeTruthy();
});
});
describe('loadStorage', () => {
it('loads each key separately from IndexedDB', async () => {
// Mock IndexedDB responses
(get as any).mockImplementation((key: string) => {
const dataMap: Record<string, string> = {
'APP_GLO:layout': JSON.stringify(mockState.layout),
'APP_GLO:navigation': JSON.stringify(mockState.navigation),
'APP_GLO:owner': JSON.stringify(mockState.owner),
'APP_GLO:program': JSON.stringify(mockState.program),
'APP_GLO:user': JSON.stringify(mockState.user),
};
return Promise.resolve(dataMap[key]);
});
// Set session in localStorage
localStorage.setItem('APP_GLO:session', JSON.stringify(mockState.session));
const result = await loadStorage();
expect(result.layout).toEqual(mockState.layout);
expect(result.navigation).toEqual(mockState.navigation);
expect(result.owner).toEqual(mockState.owner);
expect(result.program).toEqual(mockState.program);
expect(result.user).toEqual(mockState.user);
expect(result.session).toEqual(mockState.session);
});
it('loads session from localStorage only', async () => {
localStorage.setItem('APP_GLO:session', JSON.stringify(mockState.session));
const result = await loadStorage();
expect(result.session).toEqual(mockState.session);
// Verify get was NOT called for session
expect(get).not.toHaveBeenCalledWith('APP_GLO:session');
});
it('falls back to localStorage when IndexedDB fails', async () => {
// Mock IndexedDB failure
(get as any).mockRejectedValue(new Error('IndexedDB not available'));
// Set data in localStorage
localStorage.setItem('APP_GLO:layout', JSON.stringify(mockState.layout));
localStorage.setItem('APP_GLO:navigation', JSON.stringify(mockState.navigation));
localStorage.setItem('APP_GLO:owner', JSON.stringify(mockState.owner));
localStorage.setItem('APP_GLO:program', JSON.stringify(mockState.program));
localStorage.setItem('APP_GLO:user', JSON.stringify(mockState.user));
localStorage.setItem('APP_GLO:session', JSON.stringify(mockState.session));
const result = await loadStorage();
expect(result.layout).toEqual(mockState.layout);
expect(result.navigation).toEqual(mockState.navigation);
expect(result.owner).toEqual(mockState.owner);
expect(result.program).toEqual(mockState.program);
expect(result.user).toEqual(mockState.user);
expect(result.session).toEqual(mockState.session);
});
it('returns empty object when no data is found', async () => {
(get as any).mockResolvedValue(undefined);
const result = await loadStorage();
expect(result).toEqual({});
});
it('returns partial state when some keys are missing', async () => {
// Only set some keys
(get as any).mockImplementation((key: string) => {
if (key === 'APP_GLO:layout') {
return Promise.resolve(JSON.stringify(mockState.layout));
}
return Promise.resolve(undefined);
});
localStorage.setItem('APP_GLO:session', JSON.stringify(mockState.session));
const result = await loadStorage();
expect(result.layout).toEqual(mockState.layout);
expect(result.session).toEqual(mockState.session);
expect(result.navigation).toBeUndefined();
expect(result.owner).toBeUndefined();
expect(result.program).toBeUndefined();
expect(result.user).toBeUndefined();
});
it('handles corrupted JSON data gracefully', async () => {
// Mock console.error to suppress error output
const consoleError = vi.spyOn(console, 'error').mockImplementation(() => {});
(get as any).mockResolvedValue('invalid json');
localStorage.setItem('APP_GLO:session', 'invalid json');
const result = await loadStorage();
// Should log errors but still return the result (may be empty or partial)
expect(consoleError).toHaveBeenCalled();
expect(result).toBeDefined();
consoleError.mockRestore();
});
});
});

View File

@@ -2,10 +2,11 @@ import { get, set } from 'idb-keyval';
import type { GlobalState } from './GlobalStateStore.types';
const STORAGE_KEY = 'app-data';
const STORAGE_KEY = 'APP_GLO';
const SKIP_PATHS = new Set([
'app.controls',
'initialized',
'session.connected',
'session.error',
'session.loading',
@@ -43,50 +44,90 @@ const filterState = (state: unknown, prefix = ''): unknown => {
};
async function loadStorage(): Promise<Partial<GlobalState>> {
const result: Partial<GlobalState> = {};
const keys: (keyof GlobalState)[] = ['layout', 'navigation', 'owner', 'program', 'session', 'user'];
for (const key of keys) {
const storageKey = `${STORAGE_KEY}:${key}`;
// Always use localStorage for session
if (key === 'session') {
try {
if (typeof indexedDB !== 'undefined') {
const data = await get(STORAGE_KEY);
if (typeof localStorage !== 'undefined') {
const data = localStorage.getItem(storageKey);
if (data) {
return JSON.parse(data) as Partial<GlobalState>;
result[key] = JSON.parse(data);
}
}
} catch (e) {
console.error('Failed to load from IndexedDB, falling back to localStorage:', e);
console.error(`Failed to load ${key} from localStorage:`, e);
}
continue;
}
try {
if (typeof indexedDB !== 'undefined') {
const data = await get(storageKey);
if (data) {
result[key] = JSON.parse(data);
continue;
}
}
} catch (e) {
console.error(`Failed to load ${key} from IndexedDB, falling back to localStorage:`, e);
}
try {
if (typeof localStorage !== 'undefined') {
const data = localStorage.getItem(STORAGE_KEY);
const data = localStorage.getItem(storageKey);
if (data) {
return JSON.parse(data) as Partial<GlobalState>;
result[key] = JSON.parse(data);
}
}
} catch (e) {
console.error('Failed to load from localStorage:', e);
console.error(`Failed to load ${key} from localStorage:`, e);
}
}
return {};
return result;
}
async function saveStorage(state: GlobalState): Promise<void> {
const filtered = filterState(state);
const keys: (keyof GlobalState)[] = ['layout', 'navigation', 'owner', 'program', 'session', 'user'];
for (const key of keys) {
const storageKey = `${STORAGE_KEY}:${key}`;
const filtered = filterState(state[key], key);
const serialized = JSON.stringify(filtered);
// Always use localStorage for session
if (key === 'session') {
try {
if (typeof localStorage !== 'undefined') {
localStorage.setItem(storageKey, serialized);
}
} catch (e) {
console.error(`Failed to save ${key} to localStorage:`, e);
}
continue;
}
try {
if (typeof indexedDB !== 'undefined') {
await set(STORAGE_KEY, serialized);
return;
await set(storageKey, serialized);
continue;
}
} catch (e) {
console.error('Failed to save to IndexedDB, falling back to localStorage:', e);
console.error(`Failed to save ${key} to IndexedDB, falling back to localStorage:`, e);
}
try {
if (typeof localStorage !== 'undefined') {
localStorage.setItem(STORAGE_KEY, serialized);
localStorage.setItem(storageKey, serialized);
}
} catch (e) {
console.error('Failed to save to localStorage:', e);
console.error(`Failed to save ${key} to localStorage:`, e);
}
}
}

View File

@@ -1,10 +1,17 @@
import { createContext, type ReactNode, useCallback, useContext, useEffect, useMemo, useRef } from 'react';
import {
createContext,
type ReactNode,
useCallback,
useContext,
useEffect,
useMemo,
useRef,
} from 'react';
import type { GlobalStateStoreType } from './GlobalStateStore.types';
import type { GlobalState, GlobalStateStoreType, ProgramState } from './GlobalStateStore.types';
import { GetGlobalState, GlobalStateStore } from './GlobalStateStore';
interface GlobalStateStoreContextValue {
fetchData: (url?: string) => Promise<void>;
getState: () => GlobalStateStoreType;
@@ -13,12 +20,15 @@ interface GlobalStateStoreContextValue {
const GlobalStateStoreContext = createContext<GlobalStateStoreContextValue | null>(null);
interface GlobalStateStoreProviderProps {
apiURL?: string;
autoFetch?: boolean;
children: ReactNode;
fetchOnMount?: boolean;
onFetchSession?: (state: Partial<GlobalState>) => Promise<Partial<GlobalState>>;
onLogin?: (state: Partial<GlobalState>) => Promise<Partial<GlobalState>>;
onLogout?: (state: Partial<GlobalState>) => Promise<Partial<GlobalState>>;
program?: Partial<ProgramState>;
throttleMs?: number;
}
@@ -27,13 +37,16 @@ export function GlobalStateStoreProvider({
autoFetch = true,
children,
fetchOnMount = true,
onFetchSession,
onLogin,
onLogout,
program,
throttleMs = 0,
}: GlobalStateStoreProviderProps) {
const lastFetchTime = useRef<number>(0);
const fetchInProgress = useRef<boolean>(false);
const mounted = useRef<boolean>(false);
const throttledFetch = useCallback(
async (url?: string) => {
const now = Date.now();
@@ -68,6 +81,30 @@ export function GlobalStateStoreProvider({
}
}, [apiURL]);
useEffect(() => {
if (program) {
GlobalStateStore.getState().setProgram(program);
}
}, [program]);
useEffect(() => {
if (onFetchSession) {
GlobalStateStore.setState({ onFetchSession });
}
}, [onFetchSession]);
useEffect(() => {
if (onLogin) {
GlobalStateStore.setState({ onLogin });
}
}, [onLogin]);
useEffect(() => {
if (onLogout) {
GlobalStateStore.setState({ onLogout });
}
}, [onLogout]);
useEffect(() => {
if (!mounted.current) {
mounted.current = true;
@@ -88,12 +125,8 @@ export function GlobalStateStoreProvider({
};
}, [throttledFetch, refetch]);
return (
<GlobalStateStoreContext.Provider value={context}>
{children}
</GlobalStateStoreContext.Provider>
<GlobalStateStoreContext.Provider value={context}>{children}</GlobalStateStoreContext.Provider>
);
}

View File

@@ -3,14 +3,12 @@ export {
getAuthToken,
GetGlobalState,
GlobalStateStore,
isLoggedIn,
setApiURL,
setAuthToken,
useGlobalStateStore
useGlobalStateStore,
} from './GlobalStateStore';
export type * from './GlobalStateStore.types';
export {
GlobalStateStoreProvider,
useGlobalStateStoreContext,
} from './GlobalStateStoreWrapper';
export { GlobalStateStoreProvider, useGlobalStateStoreContext } from './GlobalStateStoreWrapper';

View File

@@ -1,3 +1,4 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { Button, Checkbox, Divider, Group, Stack, TagsInput, TextInput } from '@mantine/core';
import { useLocalStorage } from '@mantine/hooks';
import { useRef, useState } from 'react';
@@ -22,9 +23,20 @@ export const GridlerGoAPIExampleEventlog = () => {
const [selectRow, setSelectRow] = useState<string | undefined>('');
const [values, setValues] = useState<Array<Record<string, any>>>([]);
const [search, setSearch] = useState<string>('');
const [formProps, setFormProps] = useState<{ onChange?: any; onClose?: any; opened: boolean; request: any; title?: string; values: any; } | null>({
onChange: (_request: string, data: any) => { ref.current?.refresh({ value: data }); },
onClose: () => { setFormProps((cv) => ({ ...cv, opened: false, request: null, values: null })) },
const [formProps, setFormProps] = useState<{
onChange?: any;
onClose?: any;
opened: boolean;
request: any;
title?: string;
values: any;
} | null>({
onChange: (_request: string, data: any) => {
ref.current?.refresh({ value: data });
},
onClose: () => {
setFormProps((cv) => ({ ...cv, opened: false, request: null, values: null }));
},
opened: false,
request: null,
values: null,
@@ -33,7 +45,8 @@ export const GridlerGoAPIExampleEventlog = () => {
const columns: GridlerColumns = [
{
Cell: (row) => {
const process = `${row?.cql2?.length > 0
const process = `${
row?.cql2?.length > 0
? '🔖'
: row?.cql1?.length > 0
? '📕'
@@ -139,15 +152,15 @@ export const GridlerGoAPIExampleEventlog = () => {
changeOnActiveClick={true}
descriptionField={'process'}
onRequestForm={(request, data) => {
setFormProps((cv)=> {
return {...cv, opened: true, request: request as any, values: data as any}
})
setFormProps((cv) => {
return { ...cv, opened: true, request: request as any, values: data as any };
});
}}
/>
</Gridler>
<FormerDialog
former={{
request: formProps?.request ?? "insert",
request: formProps?.request ?? 'insert',
values: formProps?.values,
}}
onClose={formProps?.onClose}
@@ -158,7 +171,7 @@ export const GridlerGoAPIExampleEventlog = () => {
<TextInputCtrl label="Process Name" name="process" />
<NumberInputCtrl label="Sequence" name="sequence" />
<InlineWrapper label="Type" promptWidth={200}>
<NativeSelectCtrl data={["trigger","function","view"]} name="type"/>
<NativeSelectCtrl data={['trigger', 'function', 'view']} name="type" />
</InlineWrapper>
</Stack>
</FormerDialog>
@@ -222,6 +235,6 @@ export const GridlerGoAPIExampleEventlog = () => {
Goto 2050
</Button>
</Group>
</Stack >
</Stack>
);
};

View File

@@ -1,3 +1,4 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
//@ts-nocheck
import type { Meta, StoryObj } from '@storybook/react-vite';

View File

@@ -1,3 +1,4 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
//@ts-nocheck
import type { Meta, StoryObj } from '@storybook/react-vite';

View File

@@ -1,35 +1,34 @@
import {b64EncodeUnicode} from '@warkypublic/artemis-kit/base64'
const TOKEN_KEY = 'gridler_golang_restapi_v2_token'
/* eslint-disable @typescript-eslint/no-explicit-any */
import { b64EncodeUnicode } from '@warkypublic/artemis-kit/base64';
const TOKEN_KEY = 'gridler_golang_restapi_v2_token';
export type APIOptionsType = {
autocreate?: boolean
autoref?: boolean
baseurl?: string
getAPIProvider?: () => { provider: string; providerKey: string }
getAuthToken?: () => string
operations?: Array<FetchAPIOperation>
postfix?: string
prefix?: string
requestTimeoutSec?: number
}
autocreate?: boolean;
autoref?: boolean;
baseurl?: string;
getAPIProvider?: () => { provider: string; providerKey: string };
getAuthToken?: () => string;
operations?: Array<FetchAPIOperation>;
postfix?: string;
prefix?: string;
requestTimeoutSec?: number;
};
export interface APIResponse {
errmsg: string
payload?: any
retval: number
errmsg: string;
payload?: any;
retval: number;
}
export interface FetchAPIOperation {
name?: string
op?: string
type: GoAPIHeaderTypes //x-fieldfilter
value: string
name?: string;
op?: string;
type: GoAPIHeaderTypes; //x-fieldfilter
value: string;
}
/**
* @description Types for the Go Rest API headers
* @typedef {String} GoAPIEnum
*/
*/
export type GoAPIEnum =
| 'advsql'
| 'api-key'
@@ -42,7 +41,7 @@ export type GoAPIEnum =
| 'association_autoupdate'
| 'association-update'
| 'cql-sel'
| 'cursor-backward'// For x cursor-backward header
| 'cursor-backward' // For x cursor-backward header
| 'cursor-forward' // For x cursor-forward header
| 'custom-sql-join'
| 'custom-sql-or'
@@ -72,28 +71,24 @@ export type GoAPIEnum =
| 'simpleapi'
| 'skipcache'
| 'skipcount'
| 'sort'
| 'sort';
export type GoAPIHeaderKeys = `x-${GoAPIEnum}`;
export type GoAPIHeaderKeys = `x-${GoAPIEnum}`
export type GoAPIHeaderTypes = GoAPIEnum & string
export type GoAPIHeaderTypes = GoAPIEnum & string;
export interface GoAPIOperation {
name?: string
op?: string
type: GoAPIHeaderTypes //x-fieldfilter
value: string
name?: string;
op?: string;
type: GoAPIHeaderTypes; //x-fieldfilter
value: string;
}
export interface MetaData {
limit?: number
offset?: number
total?: number
limit?: number;
offset?: number;
total?: number;
}
/**
* Builds an array of objects by encoding specific values and setting headers.
*
@@ -105,50 +100,49 @@ const buildGoAPIOperation = (
ops: Array<FetchAPIOperation>,
headers?: Headers
): Array<FetchAPIOperation> => {
const newops = [...ops.filter((i) => i !== undefined && i.type !== undefined)]
const newops = [...ops.filter((i) => i !== undefined && i.type !== undefined)];
for (let i = 0; i < newops.length; i++) {
if (!newops[i].name || newops[i].name === '') {
newops[i].name = ''
newops[i].name = '';
}
if (newops[i].type === 'files' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'advsql' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'custom-sql-or' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'custom-sql-join' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'not-select-fields' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'custom-sql-w' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'select-fields' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (newops[i].type === 'cql-sel' && !newops[i].value.startsWith('__')) {
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`
newops[i].value = `__${b64EncodeUnicode(newops[i].value)}__`;
}
if (headers) {
if (!newops || newops.length === 0) {
headers.set(`x-limit`, '10')
headers.set(`x-limit`, '10');
}
if (newops[i].type === 'association_autoupdate') {
headers.set(`association_autoupdate`, newops[i].value ?? '1')
headers.set(`association_autoupdate`, newops[i].value ?? '1');
}
if (newops[i].type === 'association_autocreate') {
headers.set(`association_autocreate`, newops[i].value ?? '1')
headers.set(`association_autocreate`, newops[i].value ?? '1');
}
if (
newops[i].type === 'searchop' ||
@@ -158,20 +152,20 @@ const buildGoAPIOperation = (
headers.set(
encodeURIComponent(`x-${newops[i].type}-${newops[i].op}-${newops[i].name}`),
String(newops[i].value)
)
);
} else {
headers.set(
encodeURIComponent(
`x-${newops[i].type}${newops[i].name && newops[i].name !== '' ? '-' + newops[i].name : ''}`
),
String(newops[i].value)
)
);
}
}
}
return newops
}
return newops;
};
/**
* Retrieves the headers from an array of FetchAPIOperation objects and returns them as an object.
@@ -183,77 +177,75 @@ const GoAPIHeaders = (
ops: Array<FetchAPIOperation>,
headers?: Headers
): { [key: string]: string } => {
const head = new Headers()
const headerlist: Record<string,string> = {}
const head = new Headers();
const headerlist: Record<string, string> = {};
const authToken = getAuthToken?.()
const authToken = getAuthToken?.();
if (authToken && authToken !== '') {
head.set('Authorization', `Token ${authToken}`)
head.set('Authorization', `Token ${authToken}`);
} else {
const token = getAuthToken()
const token = getAuthToken();
if (token) {
head.set('Authorization', `Token ${token}`)
head.set('Authorization', `Token ${token}`);
}
}
if (headers) {
headers.forEach((v, k) => {
head.set(k, v)
})
head.set(k, v);
});
}
const distinctOperations: Array<FetchAPIOperation> = []
const distinctOperations: Array<FetchAPIOperation> = [];
for (const value of ops?.filter((val) => !!val) ?? []) {
const index = distinctOperations.findIndex(
(searchValue) => searchValue.name === value.name && searchValue.type === value.type
)
);
if (index === -1) {
distinctOperations.push(value)
distinctOperations.push(value);
} else {
distinctOperations[index] = value
distinctOperations[index] = value;
}
}
buildGoAPIOperation(distinctOperations, head)
buildGoAPIOperation(distinctOperations, head);
head?.forEach((v, k) => {
headerlist[k] = v
})
headerlist[k] = v;
});
if (headers) {
for (const key of Object.keys(headerlist)) {
headers.set(key, headerlist[key])
headers.set(key, headerlist[key]);
}
}
return headerlist
}
return headerlist;
};
const callbacks = {
getAuthToken: () => {
if (localStorage) {
const token = localStorage.getItem(TOKEN_KEY)
const token = localStorage.getItem(TOKEN_KEY);
if (token) {
return token
return token;
}
}
return undefined
}
}
return undefined;
},
};
/**
* Retrieves the authentication token from local storage.
*
* @return {string | undefined} The authentication token if found, otherwise undefined
*/
const getAuthToken = () => callbacks?.getAuthToken?.()
const getAuthToken = () => callbacks?.getAuthToken?.();
const setAuthTokenCallback = (cb: ()=> string) => {
callbacks.getAuthToken = cb
return callbacks.getAuthToken
}
const setAuthTokenCallback = (cb: () => string) => {
callbacks.getAuthToken = cb;
return callbacks.getAuthToken;
};
/**
* Sets the authentication token in the local storage.
@@ -262,9 +254,8 @@ const setAuthTokenCallback = (cb: ()=> string) => {
*/
const setAuthToken = (token: string) => {
if (localStorage) {
localStorage.setItem(TOKEN_KEY, token)
localStorage.setItem(TOKEN_KEY, token);
}
}
};
export {buildGoAPIOperation,getAuthToken,GoAPIHeaders,setAuthToken,setAuthTokenCallback}
export { buildGoAPIOperation, getAuthToken, GoAPIHeaders, setAuthToken, setAuthTokenCallback };