MapKit JS Token Generator


Generate long-lived tokens from the CLI that can be used with the MapKit JS's authorizationCallback.

> Setting authorizationCallback to a function that returns a token as a string is useful for local development, or if you want to use a long-lived token with MapKit JS. Sign a token locally on your development machine with an expiration, then use the token directly in your code.
>
> ``js
> mapkit.init({
> authorizationCallback(done) {
> done('your-generated-token-string-here');
> },
> });
> `

$3

- Verifies if the token works against MapKit servers

Usage

`
$ npx mapkitjs-token [options]
`

Since we're dealing with private keys, you may feel safer compiling this tool yourself and running it locally (see Compiling).

$3

`
Options:
--help Show help [boolean]
--version Show version number [boolean]
--kid A 10-character key identifier (kid) key, obtained from your Apple
Developer account [string] [required]
--iss The Issuer (iss) registered claim key. This key's value is your
10-character Team ID, obtained from your developer account.
[string] [required]
--iat The Issued At (iat), relative to now. Uses zeit/ms strings (e.g
'0', '2d', '1y')
[string] [default: 0, current time (e.g 0 seconds from "now")]
--exp The Expiration Time (exp) relative to iat, using a zeit/ms
string (e.g '1hr, '2d', '1y').
[string] [default: 364d, 364 day expiration]
--sub The subject public claim key. This value could for example be your
registered Service ID. Needed for WeatherKit tokens.
[string]
--key MapKit private key file path [required]
--origin The Origin (origin) key. This key's value is a fully qualified
domain that should match the Origin header passed by a browser.
[string]
--verify Test the generated token with MapKit servers to verify if valid
[boolean] [default: true, will verify token after it generates]
--stdout Set to true to output only the token, suitable for piping
[boolean] [default: false, by default, outputs extra data about the token]
`

See the MapKit JS documentation for the full explanation of these options.

$3

Generate a token with the default expiration (1 year) and verify the token works:

`
$ npx mapkitjs-token --kid ABC123DEFG --iss DEF123GHIJ --key ./secret.p8

Token Information:
Key Id (kid) ABC123DEFG
Issuer (iss) DEF123GHIJ
Issued (iat) 1583626697 (Sat Mar 07 2020 16:18:17 GMT-0800 (Pacific Standard Time))
Expire (exp) 1583630297 (Sat Mar 07 2020 17:18:17 GMT-0800 (Pacific Standard Time))
Expires In 364 days (31449600s)
Sub none
Origin none
Valid valid
Token [generated token]
`

Generate a token to stdout, verify, and copy directly to clipboard (macOS via pbcopy):

`
$ npx mapkitjs-token --kid ABC123DEFG --iss DEF123GHIJ --key ./secret.p8 --stdout | pbcopy
`

Generate a token with a 8 year expiration, add an origin, and skip verification:

`
$ npx mapkitjs-token --kid ABC123DEFG --iss DEF123GHIJ --key ./secret.p8 --exp=8y --origin https://example.com --verify=false

Token Information:
Key Id (kid) ABC123DEFG
Issuer (iss) DEF123GHIJ
Issued (iat) 1583627770 (Sat Mar 07 2020 16:36:10 GMT-0800 (Pacific Standard Time))
Expire (exp) 1836088570 (Tue Mar 07 2028 16:36:10 GMT-0800 (Pacific Standard Time))
Expires In 2922 days (252460800s)
Sub none
Origin https://example.com
Valid skipped
Token [generated token]
`

Compiling

`
$ npm ci
$ npm run build
$ node ./dist/cli.js [options]
``