@akanjs/document 0.0.40 → 0.0.41
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/index.d.ts +1 -10
- package/index.js +2062 -21
- package/package.json +34 -2
- package/src/dataLoader.d.ts +16 -19
- package/src/database.d.ts +110 -8
- package/src/dbDecorators.d.ts +67 -8
- package/src/index.d.ts +5 -10
- package/src/schema.d.ts +3 -6
- package/src/types.d.ts +1 -3
- package/dbDecorators-B-tzSGvi.d.ts +0 -252
- package/src/dataLoader.js +0 -184
- package/src/database.js +0 -410
- package/src/dbDecorators.js +0 -153
- package/src/index.js +0 -29
- package/src/schema.js +0 -156
- package/src/types.js +0 -15
- package/types-H2HI4YUe.d.ts +0 -3
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@akanjs/document",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.41",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -14,5 +14,37 @@
|
|
|
14
14
|
"engines": {
|
|
15
15
|
"node": ">=22"
|
|
16
16
|
},
|
|
17
|
-
"dependencies": {
|
|
17
|
+
"dependencies": {
|
|
18
|
+
"@nestjs/apollo": "^12.2.2",
|
|
19
|
+
"@nestjs/common": "^10.4.15",
|
|
20
|
+
"@nestjs/graphql": "^12.2.2",
|
|
21
|
+
"@nestjs/mongoose": "^10.1.0",
|
|
22
|
+
"@nestjs/passport": "^10.0.3",
|
|
23
|
+
"@nestjs/platform-socket.io": "^10.4.15",
|
|
24
|
+
"@nestjs/schedule": "^4.1.2",
|
|
25
|
+
"@socket.io/redis-adapter": "^8.3.0",
|
|
26
|
+
"@urql/core": "^5.1.0",
|
|
27
|
+
"apple-signin": "^1.0.9",
|
|
28
|
+
"dataloader": "^2.2.3",
|
|
29
|
+
"dayjs": "^1.11.13",
|
|
30
|
+
"iap": "^1.1.1",
|
|
31
|
+
"immer": "^10.1.1",
|
|
32
|
+
"jsonwebtoken": "^9.0.2",
|
|
33
|
+
"lodash": "^4.17.21",
|
|
34
|
+
"mongoose": "^8.9.3",
|
|
35
|
+
"next": "^15.3.2",
|
|
36
|
+
"passport-apple": "^2.0.2",
|
|
37
|
+
"passport-facebook": "^3.0.0",
|
|
38
|
+
"passport-github": "^1.1.0",
|
|
39
|
+
"passport-google-oauth20": "^2.0.0",
|
|
40
|
+
"passport-kakao": "^1.0.1",
|
|
41
|
+
"passport-naver": "^1.0.6",
|
|
42
|
+
"pluralize": "^8.0.0",
|
|
43
|
+
"redis": "^4.7.0",
|
|
44
|
+
"reflect-metadata": "^0.2.2",
|
|
45
|
+
"rxjs": "^7.8.1",
|
|
46
|
+
"socket.io-client": "^4.8.1",
|
|
47
|
+
"tunnel-ssh": "^5.2.0",
|
|
48
|
+
"ua-parser-js": "^1.0.40"
|
|
49
|
+
}
|
|
18
50
|
}
|
package/src/dataLoader.d.ts
CHANGED
|
@@ -1,29 +1,26 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import DataLoader from
|
|
3
|
-
|
|
4
|
-
import {
|
|
5
|
-
|
|
6
|
-
declare const
|
|
7
|
-
declare const
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
declare const
|
|
11
|
-
declare const
|
|
12
|
-
declare const
|
|
13
|
-
|
|
14
|
-
interface LoaderMeta {
|
|
1
|
+
import type { Type } from "@akanjs/base";
|
|
2
|
+
import DataLoader from "dataloader";
|
|
3
|
+
import type { FilterQuery, Model } from "mongoose";
|
|
4
|
+
import { Schema, Types } from "mongoose";
|
|
5
|
+
export declare const Id: typeof Types.ObjectId;
|
|
6
|
+
export declare const ObjectId: typeof Schema.Types.ObjectId;
|
|
7
|
+
export declare const Mixed: typeof Schema.Types.Mixed;
|
|
8
|
+
export { DataLoader };
|
|
9
|
+
export declare const createLoader: <Key, Value>(model: Model<any>, fieldName?: string, defaultQuery?: FilterQuery<unknown>) => DataLoader<Key, Value, Key>;
|
|
10
|
+
export declare const createArrayLoader: <K, V>(model: Model<unknown, unknown, unknown, unknown>, fieldName?: string, defaultQuery?: FilterQuery<unknown>) => DataLoader<K, V, K>;
|
|
11
|
+
export declare const createArrayElementLoader: <K, V>(model: Model<unknown>, fieldName?: string, defaultQuery?: FilterQuery<unknown>) => DataLoader<K, V, K>;
|
|
12
|
+
export declare const createQueryLoader: <Key, Value>(model: Model<any>, queryKeys: string[], defaultQuery?: FilterQuery<unknown>) => DataLoader<Key, Value, Key>;
|
|
13
|
+
export interface LoaderMeta {
|
|
15
14
|
key: string;
|
|
16
15
|
type: "Field" | "ArrayField" | "Query";
|
|
17
16
|
fieldName?: string;
|
|
18
17
|
queryKeys?: string[];
|
|
19
18
|
defaultQuery: FilterQuery<unknown>;
|
|
20
19
|
}
|
|
21
|
-
declare const getLoaderMetas: (target: Type) => LoaderMeta[];
|
|
22
|
-
type Loader<Field, Value> = DataLoader<Field, Value | null>;
|
|
23
|
-
declare const Loader: {
|
|
20
|
+
export declare const getLoaderMetas: (target: Type) => LoaderMeta[];
|
|
21
|
+
export type Loader<Field, Value> = DataLoader<Field, Value | null>;
|
|
22
|
+
export declare const Loader: {
|
|
24
23
|
ByField: (fieldName: string, defaultQuery?: FilterQuery<unknown>) => (target: object, key: string) => void;
|
|
25
24
|
ByArrayField: (fieldName: string, defaultQuery?: FilterQuery<unknown>) => (target: object, key: string) => void;
|
|
26
25
|
ByQuery: (queryKeys: string[], defaultQuery?: FilterQuery<unknown>) => (target: object, key: string) => void;
|
|
27
26
|
};
|
|
28
|
-
|
|
29
|
-
export { Id, Loader, type LoaderMeta, Mixed, ObjectId, createArrayElementLoader, createArrayLoader, createLoader, createQueryLoader, getLoaderMetas };
|
package/src/database.d.ts
CHANGED
|
@@ -1,8 +1,110 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import
|
|
6
|
-
import
|
|
7
|
-
import
|
|
8
|
-
import
|
|
1
|
+
import { type Dayjs } from "@akanjs/base";
|
|
2
|
+
import { Logger } from "@akanjs/common";
|
|
3
|
+
import { type DocumentModel, type FilterType, type FindQueryOption, type GetActionObject, type ListQueryOption, type QueryOf, type SortOf } from "@akanjs/constant";
|
|
4
|
+
import type DataLoader from "dataloader";
|
|
5
|
+
import type { Filter, MeiliSearch } from "meilisearch";
|
|
6
|
+
import type { HydratedDocument } from "mongoose";
|
|
7
|
+
import type { RedisClientType } from "redis";
|
|
8
|
+
import type { BaseMiddleware, Database, Mdl } from "./dbDecorators";
|
|
9
|
+
import type { DataInputOf } from "./types";
|
|
10
|
+
interface RedisSetOptions {
|
|
11
|
+
expireAt?: Dayjs;
|
|
12
|
+
}
|
|
13
|
+
declare class CacheDatabase<T = any> {
|
|
14
|
+
private readonly refName;
|
|
15
|
+
private readonly redis;
|
|
16
|
+
private logger;
|
|
17
|
+
constructor(refName: string, redis: RedisClientType);
|
|
18
|
+
set(topic: string, key: string, value: string | number | Buffer, option?: RedisSetOptions): Promise<void>;
|
|
19
|
+
get<T extends string | number | Buffer>(topic: string, key: string): Promise<T | undefined>;
|
|
20
|
+
delete(topic: string, key: string): Promise<void>;
|
|
21
|
+
}
|
|
22
|
+
declare class SearchDatabase<T = any> {
|
|
23
|
+
readonly refName: string;
|
|
24
|
+
readonly meili: MeiliSearch;
|
|
25
|
+
private logger;
|
|
26
|
+
private index;
|
|
27
|
+
constructor(refName: string, meili: MeiliSearch);
|
|
28
|
+
searchIds(searchText: string | undefined | null, option?: {
|
|
29
|
+
filter?: Filter;
|
|
30
|
+
skip?: number | null;
|
|
31
|
+
limit?: number | null;
|
|
32
|
+
sort?: string[] | null;
|
|
33
|
+
}): Promise<{
|
|
34
|
+
ids: string[];
|
|
35
|
+
total: number;
|
|
36
|
+
}>;
|
|
37
|
+
count(searchText: string | undefined | null, option?: {
|
|
38
|
+
filter?: Filter;
|
|
39
|
+
skip?: number | null;
|
|
40
|
+
limit?: number | null;
|
|
41
|
+
sort?: string | null;
|
|
42
|
+
}): Promise<number>;
|
|
43
|
+
}
|
|
44
|
+
export type DatabaseModel<T extends string, Input, Doc, Obj, Insight, Filter, Summary = any> = DatabaseModelWithQuerySort<T, Input, Doc, Obj, Insight, GetActionObject<Filter>, SortOf<Filter>, Summary>;
|
|
45
|
+
type DatabaseModelWithQuerySort<T extends string, Input, Doc, Obj, Insight, Query, Sort, Summary = any> = {
|
|
46
|
+
logger: Logger;
|
|
47
|
+
__model: Mdl<Doc, Obj>;
|
|
48
|
+
__cache: CacheDatabase<T>;
|
|
49
|
+
__search: SearchDatabase<T>;
|
|
50
|
+
__loader: DataLoader<string, Doc, string>;
|
|
51
|
+
__list(query?: QueryOf<Doc>, queryOption?: ListQueryOption<Sort, Obj>): Promise<Doc[]>;
|
|
52
|
+
__listIds(query?: QueryOf<Doc>, queryOption?: ListQueryOption<Sort, Obj>): Promise<string[]>;
|
|
53
|
+
__find(query?: QueryOf<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<Doc | null>;
|
|
54
|
+
__findId(query?: QueryOf<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<string | null>;
|
|
55
|
+
__pick(query?: QueryOf<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<Doc>;
|
|
56
|
+
__pickId(query?: QueryOf<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<string>;
|
|
57
|
+
__exists(query?: QueryOf<Doc>): Promise<string | null>;
|
|
58
|
+
__count(query?: QueryOf<Doc>): Promise<number>;
|
|
59
|
+
__insight(query?: QueryOf<Doc>): Promise<Insight>;
|
|
60
|
+
getDefaultSummary(addQuery?: QueryOf<Doc>): Promise<Summary>;
|
|
61
|
+
} & {
|
|
62
|
+
[key in Capitalize<T>]: Mdl<Doc, Obj>;
|
|
63
|
+
} & {
|
|
64
|
+
[key in `${T}Loader`]: DataLoader<string, Doc, string>;
|
|
65
|
+
} & {
|
|
66
|
+
[key in `${T}Cache`]: CacheDatabase<T>;
|
|
67
|
+
} & {
|
|
68
|
+
[key in `${T}Search`]: SearchDatabase<T>;
|
|
69
|
+
} & {
|
|
70
|
+
[K in `get${Capitalize<T>}`]: (id: string) => Promise<Doc>;
|
|
71
|
+
} & {
|
|
72
|
+
[K in `load${Capitalize<T>}`]: (id?: string) => Promise<Doc | null>;
|
|
73
|
+
} & {
|
|
74
|
+
[K in `load${Capitalize<T>}Many`]: (ids: string) => Promise<Doc[]>;
|
|
75
|
+
} & {
|
|
76
|
+
[K in `create${Capitalize<T>}`]: (data: DataInputOf<Input, DocumentModel<Obj>>) => Promise<Doc>;
|
|
77
|
+
} & {
|
|
78
|
+
[K in `update${Capitalize<T>}`]: (id: string, data: DataInputOf<Input, DocumentModel<Obj>>) => Promise<Doc>;
|
|
79
|
+
} & {
|
|
80
|
+
[K in `remove${Capitalize<T>}`]: (id: string) => Promise<Doc>;
|
|
81
|
+
} & {
|
|
82
|
+
[K in `search${Capitalize<T>}`]: (searchText: string, queryOption?: ListQueryOption<Sort, Obj>) => Promise<{
|
|
83
|
+
docs: Doc[];
|
|
84
|
+
count: number;
|
|
85
|
+
}>;
|
|
86
|
+
} & {
|
|
87
|
+
[K in `searchDocs${Capitalize<T>}`]: (searchText: string, queryOption?: ListQueryOption<Sort, Obj>) => Promise<Doc[]>;
|
|
88
|
+
} & {
|
|
89
|
+
[K in `searchCount${Capitalize<T>}`]: (searchText: string) => Promise<number>;
|
|
90
|
+
} & {
|
|
91
|
+
[K in keyof Query as K extends string ? `list${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: ListQueryOption<Sort, Obj>]) => Promise<Doc[]> : never;
|
|
92
|
+
} & {
|
|
93
|
+
[K in keyof Query as K extends string ? `listIds${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: ListQueryOption<Sort, Obj>]) => Promise<string[]> : never;
|
|
94
|
+
} & {
|
|
95
|
+
[K in keyof Query as K extends string ? `find${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<Doc | null> : never;
|
|
96
|
+
} & {
|
|
97
|
+
[K in keyof Query as K extends string ? `findId${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<string | null> : never;
|
|
98
|
+
} & {
|
|
99
|
+
[K in keyof Query as K extends string ? `pick${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<Doc> : never;
|
|
100
|
+
} & {
|
|
101
|
+
[K in keyof Query as K extends string ? `pickId${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<string> : never;
|
|
102
|
+
} & {
|
|
103
|
+
[K in keyof Query as K extends string ? `exists${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args]) => Promise<string | null> : never;
|
|
104
|
+
} & {
|
|
105
|
+
[K in keyof Query as K extends string ? `count${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args]) => Promise<number> : never;
|
|
106
|
+
} & {
|
|
107
|
+
[K in keyof Query as K extends string ? `insight${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args]) => Promise<Insight> : never;
|
|
108
|
+
};
|
|
109
|
+
export declare const databaseModelOf: <T extends string, Input, Doc extends HydratedDocument<any>, Model extends Mdl<any, any>, Middleware extends BaseMiddleware, Insight, Obj, Filter extends FilterType, Summary>(database: Database<T, Input, Doc, Model, Middleware, Insight, Obj, Filter, Summary>, model: Mdl<any, any>, redis: RedisClientType, meili: MeiliSearch) => DatabaseModel<T, Input, Doc, Model, Insight, Filter, Summary>;
|
|
110
|
+
export {};
|
package/src/dbDecorators.d.ts
CHANGED
|
@@ -1,8 +1,67 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
import
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import { BaseObject, Type } from "@akanjs/base";
|
|
2
|
+
import { type ConstantModel, type DocumentModel, type FilterType } from "@akanjs/constant";
|
|
3
|
+
import type { FilterQuery, HydratedDocument, Model as MongooseModel, PipelineStage, ProjectionType, Schema } from "mongoose";
|
|
4
|
+
import type { DatabaseModel } from "./database";
|
|
5
|
+
export type { FilterQuery as QueryOf };
|
|
6
|
+
interface DefaultDocMtds<TDocument> {
|
|
7
|
+
refresh(): Promise<this>;
|
|
8
|
+
set(data: Partial<TDocument>): this;
|
|
9
|
+
save(): Promise<this>;
|
|
10
|
+
}
|
|
11
|
+
type HydratedDocumentWithId<TDocument> = Omit<HydratedDocument<TDocument, DefaultDocMtds<TDocument>>, "id" | "set" | "save"> & {
|
|
12
|
+
id: string;
|
|
13
|
+
} & DefaultDocMtds<TDocument>;
|
|
14
|
+
export type Doc<M> = HydratedDocumentWithId<DocumentModel<M>>;
|
|
15
|
+
interface DefaultMdlStats<TDocument, TSchema> {
|
|
16
|
+
pickOneAndWrite: (query: FilterQuery<TSchema>, rawData: Partial<TSchema>) => Promise<TDocument>;
|
|
17
|
+
pickAndWrite: (docId: string, rawData: Partial<TSchema>) => Promise<TDocument>;
|
|
18
|
+
pickOne: (query: FilterQuery<TSchema>, projection?: ProjectionType<TSchema>) => Promise<TDocument>;
|
|
19
|
+
pickById: (docId: string | undefined, projection?: ProjectionType<TSchema>) => Promise<TDocument>;
|
|
20
|
+
addSummary: (prefix?: string | string[], num?: number) => Promise<void>;
|
|
21
|
+
moveSummary: (prev: string, next: string, num?: number) => Promise<void>;
|
|
22
|
+
subSummary: (prefix?: string | string[], num?: number) => Promise<void>;
|
|
23
|
+
sample: (query: FilterQuery<TSchema>, size?: number, aggregations?: PipelineStage[]) => Promise<TDocument[]>;
|
|
24
|
+
sampleOne: (query: FilterQuery<TSchema>, aggregations?: PipelineStage[]) => Promise<TDocument | null>;
|
|
25
|
+
}
|
|
26
|
+
export type Mdl<Doc extends HydratedDocument<any>, Raw> = MongooseModel<Raw, unknown, unknown, unknown, Doc> & DefaultMdlStats<Doc, DocumentModel<Raw>>;
|
|
27
|
+
export type SchemaOf<Mdl, Doc> = Schema<null, Mdl, Doc, undefined, null, Mdl>;
|
|
28
|
+
export interface BaseMiddleware {
|
|
29
|
+
onSchema: (schema: SchemaOf<any, any>) => void;
|
|
30
|
+
}
|
|
31
|
+
export interface Database<T extends string, Input, Doc extends HydratedDocument<any>, Model, Middleware extends BaseMiddleware, Obj, Insight, Filter extends FilterType, Summary> {
|
|
32
|
+
refName: T;
|
|
33
|
+
Input: Type<Input>;
|
|
34
|
+
Doc: Type<Doc>;
|
|
35
|
+
Model: Type<Model>;
|
|
36
|
+
Middleware: Type<Middleware>;
|
|
37
|
+
Obj: Type<Obj>;
|
|
38
|
+
Insight: Type<Insight>;
|
|
39
|
+
Filter: Type<Filter>;
|
|
40
|
+
Summary?: Type<Summary>;
|
|
41
|
+
}
|
|
42
|
+
export declare const dbOf: <T extends string, Input, Doc extends HydratedDocument<any>, Model extends DatabaseModel<T, Input, any, Obj, Insight, Filter>, Middleware extends BaseMiddleware, Obj, Insight, Filter extends FilterType, Summary>(refName: T, Input: Type<Input>, Doc: Type<Doc>, Model: Type<Model>, Middleware: Type<Middleware>, Obj: Type<Obj>, Insight: Type<Insight>, Filter: Type<Filter>, Summary?: Type<Summary>) => Database<T, Input, Doc, Model, Middleware, Obj, Insight, Filter, Summary>;
|
|
43
|
+
export declare class InputDatabaseStorage {
|
|
44
|
+
}
|
|
45
|
+
export declare class DocumentDatabaseStorage {
|
|
46
|
+
}
|
|
47
|
+
export declare class ModelDatabaseStorage {
|
|
48
|
+
}
|
|
49
|
+
export declare class MiddlewareDatabaseStorage {
|
|
50
|
+
}
|
|
51
|
+
export declare const getAllDatabaseModelNames: () => string[];
|
|
52
|
+
export declare const Database: {
|
|
53
|
+
Input: (returns: () => Type) => (target: any) => void;
|
|
54
|
+
Document: (returns: () => Type) => (target: any) => void;
|
|
55
|
+
Model: (returns: () => Type) => (target: any) => void;
|
|
56
|
+
Middleware: (returns: () => Type) => (target: any) => void;
|
|
57
|
+
};
|
|
58
|
+
export declare const into: <Doc, T extends string, Input, Full, Light, Insight, Summary, Filter extends FilterType>(docRef: Type<Doc>, cnst: ConstantModel<T, Input, Full, Light, Insight, Filter, Summary>) => Type<DatabaseModel<T, DocumentModel<Input>, Doc, Full, Insight, Filter, Summary>>;
|
|
59
|
+
export declare const inside: <Doc, T extends string, Input, Full, Light, Insight, Filter extends FilterType, Summary>(modelRef: Type, cnst: ConstantModel<T, Input, Full, Light, Insight, Filter, Summary>) => Type<DatabaseModel<T, DocumentModel<Input>, Doc, Full, Insight, Filter, Summary>>;
|
|
60
|
+
export declare const by: <Model, AddModel>(modelRef: Type<Model>, addRef?: Type<AddModel>) => AddModel extends {
|
|
61
|
+
[key: string]: any;
|
|
62
|
+
} ? Type<Model & (AddModel extends BaseObject ? Doc<AddModel> : DocumentModel<AddModel>)> : Type<Model extends BaseObject ? Doc<Model> : DocumentModel<Model>>;
|
|
63
|
+
export declare const beyond: <DbModel, Doc>(model: Type<DbModel>, doc: Type<Doc>) => {
|
|
64
|
+
new (): {
|
|
65
|
+
onSchema(schema: SchemaOf<DbModel, Doc>): void;
|
|
66
|
+
};
|
|
67
|
+
};
|
package/src/index.d.ts
CHANGED
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
export
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
5
|
-
export
|
|
6
|
-
export { default as DataLoader } from 'dataloader';
|
|
7
|
-
import 'dayjs';
|
|
8
|
-
import '../types-H2HI4YUe.js';
|
|
9
|
-
import 'meilisearch';
|
|
10
|
-
import 'redis';
|
|
1
|
+
export * from "./dbDecorators";
|
|
2
|
+
export * from "./schema";
|
|
3
|
+
export * from "./types";
|
|
4
|
+
export * from "./database";
|
|
5
|
+
export * from "./dataLoader";
|
package/src/schema.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { FilterQuery,
|
|
2
|
-
|
|
3
|
-
declare const getDefaultSchemaOptions: <TSchema, TDocument>() => {
|
|
1
|
+
import { FilterQuery, PipelineStage, type ProjectionType } from "mongoose";
|
|
2
|
+
export declare const getDefaultSchemaOptions: <TSchema, TDocument>() => {
|
|
4
3
|
toJSON: {
|
|
5
4
|
getters: boolean;
|
|
6
5
|
virtuals: boolean;
|
|
@@ -25,8 +24,6 @@ declare const getDefaultSchemaOptions: <TSchema, TDocument>() => {
|
|
|
25
24
|
subSummary: (prefix?: string, num?: number) => Promise<void>;
|
|
26
25
|
};
|
|
27
26
|
};
|
|
28
|
-
declare const convertAggregateMatch: (query: any) => {
|
|
27
|
+
export declare const convertAggregateMatch: (query: any) => {
|
|
29
28
|
[k: string]: any;
|
|
30
29
|
};
|
|
31
|
-
|
|
32
|
-
export { convertAggregateMatch, getDefaultSchemaOptions };
|
package/src/types.d.ts
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
type DataInputOf<Input, Obj> = {
|
|
1
|
+
export type DataInputOf<Input, Obj> = {
|
|
2
2
|
[K in keyof Input as Input[K] extends any[] ? never : K]: Input[K];
|
|
3
3
|
} & {
|
|
4
4
|
[K in keyof Input as Input[K] extends any[] ? K : never]?: Input[K];
|
|
5
5
|
} & Partial<Obj>;
|
|
6
|
-
|
|
7
|
-
export type { DataInputOf };
|
|
@@ -1,252 +0,0 @@
|
|
|
1
|
-
import { Dayjs } from 'dayjs';
|
|
2
|
-
import { T as Type } from './types-H2HI4YUe.js';
|
|
3
|
-
import { ProjectionType, FilterQuery, HydratedDocument, Model, PipelineStage, Schema } from 'mongoose';
|
|
4
|
-
import DataLoader from 'dataloader';
|
|
5
|
-
import { MeiliSearch, Filter as Filter$1 } from 'meilisearch';
|
|
6
|
-
import { RedisClientType } from 'redis';
|
|
7
|
-
import { DataInputOf } from './src/types.js';
|
|
8
|
-
|
|
9
|
-
declare class BaseObject {
|
|
10
|
-
id: string;
|
|
11
|
-
createdAt: Dayjs;
|
|
12
|
-
updatedAt: Dayjs;
|
|
13
|
-
removedAt: Dayjs | null;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
17
|
-
type OptionalKeys<T> = T extends {
|
|
18
|
-
[key: string]: any;
|
|
19
|
-
} ? {
|
|
20
|
-
[K in keyof T]-?: null extends T[K] ? K : never;
|
|
21
|
-
}[keyof T] : never;
|
|
22
|
-
type ObjectToId<O, D = Dayjs> = O extends BaseObject ? string : O extends BaseObject[] ? string[] : O extends Dayjs ? D : O extends {
|
|
23
|
-
[key: string]: any;
|
|
24
|
-
} ? DocumentModel<O> : O;
|
|
25
|
-
type SortOf<Filter> = keyof GetStateObject<Filter>;
|
|
26
|
-
type FilterType = Record<string, any>;
|
|
27
|
-
interface ListQueryOption<Sort, Obj> {
|
|
28
|
-
skip?: number | null;
|
|
29
|
-
limit?: number | null;
|
|
30
|
-
sort?: Sort | null;
|
|
31
|
-
sample?: number;
|
|
32
|
-
select?: ProjectionType<Obj>;
|
|
33
|
-
}
|
|
34
|
-
interface FindQueryOption<Sort, Obj> {
|
|
35
|
-
skip?: number | null;
|
|
36
|
-
sort?: Sort | null;
|
|
37
|
-
sample?: boolean;
|
|
38
|
-
select?: ProjectionType<Obj>;
|
|
39
|
-
}
|
|
40
|
-
type DocumentModel<T, D = Dayjs> = T extends (infer S)[] ? DocumentModel<S>[] : T extends string ? T : T extends number ? T : T extends boolean ? T : T extends Dayjs ? T : T extends Map<infer K, infer V> ? Map<K, DocumentModel<V, D>> : Optional<{
|
|
41
|
-
[K in keyof GetStateObject<T>]: T[K] extends infer S ? S extends null ? undefined : ObjectToId<T[K], D> : never;
|
|
42
|
-
}, OptionalKeys<GetStateObject<T>>>;
|
|
43
|
-
type GetStateObject<T> = Omit<{
|
|
44
|
-
[K in keyof T as T[K] extends (...args: any) => any ? never : K]: T[K];
|
|
45
|
-
}, "prototype">;
|
|
46
|
-
type GetActionObject<T> = Omit<{
|
|
47
|
-
[K in keyof T as T[K] extends (...args: any) => any ? K : never]: T[K];
|
|
48
|
-
}, "prototype">;
|
|
49
|
-
|
|
50
|
-
interface ConstantModel<T extends string, Input, Full, Light, Insight, Filter extends FilterType, Summary = any> {
|
|
51
|
-
refName: T;
|
|
52
|
-
Input: Type<Input>;
|
|
53
|
-
Full: Type<Full>;
|
|
54
|
-
Light: Type<Light>;
|
|
55
|
-
Insight: Type<Insight>;
|
|
56
|
-
Filter: Type<Filter>;
|
|
57
|
-
Summary?: Type<Summary>;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
declare const logLevels: readonly ["trace", "verbose", "debug", "log", "info", "warn", "error"];
|
|
61
|
-
type LogLevel = (typeof logLevels)[number];
|
|
62
|
-
declare class Logger {
|
|
63
|
-
#private;
|
|
64
|
-
static level: LogLevel;
|
|
65
|
-
static setLevel(level: LogLevel): void;
|
|
66
|
-
name?: string;
|
|
67
|
-
constructor(name?: string);
|
|
68
|
-
trace(msg: string, context?: string): void;
|
|
69
|
-
verbose(msg: string, context?: string): void;
|
|
70
|
-
debug(msg: string, context?: string): void;
|
|
71
|
-
log(msg: string, context?: string): void;
|
|
72
|
-
info(msg: string, context?: string): void;
|
|
73
|
-
warn(msg: string, context?: string): void;
|
|
74
|
-
error(msg: string, context?: string): void;
|
|
75
|
-
raw(msg: string, method?: "console" | "process"): void;
|
|
76
|
-
rawLog(msg: string, method?: "console" | "process"): void;
|
|
77
|
-
static trace(msg: string, context?: string): void;
|
|
78
|
-
static verbose(msg: string, context?: string): void;
|
|
79
|
-
static debug(msg: string, context?: string): void;
|
|
80
|
-
static log(msg: string, context?: string): void;
|
|
81
|
-
static info(msg: string, context?: string): void;
|
|
82
|
-
static warn(msg: string, context?: string): void;
|
|
83
|
-
static error(msg: string, context?: string): void;
|
|
84
|
-
static rawLog(msg: string, method?: "console" | "process"): void;
|
|
85
|
-
static raw(msg: string, method?: "console" | "process"): void;
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
interface RedisSetOptions {
|
|
89
|
-
expireAt?: Dayjs;
|
|
90
|
-
}
|
|
91
|
-
declare class CacheDatabase<T = any> {
|
|
92
|
-
private readonly refName;
|
|
93
|
-
private readonly redis;
|
|
94
|
-
private logger;
|
|
95
|
-
constructor(refName: string, redis: RedisClientType);
|
|
96
|
-
set(topic: string, key: string, value: string | number | Buffer, option?: RedisSetOptions): Promise<void>;
|
|
97
|
-
get<T extends string | number | Buffer>(topic: string, key: string): Promise<T | undefined>;
|
|
98
|
-
delete(topic: string, key: string): Promise<void>;
|
|
99
|
-
}
|
|
100
|
-
declare class SearchDatabase<T = any> {
|
|
101
|
-
readonly refName: string;
|
|
102
|
-
readonly meili: MeiliSearch;
|
|
103
|
-
private logger;
|
|
104
|
-
private index;
|
|
105
|
-
constructor(refName: string, meili: MeiliSearch);
|
|
106
|
-
searchIds(searchText: string | undefined | null, option?: {
|
|
107
|
-
filter?: Filter$1;
|
|
108
|
-
skip?: number | null;
|
|
109
|
-
limit?: number | null;
|
|
110
|
-
sort?: string[] | null;
|
|
111
|
-
}): Promise<{
|
|
112
|
-
ids: string[];
|
|
113
|
-
total: number;
|
|
114
|
-
}>;
|
|
115
|
-
count(searchText: string | undefined | null, option?: {
|
|
116
|
-
filter?: Filter$1;
|
|
117
|
-
skip?: number | null;
|
|
118
|
-
limit?: number | null;
|
|
119
|
-
sort?: string | null;
|
|
120
|
-
}): Promise<number>;
|
|
121
|
-
}
|
|
122
|
-
type DatabaseModel<T extends string, Input, Doc, Obj, Insight, Filter, Summary = any> = DatabaseModelWithQuerySort<T, Input, Doc, Obj, Insight, GetActionObject<Filter>, SortOf<Filter>, Summary>;
|
|
123
|
-
type DatabaseModelWithQuerySort<T extends string, Input, Doc, Obj, Insight, Query, Sort, Summary = any> = {
|
|
124
|
-
logger: Logger;
|
|
125
|
-
__model: Mdl<Doc, Obj>;
|
|
126
|
-
__cache: CacheDatabase<T>;
|
|
127
|
-
__search: SearchDatabase<T>;
|
|
128
|
-
__loader: DataLoader<string, Doc, string>;
|
|
129
|
-
__list(query?: FilterQuery<Doc>, queryOption?: ListQueryOption<Sort, Obj>): Promise<Doc[]>;
|
|
130
|
-
__listIds(query?: FilterQuery<Doc>, queryOption?: ListQueryOption<Sort, Obj>): Promise<string[]>;
|
|
131
|
-
__find(query?: FilterQuery<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<Doc | null>;
|
|
132
|
-
__findId(query?: FilterQuery<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<string | null>;
|
|
133
|
-
__pick(query?: FilterQuery<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<Doc>;
|
|
134
|
-
__pickId(query?: FilterQuery<Doc>, queryOption?: FindQueryOption<Sort, Obj>): Promise<string>;
|
|
135
|
-
__exists(query?: FilterQuery<Doc>): Promise<string | null>;
|
|
136
|
-
__count(query?: FilterQuery<Doc>): Promise<number>;
|
|
137
|
-
__insight(query?: FilterQuery<Doc>): Promise<Insight>;
|
|
138
|
-
getDefaultSummary(addQuery?: FilterQuery<Doc>): Promise<Summary>;
|
|
139
|
-
} & {
|
|
140
|
-
[key in Capitalize<T>]: Mdl<Doc, Obj>;
|
|
141
|
-
} & {
|
|
142
|
-
[key in `${T}Loader`]: DataLoader<string, Doc, string>;
|
|
143
|
-
} & {
|
|
144
|
-
[key in `${T}Cache`]: CacheDatabase<T>;
|
|
145
|
-
} & {
|
|
146
|
-
[key in `${T}Search`]: SearchDatabase<T>;
|
|
147
|
-
} & {
|
|
148
|
-
[K in `get${Capitalize<T>}`]: (id: string) => Promise<Doc>;
|
|
149
|
-
} & {
|
|
150
|
-
[K in `load${Capitalize<T>}`]: (id?: string) => Promise<Doc | null>;
|
|
151
|
-
} & {
|
|
152
|
-
[K in `load${Capitalize<T>}Many`]: (ids: string) => Promise<Doc[]>;
|
|
153
|
-
} & {
|
|
154
|
-
[K in `create${Capitalize<T>}`]: (data: DataInputOf<Input, DocumentModel<Obj>>) => Promise<Doc>;
|
|
155
|
-
} & {
|
|
156
|
-
[K in `update${Capitalize<T>}`]: (id: string, data: DataInputOf<Input, DocumentModel<Obj>>) => Promise<Doc>;
|
|
157
|
-
} & {
|
|
158
|
-
[K in `remove${Capitalize<T>}`]: (id: string) => Promise<Doc>;
|
|
159
|
-
} & {
|
|
160
|
-
[K in `search${Capitalize<T>}`]: (searchText: string, queryOption?: ListQueryOption<Sort, Obj>) => Promise<{
|
|
161
|
-
docs: Doc[];
|
|
162
|
-
count: number;
|
|
163
|
-
}>;
|
|
164
|
-
} & {
|
|
165
|
-
[K in `searchDocs${Capitalize<T>}`]: (searchText: string, queryOption?: ListQueryOption<Sort, Obj>) => Promise<Doc[]>;
|
|
166
|
-
} & {
|
|
167
|
-
[K in `searchCount${Capitalize<T>}`]: (searchText: string) => Promise<number>;
|
|
168
|
-
} & {
|
|
169
|
-
[K in keyof Query as K extends string ? `list${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: ListQueryOption<Sort, Obj>]) => Promise<Doc[]> : never;
|
|
170
|
-
} & {
|
|
171
|
-
[K in keyof Query as K extends string ? `listIds${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: ListQueryOption<Sort, Obj>]) => Promise<string[]> : never;
|
|
172
|
-
} & {
|
|
173
|
-
[K in keyof Query as K extends string ? `find${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<Doc | null> : never;
|
|
174
|
-
} & {
|
|
175
|
-
[K in keyof Query as K extends string ? `findId${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<string | null> : never;
|
|
176
|
-
} & {
|
|
177
|
-
[K in keyof Query as K extends string ? `pick${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<Doc> : never;
|
|
178
|
-
} & {
|
|
179
|
-
[K in keyof Query as K extends string ? `pickId${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args, queryOption?: FindQueryOption<Sort, Obj>]) => Promise<string> : never;
|
|
180
|
-
} & {
|
|
181
|
-
[K in keyof Query as K extends string ? `exists${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args]) => Promise<string | null> : never;
|
|
182
|
-
} & {
|
|
183
|
-
[K in keyof Query as K extends string ? `count${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args]) => Promise<number> : never;
|
|
184
|
-
} & {
|
|
185
|
-
[K in keyof Query as K extends string ? `insight${Capitalize<K>}` : never]: Query[K] extends (...args: infer Args) => any ? (...args: [...Args]) => Promise<Insight> : never;
|
|
186
|
-
};
|
|
187
|
-
declare const databaseModelOf: <T extends string, Input, Doc extends HydratedDocument<any>, Model extends Mdl<any, any>, Middleware extends BaseMiddleware, Insight, Obj, Filter extends FilterType, Summary>(database: Database<T, Input, Doc, Model, Middleware, Insight, Obj, Filter, Summary>, model: Mdl<any, any>, redis: RedisClientType, meili: MeiliSearch) => DatabaseModel<T, Input, Doc, Model, Insight, Filter, Summary>;
|
|
188
|
-
|
|
189
|
-
interface DefaultDocMtds<TDocument> {
|
|
190
|
-
refresh(): Promise<this>;
|
|
191
|
-
set(data: Partial<TDocument>): this;
|
|
192
|
-
save(): Promise<this>;
|
|
193
|
-
}
|
|
194
|
-
type HydratedDocumentWithId<TDocument> = Omit<HydratedDocument<TDocument, DefaultDocMtds<TDocument>>, "id" | "set" | "save"> & {
|
|
195
|
-
id: string;
|
|
196
|
-
} & DefaultDocMtds<TDocument>;
|
|
197
|
-
type Doc<M> = HydratedDocumentWithId<DocumentModel<M>>;
|
|
198
|
-
interface DefaultMdlStats<TDocument, TSchema> {
|
|
199
|
-
pickOneAndWrite: (query: FilterQuery<TSchema>, rawData: Partial<TSchema>) => Promise<TDocument>;
|
|
200
|
-
pickAndWrite: (docId: string, rawData: Partial<TSchema>) => Promise<TDocument>;
|
|
201
|
-
pickOne: (query: FilterQuery<TSchema>, projection?: ProjectionType<TSchema>) => Promise<TDocument>;
|
|
202
|
-
pickById: (docId: string | undefined, projection?: ProjectionType<TSchema>) => Promise<TDocument>;
|
|
203
|
-
addSummary: (prefix?: string | string[], num?: number) => Promise<void>;
|
|
204
|
-
moveSummary: (prev: string, next: string, num?: number) => Promise<void>;
|
|
205
|
-
subSummary: (prefix?: string | string[], num?: number) => Promise<void>;
|
|
206
|
-
sample: (query: FilterQuery<TSchema>, size?: number, aggregations?: PipelineStage[]) => Promise<TDocument[]>;
|
|
207
|
-
sampleOne: (query: FilterQuery<TSchema>, aggregations?: PipelineStage[]) => Promise<TDocument | null>;
|
|
208
|
-
}
|
|
209
|
-
type Mdl<Doc extends HydratedDocument<any>, Raw> = Model<Raw, unknown, unknown, unknown, Doc> & DefaultMdlStats<Doc, DocumentModel<Raw>>;
|
|
210
|
-
type SchemaOf<Mdl, Doc> = Schema<null, Mdl, Doc, undefined, null, Mdl>;
|
|
211
|
-
interface BaseMiddleware {
|
|
212
|
-
onSchema: (schema: SchemaOf<any, any>) => void;
|
|
213
|
-
}
|
|
214
|
-
declare const dbOf: <T extends string, Input, Doc extends HydratedDocument<any>, Model extends DatabaseModel<T, Input, any, Obj, Insight, Filter>, Middleware extends BaseMiddleware, Obj, Insight, Filter extends FilterType, Summary>(refName: T, Input: Type<Input>, Doc: Type<Doc>, Model: Type<Model>, Middleware: Type<Middleware>, Obj: Type<Obj>, Insight: Type<Insight>, Filter: Type<Filter>, Summary?: Type<Summary>) => Database<T, Input, Doc, Model, Middleware, Obj, Insight, Filter, Summary>;
|
|
215
|
-
declare class InputDatabaseStorage {
|
|
216
|
-
}
|
|
217
|
-
declare class DocumentDatabaseStorage {
|
|
218
|
-
}
|
|
219
|
-
declare class ModelDatabaseStorage {
|
|
220
|
-
}
|
|
221
|
-
declare class MiddlewareDatabaseStorage {
|
|
222
|
-
}
|
|
223
|
-
declare const getAllDatabaseModelNames: () => string[];
|
|
224
|
-
interface Database<T extends string, Input, Doc extends HydratedDocument<any>, Model, Middleware extends BaseMiddleware, Obj, Insight, Filter extends FilterType, Summary> {
|
|
225
|
-
refName: T;
|
|
226
|
-
Input: Type<Input>;
|
|
227
|
-
Doc: Type<Doc>;
|
|
228
|
-
Model: Type<Model>;
|
|
229
|
-
Middleware: Type<Middleware>;
|
|
230
|
-
Obj: Type<Obj>;
|
|
231
|
-
Insight: Type<Insight>;
|
|
232
|
-
Filter: Type<Filter>;
|
|
233
|
-
Summary?: Type<Summary>;
|
|
234
|
-
}
|
|
235
|
-
declare const Database: {
|
|
236
|
-
Input: (returns: () => Type) => (target: any) => void;
|
|
237
|
-
Document: (returns: () => Type) => (target: any) => void;
|
|
238
|
-
Model: (returns: () => Type) => (target: any) => void;
|
|
239
|
-
Middleware: (returns: () => Type) => (target: any) => void;
|
|
240
|
-
};
|
|
241
|
-
declare const into: <Doc, T extends string, Input, Full, Light, Insight, Summary, Filter extends FilterType>(docRef: Type<Doc>, cnst: ConstantModel<T, Input, Full, Light, Insight, Filter, Summary>) => Type<DatabaseModel<T, DocumentModel<Input>, Doc, Full, Insight, Filter, Summary>>;
|
|
242
|
-
declare const inside: <Doc, T extends string, Input, Full, Light, Insight, Filter extends FilterType, Summary>(modelRef: Type, cnst: ConstantModel<T, Input, Full, Light, Insight, Filter, Summary>) => Type<DatabaseModel<T, DocumentModel<Input>, Doc, Full, Insight, Filter, Summary>>;
|
|
243
|
-
declare const by: <Model, AddModel>(modelRef: Type<Model>, addRef?: Type<AddModel>) => AddModel extends {
|
|
244
|
-
[key: string]: any;
|
|
245
|
-
} ? Type<Model & (AddModel extends BaseObject ? Doc<AddModel> : DocumentModel<AddModel>)> : Type<Model extends BaseObject ? Doc<Model> : DocumentModel<Model>>;
|
|
246
|
-
declare const beyond: <DbModel, Doc>(model: Type<DbModel>, doc: Type<Doc>) => {
|
|
247
|
-
new (): {
|
|
248
|
-
onSchema(schema: SchemaOf<DbModel, Doc>): void;
|
|
249
|
-
};
|
|
250
|
-
};
|
|
251
|
-
|
|
252
|
-
export { type BaseMiddleware as B, type Doc as D, InputDatabaseStorage as I, type Mdl as M, type SchemaOf as S, Database as a, DocumentDatabaseStorage as b, ModelDatabaseStorage as c, dbOf as d, MiddlewareDatabaseStorage as e, inside as f, getAllDatabaseModelNames as g, by as h, into as i, beyond as j, type DatabaseModel as k, databaseModelOf as l };
|