@sprucelabs/schema 31.0.0 → 31.0.1

package/build/esm/fields/SchemaField.js

@@ -197,7 +197,7 @@ class SchemaField extends AbstractField {
                     instance = this.Schema(schemas[0], value);
                 }
                 else if (schemas && schemas.length > 0) {
-                    const { schemaId, version, values } = value || {};
+                    const { id, version, values } = value || {};
                     if (!values) {
                         errors.push({
                             name: this.name,
@@ -207,24 +207,23 @@ class SchemaField extends AbstractField {
                                 this.name,
                         });
                     }
-                    else if (!schemaId) {
+                    else if (!id) {
                         errors.push({
                             name: this.name,
                             label: this.label,
                             code: 'INVALID_PARAMETER',
-                            friendlyMessage: 'You need to add `schemaId` to the value of ' +
+                            friendlyMessage: 'You need to add `id` to the value of ' +
                                 this.name,
                         });
                     }
                     else {
-                        const matchSchema = schemas.find((schema) => schema.id === schemaId &&
-                            schema.version === version);
+                        const matchSchema = schemas.find((schema) => schema.id === id && schema.version === version);
                         if (!matchSchema) {
                             errors.push({
                                 name: this.name,
                                 label: this.label,
                                 code: 'INVALID_PARAMETER',
-                                friendlyMessage: `Could not find a schema by id '${schemaId}'${version
+                                friendlyMessage: `Could not find a schema by id '${id}'${version
                                     ? ` and version '${version}'`
                                     : ' with no version'}.`,
                             });
@@ -260,6 +259,7 @@ class SchemaField extends AbstractField {
     }
     toValueType(value, options) {
         const { createEntityInstances, schemasById: schemasById = {} } = options || {};
+        debugger;
         // try and pull the schema definition from the options and by id
         const destinationSchemas = SchemaField.mapFieldDefinitionToSchemas(this.definition, {
             schemasById,
@@ -275,8 +275,8 @@ class SchemaField extends AbstractField {
         }
         else {
             // this could be one of a few types, lets check the "schemaId" prop
-            const { schemaId, values } = value;
-            const allMatches = destinationSchemas.filter((def) => def.id === schemaId);
+            const { id, values } = value;
+            const allMatches = destinationSchemas.filter((def) => def.id === id);
             let matchedSchema;
             if (allMatches.length === 0) {
                 throw new SpruceError({
@@ -294,7 +294,7 @@ class SchemaField extends AbstractField {
                 if (!matchedSchema) {
                     throw new SpruceError({
                         code: 'VERSION_NOT_FOUND',
-                        schemaId,
+                        schemaId: id,
                     });
                 }
             }
@@ -313,7 +313,7 @@ class SchemaField extends AbstractField {
         };
         if (isUnion) {
             return {
-                schemaId: instance.schemaId,
+                id: instance.schemaId,
                 values: instance.getValues(getValueOptions),
             };
         }

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

@@ -16,11 +16,7 @@ export interface SchemaFieldOptions {
     typeSuffix?: string;
 }
 export type SchemaFieldUnion<S extends Schema[], CreateEntityInstances extends boolean = false> = {
-    [K in keyof S]: S[K] extends Schema ? CreateEntityInstances extends true ? StaticSchemaEntity<S[K]> : {
-        schemaId: S[K]['id'];
-        version?: S[K]['version'];
-        values: SchemaValues<S[K]>;
-    } : any;
+    [K in keyof S]: S[K] extends Schema ? CreateEntityInstances extends true ? StaticSchemaEntity<S[K]> : SchemaFieldValueUnion<SchemaValues<S[K]>, S[K]['id'], S[K]['version']> : any;
 };
 export type SchemaFieldValueTypeMapper<F extends SchemaFieldFieldDefinition, CreateEntityInstances extends boolean = false, ShouldIncludeNullAndUndefinedFields extends boolean = false> = F['options']['schemas'] extends Schema[] ? IsArrayNoUnpack<SchemaFieldUnion<F['options']['schemas'], CreateEntityInstances>[number], F['isArray']> : F['options']['schema'] extends Schema ? CreateEntityInstances extends true ? IsArray<StaticSchemaEntity<F['options']['schema']>, F['isArray']> : IsArray<SchemaValues<F['options']['schema'], false, true, ShouldIncludeNullAndUndefinedFields>, F['isArray']> : any;
 export type SchemaFieldFieldDefinition = FieldDefinition<Record<string, any>, Record<string, any>, SchemaFieldValueUnion[], SchemaFieldValueUnion[]> & {

package/build/esm/schemas.static.types.d.ts

@@ -56,9 +56,9 @@ export interface Schema {
     };
     fields?: SchemaFieldsByName;
 }
-export interface SchemaFieldValueUnion<V extends Record<string, any> = Record<string, any>> {
-    schemaId: string;
-    version?: string;
+export interface SchemaFieldValueUnion<V extends Record<string, any> = Record<string, any>, Id extends string = string, Version extends string | undefined = undefined> {
+    id: Id;
+    version?: Version;
     values: V;
 }
 export type SchemaFields<T extends Schema> = {

package/build/fields/SchemaField.js

@@ -201,7 +201,7 @@ class SchemaField extends AbstractField_1.default {
                     instance = this.Schema(schemas[0], value);
                 }
                 else if (schemas && schemas.length > 0) {
-                    const { schemaId, version, values } = value || {};
+                    const { id, version, values } = value || {};
                     if (!values) {
                         errors.push({
                             name: this.name,
@@ -211,24 +211,23 @@ class SchemaField extends AbstractField_1.default {
                                 this.name,
                         });
                     }
-                    else if (!schemaId) {
+                    else if (!id) {
                         errors.push({
                             name: this.name,
                             label: this.label,
                             code: 'INVALID_PARAMETER',
-                            friendlyMessage: 'You need to add `schemaId` to the value of ' +
+                            friendlyMessage: 'You need to add `id` to the value of ' +
                                 this.name,
                         });
                     }
                     else {
-                        const matchSchema = schemas.find((schema) => schema.id === schemaId &&
-                            schema.version === version);
+                        const matchSchema = schemas.find((schema) => schema.id === id && schema.version === version);
                         if (!matchSchema) {
                             errors.push({
                                 name: this.name,
                                 label: this.label,
                                 code: 'INVALID_PARAMETER',
-                                friendlyMessage: `Could not find a schema by id '${schemaId}'${version
+                                friendlyMessage: `Could not find a schema by id '${id}'${version
                                     ? ` and version '${version}'`
                                     : ' with no version'}.`,
                             });
@@ -264,6 +263,7 @@ class SchemaField extends AbstractField_1.default {
     }
     toValueType(value, options) {
         const { createEntityInstances, schemasById: schemasById = {} } = options || {};
+        debugger;
         // try and pull the schema definition from the options and by id
         const destinationSchemas = SchemaField.mapFieldDefinitionToSchemas(this.definition, {
             schemasById,
@@ -279,8 +279,8 @@ class SchemaField extends AbstractField_1.default {
         }
         else {
             // this could be one of a few types, lets check the "schemaId" prop
-            const { schemaId, values } = value;
-            const allMatches = destinationSchemas.filter((def) => def.id === schemaId);
+            const { id, values } = value;
+            const allMatches = destinationSchemas.filter((def) => def.id === id);
             let matchedSchema;
             if (allMatches.length === 0) {
                 throw new SpruceError_1.default({
@@ -298,7 +298,7 @@ class SchemaField extends AbstractField_1.default {
                 if (!matchedSchema) {
                     throw new SpruceError_1.default({
                         code: 'VERSION_NOT_FOUND',
-                        schemaId,
+                        schemaId: id,
                     });
                 }
             }
@@ -317,7 +317,7 @@ class SchemaField extends AbstractField_1.default {
         };
         if (isUnion) {
             return {
-                schemaId: instance.schemaId,
+                id: instance.schemaId,
                 values: instance.getValues(getValueOptions),
             };
         }

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

@@ -16,11 +16,7 @@ export interface SchemaFieldOptions {
     typeSuffix?: string;
 }
 export type SchemaFieldUnion<S extends Schema[], CreateEntityInstances extends boolean = false> = {
-    [K in keyof S]: S[K] extends Schema ? CreateEntityInstances extends true ? StaticSchemaEntity<S[K]> : {
-        schemaId: S[K]['id'];
-        version?: S[K]['version'];
-        values: SchemaValues<S[K]>;
-    } : any;
+    [K in keyof S]: S[K] extends Schema ? CreateEntityInstances extends true ? StaticSchemaEntity<S[K]> : SchemaFieldValueUnion<SchemaValues<S[K]>, S[K]['id'], S[K]['version']> : any;
 };
 export type SchemaFieldValueTypeMapper<F extends SchemaFieldFieldDefinition, CreateEntityInstances extends boolean = false, ShouldIncludeNullAndUndefinedFields extends boolean = false> = F['options']['schemas'] extends Schema[] ? IsArrayNoUnpack<SchemaFieldUnion<F['options']['schemas'], CreateEntityInstances>[number], F['isArray']> : F['options']['schema'] extends Schema ? CreateEntityInstances extends true ? IsArray<StaticSchemaEntity<F['options']['schema']>, F['isArray']> : IsArray<SchemaValues<F['options']['schema'], false, true, ShouldIncludeNullAndUndefinedFields>, F['isArray']> : any;
 export type SchemaFieldFieldDefinition = FieldDefinition<Record<string, any>, Record<string, any>, SchemaFieldValueUnion[], SchemaFieldValueUnion[]> & {

package/build/schemas.static.types.d.ts

@@ -56,9 +56,9 @@ export interface Schema {
     };
     fields?: SchemaFieldsByName;
 }
-export interface SchemaFieldValueUnion<V extends Record<string, any> = Record<string, any>> {
-    schemaId: string;
-    version?: string;
+export interface SchemaFieldValueUnion<V extends Record<string, any> = Record<string, any>, Id extends string = string, Version extends string | undefined = undefined> {
+    id: Id;
+    version?: Version;
     values: V;
 }
 export type SchemaFields<T extends Schema> = {

package/package.json

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