@astratra/wallet 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -0
- package/package.json +1 -1
- package/src/apple.js +5 -1
- package/src/google.js +20 -1
- package/src/index.d.ts +6 -0
- package/src/registrations.js +15 -0
package/README.md
CHANGED
|
@@ -21,6 +21,8 @@ le contenu vient de toi.
|
|
|
21
21
|
(400, 410) sont oubliés.
|
|
22
22
|
- **Google** : classe et carte créées au premier envoi puis mises à jour, lien
|
|
23
23
|
« Ajouter à Google Wallet » signé (JWT RS256).
|
|
24
|
+
- **Le retrait** : carte Apple annulée (grisée), carte Google inactive,
|
|
25
|
+
appareils oubliés.
|
|
24
26
|
- **La saisie des clés** : contrôles avant enregistrement (clé qui correspond au
|
|
25
27
|
certificat, certificat non expiré, vrai compte de service Google), et un
|
|
26
28
|
transport hexadécimal pour qu'un PEM traverse un pare-feu applicatif qui
|
|
@@ -97,6 +99,32 @@ Une image référencée par Google doit être **publique** : Google la télécha
|
|
|
97
99
|
depuis ses serveurs. Change son URL quand son contenu change, c'est ce qui force
|
|
98
100
|
Google à la rafraîchir.
|
|
99
101
|
|
|
102
|
+
## Retirer une carte
|
|
103
|
+
|
|
104
|
+
Une carte ajoutée à un téléphone n'en sort que par la main de son porteur :
|
|
105
|
+
ni Apple ni Google ne laissent l'émetteur l'effacer. Ce qu'on peut faire
|
|
106
|
+
quand une carte est supprimée chez toi :
|
|
107
|
+
|
|
108
|
+
```js
|
|
109
|
+
// Apple : la carte se grise et se déclare inutilisable.
|
|
110
|
+
passes.build({ ...contenu, voided: true });
|
|
111
|
+
// puis préviens les appareils, qui viennent chercher cette version :
|
|
112
|
+
await notifyApplePass({ registrations, passTypeIdentifier, serialNumber, certificate, privateKey });
|
|
113
|
+
|
|
114
|
+
// Google : la carte passe inactive, rangée avec les cartes passées.
|
|
115
|
+
await google.deactivateObject(google.objectId('C-000142')); // false si personne ne l'avait ajoutée
|
|
116
|
+
|
|
117
|
+
// Plus rien à envoyer à ses appareils :
|
|
118
|
+
await registrations.forgetPass(passTypeIdentifier, 'C-000142');
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**L'ordre compte pour Apple.** Pour récupérer la version annulée, l'appareil
|
|
122
|
+
demande d'abord quelles cartes ont changé (il faut encore son inscription),
|
|
123
|
+
puis la carte elle-même (il faut encore `findPass` et `buildPass`). Garde donc
|
|
124
|
+
de quoi servir la carte annulée — son numéro, son jeton, `voided: true` — et
|
|
125
|
+
n'appelle `forgetPass` qu'une fois qu'il n'y a plus rien à lui dire. L'appareil
|
|
126
|
+
se désinscrit tout seul quand le porteur supprime la carte.
|
|
127
|
+
|
|
100
128
|
## Saisir les clés depuis l'interface
|
|
101
129
|
|
|
102
130
|
```js
|
|
@@ -124,3 +152,13 @@ redémarrage.
|
|
|
124
152
|
- **Badges** : dans un e-mail ou une page, utilise les badges officiels
|
|
125
153
|
(« Ajouter à l'app Cartes Apple », « Ajouter au Google Wallet »), téléchargés
|
|
126
154
|
depuis les kits de marque d'Apple et de Google.
|
|
155
|
+
- **Fixe `joi` dans ton projet** : `passkit-generator` 3.6.1 (dernière version)
|
|
156
|
+
épingle `joi` 17.13.4, touché par trois failles (pollution de prototype,
|
|
157
|
+
expression régulière quadratique dans `isoDate()`, qui sert aux dates des
|
|
158
|
+
champs de carte). npm n'applique que les `overrides` du projet racine, pas
|
|
159
|
+
ceux d'un paquet installé : ajoute-les dans le `package.json` de ton
|
|
160
|
+
application.
|
|
161
|
+
|
|
162
|
+
```json
|
|
163
|
+
{ "overrides": { "passkit-generator": { "joi": "17.13.8" } } }
|
|
164
|
+
```
|
package/package.json
CHANGED
package/src/apple.js
CHANGED
|
@@ -41,6 +41,9 @@ function createApplePasses({
|
|
|
41
41
|
* @param {Array<object>} [card.headerFields] … et primaryFields, secondaryFields, auxiliaryFields, backFields
|
|
42
42
|
* @param {{message: string, altText?: string, format?: string}} [card.barcode]
|
|
43
43
|
* @param {Record<string, Buffer>} [card.images] images propres à cette carte (strip.png…), prioritaires.
|
|
44
|
+
* @param {boolean} [card.voided] carte annulée : Apple Wallet la grise et la
|
|
45
|
+
* déclare inutilisable. C'est la seule façon, côté émetteur, de
|
|
46
|
+
* retirer une carte déjà ajoutée : seul son porteur peut l'effacer.
|
|
44
47
|
* @returns {Buffer} le .pkpass
|
|
45
48
|
*/
|
|
46
49
|
function build(card) {
|
|
@@ -57,7 +60,8 @@ function createApplePasses({
|
|
|
57
60
|
...(logoText ? { logoText } : {}),
|
|
58
61
|
...colors,
|
|
59
62
|
webServiceURL,
|
|
60
|
-
authenticationToken: card.authenticationToken
|
|
63
|
+
authenticationToken: card.authenticationToken,
|
|
64
|
+
...(card.voided ? { voided: true } : {})
|
|
61
65
|
}
|
|
62
66
|
);
|
|
63
67
|
pass.type = type;
|
package/src/google.js
CHANGED
|
@@ -89,13 +89,32 @@ function createGoogleWallet({ issuerId, credentials, kind = 'loyalty', request }
|
|
|
89
89
|
return upsert('Object', object);
|
|
90
90
|
}
|
|
91
91
|
|
|
92
|
+
/**
|
|
93
|
+
* Carte retirée par l'émetteur : Google l'affiche comme expirée et la
|
|
94
|
+
* range avec les cartes passées. Seul le champ `state` est envoyé, rien
|
|
95
|
+
* n'est recréé. Renvoie false si la carte n'a jamais été créée chez Google
|
|
96
|
+
* (personne ne l'avait ajoutée) : il n'y a alors rien à retirer.
|
|
97
|
+
* @param {string} id identifiant complet de la carte (voir objectId).
|
|
98
|
+
* @param {'INACTIVE'|'EXPIRED'} [state='INACTIVE']
|
|
99
|
+
*/
|
|
100
|
+
async function deactivateObject(id, state = 'INACTIVE') {
|
|
101
|
+
if (!['INACTIVE', 'EXPIRED'].includes(state)) throw new Error(`État de retrait inconnu : ${state}`);
|
|
102
|
+
try {
|
|
103
|
+
await requete({ method: 'PATCH', url: url('Object', id), data: { state } });
|
|
104
|
+
return true;
|
|
105
|
+
} catch (error) {
|
|
106
|
+
if (error?.response?.status === 404) return false;
|
|
107
|
+
throw error;
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
|
|
92
111
|
/** Le lien « Ajouter à Google Wallet » pour des cartes déjà créées. */
|
|
93
112
|
function saveLink(objects, options) {
|
|
94
113
|
const refs = objects.map(({ id, classId }) => ({ id, classId }));
|
|
95
114
|
return `https://pay.google.com/gp/v/save/${signSaveJwt({ [type.jwtKey]: refs }, credentials, options)}`;
|
|
96
115
|
}
|
|
97
116
|
|
|
98
|
-
return { classId: idOf, objectId: idOf, ensureClass, upsertObject, saveLink };
|
|
117
|
+
return { classId: idOf, objectId: idOf, ensureClass, upsertObject, deactivateObject, saveLink };
|
|
99
118
|
}
|
|
100
119
|
|
|
101
120
|
module.exports = { createGoogleWallet, signSaveJwt };
|
package/src/index.d.ts
CHANGED
|
@@ -47,6 +47,8 @@ export interface PassContent {
|
|
|
47
47
|
backFields?: PassField[];
|
|
48
48
|
barcode?: { message: string; altText?: string; format?: string };
|
|
49
49
|
images?: Record<string, Buffer>;
|
|
50
|
+
/** Voided card: Apple Wallet greys it out. The only way for an issuer to retire a card already added. */
|
|
51
|
+
voided?: boolean;
|
|
50
52
|
}
|
|
51
53
|
|
|
52
54
|
export interface ApplePassesOptions {
|
|
@@ -96,6 +98,8 @@ export interface RegistrationStore {
|
|
|
96
98
|
listForDevice(deviceLibraryIdentifier: string, passTypeIdentifier: string): Promise<Registration[]>;
|
|
97
99
|
listForPass(passTypeIdentifier: string, serialNumber: string): Promise<Registration[]>;
|
|
98
100
|
forgetPushToken(pushToken: string): Promise<void>;
|
|
101
|
+
/** Deleted card: forget every device registered for it. Returns how many. */
|
|
102
|
+
forgetPass(passTypeIdentifier: string, serialNumber: string): Promise<number>;
|
|
99
103
|
}
|
|
100
104
|
|
|
101
105
|
export function notifyApplePass(options: Omit<ApnsOptions, 'passTypeIdentifier'> & {
|
|
@@ -122,6 +126,8 @@ export interface GoogleWallet {
|
|
|
122
126
|
objectId(suffix: string): string;
|
|
123
127
|
ensureClass(definition: { id: string; [key: string]: unknown }): Promise<string>;
|
|
124
128
|
upsertObject(object: { id: string; classId: string; [key: string]: unknown }): Promise<string>;
|
|
129
|
+
/** Retire a card: only `state` is sent. False when Google never had it (404). */
|
|
130
|
+
deactivateObject(id: string, state?: 'INACTIVE' | 'EXPIRED'): Promise<boolean>;
|
|
125
131
|
saveLink(objects: Array<{ id: string; classId: string }>, options?: { now?: Date; origins?: string[] }): string;
|
|
126
132
|
}
|
|
127
133
|
|
package/src/registrations.js
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
* listForDevice(deviceLibraryIdentifier, passTypeIdentifier) → inscriptions
|
|
9
9
|
* listForPass(passTypeIdentifier, serialNumber) → inscriptions
|
|
10
10
|
* forgetPushToken(pushToken) → jeton mort, oublié partout
|
|
11
|
+
* forgetPass(passTypeIdentifier, serialNumber) → carte supprimée, nombre d'appareils oubliés
|
|
11
12
|
*/
|
|
12
13
|
|
|
13
14
|
const memeInscription = (a, b) => a.deviceLibraryIdentifier === b.deviceLibraryIdentifier
|
|
@@ -43,6 +44,16 @@ function createMemoryRegistrationStore() {
|
|
|
43
44
|
for (let index = rows.length - 1; index >= 0; index -= 1) {
|
|
44
45
|
if (rows[index].pushToken === pushToken) rows.splice(index, 1);
|
|
45
46
|
}
|
|
47
|
+
},
|
|
48
|
+
async forgetPass(passTypeIdentifier, serialNumber) {
|
|
49
|
+
let oublies = 0;
|
|
50
|
+
for (let index = rows.length - 1; index >= 0; index -= 1) {
|
|
51
|
+
if (rows[index].passTypeIdentifier === passTypeIdentifier && rows[index].serialNumber === serialNumber) {
|
|
52
|
+
rows.splice(index, 1);
|
|
53
|
+
oublies += 1;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
return oublies;
|
|
46
57
|
}
|
|
47
58
|
};
|
|
48
59
|
}
|
|
@@ -91,6 +102,10 @@ function createMongooseRegistrationStore(connection, collection = 'apple_wallet_
|
|
|
91
102
|
},
|
|
92
103
|
async forgetPushToken(pushToken) {
|
|
93
104
|
await Registration.deleteMany({ pushToken });
|
|
105
|
+
},
|
|
106
|
+
async forgetPass(passTypeIdentifier, serialNumber) {
|
|
107
|
+
const resultat = await Registration.deleteMany({ passTypeIdentifier, serialNumber });
|
|
108
|
+
return resultat.deletedCount;
|
|
94
109
|
}
|
|
95
110
|
};
|
|
96
111
|
}
|