@bcrumbs.net/bc-api 0.0.3 → 0.0.4

package/lib/models/model.d.ts

@@ -1,33 +1,33 @@
-export interface Model {
-    Id: number;
-    Name: string;
-    ViewFields: ModelField[];
-}
-export interface ModelField {
-    Id: number;
-    Name: string;
-    Type: ModelFieldsTypes;
-    EnumId: number;
-}
-export interface ModelQueryResult {
-    viewTypes: Model[];
-}
-export declare class ModelUtilities {
-    static ConvertModelsListToFieldsMap(models: Model[]): Map<number, ModelField>;
-}
-export declare enum ModelFieldsTypes {
-    String = "String",
-    StringML = "String - Multiple Lines",
-    RichTextBox = "Rich Text Box",
-    Date = "Date",
-    PredefinedList = "Predefined List",
-    PredefinedListCheckboxes = "Predefined List - Checkboxes",
-    PredefinedListRadioButtons = "Predefined List - Radio Buttons",
-    PredefinedListFilterSelect = "Predefined List - Filter/Select",
-    AutoIncrementNumber = "Auto Increment Number",
-    ContentUrl = "Content Url",
-    Boolean = "Boolean",
-    Number = "Number",
-    Image = "Image",
-    MultipleImages = "Multiple Images"
-}
+export interface Model {
+    Id: number;
+    Name: string;
+    ViewFields: ModelField[];
+}
+export interface ModelField {
+    Id: number;
+    Name: string;
+    Type: ModelFieldsTypes;
+    EnumId: number;
+}
+export interface ModelQueryResult {
+    viewTypes: Model[];
+}
+export declare class ModelUtilities {
+    static ConvertModelsListToFieldsMap(models: Model[]): Map<number, ModelField>;
+}
+export declare enum ModelFieldsTypes {
+    String = "String",
+    StringML = "String - Multiple Lines",
+    RichTextBox = "Rich Text Box",
+    Date = "Date",
+    PredefinedList = "Predefined List",
+    PredefinedListCheckboxes = "Predefined List - Checkboxes",
+    PredefinedListRadioButtons = "Predefined List - Radio Buttons",
+    PredefinedListFilterSelect = "Predefined List - Filter/Select",
+    AutoIncrementNumber = "Auto Increment Number",
+    ContentUrl = "Content Url",
+    Boolean = "Boolean",
+    Number = "Number",
+    Image = "Image",
+    MultipleImages = "Multiple Images"
+}

package/lib/models/usage.d.ts

@@ -0,0 +1,16 @@
+export interface UsageRecord {
+    id: string;
+    object: string;
+    livemode: boolean;
+    total_usage: number;
+    subscription_item: string;
+    timestamp: number;
+}
+export interface UsageRecordQueryResult {
+    queryUsage: {
+        object: string;
+        data: UsageRecord[];
+        has_more: boolean;
+        url: string;
+    };
+}

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

@@ -1,120 +1,123 @@
-declare type STORES_TYPES = 'localStorage' | 'sessionStorage';
-declare type Storage = STORES_TYPES;
-declare type TokenKey = string;
-declare type ContextKey = string;
-declare type UserInfoKey = string;
-declare type User = {
-    name: string;
-    surname: 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(): any;
-    /**
-     * 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 {string} token value
-   */
-    getContext(fromStorage?: Storage, contextKey?: ContextKey): string | null;
-};
-export default auth;
+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(): any;
+    /**
+     * 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 {string} token value
+   */
+    getContext(fromStorage?: Storage, contextKey?: ContextKey): string | null;
+};
+export default auth;

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

@@ -1,11 +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"
-}
+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/lib/services/validators/index.d.ts

@@ -1,20 +1,20 @@
-declare const Validators: {
-    /**
-     * validate image
-     *
-     * @param {any} [file=File] uploaded file
-     * @param {func} [callBack=()=>{ }]  the callback function
-     */
-    validateImage(file: any, callback: any): void;
-};
-export declare const ValidatorsConstants: {
-    MaxFileSize: number;
-    FileFormats: {
-        TEXT: never[];
-        IMAGE: string[];
-        VIDEO: string[];
-        AUDIO: string[];
-        FILE: never[];
-    };
-};
-export default Validators;
+declare const Validators: {
+    /**
+     * validate image
+     *
+     * @param {any} [file=File] uploaded file
+     * @param {func} [callBack=()=>{ }]  the callback function
+     */
+    validateImage(file: any, callback: any): void;
+};
+export declare const ValidatorsConstants: {
+    MaxFileSize: number;
+    FileFormats: {
+        TEXT: never[];
+        IMAGE: string[];
+        VIDEO: string[];
+        AUDIO: string[];
+        FILE: never[];
+    };
+};
+export default Validators;