ngx-techlify-core 11.4.7 → 11.4.8

package/lib/base-model/index.d.ts

@@ -0,0 +1,3 @@
+export * from './techlify-form-component.class';
+export * from './techlify-listing-component.class';
+export * from './techlify-service.class';

package/lib/base-model/techlify-form-component.class.d.ts

@@ -0,0 +1,43 @@
+import { FormGroup } from '@angular/forms';
+import { FormValidatorService } from '../core/form-validator.service';
+/**
+ * Interface used to ensure we have a consistent structure across our form components
+ *
+ * It also provides some abstraction of repeated code to reduce our codebase size
+ *
+ * @todo This should be moved to ngx-techlify-core
+ *
+ * Advantages of this abstract class
+ * - Less code, less maintenance, less bugs
+ * - more consistent code
+ * - comments on more code
+ * - save time, save energy
+ */
+export declare abstract class TechlifyFormComponentInterface {
+    protected formValidatorService: FormValidatorService;
+    form: FormGroup;
+    errorMessages: any;
+    constructor(formValidatorService: FormValidatorService);
+    /**
+     * Resets the value of a field in the HTML form
+     *
+     * @param event
+     * @param field
+     */
+    resetFieldValue(event: any, field: string): void;
+    /**
+     * Retrieves the value of a field from the HTML form
+     *
+     * @param field
+     * @returns
+     */
+    getFieldValue(field: string): any;
+    /**
+     * Method to evaluate form fields
+     * */
+    isFieldValid(field: string): any;
+    /**
+     * Method to find error in form fields
+     * */
+    getErrorMessage(field: string): any;
+}

package/lib/base-model/techlify-listing-component.class.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Interface used to ensure we have a consistent structure across our listing pages
+ *
+ * @todo This should be moved to ngx-techlify-core
+ *
+ * Advantages of this abstract class
+ * - Less code, less maintenance, less bugs
+ * - more consistent code
+ * - comments on more code
+ * - save time, save energy
+ */
+export declare abstract class TechlifyListingControllerInterface {
+    models: any[];
+    page: number;
+    perPage: number;
+    lastPage: number;
+    isWorking: boolean;
+    /**
+     * Function that listens for any changes in the form group to apply the filters
+     */
+    abstract listenForChanges(): void;
+    /**
+     * Function that loads the main models of the application
+     */
+    abstract loadData(): void;
+    /**
+     * Reload all data from page 1
+     */
+    reload(): void;
+    /**
+     * Can be called when the user is scrolling,
+     * to trigger loading a new page of data
+     */
+    onScroll(): void;
+    /**
+     * Function used to pop up the edit form for the model
+     *
+     * @param model
+     */
+    abstract editForm(model: any): void;
+    /**
+     * Function used to pop up the delete form for the model
+     *
+     * @param model
+     */
+    abstract deleteForm(model: any): void;
+}

package/lib/base-model/techlify-service.class.d.ts

@@ -0,0 +1,52 @@
+import { HttpService } from '../core/http.service';
+/**
+ * Interface used to ensure we have a consistent structure across our listing pages
+ *
+ * @todo This should be moved to ngx-techlify-core
+ *
+ * Advantages of this abstract class
+ * - Less code, less maintenance, less bugs
+ * - more consistent code
+ * - comments on more code
+ * - save time, save energy
+ */
+export declare class TechlifyServiceBaseClass {
+    protected http: HttpService;
+    protected baseUrl: string;
+    constructor(http: HttpService, baseUrl: string);
+    /**
+     * Loads a set of the model this service is for
+     *
+     * @param filters Restrictors to filter the set of models
+     * @returns
+     */
+    index(filters: any): Promise<Object>;
+    /**
+     * Add a new record to the database
+     *
+     * @param model The data of the model to add
+     * @returns
+     */
+    store(model: any): Promise<Object>;
+    /**
+     * Load a single model record, often with all relations and related data
+     *
+     * @param modelId ID of the model to load
+     * @returns
+     */
+    show(modelId: any): Promise<Object>;
+    /**
+     * Update fields of a single existing model
+     *
+     * @param model Model to update
+     * @returns
+     */
+    update(model: any): Promise<Object>;
+    /**
+     * Delete a single model
+     *
+     * @param model Model to delete
+     * @returns
+     */
+    delete(model: any): Promise<Object>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-techlify-core",
-  "version": "11.4.7",
+  "version": "11.4.8",
   "peerDependencies": {
     "@angular/common": ">=11",
     "@angular/core": ">=11",

package/public-api.d.ts

@@ -1,4 +1,5 @@
 export * from './lib/action-popup';
+export * from './lib/base-model';
 export * from './lib/data-table';
 export * from './lib/document-viewer';
 export * from './lib/entity-files';