@bcrumbs.net/bc-shared 0.0.1

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@bcrumbs.net/bc-shared",
+  "version": "0.0.1",
+  "keyword": [
+    "bcrumbs",
+    "bc-shared",
+    "Bread Crumbs"
+  ],
+  "author": {
+    "name": "Ahmad Mhaish"
+  },
+  "peerDependencies": {
+    "i18next": "^21.6.14",
+    "react-i18next": "^11.15.6",
+    "date-fns": "^2.28.0"
+  },
+  "dependencies": {
+    "jwt-decode": "^3.1.2",
+    "i18next-browser-languagedetector": "^6.1.3",
+    "i18next-http-backend": "^1.3.2",
+    "next-with-apollo": "^5.3.0",
+    "apollo-cache-inmemory": "^1.6.6",
+    "apollo-link-http": "^1.5.17"
+  },
+  "module": "./index.esm.js",
+  "type": "module",
+  "main": "./index.esm.js"
+}

package/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './lib/config/routes';
+export * from './lib/components';
+export * from './lib/utils';
+export * from './lib/types';
+export * from './lib/services/i18n';
+export * from './lib/services/auth';

package/src/lib/components/LogoutRoute/index.d.ts

@@ -0,0 +1,4 @@
+export declare const LogoutRoute: ({ ...props }: {
+    [x: string]: any;
+}) => import("@emotion/react/jsx-runtime").JSX.Element;
+export default LogoutRoute;

package/src/lib/components/RoutesGaurd/index.d.ts

