@bcrumbs.net/bc-api 0.0.2

package/lib/clients/dconfigClient.d.ts

@@ -0,0 +1,4 @@
+import { ApolloClient } from '@apollo/client';
+declare const dconfigClient: ApolloClient<import("@apollo/client").NormalizedCacheObject>;
+declare const tokenClient: ApolloClient<import("@apollo/client").NormalizedCacheObject>;
+export { tokenClient, dconfigClient };

package/lib/clients/dqueryClient.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { ApolloClient } from '@apollo/client';
+declare const dqueryClient: ApolloClient<import("@apollo/client").NormalizedCacheObject>;
+declare const withDQueryClient: (Page: typeof import("next/app").default | (import("react").ComponentClass<any, any> & {
+    getInitialProps?(context: import("next").NextPageContext): any;
+}) | (import("react").FunctionComponent<any> & {
+    getInitialProps?(context: import("next").NextPageContext): any;
+}), pageOptions?: import("next-with-apollo").WithApolloOptions | undefined) => {
+    ({ apollo, apolloState, router, ...props }: Partial<import("next-with-apollo").WithApolloProps<any>>): any;
+    displayName: string;
+    getInitialProps(pageCtx: import("next-with-apollo").ApolloContext<any>): Promise<{}>;
+};
+export { dqueryClient, withDQueryClient };

package/lib/clients/showcaseClient.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+export declare const withShowcaseClient: (Page: typeof import("next/app").default | (import("react").ComponentClass<any, any> & {
+    getInitialProps?(context: import("next").NextPageContext): any;
+}) | (import("react").FunctionComponent<any> & {
+    getInitialProps?(context: import("next").NextPageContext): any;
+}), pageOptions?: import("next-with-apollo").WithApolloOptions | undefined) => {
+    ({ apollo, apolloState, router, ...props }: Partial<import("next-with-apollo").WithApolloProps<any>>): any;
+    displayName: string;
+    getInitialProps(pageCtx: import("next-with-apollo").ApolloContext<any>): Promise<{}>;
+};

package/lib/config/index.d.ts

@@ -0,0 +1,17 @@
+declare let frontend: any;
+export declare const appConfig: {
+    dconfig: {
+        networkInterface: undefined;
+    };
+    dquery: {
+        networkInterface: string;
+    };
+    billing: {
+        networkInterface: string;
+    };
+    sw: {
+        path: string;
+    };
+};
+export default appConfig;
+export { frontend };

package/lib/endpoints/graphql/showcase/index.d.ts

@@ -0,0 +1,15 @@
+export declare const showcaseContentsQuery: import("@apollo/client").DocumentNode;
+export declare const showcaseTemplatesQuery: import("@apollo/client").DocumentNode;
+export declare const showcaseTemplatesQueryOptions: any;
+export declare const showcasePagesQuery: import("@apollo/client").DocumentNode;
+export declare const showcasePagesQueryOptions: any;
+export declare const showcaseSectionQuery: import("@apollo/client").DocumentNode;
+export declare const showcaseSectionQueryOptions: any;
+export declare const showcaseDomainsQuery: import("@apollo/client").DocumentNode;
+export declare const showcaseDomainsQueryOptions: any;
+export declare const useDomainsQuery: () => import("@apollo/client").QueryResult<any, {
+    companyId: string | null;
+}>;
+export declare const useShowcaseConfig: (domain: string) => import("@apollo/client").QueryResult<any, {
+    domain: string;
+}>;

package/lib/endpoints/graphql/usage/index.d.ts

@@ -0,0 +1 @@
+export declare const usageQuery: import("graphql").DocumentNode;

package/lib/endpoints/rest/auth/index.d.ts

@@ -0,0 +1,22 @@
+export declare const login: import("graphql").DocumentNode;
+export declare const loginOptions: any;
+export declare const register: import("graphql").DocumentNode;
+export declare const registerOptions: any;
+export declare const forgetPassword: import("graphql").DocumentNode;
+export declare const forgetPasswordOptions: any;
+export declare const resetPassword: import("graphql").DocumentNode;
+export declare const resetPasswordOptions: any;
+export declare const userInfoQuery: import("graphql").DocumentNode;
+export declare const userInfoQueryOptions: any;
+export interface DefinedUserProperty {
+    Id: string;
+    Value: string;
+}
+export declare const updateUserProfile: import("graphql").DocumentNode;
+export declare const updateUserProfileOptions: any;
+export declare const updateUserPassword: import("graphql").DocumentNode;
+export declare const updateUserPasswordOptions: any;
+export declare const inviteUser: import("graphql").DocumentNode;
+export declare const inviteUserOptions: any;
+export declare const removeUserFromCompany: import("graphql").DocumentNode;
+export declare const removeUserFromCompanyOptions: any;

