@aeriajs/builtins 0.0.256 → 0.0.257

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

@@ -1,124 +1,137 @@
-import type { Context, SchemaWithId, PackReferences } from '@aeriajs/types';
-import type { description } from './description.js';
+import type { Context, ContractToFunction } from '@aeriajs/types';
+import { description } from './description.js';
 export declare const CreateAccountError: {
     readonly SignupDisallowed: "SIGNUP_DISALLOWED";
 };
-export declare const createAccount: (payload: Partial<PackReferences<SchemaWithId<typeof description>>> & Record<string, unknown>, context: Context<typeof description>) => Promise<import("@aeriajs/types").Result.Error<{
-    readonly code: "SIGNUP_DISALLOWED";
-} & {
-    httpStatus: 403;
-}> | import("@aeriajs/types").Result.Error<{
-    readonly code: "MALFORMED_INPUT";
-    readonly details: import("@aeriajs/types").PropertyValidationError | import("@aeriajs/types").ValidationError;
-} & {
-    httpStatus: 422;
-}> | import("@aeriajs/types").Result.Error<{
-    readonly code: "OWNERSHIP_ERROR";
-} & {
-    httpStatus: 403;
-}> | import("@aeriajs/types").InsertReturnType<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"];
-    readonly properties: {
-        readonly name: {
-            readonly type: "string";
-            readonly minLength: 1;
-        };
-        readonly given_name: {
-            readonly getter: (doc: object) => string | undefined;
-        };
-        readonly family_name: {
-            readonly getter: (doc: object) => string | undefined;
-        };
-        readonly active: {
-            readonly type: "boolean";
-        };
-        readonly roles: {
-            readonly type: "array";
-            readonly items: {
+export declare const createAccountContract: {
+    readonly payload: {
+        readonly type: "object";
+        readonly required: readonly [];
+        readonly additionalProperties: true;
+        readonly properties: {
+            readonly name: {
                 readonly type: "string";
+                readonly minLength: 1;
+            };
+            readonly given_name: {
+                readonly getter: (doc: object) => string | 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 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 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 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, 422, 400, 500];
+                    };
+                    readonly code: {
+                        readonly enum: ["INSECURE_OPERATOR", "OWNERSHIP_ERROR", "RESOURCE_NOT_FOUND", "TARGET_IMMUTABLE", "MALFORMED_INPUT", "UNIQUENESS_VIOLATED", "EMPTY_TARGET", "INVALID_PROPERTIES", "MISSING_PROPERTIES", "INVALID_DOCUMENT_ID", "INVALID_TEMPFILE"];
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                    };
+                    readonly details: {
+                        readonly type: "object";
+                        readonly additionalProperties: 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 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, 422];
+                    };
+                    readonly code: {
+                        readonly enum: ["MALFORMED_INPUT", "OWNERSHIP_ERROR", "SIGNUP_DISALLOWED"];
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                    };
+                    readonly details: {
+                        readonly type: "object";
+                        readonly additionalProperties: 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 type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Result";
             };
-            readonly family_name: {
-                readonly span: 3;
+            readonly error: {
+                readonly const: undefined;
+            };
+            readonly result: {
+                readonly $ref: "user";
             };
         };
-    };
-}>>>;
+    }];
+};
+export declare const createAccount: ContractToFunction<typeof createAccountContract, Context<typeof description>>;

package/dist/collections/user/createAccount.js

@@ -1,13 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAccount = exports.CreateAccountError = void 0;
+exports.createAccount = exports.createAccountContract = exports.CreateAccountError = void 0;
 const types_1 = require("@aeriajs/types");
 const validation_1 = require("@aeriajs/validation");
 const bcrypt = require("bcryptjs");
 const core_1 = require("@aeriajs/core");
+const description_js_1 = require("./description.js");
 exports.CreateAccountError = {
     SignupDisallowed: 'SIGNUP_DISALLOWED',
 };
