@typedly/collection 4.0.0 → 6.0.0

package/README.md

@@ -1,16 +1,26 @@
 <a href="https://github.com/typescript-package">
   <img
     src="https://avatars.githubusercontent.com/u/189665258?s=150&u=712e292bae048947d1f7d2020d7d38875c40e63a&v=4"
-    title="@typedly/collection - A TypeScript type definitions package for data collection."
+    title="@typedly/collection - A TypeScript type definitions package for data collections with customizable storage."
   />
 </a>
 
 ## @typedly/collection
 
 <!-- npm badge -->
-[![npm version][typedly-npm-badge-svg]][typedly-npm-badge]
-[![GitHub issues][typedly-badge-issues]][typedly-issues]
-[![GitHub license][typedly-badge-license]][typedly-license]
+[![npm version][package-npm-badge-svg]][package-npm-badge]
+[![GitHub issues][package-badge-issues]][package-issues]
+[![GitHub license][package-badge-license]][package-license]
+
+<!-- GitHub badges -->
+[![GitHub issues][package-badge-issues]][package-issues]
+[![GitHub forks][package-badge-forks]][package-forks]
+[![GitHub stars][package-badge-stars]][package-stars]
+[![GitHub license][package-badge-license]][package-license]
+
+<!-- Sponsors -->
+[![GitHub Sponsors][github-badge-sponsor]][github-sponsor-link]
+[![Patreon Sponsors][patreon-badge]][patreon-link]
 
 A **TypeScript** type definitions package for data collections with customizable storage.
 
@@ -25,14 +35,20 @@ A **TypeScript** type definitions package for data collections with customizable
 
 ## Table of contents
 
