@smallpearl/ngx-helper 0.33.50 → 20.0.2

package/mat-entity-crud/src/mat-entity-crud-internal-types.d.ts

@@ -1,131 +0,0 @@
-import { HttpParams } from "@angular/common/http";
-import { SPContextMenuItem } from "@smallpearl/ngx-helper/mat-context-menu";
-import { Observable } from "rxjs";
-export declare const ITEM_ACTION_UPDATE = "_update_";
-export declare const ITEM_ACTION_DELETE = "_delete_";
-/**
- * SPMatEntityCrudCreateEditBridge implementer uses this interface to
- * communicate with the parent SPMatEntityCreateComponent. The bridge
- * component would use the hideCreateEdit() to close itself, when user cancels
- * the create/edit operation.
- */
-export interface SPMatEntityCrudComponentBase<TEntity extends {
-    [P in IdKey]: PropertyKey;
-}, IdKey extends string = 'id'> {
-    /**
-     * Wrappers around entityName & entityNamePlural properties.
-     */
-    getEntityName(): string;
-    getEntityNamePlural(): string;
-    /**
-     * Wrapper around idKey property.
-     */
-    getIdKey(): string;
-    /**
-     * This method should return the entity URL for the given entity id.
-     * The entity URL should include any additional query parameters that were
-     * passed to the SPMatEntityCrudComponentBase component's `url` property.
-     * @param id
-     */
-    getEntityUrl(id: TEntity[IdKey] | undefined): string;
-    /**
-     * FormViewHostComponent will call this to close the Create/Edit pane.
-     * SPMatEntityCrudComponentBase implementor will destroy the client form
-     * view and hide the Create/Edit form view pane and show the hidden
-     * entity list view.
-     * @returns
-     */
-    closeCreateEdit: (cancelled: boolean) => void;
-    /**
-     * Used internally by FormViewHostComponent to determine if the client form
-     * view wants to intercept user's cancel the create/edit operation. Perhaps
-     * with the Yes/No prompt 'Lose changes?'
-     * @returns boolean indicating it's okay to cancel the create/edit operation.
-     */
-    canCancelEdit: () => boolean;
-    /**
-     * Client form view can register a callback that will be invoked by the
-     * framework when user cancels the create/edit operation by clicking on the
-     * close button on the top right.
-     * @param callback
-     * @returns
-     */
-    registerCanCancelEditCallback: (callback: () => boolean) => void;
-    /**
-     * Initiates update on the given entity.
-     * @returns
-     */
-    triggerEntityUpdate: (entity: TEntity) => void;
-    /**
-     * Initiates entity delete.
-     * @returns
-     */
-    triggerEntityDelete: (entity: TEntity) => void;
-    /**
-     * Called by client form-view host component to close a new entity.
-     * @param entityValue The ReactiveForm.value object that the server expects
-     * to create a new object.
-     * @returns The new Entity object returned by the server. For typical REST
-     * API, this would be of the same shape as the objects returned by the
-     * REST's GET request.
-     */
-    create: (entityValue: any) => Observable<any>;
-    /**
-     * Called by client form-view host component to close a new entity.
-     * @param id The id of the entity being edited.
-     * @param entityValue The ReactiveForm.value object that the server expects
-     * to update the new object.
-     * @returns The new Entity object returned by the server. For typical REST
-     * API, this would be of the same shape as the objects returned by the
-     * REST's GET request.
-     */
-    update: (id: any, entityValue: any) => Observable<any>;
-    /**
-     * Close the preview pane.
-     * @returns
-     */
-    closePreview: () => void;
-    /**
-     * Returns the context menu items for the entity. This can be used to build
-     * the context menu for an entity in its preview pane toolbar.
-     * @returns
-     */
-    getItemActions(entity?: TEntity): SPContextMenuItem[];
-    /**
-     * Returns the class to be used for the preview pane content. This interface
-     * is provided to allow the PreviewPaneComponent to access the client
-     * configured class for the preview pane content.
-     */
-    getPreviewPaneContentClass(): string;
-    getFormPaneWrapperClass(): string;
-    getFormPaneContentClass(): string;
-    getItemLabel(): string | Observable<string>;
-    getItemLabelPlural(): string | Observable<string>;
-    removeEntity(id: TEntity[IdKey]): void;
-    /**
-     * Update the entity with the given id in the list of entities.
-     * This is typically called by the client when it has performed an update
-     * on the entity itself and want to reflect the resulting changed
-     * entity in the list view.
-     *
-     * @param id The id of the entity to update.
-     * @param data The updated entity.
-     */
-    updateEntity(id: TEntity[IdKey], data: TEntity): void;
-    /**
-     * Perform a custom action on the entity endpoint. The action is specified
-     * by the verb argument, which will be used to derive the final URL. This
-     * is keeping in line with DRF specification where viewsets can define
-     * custom action methods, which translate into endpoints with the same name
-     * ast he action method.
-     * @param id id of the entity to perform the action on.
-     * @param verb The action verb, which will be appended to the entity URL to
-     * derive the final URL for the POST request.
-     * @param addlParams additional query parameters to include in the request.
-     * Called `additional` as these are in addition to the query params specified
-     * in the CRUD's endpoint.
-     * @param data the data to send with the request for the POST
-     * @returns Observable<TEntity>
-     */
-    doEntityAction(id: TEntity[IdKey], verb: string, addlParams: HttpParams, data: any, busyWheelName: string): Observable<any>;
-}

