@sprucelabs/schema 25.3.535 → 25.4.0

package/build/esm/__tests__/behavioral/AssertingSelectOptions.test.d.ts

@@ -0,0 +1,7 @@
+import AbstractSpruceTest from '@sprucelabs/test';
+export default class AssertingSelectOptionsTest extends AbstractSpruceTest {
+    protected static canCreateAssertSelectOptions(): void;
+    protected static knowsIfChoicesDontMatch(choices: any, expected: any): void;
+    protected static knowsIfSingeOptionMatches(options: any, expected: any): void;
+    protected static canType(): void;
+}

package/build/esm/__tests__/behavioral/AssertingSelectOptions.test.js

@@ -0,0 +1,93 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import AbstractSpruceTest, { test, assert } from '@sprucelabs/test';
+import selectAssertUtil from '../../tests/selectAssert.utility.js';
+export default class AssertingSelectOptionsTest extends AbstractSpruceTest {
+    static canCreateAssertSelectOptions() {
+        assert.isFunction(selectAssertUtil.assertSelectChoicesMatch);
+    }
+    static knowsIfChoicesDontMatch(choices, expected) {
+        assert.doesThrow(() => selectAssertUtil.assertSelectChoicesMatch(choices, expected));
+    }
+    static knowsIfSingeOptionMatches(options, expected) {
+        selectAssertUtil.assertSelectChoicesMatch(options, expected);
+    }
+    static canType() {
+        selectAssertUtil.assertSelectChoicesMatch([
+            {
+                value: 'hello',
+                label: 'World!',
+            },
+            {
+                value: 'no',
+                label: 'Way',
+            },
+        ], ['hello', 'no']);
+    }
+}
+__decorate([
+    test()
+], AssertingSelectOptionsTest, "canCreateAssertSelectOptions", null);
+__decorate([
+    test('throws if single option does not match', [
+        {
+            value: 'hello',
+            label: 'World!',
+        },
+    ], ['no']),
+    test('throws if choices outnumber expected does not match', [
+        {
+            value: 'hello',
+            label: 'World!',
+        },
+        {
+            value: 'no',
+            label: 'way!',
+        },
+    ], ['no']),
+    test('throws if not all choices match', [
+        {
+            value: 'hello',
+            label: 'World!',
+        },
+        {
+            value: 'no',
+            label: 'way!',
+        },
+    ], ['no', 'word'])
+], AssertingSelectOptionsTest, "knowsIfChoicesDontMatch", null);
+__decorate([
+    test('matches single choices', [
+        {
+            value: 'hello',
+            label: 'World!',
+        },
+    ], ['hello']),
+    test('matches in order', [
+        {
+            value: 'hello',
+            label: 'World!',
+        },
+        {
+            value: 'no',
+            label: 'Way',
+        },
+    ], ['hello', 'no']),
+    test('matches out of order', [
+        {
+            value: 'hello',
+            label: 'World!',
+        },
+        {
+            value: 'no',
+            label: 'Way',
+        },
+    ], ['no', 'hello'])
+], AssertingSelectOptionsTest, "knowsIfSingeOptionMatches", null);
+__decorate([
+    test('is typed correctly (will always pass)')
+], AssertingSelectOptionsTest, "canType", null);

package/build/esm/index.d.ts

@@ -3,6 +3,7 @@ import StaticSchemaEntityImplementation from './StaticSchemaEntityImplementation
 import { FieldRegistration } from './utilities/registerFieldType';
 export default StaticSchemaEntityImplementation;
 export { default as validationErrorAssertUtil } from './tests/validationErrorAssert.utility';
+export { default as selectAssertUtil } from './tests/selectAssert.utility';
 export * from './schemas.static.types';
 export * from './fields';
 export * from './errors/options.types';

package/build/esm/index.js

@@ -17,6 +17,7 @@ import textRegistration from './addons/textField.addon.js';
 import StaticSchemaEntityImplementation from './StaticSchemaEntityImplementation.js';
 export default StaticSchemaEntityImplementation;
 export { default as validationErrorAssertUtil } from './tests/validationErrorAssert.utility.js';
+export { default as selectAssertUtil } from './tests/selectAssert.utility.js';
 export * from './schemas.static.types.js';
 export * from './fields/index.js';
 export * from './errors/options.types.js';

package/build/esm/tests/selectAssert.utility.d.ts

@@ -0,0 +1,5 @@
+import { SelectChoice } from '../fields/SelectField.types';
+declare const selectAssertUtil: {
+    assertSelectChoicesMatch<Choice extends SelectChoice, Values extends Choice["value"][number] = Choice["value"][number]>(choices: Choice[], expected: Values[]): void;
+};
+export default selectAssertUtil;

