@aeriajs/security 0.0.95 → 0.0.96

package/dist/immutability.d.ts

@@ -1,4 +1,16 @@
 import type { Context } from '@aeriajs/types';
 import type { SecurityCheckProps, SecurityCheckReadPayload, SecurityCheckWritePayload } from './types.js';
 import { ACError } from '@aeriajs/types';
-export declare const checkImmutability: (props: SecurityCheckProps<SecurityCheckReadPayload | SecurityCheckWritePayload>, context: Context) => Promise<import("@aeriajs/types").Right<SecurityCheckReadPayload | SecurityCheckWritePayload> | import("@aeriajs/types").Left<ACError.ResourceNotFound> | import("@aeriajs/types").Left<ACError.TargetImmutable>>;
+export declare const checkImmutability: (props: SecurityCheckProps<SecurityCheckReadPayload | SecurityCheckWritePayload>, context: Context) => Promise<{
+    readonly _tag: "Result";
+    readonly error: undefined;
+    readonly result: SecurityCheckReadPayload | SecurityCheckWritePayload;
+} | {
+    readonly _tag: "Error";
+    readonly error: ACError.ResourceNotFound;
+    readonly result: undefined;
+} | {
+    readonly _tag: "Error";
+    readonly error: ACError.TargetImmutable;
+    readonly result: undefined;
+}>;

package/dist/immutability.js

@@ -5,7 +5,7 @@ const types_1 = require("@aeriajs/types");
 const common_1 = require("@aeriajs/common");
 const checkImmutability = async (props, context) => {
     if (!context.description.immutable) {
-        return (0, common_1.right)(props.payload);
+        return common_1.Result.result(props.payload);
     }
     const docId = 'filters' in props.payload
         ? props.payload.filters._id
@@ -16,15 +16,15 @@ const checkImmutability = async (props, context) => {
                 _id: docId,
             });
             if (!doc) {
-                return (0, common_1.left)(types_1.ACError.ResourceNotFound);
+                return common_1.Result.error(types_1.ACError.ResourceNotFound);
             }
             const isImmutable = await context.description.immutable(doc);
             return isImmutable
-                ? (0, common_1.left)(types_1.ACError.TargetImmutable)
-                : (0, common_1.right)(props.payload);
+                ? common_1.Result.error(types_1.ACError.TargetImmutable)
+                : common_1.Result.result(props.payload);
         }
-        return (0, common_1.left)(types_1.ACError.TargetImmutable);
+        return common_1.Result.error(types_1.ACError.TargetImmutable);
     }
-    return (0, common_1.right)(props.payload);
+    return common_1.Result.result(props.payload);
 };
 exports.checkImmutability = checkImmutability;

package/dist/immutability.mjs

@@ -1,9 +1,9 @@
 "use strict";
 import { ACError } from "@aeriajs/types";
-import { left, right } from "@aeriajs/common";
+import { Result } from "@aeriajs/common";
 export const checkImmutability = async (props, context) => {
   if (!context.description.immutable) {
-    return right(props.payload);
+    return Result.result(props.payload);
   }
   const docId = "filters" in props.payload ? props.payload.filters._id : props.payload.what._id;
   if (docId) {
@@ -12,12 +12,12 @@ export const checkImmutability = async (props, context) => {
         _id: docId
       });
       if (!doc) {
-        return left(ACError.ResourceNotFound);
+        return Result.error(ACError.ResourceNotFound);
       }
       const isImmutable = await context.description.immutable(doc);
-      return isImmutable ? left(ACError.TargetImmutable) : right(props.payload);
+      return isImmutable ? Result.error(ACError.TargetImmutable) : Result.result(props.payload);
     }
-    return left(ACError.TargetImmutable);
+    return Result.error(ACError.TargetImmutable);
   }
-  return right(props.payload);
+  return Result.result(props.payload);
 };

package/dist/ownership.d.ts

@@ -1,5 +1,17 @@
 import type { Context, InsertPayload } from '@aeriajs/types';
 import type { SecurityCheckProps, SecurityCheckReadPayload } from './types.js';
 import { ACError } from '@aeriajs/types';
