@ones-open/node-sdk 0.0.3 → 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 +65 -49
- package/dist/index.js +65 -49
- 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,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>;
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @enum ObjectErrorCode
|
|
3
|
-
* @description
|
|
3
|
+
* @description Object storage error code enum
|
|
4
4
|
*/
|
|
5
5
|
export declare enum ObjectErrorCode {
|
|
6
6
|
/**
|
|
7
|
-
* @description
|
|
7
|
+
* @description Object storage key is empty / contains invalid characters / exceeds max length
|
|
8
8
|
* @satisfies /^[0-9a-zA-Z!_.*'()-]{1,128}$/
|
|
9
9
|
*/
|
|
10
10
|
ObjectKeyInvalid = "ObjectKeyInvalid",
|
|
11
11
|
/**
|
|
12
|
-
* @description
|
|
12
|
+
* @description Object storage key does not exist
|
|
13
13
|
*/
|
|
14
14
|
ObjectKeyNotfound = "ObjectKeyNotfound",
|
|
15
15
|
/**
|
|
16
|
-
* @description
|
|
16
|
+
* @description Request timeout
|
|
17
17
|
*/
|
|
18
18
|
RequestTimeOut = "RequestTimeOut"
|
|
19
19
|
}
|
|
@@ -2,19 +2,19 @@ import type { ObjectErrorResult } from './types';
|
|
|
2
2
|
export * from './consts';
|
|
3
3
|
export * from './types';
|
|
4
4
|
/**
|
|
5
|
-
* @description
|
|
5
|
+
* @description Object storage operation error object
|
|
6
6
|
*/
|
|
7
7
|
export declare class ObjectError implements ObjectErrorResult {
|
|
8
8
|
/**
|
|
9
|
-
* @description
|
|
9
|
+
* @description Error code enum
|
|
10
10
|
*/
|
|
11
11
|
code: import("../../..").ErrorCode | import("./consts").ObjectErrorCode;
|
|
12
12
|
/**
|
|
13
|
-
* @description
|
|
13
|
+
* @description Error message
|
|
14
14
|
*/
|
|
15
15
|
err_msg: string;
|
|
16
16
|
/**
|
|
17
|
-
* @description
|
|
17
|
+
* @description Error payload
|
|
18
18
|
*/
|
|
19
19
|
err_values: Record<string, any> | undefined;
|
|
20
20
|
constructor(result: ObjectErrorResult);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/packages/node/storage/object/fetch/index.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAGV,qBAAqB,EAErB,uBAAuB,EAEvB,qBAAqB,EAErB,uBAAuB,EAExB,MAAM,SAAS,CAAA;AAEhB,cAAc,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/packages/node/storage/object/fetch/index.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAGV,qBAAqB,EAErB,uBAAuB,EAEvB,qBAAqB,EAErB,uBAAuB,EAExB,MAAM,SAAS,CAAA;AAEhB,cAAc,SAAS,CAAA;AAwDvB,eAAO,MAAM,WAAW,EAAE,qBAKzB,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,uBAK3B,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,qBAEzB,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,uBAE3B,CAAA"}
|
|
@@ -15,15 +15,15 @@ export type ObjectDownloadResult = ObjectResult<{
|
|
|
15
15
|
}>;
|
|
16
16
|
export type ObjectDeleteResult = ObjectResult<never>;
|
|
17
17
|
/**
|
|
18
|
-
* @description
|
|
18
|
+
* @description Result object for object metadata
|
|
19
19
|
*/
|
|
20
20
|
export interface ObjectMetadataResultData {
|
|
21
21
|
/**
|
|
22
|
-
* @description
|
|
22
|
+
* @description Object storage key
|
|
23
23
|
*/
|
|
24
24
|
object_key: string;
|
|
25
25
|
/**
|
|
26
|
-
* @description
|
|
26
|
+
* @description File size in bytes
|
|
27
27
|
*/
|
|
28
28
|
size: number;
|
|
29
29
|
}
|
|
@@ -1,64 +1,64 @@
|
|
|
1
1
|
import type { ObjectError, ObjectErrorCode } from './error';
|
|
2
2
|
import type { ObjectResultDataFields, ObjectMetadataResultData } from './result';
|
|
3
3
|
/**
|
|
4
|
-
* @description
|
|
4
|
+
* @description Operation object for getting upload info
|
|
5
5
|
*/
|
|
6
6
|
export interface ObjectStoreUploadResult {
|
|
7
7
|
/**
|
|
8
|
-
* @description
|
|
8
|
+
* @description Get upload URL (must be requested from plugin backend)
|
|
9
9
|
*/
|
|
10
10
|
getUrl(): string;
|
|
11
11
|
/**
|
|
12
|
-
* @description
|
|
12
|
+
* @description Get upload URL (suitable for browser requests)
|
|
13
13
|
*/
|
|
14
14
|
getWebUrl(): string;
|
|
15
15
|
/**
|
|
16
|
-
* @description
|
|
16
|
+
* @description Get FormData parameters for the request
|
|
17
17
|
*/
|
|
18
18
|
getFields(): ObjectResultDataFields;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* @description
|
|
21
|
+
* @description Operation object for getting download info
|
|
22
22
|
*/
|
|
23
23
|
export interface ObjectStoreDownloadResult {
|
|
24
24
|
/**
|
|
25
|
-
* @description
|
|
25
|
+
* @description Get download URL (must be requested from plugin backend)
|
|
26
26
|
*/
|
|
27
27
|
getUrl(): string;
|
|
28
28
|
/**
|
|
29
|
-
* @description
|
|
29
|
+
* @description Get download URL (suitable for browser requests)
|
|
30
30
|
*/
|
|
31
31
|
getWebUrl(): string;
|
|
32
32
|
}
|
|
33
33
|
export interface ObjectStore {
|
|
34
34
|
/**
|
|
35
|
-
* @description
|
|
35
|
+
* @description Object storage operation error object
|
|
36
36
|
*/
|
|
37
37
|
ObjectError: typeof ObjectError;
|
|
38
38
|
/**
|
|
39
|
-
* @description
|
|
39
|
+
* @description Object storage error code enum
|
|
40
40
|
*/
|
|
41
41
|
ObjectErrorCode: typeof ObjectErrorCode;
|
|
42
42
|
/**
|
|
43
|
-
* @description
|
|
44
|
-
* @param key
|
|
43
|
+
* @description Upload an object
|
|
44
|
+
* @param key Object storage key
|
|
45
45
|
* @returns ObjectStoreUploadResult
|
|
46
46
|
*/
|
|
47
47
|
upload(key: string): Promise<ObjectStoreUploadResult | ObjectError>;
|
|
48
48
|
/**
|
|
49
|
-
* @description
|
|
50
|
-
* @param key
|
|
49
|
+
* @description Download an object
|
|
50
|
+
* @param key Object storage key
|
|
51
51
|
* @returns ObjectStoreDownloadResult
|
|
52
52
|
*/
|
|
53
53
|
download(key: string): Promise<ObjectStoreDownloadResult | ObjectError>;
|
|
54
54
|
/**
|
|
55
|
-
* @description
|
|
56
|
-
* @param key
|
|
55
|
+
* @description Delete an object
|
|
56
|
+
* @param key Object storage key
|
|
57
57
|
*/
|
|
58
58
|
delete(key: string): Promise<void | ObjectError>;
|
|
59
59
|
/**
|
|
60
|
-
* @description
|
|
61
|
-
* @param key
|
|
60
|
+
* @description Get metadata of an object
|
|
61
|
+
* @param key Object storage key
|
|
62
62
|
* @returns ObjectMetadataResultData
|
|
63
63
|
*/
|
|
64
64
|
metadata(key: string): Promise<ObjectMetadataResultData | ObjectError>;
|
|
@@ -1,35 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @description
|
|
3
|
-
* @alias
|
|
4
|
-
* @
|
|
5
|
-
* @returns platformApiHost
|
|
2
|
+
* @description Get the open platform base URL
|
|
3
|
+
* @alias getONESHostedBaseUrl
|
|
4
|
+
* @returns ONES_HOSTED_BASE_URL
|
|
6
5
|
*/
|
|
7
|
-
export declare const
|
|
6
|
+
export declare const getONESHostedBaseUrl: () => string | undefined;
|
|
8
7
|
/**
|
|
9
|
-
* @description
|
|
10
|
-
* @alias
|
|
11
|
-
* @
|
|
12
|
-
* @returns platformApiHost
|
|
8
|
+
* @description Get the app instance ID
|
|
9
|
+
* @alias getONESHostedAppID
|
|
10
|
+
* @returns ONES_HOSTED_APP_ID
|
|
13
11
|
*/
|
|
14
|
-
export declare const
|
|
12
|
+
export declare const getONESHostedAppID: () => string | undefined;
|
|
15
13
|
/**
|
|
16
|
-
* @description
|
|
17
|
-
* @alias
|
|
18
|
-
* @returns
|
|
14
|
+
* @description Get the app hosted token
|
|
15
|
+
* @alias getONESHostedToken
|
|
16
|
+
* @returns ONES_HOSTED_TOKEN
|
|
19
17
|
*/
|
|
20
|
-
export declare const
|
|
21
|
-
/**
|
|
22
|
-
* @description 获取插件 ID
|
|
23
|
-
* @alias getApplicationId
|
|
24
|
-
* @alias getAppId
|
|
25
|
-
* @returns applicationId
|
|
26
|
-
*/
|
|
27
|
-
export declare const getApplicationId: () => string;
|
|
28
|
-
/**
|
|
29
|
-
* @description 获取插件 ID
|
|
30
|
-
* @alias getApplicationId
|
|
31
|
-
* @alias getAppId
|
|
32
|
-
* @returns applicationId
|
|
33
|
-
*/
|
|
34
|
-
export declare const getAppId: () => string;
|
|
18
|
+
export declare const getONESHostedToken: () => string | undefined;
|
|
35
19
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/packages/strict/env/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/packages/strict/env/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,0BAEhC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,0BAE9B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,0BAE9B,CAAA"}
|