Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1amageek/tradable.ts
tradable.ts is a basic protocol to implement EC in Firebase.
https://github.com/1amageek/tradable.ts
cloud-functions firebase typescript
Last synced: 24 days ago
JSON representation
tradable.ts is a basic protocol to implement EC in Firebase.
- Host: GitHub
- URL: https://github.com/1amageek/tradable.ts
- Owner: 1amageek
- License: mit
- Created: 2018-03-15T06:10:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T11:23:20.000Z (about 2 years ago)
- Last Synced: 2024-11-24T16:42:51.951Z (about 2 months ago)
- Topics: cloud-functions, firebase, typescript
- Language: TypeScript
- Homepage:
- Size: 1.24 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tradable.ts
## Installation
```
npm add @1amageek/tradable
```
## Usage
You need to implement Tradable Inteface in the object associated with the user.Also, you prepare objects that implement other protocols.
### PaymentDelegate
In order to process payment with tradabe it is necessary to implement delegate.
This is an example of paying with Stripe.
```typescript
export const stripe = new Stripe(Config.STRIPE_API_KEY)
export class StripePaymentDelegate implements tradable.TransactionDelegate {
async payment>(currency: tradable.Currency, amount: number, order: T, options: tradable.PaymentOptions) {
const idempotency_key = order.id
const data: Stripe.charges.IChargeCreationOptions = {
amount: order.amount,
currency: order.currency,
description: `Charge for user/${order.purchasedBy}`
}
if (options) {
if (options.customer) {
data.customer = options.customer
}
if (options.source) {
data.source = options.source
}
}
data.customer = Config.STRIPE_CUS_TOKEN
data.source = Config.STRIPE_CORD_TOKEN
try {
const charge = await stripe.charges.create(data, {
idempotency_key: idempotency_key
})
return charge
} catch (error) {
console.log(error)
throw error
}
}
async refund>(currency: tradable.Currency, amount: number, order: T, options: tradable.PaymentOptions, reason?: string | undefined) {
const transactionResults = order.transactionResults
const transactionResult = transactionResults[transactionResults.length - 1]
const stripeCharge = transactionResult["stripe"] as Stripe.charges.ICharge
const charegeID = stripeCharge.id
const idempotency_key = `refund:${order.id}`
let data: Stripe.refunds.IRefundCreationOptions = {}
data.amount = amount
if (reason) {
data.reason = reason
}
try {
return await stripe.charges.refund(charegeID, data, {
idempotency_key: idempotency_key
})
} catch (error) {
throw error
}
}
async partRefund>(currency: tradable.Currency, amount: number, order: T, orderItem: U, options: tradable.PaymentOptions, reason?: string | undefined) {
const transactionResults = order.transactionResults
const transactionResult = transactionResults[transactionResults.length - 1]
const stripeCharge = transactionResult["stripe"] as Stripe.charges.ICharge
const charegeID = stripeCharge.id
const idempotency_key = `refund:${orderItem.id}`
let data: Stripe.refunds.IRefundCreationOptions = {}
data.amount = amount
if (reason) {
data.reason = reason
}
try {
return await stripe.charges.refund(charegeID, data, {
idempotency_key: idempotency_key
})
} catch (error) {
throw error
}
}
async transfer,
V extends tradable.BalanceTransactionProtocol, W extends tradable.AccountProtocol>
(currency: tradable.Currency, amount: number, order: T, toAccount: W, options: tradable.TransferOptions) {
const idempotency_key = order.id
const destination = toAccount.accountInformation['stripe']['id']
const data: Stripe.transfers.ITransferCreationOptions = {
amount: order.amount,
currency: order.currency,
transfer_group: order.id,
destination: destination
}
try {
const transfer = await stripe.transfers.create(data, {
idempotency_key: idempotency_key
})
return transfer
} catch (error) {
console.log(error)
throw error
}
}
async transferCancel>(currency: tradable.Currency, amount: number, order: T, options: tradable.TransferOptions, reason?: string | undefined) {
throw new Error("Method not implemented.");
}
async payout(currency: tradable.Currency, amount: number, accountID: string, options: tradable.PayoutOptions) {
throw new Error("Method not implemented.");
}
async payoutCancel(currency: tradable.Currency, amount: number, accountID: string, options: tradable.PayoutOptions) {
throw new Error("Method not implemented.");
}
}
```
#### Tradable
Request implementation of protocol required for trading.
#### UserProtocol
Request implementation of the protocol of the user who can place an order.
#### ProductProtocol
Request implementation of protocol of product information.
#### SKUShardProtocol
Request implementation of SKUShard protocol.
#### SKUProtocol
Request implementation of SKU protocol.
#### OrderProtocol
Request implementation of Order protocol.
#### OrderItemProtocol
Request implementation of OrderItem protocol.