@@ -0,0 +1,10 @@
+type Props = {
+    match?: any;
+    location?: any;
+    history?: any;
+    component: any;
+    path: any;
+    exact?: boolean;
+};
+export declare const BCRoutesGuard: (props: Props) => import("@emotion/react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './RoutesGaurd';
+export * from './LogoutRoute';

package/src/lib/config/routes.d.ts

@@ -0,0 +1,43 @@
+export declare const BCRoutes: {
+    AccountDashboard: string;
+    Subscriptions: string;
+    NewSubscription: string;
+    Upgrade: string;
+    Payments: string;
+    Invitation: string;
+    Forget: string;
+    Guide: string;
+    Welcome: string;
+    Login: string;
+    Register: string;
+    Password: string;
+    Profile: string;
+    Logout: string;
+    NotFound: string;
+    Error: string;
+    NoPermissions: string;
+    ShowcaseDashboard: string;
+    ShowcasePages: string;
+    ShowcaseSections: string;
+    ShowcaseContentEditor: string;
+    ShowcasePageDesigner: string;
+    ShowcaseTemplates: string;
+    ShowcaseSectionTemplates: string;
+    ShowcaseSettings: string;
+    ShowcaseNotFound: string;
+    HyChartCharts: string;
+    HyChartSettings: string;
+    HyChartNotFound: string;
+    ListResources: string;
+    CreateResource: string;
+    PatchResource: string;
+    DeleteResource: string;
+    ResourcesNotFound: string;
+    Inbox: string;
+    EmbeddedInbox: string;
+    Broadcast: string;
+    BroadcastEdit: string;
+    BroadcastCreate: string;
+    ConvsSearch: string;
+    Dashboard: string;
+};

package/src/lib/services/auth/index.d.ts

@@ -0,0 +1,123 @@
+type STORES_TYPES = 'localStorage' | 'sessionStorage';
+type Storage = STORES_TYPES;
+type TokenKey = string;
+type ContextKey = string;
+type UserInfoKey = string;
+type User = {
+    name?: string;
+    surname?: string;
+    username?: string;
+    email?: string;
+    id: string;
+};
+export declare const auth: {
+    /**
+     * get token from localstorage
+     *
+     * @param {'localStorage' | 'sessionStorage'} [fromStorage='localStorage'] specify storage
+     * @param {any} [tokenKey=TOKEN_KEY]  optionnal parameter to specify a token key
+     * @returns {string} token value
+     */
+    getToken(fromStorage?: Storage, tokenKey?: TokenKey): string | null;
+    /**
+     * set the token value into localstorage (managed by localforage)
+     *
+     * @param {string} [value=''] token value
+     * @param {'localStorage' | 'sessionStorage'} [toStorage='localStorage'] specify storage
+     * @param {any} [tokenKey='token'] token key
+     * @returns {boolean} success/failure flag
+     */
+    setToken(value?: string, toStorage?: Storage, tokenKey?: TokenKey): void;
+    /**
+     * check
+     * - if token key contains a valid token value (defined and not an empty value)
+     * - if the token expiration date is passed
+     *
+     *
+     * Note: 'isAuthenticated' just checks 'tokenKey' on store (localStorage by default or sessionStorage)
+     *
+     * You may think: 'ok I just put an empty token key and I have access to protected routes?''
+     *    -> answer is:  YES^^
+     * BUT
+     * -> : your backend will not recognize a wrong token so private data or safe and you protected view could be a bit ugly without any data.
+     *
+     * => ON CONCLUSION: this aim of 'isAuthenticated'
+     *    -> is to help for a better "user experience"  (= better than displaying a view with no data since server did not accept the user).
+     *    -> it is not a security purpose (security comes from backend, since frontend is easily hackable => user has access to all your frontend)
+     *
+     * @param {'localStorage' | 'sessionStorage'} [fromStorage='localStorage'] specify storage
+     * @param {any} [tokenKey=TOKEN_KEY] token key
+     * @returns {bool} is authenticed response
+     */
+    isAuthenticated(fromStorage?: Storage, tokenKey?: TokenKey): boolean;
+    /**
+     * delete token
+     *
+     * @param {any} [tokenKey='token'] token key
+     * @returns {bool} success/failure flag
+     */
+    clearToken(storage?: Storage, tokenKey?: TokenKey): boolean;
+    /**
+     * return expiration date from token
+     *
+     * @param {string} encodedToken - base 64 token received from server and stored in local storage
+     * @returns {date | null} returns expiration date or null id expired props not found in decoded token
+     */
+    getTokenExpirationDate(encodedToken: string): Date;
+    /**
+     *
+     * tell is token is expired (compared to now)
+     *
+     * @param {string} encodedToken - base 64 token received from server and stored in local storage
+     * @returns {bool} returns true if expired else false
+     */
+    isExpiredToken(encodedToken: string): boolean;
+    /**
+     * get user info from localstorage
+     *
+     * @param {'localStorage' | 'sessionStorage'} [fromStorage='localStorage'] specify storage
+     * @param {any} [userInfoKey='userInfo']  optionnal parameter to specify a token key
+     * @returns {string} token value
+     */
+    getUserInfo(fromStorage?: Storage, userInfoKey?: UserInfoKey): any;
+    /**
+     * set the userInfo value into localstorage
+     *
+     * @param {object} [value=''] token value
+     * @param {'localStorage' | 'sessionStorage'} [toStorage='localStorage'] specify storage
+     * @param {any} [userInfoKey='userInfo'] token key
+     * @returns {boolean} success/failure flag
+     */
+    setUserInfo(value: User, toStorage?: Storage, userInfoKey?: UserInfoKey): void;
+    updateUserInfo(value: User, toStorage?: Storage, userInfoKey?: UserInfoKey): any;
+    /**
+     * delete userInfo
+     *
+     * @param {string} [userInfoKey='userInfo'] token key
+     * @returns {bool} success/failure flag
+     */
+    clearUserInfo(userInfoKey?: UserInfoKey): any;
+    /**
+     * forget me method: clear all
+     * @returns {bool} success/failure flag
+     */
+    clearAllAppStorage(): void;
+    /**
+     * set the context value into localstorage (managed by localforage)
+     *
+     * @param {string} [value=''] context value
+     * @param {'localStorage' | 'sessionStorage'} [toStorage='localStorage'] specify storage
+     * @param {any} [tokenKey='token'] token key
+     * @returns {boolean} success/failure flag
+     */
+    setContext(value?: string, toStorage?: Storage, contextKey?: ContextKey): void;
+    /**
+     * get context from localstorage
+     *
+     * @param {'localStorage' | 'sessionStorage'} [fromStorage='localStorage'] specify storage
+     * @param {any} [tokenKey=TOKEN_KEY]  optionnal parameter to specify a token key
+     * @returns {number} token value
+     */
+    getContext(fromStorage?: Storage, contextKey?: ContextKey): number | null | undefined;
+};
+export default auth;

package/src/lib/services/i18n/index.d.ts

@@ -0,0 +1,11 @@
+export declare const LOCAL_STORAGE_I18N_STRING = "I18N_SELECTION";
+export declare const LangService: {
+    init: () => void;
+    changeLang: (lang: Languages) => void;
+    getLang: () => string;
+};
+export declare enum Languages {
+    EN = "en",
+    AR = "ar",
+    TR = "tr"
+}

package/src/lib/types/index.d.ts

@@ -0,0 +1,7 @@
+export declare enum Loading {
+    INITIAL = "initial",
+    PENDING = "pending",
+    SUCCESS = "success",
+    ERROR = "error"
+}
+export type Awaited<T> = T extends PromiseLike<infer U> ? Awaited<U> : T;

package/src/lib/utils/allSynchronously.d.ts

@@ -0,0 +1 @@
+export default function allSynchronously<T>(resolvables: (() => Promise<T>)[]): Promise<T[]>;

package/src/lib/utils/arrays.d.ts

@@ -0,0 +1,4 @@
+export declare class ArraysUtils {
+    static isArrayAndContainItems(dataList: unknown[]): boolean;
+    static pushToArray(array: unknown[], object: unknown): void;
+}

package/src/lib/utils/index.d.ts

@@ -0,0 +1,4 @@
+export { default as allSynchronously } from './allSynchronously';
+export * from './typesUtils';
+export * from './arrays';
+export * from './strings';

package/src/lib/utils/strings.d.ts

@@ -0,0 +1,5 @@
+export declare class StringsUtils {
+    static localCompareStrings(a: string, b: string): number;
+    static localeIncludeString(a: string, b: string): boolean;
+    static isStringHasCharacters(text?: string | null): boolean | "" | null | undefined;
+}

package/src/lib/utils/time.d.ts

@@ -0,0 +1,5 @@
+export declare class TimeUtils {
+    static convertSecToHMMSS(second: number): string;
+    static getDateSevenDaysFromNow(): Date;
+    static getDateToday(): Date;
+}

package/src/lib/utils/typesUtils.d.ts

@@ -0,0 +1 @@
+export declare const propertyOf: <TObj>(name: keyof TObj) => keyof TObj;