@objectstack/objectql 0.6.0 → 0.7.1
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/CHANGELOG.md +20 -0
- package/README.md +2 -1
- package/dist/engine.d.ts +286 -0
- package/dist/engine.d.ts.map +1 -0
- package/dist/engine.js +423 -0
- package/dist/index.d.ts +3 -196
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -342
- package/dist/plugin.d.ts +1 -1
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +6 -11
- package/dist/protocol.d.ts +103 -33
- package/dist/protocol.d.ts.map +1 -1
- package/dist/protocol.js +224 -46
- package/dist/registry.d.ts +4 -0
- package/dist/registry.d.ts.map +1 -1
- package/dist/registry.js +13 -0
- package/package.json +5 -5
- package/src/engine.ts +484 -0
- package/src/index.ts +9 -405
- package/src/plugin.ts +6 -6
- package/src/protocol.ts +255 -49
- package/src/registry.ts +13 -0
package/dist/index.js
CHANGED
|
@@ -1,344 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
// Export Registry for consumers
|
|
1
|
+
// Export Registry
|
|
3
2
|
export { SchemaRegistry } from './registry';
|
|
3
|
+
// Export Protocol Implementation
|
|
4
4
|
export { ObjectStackProtocolImplementation } from './protocol';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
export class ObjectQL {
|
|
11
|
-
constructor(hostContext = {}) {
|
|
12
|
-
this.drivers = new Map();
|
|
13
|
-
this.defaultDriver = null;
|
|
14
|
-
// Hooks Registry
|
|
15
|
-
this.hooks = {
|
|
16
|
-
'beforeFind': [], 'afterFind': [],
|
|
17
|
-
'beforeInsert': [], 'afterInsert': [],
|
|
18
|
-
'beforeUpdate': [], 'afterUpdate': [],
|
|
19
|
-
'beforeDelete': [], 'afterDelete': [],
|
|
20
|
-
};
|
|
21
|
-
// Host provided context additions (e.g. Server router)
|
|
22
|
-
this.hostContext = {};
|
|
23
|
-
this.hostContext = hostContext;
|
|
24
|
-
console.log(`[ObjectQL] Engine Instance Created`);
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Load and Register a Plugin
|
|
28
|
-
*/
|
|
29
|
-
async use(manifestPart, runtimePart) {
|
|
30
|
-
// 1. Validate / Register Manifest
|
|
31
|
-
if (manifestPart) {
|
|
32
|
-
this.registerApp(manifestPart);
|
|
33
|
-
}
|
|
34
|
-
// 2. Execute Runtime
|
|
35
|
-
if (runtimePart) {
|
|
36
|
-
const pluginDef = runtimePart.default || runtimePart;
|
|
37
|
-
if (pluginDef.onEnable) {
|
|
38
|
-
const context = {
|
|
39
|
-
ql: this,
|
|
40
|
-
logger: console,
|
|
41
|
-
// Expose the driver registry helper explicitly if needed
|
|
42
|
-
drivers: {
|
|
43
|
-
register: (driver) => this.registerDriver(driver)
|
|
44
|
-
},
|
|
45
|
-
...this.hostContext
|
|
46
|
-
};
|
|
47
|
-
await pluginDef.onEnable(context);
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Register a hook
|
|
53
|
-
* @param event The event name (e.g. 'beforeFind', 'afterInsert')
|
|
54
|
-
* @param handler The handler function
|
|
55
|
-
*/
|
|
56
|
-
registerHook(event, handler) {
|
|
57
|
-
if (!this.hooks[event]) {
|
|
58
|
-
this.hooks[event] = [];
|
|
59
|
-
}
|
|
60
|
-
this.hooks[event].push(handler);
|
|
61
|
-
console.log(`[ObjectQL] Registered hook for ${event}`);
|
|
62
|
-
}
|
|
63
|
-
async triggerHooks(event, context) {
|
|
64
|
-
const handlers = this.hooks[event] || [];
|
|
65
|
-
for (const handler of handlers) {
|
|
66
|
-
// In a real system, we might want to catch errors here or allow them to bubble up
|
|
67
|
-
await handler(context);
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
registerApp(manifestPart) {
|
|
71
|
-
// 1. Handle Module Imports (commonjs/esm interop)
|
|
72
|
-
// If the passed object is a module namespace with a default export, use that.
|
|
73
|
-
const raw = manifestPart.default || manifestPart;
|
|
74
|
-
// Support nested manifest property (Stack Definition)
|
|
75
|
-
// We merge the inner manifest metadata (id, version, etc) with the outer container (objects, apps)
|
|
76
|
-
const manifest = raw.manifest ? { ...raw, ...raw.manifest } : raw;
|
|
77
|
-
// In a real scenario, we might strictly parse this using Zod
|
|
78
|
-
// For now, simple ID check
|
|
79
|
-
const id = manifest.id || manifest.name;
|
|
80
|
-
if (!id) {
|
|
81
|
-
console.warn(`[ObjectQL] Plugin manifest missing ID (keys: ${Object.keys(manifest)})`, manifest);
|
|
82
|
-
// Don't return, try to proceed if it looks like an App (Apps might use 'name' instead of 'id')
|
|
83
|
-
// return;
|
|
84
|
-
}
|
|
85
|
-
console.log(`[ObjectQL] Loading App: ${id}`);
|
|
86
|
-
SchemaRegistry.registerPlugin(manifest);
|
|
87
|
-
// Register Objects from App/Plugin
|
|
88
|
-
if (manifest.objects) {
|
|
89
|
-
for (const obj of manifest.objects) {
|
|
90
|
-
// Ensure object name is registered globally
|
|
91
|
-
SchemaRegistry.registerObject(obj);
|
|
92
|
-
console.log(`[ObjectQL] Registered Object: ${obj.name}`);
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
// Register contributions
|
|
96
|
-
if (manifest.contributes?.kinds) {
|
|
97
|
-
for (const kind of manifest.contributes.kinds) {
|
|
98
|
-
SchemaRegistry.registerKind(kind);
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Register a new storage driver
|
|
104
|
-
*/
|
|
105
|
-
registerDriver(driver, isDefault = false) {
|
|
106
|
-
if (this.drivers.has(driver.name)) {
|
|
107
|
-
console.warn(`[ObjectQL] Driver ${driver.name} is already registered. Skipping.`);
|
|
108
|
-
return;
|
|
109
|
-
}
|
|
110
|
-
this.drivers.set(driver.name, driver);
|
|
111
|
-
console.log(`[ObjectQL] Registered driver: ${driver.name} v${driver.version}`);
|
|
112
|
-
if (isDefault || this.drivers.size === 1) {
|
|
113
|
-
this.defaultDriver = driver.name;
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
/**
|
|
117
|
-
* Helper to get object definition
|
|
118
|
-
*/
|
|
119
|
-
getSchema(objectName) {
|
|
120
|
-
return SchemaRegistry.getObject(objectName);
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* Helper to get the target driver
|
|
124
|
-
*/
|
|
125
|
-
getDriver(objectName) {
|
|
126
|
-
const object = SchemaRegistry.getObject(objectName);
|
|
127
|
-
// 1. If object definition exists, check for explicit datasource
|
|
128
|
-
if (object) {
|
|
129
|
-
const datasourceName = object.datasource || 'default';
|
|
130
|
-
// If configured for 'default', try to find the default driver
|
|
131
|
-
if (datasourceName === 'default') {
|
|
132
|
-
if (this.defaultDriver && this.drivers.has(this.defaultDriver)) {
|
|
133
|
-
return this.drivers.get(this.defaultDriver);
|
|
134
|
-
}
|
|
135
|
-
// Fallback: If 'default' not explicitly set, use the first available driver?
|
|
136
|
-
// Better to be strict.
|
|
137
|
-
}
|
|
138
|
-
else {
|
|
139
|
-
// Specific datasource requested
|
|
140
|
-
if (this.drivers.has(datasourceName)) {
|
|
141
|
-
return this.drivers.get(datasourceName);
|
|
142
|
-
}
|
|
143
|
-
// If not found, fall back to default? Or error?
|
|
144
|
-
// Standard behavior: Error if specific datasource is missing.
|
|
145
|
-
throw new Error(`[ObjectQL] Datasource '${datasourceName}' configured for object '${objectName}' is not registered.`);
|
|
146
|
-
}
|
|
147
|
-
}
|
|
148
|
-
// 2. Fallback for ad-hoc objects or missing definitions
|
|
149
|
-
// If we have a default driver, use it.
|
|
150
|
-
if (this.defaultDriver) {
|
|
151
|
-
if (!object) {
|
|
152
|
-
console.warn(`[ObjectQL] Object '${objectName}' not found in registry. Using default driver.`);
|
|
153
|
-
}
|
|
154
|
-
return this.drivers.get(this.defaultDriver);
|
|
155
|
-
}
|
|
156
|
-
throw new Error(`[ObjectQL] No driver available for object '${objectName}'`);
|
|
157
|
-
}
|
|
158
|
-
/**
|
|
159
|
-
* Initialize the engine and all registered drivers
|
|
160
|
-
*/
|
|
161
|
-
async init() {
|
|
162
|
-
console.log('[ObjectQL] Initializing drivers...');
|
|
163
|
-
for (const [name, driver] of this.drivers) {
|
|
164
|
-
try {
|
|
165
|
-
await driver.connect();
|
|
166
|
-
}
|
|
167
|
-
catch (e) {
|
|
168
|
-
console.error(`[ObjectQL] Failed to connect driver ${name}`, e);
|
|
169
|
-
}
|
|
170
|
-
}
|
|
171
|
-
// In a real app, we would sync schemas here
|
|
172
|
-
}
|
|
173
|
-
async destroy() {
|
|
174
|
-
for (const driver of this.drivers.values()) {
|
|
175
|
-
await driver.disconnect();
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
// ============================================
|
|
179
|
-
// Data Access Methods (IDataEngine Interface)
|
|
180
|
-
// ============================================
|
|
181
|
-
/**
|
|
182
|
-
* Find records matching a query (IDataEngine interface)
|
|
183
|
-
*
|
|
184
|
-
* @param object - Object name
|
|
185
|
-
* @param query - Query options (IDataEngine format)
|
|
186
|
-
* @returns Promise resolving to array of records
|
|
187
|
-
*/
|
|
188
|
-
async find(object, query) {
|
|
189
|
-
const driver = this.getDriver(object);
|
|
190
|
-
// Convert DataEngineQueryOptions to QueryAST
|
|
191
|
-
let ast = { object };
|
|
192
|
-
if (query) {
|
|
193
|
-
// Map DataEngineQueryOptions to QueryAST
|
|
194
|
-
if (query.filter) {
|
|
195
|
-
ast.where = query.filter;
|
|
196
|
-
}
|
|
197
|
-
if (query.select) {
|
|
198
|
-
ast.fields = query.select;
|
|
199
|
-
}
|
|
200
|
-
if (query.sort) {
|
|
201
|
-
// Convert sort Record to orderBy array
|
|
202
|
-
// sort: { createdAt: -1, name: 'asc' } => orderBy: [{ field: 'createdAt', order: 'desc' }, { field: 'name', order: 'asc' }]
|
|
203
|
-
ast.orderBy = Object.entries(query.sort).map(([field, order]) => ({
|
|
204
|
-
field,
|
|
205
|
-
order: (order === -1 || order === 'desc') ? 'desc' : 'asc'
|
|
206
|
-
}));
|
|
207
|
-
}
|
|
208
|
-
// Handle both limit and top (top takes precedence)
|
|
209
|
-
if (query.top !== undefined) {
|
|
210
|
-
ast.limit = query.top;
|
|
211
|
-
}
|
|
212
|
-
else if (query.limit !== undefined) {
|
|
213
|
-
ast.limit = query.limit;
|
|
214
|
-
}
|
|
215
|
-
if (query.skip !== undefined) {
|
|
216
|
-
ast.offset = query.skip;
|
|
217
|
-
}
|
|
218
|
-
}
|
|
219
|
-
// Set default limit if not specified
|
|
220
|
-
if (ast.limit === undefined)
|
|
221
|
-
ast.limit = 100;
|
|
222
|
-
// Trigger Before Hook
|
|
223
|
-
const hookContext = {
|
|
224
|
-
object,
|
|
225
|
-
event: 'beforeFind',
|
|
226
|
-
input: { ast, options: undefined },
|
|
227
|
-
ql: this
|
|
228
|
-
};
|
|
229
|
-
await this.triggerHooks('beforeFind', hookContext);
|
|
230
|
-
try {
|
|
231
|
-
const result = await driver.find(object, hookContext.input.ast, hookContext.input.options);
|
|
232
|
-
// Trigger After Hook
|
|
233
|
-
hookContext.event = 'afterFind';
|
|
234
|
-
hookContext.result = result;
|
|
235
|
-
await this.triggerHooks('afterFind', hookContext);
|
|
236
|
-
return hookContext.result;
|
|
237
|
-
}
|
|
238
|
-
catch (e) {
|
|
239
|
-
// hookContext.error = e;
|
|
240
|
-
throw e;
|
|
241
|
-
}
|
|
242
|
-
}
|
|
243
|
-
async findOne(object, idOrQuery, options) {
|
|
244
|
-
const driver = this.getDriver(object);
|
|
245
|
-
let ast;
|
|
246
|
-
if (typeof idOrQuery === 'string') {
|
|
247
|
-
ast = {
|
|
248
|
-
object,
|
|
249
|
-
where: { _id: idOrQuery }
|
|
250
|
-
};
|
|
251
|
-
}
|
|
252
|
-
else {
|
|
253
|
-
// Assume query object
|
|
254
|
-
// reuse logic from find() or just wrap it
|
|
255
|
-
if (idOrQuery.where || idOrQuery.fields) {
|
|
256
|
-
ast = { object, ...idOrQuery };
|
|
257
|
-
}
|
|
258
|
-
else {
|
|
259
|
-
ast = { object, where: idOrQuery };
|
|
260
|
-
}
|
|
261
|
-
}
|
|
262
|
-
// Limit 1 for findOne
|
|
263
|
-
ast.limit = 1;
|
|
264
|
-
return driver.findOne(object, ast, options);
|
|
265
|
-
}
|
|
266
|
-
/**
|
|
267
|
-
* Insert a new record (IDataEngine interface)
|
|
268
|
-
*
|
|
269
|
-
* @param object - Object name
|
|
270
|
-
* @param data - Data to insert
|
|
271
|
-
* @returns Promise resolving to the created record
|
|
272
|
-
*/
|
|
273
|
-
async insert(object, data) {
|
|
274
|
-
const driver = this.getDriver(object);
|
|
275
|
-
// 1. Get Schema
|
|
276
|
-
const schema = SchemaRegistry.getObject(object);
|
|
277
|
-
if (schema) {
|
|
278
|
-
// TODO: Validation Logic
|
|
279
|
-
// validate(schema, data);
|
|
280
|
-
}
|
|
281
|
-
// 2. Trigger Before Hook
|
|
282
|
-
const hookContext = {
|
|
283
|
-
object,
|
|
284
|
-
event: 'beforeInsert',
|
|
285
|
-
input: { data, options: undefined },
|
|
286
|
-
ql: this
|
|
287
|
-
};
|
|
288
|
-
await this.triggerHooks('beforeInsert', hookContext);
|
|
289
|
-
// 3. Execute Driver
|
|
290
|
-
const result = await driver.create(object, hookContext.input.data, hookContext.input.options);
|
|
291
|
-
// 4. Trigger After Hook
|
|
292
|
-
hookContext.event = 'afterInsert';
|
|
293
|
-
hookContext.result = result;
|
|
294
|
-
await this.triggerHooks('afterInsert', hookContext);
|
|
295
|
-
return hookContext.result;
|
|
296
|
-
}
|
|
297
|
-
/**
|
|
298
|
-
* Update a record by ID (IDataEngine interface)
|
|
299
|
-
*
|
|
300
|
-
* @param object - Object name
|
|
301
|
-
* @param id - Record ID
|
|
302
|
-
* @param data - Updated data
|
|
303
|
-
* @returns Promise resolving to the updated record
|
|
304
|
-
*/
|
|
305
|
-
async update(object, id, data) {
|
|
306
|
-
const driver = this.getDriver(object);
|
|
307
|
-
const hookContext = {
|
|
308
|
-
object,
|
|
309
|
-
event: 'beforeUpdate',
|
|
310
|
-
input: { id, data, options: undefined },
|
|
311
|
-
ql: this
|
|
312
|
-
};
|
|
313
|
-
await this.triggerHooks('beforeUpdate', hookContext);
|
|
314
|
-
const result = await driver.update(object, hookContext.input.id, hookContext.input.data, hookContext.input.options);
|
|
315
|
-
hookContext.event = 'afterUpdate';
|
|
316
|
-
hookContext.result = result;
|
|
317
|
-
await this.triggerHooks('afterUpdate', hookContext);
|
|
318
|
-
return hookContext.result;
|
|
319
|
-
}
|
|
320
|
-
/**
|
|
321
|
-
* Delete a record by ID (IDataEngine interface)
|
|
322
|
-
*
|
|
323
|
-
* @param object - Object name
|
|
324
|
-
* @param id - Record ID
|
|
325
|
-
* @returns Promise resolving to true if deleted, false otherwise
|
|
326
|
-
*/
|
|
327
|
-
async delete(object, id) {
|
|
328
|
-
const driver = this.getDriver(object);
|
|
329
|
-
const hookContext = {
|
|
330
|
-
object,
|
|
331
|
-
event: 'beforeDelete',
|
|
332
|
-
input: { id, options: undefined },
|
|
333
|
-
ql: this
|
|
334
|
-
};
|
|
335
|
-
await this.triggerHooks('beforeDelete', hookContext);
|
|
336
|
-
const result = await driver.delete(object, hookContext.input.id, hookContext.input.options);
|
|
337
|
-
hookContext.event = 'afterDelete';
|
|
338
|
-
hookContext.result = result;
|
|
339
|
-
await this.triggerHooks('afterDelete', hookContext);
|
|
340
|
-
// Driver.delete() already returns boolean per DriverInterface spec
|
|
341
|
-
return hookContext.result;
|
|
342
|
-
}
|
|
343
|
-
}
|
|
344
|
-
export * from './plugin';
|
|
5
|
+
// Export Engine
|
|
6
|
+
export { ObjectQL } from './engine';
|
|
7
|
+
// Export Plugin Shim
|
|
8
|
+
export { ObjectQLPlugin } from './plugin';
|
|
9
|
+
// Moved logic to engine.ts
|
package/dist/plugin.d.ts
CHANGED
package/dist/plugin.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAE1D,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AAEtC,qBAAa,cAAe,YAAW,MAAM;IAC3C,IAAI,SAAqC;IACzC,IAAI,EAAG,UAAU,CAAU;IAC3B,OAAO,SAAW;IAElB,OAAO,CAAC,EAAE,CAAuB;IACjC,OAAO,CAAC,WAAW,CAAC,CAAsB;gBAE9B,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAStD,IAAI,CAAC,GAAG,EAAE,aAAa;IAkBvB,KAAK,CAAC,GAAG,EAAE,aAAa;CAoB/B"}
|
package/dist/plugin.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ObjectQL } from './
|
|
1
|
+
import { ObjectQL } from './engine';
|
|
2
2
|
import { ObjectStackProtocolImplementation } from './protocol';
|
|
3
3
|
export class ObjectQLPlugin {
|
|
4
4
|
constructor(ql, hostContext) {
|
|
@@ -18,20 +18,17 @@ export class ObjectQLPlugin {
|
|
|
18
18
|
this.ql = new ObjectQL(this.hostContext);
|
|
19
19
|
}
|
|
20
20
|
ctx.registerService('objectql', this.ql);
|
|
21
|
-
|
|
22
|
-
ctx.logger.log(`[ObjectQLPlugin] ObjectQL engine registered as service`);
|
|
21
|
+
ctx.logger.info('ObjectQL engine registered as service');
|
|
23
22
|
// Register Protocol Implementation
|
|
24
23
|
if (!this.ql) {
|
|
25
24
|
throw new Error('ObjectQL engine not initialized');
|
|
26
25
|
}
|
|
27
26
|
const protocolShim = new ObjectStackProtocolImplementation(this.ql);
|
|
28
27
|
ctx.registerService('protocol', protocolShim);
|
|
29
|
-
|
|
30
|
-
ctx.logger.log(`[ObjectQLPlugin] Protocol service registered`);
|
|
28
|
+
ctx.logger.info('Protocol service registered');
|
|
31
29
|
}
|
|
32
30
|
async start(ctx) {
|
|
33
|
-
|
|
34
|
-
ctx.logger.log(`[ObjectQLPlugin] ObjectQL engine initialized`);
|
|
31
|
+
ctx.logger.info('ObjectQL engine initialized');
|
|
35
32
|
// Discover features from Kernel Services
|
|
36
33
|
if (ctx.getServices && this.ql) {
|
|
37
34
|
const services = ctx.getServices();
|
|
@@ -39,14 +36,12 @@ export class ObjectQLPlugin {
|
|
|
39
36
|
if (name.startsWith('driver.')) {
|
|
40
37
|
// Register Driver
|
|
41
38
|
this.ql.registerDriver(service);
|
|
42
|
-
|
|
43
|
-
ctx.logger.log(`[ObjectQLPlugin] Discovered and registered driver service: ${name}`);
|
|
39
|
+
ctx.logger.debug('Discovered and registered driver service', { serviceName: name });
|
|
44
40
|
}
|
|
45
41
|
if (name.startsWith('app.')) {
|
|
46
42
|
// Register App
|
|
47
43
|
this.ql.registerApp(service); // service is Manifest
|
|
48
|
-
|
|
49
|
-
ctx.logger.log(`[ObjectQLPlugin] Discovered and registered app service: ${name}`);
|
|
44
|
+
ctx.logger.debug('Discovered and registered app service', { serviceName: name });
|
|
50
45
|
}
|
|
51
46
|
}
|
|
52
47
|
}
|
package/dist/protocol.d.ts
CHANGED
|
@@ -1,43 +1,113 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ObjectStackProtocol } from '@objectstack/spec/api';
|
|
2
2
|
import { IDataEngine } from '@objectstack/core';
|
|
3
|
-
|
|
3
|
+
import type { BatchUpdateRequest, BatchUpdateResponse, UpdateManyDataRequest, DeleteManyDataRequest } from '@objectstack/spec/api';
|
|
4
|
+
import type { MetadataCacheRequest, MetadataCacheResponse } from '@objectstack/spec/api';
|
|
5
|
+
import type { CreateViewRequest, UpdateViewRequest, ListViewsRequest, ViewResponse, ListViewsResponse } from '@objectstack/spec/api';
|
|
6
|
+
export declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
|
|
4
7
|
private engine;
|
|
8
|
+
private viewStorage;
|
|
5
9
|
constructor(engine: IDataEngine);
|
|
6
|
-
getDiscovery(): {
|
|
7
|
-
name: string;
|
|
10
|
+
getDiscovery(_request: {}): Promise<{
|
|
8
11
|
version: string;
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
getMetaItems(
|
|
17
|
-
|
|
18
|
-
|
|
12
|
+
apiName: string;
|
|
13
|
+
capabilities: string[];
|
|
14
|
+
endpoints: {};
|
|
15
|
+
}>;
|
|
16
|
+
getMetaTypes(_request: {}): Promise<{
|
|
17
|
+
types: string[];
|
|
18
|
+
}>;
|
|
19
|
+
getMetaItems(request: {
|
|
20
|
+
type: string;
|
|
21
|
+
}): Promise<{
|
|
22
|
+
type: string;
|
|
23
|
+
items: unknown[];
|
|
24
|
+
}>;
|
|
25
|
+
getMetaItem(request: {
|
|
26
|
+
type: string;
|
|
27
|
+
name: string;
|
|
28
|
+
}): Promise<{
|
|
19
29
|
type: string;
|
|
30
|
+
name: string;
|
|
31
|
+
item: unknown;
|
|
32
|
+
}>;
|
|
33
|
+
getUiView(request: {
|
|
34
|
+
object: string;
|
|
35
|
+
type: 'list' | 'form';
|
|
36
|
+
}): Promise<{
|
|
37
|
+
object: string;
|
|
38
|
+
type: "list" | "form";
|
|
39
|
+
view: any;
|
|
40
|
+
}>;
|
|
41
|
+
findData(request: {
|
|
42
|
+
object: string;
|
|
43
|
+
query?: any;
|
|
44
|
+
}): Promise<{
|
|
45
|
+
object: string;
|
|
46
|
+
value: any[];
|
|
47
|
+
records: any[];
|
|
48
|
+
total: number;
|
|
49
|
+
hasMore: boolean;
|
|
50
|
+
}>;
|
|
51
|
+
getData(request: {
|
|
20
52
|
object: string;
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
}
|
|
53
|
+
id: string;
|
|
54
|
+
}): Promise<{
|
|
55
|
+
object: string;
|
|
56
|
+
id: string;
|
|
57
|
+
record: any;
|
|
58
|
+
}>;
|
|
59
|
+
createData(request: {
|
|
60
|
+
object: string;
|
|
61
|
+
data: any;
|
|
62
|
+
}): Promise<{
|
|
63
|
+
object: string;
|
|
64
|
+
id: any;
|
|
65
|
+
record: any;
|
|
66
|
+
}>;
|
|
67
|
+
updateData(request: {
|
|
68
|
+
object: string;
|
|
69
|
+
id: string;
|
|
70
|
+
data: any;
|
|
71
|
+
}): Promise<{
|
|
72
|
+
object: string;
|
|
73
|
+
id: string;
|
|
74
|
+
record: any;
|
|
75
|
+
}>;
|
|
76
|
+
deleteData(request: {
|
|
77
|
+
object: string;
|
|
78
|
+
id: string;
|
|
79
|
+
}): Promise<{
|
|
80
|
+
object: string;
|
|
81
|
+
id: string;
|
|
82
|
+
success: boolean;
|
|
83
|
+
}>;
|
|
84
|
+
getMetaItemCached(request: {
|
|
27
85
|
type: string;
|
|
86
|
+
name: string;
|
|
87
|
+
cacheRequest?: MetadataCacheRequest;
|
|
88
|
+
}): Promise<MetadataCacheResponse>;
|
|
89
|
+
batchData(_request: {
|
|
90
|
+
object: string;
|
|
91
|
+
request: BatchUpdateRequest;
|
|
92
|
+
}): Promise<BatchUpdateResponse>;
|
|
93
|
+
createManyData(request: {
|
|
94
|
+
object: string;
|
|
95
|
+
records: any[];
|
|
96
|
+
}): Promise<any>;
|
|
97
|
+
updateManyData(_request: UpdateManyDataRequest): Promise<any>;
|
|
98
|
+
deleteManyData(request: DeleteManyDataRequest): Promise<any>;
|
|
99
|
+
createView(request: CreateViewRequest): Promise<ViewResponse>;
|
|
100
|
+
getView(request: {
|
|
101
|
+
id: string;
|
|
102
|
+
}): Promise<ViewResponse>;
|
|
103
|
+
listViews(request: ListViewsRequest): Promise<ListViewsResponse>;
|
|
104
|
+
updateView(request: UpdateViewRequest): Promise<ViewResponse>;
|
|
105
|
+
deleteView(request: {
|
|
106
|
+
id: string;
|
|
107
|
+
}): Promise<{
|
|
108
|
+
success: boolean;
|
|
28
109
|
object: string;
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
fields: {
|
|
32
|
-
field: string;
|
|
33
|
-
}[];
|
|
34
|
-
}[];
|
|
35
|
-
columns?: undefined;
|
|
36
|
-
};
|
|
37
|
-
findData(object: string, query: any): Promise<any[]>;
|
|
38
|
-
getData(object: string, id: string): Promise<any>;
|
|
39
|
-
createData(object: string, data: any): Promise<any>;
|
|
40
|
-
updateData(object: string, id: string, data: any): Promise<any>;
|
|
41
|
-
deleteData(object: string, id: string): Promise<boolean>;
|
|
110
|
+
id: string;
|
|
111
|
+
}>;
|
|
42
112
|
}
|
|
43
113
|
//# sourceMappingURL=protocol.d.ts.map
|
package/dist/protocol.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EACR,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,KAAK,EACR,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EAEpB,MAAM,uBAAuB,CAAC;AAmB/B,qBAAa,iCAAkC,YAAW,mBAAmB;IACzE,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,WAAW,CAAqC;gBAE5C,MAAM,EAAE,WAAW;IAIzB,YAAY,CAAC,QAAQ,EAAE,EAAE;;;;;;IASzB,YAAY,CAAC,QAAQ,EAAE,EAAE;;;IAMzB,YAAY,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;;;IAOtC,WAAW,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;;;;;IAQnD,SAAS,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;;;;;IAmC5D,QAAQ,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE;;;;;;;IAsBjD,OAAO,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE;;;;;IAc/C,UAAU,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAE;;;;;IASjD,UAAU,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAE;;;;;IAU7D,UAAU,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE;;;;;IAclD,iBAAiB,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,oBAAoB,CAAA;KAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA4C/H,SAAS,CAAC,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQlG,cAAc,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IASzE,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAK7D,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAY5D,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC;IAgB7D,OAAO,CAAC,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAMvD,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAgBhE,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC;IAW7D,UAAU,CAAC,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;CAKvG"}
|