@aeriajs/builtins 0.0.256 → 0.0.258

package/dist/collections/user/getActivationLink.d.ts

@@ -1,64 +1,96 @@
-import type { Context } from '@aeriajs/types';
-import { type ObjectId } from '@aeriajs/core';
-import { Result } from '@aeriajs/types';
-export declare const getActivationToken: (strId: string, context: Context) => Promise<string>;
-export declare const getActivationLink: (payload: {
-    userId: ObjectId | string;
-    redirect?: string;
-}, context: Context) => Promise<{
-    readonly _tag: "Error";
-    readonly error: Pick<{} & Omit<Readonly<import("@aeriajs/types").FilterReadonlyProperties<{
-        readonly httpStatus: {
-            readonly enum: [403, 404, 400];
+import type { Context, ContractToFunction } from '@aeriajs/types';
+import type { description } from './description.js';
+export declare const getActivationLinkContract: {
+    readonly payload: {
+        readonly type: "object";
+        readonly required: readonly ["userId"];
+        readonly properties: {
+            readonly userId: {
+                readonly type: "string";
+                readonly format: "objectid";
+            };
+            readonly redirect: {
+                readonly type: "string";
+            };
         };
-        readonly code: {
-            readonly enum: ["RESOURCE_NOT_FOUND", "OWNERSHIP_ERROR", "INSECURE_OPERATOR", "MALFORMED_INPUT"];
-        };
-        readonly message: {
-            readonly type: "string";
-        };
-        readonly details: {
-            readonly type: "object";
-            readonly additionalProperties: true;
-        };
-    }>> & {
-        code: "RESOURCE_NOT_FOUND" | "INSECURE_OPERATOR" | "OWNERSHIP_ERROR" | "MALFORMED_INPUT";
-        httpStatus: 403 | 400 | 404;
-        message: string;
-        details: any;
-    }, never>, "code" | "httpStatus"> & Partial<{} & Omit<Readonly<import("@aeriajs/types").FilterReadonlyProperties<{
-        readonly httpStatus: {
-            readonly enum: [403, 404, 400];
-        };
-        readonly code: {
-            readonly enum: ["RESOURCE_NOT_FOUND", "OWNERSHIP_ERROR", "INSECURE_OPERATOR", "MALFORMED_INPUT"];
+    };
+    readonly response: [{
+        readonly type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Error";
+            };
+            readonly result: {
+                readonly const: undefined;
+            };
+            readonly error: {
+                readonly type: "object";
+                readonly required: readonly ["httpStatus", "code"];
+                readonly properties: {
+                    readonly httpStatus: {
+                        readonly enum: [403, 404, 400];
+                    };
+                    readonly code: {
+                        readonly enum: ["RESOURCE_NOT_FOUND", "OWNERSHIP_ERROR", "INSECURE_OPERATOR", "MALFORMED_INPUT"];
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                    };
+                    readonly details: {
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    };
+                };
+            };
         };
-        readonly message: {
-            readonly type: "string";
+    }, {
+        readonly type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Error";
+            };
+            readonly result: {
+                readonly const: undefined;
+            };
+            readonly error: {
+                readonly type: "object";
+                readonly required: readonly ["httpStatus", "code"];
+                readonly properties: {
+                    readonly httpStatus: {
+                        readonly enum: [400, 403];
+                    };
+                    readonly code: {
+                        readonly enum: ["INVALID_LINK", "ALREADY_ACTIVE_USER"];
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                    };
+                    readonly details: {
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    };
+                };
+            };
         };
-        readonly details: {
-            readonly type: "object";
-            readonly additionalProperties: true;
+    }, {
+        readonly type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Result";
+            };
+            readonly error: {
+                readonly const: undefined;
+            };
+            readonly result: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly url: {
+                        readonly type: "string";
+                    };
+                };
+            };
         };
-    }>> & {
-        code: "RESOURCE_NOT_FOUND" | "INSECURE_OPERATOR" | "OWNERSHIP_ERROR" | "MALFORMED_INPUT";
-        httpStatus: 403 | 400 | 404;
-        message: string;
-        details: any;
-    }, never>>;
-    readonly result: undefined;
-} | Result.Error<{
-    readonly code: "INVALID_LINK";
-} & {
-    httpStatus: 400;
-}> | Result.Error<{
-    readonly code: "ALREADY_ACTIVE_USER";
-} & {
-    httpStatus: 403;
-}> | {
-    readonly _tag: "Result";
-    readonly error: undefined;
-    readonly result: {
-        readonly url: string;
-    };
-}>;
+    }];
+};
+export declare const getActivationToken: (userId: string, context: Context) => Promise<string>;
+export declare const getActivationLink: ContractToFunction<typeof getActivationLinkContract, Context<typeof description>>;

