@aeriajs/types 0.0.54 → 0.0.56

package/dist/context.d.ts

@@ -3,7 +3,8 @@ import type { AcceptedRole } from './token.js';
 import type { ApiConfig } from './config.js';
 import type { CollectionDocument, CollectionFunctions } from './functions.js';
 import type { Description } from './description.js';
-import type { EndpointError, EndpointErrorContent } from './error.js';
+import type { Result } from './result.js';
+import type { EndpointError } from './endpointError.js';
 import type { GenericRequest, GenericResponse, HTTPStatus } from './http.js';
 import type { PackReferences, SchemaWithId } from './schema.js';
 import type { RateLimitingParams, RateLimitingError } from './security.js';
@@ -39,15 +40,15 @@ export type RouteContext<TAcceptedRole extends AcceptedRole = null> = {
     request: GenericRequest;
     response: GenericResponse;
     log: (message: string, details?: any) => Promise<any>;
-    error: <const THTTPStatus extends HTTPStatus, const TEndpointErrorContent extends EndpointErrorContent>(httpStatus: THTTPStatus, error: TEndpointErrorContent) => EndpointError<TEndpointErrorContent & {
+    error: <const THTTPStatus extends HTTPStatus, const TEndpointError extends EndpointError>(httpStatus: THTTPStatus, error: TEndpointError) => Result.Error<TEndpointError & {
         httpStatus: THTTPStatus;
     }>;
-    limitRate: (params: RateLimitingParams) => Promise<EndpointError<EndpointErrorContent<RateLimitingError, HTTPStatus.TooManyRequests>> | {
+    limitRate: (params: RateLimitingParams) => Promise<Result.Either<EndpointError<RateLimitingError, HTTPStatus.TooManyRequests>, {
         hits: number;
         points: number;
         last_reach: Date;
         last_maximum_reach: Date;
-    }>;
+    }>>;
     config: ApiConfig;
     inherited: boolean;
     calledFunction: string;

package/dist/description.d.ts

@@ -18,6 +18,7 @@ export type CollectionAction<TDescription extends Description> = {
     clearItem?: boolean;
     params?: Record<string, any>;
     query?: Record<string, any>;
+    roles?: readonly string[];
     requires?: readonly PropertiesWithId<TDescription>[];
 };
 export type CollectionActions<TDescription extends Description> = Record<string, null | CollectionAction<TDescription>>;

package/dist/endpointError.d.ts

@@ -0,0 +1,15 @@
+import type { HTTPStatus } from './http.js';
+export declare const ERROR_SYMBOL_DESCRIPTION = "#__ERROR_SYMBOL__";
+export declare const ERROR_SYMBOL: unique symbol;
+export type EndpointError<TCode extends string = string, TDetails = unknown, THTTPStatus extends HTTPStatus = HTTPStatus, TMessage extends string = string> = {
+    code: TCode;
+    details?: TDetails;
+    httpStatus?: THTTPStatus;
+    message?: TMessage;
+};
+export type StrictEndpointError<TCode extends string = string, TDetails = unknown, THTTPStatus extends HTTPStatus | undefined = HTTPStatus, TMessage extends string | undefined = string> = {
+    code: TCode;
+    details?: TDetails;
+    httpStatus: THTTPStatus;
+    message?: TMessage;
+};

package/dist/functions.d.ts

@@ -1,5 +1,6 @@
 import type { FilterOperators, StrictFilter as Filter, StrictUpdateFilter, WithId, OptionalId, ObjectId } from 'mongodb';
-import type { EndpointError, StrictEndpointErrorContent } from './error.js';
+import type { Result } from './result.js';
+import type { StrictEndpointError } from './endpointError.js';
 import type { PackReferences } from './schema.js';
 import type { ACError } from './accessControl.js';
 import type { ValidationErrorCode } from './validation.js';
@@ -68,8 +69,8 @@ export type RemoveFilePayload = UploadAuxProps & {
         _id: any;
     };
 };
-export type InsertReturnType<TDocument> = TDocument | EndpointError<StrictEndpointErrorContent<ACError.InsecureOperator | ACError.OwnershipError | ACError.ResourceNotFound | ACError.TargetImmutable | ValidationErrorCode, unknown, HTTPStatus.NotFound | HTTPStatus.UnprocessableContent>>;
-export type GetReturnType<TDocument> = TDocument | EndpointError<StrictEndpointErrorContent<ACError.ResourceNotFound, unknown, HTTPStatus.NotFound>>;
+export type InsertReturnType<TDocument> = Result.Either<StrictEndpointError<ACError.InsecureOperator | ACError.OwnershipError | ACError.ResourceNotFound | ACError.TargetImmutable | ValidationErrorCode, unknown, HTTPStatus.NotFound | HTTPStatus.UnprocessableContent>, TDocument>;
+export type GetReturnType<TDocument> = Result.Either<StrictEndpointError<ACError.ResourceNotFound | ACError.MalformedInput, unknown, HTTPStatus.NotFound | HTTPStatus.BadRequest>, TDocument>;
 export type CollectionFunctions<TDocument extends CollectionDocument<OptionalId<any>>> = {
     count: (payload: CountPayload<TDocument>) => Promise<number>;
     get: (payload: GetPayload<TDocument>) => Promise<GetReturnType<TDocument>>;

package/dist/http.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="node" />
 import type { ServerResponse, IncomingMessage } from 'http';
 import type { MapSchemaUnion } from './schema.js';
-import type { EndpointError, EndpointErrorContent, StrictEndpointErrorContent } from './error.js';
+import type { ExtractError, ExtractResult, Result } from './result.js';
+import type { EndpointError, StrictEndpointError } from './endpointError.js';
 import type { ACError } from './accessControl.js';
 import type { RateLimitingError } from './security.js';
 export declare const REQUEST_METHODS: readonly ["GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS", "PATCH", "TRACE", "SEARCH"];
@@ -28,9 +29,9 @@ export type GenericRequest = {
     nodeRequest: IncomingMessage;
 };
 export type GenericResponse = ServerResponse;
-type ExtractCode<TRouteResponse> = TRouteResponse extends EndpointError<EndpointErrorContent<infer PCode>> ? PCode : never;
-type ExtractHTTPStatus<TRouteResponse> = TRouteResponse extends EndpointError<EndpointErrorContent<any, unknown, infer PHTTPStatus>> ? PHTTPStatus : never;
-export type WithACErrors<TRouteResponse> = Exclude<TRouteResponse, EndpointError<any>> | EndpointError<StrictEndpointErrorContent<ExtractCode<TRouteResponse> | ACError.AuthenticationError | ACError.AuthorizationError | RateLimitingError.LimitReached | RateLimitingError.Unauthenticated, unknown, ExtractHTTPStatus<TRouteResponse> | HTTPStatus.Unauthorized | HTTPStatus.TooManyRequests>>;
+type ExtractCode<TRouteResponse> = TRouteResponse extends Result.Error<EndpointError<infer PCode>> ? PCode : never;
+type ExtractHTTPStatus<TRouteResponse> = TRouteResponse extends Result.Error<EndpointError<any, unknown, infer PHTTPStatus>> ? PHTTPStatus : never;
+export type WithACErrors<TRouteResponse> = Result.Either<ExtractError<TRouteResponse> | StrictEndpointError<ExtractCode<TRouteResponse> | ACError.AuthenticationError | ACError.AuthorizationError | RateLimitingError.LimitReached | RateLimitingError.Unauthenticated, unknown, ExtractHTTPStatus<TRouteResponse> | HTTPStatus.Unauthorized | HTTPStatus.TooManyRequests>, ExtractResult<TRouteResponse>>;
 export type EndpointFunction<TRouteMethod extends RequestMethod, TRouteResponse, TRoutePayload> = (TRoutePayload extends null ? (payload?: any) => Promise<WithACErrors<TRouteResponse>> : TRoutePayload extends undefined ? () => Promise<WithACErrors<TRouteResponse>> : (payload: TRoutePayload) => Promise<WithACErrors<TRouteResponse>>) extends infer Function ? Record<TRouteMethod, Function> : never;
 export type MakeEndpoint<TRoute extends string, TRouteMethod extends RequestMethod, TRouteResponse = any, TRoutePayload = null> = TRoute extends `/${infer RouteTail}` ? MakeEndpoint<RouteTail, TRouteMethod, TRouteResponse, TRoutePayload> : TRoute extends `${infer Route}/${infer RouteTail}` ? Record<Route, MakeEndpoint<RouteTail, TRouteMethod, TRouteResponse, TRoutePayload>> : TRoute extends `(${string}` ? Record<string, EndpointFunction<TRouteMethod, TRouteResponse, TRoutePayload>> : Record<TRoute, EndpointFunction<TRouteMethod, TRouteResponse, TRoutePayload>>;
 type UnwrapResponse<TResponse> = TResponse extends readonly any[] ? TResponse : TResponse[];

package/dist/index.d.ts

@@ -5,8 +5,7 @@ export * from './config.js';
 export * from './context.js';
 export * from './contract.js';
 export * from './description.js';
-export * from './either.js';
-export * from './error.js';
+export * from './endpointError.js';
 export * from './functions.js';
 export * from './http.js';
 export * from './property.js';

package/dist/index.js

@@ -21,8 +21,7 @@ __exportStar(require("./config.js"), exports);
 __exportStar(require("./context.js"), exports);
 __exportStar(require("./contract.js"), exports);
 __exportStar(require("./description.js"), exports);
-__exportStar(require("./either.js"), exports);
-__exportStar(require("./error.js"), exports);
+__exportStar(require("./endpointError.js"), exports);
 __exportStar(require("./functions.js"), exports);
 __exportStar(require("./http.js"), exports);
 __exportStar(require("./property.js"), exports);

package/dist/index.mjs

@@ -6,8 +6,7 @@ export * from "./config.mjs";
 export * from "./context.mjs";
 export * from "./contract.mjs";
 export * from "./description.mjs";
-export * from "./either.mjs";
-export * from "./error.mjs";
+export * from "./endpointError.mjs";
 export * from "./functions.mjs";
 export * from "./http.mjs";
 export * from "./property.mjs";

package/dist/result.d.ts

@@ -0,0 +1,15 @@
+export declare namespace Result {
+    type Error<T> = {
+        readonly _tag: 'Error';
+        readonly error: T;
+        readonly result: undefined;
+    };
+    type Result<T> = {
+        readonly _tag: 'Result';
+        readonly error: undefined;
+        readonly result: T;
+    };
+    type Either<E, R> = Result.Error<E> | Result.Result<R>;
+}
+export type ExtractError<T> = T extends Result.Error<infer L> ? L : never;
+export type ExtractResult<T> = T extends Result.Result<infer R> ? R : never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeriajs/types",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -13,6 +13,11 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./result": {
+      "import": "./dist/result.mjs",
+      "require": "./dist/result.js",
+      "types": "./dist/result.d.ts"
     }
   },
   "keywords": [],

package/dist/either.d.ts

@@ -1,11 +0,0 @@
-export type Left<T> = {
-    readonly _tag: 'Left';
-    readonly value: T;
-};
-export type Right<T> = {
-    readonly _tag: 'Right';
-    readonly value: T;
-};
-export type ExtractLeft<T> = T extends Left<infer L> ? L : never;
-export type ExtractRight<T> = T extends Right<infer R> ? R : never;
-export type Either<L, R> = Left<L> | Right<R>;

package/dist/error.d.ts

@@ -1,21 +0,0 @@
-import type { HTTPStatus } from './http.js';
-export declare const ERROR_SYMBOL_DESCRIPTION = "#__ERROR_SYMBOL__";
-export declare const ERROR_SYMBOL: unique symbol;
-export type EndpointErrorContent<TCode extends string = string, TDetails = unknown, THTTPStatus extends HTTPStatus = HTTPStatus, TMessage extends string = string> = {
-    code: TCode;
-    details?: TDetails;
-    httpStatus?: THTTPStatus;
-    message?: TMessage;
-};
-export type StrictEndpointErrorContent<TCode extends string = string, TDetails = unknown, THTTPStatus extends HTTPStatus | undefined = HTTPStatus, TMessage extends string | undefined = string> = {
-    code: TCode;
-    details?: TDetails;
-    httpStatus: THTTPStatus;
-    message?: TMessage;
-};
-export type EndpointError<TEndpointErrorContent extends EndpointErrorContent | unknown = EndpointErrorContent> = {
-    readonly _tag: 'Error';
-    readonly value: TEndpointErrorContent;
-};
-export type ExtractError<T> = T extends EndpointError ? T : never;
-export type ExtractSuccessful<T> = T extends EndpointError ? never : T;