marcogll/passkit-generator
1
0
Fork 0
mirror of https://github.com/marcogll/passkit-generator.git synced 2026-03-15 22:25:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added new couple of setter/getter for pass type, that resets the current fields to prevent old data to remain

Browse Source
This commit is contained in:
Alexander Cerutti
2021-09-29 23:45:12 +02:00
parent e151afa0ed
commit b0b0a9555f
2 changed files with 64 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
src/PKPass.ts
View File

@@ -17,6 +17,7 @@ const fieldKeysPoolSymbol = Symbol("fieldKeysPoolSymbol");
const importMetadataSymbol = Symbol("import.pass.metadata"); const importMetadataSymbol = Symbol("import.pass.metadata");
const createManifestSymbol = Symbol("pass.manifest"); const createManifestSymbol = Symbol("pass.manifest");
const closePassSymbol = Symbol("pass.close"); const closePassSymbol = Symbol("pass.close");
const passTypeSymbol = Symbol("pass.type");
interface NamedBuffers { interface NamedBuffers {
[key: string]: Buffer; [key: string]: Buffer;
@@ -264,6 +265,47 @@ export default class PKPass extends Bundle {
return this[propsSymbol][this.type].backFields; return this[propsSymbol][this.type].backFields;
} }
/**
* Allows setting a pass type.
*
* **Warning**: setting a type with this setter,
* will reset all the imported or manually
* setted fields (primaryFields, secondaryFields,
* headerFields, auxiliaryFields, backFields)
*/
public set type(type: Schemas.PassTypesProps) {
if (!Schemas.isValid(type, Schemas.PassType)) {
throw new TypeError(
`Invalid type. Expected one of 'boardingPass' | 'coupon' | 'storeCard' | 'eventTicket' | 'generic' but received '${type}'`,
);
}
if (this.type) {
/**
* Removing reference to previous type and its content because
* we might have some differences between types. It is way easier
* to reset everything instead of making checks.
*/
this[propsSymbol][this.type] = undefined;
}
this[passTypeSymbol] = type;
this[propsSymbol][this[passTypeSymbol]] = {
headerFields /******/: new FieldsArray(this[fieldKeysPoolSymbol]),
primaryFields /*****/: new FieldsArray(this[fieldKeysPoolSymbol]),
secondaryFields /***/: new FieldsArray(this[fieldKeysPoolSymbol]),
auxiliaryFields /***/: new FieldsArray(this[fieldKeysPoolSymbol]),
backFields /********/: new FieldsArray(this[fieldKeysPoolSymbol]),
transitType: undefined,
};
}
public get type(): Schemas.PassTypesProps | undefined {
return this[passTypeSymbol] ?? undefined;
}
// **************************** // // **************************** //
// *** ASSETS SETUP METHODS *** // // *** ASSETS SETUP METHODS *** //
// **************************** // // **************************** //
@@ -365,39 +407,27 @@ export default class PKPass extends Bundle {
"generic", "generic",
] as Schemas.PassTypesProps[]; ] as Schemas.PassTypesProps[];
this.type = possibleTypes.find((type) => Boolean(data[type])); const type = possibleTypes.find((type) => Boolean(data[type]));
if (!this.type) { if (!type) {
/** if (!this[passTypeSymbol]) {
* @TODO improve message console.warn(
*/ "Cannot find a valid type in pass.json. You won't be able to set fields until you won't set explicitly one.",
);
throw new Error("Cannot find a valid type in this pass.json"); } else {
console.warn(
"Cannot find a new valid type in pass.json. Fields have not been resetted.",
);
} }
} else {
this.type = type;
this[propsSymbol][this.type] = { this.headerFields.push(...data[type]?.headerFields);
primaryFields /*****/: new FieldsArray( this.primaryFields.push(...data[type]?.primaryFields);
this[fieldKeysPoolSymbol], this.secondaryFields.push(...data[type]?.secondaryFields);
...data[this.type]?.primaryFields, this.auxiliaryFields.push(...data[type]?.auxiliaryFields);
), this.backFields.push(...data[type]?.backFields);
secondaryFields /***/: new FieldsArray( }
this[fieldKeysPoolSymbol],
...data[this.type]?.secondaryFields,
),
auxiliaryFields /***/: new FieldsArray(
this[fieldKeysPoolSymbol],
...data[this.type]?.auxiliaryFields,
),
headerFields /******/: new FieldsArray(
this[fieldKeysPoolSymbol],
...data[this.type]?.headerFields,
),
backFields /********/: new FieldsArray(
this[fieldKeysPoolSymbol],
...data[this.type]?.backFields,
),
transitType: this.transitType /** Setter + Getter */,
};
} }
private [createManifestSymbol]() { private [createManifestSymbol]() {

4
src/schemas/index.ts
View File

@@ -153,6 +153,10 @@ export const PassKindsProps = Joi.object<PassKindsProps>({
), ),
}); });
export const PassType = Joi.string().regex(
/(boardingPass|coupon|eventTicket|storeCard|generic)/,
);
export const OverridablePassProps = Joi.object<OverridablePassProps>({ export const OverridablePassProps = Joi.object<OverridablePassProps>({
semantics: Semantics, semantics: Semantics,
voided: Joi.boolean(), voided: Joi.boolean(),