package/lib/endpoints/rest/billing/index.d.ts

@@ -0,0 +1,2 @@
+export declare const CreateCheckoutSessionUri: string;
+export declare const CreatePortalSessionUri: string;

package/lib/endpoints/rest/companies/index.d.ts

@@ -0,0 +1,10 @@
+export declare const userCompaniesQuery: import("@apollo/client").DocumentNode;
+export declare const userCompaniesQueryOptions: any;
+export declare const useUserCompaniesQuery: () => import("@apollo/client").QueryResult<any, import("@apollo/client").OperationVariables>;
+export declare const companyUsersQuery: import("@apollo/client").DocumentNode;
+export declare const subscriptionConfigurationQuery: import("@apollo/client").DocumentNode;
+export declare const subscriptionConfigurationQueryOptions: any;
+export declare const createCompany: import("@apollo/client").DocumentNode;
+export declare const createCompanyOptions: any;
+export declare const updateCompany: import("@apollo/client").DocumentNode;
+export declare const updateCompanyOptions: any;

package/lib/endpoints/rest/contents/index.d.ts

@@ -0,0 +1,17 @@
+import { ContentInstancesQueryResult } from '../../../models/contentInstance';
+export declare const contentInstancesQuery: import("@apollo/client").DocumentNode;
+export declare const useContentInstancesQuery: (contentId: number) => import("@apollo/client").QueryResult<ContentInstancesQueryResult, import("@apollo/client").OperationVariables>;
+export declare const updateContentInstanceFieldValuesMutation: import("@apollo/client").DocumentNode;
+export declare const updateContentInstanceFieldValuesMutationOptions: any;
+export declare const useUpdateContentInstanceFieldValuesMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const createContentMutation: import("@apollo/client").DocumentNode;
+export declare const createContentMutationOptions: any;
+export declare const useCreateContentMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const createContentInstanceMutation: import("@apollo/client").DocumentNode;
+export declare const createContentInstanceMutationOptions: any;
+export declare const useCreateContentInstanceMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const removeContentMutation: import("@apollo/client").DocumentNode;
+export declare const useDeleteContentMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const updateContentsOrderingMutation: import("@apollo/client").DocumentNode;
+export declare const updateContentsOrderingMutationOptions: any;
+export declare const useUpdateContentsOrderingMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;

package/lib/endpoints/rest/files/index.d.ts

@@ -0,0 +1,14 @@
+import { FoldersTreeQueryResult } from '../../../models/folder';
+import { FilesQueryResult } from '../../../models/file';
+export declare const foldersTreeQuery: import("@apollo/client").DocumentNode;
+export declare const useFoldersTreeQuery: (rootPath: string) => import("@apollo/client").QueryResult<FoldersTreeQueryResult, import("@apollo/client").OperationVariables>;
+export declare const filesQuery: import("@apollo/client").DocumentNode;
+export declare const useFilesQuery: () => import("@apollo/client").LazyQueryResultTuple<FilesQueryResult, import("@apollo/client").OperationVariables>;
+export declare const createFolderMutation: import("@apollo/client").DocumentNode;
+export declare const useCreateFolderMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const deleteFolderMutation: import("@apollo/client").DocumentNode;
+export declare const useDeleteFolderMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const createFileMutation: import("@apollo/client").DocumentNode;
+export declare const useCreateFileMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;
+export declare const deleteFileMutation: import("@apollo/client").DocumentNode;
+export declare const useDeleteFileMutation: () => import("@apollo/client").MutationTuple<any, import("@apollo/client").OperationVariables, import("@apollo/client").DefaultContext, import("@apollo/client").ApolloCache<any>>;

package/lib/endpoints/rest/models/index.d.ts

