@aeriajs/types 0.0.30 → 0.0.32

package/dist/accessControl.d.ts

@@ -1,4 +1,4 @@
-import type { AuthenticatedToken, Collection, Token, UserRole } from '.';
+import type { Collection } from '.';
 export declare enum ACErrors {
     AssetNotFound = "ASSET_NOT_FOUND",
     AuthenticationError = "AUTHENTICATION_ERROR",
@@ -28,6 +28,3 @@ export type NonCircularAccessControl<TCollection extends Collection = any, TAcce
     availableRoles?: keyof TAccessControl['roles'];
     parent?: TAccessControl['roles'];
 };
-export type ExpectToken<TToken extends Token, TRole extends UserRole | UserRole[]> = (TRole extends any[] ? TRole[number] : TRole) extends infer NormalizedRole ? TToken extends AuthenticatedToken ? NormalizedRole extends TToken['roles'][number] ? TToken : Omit<TToken, 'roles'> & {
-    roles: readonly NormalizedRole[];
-} : TToken : never;

package/dist/api.d.ts

@@ -1,5 +1,6 @@
 import type { ObjectId } from 'mongodb';
 import type { Context, Contract, Description, CollectionSecurityPolicy, AccessControl, PackReferences } from '.';
+export type AcceptedRole = UserRole | UserRole[] | null | unknown;
 export type Collection<TCollection extends Collection = any> = {
     description: Description;
     item?: any;
@@ -9,12 +10,12 @@ export type Collection<TCollection extends Collection = any> = {
     functionContracts?: Record<string, Contract>;
 };
 export type AssetType = keyof Collection;
-export type FunctionPath = `${string}@${string}`;
-export type UserRole = Collections['user']['item']['roles'][number];
-export type AuthenticatedToken<TAcceptedRole = string> = {
+export type FunctionPath = `/${string}/${string}`;
+export type UserRole = Collections['user']['item']['roles'][number] | 'root' | 'guest';
+export type AuthenticatedToken<TAcceptedRole extends AcceptedRole = null> = {
     authenticated: true;
     sub: ObjectId;
-    roles: readonly TAcceptedRole[];
+    roles: readonly (TAcceptedRole extends null ? string : TAcceptedRole)[];
     allowed_functions?: readonly FunctionPath[];
     userinfo: PackReferences<Collections['user']['item']>;
 };
@@ -22,4 +23,4 @@ export type UnauthenticatedToken = {
     authenticated: false;
     sub: null;
 };
-export type Token<TAcceptedRole = string> = AuthenticatedToken<TAcceptedRole> | UnauthenticatedToken;
+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/condition.d.ts

@@ -1,4 +1,4 @@
-import type { JsonSchema, PropertiesWithId } from './property';
+import type { JsonSchema, PropertiesWithId } from './property.js';
 export type FinalOperator = 'equal' | 'in' | 'gt' | 'lt' | 'gte' | 'lte';
 export type FinalCondition<TSchema extends JsonSchema = any> = {
     operator: FinalOperator;

package/dist/context.d.ts

@@ -1,6 +1,6 @@
 import type { Collection as MongoCollection } from 'mongodb';
-import type { GenericRequest, GenericResponse } from './http';
-import type { Either, Description, PackReferences, SchemaWithId, FunctionPath, Token, ApiConfig, CollectionDocument, CollectionFunctions, RateLimitingParams, RateLimitingErrors } from '.';
+import type { GenericRequest, GenericResponse } from './http.js';
+import type { Either, Description, PackReferences, SchemaWithId, FunctionPath, Token, ApiConfig, CollectionDocument, CollectionFunctions, RateLimitingParams, RateLimitingErrors, AcceptedRole } 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;
@@ -26,7 +26,7 @@ export type ContextOptions = {
     inherited?: boolean;
     calledFunction?: string;
 };
-export type RouteContext<TAcceptedRole = string> = {
+export type RouteContext<TAcceptedRole extends AcceptedRole = null> = {
     collections: IndepthCollections;
     functionPath: FunctionPath;
     token: Token<TAcceptedRole>;
@@ -43,12 +43,14 @@ export type RouteContext<TAcceptedRole = string> = {
     inherited: boolean;
     calledFunction: string;
 };
-export type Context<TDescription extends Description = any, TFunctions = any> = RouteContext & {
+export type CollectionContext<TDescription extends Description = any, TFunctions = any> = {
     description: TDescription;
     collectionName?: (keyof Collections & string) | string;
     collection: TDescription['$id'] extends keyof Collections ? IndepthCollection<{
         description: TDescription;
         functions: TFunctions;
-    }> : TDescription;
+    }> : IndepthCollection<any>;
 };
+export type Context<TDescription extends Description = any, TFunctions = any> = RouteContext & CollectionContext<TDescription, TFunctions>;
+export type StrictContext<TAcceptedRole extends AcceptedRole = null, TDescription extends Description = any, TFunctions = any> = RouteContext<TAcceptedRole> & CollectionContext<TDescription, TFunctions>;
 export {};

package/dist/contract.d.ts

@@ -3,7 +3,7 @@ export type ContractBase = {
     builtin?: boolean;
 };
 export type ContractRoles = {
-    roles?: (UserRole | 'root' | 'guest')[];
+    roles?: UserRole[];
 };
 export type Contract = ContractBase & ({
     response: Property | Property[];

package/dist/description.d.ts

@@ -1,6 +1,7 @@
 import type { IconStyle, PhosphorIcon } from '@phosphor-icons/core';
-import type { JsonSchema, PropertiesWithId } from './property';
-import type { Condition } from './condition';
+import type { JsonSchema, PropertiesWithId } from './property.js';
+import type { Condition } from './condition.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']}`;
 export type CollectionAction<TDescription extends Description> = Readonly<{
@@ -71,33 +72,33 @@ export type SearchOptions<TDescription extends Description> = {
 };
 export type Description<TDescription extends Description = any> = JsonSchema<TDescription> & {
     title?: string;
-    categories?: string[];
+    categories?: readonly string[];
     system?: boolean;
     inline?: boolean;
     preferred?: Record<string, Partial<TDescription | Description>>;
     icon?: Icon;
     options?: CollectionOptions<TDescription>;
-    indexes?: ReadonlyArray<string>;
+    indexes?: readonly (keyof TDescription['properties'])[];
     defaults?: Record<string, any>;
-    owned?: boolean | 'always';
+    owned?: OwnershipMode;
     temporary?: {
         index: keyof TDescription['properties'];
         expireAfterSeconds: number;
     };
     timestamps?: false;
-    immutable?: boolean | ReadonlyArray<string>;
-    route?: ReadonlyArray<string>;
-    presets?: ReadonlyArray<CollectionPresets>;
-    table?: ReadonlyArray<PropertiesWithId<TDescription>>;
-    tableMeta?: ReadonlyArray<PropertiesWithId<TDescription>>;
+    immutable?: boolean | readonly string[];
+    route?: readonly string[];
+    presets?: readonly CollectionPresets[];
+    table?: readonly PropertiesWithId<TDescription>[];
+    tableMeta?: readonly PropertiesWithId<TDescription>[];
     filtersPresets?: Record<string, FiltersPreset<TDescription>>;
     freshItem?: Partial<Record<PropertiesWithId<TDescription>, any>>;
-    form?: ReadonlyArray<PropertiesWithId<TDescription>> | Record<PropertiesWithId<TDescription>, string[]>;
-    writable?: ReadonlyArray<PropertiesWithId<TDescription>>;
-    filters?: ReadonlyArray<PropertiesWithId<TDescription> | {
+    form?: readonly PropertiesWithId<TDescription>[] | Record<PropertiesWithId<TDescription>, string[]>;
+    writable?: readonly PropertiesWithId<TDescription>[];
+    filters?: readonly (PropertiesWithId<TDescription> | {
         property: PropertiesWithId<TDescription>;
         default: string;
-    }>;
+    })[];
     layout?: Layout<TDescription>;
     formLayout?: Partial<FormLayout<TDescription>>;
     tableLayout?: Partial<TableLayout<TDescription>>;

package/dist/security.d.ts

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

package/package.json

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