@proofkit/fmodata 0.1.0-alpha.2 → 0.1.0-alpha.20
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 +1250 -377
- package/dist/esm/client/batch-builder.d.ts +56 -0
- package/dist/esm/client/batch-builder.js +238 -0
- package/dist/esm/client/batch-builder.js.map +1 -0
- package/dist/esm/client/batch-request.d.ts +61 -0
- package/dist/esm/client/batch-request.js +252 -0
- package/dist/esm/client/batch-request.js.map +1 -0
- package/dist/esm/client/builders/default-select.d.ts +10 -0
- package/dist/esm/client/builders/default-select.js +43 -0
- package/dist/esm/client/builders/default-select.js.map +1 -0
- package/dist/esm/client/builders/expand-builder.d.ts +45 -0
- package/dist/esm/client/builders/expand-builder.js +174 -0
- package/dist/esm/client/builders/expand-builder.js.map +1 -0
- package/dist/esm/client/builders/index.d.ts +8 -0
- package/dist/esm/client/builders/query-string-builder.d.ts +18 -0
- package/dist/esm/client/builders/query-string-builder.js +25 -0
- package/dist/esm/client/builders/query-string-builder.js.map +1 -0
- package/dist/esm/client/builders/response-processor.d.ts +43 -0
- package/dist/esm/client/builders/response-processor.js +176 -0
- package/dist/esm/client/builders/response-processor.js.map +1 -0
- package/dist/esm/client/builders/select-mixin.d.ts +32 -0
- package/dist/esm/client/builders/select-mixin.js +30 -0
- package/dist/esm/client/builders/select-mixin.js.map +1 -0
- package/dist/esm/client/builders/select-utils.d.ts +18 -0
- package/dist/esm/client/builders/select-utils.js +23 -0
- package/dist/esm/client/builders/select-utils.js.map +1 -0
- package/dist/esm/client/builders/shared-types.d.ts +40 -0
- package/dist/esm/client/builders/table-utils.d.ts +35 -0
- package/dist/esm/client/builders/table-utils.js +45 -0
- package/dist/esm/client/builders/table-utils.js.map +1 -0
- package/dist/esm/client/database.d.ts +68 -15
- package/dist/esm/client/database.js +88 -34
- package/dist/esm/client/database.js.map +1 -1
- package/dist/esm/client/delete-builder.d.ts +31 -17
- package/dist/esm/client/delete-builder.js +114 -47
- package/dist/esm/client/delete-builder.js.map +1 -1
- package/dist/esm/client/entity-set.d.ts +33 -27
- package/dist/esm/client/entity-set.js +123 -45
- package/dist/esm/client/entity-set.js.map +1 -1
- package/dist/esm/client/error-parser.d.ts +12 -0
- package/dist/esm/client/error-parser.js +30 -0
- package/dist/esm/client/error-parser.js.map +1 -0
- package/dist/esm/client/filemaker-odata.d.ts +44 -6
- package/dist/esm/client/filemaker-odata.js +172 -28
- package/dist/esm/client/filemaker-odata.js.map +1 -1
- package/dist/esm/client/insert-builder.d.ts +39 -9
- package/dist/esm/client/insert-builder.js +265 -36
- package/dist/esm/client/insert-builder.js.map +1 -1
- package/dist/esm/client/query/expand-builder.d.ts +35 -0
- package/dist/esm/client/query/index.d.ts +3 -0
- package/dist/esm/client/query/query-builder.d.ts +139 -0
- package/dist/esm/client/query/query-builder.js +481 -0
- package/dist/esm/client/query/query-builder.js.map +1 -0
- package/dist/esm/client/query/response-processor.d.ts +25 -0
- package/dist/esm/client/query/types.d.ts +77 -0
- package/dist/esm/client/query/url-builder.d.ts +71 -0
- package/dist/esm/client/query/url-builder.js +107 -0
- package/dist/esm/client/query/url-builder.js.map +1 -0
- package/dist/esm/client/query-builder.d.ts +1 -94
- package/dist/esm/client/record-builder.d.ts +107 -22
- package/dist/esm/client/record-builder.js +342 -64
- package/dist/esm/client/record-builder.js.map +1 -1
- package/dist/esm/client/response-processor.d.ts +33 -0
- package/dist/esm/client/sanitize-json.d.ts +35 -0
- package/dist/esm/client/sanitize-json.js +27 -0
- package/dist/esm/client/sanitize-json.js.map +1 -0
- package/dist/esm/client/schema-manager.d.ts +57 -0
- package/dist/esm/client/schema-manager.js +132 -0
- package/dist/esm/client/schema-manager.js.map +1 -0
- package/dist/esm/client/update-builder.d.ts +42 -25
- package/dist/esm/client/update-builder.js +179 -46
- package/dist/esm/client/update-builder.js.map +1 -1
- package/dist/esm/client/webhook-builder.d.ts +126 -0
- package/dist/esm/client/webhook-builder.js +197 -0
- package/dist/esm/client/webhook-builder.js.map +1 -0
- package/dist/esm/errors.d.ts +90 -0
- package/dist/esm/errors.js +180 -0
- package/dist/esm/errors.js.map +1 -0
- package/dist/esm/index.d.ts +12 -4
- package/dist/esm/index.js +59 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/logger.d.ts +47 -0
- package/dist/esm/logger.js +72 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/logger.test.d.ts +1 -0
- package/dist/esm/orm/column.d.ts +62 -0
- package/dist/esm/orm/column.js +62 -0
- package/dist/esm/orm/column.js.map +1 -0
- package/dist/esm/orm/field-builders.d.ts +164 -0
- package/dist/esm/orm/field-builders.js +168 -0
- package/dist/esm/orm/field-builders.js.map +1 -0
- package/dist/esm/orm/index.d.ts +4 -0
- package/dist/esm/orm/operators.d.ts +175 -0
- package/dist/esm/orm/operators.js +242 -0
- package/dist/esm/orm/operators.js.map +1 -0
- package/dist/esm/orm/table.d.ts +355 -0
- package/dist/esm/orm/table.js +200 -0
- package/dist/esm/orm/table.js.map +1 -0
- package/dist/esm/transform.d.ts +64 -0
- package/dist/esm/transform.js +110 -0
- package/dist/esm/transform.js.map +1 -0
- package/dist/esm/types.d.ts +157 -7
- package/dist/esm/types.js +7 -0
- package/dist/esm/types.js.map +1 -0
- package/dist/esm/validation.d.ts +22 -9
- package/dist/esm/validation.js +195 -50
- package/dist/esm/validation.js.map +1 -1
- package/package.json +19 -4
- package/src/client/batch-builder.ts +334 -0
- package/src/client/batch-request.ts +485 -0
- package/src/client/builders/default-select.ts +80 -0
- package/src/client/builders/expand-builder.ts +245 -0
- package/src/client/builders/index.ts +11 -0
- package/src/client/builders/query-string-builder.ts +49 -0
- package/src/client/builders/response-processor.ts +286 -0
- package/src/client/builders/select-mixin.ts +75 -0
- package/src/client/builders/select-utils.ts +56 -0
- package/src/client/builders/shared-types.ts +42 -0
- package/src/client/builders/table-utils.ts +87 -0
- package/src/client/database.ts +147 -89
- package/src/client/delete-builder.ts +189 -87
- package/src/client/entity-set.ts +316 -205
- package/src/client/error-parser.ts +59 -0
- package/src/client/filemaker-odata.ts +254 -41
- package/src/client/insert-builder.ts +420 -49
- package/src/client/query/expand-builder.ts +164 -0
- package/src/client/query/index.ts +13 -0
- package/src/client/query/query-builder.ts +905 -0
- package/src/client/query/response-processor.ts +236 -0
- package/src/client/query/types.ts +128 -0
- package/src/client/query/url-builder.ts +179 -0
- package/src/client/query-builder.ts +8 -1076
- package/src/client/record-builder.ts +704 -139
- package/src/client/response-processor.ts +89 -0
- package/src/client/sanitize-json.ts +66 -0
- package/src/client/schema-manager.ts +246 -0
- package/src/client/update-builder.ts +318 -90
- package/src/client/webhook-builder.ts +285 -0
- package/src/errors.ts +261 -0
- package/src/index.ts +122 -14
- package/src/logger.test.ts +34 -0
- package/src/logger.ts +140 -0
- package/src/orm/column.ts +106 -0
- package/src/orm/field-builders.ts +318 -0
- package/src/orm/index.ts +60 -0
- package/src/orm/operators.ts +487 -0
- package/src/orm/table.ts +759 -0
- package/src/transform.ts +263 -0
- package/src/types.ts +275 -55
- package/src/validation.ts +255 -55
- package/dist/esm/client/base-table.d.ts +0 -13
- package/dist/esm/client/base-table.js +0 -19
- package/dist/esm/client/base-table.js.map +0 -1
- package/dist/esm/client/query-builder.js +0 -649
- package/dist/esm/client/query-builder.js.map +0 -1
- package/dist/esm/client/table-occurrence.d.ts +0 -25
- package/dist/esm/client/table-occurrence.js +0 -47
- package/dist/esm/client/table-occurrence.js.map +0 -1
- package/dist/esm/filter-types.d.ts +0 -76
- package/src/client/base-table.ts +0 -25
- package/src/client/table-occurrence.ts +0 -100
- package/src/filter-types.ts +0 -97
|
@@ -1,67 +1,296 @@
|
|
|
1
1
|
var __defProp = Object.defineProperty;
|
|
2
2
|
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
3
3
|
var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
4
|
-
import {
|
|
4
|
+
import { getAcceptHeader } from "../types.js";
|
|
5
|
+
import { isUsingEntityIds, getTableName, getTableId, getBaseTableConfig } from "../orm/table.js";
|
|
6
|
+
import { validateAndTransformInput, validateSingleResponse } from "../validation.js";
|
|
7
|
+
import { transformFieldNamesToIds, transformResponseFields } from "../transform.js";
|
|
8
|
+
import { InvalidLocationHeaderError } from "../errors.js";
|
|
9
|
+
import { safeJsonParse } from "./sanitize-json.js";
|
|
10
|
+
import { parseErrorResponse } from "./error-parser.js";
|
|
5
11
|
class InsertBuilder {
|
|
6
12
|
constructor(config) {
|
|
7
|
-
__publicField(this, "
|
|
8
|
-
__publicField(this, "tableName");
|
|
13
|
+
__publicField(this, "table");
|
|
9
14
|
__publicField(this, "databaseName");
|
|
10
15
|
__publicField(this, "context");
|
|
11
16
|
__publicField(this, "data");
|
|
12
|
-
this
|
|
13
|
-
this
|
|
17
|
+
__publicField(this, "returnPreference");
|
|
18
|
+
__publicField(this, "databaseUseEntityIds");
|
|
19
|
+
__publicField(this, "databaseIncludeSpecialColumns");
|
|
20
|
+
this.table = config.occurrence;
|
|
14
21
|
this.databaseName = config.databaseName;
|
|
15
22
|
this.context = config.context;
|
|
16
23
|
this.data = config.data;
|
|
24
|
+
this.returnPreference = config.returnPreference || "representation";
|
|
25
|
+
this.databaseUseEntityIds = config.databaseUseEntityIds ?? false;
|
|
26
|
+
this.databaseIncludeSpecialColumns = config.databaseIncludeSpecialColumns ?? false;
|
|
17
27
|
}
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
// No expand configs
|
|
38
|
-
"exact"
|
|
39
|
-
// Expect exactly one record
|
|
28
|
+
/**
|
|
29
|
+
* Helper to merge database-level useEntityIds with per-request options
|
|
30
|
+
*/
|
|
31
|
+
mergeExecuteOptions(options) {
|
|
32
|
+
return {
|
|
33
|
+
...options,
|
|
34
|
+
useEntityIds: (options == null ? void 0 : options.useEntityIds) ?? this.databaseUseEntityIds
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Parse ROWID from Location header
|
|
39
|
+
* Expected formats:
|
|
40
|
+
* - contacts(ROWID=4583)
|
|
41
|
+
* - contacts('some-uuid')
|
|
42
|
+
*/
|
|
43
|
+
parseLocationHeader(locationHeader) {
|
|
44
|
+
if (!locationHeader) {
|
|
45
|
+
throw new InvalidLocationHeaderError(
|
|
46
|
+
"Location header is required but was not provided"
|
|
40
47
|
);
|
|
41
|
-
|
|
42
|
-
|
|
48
|
+
}
|
|
49
|
+
const rowidMatch = locationHeader.match(/ROWID=(\d+)/);
|
|
50
|
+
if (rowidMatch && rowidMatch[1]) {
|
|
51
|
+
return parseInt(rowidMatch[1], 10);
|
|
52
|
+
}
|
|
53
|
+
const parenMatch = locationHeader.match(/\(['"]?([^'"]+)['"]?\)/);
|
|
54
|
+
if (parenMatch && parenMatch[1]) {
|
|
55
|
+
const value = parenMatch[1];
|
|
56
|
+
const numValue = parseInt(value, 10);
|
|
57
|
+
if (!isNaN(numValue)) {
|
|
58
|
+
return numValue;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
throw new InvalidLocationHeaderError(
|
|
62
|
+
`Could not extract ROWID from Location header: ${locationHeader}`,
|
|
63
|
+
locationHeader
|
|
64
|
+
);
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Gets the table ID (FMTID) if using entity IDs, otherwise returns the table name
|
|
68
|
+
* @param useEntityIds - Optional override for entity ID usage
|
|
69
|
+
*/
|
|
70
|
+
getTableId(useEntityIds) {
|
|
71
|
+
var _a, _b;
|
|
72
|
+
if (!this.table) {
|
|
73
|
+
throw new Error("Table occurrence is required");
|
|
74
|
+
}
|
|
75
|
+
const contextDefault = ((_b = (_a = this.context)._getUseEntityIds) == null ? void 0 : _b.call(_a)) ?? false;
|
|
76
|
+
const shouldUseIds = useEntityIds ?? contextDefault;
|
|
77
|
+
if (shouldUseIds) {
|
|
78
|
+
if (!isUsingEntityIds(this.table)) {
|
|
79
|
+
throw new Error(
|
|
80
|
+
`useEntityIds is true but table "${getTableName(this.table)}" does not have entity IDs configured`
|
|
81
|
+
);
|
|
43
82
|
}
|
|
44
|
-
|
|
83
|
+
return getTableId(this.table);
|
|
84
|
+
}
|
|
85
|
+
return getTableName(this.table);
|
|
86
|
+
}
|
|
87
|
+
async execute(options) {
|
|
88
|
+
const mergedOptions = this.mergeExecuteOptions(options);
|
|
89
|
+
const tableId = this.getTableId(mergedOptions.useEntityIds);
|
|
90
|
+
const url = `/${this.databaseName}/${tableId}`;
|
|
91
|
+
let validatedData = this.data;
|
|
92
|
+
if (this.table) {
|
|
93
|
+
const baseTableConfig = getBaseTableConfig(this.table);
|
|
94
|
+
const inputSchema = baseTableConfig.inputSchema;
|
|
95
|
+
try {
|
|
96
|
+
validatedData = await validateAndTransformInput(this.data, inputSchema);
|
|
97
|
+
} catch (error) {
|
|
45
98
|
return {
|
|
46
99
|
data: void 0,
|
|
47
|
-
error:
|
|
100
|
+
error: error instanceof Error ? error : new Error(String(error))
|
|
48
101
|
};
|
|
49
102
|
}
|
|
50
|
-
|
|
51
|
-
|
|
103
|
+
}
|
|
104
|
+
const shouldUseIds = mergedOptions.useEntityIds ?? false;
|
|
105
|
+
const transformedData = this.table && shouldUseIds ? transformFieldNamesToIds(validatedData, this.table) : validatedData;
|
|
106
|
+
const preferHeader = this.returnPreference === "minimal" ? "return=minimal" : "return=representation";
|
|
107
|
+
const result = await this.context._makeRequest(url, {
|
|
108
|
+
method: "POST",
|
|
109
|
+
headers: {
|
|
110
|
+
"Content-Type": "application/json",
|
|
111
|
+
Prefer: preferHeader,
|
|
112
|
+
...(mergedOptions == null ? void 0 : mergedOptions.headers) || {}
|
|
113
|
+
},
|
|
114
|
+
body: JSON.stringify(transformedData),
|
|
115
|
+
...mergedOptions
|
|
116
|
+
});
|
|
117
|
+
if (result.error) {
|
|
118
|
+
return { data: void 0, error: result.error };
|
|
119
|
+
}
|
|
120
|
+
if (this.returnPreference === "minimal") {
|
|
121
|
+
const responseData = result.data;
|
|
122
|
+
if (!responseData || !responseData._location) {
|
|
123
|
+
throw new InvalidLocationHeaderError(
|
|
124
|
+
"Location header is required when using return=minimal but was not found in response"
|
|
125
|
+
);
|
|
126
|
+
}
|
|
127
|
+
const rowid = this.parseLocationHeader(responseData._location);
|
|
128
|
+
return { data: { ROWID: rowid }, error: void 0 };
|
|
129
|
+
}
|
|
130
|
+
let response = result.data;
|
|
131
|
+
if (this.table && shouldUseIds) {
|
|
132
|
+
response = transformResponseFields(
|
|
133
|
+
response,
|
|
134
|
+
this.table,
|
|
135
|
+
void 0
|
|
136
|
+
// No expand configs for insert
|
|
137
|
+
);
|
|
138
|
+
}
|
|
139
|
+
let schema;
|
|
140
|
+
if (this.table) {
|
|
141
|
+
const baseTableConfig = getBaseTableConfig(this.table);
|
|
142
|
+
const containerFields = baseTableConfig.containerFields || [];
|
|
143
|
+
schema = { ...baseTableConfig.schema };
|
|
144
|
+
for (const containerField of containerFields) {
|
|
145
|
+
delete schema[containerField];
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
const validation = await validateSingleResponse(
|
|
149
|
+
response,
|
|
150
|
+
schema,
|
|
151
|
+
void 0,
|
|
152
|
+
// No selected fields for insert
|
|
153
|
+
void 0,
|
|
154
|
+
// No expand configs
|
|
155
|
+
"exact"
|
|
156
|
+
// Expect exactly one record
|
|
157
|
+
);
|
|
158
|
+
if (!validation.valid) {
|
|
159
|
+
return { data: void 0, error: validation.error };
|
|
160
|
+
}
|
|
161
|
+
if (validation.data === null) {
|
|
52
162
|
return {
|
|
53
163
|
data: void 0,
|
|
54
|
-
error:
|
|
164
|
+
error: new Error("Insert operation returned null response")
|
|
55
165
|
};
|
|
56
166
|
}
|
|
167
|
+
return { data: validation.data, error: void 0 };
|
|
57
168
|
}
|
|
58
169
|
getRequestConfig() {
|
|
170
|
+
const tableId = this.getTableId(this.databaseUseEntityIds);
|
|
171
|
+
const transformedData = this.table && this.databaseUseEntityIds ? transformFieldNamesToIds(this.data, this.table) : this.data;
|
|
59
172
|
return {
|
|
60
173
|
method: "POST",
|
|
61
|
-
url: `/${this.databaseName}/${
|
|
62
|
-
body: JSON.stringify(
|
|
174
|
+
url: `/${this.databaseName}/${tableId}`,
|
|
175
|
+
body: JSON.stringify(transformedData)
|
|
63
176
|
};
|
|
64
177
|
}
|
|
178
|
+
toRequest(baseUrl, options) {
|
|
179
|
+
const config = this.getRequestConfig();
|
|
180
|
+
const fullUrl = `${baseUrl}${config.url}`;
|
|
181
|
+
const preferHeader = this.returnPreference === "minimal" ? "return=minimal" : "return=representation";
|
|
182
|
+
return new Request(fullUrl, {
|
|
183
|
+
method: config.method,
|
|
184
|
+
headers: {
|
|
185
|
+
"Content-Type": "application/json",
|
|
186
|
+
Accept: getAcceptHeader(options == null ? void 0 : options.includeODataAnnotations),
|
|
187
|
+
Prefer: preferHeader
|
|
188
|
+
},
|
|
189
|
+
body: config.body
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
async processResponse(response, options) {
|
|
193
|
+
if (!response.ok) {
|
|
194
|
+
const tableName = this.table ? getTableName(this.table) : "unknown";
|
|
195
|
+
const error = await parseErrorResponse(
|
|
196
|
+
response,
|
|
197
|
+
response.url || `/${this.databaseName}/${tableName}`
|
|
198
|
+
);
|
|
199
|
+
return { data: void 0, error };
|
|
200
|
+
}
|
|
201
|
+
if (response.status === 204) {
|
|
202
|
+
if (this.returnPreference === "minimal") {
|
|
203
|
+
const locationHeader = response.headers.get("Location") || response.headers.get("location");
|
|
204
|
+
if (locationHeader) {
|
|
205
|
+
const rowid = this.parseLocationHeader(locationHeader);
|
|
206
|
+
return { data: { ROWID: rowid }, error: void 0 };
|
|
207
|
+
}
|
|
208
|
+
throw new InvalidLocationHeaderError(
|
|
209
|
+
"Location header is required when using return=minimal but was not found in response"
|
|
210
|
+
);
|
|
211
|
+
}
|
|
212
|
+
return {
|
|
213
|
+
data: {},
|
|
214
|
+
error: void 0
|
|
215
|
+
};
|
|
216
|
+
}
|
|
217
|
+
if (this.returnPreference === "minimal") {
|
|
218
|
+
throw new InvalidLocationHeaderError(
|
|
219
|
+
"Expected 204 No Content for return=minimal, but received response with body"
|
|
220
|
+
);
|
|
221
|
+
}
|
|
222
|
+
let rawResponse;
|
|
223
|
+
try {
|
|
224
|
+
rawResponse = await safeJsonParse(response);
|
|
225
|
+
} catch (err) {
|
|
226
|
+
if (response.status === 204) {
|
|
227
|
+
return {
|
|
228
|
+
data: {},
|
|
229
|
+
error: void 0
|
|
230
|
+
};
|
|
231
|
+
}
|
|
232
|
+
return {
|
|
233
|
+
data: void 0,
|
|
234
|
+
error: {
|
|
235
|
+
name: "ResponseParseError",
|
|
236
|
+
message: `Failed to parse response JSON: ${err instanceof Error ? err.message : "Unknown error"}`,
|
|
237
|
+
timestamp: /* @__PURE__ */ new Date()
|
|
238
|
+
}
|
|
239
|
+
};
|
|
240
|
+
}
|
|
241
|
+
let validatedData = this.data;
|
|
242
|
+
if (this.table) {
|
|
243
|
+
const baseTableConfig = getBaseTableConfig(this.table);
|
|
244
|
+
const inputSchema = baseTableConfig.inputSchema;
|
|
245
|
+
try {
|
|
246
|
+
validatedData = await validateAndTransformInput(this.data, inputSchema);
|
|
247
|
+
} catch (error) {
|
|
248
|
+
return {
|
|
249
|
+
data: void 0,
|
|
250
|
+
error: error instanceof Error ? error : new Error(String(error))
|
|
251
|
+
};
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
const shouldUseIds = (options == null ? void 0 : options.useEntityIds) ?? this.databaseUseEntityIds;
|
|
255
|
+
let transformedResponse = rawResponse;
|
|
256
|
+
if (this.table && shouldUseIds) {
|
|
257
|
+
transformedResponse = transformResponseFields(
|
|
258
|
+
rawResponse,
|
|
259
|
+
this.table,
|
|
260
|
+
void 0
|
|
261
|
+
// No expand configs for insert
|
|
262
|
+
);
|
|
263
|
+
}
|
|
264
|
+
let schema;
|
|
265
|
+
if (this.table) {
|
|
266
|
+
const baseTableConfig = getBaseTableConfig(this.table);
|
|
267
|
+
const containerFields = baseTableConfig.containerFields || [];
|
|
268
|
+
schema = { ...baseTableConfig.schema };
|
|
269
|
+
for (const containerField of containerFields) {
|
|
270
|
+
delete schema[containerField];
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
const validation = await validateSingleResponse(
|
|
274
|
+
transformedResponse,
|
|
275
|
+
schema,
|
|
276
|
+
void 0,
|
|
277
|
+
// No selected fields for insert
|
|
278
|
+
void 0,
|
|
279
|
+
// No expand configs
|
|
280
|
+
"exact"
|
|
281
|
+
// Expect exactly one record
|
|
282
|
+
);
|
|
283
|
+
if (!validation.valid) {
|
|
284
|
+
return { data: void 0, error: validation.error };
|
|
285
|
+
}
|
|
286
|
+
if (validation.data === null) {
|
|
287
|
+
return {
|
|
288
|
+
data: void 0,
|
|
289
|
+
error: new Error("Insert operation returned null response")
|
|
290
|
+
};
|
|
291
|
+
}
|
|
292
|
+
return { data: validation.data, error: void 0 };
|
|
293
|
+
}
|
|
65
294
|
}
|
|
66
295
|
export {
|
|
67
296
|
InsertBuilder
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"insert-builder.js","sources":["../../../src/client/insert-builder.ts"],"sourcesContent":["import type {\n ExecutionContext,\n ExecutableBuilder,\n Result,\n ODataRecordMetadata,\n InferSchemaType,\n} from \"../types\";\nimport type { TableOccurrence } from \"./table-occurrence\";\nimport { validateSingleResponse } from \"../validation\";\nimport { type FFetchOptions } from \"@fetchkit/ffetch\";\n\nexport class InsertBuilder<\n T extends Record<string, any>,\n Occ extends TableOccurrence<any, any, any, any> | undefined = undefined,\n> implements ExecutableBuilder<T & ODataRecordMetadata>\n{\n private occurrence?: Occ;\n private tableName: string;\n private databaseName: string;\n private context: ExecutionContext;\n private data: Partial<T>;\n\n constructor(config: {\n occurrence?: Occ;\n tableName: string;\n databaseName: string;\n context: ExecutionContext;\n data: Partial<T>;\n }) {\n this.occurrence = config.occurrence;\n this.tableName = config.tableName;\n this.databaseName = config.databaseName;\n this.context = config.context;\n this.data = config.data;\n }\n\n async execute(\n options?: RequestInit & FFetchOptions,\n ): Promise<Result<T & ODataRecordMetadata>> {\n try {\n const url = `/${this.databaseName}/${this.tableName}`;\n\n // Make POST request with JSON body\n const response = await this.context._makeRequest(url, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n },\n body: JSON.stringify(this.data),\n ...options,\n });\n\n // Get schema from occurrence if available\n const schema = this.occurrence?.baseTable?.schema;\n\n // Validate the response (FileMaker returns the created record)\n const validation = await validateSingleResponse<T>(\n response,\n schema,\n undefined, // No selected fields for insert\n undefined, // No expand configs\n \"exact\", // Expect exactly one record\n );\n\n if (!validation.valid) {\n return { data: undefined, error: validation.error };\n }\n\n // Handle null response (shouldn't happen for insert, but handle it)\n if (validation.data === null) {\n return {\n data: undefined,\n error: new Error(\"Insert operation returned null response\"),\n };\n }\n\n return { data: validation.data, error: undefined };\n } catch (error) {\n return {\n data: undefined,\n error: error instanceof Error ? error : new Error(String(error)),\n };\n }\n }\n\n getRequestConfig(): { method: string; url: string; body?: any } {\n return {\n method: \"POST\",\n url: `/${this.databaseName}/${this.tableName}`,\n body: JSON.stringify(this.data),\n };\n }\n}\n"],"names":[],"mappings":";;;;AAWO,MAAM,cAIb;AAAA,EAOE,YAAY,QAMT;AAZK;AACA;AACA;AACA;AACA;AASN,SAAK,aAAa,OAAO;AACzB,SAAK,YAAY,OAAO;AACxB,SAAK,eAAe,OAAO;AAC3B,SAAK,UAAU,OAAO;AACtB,SAAK,OAAO,OAAO;AAAA,EAAA;AAAA,EAGrB,MAAM,QACJ,SAC0C;;AACtC,QAAA;AACF,YAAM,MAAM,IAAI,KAAK,YAAY,IAAI,KAAK,SAAS;AAGnD,YAAM,WAAW,MAAM,KAAK,QAAQ,aAAa,KAAK;AAAA,QACpD,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,KAAK,IAAI;AAAA,QAC9B,GAAG;AAAA,MAAA,CACJ;AAGK,YAAA,UAAS,gBAAK,eAAL,mBAAiB,cAAjB,mBAA4B;AAG3C,YAAM,aAAa,MAAM;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA;AAAA,QACA;AAAA;AAAA,QACA;AAAA;AAAA,MACF;AAEI,UAAA,CAAC,WAAW,OAAO;AACrB,eAAO,EAAE,MAAM,QAAW,OAAO,WAAW,MAAM;AAAA,MAAA;AAIhD,UAAA,WAAW,SAAS,MAAM;AACrB,eAAA;AAAA,UACL,MAAM;AAAA,UACN,OAAO,IAAI,MAAM,yCAAyC;AAAA,QAC5D;AAAA,MAAA;AAGF,aAAO,EAAE,MAAM,WAAW,MAAM,OAAO,OAAU;AAAA,aAC1C,OAAO;AACP,aAAA;AAAA,QACL,MAAM;AAAA,QACN,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;AAAA,MACjE;AAAA,IAAA;AAAA,EACF;AAAA,EAGF,mBAAgE;AACvD,WAAA;AAAA,MACL,QAAQ;AAAA,MACR,KAAK,IAAI,KAAK,YAAY,IAAI,KAAK,SAAS;AAAA,MAC5C,MAAM,KAAK,UAAU,KAAK,IAAI;AAAA,IAChC;AAAA,EAAA;AAEJ;"}
|
|
1
|
+
{"version":3,"file":"insert-builder.js","sources":["../../../src/client/insert-builder.ts"],"sourcesContent":["import type {\n ExecutionContext,\n ExecutableBuilder,\n Result,\n ODataRecordMetadata,\n InferSchemaType,\n ExecuteOptions,\n ConditionallyWithODataAnnotations,\n ExecuteMethodOptions,\n} from \"../types\";\nimport { getAcceptHeader } from \"../types\";\nimport type { FMTable } from \"../orm/table\";\nimport {\n getBaseTableConfig,\n getTableName,\n getTableId as getTableIdHelper,\n isUsingEntityIds,\n} from \"../orm/table\";\nimport {\n validateSingleResponse,\n validateAndTransformInput,\n} from \"../validation\";\nimport { type FFetchOptions } from \"@fetchkit/ffetch\";\nimport {\n transformFieldNamesToIds,\n transformResponseFields,\n} from \"../transform\";\nimport { InvalidLocationHeaderError } from \"../errors\";\nimport { safeJsonParse } from \"./sanitize-json\";\nimport { parseErrorResponse } from \"./error-parser\";\n\nexport type InsertOptions = {\n return?: \"minimal\" | \"representation\";\n};\n\nimport type { InferSchemaOutputFromFMTable } from \"../orm/table\";\n\nexport class InsertBuilder<\n Occ extends FMTable<any, any> | undefined = undefined,\n ReturnPreference extends \"minimal\" | \"representation\" = \"representation\",\n> implements\n ExecutableBuilder<\n ReturnPreference extends \"minimal\"\n ? { ROWID: number }\n : InferSchemaOutputFromFMTable<NonNullable<Occ>>\n >\n{\n private table?: Occ;\n private databaseName: string;\n private context: ExecutionContext;\n private data: Partial<InferSchemaOutputFromFMTable<NonNullable<Occ>>>;\n private returnPreference: ReturnPreference;\n\n private databaseUseEntityIds: boolean;\n private databaseIncludeSpecialColumns: boolean;\n\n constructor(config: {\n occurrence?: Occ;\n databaseName: string;\n context: ExecutionContext;\n data: Partial<InferSchemaOutputFromFMTable<NonNullable<Occ>>>;\n returnPreference?: ReturnPreference;\n databaseUseEntityIds?: boolean;\n databaseIncludeSpecialColumns?: boolean;\n }) {\n this.table = config.occurrence;\n this.databaseName = config.databaseName;\n this.context = config.context;\n this.data = config.data;\n this.returnPreference = (config.returnPreference ||\n \"representation\") as ReturnPreference;\n this.databaseUseEntityIds = config.databaseUseEntityIds ?? false;\n this.databaseIncludeSpecialColumns =\n config.databaseIncludeSpecialColumns ?? false;\n }\n\n /**\n * Helper to merge database-level useEntityIds with per-request options\n */\n private mergeExecuteOptions(\n options?: RequestInit & FFetchOptions & ExecuteOptions,\n ): RequestInit & FFetchOptions & { useEntityIds?: boolean } {\n // If useEntityIds is not set in options, use the database-level setting\n return {\n ...options,\n useEntityIds: options?.useEntityIds ?? this.databaseUseEntityIds,\n };\n }\n\n /**\n * Parse ROWID from Location header\n * Expected formats:\n * - contacts(ROWID=4583)\n * - contacts('some-uuid')\n */\n private parseLocationHeader(locationHeader: string | undefined): number {\n if (!locationHeader) {\n throw new InvalidLocationHeaderError(\n \"Location header is required but was not provided\",\n );\n }\n\n // Try to match ROWID=number pattern\n const rowidMatch = locationHeader.match(/ROWID=(\\d+)/);\n if (rowidMatch && rowidMatch[1]) {\n return parseInt(rowidMatch[1], 10);\n }\n\n // Try to extract value from parentheses and parse as number\n const parenMatch = locationHeader.match(/\\(['\"]?([^'\"]+)['\"]?\\)/);\n if (parenMatch && parenMatch[1]) {\n const value = parenMatch[1];\n const numValue = parseInt(value, 10);\n if (!isNaN(numValue)) {\n return numValue;\n }\n }\n\n throw new InvalidLocationHeaderError(\n `Could not extract ROWID from Location header: ${locationHeader}`,\n locationHeader,\n );\n }\n\n /**\n * Gets the table ID (FMTID) if using entity IDs, otherwise returns the table name\n * @param useEntityIds - Optional override for entity ID usage\n */\n private getTableId(useEntityIds?: boolean): string {\n if (!this.table) {\n throw new Error(\"Table occurrence is required\");\n }\n\n const contextDefault = this.context._getUseEntityIds?.() ?? false;\n const shouldUseIds = useEntityIds ?? contextDefault;\n\n if (shouldUseIds) {\n if (!isUsingEntityIds(this.table)) {\n throw new Error(\n `useEntityIds is true but table \"${getTableName(this.table)}\" does not have entity IDs configured`,\n );\n }\n return getTableIdHelper(this.table);\n }\n\n return getTableName(this.table);\n }\n\n async execute<EO extends ExecuteOptions>(\n options?: ExecuteMethodOptions<EO>,\n ): Promise<\n Result<\n ReturnPreference extends \"minimal\"\n ? { ROWID: number }\n : ConditionallyWithODataAnnotations<\n InferSchemaOutputFromFMTable<NonNullable<Occ>>,\n EO[\"includeODataAnnotations\"] extends true ? true : false\n >\n >\n > {\n // Merge database-level useEntityIds with per-request options\n const mergedOptions = this.mergeExecuteOptions(options);\n\n // Get table identifier with override support\n const tableId = this.getTableId(mergedOptions.useEntityIds);\n const url = `/${this.databaseName}/${tableId}`;\n\n // Validate and transform input data using input validators (writeValidators)\n let validatedData = this.data;\n if (this.table) {\n const baseTableConfig = getBaseTableConfig(this.table);\n const inputSchema = baseTableConfig.inputSchema;\n\n try {\n validatedData = await validateAndTransformInput(this.data, inputSchema);\n } catch (error) {\n // If validation fails, return error immediately\n return {\n data: undefined,\n error: error instanceof Error ? error : new Error(String(error)),\n } as any;\n }\n }\n\n // Transform field names to FMFIDs if using entity IDs\n // Only transform if useEntityIds resolves to true (respects per-request override)\n const shouldUseIds = mergedOptions.useEntityIds ?? false;\n\n const transformedData =\n this.table && shouldUseIds\n ? transformFieldNamesToIds(validatedData, this.table)\n : validatedData;\n\n // Set Prefer header based on return preference\n const preferHeader =\n this.returnPreference === \"minimal\"\n ? \"return=minimal\"\n : \"return=representation\";\n\n // Make POST request with JSON body\n const result = await this.context._makeRequest<any>(url, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n Prefer: preferHeader,\n ...((mergedOptions as any)?.headers || {}),\n },\n body: JSON.stringify(transformedData),\n ...mergedOptions,\n });\n\n if (result.error) {\n return { data: undefined, error: result.error };\n }\n\n // Handle return=minimal case\n if (this.returnPreference === \"minimal\") {\n // The response should be empty (204 No Content)\n // _makeRequest will return { _location: string } when there's a Location header\n const responseData = result.data as any;\n\n if (!responseData || !responseData._location) {\n throw new InvalidLocationHeaderError(\n \"Location header is required when using return=minimal but was not found in response\",\n );\n }\n\n const rowid = this.parseLocationHeader(responseData._location);\n return { data: { ROWID: rowid } as any, error: undefined };\n }\n\n let response = result.data;\n\n // Transform response field IDs back to names if using entity IDs\n // Only transform if useEntityIds resolves to true (respects per-request override)\n if (this.table && shouldUseIds) {\n response = transformResponseFields(\n response,\n this.table,\n undefined, // No expand configs for insert\n );\n }\n\n // Get schema from table if available, excluding container fields\n let schema: Record<string, any> | undefined;\n if (this.table) {\n const baseTableConfig = getBaseTableConfig(this.table);\n const containerFields = baseTableConfig.containerFields || [];\n\n // Filter out container fields from schema\n schema = { ...baseTableConfig.schema };\n for (const containerField of containerFields) {\n delete schema[containerField as string];\n }\n }\n\n // Validate the response (FileMaker returns the created record)\n const validation = await validateSingleResponse<\n InferSchemaOutputFromFMTable<NonNullable<Occ>>\n >(\n response,\n schema,\n undefined, // No selected fields for insert\n undefined, // No expand configs\n \"exact\", // Expect exactly one record\n );\n\n if (!validation.valid) {\n return { data: undefined, error: validation.error };\n }\n\n // Handle null response (shouldn't happen for insert, but handle it)\n if (validation.data === null) {\n return {\n data: undefined,\n error: new Error(\"Insert operation returned null response\"),\n };\n }\n\n return { data: validation.data as any, error: undefined };\n }\n\n getRequestConfig(): { method: string; url: string; body?: any } {\n // For batch operations, use database-level setting (no per-request override available here)\n // Note: Input validation happens in execute() and processResponse() for batch operations\n const tableId = this.getTableId(this.databaseUseEntityIds);\n\n // Transform field names to FMFIDs if using entity IDs\n const transformedData =\n this.table && this.databaseUseEntityIds\n ? transformFieldNamesToIds(this.data, this.table)\n : this.data;\n\n return {\n method: \"POST\",\n url: `/${this.databaseName}/${tableId}`,\n body: JSON.stringify(transformedData),\n };\n }\n\n toRequest(baseUrl: string, options?: ExecuteOptions): Request {\n const config = this.getRequestConfig();\n const fullUrl = `${baseUrl}${config.url}`;\n\n // Set Prefer header based on return preference\n const preferHeader =\n this.returnPreference === \"minimal\"\n ? \"return=minimal\"\n : \"return=representation\";\n\n return new Request(fullUrl, {\n method: config.method,\n headers: {\n \"Content-Type\": \"application/json\",\n Accept: getAcceptHeader(options?.includeODataAnnotations),\n Prefer: preferHeader,\n },\n body: config.body,\n });\n }\n\n async processResponse(\n response: Response,\n options?: ExecuteOptions,\n ): Promise<\n Result<\n ReturnPreference extends \"minimal\"\n ? { ROWID: number }\n : InferSchemaOutputFromFMTable<NonNullable<Occ>>\n >\n > {\n // Check for error responses (important for batch operations)\n if (!response.ok) {\n const tableName = this.table ? getTableName(this.table) : \"unknown\";\n const error = await parseErrorResponse(\n response,\n response.url || `/${this.databaseName}/${tableName}`,\n );\n return { data: undefined, error };\n }\n\n // Handle 204 No Content (common in batch/changeset operations)\n // FileMaker uses return=minimal for changeset operations regardless of Prefer header\n if (response.status === 204) {\n // Check for Location header (for return=minimal)\n if (this.returnPreference === \"minimal\") {\n const locationHeader =\n response.headers.get(\"Location\") || response.headers.get(\"location\");\n if (locationHeader) {\n const rowid = this.parseLocationHeader(locationHeader);\n return { data: { ROWID: rowid } as any, error: undefined };\n }\n throw new InvalidLocationHeaderError(\n \"Location header is required when using return=minimal but was not found in response\",\n );\n }\n\n // For 204 responses without return=minimal, FileMaker doesn't return the created entity\n // This is valid OData behavior for changeset operations\n // We return a success indicator but no actual data\n return {\n data: {} as any,\n error: undefined,\n };\n }\n\n // If we expected return=minimal but got a body, that's unexpected\n if (this.returnPreference === \"minimal\") {\n throw new InvalidLocationHeaderError(\n \"Expected 204 No Content for return=minimal, but received response with body\",\n );\n }\n\n // Use safeJsonParse to handle FileMaker's invalid JSON with unquoted ? values\n let rawResponse;\n try {\n rawResponse = await safeJsonParse(response);\n } catch (err) {\n // If parsing fails with 204, handle it gracefully\n if (response.status === 204) {\n return {\n data: {} as any,\n error: undefined,\n };\n }\n return {\n data: undefined,\n error: {\n name: \"ResponseParseError\",\n message: `Failed to parse response JSON: ${err instanceof Error ? err.message : \"Unknown error\"}`,\n timestamp: new Date(),\n } as any,\n };\n }\n\n // Validate and transform input data using input validators (writeValidators)\n // This is needed for processResponse because it's called from batch operations\n // where the data hasn't been validated yet\n let validatedData = this.data;\n if (this.table) {\n const baseTableConfig = getBaseTableConfig(this.table);\n const inputSchema = baseTableConfig.inputSchema;\n try {\n validatedData = await validateAndTransformInput(this.data, inputSchema);\n } catch (error) {\n return {\n data: undefined,\n error: error instanceof Error ? error : new Error(String(error)),\n } as any;\n }\n }\n\n // Transform response field IDs back to names if using entity IDs\n // Only transform if useEntityIds resolves to true (respects per-request override)\n const shouldUseIds = options?.useEntityIds ?? this.databaseUseEntityIds;\n\n let transformedResponse = rawResponse;\n if (this.table && shouldUseIds) {\n transformedResponse = transformResponseFields(\n rawResponse,\n this.table,\n undefined, // No expand configs for insert\n );\n }\n\n // Get schema from table if available, excluding container fields\n let schema: Record<string, any> | undefined;\n if (this.table) {\n const baseTableConfig = getBaseTableConfig(this.table);\n const containerFields = baseTableConfig.containerFields || [];\n\n // Filter out container fields from schema\n schema = { ...baseTableConfig.schema };\n for (const containerField of containerFields) {\n delete schema[containerField as string];\n }\n }\n\n // Validate the response (FileMaker returns the created record)\n const validation = await validateSingleResponse<\n InferSchemaOutputFromFMTable<NonNullable<Occ>>\n >(\n transformedResponse,\n schema,\n undefined, // No selected fields for insert\n undefined, // No expand configs\n \"exact\", // Expect exactly one record\n );\n\n if (!validation.valid) {\n return { data: undefined, error: validation.error };\n }\n\n // Handle null response (shouldn't happen for insert, but handle it)\n if (validation.data === null) {\n return {\n data: undefined,\n error: new Error(\"Insert operation returned null response\"),\n };\n }\n\n return { data: validation.data as any, error: undefined };\n }\n}\n"],"names":["getTableIdHelper"],"mappings":";;;;;;;;;;AAqCO,MAAM,cASb;AAAA,EAUE,YAAY,QAQT;AAjBK;AACA;AACA;AACA;AACA;AAEA;AACA;AAWN,SAAK,QAAQ,OAAO;AACpB,SAAK,eAAe,OAAO;AAC3B,SAAK,UAAU,OAAO;AACtB,SAAK,OAAO,OAAO;AACd,SAAA,mBAAoB,OAAO,oBAC9B;AACG,SAAA,uBAAuB,OAAO,wBAAwB;AACtD,SAAA,gCACH,OAAO,iCAAiC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpC,oBACN,SAC0D;AAEnD,WAAA;AAAA,MACL,GAAG;AAAA,MACH,eAAc,mCAAS,iBAAgB,KAAK;AAAA,IAC9C;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,oBAAoB,gBAA4C;AACtE,QAAI,CAAC,gBAAgB;AACnB,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IAAA;AAII,UAAA,aAAa,eAAe,MAAM,aAAa;AACjD,QAAA,cAAc,WAAW,CAAC,GAAG;AAC/B,aAAO,SAAS,WAAW,CAAC,GAAG,EAAE;AAAA,IAAA;AAI7B,UAAA,aAAa,eAAe,MAAM,wBAAwB;AAC5D,QAAA,cAAc,WAAW,CAAC,GAAG;AACzB,YAAA,QAAQ,WAAW,CAAC;AACpB,YAAA,WAAW,SAAS,OAAO,EAAE;AAC/B,UAAA,CAAC,MAAM,QAAQ,GAAG;AACb,eAAA;AAAA,MAAA;AAAA,IACT;AAGF,UAAM,IAAI;AAAA,MACR,iDAAiD,cAAc;AAAA,MAC/D;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOM,WAAW,cAAgC;;AAC7C,QAAA,CAAC,KAAK,OAAO;AACT,YAAA,IAAI,MAAM,8BAA8B;AAAA,IAAA;AAGhD,UAAM,mBAAiB,gBAAK,SAAQ,qBAAb,gCAAqC;AAC5D,UAAM,eAAe,gBAAgB;AAErC,QAAI,cAAc;AAChB,UAAI,CAAC,iBAAiB,KAAK,KAAK,GAAG;AACjC,cAAM,IAAI;AAAA,UACR,mCAAmC,aAAa,KAAK,KAAK,CAAC;AAAA,QAC7D;AAAA,MAAA;AAEK,aAAAA,WAAiB,KAAK,KAAK;AAAA,IAAA;AAG7B,WAAA,aAAa,KAAK,KAAK;AAAA,EAAA;AAAA,EAGhC,MAAM,QACJ,SAUA;AAEM,UAAA,gBAAgB,KAAK,oBAAoB,OAAO;AAGtD,UAAM,UAAU,KAAK,WAAW,cAAc,YAAY;AAC1D,UAAM,MAAM,IAAI,KAAK,YAAY,IAAI,OAAO;AAG5C,QAAI,gBAAgB,KAAK;AACzB,QAAI,KAAK,OAAO;AACR,YAAA,kBAAkB,mBAAmB,KAAK,KAAK;AACrD,YAAM,cAAc,gBAAgB;AAEhC,UAAA;AACF,wBAAgB,MAAM,0BAA0B,KAAK,MAAM,WAAW;AAAA,eAC/D,OAAO;AAEP,eAAA;AAAA,UACL,MAAM;AAAA,UACN,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;AAAA,QACjE;AAAA,MAAA;AAAA,IACF;AAKI,UAAA,eAAe,cAAc,gBAAgB;AAE7C,UAAA,kBACJ,KAAK,SAAS,eACV,yBAAyB,eAAe,KAAK,KAAK,IAClD;AAGN,UAAM,eACJ,KAAK,qBAAqB,YACtB,mBACA;AAGN,UAAM,SAAS,MAAM,KAAK,QAAQ,aAAkB,KAAK;AAAA,MACvD,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,QAAQ;AAAA,QACR,IAAK,+CAAuB,YAAW,CAAA;AAAA,MACzC;AAAA,MACA,MAAM,KAAK,UAAU,eAAe;AAAA,MACpC,GAAG;AAAA,IAAA,CACJ;AAED,QAAI,OAAO,OAAO;AAChB,aAAO,EAAE,MAAM,QAAW,OAAO,OAAO,MAAM;AAAA,IAAA;AAI5C,QAAA,KAAK,qBAAqB,WAAW;AAGvC,YAAM,eAAe,OAAO;AAE5B,UAAI,CAAC,gBAAgB,CAAC,aAAa,WAAW;AAC5C,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MAAA;AAGF,YAAM,QAAQ,KAAK,oBAAoB,aAAa,SAAS;AAC7D,aAAO,EAAE,MAAM,EAAE,OAAO,MAAM,GAAU,OAAO,OAAU;AAAA,IAAA;AAG3D,QAAI,WAAW,OAAO;AAIlB,QAAA,KAAK,SAAS,cAAc;AACnB,iBAAA;AAAA,QACT;AAAA,QACA,KAAK;AAAA,QACL;AAAA;AAAA,MACF;AAAA,IAAA;AAIE,QAAA;AACJ,QAAI,KAAK,OAAO;AACR,YAAA,kBAAkB,mBAAmB,KAAK,KAAK;AAC/C,YAAA,kBAAkB,gBAAgB,mBAAmB,CAAC;AAGnD,eAAA,EAAE,GAAG,gBAAgB,OAAO;AACrC,iBAAW,kBAAkB,iBAAiB;AAC5C,eAAO,OAAO,cAAwB;AAAA,MAAA;AAAA,IACxC;AAIF,UAAM,aAAa,MAAM;AAAA,MAGvB;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MACA;AAAA;AAAA,MACA;AAAA;AAAA,IACF;AAEI,QAAA,CAAC,WAAW,OAAO;AACrB,aAAO,EAAE,MAAM,QAAW,OAAO,WAAW,MAAM;AAAA,IAAA;AAIhD,QAAA,WAAW,SAAS,MAAM;AACrB,aAAA;AAAA,QACL,MAAM;AAAA,QACN,OAAO,IAAI,MAAM,yCAAyC;AAAA,MAC5D;AAAA,IAAA;AAGF,WAAO,EAAE,MAAM,WAAW,MAAa,OAAO,OAAU;AAAA,EAAA;AAAA,EAG1D,mBAAgE;AAG9D,UAAM,UAAU,KAAK,WAAW,KAAK,oBAAoB;AAGnD,UAAA,kBACJ,KAAK,SAAS,KAAK,uBACf,yBAAyB,KAAK,MAAM,KAAK,KAAK,IAC9C,KAAK;AAEJ,WAAA;AAAA,MACL,QAAQ;AAAA,MACR,KAAK,IAAI,KAAK,YAAY,IAAI,OAAO;AAAA,MACrC,MAAM,KAAK,UAAU,eAAe;AAAA,IACtC;AAAA,EAAA;AAAA,EAGF,UAAU,SAAiB,SAAmC;AACtD,UAAA,SAAS,KAAK,iBAAiB;AACrC,UAAM,UAAU,GAAG,OAAO,GAAG,OAAO,GAAG;AAGvC,UAAM,eACJ,KAAK,qBAAqB,YACtB,mBACA;AAEC,WAAA,IAAI,QAAQ,SAAS;AAAA,MAC1B,QAAQ,OAAO;AAAA,MACf,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,QAAQ,gBAAgB,mCAAS,uBAAuB;AAAA,QACxD,QAAQ;AAAA,MACV;AAAA,MACA,MAAM,OAAO;AAAA,IAAA,CACd;AAAA,EAAA;AAAA,EAGH,MAAM,gBACJ,UACA,SAOA;AAEI,QAAA,CAAC,SAAS,IAAI;AAChB,YAAM,YAAY,KAAK,QAAQ,aAAa,KAAK,KAAK,IAAI;AAC1D,YAAM,QAAQ,MAAM;AAAA,QAClB;AAAA,QACA,SAAS,OAAO,IAAI,KAAK,YAAY,IAAI,SAAS;AAAA,MACpD;AACO,aAAA,EAAE,MAAM,QAAW,MAAM;AAAA,IAAA;AAK9B,QAAA,SAAS,WAAW,KAAK;AAEvB,UAAA,KAAK,qBAAqB,WAAW;AACjC,cAAA,iBACJ,SAAS,QAAQ,IAAI,UAAU,KAAK,SAAS,QAAQ,IAAI,UAAU;AACrE,YAAI,gBAAgB;AACZ,gBAAA,QAAQ,KAAK,oBAAoB,cAAc;AACrD,iBAAO,EAAE,MAAM,EAAE,OAAO,MAAM,GAAU,OAAO,OAAU;AAAA,QAAA;AAE3D,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MAAA;AAMK,aAAA;AAAA,QACL,MAAM,CAAC;AAAA,QACP,OAAO;AAAA,MACT;AAAA,IAAA;AAIE,QAAA,KAAK,qBAAqB,WAAW;AACvC,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IAAA;AAIE,QAAA;AACA,QAAA;AACY,oBAAA,MAAM,cAAc,QAAQ;AAAA,aACnC,KAAK;AAER,UAAA,SAAS,WAAW,KAAK;AACpB,eAAA;AAAA,UACL,MAAM,CAAC;AAAA,UACP,OAAO;AAAA,QACT;AAAA,MAAA;AAEK,aAAA;AAAA,QACL,MAAM;AAAA,QACN,OAAO;AAAA,UACL,MAAM;AAAA,UACN,SAAS,kCAAkC,eAAe,QAAQ,IAAI,UAAU,eAAe;AAAA,UAC/F,+BAAe,KAAK;AAAA,QAAA;AAAA,MAExB;AAAA,IAAA;AAMF,QAAI,gBAAgB,KAAK;AACzB,QAAI,KAAK,OAAO;AACR,YAAA,kBAAkB,mBAAmB,KAAK,KAAK;AACrD,YAAM,cAAc,gBAAgB;AAChC,UAAA;AACF,wBAAgB,MAAM,0BAA0B,KAAK,MAAM,WAAW;AAAA,eAC/D,OAAO;AACP,eAAA;AAAA,UACL,MAAM;AAAA,UACN,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;AAAA,QACjE;AAAA,MAAA;AAAA,IACF;AAKI,UAAA,gBAAe,mCAAS,iBAAgB,KAAK;AAEnD,QAAI,sBAAsB;AACtB,QAAA,KAAK,SAAS,cAAc;AACR,4BAAA;AAAA,QACpB;AAAA,QACA,KAAK;AAAA,QACL;AAAA;AAAA,MACF;AAAA,IAAA;AAIE,QAAA;AACJ,QAAI,KAAK,OAAO;AACR,YAAA,kBAAkB,mBAAmB,KAAK,KAAK;AAC/C,YAAA,kBAAkB,gBAAgB,mBAAmB,CAAC;AAGnD,eAAA,EAAE,GAAG,gBAAgB,OAAO;AACrC,iBAAW,kBAAkB,iBAAiB;AAC5C,eAAO,OAAO,cAAwB;AAAA,MAAA;AAAA,IACxC;AAIF,UAAM,aAAa,MAAM;AAAA,MAGvB;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MACA;AAAA;AAAA,MACA;AAAA;AAAA,IACF;AAEI,QAAA,CAAC,WAAW,OAAO;AACrB,aAAO,EAAE,MAAM,QAAW,OAAO,WAAW,MAAM;AAAA,IAAA;AAIhD,QAAA,WAAW,SAAS,MAAM;AACrB,aAAA;AAAA,QACL,MAAM;AAAA,QACN,OAAO,IAAI,MAAM,yCAAyC;AAAA,MAC5D;AAAA,IAAA;AAGF,WAAO,EAAE,MAAM,WAAW,MAAa,OAAO,OAAU;AAAA,EAAA;AAE5D;"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { QueryOptions } from 'odata-query';
|
|
2
|
+
import { FMTable } from '../../orm/table.js';
|
|
3
|
+
import { ExpandValidationConfig } from '../../validation.js';
|
|
4
|
+
/**
|
|
5
|
+
* Internal type for expand configuration
|
|
6
|
+
*/
|
|
7
|
+
export type ExpandConfig = {
|
|
8
|
+
relation: string;
|
|
9
|
+
options?: Partial<QueryOptions<any>>;
|
|
10
|
+
targetTable?: FMTable<any, any>;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Builds OData expand query strings and validation configs.
|
|
14
|
+
* Handles nested expands recursively and transforms relation names to FMTIDs
|
|
15
|
+
* when using entity IDs.
|
|
16
|
+
*/
|
|
17
|
+
export declare class ExpandBuilder {
|
|
18
|
+
private useEntityIds;
|
|
19
|
+
constructor(useEntityIds: boolean);
|
|
20
|
+
/**
|
|
21
|
+
* Builds OData expand query string from expand configurations.
|
|
22
|
+
* Handles nested expands recursively.
|
|
23
|
+
* Transforms relation names to FMTIDs if using entity IDs.
|
|
24
|
+
*/
|
|
25
|
+
buildExpandString(configs: ExpandConfig[]): string;
|
|
26
|
+
/**
|
|
27
|
+
* Builds a single expand string with its options.
|
|
28
|
+
*/
|
|
29
|
+
private buildSingleExpand;
|
|
30
|
+
/**
|
|
31
|
+
* Builds expand validation configs from internal expand configurations.
|
|
32
|
+
* These are used to validate expanded navigation properties.
|
|
33
|
+
*/
|
|
34
|
+
buildValidationConfigs(configs: ExpandConfig[]): ExpandValidationConfig[];
|
|
35
|
+
}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import { ExecutionContext, ExecutableBuilder, Result, ExecuteOptions, ConditionallyWithODataAnnotations, ConditionallyWithSpecialColumns, NormalizeIncludeSpecialColumns, ExecuteMethodOptions } from '../../types.js';
|
|
2
|
+
import { Column } from '../../orm/column.js';
|
|
3
|
+
import { FilterExpression, OrderByExpression } from '../../orm/operators.js';
|
|
4
|
+
import { FMTable, InferSchemaOutputFromFMTable, ValidExpandTarget, ExtractTableName } from '../../orm/table.js';
|
|
5
|
+
import { ExpandedRelations } from '../builders/index.js';
|
|
6
|
+
import { TypeSafeOrderBy, QueryReturnType, SystemColumnsOption } from './types.js';
|
|
7
|
+
export type { QueryReturnType };
|
|
8
|
+
export type { TypeSafeOrderBy, ExpandedRelations };
|
|
9
|
+
export declare class QueryBuilder<Occ extends FMTable<any, any>, Selected extends keyof InferSchemaOutputFromFMTable<Occ> | Record<string, Column<any, any, ExtractTableName<Occ>>> = keyof InferSchemaOutputFromFMTable<Occ>, SingleMode extends "exact" | "maybe" | false = false, IsCount extends boolean = false, Expands extends ExpandedRelations = {}, DatabaseIncludeSpecialColumns extends boolean = false, SystemCols extends SystemColumnsOption | undefined = undefined> implements ExecutableBuilder<QueryReturnType<InferSchemaOutputFromFMTable<Occ>, Selected, SingleMode, IsCount, Expands, SystemCols>> {
|
|
10
|
+
private queryOptions;
|
|
11
|
+
private expandConfigs;
|
|
12
|
+
private singleMode;
|
|
13
|
+
private isCountMode;
|
|
14
|
+
private occurrence;
|
|
15
|
+
private databaseName;
|
|
16
|
+
private context;
|
|
17
|
+
private navigation?;
|
|
18
|
+
private databaseUseEntityIds;
|
|
19
|
+
private databaseIncludeSpecialColumns;
|
|
20
|
+
private expandBuilder;
|
|
21
|
+
private urlBuilder;
|
|
22
|
+
private fieldMapping?;
|
|
23
|
+
private systemColumns?;
|
|
24
|
+
private logger;
|
|
25
|
+
constructor(config: {
|
|
26
|
+
occurrence: Occ;
|
|
27
|
+
databaseName: string;
|
|
28
|
+
context: ExecutionContext;
|
|
29
|
+
databaseUseEntityIds?: boolean;
|
|
30
|
+
databaseIncludeSpecialColumns?: boolean;
|
|
31
|
+
});
|
|
32
|
+
/**
|
|
33
|
+
* Helper to merge database-level useEntityIds and includeSpecialColumns with per-request options
|
|
34
|
+
*/
|
|
35
|
+
private mergeExecuteOptions;
|
|
36
|
+
/**
|
|
37
|
+
* Gets the FMTable instance
|
|
38
|
+
*/
|
|
39
|
+
private getTable;
|
|
40
|
+
/**
|
|
41
|
+
* Gets the table ID (FMTID) if using entity IDs, otherwise returns the table name
|
|
42
|
+
* @param useEntityIds - Optional override for entity ID usage
|
|
43
|
+
*/
|
|
44
|
+
private getTableIdOrName;
|
|
45
|
+
/**
|
|
46
|
+
* Creates a new QueryBuilder with modified configuration.
|
|
47
|
+
* Used by single(), maybeSingle(), count(), and select() to create new instances.
|
|
48
|
+
*/
|
|
49
|
+
private cloneWithChanges;
|
|
50
|
+
/**
|
|
51
|
+
* Select fields using column references.
|
|
52
|
+
* Allows renaming fields by using different keys in the object.
|
|
53
|
+
* Container fields cannot be selected and will cause a type error.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* db.from(users).list().select({
|
|
57
|
+
* name: users.name,
|
|
58
|
+
* userEmail: users.email // renamed!
|
|
59
|
+
* })
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* // Include system columns (ROWID, ROWMODID) when using select()
|
|
63
|
+
* db.from(users).list().select(
|
|
64
|
+
* { name: users.name },
|
|
65
|
+
* { ROWID: true, ROWMODID: true }
|
|
66
|
+
* )
|
|
67
|
+
*
|
|
68
|
+
* @param fields - Object mapping output keys to column references (container fields excluded)
|
|
69
|
+
* @param systemColumns - Optional object to request system columns (ROWID, ROWMODID)
|
|
70
|
+
* @returns QueryBuilder with updated selected fields
|
|
71
|
+
*/
|
|
72
|
+
select<TSelect extends Record<string, Column<any, any, ExtractTableName<Occ>, false>>, TSystemCols extends SystemColumnsOption = {}>(fields: TSelect, systemColumns?: TSystemCols): QueryBuilder<Occ, TSelect, SingleMode, IsCount, Expands, DatabaseIncludeSpecialColumns, TSystemCols>;
|
|
73
|
+
/**
|
|
74
|
+
* Filter results using operator expressions (new ORM-style API).
|
|
75
|
+
* Supports eq, gt, lt, and, or, etc. operators with Column references.
|
|
76
|
+
* Also supports raw OData filter strings as an escape hatch.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* .where(eq(users.hobby, "reading"))
|
|
80
|
+
* .where(and(eq(users.active, true), gt(users.age, 18)))
|
|
81
|
+
* .where("status eq 'active'") // Raw OData string escape hatch
|
|
82
|
+
*/
|
|
83
|
+
where(expression: FilterExpression | string): QueryBuilder<Occ, Selected, SingleMode, IsCount, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
84
|
+
/**
|
|
85
|
+
* Specify the sort order for query results.
|
|
86
|
+
*
|
|
87
|
+
* @example Single field (ascending by default)
|
|
88
|
+
* ```ts
|
|
89
|
+
* .orderBy("name")
|
|
90
|
+
* .orderBy(users.name) // Column reference
|
|
91
|
+
* .orderBy(asc(users.name)) // Explicit ascending
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* @example Single field with explicit direction
|
|
95
|
+
* ```ts
|
|
96
|
+
* .orderBy(["name", "desc"])
|
|
97
|
+
* .orderBy([users.name, "desc"]) // Column reference
|
|
98
|
+
* .orderBy(desc(users.name)) // Explicit descending
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* @example Multiple fields with directions
|
|
102
|
+
* ```ts
|
|
103
|
+
* .orderBy([["name", "asc"], ["createdAt", "desc"]])
|
|
104
|
+
* .orderBy([[users.name, "asc"], [users.createdAt, "desc"]]) // Column references
|
|
105
|
+
* .orderBy(users.name, desc(users.age)) // Variadic with helpers
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
orderBy(...orderByArgs: [
|
|
109
|
+
TypeSafeOrderBy<InferSchemaOutputFromFMTable<Occ>> | Column<any, any, ExtractTableName<Occ>> | OrderByExpression<ExtractTableName<Occ>>
|
|
110
|
+
] | [
|
|
111
|
+
Column<any, any, ExtractTableName<Occ>>,
|
|
112
|
+
...Array<Column<any, any, ExtractTableName<Occ>> | OrderByExpression<ExtractTableName<Occ>>>
|
|
113
|
+
]): QueryBuilder<Occ, Selected, SingleMode, IsCount, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
114
|
+
top(count: number): QueryBuilder<Occ, Selected, SingleMode, IsCount, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
115
|
+
skip(count: number): QueryBuilder<Occ, Selected, SingleMode, IsCount, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
116
|
+
expand<TargetTable extends FMTable<any, any>, TSelected extends keyof InferSchemaOutputFromFMTable<TargetTable> | Record<string, Column<any, any, ExtractTableName<TargetTable>>> = keyof InferSchemaOutputFromFMTable<TargetTable>, TNestedExpands extends ExpandedRelations = {}>(targetTable: ValidExpandTarget<Occ, TargetTable>, callback?: (builder: QueryBuilder<TargetTable, keyof InferSchemaOutputFromFMTable<TargetTable>, false, false, {}>) => QueryBuilder<TargetTable, TSelected, any, any, TNestedExpands>): QueryBuilder<Occ, Selected, SingleMode, IsCount, Expands & {
|
|
117
|
+
[K in ExtractTableName<TargetTable>]: {
|
|
118
|
+
schema: InferSchemaOutputFromFMTable<TargetTable>;
|
|
119
|
+
selected: TSelected;
|
|
120
|
+
nested: TNestedExpands;
|
|
121
|
+
};
|
|
122
|
+
}, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
123
|
+
single(): QueryBuilder<Occ, Selected, "exact", IsCount, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
124
|
+
maybeSingle(): QueryBuilder<Occ, Selected, "maybe", IsCount, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
125
|
+
count(): QueryBuilder<Occ, Selected, SingleMode, true, Expands, DatabaseIncludeSpecialColumns, SystemCols>;
|
|
126
|
+
/**
|
|
127
|
+
* Builds the OData query string from current query options and expand configs.
|
|
128
|
+
*/
|
|
129
|
+
private buildQueryString;
|
|
130
|
+
execute<EO extends ExecuteOptions>(options?: ExecuteMethodOptions<EO>): Promise<Result<ConditionallyWithODataAnnotations<ConditionallyWithSpecialColumns<QueryReturnType<InferSchemaOutputFromFMTable<Occ>, Selected, SingleMode, IsCount, Expands, SystemCols>, NormalizeIncludeSpecialColumns<EO["includeSpecialColumns"], DatabaseIncludeSpecialColumns>, Selected extends Record<string, Column<any, any, any>> ? true : Selected extends keyof InferSchemaOutputFromFMTable<Occ> ? false : true>, EO["includeODataAnnotations"] extends true ? true : false>>>;
|
|
131
|
+
getQueryString(): string;
|
|
132
|
+
getRequestConfig(): {
|
|
133
|
+
method: string;
|
|
134
|
+
url: string;
|
|
135
|
+
body?: any;
|
|
136
|
+
};
|
|
137
|
+
toRequest(baseUrl: string, options?: ExecuteOptions): Request;
|
|
138
|
+
processResponse(response: Response, options?: ExecuteOptions): Promise<Result<QueryReturnType<InferSchemaOutputFromFMTable<Occ>, Selected, SingleMode, IsCount, Expands, SystemCols>>>;
|
|
139
|
+
}
|