@capgo/capacitor-launch-navigator 7.0.0

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/docs.json ADDED
@@ -0,0 +1,467 @@
1
+ {
2
+ "api": {
3
+ "name": "LaunchNavigatorPlugin",
4
+ "slug": "launchnavigatorplugin",
5
+ "docs": "Main plugin interface",
6
+ "tags": [],
7
+ "methods": [
8
+ {
9
+ "name": "navigate",
10
+ "signature": "(options: { destination: [number, number]; options?: NavigateOptions; }) => Promise<void>",
11
+ "parameters": [
12
+ {
13
+ "name": "options",
14
+ "docs": "Navigation options with destination coordinates",
15
+ "type": "{ destination: [number, number]; options?: NavigateOptions | undefined; }"
16
+ }
17
+ ],
18
+ "returns": "Promise<void>",
19
+ "tags": [
20
+ {
21
+ "name": "param",
22
+ "text": "options Navigation options with destination coordinates"
23
+ }
24
+ ],
25
+ "docs": "Navigate to a location using latitude and longitude",
26
+ "complexTypes": [
27
+ "NavigateOptions"
28
+ ],
29
+ "slug": "navigate"
30
+ },
31
+ {
32
+ "name": "isAppAvailable",
33
+ "signature": "(options: { app: IOSNavigationApp | AndroidNavigationApp | string; }) => Promise<{ available: boolean; }>",
34
+ "parameters": [
35
+ {
36
+ "name": "options",
37
+ "docs": "Options containing app identifier",
38
+ "type": "{ app: string; }"
39
+ }
40
+ ],
41
+ "returns": "Promise<{ available: boolean; }>",
42
+ "tags": [
43
+ {
44
+ "name": "param",
45
+ "text": "options Options containing app identifier"
46
+ }
47
+ ],
48
+ "docs": "Check if a specific navigation app is available",
49
+ "complexTypes": [
50
+ "IOSNavigationApp",
51
+ "AndroidNavigationApp"
52
+ ],
53
+ "slug": "isappavailable"
54
+ },
55
+ {
56
+ "name": "getAvailableApps",
57
+ "signature": "() => Promise<{ apps: AvailableApp[]; }>",
58
+ "parameters": [],
59
+ "returns": "Promise<{ apps: AvailableApp[]; }>",
60
+ "tags": [],
61
+ "docs": "Get list of available navigation apps on the device",
62
+ "complexTypes": [
63
+ "AvailableApp"
64
+ ],
65
+ "slug": "getavailableapps"
66
+ },
67
+ {
68
+ "name": "getSupportedApps",
69
+ "signature": "() => Promise<{ apps: string[]; }>",
70
+ "parameters": [],
71
+ "returns": "Promise<{ apps: string[]; }>",
72
+ "tags": [],
73
+ "docs": "Get list of supported apps for the current platform",
74
+ "complexTypes": [],
75
+ "slug": "getsupportedapps"
76
+ },
77
+ {
78
+ "name": "getDefaultApp",
79
+ "signature": "() => Promise<{ app: string; }>",
80
+ "parameters": [],
81
+ "returns": "Promise<{ app: string; }>",
82
+ "tags": [],
83
+ "docs": "Get the name of the default app for navigation",
84
+ "complexTypes": [],
85
+ "slug": "getdefaultapp"
86
+ }
87
+ ],
88
+ "properties": []
89
+ },
90
+ "interfaces": [
91
+ {
92
+ "name": "NavigateOptions",
93
+ "slug": "navigateoptions",
94
+ "docs": "Options for navigation",
95
+ "tags": [],
96
+ "methods": [],
97
+ "properties": [
98
+ {
99
+ "name": "start",
100
+ "tags": [],
101
+ "docs": "Starting location coordinates [latitude, longitude]",
102
+ "complexTypes": [],
103
+ "type": "[number, number] | undefined"
104
+ },
105
+ {
106
+ "name": "startName",
107
+ "tags": [],
108
+ "docs": "Starting location name",
109
+ "complexTypes": [],
110
+ "type": "string | undefined"
111
+ },
112
+ {
113
+ "name": "destinationName",
114
+ "tags": [],
115
+ "docs": "Destination name (will be ignored since we only support coordinates)",
116
+ "complexTypes": [],
117
+ "type": "string | undefined"
118
+ },
119
+ {
120
+ "name": "transportMode",
121
+ "tags": [],
122
+ "docs": "Transport mode",
123
+ "complexTypes": [
124
+ "TransportMode"
125
+ ],
126
+ "type": "TransportMode"
127
+ },
128
+ {
129
+ "name": "app",
130
+ "tags": [],
131
+ "docs": "Specific app to launch (if not specified, will use default or prompt)",
132
+ "complexTypes": [
133
+ "IOSNavigationApp",
134
+ "AndroidNavigationApp"
135
+ ],
136
+ "type": "string | undefined"
137
+ },
138
+ {
139
+ "name": "launchMode",
140
+ "tags": [],
141
+ "docs": "Launch mode",
142
+ "complexTypes": [
143
+ "LaunchMode"
144
+ ],
145
+ "type": "LaunchMode"
146
+ },
147
+ {
148
+ "name": "extras",
149
+ "tags": [],
150
+ "docs": "Additional parameters specific to certain apps",
151
+ "complexTypes": [
152
+ "Record"
153
+ ],
154
+ "type": "Record<string, any>"
155
+ },
156
+ {
157
+ "name": "enableDebug",
158
+ "tags": [],
159
+ "docs": "Enable debug logging",
160
+ "complexTypes": [],
161
+ "type": "boolean | undefined"
162
+ }
163
+ ]
164
+ },
165
+ {
166
+ "name": "AvailableApp",
167
+ "slug": "availableapp",
168
+ "docs": "Result of checking app availability",
169
+ "tags": [],
170
+ "methods": [],
171
+ "properties": [
172
+ {
173
+ "name": "app",
174
+ "tags": [],
175
+ "docs": "App identifier",
176
+ "complexTypes": [],
177
+ "type": "string"
178
+ },
179
+ {
180
+ "name": "name",
181
+ "tags": [],
182
+ "docs": "Display name of the app",
183
+ "complexTypes": [],
184
+ "type": "string"
185
+ },
186
+ {
187
+ "name": "available",
188
+ "tags": [],
189
+ "docs": "Whether the app is available on the device",
190
+ "complexTypes": [],
191
+ "type": "boolean"
192
+ }
193
+ ]
194
+ }
195
+ ],
196
+ "enums": [
197
+ {
198
+ "name": "TransportMode",
199
+ "slug": "transportmode",
200
+ "members": [
201
+ {
202
+ "name": "DRIVING",
203
+ "value": "'driving'",
204
+ "tags": [],
205
+ "docs": ""
206
+ },
207
+ {
208
+ "name": "WALKING",
209
+ "value": "'walking'",
210
+ "tags": [],
211
+ "docs": ""
212
+ },
213
+ {
214
+ "name": "BICYCLING",
215
+ "value": "'bicycling'",
216
+ "tags": [],
217
+ "docs": ""
218
+ },
219
+ {
220
+ "name": "TRANSIT",
221
+ "value": "'transit'",
222
+ "tags": [],
223
+ "docs": ""
224
+ }
225
+ ]
226
+ },
227
+ {
228
+ "name": "IOSNavigationApp",
229
+ "slug": "iosnavigationapp",
230
+ "members": [
231
+ {
232
+ "name": "APPLE_MAPS",
233
+ "value": "'apple_maps'",
234
+ "tags": [],
235
+ "docs": ""
236
+ },
237
+ {
238
+ "name": "GOOGLE_MAPS",
239
+ "value": "'google_maps'",
240
+ "tags": [],
241
+ "docs": ""
242
+ },
243
+ {
244
+ "name": "WAZE",
245
+ "value": "'waze'",
246
+ "tags": [],
247
+ "docs": ""
248
+ },
249
+ {
250
+ "name": "CITYMAPPER",
251
+ "value": "'citymapper'",
252
+ "tags": [],
253
+ "docs": ""
254
+ },
255
+ {
256
+ "name": "GARMIN_NAVIGON",
257
+ "value": "'garmin_navigon'",
258
+ "tags": [],
259
+ "docs": ""
260
+ },
261
+ {
262
+ "name": "TRANSIT_APP",
263
+ "value": "'transit_app'",
264
+ "tags": [],
265
+ "docs": ""
266
+ },
267
+ {
268
+ "name": "YANDEX_NAVIGATOR",
269
+ "value": "'yandex'",
270
+ "tags": [],
271
+ "docs": ""
272
+ },
273
+ {
274
+ "name": "UBER",
275
+ "value": "'uber'",
276
+ "tags": [],
277
+ "docs": ""
278
+ },
279
+ {
280
+ "name": "TOMTOM",
281
+ "value": "'tomtom'",
282
+ "tags": [],
283
+ "docs": ""
284
+ },
285
+ {
286
+ "name": "SYGIC",
287
+ "value": "'sygic'",
288
+ "tags": [],
289
+ "docs": ""
290
+ },
291
+ {
292
+ "name": "HERE_MAPS",
293
+ "value": "'here'",
294
+ "tags": [],
295
+ "docs": ""
296
+ },
297
+ {
298
+ "name": "MOOVIT",
299
+ "value": "'moovit'",
300
+ "tags": [],
301
+ "docs": ""
302
+ },
303
+ {
304
+ "name": "LYFT",
305
+ "value": "'lyft'",
306
+ "tags": [],
307
+ "docs": ""
308
+ },
309
+ {
310
+ "name": "MAPS_ME",
311
+ "value": "'mapsme'",
312
+ "tags": [],
313
+ "docs": ""
314
+ },
315
+ {
316
+ "name": "CABIFY",
317
+ "value": "'cabify'",
318
+ "tags": [],
319
+ "docs": ""
320
+ },
321
+ {
322
+ "name": "BAIDU",
323
+ "value": "'baidu'",
324
+ "tags": [],
325
+ "docs": ""
326
+ },
327
+ {
328
+ "name": "GAODE",
329
+ "value": "'gaode'",
330
+ "tags": [],
331
+ "docs": ""
332
+ },
333
+ {
334
+ "name": "TAXI_99",
335
+ "value": "'99taxi'",
336
+ "tags": [],
337
+ "docs": ""
338
+ }
339
+ ]
340
+ },
341
+ {
342
+ "name": "AndroidNavigationApp",
343
+ "slug": "androidnavigationapp",
344
+ "members": [
345
+ {
346
+ "name": "GOOGLE_MAPS",
347
+ "value": "'google_maps'",
348
+ "tags": [],
349
+ "docs": ""
350
+ },
351
+ {
352
+ "name": "WAZE",
353
+ "value": "'waze'",
354
+ "tags": [],
355
+ "docs": ""
356
+ },
357
+ {
358
+ "name": "CITYMAPPER",
359
+ "value": "'citymapper'",
360
+ "tags": [],
361
+ "docs": ""
362
+ },
363
+ {
364
+ "name": "UBER",
365
+ "value": "'uber'",
366
+ "tags": [],
367
+ "docs": ""
368
+ },
369
+ {
370
+ "name": "YANDEX",
371
+ "value": "'yandex'",
372
+ "tags": [],
373
+ "docs": ""
374
+ },
375
+ {
376
+ "name": "SYGIC",
377
+ "value": "'sygic'",
378
+ "tags": [],
379
+ "docs": ""
380
+ },
381
+ {
382
+ "name": "HERE_MAPS",
383
+ "value": "'here'",
384
+ "tags": [],
385
+ "docs": ""
386
+ },
387
+ {
388
+ "name": "MOOVIT",
389
+ "value": "'moovit'",
390
+ "tags": [],
391
+ "docs": ""
392
+ },
393
+ {
394
+ "name": "LYFT",
395
+ "value": "'lyft'",
396
+ "tags": [],
397
+ "docs": ""
398
+ },
399
+ {
400
+ "name": "MAPS_ME",
401
+ "value": "'mapsme'",
402
+ "tags": [],
403
+ "docs": ""
404
+ },
405
+ {
406
+ "name": "CABIFY",
407
+ "value": "'cabify'",
408
+ "tags": [],
409
+ "docs": ""
410
+ },
411
+ {
412
+ "name": "BAIDU",
413
+ "value": "'baidu'",
414
+ "tags": [],
415
+ "docs": ""
416
+ },
417
+ {
418
+ "name": "GAODE",
419
+ "value": "'gaode'",
420
+ "tags": [],
421
+ "docs": ""
422
+ }
423
+ ]
424
+ },
425
+ {
426
+ "name": "LaunchMode",
427
+ "slug": "launchmode",
428
+ "members": [
429
+ {
430
+ "name": "MAPS",
431
+ "value": "'maps'",
432
+ "tags": [],
433
+ "docs": ""
434
+ },
435
+ {
436
+ "name": "TURN_BY_TURN",
437
+ "value": "'turn_by_turn'",
438
+ "tags": [],
439
+ "docs": ""
440
+ },
441
+ {
442
+ "name": "GEO",
443
+ "value": "'geo'",
444
+ "tags": [],
445
+ "docs": ""
446
+ }
447
+ ]
448
+ }
449
+ ],
450
+ "typeAliases": [
451
+ {
452
+ "name": "Record",
453
+ "slug": "record",
454
+ "docs": "Construct a type with a set of properties K of type T",
455
+ "types": [
456
+ {
457
+ "text": "{\r\n [P in K]: T;\r\n}",
458
+ "complexTypes": [
459
+ "K",
460
+ "T"
461
+ ]
462
+ }
463
+ ]
464
+ }
465
+ ],
466
+ "pluginConfigs": []
467
+ }
@@ -0,0 +1,173 @@
1
+ /**
2
+ * Available navigation apps for iOS
3
+ */
4
+ export declare enum IOSNavigationApp {
5
+ APPLE_MAPS = "apple_maps",
6
+ GOOGLE_MAPS = "google_maps",
7
+ WAZE = "waze",
8
+ CITYMAPPER = "citymapper",
9
+ GARMIN_NAVIGON = "garmin_navigon",
10
+ TRANSIT_APP = "transit_app",
11
+ YANDEX_NAVIGATOR = "yandex",
12
+ UBER = "uber",
13
+ TOMTOM = "tomtom",
14
+ SYGIC = "sygic",
15
+ HERE_MAPS = "here",
16
+ MOOVIT = "moovit",
17
+ LYFT = "lyft",
18
+ MAPS_ME = "mapsme",
19
+ CABIFY = "cabify",
20
+ BAIDU = "baidu",
21
+ GAODE = "gaode",
22
+ TAXI_99 = "99taxi"
23
+ }
24
+ /**
25
+ * Available navigation apps for Android
26
+ */
27
+ export declare enum AndroidNavigationApp {
28
+ GOOGLE_MAPS = "google_maps",
29
+ WAZE = "waze",
30
+ CITYMAPPER = "citymapper",
31
+ UBER = "uber",
32
+ YANDEX = "yandex",
33
+ SYGIC = "sygic",
34
+ HERE_MAPS = "here",
35
+ MOOVIT = "moovit",
36
+ LYFT = "lyft",
37
+ MAPS_ME = "mapsme",
38
+ CABIFY = "cabify",
39
+ BAIDU = "baidu",
40
+ GAODE = "gaode"
41
+ }
42
+ /**
43
+ * Transport modes
44
+ */
45
+ export declare enum TransportMode {
46
+ DRIVING = "driving",
47
+ WALKING = "walking",
48
+ BICYCLING = "bicycling",
49
+ TRANSIT = "transit"
50
+ }
51
+ /**
52
+ * Launch modes
53
+ */
54
+ export declare enum LaunchMode {
55
+ MAPS = "maps",
56
+ TURN_BY_TURN = "turn_by_turn",
57
+ GEO = "geo"
58
+ }
59
+ /**
60
+ * Options for navigation
61
+ */
62
+ export interface NavigateOptions {
63
+ /**
64
+ * Starting location coordinates [latitude, longitude]
65
+ */
66
+ start?: [number, number];
67
+ /**
68
+ * Starting location name
69
+ */
70
+ startName?: string;
71
+ /**
72
+ * Destination name (will be ignored since we only support coordinates)
73
+ */
74
+ destinationName?: string;
75
+ /**
76
+ * Transport mode
77
+ */
78
+ transportMode?: TransportMode;
79
+ /**
80
+ * Specific app to launch (if not specified, will use default or prompt)
81
+ */
82
+ app?: IOSNavigationApp | AndroidNavigationApp | string;
83
+ /**
84
+ * Launch mode
85
+ */
86
+ launchMode?: LaunchMode;
87
+ /**
88
+ * Additional parameters specific to certain apps
89
+ */
90
+ extras?: Record<string, any>;
91
+ /**
92
+ * Enable debug logging
93
+ */
94
+ enableDebug?: boolean;
95
+ }
96
+ /**
97
+ * Result of checking app availability
98
+ */
99
+ export interface AvailableApp {
100
+ /**
101
+ * App identifier
102
+ */
103
+ app: string;
104
+ /**
105
+ * Display name of the app
106
+ */
107
+ name: string;
108
+ /**
109
+ * Whether the app is available on the device
110
+ */
111
+ available: boolean;
112
+ }
113
+ /**
114
+ * Main plugin interface
115
+ */
116
+ export interface LaunchNavigatorPlugin {
117
+ /**
118
+ * Navigate to a location using latitude and longitude
119
+ * @param options Navigation options with destination coordinates
120
+ */
121
+ navigate(options: {
122
+ /**
123
+ * Destination coordinates [latitude, longitude]
124
+ */
125
+ destination: [number, number];
126
+ /**
127
+ * Optional navigation options
128
+ */
129
+ options?: NavigateOptions;
130
+ }): Promise<void>;
131
+ /**
132
+ * Check if a specific navigation app is available
133
+ * @param options Options containing app identifier
134
+ */
135
+ isAppAvailable(options: {
136
+ /**
137
+ * App identifier to check
138
+ */
139
+ app: IOSNavigationApp | AndroidNavigationApp | string;
140
+ }): Promise<{
141
+ /**
142
+ * Whether the app is available
143
+ */
144
+ available: boolean;
145
+ }>;
146
+ /**
147
+ * Get list of available navigation apps on the device
148
+ */
149
+ getAvailableApps(): Promise<{
150
+ /**
151
+ * List of available apps
152
+ */
153
+ apps: AvailableApp[];
154
+ }>;
155
+ /**
156
+ * Get list of supported apps for the current platform
157
+ */
158
+ getSupportedApps(): Promise<{
159
+ /**
160
+ * List of supported app identifiers
161
+ */
162
+ apps: string[];
163
+ }>;
164
+ /**
165
+ * Get the name of the default app for navigation
166
+ */
167
+ getDefaultApp(): Promise<{
168
+ /**
169
+ * Default app identifier
170
+ */
171
+ app: string;
172
+ }>;
173
+ }
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Available navigation apps for iOS
3
+ */
4
+ export var IOSNavigationApp;
5
+ (function (IOSNavigationApp) {
6
+ IOSNavigationApp["APPLE_MAPS"] = "apple_maps";
7
+ IOSNavigationApp["GOOGLE_MAPS"] = "google_maps";
8
+ IOSNavigationApp["WAZE"] = "waze";
9
+ IOSNavigationApp["CITYMAPPER"] = "citymapper";
10
+ IOSNavigationApp["GARMIN_NAVIGON"] = "garmin_navigon";
11
+ IOSNavigationApp["TRANSIT_APP"] = "transit_app";
12
+ IOSNavigationApp["YANDEX_NAVIGATOR"] = "yandex";
13
+ IOSNavigationApp["UBER"] = "uber";
14
+ IOSNavigationApp["TOMTOM"] = "tomtom";
15
+ IOSNavigationApp["SYGIC"] = "sygic";
16
+ IOSNavigationApp["HERE_MAPS"] = "here";
17
+ IOSNavigationApp["MOOVIT"] = "moovit";
18
+ IOSNavigationApp["LYFT"] = "lyft";
19
+ IOSNavigationApp["MAPS_ME"] = "mapsme";
20
+ IOSNavigationApp["CABIFY"] = "cabify";
21
+ IOSNavigationApp["BAIDU"] = "baidu";
22
+ IOSNavigationApp["GAODE"] = "gaode";
23
+ IOSNavigationApp["TAXI_99"] = "99taxi";
24
+ })(IOSNavigationApp || (IOSNavigationApp = {}));
25
+ /**
26
+ * Available navigation apps for Android
27
+ */
28
+ export var AndroidNavigationApp;
29
+ (function (AndroidNavigationApp) {
30
+ AndroidNavigationApp["GOOGLE_MAPS"] = "google_maps";
31
+ AndroidNavigationApp["WAZE"] = "waze";
32
+ AndroidNavigationApp["CITYMAPPER"] = "citymapper";
33
+ AndroidNavigationApp["UBER"] = "uber";
34
+ AndroidNavigationApp["YANDEX"] = "yandex";
35
+ AndroidNavigationApp["SYGIC"] = "sygic";
36
+ AndroidNavigationApp["HERE_MAPS"] = "here";
37
+ AndroidNavigationApp["MOOVIT"] = "moovit";
38
+ AndroidNavigationApp["LYFT"] = "lyft";
39
+ AndroidNavigationApp["MAPS_ME"] = "mapsme";
40
+ AndroidNavigationApp["CABIFY"] = "cabify";
41
+ AndroidNavigationApp["BAIDU"] = "baidu";
42
+ AndroidNavigationApp["GAODE"] = "gaode";
43
+ })(AndroidNavigationApp || (AndroidNavigationApp = {}));
44
+ /**
45
+ * Transport modes
46
+ */
47
+ export var TransportMode;
48
+ (function (TransportMode) {
49
+ TransportMode["DRIVING"] = "driving";
50
+ TransportMode["WALKING"] = "walking";
51
+ TransportMode["BICYCLING"] = "bicycling";
52
+ TransportMode["TRANSIT"] = "transit";
53
+ })(TransportMode || (TransportMode = {}));
54
+ /**
55
+ * Launch modes
56
+ */
57
+ export var LaunchMode;
58
+ (function (LaunchMode) {
59
+ LaunchMode["MAPS"] = "maps";
60
+ LaunchMode["TURN_BY_TURN"] = "turn_by_turn";
61
+ LaunchMode["GEO"] = "geo";
62
+ })(LaunchMode || (LaunchMode = {}));
63
+ //# sourceMappingURL=definitions.js.map