@monkvision/common 4.0.3 → 4.0.6

package/README/UTILITIES.md

@@ -0,0 +1,254 @@
+# Utilities
+This README page is aimed at providing documentation on a specific part of the `@monkvision/common` package : the
+utility functions. You can refer to [this page](README.md) for more general information on the package.
+
+This package exports various utility functions used throughout the MonkJs SDK.
+
+# Array Utils
+### permutations
+```typescript
+import { permutations } from '@monkvision/common';
+
+console.log(permutations([1, 2, 3]));
+// Output : [[1, 2, 3], [1, 3, 2], [2, 1, 3], [2, 3, 1], [3, 1, 2], [3, 2, 1]]
+```
+Returns an array containing all the possible permutations of the given array.
+
+### uniq
+```typescript
+import { uniq } from '@monkvision/common';
+
+console.log(uniq([1, 1, 1, 2, 3, 3]));
+// Output : [1, 2, 3]
+```
+Return a copy of the given array in which all duplicates have been removed.
+
+### flatten
+```typescript
+import { flatten } from '@monkvision/common';
+
+console.log(flatten([ 1, [2, 3], [[4], [5, 6]]]));
+// Output : [1, 2, 3, 4, 5, 6]
+```
+Flatten the given array.
+
+### flatten
+```typescript
+import { flatMap } from '@monkvision/common';
+
+console.log(flatMap([1, 2, 3], (item: number) => [item, item + 1]));
+// Output : [1, 2, 2, 3, 3, 4]
+```
+JS implementation of the
+[Array.prototype.flatMap](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flatMap)
+method, available on all versions of JavaScript.
+
+---
+
+# Color Utils
+### getRGBAFromString
+```typescript
+import { getRGBAFromString } from '@monkvision/common';
+
+console.log(JSON.stringify(getRGBAFromString('#AF270CCC')));
+// Output : {"r":175,"g":39,"b":12,"a":0.8}
+```
+Returns the RGBA values of the given color. The accepted formats are :
+- RGB : `rgb(167, 224, 146)`
+- RGBA : `rgb(167, 224, 146, 0.03)`
+- HEX : `#A7E092`
+- HEX (alpha) : `#A7E09208`
+- HEX (short) : `#AE9`
+- HEX (short + alpha) : `#AE98`
+
+This function is case-insensitive and ignores white spaces.
+
+### getHexFromRGBA
+```typescript
+import { getHexFromRGBA } from '@monkvision/common';
+
+console.log(getHexFromRGBA({ r: 111, g: 222, b: 0, a: 0.67 }));
+// Output : #6FDE00AB
+```
+Converts RGBA values to their hexadecimal representation.
+
+### shadeColor
+```typescript
+import { shadeColor } from '@monkvision/common';
+
+console.log(shadeColor('#FC72A7', 0.7));
+// Output : #FFC2FFFF
+```
+Apply a shade of black or white over the given color. The amount of shade to apply works as a ratio :
+- use positive values like 0.08 to lighten the color by 8%
+- use negative values like -0.08 to darken the color by 8%
+
+### changeAlpha
+```typescript
+import { changeAlpha } from '@monkvision/common';
+
+console.log(changeAlpha('#FF1234FF', 0.5));
+// Output : #FF123480
+```
+Returns a new color equal to the given color but with a different alpha value.
+
+### getInteractiveVariants
+```typescript
+import { getInteractiveVariants } from '@monkvision/common';
+
+const variants = getInteractiveVariants('#FC72A7');
+/*
+ * variants = {
+ *   [InteractiveStatus.DEFAULT]: '#FC72A7',
+ *   [InteractiveStatus.HOVERED]: '#FF7BB4',
+ *   [InteractiveStatus.ACTIVE]: '#FF80BB',
+ *   [InteractiveStatus.DISABLED]: '#FC72A7',
+ * }
+ */
+```
+Create interactive variants (hovered, active...) for the given color. You can specify as an additional parameter the
+type of variation to use for the interactive colors (lighten or darken the color, default = lighten).
+
+---
+
+# Environment Utils
+### getEnvOrThrow
+```typescript
+import { getEnvOrThrow } from '@monkvision/common';
+
+try {
+  const example = getEnvOrThrow('REACT_APP_EXAMPLE');
+  console.log('Env var is defined :', example);
+} catch (err) {
+  console.log('Env var is not defined');
+}
+```
+Returns the value of a given environment variable. If the value does not exist, it throws an error.
+
+---
+
+# Mimetype Utils
+### MIMETYPE_FILE_EXTENSIONS
+```typescript
+import { MIMETYPE_FILE_EXTENSIONS } from '@monkvision/common';
+
+console.log(MIMETYPE_FILE_EXTENSIONS['text/plain']);
+// Output : ['txt']
+```
+Datamap that associates mimetypes to known file extensions corresponding to this mimetype.
+
+### getFileExtensions
+```typescript
+import { getFileExtensions } from '@monkvision/common';
+
+console.log(getFileExtensions('image/jpeg'));
+// Output : ['jpeg', 'jpg']
+```
+Returns a list of file extensions known to be corresponding to the given mimetype. If no file extension is known for
+this mimetype, this function will throw an error.
+
+### getMimetype
+```typescript
+import { getMimetype } from '@monkvision/common';
+
+console.log(getMimetype('jpg'));
+// Output : 'image/jpeg'
+```
+Returns the mimetype associated with the given file extension. If the file extension is unknown, this function will
+throw an error.
+
+---
+
+# Promise Utils
+### timeoutPromise
+```typescript
+import { timeoutPromise } from '@monkvision/common';
+
+timeoutPromise(5000).then(() => console.log('Hello!'));
+// Output after 5 seconds : 'Hello!'
+```
+This function creates and returns a new Promise that will resolve to void after the given amount of milliseconds.
+
+---
+
+# State Utils
+### getInspectionImages
+```typescript
+import { getInspectionImages } from '@monkvision/common';
+
+console.log(getInspectionImages(inspectionId, images, filterRetakes));
+// Returns an array of all the images having the given inspectionId.
+```
+Utility function that extracts the images of the given inspection. Set `filterRetakes` to `false` to filter retaken
+pictures.
+
+---
+
+# String Utils
+### suffix
+```typescript
+import { suffix } from '@monkvision/common';
+
+console.log(suffix('my-str', { suffix1: true, suffix2: false }));
+// Output : 'my-str suffix1'
+```
+This function suffixes a string with the given suffixes, only if their value is `true` in the suffixes object param.
+
+*Note : The order of the suffixes is not guaranteed.*
+
+### words
+```typescript
+import { words } from '@monkvision/common';
+
+console.log(words('my-str-test'));
+// Output : 'my str test'
+```
+Split the given string into its composing words.
+
+### capitalize
+```typescript
+import { capitalize } from '@monkvision/common';
+
+console.log(capitalize('my-str-test'));
+// Output : 'My-str-test'
+```
+Capitalizes (transforms the first character to upper case) the given string.
+
+### uncapitalize
+```typescript
+import { uncapitalize } from '@monkvision/common';
+
+console.log(uncapitalize('My-str-test'));
+// Output : 'my-str-test'
+```
+Uncapitalizes (transforms the first character to lower case) the given string.
+
+### toCamelCase
+```typescript
+import { toCamelCase } from '@monkvision/common';
+
+console.log(toCamelCase('My-str-test'));
+// Output : 'myStrTest'
+```
+Converts a string to camel case.
+
+---
+
+# Zlib Utils
+### zlibCompress
+```typescript
+import { zlibCompress } from '@monkvision/common';
+
+console.log(zlibCompress('Hello World!'))
+// Output : 'eJzzSM3JyVcIzy/KSVEEABxJBD4='
+```
+Compresses and encodes a string in base64 using the ZLib algorithm.
+
+### zlibDecompress
+```typescript
+import { zlibDecompress } from '@monkvision/common';
+
+console.log(zlibDecompress('eJzzSM3JyVcIzy/KSVEEABxJBD4='))
+// Output : 'Hello World!'
+```
+Decompresses a string that has been encoded in base64 and compressed using the Zlib algorithm.

