@aeriajs/builtins 0.0.88 → 0.0.89

package/dist/functions/describe.d.ts

@@ -1,5 +1,4 @@
-import type { RouteContext } from '@aeriajs/types';
-import type { Description } from '@aeriajs/types';
+import type { Description, RouteContext } from '@aeriajs/types';
 type Payload = {
     collections?: string[];
     noSerialize?: boolean;
@@ -7,126 +6,138 @@ type Payload = {
     revalidate?: boolean;
     router?: boolean;
 };
-export declare const describe: (contextOrPayload: RouteContext | Payload) => Promise<import("@aeriajs/types").GenericResponse | import("@aeriajs/types").Left<import("../collections/user/authenticate.js").AuthenticationErrors> | {
-    descriptions: Record<string, Description>;
-    roles?: string[] | undefined;
-    auth?: Partial<{
-        user: Pick<import("@aeriajs/types").SchemaWithId<{
-            readonly $id: "user";
-            readonly required: readonly ["name", "roles", "email"];
-            readonly form: readonly ["name", "active", "roles", "email", "phone_number", "picture_file"];
-            readonly indexes: readonly ["name"];
-            readonly freshItem: {
-                readonly active: true;
-            };
-            readonly properties: {
-                readonly name: {
-                    readonly type: "string";
-                };
-                readonly given_name: {
-                    readonly getter: (document: any) => string;
-                };
-                readonly family_name: {
-                    readonly getter: (document: any) => string;
-                };
-                readonly active: {
-                    readonly type: "boolean";
-                };
-                readonly roles: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
-                    readonly uniqueItems: true;
-                };
-                readonly email: {
-                    readonly type: "string";
-                    readonly inputType: "email";
-                    readonly unique: true;
-                };
-                readonly password: {
-                    readonly type: "string";
-                    readonly inputType: "password";
-                    readonly hidden: true;
-                };
-                readonly phone_number: {
-                    readonly type: "string";
-                    readonly mask: "(##) #####-####";
-                };
-                readonly picture_file: {
-                    readonly $ref: "file";
-                    readonly accept: readonly ["image/*"];
-                };
-                readonly picture: {
-                    readonly getter: (value: any) => any;
-                };
-                readonly group: {
-                    readonly type: "string";
-                };
-                readonly self_registered: {
-                    readonly type: "boolean";
-                    readonly readOnly: true;
-                };
-                readonly updated_at: {
+export declare const describe: (contextOrPayload: RouteContext | Payload) => Promise<import("@aeriajs/types").GenericResponse | (({
+    user: Pick<import("@aeriajs/types").SchemaWithId<{
+        readonly $id: "user";
+        readonly required: readonly ["name", "roles", "email"];
+        readonly form: readonly ["name", "active", "roles", "email", "phone_number", "picture_file"];
+        readonly indexes: readonly ["name"];
+        readonly freshItem: {
+            readonly active: true;
+        };
+        readonly properties: {
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly given_name: {
+                readonly getter: (document: any) => string;
+            };
+            readonly family_name: {
+                readonly getter: (document: any) => string;
+            };
+            readonly active: {
+                readonly type: "boolean";
+            };
+            readonly roles: {
+                readonly type: "array";
+                readonly items: {
                     readonly type: "string";
-                    readonly format: "date-time";
                 };
+                readonly uniqueItems: true;
             };
-            readonly presets: readonly ["crud", "view", "duplicate"];
-            readonly layout: {
-                readonly name: "grid";
-                readonly options: {
-                    readonly title: "name";
-                    readonly badge: "roles";
-                    readonly picture: "picture_file";
-                    readonly information: "email";
-                    readonly active: "active";
-                };
+            readonly email: {
+                readonly type: "string";
+                readonly inputType: "email";
+                readonly unique: true;
             };
-            readonly individualActions: {
-                readonly 'ui:spawnEdit': {
-                    readonly label: "action.edit";
-                    readonly icon: "pencil";
-                    readonly translate: true;
-                };
-                readonly 'route:/dashboard/user/changepass': {
-                    readonly label: "change_password";
-                    readonly icon: "key";
-                    readonly fetchItem: true;
-                    readonly translate: true;
-                };
+            readonly password: {
+                readonly type: "string";
+                readonly inputType: "password";
+                readonly hidden: true;
             };
-            readonly icon: "users";
-            readonly filters: readonly ["name", "roles", "email", "phone_number"];
-            readonly table: readonly ["name", "roles", "picture_file", "active", "updated_at"];
-            readonly tableMeta: readonly ["email"];
-            readonly formLayout: {
-                readonly fields: {
-                    readonly given_name: {
-                        readonly span: 3;
-                    };
-                    readonly family_name: {
-                        readonly span: 3;
-                    };
-                };
+            readonly phone_number: {
+                readonly type: "string";
+                readonly mask: "(##) #####-####";
+            };
+            readonly picture_file: {
+                readonly $ref: "file";
+                readonly accept: readonly ["image/*"];
+            };
+            readonly picture: {
+                readonly getter: (value: any) => any;
+            };
+            readonly group: {
+                readonly type: "string";
+            };
+            readonly self_registered: {
+                readonly type: "boolean";
+                readonly readOnly: true;
+            };
+            readonly updated_at: {
+                readonly type: "string";
+                readonly format: "date-time";
             };
-        }>, "name" | "roles" | "email" | "active"> & {
-            _id: import("@aeriajs/core").ObjectId | null;
         };
-        token: import("@aeriajs/types").TokenRecipient;
-    } | {
-        user: {
-            _id: null;
-            name: string;
-            email: string;
-            roles: string[];
-            active: boolean;
+        readonly presets: readonly ["crud", "view", "duplicate"];
+        readonly layout: {
+            readonly name: "grid";
+            readonly options: {
+                readonly title: "name";
+                readonly badge: "roles";
+                readonly picture: "picture_file";
+                readonly information: "email";
+                readonly active: "active";
+            };
         };
-        token: {
-            type: string;
-            content: string;
+        readonly individualActions: {
+            readonly 'ui:spawnEdit': {
+                readonly label: "action.edit";
+                readonly icon: "pencil";
+                readonly translate: true;
+            };
+            readonly 'route:/dashboard/user/changepass': {
+                readonly label: "change_password";
+                readonly icon: "key";
+                readonly fetchItem: true;
+                readonly translate: true;
+            };
         };
-    }> | undefined;
+        readonly icon: "users";
+        readonly filters: readonly ["name", "roles", "email", "phone_number"];
+        readonly table: readonly ["name", "roles", "picture_file", "active", "updated_at"];
+        readonly tableMeta: readonly ["email"];
+        readonly formLayout: {
+            readonly fields: {
+                readonly given_name: {
+                    readonly span: 3;
+                };
+                readonly family_name: {
+                    readonly span: 3;
+                };
+            };
+        };
+    }>, "name" | "roles" | "email" | "active"> & {
+        _id: import("@aeriajs/core").ObjectId | null;
+    };
+    token: import("@aeriajs/types").TokenRecipient;
+} | import("@aeriajs/types").EndpointError<{
+    readonly code: import("@aeriajs/types").ACError.AuthorizationError;
+} & {
+    httpStatus: import("@aeriajs/types").HTTPStatus.Unauthorized;
+}> | {
+    user: {
+        _id: null;
+        name: string;
+        email: string;
+        roles: string[];
+        active: boolean;
+    };
+    token: {
+        type: string;
+        content: string;
+    };
+} | import("@aeriajs/types").EndpointError<{
+    readonly code: import("../collections/user/authenticate.js").AuthenticationError.InvalidCredentials;
+} & {
+    httpStatus: import("@aeriajs/types").HTTPStatus.Unauthorized;
+}> | import("@aeriajs/types").EndpointError<{
+    readonly code: import("../collections/user/authenticate.js").AuthenticationError.InactiveUser;
+} & {
+    httpStatus: import("@aeriajs/types").HTTPStatus.Unauthorized;
+}>) & import("@aeriajs/types").EndpointError<import("@aeriajs/types").EndpointErrorContent>) | {
+    descriptions: Record<string, Description>;
+    roles?: string[] | undefined;
+    auth?: undefined;
     router?: any;
 }>;
 export {};

package/dist/functions/describe.js

@@ -11,17 +11,15 @@ const describe = async (contextOrPayload) => {
         ? contextOrPayload.request.payload
         : contextOrPayload;
     if ('request' in contextOrPayload && props.revalidate) {
-        const authEither = await (0, authenticate_js_1.authenticate)({
+        const auth = await (0, authenticate_js_1.authenticate)({
             revalidate: true,
         }, await (0, core_1.createContext)({
             collectionName: 'user',
             parentContext: contextOrPayload,
         }));
-        if ((0, common_1.isLeft)(authEither)) {
-            const error = (0, common_1.unwrapEither)(authEither);
-            return (0, common_1.left)(error);
+        if ((0, common_1.isError)(auth)) {
+            return auth;
         }
-        const auth = (0, common_1.unwrapEither)(authEither);
         result.auth = JSON.parse(JSON.stringify(auth));
     }
     const collections = await (0, entrypoint_1.getCollections)();

package/dist/functions/describe.mjs

@@ -1,23 +1,21 @@
 "use strict";
 import { createContext, preloadDescription, getEndpoints } from "@aeriajs/core";
 import { getCollections, getAvailableRoles } from "@aeriajs/entrypoint";
-import { serialize, isLeft, left, unwrapEither } from "@aeriajs/common";
+import { serialize, isError } from "@aeriajs/common";
 import { authenticate } from "../collections/user/authenticate.mjs";
 export const describe = async (contextOrPayload) => {
   const result = {};
   const props = "request" in contextOrPayload ? contextOrPayload.request.payload : contextOrPayload;
   if ("request" in contextOrPayload && props.revalidate) {
-    const authEither = await authenticate({
+    const auth = await authenticate({
       revalidate: true
     }, await createContext({
       collectionName: "user",
       parentContext: contextOrPayload
     }));
-    if (isLeft(authEither)) {
-      const error = unwrapEither(authEither);
-      return left(error);
+    if (isError(auth)) {
+      return auth;
     }
-    const auth = unwrapEither(authEither);
     result.auth = JSON.parse(JSON.stringify(auth));
   }
   const collections = await getCollections();