@mediusinc/mng-commons-data-api-class 6.2.0-rc.0 → 7.0.0-rc.0

package/v1/index.d.ts

@@ -1,15 +1,353 @@
-export * from './helpers/query-param-convert';
-export * from './helpers/tableview-crud-create';
-export * from './models/builders/query-param.builder';
-export * from './models/filter-match-type.model';
-export * from './models/filter-param.model';
-export * from './models/query-mode.model';
-export * from './models/query-param.model';
-export * from './models/query-result.model';
-export * from './services/tokens/data-api-class.token';
-export * from './services/api.abstract.service';
-export * from './services/crud-api.abstract.service';
-export * from './services/get-all-api.abstract.service';
-export * from './tableview/tableview-crud.data-provider';
-export * from './utils/query-param-map.util';
-export * from './provide';
+import { Observable } from 'rxjs';
+import { ClassAttributeDef, DataListParams, DataListResult, ClassType, IdType, ServiceClassType, CommonsFeature } from '@mediusinc/mng-commons/core';
+import * as _mediusinc_mng_commons_tableview_api from '@mediusinc/mng-commons/tableview/api';
+import { TableviewDataProviderInst, TableviewInputBuilder, TableviewDescriptorInst } from '@mediusinc/mng-commons/tableview/api';
+import { HttpClient, HttpParams } from '@angular/common/http';
+import { ObjectSerializer } from '@mediusinc/mng-commons-data-api-class';
+import { Type, InjectionToken, Provider } from '@angular/core';
+
+/**
+ * Generated API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+declare enum MediusFilterMatchType {
+    Equals = "EQUALS",
+    NotEquals = "NOT_EQUALS",
+    FromTo = "FROM_TO",
+    Contains = "CONTAINS",
+    StartsWith = "STARTS_WITH",
+    EndsWith = "ENDS_WITH",
+    In = "IN",
+    NotIn = "NOT_IN",
+    SmallerThan = "SMALLER_THAN",
+    GreaterThan = "GREATER_THAN",
+    Exists = "EXISTS",
+    DoesNotExist = "DOES_NOT_EXIST"
+}
+
+/**
+ * Generated API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+declare class MediusFilterParam {
+    property?: string;
+    filterValue?: any;
+    filterValueTo?: any;
+    filterMatchType?: MediusFilterMatchType;
+    filterMatchCaseSensitive?: boolean;
+    static discriminator?: string;
+    static attributeTypeMap: Array<ClassAttributeDef>;
+    static getAttributeTypeMap(): ClassAttributeDef[];
+}
+
+/**
+ * Generated API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+declare enum MediusQueryMode {
+    Count = "COUNT",
+    Data = "DATA",
+    All = "ALL"
+}
+
+/**
+ * Generated API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+declare class MediusQueryParam {
+    sortProperty?: Array<string>;
+    sortAsc?: Array<boolean>;
+    itemsOffset?: number;
+    itemsPerPage?: number;
+    filterParams?: Array<MediusFilterParam>;
+    filterAllParam?: string;
+    filterAllProperties?: Array<string>;
+    validateProperties?: Array<string>;
+    selectInTwoSteps?: boolean;
+    sortEnumByOrdinal?: boolean;
+    groupByProperties?: Array<string>;
+    queryMode?: MediusQueryMode;
+    static discriminator?: string;
+    static attributeTypeMap: Array<ClassAttributeDef>;
+    static getAttributeTypeMap(): ClassAttributeDef[];
+}
+
+/**
+ * Generated API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+declare class MediusQueryResult<T> implements IMediusQueryResult<T> {
+    allDataCount?: number;
+    pageData?: Array<T>;
+    static discriminator?: string;
+    static fromArray<T>(pageData: T[], allDataCount?: number): MediusQueryResult<T>;
+    static attributeTypeMap: Array<ClassAttributeDef>;
+    static getAttributeTypeMap(): ClassAttributeDef[];
+}
+interface IMediusQueryResult<T> {
+    allDataCount?: number;
+    pageData?: Array<T>;
+}
+
+/**
+ * A class representing a mapping of query parameters.
+ *
+ * @typeparam Sorts - The type for available sort keys on get all operation.
+ * @typeparam Filters - The type for available sort keys on get all operation.
+ *
+ * @deprecated
+ */
+declare class QueryParamMap<Sorts, Filters extends keyof any> {
+    private readonly _params?;
+    private readonly _sorts;
+    private readonly _filters;
+    protected constructor(_params?: DataListParams<Sorts, Filters> | undefined);
+    static create(): QueryParamMap<string, string>;
+    static forParams<Sorts, Filters extends keyof any>(params?: DataListParams<Sorts, Filters>): QueryParamMap<Sorts, Filters>;
+    withSortMap(sort: Sorts, mapTo: string): this;
+    withFilterMap(filter: Filters, mapTo: string): this;
+    mapSort(sort: string): string;
+    mapFilter(filter: string): string;
+    mapParams(): DataListParams<any, any> | undefined;
+}
+
+declare function toV1QueryParam(): undefined;
+declare function toV1QueryParam<Sorts = string, Filters extends keyof any = string>(params: DataListParams<Sorts, Filters>, map?: QueryParamMap<Sorts, Filters>): MediusQueryParam;
+declare function toV1QueryParam<Sorts = string, Filters extends keyof any = string>(params: DataListParams<Sorts, Filters> | undefined, map?: QueryParamMap<Sorts, Filters>): MediusQueryParam | undefined;
+declare function toV1FilterMatchType(match: string): MediusFilterMatchType;
+/**
+ * Convert a query result from an obsolete API version 1 to a `DataListResult`
+ *
+ * @param {DataListParams} params - The data list parameters for the query
+ * @param {Service} service - The service object used to make the API call
+ * @param {function} apiOperation - The API operation function that returns an `Observable<MediusQueryResult<Item>>`
+ * @param {any} additionalParams - Additional parameters to pass to the API operation function (optional)
+ *
+ * @returns {Observable<DataListResult<Item>>} - An observable that emits a `DataListResult` object
+ *
+ * @deprecated
+ */
+declare function executeV1GetAll<Item, Service>(params: DataListParams, service: Service, apiOperation: (qp: MediusQueryParam, ...additionalParams: any) => Observable<MediusQueryResult<Item>>, additionalParams?: any): Observable<DataListResult<Item>>;
+
+/**
+ * This is an abstract class that provides base functionality for API services.
+ *
+ * @deprecated
+ */
+declare abstract class ACommonsBaseV1ApiService {
+    protected readonly objectSerializer: ObjectSerializer;
+    protected readonly http: HttpClient;
+    protected readonly obsoleteConfig: boolean;
+    protected abstract getBasePath(): string;
+    protected abstract getServiceBasePath(): string | null;
+    protected getUrl(...pathSegments: Array<string>): string;
+    protected serializeQueryParam(queryParam: MediusQueryParam, type?: string): any;
+    protected deserializeQueryResult<QR>(item: any, qrType: ClassType<QR>): QR;
+    protected deserializeClass<C>(item: any, type: ClassType<C>): C;
+    protected deserializeClassArray<C>(item: any, type: ClassType<C>): Array<C>;
+    protected serializeClass<C>(item: C, type: ClassType<C>): any;
+    protected serializeClassArray<C>(item: Array<C>, type: ClassType<C>): any;
+}
+/**
+ * Represents an abstract base class for the ACommonsV1ApiService.
+ *
+ * @typeparam T The main type of data to be handled by the service.
+ *
+ * @deprecated
+ */
+declare abstract class ACommonsV1ApiService<T> extends ACommonsBaseV1ApiService {
+    protected type: ClassType<T>;
+    protected constructor(type: ClassType<T>);
+    protected deserialize(item: any): T;
+    protected serialize(item: T): any;
+}
+
+/**
+ * A service interface for getting paginated data results using POST method.
+ *
+ * @typeparam QRT The type of the query result in get all operation.
+ *
+ * @deprecated
+ */
+interface ICommonsGetAllV1ApiService<QRT extends MediusQueryResult<any>> {
+    getAllPost(queryParamBody?: MediusQueryParam, params?: HttpParams, locale?: string): Observable<QRT>;
+}
+/**
+ * An abstract class representing a service for retrieving all obsolete entities.
+ *
+ * @typeparam T The main type of data to be handled by the service.
+ * @typeparam QRT The type of the query result in get all operation.
+ *
+ * @deprecated
+ */
+declare abstract class ACommonsGetAllV1ApiService<T, QRT extends MediusQueryResult<any>> extends ACommonsV1ApiService<T> implements ICommonsGetAllV1ApiService<QRT> {
+    protected queryResultType: ClassType<QRT>;
+    protected constructor(type: ClassType<T>, queryResultType: ClassType<QRT>);
+    getAllPost(queryParamBody?: MediusQueryParam, params?: HttpParams, locale?: string): Observable<QRT>;
+    protected getGetAllPostPath(): string;
+}
+
+/**
+ * A service interface for CRUD operation on a resource.
+ *
+ * @typeparam T The main type of data to be handled by the service.
+ *
+ * @deprecated
+ */
+interface ICommonsCrudV1ApiService<T> {
+    createPost?(item: T, params?: HttpParams): Observable<T>;
+    getByIdGet?(id: IdType, params?: HttpParams, locale?: string): Observable<T>;
+    updatePut?(id: IdType, item: T, params?: HttpParams): Observable<T>;
+    removeDelete?(id: IdType, item?: T, params?: HttpParams): Observable<T | null>;
+}
+/**
+ * Abstract class for creating CRUD API service implementation.
+ *
+ * @typeparam T The type of the entity.
+ * @typeparam QRT The type of the query result.
+ *
+ * @deprecated
+ */
+declare abstract class ACommonsCrudV1ApiService<T, QRT extends MediusQueryResult<any>> extends ACommonsGetAllV1ApiService<T, QRT> implements ICommonsCrudV1ApiService<T> {
+    protected constructor(type: ClassType<T>, queryResultType: ClassType<QRT>);
+    createPost(item: T, params?: HttpParams): Observable<T>;
+    getByIdGet(id: IdType, params?: HttpParams, locale?: string): Observable<T>;
+    updatePut(id: IdType, item: T, params?: HttpParams): Observable<T>;
+    removeDelete(id: IdType, item?: T, params?: HttpParams): Observable<T | null>;
+    protected getCreatePostPath(item: T): string;
+    protected getUpdatePutPath(id: IdType, item: T): string;
+    protected getGetByIdGetPath(id: IdType): string;
+    protected getRemoveDeletePath(id: IdType, item?: T): string;
+}
+
+/**
+ * A data provider for a CRUD table view that uses an obsolete version 1 API service.
+ *
+ * @typeparam Model - The type of the data model.
+ * @typeparam Service - The type of the API service.
+ * @typeparam Sorts - The type for available sort keys on get all operation.
+ * @typeparam Filters - The type for available sort keys on get all operation.
+ *
+ * @deprecated
+ */
+declare class TableviewCrudV1DataProviderInst<Model, Service extends ICommonsCrudV1ApiService<Model> & ICommonsGetAllV1ApiService<MediusQueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model> extends TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>> {
+    protected constructor(serviceType: Type<Service>, idPropertyName?: string, useGetAllForFetch?: boolean);
+}
+declare class TableviewCrudV1DataProvider extends TableviewCrudV1DataProviderInst<any, any> {
+    /**
+     * @deprecated
+     */
+    static create<Model, Service extends ICommonsCrudV1ApiService<Model> & ICommonsGetAllV1ApiService<MediusQueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: Type<Service>, idProperty?: keyof Model, useGetAllForFetch?: boolean): TableviewCrudV1DataProviderInst<Model, Service, Sorts, Filters>;
+    /**
+     * @deprecated
+     */
+    static createUnsafe<Model, Service extends ICommonsCrudV1ApiService<Model> & ICommonsGetAllV1ApiService<MediusQueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: Type<Service>, idProperty?: string, useGetAllForFetch?: boolean): TableviewCrudV1DataProviderInst<Model, Service, Sorts, Filters>;
+}
+
+/**
+ * Creates a tableview with the given class, service based on data API v1 (obsolete) and optional class/model configuration.
+ *
+ * @param {ClassType<Model>} type - The class representing the model.
+ * @param {ServiceClassType<Service>} service - The class type of the service implementing `IMngCrudObsoleteV1ApiService` and `IMngGetAllObsoleteV1ApiService`.
+ * @param {{ idProperty?: keyof Model; titleProperty?: keyof Model; i18nBaseKey?: ClassType<any> | string; }} [modelConfig] - Additional optional model configuration.
+ * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
+ *
+ * @returns {Tableview} - The built table view.
+ *
+ * @deprecated
+ */
+declare function tableviewCrudV1<Model, Service extends ICommonsCrudV1ApiService<Model> & ICommonsGetAllV1ApiService<MediusQueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, service: ServiceClassType<Service>, modelConfig?: {
+    idProperty?: keyof Model;
+    titleProperty?: keyof Model;
+    i18nBaseKey?: ClassType<any> | string;
+}, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, Model>, TableviewCrudV1DataProviderInst<Model, Service, Sorts, Filters>, Sorts, Filters>) => void): _mediusinc_mng_commons_tableview_api.TableviewInput<Model, Service, Sorts, Filters, Model, Model, Model, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, Model>, TableviewCrudV1DataProviderInst<Model, Service, Sorts, Filters>>;
+
+declare class MediusQueryParamBuilder {
+    private queryParam;
+    private constructor();
+    /**
+     * Creates a new instance of `MediusQueryParamBuilder` with the specified `itemsPerPage` and `itemsOffset` values.
+     *
+     * @param {number} [itemsPerPage=50] - The number of items per page.
+     * @param {number} [itemsOffset=0] - The offset value for the items.
+     *
+     * @returns {MediusQueryParamBuilder} A new instance of `MediusQueryParamBuilder`.
+     *
+     * @deprecated
+     */
+    static create(itemsPerPage?: number, itemsOffset?: number): MediusQueryParamBuilder;
+    /**
+     * Creates a new instance of MediusQueryParamBuilder based on an existing MediusQueryParam object.
+     *
+     * @param {MediusQueryParam} queryParam - The existing MediusQueryParam object to create from.
+     * @param {number} [itemsPerPage] - The number of items per page for the new instance. If not provided, default value is used.
+     * @param {number} [itemsOffset] - The offset for the new instance. If not provided, default value is used.
+     *
+     * @returns {MediusQueryParamBuilder} - A new instance of MediusQueryParamBuilder.
+     *
+     * @deprecated
+     */
+    static createFromExisting(queryParam: MediusQueryParam, itemsPerPage?: number, itemsOffset?: number): MediusQueryParamBuilder;
+    withItemsPerPage(itemsPerPage: number): MediusQueryParamBuilder;
+    withItemsOffset(itemsOffset: number): MediusQueryParamBuilder;
+    withQueryMode(queryMode: MediusQueryMode): MediusQueryParamBuilder;
+    withSort(property: string, asc?: boolean): MediusQueryParamBuilder;
+    withFilter(property: string, value: any, valueTo?: any, matchType?: MediusFilterMatchType, matchCaseSensitive?: boolean): MediusQueryParamBuilder;
+    build(): MediusQueryParam;
+}
+
+/**
+ * Some fake token to incept needed types for query params and object serializer setup
+ */
+declare const COMMONS_DATA_API_CLASS_OBSOLETE_CONFIG_IT: InjectionToken<boolean>;
+
+/**
+ * Prepares providers for usage of the Obsolete Data API functionalities.
+ *
+ * @returns {CommonsFeature} The `CommonsFeature` object with the Data API Obsolete configuration.
+ *
+ * @deprecated.
+ */
+declare function withDataApiV1(): CommonsFeature;
+declare function provideDataApiV1Child(): Provider;
+
+export { ACommonsBaseV1ApiService, ACommonsCrudV1ApiService, ACommonsGetAllV1ApiService, ACommonsV1ApiService, COMMONS_DATA_API_CLASS_OBSOLETE_CONFIG_IT, MediusFilterMatchType, MediusFilterParam, MediusQueryMode, MediusQueryParam, MediusQueryParamBuilder, MediusQueryResult, QueryParamMap, TableviewCrudV1DataProvider, TableviewCrudV1DataProviderInst, executeV1GetAll, provideDataApiV1Child, tableviewCrudV1, toV1FilterMatchType, toV1QueryParam, withDataApiV1 };
+export type { ICommonsCrudV1ApiService, ICommonsGetAllV1ApiService, IMediusQueryResult };

