Load model via JSON String / direct input

[xL0b0]

Hello, is it possible to load a model and all the required properties into the pass payload, instead of through the „model“ parameter which reads a file, directly through an input into the generation payload?

[alexandercerutti]

Hi @xL0b0, thanks for using passkit-generator!

PKPass constructor accepts a list of file-buffer, as you can see in both examples and documentation.

passkit-generator/examples/cloudflare-worker/src/index.ts

Lines 44 to 67 in bab4117

	const pass = new PKPass(
	{
	"icon.png": Buffer.from(icon),
	"icon@2x.png": Buffer.from(icon2x),
	"footer.png": Buffer.from(footer),
	"footer@2x.png": Buffer.from(footer2x),
	"background@2x.png": Buffer.from(background2x),
	},
	{
	signerCert: env.SIGNER_CERT,
	signerKey: env.SIGNER_KEY,
	signerKeyPassphrase: env.SIGNER_PASSPHRASE,
	wwdr: env.WWDR,
	},
	{
	description: "Example Pass generated through a cloudflare worker",
	serialNumber: "81592CQ7838",
	passTypeIdentifier: "pass.com.passkitgenerator",
	teamIdentifier: "F53WB8AE67",
	organizationName: "Apple Inc.",
	foregroundColor: "rgb(255, 255, 255)",
	backgroundColor: "rgb(60, 65, 76)",
	},
	);

If you don't mean this, do you mind clarify further what you mean?

Let me know!

[xL0b0]

That's kinda what I wanted to do, this was my approach:

    createPass({ parsedPass, index }) {
        return new Promise(async (resolve, reject) => {
            try {
                const pass = await PKPass.from({
                    model: parsedPass, // Pass the parsed JSON object directly, not as a string
                    certificates: {
                        wwdr: fs.readFileSync(`${this.documentPath}/Passkit/Certificates/wwdr.pem`),
                        signerCert: fs.readFileSync(`${this.documentPath}/Passkit/Certificates/signerCert.pem`),
                        signerKey: fs.readFileSync(`${this.documentPath}/Passkit/Certificates/signerKey.pem`),
                        signerKeyPassphrase: this.signerKeyPassphrase
                    }
                });

                const passBuffer = await pass.getAsBuffer();

                fs.writeFileSync(`./Passes/finished-${index}.pkpass`, passBuffer);

So I have a function that gets the completely parsed pass already from another function that fills in all the values into the JSON and then this function just writes the pass. So not reading them from a file, but passing it into the function dynamically.

[alexandercerutti]

Yeah, this way (you can find it as "buffer model" in the readme) was made on purpose for different modes, so that awaiting is not required.

Passing pass.json as a file in the buffer model, is a valid way to achieve things.

Furthermore, model accepts only a string, not an object, so I guess it was failing.

[alexandercerutti]

P.s. getAsBuffer is not async, it does not return a promise, so using await does not bring any plus to you.

[alexandercerutti]

P.s.2: if you could leave a ⭐ on the project, that would be awesome! 🚀

[xL0b0]

Tyvm, I will shortly give this a try and leave a star!

So in my case, I want to make an eventTicket, would that object also simply go into here then:

const pass = new PKPass( 
 	{ 
 		"icon.png": Buffer.from(icon), 
 		"icon@2x.png": Buffer.from(icon2x), 
 		"footer.png": Buffer.from(footer), 
 		"footer@2x.png": Buffer.from(footer2x), 
 		"background@2x.png": Buffer.from(background2x), 
 	}, 
 	{ 
 		signerCert: env.SIGNER_CERT, 
 		signerKey: env.SIGNER_KEY, 
 		signerKeyPassphrase: env.SIGNER_PASSPHRASE, 
 		wwdr: env.WWDR, 
 	}, 
 	{ 
 		description: "Example Pass generated through a cloudflare worker", 
 		serialNumber: "81592CQ7838", 
 		passTypeIdentifier: "pass.com.passkitgenerator", 
 		teamIdentifier: "F53WB8AE67", 
 		organizationName: "Apple Inc.", 
 		foregroundColor: "rgb(255, 255, 255)", 
 		backgroundColor: "rgb(60, 65, 76)", 
eventTicket: { all the value here?}
 	}, 
 );

[alexandercerutti]

It is mostly correct.

However, eventTicket in this case is that PKPass considers a type, so you either set it with the correct setter or you import it through your pass.json along with icon.png and the other files.

[xL0b0]

And right now I also have in my pass.json all my images as reference, in the images key

"images": {
                        "icon@2x.png": `./images/icon@2x.png`,
                        "logo@2x.png": `./images/logo@2x.png`,
                        "strip@2x.png": `./images/strip@2x.png`
                    },

Shall I leave this in still, but buffer all images too, like you did in your code example?

[alexandercerutti]

I suggest you to not call it pass.json, as pass.json is a specific file name in passes, with a specific format. What you are showing me here, instead, is something you did and not a standard format from Apple. So I suggest you renaming it in a different way, so you avoid confusion.

but buffer all images too, like you did in your code example?

I don't understand what you are asking

[xL0b0]

I just want to set all variables for my event ticket pass via the arguments in the constructor of PKPass without using a pass.json file 😅

[alexandercerutti]

You can't. Different fields have different requirements in terms of validation.
What refrains you from using the setters methods and properties?

[alexandercerutti]

And, by the way, you can create your pass.json dynamically before calling the new PKPass and pass to it as a buffer instead as an object

[alexandercerutti]

Something like

const passJson: PassProps = {
    // ... all your data in a valid format
};

const pkpassInstance = new PKPass({
    "pass.json": Buffer.from(JSON.stringify(passJson)),
    "icon.png": ...
}, {
    ...certificatesAndKeys
}, {
    ...otherDynamicProps
});

[xL0b0]

I just don't understand really what to now write into the otherDynamicProps since I got the entire data for the pass already in pass.json that I'm referencing in the first part of the arguments? Can you help me on that please?

[alexandercerutti]

Oh you can omit them if you have everything static. I mean, that object is meant for overriding some properties.

Still, I don't understand why you want to create you pass.json instead of using otherDynamicProps and setters/getters

[xL0b0]

Okay, my point is just simply here that I want to create a new Pass and instead of having to create files locally, like pass.json I just want to pass in my pass that I update with dynamic values, into the arguments of new PKPass, so I can then create a pass.

[xL0b0]

Okay, I made it, finally understood the issue!

[alexandercerutti]

What was it exactly?