@solidev/data 0.5.0 → 0.6.0

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@solidev/data",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "peerDependencies": {
-    "@angular/common": "^19",
-    "@angular/core": "^19",
-    "@ng-bootstrap/ng-bootstrap": "^17",
+    "@angular/common": "^20",
+    "@angular/core": "^20",
+    "@ng-bootstrap/ng-bootstrap": "^19.0.0-rc.0",
     "jwt-decode": "^4",
-    "ngx-editor": "^18"
+    "ngx-editor": "^19.0.0-beta.1"
   },
   "dependencies": {
     "tslib": "^2.6"

package/lib/auth/auth-interceptor.service.d.ts

@@ -1,31 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { HttpHandler, HttpInterceptor, HttpRequest } from '@angular/common/http';
-import { AuthServiceBase } from './auth.service';
-import * as i0 from "@angular/core";
-export declare const DATA_AUTH_SERVICE: InjectionToken<AuthServiceBase<any, any, any>>;
-/**
- * List of urls that should be intercepted by the auth interceptor, thus receiving the auth token
- * Default : empty list
- */
-export declare const DATA_AUTH_URLS: InjectionToken<string[]>;
-export declare class AuthInterceptor implements HttpInterceptor {
-    private _auth;
-    private _apiUrl;
-    private _urls;
-    private _isRefreshing;
-    private _refreshTokenSubject;
-    constructor(_auth: AuthServiceBase<any, any, any>, _apiUrl: string, _urls: string[] | null);
-    /**
-     * The auth token in added to the request if :
-     * - the request is not anonymous
-     * - the request is for the api url, but not for the refresh or login urls
-     * - the request is for one of the urls specified in the DATA_AUTH_URLS injection token
-     * @param req
-     * @param next
-     */
-    intercept(req: HttpRequest<any>, next: HttpHandler): import("rxjs").Observable<import("@angular/common/http").HttpEvent<any>>;
-    private _handle401Error;
-    private _addToken;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AuthInterceptor, [null, null, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AuthInterceptor>;
-}

package/lib/auth/auth.service.d.ts

@@ -1,64 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { IJwtBaseData, IJwtRefreshResponseJson } from './jwt';
-import { HttpClient } from '@angular/common/http';
-import { Observable, Subject } from 'rxjs';
-import { DataModel } from '../data/data-model';
-import { Collection } from '../data/data-collection';
-import { Router } from '@angular/router';
-import { DataMessageService } from '../messages/message.service';
-export interface AuthParams {
-    tokenUrl: string;
-    tokenRefreshUrl: string;
-    requestReactivateUrl?: string;
-    processReactivateUrl?: string;
-    requestPwResetUrl?: string;
-    processPwResetUrl?: string;
-    loginField: string;
-    passwordField: string;
-    tokenField: string;
-    loginRoute: string[];
-    logoutRoute: string[];
-    pwresetRoute?: string[];
-    reactivateRoute?: string[];
-    userFetchFields?: string[];
-    userFetchValiditySeconds?: number;
-}
-/**
- * DATA_API_URL: stores data api base url
- */
-export declare const DATA_AUTH_PARAMS: InjectionToken<AuthParams>;
-export declare const DATA_AUTH_USER_SERVICE: InjectionToken<Collection<any>>;
-export declare class AuthServiceBase<User extends DataModel, UserService extends Collection<User>, UserData extends IJwtBaseData> {
-    userService: UserService;
-    private _params;
-    private _router;
-    private _http;
-    private _msgs;
-    logout$: Subject<void>;
-    private _user;
-    private _user$;
-    private _token;
-    private _fetched?;
-    constructor(userService: UserService, _params: AuthParams, _router: Router, _http: HttpClient, _msgs: DataMessageService);
-    get isAnonymous(): boolean;
-    get accessToken(): string | null;
-    get refreshToken(): string | null;
-    get currentUser(): User | null;
-    get currentUser$(): Observable<User | null>;
-    get refreshUrl(): string;
-    get loginUrl(): string;
-    get loginRoute(): string[];
-    get logoutRoute(): string[];
-    get pwresetRoute(): string[] | undefined;
-    get reactivateRoute(): string[] | undefined;
-    logout(): void;
-    autoLogin(): void;
-    login(username: string, password: string): Observable<'success' | 'error' | 'invalid_token' | string>;
-    requestReactivate(username: string): Observable<boolean>;
-    requestPwReset(username: string): Observable<boolean>;
-    processReactivate(username: string, token: string): Observable<boolean>;
-    processPwReset(username: string, password: string, token: string): Observable<boolean>;
-    saveAuth(): void;
-    refresh(): Observable<IJwtRefreshResponseJson | null>;
-    private _fetchUser;
-}

package/lib/auth/jwt.d.ts

@@ -1,22 +0,0 @@
-export interface IJwtResponseJson {
-    access: string;
-    refresh: string;
-}
-export interface IJwtRefreshResponseJson {
-    access: string;
-}
-export interface IJwtBaseData {
-    token_type: 'access' | 'refresh';
-    user_id: number;
-}
-export declare class Jwt<UserJwtData extends IJwtBaseData> {
-    readonly access?: string;
-    readonly refresh?: string;
-    private readonly _data;
-    constructor(response?: IJwtResponseJson);
-    get data(): UserJwtData | null;
-    toJson(): {
-        access: string | undefined;
-        refresh: string | undefined;
-    };
-}

package/lib/data/data-backend.d.ts

@@ -1,72 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { TransferState } from '@angular/core';
-import { Collection, IActionParams } from './data-collection';
-import { DataModel } from './data-model';
-import * as i0 from "@angular/core";
-/**
- * DataBackend provides CRUD operations to a REST api.
- * TransferState can be used if DATA_MAX_TRANSFERSTATE_TIME is set and > 0
- */
-export declare class DataBackend {
-    private _http;
-    private _transferState;
-    private _platform;
-    private _apiUrl;
-    private _maxTransferstateTime;
-    private _created;
-    constructor(_http: HttpClient, _transferState: TransferState, _platform: any, _apiUrl: string, _maxTransferstateTime?: number);
-    /**
-     * Return api url for this backend.
-     */
-    get apiUrl(): string;
-    /**
-     * Launch an action on collection.
-     * If method is GET and collection.useTranserState & transferState are enabled,
-     * result is stored / retrieved from transferState.
-     *
-     * @param collection Collection reference
-     * @param method HTTP method
-     * @param url full URL for action
-     * @param body JSON body
-     * @param params query parameters
-     * @param headers query headers
-     * @param responseType response type
-     *
-     * @return an observable of response body
-     */
-    action<T extends DataModel, RT>(collection: Collection<T>, method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', url: string, { body, params, headers }?: IActionParams): Observable<RT>;
-    /**
-     * Launch an action on collection, receiving a blob.
-     *
-     * @param collection Collection reference
-     * @param method HTTP method
-     * @param url full URL for action
-     * @param body JSON body
-     * @param params query parameters
-     * @param headers query headers
-     * @param responseType response type
-     *
-     * @return an observable of response body
-     */
-    blob<T extends DataModel>(collection: Collection<T>, method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', url: string, { body, params, headers }?: IActionParams): Observable<Blob>;
-    put<T extends DataModel>(collection: Collection<T>, url: string, { body, params, headers }?: IActionParams): Observable<T>;
-    post<T extends DataModel>(collection: Collection<T>, url: string, { body, params, headers }?: IActionParams): Observable<Partial<T>>;
-    patch<T extends DataModel>(collection: Collection<T>, url: string, { body, params, headers }?: IActionParams): Observable<Partial<T>>;
-    delete<T extends DataModel, R>(collection: Collection<T>, url: string, { params, headers }?: IActionParams): Observable<R>;
-    _cachedGet<T extends DataModel, RT>(collection: Collection<T>, url: string, { params, headers }?: IActionParams): Observable<RT>;
-    get<T extends DataModel>(collection: Collection<T>, url: string, { params, headers }?: IActionParams): Observable<Partial<T>>;
-    list<T extends DataModel>(collection: Collection<T>, url: string, { params, headers }?: IActionParams): Observable<any>;
-    /**
-     * Return headers for this backend.
-     * Provided headers are copied and returned.
-     * Can be overriden by subclasses for specific headers (e.g. auth token).
-     */
-    protected headers(headers: {
-        [key: string]: string;
-    }): {
-        [key: string]: string;
-    };
-    static ɵfac: i0.ɵɵFactoryDeclaration<DataBackend, [null, null, null, null, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DataBackend>;
-}

package/lib/data/data-collection.d.ts

@@ -1,110 +0,0 @@
-import { DataModel } from './data-model';
-import { DataBackend } from './data-backend';
-import { Observable } from 'rxjs';
-import { FilterData, IQuerysetOptions, Queryset } from './data-query';
-export type IHttpMethod = 'POST' | 'GET' | 'DELETE' | 'PUT' | 'PATCH';
-export interface IActionParams {
-    body?: any;
-    headers?: {
-        [index: string]: string;
-    };
-    params?: {
-        [index: string]: string;
-    };
-    responseType?: 'json' | 'blob';
-}
-export interface ICollectionCacheParams {
-    transferState?: {
-        enabled: boolean;
-        maxTime: number;
-        maxCount: number;
-    };
-}
-export type DataModelType<T extends DataModel> = new (_coll?: Collection<T>) => T;
-export declare class Collection<T extends DataModel> {
-    protected backend: DataBackend;
-    protected path: string;
-    model: DataModelType<T>;
-    useTransferState: boolean;
-    constructor(backend: DataBackend, path: string, model: DataModelType<T>);
-    create(data?: Partial<T>): T;
-    fromJson(data: Partial<T>): T;
-    fromJson(data: Partial<T>[]): T[];
-    queryset(options?: IQuerysetOptions): Queryset<T>;
-    fetch(id: number, { prefix, suffix, params, headers, }?: {
-        prefix?: string;
-        suffix?: string;
-        params?: {
-            [_index: string]: string;
-        };
-        headers?: {
-            [_index: string]: string;
-        };
-    }): Observable<T>;
-    action<RT>(model: T | null, method: IHttpMethod, action: string, { body, params, headers }?: IActionParams): Observable<RT>;
-    save(model: T, { updateModel }?: {
-        updateModel?: boolean;
-    }): Observable<T>;
-    update(model: T, fields?: string[], { updateModel }?: {
-        updateModel?: boolean;
-    }): Observable<T>;
-    delete(model: T, { params, headers }?: IActionParams): Observable<any>;
-    list(query?: FilterData, { prefix, suffix, params, headers, }?: {
-        prefix?: string;
-        suffix?: string;
-        params?: {
-            [_index: string]: string;
-        };
-        headers?: {
-            [_index: string]: string;
-        };
-    }): Observable<T[]>;
-    /**
-     * Calls *method* endpoint for this collection and returns raw results.
-     *
-     * @param method GET/POST/...
-     * @param prefix collection_urlPREFIXSUFFIX
-     * @param suffix collection_urlPREFIXSUFFIX
-     * @param params query paremeters
-     * @param body body as json
-     * @param headers headers
-     */
-    raw<RT>({ method, prefix, suffix, params, body, headers, }?: {
-        method?: IHttpMethod;
-        prefix?: string;
-        suffix?: string;
-        body?: any;
-        params?: {
-            [_index: string]: string;
-        };
-        headers?: {
-            [_index: string]: string;
-        };
-    }): Observable<RT>;
-    /**
-     * Calls *method* endpoint for this collection and returns raw results.
-     *
-     * @param method GET/POST/...
-     * @param prefix collection_urlPREFIXSUFFIX
-     * @param suffix collection_urlPREFIXSUFFIX
-     * @param params query paremeters
-     * @param body body as json
-     * @param headers headers
-     */
-    blob<RT>({ method, prefix, suffix, params, body, headers, }?: {
-        method?: IHttpMethod;
-        prefix?: string;
-        suffix?: string;
-        body?: any;
-        params?: {
-            [_index: string]: string;
-        };
-        headers?: {
-            [_index: string]: string;
-        };
-    }): Observable<Blob>;
-    getUrl(id?: number | null, { prefix, suffix }?: {
-        prefix?: string;
-        suffix?: string;
-    }): string;
-}

package/lib/data/data-collection.mock.d.ts

@@ -1,19 +0,0 @@
-import { DataModel } from "./data-model";
-import { Observable } from "rxjs";
-import { IQuerysetOptions } from "./data-query";
-import { QuerysetMock } from "./data-query.mock";
-import { Collection, IActionParams, IHttpMethod } from "./data-collection";
-export declare class CollectionMock<T extends DataModel> {
-    protected model: new (coll: Collection<T>) => T;
-    mockValue?: T;
-    mockValues?: T[];
-    actionValue: any;
-    constructor(model: new (coll: Collection<T>) => T);
-    fetch(id: number, suffix?: string): Observable<T>;
-    action(model: T | null, method: IHttpMethod, action: string, params: IActionParams): Observable<any>;
-    queryset(options?: IQuerysetOptions): QuerysetMock<T>;
-    list(query?: {
-        [index: string]: string;
-    }, suffix?: string): Observable<any>;
-    fromJson(data: any, many?: boolean): T | any;
-}

package/lib/data/data-model.d.ts

@@ -1,94 +0,0 @@
-import { BaseFieldManager, IFieldStoredMetadata } from './fields/base';
-import { FormControl, FormGroup, ValidationErrors } from '@angular/forms';
-import { Collection } from './data-collection';
-import { Observable } from 'rxjs';
-export type DataModelFields = Readonly<Map<string, IFieldStoredMetadata<any>>>;
-/**
- * Base class for data model.
- *
- * Each class must have a static __name
- * primary field is given with id field.
- *
- * Some methods are provided to be used with a collection, mostly for CRUD operations.
- *
- */
-export declare class DataModel {
-    protected _coll?: Collection<any> | undefined;
-    /**
-     * data model name
-     * this need to be given because class name is not fully available because of minification.
-     */
-    protected static readonly __name: string;
-    /**
-     * Primary field; readonly; must be created and auto incremented on db side.
-     */
-    id: number;
-    private readonly _F;
-    /**
-     * Constructor for data model instance.
-     * A matching collection can be provided.
-     * ___fields readonly property is also populated from Reflected metadata
-     *
-     * @param _coll collection used for CRUD, etc..
-     */
-    constructor(_coll?: Collection<any> | undefined);
-    get _collection(): Collection<any>;
-    set _collection(coll: Collection<any>);
-    /**
-     *  HashMap of fields metadata (type, name, manager, etc...)
-     */
-    get F(): DataModelFields;
-    get FN(): IterableIterator<string>;
-    /**
-     * Loads model data from json.
-     * If partial is true, only fields with matching data keys will be loaded
-     * @param data
-     * @param options
-     */
-    fromJson(data: {
-        [index: string]: any;
-    }, { partial, check }?: {
-        partial?: boolean;
-        check?: boolean;
-    }): null | ValidationErrors;
-    toJson(fields?: string | string[]): any;
-    action<T, RT extends {
-        [index: string]: any;
-    }>(method: 'POST' | 'PATCH' | 'GET' | 'DELETE' | 'PUT', name: string, { body, update, updatePartial, updateCheck, params, headers, }?: {
-        body?: {
-            [_index: string]: any;
-        };
-        update?: boolean;
-        updatePartial?: boolean;
-        updateCheck?: boolean;
-        params?: {
-            [_index: string]: string;
-        };
-        headers?: {
-            [_index: string]: string;
-        };
-    }): Observable<RT>;
-    FM<FT>(field: string): BaseFieldManager<FT>;
-    FV<FT>(field: string): FT;
-    /**
-     * Set field value. If check is true, only set value if all validators pass.
-     * Skip setting field value if manager computed flag is true.
-     *
-     * The validation result is returned.
-     *
-     * @param field field name
-     * @param value field valued
-     * @param check default false
-     * @return null or ValidationError
-     */
-    setFV<FT>(field: string, value: FT, check?: boolean): null | ValidationErrors;
-    FC(): FormGroup;
-    FC(field: string): FormControl;
-    FC(field: string[]): FormGroup;
-    save({ updateModel }?: {
-        updateModel?: boolean;
-    }): Observable<this>;
-    update(fields?: string[], { updateModel }?: {
-        updateModel?: boolean;
-    }): Observable<this>;
-}

package/lib/data/data-parameters.d.ts

@@ -1,26 +0,0 @@
-import { InjectionToken } from "@angular/core";
-/**
- * DATA_API_URL: stores data api base url
- */
-export declare const DATA_API_URL: InjectionToken<string>;
-/**
- * DATA_MAX_TRANSFERSTATE_TIME: max duration to use transferstate time
- * If DATA_MAX_TRANSFERSTATE_TIME is zero, TransferState is not used
- */
-export declare const DATA_MAX_TRANSFERSTATE_TIME: InjectionToken<number>;
-/**
- * DataDisplayConfig interface provides default values for display classes
- */
-export interface DataDisplayConfig {
-    dispEdit: {
-        defaultMode: "inline" | "dd";
-        inputClasses: {
-            [index: string]: string;
-        };
-    };
-}
-export declare const BootstrapDataDisplayConfig: DataDisplayConfig;
-/**
- * DATA_DISPLAY_CONFIG: display config & default classes injection token
- */
-export declare const DATA_DISPLAY_CONFIG: InjectionToken<DataDisplayConfig>;

package/lib/data/data-query.d.ts

@@ -1,104 +0,0 @@
-import { Collection } from './data-collection';
-import { DataModel } from './data-model';
-import { Observable } from 'rxjs';
-import { ActivatedRoute, Router } from '@angular/router';
-export interface FilterData {
-    [index: string]: string | number | boolean | undefined | null;
-}
-export interface OutFilterData {
-    [index: string]: string;
-}
-export type SortData = string;
-/**
- * Queryset parameters
- */
-export interface IQuerysetOptions {
-    /** Emit fields list */
-    emitFields?: boolean;
-    /** Queryset name */
-    name?: string;
-    /** TODO: see usage */
-    route?: ActivatedRoute;
-    /** TODO: see usage */
-    router?: Router;
-    /** TODO: see usage */
-    hash?: string;
-}
-export interface IQueryNav {
-    page: number;
-    page_size: number;
-}
-export interface IQueryMetaNav {
-    count: number;
-    next: number | null;
-    page: number;
-    pages: number;
-    prev: number | null;
-    size: number;
-}
-export interface IQueryMetaNavParams {
-    page: string;
-    page_size: string;
-}
-export interface IQueryMeta {
-    nav: IQueryMetaNav;
-    parameters: IQueryMetaNavParams;
-}
-export interface IQueryFullResponse<T> extends IQueryMeta {
-    results: T[];
-}
-export declare class Queryset<T extends DataModel> {
-    protected _coll: Collection<T>;
-    /** Current filter data */
-    filterData: FilterData;
-    /** Current sorter data */
-    sortData: SortData[];
-    /** Current fields */
-    fields: string[];
-    /** Current page size */
-    pageSize: number;
-    /** Current page number */
-    page: number;
-    options: IQuerysetOptions;
-    private _loading;
-    /** Loading status (true if currently fetching data) */
-    loading: Observable<boolean>;
-    private _meta;
-    /** Results meta part observable */
-    meta: Observable<IQueryMeta>;
-    private _results;
-    /** Results data part observable */
-    results: Observable<T[]>;
-    private _full;
-    /** Full results observable (results, loading, meta) */
-    full: Observable<[T[], boolean, IQueryMeta]>;
-    constructor(_coll: Collection<T>, options?: IQuerysetOptions);
-    private _pristine;
-    /** Pristine status (true if it has not collected results yet) */
-    get pristine(): boolean;
-    /**
-     * Update current filter data. Null or undefined values are removed from filter data.
-     * @param params filter data
-     * @param update boolean to update filter data instead of recreating it from scratch
-     */
-    filter(params?: FilterData, update?: boolean): Queryset<T>;
-    /**
-     * Update sorting parameters, list of strings giving sort parameters e.g. sort("+name", "-id").
-     * @param sorting strings of sort parameters
-     */
-    sort(...sorting: string[]): Queryset<T>;
-    /**
-     * Update page size.
-     * @param pageSize required page size
-     */
-    paginateBy(pageSize?: number): Queryset<T>;
-    /**
-     * Update current page number.
-     * @param page required pqge
-     * @param fragment TODO: fragment usage for router usage
-     */
-    setPage(page?: number, fragment?: string): Queryset<T>;
-    setFields(fields: string[]): Queryset<T>;
-    getQueryParams(): OutFilterData;
-    get(refresh?: boolean, sync?: boolean): Observable<T[]>;
-}

package/lib/data/data-query.mock.d.ts

@@ -1,25 +0,0 @@
-import { DataModel } from "./data-model";
-import { CollectionMock } from "./data-collection.mock";
-import { FilterData, IQueryMeta, IQuerysetOptions, SortData } from "./data-query";
-import { Observable } from "rxjs";
-export declare class QuerysetMock<T extends DataModel> {
-    protected _coll: CollectionMock<T>;
-    options: IQuerysetOptions;
-    mockData: T[];
-    filterData: FilterData;
-    sortData: SortData[];
-    pageSize: number;
-    page: number;
-    pristine: boolean;
-    loading: Observable<boolean>;
-    constructor(_coll: CollectionMock<T>, options?: IQuerysetOptions);
-    get results(): Observable<T[]>;
-    get meta(): Observable<IQueryMeta>;
-    get full(): Observable<[T[], boolean, IQueryMeta]>;
-    filter(params?: FilterData): QuerysetMock<T>;
-    sort(...sorting: string[]): QuerysetMock<T>;
-    paginateBy(pageSize?: number): QuerysetMock<T>;
-    setPage(page: number): QuerysetMock<T>;
-    getQueryParams(): FilterData;
-    get(): Observable<T[]>;
-}