@smallpearl/ngx-helper 0.29.23

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "@smallpearl/ngx-helper",
+  "version": "0.29.23",
+  "peerDependencies": {
+    "@angular/common": "^19.1.0",
+    "@angular/core": "^19.1.0",
+    "@angular/cdk": "^19.1.0",
+    "@angular/material": "^19.1.0",
+    "@angular/forms": "^19.1.0",
+    "@jsverse/transloco": "7.5.1",
+    "@ngneat/elf": "^2.5.1",
+    "@ngneat/elf-entities": "^5.0.2",
+    "angular-split": "^19.0.0",
+    "google-libphonenumber": "^3.2.34",
+    "lodash": "^4.17.21",
+    "pluralize": "^8.0.0",
+    "ngx-infinite-scroll": "^19.0.0",
+    "ngx-mat-select-search": "^8.0.0",
+    "rxjs": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "ngx-infinite-scroll": {
+      "optional": true
+    },
+    "angular-split": {
+      "optional": true
+    },
+    "@ngneat/elf": {
+      "optional": true
+    },
+    "@ngneat/elf-entities": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/smallpearl-ngx-helper.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper.mjs"
+    },
+    "./core": {
+      "types": "./core/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-core.mjs"
+    },
+    "./entity-field": {
+      "types": "./entity-field/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-entity-field.mjs"
+    },
+    "./hover-dropdown": {
+      "types": "./hover-dropdown/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-hover-dropdown.mjs"
+    },
+    "./locale": {
+      "types": "./locale/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-locale.mjs"
+    },
+    "./mat-busy-wheel": {
+      "types": "./mat-busy-wheel/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-busy-wheel.mjs"
+    },
+    "./mat-context-menu": {
+      "types": "./mat-context-menu/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-context-menu.mjs"
+    },
+    "./forms": {
+      "types": "./forms/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-forms.mjs"
+    },
+    "./mat-entity-crud": {
+      "types": "./mat-entity-crud/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-entity-crud.mjs"
+    },
+    "./mat-entity-list": {
+      "types": "./mat-entity-list/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-entity-list.mjs"
+    },
+    "./mat-file-input": {
+      "types": "./mat-file-input/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-file-input.mjs"
+    },
+    "./mat-form-error": {
+      "types": "./mat-form-error/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-form-error.mjs"
+    },
+    "./mat-select-entity": {
+      "types": "./mat-select-entity/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-select-entity.mjs"
+    },
+    "./mat-side-menu-layout": {
+      "types": "./mat-side-menu-layout/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-side-menu-layout.mjs"
+    },
+    "./mat-tel-input": {
+      "types": "./mat-tel-input/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-tel-input.mjs"
+    },
+    "./sideload": {
+      "types": "./sideload/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-sideload.mjs"
+    },
+    "./stationary-with-line-items": {
+      "types": "./stationary-with-line-items/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-stationary-with-line-items.mjs"
+    }
+  }
+}

package/public-api.d.ts

@@ -0,0 +1 @@
+export * from './ngx-helper';

package/sideload/index.d.ts

@@ -0,0 +1 @@
+export * from './src/sideload';

package/sideload/src/sideload.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A function merge sideloaded content into the main object thereby returning
+ * a composite object.
+ * @param resp - the JSON response object, typically received from remote for
+ * an HTTP request.
+ * @param targetObjKey - the key name of the target object into which the
+ * sideloaded data are to be merged.
+ * @param idKey - idKey. Function assumes that all the objects use the same
+ * key name as the unique object identifier.
+ * @param sideloadDataMap: An array of [string, string], where the first
+ * element specifies the property name of the target object and the second
+ * element the sideload data element's key. This is useful when the the
+ * target objet's property name that is to be merged with sideload data do not
+ * match.
+ * @returns
+ */
+export declare function sideloadToComposite(resp: any, targetObjKey: string, idKey?: string, mergeStrategy?: 'inplace' | 'append', appendObjSuffix?: string, sideloadDataMap?: Array<[string, string, string?]>): any;

package/stationary-with-line-items/index.d.ts

@@ -0,0 +1 @@
+export * from './src/stationary-with-line-items.component';

package/stationary-with-line-items/src/stationary-with-line-items.component.d.ts

