@aeriajs/builtins 0.0.154 → 0.0.155

package/dist/functions/describe.d.ts

@@ -1,17 +1,68 @@
 import type { Description, RouteContext } from '@aeriajs/types';
-import { Result } from '@aeriajs/types';
+import { Result, ACError } from '@aeriajs/types';
 import { authenticate } from '../collections/user/authenticate.js';
-type Payload = {
-    collections?: string[];
-    noSerialize?: boolean;
-    roles?: boolean;
-    revalidate?: boolean;
-    router?: boolean;
-};
-export declare const describe: (contextOrPayload: RouteContext | Payload) => Promise<import("@aeriajs/types").GenericResponse | {
+declare const Payload: Pick<{} & Omit<Readonly<import("@aeriajs/types").FilterReadonlyProperties<{
+    readonly collections: {
+        readonly type: "array";
+        readonly items: {
+            readonly type: "string";
+        };
+    };
+    readonly noSerialize: {
+        readonly type: "boolean";
+    };
+    readonly revalidate: {
+        readonly type: "boolean";
+    };
+    readonly roles: {
+        readonly type: "boolean";
+    };
+    readonly router: {
+        readonly type: "boolean";
+    };
+}>> & {
+    roles: boolean;
+    revalidate: boolean;
+    collections: string[];
+    noSerialize: boolean;
+    router: boolean;
+}, never>, never> & Partial<{} & Omit<Readonly<import("@aeriajs/types").FilterReadonlyProperties<{
+    readonly collections: {
+        readonly type: "array";
+        readonly items: {
+            readonly type: "string";
+        };
+    };
+    readonly noSerialize: {
+        readonly type: "boolean";
+    };
+    readonly revalidate: {
+        readonly type: "boolean";
+    };
+    readonly roles: {
+        readonly type: "boolean";
+    };
+    readonly router: {
+        readonly type: "boolean";
+    };
+}>> & {
+    roles: boolean;
+    revalidate: boolean;
+    collections: string[];
+    noSerialize: boolean;
+    router: boolean;
+}, never>>;
+export declare const describe: (contextOrPayload: RouteContext | typeof Payload) => Promise<import("@aeriajs/types").GenericResponse | {
+    readonly _tag: "Error";
+    readonly error: {
+        readonly code: ACError.MalformedInput;
+        readonly details: import("@aeriajs/types").ValidationError | import("@aeriajs/types").PropertyValidationError;
+    };
+    readonly result: undefined;
+} | {
     readonly _tag: "Error";
     readonly error: ({
-        readonly code: import("@aeriajs/types").ACError.AuthorizationError;
+        readonly code: ACError.AuthorizationError;
     } & {
         httpStatus: import("@aeriajs/types").HTTPStatus.Unauthorized;
     }) | ({

package/dist/functions/describe.js

@@ -5,12 +5,48 @@ const core_1 = require("@aeriajs/core");
 const entrypoint_1 = require("@aeriajs/entrypoint");
 const types_1 = require("@aeriajs/types");
 const common_1 = require("@aeriajs/common");
+const validation_1 = require("@aeriajs/validation");
 const authenticate_js_1 = require("../collections/user/authenticate.js");
+const [Payload, validatePayload] = (0, validation_1.validator)({
+    type: 'object',
+    required: [],
+    properties: {
+        collections: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+        noSerialize: {
+            type: 'boolean',
+        },
+        revalidate: {
+            type: 'boolean',
+        },
+        roles: {
+            type: 'boolean',
+        },
+        router: {
+            type: 'boolean',
+        },
+    },
+});
 const describe = async (contextOrPayload) => {
     const result = {};
-    const props = 'request' in contextOrPayload
-        ? contextOrPayload.request.payload
-        : contextOrPayload;
+    let props;
+    if ('request' in contextOrPayload) {
+        const { error, result: validatedPayload } = validatePayload(contextOrPayload.request.payload);
+        if (error) {
+            return (0, common_1.endpointError)({
+                code: types_1.ACError.MalformedInput,
+                details: error,
+            });
+        }
+        props = validatedPayload;
+    }
+    else {
+        props = contextOrPayload;
+    }
     if ('request' in contextOrPayload && props.revalidate) {
         const { error, result: auth } = await (0, authenticate_js_1.authenticate)({
             revalidate: true,

package/dist/functions/describe.mjs

@@ -1,12 +1,49 @@
 "use strict";
 import { createContext, preloadDescription, getEndpoints } from "@aeriajs/core";
 import { getCollections, getAvailableRoles } from "@aeriajs/entrypoint";
-import { Result } from "@aeriajs/types";
-import { serialize } from "@aeriajs/common";
+import { Result, ACError } from "@aeriajs/types";
+import { serialize, endpointError } from "@aeriajs/common";
+import { validator } from "@aeriajs/validation";
 import { authenticate } from "../collections/user/authenticate.mjs";
+const [Payload, validatePayload] = validator({
+  type: "object",
+  required: [],
+  properties: {
+    collections: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    },
+    noSerialize: {
+      type: "boolean"
+    },
+    revalidate: {
+      type: "boolean"
+    },
+    roles: {
+      type: "boolean"
+    },
+    router: {
+      type: "boolean"
+    }
+  }
+});
 export const describe = async (contextOrPayload) => {
   const result = {};
-  const props = "request" in contextOrPayload ? contextOrPayload.request.payload : contextOrPayload;
+  let props;
+  if ("request" in contextOrPayload) {
+    const { error, result: validatedPayload } = validatePayload(contextOrPayload.request.payload);
+    if (error) {
+      return endpointError({
+        code: ACError.MalformedInput,
+        details: error
+      });
+    }
+    props = validatedPayload;
+  } else {
+    props = contextOrPayload;
+  }
   if ("request" in contextOrPayload && props.revalidate) {
     const { error, result: auth } = await authenticate({
       revalidate: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeriajs/builtins",
-  "version": "0.0.154",
+  "version": "0.0.155",
   "description": "## Installation",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -45,11 +45,11 @@
     "mongodb": "^6.5.0"
   },
   "peerDependencies": {
-    "@aeriajs/core": "^0.0.154",
-    "@aeriajs/common": "^0.0.93",
-    "@aeriajs/entrypoint": "^0.0.95",
+    "@aeriajs/core": "^0.0.155",
+    "@aeriajs/common": "^0.0.94",
+    "@aeriajs/entrypoint": "^0.0.96",
     "@aeriajs/types": "^0.0.80",
-    "@aeriajs/validation": "^0.0.96"
+    "@aeriajs/validation": "^0.0.97"
   },
   "scripts": {
     "test": "echo skipping",