@axelor/aos-mobile-error 0.0.1

package/README.md

@@ -0,0 +1,39 @@
+<h1 align="center">@axelor/aos-mobile-error</h1>
+
+<div align="center">
+    <img src="https://i.imgur.com/KJAAFlT.png" width="30%"/>
+</div>
+
+## Presentation
+
+This package was developed for the [Axelor Open Mobile](https://github.com/axelor/axelor-mobile) application.
+
+It only contains an ErrorBoundary component compatible with all React v18.2.x projects linked to an ERP based on [Axelor Open Platform](https://github.com/axelor/axelor-open-platform).
+
+## Usage
+
+Install the library :
+
+```bash
+yarn add @axelor/aos-mobile-error
+```
+
+All you have to do here is to wrap your application component with the ErrorBoundary component. It will catch all render errors and display the errorScreen provided to allow user to reload the application.
+
+The component needs the following props: 
+* errorScreen : screen to be displayed when an error is detected
+```typescript
+errorScreen: ({errorMessage, onReloadPress}) => React.ReactNode;
+```
+* userIdfetcher : function to fetch user information
+```typescript
+userIdfetcher: () => Promise<any>;
+```
+* putMethod : function to perform a PUT request to the server in order to inform it of the error
+```typescript
+putMethod: (fetchOptions: {additionalURL: string; data: any}) => Promise<any>;
+```
+
+## Developpment
+
+This package is developed as part of the Axelor Open Mobile application. To contribute, please go to the [Github project](https://github.com/axelor/axelor-mobile) and follow the guidelines. You will also find an installation guide to help you configure your environment.

package/lib/ErrorBoundary.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+interface ErrorBoundaryProps {
+    children: React.ReactNode;
+    errorScreen: ({ errorMessage, onReloadPress, }: {
+        errorMessage: string;
+        onReloadPress: () => any;
+    }) => React.ReactNode;
+    putMethod: (fetchOptions: {
+        additionalURL: string;
+        data: any;
+    }) => Promise<any>;
+    userIdfetcher: () => Promise<any>;
+}
+interface ErrorBoundaryState {
+    hasError: boolean;
+    tracing: boolean;
+    errorMessage: string;
+}
+declare class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: any);
+    static getDerivedStateFromError(): {
+        hasError: boolean;
+    };
+    componentDidCatch(error: any, errorInfo: any): void;
+    reloadApp(): void;
+    render(): React.ReactNode;
+}
+export default ErrorBoundary;

package/lib/ErrorBoundary.js

@@ -0,0 +1,71 @@
+/*
+ * Axelor Business Solutions
+ *
+ * Copyright (C) 2023 Axelor (<http://axelor.com>).
+ *
+ * This program is free software: you can redistribute it and/or  modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import React from 'react';
+const TECHNICAL_ABNORMALITY = 0;
+const CONFIGURATION_PROBLEM = 4;
+class ErrorBoundary extends React.Component {
+    constructor(props) {
+        super(props);
+        this.state = {
+            hasError: false,
+            tracing: false,
+            errorMessage: '',
+        };
+    }
+    static getDerivedStateFromError() {
+        return { hasError: true };
+    }
+    componentDidCatch(error, errorInfo) {
+        const { putMethod, userIdfetcher } = this.props;
+        userIdfetcher().then(userId => {
+            this.setState(state => ({
+                ...state,
+                tracing: true,
+                errorMessage: error.message,
+            }));
+            putMethod({
+                additionalURL: '/ws/rest/com.axelor.exception.db.TraceBack',
+                data: {
+                    origin: 'mobile app',
+                    typeSelect: TECHNICAL_ABNORMALITY,
+                    categorySelect: CONFIGURATION_PROBLEM,
+                    date: new Date(),
+                    exception: error.message,
+                    message: error.message,
+                    cause: JSON.stringify(errorInfo.componentStack),
+                    internalUser: { id: userId },
+                },
+            }).finally(() => this.setState(state => ({ ...state, tracing: false })));
+        });
+    }
+    reloadApp() {
+        window.location.reload();
+    }
+    render() {
+        const { errorScreen } = this.props;
+        if (this.state.hasError) {
+            return errorScreen({
+                errorMessage: this.state.errorMessage,
+                onReloadPress: () => this.setState({ hasError: false }),
+            });
+        }
+        return this.props.children;
+    }
+}
+export default ErrorBoundary;
+//# sourceMappingURL=ErrorBoundary.js.map

package/lib/ErrorBoundary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorBoundary.js","sourceRoot":"","sources":["../src/ErrorBoundary.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAqBhC,MAAM,aAAc,SAAQ,KAAK,CAAC,SAGjC;IACC,YAAY,KAAK;QACf,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,GAAG;YACX,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,EAAE;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB;QAC7B,OAAO,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;IAC1B,CAAC;IAED,iBAAiB,CAAC,KAAK,EAAE,SAAS;QAChC,MAAM,EAAC,SAAS,EAAE,aAAa,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC9C,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACtB,GAAG,KAAK;gBACR,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,KAAK,CAAC,OAAO;aAC5B,CAAC,CAAC,CAAC;YAEJ,SAAS,CAAC;gBACR,aAAa,EAAE,4CAA4C;gBAC3D,IAAI,EAAE;oBACJ,MAAM,EAAE,YAAY;oBACpB,UAAU,EAAE,qBAAqB;oBACjC,cAAc,EAAE,qBAAqB;oBACrC,IAAI,EAAE,IAAI,IAAI,EAAE;oBAChB,SAAS,EAAE,KAAK,CAAC,OAAO;oBACxB,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC;oBAC/C,YAAY,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC;iBAC3B;aACF,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAC,GAAG,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACN,MAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IACpC,CAAC;IAED,MAAM;QACJ,MAAM,EAAC,WAAW,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACjC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACvB,OAAO,WAAW,CAAC;gBACjB,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;gBACrC,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC;aACtD,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;CACF;AAED,eAAe,aAAa,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { default as ErrorBoundary } from './ErrorBoundary';

package/lib/index.js

@@ -0,0 +1,19 @@
+/*
+ * Axelor Business Solutions
+ *
+ * Copyright (C) 2023 Axelor (<http://axelor.com>).
+ *
+ * This program is free software: you can redistribute it and/or  modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export { default as ErrorBoundary } from './ErrorBoundary';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@axelor/aos-mobile-error",
+  "version": "0.0.1",
+  "author": "Axelor",
+  "license": "AGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.js",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "clean": "rm -rf lib/",
+    "compile": "tsc -p tsconfig.build.json",
+    "dev": "npm run compile -- --watch",
+    "build": "npm run clean && npm run compile && npm run copy:assets",
+    "publish": "npm publish",
+    "lint": "eslint .",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
+    "copy:assets": "cpx src/assets/** lib/assets",
+    "license:add": "npx add-copyright-header --generate --dir 'src'"
+  },
+  "peerDependencies": {
+    "react": "18.2.0"
+  },
+  "devDependencies": {
+    "@babel/runtime": "^7.19.0",
+    "@react-native-community/eslint-config": "^2.0.0",
+    "@types/react": "18.0.20",
+    "cpx2": "^4.2.0",
+    "eslint": "^7.32.0",
+    "metro-react-native-babel-preset": "^0.72.3",
+    "prettier": "^2.7.1",
+    "react": "18.2.0"
+  },
+  "resolutions": {
+    "@types/react": "18.0.20"
+  }
+}