package/version-info.json

@@ -1,11 +1,11 @@
 {
     "name": "@mediusinc/mng-commons-data-api-class",
-    "version": "6.2.0-rc.0",
+    "version": "7.0.0-rc.0",
     "tag": "v6.2.0-rc.0",
-    "distance": 0,
-    "hash": "3b7adfe2",
+    "distance": 6,
+    "hash": "ce245f4b",
     "dirty": true,
-    "semver": "6.2.0-rc.0+0.g3b7adfe2.dirty",
+    "semver": "6.2.0-rc.0+6.gce245f4b.dirty",
     "buildTimestamp": null,
-    "raw": "v6.2.0-rc.0-3b7adfe2-dirty"
+    "raw": "v6.2.0-rc.0-6-ce245f4b-dirty"
 }

package/lib/models/query-result.model.d.ts

@@ -1,13 +0,0 @@
-import { ClassAttributeDef } from '@mediusinc/mng-commons/core';
-export declare class QueryResult<Item> implements IMediusQueryResultV2<Item> {
-    totalCount?: number;
-    data?: Array<Item>;
-    static discriminator?: string;
-    static fromArray<Item>(pageData: Item[], allDataCount?: number): QueryResult<Item>;
-    static attributeTypeMap: Array<ClassAttributeDef>;
-    static getAttributeTypeMap(): ClassAttributeDef[];
-}
-export interface IMediusQueryResultV2<Item> {
-    totalCount?: number;
-    data?: Array<Item>;
-}

