@aeriajs/types 0.0.48 → 0.0.49

package/dist/accessControl.d.ts

@@ -1,6 +1,7 @@
-export type UserRole = Collections['user']['item']['roles'][number] | 'root' | 'guest';
-export type AccessCondition = readonly UserRole[] | boolean | 'unauthenticated' | 'unauthenticated-only';
+export type UserRole = (Collections['user']['item']['roles'][number] extends infer UserDefinedRole ? UserDefinedRole extends string ? `${UserDefinedRole}${UserDefinedRole}` extends UserDefinedRole ? 'root' : UserDefinedRole : never : never) | 'root' | 'unauthenticated';
 export type AcceptedRole = UserRole | UserRole[] | null | unknown;
+export type AccessCondition = readonly UserRole[] | boolean | 'unauthenticated' | 'unauthenticated-only';
+export type RoleFromAccessCondition<TAccessCondition extends AccessCondition | undefined> = undefined extends TAccessCondition ? null : number extends keyof TAccessCondition ? TAccessCondition[number] : TAccessCondition extends true ? Exclude<UserRole, 'unauthenticated'> : TAccessCondition extends false ? never : TAccessCondition extends 'unauthenticated-only' ? 'unauthenticated' : TAccessCondition extends 'unauthenticated' ? UserRole : never;
 export declare enum ACErrors {
     AssetNotFound = "ASSET_NOT_FOUND",
     AuthenticationError = "AUTHENTICATION_ERROR",

package/dist/collection.d.ts

@@ -0,0 +1,17 @@
+import type { AccessCondition } from './accessControl.js';
+import type { CollectionSecurityPolicy } from './security.js';
+import type { Context } from './context.js';
+import type { Contract } from './contract.js';
+import type { Description } from './description.js';
+export type Collection<TCollection extends Collection = any> = {
+    description: Description;
+    item?: any;
+    security?: CollectionSecurityPolicy<TCollection>;
+    functions?: Record<string, (payload: any, context: Context, ...args: any[]) => any>;
+    contracts?: Record<string, Contract>;
+    exposedFunctions?: Record<string, AccessCondition>;
+};
+export type CollectionItem<TCollectionName extends keyof Collections> = Omit<Collections[TCollectionName]['item'], '_id'>;
+export type CollectionItemWithId<TCollectionName extends keyof Collections> = Collections[TCollectionName]['item'];
+export type AssetType = keyof Collection;
+export type FunctionPath = `/${string}/${string}`;

package/dist/config.d.ts

@@ -1,4 +1,6 @@
-import type { RouteContext, RouteUri, RateLimitingParams } from '.';
+import type { RouteContext } from './context.js';
+import type { RouteUri } from './http.js';
+import type { RateLimitingParams } from './security.js';
 export type ApiConfig = {
     secret?: string;
     baseUrl?: RouteUri;

package/dist/context.d.ts

@@ -1,6 +1,14 @@
 import type { Collection as MongoCollection } from 'mongodb';
+import type { AcceptedRole } from './accessControl.js';
+import type { ApiConfig } from './config.js';
+import type { CollectionDocument, CollectionFunctions } from './functions.js';
+import type { Description } from './description.js';
+import type { Either, EndpointError, EndpointErrorContent } from './monad.js';
+import type { FunctionPath } from './collection.js';
 import type { GenericRequest, GenericResponse } from './http.js';
-import type { Either, EndpointError, Description, PackReferences, SchemaWithId, FunctionPath, Token, ApiConfig, CollectionDocument, CollectionFunctions, RateLimitingParams, RateLimitingErrors, AcceptedRole } from '.';
+import type { PackReferences, SchemaWithId } from './schema.js';
+import type { RateLimitingParams, RateLimitingErrors } from './security.js';
+import type { Token } from './token.js';
 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;
@@ -33,10 +41,7 @@ export type RouteContext<TAcceptedRole extends AcceptedRole = null> = {
     request: GenericRequest;
     response: GenericResponse;
     log: (message: string, details?: any) => Promise<any>;
-    error: (error: EndpointError) => {
-        $isError: true;
-        error: EndpointError;
-    };
+    error: <TEndpointErrorContent extends EndpointErrorContent>(error: TEndpointErrorContent) => EndpointError<TEndpointErrorContent>;
     limitRate: (params: RateLimitingParams) => Promise<Either<RateLimitingErrors, {
         hits: number;
         points: number;

package/dist/contract.d.ts

@@ -1,4 +1,8 @@
-import type { Property, InferProperty, InferResponse, Context, UserRole } from '.';
+import type { Context } from './context.js';
+import type { InferProperty } from './schema.js';
+import type { InferResponse } from './http.js';
+import type { Property } from './property.js';
+import type { UserRole } from './accessControl.js';
 export type ContractBase = {
     builtin?: boolean;
 };

package/dist/description.d.ts

@@ -1,6 +1,6 @@
 import type { IconStyle, PhosphorIcon } from '@phosphor-icons/core';
-import type { JsonSchema, PropertiesWithId } from './property.js';
 import type { Condition } from './condition.js';
+import type { JsonSchema, PropertiesWithId } from './property.js';
 import type { OwnershipMode } from './security.js';
 export type CollectionPresets = 'crud' | 'duplicate' | 'remove' | 'removeAll' | 'owned' | 'timestamped' | 'view';
 export type Icon = PhosphorIcon['name'] | `${IconStyle}:${PhosphorIcon['name']}`;

package/dist/functions.d.ts

@@ -1,5 +1,8 @@
 import type { FilterOperators, StrictFilter as Filter, StrictUpdateFilter, WithId, OptionalId, ObjectId } from 'mongodb';
-import type { PackReferences, Either, ValidationError, ACErrors } from '.';
+import type { ACErrors } from './accessControl.js';
+import type { Either } from './monad.js';
+import type { PackReferences } from './schema.js';
+import type { ValidationError } from './validation.js';
 export type UploadAuxProps = {
     parentId: string;
     propertyName: string;

package/dist/http.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { ServerResponse, IncomingMessage } from 'http';
-import type { MapSchemaUnion } from '.';
+import type { MapSchemaUnion } from './schema.js';
 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];

package/dist/index.d.ts

@@ -1,16 +1,16 @@
 export * from './accessControl.js';
-export * from './api.js';
+export * from './collection.js';
 export * from './condition.js';
 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 './monad.js';
 export * from './functions.js';
 export * from './http.js';
 export * from './property.js';
 export * from './schema.js';
 export * from './security.js';
+export * from './token.js';
 export * from './validation.js';
 export type { WithId, OptionalId, } from 'mongodb';

package/dist/index.js

@@ -15,17 +15,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./accessControl.js"), exports);
-__exportStar(require("./api.js"), exports);
+__exportStar(require("./collection.js"), exports);
 __exportStar(require("./condition.js"), exports);
 __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("./monad.js"), exports);
 __exportStar(require("./functions.js"), exports);
 __exportStar(require("./http.js"), exports);
 __exportStar(require("./property.js"), exports);
 __exportStar(require("./schema.js"), exports);
 __exportStar(require("./security.js"), exports);
+__exportStar(require("./token.js"), exports);
 __exportStar(require("./validation.js"), exports);

package/dist/index.mjs

@@ -1,16 +1,16 @@
 "use strict";
 export * from "./accessControl.mjs";
-export * from "./api.mjs";
+export * from "./collection.mjs";
 export * from "./condition.mjs";
 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 "./monad.mjs";
 export * from "./functions.mjs";
 export * from "./http.mjs";
 export * from "./property.mjs";
 export * from "./schema.mjs";
 export * from "./security.mjs";
+export * from "./token.mjs";
 export * from "./validation.mjs";

package/dist/monad.d.ts

@@ -0,0 +1,21 @@
+export type Left<T> = {
+    readonly _tag: 'Left';
+    readonly value: T;
+};
+export type Right<T> = {
+    readonly _tag: 'Right';
+    readonly value: T;
+};
+export type EndpointErrorContent = {
+    httpCode?: number;
+    code: string;
+    message: string;
+    details?: Record<string, any>;
+};
+export type EndpointError<T extends EndpointErrorContent> = {
+    readonly _tag: 'Error';
+    readonly error: 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/property.d.ts

@@ -1,5 +1,5 @@
 import type { PhosphorIcon } from '@phosphor-icons/core';
-import type { Condition } from '.';
+import type { Condition } from './condition.js';
 export type PropertyArrayElement = 'checkbox' | 'radio' | 'select';
 export type PropertyInputType = 'text' | 'email' | 'password' | 'search' | 'time' | 'month';
 export type PropertyFormat = 'date' | 'date-time';

package/dist/security.d.ts

@@ -1,4 +1,3 @@
-import type { Collection } from './api.js';
 export type OwnershipMode = boolean | 'always' | 'on-write';
 export declare enum RateLimitingErrors {
     Unauthenticated = "UNAUTHENTICATED",
@@ -25,6 +24,8 @@ export type SecurityPolicy = {
     rateLimiting?: RateLimitingParams;
     logging?: LoggingParams;
 };
-export type CollectionSecurityPolicy<TCollection extends Collection = any> = {
+export type CollectionSecurityPolicy<TCollection extends {
+    functions?: Record<string, (...args: any[]) => unknown>;
+}> = {
     functions?: Partial<Record<keyof TCollection['functions'], SecurityPolicy>>;
 };

package/dist/token.d.ts

@@ -0,0 +1,20 @@
+import type { ObjectId } from 'mongodb';
+import type { PackReferences } from './schema.js';
+import type { FunctionPath } from './collection.js';
+import type { AcceptedRole } from './accessControl.js';
+export type AuthenticatedToken<TAcceptedRole extends AcceptedRole = null> = {
+    authenticated: true;
+    sub: ObjectId;
+    roles: readonly (TAcceptedRole extends null ? string : TAcceptedRole)[];
+    allowed_functions?: readonly FunctionPath[];
+    userinfo: Omit<Collections['user']['item'], '_id' | 'roles'> extends infer UserItem ? UserItem | PackReferences<UserItem> : never;
+};
+export type UnauthenticatedToken = {
+    authenticated: false;
+    sub: null;
+};
+export type TokenRecipient = {
+    type: 'bearer';
+    content: string;
+};
+export type Token<TAcceptedRole extends AcceptedRole = null> = [TAcceptedRole] extends [null | 'unauthenticated'] ? AuthenticatedToken | UnauthenticatedToken : AuthenticatedToken<TAcceptedRole>;

package/package.json

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

package/dist/api.d.ts

@@ -1,30 +0,0 @@
-import type { ObjectId } from 'mongodb';
-import type { Context, Contract, Description, CollectionSecurityPolicy, PackReferences, AcceptedRole, AccessCondition } from '.';
-export type Collection<TCollection extends Collection = any> = {
-    description: Description;
-    item?: any;
-    security?: CollectionSecurityPolicy<TCollection>;
-    functions?: Record<string, (payload: any, context: Context, ...args: any[]) => any>;
-    functionContracts?: Record<string, Contract>;
-    exposedFunctions?: Record<string, AccessCondition>;
-};
-export type CollectionItem<TCollectionName extends keyof Collections> = Omit<Collections[TCollectionName]['item'], '_id'>;
-export type CollectionItemWithId<TCollectionName extends keyof Collections> = Collections[TCollectionName]['item'];
-export type AssetType = keyof Collection;
-export type FunctionPath = `/${string}/${string}`;
-export type AuthenticatedToken<TAcceptedRole extends AcceptedRole = null> = {
-    authenticated: true;
-    sub: ObjectId;
-    roles: readonly (TAcceptedRole extends null ? string : TAcceptedRole)[];
-    allowed_functions?: readonly FunctionPath[];
-    userinfo: Collections['user']['item'] | PackReferences<Collections['user']['item']>;
-};
-export type UnauthenticatedToken = {
-    authenticated: false;
-    sub: null;
-};
-export type TokenRecipient = {
-    type: 'bearer';
-    content: string;
-};
-export type Token<TAcceptedRole extends AcceptedRole = null> = (TAcceptedRole extends any[] ? TAcceptedRole[number] : TAcceptedRole) extends infer NormalizedRole ? NormalizedRole extends null | 'guest' ? AuthenticatedToken | UnauthenticatedToken : AuthenticatedToken<NormalizedRole> : never;

package/dist/either.d.ts

@@ -1,9 +0,0 @@
-export type Left<T> = {
-    readonly _tag: 'Left';
-    readonly value: T;
-};
-export type Right<T> = {
-    readonly _tag: 'Right';
-    readonly value: T;
-};
-export type Either<L, R> = Left<L> | Right<R>;

package/dist/error.d.ts

@@ -1,6 +0,0 @@
-export type EndpointError = {
-    httpCode?: number;
-    code: string;
-    message: string;
-    details?: Record<string, any>;
-};