@aeriajs/types 0.0.83 → 0.0.85
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/collection.d.ts +1 -1
- package/dist/config.d.ts +3 -2
- package/dist/context.d.ts +2 -0
- package/dist/property.d.ts +2 -2
- package/dist/security.d.ts +18 -7
- package/dist/token.d.ts +1 -1
- package/package.json +1 -1
package/dist/collection.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export type Collection<TCollection extends Collection = any> = {
|
|
|
10
10
|
contracts?: Record<string, Contract>;
|
|
11
11
|
exposedFunctions?: Record<string, AccessCondition>;
|
|
12
12
|
security?: CollectionSecurityPolicy<TCollection>;
|
|
13
|
-
middlewares?: CollectionMiddleware | CollectionMiddleware[];
|
|
13
|
+
middlewares?: CollectionMiddleware<any> | CollectionMiddleware<any>[];
|
|
14
14
|
};
|
|
15
15
|
export type CollectionItem<TCollectionName extends keyof Collections> = Omit<Collections[TCollectionName]['item'], '_id'>;
|
|
16
16
|
export type CollectionItemWithId<TCollectionName extends keyof Collections> = Collections[TCollectionName]['item'];
|
package/dist/config.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export type ApiConfig = {
|
|
|
6
6
|
baseUrl?: RouteUri;
|
|
7
7
|
publicUrl?: string;
|
|
8
8
|
port?: number;
|
|
9
|
-
|
|
9
|
+
defaultPaginationLimit?: number;
|
|
10
10
|
database?: {
|
|
11
11
|
mongodbUrl?: string;
|
|
12
12
|
noDatabase?: boolean;
|
|
@@ -28,8 +28,9 @@ export type ApiConfig = {
|
|
|
28
28
|
roles: string[];
|
|
29
29
|
active: boolean;
|
|
30
30
|
}>;
|
|
31
|
+
paginationLimit?: number;
|
|
31
32
|
exposeFunctionsByDefault?: boolean | 'unauthenticated';
|
|
32
33
|
};
|
|
33
34
|
tokenUserProperties?: string[];
|
|
34
|
-
errorHandler?: <TError
|
|
35
|
+
errorHandler?: <TError>(context: RouteContext, error: TError) => unknown | Promise<unknown>;
|
|
35
36
|
};
|
package/dist/context.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Collection as MongoCollection } from 'mongodb';
|
|
2
2
|
import type { AcceptedRole } from './token.js';
|
|
3
|
+
import type { Collection } from './collection.js';
|
|
3
4
|
import type { ApiConfig } from './config.js';
|
|
4
5
|
import type { CollectionDocument, CollectionFunctions } from './functions.js';
|
|
5
6
|
import type { Description } from './description.js';
|
|
@@ -22,6 +23,7 @@ export type IndepthCollection<TCollection> = TCollection extends {
|
|
|
22
23
|
functions: UnionFunctions<CollFunctions, SchemaWithId<InferredDescription>>;
|
|
23
24
|
originalFunctions: CollFunctions;
|
|
24
25
|
model: InferredDescription extends Description ? CollectionModel<InferredDescription> : never;
|
|
26
|
+
middlewares?: Collection['middlewares'];
|
|
25
27
|
} : TCollection;
|
|
26
28
|
export type IndepthCollections = {
|
|
27
29
|
[P in keyof Collections]: IndepthCollection<Collections[P]>;
|
package/dist/property.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { PhosphorIcon } from '@phosphor-icons/core';
|
|
2
2
|
import type { ObjectId } from 'mongodb';
|
|
3
3
|
import type { Condition } from './condition.js';
|
|
4
|
-
import type {
|
|
4
|
+
import type { RouteContext } from './context.js';
|
|
5
5
|
export type PropertyArrayElement = 'checkbox' | 'radio' | 'select';
|
|
6
6
|
export type PropertyInputType = 'text' | 'email' | 'password' | 'search' | 'time' | 'month';
|
|
7
7
|
export type PropertyInputElement = 'input' | 'textarea';
|
|
@@ -97,7 +97,7 @@ export type ArrayOfRefs = Omit<ArrayProperty, 'items'> & {
|
|
|
97
97
|
export type GetterProperty = {
|
|
98
98
|
getter: (document: unknown & {
|
|
99
99
|
_id: ObjectId;
|
|
100
|
-
}, context:
|
|
100
|
+
}, context: RouteContext) => unknown;
|
|
101
101
|
requires?: string[];
|
|
102
102
|
};
|
|
103
103
|
export type ConstProperty = {
|
package/dist/security.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import type { Context } from './context.js';
|
|
2
|
+
import type { What } from './functions.js';
|
|
3
|
+
import type { Result } from './result.js';
|
|
2
4
|
export type OwnershipMode = boolean | 'always' | 'on-write';
|
|
3
5
|
export declare enum RateLimitingError {
|
|
4
6
|
Unauthenticated = "UNAUTHENTICATED",
|
|
@@ -30,16 +32,25 @@ export type CollectionSecurityPolicy<TCollection extends {
|
|
|
30
32
|
}> = {
|
|
31
33
|
functions?: Partial<Record<keyof TCollection['functions'], SecurityPolicy>>;
|
|
32
34
|
};
|
|
33
|
-
export type
|
|
35
|
+
export type CollectionProps<TPayload = any> = {
|
|
34
36
|
propName?: string;
|
|
35
37
|
parentId?: string;
|
|
36
38
|
childId?: string;
|
|
37
39
|
payload: TPayload;
|
|
38
40
|
};
|
|
39
|
-
export type
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
41
|
+
export type CollectionReadPayload = {
|
|
42
|
+
filters: Record<string, any>;
|
|
43
|
+
sort?: Record<string, any>;
|
|
44
|
+
limit?: number;
|
|
45
|
+
offset?: number;
|
|
46
|
+
};
|
|
47
|
+
export type CollectionWritePayload = {
|
|
48
|
+
what: What<Record<string, any>>;
|
|
49
|
+
};
|
|
50
|
+
export type GenericMiddlewareNext<TPayload, TReturn> = (payload: TPayload, context: Context) => TReturn;
|
|
51
|
+
export type MiddlewareNext = <TPayload, TReturn>(payload: TPayload, context: Context) => TReturn;
|
|
52
|
+
export type Middleware<TPayload = any, TReturn = any, TReturnNext extends GenericMiddlewareNext<TPayload, TReturn> = GenericMiddlewareNext<TPayload, TReturn>> = (payload: TPayload, context: Context, next: TReturnNext) => TReturn;
|
|
53
|
+
export type CollectionMiddleware<TDocument> = {
|
|
54
|
+
beforeRead?: Middleware<CollectionReadPayload, Promise<Result.Either<any, TDocument | TDocument[]>>>;
|
|
55
|
+
beforeWrite?: Middleware<CollectionWritePayload, Promise<Result.Either<any, TDocument>>>;
|
|
45
56
|
};
|
package/dist/token.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export type AcceptedRole = UserRole | UserRole[] | null | unknown;
|
|
|
5
5
|
export type AuthenticatedToken<TAcceptedRole extends AcceptedRole = null> = {
|
|
6
6
|
authenticated: true;
|
|
7
7
|
sub: ObjectId;
|
|
8
|
-
roles: readonly (TAcceptedRole extends null ?
|
|
8
|
+
roles: readonly (TAcceptedRole extends null ? UserRole : TAcceptedRole)[];
|
|
9
9
|
userinfo: Omit<Collections['user']['item'], '_id' | 'roles'> extends infer UserItem ? UserItem | PackReferences<UserItem> : never;
|
|
10
10
|
};
|
|
11
11
|
export type UnauthenticatedToken = {
|