package/lib/serder/object-serializer.d.ts

@@ -1,26 +0,0 @@
-import { ClassType } from '@mediusinc/mng-commons/core';
-export declare class ObjectSerializer {
-    private static _instance;
-    private readonly _logCategory;
-    private readonly _primitives;
-    private dateTimeInUtc;
-    private dateTimeWithTimezone;
-    private dateTimeWithMillis;
-    get primitives(): string[];
-    /**
-     * Only use one instance of object (out of Angular context)
-     */
-    static get(): ObjectSerializer;
-    configure(config: {
-        dateTimeInUtc?: boolean;
-        dateTimeWithTimezone?: boolean;
-        dateTimeWithMillis?: boolean;
-    }): void;
-    findCorrectType(data: any, expectedTypeName: string): string;
-    serializeClass<T>(data: T, type: ClassType<T>): any;
-    serializeClassArray<T>(data: Array<T>, type: ClassType<T>): any;
-    serialize(data: any, typeName?: string, subtype?: string): any;
-    deserializeClass<T>(data: any, type: ClassType<T>): T;
-    deserializeClassArray<T>(data: any, type: ClassType<T>): Array<T>;
-    deserialize(data: any, type?: string): any;
-}

package/lib/services/api.abstract.service.d.ts

@@ -1,21 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { ClassType } from '@mediusinc/mng-commons/core';
-import { ObjectSerializer } from '../serder/object-serializer';
-export declare abstract class ACommonsBaseApiService {
-    protected readonly objectSerializer: ObjectSerializer;
-    protected readonly http: HttpClient;
-    protected abstract getBasePath(): string;
-    protected abstract getServiceBasePath(): string | null;
-    protected getUrl(...pathSegments: Array<string>): string;
-    protected deserializeQueryResult<QR>(item: any, qrType: ClassType<QR>): QR;
-    protected deserializeClass<C>(item: any, type: ClassType<C>): C;
-    protected deserializeClassArray<C>(item: any, type: ClassType<C>): Array<C>;
-    protected serializeClass<C>(item: C, type: ClassType<C>): any;
-    protected serializeClassArray<C>(item: Array<C>, type: ClassType<C>): any;
-}
-export declare abstract class ACommonsApiService<T> extends ACommonsBaseApiService {
-    protected type: ClassType<T>;
-    protected constructor(type: ClassType<T>);
-    protected deserialize(item: any): T;
-    protected serialize(item: T): any;
-}

