@quatrain/core 0.5.6 → 1.0.0-beta2
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/lib/Backend.d.ts +28 -0
- package/lib/Backend.js +0 -9
- package/lib/Core.d.ts +8 -8
- package/lib/Core.js +13 -3
- package/lib/backends/AbstractAdapter.d.ts +6 -42
- package/lib/backends/AbstractAdapter.js +0 -5
- package/lib/backends/BackendInterface.d.ts +13 -0
- package/lib/backends/BackendInterface.js +2 -0
- package/lib/backends/MockAdapter.d.ts +6 -4
- package/lib/backends/MockAdapter.js +15 -6
- package/lib/backends/Query.d.ts +20 -8
- package/lib/backends/Query.js +10 -6
- package/lib/backends/index.d.ts +4 -3
- package/lib/backends/middlewares/InjectKeywordsMiddleware.d.ts +9 -0
- package/lib/backends/middlewares/InjectKeywordsMiddleware.js +47 -0
- package/lib/backends/middlewares/InjectMetaMiddleware copy.d.ts +12 -0
- package/lib/backends/middlewares/InjectMetaMiddleware copy.js +30 -0
- package/lib/backends/middlewares/InjectMetaMiddleware.d.ts +3 -4
- package/lib/backends/middlewares/InjectMetaMiddleware.js +3 -3
- package/lib/backends/types/BackendInterface.d.ts +13 -0
- package/lib/backends/types/BackendInterface.js +2 -0
- package/lib/common/statuses.d.ts +3 -0
- package/lib/common/statuses.js +4 -1
- package/lib/components/AbstractObject.d.ts +6 -0
- package/lib/components/AbstractObject.js +8 -0
- package/lib/components/BaseObject.d.ts +3 -3
- package/lib/components/BaseObject.js +2 -0
- package/lib/components/BaseObjectCore.d.ts +6 -2
- package/lib/components/BaseObjectCore.js +6 -2
- package/lib/components/BaseObjectProperties.d.ts +13 -0
- package/lib/components/BaseObjectProperties.js +87 -0
- package/lib/components/BaseRepository.d.ts +13 -13
- package/lib/components/BaseRepository.js +18 -20
- package/lib/components/DataObject.d.ts +8 -1
- package/lib/components/DataObject.js +32 -9
- package/lib/components/Entity.d.ts +2 -16
- package/lib/components/Entity.js +4 -2
- package/lib/components/EntityProperties.d.ts +1 -0
- package/lib/components/EntityProperties.js +54 -0
- package/lib/components/EntityRepository.d.ts +1 -1
- package/lib/components/ObjectUri.js +1 -1
- package/lib/components/User.d.ts +2 -3
- package/lib/components/User.js +4 -2
- package/lib/components/UserProperties.d.ts +1 -0
- package/lib/components/UserProperties.js +103 -0
- package/lib/components/UserRepository.d.ts +2 -2
- package/lib/components/index.d.ts +2 -1
- package/lib/components/index.js +6 -1
- package/lib/components/types/DataObjectClass.d.ts +3 -0
- package/lib/components/types/RepositoryClass.d.ts +2 -2
- package/lib/components/types/UserClass.d.ts +3 -0
- package/lib/components/types/UserClass.js +2 -0
- package/lib/index.d.ts +5 -3
- package/lib/index.js +6 -2
- package/lib/properties/BaseProperty.js +1 -1
- package/lib/properties/CollectionProperty.d.ts +2 -2
- package/lib/properties/HashProperty.d.ts +6 -0
- package/lib/properties/HashProperty.js +8 -0
- package/lib/properties/ObjectProperty.d.ts +5 -5
- package/lib/properties/ObjectProperty.js +56 -3
- package/lib/properties/Property.d.ts +9 -2
- package/lib/properties/StringProperty.d.ts +1 -1
- package/lib/properties/types/PropertyClassType.d.ts +1 -0
- package/package.json +4 -3
package/lib/Backend.d.ts
CHANGED
|
@@ -1,6 +1,34 @@
|
|
|
1
|
+
import Middleware from "./backends/middlewares/Middleware";
|
|
1
2
|
export declare enum BackendAction {
|
|
2
3
|
CREATE = "create",
|
|
3
4
|
READ = "read",
|
|
4
5
|
UPDATE = "update",
|
|
5
6
|
DELETE = "delete"
|
|
6
7
|
}
|
|
8
|
+
/**
|
|
9
|
+
* Default interface for a backend record
|
|
10
|
+
*/
|
|
11
|
+
export interface BackendRecordType {
|
|
12
|
+
uid: string | undefined;
|
|
13
|
+
path: string | undefined;
|
|
14
|
+
[key: string]: any;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Backend Parameters acceptable keys
|
|
18
|
+
*/
|
|
19
|
+
export type BackendParametersKeys = 'host' | 'alias' | 'mapping' | 'middlewares' | 'config' | 'fixtures' | 'softDelete' | 'debug';
|
|
20
|
+
/**
|
|
21
|
+
* Backend parameters interface
|
|
22
|
+
*/
|
|
23
|
+
export interface BackendParameters {
|
|
24
|
+
host?: string;
|
|
25
|
+
alias?: string;
|
|
26
|
+
mapping?: {
|
|
27
|
+
[x: string]: any;
|
|
28
|
+
};
|
|
29
|
+
middlewares?: Middleware[];
|
|
30
|
+
config?: any;
|
|
31
|
+
fixtures?: any;
|
|
32
|
+
softDelete?: boolean;
|
|
33
|
+
debug?: boolean;
|
|
34
|
+
}
|
package/lib/Backend.js
CHANGED
|
@@ -1,15 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
// export const CREATE = 'create'
|
|
3
|
-
// export const READ = 'read'
|
|
4
|
-
// export const UPDATE = 'update'
|
|
5
|
-
// export const DELETE = 'delete'
|
|
6
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
3
|
exports.BackendAction = void 0;
|
|
8
|
-
// export type BackendActions =
|
|
9
|
-
// | typeof CREATE
|
|
10
|
-
// | typeof READ
|
|
11
|
-
// | typeof UPDATE
|
|
12
|
-
// | typeof DELETE
|
|
13
4
|
var BackendAction;
|
|
14
5
|
(function (BackendAction) {
|
|
15
6
|
BackendAction["CREATE"] = "create";
|
package/lib/Core.d.ts
CHANGED
|
@@ -1,19 +1,17 @@
|
|
|
1
1
|
import { AbstractAdapter } from './backends/AbstractAdapter';
|
|
2
|
-
import {
|
|
2
|
+
import { UserCore } from './components/User';
|
|
3
3
|
import { DataObjectClass } from './components/types/DataObjectClass';
|
|
4
4
|
export type BackendRegistry<T extends AbstractAdapter> = {
|
|
5
5
|
[x: string]: T;
|
|
6
6
|
};
|
|
7
7
|
export declare class Core {
|
|
8
8
|
static defaultBackend: string;
|
|
9
|
-
static
|
|
9
|
+
static userClass: typeof UserCore;
|
|
10
10
|
static classRegistry: {
|
|
11
11
|
[key: string]: any;
|
|
12
12
|
};
|
|
13
|
-
static logger:
|
|
14
|
-
|
|
15
|
-
(message?: any, ...optionalParams: any[]): void;
|
|
16
|
-
};
|
|
13
|
+
static logger: Console;
|
|
14
|
+
static timestamp: () => string;
|
|
17
15
|
protected static _backends: BackendRegistry<any>;
|
|
18
16
|
static definition(key: string): {
|
|
19
17
|
manifest: {
|
|
@@ -23,6 +21,8 @@ export declare class Core {
|
|
|
23
21
|
};
|
|
24
22
|
static addBackend(backend: AbstractAdapter, alias: string, setDefault?: boolean): void;
|
|
25
23
|
static getBackend<T extends AbstractAdapter>(alias?: string): T;
|
|
24
|
+
static addClass(name: string, obj: any): void;
|
|
25
|
+
static getClass(name: string): any;
|
|
26
26
|
/**
|
|
27
27
|
* Returns the class to use for a data object
|
|
28
28
|
* This is currently just a stub that will be implemented from config in the future
|
|
@@ -32,8 +32,8 @@ export declare class Core {
|
|
|
32
32
|
/**
|
|
33
33
|
* Log message using defined logger
|
|
34
34
|
* This is currently just a stub that will be implemented from config in the future
|
|
35
|
-
* @param message string
|
|
35
|
+
* @param message string | object
|
|
36
36
|
* @param level string
|
|
37
37
|
*/
|
|
38
|
-
static log(message:
|
|
38
|
+
static log(message: any, src?: string, level?: string): void;
|
|
39
39
|
}
|
package/lib/Core.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.Core = void 0;
|
|
4
4
|
const DataObject_1 = require("./components/DataObject");
|
|
5
|
+
const User_1 = require("./components/User");
|
|
5
6
|
class Core {
|
|
6
7
|
static definition(key) {
|
|
7
8
|
return {
|
|
@@ -25,6 +26,12 @@ class Core {
|
|
|
25
26
|
throw new Error(`Unknown backend alias: '${alias}'`);
|
|
26
27
|
}
|
|
27
28
|
}
|
|
29
|
+
static addClass(name, obj) {
|
|
30
|
+
Core.classRegistry[name] = obj;
|
|
31
|
+
}
|
|
32
|
+
static getClass(name) {
|
|
33
|
+
return Core.classRegistry[name];
|
|
34
|
+
}
|
|
28
35
|
/**
|
|
29
36
|
* Returns the class to use for a data object
|
|
30
37
|
* This is currently just a stub that will be implemented from config in the future
|
|
@@ -36,15 +43,18 @@ class Core {
|
|
|
36
43
|
/**
|
|
37
44
|
* Log message using defined logger
|
|
38
45
|
* This is currently just a stub that will be implemented from config in the future
|
|
39
|
-
* @param message string
|
|
46
|
+
* @param message string | object
|
|
40
47
|
* @param level string
|
|
41
48
|
*/
|
|
42
49
|
static log(message, src = 'Core', level = 'NOTICE') {
|
|
43
|
-
Core.logger(`${Date.now()} - [${src}] ${message}`);
|
|
50
|
+
Core.logger.log(`${Date.now()} - [${src}] ${typeof message === 'string' ? message : JSON.stringify(message)}`);
|
|
44
51
|
}
|
|
45
52
|
}
|
|
46
53
|
exports.Core = Core;
|
|
47
54
|
Core.defaultBackend = '@default';
|
|
55
|
+
Core.userClass = User_1.UserCore;
|
|
48
56
|
Core.classRegistry = {};
|
|
49
|
-
Core.logger = console
|
|
57
|
+
Core.logger = console;
|
|
58
|
+
// How timestamp are formatted
|
|
59
|
+
Core.timestamp = () => new Date().toISOString();
|
|
50
60
|
Core._backends = {};
|
|
@@ -1,46 +1,11 @@
|
|
|
1
|
-
import { BackendAction } from '../Backend';
|
|
1
|
+
import { BackendAction, BackendParameters, BackendParametersKeys } from '../Backend';
|
|
2
2
|
import { DataObjectClass } from '../components/types/DataObjectClass';
|
|
3
|
+
import { BackendInterface } from './types/BackendInterface';
|
|
3
4
|
import { Filter } from './Filter';
|
|
4
5
|
import { Filters } from './Filters';
|
|
5
|
-
import { Query } from './Query';
|
|
6
|
+
import { Query, QueryResultType } from './Query';
|
|
6
7
|
import { SortAndLimit } from './SortAndLimit';
|
|
7
8
|
import Middleware from './middlewares/Middleware';
|
|
8
|
-
/**
|
|
9
|
-
* Default interface for a backend record
|
|
10
|
-
*/
|
|
11
|
-
export interface BackendRecordType {
|
|
12
|
-
uid: string | undefined;
|
|
13
|
-
path: string | undefined;
|
|
14
|
-
[key: string]: any;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* Backend Parameters acceptable keys
|
|
18
|
-
*/
|
|
19
|
-
export type BackendParametersKeys = 'host' | 'alias' | 'mapping' | 'middlewares' | 'config' | 'fixtures' | 'softDelete' | 'debug';
|
|
20
|
-
/**
|
|
21
|
-
* Backend parameters interface
|
|
22
|
-
*/
|
|
23
|
-
export interface BackendParameters {
|
|
24
|
-
host?: string;
|
|
25
|
-
alias?: string;
|
|
26
|
-
mapping?: {
|
|
27
|
-
[x: string]: any;
|
|
28
|
-
};
|
|
29
|
-
middlewares?: Middleware[];
|
|
30
|
-
config?: any;
|
|
31
|
-
fixtures?: any;
|
|
32
|
-
softDelete?: boolean;
|
|
33
|
-
debug?: boolean;
|
|
34
|
-
}
|
|
35
|
-
export interface BackendInterface {
|
|
36
|
-
create(dataObject: DataObjectClass<any>, desiredUid: string | undefined): Promise<DataObjectClass<any>>;
|
|
37
|
-
read(param: string | DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
38
|
-
update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
39
|
-
delete(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
40
|
-
query(query: Query<any>): Promise<DataObjectClass<any>[]>;
|
|
41
|
-
find(dataObject: DataObjectClass<any>, filters: Filters | Filter[] | undefined, pagination: SortAndLimit | undefined): Promise<DataObjectClass<any>[]>;
|
|
42
|
-
count(query: Query<any>): Promise<number>;
|
|
43
|
-
}
|
|
44
9
|
export declare abstract class AbstractAdapter implements BackendInterface {
|
|
45
10
|
protected _alias: string;
|
|
46
11
|
protected _params: BackendParameters;
|
|
@@ -52,7 +17,7 @@ export declare abstract class AbstractAdapter implements BackendInterface {
|
|
|
52
17
|
set alias(alias: string);
|
|
53
18
|
get alias(): string;
|
|
54
19
|
getCollection(dao: DataObjectClass<any>): string | undefined;
|
|
55
|
-
abstract create(dataObject: DataObjectClass<any
|
|
20
|
+
abstract create(dataObject: DataObjectClass<any>, desiredUid?: string | undefined): Promise<DataObjectClass<any>>;
|
|
56
21
|
abstract read(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
57
22
|
abstract update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
58
23
|
abstract delete(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
@@ -62,9 +27,8 @@ export declare abstract class AbstractAdapter implements BackendInterface {
|
|
|
62
27
|
* @param query
|
|
63
28
|
* @returns Array
|
|
64
29
|
*/
|
|
65
|
-
query(query: Query<any>): Promise<DataObjectClass<any
|
|
66
|
-
|
|
67
|
-
abstract find(dataObject: DataObjectClass<any>, filters: Filters | Filter[] | undefined, pagination: SortAndLimit | undefined): Promise<DataObjectClass<any>[]>;
|
|
30
|
+
query(query: Query<any>): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
31
|
+
abstract find(dataObject: DataObjectClass<any>, filters: Filters | Filter[] | undefined, pagination: SortAndLimit | undefined): Promise<QueryResultType<any>>;
|
|
68
32
|
log(message: string): void;
|
|
69
33
|
executeMiddlewares(dataObject: DataObjectClass<any>, action: BackendAction): Promise<DataObjectClass<any>>;
|
|
70
34
|
}
|
|
@@ -46,11 +46,6 @@ class AbstractAdapter {
|
|
|
46
46
|
return yield this.find(yield query.obj.daoFactory(), query.filters, query.sortAndLimit);
|
|
47
47
|
});
|
|
48
48
|
}
|
|
49
|
-
count(query) {
|
|
50
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
51
|
-
return (yield this.find(yield query.obj.daoFactory(), query.filters, undefined)).length;
|
|
52
|
-
});
|
|
53
|
-
}
|
|
54
49
|
log(message) {
|
|
55
50
|
if (this._params['debug'] === true) {
|
|
56
51
|
console.log(message);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DataObjectClass } from '../components';
|
|
2
|
+
import { Filter } from './Filter';
|
|
3
|
+
import { Filters } from './Filters';
|
|
4
|
+
import { Query, QueryResultType } from './Query';
|
|
5
|
+
import { SortAndLimit } from './SortAndLimit';
|
|
6
|
+
export interface BackendInterface {
|
|
7
|
+
create(dataObject: DataObjectClass<any>, desiredUid: string | undefined): Promise<DataObjectClass<any>>;
|
|
8
|
+
read(param: string | DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
9
|
+
update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
10
|
+
delete(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
11
|
+
query(query: Query<any>): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
12
|
+
find(dataObject: DataObjectClass<any>, filters: Filters | Filter[] | undefined, pagination: SortAndLimit | undefined): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
13
|
+
}
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { DataObjectClass } from '../components/types/DataObjectClass';
|
|
2
|
+
import { QueryResultType } from './Query';
|
|
3
3
|
import { Filter } from './Filter';
|
|
4
4
|
import { Filters } from './Filters';
|
|
5
5
|
import { SortAndLimit } from './SortAndLimit';
|
|
6
|
-
import {
|
|
6
|
+
import { AbstractAdapter } from './AbstractAdapter';
|
|
7
|
+
import { BackendInterface } from './types/BackendInterface';
|
|
8
|
+
import { BackendRecordType } from '../Backend';
|
|
7
9
|
export declare class MockAdapter extends AbstractAdapter implements BackendInterface {
|
|
8
10
|
protected static _fixtures: any;
|
|
9
11
|
/**
|
|
@@ -19,5 +21,5 @@ export declare class MockAdapter extends AbstractAdapter implements BackendInter
|
|
|
19
21
|
update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
20
22
|
delete(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
21
23
|
deleteCollection(collection: string, batchSize?: number | undefined): Promise<void>;
|
|
22
|
-
find(dataObject: DataObjectClass<any>, filters?: Filters | Filter[] | undefined, pagination?: SortAndLimit | undefined): Promise<DataObjectClass<any
|
|
24
|
+
find(dataObject: DataObjectClass<any>, filters?: Filters | Filter[] | undefined, pagination?: SortAndLimit | undefined): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
23
25
|
}
|
|
@@ -10,11 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
12
|
exports.MockAdapter = void 0;
|
|
13
|
-
const
|
|
13
|
+
const Core_1 = require("../Core");
|
|
14
14
|
const ObjectUri_1 = require("../components/ObjectUri");
|
|
15
15
|
const faker_1 = require("@faker-js/faker");
|
|
16
16
|
const BackendError_1 = require("./BackendError");
|
|
17
17
|
const ResourcesErrors_1 = require("../common/ResourcesErrors");
|
|
18
|
+
const AbstractAdapter_1 = require("./AbstractAdapter");
|
|
18
19
|
class MockAdapter extends AbstractAdapter_1.AbstractAdapter {
|
|
19
20
|
/**
|
|
20
21
|
* Inject fixtures data to backend adapter
|
|
@@ -116,12 +117,12 @@ class MockAdapter extends AbstractAdapter_1.AbstractAdapter {
|
|
|
116
117
|
find(dataObject, filters = undefined, pagination = undefined) {
|
|
117
118
|
return __awaiter(this, void 0, void 0, function* () {
|
|
118
119
|
const limit = (pagination === null || pagination === void 0 ? void 0 : pagination.limits.batch) || 1e10;
|
|
119
|
-
let
|
|
120
|
+
let items = [];
|
|
120
121
|
const collection = this.getCollection(dataObject);
|
|
121
122
|
// TODO filter only records matchinf collection
|
|
122
123
|
for (let key in MockAdapter.getFixtures()) {
|
|
123
124
|
let keep = true;
|
|
124
|
-
if (key.startsWith(`${collection}/`) &&
|
|
125
|
+
if (key.startsWith(`${collection}/`) && items.length <= limit) {
|
|
125
126
|
const dao = yield dataObject.clone(MockAdapter.getFixture(key));
|
|
126
127
|
if (filters) {
|
|
127
128
|
if (Array.isArray(filters)) {
|
|
@@ -164,15 +165,23 @@ class MockAdapter extends AbstractAdapter_1.AbstractAdapter {
|
|
|
164
165
|
}
|
|
165
166
|
if (keep) {
|
|
166
167
|
dao.uri = new ObjectUri_1.ObjectUri(key);
|
|
167
|
-
|
|
168
|
+
items.push(dao);
|
|
168
169
|
}
|
|
169
170
|
}
|
|
170
171
|
}
|
|
171
172
|
if (pagination && pagination.sortings.length > 0) {
|
|
172
|
-
|
|
173
|
+
items = items.sort((a, b) => Number(a.val(pagination.sortings[0].prop) >
|
|
173
174
|
b.val(pagination.sortings[0].prop)));
|
|
174
175
|
}
|
|
175
|
-
return
|
|
176
|
+
return {
|
|
177
|
+
items,
|
|
178
|
+
meta: {
|
|
179
|
+
count: 100,
|
|
180
|
+
offset: (pagination === null || pagination === void 0 ? void 0 : pagination.limits.offset) || 0,
|
|
181
|
+
batch: (pagination === null || pagination === void 0 ? void 0 : pagination.limits.batch) || 10,
|
|
182
|
+
executionTime: Core_1.Core.timestamp(),
|
|
183
|
+
},
|
|
184
|
+
};
|
|
176
185
|
});
|
|
177
186
|
}
|
|
178
187
|
}
|
package/lib/backends/Query.d.ts
CHANGED
|
@@ -2,18 +2,29 @@ import { Filter } from './Filter';
|
|
|
2
2
|
import { Limits } from './Limits';
|
|
3
3
|
import { Sorting } from './Sorting';
|
|
4
4
|
import { SortAndLimit } from './SortAndLimit';
|
|
5
|
-
import { BackendInterface } from './
|
|
5
|
+
import { BackendInterface } from './types/BackendInterface';
|
|
6
6
|
import { DataObjectClass, ObjectUri } from '../components';
|
|
7
|
-
import { Persisted } from '../components/types/Persisted';
|
|
8
|
-
import { BaseObject } from '../components/BaseObject';
|
|
9
7
|
import { BaseObjectCore } from '../components/BaseObjectCore';
|
|
10
8
|
export declare const AS_OBJECTURIS = "objectUris";
|
|
11
9
|
export declare const AS_DATAOBJECTS = "dataObjects";
|
|
12
10
|
export declare const AS_INSTANCES = "classInstances";
|
|
11
|
+
export type QueryMetaType = {
|
|
12
|
+
count: number;
|
|
13
|
+
offset: number;
|
|
14
|
+
batch: number;
|
|
15
|
+
executionTime: string | number;
|
|
16
|
+
sortField?: string;
|
|
17
|
+
sortOrder?: 'asc' | 'desc';
|
|
18
|
+
};
|
|
19
|
+
export type QueryResultType<T> = {
|
|
20
|
+
items: Array<T>;
|
|
21
|
+
meta: QueryMetaType;
|
|
22
|
+
};
|
|
13
23
|
export declare enum returnAs {
|
|
14
24
|
AS_OBJECTURIS = "objectUris",
|
|
15
25
|
AS_DATAOBJECTS = "dataObjects",
|
|
16
|
-
AS_INSTANCES = "classInstances"
|
|
26
|
+
AS_INSTANCES = "classInstances",
|
|
27
|
+
AS_IS = "asIs"
|
|
17
28
|
}
|
|
18
29
|
export declare class Query<T extends typeof BaseObjectCore> {
|
|
19
30
|
protected _obj: T;
|
|
@@ -21,6 +32,7 @@ export declare class Query<T extends typeof BaseObjectCore> {
|
|
|
21
32
|
filters: Filter[];
|
|
22
33
|
sortings: Sorting[];
|
|
23
34
|
limits: Limits;
|
|
35
|
+
meta: any;
|
|
24
36
|
constructor(obj: T, params?: {
|
|
25
37
|
[x: string]: any;
|
|
26
38
|
});
|
|
@@ -31,8 +43,8 @@ export declare class Query<T extends typeof BaseObjectCore> {
|
|
|
31
43
|
offset(offset?: number): this;
|
|
32
44
|
batch(batch?: number): this;
|
|
33
45
|
get sortAndLimit(): SortAndLimit;
|
|
34
|
-
fetch(backend?: BackendInterface): Promise<DataObjectClass<any
|
|
35
|
-
fetchAsUri(backend?: BackendInterface): Promise<ObjectUri
|
|
36
|
-
fetchAsInstances(backend?: BackendInterface): Promise<
|
|
37
|
-
execute(as?: returnAs, backend?: BackendInterface): Promise<
|
|
46
|
+
fetch(backend?: BackendInterface): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
47
|
+
fetchAsUri(backend?: BackendInterface): Promise<QueryResultType<ObjectUri>>;
|
|
48
|
+
fetchAsInstances(backend?: BackendInterface): Promise<QueryResultType<T>>;
|
|
49
|
+
execute(as?: returnAs, backend?: BackendInterface): Promise<QueryResultType<any>>;
|
|
38
50
|
}
|
package/lib/backends/Query.js
CHANGED
|
@@ -23,6 +23,7 @@ var returnAs;
|
|
|
23
23
|
returnAs["AS_OBJECTURIS"] = "objectUris";
|
|
24
24
|
returnAs["AS_DATAOBJECTS"] = "dataObjects";
|
|
25
25
|
returnAs["AS_INSTANCES"] = "classInstances";
|
|
26
|
+
returnAs["AS_IS"] = "asIs";
|
|
26
27
|
})(returnAs || (exports.returnAs = returnAs = {}));
|
|
27
28
|
class Query {
|
|
28
29
|
constructor(obj, params = {}) {
|
|
@@ -31,18 +32,20 @@ class Query {
|
|
|
31
32
|
this.filters = [];
|
|
32
33
|
this.sortings = [];
|
|
33
34
|
this.limits = new Limits_1.Limits();
|
|
35
|
+
this.meta = {};
|
|
34
36
|
}
|
|
35
37
|
get obj() {
|
|
36
38
|
return this._obj;
|
|
37
39
|
}
|
|
38
40
|
where(param, value = null, operator = 'equals') {
|
|
41
|
+
console.log(`received value`, value);
|
|
39
42
|
if (typeof param == 'object') {
|
|
40
43
|
this.filters.push(param);
|
|
41
44
|
}
|
|
42
45
|
else {
|
|
43
46
|
if (operator === 'equals' && Array.isArray(value)) {
|
|
44
47
|
// auto-convert operator if value is an array
|
|
45
|
-
operator = '
|
|
48
|
+
operator = 'contains'; // Any'
|
|
46
49
|
}
|
|
47
50
|
this.filters.push(new Filter_1.Filter(param, value, operator));
|
|
48
51
|
}
|
|
@@ -79,22 +82,23 @@ class Query {
|
|
|
79
82
|
}
|
|
80
83
|
fetchAsUri(backend = Core_1.Core.getBackend()) {
|
|
81
84
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82
|
-
const
|
|
83
|
-
return yield Promise.all(
|
|
85
|
+
const { items, meta } = yield this.fetch(backend);
|
|
86
|
+
return { items: yield Promise.all(items.map((dao) => dao.uri)), meta };
|
|
84
87
|
});
|
|
85
88
|
}
|
|
86
89
|
fetchAsInstances(backend = Core_1.Core.getBackend()) {
|
|
87
90
|
return __awaiter(this, void 0, void 0, function* () {
|
|
88
|
-
const
|
|
91
|
+
const { items, meta } = yield this.fetch(backend);
|
|
89
92
|
const instances = [];
|
|
90
|
-
for (const item of
|
|
93
|
+
for (const item of items) {
|
|
91
94
|
instances.push(this._obj.fromDataObject(item));
|
|
92
95
|
}
|
|
93
|
-
return instances;
|
|
96
|
+
return { items: instances, meta };
|
|
94
97
|
});
|
|
95
98
|
}
|
|
96
99
|
execute(as = returnAs.AS_DATAOBJECTS, backend = Core_1.Core.getBackend()) {
|
|
97
100
|
return __awaiter(this, void 0, void 0, function* () {
|
|
101
|
+
//<DataObjectClass<any>[] | ObjectUri[] | Persisted<BaseObject>[]> {
|
|
98
102
|
//</any><Array<T2> | Array<DataObject> | Array<ObjectUri>> {
|
|
99
103
|
try {
|
|
100
104
|
switch (as) {
|
package/lib/backends/index.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import { AbstractAdapter
|
|
1
|
+
import { AbstractAdapter } from './AbstractAdapter';
|
|
2
2
|
import { MockAdapter } from './MockAdapter';
|
|
3
3
|
import { BackendError } from './BackendError';
|
|
4
|
-
import {
|
|
4
|
+
import { BackendInterface } from './types/BackendInterface';
|
|
5
|
+
import { Query, QueryResultType, QueryMetaType } from './Query';
|
|
5
6
|
import { Filter } from './Filter';
|
|
6
7
|
import { Filters } from './Filters';
|
|
7
8
|
import { Sorting } from './Sorting';
|
|
8
9
|
import { Limits } from './Limits';
|
|
9
10
|
import { SortAndLimit } from './SortAndLimit';
|
|
10
|
-
export {
|
|
11
|
+
export { BackendInterface, AbstractAdapter, BackendError, MockAdapter, Query, QueryResultType, QueryMetaType, Filter, Filters, Sorting, Limits, SortAndLimit, };
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DataObjectClass } from '../../components';
|
|
2
|
+
import { BackendAction } from '../../Backend';
|
|
3
|
+
import Middleware from './Middleware';
|
|
4
|
+
export interface InjectKeywordsMiddlewareParams {
|
|
5
|
+
}
|
|
6
|
+
export declare class InjectKeywordsMiddleware implements Middleware {
|
|
7
|
+
execute(dataObject: DataObjectClass<any>, action: BackendAction): void;
|
|
8
|
+
protected _createKeywords(dataObject: DataObjectClass<any>): string[];
|
|
9
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InjectKeywordsMiddleware = void 0;
|
|
4
|
+
const Backend_1 = require("../../Backend");
|
|
5
|
+
const properties_1 = require("../../properties");
|
|
6
|
+
class InjectKeywordsMiddleware {
|
|
7
|
+
execute(dataObject, action) {
|
|
8
|
+
if (!dataObject.has('keywords')) {
|
|
9
|
+
dataObject.addProperty(new properties_1.ArrayProperty({ name: 'keywords' }));
|
|
10
|
+
}
|
|
11
|
+
switch (action) {
|
|
12
|
+
case Backend_1.BackendAction.CREATE:
|
|
13
|
+
case Backend_1.BackendAction.UPDATE:
|
|
14
|
+
dataObject.set('keywords', this._createKeywords(dataObject));
|
|
15
|
+
break;
|
|
16
|
+
default:
|
|
17
|
+
break;
|
|
18
|
+
}
|
|
19
|
+
return;
|
|
20
|
+
}
|
|
21
|
+
_createKeywords(dataObject) {
|
|
22
|
+
const keywords = [];
|
|
23
|
+
Object.keys(dataObject.properties)
|
|
24
|
+
.filter((key) => dataObject.get(key).fullSearch === true)
|
|
25
|
+
.forEach((key) => {
|
|
26
|
+
const val = dataObject.val(key);
|
|
27
|
+
if (val) {
|
|
28
|
+
val.toLowerCase()
|
|
29
|
+
.split(' ')
|
|
30
|
+
.forEach((word) => {
|
|
31
|
+
let seq = '';
|
|
32
|
+
word
|
|
33
|
+
.split('')
|
|
34
|
+
.splice(0, 15)
|
|
35
|
+
.forEach((letter) => {
|
|
36
|
+
seq += letter;
|
|
37
|
+
if (seq.length > 1) {
|
|
38
|
+
keywords.push(seq);
|
|
39
|
+
}
|
|
40
|
+
});
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
return [...new Set(keywords)];
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
exports.InjectKeywordsMiddleware = InjectKeywordsMiddleware;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataObjectClass } from '../../components';
|
|
2
|
+
import { BackendAction } from '../../Backend';
|
|
3
|
+
import { UserCore } from '../../components/User';
|
|
4
|
+
import Middleware from './Middleware';
|
|
5
|
+
export interface InjectMetaMiddlewareParams {
|
|
6
|
+
user: UserCore;
|
|
7
|
+
}
|
|
8
|
+
export declare class InjectMetaMiddleware implements Middleware {
|
|
9
|
+
protected _user: UserCore;
|
|
10
|
+
constructor(params: InjectMetaMiddlewareParams);
|
|
11
|
+
execute(dataObject: DataObjectClass<any>, action: BackendAction): void;
|
|
12
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InjectMetaMiddleware = void 0;
|
|
4
|
+
const Backend_1 = require("../../Backend");
|
|
5
|
+
class InjectMetaMiddleware {
|
|
6
|
+
constructor(params) {
|
|
7
|
+
this._user = params.user;
|
|
8
|
+
}
|
|
9
|
+
execute(dataObject, action) {
|
|
10
|
+
switch (action) {
|
|
11
|
+
// add properties existence validation
|
|
12
|
+
case Backend_1.BackendAction.CREATE:
|
|
13
|
+
dataObject.set('createdBy', this._user);
|
|
14
|
+
dataObject.set('createdAt', Date.now());
|
|
15
|
+
break;
|
|
16
|
+
case Backend_1.BackendAction.UPDATE:
|
|
17
|
+
dataObject.set('updatedBy', this._user);
|
|
18
|
+
dataObject.set('updatedAt', Date.now());
|
|
19
|
+
break;
|
|
20
|
+
case Backend_1.BackendAction.DELETE:
|
|
21
|
+
dataObject.set('deletedBy', this._user);
|
|
22
|
+
dataObject.set('deletedAt', Date.now());
|
|
23
|
+
break;
|
|
24
|
+
default:
|
|
25
|
+
break;
|
|
26
|
+
}
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
exports.InjectMetaMiddleware = InjectMetaMiddleware;
|
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
import { DataObjectClass } from '../../components';
|
|
2
2
|
import { BackendAction } from '../../Backend';
|
|
3
|
-
import {
|
|
3
|
+
import { UserCore } from '../../components/User';
|
|
4
4
|
import Middleware from './Middleware';
|
|
5
|
-
import { Proxy } from '../../components/types/ProxyConstructor';
|
|
6
5
|
export interface InjectMetaMiddlewareParams {
|
|
7
|
-
user:
|
|
6
|
+
user: UserCore;
|
|
8
7
|
}
|
|
9
8
|
export declare class InjectMetaMiddleware implements Middleware {
|
|
10
|
-
protected _user:
|
|
9
|
+
protected _user: UserCore;
|
|
11
10
|
constructor(params: InjectMetaMiddlewareParams);
|
|
12
11
|
execute(dataObject: DataObjectClass<any>, action: BackendAction): void;
|
|
13
12
|
}
|
|
@@ -10,15 +10,15 @@ class InjectMetaMiddleware {
|
|
|
10
10
|
switch (action) {
|
|
11
11
|
// add properties existence validation
|
|
12
12
|
case Backend_1.BackendAction.CREATE:
|
|
13
|
-
dataObject.set('createdBy', this._user
|
|
13
|
+
dataObject.set('createdBy', this._user);
|
|
14
14
|
dataObject.set('createdAt', Date.now());
|
|
15
15
|
break;
|
|
16
16
|
case Backend_1.BackendAction.UPDATE:
|
|
17
|
-
dataObject.set('updatedBy', this._user
|
|
17
|
+
dataObject.set('updatedBy', this._user);
|
|
18
18
|
dataObject.set('updatedAt', Date.now());
|
|
19
19
|
break;
|
|
20
20
|
case Backend_1.BackendAction.DELETE:
|
|
21
|
-
dataObject.set('deletedBy', this._user
|
|
21
|
+
dataObject.set('deletedBy', this._user);
|
|
22
22
|
dataObject.set('deletedAt', Date.now());
|
|
23
23
|
break;
|
|
24
24
|
default:
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DataObjectClass } from '../../components';
|
|
2
|
+
import { Filter } from '../Filter';
|
|
3
|
+
import { Filters } from '../Filters';
|
|
4
|
+
import { Query, QueryResultType } from '../Query';
|
|
5
|
+
import { SortAndLimit } from '../SortAndLimit';
|
|
6
|
+
export interface BackendInterface {
|
|
7
|
+
create(dataObject: DataObjectClass<any>, desiredUid: string | undefined): Promise<DataObjectClass<any>>;
|
|
8
|
+
read(param: string | DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
9
|
+
update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
10
|
+
delete(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
|
|
11
|
+
query(query: Query<any>): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
12
|
+
find(dataObject: DataObjectClass<any>, filters: Filters | Filter[] | undefined, pagination: SortAndLimit | undefined): Promise<QueryResultType<DataObjectClass<any>>>;
|
|
13
|
+
}
|
package/lib/common/statuses.d.ts
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
export declare const CREATED = "created";
|
|
2
2
|
export declare const PENDING = "pending";
|
|
3
|
+
export declare const QUEUED = "queued";
|
|
3
4
|
export declare const ACTIVE = "active";
|
|
5
|
+
export declare const COMPLETED = "completed";
|
|
4
6
|
export declare const ERROR = "error";
|
|
5
7
|
export declare const TEST = "test";
|
|
6
8
|
export declare const SUSPENDED = "suspended";
|
|
7
9
|
export declare const DELETABLE = "deletable";
|
|
8
10
|
export declare const DELETED = "deleted";
|
|
11
|
+
export declare const DISABLED = "disabled";
|
|
9
12
|
export declare const DONE = "done";
|
|
10
13
|
export declare const MAINTENANCE = "maintenance";
|
|
11
14
|
export declare const UNKNOWN = "unknown";
|
package/lib/common/statuses.js
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.UNKNOWN = exports.MAINTENANCE = exports.DONE = exports.DELETED = exports.DELETABLE = exports.SUSPENDED = exports.TEST = exports.ERROR = exports.ACTIVE = exports.PENDING = exports.CREATED = void 0;
|
|
3
|
+
exports.UNKNOWN = exports.MAINTENANCE = exports.DONE = exports.DISABLED = exports.DELETED = exports.DELETABLE = exports.SUSPENDED = exports.TEST = exports.ERROR = exports.COMPLETED = exports.ACTIVE = exports.QUEUED = exports.PENDING = exports.CREATED = void 0;
|
|
4
4
|
exports.CREATED = 'created';
|
|
5
5
|
exports.PENDING = 'pending';
|
|
6
|
+
exports.QUEUED = 'queued';
|
|
6
7
|
exports.ACTIVE = 'active';
|
|
8
|
+
exports.COMPLETED = 'completed';
|
|
7
9
|
exports.ERROR = 'error';
|
|
8
10
|
exports.TEST = 'test';
|
|
9
11
|
exports.SUSPENDED = 'suspended';
|
|
10
12
|
exports.DELETABLE = 'deletable';
|
|
11
13
|
exports.DELETED = 'deleted';
|
|
14
|
+
exports.DISABLED = 'disabled';
|
|
12
15
|
exports.DONE = 'done';
|
|
13
16
|
exports.MAINTENANCE = 'maintenance';
|
|
14
17
|
exports.UNKNOWN = 'unknown';
|