From e3f8c31b2a0faa3d2e17e409b08e5d503be026ac Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 18 Oct 2017 08:27:08 -0700 Subject: [PATCH] Rename stripe-node to stripe (#20644) * Rename stripe-node to stripe * Export class instead of function * Rename import --- types/{stripe-node => stripe}/index.d.ts | 145 ++++++++---------- .../stripe-tests.ts} | 52 +++---- types/{stripe-node => stripe}/tsconfig.json | 2 +- 3 files changed, 94 insertions(+), 105 deletions(-) rename types/{stripe-node => stripe}/index.d.ts (99%) rename types/{stripe-node/stripe-node-tests.ts => stripe/stripe-tests.ts} (95%) rename types/{stripe-node => stripe}/tsconfig.json (93%) diff --git a/types/stripe-node/index.d.ts b/types/stripe/index.d.ts similarity index 99% rename from types/stripe-node/index.d.ts rename to types/stripe/index.d.ts index daa91487f7..d67ee5d115 100644 --- a/types/stripe-node/index.d.ts +++ b/types/stripe/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for stripe-node 4.7 +// Type definitions for stripe 4.7 // Project: https://github.com/stripe/stripe-node/ // Definitions by: William Johnston // Peter Harris @@ -8,88 +8,79 @@ /// -declare module 'stripe' { - var out: StripeNode.StripeExport; - export = out; +declare class Stripe { + DEFAULT_HOST: string; + DEFAULT_PORT: string; + DEFAULT_BASE_PATH: string; + DEFAULT_API_VERSION: string; + DEFAULT_TIMEOUT: number; + PACKAGE_VERSION: string; + USER_AGENT: { + bindings_version: string; + lang: string; + lang_version: string; + platform: string; + publisher: string; + uname: string; + }; + USER_AGENT_SERIALIZED: string; + + resources: typeof Stripe.resources; + StripeResource: typeof Stripe.StripeResource; + + constructor(apiKey: string, version?: string); + + accounts: Stripe.resources.Accounts; + balance: Stripe.resources.Balance; + charges: Stripe.resources.Charges; + coupons: Stripe.resources.Coupons; + customers: Stripe.resources.Customers; + disputes: Stripe.resources.Disputes; + events: Stripe.resources.Events; + invoices: Stripe.resources.Invoices; + invoiceItems: Stripe.resources.InvoiceItems; + plans: Stripe.resources.Plans; + /** + * @deprecated + */ + recipientCards: Stripe.resources.RecipientCards; + /** + * @deprecated + */ + recipients: Stripe.resources.Recipients; + subscriptions: Stripe.resources.Subscriptions; + tokens: Stripe.resources.Tokens; + transfers: Stripe.resources.Transfers; + applicationFees: Stripe.resources.ApplicationFees; + fileUploads: Stripe.resources.FileUploads; + bitcoinReceivers: Stripe.resources.BitcoinReceivers; + refunds: Stripe.resources.Refunds; + countrySpecs: Stripe.resources.CountrySpecs; + orders: Stripe.resources.Orders; + products: Stripe.resources.Products; + skus: Stripe.resources.SKUs; + webhooks: Stripe.resources.WebHooks; + + setHost(host: string): void; + setHost(host: string, port: string|number): void; + setHost(host: string, port: string|number, protocol: string): void; + + setProtocol(protocol: string): void; + setPort(port: string|number): void; + setApiVersion(version?: string): void; + setApiKey(key?: string): void; + setTimeout(timeout?: number): void; + setHttpAgent(agent: string): void; + getConstant(c: string): any; + getClientUserAgent(response: (userAgent: string) => void): void; } +export = Stripe; -declare namespace StripeNode { - interface StripeExport extends StripeStatic { - new (apiKey: string, version?: string): Stripe; - (apiKey: string, version?: string): Stripe; - } - - interface StripeStatic { - DEFAULT_HOST: string; - DEFAULT_PORT: string; - DEFAULT_BASE_PATH: string; - DEFAULT_API_VERSION: string; - DEFAULT_TIMEOUT: number; - PACKAGE_VERSION: string; - USER_AGENT: { - bindings_version: string; - lang: string; - lang_version: string; - platform: string; - publisher: string; - uname: string; - }; - USER_AGENT_SERIALIZED: string; - - resources: typeof resources; - StripeResource: typeof StripeResource; - } - +declare namespace Stripe { // Helper type IBankAccount = bankAccounts.IBankAccount; type ICard = cards.ICard; - interface Stripe extends StripeStatic { - accounts: resources.Accounts; - balance: resources.Balance; - charges: resources.Charges; - coupons: resources.Coupons; - customers: resources.Customers; - disputes: resources.Disputes; - events: resources.Events; - invoices: resources.Invoices; - invoiceItems: resources.InvoiceItems; - plans: resources.Plans; - /** - * @deprecated - */ - recipientCards: resources.RecipientCards; - /** - * @deprecated - */ - recipients: resources.Recipients; - subscriptions: resources.Subscriptions; - tokens: resources.Tokens; - transfers: resources.Transfers; - applicationFees: resources.ApplicationFees; - fileUploads: resources.FileUploads; - bitcoinReceivers: resources.BitcoinReceivers; - refunds: resources.Refunds; - countrySpecs: resources.CountrySpecs; - orders: resources.Orders; - products: resources.Products; - skus: resources.SKUs; - webhooks: resources.WebHooks; - - setHost(host: string): void; - setHost(host: string, port: string|number): void; - setHost(host: string, port: string|number, protocol: string): void; - - setProtocol(protocol: string): void; - setPort(port: string|number): void; - setApiVersion(version?: string): void; - setApiKey(key?: string): void; - setTimeout(timeout?: number): void; - setHttpAgent(agent: string): void; - getConstant(c: string): any; - getClientUserAgent(response: (userAgent: string) => void): void; - } - namespace accounts { interface IAccount extends IResourceObject, IAccountShared { /** diff --git a/types/stripe-node/stripe-node-tests.ts b/types/stripe/stripe-tests.ts similarity index 95% rename from types/stripe-node/stripe-node-tests.ts rename to types/stripe/stripe-tests.ts index f8a3f5c353..c4b291a7ed 100644 --- a/types/stripe-node/stripe-node-tests.ts +++ b/types/stripe/stripe-tests.ts @@ -1,11 +1,9 @@ -import StripeNode = require('stripe'); +import Stripe = require('stripe'); -var stripeTor = new StripeNode("sk_test_BF573NobVn98OiIsPAv7A04K"); -var stripe = StripeNode("sk_test_BF573NobVn98OiIsPAv7A04K") +var stripe = new Stripe("sk_test_BF573NobVn98OiIsPAv7A04K") stripe.setApiVersion('2016-03-07'); - //#region Balance tests // ################################################################################## @@ -168,7 +166,7 @@ stripe.charges.updateRefund( "ch_15fvyXEe31JkLCeQOo0SwFk9", "re_15jzA4Ee31JkLCeQcxbTbjaL", { metadata: { key: "value" } }, - function (err: StripeNode.IStripeError, refund: StripeNode.refunds.IRefund) { + function (err: Stripe.IStripeError, refund: Stripe.refunds.IRefund) { // asynchronously called } @@ -315,13 +313,13 @@ stripe.customers.createSource( "cus_5rfJKDJkuxzh5Q", { source: "tok_15V2YhEe31JkLCeQy9iUgsJX" }, function (err, source) { - var card = source; - var bankAcc = source; + var card = source; + var bankAcc = source; } ); stripe.customers.createSource("cus_5rfJKDJkuxzh5Q", { source: "tok_15V2YhEe31JkLCeQy9iUgsJX" }).then(function (source) { - var card = source; - var bankAcc = source; + var card = source; + var bankAcc = source; }); stripe.customers.createSource( @@ -336,7 +334,7 @@ stripe.customers.createSource( }, function (err, card) { // asynchronously called - var obj: StripeNode.ICard = card; + var obj: Stripe.ICard = card; } ); stripe.customers.createSource( @@ -351,21 +349,21 @@ stripe.customers.createSource( }).then( function (card) { // asynchronously called - var obj: StripeNode.ICard = card; + var obj: Stripe.ICard = card; } ); stripe.customers.createSource( "cus_5rfJKDJkuxzh5Q", { source: "btok_8E264Lxsbyvj3E" }, - function (err: StripeNode.IStripeError, bankAcc: StripeNode.IBankAccount) { + function (err: Stripe.IStripeError, bankAcc: Stripe.IBankAccount) { // asynchronously called bankAcc.bank_name; } ); stripe.customers.createSource( "cus_5rfJKDJkuxzh5Q", - { source: "btok_8E264Lxsbyvj3E" }).then(function (bankAcc: StripeNode.IBankAccount) { + { source: "btok_8E264Lxsbyvj3E" }).then(function (bankAcc: Stripe.IBankAccount) { // asynchronously called bankAcc.bank_name; } @@ -376,14 +374,14 @@ stripe.customers.retrieveCard( "card_15fvyXEe31JkLCeQ9KMktP5S", function (err, card) { // asynchronously called - var obj: StripeNode.ICard = card; + var obj: Stripe.ICard = card; } ); stripe.customers.retrieveCard( "cus_5rfJKDJkuxzh5Q", "card_15fvyXEe31JkLCeQ9KMktP5S").then(function (card) { // asynchronously called - var obj: StripeNode.ICard = card; + var obj: Stripe.ICard = card; }); stripe.customers.updateCard( @@ -392,7 +390,7 @@ stripe.customers.updateCard( { name: "Jane Austen" }, function (err, card) { // asynchronously called - var obj: StripeNode.ICard = card; + var obj: Stripe.ICard = card; } ); @@ -401,7 +399,7 @@ stripe.customers.updateCard( "card_15fvyXEe31JkLCeQ9KMktP5S", { name: "Jane Austen" }).then(function (card) { // asynchronously called - var obj: StripeNode.ICard = card; + var obj: Stripe.ICard = card; }); stripe.customers.deleteCard( @@ -635,21 +633,21 @@ stripe.accounts.list( // ################################################################################## stripe.accounts.createExternalAccount("", { external_account: "btok_8E264Lxsbyvj3E" }, function (err, extAcc) { - var card = extAcc; - var bankAcc = extAcc; + var card = extAcc; + var bankAcc = extAcc; }); stripe.accounts.createExternalAccount("", { external_account: "tok_15V2YhEe31JkLCeQy9iUgsJX" }).then(function (extAcc) { - var card = extAcc; - var bankAcc = extAcc; + var card = extAcc; + var bankAcc = extAcc; }); stripe.accounts.createExternalAccount("", { external_account: "tok_15V2YhEe31JkLCeQy9iUgsJX" }, { stripe_account: "acct_17wV8KOoqMF9a2xk" }).then(function (extAcc) { - var card = extAcc; - var bankAcc = extAcc; + var card = extAcc; + var bankAcc = extAcc; }); stripe.accounts.createExternalAccount("", { external_account: "tok_15V2YhEe31JkLCeQy9iUgsJX" }, "acct_17wV8KOoqMF9a2xk").then(function (extAcc) { - var card = extAcc; - var bankAcc = extAcc; + var card = extAcc; + var bankAcc = extAcc; }); //#endregion @@ -712,7 +710,7 @@ const webhookRequest = { }; const webhookSecret = ''; -const event = stripe.webhooks.constructEvent( +const event = stripe.webhooks.constructEvent( webhookRequest.rawBody, webhookRequest.headers['stripe-signature'], webhookSecret @@ -752,7 +750,7 @@ stripe.coupons.retrieve("25OFF").then(function (coupon) { stripe.coupons.update("25OFF", { metadata: { key: "value" } -}, function (err: StripeNode.IStripeError, coupon: StripeNode.coupons.ICoupon) { +}, function (err: Stripe.IStripeError, coupon: Stripe.coupons.ICoupon) { // asynchronously called }); stripe.coupons.update("25OFF", { diff --git a/types/stripe-node/tsconfig.json b/types/stripe/tsconfig.json similarity index 93% rename from types/stripe-node/tsconfig.json rename to types/stripe/tsconfig.json index 7723446cb5..f2ac469aad 100644 --- a/types/stripe-node/tsconfig.json +++ b/types/stripe/tsconfig.json @@ -18,6 +18,6 @@ }, "files": [ "index.d.ts", - "stripe-node-tests.ts" + "stripe-tests.ts" ] } \ No newline at end of file