package/lib/services/crud-api.abstract.service.d.ts

@@ -1,25 +0,0 @@
-import { HttpParams } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { ClassType, IdType } from '@mediusinc/mng-commons/core';
-import { QueryResult } from '../models/query-result.model';
-import { ACommonsGetAllApiService } from './get-all-api.abstract.service';
-export interface ICommonsCrudApiService<FetchType, RequestType> {
-    createPost?(item: RequestType, params?: HttpParams): Observable<FetchType>;
-    getByIdGet?(id: IdType, params?: HttpParams, locale?: string): Observable<FetchType>;
-    updatePut?(id: IdType, item: RequestType, params?: HttpParams): Observable<FetchType>;
-    removeDelete?(id: IdType, item?: FetchType, params?: HttpParams): Observable<FetchType | undefined>;
-}
-export declare abstract class ACommonsCrudApiService<FetchType, RequestType, QueryResultType extends QueryResult<any>> extends ACommonsGetAllApiService<FetchType, QueryResultType> implements ICommonsCrudApiService<FetchType, RequestType> {
-    protected requestType: ClassType<RequestType>;
-    protected constructor(fetchType: ClassType<FetchType>, requestType: ClassType<RequestType>, queryResultType: ClassType<QueryResultType>);
-    createPost(item: RequestType, params?: HttpParams): Observable<FetchType>;
-    getByIdGet(id: IdType, params?: HttpParams, locale?: string): Observable<FetchType>;
-    updatePut(id: IdType, item: RequestType, params?: HttpParams): Observable<FetchType>;
-    removeDelete(id: IdType, item?: FetchType, params?: HttpParams): Observable<FetchType | undefined>;
-    protected getCreatePostPath(item: RequestType): string;
-    protected getUpdatePutPath(id: IdType, item: RequestType): string;
-    protected getGetByIdGetPath(id: IdType): string;
-    protected getRemoveDeletePath(id: IdType, item?: FetchType): string;
-    protected deserializeRequest(item: any): RequestType;
-    protected serializeRequest(item: RequestType): any;
-}

