@web-ts-toolkit/access-router 0.3.0 → 0.4.0

package/index.js

@@ -37,6 +37,17 @@ __export(index_exports, {
   combineRoutes: () => combineRoutes,
   createAccessRuntime: () => createAccessRuntime,
   default: () => index_default,
+  defineRequestSchema: () => defineRequestSchema,
+  fromAjv: () => fromAjv,
+  fromArkType: () => fromArkType,
+  fromIoTs: () => fromIoTs,
+  fromJoi: () => fromJoi,
+  fromStandardSchema: () => fromStandardSchema,
+  fromSuperstruct: () => fromSuperstruct,
+  fromValibot: () => fromValibot,
+  fromVine: () => fromVine,
+  fromYup: () => fromYup,
+  fromZod: () => fromZod,
   getDefaultModelOption: () => getDefaultModelOption,
   getDefaultModelOptions: () => getDefaultModelOptions,
   getGlobalOption: () => getGlobalOption,
@@ -3202,7 +3213,7 @@ var clientErrors = import_express_json_router4.default.clientErrors;
 function parsePathParam(value, parameter) {
   const result = stringOrStringArray.safeParse(value);
   if (!result.success) {
-    throwValidationError(result.error.issues, parameter, "parameter");
+    throwValidationError(normalizeIssues(result.error.issues), parameter, "parameter");
   }
   const param = Array.isArray(result.data) ? result.data[0] : result.data;
   if (!param) {
@@ -3215,49 +3226,333 @@ function parsePathParam(value, parameter) {
 function parseQuery(schema, value) {
   const result = schema.safeParse(value);
   if (!result.success) {
-    throwValidationError(result.error.issues, void 0, "parameter");
+    throwValidationError(normalizeIssues(result.error.issues), void 0, "parameter");
   }
   return result.data;
 }
 function parseBody(schema, value) {
   const result = schema.safeParse(value ?? {});
   if (!result.success) {
-    throwValidationError(result.error.issues, void 0, "pointer");
+    throwValidationError(normalizeIssues(result.error.issues), void 0, "pointer");
   }
   return result.data;
 }
 function parseBodyWithSchema(schema, value, userSchema) {
   const body = parseBody(schema, value);
-  return isZodSchema(userSchema) ? parseUserSchema(userSchema, body) : body;
+  return isRequestSchema(userSchema) ? parseUserSchema(userSchema, body) : Promise.resolve(body);
 }
-function parseNestedBodyWithSchema(schema, value, nestedKey, userSchema) {
+async function parseNestedBodyWithSchema(schema, value, nestedKey, userSchema) {
   const body = parseBody(schema, value);
-  if (!isZodSchema(userSchema)) return body;
+  if (!isRequestSchema(userSchema)) return body;
   return {
     ...body,
-    [nestedKey]: parseUserSchema(userSchema, body?.[nestedKey], [nestedKey])
+    [nestedKey]: await parseUserSchema(userSchema, body?.[nestedKey], [nestedKey])
   };
 }
 function throwValidationError(issues, key, location = "pointer") {
   const errors = issues.map((issue) => formatIssue(issue, key, location));
   throw new clientErrors.BadRequestError("Bad Request", { errors });
 }
-function parseUserSchema(schema, value, prefix = []) {
-  const result = schema.safeParse(value);
-  if (!result.success) {
-    const issues = result.error.issues.map((issue) => ({
-      ...issue,
-      path: prefix.concat(issue.path.map(String))
-    }));
-    throwValidationError(issues, void 0, "pointer");
-  }
-  return result.data;
+async function parseUserSchema(schema, value, prefix = []) {
+  const validator = toRequestSchemaValidator(schema);
+  const result = await validator(value);
+  if (!isRequestSchemaFailure(result)) {
+    return result.data;
+  }
+  const issues = result.issues.map((issue) => ({
+    ...issue,
+    path: prefix.concat((issue.path ?? []).map(String))
+  }));
+  throwValidationError(issues, void 0, "pointer");
 }
 function isZodSchema(schema) {
   return typeof schema === "object" && schema !== null && "safeParse" in schema && typeof schema.safeParse === "function";
 }
+function isRequestSchema(schema) {
+  return isZodSchema(schema) || isStandardSchema(schema) || isRequestSchemaValidator(schema) || isRequestSchemaAdapter(schema);
+}
+function isRequestSchemaValidator(schema) {
+  return typeof schema === "function";
+}
+function isRequestSchemaAdapter(schema) {
+  return typeof schema === "object" && schema !== null && "validate" in schema && typeof schema.validate === "function";
+}
+function isStandardSchema(schema) {
+  return typeof schema === "object" && schema !== null && "~standard" in schema && typeof schema["~standard"] === "object" && schema["~standard"] !== null && "validate" in schema["~standard"] && typeof schema["~standard"].validate === "function";
+}
+function isRequestSchemaFailure(result) {
+  return result.success === false;
+}
+function toRequestSchemaValidator(schema) {
+  if (isZodSchema(schema)) return fromZod(schema);
+  if (isStandardSchema(schema)) return fromStandardSchema(schema);
+  if (isRequestSchemaValidator(schema)) return schema;
+  return schema.validate;
+}
+function defineRequestSchema(validator) {
+  return validator;
+}
+function fromZod(schema) {
+  return (value) => {
+    const result = schema.safeParse(value);
+    if (result.success) {
+      return {
+        success: true,
+        data: result.data
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeIssues(result.error.issues)
+    };
+  };
+}
+function fromStandardSchema(schema) {
+  return async (value) => {
+    const result = await schema["~standard"].validate(value);
+    if (!isStandardSchemaFailure(result)) {
+      return {
+        success: true,
+        data: result.value
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeIssues(result.issues)
+    };
+  };
+}
+function fromYup(schema) {
+  return async (value) => {
+    try {
+      const data = await schema.validate(value, { abortEarly: false });
+      return {
+        success: true,
+        data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        issues: normalizeYupIssues(error)
+      };
+    }
+  };
+}
+function fromJoi(schema) {
+  return async (value) => {
+    const result = await schema.validate(value, { abortEarly: false });
+    if (!result.error?.details?.length) {
+      return {
+        success: true,
+        data: result.value
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeJoiIssues(result.error.details)
+    };
+  };
+}
+function fromAjv(validator) {
+  return async (value) => {
+    const valid = await validator(value);
+    if (valid) {
+      return {
+        success: true,
+        data: value
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeAjvIssues(validator.errors ?? [])
+    };
+  };
+}
+function fromValibot(schema, safeParse) {
+  return async (value) => {
+    const result = await safeParse(schema, value, { abortEarly: false });
+    if (result.success) {
+      return {
+        success: true,
+        data: result.output
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeValibotIssues(result.issues)
+    };
+  };
+}
+function fromArkType(type) {
+  return async (value) => {
+    const result = await type(value);
+    if (!isArkTypeErrors(result)) {
+      return {
+        success: true,
+        data: result
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeArkTypeIssues(result)
+    };
+  };
+}
+function fromIoTs(decoder) {
+  return async (value) => {
+    const result = decoder.decode(value);
+    if (result._tag === "Right") {
+      return {
+        success: true,
+        data: result.right
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeIoTsIssues(result.left)
+    };
+  };
+}
+function fromSuperstruct(struct, validate) {
+  return async (value) => {
+    const [failure, output] = await validate(value, struct);
+    if (!failure) {
+      return {
+        success: true,
+        data: output
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeSuperstructFailure(failure)
+    };
+  };
+}
+function fromVine(validator) {
+  return async (value) => {
+    try {
+      const output = await validator.validate(value);
+      return {
+        success: true,
+        data: output
+      };
+    } catch (error) {
+      return {
+        success: false,
+        issues: normalizeVineError(error)
+      };
+    }
+  };
+}
+function isStandardSchemaFailure(result) {
+  return Array.isArray(result.issues);
+}
+function normalizeIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: issue.path?.flatMap((segment) => normalizePathSegment(segment))
+  }));
+}
+function normalizePathSegment(segment) {
+  const key = isStandardSchemaPathSegment(segment) ? segment.key : segment;
+  return typeof key === "string" || typeof key === "number" ? [key] : [];
+}
+function isStandardSchemaPathSegment(segment) {
+  return typeof segment === "object" && segment !== null && "key" in segment;
+}
+function normalizeYupIssues(error) {
+  if (!isYupValidationError(error)) {
+    return [{ message: "Validation failed" }];
+  }
+  const issues = error.inner?.length ? error.inner : [error];
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: parsePathString(issue.path)
+  }));
+}
+function normalizeJoiIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: issue.path ? [...issue.path] : void 0
+  }));
+}
+function normalizeAjvIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message ?? "Validation failed",
+    path: parseAjvPath(issue)
+  }));
+}
+function normalizeValibotIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: issue.path?.flatMap(
+      (item) => typeof item.key === "string" || typeof item.key === "number" ? [item.key] : []
+    )
+  }));
+}
+function normalizeArkTypeIssues(issues) {
+  const normalized = issues.map((issue) => ({
+    message: issue.message ?? issue.problem ?? issues.summary ?? "Validation failed",
+    path: issue.path ? [...issue.path] : void 0
+  }));
+  return normalized.length ? normalized : [{ message: issues.summary ?? "Validation failed" }];
+}
+function normalizeIoTsIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message ?? "Validation failed",
+    path: issue.context.map((entry) => entry.key).filter(Boolean)
+  }));
+}
+function normalizeSuperstructFailure(failure) {
+  const failures = failure.failures?.() ?? [failure];
+  return failures.map((entry) => ({
+    message: entry.message ?? "Validation failed",
+    path: normalizeSuperstructPath(entry)
+  }));
+}
+function normalizeSuperstructPath(failure) {
+  if (failure.path?.length) return [...failure.path];
+  if (typeof failure.key === "string" || typeof failure.key === "number") return [failure.key];
+  return void 0;
+}
+function normalizeVineError(error) {
+  if (!isVineValidationError(error)) {
+    return [{ message: "Validation failed" }];
+  }
+  return error.messages.map((message) => ({
+    message: message.message,
+    path: normalizeVineField(message)
+  }));
+}
+function normalizeVineField(message) {
+  const path = message.field.replace(/\[(\d+)\]/g, ".$1").split(".").filter(Boolean).map((segment) => /^\d+$/.test(segment) ? Number(segment) : segment);
+  if (typeof message.index === "number" && path.length === 0) {
+    return [message.index];
+  }
+  return path.length ? path : void 0;
+}
+function parseAjvPath(issue) {
+  const path = issue.instancePath?.split("/").filter(Boolean).map((segment) => /^\d+$/.test(segment) ? Number(segment) : segment);
+  if (issue.params?.missingProperty) {
+    return (path ?? []).concat(issue.params.missingProperty);
+  }
+  return path;
+}
+function parsePathString(path) {
+  if (!path) return void 0;
+  return path.replace(/\[(\d+)\]/g, ".$1").split(".").filter(Boolean).map((segment) => /^\d+$/.test(segment) ? Number(segment) : segment);
+}
+function isYupValidationError(error) {
+  return typeof error === "object" && error !== null && "message" in error;
+}
+function isArkTypeErrors(value) {
+  return Array.isArray(value);
+}
+function isVineValidationError(error) {
+  return typeof error === "object" && error !== null && "messages" in error && Array.isArray(error.messages);
+}
 function formatIssue(issue, key, location = "pointer") {
-  const path = issue.path.map(String);
+  const path = (issue.path ?? []).map(String);
   const joinedPath = path.join(".");
   if (location === "parameter") {
     return {
@@ -3694,7 +3989,7 @@ function setModelCollectionRoutes(context) {
   });
   router.post(`/${options.queryRouteSegment}`, async (req) => {
     await context.assertAllowed(req, "list");
-    const body = parseBodyWithSchema(
+    const body = await parseBodyWithSchema(
       listBodySchema,
       req.body,
       context.getRequestSchema("requestSchemas.advancedList")
@@ -3720,7 +4015,11 @@ function setModelCollectionRoutes(context) {
   router.post("", async (req) => {
     await context.assertAllowed(req, "create");
     const { include_permissions } = parseQuery(requestSchemas.createQuery, req.query);
-    const data = parseBodyWithSchema(createBodySchema, req.body, context.getRequestSchema("requestSchemas.create"));
+    const data = await parseBodyWithSchema(
+      createBodySchema,
+      req.body,
+      context.getRequestSchema("requestSchemas.create")
+    );
     const svc = context.getPublicService(req);
     const result = await svc._create(data, {}, { includePermissions: parseBooleanString(include_permissions) });
     handleResultError(result);
@@ -3729,7 +4028,7 @@ function setModelCollectionRoutes(context) {
   router.post(`/${options.mutationRouteSegment}`, async (req) => {
     await context.assertAllowed(req, "create");
     const { include_permissions } = parseQuery(requestSchemas.createQuery, req.query);
-    const body = parseNestedBodyWithSchema(
+    const body = await parseNestedBodyWithSchema(
       advancedCreateBodySchema,
       req.body,
       "data",
@@ -3737,7 +4036,7 @@ function setModelCollectionRoutes(context) {
     );
     const { data, select, populate, tasks } = body;
     const advancedOptions = body.options ?? {};
-    parseBodyWithSchema(
+    await parseBodyWithSchema(
       advancedCreateBodySchema,
       { data, select, populate, tasks, options: advancedOptions },
       context.getRequestSchema("requestSchemas.advancedCreate.default") ?? context.getRequestSchema("requestSchemas.advancedCreate")
@@ -3775,7 +4074,7 @@ function setModelDocumentRoutes(context) {
   });
   router.post("/count", async (req) => {
     await context.assertAllowed(req, "count");
-    const { filter: filter2, options: countOptions = {} } = parseBodyWithSchema(
+    const { filter: filter2, options: countOptions = {} } = await parseBodyWithSchema(
       countBodySchema,
       req.body,
       context.getRequestSchema("requestSchemas.count")
@@ -3806,7 +4105,7 @@ function setModelDocumentRoutes(context) {
   });
   router.post(`/${options.queryRouteSegment}/__filter`, async (req) => {
     await context.assertAllowed(req, "read");
-    const body = parseBodyWithSchema(
+    const body = await parseBodyWithSchema(
       readFilterBodySchema,
       req.body,
       context.getRequestSchema("requestSchemas.advancedReadFilter")
@@ -3826,7 +4125,7 @@ function setModelDocumentRoutes(context) {
   router.post(`/${options.queryRouteSegment}/:${options.idParam}`, async (req) => {
     await context.assertAllowed(req, "read");
     const id = parsePathParam(req.params[options.idParam], options.idParam);
-    const body = parseBodyWithSchema(
+    const body = await parseBodyWithSchema(
       readByIdBodySchema,
       req.body,
       context.getRequestSchema("requestSchemas.advancedRead")
@@ -3847,7 +4146,11 @@ function setModelDocumentRoutes(context) {
     await context.assertAllowed(req, "update");
     const id = parsePathParam(req.params[options.idParam], options.idParam);
     const { returning_all, include_permissions } = parseQuery(requestSchemas.updateQuery, req.query);
-    const data = parseBodyWithSchema(updateBodySchema, req.body, context.getRequestSchema("requestSchemas.update"));
+    const data = await parseBodyWithSchema(
+      updateBodySchema,
+      req.body,
+      context.getRequestSchema("requestSchemas.update")
+    );
     const svc = context.getPublicService(req);
     const result = await svc._update(
       id,
@@ -3865,7 +4168,7 @@ function setModelDocumentRoutes(context) {
     await context.assertAllowed(req, "update");
     const id = parsePathParam(req.params[options.idParam], options.idParam);
     const { returning_all, include_permissions } = parseQuery(requestSchemas.updateQuery, req.query);
-    const body = parseNestedBodyWithSchema(
+    const body = await parseNestedBodyWithSchema(
       advancedUpdateBodySchema,
       req.body,
       "data",
@@ -3873,7 +4176,7 @@ function setModelDocumentRoutes(context) {
     );
     const { data, select, populate, tasks } = body;
     const advancedOptions = body.options ?? {};
-    parseBodyWithSchema(
+    await parseBodyWithSchema(
       advancedUpdateBodySchema,
       { data, select, populate, tasks, options: advancedOptions },
       context.getRequestSchema("requestSchemas.advancedUpdate.default") ?? context.getRequestSchema("requestSchemas.advancedUpdate")
@@ -3897,7 +4200,11 @@ function setModelDocumentRoutes(context) {
     await context.assertAllowed(req, "upsert");
     const svc = context.getPublicService(req);
     const { returning_all, include_permissions } = parseQuery(requestSchemas.upsertQuery, req.query);
-    const body = parseBodyWithSchema(upsertBodySchema, req.body, context.getRequestSchema("requestSchemas.upsert"));
+    const body = await parseBodyWithSchema(
+      upsertBodySchema,
+      req.body,
+      context.getRequestSchema("requestSchemas.upsert")
+    );
     const result = await svc._upsert(
       body,
       {},
@@ -3913,7 +4220,7 @@ function setModelDocumentRoutes(context) {
     await context.assertAllowed(req, "upsert");
     const svc = context.getPublicService(req);
     const { returning_all, include_permissions } = parseQuery(requestSchemas.upsertQuery, req.query);
-    const body = parseNestedBodyWithSchema(
+    const body = await parseNestedBodyWithSchema(
       advancedUpsertBodySchema,
       req.body,
       "data",
@@ -3921,7 +4228,7 @@ function setModelDocumentRoutes(context) {
     );
     const { data, select, populate, tasks } = body;
     const advancedOptions = body.options ?? {};
-    parseBodyWithSchema(
+    await parseBodyWithSchema(
       advancedUpsertBodySchema,
       { data, select, populate, tasks, options: advancedOptions },
       context.getRequestSchema("requestSchemas.advancedUpsert.default") ?? context.getRequestSchema("requestSchemas.advancedUpsert")
@@ -3958,7 +4265,7 @@ function setModelDocumentRoutes(context) {
   router.post("/distinct/:field", async (req) => {
     await context.assertAllowed(req, "distinct");
     const field = parsePathParam(req.params.field, "field");
-    const { filter: filter2 } = parseBodyWithSchema(
+    const { filter: filter2 } = await parseBodyWithSchema(
       distinctBodySchema,
       req.body,
       context.getRequestSchema("requestSchemas.distinct")
@@ -3989,7 +4296,7 @@ function setModelSubDocumentRoutes(context) {
       async (req) => {
         await context.assertAllowed(req, `subs.${sub}.list`);
         const id = parsePathParam(req.params[context.options.idParam], context.options.idParam);
-        const body = parseBodyWithSchema(
+        const body = await parseBodyWithSchema(
           subListBodySchema,
           req.body,
           context.getRequestSchema("requestSchemas.subList")
@@ -4003,7 +4310,7 @@ function setModelSubDocumentRoutes(context) {
     context.router.patch(`/:${context.options.idParam}/${sub}`, async (req) => {
       await context.assertAllowed(req, `subs.${sub}.update`);
       const id = parsePathParam(req.params[context.options.idParam], context.options.idParam);
-      const data = parseBodyWithSchema(
+      const data = await parseBodyWithSchema(
         subMutationBodySchema,
         req.body,
         context.getRequestSchema("requestSchemas.subBulkUpdate")
@@ -4028,7 +4335,7 @@ function setModelSubDocumentRoutes(context) {
         await context.assertAllowed(req, `subs.${sub}.read`);
         const id = parsePathParam(req.params[context.options.idParam], context.options.idParam);
         const subId = parsePathParam(req.params.subId, "subId");
-        const body = parseBodyWithSchema(
+        const body = await parseBodyWithSchema(
           subReadBodySchema,
           req.body,
           context.getRequestSchema("requestSchemas.subRead")
@@ -4045,7 +4352,7 @@ function setModelSubDocumentRoutes(context) {
       await context.assertAllowed(req, `subs.${sub}.update`);
       const id = parsePathParam(req.params[context.options.idParam], context.options.idParam);
       const subId = parsePathParam(req.params.subId, "subId");
-      const data = parseBodyWithSchema(
+      const data = await parseBodyWithSchema(
         subMutationBodySchema,
         req.body,
         context.getRequestSchema("requestSchemas.subUpdate")
@@ -4058,7 +4365,7 @@ function setModelSubDocumentRoutes(context) {
     context.router.post(`/:${context.options.idParam}/${sub}`, async (req) => {
       await context.assertAllowed(req, `subs.${sub}.create`);
       const id = parsePathParam(req.params[context.options.idParam], context.options.idParam);
-      const data = parseBodyWithSchema(
+      const data = await parseBodyWithSchema(
         subMutationBodySchema,
         req.body,
         context.getRequestSchema("requestSchemas.subCreate")
@@ -4781,7 +5088,7 @@ var DataRouter = class {
         page,
         pageSize,
         options = {}
-      } = parseBodyWithSchema(dataListBodySchema, req.body, this.getRequestSchema("requestSchemas.advancedList"));
+      } = await parseBodyWithSchema(dataListBodySchema, req.body, this.getRequestSchema("requestSchemas.advancedList"));
       const { includeCount, includeExtraHeaders } = options;
       const svc = this.getService(req);
       const result = await svc.find(
@@ -4809,7 +5116,7 @@ var DataRouter = class {
     });
     this.router.post(`/${this.options.queryRouteSegment}/__filter`, async (req) => {
       await this.assertAllowed(req, "read");
-      let { filter: filter2, select } = parseBodyWithSchema(
+      let { filter: filter2, select } = await parseBodyWithSchema(
         dataReadFilterBodySchema,
         req.body,
         this.getRequestSchema("requestSchemas.advancedReadFilter")
@@ -4823,7 +5130,7 @@ var DataRouter = class {
     this.router.post(`/${this.options.queryRouteSegment}/:${this.options.idParam}`, async (req) => {
       await this.assertAllowed(req, "read");
       const id = parsePathParam(req.params[this.options.idParam], this.options.idParam);
-      let { select } = parseBodyWithSchema(
+      let { select } = await parseBodyWithSchema(
         dataReadByIdBodySchema,
         req.body,
         this.getRequestSchema("requestSchemas.advancedRead")
@@ -4952,6 +5259,17 @@ var index_default = acl;
   acl,
   combineRoutes,
   createAccessRuntime,
+  defineRequestSchema,
+  fromAjv,
+  fromArkType,
+  fromIoTs,
+  fromJoi,
+  fromStandardSchema,
+  fromSuperstruct,
+  fromValibot,
+  fromVine,
+  fromYup,
+  fromZod,
   getDefaultModelOption,
   getDefaultModelOptions,
   getGlobalOption,