-export declare const checkOwnershipRead: (props: SecurityCheckProps<SecurityCheckReadPayload>, context: Context) => Promise<import("@aeriajs/types").Right<SecurityCheckReadPayload>>;
-export declare const checkOwnershipWrite: (props: SecurityCheckProps<InsertPayload<any>>, context: Context) => Promise<import("@aeriajs/types").Right<InsertPayload<any>> | import("@aeriajs/types").Left<ACError.OwnershipError>>;
+export declare const checkOwnershipRead: (props: SecurityCheckProps<SecurityCheckReadPayload>, context: Context) => Promise<{
+    readonly _tag: "Result";
+    readonly error: undefined;
+    readonly result: SecurityCheckReadPayload;
+}>;
+export declare const checkOwnershipWrite: (props: SecurityCheckProps<InsertPayload<any>>, context: Context) => Promise<{
+    readonly _tag: "Result";
+    readonly error: undefined;
+    readonly result: InsertPayload<any>;
+} | {
+    readonly _tag: "Error";
+    readonly error: ACError.OwnershipError;
+    readonly result: undefined;
+}>;

package/dist/ownership.js

@@ -11,7 +11,7 @@ const checkOwnershipRead = async (props, context) => {
             payload.filters.owner = token.sub;
         }
     }
-    return (0, common_1.right)(payload);
+    return common_1.Result.result(payload);
 };
 exports.checkOwnershipRead = checkOwnershipRead;
 const checkOwnershipWrite = async (props, context) => {
@@ -23,12 +23,12 @@ const checkOwnershipWrite = async (props, context) => {
             payload.what.owner = token.sub;
         }
         else {
-            return (0, common_1.right)(payload);
+            return common_1.Result.result(payload);
         }
     }
     if ((!payload.what.owner && !parentId) && context.description.owned) {
-        return (0, common_1.left)(types_1.ACError.OwnershipError);
+        return common_1.Result.error(types_1.ACError.OwnershipError);
     }
-    return (0, common_1.right)(payload);
+    return common_1.Result.result(payload);
 };
 exports.checkOwnershipWrite = checkOwnershipWrite;

package/dist/ownership.mjs

@@ -1,6 +1,6 @@
 "use strict";
 import { ACError } from "@aeriajs/types";
-import { left, right } from "@aeriajs/common";
+import { Result } from "@aeriajs/common";
 export const checkOwnershipRead = async (props, context) => {
   const { token, description } = context;
   const payload = Object.assign({}, props.payload);
@@ -9,7 +9,7 @@ export const checkOwnershipRead = async (props, context) => {
       payload.filters.owner = token.sub;
     }
   }
-  return right(payload);
+  return Result.result(payload);
 };
 export const checkOwnershipWrite = async (props, context) => {
   const { token, description } = context;
@@ -19,11 +19,11 @@ export const checkOwnershipWrite = async (props, context) => {
     if (!payload.what._id || description.owned === "always") {
       payload.what.owner = token.sub;
     } else {
-      return right(payload);
+      return Result.result(payload);
     }
   }
   if (!payload.what.owner && !parentId && context.description.owned) {
-    return left(ACError.OwnershipError);
+    return Result.error(ACError.OwnershipError);
   }
-  return right(payload);
+  return Result.result(payload);
 };

package/dist/pagination.d.ts

@@ -1,3 +1,11 @@
 import type { SecurityCheckProps, SecurityCheckReadPayload } from './types.js';
 import { ACError } from '@aeriajs/types';
-export declare const checkPagination: (props: SecurityCheckProps<SecurityCheckReadPayload>) => Promise<import("@aeriajs/types").Right<SecurityCheckReadPayload> | import("@aeriajs/types").Left<ACError.InvalidLimit>>;
+export declare const checkPagination: (props: SecurityCheckProps<SecurityCheckReadPayload>) => Promise<{
+    readonly _tag: "Result";
+    readonly error: undefined;
+    readonly result: SecurityCheckReadPayload;
+} | {
+    readonly _tag: "Error";
+    readonly error: ACError.InvalidLimit;
+    readonly result: undefined;
+}>;

package/dist/pagination.js

