@sprucelabs/schema 25.4.148 → 25.5.0

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

@@ -0,0 +1,7 @@
+import AbstractSchemaTest from '../../AbstractSchemaTest';
+export default class GettingFieldsOffASchemaTest extends AbstractSchemaTest {
+    protected static throwsWithNothingPassed(): Promise<void>;
+    protected static noFieldsThrows(): Promise<void>;
+    protected static getsBacksFields(): Promise<void>;
+    protected static getsBackMoreFields(): Promise<void>;
+}

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

@@ -0,0 +1,88 @@
+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;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { test, assert } from '@sprucelabs/test';
+import { errorAssertUtil } from '@sprucelabs/test-utils';
+import { buildSchema } from '../../index.js';
+import AbstractSchemaTest from '../../AbstractSchemaTest.js';
+import getFields from '../../utilities/getFields.js';
+const noFieldsSchema = buildSchema({
+    id: 'noField',
+    fields: {},
+});
+const withFieldsSchema = buildSchema({
+    id: 'withField',
+    fields: {
+        firstName: {
+            type: 'text',
+        },
+    },
+});
+const withManyFieldsSchema = buildSchema({
+    id: 'withManyField',
+    fields: {
+        firstName: {
+            type: 'text',
+        },
+        lastName: {
+            type: 'text',
+        },
+    },
+});
+export default class GettingFieldsOffASchemaTest extends AbstractSchemaTest {
+    static throwsWithNothingPassed() {
+        return __awaiter(this, void 0, void 0, function* () {
+            //@ts-ignore
+            const err = assert.doesThrow(() => getFields());
+            errorAssertUtil.assertError(err, 'INVALID_PARAMETERS', {
+                parameters: ['schema'],
+            });
+        });
+    }
+    static noFieldsThrows() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const err = assert.doesThrow(() => getFields(noFieldsSchema));
+            errorAssertUtil.assertError(err, 'INVALID_PARAMETERS', {
+                parameters: ['schema'],
+            });
+        });
+    }
+    static getsBacksFields() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const actual = getFields(withFieldsSchema);
+            assert.isEqualDeep(actual, ['firstName']);
+            assert.isExactType(true);
+        });
+    }
+    static getsBackMoreFields() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const actual = getFields(withManyFieldsSchema);
+            assert.isEqualDeep(actual, ['firstName', 'lastName']);
+            assert.isExactType(true);
+        });
+    }
+}
+__decorate([
+    test()
+], GettingFieldsOffASchemaTest, "throwsWithNothingPassed", null);
+__decorate([
+    test()
+], GettingFieldsOffASchemaTest, "noFieldsThrows", null);
+__decorate([
+    test()
+], GettingFieldsOffASchemaTest, "getsBacksFields", null);
+__decorate([
+    test()
+], GettingFieldsOffASchemaTest, "getsBackMoreFields", null);

package/build/esm/index.d.ts

@@ -25,6 +25,7 @@ export { default as validateSchema } from './utilities/validateSchema';
 export { default as isSchemaValid } from './utilities/isSchemaValid';
 export { default as areSchemasTheSame } from './utilities/areSchemasTheSame';
 export { default as formatPhoneNumber } from './utilities/formatPhoneNumber';
+export { default as getFields } from './utilities/getFields';
 export { default as isIdWithVersion } from './utilities/isIdWithVersion';
 export { default as normalizeSchemaToIdWithVersion } from './utilities/normalizeSchemaToIdWithVersion';
 export * from './utilities/formatPhoneNumber';

package/build/esm/index.js

@@ -39,6 +39,7 @@ export { default as validateSchema } from './utilities/validateSchema.js';
 export { default as isSchemaValid } from './utilities/isSchemaValid.js';
 export { default as areSchemasTheSame } from './utilities/areSchemasTheSame.js';
 export { default as formatPhoneNumber } from './utilities/formatPhoneNumber.js';
+export { default as getFields } from './utilities/getFields.js';
 export { default as isIdWithVersion } from './utilities/isIdWithVersion.js';
 export { default as normalizeSchemaToIdWithVersion } from './utilities/normalizeSchemaToIdWithVersion.js';
 export * from './utilities/formatPhoneNumber.js';

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

