@smallpearl/ngx-helper 0.33.50 → 20.0.2

package/mat-entity-crud/src/mat-entity-crud.component.d.ts

@@ -1,366 +0,0 @@
-import { HttpClient, HttpContextToken, HttpParams } from '@angular/common/http';
-import { AfterViewInit, EventEmitter, Injector, QueryList, TemplateRef } from '@angular/core';
-import { MatSnackBar } from '@angular/material/snack-bar';
-import { MatColumnDef } from '@angular/material/table';
-import { SPMatEntityListComponent } from '@smallpearl/ngx-helper/mat-entity-list';
-import { DomSanitizer } from '@angular/platform-browser';
-import { TranslocoService } from '@jsverse/transloco';
-import { Observable, Subscription } from 'rxjs';
-import { FormViewHostComponent } from './form-view-host.component';
-import { SPMatEntityCrudComponentBase } from './mat-entity-crud-internal-types';
-import { MatEntityCrudItemAction } from './mat-entity-crud-item-action';
-import { ALLOW_ITEM_ACTION_FN, CRUD_OP_FN, NewItemSubType, SPMatEntityCrudConfig, SPMatEntityCrudResponseParser } from './mat-entity-crud-types';
-import { PreviewHostComponent } from './preview-host.component';
-import * as i0 from "@angular/core";
-export declare class SPMatEntityCrudComponent<TEntity extends {
-    [P in IdKey]: PropertyKey;
-}, IdKey extends string = 'id'> extends SPMatEntityListComponent<TEntity, IdKey> implements SPMatEntityCrudComponentBase<TEntity, IdKey>, AfterViewInit {
-    private snackBar;
-    itemLabel: import("@angular/core").InputSignal<string | Observable<string> | undefined>;
-    itemLabelPlural: import("@angular/core").InputSignal<string | Observable<string> | undefined>;
-    /**
-     * Title string displayed above the component. If not specified, will use
-     * itemLabelPlural() as the title.
-     */
-    title: import("@angular/core").InputSignal<string | Observable<string> | undefined>;
-    /**
-     *
-     */
-    itemActions: import("@angular/core").InputSignal<MatEntityCrudItemAction<TEntity, IdKey>[]>;
-    /**
-     * Specify the list of router paths that will be set as the value for
-     * [routerLink] for the 'New {{ item }}' button. If not specified,
-     * if createEditTemplate is specified, it will be shown. If not, `action`
-     * out event will be raised with `{ role: '_new_' }`.
-     */
-    newItemLink: import("@angular/core").InputSignal<string | string[] | undefined>;
-    /**
-     * If not specified, will default to 'New <itemLabel()>'.
-     */
-    newItemLabel: import("@angular/core").InputSignal<string | string[] | undefined>;
-    /**
-     * Text for the Edit <item> pane title
-     */
-    editItemTitle: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * If you want "New {{item}}" button to support multiple entity types,
-     * you can set this to `NewItemSubType[]`, where each element stands for for
-     * a dropdown menu item. Refer to `NewItemSubType` for details on this
-     * interface.
-     */
-    newItemSubTypes: import("@angular/core").InputSignal<NewItemSubType[] | undefined>;
-    /**
-     * If you want to take control of the network operations for the CRUD
-     * operations (GET/CREATE/UPDATE/DELETE), provide a value for this property.
-     */
-    crudOpFn: import("@angular/core").InputSignal<CRUD_OP_FN<TEntity, IdKey> | undefined>;
-    /**
-     * Item preview template.
-     */
-    previewTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
-    /**
-     * Whether to allow a context menu action or not. Return false to disable
-     * the action.
-     */
-    allowEntityActionFn: import("@angular/core").InputSignal<ALLOW_ITEM_ACTION_FN<TEntity> | undefined>;
-    /**
-     * A template that allows the header to be replaced. Usage:-
-     *
-     *    ```
-     *    <sp-map-entity-crud
-     *      [headerTemplate]="myCrudViewHeader"
-     *    ></sp-map-entity-crud>
-     *    <ng-template #myCrudViewHeader>...</ng-template>
-     *    ```
-     */
-    headerTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
-    /**
-     * Set this to the custom template identifier that will replace the
-     * "New {{Item}}" button portion. This template will expand towards the
-     * title which will be placed to its left (right in rtl).
-     *
-     *    ```
-     *    <sp-map-entity-crud
-     *      [actionsTemplate]="myCrudActions"
-     *    ></sp-map-entity-crud>
-     *    <ng-template #myCrudActions>...</ng-template>
-     *    ```
-     */
-    actionsTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
-    /**
-     * CRUD action response parser. This will be called with the response
-     * from CREATE & UPDATE operations to parse the response JSON and return
-     * the created/updated TEntity.
-     */
-    crudResponseParser: import("@angular/core").InputSignal<SPMatEntityCrudResponseParser | undefined>;
-    /**
-     * An ng-template name that contains the component which provides the
-     * create/edit CRUD action.
-     *
-     *  ```
-     *  <ng-template #createEdit let-data>
-     *    <app-create-edit-entity-demo [bridge]="data.bridge" [entity]="data.entity"></app-create-edit-entity-demo>
-     *  </ng-template>
-     *  ```
-     * Note how [bridge] & [entity] properties are set deriving them from the
-     * implicit template context. [entity] will be undefined for Create
-     * opreation and will be the valid entity for an Update.
-     * (app-create-edit-entity-demo here is the client code that implements the
-     * Create/Edit form)
-     */
-    createEditFormTemplate: import("@angular/core").InputSignal<TemplateRef<any> | null>;
-    /**
-     * Disables the per item actions column, preventing 'Edit' & 'Delete'
-     * (and other user defined) item operations.
-     */
-    disableItemActions: import("@angular/core").InputSignal<boolean>;
-    /**
-     * Disables the Create function.
-     */
-    disableCreate: import("@angular/core").InputSignal<boolean>;
-    /**
-     * View refresh policy after a CREATE/UPDATE operation. Values
-     *  'none'   - Objects are not refreshed after an edit operation. The return
-     *             value of the edit operation is used as the object to
-     *             add/update the component's internal store. This is the default.
-     *  'object' - Refresh just the object that was returned from the
-     *             CREATE/UPDATE operation. Use this if the JSON object returned
-     *             after a successful CREATE/UPDATE op differs from the JSON
-     *             object returned for the GET request.
-     *  'all'    - Refresh the entire list after a CREATE/UPDATE operation. This
-     *             mimics the behaviour of legacy HTML apps with pure server
-     *             defined UI.
-     */
-    refreshAfterEdit: import("@angular/core").InputSignal<"object" | "none" | "all">;
-    /**
-     * HttpContext for crud requests - `create`, `retrieve`, `update` & `delete`.
-     * Note that HttpContext for `list` operation should be set using the
-     * `httpReqContext` property inherited from SPMatEntityListComponent.
-     * The value of the property is an object where the key names reflect the CRUD
-     * operation with each of these keys expected to have a value of type
-     * `[[HttpContextToken<any>, any]] | [HttpContextToken<any>, any] | HttpContext`.
-     *
-     * Alternatively the property value can be set to
-     * `[[HttpContextToken<any>, any]] | [HttpContextToken<any>, any] | HttpContext`,
-     * in which case the same context would be used for all HTTP requests.
-     */
-    crudHttpReqContext: import("@angular/core").InputSignal<[HttpContextToken<any>, any] | [[HttpContextToken<any>, any]] | {
-        create?: [[HttpContextToken<any>, any]] | [HttpContextToken<any>, any];
-        retrieve?: [[HttpContextToken<any>, any]] | [HttpContextToken<any>, any];
-        update?: [[HttpContextToken<any>, any]] | [HttpContextToken<any>, any];
-        delete?: [[HttpContextToken<any>, any]] | [HttpContextToken<any>, any];
-    } | undefined>;
-    /**
-     * Width of the edit pane as a percentange of the overall <as-split> width.
-     */
-    editPaneWidth: import("@angular/core").InputSignal<number>;
-    /**
-     * Width of the preview pane as a percentange of the overall <as-split> width.
-     */
-    previewPaneWidth: import("@angular/core").InputSignal<number>;
-    /**
-     * The class class that will be applied to the list pane wrapper.
-     */
-    listPaneWrapperClass: import("@angular/core").InputSignal<string>;
-    /**
-     * The class class that will be applied to the preview pane wrapper.
-     * Inside this wrapper, another div element with class='previewPaneContentClass()'
-     * will be created to host the preview content. The client supplied preview
-     * template will be rendered inside this div.
-     *
-     * +----------------------------------------+
-     * | previewPaneWrapperClass                |
-     * |----------------------------------------|
-     * | preview toolbar                        |
-     * |----------------------------------------|
-     * | +------------------------------------+ |
-     * | | div class=previewPaneContentClass()| |
-     * | |------------------------------------| |
-     * | | client supplied preview template   | |
-     * | +------------------------------------+ |
-     * +----------------------------------------+
-     */
-    previewPaneWrapperClass: import("@angular/core").InputSignal<string>;
-    /**
-     * The class class that will be applied to the preview pane content.
-     */
-    previewPaneContentClass: import("@angular/core").InputSignal<string>;
-    /**
-     * The class class that will be applied to the form pane wrapper. Inside this
-     * wrapper, another div element with class='formPaneContentClass()' will be
-     * created to host the form content. The client supplied form template will
-     * be rendered inside this div.
-     *
-     * +----------------------------------------+
-     * | formPaneWrapperClass                   |
-     * | +------------------------------------+ |
-     * | | div class=formPaneContentClass()   | |
-     * | |------------------------------------| |
-     * | | form title + close button          | |
-     * | |------------------------------------| |
-     * | | client supplied form template      | |
-     * | +------------------------------------+ |
-     * +----------------------------------------+
-     */
-    formPaneWrapperClass: import("@angular/core").InputSignal<string>;
-    /**
-     * The CSS class that will be applied to the form pane content.
-     */
-    formPaneContentClass: import("@angular/core").InputSignal<string>;
-    private getLabel;
-    _itemLabel: import("@angular/core").Signal<Observable<string>>;
-    _itemLabelPlural: import("@angular/core").Signal<Observable<string>>;
-    _title: import("@angular/core").Signal<Observable<string | undefined>>;
-    _endpointSansParams: import("@angular/core").Signal<string>;
-    _endpointParams: import("@angular/core").Signal<void>;
-    componentColumns: import("@angular/core").Signal<readonly MatColumnDef[]>;
-    _clientColumnDefs: QueryList<MatColumnDef>;
-    /**
-     * Event raised for user selecting an item action. It's also raised
-     * for 'New <Item>' action, if 'newItemLink' property is not set.
-     */
-    action: EventEmitter<{
-        role: string;
-        entity?: TEntity;
-    }>;
-    /**
-     * Event raised when create Create/Edit pane is activated & deactivated.
-     * Event contains two flags:-
-     *  activated - whether the createEdit form view was activated or
-     *              deactivated.
-     *  cancelled - whether the form view was cancelled by user. False for this
-     *              indicates that the form view was closed after a successful
-     *              edit operation.
-     */
-    entityViewPaneActivated: EventEmitter<{
-        activated: boolean;
-        cancelled: boolean | undefined;
-        mode: "edit" | "preview";
-    }>;
-    busyWheelId: string;
-    sub$: Subscription;
-    spEntitiesList: import("@angular/core").Signal<SPMatEntityListComponent<TEntity, IdKey> | undefined>;
-    spEntitiesListInited: import("@angular/core").EffectRef;
-    crudConfig: SPMatEntityCrudConfig;
-    createEditHostComponent: import("@angular/core").Signal<FormViewHostComponent<{
-        [x: string]: PropertyKey;
-    }, string> | undefined>;
-    createEditViewActive: import("@angular/core").WritableSignal<boolean>;
-    canCancelEditCallback: () => boolean;
-    previewHostComponent: import("@angular/core").Signal<PreviewHostComponent<{
-        [x: string]: PropertyKey;
-    }, string> | undefined>;
-    previewActive: import("@angular/core").Signal<boolean>;
-    previewedEntity: import("@angular/core").WritableSignal<TEntity | undefined>;
-    entityPaneActive: import("@angular/core").Signal<boolean>;
-    entityPaneWidth: import("@angular/core").Signal<number>;
-    entitiesPaneWidth: import("@angular/core").Signal<number>;
-    entitiesPaneHidden: import("@angular/core").Signal<boolean>;
-    defaultItemCrudActions: import("@angular/core").WritableSignal<MatEntityCrudItemAction<TEntity, IdKey>[]>;
-    columnsWithAction: import("@angular/core").Signal<(string | import("@smallpearl/ngx-helper/entity-field").SPEntityFieldSpec<TEntity, IdKey>)[]>;
-    _itemActions: (entity: TEntity) => MatEntityCrudItemAction<TEntity, IdKey>[];
-    visibleColumns: import("@angular/core").Signal<string[]>;
-    transloco: TranslocoService;
-    constructor(http: HttpClient, snackBar: MatSnackBar, sanitizer: DomSanitizer, injector: Injector);
-    ngOnInit(): void;
-    ngOnDestroy(): void;
-    /**
-     * Override so that we can suppress default action in SPMatEntityListComponent
-     */
-    ngAfterViewInit(): void;
-    /**
-     * If the create/edit entity form is active, it calls its registered
-     * canCancelEdit callback to determine if it's okay to cancel the edit.
-     * You can use this method from the host component's router guard to
-     * ensure that any changes made to the form are not accidentally lost by
-     * navigating away from the CRUD page.
-     *
-     * If your CRUD page has multiple sp-mat-entity-crud components, you have to
-     * implement the logic to call this method on the appropriate component.
-     *
-     * If the the create/edit form is not active, this method returns true.
-     * @returns
-     */
-    canDeactivate(): boolean;
-    refresh(force?: boolean): void;
-    getEntityName(): string;
-    getEntityNamePlural(): string;
-    getIdKey(): string;
-    closeCreateEdit(cancelled: boolean): void;
-    canCancelEdit(): boolean;
-    registerCanCancelEditCallback(callback: () => boolean): void;
-    triggerEntityUpdate(entity: TEntity): void;
-    triggerEntityDelete(entity: TEntity): void;
-    create(entityValue: any): Observable<any>;
-    update(id: TEntity[IdKey], entityValue: any): Observable<any>;
-    /**
-     * Thunk these methods to the internal <sp-mat-entity-list> component.
-     */
-    addEntity(entity: TEntity): void;
-    removeEntity(id: TEntity[IdKey]): void;
-    updateEntity(id: TEntity[IdKey], entity: TEntity): void;
-    /**
-     * Refresh the entity list, after a CRUD CREATE or UPDATE operation.
-     * @param resp This is the response from the CRUD operation (CREATE/UPDATE).
-     * @param method The CRUD operation post which REFRESH is requested.
-     * @returns Observable<TEntity|null>
-     */
-    doRefreshAfterEdit(resp: any, method: 'create' | 'update'): Observable<any>;
-    getCrudOpResponseParser(): SPMatEntityCrudResponseParser;
-    closePreview(): void;
-    private closePreviewImpl;
-    onItemAction(role: string, entity: TEntity): void;
-    onCreate(event: Event): void;
-    onUpdate(entity: TEntity): void;
-    /**
-     * Show the create/edit component. This is deliberately made public so as to
-     * be callable from the client. This allows the client to dynamically
-     * set the form edit template and then show the edit pane by calling this
-     * method.
-     * @param entity
-     * @param params
-     */
-    showCreateEditView(entity?: TEntity | undefined, params?: any): void;
-    showPreviewView(entity?: TEntity, params?: any): void;
-    hidePreviewView(): void;
-    onDelete(entity: TEntity): Promise<void>;
-    getUrl(endpoint: string): string;
-    getEntityUrl(entityId: TEntity[IdKey]): string;
-    getEntityActionUrl(entityId: TEntity[IdKey], action: string): string;
-    handleSelectEntity(entity: TEntity | undefined): void;
-    handleNewItemSubType(subtype: NewItemSubType): void;
-    private getCrudReqHttpContext;
-    isItemActionAllowed(action: string, entity: TEntity): boolean;
-    /**
-     * Returns the list of item actions. Calls 'allowItemActionFn' for each action
-     * to determine if the action is allowed for the given entity.
-     * @returns
-     */
-    getItemActions(entity: TEntity): MatEntityCrudItemAction<TEntity, IdKey>[];
-    getPreviewPaneContentClass(): string;
-    getFormPaneWrapperClass(): string;
-    getFormPaneContentClass(): string;
-    getItemLabel(): string | Observable<string>;
-    getItemLabelPlural(): string | Observable<string>;
-    /**
-     * Perform an action on the entity with the given id. The endpoint for the
-     * action is derived from the `verb` argument which is appended to the
-     * entity URL. This is following DRF specification where ViewSets can be
-     * extended with custom actions that are not part of the standard
-     * CRUD operations. Such methods will have a URL like
-     * `/api/v1/entity/<id>/<verb>/` where `<verb>` is the custom action verb.
-     * @param id
-     * @param verb
-     * @param addlParams
-     * @param data
-     */
-    doEntityAction(id: TEntity[IdKey], verb: string, addlParams: HttpParams, data: any, busyWheelName?: string): Observable<any>;
-    /**
-     * Initialize the columns for the mat-entities-list component. This is
-     * called when the <sp-mat-entities-list> component has been properly
-     * initialized.
-     */
-    private _initEntitiesList;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SPMatEntityCrudComponent<any, any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SPMatEntityCrudComponent<any, any>, "sp-mat-entity-crud", never, { "itemLabel": { "alias": "itemLabel"; "required": false; "isSignal": true; }; "itemLabelPlural": { "alias": "itemLabelPlural"; "required": false; "isSignal": true; }; "title": { "alias": "title"; "required": false; "isSignal": true; }; "itemActions": { "alias": "itemActions"; "required": false; "isSignal": true; }; "newItemLink": { "alias": "newItemLink"; "required": false; "isSignal": true; }; "newItemLabel": { "alias": "newItemLabel"; "required": false; "isSignal": true; }; "editItemTitle": { "alias": "editItemTitle"; "required": false; "isSignal": true; }; "newItemSubTypes": { "alias": "newItemSubTypes"; "required": false; "isSignal": true; }; "crudOpFn": { "alias": "crudOpFn"; "required": false; "isSignal": true; }; "previewTemplate": { "alias": "previewTemplate"; "required": false; "isSignal": true; }; "allowEntityActionFn": { "alias": "allowEntityActionFn"; "required": false; "isSignal": true; }; "headerTemplate": { "alias": "headerTemplate"; "required": false; "isSignal": true; }; "actionsTemplate": { "alias": "actionsTemplate"; "required": false; "isSignal": true; }; "crudResponseParser": { "alias": "crudResponseParser"; "required": false; "isSignal": true; }; "createEditFormTemplate": { "alias": "createEditFormTemplate"; "required": false; "isSignal": true; }; "disableItemActions": { "alias": "disableItemActions"; "required": false; "isSignal": true; }; "disableCreate": { "alias": "disableCreate"; "required": false; "isSignal": true; }; "refreshAfterEdit": { "alias": "refreshAfterEdit"; "required": false; "isSignal": true; }; "crudHttpReqContext": { "alias": "crudHttpReqContext"; "required": false; "isSignal": true; }; "editPaneWidth": { "alias": "editPaneWidth"; "required": false; "isSignal": true; }; "previewPaneWidth": { "alias": "previewPaneWidth"; "required": false; "isSignal": true; }; "listPaneWrapperClass": { "alias": "listPaneWrapperClass"; "required": false; "isSignal": true; }; "previewPaneWrapperClass": { "alias": "previewPaneWrapperClass"; "required": false; "isSignal": true; }; "previewPaneContentClass": { "alias": "previewPaneContentClass"; "required": false; "isSignal": true; }; "formPaneWrapperClass": { "alias": "formPaneWrapperClass"; "required": false; "isSignal": true; }; "formPaneContentClass": { "alias": "formPaneContentClass"; "required": false; "isSignal": true; }; }, { "action": "action"; "entityViewPaneActivated": "entityViewPaneActivated"; }, ["_clientColumnDefs"], ["[breadCrumbs]"], true, never>;
-}

