oolib 2.110.1 → 2.111.0

package/dist/utils/getterSetterDeleter/getVal_caseExamples.js

@@ -0,0 +1,91 @@
+//These might be outdated after
+//recent flattenIfValueIsArray updates.
+//cross check these and update accordingly
+//CASE 1: obj-obj-ary-ary
+var sampleObj = {
+    key1: {
+        key2: [
+            ['hello', 'world'],
+            ['hello2', 'world2']
+        ],
+        key4: 'removeMe'
+    }
+};
+//returns
+var returned = {
+    "getVal": [
+        ["hello", "world"],
+        ["hello2", "world2"]
+    ]
+};
+//--------------
+//CASE 2: obj-obj-ary-obj-ary-obj : value is a string
+//resource
+var sampleObj2 = {
+    key1: {
+        key2: [
+            {
+                aryKey1: [{ aryKey2: "hello1" }],
+            },
+            {
+                aryKey1: [{ aryKey2: "hello2" }],
+            },
+        ],
+        key4: "removeMe",
+    },
+};
+//returns
+var returned2 = {
+    getVal: ["hello1", "hello2"],
+};
+//------------
+//CASE 4: obj-obj-ary-obj-ary-obj-ary-obj : value is an array
+var sampleObj4 = {
+    key1: {
+        key2: [
+            {
+                aryKey1: [{ aryKey2: [{ aryKey3: ["hello1"] }] }],
+            },
+            {
+                aryKey1: [{ aryKey2: [{ aryKey3: ["hello2"] }] }],
+            },
+        ],
+        key4: "removeMe",
+    },
+};
+// all arrays are flattened to a single array : maybe the value ary should not be flattened...
+var returned4 = {
+    "getVal": [
+        "hello1",
+        "hello2"
+    ]
+};
+//-----------
+//CASE 3: obj-obj-ary-obj : value is an array
+var sampleObj3 = {
+    key1: {
+        key2: [
+            {
+                aryInside: ['hello', 'world']
+            },
+            {
+                aryInside: ['hello2', 'world2']
+            },
+        ],
+        key4: 'removeMe'
+    }
+};
+// no arrays are flattened
+var returned3 = {
+    "getVal": [
+        ["hello", "world"],
+        ["hello2", "world2"]
+    ]
+};
+//look at the above results and you will see the inconsistency, and thats the bug
+/**
+ * BUG:
+
+if the value is an array inside 1 array. we are returned an array inside array : which i think is right...
+if the value is an array inside 2 arrays, we are returned 1 single array (i.e the value array is flattened out) : which i think is wrong, but this might be addressing some scenario (although it is wrong.). Still a bit dangerous to change it...
+ */

package/dist/utilsOolib/StorybookBannersWrapper.d.ts

@@ -0,0 +1,2 @@
+export function StorybookBannersWrapper(): React.JSX.Element;
+import React from "react";

package/dist/utilsOolib/StorybookBannersWrapper.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorybookBannersWrapper = void 0;
+var react_1 = __importDefault(require("react"));
+var bannerContext_1 = require("../components/Banners/bannerContext");
+var Banners_1 = require("../components/Banners");
+var StorybookBannersWrapper = function () {
+    var _a = (0, bannerContext_1.useBannerContext)(), BANNER_STATE = _a.BANNER_STATE, REMOVE_ALERT_BANNER = _a.REMOVE_ALERT_BANNER, REMOVE_INFO_BANNER = _a.REMOVE_INFO_BANNER;
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(Banners_1.BannerInfo, { BANNER_STATE: BANNER_STATE, REMOVE_INFO_BANNER: REMOVE_INFO_BANNER }),
+        react_1.default.createElement(Banners_1.BannerAlert, { BANNER_STATE: BANNER_STATE, REMOVE_ALERT_BANNER: REMOVE_ALERT_BANNER })));
+};
+exports.StorybookBannersWrapper = StorybookBannersWrapper;

package/dist/utilsOolib/excludeKeys.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @description From the supplied object, this function excludes the keys
+ * defined in the 'exclude' array, and returns the remaining object.
+ * @param obj The object from which keys will be excluded
+ * @param exclude An array of keys to exclude from the object
+ * @returns A new object with the specified keys excluded
+ */
+export declare const excludeKeys: <T extends object, K extends keyof T>(obj: T, exclude?: K[]) => Omit<T, K>;

package/dist/utilsOolib/excludeKeys.js

@@ -0,0 +1,31 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.excludeKeys = void 0;
+/**
+ * @description From the supplied object, this function excludes the keys
+ * defined in the 'exclude' array, and returns the remaining object.
+ * @param obj The object from which keys will be excluded
+ * @param exclude An array of keys to exclude from the object
+ * @returns A new object with the specified keys excluded
+ */
+var excludeKeys = function (obj, exclude) {
+    if (exclude === void 0) { exclude = []; }
+    return Object.keys(obj)
+        .filter(function (k) { return !exclude.includes(k); })
+        .reduce(function (a, b) {
+        var _a;
+        return (__assign(__assign({}, a), (_a = {}, _a[b] = obj[b], _a)));
+    }, {});
+};
+exports.excludeKeys = excludeKeys;