package/lib/services/get-all-api.abstract.service.d.ts

@@ -1,14 +0,0 @@
-import { HttpParams } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { ClassType, DataListParams } from '@mediusinc/mng-commons/core';
-import { QueryResult } from '../models/query-result.model';
-import { ACommonsApiService } from './api.abstract.service';
-export interface ICommonsGetAllApiService<QRT extends QueryResult<any>> {
-    getAllGet(requestParams?: DataListParams<any, any>, params?: HttpParams, locale?: string): Observable<QRT>;
-}
-export declare abstract class ACommonsGetAllApiService<FetchType, QueryResultType extends QueryResult<any>> extends ACommonsApiService<FetchType> implements ICommonsGetAllApiService<QueryResultType> {
-    protected queryResultType: ClassType<QueryResultType>;
-    protected constructor(fetchType: ClassType<FetchType>, queryResultType: ClassType<QueryResultType>);
-    getAllGet(requestParams?: DataListParams, params?: HttpParams, locale?: string): Observable<QueryResultType>;
-    protected getGetAllGetPath(): string;
-}

package/tableview/tableview-crud-create.d.ts

@@ -1,24 +0,0 @@
-import { ICommonsCrudApiService, ICommonsGetAllApiService, QueryResult } from '@mediusinc/mng-commons-data-api-class';
-import { ClassType, ServiceClassType } from '@mediusinc/mng-commons/core';
-import { ModelDescriptor, TypeDescriptor } from '@mediusinc/mng-commons/model';
-import { TableviewDescriptorInst, TableviewInputBuilder } from '@mediusinc/mng-commons/tableview/api';
-import { TableviewCrudDataProviderInst } from './tableview-crud.data-provider';
-/**
- * Creates a tableview with the given class, request class, service based on data API v2, sort, filters and optional class/model configuration.
- * Sorts and filters are expected to be keys of class.
- *
- * @param {ClassType<Model>} type - The class representing the model.
- * @param {ClassType<RequestModel>} requestType - The class representing the model for create and update operations.
- * @param {ServiceClassType<Service>} service - The class type of the service implementing `IMngCrudApiService` and `IMngGetAllApiService`.
- * @param {{ idProperty?: keyof Model; titleProperty?: keyof Model; i18nBaseKey?: ClassType<any> | string; }} [modelConfig] - Additional optional model configuration.
- * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
- *
- * @returns A tableview instance with descriptor, data provider and actions.
- */
-export declare function tableviewCrud<Model, RequestModel, Service extends ICommonsCrudApiService<Model, RequestModel> & ICommonsGetAllApiService<QueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, requestType: ClassType<RequestModel>, service: ServiceClassType<Service>, modelConfig?: {
-    idProperty?: keyof Model;
-    titleProperty?: keyof Model;
-    i18nBaseKey?: string;
-    sortsType?: TypeDescriptor<Sorts> | ModelDescriptor<Sorts>;
-    filtersType?: TypeDescriptor<Filters> | ModelDescriptor<Filters>;
-}, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters>, TableviewCrudDataProviderInst<Model, RequestModel, Service, Sorts, Filters>, Sorts, Filters>) => void): import("@mediusinc/mng-commons/tableview/api").TableviewInput<Model, Service, Sorts, Filters, Model, Model, Model, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, import("@mediusinc/mng-commons/tableview/api").TableviewDescriptorFieldsManageMultiType<Model, Model, Model>>, TableviewCrudDataProviderInst<Model, RequestModel, Service, Sorts, Filters>>;

