Toolkit documentation - alexandercerutti/passkit-webservice-toolkit GitHub Wiki

This package exposes a set of endpoint definitions and Typescript types to let you build your integration. They are organized below per Apple Service.

Each entry point exposes an endpoint definition. Thanks to the magic of Typescript, the properties of the definition will show the exact values 🪄 🌈.

So, anytime, you can mouse-hover the constants and see all the details of the endpoint.

type EntrypointDefinition = {
    method: "POST";
    path: "/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber";
    params: ["deviceLibraryIdentifier", "passTypeIdentifier", "serialNumber"];
    toString(): "POST /v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber";
}

This package is studied to be compatible with both CJS and ESM. It exposes the following entry points in package.json:

{
	".": {
		"import": "./lib/esm/index.js",
		"require": "./lib/cjs/index.js"
	},
	"./v1": {
		"import": "./lib/esm/services/v1/index.js",
		"require": "./lib/cjs/services/v1/index.js"
	},
	"./v1/*": {
		"import": "./lib/esm/services/v1/*",
		"require": "./lib/cjs/services/v1/*"
	}
}

Therefore it could be used in the following ways:

import { v1 } from "passkit-webservice-toolkit";
import { ... } from "passkit-webservice-toolkit/v1";
import { LogEndpoint } from "passkit-webservice-toolkit/v1/log.js";

const { v1 } = require("passkit-webservice-toolkit");
const { ... } = require("passkit-webservice-toolkit/v1");
const { LogEndpoint } = require("passkit-webservice-toolkit/v1/log.js");

Documentation: https://developer.apple.com/documentation/walletpasses/register_a_pass_for_update_notifications

Entrypoint: passkit-webservice-toolkit/v1/register.js.

Exports:

(typeof RegisterEndpoint)["params"]

Documentation: https://developer.apple.com/documentation/walletpasses/unregister_a_pass_for_update_notifications

Entrypoint: passkit-webservice-toolkit/v1/unregister.js.

Exports:

(typeof UnregisterEndpoint)["params"]

Documentation: https://developer.apple.com/documentation/walletpasses/send_an_updated_pass

Entrypoint: passkit-webservice-toolkit/v1/update.js.

Exports:

(typeof UpdateEndpoint)["params"]

Documentation: https://developer.apple.com/documentation/walletpasses/get_the_list_of_updatable_passes

Entrypoint: passkit-webservice-toolkit/v1/list.js.

Description:

Will be called only after the server signals Apple of updates via APNS.

Exports:

(typeof ListEndpoint)["params"]

Documentation: https://developer.apple.com/documentation/walletpasses/log_a_message

Entrypoint: passkit-webservice-toolkit/v1/log.js.

Exports:

(typeof LogEndpoint)["params"]

passkit-webservice-toolkit also exposes some utilities that could be helpful to perform some kind of validation.

Entrypoint: passkit-webservice-toolkit/v1/utils/auth.js

declare function isAuthorizationSchemeValid(authorizationString: string): boolean;

Description:

Will perform light validation on the Authorization schema, by checking if it is ApplePass and returning the right boolean.

declare function getAuthorizationToken(authorizationString: string): string;

Description:

Will extract the token from the Authorization header you provide. Performs a light validation on the Authorization Schema.

Throws if the schema is not ApplePass.