package/lib/PreventExit/hooks.js

@@ -24,4 +24,3 @@ function usePreventExit(preventExit) {
     return (0, hooks_1.useObjectMemo)({ allowRedirect: allowRedirect });
 }
 exports.usePreventExit = usePreventExit;
-//# sourceMappingURL=hooks.js.map

package/lib/PreventExit/index.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./hooks"), exports);
-//# sourceMappingURL=index.js.map

package/lib/PreventExit/store.js

@@ -38,4 +38,3 @@ function createPreventExitListener() {
     };
 }
 exports.createPreventExitListener = createPreventExitListener;
-//# sourceMappingURL=store.js.map

package/lib/apps/analytics.js

@@ -13,4 +13,3 @@ function useAppStateAnalytics(_a) {
     }, [inspectionId, setUserId]);
 }
 exports.useAppStateAnalytics = useAppStateAnalytics;
-//# sourceMappingURL=analytics.js.map

package/lib/apps/appState.js

@@ -8,4 +8,3 @@ var react_1 = require("react");
  * @see MonkAppState
  */
 exports.MonkAppStateContext = (0, react_1.createContext)(null);
-//# sourceMappingURL=appState.js.map

package/lib/apps/appStateProvider.js

@@ -113,4 +113,3 @@ function useMonkAppState(options) {
     return value;
 }
 exports.useMonkAppState = useMonkAppState;
