MapkitJS (mapkit_js v0.3.0)

Copy Markdown View Source

Elixir client for Apple MapKit JS token generation.

MapKit JS uses an ES256 JWT that your web app passes to mapkit.init/1. This library focuses on generating and caching that JWT.

The public surface is intentionally small:

MapkitJS.token()
MapkitJS.generate_token(origin: "https://example.com")
MapkitJS.authorization_callback_payload()

Configuration

config :mapkit_js,
  team_id: System.get_env("APPLE_TEAM_ID"),
  key_id: System.get_env("MAPKIT_KEY_ID"),
  private_key: System.get_env("MAPKIT_PRIVATE_KEY"),
  origin: System.get_env("MAPKIT_ORIGIN")

Every function also accepts per-call opts that override the application config.

Summary

Types

opts()

Functions

authorization_callback_payload(opts \\ [])

Return the payload commonly passed into a browser-side authorizationCallback.

generate_token(opts \\ [])

Generate a new MapKit JS JWT.

token(opts \\ [])

Return a MapKit JS JWT using the configured token cache behavior.

Types

opts()

@type opts() :: keyword()

Functions

authorization_callback_payload(opts \\ [])

@spec authorization_callback_payload(opts()) :: {:ok, map()} | {:error, term()}

Return the payload commonly passed into a browser-side authorizationCallback.

generate_token(opts \\ [])

@spec generate_token(opts()) :: {:ok, String.t()} | {:error, term()}

Generate a new MapKit JS JWT.

token(opts \\ [])

@spec token(opts()) :: {:ok, String.t()} | {:error, term()}

Return a MapKit JS JWT using the configured token cache behavior.