package/tableview/tableview-crud.data-provider.d.ts

@@ -1,16 +0,0 @@
-import { Type } from '@angular/core';
-import { ICommonsCrudApiService, ICommonsGetAllApiService, QueryResult } from '@mediusinc/mng-commons-data-api-class';
-import { ClassType, ServiceClassType } from '@mediusinc/mng-commons/core';
-import { TableviewDataProviderInst } from '@mediusinc/mng-commons/tableview/api';
-export type ToRequestMapFnType<Model, RequestModel> = (item?: Model) => RequestModel;
-export declare class TableviewCrudDataProviderInst<Model, RequestModel, Service extends ICommonsCrudApiService<Model, RequestModel> & ICommonsGetAllApiService<QueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model> extends TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>> {
-    protected requestType: ClassType<RequestModel>;
-    private _toRequestMap;
-    protected constructor(type: ClassType<Model>, requestType: ClassType<RequestModel>, serviceType: Type<Service>, idPropertyName?: string, useGetAllForFetch?: boolean);
-    get toRequestMap(): ToRequestMapFnType<Model, RequestModel>;
-    withToRequestMap(fn: ToRequestMapFnType<Model, RequestModel>): this;
-}
-export declare class TableviewCrudDataProvider extends TableviewCrudDataProviderInst<any, any, any> {
-    static create<Model, RequestModel, Service extends ICommonsCrudApiService<Model, RequestModel> & ICommonsGetAllApiService<QueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, requestType: ClassType<RequestModel>, serviceType: Type<Service>, idProperty?: keyof Model, useGetAllForFetch?: boolean): TableviewCrudDataProviderInst<Model, RequestModel, Service, Sorts, Filters>;
-    static createUnsafe<Model, RequestModel, Service extends ICommonsCrudApiService<Model, RequestModel> & ICommonsGetAllApiService<QueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, requestType: ClassType<RequestModel>, serviceType: Type<Service>, idProperty?: string, useGetAllForFetch?: boolean): TableviewCrudDataProviderInst<Model, RequestModel, Service, Sorts, Filters>;
-}