-//# sourceMappingURL=appStateProvider.js.map

package/lib/apps/index.js

@@ -17,4 +17,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./appState"), exports);
 __exportStar(require("./appStateProvider"), exports);
 __exportStar(require("./searchParams"), exports);
-//# sourceMappingURL=index.js.map

package/lib/apps/monitoring.js

@@ -22,4 +22,3 @@ function useAppStateMonitoring(_a) {
     }, [authToken, setUserId]);
 }
 exports.useAppStateMonitoring = useAppStateMonitoring;
-//# sourceMappingURL=monitoring.js.map

package/lib/apps/searchParams.js

@@ -78,4 +78,3 @@ function useMonkSearchParams() {
     return (0, hooks_1.useObjectMemo)({ get: get });
 }
 exports.useMonkSearchParams = useMonkSearchParams;
-//# sourceMappingURL=searchParams.js.map

package/lib/hooks/index.js

@@ -26,4 +26,3 @@ __exportStar(require("./useSearchParams"), exports);
 __exportStar(require("./useInterval"), exports);
 __exportStar(require("./useAsyncInterval"), exports);
 __exportStar(require("./useObjectMemo"), exports);
-//# sourceMappingURL=index.js.map

package/lib/hooks/useAsyncEffect.js

@@ -34,4 +34,3 @@ function useAsyncEffect(effect, deps, handlers) {
     }, deps);
 }
 exports.useAsyncEffect = useAsyncEffect;
-//# sourceMappingURL=useAsyncEffect.js.map

package/lib/hooks/useAsyncInterval.js

@@ -51,4 +51,3 @@ function useAsyncInterval(callback, delay, handlers) {
     }, [delay]);
 }
 exports.useAsyncInterval = useAsyncInterval;
-//# sourceMappingURL=useAsyncInterval.js.map

package/lib/hooks/useInteractiveStatus.js

@@ -67,4 +67,3 @@ function useInteractiveStatus(params) {
     }); }, [hovered, active, params === null || params === void 0 ? void 0 : params.disabled, onMouseEnter, onMouseLeave, onMouseDown, onMouseUp]);
 }
 exports.useInteractiveStatus = useInteractiveStatus;
-//# sourceMappingURL=useInteractiveStatus.js.map

