@depup/stripe 21.0.0-depup.0

package/types/test/tsconfig.json

@@ -0,0 +1,67 @@
+{
+  "files": ["./typescriptTest.ts"],
+  "compilerOptions": {
+    /* Basic Options */
+    "incremental": false /* Enable incremental compilation */,
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "lib": ["esnext"],
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    "rootDir": "./" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    "noEmit": true /* Do not emit outputs. */,
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": true /* Enable strict null checks. */,
+    "strictFunctionTypes": true /* Enable strict checking of function types. */,
+    "strictBindCallApply": true /* Enable strict 'bind', 'call', and 'apply' methods on functions. */,
+    "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
+    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
+    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    // "esModuleInterop": true                /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  }
+}

package/types/test/typescriptTest.ts

@@ -0,0 +1,357 @@
+/**
+ * This file does not exist to be executed, just compiled,
+ * so that we can ensure that the definition files
+ * only reference names that exist,
+ * and to perform a basic sanity check that types are exported as intended.
+ */
+
+///<reference types=".." />
+import Stripe from 'stripe';
+
+import {ApiVersion} from '../apiVersion';
+
+let stripe = new Stripe('sk_test_123', {
+  apiVersion: ApiVersion,
+});
+
+stripe = new Stripe('sk_test_123');
+
+stripe = new Stripe('sk_test_123', {
+  // @ts-ignore ignore specific apiVersion.
+  apiVersion: '2019-11-05',
+});
+
+stripe = new Stripe('sk_test_123', {
+  // @ts-ignore ignore default apiVersion.
+  apiVersion: null,
+});
+
+// Check config object.
+stripe = new Stripe('sk_test_123', {
+  apiVersion: ApiVersion,
+  typescript: true,
+  maxNetworkRetries: 1,
+  timeout: 1000,
+  host: 'api.example.com',
+  stripeContext: new Stripe.StripeContext(['acct_123']),
+  port: 123,
+  telemetry: true,
+  httpClient: Stripe.createNodeHttpClient(),
+  appInfo: {
+    name: 'my-wordpress-plugin',
+  },
+});
+
+(async (): Promise<void> => {
+  const params: Stripe.CustomerCreateParams = {
+    description: 'test',
+  };
+  const opts: Stripe.RequestOptions = {
+    apiVersion: ApiVersion,
+  };
+  const customer: Stripe.Customer = await stripe.customers.create(params, opts);
+
+  const address: Stripe.Address | null | undefined = customer.address;
+
+  if (!address) return;
+  const city: string | null = address.city;
+
+  // Check no opts:
+  await stripe.customers.create(params);
+
+  // Check multiple dispatch:
+  let product = await stripe.products.retrieve('prod_123', opts);
+  product = await stripe.products.retrieve('prod_123', {expand: []}, opts);
+
+  const charge: Stripe.Charge = await stripe.charges.retrieve('ch_123', {
+    expand: ['customer'],
+  });
+
+  // Ignore null case.
+  if (!charge.customer) throw Error('guard');
+
+  // Check you can cast an expandable field to the object:
+  const cusEmail: string | null = (charge.customer as Stripe.Customer).email;
+  // Check you can cast an expandable field to a string:
+  const btId: string = charge.balance_transaction as string;
+
+  // Check you can deal with deleted:
+  if (
+    typeof charge.customer !== 'string' &&
+    // Not sure why `!charge.customer.deleted` doesn't work, it seems to in a playground:
+    // https://www.typescriptlang.org/play/index.html#code/JYOwLgpgTgZghgYwgAgGIHt3IN4ChnJwBcyAzmFKAOYDc+yADpQgNYA2AnieZSLfXABGiFtwrVkAH2QgArmzZSZsgLaDodAmA4MIJAOQxM+zcgAmENhEhmA-CQBu6YGboBfXKEixEKACKW1hBmGFh4Wjp6yIbGphZWNiQUshDuuLjausgAsnAc6qHIALxomEoBCcGh6RYIbHBQKAjoIOTIAB4kufkQ1Z4wyAAUAITtAHTxQWYAlDj0za1ghGK8VMUdY3C4Hri19Y3IC21cpVjSFVOF0jwS0nIK6cADgxzIAGRvyJkQ6AOvw0USvobnx9O9PsMOBNAjZZuFDi02sQyOI+OsoVsPEA
+    // Might be a complexity limit with our resources: https://github.com/microsoft/TypeScript/pull/30779/files#diff-c3ed224e4daa84352f7f1abcd23e8ccaR13219
+    !('deleted' in charge.customer)
+  ) {
+    const created: number = charge.customer.created;
+  }
+  const r = Math.random() - 0.5;
+  // Okay, this is how I hope people can deal with deleted:
+  const maybeCoupon: Stripe.Coupon | Stripe.DeletedCoupon = await (r
+    ? stripe.coupons.retrieve('25_off')
+    : stripe.coupons.del('25_off'));
+  if (maybeCoupon.deleted) {
+    const d: true = maybeCoupon.deleted;
+  } else {
+    // Here, TS knows it's a full Coupon.
+    const created: number = maybeCoupon.created;
+  }
+
+  for await (const customer of stripe.customers.list()) {
+    const {id} = customer as Stripe.Customer;
+    if (id === 'hi') {
+      break;
+    }
+  }
+
+  const cusList: Stripe.ApiList<Stripe.Customer> = await stripe.customers.list();
+
+  const aThousandCustomers: Array<Stripe.Customer> = await stripe.customers
+    .list()
+    .autoPagingToArray({limit: 1000});
+
+  const nothing: void = await stripe.customers
+    .list()
+    .autoPagingEach((customer: Stripe.Customer) => {
+      if (customer.id === 'one') {
+        return false;
+      }
+      if (customer.id === 'two') {
+        return Promise.resolve(false);
+      }
+      if (customer.id === 'three') {
+        return Promise.resolve();
+      }
+      return undefined;
+    });
+
+  // @ts-expect-error
+  (await stripe.invoices.retrieveUpcoming()).id;
+  (await stripe.invoices.retrieve('')).id;
+
+  try {
+    await stripe.paymentIntents.create({amount: 100, currency: 'USD'});
+  } catch (err) {
+    if (err instanceof stripe.errors.StripeCardError) {
+      const declineCode: string = err.decline_code;
+    }
+    if (err instanceof Stripe.errors.StripeCardError) {
+      const declineCode: string = err.decline_code;
+    }
+  }
+
+  {
+    const custs = await stripe.customers.list();
+    const lr = custs.lastResponse;
+    const requestId: string = lr.requestId;
+    const statusCode: number = lr.statusCode;
+    const apiVersion: string | undefined = lr.apiVersion;
+    const idempotencyKey: string | undefined = lr.idempotencyKey;
+    const headers = lr.headers;
+    const header: string | undefined = headers['request-id'];
+  }
+
+  {
+    const cust = await stripe.customers.retrieve('foo');
+    const lr = cust.lastResponse;
+    const requestId: string = lr.requestId;
+    const statusCode: number = lr.statusCode;
+    const apiVersion: string | undefined = lr.apiVersion;
+    const idempotencyKey: string | undefined = lr.idempotencyKey;
+    const headers = lr.headers;
+    const header: string | undefined = lr.headers['request-id'];
+  }
+  {
+    const acct = await stripe.accounts.createExternalAccount('foo', {
+      ['external_account']: 'foo',
+    });
+    if (acct.object === 'card') {
+      const rid: string = acct.lastResponse.requestId;
+    }
+  }
+})();
+
+const Foo = Stripe.StripeResource.extend({
+  foo: Stripe.StripeResource.method({
+    method: 'create',
+    path: 'foo',
+  }),
+  fooFullPath: Stripe.StripeResource.method({
+    method: 'create',
+    fullPath: '/v1/full/path',
+  }),
+  search: Stripe.StripeResource.method({
+    method: 'create',
+    fullPath: 'foo',
+    methodType: 'search',
+  }),
+  customer: Stripe.StripeResource.method<Stripe.Customer>({method: 'POST'}),
+});
+const fooClient = new Foo(stripe);
+const searchResponse: Stripe.Response<object> = fooClient.search();
+const customerResponse: Stripe.Response<Stripe.Customer> = fooClient.customer();
+
+const maxBufferedRequestMetrics: number =
+  Stripe.StripeResource.MAX_BUFFERED_REQUEST_METRICS;
+
+// Test NodeHttpClient request processing.
+import {Agent} from 'http';
+async (): Promise<void> => {
+  const client = Stripe.createNodeHttpClient(new Agent());
+
+  const response = await client.makeRequest(
+    'api.stripe.com',
+    '443',
+    '/test',
+    'POST',
+    {
+      'Stripe-Account': 'account',
+      'Content-Length': 123,
+    },
+    'requestdata',
+    'https',
+    80000
+  );
+
+  const stream: Stripe.StripeStreamResponse = response.toStream(() => {
+    return;
+  });
+  stream.setEncoding('utf8');
+
+  const jsonResponse: object = await response.toJSON();
+};
+
+// Test FetchHttpClient request processing.
+async (): Promise<void> => {
+  const client = Stripe.createFetchHttpClient();
+
+  const response = await client.makeRequest(
+    'api.stripe.com',
+    '443',
+    '/test',
+    'POST',
+    {
+      'Stripe-Account': 'account',
+      'Content-Length': 123,
+    },
+    'requestdata',
+    'https',
+    80000
+  );
+
+  const stream = response.toStream(() => {
+    return;
+  });
+
+  const results = await stream.getReader().read();
+
+  const jsonResponse: object = await response.toJSON();
+};
+
+// Tests asynchronous webhook processing.
+async (): Promise<void> => {
+  const cryptoProvider = Stripe.createSubtleCryptoProvider();
+
+  const event = await stripe.webhooks.constructEventAsync(
+    'body',
+    'signature',
+    'secret',
+    undefined,
+    cryptoProvider
+  );
+
+  if (event.type == 'customer.created') {
+    const customer: Stripe.Customer = event.data.object;
+    const previous_attributes = event.data.previous_attributes;
+  }
+
+  // @ts-expect-error unknown type
+  if (event.type == 'customer.created2') {
+    // @ts-expect-error unknown type doesn't have a typed object
+    const customer: Stripe.Customer = event.data.object;
+  }
+
+  const event2 = await stripe.events.retrieve(event.id);
+};
+
+// Can reference error types
+let rawError: Stripe.StripeRawError;
+
+let newError: Stripe.errors.StripeError;
+
+const instanceofCheck1 = {} instanceof Stripe.errors.StripeError;
+const instanceofCheck2 = {} instanceof Stripe.errors.StripeAPIError;
+const instanceofCheck5 = {} instanceof stripe.errors.StripeError;
+const instanceofCheck6 = {} instanceof stripe.errors.StripeAPIError;
+
+Stripe.errors.generate({
+  type: 'card_error',
+});
+stripe.errors.generate({
+  type: 'card_error',
+});
+Stripe.errors.StripeError.generate({
+  type: 'card_error',
+});
+
+stripe.accounts.retrieve('123', {
+  host: 'my_host',
+});
+stripe.files.create({
+  purpose: 'dispute_evidence',
+  file: {
+    data: Buffer.from('File'),
+    name: 'minimal.pdf',
+    type: 'application/octet-stream',
+  },
+  file_link_data: {create: true},
+});
+
+const v1Event = {} as Stripe.AccountApplicationAuthorizedEvent;
+// v1 event context is a string
+const v1Context: string | undefined = v1Event.context;
+
+const v2Event = {} as Stripe.Events.V1BillingMeterErrorReportTriggeredEvent;
+// v2 is also a string
+const v2Context: string | undefined = v2Event.context;
+
+// but event notification is a context object
+const v2EventNotif = {} as Stripe.Events.V1BillingMeterErrorReportTriggeredEventNotification;
+const v2ContextObj: Stripe.StripeContext | undefined = v2EventNotif.context;
+
+async (): Promise<void> => {
+  // parsing event notifications
+  const eventNotification = stripe.parseEventNotification('', '', '');
+
+  if (eventNotification.type === 'v1.billing.meter.error_report_triggered') {
+    eventNotification.related_object;
+    const m: Stripe.Billing.Meter = await eventNotification.fetchRelatedObject();
+    const e: Stripe.Events.V1BillingMeterErrorReportTriggeredEvent = await eventNotification.fetchEvent();
+    const d: Stripe.Events.V1BillingMeterErrorReportTriggeredEvent.Data =
+      e.data;
+  } else if (eventNotification.type === 'v1.billing.meter.no_meter_found') {
+    // @ts-expect-error - shouldn't be available
+    eventNotification.related_object;
+    const e: Stripe.Events.V1BillingMeterNoMeterFoundEvent = await eventNotification.fetchEvent();
+    // @ts-expect-error - isn't a known type
+  } else if (eventNotification.type === 'some.unknown.event') {
+    const e = eventNotification as Stripe.Events.UnknownEventNotification;
+    e.fetchEvent();
+    // these exist, but may be null
+    e.related_object;
+    e.fetchRelatedObject();
+  }
+};
+
+{
+  // v1 event resource
+  let a: Stripe.EventBase;
+  // v2 event resource
+  let b: Stripe.V2.Core.EventBase;
+  let c: Stripe.V2.Core.EventNotification;
+  let d: Stripe.Events.UnknownEventNotification;
+  let e: Stripe.Events.V1BillingMeterErrorReportTriggeredEvent;
+  let f: Stripe.Events.V1BillingMeterErrorReportTriggeredEventNotification;
+  // union of all V2 Events
+  let g: Stripe.V2.Core.Event;
+}