package/v1/helpers/query-param-convert.d.ts

@@ -1,23 +0,0 @@
-import { Observable } from 'rxjs';
-import { DataListParams, DataListResult } from '@mediusinc/mng-commons/core';
-import { MediusFilterMatchType } from '../models/filter-match-type.model';
-import { MediusQueryParam } from '../models/query-param.model';
-import { MediusQueryResult } from '../models/query-result.model';
-import { QueryParamMap } from '../utils/query-param-map.util';
-export declare function toV1QueryParam(): undefined;
-export declare function toV1QueryParam<Sorts = string, Filters extends keyof any = string>(params: DataListParams<Sorts, Filters>, map?: QueryParamMap<Sorts, Filters>): MediusQueryParam;
-export declare function toV1QueryParam<Sorts = string, Filters extends keyof any = string>(params: DataListParams<Sorts, Filters> | undefined, map?: QueryParamMap<Sorts, Filters>): MediusQueryParam | undefined;
-export declare function toV1FilterMatchType(match: string): MediusFilterMatchType;
-/**
- * Convert a query result from an obsolete API version 1 to a `DataListResult`
- *
- * @param {DataListParams} params - The data list parameters for the query
- * @param {Service} service - The service object used to make the API call
- * @param {function} apiOperation - The API operation function that returns an `Observable<MediusQueryResult<Item>>`
- * @param {any} additionalParams - Additional parameters to pass to the API operation function (optional)
- *
- * @returns {Observable<DataListResult<Item>>} - An observable that emits a `DataListResult` object
- *
- * @deprecated
- */
-export declare function executeV1GetAll<Item, Service>(params: DataListParams, service: Service, apiOperation: (qp: MediusQueryParam, ...additionalParams: any) => Observable<MediusQueryResult<Item>>, additionalParams?: any): Observable<DataListResult<Item>>;

package/v1/helpers/tableview-crud-create.d.ts