@@ -7,9 +7,9 @@ const checkPagination = async (props) => {
     const { payload } = props;
     if (payload.limit) {
         if (payload.limit <= 0 || payload.limit > 150) {
-            return (0, common_1.left)(types_1.ACError.InvalidLimit);
+            return common_1.Result.error(types_1.ACError.InvalidLimit);
         }
     }
-    return (0, common_1.right)(payload);
+    return common_1.Result.result(payload);
 };
 exports.checkPagination = checkPagination;

package/dist/pagination.mjs

@@ -1,12 +1,12 @@
 "use strict";
 import { ACError } from "@aeriajs/types";
-import { left, right } from "@aeriajs/common";
+import { Result } from "@aeriajs/common";
 export const checkPagination = async (props) => {
   const { payload } = props;
   if (payload.limit) {
     if (payload.limit <= 0 || payload.limit > 150) {
-      return left(ACError.InvalidLimit);
+      return Result.error(ACError.InvalidLimit);
     }
   }
-  return right(payload);
+  return Result.result(payload);
 };

package/dist/rateLimiting.d.ts

@@ -34,28 +34,32 @@ export declare const getOrCreateUsageEntry: (params: RateLimitingParams, context
         };
     };
 }>>, "_id">>>;
-export declare const limitRate: (params: RateLimitingParams, context: RouteContext) => Promise<import("@aeriajs/types").PackReferences<{} & Omit<Readonly<import("@aeriajs/types").FilterReadonlyProperties<{
-    readonly hits: {
-        readonly type: "integer";
-    };
-    readonly points: {
-        readonly type: "integer";
-    };
-    readonly last_reach: {
-        readonly type: "string";
-        readonly format: "date-time";
-    };
-    readonly last_maximum_reach: {
-        readonly type: "string";
-        readonly format: "date-time";
-    };
-}>> & {
-    hits: number;
-    points: number;
-    last_reach: Date;
-    last_maximum_reach: Date;
-}, never>> | import("@aeriajs/types").EndpointError<{
+export declare const limitRate: (params: RateLimitingParams, context: RouteContext) => Promise<import("../../types/dist/result").Result.Error<{
     readonly code: RateLimitingError.LimitReached;
 } & {
     httpStatus: HTTPStatus.TooManyRequests;
-}>>;
+}> | {
+    readonly _tag: "Result";
+    readonly error: undefined;
+    readonly result: import("@aeriajs/types").PackReferences<{} & Omit<Readonly<import("@aeriajs/types").FilterReadonlyProperties<{
+        readonly hits: {
+            readonly type: "integer";
+        };
+        readonly points: {
+            readonly type: "integer";
+        };
+        readonly last_reach: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly last_maximum_reach: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+    }>> & {
+        hits: number;
+        points: number;
+        last_reach: Date;
+        last_maximum_reach: Date;
+    }, never>>;
+}>;

package/dist/rateLimiting.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.limitRate = exports.getOrCreateUsageEntry = void 0;
 const types_1 = require("@aeriajs/types");
