@aeriajs/types 0.0.72 → 0.0.74

package/dist/collection.d.ts

@@ -1,15 +1,16 @@
 import type { AccessCondition } from './accessControl.js';
-import type { CollectionSecurityPolicy } from './security.js';
+import type { CollectionSecurityPolicy, CollectionMiddleware } 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<any>, ...args: any[]) => any>;
     contracts?: Record<string, Contract>;
     exposedFunctions?: Record<string, AccessCondition>;
+    security?: CollectionSecurityPolicy<TCollection>;
+    middlewares?: CollectionMiddleware | CollectionMiddleware[];
 };
 export type CollectionItem<TCollectionName extends keyof Collections> = Omit<Collections[TCollectionName]['item'], '_id'>;
 export type CollectionItemWithId<TCollectionName extends keyof Collections> = Collections[TCollectionName]['item'];

package/dist/description.d.ts

@@ -3,7 +3,7 @@ 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 CollectionPresets = 'crud' | 'duplicate' | 'remove' | 'removeAll' | 'owned' | 'timestamped' | 'view';
+export type DescriptionPreset = 'crud' | 'duplicate' | 'remove' | 'removeAll' | 'owned' | 'timestamped' | 'view';
 export type Icon = PhosphorIcon['name'];
 export type CollectionActionRoute = {
     route: {
@@ -61,16 +61,10 @@ export type FiltersPreset<TDescription extends Description> = {
     badgeFunction?: string;
     default?: boolean;
 };
-export type CollectionOptions<TDescription extends Description> = {
-    queryPreset?: {
-        filters?: Partial<Record<PropertiesWithId<TDescription> | `$${string}`, any>>;
-        sort?: Partial<Record<PropertiesWithId<TDescription>, any>>;
-    };
-};
 export type LayoutName = 'tabular' | 'grid' | 'list';
 export type LayoutOptions<TDescription extends Description = any> = {
-    picture?: PropertiesWithId<TDescription>;
     title?: PropertiesWithId<TDescription>;
+    picture?: PropertiesWithId<TDescription>;
     badge?: PropertiesWithId<TDescription>;
     information?: PropertiesWithId<TDescription>;
     active?: PropertiesWithId<TDescription>;
@@ -88,11 +82,9 @@ export type RuntimeDescription<TDescription extends Description = any> = Pick<TD
 export type Description<TDescription extends Description = any> = JsonSchema<TDescription> & {
     title?: string;
     categories?: readonly string[];
-    system?: boolean;
-    inline?: boolean;
+    hidden?: boolean;
     preferred?: Record<string, RuntimeDescription<TDescription>>;
     icon?: Icon;
-    options?: CollectionOptions<TDescription>;
     indexes?: readonly PropertiesWithId<TDescription>[];
     defaults?: Record<string, any>;
     owned?: OwnershipMode;
@@ -103,7 +95,7 @@ export type Description<TDescription extends Description = any> = JsonSchema<TDe
     timestamps?: false;
     immutable?: boolean | readonly (keyof TDescription['properties'])[] | ((doc: WithId<any>) => boolean | Promise<boolean>);
     route?: readonly string[];
-    presets?: readonly CollectionPresets[];
+    presets?: readonly DescriptionPreset[];
     table?: readonly PropertiesWithId<TDescription>[];
     tableMeta?: readonly PropertiesWithId<TDescription>[];
     filtersPresets?: Record<string, FiltersPreset<TDescription>>;

package/dist/property.d.ts

@@ -2,6 +2,7 @@ import type { PhosphorIcon } from '@phosphor-icons/core';
 import type { Condition } from './condition.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';
 export type PropertiesWithId<TSchema extends JsonSchema> = keyof TSchema['properties'] | '_id';
 export type RequiredProperties<TSchema extends JsonSchema> = readonly PropertiesWithId<TSchema>[] | Partial<Record<PropertiesWithId<TSchema>, Condition<TSchema> | boolean>>;
@@ -70,7 +71,7 @@ export type StringProperty = {
     mask?: string | readonly string[];
     maskedValue?: boolean;
     placeholder?: string;
-    element?: 'textarea';
+    element?: PropertyInputElement;
     inputType?: PropertyInputType;
 };
 export type NumberProperty = {

package/dist/security.d.ts

@@ -1,3 +1,6 @@
+import type { Result } from './result.js';
+import type { Context } from './context.js';
+import type { ACError } from './accessControl.js';
 export type OwnershipMode = boolean | 'always' | 'on-write';
 export declare enum RateLimitingError {
     Unauthenticated = "UNAUTHENTICATED",
@@ -29,3 +32,14 @@ export type CollectionSecurityPolicy<TCollection extends {
 }> = {
     functions?: Partial<Record<keyof TCollection['functions'], SecurityPolicy>>;
 };
+export type CollectionHookProps<TPayload = any> = {
+    propertyName?: string;
+    parentId?: string;
+    childId?: string;
+    payload: TPayload;
+};
+export type CollectionHook<TPayload = any> = (props: CollectionHookProps, context: Context) => Promise<Result.Either<ACError, TPayload>>;
+export type CollectionMiddleware = {
+    beforeRead: CollectionHook;
+    beforeWrite: CollectionHook;
+};

package/package.json

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