@@ -0,0 +1,74 @@
+import { ChangeDetectorRef, OnInit, TemplateRef } from '@angular/core';
+import { SPEntityField, SPEntityFieldSpec } from '@smallpearl/ngx-helper/entity-field';
+import * as i0 from "@angular/core";
+export declare class FieldsRendererComponent<TEntity extends {
+    [P in IdKey]: PropertyKey;
+}, IdKey extends string = 'id'> implements OnInit {
+    cdr: ChangeDetectorRef;
+    entity: import("@angular/core").InputSignal<TEntity>;
+    fields: import("@angular/core").InputSignal<SPEntityField<TEntity, IdKey>[]>;
+    isString: import("@angular/core").Signal<boolean>;
+    stringValue: import("@angular/core").Signal<any>;
+    ngxHelperConfig: import("@smallpearl/ngx-helper/core").SPNgxHelperConfig;
+    constructor(cdr: ChangeDetectorRef);
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FieldsRendererComponent<any, any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FieldsRendererComponent<any, any>, "sp-fields-renderer", never, { "entity": { "alias": "entity"; "required": true; "isSignal": true; }; "fields": { "alias": "fields"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+/**
+ * A component that renders a stationary with line items, such as invoice,
+ * payment receipt, bill, bill payment record, journal entry, etc. All these
+ * documents have a uniform format and this component abstracts out the
+ * information displayed in this type of document as properties that the client
+ * can provide while it takes care of the rendering.
+ *
+ * Ideally we would declare this as a wrapper class with the actual rendering
+ * to be performed by an inner replaceable component. This way the app will be
+ * able to support multiple stationary designs, which eventually can be
+ * chosen by the user. Perhaps even providing them a feature to design the
+ * stationary.
+ *
+ * This is the first towards that long path ahead.
+ */
+export declare class StationaryWithLineItemsComponent<TEntity extends {
+    [P in IdKey]: PropertyKey;
+}, TEntityLineItem extends {
+    [P in IdKey]: PropertyKey;
+}, IdKey extends string = 'id'> implements OnInit {
+    entity: import("@angular/core").InputSignal<TEntity>;
+    title: import("@angular/core").InputSignal<string>;
+    number: import("@angular/core").InputSignal<string | number | undefined>;
+    leftHeader: import("@angular/core").InputSignal<string | (string | SPEntityFieldSpec<TEntity, IdKey>)[] | undefined>;
+    _leftHeaderFields: import("@angular/core").Signal<SPEntityField<TEntity, IdKey>[]>;
+    leftHeaderTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
+    rightHeader: import("@angular/core").InputSignal<string | (string | SPEntityFieldSpec<TEntity, IdKey>)[] | undefined>;
+    _rightHeaderFields: import("@angular/core").Signal<SPEntityField<TEntity, IdKey>[]>;
+    rightHeaderTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
+    items: import("@angular/core").InputSignal<{
+        [key: string]: string;
+    }[] | undefined>;
+    leftFooter: import("@angular/core").InputSignal<string | (string | SPEntityFieldSpec<TEntity, IdKey>)[] | undefined>;
+    _leftFooterFields: import("@angular/core").Signal<SPEntityField<TEntity, IdKey>[]>;
+    leftFooterTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
+    rightFooter: import("@angular/core").InputSignal<string | (string | SPEntityFieldSpec<TEntity, IdKey>)[] | undefined>;
+    _rightFooterFields: import("@angular/core").Signal<SPEntityField<TEntity, IdKey>[]>;
+    rightFooterTemplate: import("@angular/core").InputSignal<TemplateRef<any> | undefined>;
+    itemFieldName: import("@angular/core").InputSignal<string>;
+    itemColumnFields: import("@angular/core").InputSignal<(string | SPEntityFieldSpec<TEntity, IdKey>)[] | undefined>;
+    _itemColumnFields: import("@angular/core").Signal<SPEntityField<TEntity, IdKey>[]>;
+    _items: import("@angular/core").Signal<any>;
+    ngxHelperConfig: import("@smallpearl/ngx-helper/core").SPNgxHelperConfig;
+    ngxEntityFieldConfig: import("@smallpearl/ngx-helper/entity-field").SPEntityFieldConfig;
+    constructor();
+    ngOnInit(): void;
+    isString(value: any): value is string;
+    /**
+     * Make the method a generic as we'll be using it for both TEntity and its
+     * child TEntityLineItem objects.
+     * @param fieldSpecs
+     * @returns
+     */
+    getSPEntityFields<T>(fieldSpecs: Array<SPEntityFieldSpec<TEntity, IdKey> | string> | string | undefined): Array<SPEntityField<TEntity, IdKey>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StationaryWithLineItemsComponent<any, any, any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<StationaryWithLineItemsComponent<any, any, any>, "sp-stationary-with-line-items", never, { "entity": { "alias": "entity"; "required": true; "isSignal": true; }; "title": { "alias": "title"; "required": true; "isSignal": true; }; "number": { "alias": "number"; "required": false; "isSignal": true; }; "leftHeader": { "alias": "leftHeader"; "required": false; "isSignal": true; }; "leftHeaderTemplate": { "alias": "leftHeaderTemplate"; "required": false; "isSignal": true; }; "rightHeader": { "alias": "rightHeader"; "required": false; "isSignal": true; }; "rightHeaderTemplate": { "alias": "rightHeaderTemplate"; "required": false; "isSignal": true; }; "items": { "alias": "items"; "required": false; "isSignal": true; }; "leftFooter": { "alias": "leftFooter"; "required": false; "isSignal": true; }; "leftFooterTemplate": { "alias": "leftFooterTemplate"; "required": false; "isSignal": true; }; "rightFooter": { "alias": "rightFooter"; "required": false; "isSignal": true; }; "rightFooterTemplate": { "alias": "rightFooterTemplate"; "required": false; "isSignal": true; }; "itemFieldName": { "alias": "itemFieldName"; "required": false; "isSignal": true; }; "itemColumnFields": { "alias": "itemColumnFields"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}