@base-framework/base 3.0.90 → 3.0.92

package/dist/types/modules/data/types/model/model-service.d.ts

@@ -0,0 +1,280 @@
+/**
+ * ModelService
+ *
+ * This will create a new model service.
+ *
+ * @class
+ */
+export class ModelService {
+    /**
+     * This will extend the model service.
+     *
+     * @param {object} child
+     * @returns {object}
+     */
+    static extend(child: object): object;
+    /**
+     * This will create a model service.
+     *
+     * @constructor
+     * @param {object} model
+     */
+    constructor(model: object);
+    /**
+     * @member {object} model
+     */
+    model: any;
+    /**
+     * @member {string} objectType The return type.
+     */
+    objectType: string;
+    /**
+     * @member {string} url
+     */
+    url: string;
+    /**
+     * @member {function} validateCallBack
+     */
+    validateCallBack: any;
+    /**
+     * This will initialize the model service.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected init(): void;
+    /**
+     * This will check if the model is valid.
+     *
+     * @returns {boolean}
+     */
+    isValid(): boolean;
+    /**
+     * This should be overriden to validate the model
+     * before submitting.
+     *
+     * @returns {boolean}
+     */
+    validate(): boolean;
+    /**
+     * This can be overriden to add default params
+     * with each request.
+     *
+     * @protected
+     * @returns {string}
+     */
+    protected getDefaultParams(): string;
+    /**
+     * This will setup the request params.
+     *
+     * @protected
+     * @param {(string|object)} params
+     * @returns {(string|object)}
+     */
+    protected setupParams(params: (string | object)): (string | object);
+    /**
+     * This will convert an object to a string.
+     *
+     * @protected
+     * @param {object} object
+     * @returns {string}
+     */
+    protected objectToString(object: object): string;
+    /**
+     * This will add the params.
+     *
+     * @protected
+     * @param {*} params
+     * @param {*} addingParams
+     * @returns {(string|object)}
+     */
+    protected addParams(params: any, addingParams: any): (string | object);
+    /**
+     * This will get the model by id.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    get(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will get the object from the response.
+     *
+     * @protected
+     * @param {object} response
+     * @returns {object}
+     */
+    protected getObject(response: object): object;
+    /**
+     * This will return a string with the model data json encoded.
+     *
+     * @protected
+     * @returns {string}
+     */
+    protected setupObjectData(): string;
+    /**
+     * This will add or update the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    setup(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will add the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    add(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will update the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    update(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will delete the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    delete(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will list rows of the model.
+     *
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {number} start
+     * @param {number} count
+     * @param {string} filter
+     * @returns {object}
+     */
+    all(instanceParams: string, callBack: Function, start: number, count: number, filter: string): object;
+    /**
+     * This will get the url.
+     *
+     * @protected
+     * @param {string} url
+     * @returns {string}
+     */
+    protected getUrl(url: string): string;
+    /**
+     * This will make an ajax request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {string} method
+     * @param {(string|object)} params
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected setupRequest(url: string, method: string, params: (string | object), callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will check if the data is a form data object.
+     *
+     * @protected
+     * @param {*} data
+     * @returns {boolean}
+     */
+    protected _isFormData(data: any): boolean;
+    /**
+     * This will make an ajax request.
+     *
+     * @protected
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected request(params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a GET request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _get(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a POST request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _post(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a PUT request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _put(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a PATCH request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _patch(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a DELETE request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _delete(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make an ajax request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {string} method
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _request(url: string, method: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will get the response.
+     *
+     * @protected
+     * @param {object} response
+     * @param {function} callBack
+     * @param {object} xhr
+     * @returns {void}
+     */
+    protected getResponse(response: object, callBack: Function, xhr: object): void;
+}