+exports.createAccountContract = (0, types_1.defineContract)({
+    payload: {
+        type: 'object',
+        required: [],
+        additionalProperties: true,
+        properties: description_js_1.description.properties,
+    },
+    response: [
+        types_1.functionSchemas.insertError(),
+        (0, types_1.endpointErrorSchema)({
+            httpStatus: [
+                types_1.HTTPStatus.Forbidden,
+                types_1.HTTPStatus.UnprocessableContent,
+            ],
+            code: [
+                types_1.ACError.MalformedInput,
+                types_1.ACError.OwnershipError,
+                exports.CreateAccountError.SignupDisallowed,
+            ],
+        }),
+        (0, types_1.resultSchema)({
+            $ref: 'user',
+        }),
+    ],
+});
 const createAccount = async (payload, context) => {
     const userCandidate = Object.assign({}, payload);
     if (!context.config.security.allowSignup) {

package/dist/collections/user/createAccount.mjs

@@ -1,11 +1,37 @@
 "use strict";
-import { HTTPStatus, ACError } from "@aeriajs/types";
+import { defineContract, HTTPStatus, ACError, functionSchemas, endpointErrorSchema, resultSchema } from "@aeriajs/types";
 import { validate } from "@aeriajs/validation";
 import * as bcrypt from "bcryptjs";
 import { insert as originalInsert } from "@aeriajs/core";
+import { description } from "./description.mjs";
 export const CreateAccountError = {
   SignupDisallowed: "SIGNUP_DISALLOWED"
 };
+export const createAccountContract = defineContract({
+  payload: {
+    type: "object",
+    required: [],
+    additionalProperties: true,
+    properties: description.properties
+  },
+  response: [
+    functionSchemas.insertError(),
+    endpointErrorSchema({
+      httpStatus: [
+        HTTPStatus.Forbidden,
+        HTTPStatus.UnprocessableContent
+      ],
+      code: [
+        ACError.MalformedInput,
+        ACError.OwnershipError,
+        CreateAccountError.SignupDisallowed
+      ]
+    }),
+    resultSchema({
+      $ref: "user"
+    })
+  ]
+});
 export const createAccount = async (payload, context) => {
   const userCandidate = Object.assign({}, payload);
   if (!context.config.security.allowSignup) {

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

@@ -1,112 +1,104 @@
-import type { description } from './description.js';
-import { type Context, type SchemaWithId, type PackReferences } from '@aeriajs/types';
-export declare const editProfile: (payload: Partial<PackReferences<SchemaWithId<typeof description>>>, context: Context<typeof description>) => Promise<import("@aeriajs/types").InsertReturnType<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"];
-    readonly properties: {
-        readonly name: {
-            readonly type: "string";
-            readonly minLength: 1;
-        };
-        readonly given_name: {
-            readonly getter: (doc: object) => string | undefined;
-        };
-        readonly family_name: {
-            readonly getter: (doc: object) => string | undefined;
-        };
-        readonly active: {
-            readonly type: "boolean";
-        };
-        readonly roles: {
-            readonly type: "array";
-            readonly items: {
+import type { Context, ContractToFunction } from '@aeriajs/types';
+import { description } from './description.js';
+export declare const editProfileContract: {
+    readonly payload: {
+        readonly type: "object";
+        readonly required: readonly [];
+        readonly properties: {
+            readonly picture_file: {
                 readonly type: "string";
+                readonly format: "objectid";
             };
-            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 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 name: {
+                readonly type: "string";
+                readonly minLength: 1;
             };
-        };
-        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 getter: (doc: object) => string | undefined;
             };
             readonly family_name: {
-                readonly span: 3;
+                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: {
+                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";
             };
         };
     };
-}>> | import("@aeriajs/types").Result.Error<{
-    readonly code: "TARGET_IMMUTABLE";
-} & {
-    httpStatus: 403;
-}>>;
+    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, 422, 400, 500];
+                    };
+                    readonly code: {
+                        readonly enum: ["INSECURE_OPERATOR", "OWNERSHIP_ERROR", "RESOURCE_NOT_FOUND", "TARGET_IMMUTABLE", "MALFORMED_INPUT", "UNIQUENESS_VIOLATED", "EMPTY_TARGET", "INVALID_PROPERTIES", "MISSING_PROPERTIES", "INVALID_DOCUMENT_ID", "INVALID_TEMPFILE"];
+                    };
+                    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 $ref: "user";
+            };
+        };
+    }];
+};
+export declare const editProfile: ContractToFunction<typeof editProfileContract, Context<typeof description>>;

package/dist/collections/user/editProfile.js

@@ -1,9 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.editProfile = void 0;
+exports.editProfile = exports.editProfileContract = void 0;
 const types_1 = require("@aeriajs/types");
 const core_1 = require("@aeriajs/core");
 const bcrypt = require("bcryptjs");
+const description_js_1 = require("./description.js");
+exports.editProfileContract = (0, types_1.defineContract)({
+    payload: {
+        type: 'object',
+        required: [],
+        properties: {
+            ...description_js_1.description.properties,
+            picture_file: {
+                type: 'string',
+                format: 'objectid',
+            },
+        },
+    },
+    response: [
+        types_1.functionSchemas.insertError(),
+        (0, types_1.resultSchema)({
+            $ref: 'user',
+        }),
+    ],
+});
 const editProfile = async (payload, context) => {
     const mutableProperties = context.config.security.mutableUserProperties;
     if (!context.token.sub) {

package/dist/collections/user/editProfile.mjs

@@ -1,7 +1,27 @@
 "use strict";
-import { HTTPStatus, ACError } from "@aeriajs/types";
+import { HTTPStatus, ACError, defineContract, functionSchemas, resultSchema } from "@aeriajs/types";
 import { insert as originalInsert } from "@aeriajs/core";
 import * as bcrypt from "bcryptjs";
+import { description } from "./description.mjs";
+export const editProfileContract = defineContract({
+  payload: {
+    type: "object",
+    required: [],
+    properties: {
+      ...description.properties,
+      picture_file: {
+        type: "string",
+        format: "objectid"
+      }
+    }
+  },
+  response: [
+    functionSchemas.insertError(),
+    resultSchema({
+      $ref: "user"
+    })
+  ]
+});
 export const editProfile = async (payload, context) => {
   const mutableProperties = context.config.security.mutableUserProperties;
   if (!context.token.sub) {