package/lib/hooks/useInterval.js

@@ -24,4 +24,3 @@ function useInterval(callback, delay) {
     }, [delay]);
 }
 exports.useInterval = useInterval;
-//# sourceMappingURL=useInterval.js.map

package/lib/hooks/useLoadingState.js

@@ -33,4 +33,3 @@ function useLoadingState(startsLoading) {
     });
 }
 exports.useLoadingState = useLoadingState;
-//# sourceMappingURL=useLoadingState.js.map

package/lib/hooks/useObjectMemo.js

@@ -17,4 +17,3 @@ function useObjectMemo(object) {
     return (0, react_1.useMemo)(function () { return object; }, Object.values(object));
 }
 exports.useObjectMemo = useObjectMemo;
-//# sourceMappingURL=useObjectMemo.js.map

package/lib/hooks/useObjectTranslation.js

@@ -16,4 +16,3 @@ function useObjectTranslation() {
     return { tObj: tObj };
 }
 exports.useObjectTranslation = useObjectTranslation;
-//# sourceMappingURL=useObjectTranslation.js.map

package/lib/hooks/useQueue.js

@@ -191,4 +191,3 @@ function useQueue(process, optionsParams) {
     };
 }
 exports.useQueue = useQueue;
-//# sourceMappingURL=useQueue.js.map

package/lib/hooks/useResponsiveStyle.js

@@ -61,4 +61,3 @@ function useResponsiveStyle() {
     return { responsive: responsive };
 }
 exports.useResponsiveStyle = useResponsiveStyle;
-//# sourceMappingURL=useResponsiveStyle.js.map

package/lib/hooks/useSearchParams.js

@@ -9,4 +9,3 @@ function useSearchParams() {
     return (0, react_1.useMemo)(function () { return new URL(window.location.toString()).searchParams; }, []);
 }
 exports.useSearchParams = useSearchParams;
-//# sourceMappingURL=useSearchParams.js.map

package/lib/hooks/useSightLabel.js

@@ -16,4 +16,3 @@ function useSightLabel(_a) {
     return { label: label };
 }
 exports.useSightLabel = useSightLabel;
-//# sourceMappingURL=useSightLabel.js.map

package/lib/hooks/useWindowDimensions.js

@@ -24,4 +24,3 @@ function useWindowDimensions() {
     return dimensions;
 }
 exports.useWindowDimensions = useWindowDimensions;
-//# sourceMappingURL=useWindowDimensions.js.map

package/lib/i18n/index.js

@@ -16,4 +16,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./utils"), exports);
 __exportStar(require("./translations"), exports);
-//# sourceMappingURL=index.js.map

package/lib/i18n/translations/image.js

@@ -405,4 +405,3 @@ exports.complianceIssueLabels = (_b = {},
         },
     },
     _b);
-//# sourceMappingURL=image.js.map

package/lib/i18n/translations/index.js

@@ -16,4 +16,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./vehicleParts"), exports);
 __exportStar(require("./image"), exports);
-//# sourceMappingURL=index.js.map

package/lib/i18n/translations/vehicleParts.js

@@ -458,4 +458,3 @@ exports.vehiclePartLabels = (_a = {},
         nl: 'BACKGROUND',
     },
     _a);
-//# sourceMappingURL=vehicleParts.js.map

package/lib/i18n/utils.js

@@ -83,4 +83,3 @@ function getLanguage(language) {
     return types_1.monkLanguages.includes(languagePrefix) ? languagePrefix : 'en';
 }
 exports.getLanguage = getLanguage;
-//# sourceMappingURL=utils.js.map

package/lib/index.js

@@ -21,4 +21,3 @@ __exportStar(require("./i18n"), exports);
 __exportStar(require("./state"), exports);
 __exportStar(require("./theme"), exports);
 __exportStar(require("./utils"), exports);
-//# sourceMappingURL=index.js.map

package/lib/state/actions/createdOneImage.js

