angular-toolbox 0.9.4 → 0.9.5

package/lib/collection/array-list-event-type.enum.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The `ArrayListEventType` class the type of events on an `ArrayListEvent` object.
+ */
+export declare enum ArrayListEventType {
+    /**
+     * The type of event associated with the `ArrayList.addAll` action.
+     */
+    ADD_ALL = "addAll",
+    /**
+     * The type of event associated with the `ArrayList.addItem`, or `ArrayList.addItemAt` actions.
+     */
+    ADD = "add",
+    /**
+     * The type of event associated with the `ArrayList.removeAll` action.
+     */
+    REMOVE_ALL = "removeAll",
+    /**
+     * The type of event associated with the `ArrayList.remove`, or `ArrayList.removeAt` actions.
+     */
+    REMOVE = "remove"
+}

package/lib/collection/array-list.d.ts

@@ -0,0 +1,111 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { EventEmitter } from "@angular/core";
+import { IdentifiableComponent } from "../core";
+import { ArrayListEvent } from "./array-list.event";
+/**
+ * The `ArrayList` class uses a backing `Array` as the source of the data collection. Items in the backing
+ * `Array` can be accessed and manipulated using the methods and properties of the `ArrayList` instance.
+ * Operations on an `ArrayList` instance modify the data source.
+ *
+ * You typically use the `ArrayList` class as base class for services that persist data in the User Interface.
+ */
+export declare class ArrayList<T> extends IdentifiableComponent {
+    /**
+     * Dispatches events each time this `ArrayList` is modified.
+     */
+    readonly change: EventEmitter<ArrayListEvent<T>>;
+    /**
+     * Gets the number of items in the list.
+     */
+    get length(): number;
+    /**
+     * @private
+     * The array used as a source for the `ArrayList`.
+     */
+    protected __list__: Array<T>;
+    /**
+     * @private
+     */
+    constructor(classRef?: string | undefined);
+    /**
+     * Adds a list of items to the current `ArrayList` instance, placing them at the end of the
+     * list in the order they are passed.
+     *
+     * @param addList The list of items to add to this current `ArrayList` instance.
+     *
+     * @return A reference to this `ArrayList` instance.
+     */
+    addAll(addList: Array<T>): ArrayList<T>;
+    /**
+     * Adds the specified item to the end of the list.
+     *
+     * @param item The item to add.
+     *
+     * @return A reference to this `ArrayList` instance.
+     */
+    addItem(item: T): ArrayList<T>;
+    /**
+     * Adds the item at the specified index.
+     *
+     * @param item The item to place at the index.
+     * @param index The index at which to place the item.
+     *
+     * @return A reference to this `ArrayList` instance.
+     */
+    addItemAt(item: T, index: number): ArrayList<T>;
+    /**
+     * Gets the item at the specified index.
+     *
+     * @param index The index in the list from which to retrieve the item.
+     *
+     * @returns The item at that index, `undefined` if there is none.
+     */
+    getItemAt(index: number): T | undefined;
+    /**
+     * Returns the index of the item if it is in the list.
+     *
+     * @param item The item to find.
+     *
+     * @returns The index of the item, `-1` if the item is not in the list.
+     */
+    getItemIndex(item: T): number;
+    /**
+     * Removes all items from the list.
+     *
+     * @return A reference to this `ArrayList` instance.
+     */
+    removeAll(): ArrayList<T>;
+    /**
+     * Removes the specified item from this list.
+     *
+     * @param item Reference to the item that should be removed.
+     *
+     * @returns  `true` whether if the item was removed; `false` otherwise.
+     */
+    removeItem(item: T): boolean;
+    /**
+     * Removes the item at the specified index and returns it.
+     * Any items that were after this index are now one index earlier.
+     *
+     * @param index The index from which to remove the item.
+
+     * @returns The item that was removed.
+     */
+    removeItemAt(index: number): T | undefined;
+    /**
+     * Returns an array that is populated in the same order as this `ArrayList` instance.
+     *
+     * @returns An array that is populated in the same order as this `ArrayList` instance.
+     */
+    toArray(): Array<T>;
+    /**
+     * @private
+     */
+    private dispatchEvent;
+}

package/lib/collection/array-list.event.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { ArrayList } from "./array-list";
+import { ArrayListEventType } from "./array-list-event-type.enum";
+/**
+ * The `ArrayListEvent` class represents an event that is dispatched when the associated collection changes.
+ */
+export declare class ArrayListEvent<T> {
+    /**
+     * The type of this event.
+     */
+    readonly type: ArrayListEventType;
+    /**
+     * The reference to the `ArrayList` instance that dispatches this event.
+     */
+    readonly list: ArrayList<T>;
+    /**
+     * Represents events dispatched by the `ArrayList` class.
+     *
+     * @param type The type of the event.
+     * @param list The reference to the `ArrayList` instance that dispatches this event.
+     */
+    constructor(type: ArrayListEventType, list: ArrayList<T>);
+}

package/lib/collection/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+export * from './array-list';
+export * from './array-list.event';
+export * from './array-list-event-type.enum';

package/lib/model/service/index.d.ts

@@ -1,4 +1,4 @@
 export * from './subscription/subscription.service';
 export * from './ui';
-export * from './version/version.service';
+export * from './version';
 export * from './mock/http/http-mock.service';

package/lib/model/service/version/index.d.ts

@@ -0,0 +1,2 @@
+export * from './angular-toolbox-version.service';
+export * from './version.service';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "0.9.4",
+  "version": "0.9.5",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",

package/public-api.d.ts

@@ -6,6 +6,7 @@
  * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
  */
 export * from './lib/angular-toolbox.module';
+export * from './lib/collection';
 export * from './lib/component';
 export * from './lib/core';
 export * from './lib/directive';