@ones-open/node-sdk 0.0.2 → 0.0.4-10001.152
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/index.cjs +74 -2996
- package/dist/index.js +71 -2993
- package/dist/types/packages/node/storage/entity/entity/types.d.ts +20 -20
- package/dist/types/packages/node/storage/entity/error/consts.d.ts +29 -29
- package/dist/types/packages/node/storage/entity/fetch/index.d.ts.map +1 -1
- package/dist/types/packages/node/storage/entity/index.d.ts +1 -1
- package/dist/types/packages/node/storage/entity/query/types.d.ts +52 -52
- package/dist/types/packages/node/storage/entity/result/types.d.ts +12 -12
- package/dist/types/packages/node/storage/entity/sort/consts.d.ts +3 -3
- package/dist/types/packages/node/storage/entity/types.d.ts +29 -29
- package/dist/types/packages/node/storage/entity/where/index.d.ts +1 -1
- package/dist/types/packages/node/storage/object/error/consts.d.ts +4 -4
- package/dist/types/packages/node/storage/object/error/index.d.ts +4 -4
- package/dist/types/packages/node/storage/object/fetch/index.d.ts.map +1 -1
- package/dist/types/packages/node/storage/object/index.d.ts +1 -1
- package/dist/types/packages/node/storage/object/result/types.d.ts +3 -3
- package/dist/types/packages/node/storage/object/types.d.ts +17 -17
- package/dist/types/packages/strict/env/index.d.ts +12 -28
- package/dist/types/packages/strict/env/index.d.ts.map +1 -1
- package/dist/types/packages/strict/result/types.d.ts +6 -6
- package/package.json +3 -3
|
@@ -7,55 +7,55 @@ export type BaseIndexesStructValue = null | StringOrNumberOrBoolean[] | [StringO
|
|
|
7
7
|
export type BaseIndexesStruct<IndexesStruct> = SetFieldType<IndexesStruct, keyof IndexesStruct, BaseIndexesStructValue>;
|
|
8
8
|
export type UnionIndexesStruct<IndexesStruct> = BaseIndexesStruct<IndexesStruct> | EmptyObject | null;
|
|
9
9
|
/**
|
|
10
|
-
* @description
|
|
11
|
-
* @typedef EntityStruct
|
|
12
|
-
* @typedef IndexesStruct
|
|
10
|
+
* @description Entity operation object
|
|
11
|
+
* @typedef EntityStruct Entity data structure
|
|
12
|
+
* @typedef IndexesStruct Entity index structure
|
|
13
13
|
*/
|
|
14
14
|
export interface Entity<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends UnionIndexesStruct<IndexesStruct>> {
|
|
15
15
|
/**
|
|
16
|
-
* @description
|
|
17
|
-
* @param key
|
|
18
|
-
* @returns
|
|
16
|
+
* @description Get one entity record
|
|
17
|
+
* @param key Entity data key
|
|
18
|
+
* @returns Entity data value
|
|
19
19
|
*/
|
|
20
20
|
get<Key extends string>(key: NotEmptyString<Key>): Promise<EntityStruct | undefined>;
|
|
21
21
|
/**
|
|
22
|
-
* @description
|
|
23
|
-
* @param key
|
|
24
|
-
* @param value
|
|
22
|
+
* @description Create or update one entity record
|
|
23
|
+
* @param key Entity data key
|
|
24
|
+
* @param value Entity data value
|
|
25
25
|
*/
|
|
26
26
|
set<Key extends string>(key: NotEmptyString<Key>, value: Partial<EntityStruct>): Promise<void>;
|
|
27
27
|
/**
|
|
28
|
-
* @description
|
|
29
|
-
* @param key
|
|
28
|
+
* @description Delete one entity record
|
|
29
|
+
* @param key Entity data key
|
|
30
30
|
*/
|
|
31
31
|
delete<Key extends string>(key: NotEmptyString<Key>): Promise<void>;
|
|
32
32
|
/**
|
|
33
|
-
* @description
|
|
33
|
+
* @description Create entity query object
|
|
34
34
|
* @returns EntityQuery
|
|
35
35
|
*/
|
|
36
36
|
query(): IfNull<IndexesStruct, BaseEntityQuery<EntityStruct, EmptyObject>, IfEmptyObject<IndexesStruct, InputIndexEntityQuery<EntityStruct, EmptyObject>, InferIndexEntityQuery<EntityStruct, Exclude<IndexesStruct, EmptyObject | null>>>>;
|
|
37
37
|
/**
|
|
38
|
-
* @description
|
|
39
|
-
* @param items
|
|
38
|
+
* @description Batch create or update entity data
|
|
39
|
+
* @param items Array of items
|
|
40
40
|
*/
|
|
41
41
|
batchSet<Items extends EntityBatchSetItem<EntityStruct>[]>(items: NotEmptyArray<Items>): Promise<void>;
|
|
42
42
|
/**
|
|
43
|
-
* @description
|
|
44
|
-
* @param keys
|
|
43
|
+
* @description Batch delete entity data
|
|
44
|
+
* @param keys Array of entity data keys
|
|
45
45
|
*/
|
|
46
46
|
batchDelete<Keys extends string[]>(keys: NotEmptyArray<Keys>): Promise<void>;
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* @description
|
|
50
|
-
* @typedef EntityStruct
|
|
49
|
+
* @description Item for batch create or update entity data
|
|
50
|
+
* @typedef EntityStruct Entity data structure
|
|
51
51
|
*/
|
|
52
52
|
export interface EntityBatchSetItem<EntityStruct extends BaseEntityStruct<EntityStruct>> {
|
|
53
53
|
/**
|
|
54
|
-
* @description
|
|
54
|
+
* @description Entity data key
|
|
55
55
|
*/
|
|
56
56
|
key: string;
|
|
57
57
|
/**
|
|
58
|
-
* @description
|
|
58
|
+
* @description Entity data value
|
|
59
59
|
*/
|
|
60
60
|
value: Partial<EntityStruct>;
|
|
61
61
|
}
|
|
@@ -1,126 +1,126 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @enum EntityErrorCode
|
|
3
|
-
* @description
|
|
3
|
+
* @description Entity error code enum
|
|
4
4
|
*/
|
|
5
5
|
export declare enum EntityErrorCode {
|
|
6
6
|
/**
|
|
7
|
-
* @description
|
|
7
|
+
* @description Entity name is empty / contains invalid characters / exceeds max length
|
|
8
8
|
* @satisfies /^[_a-z0-9]{1,32}$/
|
|
9
9
|
*/
|
|
10
10
|
EntityNameInvalid = "EntityNameInvalid",
|
|
11
11
|
/**
|
|
12
|
-
* @description
|
|
12
|
+
* @description Entity name does not exist (not defined in config)
|
|
13
13
|
*/
|
|
14
14
|
EntityNotFound = "EntityNotFound",
|
|
15
15
|
/**
|
|
16
|
-
* @description
|
|
16
|
+
* @description Entity data cannot be empty
|
|
17
17
|
*/
|
|
18
18
|
EntityDataEmpty = "EntityDataEmpty",
|
|
19
19
|
/**
|
|
20
|
-
* @description
|
|
20
|
+
* @description Too many entity data items
|
|
21
21
|
* @satisfies maximum 100 items
|
|
22
22
|
*/
|
|
23
23
|
EntityDataBatchLimit = "EntityDataBatchLimit",
|
|
24
24
|
/**
|
|
25
|
-
* @description key
|
|
25
|
+
* @description key is empty / contains invalid characters / exceeds max length
|
|
26
26
|
* @satisfies /^[_a-z0-9]{1,64}$/
|
|
27
27
|
*/
|
|
28
28
|
EntityDataKeyInvalid = "EntityDataKeyInvalid",
|
|
29
29
|
/**
|
|
30
|
-
* @description key
|
|
30
|
+
* @description Duplicate key
|
|
31
31
|
*/
|
|
32
32
|
EntityDataKeyDuplicate = "EntityDataKeyDuplicate",
|
|
33
33
|
/**
|
|
34
|
-
* @description
|
|
34
|
+
* @description Attribute name is empty / contains invalid characters / exceeds max length
|
|
35
35
|
* @satisfies /^[_a-z0-9]{1,64}$/
|
|
36
36
|
*/
|
|
37
37
|
EntityDataValueAttrInvalid = "EntityDataValueAttrInvalid",
|
|
38
38
|
/**
|
|
39
|
-
* @description
|
|
39
|
+
* @description Attribute name does not exist (not defined in config)
|
|
40
40
|
*/
|
|
41
41
|
EntityDataValueAttrNotFound = "EntityDataValueAttrNotFound",
|
|
42
42
|
/**
|
|
43
|
-
* @description
|
|
43
|
+
* @description Value cannot be empty
|
|
44
44
|
*/
|
|
45
45
|
EntityDataValueEmpty = "EntityDataValueEmpty",
|
|
46
46
|
/**
|
|
47
|
-
* @description
|
|
47
|
+
* @description Invalid value
|
|
48
48
|
*/
|
|
49
49
|
EntityDataValueInvalid = "EntityDataValueInvalid",
|
|
50
50
|
/**
|
|
51
|
-
* @description string
|
|
51
|
+
* @description Value of string attribute exceeds max length
|
|
52
52
|
*/
|
|
53
53
|
EntityDataStringValueTooLong = "EntityDataStringValueTooLong",
|
|
54
54
|
/**
|
|
55
|
-
* @description text
|
|
55
|
+
* @description Value of text attribute exceeds max length
|
|
56
56
|
* @satisfies maximum 32768 characters
|
|
57
57
|
*/
|
|
58
58
|
EntityDataTextValueTooLong = "EntityDataTextValueTooLong",
|
|
59
59
|
/**
|
|
60
|
-
* @description
|
|
60
|
+
* @description Missing required attribute
|
|
61
61
|
*/
|
|
62
62
|
EntityDataAttrRequired = "EntityDataAttrRequired",
|
|
63
63
|
/**
|
|
64
|
-
* @description
|
|
64
|
+
* @description Attribute value type does not match definition
|
|
65
65
|
*/
|
|
66
66
|
EntityDataValueTypeInvalid = "EntityDataValueTypeInvalid",
|
|
67
67
|
/**
|
|
68
|
-
* @description
|
|
68
|
+
* @description Index cannot be empty
|
|
69
69
|
*/
|
|
70
70
|
EntityDataIndexEmpty = "EntityDataIndexEmpty",
|
|
71
71
|
/**
|
|
72
|
-
* @description
|
|
72
|
+
* @description Index is empty / contains invalid characters / exceeds max length
|
|
73
73
|
* @satisfies /^[_a-z0-9]{1,64}$/
|
|
74
74
|
*/
|
|
75
75
|
EntityDataIndexNameInvalid = "EntityDataIndexNameInvalid",
|
|
76
76
|
/**
|
|
77
|
-
* @description
|
|
77
|
+
* @description Index does not exist (not defined in config)
|
|
78
78
|
*/
|
|
79
79
|
EntityDataIndexNotFound = "EntityDataIndexNotFound",
|
|
80
80
|
/**
|
|
81
|
-
* @description
|
|
81
|
+
* @description Attribute value in custom index is empty or invalid
|
|
82
82
|
*/
|
|
83
83
|
EntityDataPartitionValueInvalid = "EntityDataPartitionValueInvalid",
|
|
84
84
|
/**
|
|
85
|
-
* @description
|
|
85
|
+
* @description Attribute value type in custom index does not match definition
|
|
86
86
|
*/
|
|
87
87
|
EntityDataPartitionValueTypeInvalid = "EntityDataPartitionValueTypeInvalid",
|
|
88
88
|
/**
|
|
89
|
-
* @description
|
|
89
|
+
* @description Attribute value in custom index exceeds max length
|
|
90
90
|
*/
|
|
91
91
|
EntityDataPartitionValueTooLong = "EntityDataPartitionValueTooLong",
|
|
92
92
|
/**
|
|
93
|
-
* @description
|
|
93
|
+
* @description Unique constraint violation
|
|
94
94
|
*/
|
|
95
95
|
EntityDataUniqueConstraintFailed = "EntityDataUniqueConstraintFailed",
|
|
96
96
|
/**
|
|
97
|
-
* @description
|
|
97
|
+
* @description Attribute value type in entity query condition clause does not match
|
|
98
98
|
*/
|
|
99
99
|
EntityDataWhereConditionValueTypeInvalid = "EntityDataWhereConditionValueTypeInvalid",
|
|
100
100
|
/**
|
|
101
|
-
* @description
|
|
101
|
+
* @description Attribute value in entity query condition clause exceeds max length
|
|
102
102
|
*/
|
|
103
103
|
EntityDataWhereConditionValueTooLong = "EntityDataWhereConditionValueTooLong",
|
|
104
104
|
/**
|
|
105
|
-
* @description
|
|
105
|
+
* @description Entity query cursor value is invalid
|
|
106
106
|
*/
|
|
107
107
|
EntityDataPageCursorInvalid = "EntityDataPageCursorInvalid",
|
|
108
108
|
/**
|
|
109
|
-
* @description
|
|
109
|
+
* @description Entity query sort value is invalid
|
|
110
110
|
* @satisfies EntitySortEnum
|
|
111
111
|
*/
|
|
112
112
|
EntityDataSortValueInvalid = "EntityDataSortValueInvalid",
|
|
113
113
|
/**
|
|
114
|
-
* @description
|
|
114
|
+
* @description Entity query page limit value is invalid
|
|
115
115
|
* @satisfies [1, 1000]
|
|
116
116
|
*/
|
|
117
117
|
EntityDataPageLimitNotInRange = "EntityDataPageLimitNotInRange",
|
|
118
118
|
/**
|
|
119
|
-
* @description
|
|
119
|
+
* @description Entity operation or query timeout
|
|
120
120
|
*/
|
|
121
121
|
EntityDataAPITimeOut = "EntityDataAPITimeOut",
|
|
122
122
|
/**
|
|
123
|
-
* @description JSON
|
|
123
|
+
* @description JSON serialization failed
|
|
124
124
|
*/
|
|
125
125
|
MalformedJSON = "Malformed.JSON"
|
|
126
126
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/packages/node/storage/entity/fetch/index.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAGV,oBAAoB,EAEpB,qBAAqB,EAErB,mBAAmB,EAEnB,oBAAoB,EAErB,MAAM,SAAS,CAAA;AAEhB,cAAc,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/packages/node/storage/entity/fetch/index.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAGV,oBAAoB,EAEpB,qBAAqB,EAErB,mBAAmB,EAEnB,oBAAoB,EAErB,MAAM,SAAS,CAAA;AAEhB,cAAc,SAAS,CAAA;AA2DvB,eAAO,MAAM,SAAS,EAAE,mBAIvB,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,qBAIzB,CAAA;AAED,eAAO,MAAM,UAAU,EAAE,oBAYxB,CAAA;AAED,eAAO,MAAM,UAAU,EAAE,oBAIxB,CAAA"}
|
|
@@ -7,147 +7,147 @@ import type { BaseEntityStruct, BaseIndexesStruct, BaseIndexesStructValue } from
|
|
|
7
7
|
import type { defaultEntityQueryCursor, defaultEntityQueryLimit, defaultEntityQuerySort, defaultEntityQueryIndex, defaultEntityQueryWhere } from './consts';
|
|
8
8
|
export type LimitNumber = IntClosedRange<1, 998> | 999 | 1000;
|
|
9
9
|
/**
|
|
10
|
-
* @description
|
|
11
|
-
* @typedef EntityStruct
|
|
12
|
-
* @typedef IndexesStruct
|
|
10
|
+
* @description Entity query object
|
|
11
|
+
* @typedef EntityStruct Entity data structure
|
|
12
|
+
* @typedef IndexesStruct Entity index structure
|
|
13
13
|
*/
|
|
14
14
|
export interface BaseEntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> {
|
|
15
15
|
/**
|
|
16
|
-
* @description
|
|
17
|
-
* @param cursor
|
|
16
|
+
* @description Set entity query cursor
|
|
17
|
+
* @param cursor Cursor
|
|
18
18
|
* @returns EntityQuery
|
|
19
19
|
*/
|
|
20
20
|
cursor(cursor: string | typeof defaultEntityQueryCursor): BaseEntityQuery<EntityStruct, IndexesStruct>;
|
|
21
21
|
/**
|
|
22
|
-
* @description
|
|
22
|
+
* @description Set entity query limit
|
|
23
23
|
* @satisfies [1, 1000]
|
|
24
|
-
* @param limit
|
|
24
|
+
* @param limit Limit
|
|
25
25
|
* @returns EntityQuery
|
|
26
26
|
*/
|
|
27
27
|
limit(limit: LimitNumber | typeof defaultEntityQueryLimit): BaseEntityQuery<EntityStruct, IndexesStruct>;
|
|
28
28
|
/**
|
|
29
|
-
* @description
|
|
30
|
-
* @param sort
|
|
29
|
+
* @description Set entity query sort order
|
|
30
|
+
* @param sort Sort order
|
|
31
31
|
* @returns EntityQuery
|
|
32
32
|
*/
|
|
33
33
|
sort(sort: EntitySortEnum | typeof defaultEntityQuerySort): BaseEntityQuery<EntityStruct, IndexesStruct>;
|
|
34
34
|
/**
|
|
35
|
-
* @description
|
|
36
|
-
* @returns
|
|
35
|
+
* @description Get one entity record
|
|
36
|
+
* @returns Entity data value
|
|
37
37
|
*/
|
|
38
38
|
getOne(): Promise<EntityResultData<EntityStruct> | undefined>;
|
|
39
39
|
/**
|
|
40
|
-
* @description
|
|
41
|
-
* @returns
|
|
40
|
+
* @description Get entity data array
|
|
41
|
+
* @returns Entity data paginated query result object
|
|
42
42
|
*/
|
|
43
43
|
getMany(): Promise<EntityListResultData<EntityStruct>>;
|
|
44
44
|
/**
|
|
45
|
-
* @description
|
|
46
|
-
* @returns
|
|
45
|
+
* @description Get total count of entity data
|
|
46
|
+
* @returns Total count
|
|
47
47
|
*/
|
|
48
48
|
count(): Promise<number>;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* @description
|
|
52
|
-
* @typedef EntityStruct
|
|
53
|
-
* @typedef IndexesStruct
|
|
51
|
+
* @description Entity query object
|
|
52
|
+
* @typedef EntityStruct Entity data structure
|
|
53
|
+
* @typedef IndexesStruct Entity index structure
|
|
54
54
|
*/
|
|
55
55
|
export interface InferIndexEntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> extends BaseEntityQuery<EntityStruct, IndexesStruct> {
|
|
56
56
|
cursor: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['cursor'], InferIndexEntityQuery<EntityStruct, IndexesStruct>>;
|
|
57
57
|
limit: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['limit'], InferIndexEntityQuery<EntityStruct, IndexesStruct>>;
|
|
58
58
|
sort: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['sort'], InferIndexEntityQuery<EntityStruct, IndexesStruct>>;
|
|
59
59
|
/**
|
|
60
|
-
* @description
|
|
61
|
-
* @param index
|
|
62
|
-
* @param partitions
|
|
60
|
+
* @description Set entity query index
|
|
61
|
+
* @param index Index
|
|
62
|
+
* @param partitions Partition attribute values of the index
|
|
63
63
|
* @returns EntityQuery
|
|
64
64
|
*/
|
|
65
65
|
index<IndexKey extends keyof ConditionalExcept<IndexesStruct, null>>(index: IndexKey, partitions: IndexesStruct[IndexKey]): InferWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
66
66
|
/**
|
|
67
|
-
* @description
|
|
68
|
-
* @param index
|
|
67
|
+
* @description Set entity query index
|
|
68
|
+
* @param index Index
|
|
69
69
|
* @returns EntityQuery
|
|
70
70
|
*/
|
|
71
71
|
index<IndexKey extends keyof ConditionalPick<IndexesStruct, null>>(index: IndexKey): InferWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
72
72
|
/**
|
|
73
|
-
* @description
|
|
74
|
-
* @param index
|
|
73
|
+
* @description Set entity query index
|
|
74
|
+
* @param index Index
|
|
75
75
|
* @returns EntityQuery
|
|
76
76
|
*/
|
|
77
77
|
index(index: typeof defaultEntityQueryIndex): InferWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
78
78
|
}
|
|
79
79
|
/**
|
|
80
|
-
* @description
|
|
81
|
-
* @typedef EntityStruct
|
|
82
|
-
* @typedef IndexesStruct
|
|
80
|
+
* @description Entity query object
|
|
81
|
+
* @typedef EntityStruct Entity data structure
|
|
82
|
+
* @typedef IndexesStruct Entity index structure
|
|
83
83
|
*/
|
|
84
84
|
export interface InputIndexEntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> extends BaseEntityQuery<EntityStruct, IndexesStruct> {
|
|
85
85
|
cursor: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['cursor'], InputIndexEntityQuery<EntityStruct, IndexesStruct>>;
|
|
86
86
|
limit: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['limit'], InputIndexEntityQuery<EntityStruct, IndexesStruct>>;
|
|
87
87
|
sort: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['sort'], InputIndexEntityQuery<EntityStruct, IndexesStruct>>;
|
|
88
88
|
/**
|
|
89
|
-
* @description
|
|
90
|
-
* @typedef Partitions
|
|
91
|
-
* @param index
|
|
92
|
-
* @param partitions
|
|
89
|
+
* @description Set entity query index
|
|
90
|
+
* @typedef Partitions Partition attribute value type of index
|
|
91
|
+
* @param index Index
|
|
92
|
+
* @param partitions Partition attribute values of the index
|
|
93
93
|
* @returns EntityQuery
|
|
94
94
|
*/
|
|
95
95
|
index<Partitions extends BaseIndexesStructValue>(index: string, partitions: Partitions): InputWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
96
96
|
/**
|
|
97
|
-
* @description
|
|
98
|
-
* @param index
|
|
97
|
+
* @description Set entity query index
|
|
98
|
+
* @param index Index
|
|
99
99
|
* @returns EntityQuery
|
|
100
100
|
*/
|
|
101
101
|
index(index: string): InputWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
102
102
|
/**
|
|
103
|
-
* @description
|
|
104
|
-
* @param index
|
|
103
|
+
* @description Set entity query index
|
|
104
|
+
* @param index Index
|
|
105
105
|
* @returns EntityQuery
|
|
106
106
|
*/
|
|
107
107
|
index(index: typeof defaultEntityQueryIndex): InputWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* @description
|
|
111
|
-
* @typedef EntityStruct
|
|
112
|
-
* @typedef IndexesStruct
|
|
110
|
+
* @description Entity query object
|
|
111
|
+
* @typedef EntityStruct Entity data structure
|
|
112
|
+
* @typedef IndexesStruct Entity index structure
|
|
113
113
|
*/
|
|
114
114
|
export interface InferWhereEntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> extends InferIndexEntityQuery<EntityStruct, IndexesStruct> {
|
|
115
115
|
cursor: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['cursor'], InferWhereEntityQuery<EntityStruct, IndexesStruct>>;
|
|
116
116
|
limit: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['limit'], InferWhereEntityQuery<EntityStruct, IndexesStruct>>;
|
|
117
117
|
sort: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['sort'], InferWhereEntityQuery<EntityStruct, IndexesStruct>>;
|
|
118
118
|
/**
|
|
119
|
-
* @description
|
|
120
|
-
* @param condition
|
|
119
|
+
* @description Set entity query condition
|
|
120
|
+
* @param condition Condition
|
|
121
121
|
* @returns EntityQuery
|
|
122
122
|
*/
|
|
123
123
|
where(condition: EntityWhereCondition | typeof defaultEntityQueryWhere): InferWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* @description
|
|
127
|
-
* @typedef EntityStruct
|
|
128
|
-
* @typedef IndexesStruct
|
|
126
|
+
* @description Entity query object
|
|
127
|
+
* @typedef EntityStruct Entity data structure
|
|
128
|
+
* @typedef IndexesStruct Entity index structure
|
|
129
129
|
*/
|
|
130
130
|
export interface InputWhereEntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> extends InputIndexEntityQuery<EntityStruct, IndexesStruct> {
|
|
131
131
|
cursor: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['cursor'], InputWhereEntityQuery<EntityStruct, IndexesStruct>>;
|
|
132
132
|
limit: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['limit'], InputWhereEntityQuery<EntityStruct, IndexesStruct>>;
|
|
133
133
|
sort: SetReturnType<BaseEntityQuery<EntityStruct, IndexesStruct>['sort'], InputWhereEntityQuery<EntityStruct, IndexesStruct>>;
|
|
134
134
|
/**
|
|
135
|
-
* @description
|
|
136
|
-
* @param condition
|
|
135
|
+
* @description Set entity query condition
|
|
136
|
+
* @param condition Condition
|
|
137
137
|
* @returns EntityQuery
|
|
138
138
|
*/
|
|
139
139
|
where(condition: EntityWhereCondition | typeof defaultEntityQueryWhere): InputWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
140
140
|
}
|
|
141
141
|
/**
|
|
142
|
-
* @description
|
|
143
|
-
* @typedef EntityStruct
|
|
144
|
-
* @typedef IndexesStruct
|
|
142
|
+
* @description Entity query object
|
|
143
|
+
* @typedef EntityStruct Entity data structure
|
|
144
|
+
* @typedef IndexesStruct Entity index structure
|
|
145
145
|
*/
|
|
146
146
|
export type UnionEntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> = BaseEntityQuery<EntityStruct, IndexesStruct> | InferIndexEntityQuery<EntityStruct, IndexesStruct> | InputIndexEntityQuery<EntityStruct, IndexesStruct> | InferWhereEntityQuery<EntityStruct, IndexesStruct> | InputWhereEntityQuery<EntityStruct, IndexesStruct>;
|
|
147
147
|
/**
|
|
148
|
-
* @description
|
|
149
|
-
* @typedef EntityStruct
|
|
150
|
-
* @typedef IndexesStruct
|
|
148
|
+
* @description Entity query object
|
|
149
|
+
* @typedef EntityStruct Entity data structure
|
|
150
|
+
* @typedef IndexesStruct Entity index structure
|
|
151
151
|
*/
|
|
152
152
|
export type EntityQuery<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>> = UnionToIntersection<UnionEntityQuery<EntityStruct, IndexesStruct>>;
|
|
153
153
|
export interface DefaultEntityQuery {
|
|
@@ -6,48 +6,48 @@ export type EntityCountResult = EntityResult<{
|
|
|
6
6
|
}>;
|
|
7
7
|
export type EntityListResult<EntityStruct> = EntityResult<EntityListResultData<EntityStruct>>;
|
|
8
8
|
/**
|
|
9
|
-
* @description
|
|
10
|
-
* @typedef EntityStruct
|
|
9
|
+
* @description Entity data query result object
|
|
10
|
+
* @typedef EntityStruct Entity data structure
|
|
11
11
|
*/
|
|
12
12
|
export interface EntityResultData<EntityStruct> {
|
|
13
13
|
/**
|
|
14
|
-
* @description
|
|
14
|
+
* @description Data key
|
|
15
15
|
*/
|
|
16
16
|
key: string;
|
|
17
17
|
/**
|
|
18
|
-
* @description
|
|
18
|
+
* @description Data value
|
|
19
19
|
*/
|
|
20
20
|
value: EntityStruct;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* @description
|
|
24
|
-
* @typedef EntityStruct
|
|
23
|
+
* @description Entity data paginated query result object
|
|
24
|
+
* @typedef EntityStruct Entity data structure
|
|
25
25
|
*/
|
|
26
26
|
export interface EntityListResultData<EntityStruct> {
|
|
27
27
|
/**
|
|
28
|
-
* @description
|
|
28
|
+
* @description Pagination info
|
|
29
29
|
*/
|
|
30
30
|
page_info: {
|
|
31
31
|
/**
|
|
32
|
-
* @description
|
|
32
|
+
* @description Total count of current page
|
|
33
33
|
*/
|
|
34
34
|
count: number;
|
|
35
35
|
/**
|
|
36
|
-
* @description
|
|
36
|
+
* @description Whether there is more data
|
|
37
37
|
*/
|
|
38
38
|
has_more: boolean;
|
|
39
39
|
/**
|
|
40
|
-
* @description
|
|
40
|
+
* @description Cursor at end of current page
|
|
41
41
|
*/
|
|
42
42
|
end_cursor: string;
|
|
43
43
|
};
|
|
44
44
|
/**
|
|
45
|
-
* @description
|
|
45
|
+
* @description Paginated data array
|
|
46
46
|
*/
|
|
47
47
|
data: EntityResultData<EntityStruct>[];
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
|
-
* @description
|
|
50
|
+
* @description Entity query or operation error object
|
|
51
51
|
*/
|
|
52
52
|
export type EntityError = ErrorResult<never, EntityErrorCode>;
|
|
53
53
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @enum EntitySortEnum
|
|
3
|
-
* @description
|
|
3
|
+
* @description Entity sort order enum
|
|
4
4
|
*/
|
|
5
5
|
export declare enum EntitySortEnum {
|
|
6
6
|
/**
|
|
7
|
-
* @description
|
|
7
|
+
* @description Ascending
|
|
8
8
|
*/
|
|
9
9
|
ASC = "ASC",
|
|
10
10
|
/**
|
|
11
|
-
* @description
|
|
11
|
+
* @description Descending
|
|
12
12
|
*/
|
|
13
13
|
DESC = "DESC"
|
|
14
14
|
}
|
|
@@ -6,40 +6,40 @@ import type { Entity, BaseEntityStruct, BaseIndexesStruct } from './entity';
|
|
|
6
6
|
import type { defaultEntityQueryCursor, defaultEntityQueryIndex, defaultEntityQueryLimit, defaultEntityQuerySort, defaultEntityQueryWhere } from './query';
|
|
7
7
|
export interface EntityStatic {
|
|
8
8
|
/**
|
|
9
|
-
* @description
|
|
9
|
+
* @description Entity sort order enum
|
|
10
10
|
*/
|
|
11
11
|
Sort: typeof EntitySortEnum;
|
|
12
12
|
/**
|
|
13
|
-
* @description
|
|
13
|
+
* @description Entity error code enum
|
|
14
14
|
*/
|
|
15
15
|
EntityErrorCode: typeof EntityErrorCode;
|
|
16
16
|
/**
|
|
17
|
-
* @description
|
|
17
|
+
* @description Entity query condition method enum
|
|
18
18
|
*/
|
|
19
19
|
WhereConditions: typeof WhereConditions;
|
|
20
20
|
/**
|
|
21
|
-
* @description
|
|
21
|
+
* @description Default entity query cursor
|
|
22
22
|
*/
|
|
23
23
|
defaultEntityQueryCursor: typeof defaultEntityQueryCursor;
|
|
24
24
|
/**
|
|
25
|
-
* @description
|
|
25
|
+
* @description Default entity query index
|
|
26
26
|
*/
|
|
27
27
|
defaultEntityQueryIndex: typeof defaultEntityQueryIndex;
|
|
28
28
|
/**
|
|
29
|
-
* @description
|
|
29
|
+
* @description Default entity query limit
|
|
30
30
|
*/
|
|
31
31
|
defaultEntityQueryLimit: typeof defaultEntityQueryLimit;
|
|
32
32
|
/**
|
|
33
|
-
* @description
|
|
33
|
+
* @description Default entity query sort
|
|
34
34
|
*/
|
|
35
35
|
defaultEntityQuerySort: typeof defaultEntityQuerySort;
|
|
36
36
|
/**
|
|
37
|
-
* @description
|
|
37
|
+
* @description Default entity query condition
|
|
38
38
|
*/
|
|
39
39
|
defaultEntityQueryWhere: typeof defaultEntityQueryWhere;
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* @description
|
|
42
|
+
* @description Auto-generated at compile time
|
|
43
43
|
* @example
|
|
44
44
|
* declare global {
|
|
45
45
|
* var ONESEntities: {
|
|
@@ -61,19 +61,19 @@ type PluginEntities = FindGlobalType<'ONESEntities'>;
|
|
|
61
61
|
export interface BaseEntityFactory {
|
|
62
62
|
/**
|
|
63
63
|
* @function EntityFactory
|
|
64
|
-
* @description
|
|
65
|
-
* @typedef EntityStruct
|
|
66
|
-
* @typedef IndexesStruct
|
|
67
|
-
* @param entityName
|
|
64
|
+
* @description Create entity operation object
|
|
65
|
+
* @typedef EntityStruct Entity data structure
|
|
66
|
+
* @typedef IndexesStruct Entity index structure
|
|
67
|
+
* @param entityName Entity name
|
|
68
68
|
* @returns Entity
|
|
69
69
|
*/
|
|
70
70
|
<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>>(entityName: string): Entity<EntityStruct, IndexesStruct>;
|
|
71
71
|
/**
|
|
72
72
|
* @function EntityFactory
|
|
73
|
-
* @description
|
|
74
|
-
* @typedef EntityStruct
|
|
75
|
-
* @typedef IndexesStruct
|
|
76
|
-
* @param entityName
|
|
73
|
+
* @description Create entity operation object
|
|
74
|
+
* @typedef EntityStruct Entity data structure
|
|
75
|
+
* @typedef IndexesStruct Entity index structure
|
|
76
|
+
* @param entityName Entity name
|
|
77
77
|
* @returns Entity
|
|
78
78
|
*/
|
|
79
79
|
<EntityStruct extends BaseEntityStruct<EntityStruct>>(entityName: string): Entity<EntityStruct, EmptyObject>;
|
|
@@ -81,28 +81,28 @@ export interface BaseEntityFactory {
|
|
|
81
81
|
export interface PluginEntityFactory {
|
|
82
82
|
/**
|
|
83
83
|
* @function EntityFactory
|
|
84
|
-
* @description
|
|
85
|
-
* @typedef EntityStruct
|
|
86
|
-
* @typedef IndexesStruct
|
|
87
|
-
* @param entityName
|
|
84
|
+
* @description Create entity operation object
|
|
85
|
+
* @typedef EntityStruct Entity data structure
|
|
86
|
+
* @typedef IndexesStruct Entity index structure
|
|
87
|
+
* @param entityName Entity name
|
|
88
88
|
* @returns Entity
|
|
89
89
|
*/
|
|
90
90
|
<EntityName extends keyof PluginEntities>(entityName: EntityName): Entity<Get<PluginEntities, Exclude<EntityName, number | symbol>>['attributes'], Get<PluginEntities, Exclude<EntityName, number | symbol>>['indexes']>;
|
|
91
91
|
/**
|
|
92
92
|
* @function EntityFactory
|
|
93
|
-
* @description
|
|
94
|
-
* @typedef EntityStruct
|
|
95
|
-
* @typedef IndexesStruct
|
|
96
|
-
* @param entityName
|
|
93
|
+
* @description Create entity operation object
|
|
94
|
+
* @typedef EntityStruct Entity data structure
|
|
95
|
+
* @typedef IndexesStruct Entity index structure
|
|
96
|
+
* @param entityName Entity name
|
|
97
97
|
* @returns Entity
|
|
98
98
|
*/
|
|
99
99
|
<EntityStruct extends BaseEntityStruct<EntityStruct>, IndexesStruct extends BaseIndexesStruct<IndexesStruct>>(entityName: string): Entity<EntityStruct, IndexesStruct>;
|
|
100
100
|
/**
|
|
101
101
|
* @function EntityFactory
|
|
102
|
-
* @description
|
|
103
|
-
* @typedef EntityStruct
|
|
104
|
-
* @typedef IndexesStruct
|
|
105
|
-
* @param entityName
|
|
102
|
+
* @description Create entity operation object
|
|
103
|
+
* @typedef EntityStruct Entity data structure
|
|
104
|
+
* @typedef IndexesStruct Entity index structure
|
|
105
|
+
* @param entityName Entity name
|
|
106
106
|
* @returns Entity
|
|
107
107
|
*/
|
|
108
108
|
<EntityStruct extends BaseEntityStruct<EntityStruct>>(entityName: string): Entity<EntityStruct, EmptyObject>;
|