c3nav 3.4.5 → 3.4.7

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.
@@ -1,68 +1,68 @@
1
1
  export declare const Endpoint: {
2
2
  ACCESSRESTRICTIONGROUPS: string;
3
+ accessRestrictionGroups(id?: number | string): string;
3
4
  ACCESSRESTRICTIONS: string;
5
+ accessRestrictions(id?: number | string): string;
4
6
  AREAS: string;
7
+ areas(id?: number | string): string;
5
8
  BOUNDS: string;
6
9
  BUILDINGS: string;
10
+ buildings(id?: number | string): string;
7
11
  CHANGESETS: string;
12
+ changesets(id?: number | string): string;
8
13
  COLUMNS: string;
14
+ columns(id?: number | string): string;
9
15
  CROSSDESCRIPTIONS: string;
16
+ crossDescriptions(id?: number | string): string;
10
17
  DETAILS: string;
11
18
  DOORS: string;
19
+ doors(id?: number | string): string;
12
20
  EDITOR: string;
21
+ editor(id?: number | string): string;
13
22
  GEOMETRY: string;
14
23
  HOLES: string;
24
+ holes(id?: number | string): string;
15
25
  LEAVEDESCRIPTIONS: string;
16
- LEVELS: string;
17
- LINEOBSTACLES: string;
18
- LOCATIONGROUPCATEGORIES: string;
19
- LOCATIONGROUPS: string;
20
- LOCATIONS: string;
21
- MAP: string;
22
- OBSTACLES: string;
23
- POIS: string;
24
- RAMPS: string;
25
- ROUTING: string;
26
- SESSION: string;
27
- SOURCES: string;
28
- SPACES: string;
29
- STAIRS: string;
30
- TYPES: string;
31
- UPDATES: string;
32
- Map: {
33
- bounds(): string;
34
- };
26
+ leaveDescriptions(id?: number | string): string;
35
27
  Level: {
36
28
  levels(id?: number | string): string;
37
29
  };
30
+ LEVELS: string;
31
+ LINEOBSTACLES: string;
32
+ lineObstacles(id?: number | string): string;
38
33
  Location: {
39
- locations(): string;
40
34
  detail(id: number | string): string;
41
35
  details(id: number | string): string;
42
36
  geometry(id: number | string): string;
37
+ locations(): string;
43
38
  types(): string;
44
39
  };
45
- accessRestrictionGroups(id?: number | string): string;
46
- accessRestrictions(id?: number | string): string;
47
- areas(id?: number | string): string;
48
- buildings(id?: number | string): string;
49
- changesets(id?: number | string): string;
50
- columns(id?: number | string): string;
51
- crossDescriptions(id?: number | string): string;
52
- doors(id?: number | string): string;
53
- editor(id?: number | string): string;
54
- holes(id?: number | string): string;
55
- leaveDescriptions(id?: number | string): string;
56
- lineObstacles(id?: number | string): string;
40
+ LOCATIONGROUPCATEGORIES: string;
57
41
  locationGroupCategories(id?: number | string): string;
42
+ LOCATIONGROUPS: string;
58
43
  locationGroups(id?: number | string): string;
44
+ LOCATIONS: string;
45
+ MAP: string;
46
+ Map: {
47
+ bounds(): string;
48
+ };
49
+ OBSTACLES: string;
59
50
  obstacles(id?: number | string): string;
51
+ POIS: string;
60
52
  pois(id?: number | string): string;
53
+ RAMPS: string;
61
54
  ramps(id?: number | string): string;
55
+ ROUTING: string;
62
56
  routing(id?: number | string): string;
57
+ SESSION: string;
63
58
  session(id?: number | string): string;
59
+ SOURCES: string;
64
60
  sources(id?: number | string): string;
61
+ SPACES: string;
65
62
  spaces(id?: number | string): string;
63
+ STAIRS: string;
66
64
  stairs(id?: number | string): string;
65
+ TYPES: string;
66
+ UPDATES: string;
67
67
  updates(id?: number | string): string;
68
68
  };
package/dist/Endpoints.js CHANGED
@@ -4,75 +4,6 @@ exports.Endpoint = void 0;
4
4
  const encode = encodeURIComponent;
