@aeriajs/types 0.0.26 → 0.0.28

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,7 +1,8 @@
-import type { Context } from './context';
+import type { RouteContext, RouteUri, RateLimitingParams } from '.';
 export type ApiConfig = {
     secret?: string;
     apiUrl?: string;
+    apiBase?: RouteUri;
     port?: number;
     paginationLimit?: number;
     database?: {
@@ -22,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: Context, error: TError) => any | Promise<any>;
+    errorHandler?: <TError extends Error>(context: RouteContext, error: TError) => any | Promise<any>;
 };

package/dist/context.d.ts

@@ -1,8 +1,8 @@
 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: infer Payload, context: Context, ...args: infer Rest) => infer Return ? (payload: Payload, ...args: Rest) => Return : never;
+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;
 type UnionFunctions<TFunctions, TSchema extends CollectionDocument<any>> = {
     [P in keyof TFunctions]: (P extends keyof CollectionFunctions<any> ? CollectionFunctions<TSchema>[P] extends infer CollFunction ? CollFunction extends (...args: any[]) => any ? Extract<undefined, Parameters<CollFunction>[0]> extends never ? (payload: Parameters<CollFunction>[0], ...args: RestParameters<TFunctions[P]>) => ReturnType<CollFunction> : (payload?: Parameters<CollFunction>[0], ...args: RestParameters<TFunctions[P]>) => ReturnType<CollFunction> : never : never : OmitContextParameter<TFunctions[P]>) extends (...args: infer Args) => infer Return ? Return extends Promise<any> ? (...args: Args) => Return : (...args: Args) => Promise<Return> : never;
@@ -18,29 +18,37 @@ 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;
     calledFunction?: string;
 };
-export type Context<TDescription extends Description = any, TFunctions = any> = {
-    description: TDescription;
-    collection: TDescription['$id'] extends keyof Collections ? IndepthCollection<{
-        description: TDescription;
-        functions: TFunctions;
-    }> : TDescription;
+export type RouteContext = {
     collections: IndepthCollections;
     functionPath: FunctionPath;
     token: DecodedToken;
-    collectionName?: (keyof Collections & string) | string;
     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;
 };
+export type Context<TDescription extends Description = any, TFunctions = any> = RouteContext & {
+    description: TDescription;
+    collectionName?: (keyof Collections & string) | string;
+    collection: TDescription['$id'] extends keyof Collections ? IndepthCollection<{
+        description: TDescription;
+        functions: TFunctions;
+    }> : TDescription;
+};
 export {};

package/dist/contract.d.ts

@@ -1,8 +1,11 @@
-import type { Property, InferProperty, Context } from '.';
+import type { Property, InferProperty, InferResponse, Context } from '.';
+export type ContractBase = {
+    builtin?: boolean;
+};
 export type ContractRoles = {
     roles?: (Collections['user']['item']['roles'][number] | 'root' | 'guest')[];
 };
-export type Contract = {
+export type Contract = ContractBase & ({
     response: Property | Property[];
 } | {
     payload: Property;
@@ -12,7 +15,7 @@ export type Contract = {
     response?: Property | Property[];
     payload?: Property;
     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/http.d.ts

@@ -2,6 +2,7 @@
 import type { ServerResponse, IncomingMessage } from 'http';
 import type { MapSchemaUnion } from '.';
 export declare const REQUEST_METHODS: readonly ["GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS", "PATCH", "TRACE", "SEARCH"];
+export type RouteUri = `/${string}`;
 export type RequestMethod = (typeof REQUEST_METHODS)[number];
 export type GenericRequest = {
     url: string;

package/dist/schema.d.ts

@@ -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.26",
+  "version": "0.0.28",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",