package/dist/utilsOolib/genRandomHash.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generates a random hash of a specified length.
+ *
+ * @param {number} length - the length of the hash to generate
+ * @return {string} the randomly generated hash
+ */
+export declare function genRandomHash(length: number): string;

package/dist/utilsOolib/genRandomHash.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genRandomHash = void 0;
+/**
+ * Generates a random hash of a specified length.
+ *
+ * @param {number} length - the length of the hash to generate
+ * @return {string} the randomly generated hash
+ */
+function genRandomHash(length) {
+    var result = '';
+    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    var charactersLength = characters.length;
+    for (var counter = 0; counter < length; counter++) {
+        result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+    return result;
+}
+exports.genRandomHash = genRandomHash;

package/dist/utilsOolib/index.d.ts

@@ -1,5 +1,12 @@
-export function useLocale(): (text: any) => any;
-export function getPrimaryColor10(colors: any): any;
-export function getPrimaryColor40(colors: any): any;
-export function getPrimaryColor100(colors: any): any;
-export function getPrimaryColorText(colors: any): any;
+/**
+ * @note : THESE ARE NOT MEANT TO BE EXPORTED
+ *
+ * These are utility functions that make certain tasks
+ * within oolib easier
+ */
+import { ColorsType } from '../themes/colors';
+export declare const useLocale: () => (text: string) => string;
+export declare const getPrimaryColor10: (colors?: ColorsType) => string;
+export declare const getPrimaryColor40: (colors?: ColorsType) => string;
+export declare const getPrimaryColor100: (colors?: ColorsType) => string;
+export declare const getPrimaryColorText: (colors?: ColorsType) => string;

package/dist/utilsOolib/index.js

@@ -13,13 +13,21 @@ var primaryColor10 = colors_1.colors.primaryColor10, primaryColor40 = colors_1.c
 var useLocale = function () {
     var currentTheme = (0, styled_components_1.useTheme)();
     var localize = function (text) {
-        return (currentTheme === null || currentTheme === void 0 ? void 0 : currentTheme.localize)
-            ? currentTheme.localize(text)
-            : text;
+        return (currentTheme === null || currentTheme === void 0 ? void 0 : currentTheme.localize) ? currentTheme.localize(text) : text;
     };
     return localize;
 };
 exports.useLocale = useLocale;
+// export const useLocale = () => {
+//   const currentTheme = useTheme();
+//   const localize = text => {
+//     console.log({ text })
+//       return currentTheme?.localize 
+//           ? currentTheme.localize(text) 
+//           : text
+//   }
+//   return localize
+// }
 var getPrimaryColor10 = function (colors) {
     return (colors === null || colors === void 0 ? void 0 : colors.primaryColor10) || primaryColor10;
 };

package/dist/utilsOolib/renderRTEPlaceholderForOolibPreview.d.ts

@@ -1,2 +1,9 @@
-export function renderRTEPlaceholderForOolibPreview(options?: {}): React.JSX.Element;
 import React from "react";
+import { TooltipProps } from "../components/Tooltip";
+interface RenderRTEPlaceholderForOolibPreviewOptions {
+    width?: string;
+    height?: string;
+    tooltipPos?: TooltipProps["position"];
+}
+export declare const renderRTEPlaceholderForOolibPreview: (options?: RenderRTEPlaceholderForOolibPreviewOptions) => React.JSX.Element;
+export {};

package/dist/utilsOolib/renderRTEPlaceholderForOolibPreview.js

@@ -5,12 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderRTEPlaceholderForOolibPreview = void 0;
 var react_1 = __importDefault(require("react"));
-var phosphor_react_1 = require("phosphor-react");
 var Tooltip_1 = require("../components/Tooltip");
 var themes_1 = require("../themes");
 var renderRTEPlaceholderForOolibPreview = function (options) {
     if (options === void 0) { options = {}; }
-    var _a = options.width, width = _a === void 0 ? "2rem" : _a, _b = options.height, height = _b === void 0 ? '2rem' : _b, _c = options.tooltipPos, tooltipPos = _c === void 0 ? 'bottom' : _c;
+    var _a = options.width, width = _a === void 0 ? "2rem" : _a, _b = options.height, height = _b === void 0 ? "2rem" : _b, _c = options.tooltipPos, tooltipPos = _c === void 0 ? "bottom" : _c;
     return (react_1.default.createElement("div", { style: {
             width: width,
             height: height,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oolib",
-  "version": "2.110.1",
+  "version": "2.111.0",
   "description": " OKE Component Library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -67,10 +67,10 @@
     "react-json-view": "^1.21.3",
     "react-router-dom": "^5.1.2",
     "semantic-release": "^18.0.0",
-    "storybook": "^7.2.1"
+    "storybook": "^7.2.1",
+    "typescript": "^5.4.3"
   },
   "peerDependencies": {
-    "framer-motion": "^4.1.17",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-router-dom": "^5.1.2",
@@ -85,6 +85,7 @@
     "access": "public"
   },
   "dependencies": {
+    "framer-motion": "^4.1.17",
     "@faker-js/faker": "^8.3.1",
     "@react-hook/resize-observer": "^1.2.6",
     "babel-polyfill": "^6.26.0",