+- [Related packages](#related-packages)
 - [Installation](#installation)
 - [Api](#api)
-  - Interface
-    - [`CollectionAdapter`](#collectionadapter)
+  - [Adapter](#adapter)
     - [`CollectionAdapterConstructor`](#collectionadapterconstructor)
-    - [`CollectionShape`](#collectionshape)
-  - Type
+    - [`CollectionAdapter`](#collectionadapter)
+  - [Inference](#inference)
+    - [`InferCollectionType`](#infercollectiontype)
+    - [`InferElementFromSettings`](#inferelementfromsettings)
+    - [`InferElement`](#inferelement)
+  - [Main](#main)
     - [`CollectionConstructor`](#collectionconstructor)
+    - [`CollectionSettings`](#collectionsettings)
+    - [`CollectionShape`](#collectionshape)
 - [Contributing](#contributing)
 - [Support](#support)
 - [Code of Conduct](#code-of-conduct)
@@ -40,6 +56,25 @@ A **TypeScript** type definitions package for data collections with customizable
   - [Commit](#commit)
   - [Versioning](#versioning)
 - [License](#license)
+- [Packages](#packages)
+
+## Related packages
+
+### Peer dependencies
+
+- **[@typedly/adaptable-data](https://github.com/typedly/adaptable-data)**: A **TypeScript** type definitions package for configurable, composable, trait-driven adaptable data models with adapter support.
+- **[@typedly/configurable-data](https://github.com/typedly/configurable-data)**: A **TypeScript** type definitions package for configurable, composable, trait-driven data models.
+- **[@typedly/data-traits](https://github.com/typedly/data-traits)**: A **TypeScript** type definitions package for configurable data traits, providing various kinds of configurable data interfaces.
+- **[@typedly/data](https://github.com/typedly/data)**: A **TypeScript** type definitions for [`@typescript-package/data`](https://github.com/typedly/data).
+
+### General
+
+- **[@typedly/adaptable-data](https://github.com/typedly/adaptable-data)**: A **TypeScript** type definitions for data adapter.
+- **[@typedly/adaptable-collection](https://github.com/typedly/adaptable-collection)**: A **TypeScript** type definitions package for adaptable collections with configuration and adapter support.
+- **[@typedly/configurable-collection](https://github.com/typedly/configurable-collection)**: A **TypeScript** type definitions package for configurable collections with configuration.
+- **[@typedly/collection](https://github.com/typedly/collection)**: A **TypeScript** type definitions package for data collections with customizable storage.
+- **[@typescript-package/data](https://github.com/typescript-package/data)**: A lightweight **TypeScript** library for basic data management.
+- **[@typescript-package/collection](https://github.com/typescript-package/collection)**: A lightweight **TypeScript** library for data collection.
 
 ## Installation
 
@@ -51,17 +86,28 @@ npm install @typedly/collection --save-peer
 
 ```typescript
 import {
-  // Interface.
+  // Adapter.
   CollectionAdapter,
+
+  // Constructor.
   CollectionAdapterConstructor,
+  CollectionConstructor,
+
+  // Inference.
+  InferCollectionType,
+  InferElementFromSettings,
+  InferElement,
+
+  // Interface.
+  CollectionSettings,
   CollectionShape,
-  // Type.
-  CollectionConstructor
 } from '@typedly/collection';
 ```
 
 ### Interface
 
+### Adapter
+
 ### `CollectionAdapter`
 
 The adapter interface for collections.
@@ -75,223 +121,61 @@ import { CollectionAdapter } from '@typedly/collection';
 The interface of adapter constructor.
 
 ```typescript
-import { CollectionAdapter, CollectionAdapterConstructor } from '@typedly/collection';
-import { AsyncReturn } from '@typedly/data';
-/**
- * Example class with fake async returned types.
- */
-export class ExampleCollectionAdapter<
-  E,
-  T,
-  R extends boolean = false, 
-> implements CollectionAdapter<E, T, R> {
-  public get async(): R {
-    return this.#async;
-  }
-  public get size(): number {
-    return this.#items.length;
-  }
-  public get  value(): T {
-    // Implementation depends on specific requirements.
-    return {} as T;
-  }
-  version = "1.0.0";
-  #async: R;
-  #items: E[] = [];
-  constructor({async}: {async: R}, ...elements: E[]) {
-    this.#async = async;
-    this.#items.push(...elements);
-  }
-  public add(...element: E[]): AsyncReturn<R, this> {
-    this.#items.push(...element);
-    return this as AsyncReturn<R, this>;
-  }
-  public clear(): AsyncReturn<R, this> {
-    this.#items = [];
-    return this as AsyncReturn<R, this>;
-  }
-  public delete(...element: E[]): AsyncReturn<R, boolean> {
-    const index = this.#items.indexOf(element[0]);
-    if (index !== -1) {
-      this.#items.splice(index, 1);
-      return true as AsyncReturn<R, boolean>;
-    }
-    return false as AsyncReturn<R, boolean>;
-  }
-  public destroy(): AsyncReturn<R, this> {
-    this.#items = [];
-    return this as AsyncReturn<R, this>;
-  }
-  public forEach(callbackfn: (element: E, element2: E, collection: CollectionAdapter<E, T, R>) => void, thisArg?: any): AsyncReturn<R, this> {
-    this.#items.forEach((value: E) => {
-      callbackfn.call(thisArg, value, value, this);
-    });
-    return this as AsyncReturn<R, this>;
-  }
-  public getValue(): AsyncReturn<R, T> {
-    // Implementation depends on specific requirements.
-    return {} as AsyncReturn<R, T>;
-  }
-  public has(element: E): AsyncReturn<R, boolean> {
-    return this.#items.includes(element) as AsyncReturn<R, boolean>;
-  }
-  public lock(): this {
-    // Implementation depends on specific requirements.
-    return this;
-  }
-  public setValue(value: T): AsyncReturn<R, this> {
-    // Implementation depends on specific requirements.
-    return this as AsyncReturn<R, this>;
-  }
-  public unlock(): AsyncReturn<R, this> {
-    // Implementation depends on specific requirements.
-    return this as AsyncReturn<R, this>;
-  }
-}
-
-// Create factory function for creating adapter instances.
-function createAdapter<
-  E,
-  T,
-  R extends boolean = false,
-  A extends CollectionAdapter<E, T, R> = CollectionAdapter<E, T, R>
->(
-  AdapterCtor: CollectionAdapterConstructor<E, T, R, { async: R }, A>,
-  async: R,
-  ...elements: E[]
-): A {
-  return new AdapterCtor({ async }, ...elements);
-}
-
-// ExampleCollectionAdapter<number, unknown, false>
-const adapter1 = createAdapter(ExampleCollectionAdapter, false, 1, 2, 3);
-// ExampleCollectionAdapter<string, unknown, true>
-const adapter2 = createAdapter(ExampleCollectionAdapter, true, 'a', 'b', 'c');
+import { CollectionAdapterConstructor } from '@typedly/collection';
+```
+
+### Inference
+
+### `InferCollectionType`
+
+Infer the collection type from the collection settings or adapter.
+
+```typescript
+import { InferCollectionType } from '@typedly/collection';
+```
+
+### `InferElementFromSettings`
+
+Type to infer the element type from collection settings or adapter.
 
+```typescript
+import { InferElementFromSettings } from '@typedly/collection';
 ```
 
-### `CollectionShape`
+### `InferElement`
 
-Represents a collection of elements.
+Type to infer the element type from collection settings or adapter, with special handling for common collection types like Set, Array, and Map.
 
 ```typescript
-import { CollectionShape, IterValue } from '@typedly/collection';
-
-// Example class implementing CollectionShape.
-export class AnyCollection<
-  E,
-  T = Set<E>
-> implements CollectionShape<E, T, false> {
-  async = false as false;
-
-  // Data shape method.
-  get value(): T {
-    // Implementation depends on specific requirements.
-    return this.#items;
-  }
-
-  // Example internal storage.
-  #items: T;
-
-  constructor(
-    { async, value }: { async: false, value?: T },
-    type?: new (...args: any[]) => T,
-    ...elements: E[]
-  ) {
-    this.async = async;
-    this.#items = type ? new type() : value ? value : {} as T;
-    elements.forEach(element => (this.#items as any).add(element));
-  }
-
-  public clear(): this {
-    // Implementation depends on specific requirements.
-    return this;
-  }
-  public destroy(): this {
-    // Implementation depends on specific requirements.
-    return this;
-  }
-  public lock(): this {
-    // Implementation depends on specific requirements.
-    return this;
-  }
-  public getValue(): T {
-    // Implementation depends on specific requirements.
-    return this.#items;
-  }
-  public setValue(value: T): this {
-    // Implementation depends on specific requirements.
-    this.#items = value;
-    return this;
-  }
-  public unlock(): this {
-    // Implementation depends on specific requirements.
-    return this;
-  }
-
-
-  add(element: E): this {
-    (this.#items as any).add(element);
-    return this;
-  }
-
-  delete(element: E): boolean {
-    return (this.#items as any).delete(element);
-  }
-
-  forEach(callbackfn: (element: E, element2: E, collection: CollectionShape<E, T, false>) => void, thisArg?: any): this {
-    (this.#items as any).forEach((value: E) => {
-      callbackfn.call(thisArg, value, value, this);
-    });
-    return this;
-  }
-
-  has(element: E): boolean {
-    return (this.#items as any).has(element);
-  }
-
-  get size(): number {
-    return (this.#items as any).size;
-  }
-
-  get [Symbol.toStringTag](): string {
-    return 'MyCollection';
-  }
-
-  [Symbol.iterator](): IterableIterator<IterValue<T>> {
-    return (this.#items as any).values();
-  }
-}
-
-const obj1 = {age: 27};
-const obj2 = {age: 37};
-const obj3 = {age: 47};
-const anyCollection1 = new AnyCollection<{age: number}, Set<{age: number}>>(
-  { async: false, value: new Set([{age: 27}, {age: 37}, {age: 47}]) }
-  )
-  .add(obj1)
-  .add(obj2)
-  .add(obj3);
-
-console.log(`anyCollection1:`, anyCollection1.value);
-
-const anyCollection2 = new AnyCollection<{age: number}, Set<{age: number}>>(
-  { async: false }, Set)
-  .add(obj1)
-  .add(obj2)
-  .add(obj3);
-
-console.log(`anyCollection2:`, anyCollection2.value);
+import { InferElement } from '@typedly/collection';
 ```
 
-### Type
+### Main
 
 ### `CollectionConstructor`
 
+The constructor type for `CollectionShape`.
+
 ```typescript
 import { CollectionConstructor } from '@typedly/collection';
 ```
 
+### `CollectionSettings`
+
+Represents the settings for a collection.
+
+```typescript
+import { CollectionSettings } from '@typedly/collection';
+```
+
+### `CollectionShape`
+
+The `CollectionShape` interface defines the structure and behavior of a collection data structure, which can be implemented by various types of collections such as sets, arrays, or maps.
+
+```typescript
+import { CollectionShape } from '@typedly/collection';
+```
+
 ## Contributing
 
 Your contributions are valued! If you'd like to contribute, please feel free to submit a pull request. Help is always appreciated.
@@ -302,20 +186,23 @@ If you find this package useful and would like to support its and general develo
 
 Support via:
 
-- [Stripe](https://donate.stripe.com/dR614hfDZcJE3wAcMM)
-- ~~[Revolut](https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29)~~
-- [GitHub](https://github.com/sponsors/angular-package/sponsorships?sponsor=sciborrudnicki&tier_id=83618)
+- [4Fund](https://4fund.com/bruubs)
 - [DonorBox](https://donorbox.org/become-a-sponsor-to-the-angular-package?default_interval=o)
+- [GitHub](https://github.com/sponsors/angular-package/sponsorships?sponsor=sciborrudnicki&tier_id=83618)
+- [Ko-fi](https://ko-fi.com/sterblack)
+- [OpenCollective](https://opencollective.com/sterblack)
 - [Patreon](https://www.patreon.com/checkout/angularpackage?rid=0&fan_landing=true&view_as=public)
-- [4Fund](https://4fund.com/bruubs)
+- [PayPal](https://paypal.me/sterblack)
+- [Stripe](https://donate.stripe.com/dR614hfDZcJE3wAcMM)
+- ~~[Revolut](https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29)~~
 
 or via Trust Wallet
 
-- [XLM](https://link.trustwallet.com/send?coin=148&address=GAFFFB7H3LG42O6JA63FJDRK4PP4JCNEOPHLGLLFH625X2KFYQ4UYVM4)
-- [USDT (BEP20)](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94&token_id=0x55d398326f99059fF775485246999027B3197955)
-- [ETH](https://link.trustwallet.com/send?coin=60&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94)
-- [BTC](https://link.trustwallet.com/send?coin=0&address=bc1qnf709336tfl57ta5mfkf4t9fndhx7agxvv9svn)
 - [BNB](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94)
+- [BTC](https://link.trustwallet.com/send?coin=0&address=bc1qnf709336tfl57ta5mfkf4t9fndhx7agxvv9svn)
+- [ETH](https://link.trustwallet.com/send?coin=60&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94)
+- [USDT (BEP20)](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94&token_id=0x55d398326f99059fF775485246999027B3197955)
+- [XLM](https://link.trustwallet.com/send?coin=148&address=GAFFFB7H3LG42O6JA63FJDRK4PP4JCNEOPHLGLLFH625X2KFYQ4UYVM4)
 
 ## Code of Conduct
 
@@ -352,7 +239,7 @@ How do I know when to release 1.0.0?
 
 ## License
 
-MIT © typedly ([license][typedly-license])
+MIT © typedly ([license][package-license])
 
 ## Packages
 
@@ -369,23 +256,29 @@ MIT © typedly ([license][typedly-license])
 - **[@typedly/regexp](https://github.com/typedly/regexp)**: A **TypeScript** type definitions package for `RegExp`.
 - **[@typedly/symbol](https://github.com/typedly/symbol)**: A **TypeScript** type definitions package for various symbols.
 
+<!-- Funding -->
+[github-badge-sponsor]: https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=https://github.com/sponsors/angular-package
+[github-sponsor-link]: https://github.com/sponsors/angular-package
+[patreon-badge]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dangularpackage%26type%3Dpatrons&style=flat
+[patreon-link]: https://www.patreon.com/join/angularpackage/checkout?fan_landing=true&rid=0
+
 <!-- This package: typedly  -->
   <!-- GitHub: badges -->
-  [typedly-badge-issues]: https://img.shields.io/github/issues/typedly/collection
-  [typedly-badge-forks]: https://img.shields.io/github/forks/typedly/collection
-  [typedly-badge-stars]: https://img.shields.io/github/stars/typedly/collection
-  [typedly-badge-license]: https://img.shields.io/github/license/typedly/collection
+  [package-badge-issues]: https://img.shields.io/github/issues/typedly/collection
+  [package-badge-forks]: https://img.shields.io/github/forks/typedly/collection
+  [package-badge-stars]: https://img.shields.io/github/stars/typedly/collection
+  [package-badge-license]: https://img.shields.io/github/license/typedly/collection
   <!-- GitHub: badges links -->
-  [typedly-issues]: https://github.com/typedly/collection/issues
-  [typedly-forks]: https://github.com/typedly/collection/network
-  [typedly-license]: https://github.com/typedly/collection/blob/master/LICENSE
-  [typedly-stars]: https://github.com/typedly/collection/stargazers
+  [package-issues]: https://github.com/typedly/collection/issues
+  [package-forks]: https://github.com/typedly/collection/network
+  [package-license]: https://github.com/typedly/collection/blob/master/LICENSE
+  [package-stars]: https://github.com/typedly/collection/stargazers
 <!-- This package -->
 
 <!-- Package: typedly -->
   <!-- npm -->
-  [typedly-npm-badge-svg]: https://badge.fury.io/js/@typedly%2Fcollection.svg
-  [typedly-npm-badge]: https://badge.fury.io/js/@typedly%2Fcollection
+  [package-npm-badge-svg]: https://badge.fury.io/js/@typedly%2Fcollection.svg
+  [package-npm-badge]: https://badge.fury.io/js/@typedly%2Fcollection
 
 <!-- GIT -->
 [git-semver]: http://semver.org/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typedly/collection",
-  "version": "4.0.0",
+  "version": "6.0.0",
   "author": "wwwdev.io <dev@wwwdev.io>",
   "description": "A TypeScript type definitions package for data collections with customizable storage.",
   "license": "MIT",
@@ -9,7 +9,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@typedly/data": "^4.0.0"
+    "@typedly/adaptable-data": "^4.1.0"
   },
   "repository": {
     "type": "git",
@@ -29,7 +29,27 @@
       "url": "https://donate.stripe.com/dR614hfDZcJE3wAcMM"
     },
     {
-      "type": "revolut",
+      "type": "Donorbox",
+      "url": "https://donorbox.org/become-a-sponsor-to-the-angular-package?default_interval=o"
+    },
+    {
+      "type": "Open Collective",
+      "url": "https://opencollective.com/sterblack"
+    },
+    {
+      "type": "Ko-fi",
+      "url": "https://ko-fi.com/sterblack"
+    },
+    {
+      "type": "4Fund",
+      "url": "https://4fund.com/bruubs"
+    },
+    {
+      "type": "paypal",
+      "url": "https://paypal.me/sterblack"
+    },
+    {
+      "type": "individual",
       "url": "https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29"
     }
   ],

package/types/typedly-collection.d.ts

@@ -1,103 +1,199 @@
-import { DataShape, AsyncReturn } from '@typedly/data';
+import { IterableElement, DataShape, AsyncReturn, DataSettings, InferValue } from '@typedly/data';
+import { Collection } from '@typedly/data-traits';
 import { ConstrainedConstructor } from '@typedly/constructor';
 
 /**
- * @description Represents a collection of elements.
+ * @description The `CollectionShape` interface defines the structure and behavior of a collection data structure, which can be implemented by various types of collections such as sets, arrays, or maps.
+ * It extends the `DataShape` interface, allowing it to inherit common data-related properties and methods while also introducing collection-specific functionalities.
  * @export
- * @interface Collection
- * @template E The type of elements in the collection.
- * @template [T=any] The type of the value in the collection, data of elements.
- * @template {boolean} [R=false] The `boolean` type to determine async methods.
- * @extends {DataShape<T, R>}
+ * @interface CollectionShape
+ * @template {Iterable<E>} T The iterable collection type.
+ * @template [E=IterableElement<T>] The type of elements in the collection inferred from the `T` if possible.
+ * @template {boolean} [R=false] The async behavior flag.
+ * @extends {DataShape<T, R>} The data-related functionalities defined in `DataShape`.
+ * @extends {CollectionTrait<E, R>} The base collection functionalities defined in `CollectionTrait`.
  */
-interface CollectionShape<E, T = any, R extends boolean = false> extends DataShape<T, R> {
-    /**
-     * @description Indicates whether the collection operates in asynchronous mode.
-     * @readonly
-     * @type {R}
-     */
-    readonly async: R;
-    /**
-     * @description The number of items in the collection.
-     * @returns {number}
-     */
-    readonly size: number;
-    /**
-     * @description Adds elements to the collection.
-     * @param {...E[]} element Element of type `T` to add.
-     * @returns {AsyncReturn<R, this>} The collection instance `this`, or in `Promise`.
-     */
-    add(...element: E[]): AsyncReturn<R, this>;
-    /**
-     * @description Deletes elements from the collection.
-     * @param {...E[]} element Element of type `T` to delete.
-     * @returns {AsyncReturn<R, boolean>} `true` if the element was successfully deleted, otherwise `false`.
-     */
-    delete(...element: E[]): AsyncReturn<R, boolean>;
+interface CollectionShape<T extends Iterable<E>, E = IterableElement<T>, R extends boolean = false> extends DataShape<T, R>, Collection<E, R> {
     /**
      * @description Executes a provided function once for each collection element.
-     * @param {(value: E, value2: E, collection: CollectionShape<E, T, R>) => void} callbackfn Function to execute for each element.
-     * @param {AsyncReturn<R, this>} [thisArg] Value to use as `this` when executing `callbackfn`.
+     * @param {(element: E, collection: this) => void} callbackfn Function to execute for each element.
+     * @param {?*} [thisArg] Value to use as `this` when executing `callbackfn`.
+     * @returns {AsyncReturn<R, this>}
      */
-    forEach(callbackfn: (element: E, element2: E, collection: CollectionShape<E, T, R>) => void, thisArg?: any): AsyncReturn<R, this>;
+    forEach(callbackfn: (element: E, collection: this) => void, thisArg?: any): AsyncReturn<R, this>;
     /**
-     * @description Checks if every item exists in the collection.
-     * @param {...E[]} element Element of type `T` to check for existence.
-     * @returns {AsyncReturn<R, boolean>} `true` if the element exists, otherwise `false`.
+     * @description Returns an iterable of the values in the collection.
+     * The type of the values is determined by the generic type `T`, which represents the iterable collection type.
+     * If `T` is not provided, it defaults to `Iterable<unknown>`, and the values will be of type `unknown`.
+     * @returns {IterableIterator<IterableElement<T>>}
      */
-    has(...element: E[]): AsyncReturn<R, boolean>;
+    [Symbol.iterator](): IterableIterator<IterableElement<T>>;
 }
 
 /**
  * @description The adapter interface for collections.
  * @export
  * @interface CollectionAdapter
- * @template E  The type of elements in the collection.
- * @template T The type of the value in the collection, data of elements.
- * @template R The `boolean` type to determine async methods.
- * @extends {CollectionShape<E, T>}
+ * @template {Iterable<E>} T The type of the collection.
+ * @template [E=IterableElement<T>] The type of elements in the collection.
+ * @template {boolean} [R=false] The async behavior flag.
+ * @extends {CollectionShape<T, E, R>} The collection shape interface.
+ * @since
+ * @version
+ * @author Ścibor Rudnicki <sciborrudnicki@wvvw.dev>
+ * @see {@link CollectionShape}
+ * @see {@link IterableElement}
+ * @example
+ * ```ts
+ * import { CollectionAdapter } from "@typedly/collection";
+ *
+ * class MyCollectionAdapter implements CollectionAdapter<string[], string, false> {
+ *   readonly version = "1.0.0";
+ *  // Implement the methods defined in CollectionShape...
+ * }
  */
-interface CollectionAdapter<E, T, R extends boolean = false> extends CollectionShape<E, T, R> {
-    version: string;
+interface CollectionAdapter<T extends Iterable<E>, E = IterableElement<T>, R extends boolean = false> extends CollectionShape<T, E, R> {
+    readonly version: string;
 }
 
 /**
  * @description The interface of adapter constructor.
  * @export
  * @interface CollectionAdapterConstructor
- * @template E Elements type.
+ * @template E Elements type of `T`.
+ * @template T Value type under which the elements are stored.
  * @template {boolean} [R=false] The boolean type indicates the async methods.
- * @template {C} [C={async?: R, value?: T}] The configuration object type for the constructor, which has an `async` property of type `R` and an optional `value` property of type `T`.
- * @template {CollectionAdapter<E, T, R>} [A=CollectionAdapter<E, T, R>]
+ * @template {CollectionAdapter<E, T, R>} [A=CollectionAdapter<E, T, R>] The adapter type.
  */
-interface CollectionAdapterConstructor<E, T, R extends boolean = false, C extends {
-    async?: R;
-    value?: T;
-} = {
-    async?: R;
-    value?: T;
-}, A extends CollectionAdapter<E, T, R> = CollectionAdapter<E, T, R>> {
-    new ({ async, value }: C, ...elements: E[]): A;
+interface CollectionAdapterConstructor<A extends CollectionAdapter<T, E, R>, E, T extends Iterable<E>, R extends boolean> {
+    new (...elements: E[]): A;
 }
 
 /**
- * @description The constructor type for CollectionShape.
+ * @description The constructor type for `CollectionShape`.
  * @export
- * @template E The type of the elements in the collection.
- * @template T The type of the value in the collection, data of elements.
+ * @interface CollectionConstructor
+ * @template {CollectionShape<T, E, R>} S The collection shape type.
+ * @template {Iterable<E>} [T=S extends CollectionShape<infer U, any, any> ? U : unknown] The type of the elements in the collection, inferred from the collection shape or defaults to `unknown` if not specified.
+ * @template [E=S extends CollectionShape<any, infer U, any> ? U : unknown] The element type inferred from the collection shape or defaults to `unknown` if not specified.
+ * @template {boolean} [R=S extends CollectionShape<any, any, infer U> ? U : false] The async behavior flag inferred from the collection shape or defaults to `false` if not specified.
+ * @extends {ConstrainedConstructor<CollectionShape<T, E, R>, S, E[]>}
+ */
+interface CollectionConstructor<S extends CollectionShape<T, E, R>, T extends Iterable<E> = S extends CollectionShape<infer U, any, any> ? U : unknown, E = S extends CollectionShape<any, infer U, any> ? U : unknown, R extends boolean = S extends CollectionShape<any, any, infer U> ? U : false> extends ConstrainedConstructor<CollectionShape<T, E, R>, S, E[]> {
+}
+
+/**
+ * @description Represents the settings for a collection.
+ * @export
+ * @interface CollectionSettings
+ * @template {Iterable<E>} T The iterable type of the value in the collection.
+ * @template [E=IterableElement<T>] The type of the elements in the collection inferred from the `T` if possible.
  * @template {boolean} [R=false] The `boolean` type to determine async methods.
- * @template {G} [G={async?: R, value?: T}] The configuration object type for the constructor, which has an `async` property of type `R` and an optional `value` property of type `T`.
- * @template {CollectionShape<E, T, R>} [C=CollectionShape<E, T, R>]
+ * @extends {DataSettings<R>} The base settings for data.
  */
-type CollectionConstructor<E, T, R extends boolean = false, G extends {
-    async?: R;
-    value?: T;
-} = {
-    async?: R;
+interface CollectionSettings<T extends Iterable<E>, E = IterableElement<T>, R extends boolean = false> extends DataSettings<R> {
+    /**
+     * @description The initial value of the collection. The type of the value is determined by the generic type `T`. If not provided, it defaults to `undefined`.
+     * @type {?T}
+     */
     value?: T;
-}, C extends CollectionShape<E, T, R> = CollectionShape<E, T, R>> = ConstrainedConstructor<CollectionShape<E, T, R>, C, [
-    G,
-    ...E[]
-]>;
+    /**
+     * @description The maximum number of items the collection can hold. If not provided, it defaults to `undefined`, indicating no limit.
+     * @default undefined
+     * @type {?number}
+     */
+    maxSize?: number;
+    /**
+     * @description The initial capacity of the collection. This is a hint for optimization and does not limit the number of items. If not provided, it defaults to `undefined`.
+     * @default undefined
+     * @type {?number}
+     */
+    capacity?: number;
+    /**
+     * @description Indicates whether the collection should automatically sort its elements. If `true`, the collection will maintain its elements in sorted order based on the provided `comparator` function. If not provided, it defaults to `false`.
+     * @default false
+     * @type {?boolean}
+     */
+    autoSort?: boolean;
+    /**
+     * @description A function that defines the sort order of the collection's elements. It should return a negative number if `a` should come before `b`, a positive number if `a` should come after `b`, or `0` if they are considered equal. If not provided, it defaults to `undefined`.
+     * @type {?(a: E, b: E) => number}
+     */
+    comparator?: (a: E, b: E) => number;
+    /**
+     * @description Indicates whether the collection should enforce uniqueness of its elements. If `true`, the collection will not allow duplicate elements. If not provided, it defaults to `false`.
+     * @default false
+     * @type {?boolean}
+     */
+    unique?: boolean;
+    /**
+     * @description Indicates whether the collection should be immutable. If `true`, the collection will not allow modifications after it has been created. If not provided, it defaults to `false`.
+     * @default false
+     * @type {?boolean}
+     */
+    immutable?: boolean;
+    /**
+     * @description Indicates whether the collection should log its actions. If `true`, the collection will log actions such as additions, removals, and updates. If not provided, it defaults to `false`.
+     * @default false
+     * @type {?boolean}
+     */
+    log?: boolean;
+    /**
+     * @description Indicates whether the collection should be lazily initialized. If `true`, the collection will delay initialization until it is first accessed. If not provided, it defaults to `false`.
+     * @default false
+     * @type {?boolean}
+     */
+    lazy?: boolean;
+    /**
+     * @description The maximum time, in milliseconds, that the collection will wait for an operation to complete before timing out. If not provided, it defaults to `undefined`, indicating no timeout.
+     * @type {?number}
+     */
+    timeout?: number;
+    /**
+     * @description The number of items to prefetch in the collection. If not provided, it defaults to `undefined`, indicating no prefetching.
+     * @type {?number}
+     */
+    prefetch?: number;
+    /**
+     * @description Indicates whether the collection should be locked. If `true`, the collection will not allow any modifications after it has been created. If not provided, it defaults to `false`.
+     * @default false
+     * @type {?boolean}
+     */
+    locked?: boolean;
+    /**
+     * @description The name of the collection. If not provided, it defaults to `undefined`.
+     * @type {?string}
+     */
+    name?: string;
+    /**
+     * @description Function to validate elements before adding
+     */
+    validator?: (element: E) => boolean;
+}
+
+/**
+ * @description Infer the collection type from the collection settings or adapter.
+ * @export
+ * @template C The collection settings type to infer the collection type from.
+ * @template [I=undefined]  The collection shape type to infer the collection type from if it cannot be inferred from the collection settings.
+ * @template [F=unknown] The fallback type to use if the collection type cannot be inferred from the collection settings or the adapter, defaults to `unknown`.
+ */
+type InferCollectionType<C, I = undefined, F = unknown> = C extends CollectionSettings<infer T, any, any> ? T : InferValue<I, F>;
+
+/**
+ * @description Type to infer the element type from collection settings or adapter.
+ * @export
+ * @template C The collections settings type to infer the element type from.
+ * @template [F=unknown] The fallback type if neither settings nor adapter provide an element type.
+ */
+type InferElementFromSettings<C, F = unknown> = C extends CollectionSettings<infer T, infer E, any> ? T extends Iterable<infer U> ? U : E : C extends CollectionSettings<any, infer E, any> ? E : F;
+
+/**
+ * @description Type to infer the element type from collection settings or adapter, with special handling for common collection types like Set, Array, and Map.
+ * @export
+ * @template C The collections configuration type to infer the element type from.
+ * @template [F=unknown] The fallback type to use if the element type cannot be inferred from either the collection settings or the adapter.
+ */
+type InferElement<C, I = undefined, F = unknown> = InferElementFromSettings<C, F> extends F ? I extends CollectionShape<any, infer E, any> ? E : F : InferElementFromSettings<C, F>;
 
-export type { CollectionAdapter, CollectionAdapterConstructor, CollectionConstructor, CollectionShape };
+export type { CollectionAdapter, CollectionAdapterConstructor, CollectionConstructor, CollectionSettings, CollectionShape, InferCollectionType, InferElement, InferElementFromSettings };