@@ -49,4 +49,3 @@ function createdOneImage(state, action) {
     return __assign(__assign({}, state), { inspections: __spreadArray([], inspections, true), images: __spreadArray([], images, true) });
 }
 exports.createdOneImage = createdOneImage;
-//# sourceMappingURL=createdOneImage.js.map

package/lib/state/actions/gotOneInspection.js

@@ -52,4 +52,3 @@ function gotOneInspection(state, action) {
     return newState;
 }
 exports.gotOneInspection = gotOneInspection;
-//# sourceMappingURL=gotOneInspection.js.map

package/lib/state/actions/index.js

@@ -20,4 +20,3 @@ __exportStar(require("./gotOneInspection"), exports);
 __exportStar(require("./createdOneImage"), exports);
 __exportStar(require("./updatedManyTasks"), exports);
 __exportStar(require("./updatedVehicle"), exports);
-//# sourceMappingURL=index.js.map

package/lib/state/actions/monkAction.js

@@ -27,4 +27,3 @@ var MonkActionType;
      */
     MonkActionType["UPDATED_VEHICLE"] = "updated_vehicle";
 })(MonkActionType = exports.MonkActionType || (exports.MonkActionType = {}));
-//# sourceMappingURL=monkAction.js.map

package/lib/state/actions/resetState.js

@@ -18,4 +18,3 @@ function resetState() {
     return (0, state_1.createEmptyMonkState)();
 }
 exports.resetState = resetState;
-//# sourceMappingURL=resetState.js.map

package/lib/state/actions/updatedManyTasks.js

@@ -44,4 +44,3 @@ function updatedManyTasks(state, action) {
     return __assign(__assign({}, state), { tasks: __spreadArray([], tasks, true) });
 }
 exports.updatedManyTasks = updatedManyTasks;
-//# sourceMappingURL=updatedManyTasks.js.map

package/lib/state/actions/updatedVehicle.js

@@ -47,4 +47,3 @@ function updatedVehicle(state, action) {
     return __assign(__assign({}, state), { vehicles: __spreadArray([], vehicles, true) });
 }
 exports.updatedVehicle = updatedVehicle;
-//# sourceMappingURL=updatedVehicle.js.map

package/lib/state/context.js

@@ -7,4 +7,3 @@ var react_1 = require("react");
  * the default value is `null`.
  */
 exports.MonkContext = (0, react_1.createContext)(null);
-//# sourceMappingURL=context.js.map

package/lib/state/hooks.js

@@ -17,4 +17,3 @@ function useMonkState() {
     return stateWithDispatch;
 }
 exports.useMonkState = useMonkState;
-//# sourceMappingURL=hooks.js.map

package/lib/state/index.js

@@ -20,4 +20,3 @@ __exportStar(require("./hooks"), exports);
 __exportStar(require("./provider"), exports);
 __exportStar(require("./reducer"), exports);
 __exportStar(require("./state"), exports);
-//# sourceMappingURL=index.js.map

package/lib/state/provider.js

@@ -37,4 +37,3 @@ function MonkProvider(_a) {
     }
 }
 exports.MonkProvider = MonkProvider;
-//# sourceMappingURL=provider.js.map

package/lib/state/reducer.js

@@ -21,4 +21,3 @@ function monkReducer(state, action) {
     return state;
 }
 exports.monkReducer = monkReducer;
-//# sourceMappingURL=reducer.js.map

package/lib/state/state.js

@@ -19,4 +19,3 @@ function createEmptyMonkState() {
     };
 }
 exports.createEmptyMonkState = createEmptyMonkState;
-//# sourceMappingURL=state.js.map

package/lib/theme/context.js

@@ -7,4 +7,3 @@ var theme_1 = require("./theme");
  * A React Context that contains the current Monk theme.
  */
 exports.MonkThemeContext = (0, react_1.createContext)((0, theme_1.createTheme)());
-//# sourceMappingURL=context.js.map

package/lib/theme/default/index.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./palette"), exports);
-//# sourceMappingURL=index.js.map

