@typedly/data 2.0.0 → 3.0.0

package/README.md

@@ -16,18 +16,26 @@
 
 A **TypeScript** type definitions package for [**@typescript-package/data**](https://github.com/typescript-package/data).
 
+## Features
+
+- **Adapter**: Optional data adapter to customize managing underlying data.
+- **Shape**: The default shape for data of any `T` type with conditional async.
+
 ## Table of contents
 
 - [Installation](#installation)
 - [Api](#api)
   - [Interface](#interface)
+    - [`DataAdapter`](#dataadapter)
     - [`DataConstructor`](#dataconstructor)
     - [`DataShape`](#datashape)
     - [`ValueConstructor`](#valueconstructor)
     - [`ValueShape`](#valueshape)
   - [Type](#type)
+    - [`AsyncReturn`](#asyncreturn)
     - [`DataConstructorInput`](#dataconstructorinput)
     - [`DataConstructorTuple`](#dataconstructortuple)
+    - [`IterValue`](#itervalue)
 - [Full example usage](#full-example-usage)
 - [Contributing](#contributing)
 - [Support](#support)
@@ -57,18 +65,31 @@ npm install @typedly/data --save-peer
 ```typescript
 import {
   // Interface.
+  DataAdapter,
   DataConstructor,
   DataShape,
   ValueConstructor,
   ValueShape,
   // Type.
+  AsyncReturn,
   DataConstructorInput,
   DataConstructorTuple,
+  IterValue
 } from '@typedly/data';
 ```
 
 ### Interface
 
+#### `DataAdapter`
+
+The adapter interface for data types.
+
+```typescript
+import { DataAdapter } from '@typedly/data';
+```
+
+[Source](https://github.com/typedly/data/blob/main/src/lib/interface/data-adapter.interface.ts)
+
 #### `DataConstructor`
 
 The constructor interface for data types.
@@ -193,6 +214,16 @@ import { ValueShape } from '@typedly/data';
 
 ### Type
 
+#### `AsyncReturn`
+
+The conditional return type for async methods.
+
+```typescript
+import { AsyncReturn } from '@typedly/data';
+```
+
+[Source](https://github.com/typedly/data/blob/main/src/lib/type/async-return.type.ts)
+
 #### `DataConstructorInput`
 
 The input type for data constructors, with arguments support.
@@ -213,6 +244,16 @@ import { DataConstructorTuple } from '@typedly/data';
 
 [Source](https://github.com/typedly/data/blob/main/src/lib/type/data-constructor-tuple.type.ts)
 
+#### `IterValue`
+
+The iterated value type.
+
+```typescript
+import { IterValue } from '@typedly/data';
+```
+
+[Source](https://github.com/typedly/data/blob/main/src/lib/type/iter-value.type.ts)
+
 ### Full example usage
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typedly/data",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "author": "wwwdev.io <dev@wwwdev.io>",
   "description": "A TypeScript type definitions package for @typescript-package/data.",
   "license": "MIT",
@@ -33,13 +33,13 @@
     }
   ],
   "sideEffects": false,
-  "typings": "index.d.ts",
+  "typings": "types/typedly-data.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./index.d.ts",
+      "types": "./types/typedly-data.d.ts",
       "default": "./fesm2022/typedly-data.mjs"
     }
   }

package/{index.d.ts → types/typedly-data.d.ts}

@@ -1,17 +1,66 @@
 import { DataConstructor as DataConstructor$1 } from '@typedly/constructor';
 
+/**
+ * @description The conditional return type for async methods.
+ * @export
+ * @template Async The boolean flag indicating if the return type should be a Promise.
+ * @template T The type of the value to be returned.
+ */
+type AsyncReturn<Async, T> = Async extends true ? Promise<T> : T;
+
+/**
+ * @description The type to provide data constructor with arguments.
+ * @export
+ * @template Value The value type.
+ * @template {DataShape<Value>} Instance The shape of the instance.
+ * @template {any[]} [Args=any[]] Additional Arguments passed to the instance.
+ */
+type DataConstructorTuple<Value, Instance extends DataShape<Value>, Args extends any[] = any[]> = [DataConstructor<Value, Instance, Args>, ...Args];
+
+/**
+ * @description The input type for data constructors, with arguments support.
+ * @export
+ * @template Value The value type.
+ * @template {DataShape<Value>} Instance The data instance type.
+ * @template {any[]} [Args=any[]] The arguments to pass to instance.
+ */
+type DataConstructorInput<Value, Instance extends DataShape<Value>, Args extends any[] = any[]> = DataConstructor<Value, Instance, Args> | DataConstructorTuple<Value, Instance, Args>;
+
+/**
+ * @description The iterated value type.
+ * @export
+ * @template T The type of iterated value constrained by the `Iterable` type.
+ */
+type IterValue<T> = T extends Iterable<infer U> ? U : T;
+
 /**
  * @description The shape of a `Data` type.
  * @export
  * @interface DataShape
- * @template Value The value type.
+ * @template T The value type.
+ * @template {boolean} [Async=false] The `Promise` return type for methods.
  */
-interface DataShape<Value> {
-    get value(): Value;
-    clear(): this;
-    destroy(): this;
+interface DataShape<T, Async extends boolean = false> {
+    value: T;
+    clear(): AsyncReturn<Async, this>;
+    destroy(): AsyncReturn<Async, this>;
     lock(): this;
-    set(value: Value): this;
+    set(value: T): AsyncReturn<Async, this>;
+    [Symbol.toStringTag]?: string;
+    [Symbol.iterator]?(): IterableIterator<IterValue<T>>;
+    [Symbol.asyncIterator]?(): AsyncIterableIterator<IterValue<T>>;
+}
+
+/**
+ * @description The adapter interface for data types.
+ * @export
+ * @interface DataAdapter
+ * @template T The type of the data value.
+ * @template {boolean} [R=false] The type of the return values for methods.
+ * @extends {DataShape<T, R>}
+ */
+interface DataAdapter<T, R extends boolean = false> extends DataShape<T, R> {
+    version?: string;
 }
 
 /**
@@ -49,22 +98,4 @@ interface ValueShape<Type> {
 interface ValueConstructor<Value, Instance extends ValueShape<Value>, Args extends readonly any[] = any[]> extends DataConstructor$1<Value, ValueShape<Value>, Instance, [...Args]> {
 }
 
-/**
- * @description The type to provide data constructor with arguments.
- * @export
- * @template Value The value type.
- * @template {DataShape<Value>} Instance The shape of the instance.
- * @template {any[]} [Args=any[]] Additional Arguments passed to the instance.
- */
-type DataConstructorTuple<Value, Instance extends DataShape<Value>, Args extends any[] = any[]> = [DataConstructor<Value, Instance, Args>, ...Args];
-
-/**
- * @description The input type for data constructors, with arguments support.
- * @export
- * @template Value The value type.
- * @template {DataShape<Value>} Instance The data instance type.
- * @template {any[]} [Args=any[]] The arguments to pass to instance.
- */
-type DataConstructorInput<Value, Instance extends DataShape<Value>, Args extends any[] = any[]> = DataConstructor<Value, Instance, Args> | DataConstructorTuple<Value, Instance, Args>;
-
-export type { DataConstructor, DataConstructorInput, DataConstructorTuple, DataShape, ValueConstructor, ValueShape };
+export type { AsyncReturn, DataAdapter, DataConstructor, DataConstructorInput, DataConstructorTuple, DataShape, IterValue, ValueConstructor, ValueShape };