@sprucelabs/schema 28.0.1 → 28.0.4

package/build/addons/imageField.addon.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../utilities/registerFieldType").FieldRegistration;
+export default _default;

package/build/addons/imageField.addon.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ImageField_1 = __importDefault(require("../fields/ImageField"));
+const registerFieldType_1 = __importDefault(require("../utilities/registerFieldType"));
+exports.default = (0, registerFieldType_1.default)({
+    type: 'Image',
+    class: ImageField_1.default,
+    package: '@sprucelabs/schema',
+    importAs: 'SpruceSchema',
+});

package/build/esm/addons/imageField.addon.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../utilities/registerFieldType").FieldRegistration;
+export default _default;

package/build/esm/addons/imageField.addon.js

@@ -0,0 +1,8 @@
+import ImageField from '../fields/ImageField.js';
+import registerFieldType from '../utilities/registerFieldType.js';
+export default registerFieldType({
+    type: 'Image',
+    class: ImageField,
+    package: '@sprucelabs/schema',
+    importAs: 'SpruceSchema',
+});

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/AbstractField.js

@@ -32,7 +32,7 @@ public static get description() {
             instructions: `Copy and paste this into ${this.name}:
 			
 public static generateTemplateDetails(
-	options: IFieldTemplateDetailOptions<I{{YourFieldName}}Definition>
+	options: FieldTemplateDetailOptions<{{YourFieldName}}Definition>
 ): IFieldTemplateDetails {
 	const { definition } = options
 	return {

package/build/esm/fields/FileField.js

@@ -5,7 +5,7 @@ export default class FileField extends AbstractField {
     }
     static generateTemplateDetails(options) {
         return {
-            valueType: `${options.importAs}.IFileFieldValue${options.definition.isArray ? '[]' : ''}`,
+            valueType: `${options.importAs}.FileFieldValue${options.definition.isArray ? '[]' : ''}`,
         };
     }
     validate(value, _) {

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

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

package/build/esm/fields/ImageField.js

@@ -1,6 +1,15 @@
 import AbstractField from './AbstractField.js';
 import { requiredImageSizes, } from './ImageField.types.js';
 export default class ImageField extends AbstractField {
+    static generateTemplateDetails(options) {
+        const { definition, importAs } = options;
+        return {
+            valueType: `${importAs}.ImageFieldValue${definition.isArray ? '[]' : ''}`,
+        };
+    }
+    static get description() {
+        return 'Images of various sizes!';
+    }
     validate(value) {
         var _a;
         const errors = super.validate(value);

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/fields/index.d.ts

@@ -37,6 +37,8 @@ export { default as DateTimeField } from './DateTimeField';
 export * from './FileField';
 export * from './FileField.types';
 export { default as FileField } from './FileField';
+export * from './ImageField.types';
+export { default as ImageField } from './ImageField';
 export * from './DateField';
 export * from './DateField.types';
 export { default as DateField } from './DateField';

package/build/esm/fields/index.js

@@ -37,6 +37,8 @@ export { default as DateTimeField } from './DateTimeField.js';
 export * from './FileField.js';
 export * from './FileField.types.js';
 export { default as FileField } from './FileField.js';
+export * from './ImageField.types.js';
+export { default as ImageField } from './ImageField.js';
 export * from './DateField.js';
 export * from './DateField.types.js';
 export { default as DateField } from './DateField.js';

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/AbstractField.js

@@ -37,7 +37,7 @@ public static get description() {
             instructions: `Copy and paste this into ${this.name}:
 			
 public static generateTemplateDetails(
-	options: IFieldTemplateDetailOptions<I{{YourFieldName}}Definition>
+	options: FieldTemplateDetailOptions<{{YourFieldName}}Definition>
 ): IFieldTemplateDetails {
 	const { definition } = options
 	return {

package/build/fields/FileField.js

@@ -10,7 +10,7 @@ class FileField extends AbstractField_1.default {
     }
     static generateTemplateDetails(options) {
         return {
-            valueType: `${options.importAs}.IFileFieldValue${options.definition.isArray ? '[]' : ''}`,
+            valueType: `${options.importAs}.FileFieldValue${options.definition.isArray ? '[]' : ''}`,
         };
     }
     validate(value, _) {

package/build/fields/ImageField.d.ts

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

package/build/fields/ImageField.js

@@ -6,6 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const AbstractField_1 = __importDefault(require("./AbstractField"));
 const ImageField_types_1 = require("./ImageField.types");
 class ImageField extends AbstractField_1.default {
+    static generateTemplateDetails(options) {
+        const { definition, importAs } = options;
+        return {
+            valueType: `${importAs}.ImageFieldValue${definition.isArray ? '[]' : ''}`,
+        };
+    }
+    static get description() {
+        return 'Images of various sizes!';
+    }
     validate(value) {
         var _a;
         const errors = super.validate(value);

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/fields/index.d.ts

@@ -37,6 +37,8 @@ export { default as DateTimeField } from './DateTimeField';
 export * from './FileField';
 export * from './FileField.types';
 export { default as FileField } from './FileField';
+export * from './ImageField.types';
+export { default as ImageField } from './ImageField';
 export * from './DateField';
 export * from './DateField.types';
 export { default as DateField } from './DateField';

package/build/fields/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fieldClassMap = exports.DateField = exports.FileField = exports.DateTimeField = exports.NumberField = exports.RawField = exports.SchemaField = exports.PhoneField = exports.AddressField = exports.SelectField = exports.IdField = exports.DurationField = exports.DirectoryField = exports.TextField = exports.BooleanField = void 0;
+exports.fieldClassMap = exports.DateField = exports.ImageField = exports.FileField = exports.DateTimeField = exports.NumberField = exports.RawField = exports.SchemaField = exports.PhoneField = exports.AddressField = exports.SelectField = exports.IdField = exports.DurationField = exports.DirectoryField = exports.TextField = exports.BooleanField = void 0;
 __exportStar(require("./BooleanField"), exports);
 __exportStar(require("./BooleanField.types"), exports);
 var BooleanField_1 = require("./BooleanField");
@@ -70,6 +70,9 @@ __exportStar(require("./FileField"), exports);
 __exportStar(require("./FileField.types"), exports);
 var FileField_1 = require("./FileField");
 Object.defineProperty(exports, "FileField", { enumerable: true, get: function () { return __importDefault(FileField_1).default; } });
+__exportStar(require("./ImageField.types"), exports);
+var ImageField_1 = require("./ImageField");
+Object.defineProperty(exports, "ImageField", { enumerable: true, get: function () { return __importDefault(ImageField_1).default; } });
 __exportStar(require("./DateField"), exports);
 __exportStar(require("./DateField.types"), exports);
 var DateField_1 = require("./DateField");

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.1",
+  "version": "28.0.4",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "module": "./build/esm/index.js",