package/mat-entity-crud/src/preview-host.component.d.ts

@@ -1,21 +0,0 @@
-import { EmbeddedViewRef, OnDestroy, OnInit, TemplateRef, ViewContainerRef } from '@angular/core';
-import { SPMatEntityCrudComponentBase } from './mat-entity-crud-internal-types';
-import * as i0 from "@angular/core";
-export declare class PreviewHostComponent<TEntity extends {
-    [P in IdKey]: PropertyKey;
-}, IdKey extends string = 'id'> implements OnInit, OnDestroy {
-    vc: import("@angular/core").Signal<ViewContainerRef | undefined>;
-    entityCrudComponentBase: import("@angular/core").InputSignal<SPMatEntityCrudComponentBase<TEntity, IdKey>>;
-    clientViewTemplate: import("@angular/core").InputSignal<TemplateRef<any> | null>;
-    entity: import("@angular/core").WritableSignal<TEntity | undefined>;
-    clientView: EmbeddedViewRef<any> | null;
-    constructor();
-    ngOnInit(): void;
-    ngOnDestroy(): void;
-    show(entity: TEntity | undefined, params?: any): void;
-    close(): void;
-    private createClientView;
-    destroyClientView(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PreviewHostComponent<any, any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<PreviewHostComponent<any, any>, "sp-entity-crud-preview-host", never, { "entityCrudComponentBase": { "alias": "entityCrudComponentBase"; "required": true; "isSignal": true; }; "clientViewTemplate": { "alias": "clientViewTemplate"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}

package/mat-entity-crud/src/preview-pane.component.d.ts

@@ -1,31 +0,0 @@
-import { InputSignal, OnDestroy, OnInit } from '@angular/core';
-import { SPContextMenuItem } from '@smallpearl/ngx-helper/mat-context-menu';
-import { SPMatEntityCrudComponentBase } from './mat-entity-crud-internal-types';
-import * as i0 from "@angular/core";
-/**
- * A preview pane container to provide a consistent UX for all preview panes.
- * It consits of a toolbar on the top and a container div below that takes up
- * the rest of the preview pane area.
- */
-export declare class SPMatEntityCrudPreviewPaneComponent<TEntity extends {
-    [P in IdKey]: PropertyKey;
-}, IdKey extends string = 'id'> implements OnInit, OnDestroy {
-    entity: InputSignal<TEntity>;
-    entityCrudComponent: InputSignal<SPMatEntityCrudComponentBase<TEntity, IdKey>>;
-    title: InputSignal<string | undefined>;
-    disableUpdate: InputSignal<boolean>;
-    hideUpdate: InputSignal<boolean>;
-    disableDelete: InputSignal<boolean>;
-    hideDelete: InputSignal<boolean>;
-    itemActions: SPContextMenuItem[];
-    _disableActionFactory: (role: string, signal?: InputSignal<boolean>) => import("@angular/core").Signal<boolean>;
-    _disableUpdate: import("@angular/core").Signal<boolean>;
-    _disableDelete: import("@angular/core").Signal<boolean>;
-    ngOnInit(): void;
-    ngOnDestroy(): void;
-    onEdit(): void;
-    onDelete(): void;
-    onClose(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SPMatEntityCrudPreviewPaneComponent<any, any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SPMatEntityCrudPreviewPaneComponent<any, any>, "sp-mat-entity-crud-preview-pane", never, { "entity": { "alias": "entity"; "required": true; "isSignal": true; }; "entityCrudComponent": { "alias": "entityCrudComponent"; "required": true; "isSignal": true; }; "title": { "alias": "title"; "required": false; "isSignal": true; }; "disableUpdate": { "alias": "disableUpdate"; "required": false; "isSignal": true; }; "hideUpdate": { "alias": "hideUpdate"; "required": false; "isSignal": true; }; "disableDelete": { "alias": "disableDelete"; "required": false; "isSignal": true; }; "hideDelete": { "alias": "hideDelete"; "required": false; "isSignal": true; }; }, {}, never, ["[previewToolbarContent]", "[previewContent]"], true, never>;
-}

package/mat-entity-crud/src/providers.d.ts

@@ -1,3 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { SPMatEntityCrudConfig } from './mat-entity-crud-types';
-export declare const SP_MAT_ENTITY_CRUD_CONFIG: InjectionToken<SPMatEntityCrudConfig>;

package/mat-entity-list/src/config.d.ts

@@ -1,6 +0,0 @@
-import { SPMatEntityListConfig } from './mat-entity-list-types';
-export declare const DefaultSPMatEntityListConfig: SPMatEntityListConfig;
-/**
- * To be called from an object's constructor.
- */
-export declare function getEntityListConfig(): SPMatEntityListConfig;

package/mat-entity-list/src/mat-entity-list-types.d.ts

@@ -1,128 +0,0 @@
-import { HttpContextToken } from "@angular/common/http";
-import { Observable } from "rxjs";
-export interface SPMatEntityListHttpContext {
-    entityName: string;
-    entityNamePlural: string;
-    endpoint: string;
-}
-export declare const SP_MAT_ENTITY_LIST_HTTP_CONTEXT: HttpContextToken<SPMatEntityListHttpContext>;
-/**
- * Pagination HTTP request params. Actually copied from Angular's HttpParams
- * declaration. The ReadonlyArray<string|number|boolean> is a bit of an
- * overkill for pagination params, but what the heck. When you copy-paste,
- * do it in full!
- */
-export type SPPageParams = {
-    [param: string]: string | number | boolean | ReadonlyArray<string | number | boolean>;
-};
-/**
- * An interface that the clients should provide, either via a global config
- * (see above), that handles parsing the GET response and returns the entities
- * stored therein. This class will allow the entity-list component to be
- * used across different pagination response types as long as the appropriate
- * SPMatEntityListPaginator class is provided to the component.
- */
-export interface SPMatEntityListPaginator {
-    /**
-     * Return the HTTP request params for the given page index and page size as
-     * an object. For example, for a REST API that supports 'skip' and 'top' params,
-     * the implementation would be:
-     *
-     * ```typescript
-     * getRequestPageParams(endpoint: string, pageIndex: number, pageSize: number): SPPageParams {
-     *   return {
-     *     skip: pageIndex * pageSize,
-     *     top: pageSize
-     *   };
-     * }
-     * ```
-     * @param endpoint
-     * @param pageIndex
-     * @param pageSize
-     * @returns
-     */
-    getRequestPageParams: (endpoint: string, pageIndex: number, pageSize: number) => SPPageParams;
-    /**
-     * Parse the HTTP response received from the GET request and return an object
-     * containing the total number of entities available and the array of entities
-     * for the current page. For example, for the pure DRF paginated response
-     * like below:
-     * ```json
-     * {
-     *  "count": 102,
-     *  "next": "http://api.example.org/entities/?page=3",
-     *  "previous": "http://api.example.org/entities/?page=1",
-     *  "results": [
-     *    {
-     *      "id": 1,
-     *      "name": "Entity 1"
-     *    },
-     *    {
-     *      "id": 2,
-     *      "name": "Entity 2"
-     *    }
-     *  ]
-     * }
-     * ```
-     * The implementation would be:
-     * ```typescript
-     * parseRequestResponse<TEntity extends { [P in IdKey]: PropertyKey }, IdKey extends string = 'id'>(
-     *   entityName: string,
-     *   entityNamePlural: string,
-     *   endpoint: string,
-     *   params: SPPageParams,
-     *   resp: any
-     * ): { total: number; entities: TEntity[] } {
-     *   return {
-     *     total: resp.count,
-     *     entities: resp.results
-     *   };
-     * }
-     * ```
-     * @param entityName
-     * @param entityNamePlural
-     * @param endpoint
-     * @param params
-     * @param resp
-     * @returns
-     */
-    parseRequestResponse: <TEntity extends {
-        [P in IdKey]: PropertyKey;
-    }, IdKey extends string = 'id'>(entityName: string, entityNamePlural: string, endpoint: string, params: SPPageParams, resp: any) => {
-        total: number;
-        entities: TEntity[];
-    };
-}
-/**
- * 'entity' is really TEntity arg of SPMatEntityListComponent<TEntity>.
- * 'column' is the column name. This allows the same value function to support
- * multiple columns further enabing DRY.
- */
-export type COLUMN_VALUE_FN = (entity: any, column: string) => string | number | Date | boolean;
-/**
- * Global config for SPMatEntityList component.
- */
-export interface SPMatEntityListConfig {
-    urlResolver?: (endpoint: string) => string;
-    paginator?: SPMatEntityListPaginator;
-    defaultPageSize?: number;
-    pageSizes?: Array<number>;
-    /**
-     * Provide a method to return the labels for the columns. This is useful when
-     * the columns are specified as the JSON object key names and the labels are
-     * to be transformed into a uniform manner (uppercase) or when the labels
-     * are to be dynamically localized. Note that the response can be an
-     * Observable<string> if the label is to be fetched/changed asynchronously
-     * (as that can happen in an app that supports dynamic changing of the UI
-     * language).
-     * @param entityName
-     * @param columnName
-     * @returns
-     */
-    columnLabelFn?: (entityName: string, columnName: string) => string | Observable<string>;
-}
-/**
- * Type for custom entities loader function, which if provided will be called
- * instead of HttpClient.get.
- */
-export type SPMatEntityListEntityLoaderFn = (params: any) => Observable<any>;