package/dist/collections/user/getActivationLink.js

@@ -1,10 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getActivationLink = exports.getActivationToken = void 0;
+exports.getActivationLink = exports.getActivationToken = exports.getActivationLinkContract = void 0;
 const core_1 = require("@aeriajs/core");
 const types_1 = require("@aeriajs/types");
 const activate_js_1 = require("./activate.js");
-const getActivationToken = async (strId, context) => {
+exports.getActivationLinkContract = (0, types_1.defineContract)({
+    payload: {
+        type: 'object',
+        required: ['userId'],
+        properties: {
+            userId: {
+                type: 'string',
+                format: 'objectid',
+            },
+            redirect: {
+                type: 'string',
+            },
+        },
+    },
+    response: [
+        types_1.functionSchemas.getError(),
+        (0, types_1.endpointErrorSchema)({
+            httpStatus: [
+                types_1.HTTPStatus.BadRequest,
+                types_1.HTTPStatus.Forbidden,
+            ],
+            code: [
+                activate_js_1.ActivationError.InvalidLink,
+                activate_js_1.ActivationError.AlreadyActiveUser,
+            ],
+        }),
+        (0, types_1.resultSchema)({
+            type: 'object',
+            properties: {
+                url: {
+                    type: 'string',
+                },
+            },
+        }),
+    ],
+});
+const getActivationToken = async (userId, context) => {
     if (context.calledFunction === 'getActivationToken') {
         throw new Error('cannot be called externally');
     }
@@ -12,7 +48,7 @@ const getActivationToken = async (strId, context) => {
         throw new Error('config.secret is not set');
     }
     const token = await (0, core_1.signToken)({
-        data: strId,
+        data: userId,
     }, context.config.secret, {
         expiresIn: context.config.security.linkTokenExpiration,
     });
@@ -40,7 +76,6 @@ const getActivationLink = async (payload, context) => {
         });
     }
     const activationToken = await (0, exports.getActivationToken)(payload.userId.toString(), context);
-    //const url = `${context.config.webPublicUrl}/user/activation?step=password&u=${payload.userId.toString()}&t=${activationToken}`
     const url = new URL(`${context.config.webPublicUrl}/user/activation`);
     url.searchParams.set('u', payload.userId.toString());
     url.searchParams.set('t', activationToken);

package/dist/collections/user/getActivationLink.mjs

@@ -1,8 +1,44 @@
 "use strict";
 import { signToken } from "@aeriajs/core";
-import { Result, HTTPStatus } from "@aeriajs/types";
+import { Result, HTTPStatus, defineContract, resultSchema, endpointErrorSchema, functionSchemas } from "@aeriajs/types";
 import { ActivationError } from "./activate.mjs";