package/lib/theme/default/palette.js

@@ -66,4 +66,3 @@ exports.MonkDefaultPalette = {
         base: '#7B61FF',
     },
 };
-//# sourceMappingURL=palette.js.map

package/lib/theme/hooks.js

@@ -10,4 +10,3 @@ function useMonkTheme() {
     return (0, react_1.useContext)(context_1.MonkThemeContext);
 }
 exports.useMonkTheme = useMonkTheme;
-//# sourceMappingURL=hooks.js.map

package/lib/theme/index.js

@@ -19,4 +19,3 @@ __exportStar(require("./default"), exports);
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./provider"), exports);
 __exportStar(require("./theme"), exports);
-//# sourceMappingURL=index.js.map

package/lib/theme/provider.js

@@ -26,4 +26,3 @@ function MonkThemeProvider(_a) {
     return (0, jsx_runtime_1.jsx)(context_1.MonkThemeContext.Provider, __assign({ value: theme }, { children: children }));
 }
 exports.MonkThemeProvider = MonkThemeProvider;
-//# sourceMappingURL=provider.js.map

package/lib/theme/theme.js

@@ -51,4 +51,3 @@ function createTheme(_a) {
     };
 }
 exports.createTheme = createTheme;
-//# sourceMappingURL=theme.js.map

package/lib/utils/array.utils.js

@@ -72,4 +72,3 @@ function flatMap(array, map) {
     return flatten(array.map(map));
 }
 exports.flatMap = flatMap;
-//# sourceMappingURL=array.utils.js.map

package/lib/utils/browser.utils.js

@@ -13,4 +13,3 @@ function isMobileDevice() {
         userAgent.includes('windows phone'));
 }
 exports.isMobileDevice = isMobileDevice;
-//# sourceMappingURL=browser.utils.js.map

package/lib/utils/color.utils.js

@@ -152,4 +152,3 @@ function getInteractiveVariants(color, variant) {
         _a;
 }
 exports.getInteractiveVariants = getInteractiveVariants;
-//# sourceMappingURL=color.utils.js.map

package/lib/utils/env.utils.js

@@ -13,4 +13,3 @@ function getEnvOrThrow(name) {
     return value;
 }
 exports.getEnvOrThrow = getEnvOrThrow;
-//# sourceMappingURL=env.utils.js.map

package/lib/utils/index.js

@@ -23,4 +23,3 @@ __exportStar(require("./zlib.utils"), exports);
 __exportStar(require("./browser.utils"), exports);
 __exportStar(require("./env.utils"), exports);
 __exportStar(require("./state.utils"), exports);
-//# sourceMappingURL=index.js.map

package/lib/utils/mimetype.utils.js

@@ -66,4 +66,3 @@ function getMimetype(fileExtension) {
     return mimetype;
 }
 exports.getMimetype = getMimetype;
-//# sourceMappingURL=mimetype.utils.js.map

package/lib/utils/promise.utils.js

@@ -10,4 +10,3 @@ function timeoutPromise(delayMs) {
     });
 }
 exports.timeoutPromise = timeoutPromise;
-//# sourceMappingURL=promise.utils.js.map

package/lib/utils/state.utils.js

@@ -32,4 +32,3 @@ function getInspectionImages(inspectionId, images, filterRetakes) {
     return filteredRetakes;
 }
 exports.getInspectionImages = getInspectionImages;
-//# sourceMappingURL=state.utils.js.map

package/lib/utils/string.utils.js

@@ -45,4 +45,3 @@ function toCamelCase(str) {
         .join('');
 }
 exports.toCamelCase = toCamelCase;
-//# sourceMappingURL=string.utils.js.map

package/lib/utils/zlib.utils.js

@@ -27,4 +27,3 @@ function zlibDecompress(str) {
     return binaryConverter.decode(binary);
 }
 exports.zlibDecompress = zlibDecompress;
-//# sourceMappingURL=zlib.utils.js.map