5
5
  exports.Endpoint = {
6
6
  ACCESSRESTRICTIONGROUPS: 'accessrestrictiongroups',
7
- ACCESSRESTRICTIONS: 'accessrestrictions',
8
- AREAS: 'areas',
9
- BOUNDS: 'bounds',
10
- BUILDINGS: 'buildings',
11
- CHANGESETS: 'changesets',
12
- COLUMNS: 'columns',
13
- CROSSDESCRIPTIONS: 'crossdescriptions',
14
- DETAILS: 'details',
15
- DOORS: 'doors',
16
- EDITOR: 'editor',
17
- GEOMETRY: 'geometry',
18
- HOLES: 'holes',
19
- LEAVEDESCRIPTIONS: 'leavedescriptions',
20
- LEVELS: 'levels',
21
- LINEOBSTACLES: 'lineobstacles',
22
- LOCATIONGROUPCATEGORIES: 'locationgroupcategories',
23
- LOCATIONGROUPS: 'locationgroups',
24
- LOCATIONS: 'locations',
25
- MAP: 'map',
26
- OBSTACLES: 'obstacles',
27
- POIS: 'pois',
28
- RAMPS: 'ramps',
29
- ROUTING: 'routing',
30
- SESSION: 'session',
31
- SOURCES: 'sources',
32
- SPACES: 'spaces',
33
- STAIRS: 'stairs',
34
- TYPES: 'types',
35
- UPDATES: 'updates',
36
- Map: {
37
- bounds() {
38
- return `/${exports.Endpoint.MAP}/${exports.Endpoint.BOUNDS}/`;
39
- },
40
- },
41
- Level: {
42
- levels(id) {
43
- let endpoint = `/${exports.Endpoint.LEVELS}/`;
44
- if (id) {
45
- endpoint += `${encode(String(id))}/`;
46
- }
47
- return endpoint;
48
- },
49
- },
50
- Location: {
51
- locations() {
52
- return `/${exports.Endpoint.LOCATIONS}/`;
53
- },
54
- detail(id) {
55
- let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
56
- endpoint += typeof id === 'string' ? 'by_slug/' : '';
57
- endpoint += `${encode(String(id))}/`;
58
- return endpoint;
59
- },
60
- details(id) {
61
- let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
62
- endpoint += typeof id === 'string' ? 'by_slug/' : '';
63
- endpoint += `${encode(String(id))}/${exports.Endpoint.DETAILS}/`;
64
- return endpoint;
65
- },
66
- geometry(id) {
67
- let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
68
- endpoint += typeof id === 'string' ? 'by_slug/' : '';
69
- endpoint += `${encode(String(id))}/${exports.Endpoint.GEOMETRY}/`;
70
- return endpoint;
71
- },
72
- types() {
73
- return `/${exports.Endpoint.LOCATIONS}/${exports.Endpoint.TYPES}/`;
74
- },
75
- },
76
7
  accessRestrictionGroups(id) {
77
8
  let endpoint = `/${exports.Endpoint.ACCESSRESTRICTIONGROUPS}/`;
78
9
  if (id) {
@@ -80,6 +11,7 @@ exports.Endpoint = {
80
11
  }
81
12
  return endpoint;
82
13
  },
14
+ ACCESSRESTRICTIONS: 'accessrestrictions',
83
15
  accessRestrictions(id) {
84
16
  let endpoint = `/${exports.Endpoint.ACCESSRESTRICTIONS}/`;
85
17
  if (id) {
@@ -87,6 +19,7 @@ exports.Endpoint = {
87
19
  }
88
20
  return endpoint;
89
21
  },
22
+ AREAS: 'areas',
90
23
  areas(id) {
91
24
  let endpoint = `/${exports.Endpoint.AREAS}/`;
92
25
  if (id) {
@@ -94,6 +27,8 @@ exports.Endpoint = {
94
27
  }
95
28
  return endpoint;
96
29
  },
30
+ BOUNDS: 'bounds',
31
+ BUILDINGS: 'buildings',
97
32
  buildings(id) {
98
33
  let endpoint = `/${exports.Endpoint.BUILDINGS}/`;
99
34
  if (id) {
@@ -101,6 +36,7 @@ exports.Endpoint = {
101
36
  }
102
37
  return endpoint;
103
38
  },
39
+ CHANGESETS: 'changesets',
104
40
  changesets(id) {
105
41
  let endpoint = `/${exports.Endpoint.CHANGESETS}/`;
106
42
  if (id) {
@@ -108,6 +44,7 @@ exports.Endpoint = {
108
44
  }
109
45
  return endpoint;
110
46
  },
47
+ COLUMNS: 'columns',
111
48
  columns(id) {
112
49
  let endpoint = `/${exports.Endpoint.COLUMNS}/`;
113
50
  if (id) {
@@ -115,6 +52,7 @@ exports.Endpoint = {
115
52
  }
116
53
  return endpoint;
117
54
  },
55
+ CROSSDESCRIPTIONS: 'crossdescriptions',
118
56
  crossDescriptions(id) {
119
57
  let endpoint = `/${exports.Endpoint.CROSSDESCRIPTIONS}/`;
120
58
  if (id) {
@@ -122,6 +60,8 @@ exports.Endpoint = {
122
60
  }
123
61
  return endpoint;
124
62
  },
63
+ DETAILS: 'details',
64
+ DOORS: 'doors',
125
65
  doors(id) {
126
66
  let endpoint = `/${exports.Endpoint.DOORS}/`;
127
67
  if (id) {
@@ -129,6 +69,7 @@ exports.Endpoint = {
129
69
  }
130
70
  return endpoint;
131
71
  },
72
+ EDITOR: 'editor',
132
73
  editor(id) {
133
74
  let endpoint = `/${exports.Endpoint.EDITOR}/`;
134
75
  if (id) {
@@ -136,6 +77,8 @@ exports.Endpoint = {
136
77
  }
137
78
  return endpoint;
138
79
  },
80
+ GEOMETRY: 'geometry',
81
+ HOLES: 'holes',
139
82
  holes(id) {
140
83
  let endpoint = `/${exports.Endpoint.HOLES}/`;
141
84
  if (id) {
@@ -143,6 +86,7 @@ exports.Endpoint = {
143
86
  }
144
87
  return endpoint;
145
88
  },
89
+ LEAVEDESCRIPTIONS: 'leavedescriptions',
146
90
  leaveDescriptions(id) {
147
91
  let endpoint = `/${exports.Endpoint.LEAVEDESCRIPTIONS}/`;
148
92
  if (id) {
@@ -150,6 +94,17 @@ exports.Endpoint = {
150
94
  }
151
95
  return endpoint;
152
96
  },
97
+ Level: {
98
+ levels(id) {
99
+ let endpoint = `/${exports.Endpoint.LEVELS}/`;
100
+ if (id) {
101
+ endpoint += `${encode(String(id))}/`;
102
+ }
103
+ return endpoint;
104
+ },
105
+ },
106
+ LEVELS: 'levels',
107
+ LINEOBSTACLES: 'lineobstacles',
153
108
  lineObstacles(id) {
154
109
  let endpoint = `/${exports.Endpoint.LINEOBSTACLES}/`;
155
110
  if (id) {
@@ -157,6 +112,33 @@ exports.Endpoint = {
157
112
  }
158
113
  return endpoint;
159
114
  },
115
+ Location: {
116
+ detail(id) {
117
+ let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
118
+ endpoint += typeof id === 'string' ? 'by_slug/' : '';
119
+ endpoint += `${encode(String(id))}/`;
120
+ return endpoint;
121
+ },
122
+ details(id) {
123
+ let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
124
+ endpoint += typeof id === 'string' ? 'by_slug/' : '';
125
+ endpoint += `${encode(String(id))}/${exports.Endpoint.DETAILS}/`;
126
+ return endpoint;
127
+ },
128
+ geometry(id) {
129
+ let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
130
+ endpoint += typeof id === 'string' ? 'by_slug/' : '';
131
+ endpoint += `${encode(String(id))}/${exports.Endpoint.GEOMETRY}/`;
132
+ return endpoint;
133
+ },
134
+ locations() {
135
+ return `/${exports.Endpoint.LOCATIONS}/`;
136
+ },
137
+ types() {
138
+ return `/${exports.Endpoint.LOCATIONS}/${exports.Endpoint.TYPES}/`;
139
+ },
140
+ },
141
+ LOCATIONGROUPCATEGORIES: 'locationgroupcategories',
160
142
  locationGroupCategories(id) {
161
143
  let endpoint = `/${exports.Endpoint.LOCATIONGROUPCATEGORIES}/`;
162
144
  if (id) {
@@ -164,6 +146,7 @@ exports.Endpoint = {
164
146
  }
165
147
  return endpoint;
166
148
  },
149
+ LOCATIONGROUPS: 'locationgroups',
167
150
  locationGroups(id) {
168
151
  let endpoint = `/${exports.Endpoint.LOCATIONGROUPS}/`;
169
152
  if (id) {
@@ -171,6 +154,14 @@ exports.Endpoint = {
171
154
  }
172
155
  return endpoint;
173
156
  },
157
+ LOCATIONS: 'locations',
158
+ MAP: 'map',
159
+ Map: {
160
+ bounds() {
161
+ return `/${exports.Endpoint.MAP}/${exports.Endpoint.BOUNDS}/`;
162
+ },
163
+ },
164
+ OBSTACLES: 'obstacles',
174
165
  obstacles(id) {
175
166
  let endpoint = `/${exports.Endpoint.OBSTACLES}/`;
176
167
  if (id) {
@@ -178,6 +169,7 @@ exports.Endpoint = {
178
169
  }
179
170
  return endpoint;
180
171
  },
172
+ POIS: 'pois',
181
173
  pois(id) {
182
174
  let endpoint = `/${exports.Endpoint.POIS}/`;
183
175
  if (id) {
@@ -185,6 +177,7 @@ exports.Endpoint = {
185
177
  }
186
178
  return endpoint;
187
179
  },
180
+ RAMPS: 'ramps',
188
181
  ramps(id) {
189
182
  let endpoint = `/${exports.Endpoint.RAMPS}/`;
190
183
  if (id) {
@@ -192,6 +185,7 @@ exports.Endpoint = {
192
185
  }
193
186
  return endpoint;
194
187
  },
188
+ ROUTING: 'routing',
195
189
  routing(id) {
196
190
  let endpoint = `/${exports.Endpoint.ROUTING}/`;
197
191
  if (id) {
@@ -199,6 +193,7 @@ exports.Endpoint = {
199
193
  }
200
194
  return endpoint;
201
195
  },
196
+ SESSION: 'session',
202
197
  session(id) {
203
198
  let endpoint = `/${exports.Endpoint.SESSION}/`;
204
199
  if (id) {
@@ -206,6 +201,7 @@ exports.Endpoint = {
206
201
  }
207
202
  return endpoint;
208
203
  },
204
+ SOURCES: 'sources',
209
205
  sources(id) {
210
206
  let endpoint = `/${exports.Endpoint.SOURCES}/`;
211
207
  if (id) {
@@ -213,6 +209,7 @@ exports.Endpoint = {
213
209
  }
214
210
  return endpoint;
215
211
  },
212
+ SPACES: 'spaces',
216
213
  spaces(id) {
217
214
  let endpoint = `/${exports.Endpoint.SPACES}/`;
218
215
  if (id) {
@@ -220,6 +217,7 @@ exports.Endpoint = {
220
217
  }
221
218
  return endpoint;
222
219
  },
220
+ STAIRS: 'stairs',
223
221
  stairs(id) {
224
222
  let endpoint = `/${exports.Endpoint.STAIRS}/`;
225
223
  if (id) {
@@ -227,6 +225,8 @@ exports.Endpoint = {
227
225
  }
228
226
  return endpoint;
229
227
  },
228
+ TYPES: 'types',
229
+ UPDATES: 'updates',
230
230
  updates(id) {
231
231
  let endpoint = `/${exports.Endpoint.UPDATES}/`;
232
232
  if (id) {
package/dist/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
+ export * from './api/';
1
2
  export * from './c3nav';
2
3
  export * from './interfaces/';
package/dist/index.js CHANGED
@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./api/"), exports);
17
18
  __exportStar(require("./c3nav"), exports);
18
19
  __exportStar(require("./interfaces/"), exports);
@@ -8,7 +8,7 @@ export interface Location {
8
8
  type: string;
9
9
  }
10
10
  export interface LocationDetails {
11
- display: Array<[string, string | null | number]>;
11
+ display: Array<[string, null | number | string]>;
12
12
  editor_url: string;
13
13
  id: number;
14
14
  }
@@ -18,7 +18,7 @@ export interface LocationGeometry {
18
18
  type: string;
19
19
  };
20
20
  id: number;
21
- level: number | null;
21
+ level: null | number;
22
22
  }
23
23
  export interface LocationType {
24
24
  name: string;
@@ -1,11 +1,11 @@
1
1
  export interface ClientOptions {
2
2
  apiUrl?: string;
3
3
  }
4
+ export type HttpMethod = 'get' | 'head' | 'options' | 'post' | 'put';
4
5
  export interface LevelListOptions {
5
6
  /** filter by group */
6
- group?: string | number;
7
+ group?: number | string;
7
8
  /** filter by on_top_of */
8
- on_top_of?: null | string | number;
9
+ on_top_of?: null | number | string;
9
10
  }
10
11
  export type RequestOptions = LevelListOptions;
11
- export type HttpMethod = 'get' | 'head' | 'options' | 'post' | 'put';
@@ -2,6 +2,7 @@ export * from './AccessRestrictionGroups';
2
2
  export * from './AccessRestrictions';
3
3
  export * from './API';
4
4
  export * from './Areas';
5
+ export * from './Bounds';
5
6
  export * from './Buildings';
6
7
  export * from './Changesets';
7
8
  export * from './Columns';
@@ -12,10 +13,9 @@ export * from './Holes';
12
13
  export * from './LeaveDescriptions';
13
14
  export * from './Level';
14
15
  export * from './LineObstacles';
16
+ export * from './Location';
15
17
  export * from './LocationGroupCategories';
16
18
  export * from './LocationGroups';
17
- export * from './Location';
18
- export * from './Bounds';
19
19
  export * from './Obstacles';
20
20
  export * from './Options';
21
21
  export * from './POIs';
@@ -18,6 +18,7 @@ __exportStar(require("./AccessRestrictionGroups"), exports);
18
18
  __exportStar(require("./AccessRestrictions"), exports);
19
19
  __exportStar(require("./API"), exports);
20
20
  __exportStar(require("./Areas"), exports);
21
+ __exportStar(require("./Bounds"), exports);
21
22
  __exportStar(require("./Buildings"), exports);
22
23
  __exportStar(require("./Changesets"), exports);
23
24
  __exportStar(require("./Columns"), exports);
@@ -28,10 +29,9 @@ __exportStar(require("./Holes"), exports);
28
29
  __exportStar(require("./LeaveDescriptions"), exports);
29
30
  __exportStar(require("./Level"), exports);
30
31
  __exportStar(require("./LineObstacles"), exports);
32
+ __exportStar(require("./Location"), exports);
31
33
  __exportStar(require("./LocationGroupCategories"), exports);
32
34
  __exportStar(require("./LocationGroups"), exports);
33
- __exportStar(require("./Location"), exports);
34
- __exportStar(require("./Bounds"), exports);
35
35
  __exportStar(require("./Obstacles"), exports);
36
36
  __exportStar(require("./Options"), exports);
37
37
  __exportStar(require("./POIs"), exports);
package/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "author": "Florian Imdahl <git@ffflorian.de>",
3
3
  "dependencies": {
4
- "@ffflorian/api-client": "2.2.0"
4
+ "@ffflorian/api-client": "2.5.1"
5
5
  },
6
6
  "description": "A c3nav API client",
7
7
  "devDependencies": {
8
8
  "@types/node": "~24",
9
- "rimraf": "6.1.2",
10
- "typedoc": "0.28.15",
11
- "typescript": "5.9.3"
9
+ "rimraf": "6.1.3",
10
+ "typedoc": "0.28.18",
11
+ "typescript": "6.0.2"
12
12
  },
13
13
  "engines": {
14
14
  "node": ">= 21"
@@ -28,13 +28,13 @@
28
28
  "readme": "https://github.com/ffflorian/api-clients#readme",
29
29
  "repository": "https://github.com/ffflorian/api-clients.git",
30
30
  "scripts": {
31
+ "build": "yarn build:ts",
31
32
  "build:ts": "tsc -p tsconfig.build.json",
32
33
  "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/c3nav src/index.ts",
33
34
  "clean": "rimraf dist",
34
- "dist": "yarn clean && yarn build:ts",
35
+ "dist": "yarn clean && yarn build",
35
36
  "test": "exit 0"
36
37
  },
37
38
  "types": "dist/index.d.ts",
38
- "version": "3.4.5",
39
- "gitHead": "8d7471cbe490305b3e441c27acbc81e36a4bd9df"
39
+ "version": "3.4.7"
40
40
  }