ng-qubee 2.1.0 → 3.1.0

package/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="ng-qubee" />
-export * from './public-api';

package/lib/enums/sort.enum.d.ts

@@ -1,4 +0,0 @@
-export declare enum SortEnum {
-    ASC = "asc",
-    DESC = "desc"
-}

package/lib/errors/invalid-limit.error.d.ts

@@ -1,3 +0,0 @@
-export declare class InvalidLimitError extends Error {
-    constructor(limit: number);
-}

package/lib/errors/invalid-model-name.error.d.ts

@@ -1,3 +0,0 @@
-export declare class InvalidModelNameError extends Error {
-    constructor(model: string | null | undefined);
-}

package/lib/errors/invalid-page-number.error.d.ts

@@ -1,3 +0,0 @@
-export declare class InvalidPageNumberError extends Error {
-    constructor(page: number);
-}

package/lib/errors/key-not-found.error.d.ts

@@ -1,3 +0,0 @@
-export declare class KeyNotFoundError extends Error {
-    constructor(key: string);
-}

package/lib/errors/unselectable-model.error.d.ts

@@ -1,3 +0,0 @@
-export declare class UnselectableModelError extends Error {
-    constructor(model: string);
-}

package/lib/interfaces/config.interface.d.ts

@@ -1,6 +0,0 @@
-import { IPaginationConfig } from "./pagination-config.interface";
-import { IQueryBuilderConfig } from "./query-builder-config.interface";
-export interface IConfig {
-    request?: IQueryBuilderConfig;
-    response?: IPaginationConfig;
-}

package/lib/interfaces/fields.interface.d.ts

@@ -1,3 +0,0 @@
-export interface IFields {
-    [model: string]: string[];
-}

package/lib/interfaces/filters.interface.d.ts

@@ -1,3 +0,0 @@
-export interface IFilters {
-    [k: string]: (string | number | boolean)[];
-}

package/lib/interfaces/nest-state.interface.d.ts

@@ -1,4 +0,0 @@
-import { IQueryBuilderState } from "./query-builder-state.interface";
-export interface INestState {
-    nest: IQueryBuilderState;
-}

package/lib/interfaces/normalized.interface.d.ts

@@ -1,3 +0,0 @@
-export interface INormalized {
-    [k: number | string]: number[] | string[];
-}

package/lib/interfaces/page.interface.d.ts

@@ -1,2 +0,0 @@
-export interface IPage {
-}

package/lib/interfaces/paginated-object.interface.d.ts

@@ -1,3 +0,0 @@
-export interface IPaginatedObject {
-    [k: string]: any;
-}

package/lib/interfaces/pagination-config.interface.d.ts

@@ -1,14 +0,0 @@
-export interface IPaginationConfig {
-    currentPage?: string;
-    data?: string;
-    firstPageUrl?: string;
-    from?: string;
-    lastPage?: string;
-    lastPageUrl?: string;
-    nextPageUrl?: string;
-    path?: string;
-    perPage?: string;
-    prevPageUrl?: string;
-    to?: string;
-    total?: string;
-}

package/lib/interfaces/query-builder-config.interface.d.ts

@@ -1,9 +0,0 @@
-export interface IQueryBuilderConfig {
-    appends?: string;
-    fields?: string;
-    filters?: string;
-    includes?: string;
-    limit?: string;
-    page?: string;
-    sort?: string;
-}

package/lib/interfaces/query-builder-state.interface.d.ts

@@ -1,13 +0,0 @@
-import { IFields } from "./fields.interface";
-import { IFilters } from "./filters.interface";
-import { ISort } from "./sort.interface";
-export interface IQueryBuilderState {
-    baseUrl: string;
-    fields: IFields;
-    filters: IFilters;
-    includes: string[];
-    limit: number;
-    model: string;
-    page: number;
-    sorts: ISort[];
-}

package/lib/interfaces/sort.interface.d.ts

@@ -1,5 +0,0 @@
-import { SortEnum } from "../enums/sort.enum";
-export interface ISort {
-    field: string;
-    order: SortEnum;
-}

