@tracktor/shared-module 0.6.0 → 0.6.2

package/CHANGELOG.md

@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/react-google-tag-manager/releases)
 
-## v0.6.0
-- **[feat]** : add `MaskTextField` component
+## v0.6.2
+- **[feat]** : Documentation

package/dist/components/Inputs/MaskTextField.d.ts

@@ -1,7 +1,25 @@
 import { ComponentProps, ComponentType } from "react";
 interface MaskTextFieldProps<T> {
+    /**
+     * Mask pattern.
+     * e.g. `Date: {d}.{m}.{y}`
+     * e.g. `Phone: +{7}(000)000-00-00`
+     * @see https://imask.js.org/guide.html#masked-pattern
+     */
     mask?: unknown;
+    /**
+     * Definitions.
+     */
+    definitions?: unknown;
+    /**
+     * Text field component dependency.
+     */
     TextField: T;
+    /**
+     * Mask mixin dependency.
+     * @param param
+     * @constructor
+     */
     IMaskMixin: (param: (props: any) => any) => any;
 }
 declare const MaskTextField: <T extends ComponentType<{}>>({ IMaskMixin, ...props }: MaskTextFieldProps<T> & ComponentProps<T>) => JSX.Element;

package/dist/components/Utils/GTMSendPageView.d.ts

@@ -1,7 +1,16 @@
 import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 export interface GTMSendPageViewProps {
+    /**
+     * useGoogleTagManager is the hook that will be used to send page view
+     */
     useGoogleTagManager?: InjectDependenciesContextProps["useGoogleTagManager"];
+    /**
+     * Outlet is the component that will be rendered
+     */
     Outlet?: InjectDependenciesContextProps["Outlet"];
+    /**
+     * useLocation is the hook that will be used to get current pathname
+     */
     useLocation?: InjectDependenciesContextProps["useLocation"];
 }
 /**

package/dist/components/Utils/I18nConfig.d.ts

@@ -8,10 +8,26 @@ interface I18nConfigProps<I, L, R> {
         on: (event: string, callback: (lng: string) => void) => void;
         resolvedLanguage?: string;
     };
+    /**
+     * i18next language detector dependency
+     */
     LanguageDetector?: L;
+    /**
+     * i18next ressources
+     * exemple
+     * {
+     *   en: {
+     *     roles: {...},
+     *     translation: {...},
+     *   },
+     * }
+     */
     resources?: {
         [language: string]: any;
     };
+    /**
+     * i18next innit react plugin dependency
+     */
     initReactI18next?: R;
 }
 /**

package/dist/components/Utils/SentryConfig.d.ts

@@ -10,6 +10,9 @@ interface SentryConfigProps<T> {
         }) => void;
         BrowserTracing: any;
     };
+    /**
+     * Sentry DSN
+     */
     dsn: string;
 }
 /**

package/dist/context/QueryClientConfigProvider.d.ts

@@ -20,6 +20,9 @@ interface QueryClientConfigProviderProps<T> extends PropsWithChildren {
         client: T;
         children: ReactNode;
     }) => any;
+    /**
+     * Default options for queries
+     */
     defaultOptions?: {
         [key: string]: any;
     };

package/dist/hooks/useResponseError/useResponseError.d.ts

@@ -25,6 +25,7 @@ export interface useResponseErrorParams {
 }
 /**
  * This hook is used to print error messages from the API
+ * @param params
  */
 export declare const useResponseError: <T = ResponseError>(params?: useResponseErrorParams) => {
     printError: (error?: any) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tracktor/shared-module",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "type": "module",
   "license": "UNLICENSED",
   "types": "./dist/main.d.ts",