/
geoWithin.ts
160 lines (157 loc) · 5 KB
/
geoWithin.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
import { geoWithinFP, toGeoJSON } from '@terascope/utils';
import { FieldType, GeoShapeType, GeoInput } from '@terascope/types';
import {
FieldValidateConfig,
ProcessMode,
FunctionDefinitionType,
FunctionDefinitionCategory,
FunctionDefinitionExample
} from '../interfaces';
export interface GeoWithinArgs {
value: GeoInput;
}
const examples: FunctionDefinitionExample<GeoWithinArgs>[] = [
{
args: { value: ['10,10', '10,50', '50,50', '50,10', '10,10'] },
config: { version: 1, fields: { testField: { type: FieldType.GeoJSON } } },
field: 'testField',
input: {
type: GeoShapeType.Point,
coordinates: [20, 20]
},
output: {
type: GeoShapeType.Point,
coordinates: [20, 20]
},
},
{
args: { value: ['10,10', '10,50', '50,50', '50,10', '10,10'] },
config: { version: 1, fields: { testField: { type: FieldType.String } } },
field: 'testField',
input: '20,20',
output: '20,20',
},
{
args: { value: ['10,10', '10,50', '50,50', '50,10', '10,10'] },
config: { version: 1, fields: { testField: { type: FieldType.GeoJSON } } },
field: 'testField',
input: {
type: GeoShapeType.Polygon,
coordinates: [[[20, 20], [20, 30], [30, 30], [30, 20], [20, 20]]]
},
output: {
type: GeoShapeType.Polygon,
coordinates: [[[20, 20], [20, 30], [30, 30], [30, 20], [20, 20]]]
}
},
{
args: {
value: {
type: GeoShapeType.MultiPolygon,
coordinates: [
[
[[10, 10], [10, 50], [50, 50], [50, 10], [10, 10]],
],
[
[[-10, -10], [-10, -50], [-50, -50], [-50, -10], [-10, -10]],
]
]
}
},
config: { version: 1, fields: { testField: { type: FieldType.GeoJSON } } },
field: 'testField',
input: {
type: GeoShapeType.MultiPolygon,
coordinates: [
[
[[10, 10], [10, 50], [50, 50], [50, 10], [10, 10]],
],
[
[[-10, -10], [-10, -50], [-50, -50], [-50, -10], [-10, -10]],
]
]
},
output: {
type: GeoShapeType.MultiPolygon,
coordinates: [
[
[[10, 10], [10, 50], [50, 50], [50, 10], [10, 10]],
],
[
[[-10, -10], [-10, -50], [-50, -50], [-50, -10], [-10, -10]],
]
]
}
},
{
args: {
value: {
type: GeoShapeType.MultiPolygon,
coordinates: [
[
[[10, 10], [10, 50], [50, 50], [50, 10], [10, 10]],
],
[
[[-10, -10], [-10, -50], [-50, -50], [-50, -10], [-10, -10]],
]
]
}
},
config: { version: 1, fields: { testField: { type: FieldType.GeoJSON } } },
field: 'testField',
input: {
type: GeoShapeType.MultiPolygon,
coordinates: [
[
[[10, 10], [10, 20], [20, 20], [20, 10], [10, 10]],
],
[
[[30, 30], [30, 40], [40, 40], [40, 30], [30, 30]],
]
]
},
output: {
type: GeoShapeType.MultiPolygon,
coordinates: [
[
[[10, 10], [10, 20], [20, 20], [20, 10], [10, 10]],
],
[
[[30, 30], [30, 40], [40, 40], [40, 30], [30, 30]],
]
]
}
},
];
export const geoWithinConfig: FieldValidateConfig<GeoWithinArgs> = {
name: 'geoWithin',
type: FunctionDefinitionType.FIELD_VALIDATION,
process_mode: ProcessMode.FULL_VALUES,
category: FunctionDefinitionCategory.GEO,
examples,
description: 'Returns the input if it is completely within the argument geo-value. The interiors of both geo entities must intersect and the geo data must not exceed the bounds of the geo argument. Otherwise returns null',
create({ args: { value } }) {
return geoWithinFP(value);
},
accepts: [
FieldType.GeoJSON,
FieldType.GeoPoint,
FieldType.Geo,
FieldType.Object,
FieldType.String,
FieldType.Number
],
argument_schema: {
value: {
type: FieldType.Any,
description: 'The geo value used to compare the input value to.'
}
},
required_arguments: ['value'],
validate_arguments({ value }) {
const input = toGeoJSON(value);
if (!input) {
throw new Error(`Invalid parameter value: ${JSON.stringify(value)}, is not a valid geo-json`);
}
}
};