@sprucelabs/schema 28.0.2 → 28.0.5

package/build/esm/fields/AbstractField.d.ts

@@ -36,7 +36,7 @@ export default abstract class AbstractField<F extends FieldDefinitions> implemen
     } | {
         relativeTo?: string | undefined;
     } | {
-        requiredSizes: ("s" | "*" | "xxs" | "xs" | "m" | "l" | "xl" | "xxl")[];
+        requiredSizes: ("s" | "*" | "m" | "l" | "xl")[];
     } | undefined;
     get isRequired(): boolean;
     get isPrivate(): boolean;

package/build/esm/fields/ImageField.d.ts

@@ -1,8 +1,9 @@
 import { FieldTemplateDetailOptions, FieldTemplateDetails } from '../types/template.types';
 import AbstractField from './AbstractField';
-import { ImageFieldDefinition, ImageFieldValue } from './ImageField.types';
+import { ImageFieldDefinition } from './ImageField.types';
 export default class ImageField extends AbstractField<ImageFieldDefinition> {
     static generateTemplateDetails(options: FieldTemplateDetailOptions<ImageFieldDefinition>): FieldTemplateDetails;
-    validate(value: ImageFieldValue): import("..").FieldError[];
+    static get description(): string;
+    validate(value: any): import("..").FieldError[];
     private getRequiredSizes;
 }

package/build/esm/fields/ImageField.js

@@ -1,5 +1,5 @@
 import AbstractField from './AbstractField.js';
