@sprucelabs/schema 29.1.2 → 29.2.1

package/build/errors/SpruceError.js

@@ -56,6 +56,9 @@ class SpruceError extends error_1.default {
                 message = `${map[options.code]}:\n\n${this.renderParametersWithFriendlyMessages(options.parameters, options.friendlyMessages)}`;
                 break;
             }
+            case 'FIELDS_NOT_MAPPED':
+                message = `The following fields were not mapped because they don't exist in your map: ${options.fields.join(', ')}`;
+                break;
             default:
                 message = this.message;
         }

package/build/errors/options.types.d.ts

@@ -1,6 +1,6 @@
 import AbstractSpruceError, { ErrorOptions as ISpruceErrorOptions } from '@sprucelabs/error';
 import { FieldType } from '../fields/field.static.types';
-export type SchemaErrorOptions = DuplicateSchemaErrorOptions | SchemaErrorOptionsNotFound | TransformationFailedErrorOptions | InvalidSchemaDefinitionErrorOptions | NotImplementedErrorOptions | InvalidFieldRegistrationErrorOptions | VersionRequiredErrorOptions | MissingParametersOptions | InvalidParametersOptions | UnexpectedParametersOptions | ValidationFailedErrorOptions | InvalidSchemaReferenceErrorOptions;
+export type SchemaErrorOptions = DuplicateSchemaErrorOptions | SchemaErrorOptionsNotFound | TransformationFailedErrorOptions | InvalidSchemaDefinitionErrorOptions | NotImplementedErrorOptions | InvalidFieldRegistrationErrorOptions | VersionRequiredErrorOptions | MissingParametersOptions | InvalidParametersOptions | UnexpectedParametersOptions | ValidationFailedErrorOptions | InvalidSchemaReferenceErrorOptions | FieldsNotMappedErrorOptions;
 export type FieldErrorCode = 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'UNEXPECTED_PARAMETER';
 export interface FieldError {
     code: FieldErrorCode;
@@ -41,6 +41,10 @@ export interface NotImplementedErrorOptions extends ISpruceErrorOptions {
     code: 'NOT_IMPLEMENTED';
     instructions: string;
 }
+export interface FieldsNotMappedErrorOptions extends ISpruceErrorOptions {
+    code: 'FIELDS_NOT_MAPPED';
+    fields: string[];
+}
 export interface InvalidFieldRegistrationErrorOptions extends ISpruceErrorOptions {
     code: 'INVALID_FIELD_REGISTRATION';
     package: string;

package/build/esm/errors/SpruceError.js

@@ -51,6 +51,9 @@ export default class SpruceError extends AbstractSpruceError {
                 message = `${map[options.code]}:\n\n${this.renderParametersWithFriendlyMessages(options.parameters, options.friendlyMessages)}`;
                 break;
             }
+            case 'FIELDS_NOT_MAPPED':
+                message = `The following fields were not mapped because they don't exist in your map: ${options.fields.join(', ')}`;
+                break;
             default:
                 message = this.message;
         }

package/build/esm/errors/options.types.d.ts

@@ -1,6 +1,6 @@
 import AbstractSpruceError, { ErrorOptions as ISpruceErrorOptions } from '@sprucelabs/error';
 import { FieldType } from '../fields/field.static.types';
-export type SchemaErrorOptions = DuplicateSchemaErrorOptions | SchemaErrorOptionsNotFound | TransformationFailedErrorOptions | InvalidSchemaDefinitionErrorOptions | NotImplementedErrorOptions | InvalidFieldRegistrationErrorOptions | VersionRequiredErrorOptions | MissingParametersOptions | InvalidParametersOptions | UnexpectedParametersOptions | ValidationFailedErrorOptions | InvalidSchemaReferenceErrorOptions;
+export type SchemaErrorOptions = DuplicateSchemaErrorOptions | SchemaErrorOptionsNotFound | TransformationFailedErrorOptions | InvalidSchemaDefinitionErrorOptions | NotImplementedErrorOptions | InvalidFieldRegistrationErrorOptions | VersionRequiredErrorOptions | MissingParametersOptions | InvalidParametersOptions | UnexpectedParametersOptions | ValidationFailedErrorOptions | InvalidSchemaReferenceErrorOptions | FieldsNotMappedErrorOptions;
 export type FieldErrorCode = 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'UNEXPECTED_PARAMETER';
 export interface FieldError {
     code: FieldErrorCode;
@@ -41,6 +41,10 @@ export interface NotImplementedErrorOptions extends ISpruceErrorOptions {
     code: 'NOT_IMPLEMENTED';
     instructions: string;
 }
+export interface FieldsNotMappedErrorOptions extends ISpruceErrorOptions {
+    code: 'FIELDS_NOT_MAPPED';
+    fields: string[];
+}
 export interface InvalidFieldRegistrationErrorOptions extends ISpruceErrorOptions {
     code: 'INVALID_FIELD_REGISTRATION';
     package: string;

package/build/esm/utilities/KeyMapper.d.ts

@@ -3,4 +3,9 @@ export default class KeyMapper {
     constructor(map: Record<string, any>);
     mapTo(values: Record<string, any>): any;
     mapFrom(values: Record<string, any>): any;
+    mapFieldNameTo(name: string): any;
+    private throwFieldsNotMapped;
+    mapFieldNameFrom(name: string): string;
+    private _mapTo;
+    private _mapFrom;
 }

package/build/esm/utilities/KeyMapper.js

@@ -1,34 +1,69 @@
+import SpruceError from '../errors/SpruceError.js';
 export default class KeyMapper {
     constructor(map) {
         this.map = map;
     }
     mapTo(values) {
-        return keyMapper.mapTo(values, this.map);
+        return this._mapTo(values, this.map);
     }
     mapFrom(values) {
-        return keyMapper.mapFrom(values, this.map);
+        return this._mapFrom(values, this.map);
     }
-}
-const keyMapper = {
-    mapTo(values, map) {
+    mapFieldNameTo(name) {
+        if (!this.map[name]) {
+            this.throwFieldsNotMapped([name]);
+        }
+        return this.map[name];
+    }
+    throwFieldsNotMapped(fields) {
+        throw new SpruceError({
+            code: 'FIELDS_NOT_MAPPED',
+            fields,
+        });
+    }
+    mapFieldNameFrom(name) {
+        for (const key in this.map) {
+            // eslint-disable-next-line no-prototype-builtins
+            if (this.map.hasOwnProperty(key)) {
+                if (this.map[key] === name) {
+                    return key;
+                }
+            }
+        }
+        this.throwFieldsNotMapped([name]);
+        return 'never hit';
+    }
+    _mapTo(values, map) {
+        const foundFields = [];
         let target = {};
         for (const key in map) {
             // eslint-disable-next-line no-prototype-builtins
             if (values.hasOwnProperty(key)) {
                 target[map[key]] = values[key];
+                foundFields.push(key);
             }
         }
+        const missingFields = Object.keys(values).filter((key) => !foundFields.includes(key));
+        if (missingFields.length > 0) {
+            this.throwFieldsNotMapped(missingFields);
+        }
         return target;
-    },
-    mapFrom(values, map) {
+    }
+    _mapFrom(values, map) {
+        const foundFields = [];
         let target = {};
         for (const targetKey in map) {
             const sourceKey = map[targetKey];
             // eslint-disable-next-line no-prototype-builtins
             if (values.hasOwnProperty(sourceKey)) {
                 target[targetKey] = values[sourceKey];
+                foundFields.push(sourceKey);
             }
         }
+        const missingFields = Object.keys(values).filter((key) => !foundFields.includes(key));
+        if (missingFields.length > 0) {
+            this.throwFieldsNotMapped(missingFields);
+        }
         return target;
-    },
-};
+    }
+}

package/build/utilities/KeyMapper.d.ts

@@ -3,4 +3,9 @@ export default class KeyMapper {
     constructor(map: Record<string, any>);
     mapTo(values: Record<string, any>): any;
     mapFrom(values: Record<string, any>): any;
+    mapFieldNameTo(name: string): any;
+    private throwFieldsNotMapped;
+    mapFieldNameFrom(name: string): string;
+    private _mapTo;
+    private _mapFrom;
 }

package/build/utilities/KeyMapper.js

@@ -1,37 +1,75 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const SpruceError_1 = __importDefault(require("../errors/SpruceError"));
 class KeyMapper {
     constructor(map) {
         this.map = map;
     }
     mapTo(values) {
-        return keyMapper.mapTo(values, this.map);
+        return this._mapTo(values, this.map);
     }
     mapFrom(values) {
-        return keyMapper.mapFrom(values, this.map);
+        return this._mapFrom(values, this.map);
     }
-}
-exports.default = KeyMapper;
-const keyMapper = {
-    mapTo(values, map) {
+    mapFieldNameTo(name) {
+        if (!this.map[name]) {
+            this.throwFieldsNotMapped([name]);
+        }
+        return this.map[name];
+    }
+    throwFieldsNotMapped(fields) {
+        throw new SpruceError_1.default({
+            code: 'FIELDS_NOT_MAPPED',
+            fields,
+        });
+    }
+    mapFieldNameFrom(name) {
+        for (const key in this.map) {
+            // eslint-disable-next-line no-prototype-builtins
+            if (this.map.hasOwnProperty(key)) {
+                if (this.map[key] === name) {
+                    return key;
+                }
+            }
+        }
+        this.throwFieldsNotMapped([name]);
+        return 'never hit';
+    }
+    _mapTo(values, map) {
+        const foundFields = [];
         let target = {};
         for (const key in map) {
             // eslint-disable-next-line no-prototype-builtins
             if (values.hasOwnProperty(key)) {
                 target[map[key]] = values[key];
+                foundFields.push(key);
             }
         }
+        const missingFields = Object.keys(values).filter((key) => !foundFields.includes(key));
+        if (missingFields.length > 0) {
+            this.throwFieldsNotMapped(missingFields);
+        }
         return target;
-    },
-    mapFrom(values, map) {
+    }
+    _mapFrom(values, map) {
+        const foundFields = [];
         let target = {};
         for (const targetKey in map) {
             const sourceKey = map[targetKey];
             // eslint-disable-next-line no-prototype-builtins
             if (values.hasOwnProperty(sourceKey)) {
                 target[targetKey] = values[sourceKey];
+                foundFields.push(sourceKey);
             }
         }
+        const missingFields = Object.keys(values).filter((key) => !foundFields.includes(key));
+        if (missingFields.length > 0) {
+            this.throwFieldsNotMapped(missingFields);
+        }
         return target;
-    },
-};
+    }
+}
+exports.default = KeyMapper;

package/package.json

@@ -8,7 +8,7 @@
     "!build/__tests__",
     "esm"
   ],
-  "version": "29.1.2",
+  "version": "29.2.1",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "module": "./build/esm/index.js",