@spotto/contract 1.0.46-alpha.3 → 1.0.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/events/constants.d.ts +2 -1
- package/dist/events/constants.js.map +1 -1
- package/dist/events/get/response.d.ts +12 -2
- package/dist/fields/[id]/patch/request.d.ts +5 -1
- package/dist/snapshots/[id]/get.d.ts +3 -0
- package/dist/snapshots/[id]/get.js.map +1 -1
- package/dist/snapshots/post/request.d.ts +2 -0
- package/dist/snapshots/post/request.js.map +1 -1
- package/package.json +2 -2
|
@@ -3,6 +3,7 @@ export declare const EVENT_COUNT_BREAKDOWN: EventCountBreakdown[];
|
|
|
3
3
|
export declare type AssetCrudEventType = 'AssetCreated' | 'AssetUpdated' | 'AssetDeleted';
|
|
4
4
|
export declare type LocationCrudEventType = 'LocationCreated' | 'LocationUpdated' | 'LocationDeleted';
|
|
5
5
|
export declare type ReaderCrudEventType = 'ReaderCreated' | 'ReaderUpdated' | 'ReaderDeleted';
|
|
6
|
+
export declare type SnapshotCrudEventType = 'SnapshotCreated' | 'SnapshotDeleted';
|
|
6
7
|
export declare type SlateEventType = 'ReaderArrived' | 'ReaderExited' | 'Arrived' | 'Moved' | 'ExplicitArrived' | 'Exited' | 'ReaderOnline' | 'ReaderOffline';
|
|
7
|
-
export declare type EventType = SlateEventType | AssetCrudEventType | LocationCrudEventType | ReaderCrudEventType | 'UserSearch';
|
|
8
|
+
export declare type EventType = SlateEventType | AssetCrudEventType | LocationCrudEventType | ReaderCrudEventType | SnapshotCrudEventType | 'UserSearch';
|
|
8
9
|
export declare const EVENT_TYPES: EventType[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/events/constants.ts"],"names":[],"mappings":";;;AACa,QAAA,qBAAqB,GAA0B;IAC1D,MAAM;IACN,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;CACP,CAAA;
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/events/constants.ts"],"names":[],"mappings":";;;AACa,QAAA,qBAAqB,GAA0B;IAC1D,MAAM;IACN,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;CACP,CAAA;AAqCY,QAAA,WAAW,GAAgB;IACtC,eAAe;IACf,cAAc;IACd,SAAS;IACT,OAAO;IACP,iBAAiB;IACjB,QAAQ;IACR,cAAc;IACd,eAAe;IACf,cAAc;IACd,cAAc;IACd,cAAc;IACd,iBAAiB;IACjB,iBAAiB;IACjB,iBAAiB;IACjB,eAAe;IACf,eAAe;IACf,eAAe;IACf,YAAY;CACb,CAAA"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { IEmbeddedEntity } from '../../shared';
|
|
2
|
-
import { AssetCrudEventType, EventType, LocationCrudEventType, ReaderCrudEventType } from '../constants';
|
|
2
|
+
import { AssetCrudEventType, EventType, LocationCrudEventType, ReaderCrudEventType, SnapshotCrudEventType } from '../constants';
|
|
3
3
|
import { GetEventsQuery } from './query';
|
|
4
4
|
import { DeviceType, ReaderType } from '../../readers/constants';
|
|
5
5
|
import { LocationType } from '../../locations/constants';
|
|
6
|
+
import { GetSnapshotResponse } from '../../snapshots';
|
|
6
7
|
export interface EventLocation extends IEmbeddedEntity {
|
|
7
8
|
type: LocationType;
|
|
8
9
|
organisation?: IEmbeddedEntity;
|
|
@@ -32,6 +33,7 @@ export interface IReaderEventPayload {
|
|
|
32
33
|
deviceId?: string;
|
|
33
34
|
location?: IEmbeddedEntity;
|
|
34
35
|
}
|
|
36
|
+
export declare type ISnapshotEventPayload = Pick<GetSnapshotResponse, 'reader' | 'location' | 'manifest' | 'detectedAssets' | 'sightedTypes' | 'sightedAssets' | 'computed' | 'fields' | 'submitted' | 'created' | 'geolocation'>;
|
|
35
37
|
export interface IAssetCrudEvent extends IBaseEvent {
|
|
36
38
|
type: AssetCrudEventType;
|
|
37
39
|
asset: IEmbeddedEntity;
|
|
@@ -50,6 +52,14 @@ export interface IReaderCrudEvent extends IBaseEvent {
|
|
|
50
52
|
user: IEmbeddedEntity;
|
|
51
53
|
payload: IReaderEventPayload;
|
|
52
54
|
}
|
|
55
|
+
export interface ISnapshotCrudEvent extends IBaseEvent {
|
|
56
|
+
type: SnapshotCrudEventType;
|
|
57
|
+
snapshot: {
|
|
58
|
+
id: string;
|
|
59
|
+
};
|
|
60
|
+
user: IEmbeddedEntity;
|
|
61
|
+
payload: ISnapshotEventPayload;
|
|
62
|
+
}
|
|
53
63
|
export interface IUserSearchEvent extends IBaseEvent {
|
|
54
64
|
type: 'UserSearch';
|
|
55
65
|
entity: string;
|
|
@@ -97,7 +107,7 @@ export interface IReaderOfflineEvent extends IBaseEvent {
|
|
|
97
107
|
type: 'ReaderOffline';
|
|
98
108
|
reader: IEmbeddedEntity;
|
|
99
109
|
}
|
|
100
|
-
export declare type GetEventResponse = IAssetCrudEvent | ILocationCrudEvent | IReaderCrudEvent | IUserSearchEvent | IReaderArrivedEvent | IReaderExitedEvent | IArrivedEvent | IMovedEvent | IExplicitArrivedEvent | IExitedEvent | IReaderOnlineEvent | IReaderOfflineEvent;
|
|
110
|
+
export declare type GetEventResponse = IAssetCrudEvent | ILocationCrudEvent | IReaderCrudEvent | ISnapshotCrudEvent | IUserSearchEvent | IReaderArrivedEvent | IReaderExitedEvent | IArrivedEvent | IMovedEvent | IExplicitArrivedEvent | IExitedEvent | IReaderOnlineEvent | IReaderOfflineEvent;
|
|
101
111
|
export interface GetEventsResponse {
|
|
102
112
|
query: GetEventsQuery | null;
|
|
103
113
|
items: GetEventResponse[];
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { FieldInputType } from '../../constants';
|
|
2
|
+
export interface UpdateFieldRequestOption {
|
|
3
|
+
value: string;
|
|
4
|
+
previousValue?: string;
|
|
5
|
+
}
|
|
2
6
|
export interface UpdateFieldRequest {
|
|
3
7
|
inputType?: FieldInputType;
|
|
4
8
|
label?: string | null;
|
|
5
9
|
required?: boolean;
|
|
6
10
|
rememberLast?: boolean | null;
|
|
7
11
|
regex?: string | null;
|
|
8
|
-
options?:
|
|
12
|
+
options?: UpdateFieldRequestOption[];
|
|
9
13
|
integerMin?: number | null;
|
|
10
14
|
integerMax?: number | null;
|
|
11
15
|
decimalMin?: number | null;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { IEmbeddedEntity, IEntityMeta } from '../../shared';
|
|
2
2
|
import { GetManifestResponse, IManifestAsset, IManifestType } from '../../manifests';
|
|
3
|
+
import { Point } from 'geojson';
|
|
3
4
|
export interface IManifestTypeExtended extends IManifestType {
|
|
4
5
|
c_detected?: number;
|
|
5
6
|
c_sighted?: number;
|
|
@@ -76,6 +77,7 @@ export interface GetSnapshotResponse {
|
|
|
76
77
|
submitted?: number;
|
|
77
78
|
created: number;
|
|
78
79
|
meta?: IEntityMeta;
|
|
80
|
+
geolocation?: Point;
|
|
79
81
|
}
|
|
80
82
|
export interface GetSnapshotsItem {
|
|
81
83
|
id: string;
|
|
@@ -87,6 +89,7 @@ export interface GetSnapshotsItem {
|
|
|
87
89
|
fields?: ISnapshotFields;
|
|
88
90
|
submitted?: number;
|
|
89
91
|
created: number;
|
|
92
|
+
geolocation?: Point;
|
|
90
93
|
}
|
|
91
94
|
export declare const testGetSnapshotRequest: GetSnapshotResponse;
|
|
92
95
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/snapshots/[id]/get.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/snapshots/[id]/get.ts"],"names":[],"mappings":";;;AAmHa,QAAA,sBAAsB,GAAwB;IACzD,EAAE,EAAE,OAAO;IACX,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE;QACR,EAAE,EAAE,YAAY;QAChB,IAAI,EAAE,cAAc;KACrB;IACD,QAAQ,EAAE;QACR,YAAY,EAAE,CAAC;QACf,cAAc,EAAE,CAAC;QACjB,aAAa,EAAE;YACb,KAAK,EAAE,CAAC;YACR,iBAAiB,EAAE,CAAC;YACpB,YAAY,EAAE,CAAC;YACf,YAAY,EAAE,CAAC;SAEhB;QACD,cAAc,EAAE;YACd,KAAK,EAAE,CAAC;YACR,YAAY,EAAE,CAAC;YACf,YAAY,EAAE,CAAC;SAChB;QACD,UAAU,EAAE;YACV,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,CAAC;SACf;KACF;CACF,CAAA"}
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { Point } from 'geojson';
|
|
1
2
|
import { ISnapshotDetectedAsset, ISnapshotSightedType, ISnapshotSightedAsset, ISnapshotFields } from '../[id]/get';
|
|
2
3
|
import { GetManifestResponse } from '../../manifests';
|
|
3
4
|
import { IEmbeddedEntity } from '../../shared/embed';
|
|
4
5
|
export interface PostSnapshotRequest {
|
|
5
6
|
reader?: IEmbeddedEntity;
|
|
6
7
|
location: IEmbeddedEntity;
|
|
8
|
+
geolocation?: Point;
|
|
7
9
|
manifest?: GetManifestResponse;
|
|
8
10
|
detectedAssets?: ISnapshotDetectedAsset[];
|
|
9
11
|
sightedTypes?: ISnapshotSightedType[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/snapshots/post/request.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/snapshots/post/request.ts"],"names":[],"mappings":";;;AAyBa,QAAA,wBAAwB,GAAwB;IAC3D,MAAM,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,UAAU,EAAE;IAC5D,QAAQ,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,YAAY,EAAE;IAChE,cAAc,EAAE;QACd;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,uBAAuB;YACjC,QAAQ,EAAE,iBAAiB;SAC5B;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,eAAe;YAC1B,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,iBAAiB;SAC5B;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,iBAAiB;SAC5B;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,iBAAiB;SAC5B;KACF;IACD,MAAM,EAAE;QACN,KAAK,EAAE,EAAE;KACV;IACD,SAAS,EAAE,aAAa;CACzB,CAAA;AAEY,QAAA,wBAAwB,GAAwB;IAC3D,MAAM,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,UAAU,EAAE;IAC5D,QAAQ,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,YAAY,EAAE;IAChE,QAAQ,EAAE;QACR,EAAE,EAAE,0BAA0B;QAC9B,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,CAAC,kBAAkB,EAAE,aAAa,EAAE,WAAW,CAAC;QAC1D,KAAK,EAAE;YACL;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,mBAAmB;gBAC7B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,mBAAmB;gBAC7B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,oBAAoB;gBAC9B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,cAAc;gBACxB,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,qBAAqB;gBAC/B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,wBAAwB;gBAClC,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,0BAA0B;gBACpC,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD;gBACE,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,iBAAiB;gBAC3B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;SACF;QACD,UAAU,EAAE,GAAG;QACf,WAAW,EAAE,GAAG;KACjB;IACD,cAAc,EAAE;QACd;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,uBAAuB;YACjC,QAAQ,EAAE,YAAY;SACvB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,eAAe;YAC1B,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,YAAY;SACvB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,YAAY;SACvB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,YAAY;SACvB;KACF;IACD,YAAY,EAAE;QACZ;YACE,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;SACT;QACD;YACE,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;SACT;QACD;YACE,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,CAAC;SACT;KACF;IACD,MAAM,EAAE;QACN,KAAK,EAAE,EAAE;KACV;IACD,SAAS,EAAE,aAAa;CACzB,CAAA;AAEY,QAAA,wBAAwB,GAAwB;IAC3D,MAAM,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,UAAU,EAAE;IAC5D,QAAQ,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,YAAY,EAAE;IAChE,QAAQ,EAAE;QACR,EAAE,EAAE,0BAA0B;QAC9B,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,CAAC,kBAAkB,EAAE,aAAa,EAAE,WAAW,CAAC;QAC1D,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,0BAA0B;gBACnC,SAAS,EAAE,WAAW;gBACtB,QAAQ,EAAE,YAAY;gBACtB,MAAM,EAAE,0BAA0B;gBAClC,QAAQ,EAAE,WAAW;gBACrB,OAAO,EAAE,gBAAgB;aAC1B;SACF;QACD,UAAU,EAAE,CAAC;QACb,WAAW,EAAE,CAAC;KACf;IACD,cAAc,EAAE;QACd;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,uBAAuB;YACjC,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,gBAAgB;SAC1B;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,eAAe;YAC1B,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,gBAAgB;SAC1B;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,gBAAgB;SAC1B;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,YAAY;SACvB;KACF;IACD,aAAa,EAAE;QACb;YACE,OAAO,EAAE,0BAA0B;YACnC,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,0BAA0B;YAClC,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,gBAAgB;SAC1B;KACF;IACD,MAAM,EAAE;QACN,KAAK,EAAE,EAAE;KACV;IACD,SAAS,EAAE,aAAa;CACzB,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spotto/contract",
|
|
3
3
|
"license": "ISC",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.47",
|
|
5
5
|
"description": "Spotto's API Contract type definitions",
|
|
6
6
|
"main": "./dist/index.js",
|
|
7
7
|
"files": [
|
|
@@ -15,5 +15,5 @@
|
|
|
15
15
|
"@types/geojson": "^7946.0.11",
|
|
16
16
|
"shx": "^0.3.4"
|
|
17
17
|
},
|
|
18
|
-
"gitHead": "
|
|
18
|
+
"gitHead": "fc3ce2ee41ef0688f819f3a2ee07bb6f773304c5"
|
|
19
19
|
}
|