@aeriajs/types 0.0.112 → 0.0.114

package/dist/accessControl.d.ts

@@ -1,5 +1,5 @@
 import type { UserRole } from './token.js';
-export type AccessCondition = readonly UserRole[] | boolean | 'unauthenticated' | 'unauthenticated-only';
+export type AccessCondition = undefined | boolean | readonly UserRole[] | 'unauthenticated' | 'unauthenticated-only';
 export type RoleFromAccessCondition<TAccessCondition extends AccessCondition | undefined> = undefined extends TAccessCondition ? null : TAccessCondition extends readonly (infer Role)[] ? Role : TAccessCondition extends true ? Exclude<UserRole, 'unauthenticated'> : TAccessCondition extends false ? never : TAccessCondition extends 'unauthenticated-only' ? 'unauthenticated' : TAccessCondition extends 'unauthenticated' ? UserRole : never;
 export declare enum ACError {
     AuthenticationError = "AUTHENTICATION_ERROR",

package/dist/config.d.ts

@@ -2,6 +2,8 @@ import type { RouteContext } from './context.js';
 import type { RouteUri } from './http.js';
 import type { RateLimitingParams } from './security.js';
 import type { CollectionItem } from './collection.js';
+import type { UserRole } from './token.js';
+export type RolesHierarchy = Record<UserRole, readonly UserRole[] | boolean>;
 export type ApiConfig = {
     name?: string;
     secret?: string;
@@ -33,11 +35,12 @@ export type ApiConfig = {
         allowSignup?: boolean;
         mutableUserProperties: (keyof CollectionItem<'user'>)[];
         signupDefaults?: {
-            roles?: string[];
+            roles?: readonly UserRole[];
             active?: boolean;
         };
         paginationLimit?: number;
         exposeFunctionsByDefault?: boolean | 'unauthenticated';
+        rolesHierarchy?: RolesHierarchy;
     };
     tokenUserProperties?: (keyof CollectionItem<'user'>)[];
     errorHandler?: <TError>(context: RouteContext, error: TError) => unknown | Promise<unknown>;

package/dist/context.d.ts

@@ -1,5 +1,4 @@
 import type { Collection as MongoCollection } from 'mongodb';
-import type { AcceptedRole } from './token.js';
 import type { Collection } from './collection.js';
 import type { ApiConfig } from './config.js';
 import type { CollectionFunctions } from './functions.js';
@@ -11,6 +10,7 @@ import type { PackReferences, SchemaWithId } from './schema.js';
 import type { JsonSchema } from './property.js';
 import type { RateLimitingParams, RateLimitingError } from './security.js';
 import type { Token } from './token.js';
+import type { AccessCondition } from './accessControl.js';
 export type CollectionModel<TDescription extends Description> = MongoCollection<Omit<PackReferences<SchemaWithId<TDescription>>, '_id'>>;
 type OmitContextParameter<TFunction> = TFunction extends () => unknown ? TFunction : TFunction extends (payload: undefined, ...args: any[]) => infer Return ? () => Return : TFunction extends (payload: infer Payload, context: Context<any>, ...args: infer Rest) => infer Return ? (payload: Payload, ...args: Rest) => Return : never;
 type RestParameters<TFunction> = TFunction extends (payload: any, context: Context<any>, ...args: infer Rest) => unknown ? Rest : never;
@@ -38,9 +38,9 @@ export type ContextOptions = {
     inherited?: boolean;
     calledFunction?: string;
 };
-export type RouteContext<TAcceptedRole extends AcceptedRole = null> = {
+export type RouteContext<TAccessCondition extends AccessCondition = false> = {
     collections: IndepthCollections;
-    token: Token<TAcceptedRole>;
+    token: Token<TAccessCondition>;
     request: GenericRequest;
     response: GenericResponse;
     log: (message: string, details?: unknown) => Promise<unknown>;
@@ -66,5 +66,5 @@ export type CollectionContext<TDescription extends Description, TFunctions = Col
     calledFunction?: string;
 };
 export type Context<TDescription extends Description = Description, TFunctions = Collection['functions']> = RouteContext & CollectionContext<TDescription, TFunctions>;
-export type StrictContext<TAcceptedRole extends AcceptedRole = null, TDescription extends Description = any, TFunctions = Collection['functions']> = RouteContext<TAcceptedRole> & CollectionContext<TDescription, TFunctions>;
+export type StrictContext<TAccessCondition extends AccessCondition = false, TDescription extends Description = any, TFunctions = Collection['functions']> = RouteContext<TAccessCondition> & CollectionContext<TDescription, TFunctions>;
 export {};

package/dist/description.d.ts

@@ -3,7 +3,10 @@ import type { PhosphorIcon } from '@phosphor-icons/core';
 import type { Condition } from './condition.js';
 import type { JsonSchema, PropertiesWithId } from './property.js';
 import type { OwnershipMode } from './security.js';
-export type DescriptionPreset = 'add' | 'crud' | 'duplicate' | 'remove' | 'removeAll' | 'owned' | 'timestamped' | 'view';
+export declare const DESCRIPTION_PRESETS: readonly ["add", "crud", "duplicate", "remove", "removeAll", "owned", "timestamped", "view"];
+export declare const LAYOUT_NAMES: readonly ["tabular", "grid", "list"];
+export type DescriptionPreset = typeof DESCRIPTION_PRESETS[number];
+export type LayoutName = typeof LAYOUT_NAMES[number];
 export type Icon = PhosphorIcon['name'];
 export type CollectionActionRoute = {
     route: {
@@ -23,19 +26,19 @@ export type CollectionActionFunction = {
 export type CollectionActionEvent = {
     event?: string;
 };
-export type CollectionActionBase<TDescription extends Description> = {
+export type CollectionActionBase<TDescription extends Description = Description> = {
     label?: string;
     icon?: Icon;
     ask?: boolean;
     translate?: boolean;
+    button?: boolean;
     roles?: readonly string[];
     requires?: readonly PropertiesWithId<TDescription>[];
 };
-export type CollectionAction<TDescription extends Description> = CollectionActionBase<TDescription> & (CollectionActionRoute | CollectionActionFunction | CollectionActionEvent);
-export type CollectionActions<TDescription extends Description> = Record<string, CollectionAction<TDescription> & {
+export type CollectionAction<TDescription extends Description = Description> = CollectionActionBase<TDescription> & (CollectionActionRoute | CollectionActionFunction | CollectionActionEvent);
+export type CollectionActions<TDescription extends Description = Description> = Record<string, CollectionAction<TDescription> & {
     button?: boolean;
 } | null>;
-export type CollectionIndividualActions<TDescription extends Description> = Record<string, CollectionAction<TDescription> | null>;
 export type FormLayout<TDescription extends Description> = {
     fields?: Partial<Record<PropertiesWithId<TDescription>, FormLayoutField<TDescription>>>;
 };
@@ -64,7 +67,6 @@ export type FiltersPreset<TDescription extends Description> = {
     badgeFunction?: string;
     default?: boolean;
 };
-export type LayoutName = 'tabular' | 'grid' | 'list';
 export type LayoutOptions<TDescription extends Description = Description> = {
     title?: PropertiesWithId<TDescription>;
     picture?: PropertiesWithId<TDescription>;
@@ -77,12 +79,12 @@ export type Layout<TDescription extends Description = Description> = {
     name: LayoutName;
     options?: LayoutOptions<TDescription>;
 };
-export type SearchOptions<TDescription extends Description> = {
+export type SearchOptions<TDescription extends Description = Description> = {
     indexes: readonly (keyof TDescription['properties'])[];
     placeholder?: string;
     exactMatches?: boolean;
 };
-export type RuntimeDescription<TDescription extends Description = Description> = Pick<TDescription, 'actions' | 'individualActions' | 'filters' | 'filtersPresets' | 'layout' | 'table' | 'tableMeta' | 'form' | 'tableLayout' | 'formLayout'>;
+export type RuntimeDescription<TDescription extends Description = Description> = Partial<Pick<TDescription, 'actions' | 'individualActions' | 'filters' | 'filtersPresets' | 'layout' | 'table' | 'tableMeta' | 'form' | 'tableLayout' | 'formLayout'>>;
 export type Description<TDescription extends Description = any> = JsonSchema<TDescription> & {
     title?: string;
     categories?: readonly string[];
@@ -115,6 +117,6 @@ export type Description<TDescription extends Description = any> = JsonSchema<TDe
     formLayout?: Partial<FormLayout<TDescription>>;
     tableLayout?: Partial<TableLayout<TDescription>>;
     actions?: CollectionActions<TDescription>;
-    individualActions?: CollectionIndividualActions<TDescription>;
+    individualActions?: CollectionActions<TDescription>;
     search?: SearchOptions<TDescription>;
 };

package/dist/description.js

@@ -1,2 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.LAYOUT_NAMES = exports.DESCRIPTION_PRESETS = void 0;
+exports.DESCRIPTION_PRESETS = [
+    'add',
+    'crud',
+    'duplicate',
+    'remove',
+    'removeAll',
+    'owned',
+    'timestamped',
+    'view',
+];
+exports.LAYOUT_NAMES = [
+    'tabular',
+    'grid',
+    'list',
+];

package/dist/description.mjs

@@ -1 +1,16 @@
 "use strict";
+export const DESCRIPTION_PRESETS = [
+  "add",
+  "crud",
+  "duplicate",
+  "remove",
+  "removeAll",
+  "owned",
+  "timestamped",
+  "view"
+];
+export const LAYOUT_NAMES = [
+  "tabular",
+  "grid",
+  "list"
+];

package/dist/property.d.ts

@@ -2,10 +2,14 @@ import type { PhosphorIcon } from '@phosphor-icons/core';
 import type { ObjectId } from 'mongodb';
 import type { Condition } from './condition.js';
 import type { RouteContext } from './context.js';
-export type PropertyArrayElement = 'checkbox' | 'radio' | 'select';
-export type PropertyInputType = 'text' | 'email' | 'password' | 'search' | 'time' | 'month';
-export type PropertyInputElement = 'input' | 'textarea';
-export type PropertyFormat = 'date' | 'date-time' | 'objectid';
+export declare const PROPERTY_ARRAY_ELEMENTS: readonly ["checkbox", "radio", "select"];
+export declare const PROPERTY_INPUT_TYPES: readonly ["text", "email", "password", "search", "time", "month"];
+export declare const PROPERTY_INPUT_ELEMENTS: readonly ["input", "textarea"];
+export declare const PROPERTY_FORMATS: readonly ["date", "date-time", "objectid"];
+export type PropertyArrayElement = typeof PROPERTY_ARRAY_ELEMENTS[number];
+export type PropertyInputType = typeof PROPERTY_INPUT_TYPES[number];
+export type PropertyInputElement = typeof PROPERTY_INPUT_ELEMENTS[number];
+export type PropertyFormat = typeof PROPERTY_FORMATS[number];
 export type PropertiesWithId<TJsonSchema extends JsonSchema> = Extract<keyof TJsonSchema['properties'], string> | '_id';
 export type RequiredProperties<TJsonSchema extends JsonSchema> = readonly PropertiesWithId<TJsonSchema>[] | Partial<Record<PropertiesWithId<TJsonSchema>, Condition<TJsonSchema> | boolean>>;
 export type JsonSchema<TJsonSchema extends JsonSchema = any> = {
@@ -21,10 +25,10 @@ export type RefProperty = {
     $ref: Exclude<keyof Collections, 'file'> & string;
     indexes?: readonly string[];
     select?: readonly string[];
-    inline?: boolean;
+    populate?: readonly string[];
     form?: readonly string[];
+    inline?: boolean;
     purge?: boolean;
-    populate?: readonly string[];
     populateDepth?: number;
     constraints?: Condition;
 };
@@ -72,8 +76,8 @@ export type StringProperty = {
     mask?: string | readonly string[];
     maskedValue?: boolean;
     placeholder?: string;
-    element?: PropertyInputElement;
     inputType?: PropertyInputType;
+    element?: PropertyInputElement;
 };
 export type NumberProperty = {
     type: 'number' | 'integer';

package/dist/property.js

@@ -1,2 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROPERTY_FORMATS = exports.PROPERTY_INPUT_ELEMENTS = exports.PROPERTY_INPUT_TYPES = exports.PROPERTY_ARRAY_ELEMENTS = void 0;
+exports.PROPERTY_ARRAY_ELEMENTS = [
+    'checkbox',
+    'radio',
+    'select',
+];
+exports.PROPERTY_INPUT_TYPES = [
+    'text',
+    'email',
+    'password',
+    'search',
+    'time',
+    'month',
+];
+exports.PROPERTY_INPUT_ELEMENTS = [
+    'input',
+    'textarea',
+];
+exports.PROPERTY_FORMATS = [
+    'date',
+    'date-time',
+    'objectid',
+];

package/dist/property.mjs

@@ -1 +1,23 @@
 "use strict";
+export const PROPERTY_ARRAY_ELEMENTS = [
+  "checkbox",
+  "radio",
+  "select"
+];
+export const PROPERTY_INPUT_TYPES = [
+  "text",
+  "email",
+  "password",
+  "search",
+  "time",
+  "month"
+];
+export const PROPERTY_INPUT_ELEMENTS = [
+  "input",
+  "textarea"
+];
+export const PROPERTY_FORMATS = [
+  "date",
+  "date-time",
+  "objectid"
+];

package/dist/token.d.ts

@@ -1,13 +1,13 @@
 import type { ObjectId } from 'mongodb';
 import type { PackReferences } from './schema.js';
+import type { AccessCondition } from './accessControl.js';
 export type UserRole = (Collections['user']['item'] extends {
     roles: infer Roles;
 } ? Roles extends unknown[] ? Roles[number] extends infer UserDefinedRole ? UserDefinedRole extends string ? `${UserDefinedRole}${UserDefinedRole}` extends UserDefinedRole ? 'root' : UserDefinedRole : never : never : never : never) | 'root' | 'unauthenticated';
-export type AcceptedRole = UserRole | UserRole[] | null | unknown;
-export type AuthenticatedToken<TAcceptedRole extends AcceptedRole = null, TUserRole = UserRole, TUserInfo = Omit<Collections['user']['item'], '_id' | 'roles'>> = {
+export type AuthenticatedToken<TAccessCondition extends AccessCondition = true, TUserRole = UserRole, TUserInfo = Omit<Collections['user']['item'], '_id' | 'roles'>> = {
     authenticated: true;
     sub: ObjectId | null;
-    roles: readonly (TAcceptedRole extends null ? TUserRole : TAcceptedRole)[];
+    roles: TAccessCondition extends readonly unknown[] ? TAccessCondition : TAccessCondition extends true ? readonly TUserRole[] : TAccessCondition extends 'unauthenticated' ? readonly UserRole[] : readonly [];
     picture?: string;
     userinfo: Partial<TUserInfo | PackReferences<TUserInfo>>;
 };
@@ -19,4 +19,4 @@ export type TokenRecipient = {
     type: 'bearer';
     content: string;
 };
-export type Token<TAcceptedRole extends AcceptedRole = null, TUserRole = UserRole, TUserInfo = Omit<Collections['user']['item'], '_id' | 'roles'>> = (null extends TAcceptedRole ? true : 'unauthenticated' extends TAcceptedRole ? true : false) extends true ? AuthenticatedToken<null, TUserRole, TUserInfo> | UnauthenticatedToken : AuthenticatedToken<TAcceptedRole>;
+export type Token<TAccessCondition extends AccessCondition = false, TUserRole = UserRole, TUserInfo = Omit<Collections['user']['item'], '_id' | 'roles'>> = (false extends TAccessCondition ? false : TAccessCondition extends 'unauthenticated' | 'unauthenticated-only' ? false : true) extends true ? AuthenticatedToken<TAccessCondition> : 'unauthenticated-only' extends TAccessCondition ? UnauthenticatedToken : AuthenticatedToken<true, TUserRole, TUserInfo> | UnauthenticatedToken;

package/dist/validation.d.ts

@@ -27,16 +27,16 @@ export type PropertyValidationError = {
 };
 export type ValidationErrorInvalidProperties = {
     code: ValidationErrorCode.InvalidProperties;
-    errors: Record<string, PropertyValidationError | ValidationError>;
+    details: Record<string, PropertyValidationError | ValidationError>;
 };
 export type ValidationErrorMissingProperties = {
     code: ValidationErrorCode.MissingProperties;
-    errors: Record<string, {
+    details: Record<string, {
         type: 'missing';
     }>;
 };
 export type ValidationErrorEmptyTarget = {
     code: ValidationErrorCode.EmptyTarget;
-    errors: {};
+    details: {};
 };
 export type ValidationError = ValidationErrorInvalidProperties | ValidationErrorMissingProperties | ValidationErrorEmptyTarget;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeriajs/types",
-  "version": "0.0.112",
+  "version": "0.0.114",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -21,7 +21,7 @@
   "files": [
     "dist"
   ],
-  "devDependencies": {
+  "peerDependencies": {
     "@phosphor-icons/core": "^2.1.1"
   },
   "scripts": {