@applica-software-guru/react-admin 1.0.57 → 1.0.59

package/.eslintrc.json

@@ -36,6 +36,9 @@
     "react/no-unescaped-entities ":"off"
   },
   "settings": {
+    "react": {
+      "version": "detect"
+    },
     "import/resolver": {
       "typescript": {}
     }

package/README.md

@@ -13,8 +13,22 @@ Libreria di componenti React per la creazione di applicativi web basati su React
 
 Lo scopo di questa libreria è fornire un set di strumenti per la prototipazione rapida di applicativi web (generalmente di tipo gestionale) basati su React-Admin, personalizzati con il tema Mantis e che seguono le direttive grafiche del Design System ideato da Applica.
 
+## Avviare il progetto
+
+Pur essendo una libreria, è possibile avviare questo progetto come applicazione e testare tutte le componenti della libreria stessa a proprio piacimento.
+Il testing avviene avviando un'applicazione che esegue il codice realizzato e gestito all'interno della cartella **src/playground**.
+
+Per avviare il progetto, segui questi passi:
+
+- `nvm use` per impostare la versione di Node.js corretta;
+- `npm install` per installare le dipendenze;
+- `npm run dev` per avviare il playground in modalità sviluppo;
+- divertiti a testare le componenti!
+
 ## Contribuire
 
+> Questo paragrafo tratta una procedura che sarà dismessa in futuro, per maggiori informazioni consulta il paragrafo **Avviare il progetto**
+
 Puoi avviare un ambiente locale di sviluppo ed utilizzarlo per testare le modifiche che apporti alla libreria.
 Per farlo, segui questi passi:
 

package/dist/ApplicaAdmin.d.ts

@@ -1,19 +1,82 @@
 import { AdminProps } from 'react-admin';
 import { MenuProps } from 'src/types';
 export type ApplicaAdminProps = AdminProps & {
+    /**
+     * Eventuali configurazioni aggiuntive da passare al tema.
+     * @remarks Questo tema è basato su Mantis Theme (https://mantisdashboard.io/)
+     *
+     * @see https://marmelab.com/react-admin/Theming.html
+     * @see https://material-ui.com/customization/theming/
+     */
     theme: any;
+    /**
+     * URL dell'API da utilizzare nell'applicazione.
+     * Sebbene venga già definito un dataProvider ed authProvider di default, è possibile che l'app
+     * utilizzi l'apiUrl specificato per ulteriori operazioni (es. getstione delle notifiche).
+     */
     apiUrl: string;
+    /**
+     * La lingua di default da utilizzare nell'applicazione.
+     */
     defaultLocale: string;
+    /**
+     * Se impostato a true, l'applicazione lavora in modalità sviluppo.
+     * La modalità sviluppo è utile per effettuare test e debug ed esegue attività che non sono
+     * consigliate in produzione (es. cattura e inoltro dei messaggi non localizzati).
+     */
     development: boolean;
+    /**
+     * Il logo da visualizzare nella barra laterale quando il menu è espanso lateralmente.
+     */
     logoMain: any;
+    /**
+     * Eventuale logo da visualizzare nella barra laterale quando il menu è ridotto lateralmente.
+     */
     logoIcon: any;
+    /**
+     * Configurazione del menu da visualizzare nell'applicazione.
+     */
     menu: MenuProps;
+    /**
+     * Nome dell'applicazione da mostrare nell'header.
+     */
     name: string;
+    /**
+     * Versione dell'applicazione da mostrare nel footer.
+     */
     version: string;
+    /**
+     * Il provider di autenticazione da utilizzare nell'applicazione.
+     */
     dataProvider: any;
+    /**
+     * Il provider di dati da utilizzare nell'applicazione.
+     */
     authProvider: any;
+    /**
+     * Indica il nome della risorsa REST da utilizzare per la gestione delle notifiche.
+     * @example
+     * // In questo caso, le notifiche verranno gestite tramite la risorsa "entities/notification"
+     * <ApplicaAdmin notification="entities/notification" />
+     */
     notification: string;
+    /**
+     * Indica se le notifiche devono essere disabilitate.
+     * Se le notifiche sono abilitate comparirà automaticamente un'icona in alto a destra nell'header.
+     *
+     * @example
+     * // In questo caso, le notifiche verranno disabilitate
+     * <ApplicaAdmin disableNotification />
+     */
     disableNotification: boolean;
+    /**
+     * Indica se la schermata di registrazione deve essere disabilitata.
+     */
+    disableSignup: boolean;
+    /**
+     * Indica se la schermata di recupero password deve essere disabilitata.
+     */
+    disableForgotPassword: boolean;
 };
 /**
  * Definisce un'applicazione super figa basata su React Admi, Mantis Theme ed il nostro stile.
@@ -21,7 +84,7 @@ export type ApplicaAdminProps = AdminProps & {
  *
  * @example
  * // Esempio di utilizzo
- * import { ApplicaAdmin } from '@applica-software-guru/react-admin';
+ * import { ApplicaAdmin } from '.';
  * import { createAuthProvider } from '@applica-software-guru/iam-client';
  * import { createDataProvider } from '@applica-software-guru/crud-client';
  * import * as entities from './entities';
@@ -48,7 +111,7 @@ export type ApplicaAdminProps = AdminProps & {
  * @returns {React.ReactElement}
  */
 declare const ApplicaAdmin: {
-    ({ theme, apiUrl, defaultLocale, development, logoMain, logoIcon, menu, name, version, dataProvider, authProvider, notification, disableNotification, ...props }: ApplicaAdminProps): import("react/jsx-runtime").JSX.Element | null;
+    ({ theme, apiUrl, defaultLocale, development, logoMain, logoIcon, loginPage, menu, name, version, dataProvider, authProvider, notification, disableNotification, disableSignup, disableForgotPassword, ...props }: ApplicaAdminProps): import("react/jsx-runtime").JSX.Element | null;
     defaultProps: {
         fileFields: never[];
         defaultLocale: string;
@@ -56,6 +119,9 @@ declare const ApplicaAdmin: {
         version: string;
         notification: string;
         disableNotification: boolean;
+        disableSignup: boolean;
+        disableForgotPassword: boolean;
+        loginPage: import("react/jsx-runtime").JSX.Element;
         store: import("react-admin").Store;
         title: string;
     };

package/dist/ApplicaAdmin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApplicaAdmin.d.ts","sourceRoot":"","sources":["../../src/ApplicaAdmin.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AA+BtC,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG;IAC3C,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,GAAG,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;IACd,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,QAAA,MAAM,YAAY;sKAsEf,iBAAiB;;;;;;;;;;;;CAmFnB,CAAC;AA6BF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"ApplicaAdmin.d.ts","sourceRoot":"","sources":["../../src/ApplicaAdmin.tsx"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AA8BtC,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG;IAC3C;;;;;;OAMG;IACH,KAAK,EAAE,GAAG,CAAC;IACX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,GAAG,CAAC;IAClB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,QAAA,MAAM,YAAY;uNAkBf,iBAAiB;;;;;;;;;;;;;;;CA0FnB,CAAC;AAkCF,eAAe,YAAY,CAAC"}

package/dist/components/MainIcon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MainIcon.d.ts","sourceRoot":"","sources":["../../../src/components/MainIcon.jsx"],"names":[],"mappings":";AAGA;;4CAUC;;;;;;sBAbqB,YAAY"}
+{"version":3,"file":"MainIcon.d.ts","sourceRoot":"","sources":["../../../src/components/MainIcon.jsx"],"names":[],"mappings":";AAIA;;4CAUC;;;;;;sBAZqB,YAAY"}

package/dist/components/index.d.ts

@@ -6,6 +6,7 @@ export * from "./ra-inputs";
 export * from "./ra-lists";
 export * from "./ra-forms";
 export * from "./ra-custom";
+export * from "./ra-pages";
 import MainIcon from './MainIcon';
 import ActionsMenu from './ActionsMenu';
 import Loadable from './Loadable';

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.jsx"],"names":[],"mappings":";;;;;;;;qBAMqB,YAAY;wBANT,eAAe;qBAElB,YAAY;mBACd,UAAU;mBAFV,UAAU;iBAGZ,QAAQ;qBACJ,YAAY;sBAIX,aAAa;oBACf,WAAW;4BAHH,eAAe;yBAClB,gBAAgB;sBAGnB,aAAa"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.jsx"],"names":[],"mappings":";;;;;;;;;qBAMqB,YAAY;wBANT,eAAe;qBAElB,YAAY;mBACd,UAAU;mBAFV,UAAU;iBAGZ,QAAQ;qBACJ,YAAY;sBAIX,aAAa;oBACf,WAAW;4BAHH,eAAe;yBAClB,gBAAgB;sBAGnB,aAAa"}

package/dist/components/ra-pages/LoginPage/AuthCard.d.ts

@@ -0,0 +1,12 @@
+export default AuthCard;
+declare function AuthCard({ children, ...other }: {
+    [x: string]: any;
+    children: any;
+}): import("react/jsx-runtime").JSX.Element;
+declare namespace AuthCard {
+    namespace propTypes {
+        const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    }
+}
+import PropTypes from 'prop-types';
+//# sourceMappingURL=AuthCard.d.ts.map

package/dist/components/ra-pages/LoginPage/AuthCard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthCard.d.ts","sourceRoot":"","sources":["../../../../../src/components/ra-pages/LoginPage/AuthCard.jsx"],"names":[],"mappings":";AAKA;;;4CAqBC;;;;;;sBAxBqB,YAAY"}

package/dist/components/ra-pages/LoginPage/AuthLogin.d.ts

@@ -0,0 +1,6 @@
+export default AuthLogin;
+declare function AuthLogin({ enablePasswordForgot, ...props }: {
+    [x: string]: any;
+    enablePasswordForgot: any;
+}): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=AuthLogin.d.ts.map

package/dist/components/ra-pages/LoginPage/AuthLogin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthLogin.d.ts","sourceRoot":"","sources":["../../../../../src/components/ra-pages/LoginPage/AuthLogin.jsx"],"names":[],"mappings":";AAMA;;;4CAsEC"}

package/dist/components/ra-pages/LoginPage/AuthWrapper.d.ts

@@ -0,0 +1,15 @@
+export default AuthWrapper;
+declare function AuthWrapper({ version, name, children }: {
+    version: any;
+    name: any;
+    children: any;
+}): import("react/jsx-runtime").JSX.Element;
+declare namespace AuthWrapper {
+    namespace propTypes {
+        const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        const version: PropTypes.Requireable<string>;
+        const name: PropTypes.Requireable<string>;
+    }
+}
+import PropTypes from 'prop-types';
+//# sourceMappingURL=AuthWrapper.d.ts.map

package/dist/components/ra-pages/LoginPage/AuthWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthWrapper.d.ts","sourceRoot":"","sources":["../../../../../src/components/ra-pages/LoginPage/AuthWrapper.jsx"],"names":[],"mappings":";AAOA;;;;4CA8BC;;;;;;;;sBAhCqB,YAAY"}

package/dist/components/ra-pages/LoginPage/Login.d.ts

@@ -0,0 +1,34 @@
+import PropTypes from 'prop-types';
+export type LoginProps = {
+    /**
+     * Versione dell'applicazione.
+     */
+    version: string;
+    /**
+     * Nome dell'applicazione.
+     */
+    name: string;
+    /**
+     * Indica se abilitare o meno la schermata di recupero password.
+     */
+    enablePasswordForgot?: boolean;
+    /**
+     * Indica se abilitare o meno la schermata di registrazione.
+     */
+    enableSignup?: boolean;
+};
+declare const Login: {
+    ({ version, name, enablePasswordForgot, enableSignup }: LoginProps): import("react/jsx-runtime").JSX.Element;
+    propTypes: {
+        version: PropTypes.Validator<string>;
+        name: PropTypes.Validator<string>;
+        enablePasswordForgot: PropTypes.Requireable<boolean>;
+        enableSignup: PropTypes.Requireable<boolean>;
+    };
+    defaultProps: {
+        enablePasswordForgot: boolean;
+        enableSignup: boolean;
+    };
+};
+export default Login;
+//# sourceMappingURL=Login.d.ts.map

package/dist/components/ra-pages/LoginPage/Login.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Login.d.ts","sourceRoot":"","sources":["../../../../../src/components/ra-pages/LoginPage/Login.tsx"],"names":[],"mappings":"AAKA,OAAO,SAAS,MAAM,YAAY,CAAC;AAGnC,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AACF,QAAA,MAAM,KAAK;4DAA2D,UAAU;;;;;;;;;;;CAqB/E,CAAC;AAaF,eAAe,KAAK,CAAC"}

package/dist/components/ra-pages/LoginPage/index.d.ts

@@ -0,0 +1,3 @@
+export default Login;
+import Login from './Login';
+//# sourceMappingURL=index.d.ts.map

package/dist/components/ra-pages/LoginPage/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/ra-pages/LoginPage/index.jsx"],"names":[],"mappings":";kBAAkB,SAAS"}

package/dist/components/ra-pages/index.d.ts

@@ -0,0 +1,3 @@
+import LoginPage from './LoginPage';
+export { LoginPage };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/ra-pages/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/ra-pages/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,CAAC"}