@empathyco/x-adapter 8.0.0-alpha.8 → 8.0.0

package/dist/types/schemas/types.d.ts

@@ -1,4 +1,4 @@
-import { AnyFunction, ExtractPath, ExtractPathByType, ExtractType, Primitive } from '@empathyco/x-utils';
+import { AnyFunction, DeepPartial, ExtractPath, ExtractPathByType, ExtractType, Primitive } from '@empathyco/x-utils';
 import { MapperContext } from '../mappers/types';
 /**
  * Template object to transform a source object to a target object.
@@ -34,7 +34,7 @@ import { MapperContext } from '../mappers/types';
  * ```
  * @public
  */
-export declare type Schema<Source = any, Target = any> = {
+export type Schema<Source = any, Target = any> = {
     [TargetKey in keyof Target]: SchemaTransformer<Source, Target, TargetKey>;
 };
 /**
@@ -44,29 +44,31 @@ export declare type Schema<Source = any, Target = any> = {
  * @param OriginalSchema - The {@link Schema | schema} that will be mutable.
  * @public
  */
-export declare type MutableSchema<OriginalSchema extends Schema> = OriginalSchema & {
+export type MutableSchema<Source, Target> = Schema<Source, Target> & {
     /**
      * Replaces all usages of the original {@link Schema | schema} with the given one.
      *
      * @param newSchema - The {@link Schema | schema} to use instead of the original one.
      * @returns The new {@link Schema | schema} that will be used.
      */
-    $replace: <Source, Target>(newSchema: Schema<Source, Target>) => MutableSchema<Schema<Source, Target>>;
+    $replace<NewSource, NewTarget>(newSchema: Schema<NewSource, NewTarget>): MutableSchema<NewSource, NewTarget>;
     /**
      * Merges the original {@link Schema | schema} with the given one.
      *
      * @param newSchema - The {@link Schema | schema} to use to merge with the original one.
      * @returns The {@link Schema | schema} returned by the merge.
      */
-    $override: <Source, Target>(newSchema: Schema<Source, Target>) => MutableSchema<Schema<Source, Target>>;
+    $override<NewSource, NewTarget = {}>(newSchema: DeepPartial<Schema<Source & NewSource, Target>> & Schema<Source & NewSource, NewTarget>): MutableSchema<Source & NewSource, Target & NewTarget>;
     /**
      * Creates a new {@link Schema | schema} using the original one as starting point.
      * The original {@link Schema | schema} will remain unchanged.
      *
      * @param newSchema - The {@link Schema | schema} to be used to extend the original one.
+     * Both schema's Target and Source can be unique or also be extending from another one.
      * @returns The {@link Schema | schema} created.
      */
-    $extends: <Source, Target>(newSchema: Schema<Source, Target>) => MutableSchema<Schema<Source, Target>>;
+    $extends<NewSource extends Source, NewTarget extends Target>(newSchema: DeepPartial<Schema<Source & NewSource, Target>> & Schema<Source & NewSource, Omit<NewTarget, keyof Target>>): MutableSchema<Source & NewSource, Target & NewTarget>;
+    $extends<NewSource, NewTarget = {}>(newSchema: DeepPartial<Schema<Source & NewSource, Target>> & Schema<Source & NewSource, NewTarget>): MutableSchema<Source & NewSource, Target & NewTarget>;
     /**
      * Returns a string representing of the {@link Schema | schema}.
      *
@@ -74,7 +76,7 @@ export declare type MutableSchema<OriginalSchema extends Schema> = OriginalSchem
      * the internal methods. Disabled by default.
      * @returns The string representation.
      */
-    toString: (includeInternalMethods?: boolean) => string;
+    toString(includeInternalMethods?: boolean): string;
 };
 /**
  * The possible transformers to apply to the target key.
@@ -84,7 +86,7 @@ export declare type MutableSchema<OriginalSchema extends Schema> = OriginalSchem
  * @param TargetKey - The target key to apply the transformation.
  * @public
  */
-export declare type SchemaTransformer<Source, Target, TargetKey extends keyof Target> = PathTransformer<Source, Target[TargetKey]> | FunctionTransformer<Source, Target[TargetKey]> | SubSchemaTransformer<Source, Target[TargetKey]> | Schema<Source, Exclude<Target[TargetKey], AnyFunction | Primitive>>;
+export type SchemaTransformer<Source, Target, TargetKey extends keyof Target> = PathTransformer<Source, Target[TargetKey]> | FunctionTransformer<Source, Target[TargetKey]> | SubSchemaTransformer<Source, Target[TargetKey]> | Schema<Source, Exclude<Target[TargetKey], AnyFunction | Primitive>>;
 /**
  * A function with the source object and mapper context as parameters that returns the value of a
  * target's property.
@@ -116,7 +118,7 @@ export declare type SchemaTransformer<Source, Target, TargetKey extends keyof Ta
  * ```
  * @public
  */
-export declare type PathTransformer<Source, Target> = ExtractPathByType<Source, Target>;
+export type PathTransformer<Source, Target> = ExtractPathByType<Source, Target>;
 /**
  * A function with the source object and mapper context as parameters that returns the value of a
  * target's property.
@@ -144,7 +146,7 @@ export declare type PathTransformer<Source, Target> = ExtractPathByType<Source,
  * ```
  * @public
  */
-export declare type FunctionTransformer<Source, Target> = (source: Source, context?: MapperContext) => Target;
+export type FunctionTransformer<Source, Target> = (source: Source, context?: MapperContext) => Target;
 /**
  * An object containing a schema narrowing its source object based on the given path.
  *
@@ -180,7 +182,7 @@ export declare type FunctionTransformer<Source, Target> = (source: Source, conte
  * ```
  * @public
  */
-export declare type SubSchemaTransformer<Source, Target> = {
+export type SubSchemaTransformer<Source, Target> = {
     [Path in ExtractPath<Source>]: {
         $context?: MapperContext;
         $path: Path;
@@ -195,4 +197,4 @@ export declare type SubSchemaTransformer<Source, Target> = {
  * @param Path - The path where the schema will be applied.
  * @public
  */
-export declare type SubSchema<Source, Target, Path extends ExtractPath<Source>> = ExtractType<Source, Path> extends (infer SourceArrayType)[] ? Target extends (infer TargetArrayType)[] ? Schema<SourceArrayType, TargetArrayType> : never : Target extends [] ? never : Schema<ExtractType<Source, Path>, Target>;
+export type SubSchema<Source, Target, Path extends ExtractPath<Source>> = ExtractType<Source, Path> extends (infer SourceArrayType)[] ? Target extends (infer TargetArrayType)[] ? Schema<SourceArrayType, TargetArrayType> : never : Target extends [] ? never : Schema<ExtractType<Source, Path>, Target>;

package/dist/types/schemas/utils.d.ts

@@ -8,7 +8,7 @@ import { MutableSchema, Schema } from './types';
  *
  * @public
  */
-export declare function createMutableSchema<T extends Schema>(schema: T): MutableSchema<T>;
+export declare function createMutableSchema<Source, Target>(schema: Schema<Source, Target>): MutableSchema<Source, Target>;
 /**
  * Checks if the given key is a {@link MutableSchema | mutableSchema} method.
  *

package/dist/types/utils/index.d.ts

@@ -1,2 +1 @@
-export * from './extract-value';
 export * from './interpolate';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-adapter",
-  "version": "8.0.0-alpha.8",
+  "version": "8.0.0",
   "description": "A utils library to create a client for any API",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -22,31 +22,35 @@
     "url": "git+https://github.com/empathyco/x.git",
     "directory": "packages/x-adapter"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "prebuild": "rimraf ./dist ./*.tgz",
-    "build": "concurrently \"npm run build:*\"",
+    "build": "concurrently \"pnpm run build:*\"",
     "build:cjs": "tsc --project tsconfig.cjs.json",
     "build:esm": "tsc --project tsconfig.esm.json",
+    "postbuild": "pnpm pack",
+    "lint": "eslint . --ext .ts",
     "test": "jest",
-    "postbuild": "npm pack",
-    "prepublishOnly": "npm run build"
+    "test:unit": "jest",
+    "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@empathyco/x-deep-merge": "^1.3.0-alpha.21",
-    "@empathyco/x-get-safe-property-chain": "^1.3.0-alpha.3",
-    "tslib": "~2.3.0"
+    "@empathyco/x-deep-merge": "^2.0.0",
+    "@empathyco/x-utils": "^1.0.0",
+    "tslib": "~2.5.0"
   },
   "devDependencies": {
-    "@empathyco/x-utils": "^1.0.0-alpha.7",
-    "@types/jest": "~27.0.3",
-    "concurrently": "~7.0.0",
-    "jest": "~27.3.1",
+    "@types/jest": "~27.5.0",
+    "concurrently": "~8.1.0",
+    "jest": "~27.5.0",
     "rimraf": "~3.0.2",
-    "ts-jest": "~27.0.7",
-    "typescript": "~4.6.2"
+    "ts-jest": "~27.1.0",
+    "typescript": "~4.9.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c2150c4957ff99d27ce904c8554d72ac61261f36"
+  "gitHead": "b8ff7113a91e5a8f05228fc7994faa6dd91c44f3"
 }

package/dist/cjs/utils/extract-value.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractValue = void 0;
-const x_get_safe_property_chain_1 = require("@empathyco/x-get-safe-property-chain");
-const x_utils_1 = require("@empathyco/x-utils");
-/**
- * Extracts the value of the given property's path from the given object.
- *
- * @param obj - The object to extract the property's value from.
- * @param path - The path to the object's property.
- *
- * @returns The value of the property.
- *
- * @public
- */
-function extractValue(obj, path) {
-    const result = (0, x_get_safe_property_chain_1.getSafePropertyChain)(obj, path);
-    if (result !== undefined) {
-        if ((0, x_utils_1.isArray)(result)) {
-            return result;
-        }
-        else {
-            return result;
-        }
-    }
-}
-exports.extractValue = extractValue;
-//# sourceMappingURL=extract-value.js.map

package/dist/cjs/utils/extract-value.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extract-value.js","sourceRoot":"","sources":["../../../src/utils/extract-value.ts"],"names":[],"mappings":";;;AAAA,oFAA4E;AAC5E,gDAAmF;AAEnF;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,GAA8B,EAC9B,IAAU;IAEV,MAAM,MAAM,GAAG,IAAA,gDAAoB,EAA+B,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7E,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,IAAI,IAAA,iBAAO,EAAgC,MAAM,CAAC,EAAE;YAClD,OAAO,MAAM,CAAC;SACf;aAAM;YACL,OAAO,MAAM,CAAC;SACf;KACF;AACH,CAAC;AAZD,oCAYC","sourcesContent":["import { getSafePropertyChain } from '@empathyco/x-get-safe-property-chain';\nimport { Dictionary, ExtractPath, ExtractType, isArray } from '@empathyco/x-utils';\n\n/**\n * Extracts the value of the given property's path from the given object.\n *\n * @param obj - The object to extract the property's value from.\n * @param path - The path to the object's property.\n *\n * @returns The value of the property.\n *\n * @public\n */\nexport function extractValue<SomeObject extends Dictionary, Path extends ExtractPath<SomeObject>>(\n  obj: SomeObject | SomeObject[],\n  path: Path\n): ExtractType<SomeObject, Path> | ExtractType<SomeObject, Path>[] | undefined {\n  const result = getSafePropertyChain<ReturnType<SomeObject, Path>>(obj, path);\n  if (result !== undefined) {\n    if (isArray<ExtractType<SomeObject, Path>>(result)) {\n      return result;\n    } else {\n      return result;\n    }\n  }\n}\n\n/**\n * Helper to narrow down the type of the returned value when calling `getSafePropertyChain()`.\n *\n * @param SomeObject - The object to check.\n * @param Path - The path to check.\n *\n * @internal\n */\ntype ReturnType<SomeObject, Path extends ExtractPath<SomeObject>> =\n  | ExtractType<SomeObject, Path>\n  | ExtractType<SomeObject, Path>[];\n"]}

package/dist/esm/utils/extract-value.js

@@ -1,24 +0,0 @@
-import { getSafePropertyChain } from '@empathyco/x-get-safe-property-chain';
-import { isArray } from '@empathyco/x-utils';
-/**
- * Extracts the value of the given property's path from the given object.
- *
- * @param obj - The object to extract the property's value from.
- * @param path - The path to the object's property.
- *
- * @returns The value of the property.
- *
- * @public
- */
-export function extractValue(obj, path) {
-    const result = getSafePropertyChain(obj, path);
-    if (result !== undefined) {
-        if (isArray(result)) {
-            return result;
-        }
-        else {
-            return result;
-        }
-    }
-}
-//# sourceMappingURL=extract-value.js.map

package/dist/esm/utils/extract-value.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extract-value.js","sourceRoot":"","sources":["../../../src/utils/extract-value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAwC,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAEnF;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAC1B,GAA8B,EAC9B,IAAU;IAEV,MAAM,MAAM,GAAG,oBAAoB,CAA+B,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7E,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,IAAI,OAAO,CAAgC,MAAM,CAAC,EAAE;YAClD,OAAO,MAAM,CAAC;SACf;aAAM;YACL,OAAO,MAAM,CAAC;SACf;KACF;AACH,CAAC","sourcesContent":["import { getSafePropertyChain } from '@empathyco/x-get-safe-property-chain';\nimport { Dictionary, ExtractPath, ExtractType, isArray } from '@empathyco/x-utils';\n\n/**\n * Extracts the value of the given property's path from the given object.\n *\n * @param obj - The object to extract the property's value from.\n * @param path - The path to the object's property.\n *\n * @returns The value of the property.\n *\n * @public\n */\nexport function extractValue<SomeObject extends Dictionary, Path extends ExtractPath<SomeObject>>(\n  obj: SomeObject | SomeObject[],\n  path: Path\n): ExtractType<SomeObject, Path> | ExtractType<SomeObject, Path>[] | undefined {\n  const result = getSafePropertyChain<ReturnType<SomeObject, Path>>(obj, path);\n  if (result !== undefined) {\n    if (isArray<ExtractType<SomeObject, Path>>(result)) {\n      return result;\n    } else {\n      return result;\n    }\n  }\n}\n\n/**\n * Helper to narrow down the type of the returned value when calling `getSafePropertyChain()`.\n *\n * @param SomeObject - The object to check.\n * @param Path - The path to check.\n *\n * @internal\n */\ntype ReturnType<SomeObject, Path extends ExtractPath<SomeObject>> =\n  | ExtractType<SomeObject, Path>\n  | ExtractType<SomeObject, Path>[];\n"]}

package/dist/types/utils/extract-value.d.ts

@@ -1,12 +0,0 @@
-import { Dictionary, ExtractPath, ExtractType } from '@empathyco/x-utils';
-/**
- * Extracts the value of the given property's path from the given object.
- *
- * @param obj - The object to extract the property's value from.
- * @param path - The path to the object's property.
- *
- * @returns The value of the property.
- *
- * @public
- */
-export declare function extractValue<SomeObject extends Dictionary, Path extends ExtractPath<SomeObject>>(obj: SomeObject | SomeObject[], path: Path): ExtractType<SomeObject, Path> | ExtractType<SomeObject, Path>[] | undefined;