rads-db 3.0.10 → 3.0.12

package/dist/index.cjs

@@ -45,7 +45,7 @@ function getZodSchema(zodSchemas, schema, key) {
     return zodSchemas[key];
   const type = schema[key];
   if (type.enumValues) {
-    const enums = ___default.fromPairs(type.enumValues.map((x) => [x, x]));
+    const enums = ___default.mapValues(type.enumValues, (v) => v.name);
     return zod.z.nativeEnum(enums);
   }
   const objectSchema = {};
@@ -603,7 +603,7 @@ function validateEventSourcingSetup(schema, entityName, eventEntityName, aggrega
     if (!field)
       throw new Error(`"${eventEntityName}" must have field "${f}"`);
     if (expectedFields[f] === "enum") {
-      if (!schema[field.type]?.enumValues?.includes("creation"))
+      if (!schema[field.type]?.enumValues?.creation)
         throw new Error(`Field "${eventEntityName}.${f}" must be enum that accepts value 'creation'`);
     } else {
       if (field.type !== expectedFields[f])

package/dist/index.d.ts

@@ -112,6 +112,8 @@ interface UiFieldDecoratorArgs {
     icon?: string;
     /** Free text - hint to display under editor field in UI */
     hint?: string;
+    /** If true, field is hidden from the rads-ui */
+    isHidden?: boolean;
     /** TODO: Preferred component to display or edit this value */
     component?: string;
 }
@@ -142,6 +144,8 @@ interface UiDecoratorArgs<T = any> {
     searchOperator?: 'startsWith' | 'istartsWith' | 'contains' | 'icontains';
     /** Defines section name in rads-ui where this entity will be grouped under */
     group?: string;
+    /** If true, field is hidden from the rads-ui */
+    isHidden?: boolean;
 }
 interface EntityDecoratorArgs {
     driver?: string;
@@ -199,7 +203,7 @@ interface TypeDefinition {
     computedFields?: string[];
     nestedTypeFields?: string[];
     fields?: Record<string, FieldDefinition>;
-    enumValues?: string[];
+    enumValues?: Record<string, EnumDefinition>;
     handle?: string;
     handlePlural?: string;
 }
@@ -260,6 +264,11 @@ interface FieldDefinition {
     comment?: string;
     decorators?: Record<string, Record<string, any>>;
 }
+interface EnumDefinition {
+    name: string;
+    comment?: string;
+    decorators?: Record<string, Record<string, any>>;
+}
 interface ComputedContextGlobal {
     db: RadsDb;
     schema: Schema;
@@ -380,4 +389,4 @@ declare function createRadsDb(args?: CreateRadsDbArgs): RadsDb;
  */
 declare function createRadsDbClient(args?: CreateRadsDbClientArgs): RadsDb;
 
-export { Change, ComputedContext, ComputedContextGlobal, ComputedDecoratorArgs, CreateRadsArgsDrivers, CreateRadsDbArgs, CreateRadsDbArgsNormalized, CreateRadsDbClientArgs, DeepPartial, Driver, DriverConstructor, EntityDecoratorArgs, EntityMethods, FieldDecoratorArgs, FieldDefinition, FileSystemNode, FileUploadArgs, FileUploadDriver, GenerateClientNormalizedOptions, GenerateClientOptions, GetAggArgs, GetAggArgsAgg, GetAggArgsAny, GetAggResponse, GetArgs, GetArgsAny, GetArgsInclude, GetManyArgs, GetManyArgsAny, GetManyResponse, GetResponse, GetResponseInclude, GetResponseIncludeSelect, GetResponseNoInclude, GetRestRoutesArgs, GetRestRoutesOptions, GetRestRoutesResponse, MinimalDriver, PutArgs, PutEffect, RadsFeature, RadsRequestContext, RadsUiSlotDefinition, RadsUiSlotName, RadsVitePluginOptions, Relation, RequiredFields, RestDriverOptions, RestFileUploadDriverOptions, Schema, SchemaValidators, TypeDefinition, UiDecoratorArgs, UiFieldDecoratorArgs, ValidateEntityDecoratorArgs, ValidateFieldDecoratorArgs, ValidateStringDecoratorArgs, VerifyManyArgs, VerifyManyArgsAny, VerifyManyResponse, computed, createRadsDb, createRadsDbClient, entity, field, getDriverInstance, precomputed, ui, validate };
+export { Change, ComputedContext, ComputedContextGlobal, ComputedDecoratorArgs, CreateRadsArgsDrivers, CreateRadsDbArgs, CreateRadsDbArgsNormalized, CreateRadsDbClientArgs, DeepPartial, Driver, DriverConstructor, EntityDecoratorArgs, EntityMethods, EnumDefinition, FieldDecoratorArgs, FieldDefinition, FileSystemNode, FileUploadArgs, FileUploadDriver, GenerateClientNormalizedOptions, GenerateClientOptions, GetAggArgs, GetAggArgsAgg, GetAggArgsAny, GetAggResponse, GetArgs, GetArgsAny, GetArgsInclude, GetManyArgs, GetManyArgsAny, GetManyResponse, GetResponse, GetResponseInclude, GetResponseIncludeSelect, GetResponseNoInclude, GetRestRoutesArgs, GetRestRoutesOptions, GetRestRoutesResponse, MinimalDriver, PutArgs, PutEffect, RadsFeature, RadsRequestContext, RadsUiSlotDefinition, RadsUiSlotName, RadsVitePluginOptions, Relation, RequiredFields, RestDriverOptions, RestFileUploadDriverOptions, Schema, SchemaValidators, TypeDefinition, UiDecoratorArgs, UiFieldDecoratorArgs, ValidateEntityDecoratorArgs, ValidateFieldDecoratorArgs, ValidateStringDecoratorArgs, VerifyManyArgs, VerifyManyArgsAny, VerifyManyResponse, computed, createRadsDb, createRadsDbClient, entity, field, getDriverInstance, precomputed, ui, validate };

package/dist/index.mjs

@@ -37,7 +37,7 @@ function getZodSchema(zodSchemas, schema, key) {
     return zodSchemas[key];
   const type = schema[key];
   if (type.enumValues) {
-    const enums = _.fromPairs(type.enumValues.map((x) => [x, x]));
+    const enums = _.mapValues(type.enumValues, (v) => v.name);
     return z.nativeEnum(enums);
   }
   const objectSchema = {};
@@ -595,7 +595,7 @@ function validateEventSourcingSetup(schema, entityName, eventEntityName, aggrega
     if (!field)
       throw new Error(`"${eventEntityName}" must have field "${f}"`);
     if (expectedFields[f] === "enum") {
-      if (!schema[field.type]?.enumValues?.includes("creation"))
+      if (!schema[field.type]?.enumValues?.creation)
         throw new Error(`Field "${eventEntityName}.${f}" must be enum that accepts value 'creation'`);
     } else {
       if (field.type !== expectedFields[f])

package/integrations/lib.cjs

@@ -191,7 +191,7 @@ function parseDecorators(modifiers, ctx) {
   return decorators;
 }
 function getEnumValues(node, parentNode, ctx) {
-  return node.types.map(node2 => {
+  const enumValuesArray = node.types.map(node2 => {
     if (node2.kind !== _typescript.SyntaxKind.LiteralType) {
       throw new Error(`Unexpected type definition - ${parentNode.getText(ctx.sourceFile)}`);
     }
@@ -199,8 +199,11 @@ function getEnumValues(node, parentNode, ctx) {
       literal
     } = node2;
     if (literal.kind !== _typescript.SyntaxKind.StringLiteral) throw new Error(`Unexpected type definition - ${parentNode.getText(ctx.sourceFile)}`);
-    return literal.text;
+    return {
+      name: literal.text
+    };
   });
+  return _lodash.default.keyBy(enumValuesArray, "name");
 }
 function parseClassMember(node, parentName, ctx) {
   const name = node.name.getText(ctx.sourceFile);
@@ -289,8 +292,8 @@ function parseFieldTypeRecordEnum(parsedType, parentName, fieldName, ctx) {
   const enumValues = ctx.result[keyTypeName].enumValues;
   if (!enumValues) throw new Error(`Unexpected type - ${keyTypeName}`);
   const newTypeName = `${parentName}_${_lodash.default.upperFirst(fieldName)}`;
-  const fieldsArray = enumValues.map(v => ({
-    name: v,
+  const fieldsArray = _lodash.default.values(enumValues).map(v => ({
+    name: v.name,
     type: valueTypeName,
     isRequired: true
   }));
@@ -365,7 +368,11 @@ function getEnumValuesFromKeyOf(nodeType, ctx) {
   }
   if (!ctx.result[typeName]) ctx.result[typeName] = parseType(type.node, typeName, ctx);
   if (!ctx.result[typeName].fields) throw new Error(`Unexpected type - ${typeName}`);
-  return Object.keys(ctx.result[typeName].fields);
+  return _lodash.default.mapValues(ctx.result[typeName].fields || {}, v => ({
+    name: v.name,
+    comment: v.comment,
+    decorators: v.decorators
+  }));
 }
 function getRelationDenormFields(ctx, node) {
   if (node.kind === _typescript.SyntaxKind.LiteralType) {
@@ -392,8 +399,8 @@ function verifyDefaultValueType(isArray, defaultValueDescription, type, supporte
     }
     if (!ctx.result[type] && ctx.typesMap[type]) ctx.result[type] = parseType(ctx.typesMap[type].node, type, ctx);
     const enumValues = ctx.result[type]?.enumValues;
-    if (enumValues && !enumValues.includes(defaultValueDescription.value)) {
-      const enumValuesStr = enumValues.map(x => `'x'`).join(", ");
+    if (enumValues && !enumValues[defaultValueDescription.value]) {
+      const enumValuesStr = _lodash.default.keys(enumValues).map(x => `'x'`).join(", ");
       throw new Error(`Default value must be one of: ${enumValuesStr}`);
     }
   }

package/integrations/lib.mjs

@@ -164,15 +164,16 @@ function parseDecorators(modifiers, ctx) {
   return decorators;
 }
 function getEnumValues(node, parentNode, ctx) {
-  return node.types.map((node2) => {
+  const enumValuesArray = node.types.map((node2) => {
     if (node2.kind !== SyntaxKind.LiteralType) {
       throw new Error(`Unexpected type definition - ${parentNode.getText(ctx.sourceFile)}`);
     }
     const { literal } = node2;
     if (literal.kind !== SyntaxKind.StringLiteral)
       throw new Error(`Unexpected type definition - ${parentNode.getText(ctx.sourceFile)}`);
-    return literal.text;
+    return { name: literal.text };
   });
+  return _.keyBy(enumValuesArray, "name");
 }
 function parseClassMember(node, parentName, ctx) {
   const name = node.name.getText(ctx.sourceFile);
@@ -270,7 +271,7 @@ function parseFieldTypeRecordEnum(parsedType, parentName, fieldName, ctx) {
   if (!enumValues)
     throw new Error(`Unexpected type - ${keyTypeName}`);
   const newTypeName = `${parentName}_${_.upperFirst(fieldName)}`;
-  const fieldsArray = enumValues.map((v) => ({ name: v, type: valueTypeName, isRequired: true }));
+  const fieldsArray = _.values(enumValues).map((v) => ({ name: v.name, type: valueTypeName, isRequired: true }));
   ctx.result[newTypeName] = {
     name: newTypeName,
     decorators: {},
@@ -342,7 +343,11 @@ function getEnumValuesFromKeyOf(nodeType, ctx) {
     ctx.result[typeName] = parseType(type.node, typeName, ctx);
   if (!ctx.result[typeName].fields)
     throw new Error(`Unexpected type - ${typeName}`);
-  return Object.keys(ctx.result[typeName].fields);
+  return _.mapValues(ctx.result[typeName].fields || {}, (v) => ({
+    name: v.name,
+    comment: v.comment,
+    decorators: v.decorators
+  }));
 }
 function getRelationDenormFields(ctx, node) {
   if (node.kind === SyntaxKind.LiteralType) {
@@ -370,8 +375,8 @@ function verifyDefaultValueType(isArray, defaultValueDescription, type, supporte
     if (!ctx.result[type] && ctx.typesMap[type])
       ctx.result[type] = parseType(ctx.typesMap[type].node, type, ctx);
     const enumValues = ctx.result[type]?.enumValues;
-    if (enumValues && !enumValues.includes(defaultValueDescription.value)) {
-      const enumValuesStr = enumValues.map((x) => `'x'`).join(", ");
+    if (enumValues && !enumValues[defaultValueDescription.value]) {
+      const enumValuesStr = _.keys(enumValues).map((x) => `'x'`).join(", ");
       throw new Error(`Default value must be one of: ${enumValuesStr}`);
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rads-db",
-  "version": "3.0.10",
+  "version": "3.0.12",
   "files": [
     "dist",
     "drivers",