package/dist/types/modules/data/types/model/model.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Model
+ *
+ * This will extend Data to add a model that can specify
+ * a service that connects to a remote source.
+ *
+ * @class
+ * @extends Data
+ */
+export class Model extends Data {
+    /**
+     * This will extend the model to a child model.
+     *
+     * @param {object} [settings]
+     * @returns {object}
+     */
+    static extend(settings?: object): object;
+    /**
+     * @member {object|null} xhr
+     */
+    xhr: any;
+    /**
+     * This adds a method to call if you want the model
+     * to do something when its initialized.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected initialize(): void;
+    service: typeof ModelService;
+}
+import { Data } from '../deep-data/deep-data.js';
+import { ModelService } from './model-service.js';

package/dist/types/modules/data/types/simple-data.d.ts

@@ -0,0 +1,12 @@
+/**
+ * SimpleData
+ *
+ * This will extend Data to add a simple data object
+ * that doesn't allow deep nested data.
+ *
+ * @class
+ * @augments BasicData
+ */
+export class SimpleData extends BasicData {
+}
+import { BasicData } from './basic-data.js';

package/dist/types/modules/data-binder/connection-tracker/connections/one-way-connection.d.ts

@@ -8,7 +8,7 @@
  */
 export class OneWayConnection extends Connection {
     /**
-     * @member {object} source
+     * @member {object|null} source
      */
     source: OneWaySource;
     /**

package/dist/types/modules/data-binder/connection-tracker/connections/two-way-connection.d.ts

@@ -10,15 +10,16 @@ export class TwoWayConnection extends Connection {
     /**
      * This will create a two way connection.
      *
+     * @param {object} pubSub
      * @constructor
      */
-    constructor(pubSub: any);
+    constructor(pubSub: object);
     /**
-     * @member {object} element
+     * @member {object|null} element
      */
     element: ElementSource;
     /**
-     * @member {object} data
+     * @member {object|null} data
      */
     data: DataSource;
     /**

package/dist/types/modules/layout/html-to-string.d.ts

@@ -0,0 +1,39 @@
+/**
+ * HtmlToString
+ *
+ * This will render html to a string.
+ *
+ * @class
+ */
+export class HtmlToString {
+    /**
+     * This will create a node string.
+     *
+     * @param {string} tag
+     * @param {object} attrs
+     * @param {string} children
+     * @returns {string}
+     */
+    static create(tag: string, attrs?: object, children?: string): string;
+    /**
+     * This will create a text node.
+     *
+     * @param {array} attrs
+     * @returns {string}
+     */
+    static createAttributes(attrs?: any[]): string;
+    /**
+     * This will create a text node.
+     *
+     * @param {string} text
+     * @returns {string}
+     */
+    static createText(text: string): string;
+    /**
+     * This will create a comment node.
+     *
+     * @param {string} text
+     * @returns {string}
+     */
+    static createComment(text: string): string;
+}

package/dist/types/modules/layout/render/browser-render.d.ts

@@ -6,5 +6,61 @@
  * @class
  */
 export class BrowserRender extends Render {
+    /**
+     * This will build an element or component.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {object} container
+     * @param {object} [parent] The component adding the layout.
+     * @returns {void}
+     */
+    protected buildElement(obj: object, container: object, parent?: object): void;
+    /**
+     * This will create an element.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {object} container
+     * @param {object} [parent] The component adding the layout.
+     * @returns {void}
+     */
+    protected createElement(obj: object, container: object, parent?: object): void;
+    /**
+     * This will add the element directives.
+     *
+     * @param {object} ele
+     * @param {array} directives
+     * @param {object} parent
+     * @returns {void}
+     */
+    setDirectives(ele: object, directives: any[], parent: object): void;
+    /**
+     * This will handle an attr directive.
+     *
+     * @protected
+     * @param {object} ele
+     * @param {object} attrDirective
+     * @param {object} parent
+     * @returns {void}
+     */
+    protected handleDirective(ele: object, attrDirective: object, parent: object): void;
+    /**
+     * This will cache an element ot the parent.
+     *
+     * @param {object} ele
+     * @param {object} propName
+     * @param {object} parent
+     */
+    cache(ele: object, propName: object, parent: object): void;
+    /**
+     * This will create a node.
+     *
+     * @param {object} settings
+     * @param {object} container
+     * @param {object} parent
+     * @returns {object}
+     */
+    createNode(settings: object, container: object, parent: object): object;
 }
 import { Render } from './render.js';

package/dist/types/modules/layout/render/render-controller.d.ts

@@ -9,9 +9,9 @@ export class RenderController {
     /**
      * This will check if we are in the browser.
      *
-     * @returns boolean
+     * @returns {boolean}
      */
-    static browserIsSupported(): Window & typeof globalThis;
+    static browserIsSupported(): boolean;
     /**
      * This will create a History Object based on navigation support
      *

package/dist/types/modules/layout/render/render.d.ts

@@ -7,12 +7,28 @@
  */
 export class Render {
     /**
-     * This will create a node.
+     * This will render the layout
      *
-     * @param {object} settings
+     * @param {object} obj The JSON layout.
+     * @param {object} [container] The parent receiving the layout.
+     * @param {object} [parent] The component adding the layout.
+     * @returns {*} The layout result
+     */
+    build(obj: object, container?: object, parent?: object): any;
+    /**
+     * This will create a component.
+     *
+     * @param {object} obj
      * @param {object} container
      * @param {object} parent
-     * @returns {object}
+     * @returns {void}
+     */
+    createComponent(obj: object, container: object, parent: object): void;
+    /**
+     * This will remove all the children from an element.
+     *
+     * @param {object} ele
+     * @returns {void}
      */
-    createNode(settings: object, container: object, parent: object): object;
+    removeAll(ele: object): void;
 }

package/dist/types/modules/layout/render/server-render.d.ts

@@ -6,5 +6,31 @@
  * @class
  */
 export class ServerRender extends Render {
+    /**
+   * This will build an element or component and return an HTML string.
+   *
+   * @protected
+   * @param {object} obj
+   * @param {object} [parent] The component adding the layout.
+   * @returns {*}
+   */
+    protected buildElement(obj: object, parent?: object): any;
+    /**
+     * This will create an element and return an HTML string.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {object} [parent] The component adding the layout.
+     * @returns {string} The HTML string.
+     */
+    protected createElement(obj: object, parent?: object): string;
+    /**
+     * This will create a node.
+     *
+     * @param {object} settings
+     * @param {string} childrenHtml
+     * @returns {object}
+     */
+    createNode(settings: object, childrenHtml: string): object;
 }
 import { Render } from './render.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@base-framework/base",
-	"version": "3.0.90",
+	"version": "3.0.92",
 	"description": "This is a javascript framework.",
 	"main": "/dist/base.js",
 	"scripts": {