+const common_1 = require("@aeriajs/common");
 const buildEntryFilter = (params, context) => {
     if (params.strategy === 'ip') {
         const address = context.response.socket.remoteAddress;
@@ -65,6 +66,6 @@ const limitRate = async (params, context) => {
     if (!newEntry) {
         throw new Error();
     }
-    return newEntry.usage[resourceName];
+    return common_1.Result.result(newEntry.usage[resourceName]);
 };
 exports.limitRate = limitRate;

package/dist/rateLimiting.mjs

@@ -1,5 +1,6 @@
 "use strict";
 import { HTTPStatus, RateLimitingError } from "@aeriajs/types";
+import { Result } from "@aeriajs/common";
 const buildEntryFilter = (params, context) => {
   if (params.strategy === "ip") {
     const address = context.response.socket.remoteAddress;
@@ -70,5 +71,5 @@ export const limitRate = async (params, context) => {
   if (!newEntry) {
     throw new Error();
   }
-  return newEntry.usage[resourceName];
+  return Result.result(newEntry.usage[resourceName]);
 };

package/dist/types.d.ts

@@ -1,4 +1,5 @@
-import type { Context, Either, GetAllPayload, InsertPayload, ACError } from '@aeriajs/types';
+import type { Context, GetAllPayload, InsertPayload, ACError } from '@aeriajs/types';
+import type { Result } from '@aeriajs/common';
 export type SecurityCheckReadPayload = {
     filters: Record<string, any>;
     sort?: Record<string, any>;
@@ -14,4 +15,4 @@ export type SecurityCheckProps<TPayload extends Record<string, any> = any> = {
     childId?: string;
     payload: TPayload;
 };
-export type SecurityCheck = (props: SecurityCheckProps, context: Context) => Promise<Either<ACError, GetAllPayload<any> | InsertPayload<any>>>;
+export type SecurityCheck = (props: SecurityCheckProps, context: Context) => Promise<Result.Either<ACError, GetAllPayload<any> | InsertPayload<any>>>;

package/dist/use.d.ts

@@ -1,5 +1,21 @@
 import type { Context, Description, GetAllPayload, InsertPayload } from '@aeriajs/types';
 export declare const useSecurity: <TDescription extends Description>(context: Context<TDescription>) => {
-    beforeRead: <TPayload extends Partial<GetAllPayload<any>>>(payload?: TPayload) => Promise<import("@aeriajs/types").Left<import("@aeriajs/types").ACError> | import("@aeriajs/types").Right<any>>;
-    beforeWrite: <TPayload_1 extends Partial<InsertPayload<any>>>(payload?: TPayload_1 | undefined) => Promise<import("@aeriajs/types").Left<import("@aeriajs/types").ACError> | import("@aeriajs/types").Right<any>>;
+    beforeRead: <TPayload extends Partial<GetAllPayload<any>>>(payload?: TPayload) => Promise<{
+        readonly _tag: "Error";
+        readonly error: any;
+        readonly result: undefined;
+    } | {
+        readonly _tag: "Result";
+        readonly error: undefined;
+        readonly result: any;
+    }>;
+    beforeWrite: <TPayload_1 extends Partial<InsertPayload<any>>>(payload?: TPayload_1 | undefined) => Promise<{
+        readonly _tag: "Error";
+        readonly error: any;
+        readonly result: undefined;
+    } | {
+        readonly _tag: "Result";
+        readonly error: undefined;
+        readonly result: any;
+    }>;
 };

package/dist/use.js

@@ -11,14 +11,13 @@ const chainFunctions = async (_props, context, functions) => {
         if (!fn) {
             continue;
         }
-        const resultEither = await fn(props, context);
-        if ((0, common_1.isLeft)(resultEither)) {
-            return resultEither;
+        const { error, result } = await fn(props, context);
+        if (error) {
+            return common_1.Result.error(error);
         }
-        const result = (0, common_1.unwrapEither)(resultEither);
         Object.assign(props.payload, result);
     }
-    return (0, common_1.right)(props.payload);
+    return common_1.Result.result(props.payload);
 };
 const useSecurity = (context) => {
     const options = context.description.options

package/dist/use.mjs

@@ -1,5 +1,5 @@
 "use strict";
-import { deepMerge, right, isLeft, unwrapEither } from "@aeriajs/common";
+import { deepMerge, Result } from "@aeriajs/common";
 import {
   checkImmutability,
   checkOwnershipRead,
@@ -14,14 +14,13 @@ const chainFunctions = async (_props, context, functions) => {
     if (!fn) {
       continue;
     }
-    const resultEither = await fn(props, context);
-    if (isLeft(resultEither)) {
-      return resultEither;
+    const { error, result } = await fn(props, context);
+    if (error) {
+      return Result.error(error);
     }
-    const result = unwrapEither(resultEither);
     Object.assign(props.payload, result);
   }
-  return right(props.payload);
+  return Result.result(props.payload);
 };
 export const useSecurity = (context) => {
   const options = context.description.options ? Object.assign({}, context.description.options) : {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeriajs/security",
-  "version": "0.0.95",
+  "version": "0.0.96",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -28,9 +28,9 @@
     "mongodb": "^6.5.0"
   },
   "peerDependencies": {
-    "@aeriajs/core": "^0.0.95",
-    "@aeriajs/common": "^0.0.59",
-    "@aeriajs/types": "^0.0.55",
+    "@aeriajs/core": "^0.0.96",
+    "@aeriajs/common": "^0.0.60",
+    "@aeriajs/types": "^0.0.56",
     "mongodb": "^6.5.0"
   },
   "scripts": {