@cubicweb/client 3.0.0-alpha.10 → 3.0.0-alpha.12
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/README.md +11 -20
- package/lib/api/Api.d.ts +30 -22
- package/lib/api/Api.d.ts.map +1 -1
- package/lib/api/Api.js +148 -154
- package/lib/api/Api.js.map +1 -1
- package/lib/api/Client.d.ts +21 -9
- package/lib/api/Client.d.ts.map +1 -1
- package/lib/api/Client.js +40 -57
- package/lib/api/Client.js.map +1 -1
- package/lib/api/ResultSet.d.ts +25 -0
- package/lib/api/ResultSet.d.ts.map +1 -0
- package/lib/api/ResultSet.js +12 -0
- package/lib/api/ResultSet.js.map +1 -0
- package/lib/api/binary/RQLBinary.d.ts +6 -0
- package/lib/api/binary/RQLBinary.d.ts.map +1 -0
- package/lib/api/binary/RQLBinary.js +10 -0
- package/lib/api/binary/RQLBinary.js.map +1 -0
- package/lib/api/query/RQLQuery.d.ts +40 -0
- package/lib/api/query/RQLQuery.d.ts.map +1 -0
- package/lib/api/query/RQLQuery.js +48 -0
- package/lib/api/query/RQLQuery.js.map +1 -0
- package/lib/api/query/references.d.ts +41 -0
- package/lib/api/query/references.d.ts.map +1 -0
- package/lib/api/query/references.js +50 -0
- package/lib/api/query/references.js.map +1 -0
- package/lib/api/transaction/Transaction.d.ts +25 -0
- package/lib/api/transaction/Transaction.d.ts.map +1 -0
- package/lib/api/transaction/Transaction.js +28 -0
- package/lib/api/transaction/Transaction.js.map +1 -0
- package/lib/api/transaction/TransactionResult.d.ts +32 -0
- package/lib/api/transaction/TransactionResult.d.ts.map +1 -0
- package/lib/api/transaction/TransactionResult.js +41 -0
- package/lib/api/transaction/TransactionResult.js.map +1 -0
- package/lib/{Errors.d.ts → errors.d.ts} +7 -4
- package/lib/errors.d.ts.map +1 -0
- package/lib/errors.js +19 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +18 -13
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +17 -34
- package/lib/index.js.map +1 -1
- package/lib/schema/classes/EntitySchema.d.ts +5 -5
- package/lib/schema/classes/EntitySchema.d.ts.map +1 -1
- package/lib/schema/classes/EntitySchema.js +3 -5
- package/lib/schema/classes/EntitySchema.js.map +1 -1
- package/lib/schema/classes/RelationDefinitionSchema.d.ts +6 -6
- package/lib/schema/classes/RelationDefinitionSchema.d.ts.map +1 -1
- package/lib/schema/classes/RelationDefinitionSchema.js +8 -10
- package/lib/schema/classes/RelationDefinitionSchema.js.map +1 -1
- package/lib/schema/classes/Schema.d.ts +7 -7
- package/lib/schema/classes/Schema.d.ts.map +1 -1
- package/lib/schema/classes/Schema.js +8 -11
- package/lib/schema/classes/Schema.js.map +1 -1
- package/lib/schema/classes/Utils.d.ts +10 -10
- package/lib/schema/classes/Utils.d.ts.map +1 -1
- package/lib/schema/classes/Utils.js +19 -35
- package/lib/schema/classes/Utils.js.map +1 -1
- package/lib/schema/raw/Constraints.d.ts +27 -0
- package/lib/schema/raw/Constraints.d.ts.map +1 -1
- package/lib/schema/raw/Constraints.js +1 -2
- package/lib/schema/raw/Entities.js +1 -2
- package/lib/schema/raw/RelationDefinitions.d.ts +3 -3
- package/lib/schema/raw/RelationDefinitions.d.ts.map +1 -1
- package/lib/schema/raw/RelationDefinitions.js +1 -2
- package/lib/schema/raw/Schema.d.ts +2 -2
- package/lib/schema/raw/Schema.d.ts.map +1 -1
- package/lib/schema/raw/Schema.js +1 -2
- package/lib/schema/raw/Utils.d.ts +1 -1
- package/lib/schema/raw/Utils.d.ts.map +1 -1
- package/lib/schema/raw/Utils.js +1 -2
- package/lib/utils.d.ts +39 -0
- package/lib/utils.d.ts.map +1 -0
- package/lib/utils.js +58 -0
- package/lib/utils.js.map +1 -0
- package/package.json +12 -5
- package/src/api/Api.ts +49 -42
- package/src/api/Client.ts +24 -15
- package/src/api/ResultSet.ts +29 -0
- package/src/api/binary/RQLBinary.ts +9 -0
- package/src/api/query/RQLQuery.ts +51 -0
- package/src/api/query/references.ts +43 -0
- package/src/api/transaction/Transaction.ts +31 -0
- package/src/api/transaction/TransactionResult.ts +46 -0
- package/src/{Errors.ts → errors.ts} +6 -7
- package/src/index.ts +21 -17
- package/src/schema/classes/EntitySchema.ts +8 -5
- package/src/schema/classes/RelationDefinitionSchema.ts +7 -7
- package/src/schema/classes/Schema.ts +10 -7
- package/src/schema/classes/Utils.ts +4 -4
- package/src/schema/raw/Constraints.ts +28 -0
- package/src/schema/raw/RelationDefinitions.ts +3 -3
- package/src/schema/raw/Schema.ts +2 -2
- package/src/schema/raw/Utils.ts +1 -1
- package/src/utils.ts +91 -0
- package/lib/Errors.d.ts.map +0 -1
- package/lib/Errors.js +0 -25
- package/lib/Errors.js.map +0 -1
- package/lib/api/Transaction.d.ts +0 -46
- package/lib/api/Transaction.d.ts.map +0 -1
- package/lib/api/Transaction.js +0 -75
- package/lib/api/Transaction.js.map +0 -1
- package/src/api/Transaction.ts +0 -94
|
@@ -1,6 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isAttributeRichString = exports.hasAttributeWithName = exports.getRelationDefinition = exports.getRelationType = exports.getRawRelationType = exports.getReverseRelationType = exports.getRoleFromRelationType = exports.isRelationTypeReversed = exports.getOppositeRelationRole = exports.isCardinalityOptional = exports.isCardinalityMultiple = exports.isCardinalityRequired = exports.getLooseSchema = void 0;
|
|
4
1
|
// This prefix is often applied to relation types as convention
|
|
5
2
|
// indicating a relation is viewed from the object's point of view
|
|
6
3
|
// We do not export it and instead encourage users to use the utility functions
|
|
@@ -14,10 +11,9 @@ const REVERSE_INDICATOR = "reverse_";
|
|
|
14
11
|
*
|
|
15
12
|
* @category Utils
|
|
16
13
|
*/
|
|
17
|
-
const getLooseSchema = (schema) => {
|
|
14
|
+
export const getLooseSchema = (schema) => {
|
|
18
15
|
return schema;
|
|
19
16
|
};
|
|
20
|
-
exports.getLooseSchema = getLooseSchema;
|
|
21
17
|
/**
|
|
22
18
|
* Checks if the given cardinality requires at least one entity to be present
|
|
23
19
|
*
|
|
@@ -26,10 +22,9 @@ exports.getLooseSchema = getLooseSchema;
|
|
|
26
22
|
*
|
|
27
23
|
* @category Utils
|
|
28
24
|
*/
|
|
29
|
-
function isCardinalityRequired(cardinality) {
|
|
25
|
+
export function isCardinalityRequired(cardinality) {
|
|
30
26
|
return cardinality === "1" || cardinality === "+";
|
|
31
27
|
}
|
|
32
|
-
exports.isCardinalityRequired = isCardinalityRequired;
|
|
33
28
|
/**
|
|
34
29
|
* Checks if the cardinality allows multiple entities to be present
|
|
35
30
|
*
|
|
@@ -38,10 +33,9 @@ exports.isCardinalityRequired = isCardinalityRequired;
|
|
|
38
33
|
*
|
|
39
34
|
* @category Utils
|
|
40
35
|
*/
|
|
41
|
-
const isCardinalityMultiple = (cardinality) => {
|
|
36
|
+
export const isCardinalityMultiple = (cardinality) => {
|
|
42
37
|
return cardinality === "*" || cardinality === "+";
|
|
43
38
|
};
|
|
44
|
-
exports.isCardinalityMultiple = isCardinalityMultiple;
|
|
45
39
|
/**
|
|
46
40
|
* Checks if the cardinality allows entities to be absent
|
|
47
41
|
*
|
|
@@ -50,10 +44,9 @@ exports.isCardinalityMultiple = isCardinalityMultiple;
|
|
|
50
44
|
*
|
|
51
45
|
* @category Utils
|
|
52
46
|
*/
|
|
53
|
-
const isCardinalityOptional = (cardinality) => {
|
|
47
|
+
export const isCardinalityOptional = (cardinality) => {
|
|
54
48
|
return cardinality === "?" || cardinality === "*";
|
|
55
49
|
};
|
|
56
|
-
exports.isCardinalityOptional = isCardinalityOptional;
|
|
57
50
|
/**
|
|
58
51
|
* Reverses the given role name
|
|
59
52
|
*
|
|
@@ -62,10 +55,9 @@ exports.isCardinalityOptional = isCardinalityOptional;
|
|
|
62
55
|
*
|
|
63
56
|
* @category Utils
|
|
64
57
|
*/
|
|
65
|
-
function getOppositeRelationRole(role) {
|
|
58
|
+
export function getOppositeRelationRole(role) {
|
|
66
59
|
return role === "subject" ? "object" : "subject";
|
|
67
60
|
}
|
|
68
|
-
exports.getOppositeRelationRole = getOppositeRelationRole;
|
|
69
61
|
/**
|
|
70
62
|
* Checks if the given relation type is reversed.
|
|
71
63
|
*
|
|
@@ -78,10 +70,9 @@ exports.getOppositeRelationRole = getOppositeRelationRole;
|
|
|
78
70
|
*
|
|
79
71
|
* @category Utils
|
|
80
72
|
*/
|
|
81
|
-
const isRelationTypeReversed = (relationType) => {
|
|
73
|
+
export const isRelationTypeReversed = (relationType) => {
|
|
82
74
|
return relationType.startsWith(REVERSE_INDICATOR);
|
|
83
75
|
};
|
|
84
|
-
exports.isRelationTypeReversed = isRelationTypeReversed;
|
|
85
76
|
/**
|
|
86
77
|
* Gets the entity role in the given relation type by
|
|
87
78
|
* checking for the reverse indicator
|
|
@@ -95,10 +86,9 @@ exports.isRelationTypeReversed = isRelationTypeReversed;
|
|
|
95
86
|
*
|
|
96
87
|
* @category Utils
|
|
97
88
|
*/
|
|
98
|
-
const getRoleFromRelationType = (relationType) => {
|
|
99
|
-
return
|
|
89
|
+
export const getRoleFromRelationType = (relationType) => {
|
|
90
|
+
return isRelationTypeReversed(relationType) ? "object" : "subject";
|
|
100
91
|
};
|
|
101
|
-
exports.getRoleFromRelationType = getRoleFromRelationType;
|
|
102
92
|
/**
|
|
103
93
|
* Adds the reverse indicator from the relation type if it is not already present.
|
|
104
94
|
*
|
|
@@ -111,15 +101,14 @@ exports.getRoleFromRelationType = getRoleFromRelationType;
|
|
|
111
101
|
*
|
|
112
102
|
* @category Utils
|
|
113
103
|
*/
|
|
114
|
-
const getReverseRelationType = (relationType) => {
|
|
115
|
-
if (!
|
|
104
|
+
export const getReverseRelationType = (relationType) => {
|
|
105
|
+
if (!isRelationTypeReversed(relationType)) {
|
|
116
106
|
return `${REVERSE_INDICATOR}${relationType}`;
|
|
117
107
|
}
|
|
118
108
|
else {
|
|
119
109
|
return relationType;
|
|
120
110
|
}
|
|
121
111
|
};
|
|
122
|
-
exports.getReverseRelationType = getReverseRelationType;
|
|
123
112
|
/**
|
|
124
113
|
* Clears the reverse indicator from the relation type if it is present.
|
|
125
114
|
*
|
|
@@ -132,15 +121,14 @@ exports.getReverseRelationType = getReverseRelationType;
|
|
|
132
121
|
*
|
|
133
122
|
* @category Utils
|
|
134
123
|
*/
|
|
135
|
-
const getRawRelationType = (relationType) => {
|
|
136
|
-
if (
|
|
124
|
+
export const getRawRelationType = (relationType) => {
|
|
125
|
+
if (isRelationTypeReversed(relationType)) {
|
|
137
126
|
return relationType.replace(REVERSE_INDICATOR, "");
|
|
138
127
|
}
|
|
139
128
|
else {
|
|
140
129
|
return relationType;
|
|
141
130
|
}
|
|
142
131
|
};
|
|
143
|
-
exports.getRawRelationType = getRawRelationType;
|
|
144
132
|
/**
|
|
145
133
|
* Returns the relation type with the reverse indicator added if necessary.
|
|
146
134
|
*
|
|
@@ -154,12 +142,11 @@ exports.getRawRelationType = getRawRelationType;
|
|
|
154
142
|
*
|
|
155
143
|
* @category Utils
|
|
156
144
|
*/
|
|
157
|
-
const getRelationType = (relationType, role) => {
|
|
145
|
+
export const getRelationType = (relationType, role) => {
|
|
158
146
|
return role === "subject"
|
|
159
147
|
? relationType
|
|
160
|
-
:
|
|
148
|
+
: getReverseRelationType(relationType);
|
|
161
149
|
};
|
|
162
|
-
exports.getRelationType = getRelationType;
|
|
163
150
|
/**
|
|
164
151
|
* Finds the relation matching the provided source, relation typ and target
|
|
165
152
|
*
|
|
@@ -171,11 +158,11 @@ exports.getRelationType = getRelationType;
|
|
|
171
158
|
*
|
|
172
159
|
* @category Utils
|
|
173
160
|
*/
|
|
174
|
-
const getRelationDefinition = (entitySchema, sourceType, relationType, targetType) => {
|
|
175
|
-
const role =
|
|
161
|
+
export const getRelationDefinition = (entitySchema, sourceType, relationType, targetType) => {
|
|
162
|
+
const role = getRoleFromRelationType(relationType);
|
|
176
163
|
const match = entitySchema.matchRelationDefinitions({
|
|
177
164
|
[role]: sourceType,
|
|
178
|
-
type:
|
|
165
|
+
type: getRawRelationType(relationType),
|
|
179
166
|
[getOppositeRelationRole(role)]: targetType,
|
|
180
167
|
});
|
|
181
168
|
if (match.length > 0) {
|
|
@@ -183,8 +170,7 @@ const getRelationDefinition = (entitySchema, sourceType, relationType, targetTyp
|
|
|
183
170
|
}
|
|
184
171
|
return undefined;
|
|
185
172
|
};
|
|
186
|
-
|
|
187
|
-
function hasAttributeWithName(entitySchema, attributeNameSearched) {
|
|
173
|
+
export function hasAttributeWithName(entitySchema, attributeNameSearched) {
|
|
188
174
|
for (const entityAttribute of entitySchema.attributes) {
|
|
189
175
|
if (entityAttribute.type == attributeNameSearched) {
|
|
190
176
|
return true;
|
|
@@ -192,9 +178,7 @@ function hasAttributeWithName(entitySchema, attributeNameSearched) {
|
|
|
192
178
|
}
|
|
193
179
|
return false;
|
|
194
180
|
}
|
|
195
|
-
|
|
196
|
-
function isAttributeRichString(entitySchema, attributeNameSearched) {
|
|
181
|
+
export function isAttributeRichString(entitySchema, attributeNameSearched) {
|
|
197
182
|
return hasAttributeWithName(entitySchema, attributeNameSearched + "_format");
|
|
198
183
|
}
|
|
199
|
-
exports.isAttributeRichString = isAttributeRichString;
|
|
200
184
|
//# sourceMappingURL=Utils.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":"AASA,+DAA+D;AAC/D,kEAAkE;AAClE,+EAA+E;AAC/E,MAAM,iBAAiB,GAAG,UAAU,CAAC;AASrC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAI5B,MAAoB,EACpB,EAAE;IACF,OAAO,MAA2B,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,WAAwB;IAC5D,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,WAAwB,EAAW,EAAE;IACzE,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,WAAwB,EAAW,EAAE;IACzE,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAgB;IACtD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,YAAoB,EAAW,EAAE;IACtE,OAAO,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,YAAoB,EAAc,EAAE;IAC1E,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AACrE,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,YAAoB,EAAU,EAAE;IACrE,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACzC,OAAO,GAAG,iBAAiB,GAAG,YAAY,EAAE,CAAC;KAC9C;SAAM;QACL,OAAO,YAAY,CAAC;KACrB;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,YAAoB,EAAU,EAAE;IACjE,IAAI,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACxC,OAAO,YAAY,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;KACpD;SAAM;QACL,OAAO,YAAY,CAAC;KACrB;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,YAAoB,EAAE,IAAgB,EAAE,EAAE;IACxE,OAAO,IAAI,KAAK,SAAS;QACvB,CAAC,CAAC,YAAY;QACd,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,YAA0B,EAC1B,UAAkB,EAClB,YAAoB,EACpB,UAAkB,EAClB,EAAE;IACF,MAAM,IAAI,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,YAAY,CAAC,wBAAwB,CAAC;QAClD,CAAC,IAAI,CAAC,EAAE,UAAU;QAClB,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC;QACtC,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,UAAU;KAC5C,CAAC,CAAC;IACH,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACpB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAyBF,MAAM,UAAU,oBAAoB,CAClC,YAA0B,EAC1B,qBAA6B;IAE7B,KAAK,MAAM,eAAe,IAAI,YAAY,CAAC,UAAU,EAAE;QACrD,IAAI,eAAe,CAAC,IAAI,IAAI,qBAAqB,EAAE;YACjD,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,YAA0B,EAC1B,qBAA6B;IAE7B,OAAO,oBAAoB,CAAC,YAAY,EAAE,qBAAqB,GAAG,SAAS,CAAC,CAAC;AAC/E,CAAC"}
|
|
@@ -9,14 +9,23 @@ type ConstraintBase<T extends string, V extends Record<string, unknown> | null>
|
|
|
9
9
|
* The type of a constraint message when one is present.
|
|
10
10
|
*/
|
|
11
11
|
type ConstraintMessage = string | null;
|
|
12
|
+
/**
|
|
13
|
+
* A Unique constraint on an attribute.
|
|
14
|
+
*/
|
|
12
15
|
export type UniqueConstraint = ConstraintBase<"UniqueConstraint", {
|
|
13
16
|
msg: ConstraintMessage;
|
|
14
17
|
}>;
|
|
18
|
+
/**
|
|
19
|
+
* A constraint on the size of a string
|
|
20
|
+
*/
|
|
15
21
|
export type SizeConstraint = ConstraintBase<"SizeConstraint", {
|
|
16
22
|
min: number | null;
|
|
17
23
|
max: number | null;
|
|
18
24
|
msg: ConstraintMessage;
|
|
19
25
|
}>;
|
|
26
|
+
/**
|
|
27
|
+
* A Regexp constraint on a string
|
|
28
|
+
*/
|
|
20
29
|
export type RegexpConstraint = ConstraintBase<"RegexpConstraint", {
|
|
21
30
|
regexp: string;
|
|
22
31
|
flags: number;
|
|
@@ -69,28 +78,46 @@ export interface Now {
|
|
|
69
78
|
* @category Schema
|
|
70
79
|
*/
|
|
71
80
|
export type ConstraintOperator = ">" | ">=" | "<" | "<=";
|
|
81
|
+
/**
|
|
82
|
+
* A boundary constraint on a number attribute.
|
|
83
|
+
*/
|
|
72
84
|
export type BoundaryConstraint = ConstraintBase<"BoundaryConstraint", {
|
|
73
85
|
boundary: Attribute | Today | Now | number | string | null;
|
|
74
86
|
op: ConstraintOperator;
|
|
75
87
|
msg: ConstraintMessage;
|
|
76
88
|
}>;
|
|
89
|
+
/**
|
|
90
|
+
* An interval constraint on a number attribute.
|
|
91
|
+
*/
|
|
77
92
|
export type IntervalBoundConstraint = ConstraintBase<"IntervalBoundConstraint", {
|
|
78
93
|
minvalue: number | string | null;
|
|
79
94
|
maxvalue: number | string | null;
|
|
80
95
|
msg: ConstraintMessage;
|
|
81
96
|
}>;
|
|
97
|
+
/**
|
|
98
|
+
* A static vocabulary constraint on a string attribute.
|
|
99
|
+
*/
|
|
82
100
|
export type StaticVocabularyConstraint = ConstraintBase<"StaticVocabularyConstraint", {
|
|
83
101
|
values: string[];
|
|
84
102
|
msg: ConstraintMessage;
|
|
85
103
|
}>;
|
|
104
|
+
/**
|
|
105
|
+
* A format constraint on a string attribute.
|
|
106
|
+
*/
|
|
86
107
|
export type FormatConstraint = ConstraintBase<"FormatConstraint", {
|
|
87
108
|
values: ["text/rest", "text/markdown", "text/html", "text/plain"];
|
|
88
109
|
msg: ConstraintMessage;
|
|
89
110
|
}>;
|
|
111
|
+
/**
|
|
112
|
+
* A vocabulary constraint on a string attribute described by a RQL.
|
|
113
|
+
*/
|
|
90
114
|
export type RQLVocabularyConstraint = ConstraintBase<"RQLVocabularyConstraint", {
|
|
91
115
|
expression: string;
|
|
92
116
|
mainvars: string[];
|
|
93
117
|
}>;
|
|
118
|
+
/**
|
|
119
|
+
* A constraint on an attribute described by a RQL.
|
|
120
|
+
*/
|
|
94
121
|
export type RQLConstraint = ConstraintBase<"RQLConstraint", {
|
|
95
122
|
expression: string;
|
|
96
123
|
mainvars: string[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Constraints.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Constraints.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,KAAK,cAAc,CACjB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,IACtC;IACF,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;GAEG;AACH,KAAK,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IAAE,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,cAAc,CACzC,gBAAgB,EAChB;IAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CACnE,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,UAAU,GAAG,YAAY,GAAG,MAAM,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,IAAI,CAAC;IACd,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;AAEzD,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAC7C,oBAAoB,EACpB;IACE,QAAQ,EAAE,SAAS,GAAG,KAAK,GAAG,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC3D,EAAE,EAAE,kBAAkB,CAAC;IACvB,GAAG,EAAE,iBAAiB,CAAC;CACxB,CACF,CAAC;
|
|
1
|
+
{"version":3,"file":"Constraints.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Constraints.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,KAAK,cAAc,CACjB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,IACtC;IACF,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;GAEG;AACH,KAAK,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IAAE,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,cAAc,CACzC,gBAAgB,EAChB;IAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CACnE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,UAAU,GAAG,YAAY,GAAG,MAAM,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,IAAI,CAAC;IACd,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAC7C,oBAAoB,EACpB;IACE,QAAQ,EAAE,SAAS,GAAG,KAAK,GAAG,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC3D,EAAE,EAAE,kBAAkB,CAAC;IACvB,GAAG,EAAE,iBAAiB,CAAC;CACxB,CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAClD,yBAAyB,EACzB;IACE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,GAAG,EAAE,iBAAiB,CAAC;CACxB,CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,cAAc,CACrD,4BAA4B,EAC5B;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IACE,MAAM,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAClE,GAAG,EAAE,iBAAiB,CAAC;CACxB,CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAClD,yBAAyB,EACzB;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,CACxC,eAAe,EACf;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CACnE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CACtC,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,gBAAgB,GAChB,aAAa,CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CACvC,uBAAuB,GAAG,aAAa,CACxC,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EntityRole } from "../classes/Utils";
|
|
2
|
-
import { AttributeConstraint, RelationConstraint } from "./Constraints";
|
|
3
|
-
import { EntityRawSchema, EntityRawSchemaArray } from "./Entities";
|
|
1
|
+
import { EntityRole } from "../classes/Utils.js";
|
|
2
|
+
import { AttributeConstraint, RelationConstraint } from "./Constraints.js";
|
|
3
|
+
import { EntityRawSchema, EntityRawSchemaArray } from "./Entities.js";
|
|
4
4
|
/**
|
|
5
5
|
* Type representing all the possible cardinalities in CubicWeb.
|
|
6
6
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelationDefinitions.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/RelationDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"RelationDefinitions.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/RelationDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAE7D;;;;GAIG;AACH,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI;IACpC,MAAM,EAAE,CAAC,CAAC;IACV,KAAK,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,UAAU,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IACzD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,aAAc,SAAQ,YAAY,CAAC,OAAO,CAAC;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,WAAY,SAAQ,YAAY,CAAC,KAAK,CAAC;IAC/C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,aAAc,SAAQ,YAAY,CAAC,OAAO,CAAC;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,eAAgB,SAAQ,YAAY,CAAC,SAAS,CAAC;IACvD,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,eAAgB,SAAQ,YAAY,CAAC,SAAS,CAAC;IACvD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,YAAa,SAAQ,YAAY,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,YAAa,SAAQ,YAAY,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IACzD,OAAO,EAAE,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CACxC;AAED,UAAU,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,kBAAmB,SAAQ,YAAY,CAAC,YAAY,CAAC;IAC7D,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IACzD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,cAAc,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;IAChE,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAC3B,cAAc,GACd,gBAAgB,GAChB,aAAa,GACb,WAAW,GACX,cAAc,GACd,aAAa,GACb,eAAe,GACf,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,CAAC,MAAM,CAAC,CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,UAAU,CAAC;IAChC,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,2BAA2B,CACrC,QAAQ,SAAS,oBAAoB,EACrC,KAAK,SAAS,OAAO,GAAG,OAAO,IAC7B,QAAQ,CACV;IACE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,eAAe,CAAC;IAC7B,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;CACnC,GAAG,CAAC,KAAK,SAAS,IAAI,GACnB,QAAQ,GAAG;IACT,KAAK,EAAE,IAAI,CAAC;IACZ,WAAW,EAAE,mBAAmB,EAAE,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC;CAC3B,GACD;IACE,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC,CACP,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,CAC1C,QAAQ,SAAS,oBAAoB,IACnC,aAAa,CAAC,2BAA2B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { EntityRawSchemaArray } from "./Entities";
|
|
2
|
-
import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions";
|
|
1
|
+
import { EntityRawSchemaArray } from "./Entities.js";
|
|
2
|
+
import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions.js";
|
|
3
3
|
/**
|
|
4
4
|
* The full raw JSON schema type as returned by the API.
|
|
5
5
|
* You can export this schema from your CubicWeb instance using the command:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AAE5E;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EACrD,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,IACjF;IACF,QAAQ,EAAE,CAAC,CAAC;IACZ,qBAAqB,EAAE,CAAC,CAAC;CAC1B,CAAC"}
|
package/lib/schema/raw/Schema.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,oBAAoB,IACtD,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,EAC9B,KAAK,SAAS,MAAM,IAClB,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,MAAM,IACd,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,OAAO,GAC/B,OAAO,SAAS;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GACzB,OAAO,GACP,KAAK,GACP,KAAK,CAAC"}
|
package/lib/schema/raw/Utils.js
CHANGED
package/lib/utils.d.ts
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { RQLQueryParams, RQLQueryParamValue } from "./api/Api";
|
|
2
|
+
import { RQLBinary } from "./api/binary/RQLBinary";
|
|
3
|
+
import { RQLQuery } from "./api/query/RQLQuery";
|
|
4
|
+
import { Transaction } from "./api/transaction/Transaction";
|
|
5
|
+
type SerializedRQLParams = Record<string, RQLQueryParamValue | SerializedRqlQueryCellRef | SerializedRqlQueryBinaryRef>;
|
|
6
|
+
interface SerializedRqlQueryCellRef {
|
|
7
|
+
readonly queryIndex: number;
|
|
8
|
+
readonly row: number;
|
|
9
|
+
readonly column: number;
|
|
10
|
+
readonly type: "query_reference";
|
|
11
|
+
}
|
|
12
|
+
interface SerializedRqlQueryBinaryRef {
|
|
13
|
+
readonly ref: string;
|
|
14
|
+
readonly type: "binary_reference";
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Retrieves the query index in the given transaction from its eid
|
|
18
|
+
*
|
|
19
|
+
* @param transaction The transaction to search the query in
|
|
20
|
+
* @param queryUUID The UUID of the query to find
|
|
21
|
+
* @returns The query index in the transaction if found
|
|
22
|
+
* @throws When no query with the given UUID is found
|
|
23
|
+
*
|
|
24
|
+
* @internal
|
|
25
|
+
*/
|
|
26
|
+
export declare function getQueryIndexInTransaction(transaction: Transaction, queryUUID: string): number;
|
|
27
|
+
/**
|
|
28
|
+
* Serializes the user parameters to the format understood by the API
|
|
29
|
+
*
|
|
30
|
+
* @param params The params passed by the user
|
|
31
|
+
* @returns A serialized version of the parameters as understood by the API
|
|
32
|
+
*
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
export declare function serializeQueryParams(transaction: Transaction, params: RQLQueryParams): SerializedRQLParams;
|
|
36
|
+
export declare function getBinariesFromTransaction(transaction: Transaction): RQLBinary[];
|
|
37
|
+
export declare function getBinariesFromRQLQuery(query: RQLQuery): RQLBinary[];
|
|
38
|
+
export {};
|
|
39
|
+
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAE5D,KAAK,mBAAmB,GAAG,MAAM,CAC/B,MAAM,EACN,kBAAkB,GAAG,yBAAyB,GAAG,2BAA2B,CAC7E,CAAC;AAEF,UAAU,yBAAyB;IACjC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;CAClC;AAED,UAAU,2BAA2B;IACnC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;CACnC;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,MAAM,UASlB;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,cAAc,uBAsBvB;AAED,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,WAAW,GACvB,SAAS,EAAE,CAEb;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,EAAE,CAIpE"}
|
package/lib/utils.js
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { RQLBinary } from "./api/binary/RQLBinary";
|
|
2
|
+
import { RQLQueryCellRef } from "./api/query/references";
|
|
3
|
+
/**
|
|
4
|
+
* Retrieves the query index in the given transaction from its eid
|
|
5
|
+
*
|
|
6
|
+
* @param transaction The transaction to search the query in
|
|
7
|
+
* @param queryUUID The UUID of the query to find
|
|
8
|
+
* @returns The query index in the transaction if found
|
|
9
|
+
* @throws When no query with the given UUID is found
|
|
10
|
+
*
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
export function getQueryIndexInTransaction(transaction, queryUUID) {
|
|
14
|
+
const index = transaction.queries.findIndex((q) => q.queryUUID === queryUUID);
|
|
15
|
+
if (index < 0) {
|
|
16
|
+
throw new Error(`Cannot find query of id '${queryUUID}' in the transaction`);
|
|
17
|
+
}
|
|
18
|
+
return index;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Serializes the user parameters to the format understood by the API
|
|
22
|
+
*
|
|
23
|
+
* @param params The params passed by the user
|
|
24
|
+
* @returns A serialized version of the parameters as understood by the API
|
|
25
|
+
*
|
|
26
|
+
* @internal
|
|
27
|
+
*/
|
|
28
|
+
export function serializeQueryParams(transaction, params) {
|
|
29
|
+
const newParams = {};
|
|
30
|
+
Object.entries(params).forEach(([k, v]) => {
|
|
31
|
+
if (v instanceof RQLQueryCellRef) {
|
|
32
|
+
const queryIndex = getQueryIndexInTransaction(transaction, v.queryUUID);
|
|
33
|
+
newParams[k] = {
|
|
34
|
+
queryIndex,
|
|
35
|
+
column: v.column,
|
|
36
|
+
row: v.row,
|
|
37
|
+
type: "query_reference",
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
else if (v instanceof RQLBinary) {
|
|
41
|
+
newParams[k] = {
|
|
42
|
+
ref: v.uuid,
|
|
43
|
+
type: "binary_reference",
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
else {
|
|
47
|
+
newParams[k] = k;
|
|
48
|
+
}
|
|
49
|
+
});
|
|
50
|
+
return newParams;
|
|
51
|
+
}
|
|
52
|
+
export function getBinariesFromTransaction(transaction) {
|
|
53
|
+
return transaction.queries.flatMap(getBinariesFromRQLQuery);
|
|
54
|
+
}
|
|
55
|
+
export function getBinariesFromRQLQuery(query) {
|
|
56
|
+
return Object.values(query.params).filter((p) => p instanceof RQLBinary);
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=utils.js.map
|
package/lib/utils.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAoBzD;;;;;;;;;GASG;AACH,MAAM,UAAU,0BAA0B,CACxC,WAAwB,EACxB,SAAiB;IAEjB,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;IAC9E,IAAI,KAAK,GAAG,CAAC,EAAE;QACb,MAAM,IAAI,KAAK,CACb,4BAA4B,SAAS,sBAAsB,CAC5D,CAAC;KACH;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,WAAwB,EACxB,MAAsB;IAEtB,MAAM,SAAS,GAAwB,EAAE,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,YAAY,eAAe,EAAE;YAChC,MAAM,UAAU,GAAG,0BAA0B,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;YACxE,SAAS,CAAC,CAAC,CAAC,GAAG;gBACb,UAAU;gBACV,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,GAAG,EAAE,CAAC,CAAC,GAAG;gBACV,IAAI,EAAE,iBAAiB;aACK,CAAC;SAChC;aAAM,IAAI,CAAC,YAAY,SAAS,EAAE;YACjC,SAAS,CAAC,CAAC,CAAC,GAAG;gBACb,GAAG,EAAE,CAAC,CAAC,IAAI;gBACX,IAAI,EAAE,kBAAkB;aACM,CAAC;SAClC;aAAM;YACL,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SAClB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,WAAwB;IAExB,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAe;IACrD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CACvC,CAAC,CAAC,EAAkB,EAAE,CAAC,CAAC,YAAY,SAAS,CAC9C,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -2,12 +2,10 @@
|
|
|
2
2
|
"name": "@cubicweb/client",
|
|
3
3
|
"description": "Official JS client for CubicWeb API",
|
|
4
4
|
"author": "Logilab",
|
|
5
|
-
"version": "3.0.0-alpha.
|
|
5
|
+
"version": "3.0.0-alpha.12",
|
|
6
6
|
"license": "LGPL-3.0-or-later",
|
|
7
|
-
"main": "lib/index.js",
|
|
8
|
-
"types": "lib/index.d.ts",
|
|
9
7
|
"scripts": {
|
|
10
|
-
"build": "run -T tsc
|
|
8
|
+
"build": "run -T tsc --project tsconfig.build.json",
|
|
11
9
|
"docs": "run -T typedoc"
|
|
12
10
|
},
|
|
13
11
|
"repository": {
|
|
@@ -23,5 +21,14 @@
|
|
|
23
21
|
"lib/**",
|
|
24
22
|
"src/**",
|
|
25
23
|
"!**/__tests__/**"
|
|
26
|
-
]
|
|
24
|
+
],
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"uuid": "^9.0.1"
|
|
27
|
+
},
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"@types/uuid": "^9.0.8"
|
|
30
|
+
},
|
|
31
|
+
"type": "module",
|
|
32
|
+
"exports": "./lib/index.js",
|
|
33
|
+
"types": "./lib/index.d.ts"
|
|
27
34
|
}
|