fixed typos

Author: bennobuilder

packages/core/src/collection/collection.ts

@@ -32,7 +32,7 @@ export class Collection<
   public agileInstance: () => Agile;
 
   public config: CollectionConfigInterface;
-  private initialConfig: CreateCollectionConfigInterface;
+  private initialConfig: CreateCollectionConfigImpl;
 
   // Key/Name identifier of the Collection
   public _key?: CollectionKey;
@@ -74,7 +74,10 @@ export class Collection<
    * @param agileInstance - Instance of Agile the Collection belongs to.
    * @param config - Configuration object
    */
-  constructor(agileInstance: Agile, config: CollectionConfig<DataType> = {}) {
+  constructor(
+    agileInstance: Agile,
+    config: CreateCollectionConfig<DataType> = {}
+  ) {
     this.agileInstance = () => agileInstance;
     let _config = typeof config === 'function' ? config(this) : config;
     _config = defineConfig(_config, {
@@ -1521,7 +1524,9 @@ export type DefaultItem = Record<string, any>; // same as { [key: string]: any }
 export type CollectionKey = string | number;
 export type ItemKey = string | number;
 
-export interface CreateCollectionConfigInterface<DataType = DefaultItem> {
+export interface CreateCollectionConfigImpl<
+  DataType extends DefaultItem = DefaultItem
+> {
   /**
    * Initial Groups of the Collection.
    * @default []
@@ -1557,11 +1562,13 @@ export interface CreateCollectionConfigInterface<DataType = DefaultItem> {
   initialData?: Array<DataType>;
 }
 
-export type CollectionConfig<DataType extends Object = DefaultItem> =
-  | CreateCollectionConfigInterface<DataType>
+export type CreateCollectionConfig<
+  DataType extends DefaultItem = DefaultItem
+> =
+  | CreateCollectionConfigImpl<DataType>
   | ((
       collection: Collection<DataType>
-    ) => CreateCollectionConfigInterface<DataType>);
+    ) => CreateCollectionConfigImpl<DataType>);
 
 export interface CollectionConfigInterface {
   /**

packages/core/src/collection/index.ts

@@ -1,6 +1,6 @@
 import { Agile } from '../agile';
 import { shared } from '../shared';
-import { Collection, CollectionConfig, DefaultItem } from './collection';
+import { Collection, CreateCollectionConfig, DefaultItem } from './collection';
 
 export * from './collection';
 export * from './collection.persistent';
@@ -29,7 +29,7 @@ export * from './selector';
  * @param agileInstance - Instance of Agile the Collection belongs to.
  */
 export function createCollection<DataType extends DefaultItem = DefaultItem>(
-  config?: CollectionConfig<DataType>,
+  config?: CreateCollectionConfig<DataType>,
   agileInstance: Agile = shared
 ): Collection<DataType> {
   return new Collection<DataType>(agileInstance, config);

packages/multieditor/src/multieditor/index.ts

@@ -1,6 +1,6 @@
 import { Agile, shared } from '@agile-ts/core';
 import { Multieditor } from './multieditor';
-import { EditorConfig, FieldData } from './types';
+import { CreateEditorConfig, FieldData } from './types';
 
 export * from './multieditor';
 export * from './types';
@@ -15,7 +15,7 @@ export * from './types';
  * @param agileInstance - Instance of Agile the Multieditor belongs to.
  */
 export function createMultieditor<TFieldData extends FieldData = FieldData>(
-  config: EditorConfig<TFieldData>,
+  config: CreateEditorConfig<TFieldData>,
   agileInstance: Agile = shared
 ): Multieditor<TFieldData> {
   return new Multieditor<TFieldData>(config, agileInstance);

packages/multieditor/src/multieditor/multieditor.ts

@@ -6,7 +6,7 @@ import { StatusInterface, StatusType } from '../status';
 import {
   DeepFieldPaths,
   DeepFieldPathValues,
-  EditorConfig,
+  CreateEditorConfig,
   EditorConfigInterface,
   EditorKey,
   EditorValidationSchemaType,
@@ -51,7 +51,7 @@ export class Multieditor<TFieldData extends FieldData = FieldData> {
    * @param agileInstance - Instance of Agile the Multieditor belongs to.
    * @param config - Configuration object
    */
-  constructor(config: EditorConfig<TFieldData>, agileInstance: Agile) {
+  constructor(config: CreateEditorConfig<TFieldData>, agileInstance: Agile) {
     this.agileInstance = () => agileInstance;
     let _config = typeof config === 'function' ? config(this) : config;
     _config = defineConfig(_config, {
@@ -375,7 +375,7 @@ export class Multieditor<TFieldData extends FieldData = FieldData> {
   /**
    * Retrieves a single Item with the specified key/name identifier from the Multieditor.
    *
-   * If the to retrieve Item doesn't exist, `undefined` is returned.
+   * If the to retrieve Item doesn't exist, `null` is returned.
    *
    * @public
    * @param itemKey - Key/Name identifier of the Item.
@@ -422,7 +422,6 @@ export class Multieditor<TFieldData extends FieldData = FieldData> {
     return this.getItem(itemKey)?.initialStateValue;
   }
 
-  /**
   /**
    * Returns a boolean indicating whether at least one Item
    * of the Items with the specified key/name identifiers is modified.

packages/multieditor/src/multieditor/types.ts

@@ -25,7 +25,7 @@ export type NestedValue<TValue extends Object = Object> = {
   [$NestedValue]: never;
 } & TValue;
 
-// Creates an object type based on the specified object were each property is optional
+// Creates an object type, based on the specified object were each property is optional
 export type DeepPartial<T> = {
   [K in keyof T]?: DeepPartialImpl<T[K]>;
 };
@@ -36,13 +36,13 @@ type DeepPartialImpl<T> = T extends NestedValue
     ? DeepPartial<T>
     : T;
 
-// Creates an object type based on the specified object were each property at the top level is optional
+// Creates an object type, based on the specified object were each property at the top level is optional
 export type ShallowPartial<T> = {
   [K in keyof T]?: T;
 };
 
 
-// Extracts each path to a property from the specified object
+// Extracts each path to a property (e.g. user.location.city) from the specified object
 export type DeepPaths<T> = {
   [K in keyof T]: DeepPathsImpl<K & string, T[K]>;
 }[keyof T] & string;
@@ -51,12 +51,12 @@ type DeepPathsImpl<K extends string | number, V> = V extends Primitive
   ? `${K}`
   : `${K}` | `${K}.${DeepPaths<V>}`;
 
-// Extracts each path to a property at the top level of the specified object
+// Extracts each path to a property (e.g. user) at the top level of the specified object
 export type FlatPaths<T> = {
   [K in keyof T]: T[K] extends any ? K : never;
 }[keyof T] & string;
 
-// Extracts the value type of the specified Path (P) in the provided object (T) at top level
+// Extracts the value type of the specified Path (P) in the provided object (T) at the top level
 export type DeepPathValues<T, P extends DeepPaths<T> | string | number> = T extends any
   ? P extends `${infer K}.${infer R}` // if having nested Path like 'image.id'
     ? K extends keyof T
@@ -81,10 +81,9 @@ export type DeepFieldPathValues<
   TFieldPath extends DeepFieldPaths<TFieldData>,
   > = DeepPathValues<TFieldData, TFieldPath>;
 
-
 export type EditorKey = string | number;
 
-export interface CreateEditorConfigInterface<
+export interface CreateEditorConfigImpl<
   TFieldData extends FieldData = FieldData
   > {
   /**
@@ -98,13 +97,13 @@ export interface CreateEditorConfigInterface<
    */
   initialData: TFieldData;
   /**
-   * Key/name identifiers of Items whose values
+   * Key/name identifiers of the Items whose values
    * to be always passed to the specified 'onSubmit()' method.
    * @default []
    */
   fixedProperties?: string[];
   /**
-   * Key/Name identifiers of Items that can be edited.
+   * Key/Name identifiers of the Items that can be edited.
    * @default Object.keys(config.initialData)
    */
   editableProperties?: string[];
@@ -127,7 +126,7 @@ export interface CreateEditorConfigInterface<
     config?: any
   ) => Promise<any>;
   /**
-   * In which circumstances the Multieditor is revalidated.
+   * In which circumstances the Multieditor should be revalidated.
    * @default 'onSubmit'
    */
   reValidateMode?: ValidationMode;
@@ -138,13 +137,19 @@ export interface CreateEditorConfigInterface<
   toValidate?: ValidateType;
 }
 
+export type CreateEditorConfig<TFieldData extends FieldData = FieldData> =
+  | CreateEditorConfigImpl<TFieldData>
+  | ((
+  editor: Multieditor<TFieldData>
+) => CreateEditorConfigImpl<TFieldData>);
+
 export type EditorValidationSchemaType = {
   [key: string]: ValidationMethodInterface | Validator;
 };
 
 export interface EditorConfigInterface {
   /**
-   * In which circumstances the Multieditor is revalidated.
+   * In which circumstances the Multieditor should be revalidated.
    * @default 'onSubmit'
    */
   reValidateMode: ValidationMode;
@@ -155,12 +160,6 @@ export interface EditorConfigInterface {
   toValidate: ValidateType;
 }
 
-export type EditorConfig<TFieldData extends FieldData = FieldData> =
-  | CreateEditorConfigInterface<TFieldData>
-  | ((
-  editor: Multieditor<TFieldData>
-) => CreateEditorConfigInterface<TFieldData>);
-
 export interface SubmitConfigInterface<OnSubmitConfigType = any> {
   /**
    * Whether the submitted values should be assigned