@@ -1,23 +0,0 @@
-import { ClassType, ServiceClassType } from '@mediusinc/mng-commons/core';
-import { TableviewDescriptorInst, TableviewInputBuilder } from '@mediusinc/mng-commons/tableview/api';
-import { MediusQueryResult } from '../models/query-result.model';
-import { ICommonsCrudV1ApiService } from '../services/crud-api.abstract.service';
-import { ICommonsGetAllV1ApiService } from '../services/get-all-api.abstract.service';
-import { TableviewCrudV1DataProviderInst } from '../tableview/tableview-crud.data-provider';
-/**
- * Creates a tableview with the given class, service based on data API v1 (obsolete) and optional class/model configuration.
- *
- * @param {ClassType<Model>} type - The class representing the model.
- * @param {ServiceClassType<Service>} service - The class type of the service implementing `IMngCrudObsoleteV1ApiService` and `IMngGetAllObsoleteV1ApiService`.
- * @param {{ idProperty?: keyof Model; titleProperty?: keyof Model; i18nBaseKey?: ClassType<any> | string; }} [modelConfig] - Additional optional model configuration.
- * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
- *
- * @returns {Tableview} - The built table view.
- *
- * @deprecated
- */
-export declare function tableviewCrudV1<Model, Service extends ICommonsCrudV1ApiService<Model> & ICommonsGetAllV1ApiService<MediusQueryResult<Model>>, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, service: ServiceClassType<Service>, modelConfig?: {
-    idProperty?: keyof Model;
-    titleProperty?: keyof Model;
-    i18nBaseKey?: ClassType<any> | string;
-}, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, Model>, TableviewCrudV1DataProviderInst<Model, Service, Sorts, Filters>, Sorts, Filters>) => void): import("@mediusinc/mng-commons/tableview/api").TableviewInput<Model, Service, Sorts, Filters, Model, Model, Model, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, Model>, TableviewCrudV1DataProviderInst<Model, Service, Sorts, Filters>>;

package/v1/models/builders/query-param.builder.d.ts

@@ -1,36 +0,0 @@
-import { MediusFilterMatchType } from '../filter-match-type.model';
-import { MediusQueryMode } from '../query-mode.model';
-import { MediusQueryParam } from '../query-param.model';
-export declare class MediusQueryParamBuilder {
-    private queryParam;
-    private constructor();
-    /**
-     * Creates a new instance of `MediusQueryParamBuilder` with the specified `itemsPerPage` and `itemsOffset` values.
-     *
-     * @param {number} [itemsPerPage=50] - The number of items per page.
-     * @param {number} [itemsOffset=0] - The offset value for the items.
-     *
-     * @returns {MediusQueryParamBuilder} A new instance of `MediusQueryParamBuilder`.
-     *
-     * @deprecated
-     */
-    static create(itemsPerPage?: number, itemsOffset?: number): MediusQueryParamBuilder;
-    /**
-     * Creates a new instance of MediusQueryParamBuilder based on an existing MediusQueryParam object.
-     *
-     * @param {MediusQueryParam} queryParam - The existing MediusQueryParam object to create from.
-     * @param {number} [itemsPerPage] - The number of items per page for the new instance. If not provided, default value is used.
-     * @param {number} [itemsOffset] - The offset for the new instance. If not provided, default value is used.
-     *
-     * @returns {MediusQueryParamBuilder} - A new instance of MediusQueryParamBuilder.
-     *
-     * @deprecated
-     */
-    static createFromExisting(queryParam: MediusQueryParam, itemsPerPage?: number, itemsOffset?: number): MediusQueryParamBuilder;
-    withItemsPerPage(itemsPerPage: number): MediusQueryParamBuilder;
-    withItemsOffset(itemsOffset: number): MediusQueryParamBuilder;
-    withQueryMode(queryMode: MediusQueryMode): MediusQueryParamBuilder;
-    withSort(property: string, asc?: boolean): MediusQueryParamBuilder;
-    withFilter(property: string, value: any, valueTo?: any, matchType?: MediusFilterMatchType, matchCaseSensitive?: boolean): MediusQueryParamBuilder;
-    build(): MediusQueryParam;
-}

package/v1/models/filter-match-type.model.d.ts

@@ -1,25 +0,0 @@
-/**
- * Generated API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export declare enum MediusFilterMatchType {
-    Equals = "EQUALS",
-    NotEquals = "NOT_EQUALS",
-    FromTo = "FROM_TO",
-    Contains = "CONTAINS",
-    StartsWith = "STARTS_WITH",
-    EndsWith = "ENDS_WITH",
-    In = "IN",
-    NotIn = "NOT_IN",
-    SmallerThan = "SMALLER_THAN",
-    GreaterThan = "GREATER_THAN",
-    Exists = "EXISTS",
-    DoesNotExist = "DOES_NOT_EXIST"
-}