package/mat-entity-crud/src/mat-entity-crud-item-action.d.ts

@@ -1,68 +0,0 @@
-import { HttpParams } from "@angular/common/http";
-import { SPContextMenuItem } from "@smallpearl/ngx-helper/mat-context-menu";
-/**
- * Describes an action on an item in the MatEntityCrud component. Actions are
- * shown in the context menu for each entity in the MatEntityCrud component.
- * The action is triggered when the user selects the corresponding menu item.
- * There are two ways to handle the action when it is triggered (user selects
- * the corresponding menu item):
- *
- * 1. If the action's 'role' property is one of the predefined roles
- *   ('_edit_', '_view_', '_delete_'), the MatEntityCrud component handles
- *   the action internally by opening the corresponding dialog (edit/view)
- *   or performing the delete operation.
- * 2. If the action maps to a HTTP REST API endpoint on the item at the server,
- *   the MatEntityCrud component can perform the HTTP request. To enable this,
- *   the application must set the action's 'behavior' property to 'http' and
- *   if the REST request differs from the default POST to the entity's base URL
- *   with the action's 'role' appended as the URL path, provide the necessary
- *   HTTP request parameters in the 'httpRequestParameters' property.
- * 3. For all other actions, the MatEntityCrud component emits an 'action'
- *   event with the action's 'role' and the entity as arguments. The
- *   application can listen to this event and handle the action as needed.
- *
- * @template TEntity The type of the entity on which the action is performed.
- */
-export interface MatEntityCrudItemAction<TEntity extends {
-    [P in IdKey]: PropertyKey;
-}, IdKey extends string = 'id'> extends SPContextMenuItem {
-    /**
-     * Optional confirmation prompt message to be shown to the user
-     * before performing the action. If specified, the user must confirm
-     * the action before it is executed.
-     */
-    confirmPrompt?: string;
-    /**
-     * Optional message to be shown to the user after the action is
-     * successfully performed.
-     */
-    successMessage?: string;
-    /**
-     * Optional error message to be shown to the user if the action fails.
-     */
-    errorMessage?: string;
-    /**
-     * HTTP request parameters for actions that map to HTTP REST API
-     * endpoints on the item at the server. This property is used when
-     * 'actionBehavior' is set to 'http'.
-     *
-     * If not specified, and behavior is set to 'http', a POST request is
-     * made to the entity's base URL with the action's 'role' appended
-     * as the URL path.
-     */
-    httpRequestParameters?: {
-        method: 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-        urlPath?: string;
-        params?: HttpParams;
-        body?: any;
-    };
-    /**
-     * Custom handler function to be called when the action is triggered.
-     * If provided, this function is called instead of the default handling
-     * by the MatEntityCrud component. This property takes precedence over
-     * `httpRequestParameters`.
-     *
-     * @param entity The entity on which the action is performed.
-     */
-    action?: (entity: TEntity) => void;
-}

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