package/lib/models/paginated-collection.d.ts

@@ -1,30 +0,0 @@
-import { INormalized } from "../interfaces/normalized.interface";
-import { IPaginatedObject } from "../interfaces/paginated-object.interface";
-export declare class PaginatedCollection<T extends IPaginatedObject> {
-    data: T[];
-    readonly page: number;
-    readonly from?: number | undefined;
-    readonly to?: number | undefined;
-    readonly total?: number | undefined;
-    readonly perPage?: number | undefined;
-    readonly prevPageUrl?: string | undefined;
-    readonly nextPageUrl?: string | undefined;
-    readonly lastPage?: number | undefined;
-    readonly firstPageUrl?: string | undefined;
-    readonly lastPageUrl?: string | undefined;
-    constructor(data: T[], page: number, from?: number | undefined, to?: number | undefined, total?: number | undefined, perPage?: number | undefined, prevPageUrl?: string | undefined, nextPageUrl?: string | undefined, lastPage?: number | undefined, firstPageUrl?: string | undefined, lastPageUrl?: string | undefined);
-    /**
-     * Normalize the collection to a paginated list of ids for state-managed applications.
-     *
-     * This method returns a single key object, where the key is the page number and the associated value is
-     * an array of ids. Each id is fetched by the collection items, looking up for the "id" key. If an id is supplied
-     * to this method, it will be used instead of the default "id" key.
-     *
-     * Please note that in case the key doesn't exist in the collection's item, a KeyNotFoundError is thrown
-     *
-     * @param k A key to use instead of the default "id": this will be searched inside each element of the collection
-     * @returns []
-     * @throws KeyNotFoundItem
-     */
-    normalize(id?: string): INormalized;
-}

package/lib/models/query-builder-options.d.ts

@@ -1,11 +0,0 @@
-import { IQueryBuilderConfig } from '../interfaces/query-builder-config.interface';
-export declare class QueryBuilderOptions {
-    readonly appends: string;
-    readonly fields: string;
-    readonly filters: string;
-    readonly includes: string;
-    readonly limit: string;
-    readonly page: string;
-    readonly sort: string;
-    constructor(options: IQueryBuilderConfig);
-}

package/lib/models/response-options.d.ts

@@ -1,16 +0,0 @@
-import { IPaginationConfig } from '../interfaces/pagination-config.interface';
-export declare class ResponseOptions {
-    readonly currentPage: string;
-    readonly data: string;
-    readonly firstPageUrl: string;
-    readonly from: string;
-    readonly lastPage: string;
-    readonly lastPageUrl: string;
-    readonly nextPageUrl: string;
-    readonly path: string;
-    readonly perPage: string;
-    readonly prevPageUrl: string;
-    readonly to: string;
-    readonly total: string;
-    constructor(options: IPaginationConfig);
-}

package/lib/ng-qubee.module.d.ts

@@ -1,9 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { IConfig } from './interfaces/config.interface';
-import * as i0 from "@angular/core";
-export declare class NgQubeeModule {
-    static forRoot(config?: IConfig): ModuleWithProviders<NgQubeeModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgQubeeModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgQubeeModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgQubeeModule>;
-}

package/lib/provide-ngqubee.d.ts

@@ -1,21 +0,0 @@
-import { EnvironmentProviders } from "@angular/core";
-import { IConfig } from "./interfaces/config.interface";
-/**
- * Sets up providers necessary to enable `NgQubee` functionality for the application.
- *
- * @usageNotes
- *
- * Basic example of how you can add NgQubee to your application:
- * ```
- * const config = {};
- *
- * bootstrapApplication(AppComponent, {
- *   providers: [provideNgQubee(config)]
- * });
- * ```
- *
- * @publicApi
- * @param config Configuration object compliant to the IConfig interface
- * @returns A set of providers to setup NgQubee
- */
-export declare function provideNgQubee(config?: IConfig): EnvironmentProviders;

package/lib/services/nest.service.d.ts

