@sprucelabs/schema 32.3.1 → 32.3.3

package/build/SchemaTypesRenderer.d.ts

@@ -1,10 +1,12 @@
 import { Schema } from './schemas.static.types';
-import { TemplateLanguage } from './types/template.types';
+import { SchemaTemplateItem, TemplateLanguage } from './types/template.types';
 export default class SchemaTypesRenderer {
     static Renderer(): SchemaTypesRenderer;
     render(schema: Schema, options: {
         language: TemplateLanguage;
+        schemaTemplateItems: SchemaTemplateItem[];
     }): string;
+    private renderName;
     private renderField;
     private renderComment;
     private ucFirst;

package/build/SchemaTypesRenderer.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fields_1 = require("./fields");
+const template_types_1 = require("./types/template.types");
 const assertOptions_1 = __importDefault(require("./utilities/assertOptions"));
 class SchemaTypesRenderer {
     static Renderer() {
@@ -11,24 +12,30 @@ class SchemaTypesRenderer {
     }
     render(schema, options) {
         (0, assertOptions_1.default)({ schema, options }, ['schema', 'options']);
-        const { id, fields } = schema;
-        const name = this.ucFirst(id);
+        const { id, fields, namespace } = schema;
+        const { schemaTemplateItems } = options;
+        const name = this.renderName(id, namespace);
         const comment = this.renderComment(schema);
         let body = '';
         for (const [key, field] of Object.entries(fields ?? {})) {
-            let fieldLine = this.renderField(field, key);
+            let fieldLine = this.renderField(field, key, schemaTemplateItems);
             body += fieldLine;
         }
         return `${comment ? `${comment}\n` : ''}type ${name} struct {
 ${body}}`;
     }
-    renderField(field, key) {
+    renderName(id, namespace) {
+        return `${namespace ? `${namespace}` : ''}${this.ucFirst(id)}`;
+    }
+    renderField(field, key, schemaTemplateItems = []) {
         const FieldClass = fields_1.fieldClassMap[field.type];
         const { valueType, validation } = FieldClass.generateTemplateDetails({
             //@ts-ignore
             definition: field,
             language: 'go',
             importAs: 'SpruceSchema',
+            templateItems: schemaTemplateItems,
+            renderAs: template_types_1.TemplateRenderAs.Type,
         });
         const { hint, isRequired, minArrayLength, isArray } = field;
         let fieldLine = '';
@@ -41,8 +48,8 @@ ${body}}`;
         if (isRequired) {
             validateTags.push('required');
         }
-        if (minArrayLength !== undefined) {
-            validateTags.push(`min=${minArrayLength}`);
+        if ((isArray && isRequired) || minArrayLength !== undefined) {
+            validateTags.push(`min=${minArrayLength ?? 1}`);
         }
         if (!isRequired) {
             fieldLine += ',omitempty"';
@@ -68,7 +75,7 @@ ${body}}`;
             comment = `// ${schema.name}`;
         }
         if (schema.description) {
-            comment += `: ${schema.description}`;
+            comment += `${schema.name ? ': ' : '// '}${schema.description}`;
         }
         return comment;
     }

package/build/esm/SchemaTypesRenderer.d.ts

@@ -1,10 +1,12 @@
 import { Schema } from './schemas.static.types';
-import { TemplateLanguage } from './types/template.types';
+import { SchemaTemplateItem, TemplateLanguage } from './types/template.types';
 export default class SchemaTypesRenderer {
     static Renderer(): SchemaTypesRenderer;
     render(schema: Schema, options: {
         language: TemplateLanguage;
+        schemaTemplateItems: SchemaTemplateItem[];
     }): string;
+    private renderName;
     private renderField;
     private renderComment;
     private ucFirst;

package/build/esm/SchemaTypesRenderer.js

@@ -1,4 +1,5 @@
 import { fieldClassMap } from './fields/index.js';
+import { TemplateRenderAs, } from './types/template.types.js';
 import assertOptions from './utilities/assertOptions.js';
 export default class SchemaTypesRenderer {
     static Renderer() {
@@ -6,24 +7,30 @@ export default class SchemaTypesRenderer {
     }
     render(schema, options) {
         assertOptions({ schema, options }, ['schema', 'options']);
-        const { id, fields } = schema;
-        const name = this.ucFirst(id);
+        const { id, fields, namespace } = schema;
+        const { schemaTemplateItems } = options;
+        const name = this.renderName(id, namespace);
         const comment = this.renderComment(schema);
         let body = '';
         for (const [key, field] of Object.entries(fields !== null && fields !== void 0 ? fields : {})) {
-            let fieldLine = this.renderField(field, key);
+            let fieldLine = this.renderField(field, key, schemaTemplateItems);
             body += fieldLine;
         }
         return `${comment ? `${comment}\n` : ''}type ${name} struct {
 ${body}}`;
     }
-    renderField(field, key) {
+    renderName(id, namespace) {
+        return `${namespace ? `${namespace}` : ''}${this.ucFirst(id)}`;
+    }
+    renderField(field, key, schemaTemplateItems = []) {
         const FieldClass = fieldClassMap[field.type];
         const { valueType, validation } = FieldClass.generateTemplateDetails({
             //@ts-ignore
             definition: field,
             language: 'go',
             importAs: 'SpruceSchema',
+            templateItems: schemaTemplateItems,
+            renderAs: TemplateRenderAs.Type,
         });
         const { hint, isRequired, minArrayLength, isArray } = field;
         let fieldLine = '';
@@ -36,8 +43,8 @@ ${body}}`;
         if (isRequired) {
             validateTags.push('required');
         }
-        if (minArrayLength !== undefined) {
-            validateTags.push(`min=${minArrayLength}`);
+        if ((isArray && isRequired) || minArrayLength !== undefined) {
+            validateTags.push(`min=${minArrayLength !== null && minArrayLength !== void 0 ? minArrayLength : 1}`);
         }
         if (!isRequired) {
             fieldLine += ',omitempty"';
@@ -63,7 +70,7 @@ ${body}}`;
             comment = `// ${schema.name}`;
         }
         if (schema.description) {
-            comment += `: ${schema.description}`;
+            comment += `${schema.name ? ': ' : '// '}${schema.description}`;
         }
         return comment;
     }

package/build/esm/fields/RawField.js

@@ -1,8 +1,23 @@
 import AbstractField from './AbstractField.js';
 class RawField extends AbstractField {
     static generateTemplateDetails(options) {
+        const { definition, language } = options;
+        const { isArray } = definition;
+        const { options: fieldOptions } = definition;
+        const { valueType } = fieldOptions;
+        const arrayNotation = isArray ? '[]' : '';
+        let resolvedType = valueType;
+        if (language === 'go') {
+            const goType = valueType === 'Record<string, any>'
+                ? 'map[string]interface{}'
+                : 'interface{}';
+            resolvedType = `${arrayNotation}${goType}`;
+        }
+        else {
+            resolvedType = `${arrayNotation}${valueType}`;
+        }
         return {
-            valueType: `(${options.definition.options.valueType})${options.definition.isArray ? '[]' : ''}`,
+            valueType: resolvedType,
         };
     }
 }

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

@@ -12,6 +12,7 @@ export default class SchemaField<F extends SchemaFieldFieldDefinition = SchemaFi
         valueTypeMapper: string;
     };
     static generateTemplateDetails(options: FieldTemplateDetailOptions<SchemaFieldFieldDefinition>): FieldTemplateDetails;
+    private static findSchemaInTemplateItems;
     private static mapFieldDefinitionToSchemas;
     validate(value: any, options?: ValidateOptions<SchemaFieldFieldDefinition>): FieldError[];
     private Schema;

package/build/esm/fields/SchemaField.js

@@ -48,67 +48,34 @@ class SchemaField extends AbstractField {
         };
     }
     static generateTemplateDetails(options) {
-        const { templateItems, renderAs, definition, globalNamespace } = options;
+        const { templateItems, renderAs, definition, globalNamespace, language, } = options;
+        const { isArray } = definition;
         const { typeSuffix = '' } = definition.options;
-        const idsWithVersion = SchemaField.mapFieldDefinitionToSchemaIdsWithVersion(definition);
+        const idsWithVersion = this.mapFieldDefinitionToSchemaIdsWithVersion(definition);
         const unions = [];
         idsWithVersion.forEach((idWithVersion) => {
-            const { id, version, namespace } = idWithVersion;
-            let allMatches = templateItems.filter((item) => {
-                if (!item.id) {
-                    throwInvalidReferenceError(item);
-                }
-                return item.id.toLowerCase() === id.toLowerCase();
-            });
-            if (namespace) {
-                allMatches = allMatches.filter((item) => {
-                    if (!item.namespace) {
-                        throwInvalidReferenceError(item);
-                    }
-                    return (item.namespace.toLowerCase() === namespace.toLowerCase());
-                });
+            const { version } = idWithVersion;
+            const { namePascal, namespace, id, nameCamel, schema } = this.findSchemaInTemplateItems(idWithVersion, templateItems);
+            let valueType;
+            if (language === 'go') {
+                valueType = `${namespace}${namePascal}`;
             }
-            let matchedTemplateItem;
-            if (allMatches.length === 0) {
-                matchedTemplateItem = allMatches[0];
+            else if (renderAs === TemplateRenderAs.Value) {
+                valueType = `${nameCamel}Schema${schema.version ? `_${schema.version}` : ''}`;
             }
             else {
-                matchedTemplateItem = allMatches.find((d) => d.schema.version === version);
-                if (!matchedTemplateItem) {
-                    throw new SpruceError({
-                        code: 'VERSION_NOT_FOUND',
-                        schemaId: id,
-                    });
-                }
-            }
-            if (matchedTemplateItem) {
-                let valueType;
-                if (renderAs === TemplateRenderAs.Value) {
-                    valueType = `${matchedTemplateItem.nameCamel}Schema${matchedTemplateItem.schema.version
-                        ? `_${matchedTemplateItem.schema.version}`
-                        : ''}`;
-                }
-                else {
-                    valueType = `${globalNamespace}.${matchedTemplateItem.namespace}${version ? `.${version}` : ''}${renderAs === TemplateRenderAs.Type
-                        ? `.${matchedTemplateItem.namePascal + typeSuffix}`
-                        : `.${matchedTemplateItem.namePascal}Schema`}`;
-                    if (renderAs === TemplateRenderAs.Type &&
-                        idsWithVersion.length > 1) {
-                        valueType = `{ id: '${id}', values: ${valueType} }`;
-                    }
+                valueType = `${globalNamespace}.${namespace}${version ? `.${version}` : ''}${renderAs === TemplateRenderAs.Type
+                    ? `.${namePascal + typeSuffix}`
+                    : `.${namePascal}Schema`}`;
+                if (renderAs === TemplateRenderAs.Type &&
+                    idsWithVersion.length > 1) {
+                    valueType = `{ id: '${id}', values: ${valueType} }`;
                 }
-                unions.push({
-                    schemaId: matchedTemplateItem.id,
-                    valueType,
-                });
-            }
-            else {
-                throw new SpruceError({
-                    code: 'SCHEMA_NOT_FOUND',
-                    schemaId: id,
-                    friendlyMessage: `Template generation failed. I could not find a schema that was being referenced. I was looking for a schema with the id of '${id}' and namespace '${namespace !== null && namespace !== void 0 ? namespace : '**missing**'}'.`,
-                });
             }
+            unions.push({
+                schemaId: id,
+                valueType,
+            });
         });
         let valueType;
         if (renderAs === TemplateRenderAs.Value) {
@@ -121,19 +88,55 @@ class SchemaField extends AbstractField {
         }
         else {
             valueType = unions.map((item) => item.valueType).join(' | ');
-            valueType = `${(definition.isArray ||
-                renderAs === TemplateRenderAs.SchemaType) &&
-                unions.length > 1
-                ? `(${valueType})`
-                : `${valueType}`}${(definition.isArray && renderAs === TemplateRenderAs.Type) ||
-                (unions.length > 1 && renderAs === TemplateRenderAs.SchemaType)
-                ? '[]'
-                : ''}`;
+            const shouldRenderAsArray = (isArray && renderAs === TemplateRenderAs.Type) ||
+                (unions.length > 1 && renderAs === TemplateRenderAs.SchemaType);
+            const arrayNotation = shouldRenderAsArray ? '[]' : '';
+            if (language === 'go') {
+                valueType = `*${arrayNotation}${valueType}`;
+            }
+            else {
+                valueType = `${shouldRenderAsArray && unions.length > 1
+                    ? `(${valueType})`
+                    : `${valueType}`}${arrayNotation}`;
+            }
         }
         return {
             valueType,
         };
     }
+    static findSchemaInTemplateItems(idWithVersion, templateItems) {
+        const { id, namespace, version } = idWithVersion;
+        let allMatches = templateItems.filter((item) => {
+            if (!item.id) {
+                throwInvalidReferenceError(item);
+            }
+            return item.id.toLowerCase() === id.toLowerCase();
+        });
+        if (namespace) {
+            allMatches = allMatches.filter((item) => {
+                if (!item.namespace) {
+                    throwInvalidReferenceError(item);
+                }
+                return item.namespace.toLowerCase() === namespace.toLowerCase();
+            });
+        }
+        if (allMatches.length === 0) {
+            throw new SpruceError({
+                code: 'SCHEMA_NOT_FOUND',
+                schemaId: id,
+                friendlyMessage: `Template generation failed. I could not find a schema that was being referenced. I was looking for a schema with the id of '${id}' and namespace '${namespace !== null && namespace !== void 0 ? namespace : '**missing**'}'.`,
+            });
+        }
+        let matchedTemplateItem;
+        matchedTemplateItem = allMatches.find((d) => d.schema.version === version);
+        if (!matchedTemplateItem) {
+            throw new SpruceError({
+                code: 'VERSION_NOT_FOUND',
+                schemaId: id,
+            });
+        }
+        return matchedTemplateItem;
+    }
     static mapFieldDefinitionToSchemas(definition, options) {
         const { schemasById: schemasById = {} } = options || {};
         const schemasOrIds = SchemaField.mapFieldDefinitionToSchemasOrIdsWithVersion(definition);

package/build/fields/RawField.js

@@ -6,8 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const AbstractField_1 = __importDefault(require("./AbstractField"));
 class RawField extends AbstractField_1.default {
     static generateTemplateDetails(options) {
+        const { definition, language } = options;
+        const { isArray } = definition;
+        const { options: fieldOptions } = definition;
+        const { valueType } = fieldOptions;
+        const arrayNotation = isArray ? '[]' : '';
+        let resolvedType = valueType;
+        if (language === 'go') {
+            const goType = valueType === 'Record<string, any>'
+                ? 'map[string]interface{}'
+                : 'interface{}';
+            resolvedType = `${arrayNotation}${goType}`;
+        }
+        else {
+            resolvedType = `${arrayNotation}${valueType}`;
+        }
         return {
-            valueType: `(${options.definition.options.valueType})${options.definition.isArray ? '[]' : ''}`,
+            valueType: resolvedType,
         };
     }
 }

package/build/fields/SchemaField.d.ts

@@ -12,6 +12,7 @@ export default class SchemaField<F extends SchemaFieldFieldDefinition = SchemaFi
         valueTypeMapper: string;
     };
     static generateTemplateDetails(options: FieldTemplateDetailOptions<SchemaFieldFieldDefinition>): FieldTemplateDetails;
+    private static findSchemaInTemplateItems;
     private static mapFieldDefinitionToSchemas;
     validate(value: any, options?: ValidateOptions<SchemaFieldFieldDefinition>): FieldError[];
     private Schema;

package/build/fields/SchemaField.js

@@ -53,67 +53,34 @@ class SchemaField extends AbstractField_1.default {
         };
     }
     static generateTemplateDetails(options) {
-        const { templateItems, renderAs, definition, globalNamespace } = options;
+        const { templateItems, renderAs, definition, globalNamespace, language, } = options;
+        const { isArray } = definition;
         const { typeSuffix = '' } = definition.options;
-        const idsWithVersion = SchemaField.mapFieldDefinitionToSchemaIdsWithVersion(definition);
+        const idsWithVersion = this.mapFieldDefinitionToSchemaIdsWithVersion(definition);
         const unions = [];
         idsWithVersion.forEach((idWithVersion) => {
-            const { id, version, namespace } = idWithVersion;
-            let allMatches = templateItems.filter((item) => {
-                if (!item.id) {
-                    throwInvalidReferenceError(item);
-                }
-                return item.id.toLowerCase() === id.toLowerCase();
-            });
-            if (namespace) {
-                allMatches = allMatches.filter((item) => {
-                    if (!item.namespace) {
-                        throwInvalidReferenceError(item);
-                    }
-                    return (item.namespace.toLowerCase() === namespace.toLowerCase());
-                });
+            const { version } = idWithVersion;
+            const { namePascal, namespace, id, nameCamel, schema } = this.findSchemaInTemplateItems(idWithVersion, templateItems);
+            let valueType;
+            if (language === 'go') {
+                valueType = `${namespace}${namePascal}`;
             }
-            let matchedTemplateItem;
-            if (allMatches.length === 0) {
-                matchedTemplateItem = allMatches[0];
+            else if (renderAs === template_types_1.TemplateRenderAs.Value) {
+                valueType = `${nameCamel}Schema${schema.version ? `_${schema.version}` : ''}`;
             }
             else {
-                matchedTemplateItem = allMatches.find((d) => d.schema.version === version);
-                if (!matchedTemplateItem) {
-                    throw new SpruceError_1.default({
-                        code: 'VERSION_NOT_FOUND',
-                        schemaId: id,
-                    });
-                }
-            }
-            if (matchedTemplateItem) {
-                let valueType;
-                if (renderAs === template_types_1.TemplateRenderAs.Value) {
-                    valueType = `${matchedTemplateItem.nameCamel}Schema${matchedTemplateItem.schema.version
-                        ? `_${matchedTemplateItem.schema.version}`
-                        : ''}`;
-                }
-                else {
-                    valueType = `${globalNamespace}.${matchedTemplateItem.namespace}${version ? `.${version}` : ''}${renderAs === template_types_1.TemplateRenderAs.Type
-                        ? `.${matchedTemplateItem.namePascal + typeSuffix}`
-                        : `.${matchedTemplateItem.namePascal}Schema`}`;
-                    if (renderAs === template_types_1.TemplateRenderAs.Type &&
-                        idsWithVersion.length > 1) {
-                        valueType = `{ id: '${id}', values: ${valueType} }`;
-                    }
+                valueType = `${globalNamespace}.${namespace}${version ? `.${version}` : ''}${renderAs === template_types_1.TemplateRenderAs.Type
+                    ? `.${namePascal + typeSuffix}`
+                    : `.${namePascal}Schema`}`;
+                if (renderAs === template_types_1.TemplateRenderAs.Type &&
+                    idsWithVersion.length > 1) {
+                    valueType = `{ id: '${id}', values: ${valueType} }`;
                 }
-                unions.push({
-                    schemaId: matchedTemplateItem.id,
-                    valueType,
-                });
-            }
-            else {
-                throw new SpruceError_1.default({
-                    code: 'SCHEMA_NOT_FOUND',
-                    schemaId: id,
-                    friendlyMessage: `Template generation failed. I could not find a schema that was being referenced. I was looking for a schema with the id of '${id}' and namespace '${namespace ?? '**missing**'}'.`,
-                });
             }
+            unions.push({
+                schemaId: id,
+                valueType,
+            });
         });
         let valueType;
         if (renderAs === template_types_1.TemplateRenderAs.Value) {
@@ -126,19 +93,55 @@ class SchemaField extends AbstractField_1.default {
         }
         else {
             valueType = unions.map((item) => item.valueType).join(' | ');
-            valueType = `${(definition.isArray ||
-                renderAs === template_types_1.TemplateRenderAs.SchemaType) &&
-                unions.length > 1
-                ? `(${valueType})`
-                : `${valueType}`}${(definition.isArray && renderAs === template_types_1.TemplateRenderAs.Type) ||
-                (unions.length > 1 && renderAs === template_types_1.TemplateRenderAs.SchemaType)
-                ? '[]'
-                : ''}`;
+            const shouldRenderAsArray = (isArray && renderAs === template_types_1.TemplateRenderAs.Type) ||
+                (unions.length > 1 && renderAs === template_types_1.TemplateRenderAs.SchemaType);
+            const arrayNotation = shouldRenderAsArray ? '[]' : '';
+            if (language === 'go') {
+                valueType = `*${arrayNotation}${valueType}`;
+            }
+            else {
+                valueType = `${shouldRenderAsArray && unions.length > 1
+                    ? `(${valueType})`
+                    : `${valueType}`}${arrayNotation}`;
+            }
         }
         return {
             valueType,
         };
     }
+    static findSchemaInTemplateItems(idWithVersion, templateItems) {
+        const { id, namespace, version } = idWithVersion;
+        let allMatches = templateItems.filter((item) => {
+            if (!item.id) {
+                throwInvalidReferenceError(item);
+            }
+            return item.id.toLowerCase() === id.toLowerCase();
+        });
+        if (namespace) {
+            allMatches = allMatches.filter((item) => {
+                if (!item.namespace) {
+                    throwInvalidReferenceError(item);
+                }
+                return item.namespace.toLowerCase() === namespace.toLowerCase();
+            });
+        }
+        if (allMatches.length === 0) {
+            throw new SpruceError_1.default({
+                code: 'SCHEMA_NOT_FOUND',
+                schemaId: id,
+                friendlyMessage: `Template generation failed. I could not find a schema that was being referenced. I was looking for a schema with the id of '${id}' and namespace '${namespace ?? '**missing**'}'.`,
+            });
+        }
+        let matchedTemplateItem;
+        matchedTemplateItem = allMatches.find((d) => d.schema.version === version);
+        if (!matchedTemplateItem) {
+            throw new SpruceError_1.default({
+                code: 'VERSION_NOT_FOUND',
+                schemaId: id,
+            });
+        }
+        return matchedTemplateItem;
+    }
     static mapFieldDefinitionToSchemas(definition, options) {
         const { schemasById: schemasById = {} } = options || {};
         const schemasOrIds = SchemaField.mapFieldDefinitionToSchemasOrIdsWithVersion(definition);

package/package.json

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