rads-db 3.2.23 → 3.2.25

package/integrations/getOpenApiSpec.cjs

@@ -94,14 +94,136 @@ function buildObjectSchema(entity, schema, allOptional = false) {
     } : {})
   };
 }
-const whereSchema = {
+const WHERE_OPERATORS_DESCRIPTION = "Suffix operators: strings \u2014 _in, _ieq, _istartsWith, _startsWith, _icontains, _contains, _iendsWith, _endsWith, _gt, _gte, _lt, _lte; numbers \u2014 _in, _gt, _gte, _lt, _lte; optional fields \u2014 _isNull; arrays \u2014 _isEmpty; JSON \u2014 _jsonContains";
+const relationWhereOas = () => ({
   type: "object",
-  additionalProperties: true
-};
-const includeSchema = {
-  type: "object",
-  additionalProperties: true
-};
+  properties: {
+    id: {
+      type: "string"
+    },
+    id_in: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    }
+  }
+});
+function buildWhereProps(typeDef, schema) {
+  const props = {};
+  for (const [, field] of Object.entries(typeDef.fields ?? {})) {
+    if (field.isInverseRelation) continue;
+    const {
+      name,
+      type,
+      isRelation,
+      isRequired,
+      isArray
+    } = field;
+    const entry = schema[type];
+    const isEnum = !!entry?.enumValues;
+    const isObject = !!entry?.fields;
+    const optional = !isRequired;
+    const enumSchema = isEnum ? {
+      type: "string",
+      enum: Object.keys(entry.enumValues)
+    } : {};
+    if (isArray) {
+      if (isEnum) props[`${name}_arrayContains`] = enumSchema;else if (!entry) props[`${name}_arrayContains`] = primitiveToOas(type);else if (isRelation) props[`${name}_some`] = relationWhereOas();else if (isObject) props[`${name}_some`] = {
+        $ref: `#/components/schemas/${type}Where`
+      };
+      props[`${name}_isEmpty`] = {
+        type: "boolean"
+      };
+      if (optional) props[`${name}_isNull`] = {
+        type: "boolean"
+      };
+      continue;
+    }
+    if (isRelation) {
+      props[name] = relationWhereOas();
+    } else if (isObject) {
+      props[name] = {
+        $ref: `#/components/schemas/${type}Where`
+      };
+    } else if (isEnum) {
+      props[name] = enumSchema;
+    } else if (type === "Record<string, any>") {
+      props[`${name}_jsonContains`] = {
+        $ref: "#/components/schemas/WhereJsonContains"
+      };
+    } else {
+      props[name] = primitiveToOas(type);
+    }
+    if (optional) props[`${name}_isNull`] = {
+      type: "boolean"
+    };
+  }
+  return props;
+}
+function buildWhereSchema(typeName, typeDef, schema) {
+  const selfRef = `#/components/schemas/${typeName}Where`;
+  return {
+    type: "object",
+    description: WHERE_OPERATORS_DESCRIPTION,
+    additionalProperties: true,
+    properties: {
+      _not: {
+        $ref: selfRef
+      },
+      _and: {
+        type: "array",
+        items: {
+          $ref: selfRef
+        }
+      },
+      _or: {
+        type: "array",
+        items: {
+          $ref: selfRef
+        }
+      },
+      ...buildWhereProps(typeDef, schema)
+    }
+  };
+}
+function buildIncludeSchema(typeDef, schema) {
+  const primitiveFields = [];
+  const includeProps = {};
+  for (const [, field] of Object.entries(typeDef.fields ?? {})) {
+    if (field.isInverseRelation) continue;
+    const entry = schema[field.type];
+    const canSubInclude = field.isRelation || entry?.fields && !entry.enumValues;
+    if (canSubInclude) {
+      includeProps[field.name] = {
+        $ref: `#/components/schemas/${field.type}Include`
+      };
+    } else {
+      primitiveFields.push(field.name);
+    }
+  }
+  return {
+    type: "object",
+    properties: {
+      _pick: {
+        type: "array",
+        items: {
+          type: "string",
+          enum: primitiveFields
+        }
+      },
+      ...includeProps
+    }
+  };
+}
+function buildAggEnum(typeDef) {
+  const values = ["_count"];
+  for (const [, field] of Object.entries(typeDef.fields ?? {})) {
+    if (field.isInverseRelation || field.isArray || field.isRelation) continue;
+    if (field.type === "number") values.push(`${field.name}_min`, `${field.name}_max`, `${field.name}_sum`);
+  }
+  return values;
+}
 const paginationProps = {
   cursor: {
     type: "string"
@@ -121,36 +243,6 @@ const paginationProps = {
     description: "Multiple order-by expressions"
   }
 };
-const getRequestSchema = {
-  type: "object",
-  properties: {
-    where: whereSchema,
-    include: includeSchema
-  }
-};
-const getManyRequestSchema = {
-  type: "object",
-  properties: {
-    where: whereSchema,
-    include: includeSchema,
-    ...paginationProps
-  }
-};
-const getAggRequestSchema = {
-  type: "object",
-  required: ["agg"],
-  properties: {
-    where: whereSchema,
-    agg: {
-      type: "array",
-      items: {
-        type: "string"
-      },
-      description: 'Aggregation operations: "_count", "field_min", "field_max", "field_sum"'
-    },
-    ...paginationProps
-  }
-};
 function jsonBody(s) {
   return {
     required: true,
@@ -182,6 +274,22 @@ function getOpenApiSpec(options, openApiOptions) {
   const base = prefix.endsWith("/") ? prefix.slice(0, -1) : prefix;
   const paths = {};
   const schemas = {};
+  schemas.WhereJsonContains = {
+    type: "object",
+    required: ["path"],
+    properties: {
+      path: {
+        type: "string",
+        description: 'JSON path, e.g. "meta.countries[0].name"'
+      },
+      isNull: {
+        type: "boolean"
+      },
+      value: {
+        description: "Expected value at path (string, number, or boolean)"
+      }
+    }
+  };
   paths[`${base}/me`] = {
     get: {
       summary: "Get current user",
@@ -260,17 +368,52 @@ function getOpenApiSpec(options, openApiOptions) {
       handlePlural
     } = entity;
     const tag = name;
-    schemas[name] = buildObjectSchema(entity, schema);
-    schemas[`${name}Put`] = buildObjectSchema(entity, schema, true);
-    schemas[`${name}Put`].required = ["id"];
     const ref = n => ({
       $ref: `#/components/schemas/${n}`
     });
+    schemas[name] = buildObjectSchema(entity, schema);
+    schemas[`${name}Put`] = buildObjectSchema(entity, schema, true);
+    schemas[`${name}Put`].required = ["id"];
+    schemas[`${name}Where`] = buildWhereSchema(name, entity, schema);
+    schemas[`${name}Include`] = buildIncludeSchema(entity, schema);
+    const aggValues = buildAggEnum(entity);
+    const aggSchema = {
+      type: "array",
+      items: {
+        type: "string",
+        enum: aggValues
+      },
+      description: "Aggregation operations to compute"
+    };
+    const getReqBody = {
+      type: "object",
+      properties: {
+        where: ref(`${name}Where`),
+        include: ref(`${name}Include`)
+      }
+    };
+    const getManyReqBody = {
+      type: "object",
+      properties: {
+        where: ref(`${name}Where`),
+        include: ref(`${name}Include`),
+        ...paginationProps
+      }
+    };
+    const getAggReqBody = {
+      type: "object",
+      required: ["agg"],
+      properties: {
+        where: ref(`${name}Where`),
+        agg: aggSchema,
+        ...paginationProps
+      }
+    };
     paths[`${base}/${handle}`] = {
       post: {
         summary: `Get ${name}`,
         tags: [tag],
-        requestBody: jsonBody(getRequestSchema),
+        requestBody: jsonBody(getReqBody),
         responses: jsonOk(ref(name), `${name} object`)
       },
       put: {
@@ -290,7 +433,7 @@ function getOpenApiSpec(options, openApiOptions) {
       post: {
         summary: `Get many ${name} objects`,
         tags: [tag],
-        requestBody: jsonBody(getManyRequestSchema),
+        requestBody: jsonBody(getManyReqBody),
         responses: jsonOk({
           type: "object",
           required: ["nodes"],
@@ -329,7 +472,7 @@ function getOpenApiSpec(options, openApiOptions) {
       post: {
         summary: `Aggregate ${name} data`,
         tags: [tag],
-        requestBody: jsonBody(getAggRequestSchema),
+        requestBody: jsonBody(getAggReqBody),
         responses: jsonOk({
           type: "object",
           additionalProperties: {
@@ -342,7 +485,7 @@ function getOpenApiSpec(options, openApiOptions) {
   }
   for (const key in schema) {
     const entry = schema[key];
-    if (entry.decorators?.entity || schemas[key]) continue;
+    if (entry.decorators?.entity) continue;
     if (entry.enumValues) {
       schemas[key] = {
         type: "string",
@@ -352,7 +495,9 @@ function getOpenApiSpec(options, openApiOptions) {
         } : {})
       };
     } else if (entry.fields) {
-      schemas[key] = buildObjectSchema(entry, schema);
+      if (!schemas[key]) schemas[key] = buildObjectSchema(entry, schema);
+      schemas[`${key}Where`] = buildWhereSchema(key, entry, schema);
+      schemas[`${key}Include`] = buildIncludeSchema(entry, schema);
     }
   }
   return {

package/integrations/getOpenApiSpec.mjs

@@ -52,35 +52,94 @@ function buildObjectSchema(entity, schema, allOptional = false) {
     ...required.length > 0 ? { required } : {}
   };
 }
-const whereSchema = { type: "object", additionalProperties: true };
-const includeSchema = { type: "object", additionalProperties: true };
+const WHERE_OPERATORS_DESCRIPTION = "Suffix operators: strings \u2014 _in, _ieq, _istartsWith, _startsWith, _icontains, _contains, _iendsWith, _endsWith, _gt, _gte, _lt, _lte; numbers \u2014 _in, _gt, _gte, _lt, _lte; optional fields \u2014 _isNull; arrays \u2014 _isEmpty; JSON \u2014 _jsonContains";
+const relationWhereOas = () => ({
+  type: "object",
+  properties: { id: { type: "string" }, id_in: { type: "array", items: { type: "string" } } }
+});
+function buildWhereProps(typeDef, schema) {
+  const props = {};
+  for (const [, field] of Object.entries(typeDef.fields ?? {})) {
+    if (field.isInverseRelation) continue;
+    const { name, type, isRelation, isRequired, isArray } = field;
+    const entry = schema[type];
+    const isEnum = !!entry?.enumValues;
+    const isObject = !!entry?.fields;
+    const optional = !isRequired;
+    const enumSchema = isEnum ? { type: "string", enum: Object.keys(entry.enumValues) } : {};
+    if (isArray) {
+      if (isEnum) props[`${name}_arrayContains`] = enumSchema;
+      else if (!entry) props[`${name}_arrayContains`] = primitiveToOas(type);
+      else if (isRelation) props[`${name}_some`] = relationWhereOas();
+      else if (isObject) props[`${name}_some`] = { $ref: `#/components/schemas/${type}Where` };
+      props[`${name}_isEmpty`] = { type: "boolean" };
+      if (optional) props[`${name}_isNull`] = { type: "boolean" };
+      continue;
+    }
+    if (isRelation) {
+      props[name] = relationWhereOas();
+    } else if (isObject) {
+      props[name] = { $ref: `#/components/schemas/${type}Where` };
+    } else if (isEnum) {
+      props[name] = enumSchema;
+    } else if (type === "Record<string, any>") {
+      props[`${name}_jsonContains`] = { $ref: "#/components/schemas/WhereJsonContains" };
+    } else {
+      props[name] = primitiveToOas(type);
+    }
+    if (optional) props[`${name}_isNull`] = { type: "boolean" };
+  }
+  return props;
+}
+function buildWhereSchema(typeName, typeDef, schema) {
+  const selfRef = `#/components/schemas/${typeName}Where`;
+  return {
+    type: "object",
+    description: WHERE_OPERATORS_DESCRIPTION,
+    additionalProperties: true,
+    properties: {
+      _not: { $ref: selfRef },
+      _and: { type: "array", items: { $ref: selfRef } },
+      _or: { type: "array", items: { $ref: selfRef } },
+      ...buildWhereProps(typeDef, schema)
+    }
+  };
+}
+function buildIncludeSchema(typeDef, schema) {
+  const primitiveFields = [];
+  const includeProps = {};
+  for (const [, field] of Object.entries(typeDef.fields ?? {})) {
+    if (field.isInverseRelation) continue;
+    const entry = schema[field.type];
+    const canSubInclude = field.isRelation || entry?.fields && !entry.enumValues;
+    if (canSubInclude) {
+      includeProps[field.name] = { $ref: `#/components/schemas/${field.type}Include` };
+    } else {
+      primitiveFields.push(field.name);
+    }
+  }
+  return {
+    type: "object",
+    properties: {
+      _pick: { type: "array", items: { type: "string", enum: primitiveFields } },
+      ...includeProps
+    }
+  };
+}
+function buildAggEnum(typeDef) {
+  const values = ["_count"];
+  for (const [, field] of Object.entries(typeDef.fields ?? {})) {
+    if (field.isInverseRelation || field.isArray || field.isRelation) continue;
+    if (field.type === "number") values.push(`${field.name}_min`, `${field.name}_max`, `${field.name}_sum`);
+  }
+  return values;
+}
 const paginationProps = {
   cursor: { type: "string" },
   maxItemCount: { type: "integer" },
   orderBy: { type: "string", description: 'Single order-by expression, e.g. "name_asc"' },
   orderByArray: { type: "array", items: { type: "string" }, description: "Multiple order-by expressions" }
 };
-const getRequestSchema = {
-  type: "object",
-  properties: { where: whereSchema, include: includeSchema }
-};
-const getManyRequestSchema = {
-  type: "object",
-  properties: { where: whereSchema, include: includeSchema, ...paginationProps }
-};
-const getAggRequestSchema = {
-  type: "object",
-  required: ["agg"],
-  properties: {
-    where: whereSchema,
-    agg: {
-      type: "array",
-      items: { type: "string" },
-      description: 'Aggregation operations: "_count", "field_min", "field_max", "field_sum"'
-    },
-    ...paginationProps
-  }
-};
 function jsonBody(s) {
   return { required: true, content: { "application/json": { schema: s } } };
 }
@@ -93,6 +152,15 @@ export function getOpenApiSpec(options, openApiOptions) {
   const base = prefix.endsWith("/") ? prefix.slice(0, -1) : prefix;
   const paths = {};
   const schemas = {};
+  schemas.WhereJsonContains = {
+    type: "object",
+    required: ["path"],
+    properties: {
+      path: { type: "string", description: 'JSON path, e.g. "meta.countries[0].name"' },
+      isNull: { type: "boolean" },
+      value: { description: "Expected value at path (string, number, or boolean)" }
+    }
+  };
   paths[`${base}/me`] = {
     get: {
       summary: "Get current user",
@@ -143,15 +211,36 @@ export function getOpenApiSpec(options, openApiOptions) {
     if (!entity.decorators?.entity) continue;
     const { name, handle, handlePlural } = entity;
     const tag = name;
+    const ref = (n) => ({ $ref: `#/components/schemas/${n}` });
     schemas[name] = buildObjectSchema(entity, schema);
     schemas[`${name}Put`] = buildObjectSchema(entity, schema, true);
     schemas[`${name}Put`].required = ["id"];
-    const ref = (n) => ({ $ref: `#/components/schemas/${n}` });
+    schemas[`${name}Where`] = buildWhereSchema(name, entity, schema);
+    schemas[`${name}Include`] = buildIncludeSchema(entity, schema);
+    const aggValues = buildAggEnum(entity);
+    const aggSchema = {
+      type: "array",
+      items: { type: "string", enum: aggValues },
+      description: "Aggregation operations to compute"
+    };
+    const getReqBody = {
+      type: "object",
+      properties: { where: ref(`${name}Where`), include: ref(`${name}Include`) }
+    };
+    const getManyReqBody = {
+      type: "object",
+      properties: { where: ref(`${name}Where`), include: ref(`${name}Include`), ...paginationProps }
+    };
+    const getAggReqBody = {
+      type: "object",
+      required: ["agg"],
+      properties: { where: ref(`${name}Where`), agg: aggSchema, ...paginationProps }
+    };
     paths[`${base}/${handle}`] = {
       post: {
         summary: `Get ${name}`,
         tags: [tag],
-        requestBody: jsonBody(getRequestSchema),
+        requestBody: jsonBody(getReqBody),
         responses: jsonOk(ref(name), `${name} object`)
       },
       put: {
@@ -169,7 +258,7 @@ export function getOpenApiSpec(options, openApiOptions) {
       post: {
         summary: `Get many ${name} objects`,
         tags: [tag],
-        requestBody: jsonBody(getManyRequestSchema),
+        requestBody: jsonBody(getManyReqBody),
         responses: jsonOk(
           {
             type: "object",
@@ -197,7 +286,7 @@ export function getOpenApiSpec(options, openApiOptions) {
       post: {
         summary: `Aggregate ${name} data`,
         tags: [tag],
-        requestBody: jsonBody(getAggRequestSchema),
+        requestBody: jsonBody(getAggReqBody),
         responses: jsonOk(
           { type: "object", additionalProperties: { type: "number", nullable: true } },
           `${name} aggregation result`
@@ -207,7 +296,7 @@ export function getOpenApiSpec(options, openApiOptions) {
   }
   for (const key in schema) {
     const entry = schema[key];
-    if (entry.decorators?.entity || schemas[key]) continue;
+    if (entry.decorators?.entity) continue;
     if (entry.enumValues) {
       schemas[key] = {
         type: "string",
@@ -215,7 +304,9 @@ export function getOpenApiSpec(options, openApiOptions) {
         ...entry.comment ? { description: entry.comment } : {}
       };
     } else if (entry.fields) {
-      schemas[key] = buildObjectSchema(entry, schema);
+      if (!schemas[key]) schemas[key] = buildObjectSchema(entry, schema);
+      schemas[`${key}Where`] = buildWhereSchema(key, entry, schema);
+      schemas[`${key}Include`] = buildIncludeSchema(entry, schema);
     }
   }
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rads-db",
-  "version": "3.2.23",
+  "version": "3.2.25",
   "description": "Say goodbye to boilerplate code and hello to efficient and elegant syntax.",
   "author": "",
   "license": "ISC",