package/build/esm/tests/selectAssert.utility.js

@@ -0,0 +1,11 @@
+import { assert } from '@sprucelabs/test';
+const selectAssertUtil = {
+    assertSelectChoicesMatch(choices, expected) {
+        assert.isEqual(choices.length, expected.length, `Expected ${expected.length} choices, but found ${choices.length}!`);
+        const actualValues = choices.map((c) => c.value);
+        actualValues.sort();
+        expected.sort();
+        assert.isEqualDeep(actualValues, expected, `The options you sent don't match!`);
+    },
+};
+export default selectAssertUtil;

package/build/index.d.ts

@@ -3,6 +3,7 @@ import StaticSchemaEntityImplementation from './StaticSchemaEntityImplementation
 import { FieldRegistration } from './utilities/registerFieldType';
 export default StaticSchemaEntityImplementation;
 export { default as validationErrorAssertUtil } from './tests/validationErrorAssert.utility';
+export { default as selectAssertUtil } from './tests/selectAssert.utility';
 export * from './schemas.static.types';
 export * from './fields';
 export * from './errors/options.types';

package/build/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapFieldErrorsToParameterErrors = exports.assertOptions = exports.fieldRegistrations = exports.SchemaRegistry = exports.SchemaEntityFactory = exports.FieldFactory = exports.normalizeSchemaToIdWithVersion = exports.isIdWithVersion = exports.formatPhoneNumber = exports.areSchemasTheSame = exports.isSchemaValid = exports.validateSchema = exports.dropPrivateFields = exports.dropFields = exports.makeFieldsOptional = exports.areSchemaValuesValid = exports.normalizeSchemaValues = exports.validateSchemaValues = exports.defaultSchemaValues = exports.registerFieldType = exports.buildSchema = exports.buildErrorSchema = exports.SchemaError = exports.validationErrorAssertUtil = void 0;
+exports.mapFieldErrorsToParameterErrors = exports.assertOptions = exports.fieldRegistrations = exports.SchemaRegistry = exports.SchemaEntityFactory = exports.FieldFactory = exports.normalizeSchemaToIdWithVersion = exports.isIdWithVersion = exports.formatPhoneNumber = exports.areSchemasTheSame = exports.isSchemaValid = exports.validateSchema = exports.dropPrivateFields = exports.dropFields = exports.makeFieldsOptional = exports.areSchemaValuesValid = exports.normalizeSchemaValues = exports.validateSchemaValues = exports.defaultSchemaValues = exports.registerFieldType = exports.buildSchema = exports.buildErrorSchema = exports.SchemaError = exports.selectAssertUtil = exports.validationErrorAssertUtil = void 0;
 __exportStar(require("./StaticSchemaEntityImplementation"), exports);
 const addressField_addon_1 = __importDefault(require("./addons/addressField.addon"));
 const booleanField_addon_1 = __importDefault(require("./addons/booleanField.addon"));
@@ -34,6 +34,8 @@ const StaticSchemaEntityImplementation_1 = __importDefault(require("./StaticSche
 exports.default = StaticSchemaEntityImplementation_1.default;
 var validationErrorAssert_utility_1 = require("./tests/validationErrorAssert.utility");
 Object.defineProperty(exports, "validationErrorAssertUtil", { enumerable: true, get: function () { return __importDefault(validationErrorAssert_utility_1).default; } });
+var selectAssert_utility_1 = require("./tests/selectAssert.utility");
+Object.defineProperty(exports, "selectAssertUtil", { enumerable: true, get: function () { return __importDefault(selectAssert_utility_1).default; } });
 __exportStar(require("./schemas.static.types"), exports);
 __exportStar(require("./fields"), exports);
 __exportStar(require("./errors/options.types"), exports);

package/build/tests/selectAssert.utility.d.ts

@@ -0,0 +1,5 @@
+import { SelectChoice } from '../fields/SelectField.types';
+declare const selectAssertUtil: {
+    assertSelectChoicesMatch<Choice extends SelectChoice, Values extends Choice["value"][number] = Choice["value"][number]>(choices: Choice[], expected: Values[]): void;
+};
+export default selectAssertUtil;

package/build/tests/selectAssert.utility.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("@sprucelabs/test");
+const selectAssertUtil = {
+    assertSelectChoicesMatch(choices, expected) {
+        test_1.assert.isEqual(choices.length, expected.length, `Expected ${expected.length} choices, but found ${choices.length}!`);
+        const actualValues = choices.map((c) => c.value);
+        actualValues.sort();
+        expected.sort();
+        test_1.assert.isEqualDeep(actualValues, expected, `The options you sent don't match!`);
+    },
+};
+exports.default = selectAssertUtil;

package/package.json

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