-export const getActivationToken = async (strId, context) => {
+export const getActivationLinkContract = defineContract({
+  payload: {
+    type: "object",
+    required: ["userId"],
+    properties: {
+      userId: {
+        type: "string",
+        format: "objectid"
+      },
+      redirect: {
+        type: "string"
+      }
+    }
+  },
+  response: [
+    functionSchemas.getError(),
+    endpointErrorSchema({
+      httpStatus: [
+        HTTPStatus.BadRequest,
+        HTTPStatus.Forbidden
+      ],
+      code: [
+        ActivationError.InvalidLink,
+        ActivationError.AlreadyActiveUser
+      ]
+    }),
+    resultSchema({
+      type: "object",
+      properties: {
+        url: {
+          type: "string"
+        }
+      }
+    })
+  ]
+});
+export const getActivationToken = async (userId, context) => {
   if (context.calledFunction === "getActivationToken") {
     throw new Error("cannot be called externally");
   }
@@ -10,7 +46,7 @@ export const getActivationToken = async (strId, context) => {
     throw new Error("config.secret is not set");
   }
   const token = await signToken({
-    data: strId
+    data: userId
   }, context.config.secret, {
     expiresIn: context.config.security.linkTokenExpiration
   });

package/dist/collections/user/getCurrentUser.d.ts

@@ -1,127 +1,57 @@
-import type { Context } from '@aeriajs/types';
+import type { Context, ContractToFunction } from '@aeriajs/types';
 import type { description } from './description.js';
 export declare const ActivationError: {
     readonly UserNotFound: "USER_NOT_FOUND";
     readonly AlreadyActiveUser: "ALREADY_ACTIVE_USER";
     readonly InvalidLink: "INVALID_LINK";
 };
-export declare const getCurrentUser: (_payload: undefined, context: Context<typeof description>) => Promise<{
-    readonly _tag: "Result";
-    readonly error: undefined;
-    readonly result: {
-        _id: null;
-        name: string;
-        email: string;
-        roles: string[];
-        active: boolean;
-    };
-} | {
-    readonly _tag: "Result";
-    readonly error: undefined;
-    readonly result: import("@aeriajs/types").SchemaWithId<{
-        readonly $id: "user";
-        readonly icon: "users";
-        readonly required: readonly ["name", "roles", "email"];
-        readonly form: readonly ["name", "active", "roles", "email", "phone_number", "picture_file"];
-        readonly indexes: readonly ["name"];
-        readonly unique: readonly ["email"];
+export declare const getCurrentUserContract: {
+    readonly response: [{
+        readonly type: "object";
         readonly properties: {
-            readonly name: {
-                readonly type: "string";
-                readonly minLength: 1;
+            readonly _tag: {
+                readonly const: "Result";
             };
-            readonly given_name: {
-                readonly getter: (doc: object) => string | undefined;
+            readonly error: {
+                readonly const: undefined;
             };
-            readonly family_name: {
-                readonly getter: (doc: object) => string | undefined;
-            };
-            readonly active: {
-                readonly type: "boolean";
-            };
-            readonly roles: {
-                readonly type: "array";
-                readonly items: {
-                    readonly type: "string";
-                };
-                readonly uniqueItems: true;
-                readonly minItems: 1;
-            };
-            readonly email: {
-                readonly type: "string";
-                readonly inputType: "email";
-                readonly minLength: 3;
-            };
-            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: (doc: object) => Promise<string> | undefined;
-            };
-            readonly self_registered: {
-                readonly type: "boolean";
-                readonly readOnly: true;
-            };
-            readonly updated_at: {
-                readonly type: "string";
-                readonly format: "date-time";
+            readonly result: {
+                readonly $ref: "user";
             };
         };
-        readonly presets: readonly ["crud", "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 translateBadge: true;
-            };
-        };
-        readonly individualActions: {
-            readonly changePassword: {
-                readonly label: "change_password";
-                readonly icon: "key";
-                readonly translate: true;
-                readonly route: {
-                    readonly name: "/dashboard/user/changepass";
-                    readonly fetchItem: true;
-                };
-            };
-            readonly copyRedefinePasswordLink: {
-                readonly label: "copy_redefine_password_link";
-                readonly icon: "link";
-                readonly translate: true;
-            };
-            readonly copyActivationLink: {
-                readonly label: "copy_activation_link";
-                readonly icon: "link";
-                readonly translate: true;
-            };
-        };
-        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 type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Result";
+            };
+            readonly error: {
+                readonly const: undefined;
+            };
+            readonly result: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly _id: {
+                        readonly const: null;
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                    };
+                    readonly email: {
+                        readonly type: "string";
+                    };
+                    readonly roles: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly active: {
+                        readonly type: "boolean";
+                    };
                 };
             };
         };
-    }>;
-}>;
+    }];
+};
+export declare const getCurrentUser: ContractToFunction<typeof getCurrentUserContract, Context<typeof description>>;

package/dist/collections/user/getCurrentUser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCurrentUser = exports.ActivationError = void 0;
+exports.getCurrentUser = exports.getCurrentUserContract = exports.ActivationError = void 0;
 const types_1 = require("@aeriajs/types");
 const core_1 = require("@aeriajs/core");
 const authentication_js_1 = require("../../authentication.js");
@@ -9,6 +9,36 @@ exports.ActivationError = {
     AlreadyActiveUser: 'ALREADY_ACTIVE_USER',
     InvalidLink: 'INVALID_LINK',
 };