@@ -0,0 +1,39 @@
+import { ModelQueryResult } from '../../../models/model';
+export declare const viewTypesQuery: import("@apollo/client").DocumentNode;
+export declare const viewTypesQueryOptions: {
+    options: () => {
+        client: import("@apollo/client").ApolloClient<import("@apollo/client").NormalizedCacheObject>;
+    };
+    name: string;
+    props: ({ viewTypes: { loading, viewTypes, refetch }, }: {
+        viewTypes: {
+            loading: boolean;
+            viewTypes: any;
+            refetch: any;
+        };
+    }) => {
+        models: any;
+        refetchModels: any;
+        loadingModels: boolean;
+    };
+};
+export declare const useModelsQuery: (templateContextId?: number | undefined) => import("@apollo/client").QueryResult<ModelQueryResult, import("@apollo/client").OperationVariables>;
+export declare const viewTypeChildrenQuery: import("@apollo/client").DocumentNode;
+export declare const viewTypeChildrenQueryOptions: {
+    options: () => {
+        client: import("@apollo/client").ApolloClient<import("@apollo/client").NormalizedCacheObject>;
+    };
+    name: string;
+    props: ({ viewTypes: { loading, viewTypes, refetch }, }: {
+        viewTypes: {
+            loading: boolean;
+            viewTypes: any;
+            refetch: any;
+        };
+    }) => {
+        models: any;
+        refetchModels: any;
+        loadingModels: boolean;
+    };
+};
+export declare const useModelChildrenQuery: (parentId?: number | undefined, templateId?: number | undefined) => import("@apollo/client").QueryResult<ModelQueryResult, import("@apollo/client").OperationVariables>;

package/lib/endpoints/rest/showcase/index.d.ts

@@ -0,0 +1,16 @@
+export declare const showcaseConfigurationQuery: import("@apollo/client").DocumentNode;
+export declare const useShowcaseConfigurationQuery: () => import("@apollo/client").QueryResult<any, {
+    ContextId: string | null;
+}>;
+export declare const showcaseConfigurationQueryOptions: any;
+export declare const addDomain: import("@apollo/client").DocumentNode;
+export declare const addDomainOptions: any;
+export declare const removeDomain: import("@apollo/client").DocumentNode;
+export declare const removeDomainOptions: any;
+export declare const useShowcaseTemplate: import("@apollo/client").DocumentNode;
+export declare const useShowcaseTemplateOptions: any;
+export declare const useShowcaseTemplateProgress: import("@apollo/client").DocumentNode;
+export declare const useShowcaseTemplateProgressQuery: (templateId: number) => import("@apollo/client").LazyQueryResultTuple<any, {
+    templateId: number;
+    companyId: string | null;
+}>;

package/lib/models/content.d.ts

@@ -0,0 +1,27 @@
+export interface Content {
+    Id: number;
+    Name: string;
+    DomainId?: number;
+    ViewTypeId?: number;
+    Online?: boolean;
+    PlentyChildren?: boolean;
+    ParentId?: number;
+    UrlName?: string;
+    Priority: number;
+    ContentType?: number;
+    UrlFullCode?: string;
+    CreatorId?: number;
+    StageId?: number;
+    CreateDate?: Date;
+    DueDate?: Date;
+}
+export interface GraphContent {
+    createDate?: Date;
+    id: number;
+    modelId?: number;
+    name: string;
+    online: boolean;
+    parentId?: number;
+    path?: string;
+    priority: number;
+}

package/lib/models/contentInstance.d.ts

@@ -0,0 +1,32 @@
+export interface ContentInstance {
+    Id: number;
+    Name: string;
+    MetaDescription: string;
+    MetaKeywords: string;
+    Title: string;
+    ViewTemplateId: number;
+    Online: boolean;
+    ContentId: number;
+    Language: string;
+    Version: number;
+    CreateDate: Date;
+    FieldsValues: ContentInstanceField[];
+    RedirectUrl: string;
+    DownloadPath: string;
+    DownloadName: string;
+    CreatorId: number;
+    StageId: number;
+    Stage: any;
+    Comments: any;
+    ContextCompanyId: number;
+    Data: string;
+    DataDic: any;
+}
+export interface ContentInstanceField {
+    ContentId?: number;
+    FieldId: number;
+    Value: string;
+}
+export interface ContentInstancesQueryResult {
+    contentInstances: ContentInstance[];
+}

package/lib/models/file.d.ts

@@ -0,0 +1,12 @@
+export interface File {
+    Name: string;
+    Id: string;
+    Type: string;
+    Path: string;
+    Length: number;
+    CreationDate: Date;
+    LastModifiedDate: Date;
+}
+export interface FilesQueryResult {
+    files: File[];
+}

package/lib/models/folder.d.ts

@@ -0,0 +1,11 @@
+export interface FolderTreeItem {
+    id: string;
+    text: string;
+    obj: {
+        Path: string;
+    };
+    children?: FolderTreeItem[];
+}
+export interface FoldersTreeQueryResult {
+    foldersTree: FolderTreeItem[];
+}

package/lib/models/model.d.ts

@@ -0,0 +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"
+}

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

@@ -0,0 +1,120 @@
+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;

package/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/lib/services/validators/index.d.ts

@@ -0,0 +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;