Files
passkit-generator/spec/PKPass.ts
2021-10-11 23:23:25 +02:00

528 lines
13 KiB
TypeScript

import {
default as PKPass,
localizationSymbol,
certificatesSymbol,
propsSymbol,
} from "../lib/PKPass";
describe("PKPass", () => {
let pass: PKPass;
const baseCerts = {
signerCert: "",
signerKey: "",
wwdr: "",
signerKeyPassphrase: "p477w0rb",
};
beforeEach(() => {
pass = new PKPass(
{},
/** @ts-ignore - We don't need certificates here*/
baseCerts,
{},
);
});
describe("setBeacons", () => {
it("should reset instance.props['beacons'] if 'null' is passed as value", () => {
pass.setBeacons({
proximityUUID: "0000000000-00000000",
major: 4,
minor: 3,
relevantText: "This is not the Kevin you are looking for.",
});
expect(pass.props["beacons"].length).toBe(1);
pass.setBeacons(null);
expect(pass.props["beacons"]).toBeUndefined();
});
it("should filter out invalid beacons objects", () => {
/** This is invalid, major should be greater than minor */
pass.setBeacons(
{
proximityUUID: "0000000000-00000000",
major: 2,
minor: 3,
relevantText: "This is not the Kevin you are looking for.",
},
// @ts-expect-error
{
major: 2,
minor: 3,
},
{
proximityUUID: "0000000000-00000",
major: 2,
minor: 1,
},
);
expect(pass.props["beacons"].length).toBe(1);
});
it("should always return undefined", () => {
expect(pass.setBeacons(null)).toBeUndefined();
expect(
pass.setBeacons({
proximityUUID: "0000000000-00000000",
major: 2,
minor: 3,
relevantText: "This is not the Kevin you are looking for.",
}),
).toBeUndefined();
});
});
describe("setLocations", () => {
it("should reset instance.props['locations'] if 'null' is passed as value", () => {
pass.setLocations({
longitude: 0.25456342344,
latitude: 0.26665773234,
});
expect(pass.props["locations"].length).toBe(1);
pass.setLocations(null);
expect(pass.props["locations"]).toBeUndefined();
});
it("should filter out invalid beacons objects", () => {
pass.setLocations(
{
// @ts-expect-error
longitude: "unknown",
// @ts-expect-error
latitude: "unknown",
},
{
altitude: "say hello from here",
longitude: 0.25456342344,
},
{
longitude: 0.25456342344,
latitude: 0.26665773234,
altitude: 12552.31233321,
relevantText:
/** Hi mom, see how do I fly! */
"Ciao mamma, guarda come volooo!",
},
);
expect(pass.props["locations"].length).toBe(1);
expect(pass.props["locations"][0].longitude).toBe(0.25456342344);
expect(pass.props["locations"][0].latitude).toBe(0.26665773234);
expect(pass.props["locations"][0].altitude).toBe(12552.31233321);
expect(pass.props["locations"][0].relevantText).toBe(
"Ciao mamma, guarda come volooo!",
);
});
it("should always return undefined", () => {
expect(pass.setLocations(null)).toBeUndefined();
expect(
pass.setLocations({
longitude: 0.25456342344,
latitude: 0.26665773234,
altitude: 12552.31233321,
}),
).toBeUndefined();
});
});
describe("setNFCCapability", () => {
it("should reset instance.props['nfc'] if 'null' is passed as value", () => {
pass.setNFCCapability({
encryptionPublicKey: "mimmo",
message: "No message for you here",
});
expect(pass.props["nfc"]).toEqual({
encryptionPublicKey: "mimmo",
message: "No message for you here",
});
pass.setNFCCapability(null);
expect(pass.props["nfc"]).toBeUndefined();
});
it("should throw on invalid objects received", () => {
expect(() =>
pass.setNFCCapability({
// @ts-expect-error
requiresAuth: false,
encryptionPublicKey: "Nope",
}),
).toThrow();
});
it("should always return undefined", () => {
expect(pass.setNFCCapability(null)).toBeUndefined();
expect(
pass.setNFCCapability({
encryptionPublicKey: "mimmo",
message: "No message for you here",
}),
).toBeUndefined();
});
});
describe("setExpirationDate", () => {
it("should reset instance.props['expirationDate'] if 'null' is passed as value", () => {
pass.setExpirationDate(new Date(2020, 6, 1, 0, 0, 0, 0));
// Month starts from 0 in Date Object when used this way, therefore
// we expect one month more
expect(pass.props["expirationDate"]).toBe("2020-07-01T00:00:00Z");
pass.setExpirationDate(null);
expect(pass.props["expirationDate"]).toBeUndefined();
});
it("expects a Date object as the only argument", () => {
pass.setExpirationDate(new Date(2020, 6, 1, 0, 0, 0, 0));
// Month starts from 0 in Date Object when used this way, therefore
// we expect one month more
expect(pass.props["expirationDate"]).toBe("2020-07-01T00:00:00Z");
});
it("should throw if an invalid date is received", () => {
// @ts-expect-error
expect(() => pass.setExpirationDate("32/18/228317")).toThrowError(
TypeError,
"Cannot set expirationDate. Invalid date 32/18/228317",
);
expect(() => pass.setExpirationDate(undefined)).toThrowError(
TypeError,
"Cannot set expirationDate. Invalid date undefined",
);
// @ts-expect-error
expect(() => pass.setExpirationDate(5)).toThrowError(
TypeError,
"Cannot set expirationDate. Invalid date 5",
);
// @ts-expect-error
expect(() => pass.setExpirationDate({})).toThrowError(
TypeError,
"Cannot set expirationDate. Invalid date [object Object]",
);
});
it("should always return undefined", () => {
expect(pass.setExpirationDate(null)).toBeUndefined();
expect(
pass.setExpirationDate(new Date(2020, 6, 1, 0, 0, 0, 0)),
).toBeUndefined();
});
});
describe("setRelevantDate", () => {
it("should reset instance.props['relevantDate'] if 'null' is passed as value", () => {
pass.setRelevantDate(new Date(2020, 6, 1, 0, 0, 0, 0));
// Month starts from 0 in Date Object when used this way, therefore
// we expect one month more
expect(pass.props["relevantDate"]).toBe("2020-07-01T00:00:00Z");
pass.setRelevantDate(null);
expect(pass.props["relevantDate"]).toBeUndefined();
});
it("expects a Date object as the only argument", () => {
pass.setRelevantDate(new Date("10-04-2021"));
expect(pass.props["relevantDate"]).toBe("2021-10-04T00:00:00Z");
});
it("should throw if an invalid date is received", () => {
// @ts-expect-error
expect(() => pass.setRelevantDate("32/18/228317")).toThrowError(
TypeError,
"Cannot set relevantDate. Invalid date 32/18/228317",
);
expect(() => pass.setRelevantDate(undefined)).toThrowError(
TypeError,
"Cannot set relevantDate. Invalid date undefined",
);
// @ts-expect-error
expect(() => pass.setRelevantDate(5)).toThrowError(
TypeError,
"Cannot set relevantDate. Invalid date 5",
);
// @ts-expect-error
expect(() => pass.setRelevantDate({})).toThrowError(
TypeError,
"Cannot set relevantDate. Invalid date [object Object]",
);
});
it("should always return undefined", () => {
expect(pass.setRelevantDate(null)).toBeUndefined();
expect(
pass.setRelevantDate(new Date(2020, 6, 1, 0, 0, 0, 0)),
).toBeUndefined();
});
});
describe("setBarcodes", () => {
it("shouldn't apply changes if no data is passed", () => {
const props = pass.props["barcodes"] || [];
const oldAmountOfBarcodes = props?.length ?? 0;
pass.setBarcodes();
expect(pass.props["barcodes"]?.length || 0).toBe(
oldAmountOfBarcodes,
);
});
it("should throw error if a boolean parameter is received", () => {
// @ts-expect-error
expect(() => pass.setBarcodes(true)).toThrowError(
TypeError,
"Expected Schema.Barcode in setBarcodes but no one is valid.",
);
});
it("should ignore if a number parameter is received", () => {
// @ts-expect-error
expect(() => pass.setBarcodes(42)).toThrowError(
TypeError,
"Expected Schema.Barcode in setBarcodes but no one is valid.",
);
});
it("should autogenerate all the barcodes objects if a string is provided as message", () => {
pass.setBarcodes("28363516282");
expect(pass.props["barcodes"].length).toBe(4);
});
it("should save changes if object conforming to Schemas.Barcode are provided", () => {
pass.setBarcodes({
message: "28363516282",
format: "PKBarcodeFormatPDF417",
messageEncoding: "utf8",
});
expect(pass.props["barcodes"].length).toBe(1);
});
it("should add 'messageEncoding' if missing in valid Schema.Barcode parameters", () => {
pass.setBarcodes({
message: "28363516282",
format: "PKBarcodeFormatPDF417",
});
expect(pass.props["barcodes"][0].messageEncoding).toBe(
"iso-8859-1",
);
});
it("should ignore objects without 'message' property in Schema.Barcode", () => {
pass.setBarcodes(
{
format: "PKBarcodeFormatCode128",
message: "No one can validate meeee",
},
// @ts-expect-error
{
format: "PKBarcodeFormatPDF417",
},
);
expect(pass.props["barcodes"].length).toBe(1);
});
it("should ignore objects and values that not comply with Schema.Barcodes", () => {
pass.setBarcodes(
// @ts-expect-error
5,
10,
15,
{
message: "28363516282",
format: "PKBarcodeFormatPDF417",
},
7,
1,
);
expect(pass.props["barcodes"].length).toBe(1);
});
it("should reset barcodes content if parameter is null", () => {
pass.setBarcodes({
message: "28363516282",
format: "PKBarcodeFormatPDF417",
messageEncoding: "utf8",
});
expect(pass.props["barcodes"].length).toBe(1);
pass.setBarcodes(null);
expect(pass.props["barcodes"]).toBe(undefined);
});
it("should always return undefined", () => {
expect(pass.setBarcodes(null)).toBeUndefined();
expect(
pass.setBarcodes({
message: "28363516282",
format: "PKBarcodeFormatPDF417",
messageEncoding: "utf8",
}),
).toBeUndefined();
});
});
describe("transitType", () => {
it("should accept a new value only if the pass is a boarding pass", () => {
const passBP = new PKPass(
{
"pass.json": Buffer.from(
JSON.stringify({
boardingPass: {},
}),
),
},
baseCerts,
{},
);
const passCP = new PKPass(
{
"pass.json": Buffer.from(
JSON.stringify({
coupon: {},
}),
),
},
baseCerts,
{},
);
passBP.transitType = "PKTransitTypeAir";
expect(passBP.transitType).toBe("PKTransitTypeAir");
expect(
() => (passCP.transitType = "PKTransitTypeAir"),
).toThrowError(
TypeError,
"Cannot set transitType on a pass with type different from 'boardingPass'.",
);
expect(passCP.transitType).toBeUndefined();
});
});
describe("certificates setter", () => {
it("should throw an error if certificates provided are not complete or invalid", () => {
expect(() => {
// @ts-expect-error
pass.certificates = {
signerCert: "",
};
}).toThrow();
expect(() => {
pass.certificates = {
// @ts-expect-error
signerCert: 5,
// @ts-expect-error
signerKey: 3,
wwdr: "",
};
}).toThrow();
expect(() => {
pass.certificates = {
signerCert: undefined,
signerKey: null,
wwdr: "",
};
}).toThrow();
/** Expecting previous result */
expect(pass[certificatesSymbol]).toEqual(baseCerts);
});
});
describe("localize", () => {
it("should fail throw if lang is not a string", () => {
expect(() => pass.localize(null)).toThrowError(
TypeError,
"Cannot set localization. Expected a string for 'lang' but received a object",
);
expect(() => pass.localize(undefined)).toThrowError(
TypeError,
"Cannot set localization. Expected a string for 'lang' but received a undefined",
);
// @ts-expect-error
expect(() => pass.localize(5)).toThrowError(
TypeError,
"Cannot set localization. Expected a string for 'lang' but received a number",
);
// @ts-expect-error
expect(() => pass.localize(true)).toThrowError(
TypeError,
"Cannot set localization. Expected a string for 'lang' but received a boolean",
);
// @ts-expect-error
expect(() => pass.localize({})).toThrowError(
TypeError,
"Cannot set localization. Expected a string for 'lang' but received a object",
);
});
it("should create a new language record inside class props", () => {
pass.localize("en");
expect(pass[localizationSymbol]["en"]).toEqual({});
});
it("should accept later translations and merge them with existing ones", () => {
pass.localize("it", {
say_hi: "ciao",
say_gb: "arrivederci",
});
pass.localize("it", {
say_good_morning: "buongiorno",
say_good_evening: "buonasera",
});
expect(pass[localizationSymbol]["it"]).toEqual({
say_hi: "ciao",
say_gb: "arrivederci",
say_good_morning: "buongiorno",
say_good_evening: "buonasera",
});
});
it("should delete a language and its all translations when null is passed as parameter", () => {
pass.localize("it", null);
pass.localize("en", null);
expect(pass[localizationSymbol]["it"]).toBeUndefined();
expect(pass[localizationSymbol]["en"]).toBeUndefined();
});
it("should always return undefined", () => {
expect(pass.localize("it", undefined)).toBeUndefined();
expect(pass.localize("it", null)).toBeUndefined();
expect(pass.localize("it", {})).toBeUndefined();
});
});
});