@@ -1,149 +0,0 @@
-import { HttpContextToken } from "@angular/common/http";
-import { SPContextMenuItem } from "@smallpearl/ngx-helper/mat-context-menu";
-import { Observable } from "rxjs";
-/**
- * Prototype of the function to parse the CRUD action response.
- */
-export type SPMatEntityCrudResponseParser = (entityName: string, idKey: string, method: string, // 'create' | 'retrieve' | 'update' | 'delete',
-resp: any) => any | undefined;
-/**
- * Global config for SPMatEntityList component.
- */
-export interface SPMatEntityCrudConfig {
-    /**
-     * The item actions that will be shown for each item in the list.
-     * This defaults to 'Update' & 'Delete' actions, but can be customized
-     * by this property. Note the item actions can be set for individual
-     * <sp-mat-entity-crud> component through its itemActions property.
-     */
-    defaultItemActions?: SPContextMenuItem[];
-    /**
-     * Global crud response parser.
-     */
-    crudOpResponseParser?: SPMatEntityCrudResponseParser;
-}
-/**
- * This is the interface through which the client provided CRUD form component
- * interacts with the 'host' SPMatEntityCrudComponent. When the form wants to
- * submit an entity to the server (for create or update), it should call the
- * one of the create or update methods. The interface also provides other
- * methods for the form component to interact with SPMatEntityCrudComponent
- * such as refresh its entities list, close the form pane, etc.
- *
- * The interface name has a 'Bridge' as the interface acts as a bridge between
- * the client provided form handler component and the host
- * SPMatEntityCrudComponent.
- */
-export interface SPMatEntityCrudCreateEditBridge {
-    /**
-     * Returns the entity name as provided to the host SPMatEntityCrudComponent.
-     * @returns The entity name string.
-     */
-    getEntityName(): string;
-    /**
-     * Returns the entity id key as provided to the host SPMatEntityCrudComponent.
-     * @returns The entity id key string.
-     */
-    getIdKey(): string;
-    /**
-     * Get Entity url
-     * @param cancel
-     * @returns
-     */
-    getEntityUrl(entityId: any): string;
-    /**
-     * Close the edit/update form pane. This WON'T call the 'cancelEditCallback'
-     * even if one is registered.
-     */
-    close: (cancel: boolean) => void;
-    /**
-     * Client form view can register a callback that will be invoked by the
-     * framework when user cancels the create/edit operation by clicking on the
-     * close button on the top right.
-     * @param callback
-     * @returns None
-     */
-    registerCanCancelEditCallback: (callback: () => boolean) => void;
-    /**
-     * Create a new instance of TEntity, by sending a POST request to remote.
-     * @param entityValue This is the typically the output of Reactive form's
-     * form.value. Since this value's shape may be different from TEntity and is
-     * known only to client form, we use 'any'.
-     * @returns None
-     * @inner Implementation will show a busy wheel centered on the form
-     * view while the async function to update the object remains active.
-     */
-    create: (entityValue: any) => Observable<any>;
-    /**
-     * Update the entity with id `id` with new values in entityValue.
-     * @param id TEntity id
-     * @param entityValue Entity values to be updated.
-     * @returns None
-     * @inner Implementation will show a busy wheel centered on the form
-     * view while the async function to update the object remains active.
-     */
-    update: (id: any, entityValue: any) => Observable<any>;
-}
-/**
- * Prototype of the function that will be used instead of HttpClient for
- * CRUD operations.
- * @param op - the CRUD operation being requested
- * @param entityValue - The entity or entity value upon which the operation
- * is being requested. for 'create' & 'update' this will be the value
- * of the reactive form. This is typically form.value or the 2nd arg to create
- * & update methods of SPMatEntityCrudCreateEditBridge.
- */
-export type CRUD_OP_FN<TEntity extends {
-    [P in IdKey]: PropertyKey;
-}, IdKey extends string = 'id'> = (op: string, id: TEntity[IdKey] | undefined, // valid only for 'get', 'update' & 'delete'
-entityValue: any, // valid only for 'create' & 'update'
-entityCrudComponent: any) => Observable<TEntity | null>;
-export type ALLOW_ITEM_ACTION_FN<TEntity> = (entity: TEntity, action: string) => boolean;
-/**
- * This interface is used to define sub types for the "New {{item}}" button on
- * top of the CRUD UI. An array of these is provided as the value to the
- * component property 'newItemSubTypes'.
- */
-export interface NewItemSubType {
-    /**
-     * A role string that will be passed as argument to the (action) event
-     * handler. This string allows the event handler to distinguish the selected
-     * sub-type.
-     *
-     * The special keyword '_new_' can be used to activate the
-     * `createEditTemplate` template if one is provided. In this case the params
-     * element value (see below) can be used in the template to distinguish
-     * between different menu items.
-     */
-    role: string;
-    /**
-     * Label displayed in the menu representing this role.
-     */
-    label: string;
-    /**
-     * Arbitrary value that will be passed to the 'createEditTemplate' in the
-     * $implicit template context as 'params'. You can access this in the
-     * template like below (see `data.params`):-
-        ```
-        <ng-template #createEdit let-data>
-          <app-create-edit-entity-demo
-            [bridge]="data.bridge"
-            [entity]="data.entity"
-            [params]="data.params"
-          ></app-create-edit-entity-demo>
-        </ng-template>
-        ```
-  
-      If params is an object and it includes the key 'title', its value will be
-      used as the title for the edit form.
-     */
-    params?: any;
-}
-export type CrudOp = 'create' | 'retrieve' | 'update' | 'delete' | undefined;
-export interface SPMatEntityCrudHttpContext {
-    entityName: string;
-    entityNamePlural: string;
-    endpoint: string;
-    op: CrudOp;
-}
-export declare const SP_MAT_ENTITY_CRUD_HTTP_CONTEXT: HttpContextToken<SPMatEntityCrudHttpContext>;