passkit 0.0.3

Pure Dart library which can read Apple's PKPass files. Works on servers too.

PassKit

🚧 API is subject to change! 🚧 The API should become a lot more stable once this package fully supports localization.

PassKit allows you to work with Apple's PkPass files. This is a pure Dart library. No Flutter needed.

In order to show PassKit files in Flutter, use the passkit_ui package, which includes ready made widgets.

Want to work with Apple's native PassKit APIs? Consider using apple_passkit.

What is PassKit?

Passes are a digital representation of information that might otherwise be printed on small pieces of paper or plastic. They let users take an action in the physical world. Passes can contain images and a barcode, and you can update passes using push notifications on iOS.

This technology consists of three main components:

• A package format for creating passes.
• A web service API for updating passes, implemented on your server.
• An API used by your apps to interact with the user’s pass library.

A PkPass file looks something like this when rendered:

How to read a PassKit file?

import 'package:passkit/passkit.dart';

void main() {
  final passKitBytes = ... // get bytes for the PassKit from somewhere
  final pkPass = PkPass.fromBytes(passKitBytes);
}

How to get the latest version of a given PkPass?

import 'package:passkit/passkit.dart';

void main() {
  final passKitBytes = ... // get bytes for the PassKit from somewhere
  final pkPass = PkPass.fromBytes(passKitBytes);

  if(pkPass.isWebServiceAvailable) {
    final pkPassBytes = PassKitWebClient().getLatestVersion(pkPass);
  }
}

Currently unsupported functionality

Feel free to submit PRs for them

• Semantic Tags: https://developer.apple.com/documentation/passkit/wallet/supporting_semantic_tags_in_wallet_passes
• PassKit Web Service: https://developer.apple.com/library/archive/documentation/PassKit/Reference/PassKit_WebService/WebService.html#//apple_ref/doc/uid/TP40011988
  • Partially supported
  • Push Notification related functionality can only work on iOS due to its APN requirement (that's why it's not done yet)
• Localization: https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/Creating.html#//apple_ref/doc/uid/TP40012195-CH4-SW54 (as seen at the bottom of the page)
  • .strings file format description https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/LoadingResources/Strings/Strings.html
• Passkit creation: https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/Creating.html#//apple_ref/doc/uid/TP40012195-CH4-SW54 (as seen at the bottom of the page)
• checksum verification

Apple Wallet PassKit docs

• Wallet Human Interface Guidelines
• Wallet Passes
• Loyalty passes
• Wallet Developer Guide

Bugs and parsing issues

If you hit an issue with parsing, please create an issue and attach the PkPass (if possible)

Contributors

Thanks a lot to all the awesome contributors:

Contribute to this library, and you'll show up too.

We encourage you to contribute to this library. A good starting point is to look at these good first issues. Take a look at these issues if you're up for a challenge.