@yusr_systems/core 2.0.1

package/dist/yusr-core.d.ts

@@ -0,0 +1,202 @@
+import { InternalDispatch } from '../../../yusr-ui/src/state/factory';
+import { PayloadAction } from '@reduxjs/toolkit';
+import { Slice } from '@reduxjs/toolkit';
+import { SliceSelectors } from '@reduxjs/toolkit';
+
+export declare class ApiConstants {
+    private static _baseUrl;
+    static get baseUrl(): string;
+    static initialize(url: string): void;
+}
+
+declare interface AuthActions {
+    logout: () => any;
+    syncFromStorage: () => any;
+}
+
+export declare class AuthConstants {
+    static LoggedInUserStorageItemName: string;
+    static AuthCheckStorageItemName: string;
+    static SettingStorageItemName: string;
+    static UnauthorizedEventName: string;
+}
+
+export declare interface AuthState<TUser, TSetting> {
+    isAuthenticated: boolean;
+    loggedInUser: Partial<TUser> | undefined;
+    setting: Partial<TSetting> | undefined;
+}
+
+export declare abstract class BaseApiService<T extends BaseEntity> extends BaseFilterableApiService<T> {
+    Get(id: number): Promise<RequestResult<T>>;
+    Add(entity: T): Promise<RequestResult<unknown>>;
+    Update(entity: T): Promise<RequestResult<unknown>>;
+    Delete(id: number): Promise<RequestResult<unknown>>;
+}
+
+export declare abstract class BaseEntity {
+    id: number;
+}
+
+export declare abstract class BaseFilterableApiService<T extends BaseEntity> {
+    abstract routeName: string;
+    Filter(pageNumber: number, rowsPerPage: number, condition?: FilterCondition): Promise<RequestResult<FilterResult<T>>>;
+}
+
+export declare class City extends BaseEntity {
+    name: string;
+    countryId: number;
+    country: Country;
+    constructor(init?: Partial<City>);
+}
+
+export declare class CityFilterColumns {
+    static columnsNames: ColumnName[];
+}
+
+export declare type ColumnName = {
+    label: string;
+    value: string;
+};
+
+export declare class Country extends BaseEntity {
+    name: string;
+    code: string;
+    constructor(init?: Partial<Country>);
+}
+
+export declare class CountryFilterColumns {
+    static columnsNames: ColumnName[];
+}
+
+export declare const createAuthSlice: <TUser extends object, TSetting extends object>() => Slice<AuthState<object, object>, {
+login: (state: {
+isAuthenticated: boolean;
+loggedInUser: object | undefined;
+setting: object | undefined;
+}, action: PayloadAction<{
+user: TUser;
+setting: TSetting;
+} | undefined>) => void;
+logout: (state: {
+isAuthenticated: boolean;
+loggedInUser: object | undefined;
+setting: object | undefined;
+}) => void;
+updateLoggedInUser: (state: {
+isAuthenticated: boolean;
+loggedInUser: object | undefined;
+setting: object | undefined;
+}, action: PayloadAction<TUser>) => void;
+updateSetting: (state: {
+isAuthenticated: boolean;
+loggedInUser: object | undefined;
+setting: object | undefined;
+}, action: PayloadAction<TSetting>) => void;
+syncFromStorage: (state: {
+isAuthenticated: boolean;
+loggedInUser: object | undefined;
+setting: object | undefined;
+}) => void;
+}, "auth", "auth", SliceSelectors<AuthState<object, object>>>;
+
+export declare class Currency extends BaseEntity {
+    name: string;
+    code: string;
+    isFeminine: boolean;
+    plural: string;
+    subName: string;
+    subIsFeminine: boolean;
+    subPlural: string;
+    constructor(init?: Partial<Currency>);
+}
+
+export declare class FilterCondition {
+    value: string;
+    columnName: string;
+    constructor(init?: Partial<FilterCondition>);
+}
+
+export declare type FilterResult<T> = {
+    data: T[] | undefined;
+    count: number;
+};
+
+export declare class LoginRequest {
+    companyEmail: string;
+    username: string;
+    password: string;
+    constructor(init?: Partial<LoginRequest>);
+}
+
+export declare type PermissionSelector<S> = (state: S, resource: string) => ResourcePermissions;
+
+export declare type RequestResult<T> = {
+    data?: T;
+    status: number;
+    errorTitle: string;
+    errorDetails: string;
+};
+
+export declare interface ResourcePermissions {
+    getPermission: boolean;
+    addPermission: boolean;
+    updatePermission: boolean;
+    deletePermission: boolean;
+}
+
+export declare const setupAuthListeners: (dispatch: InternalDispatch, actions: AuthActions) => void;
+
+export declare class StorageFile {
+    url: string | null;
+    base64File: string | null;
+    extension: string | null;
+    contentType: string | null;
+    status: StorageFileStatus;
+    constructor(init?: Partial<StorageFile>);
+}
+
+export declare const StorageFileStatus: {
+    readonly Unchanged: 0;
+    readonly New: 1;
+    readonly Delete: 2;
+};
+
+export declare type StorageFileStatus = typeof StorageFileStatus[keyof typeof StorageFileStatus];
+
+export declare class SystemPermissions {
+    static Format(resource: string, action: string): string;
+    static hasAuth(permissions: string[], resource: string, action: string): boolean;
+    private permissions;
+    private resource;
+    constructor(permissions: string[], resource: string);
+    hasAuth(action: string): boolean;
+    static getFirstPermissionPath(permissions: string[]): string;
+}
+
+export declare interface ValidationRule<T> {
+    field: keyof T | string;
+    selector: (data: T) => any;
+    validators: ValidatorFn[];
+}
+
+export declare type ValidatorFn<T = any> = (value: T, formData?: any) => string | null;
+
+export declare class Validators {
+    static required(message?: string): ValidatorFn;
+    static min(min: number, message?: string): ValidatorFn;
+    static max(threshold: number, message?: string): ValidatorFn;
+    static arrayMinLength(min: number, message?: string): ValidatorFn;
+    static custom<T>(fn: (value: T, formData: any) => boolean, message: string): ValidatorFn<T>;
+}
+
+export declare class YusrApiHelper {
+    static Get<T>(url: string, options?: RequestInit): Promise<RequestResult<T>>;
+    static Post<T>(url: string, body?: unknown, options?: RequestInit, successMessage?: string): Promise<RequestResult<T>>;
+    static Put<T>(url: string, body?: unknown, options?: RequestInit, successMessage?: string): Promise<RequestResult<T>>;
+    static Delete<T>(url: string, options?: RequestInit, successMessage?: string): Promise<RequestResult<T>>;
+    static PostBlob(url: string, body?: unknown, options?: RequestInit): Promise<Blob | undefined>;
+    private static handleResponse;
+}
+
+export { }