@@ -1,182 +0,0 @@
-import { Signal } from '@angular/core';
-import { IQueryBuilderState } from '../interfaces/query-builder-state.interface';
-import { IFields } from '../interfaces/fields.interface';
-import { IFilters } from '../interfaces/filters.interface';
-import { ISort } from '../interfaces/sort.interface';
-import * as i0 from "@angular/core";
-export declare class NestService {
-    /**
-     * Private writable signal that holds the Query Builder state
-     *
-     * @type {IQueryBuilderState}
-     */
-    private _nest;
-    /**
-     * A computed signal that makes readonly the writable signal _nest
-     *
-     * @type {Signal<IQueryBuilderState>}
-     */
-    nest: Signal<IQueryBuilderState>;
-    constructor();
-    /**
-     * Set the base URL for the API
-     *
-     * @param {string} baseUrl - The base URL to prepend to generated URIs
-     * @example
-     * service.baseUrl = 'https://api.example.com';
-     */
-    set baseUrl(baseUrl: string);
-    /**
-     * Set the limit for paginated results
-     * Must be a positive integer greater than 0
-     *
-     * @param {number} limit - The number of items per page
-     * @throws {InvalidLimitError} If limit is not a positive integer
-     * @example
-     * service.limit = 25;
-     */
-    set limit(limit: number);
-    /**
-     * Set the model name for the query
-     * Must be a non-empty string
-     *
-     * @param {string} model - The model/resource name (e.g., 'users', 'posts')
-     * @throws {InvalidModelNameError} If model is not a non-empty string
-     * @example
-     * service.model = 'users';
-     */
-    set model(model: string);
-    /**
-     * Set the page number for pagination
-     * Must be a positive integer greater than 0
-     *
-     * @param {number} page - The page number to fetch
-     * @throws {InvalidPageNumberError} If page is not a positive integer
-     * @example
-     * service.page = 2;
-     */
-    set page(page: number);
-    private _clone;
-    /**
-     * Validates that the model name is a non-empty string
-     *
-     * @param {string} model - The model name to validate
-     * @throws {InvalidModelNameError} If model is not a non-empty string
-     * @private
-     */
-    private _validateModelName;
-    /**
-     * Validates that the page number is a positive integer
-     *
-     * @param {number} page - The page number to validate
-     * @throws {InvalidPageNumberError} If page is not a positive integer
-     * @private
-     */
-    private _validatePageNumber;
-    /**
-     * Validates that the limit is a positive integer
-     *
-     * @param {number} limit - The limit value to validate
-     * @throws {InvalidLimitError} If limit is not a positive integer
-     * @private
-     */
-    private _validateLimit;
-    /**
-     * Add selectable fields for the given model to the request
-     * Automatically prevents duplicate fields for each model
-     *
-     * @param {IFields} fields - Object mapping model names to arrays of field names
-     * @return {void}
-     * @example
-     * service.addFields({ users: ['id', 'email', 'username'] });
-     * service.addFields({ posts: ['title', 'content'] });
-     */
-    addFields(fields: IFields): void;
-    /**
-     * Add filters to the request
-     * Automatically prevents duplicate filter values for each filter key
-     *
-     * @param {IFilters} filters - Object mapping filter keys to arrays of values
-     * @return {void}
-     * @example
-     * service.addFilters({ id: [1, 2, 3] });
-     * service.addFilters({ status: ['active', 'pending'] });
-     */
-    addFilters(filters: IFilters): void;
-    /**
-     * Add resources to include with the request
-     * Automatically prevents duplicate includes
-     *
-     * @param {string[]} includes - Array of model names to include in the response
-     * @return {void}
-     * @example
-     * service.addIncludes(['profile', 'posts']);
-     * service.addIncludes(['comments']);
-     */
-    addIncludes(includes: string[]): void;
-    /**
-     * Add a field that should be used for sorting data
-     *
-     * @param {ISort} sort - Sort configuration with field name and order (ASC/DESC)
-     * @return {void}
-     * @example
-     * import { SortEnum } from 'ng-qubee';
-     * service.addSort({ field: 'created_at', order: SortEnum.DESC });
-     * service.addSort({ field: 'name', order: SortEnum.ASC });
-     */
-    addSort(sort: ISort): void;
-    /**
-     * Remove fields for the given model
-     * Uses deep cloning to prevent mutations to the original state
-     *
-     * @param {IFields} fields - Object mapping model names to arrays of field names to remove
-     * @return {void}
-     * @example
-     * service.deleteFields({ users: ['email'] });
-     * service.deleteFields({ posts: ['content', 'body'] });
-     */
-    deleteFields(fields: IFields): void;
-    /**
-     * Remove filters from the request
-     * Uses deep cloning to prevent mutations to the original state
-     *
-     * @param {...string[]} filters - Filter keys to remove
-     * @return {void}
-     * @example
-     * service.deleteFilters('id');
-     * service.deleteFilters('status', 'type');
-     */
-    deleteFilters(...filters: string[]): void;
-    /**
-     * Remove includes from the request
-     *
-     * @param {...string[]} includes - Include names to remove
-     * @return {void}
-     * @example
-     * service.deleteIncludes('profile');
-     * service.deleteIncludes('posts', 'comments');
-     */
-    deleteIncludes(...includes: string[]): void;
-    /**
-     * Remove sorts from the request by field name
-     *
-     * @param {...string[]} sorts - Field names of sorts to remove
-     * @return {void}
-     * @example
-     * service.deleteSorts('created_at');
-     * service.deleteSorts('name', 'created_at');
-     */
-    deleteSorts(...sorts: string[]): void;
-    /**
-     * Reset the query builder state to initial values
-     * Clears all fields, filters, includes, sorts, and resets pagination
-     *
-     * @return {void}
-     * @example
-     * service.reset();
-     * // State is now: { baseUrl: '', fields: {}, filters: {}, includes: [], limit: 15, model: '', page: 1, sorts: [] }
-     */
-    reset(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NestService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NestService>;
-}

package/lib/services/ng-qubee.service.d.ts

@@ -1,147 +0,0 @@
-import { Observable } from 'rxjs';
-import { SortEnum } from '../enums/sort.enum';
-import { IFields } from '../interfaces/fields.interface';
-import { IQueryBuilderConfig } from '../interfaces/query-builder-config.interface';
-import { NestService } from './nest.service';
-import * as i0 from "@angular/core";
-export declare class NgQubeeService {
-    private _nestService;
-    private _options;
-    /**
-     * This property serves as an accumulator for holding the composed string with each query param
-     */
-    private _uri;
-    private _uri$;
-    uri$: Observable<string>;
-    constructor(_nestService: NestService, options?: IQueryBuilderConfig);
-    private _parseFields;
-    private _parseFilters;
-    private _parseIncludes;
-    private _parseLimit;
-    private _parsePage;
-    private _parseSort;
-    private _parse;
-    private _prepend;
-    /**
-     * Add fields to the select statement for the given model
-     *
-     * @param model Model that holds the fields
-     * @param fields Fields to select
-     * @returns {this}
-     */
-    addFields(model: string, fields: string[]): this;
-    /**
-     * Add a filter with the given value(s)
-     *  I.e. filter[field]=1 or filter[field]=1,2,3
-     *
-     * @param {string} field Name of the field to filter
-     * @param {string[]} value The needle(s)
-     * @returns {this}
-     */
-    addFilter(field: string, ...values: (string | number | boolean)[]): this;
-    /**
-     * Add related entities to include in the request
-     *
-     * @param {string[]} models
-     * @returns
-     */
-    addIncludes(...models: string[]): this;
-    /**
-     * Add a field with a sort criteria
-     *
-     * @param field Field to use for sorting
-     * @param {SortEnum} order A value from the SortEnum enumeration
-     * @returns {this}
-     */
-    addSort(field: string, order: SortEnum): this;
-    /**
-     * Delete selected fields for the given models in the current query builder state
-     *
-     * ```
-     * ngQubeeService.deleteFields({
-     *   users: ['email', 'password'],
-     *   address: ['zipcode']
-     * });
-     * ```
-     *
-     * @param {IFields} fields
-     * @returns
-     */
-    deleteFields(fields: IFields): this;
-    /**
-     * Delete selected fields for the given model in the current query builder state
-     *
-     * ```
-     * ngQubeeService.deleteFieldsByModel('users', 'email', 'password']);
-     * ```
-     *
-     * @param model Model that holds the fields
-     * @param {string[]} fields Fields to delete from the state
-     * @returns {this}
-     */
-    deleteFieldsByModel(model: string, ...fields: string[]): this;
-    /**
-     * Remove given filters from the query builder state
-     *
-     * @param {string[]} filters Filters to remove
-     * @returns {this}
-     */
-    deleteFilters(...filters: string[]): this;
-    /**
-     * Remove selected related models from the query builder state
-     *
-     * @param {string[]} includes Models to remove
-     * @returns
-     */
-    deleteIncludes(...includes: string[]): this;
-    /**
-     * Remove sorts rules from the query builder state
-     *
-     * @param sorts Fields used for sorting to remove
-     * @returns {this}
-     */
-    deleteSorts(...sorts: string[]): this;
-    /**
-     * Generate an URI accordingly to the given data
-     *
-     * @returns {Observable<string>} An observable that emits the generated uri
-     */
-    generateUri(): Observable<string>;
-    /**
-     * Clear the current state and reset the Query Builder to a fresh, clean condition
-     *
-     * @returns {this}
-     */
-    reset(): this;
-    /**
-     * Set the base url to use for composing the address
-     *
-     * @param {string} baseUrl
-     * @returns {this}
-     */
-    setBaseUrl(baseUrl: string): this;
-    /**
-     * Set the items per page number
-     *
-     * @param limit
-     * @returns {this}
-     */
-    setLimit(limit: number): this;
-    /**
-     * Set the model to use for running the query against
-     *   - I.e. the model "users" will return /users
-     *
-     * @param {string} model Model name
-     * @returns {this}
-     */
-    setModel(model: string): this;
-    /**
-     * Set the page that the backend will use to paginate the result set
-     *
-     * @param page Page param
-     * @returns {this}
-     */
-    setPage(page: number): this;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgQubeeService, [null, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgQubeeService>;
-}

package/lib/services/pagination.service.d.ts

@@ -1,13 +0,0 @@
-import { IPaginationConfig } from "../interfaces/pagination-config.interface";
-import { PaginatedCollection } from "../models/paginated-collection";
-import { IPaginatedObject } from "../interfaces/paginated-object.interface";
-import * as i0 from "@angular/core";
-export declare class PaginationService {
-    private _options;
-    constructor(options?: IPaginationConfig);
-    paginate<T extends IPaginatedObject>(response: {
-        [key: string]: any;
-    }): PaginatedCollection<T>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PaginationService, [{ optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PaginationService>;
-}

package/public-api.d.ts

@@ -1,20 +0,0 @@
-export * from './lib/models/paginated-collection';
-export * from './lib/ng-qubee.module';
-export * from './lib/provide-ngqubee';
-export * from './lib/services/ng-qubee.service';
-export * from './lib/services/pagination.service';
-export * from './lib/enums/sort.enum';
-export * from './lib/errors/invalid-limit.error';
-export * from './lib/errors/invalid-model-name.error';
-export * from './lib/errors/invalid-page-number.error';
-export * from './lib/errors/key-not-found.error';
-export * from './lib/errors/unselectable-model.error';
-export * from './lib/interfaces/config.interface';
-export * from './lib/interfaces/fields.interface';
-export * from './lib/interfaces/filters.interface';
-export * from './lib/interfaces/nest-state.interface';
-export * from './lib/interfaces/page.interface';
-export * from './lib/interfaces/paginated-object.interface';
-export * from './lib/interfaces/pagination-config.interface';
-export * from './lib/interfaces/query-builder-config.interface';
-export * from './lib/interfaces/sort.interface';