Add generateTestHeaderStringAsync function to Webhooks.ts

src/Webhooks.ts

@@ -65,6 +65,9 @@
  receivedAt: number
  ) => Promise<WebhookEvent>;
  generateTestHeaderString: (opts: WebhookTestHeaderOptions) => string;
+ generateTestHeaderStringAsync: (
+ opts: WebhookTestHeaderOptions
+ ) => Promise<string>;
 };
 
 export function createWebhooks(
@@ -166,6 +169,35 @@
  opts.scheme + '=' + opts.signature,
  ].join(',');
 
+ return generatedHeader;
+ },
+ generateTestHeaderStringAsync: async function(
+ opts: WebhookTestHeaderOptions
+ ): Promise<string> {
+ if (!opts) {
+ throw new StripeError({
+ message: 'Options are required',
+ });
+ }
+
+ opts.timestamp =
+ Math.floor(opts.timestamp) || Math.floor(Date.now() / 1000);
+ opts.scheme = opts.scheme || signature.EXPECTED_SCHEME;
+
+ opts.cryptoProvider = opts.cryptoProvider || getCryptoProvider();
+
+ opts.signature =
+ opts.signature ||
+ (await opts.cryptoProvider.computeHMACSignatureAsync(
+ opts.timestamp + '.' + opts.payload,
+ opts.secret
+ ));
+
+ const generatedHeader = [
+ 't=' + opts.timestamp,
+ opts.scheme + '=' + opts.signature,
+ ].join(',');
+
  return generatedHeader;
  },
  };
@@ -440,7 +472,7 @@
  if (!webhooksCryptoProviderInstance) {
  webhooksCryptoProviderInstance = platformFunctions.createDefaultCryptoProvider();
  }
  return webhooksCryptoProviderInstance!;
  }
 
  Webhook.signature = signature;

test/Webhook.spec.ts

@@ -41,6 +41,30 @@ function createWebhooksTestSuite(stripe) {
  });
  });
 
+ describe('.generateTestHeaderStringAsync', () => {
+ it('should throw when no opts are passed', async () => {
+ await expect(
+ stripe.webhooks.generateTestHeaderStringAsync()
+ ).to.be.rejectedWith('Options are required');
+ });
+
+ it('should correctly construct a webhook header', async () => {
+ const header = await stripe.webhooks.generateTestHeaderStringAsync({
+ payload: EVENT_PAYLOAD_STRING,
+ secret: SECRET,
+ });
+
+ expect(header).to.not.be.undefined;
+ expect(header.split(',')).to.have.lengthOf(2);
+ expect(header).to.equal(
+ stripe.webhooks.generateTestHeaderString({
+ payload: EVENT_PAYLOAD_STRING,
+ secret: SECRET,
+ })
+ );
+ });
+ });
+
  const makeConstructEventTests = (
  constructEventFn: typeof stripe.webhooks.construct
  ) => {