@aeriajs/types 0.0.27 → 0.0.29

package/dist/api.d.ts

@@ -14,13 +14,15 @@ export type UserACProfile = {
     readonly roles: string[];
     readonly allowed_functions?: string[];
 };
-export type DecodedToken = {
+export type AuthenticatedToken = {
     authenticated: true;
     sub: ObjectId;
     roles: string[];
     userinfo: PackReferences<Collections['user']['item']>;
     allowed_functions?: FunctionPath[];
-} | {
+};
+export type UnauthenticatedToken = {
     authenticated: false;
     sub: null;
 };
+export type DecodedToken = AuthenticatedToken | UnauthenticatedToken;

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import type { RouteContext, RouteUri } from '.';
+import type { RouteContext, RouteUri, RateLimitingParams } from '.';
 export type ApiConfig = {
     secret?: string;
     apiUrl?: string;
@@ -23,7 +23,10 @@ export type ApiConfig = {
         roles: string[];
         active: boolean;
     }>;
-    logSuccessfulAuthentications?: boolean;
+    security?: {
+        logSuccessfulAuthentications?: boolean;
+        authenticationRateLimiting?: RateLimitingParams | null;
+    };
     tokenUserProperties?: string[];
     errorHandler?: <TError extends Error>(context: RouteContext, error: TError) => any | Promise<any>;
 };

package/dist/context.d.ts

@@ -1,6 +1,6 @@
 import type { Collection as MongoCollection } from 'mongodb';
 import type { GenericRequest, GenericResponse } from './http';
-import type { Description, PackReferences, SchemaWithId, FunctionPath, DecodedToken, ApiConfig, CollectionDocument, CollectionFunctions } from '.';
+import type { Either, Description, PackReferences, SchemaWithId, FunctionPath, DecodedToken, ApiConfig, CollectionDocument, CollectionFunctions, RateLimitingParams, RateLimitingErrors } from '.';
 export type CollectionModel<TDescription extends Description> = MongoCollection<Omit<PackReferences<SchemaWithId<TDescription>>, '_id'>>;
 type OmitContextParameter<TFunction> = TFunction extends () => any ? TFunction : TFunction extends (payload: undefined, ...args: any[]) => infer Return ? () => Return : TFunction extends (payload: infer Payload, context: Context, ...args: infer Rest) => infer Return ? (payload: Payload, ...args: Rest) => Return : never;
 type RestParameters<TFunction> = TFunction extends (payload: any, context: Context, ...args: infer Rest) => any ? Rest : never;
@@ -18,9 +18,9 @@ export type IndepthCollection<TCollection> = TCollection extends {
 export type IndepthCollections = {
     [P in keyof Collections]: IndepthCollection<Collections[P]>;
 };
-export type ContextOptions<TContext> = {
+export type ContextOptions = {
     config?: ApiConfig;
-    parentContext?: TContext;
+    parentContext?: RouteContext | Context;
     collectionName?: string;
     token?: DecodedToken;
     inherited?: boolean;
@@ -33,6 +33,12 @@ export type RouteContext = {
     request: GenericRequest;
     response: GenericResponse;
     log: (message: string, details?: any) => Promise<any>;
+    limitRate: (params: RateLimitingParams) => Promise<Either<RateLimitingErrors, {
+        hits: number;
+        points: number;
+        last_reach: Date;
+        last_maximum_reach: Date;
+    }>>;
     config: ApiConfig;
     inherited: boolean;
     calledFunction: string;

package/dist/contract.d.ts

@@ -1,4 +1,4 @@
-import type { Property, InferProperty, Context } from '.';
+import type { Property, InferProperty, InferResponse, Context } from '.';
 export type ContractBase = {
     builtin?: boolean;
 };
@@ -17,5 +17,5 @@ export type Contract = ContractBase & ({
     query?: Property;
 });
 export type ContractWithRoles = ContractRoles & Contract;
-export type ContractToFunction<TContract extends Contract | ContractWithRoles, ContextParameter = Context> = ('payload' extends keyof TContract ? InferProperty<TContract['payload']> : undefined) extends infer Payload ? ('response' extends keyof TContract ? InferProperty<TContract['response']> : any) extends infer Response ? Payload extends undefined ? (payload: Payload | undefined, context: ContextParameter) => Response : (payload: Payload, context: ContextParameter) => Response : never : never;
+export type ContractToFunction<TContract extends Contract | ContractWithRoles, ContextParameter = Context> = ('payload' extends keyof TContract ? InferProperty<TContract['payload']> : undefined) extends infer Payload ? ('response' extends keyof TContract ? InferResponse<TContract['response']> : any) extends infer Response ? Payload extends undefined ? (payload: Payload | undefined, context: ContextParameter) => Response : (payload: Payload, context: ContextParameter) => Response : never : never;
 export declare const defineContract: <const TContractWithRoles extends ContractWithRoles>(contract: TContractWithRoles) => TContractWithRoles;

package/dist/schema.d.ts

@@ -20,7 +20,7 @@ export type InferProperty<T> = T extends TestType<{
 }> ? K : T extends TestType<{
     type: 'string';
 }> ? string : T extends TestType<{
-    type: 'number';
+    type: 'number' | 'integer';
 }> ? number : T extends TestType<{
     type: 'boolean';
 }> ? boolean : T extends TestType<{
@@ -28,6 +28,10 @@ export type InferProperty<T> = T extends TestType<{
 }> ? Schema<T & {
     timestamps: false;
 }> : T extends TestType<{
+    additionalProperties: infer K;
+}> ? {
+    [P: string]: InferProperty<K> | undefined;
+} : T extends TestType<{
     type: 'object';
 }> ? any : T extends TestType<{
     items: infer K;

package/dist/security.d.ts

@@ -1,4 +1,9 @@
+export declare enum RateLimitingErrors {
+    Unauthenticated = "UNAUTHENTICATED",
+    LimitReached = "LIMIT_REACHED"
+}
 export type RateLimitingParams = {
+    strategy: 'tenant' | 'ip';
     limit?: number;
     scale?: number;
     increment?: number;

package/dist/security.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitingErrors = void 0;
+var RateLimitingErrors;
+(function (RateLimitingErrors) {
+    RateLimitingErrors["Unauthenticated"] = "UNAUTHENTICATED";
+    RateLimitingErrors["LimitReached"] = "LIMIT_REACHED";
+})(RateLimitingErrors || (exports.RateLimitingErrors = RateLimitingErrors = {}));

package/dist/security.mjs

@@ -1 +1,6 @@
 "use strict";
+export var RateLimitingErrors = /* @__PURE__ */ ((RateLimitingErrors2) => {
+  RateLimitingErrors2["Unauthenticated"] = "UNAUTHENTICATED";
+  RateLimitingErrors2["LimitReached"] = "LIMIT_REACHED";
+  return RateLimitingErrors2;
+})(RateLimitingErrors || {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeriajs/types",
-  "version": "0.0.27",
+  "version": "0.0.29",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",