@@ -0,0 +1,2 @@
+import { Schema, SchemaFieldNames } from '..';
+export default function getFields<S extends Schema>(schema: S): SchemaFieldNames<S>[];

package/build/esm/utilities/getFields.js

@@ -0,0 +1,12 @@
+import SpruceError from '../errors/SpruceError.js';
+export default function getFields(schema) {
+    var _a;
+    const names = Object.keys((_a = schema === null || schema === void 0 ? void 0 : schema.fields) !== null && _a !== void 0 ? _a : {});
+    if (names.length === 0) {
+        throw new SpruceError({
+            code: 'INVALID_PARAMETERS',
+            parameters: ['schema'],
+        });
+    }
+    return names;
+}

package/build/index.d.ts

@@ -25,6 +25,7 @@ export { default as validateSchema } from './utilities/validateSchema';
 export { default as isSchemaValid } from './utilities/isSchemaValid';
 export { default as areSchemasTheSame } from './utilities/areSchemasTheSame';
 export { default as formatPhoneNumber } from './utilities/formatPhoneNumber';
+export { default as getFields } from './utilities/getFields';
 export { default as isIdWithVersion } from './utilities/isIdWithVersion';
 export { default as normalizeSchemaToIdWithVersion } from './utilities/normalizeSchemaToIdWithVersion';
 export * from './utilities/formatPhoneNumber';

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.selectAssertUtil = exports.validationErrorAssertUtil = void 0;
+exports.mapFieldErrorsToParameterErrors = exports.assertOptions = exports.fieldRegistrations = exports.SchemaRegistry = exports.SchemaEntityFactory = exports.FieldFactory = exports.normalizeSchemaToIdWithVersion = exports.isIdWithVersion = exports.getFields = 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"));
@@ -72,6 +72,8 @@ var areSchemasTheSame_1 = require("./utilities/areSchemasTheSame");
 Object.defineProperty(exports, "areSchemasTheSame", { enumerable: true, get: function () { return __importDefault(areSchemasTheSame_1).default; } });
 var formatPhoneNumber_1 = require("./utilities/formatPhoneNumber");
 Object.defineProperty(exports, "formatPhoneNumber", { enumerable: true, get: function () { return __importDefault(formatPhoneNumber_1).default; } });
+var getFields_1 = require("./utilities/getFields");
+Object.defineProperty(exports, "getFields", { enumerable: true, get: function () { return __importDefault(getFields_1).default; } });
 var isIdWithVersion_1 = require("./utilities/isIdWithVersion");
 Object.defineProperty(exports, "isIdWithVersion", { enumerable: true, get: function () { return __importDefault(isIdWithVersion_1).default; } });
 var normalizeSchemaToIdWithVersion_1 = require("./utilities/normalizeSchemaToIdWithVersion");

package/build/utilities/getFields.d.ts

@@ -0,0 +1,2 @@
+import { Schema, SchemaFieldNames } from '..';
+export default function getFields<S extends Schema>(schema: S): SchemaFieldNames<S>[];

package/build/utilities/getFields.js

@@ -0,0 +1,18 @@
+"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"));
+function getFields(schema) {
+    var _a;
+    const names = Object.keys((_a = schema === null || schema === void 0 ? void 0 : schema.fields) !== null && _a !== void 0 ? _a : {});
+    if (names.length === 0) {
+        throw new SpruceError_1.default({
+            code: 'INVALID_PARAMETERS',
+            parameters: ['schema'],
+        });
+    }
+    return names;
+}
+exports.default = getFields;

package/package.json

@@ -8,7 +8,7 @@
     "!build/__tests__",
     "esm"
   ],
-  "version": "25.4.148",
+  "version": "25.5.0",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "module": "./build/esm/index.js",
@@ -73,7 +73,7 @@
     "@sprucelabs/jest-sheets-reporter": "^1.2.290",
     "@sprucelabs/resolve-path-aliases": "^1.0.246",
     "@sprucelabs/semantic-release": "^4.0.8",
-    "@sprucelabs/spruce-test-fixtures": "^19.1.6",
+    "@sprucelabs/spruce-test-fixtures": "^19.1.10",
     "@sprucelabs/test-utils": "^3.0.347",
     "@types/lodash": "^4.14.178",
     "@types/mime-db": "^1.43.1",