-import { requiredImageSizes, } from './ImageField.types.js';
+import { requiredImageSizes } from './ImageField.types.js';
 export default class ImageField extends AbstractField {
     static generateTemplateDetails(options) {
         const { definition, importAs } = options;
@@ -7,10 +7,13 @@ export default class ImageField extends AbstractField {
             valueType: `${importAs}.ImageFieldValue${definition.isArray ? '[]' : ''}`,
         };
     }
+    static get description() {
+        return 'Images of various sizes!';
+    }
     validate(value) {
         var _a;
         const errors = super.validate(value);
-        if (errors.length === 0 && !value.base64) {
+        if (value && errors.length === 0 && !value.base64) {
             let sizes = this.getRequiredSizes();
             const missing = [];
             for (const size of sizes) {

package/build/esm/fields/ImageField.types.d.ts

@@ -1,16 +1,20 @@
 import { FieldDefinition } from './field.static.types';
-export declare const requiredImageSizes: readonly ["xxs", "xs", "s", "m", "l", "xl", "xxl", "*"];
+/**
+ * Min dimension for each size
+    xl: 1024
+    l: 500
+    m: 60
+    s: 30
+*/
+export declare const requiredImageSizes: readonly ["s", "m", "l", "xl", "*"];
 export declare type RequiredImageSize = typeof requiredImageSizes[number];
 export interface ImageFieldValue {
     name: string;
     base64?: string;
-    xxsUri?: string;
-    xsUri?: string;
     sUri?: string;
     mUri?: string;
     lUri?: string;
     xlUri?: string;
-    xxlUri?: string;
 }
 export declare type ImageFieldDefinition = FieldDefinition<ImageFieldValue> & {
     /** * .image - a great way to deal with file management */

package/build/esm/fields/ImageField.types.js

@@ -1,10 +1,8 @@
-export const requiredImageSizes = [
-    'xxs',
-    'xs',
-    's',
-    'm',
-    'l',
-    'xl',
-    'xxl',
-    '*',
-];
+/**
+ * Min dimension for each size
+    xl: 1024
+    l: 500
+    m: 60
+    s: 30
+*/
+export const requiredImageSizes = ['s', 'm', 'l', 'xl', '*'];

package/build/esm/index.js

@@ -8,6 +8,7 @@ import durationRegistration from './addons/durationField.addon.js';
 import emailRegistration from './addons/emailField.addon.js';
 import fileRegistration from './addons/fileField.addon.js';
 import idRegistration from './addons/idField.addon.js';
+import imageRegistration from './addons/imageField.addon.js';
 import numberRegistration from './addons/numberField.addon.js';
 import phoneRegistration from './addons/phoneField.addon.js';
 import rawRegistration from './addons/rawField.addon.js';
@@ -64,6 +65,7 @@ export const fieldRegistrations = [
     selectRegistration,
     textRegistration,
     emailRegistration,
+    imageRegistration,
 ];
 export { default as assertOptions } from './utilities/assertOptions.js';
 export { default as mapFieldErrorsToParameterErrors } from './utilities/mapFieldErrorsToParameterErrors.js';

package/build/fields/AbstractField.d.ts

@@ -36,7 +36,7 @@ export default abstract class AbstractField<F extends FieldDefinitions> implemen
     } | {
         relativeTo?: string | undefined;
     } | {
-        requiredSizes: ("s" | "*" | "xxs" | "xs" | "m" | "l" | "xl" | "xxl")[];
+        requiredSizes: ("s" | "*" | "m" | "l" | "xl")[];
     } | undefined;
     get isRequired(): boolean;
     get isPrivate(): boolean;

package/build/fields/ImageField.d.ts

@@ -1,8 +1,9 @@
 import { FieldTemplateDetailOptions, FieldTemplateDetails } from '../types/template.types';
 import AbstractField from './AbstractField';
-import { ImageFieldDefinition, ImageFieldValue } from './ImageField.types';
+import { ImageFieldDefinition } from './ImageField.types';
 export default class ImageField extends AbstractField<ImageFieldDefinition> {
     static generateTemplateDetails(options: FieldTemplateDetailOptions<ImageFieldDefinition>): FieldTemplateDetails;
-    validate(value: ImageFieldValue): import("..").FieldError[];
+    static get description(): string;
+    validate(value: any): import("..").FieldError[];
     private getRequiredSizes;
 }

package/build/fields/ImageField.js

@@ -12,10 +12,13 @@ class ImageField extends AbstractField_1.default {
             valueType: `${importAs}.ImageFieldValue${definition.isArray ? '[]' : ''}`,
         };
     }
+    static get description() {
+        return 'Images of various sizes!';
+    }
     validate(value) {
         var _a;
         const errors = super.validate(value);
-        if (errors.length === 0 && !value.base64) {
+        if (value && errors.length === 0 && !value.base64) {
             let sizes = this.getRequiredSizes();
             const missing = [];
             for (const size of sizes) {

package/build/fields/ImageField.types.d.ts

@@ -1,16 +1,20 @@
 import { FieldDefinition } from './field.static.types';
-export declare const requiredImageSizes: readonly ["xxs", "xs", "s", "m", "l", "xl", "xxl", "*"];
+/**
+ * Min dimension for each size
+    xl: 1024
+    l: 500
+    m: 60
+    s: 30
+*/
+export declare const requiredImageSizes: readonly ["s", "m", "l", "xl", "*"];
 export declare type RequiredImageSize = typeof requiredImageSizes[number];
 export interface ImageFieldValue {
     name: string;
     base64?: string;
-    xxsUri?: string;
-    xsUri?: string;
     sUri?: string;
     mUri?: string;
     lUri?: string;
     xlUri?: string;
-    xxlUri?: string;
 }
 export declare type ImageFieldDefinition = FieldDefinition<ImageFieldValue> & {
     /** * .image - a great way to deal with file management */

package/build/fields/ImageField.types.js

@@ -1,13 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.requiredImageSizes = void 0;
-exports.requiredImageSizes = [
-    'xxs',
-    'xs',
-    's',
-    'm',
-    'l',
-    'xl',
-    'xxl',
-    '*',
-];
+/**
+ * Min dimension for each size
+    xl: 1024
+    l: 500
+    m: 60
+    s: 30
+*/
+exports.requiredImageSizes = ['s', 'm', 'l', 'xl', '*'];

package/build/index.js

@@ -28,6 +28,7 @@ const durationField_addon_1 = __importDefault(require("./addons/durationField.ad
 const emailField_addon_1 = __importDefault(require("./addons/emailField.addon"));
 const fileField_addon_1 = __importDefault(require("./addons/fileField.addon"));
 const idField_addon_1 = __importDefault(require("./addons/idField.addon"));
+const imageField_addon_1 = __importDefault(require("./addons/imageField.addon"));
 const numberField_addon_1 = __importDefault(require("./addons/numberField.addon"));
 const phoneField_addon_1 = __importDefault(require("./addons/phoneField.addon"));
 const rawField_addon_1 = __importDefault(require("./addons/rawField.addon"));
@@ -107,6 +108,7 @@ exports.fieldRegistrations = [
     selectField_addon_1.default,
     textField_addon_1.default,
     emailField_addon_1.default,
+    imageField_addon_1.default,
 ];
 var assertOptions_1 = require("./utilities/assertOptions");
 Object.defineProperty(exports, "assertOptions", { enumerable: true, get: function () { return __importDefault(assertOptions_1).default; } });

package/package.json

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