+exports.getCurrentUserContract = (0, types_1.defineContract)({
+    response: [
+        (0, types_1.resultSchema)({
+            $ref: 'user',
+        }),
+        (0, types_1.resultSchema)({
+            type: 'object',
+            properties: {
+                _id: {
+                    const: null,
+                },
+                name: {
+                    type: 'string',
+                },
+                email: {
+                    type: 'string',
+                },
+                roles: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+                active: {
+                    type: 'boolean',
+                },
+            },
+        }),
+    ],
+});
 const getCurrentUser = async (_payload, context) => {
     if (!context.token.authenticated) {
         throw new Error();

package/dist/collections/user/getCurrentUser.mjs

@@ -1,5 +1,5 @@
 "use strict";
-import { Result } from "@aeriajs/types";
+import { Result, defineContract, resultSchema } from "@aeriajs/types";
 import { get } from "@aeriajs/core";
 import { defaultSuccessfulAuthentication } from "../../authentication.mjs";
 export const ActivationError = {
@@ -7,6 +7,36 @@ export const ActivationError = {
   AlreadyActiveUser: "ALREADY_ACTIVE_USER",
   InvalidLink: "INVALID_LINK"
 };
+export const getCurrentUserContract = defineContract({
+  response: [
+    resultSchema({
+      $ref: "user"
+    }),
+    resultSchema({
+      type: "object",
+      properties: {
+        _id: {
+          const: null
+        },
+        name: {
+          type: "string"
+        },
+        email: {
+          type: "string"
+        },
+        roles: {
+          type: "array",
+          items: {
+            type: "string"
+          }
+        },
+        active: {
+          type: "boolean"
+        }
+      }
+    })
+  ]
+});
 export const getCurrentUser = async (_payload, context) => {
   if (!context.token.authenticated) {
     throw new Error();

package/dist/collections/user/getInfo.d.ts

@@ -1,33 +1,78 @@
-import type { Context } from '@aeriajs/types';
-import type { description } from './description.js';
-import { Result } from '@aeriajs/types';
+import type { Context, ContractToFunction } from '@aeriajs/types';
+import { type description } from './description.js';
 export declare const ActivationError: {
     readonly UserNotFound: "USER_NOT_FOUND";
     readonly AlreadyActiveUser: "ALREADY_ACTIVE_USER";
     readonly InvalidLink: "INVALID_LINK";
     readonly InvalidToken: "INVALID_TOKEN";
 };
-export declare const getInfo: (payload: {
-    userId: string;
-    token: string;
-}, context: Context<typeof description>) => Promise<Result.Error<{
-    readonly code: "INVALID_LINK";
-} & {
-    httpStatus: 404;
-}> | Result.Error<{
-    readonly code: "USER_NOT_FOUND";
-} & {
-    httpStatus: 404;
-}> | Result.Error<{
-    readonly code: "INVALID_TOKEN";
-} & {
-    httpStatus: 401;
-}> | {
-    readonly _tag: "Result";
-    readonly error: undefined;
-    readonly result: {
-        readonly name: string;
-        readonly email: string;
-        readonly active: boolean | undefined;
+export declare const getInfoContract: {
+    readonly payload: {
+        readonly type: "object";
+        readonly required: readonly [];
+        readonly properties: {
+            readonly userId: {
+                readonly type: "string";
+            };
+            readonly token: {
+                readonly type: "string";
+            };
+        };
     };
-}>;
+    readonly response: [{
+        readonly type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Error";
+            };
+            readonly result: {
+                readonly const: undefined;
+            };
+            readonly error: {
+                readonly type: "object";
+                readonly required: readonly ["httpStatus", "code"];
+                readonly properties: {
+                    readonly httpStatus: {
+                        readonly enum: [404, 401, 422];
+                    };
+                    readonly code: {
+                        readonly enum: ["INVALID_LINK", "INVALID_TOKEN", "USER_NOT_FOUND"];
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                    };
+                    readonly details: {
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    };
+                };
+            };
+        };
+    }, {
+        readonly type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Result";
+            };
+            readonly error: {
+                readonly const: undefined;
+            };
+            readonly result: {
+                readonly type: "object";
+                readonly required: readonly ["name", "email"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                    };
+                    readonly email: {
+                        readonly type: "string";
+                    };
+                    readonly active: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    }];
+};
+export declare const getInfo: ContractToFunction<typeof getInfoContract, Context<typeof description>>;