@skalpgg/sdk 1.6.0 → 1.8.0

package/README.md

@@ -41,7 +41,8 @@ Create the key on the API keys page of your dashboard. Each key is bound to one
 
 | Method | Scope |
 | --- | --- |
-| `checkout.create({ productId, quantity?, customerEmail?, metadata?, couponCode?, returnUrl?, customFields? })` | `checkout:write` |
+| `me()` | none |
+| `checkout.create({ productId, quantity?, customerEmail?, metadata?, couponCode?, returnUrl?, customFields?, player? })` | `checkout:write` |
 | `checkout.get(id)` | `checkout:read` |
 | `orders.list({ status?, productId?, email?, identifier?, createdAfter?, createdBefore?, updatedSince?, limit?, offset? })` | `orders:read` |
 | `orders.get(id)` | `orders:read` |
@@ -63,7 +64,7 @@ Create the key on the API keys page of your dashboard. Each key is bound to one
 | `groups.list()` / `groups.get(id)` | `products:read` |
 | `groups.create({ title, productIds, ... })` / `groups.update(id, { ... })` / `groups.delete(id)` | `products:write` |
 | `coupons.list()` / `coupons.get(id)` | `coupons:read` |
-| `coupons.create({ code, discountType?, discountPercent?, discountAmount?, validFrom?, validTo?, maxUses?, ... })` / `coupons.update(id, { ... })` / `coupons.delete(id)` | `coupons:write` |
+| `coupons.create({ code, discountType?, discountPercent?, discountAmount?, validFrom?, validTo?, maxUses?, subscriptionDuration?, subscriptionMonths?, ... })` / `coupons.update(id, { ... })` / `coupons.delete(id)` | `coupons:write` |
 | `customers.list({ search?, limit?, offset? })` / `customers.get(id)` | `customers:read` |
 | `customers.create({ email, name?, note? })` / `customers.update(id, { name?, note? })` / `customers.delete(id)` | `customers:write` |
 | `feedback.list({ productId?, rating?, limit?, offset? })` / `feedback.get(id)` | `feedback:read` |
@@ -86,6 +87,8 @@ Create the key on the API keys page of your dashboard. Each key is bound to one
 | `licenses.resetDevices({ key, hardwareId? })` | `licenses:write` |
 | `licenses.verify({ licenseKey, serverIp, serverKey, serverPort? })` | none |
 | `licenses.heartbeat({ licenseKey, serverIp })` | none |
+| `webhooks.list()` | `webhooks:read` |
+| `webhooks.create({ url, events, productIds? })` / `webhooks.delete(id)` | `webhooks:write` |
 | `webhooks.constructEvent(rawBody, headers)` | none |
 | `webhooks.verify(rawBody, headers)` | none |
 
@@ -107,7 +110,7 @@ const { added, skipped, stock } = await skalp.products.addSerials(product.id, {
 await skalp.products.submit(product.id)
 ```
 
-A product starts as a `DRAFT`. `submit` sends it to review, and the review sets `ACTIVE` or `REJECTED`; read the product to see which. `update` accepts only `DRAFT` and `ARCHIVED` as a `status`, and `archive` takes a product off sale without deleting anything. Pass `null` to `update` to clear `comparePrice`, `storeCategoryId`, `dynamicUrl` or `licenseDurationDays`.
+A product starts as a `DRAFT`. `submit` sends it to review, and the review sets `ACTIVE` or `REJECTED`; read the product to see which. `update` accepts only `DRAFT` and `ARCHIVED` as a `status`, and `archive` takes a product off sale without deleting anything. Pass `null` to `update` to clear `comparePrice`, `storeCategoryId`, `dynamicUrl`, `licenseDurationDays` or `trialPrice`. `trialPrice` is what the buyer pays for the trial of a recurring product in a digital store, in the store currency before VAT, and `null` makes the trial free.
 
 `price` is in your store currency, and buyers in Poland, the euro area, the US and Brazil pay it converted at the day's rate. To charge a round local price instead, pass `prices: [{ currency: 'PLN', price: 79 }]`: up to three currencies other than the store one, from 5 to 999999 each, not on coin packs. The list replaces the old one, and `[]` removes them.
 
@@ -135,7 +138,9 @@ const { replacements } = await skalp.orders.replace(order.id, { reason: 'Key doe
 
 `updatedSince` lists oldest change first, so you can page through it and keep the last `updatedAt` as your cursor; without it, newest orders come first. Amounts are in major units (`19.5`).
 
-Coupons take `validFrom`, `validTo` as an ISO string or a `Date`; `coupons.update` accepts `null` to clear `validTo`, `maxUses`, `minPurchaseAmount` and `description`.
+Coupons take `validFrom`, `validTo` as an ISO string or a `Date`; `coupons.update` accepts `null` to clear `validTo`, `maxUses`, `minPurchaseAmount`, `subscriptionMonths` and `description`. On a subscription, `subscriptionDuration` sets how long the discount lasts: `ONCE` (the default), `REPEATING` for `subscriptionMonths` (1 to 36) or `FOREVER`.
+
+`me()` returns the store and the key you are using, with its scopes. `checkout.create` takes `player`, a `name` and game `ids` such as `steamid64` or `mc_name`, when your server already knows who gets the order. Orders carry `serviceFee`, the buyer fee included in `amount`, and customers carry `spent`, one total per currency.
 
 ## Support and access rules
 
@@ -180,9 +185,15 @@ export async function POST(request: Request) {
 }
 ```
 
+`webhooks.create` returns the endpoint's signing `secret` once, so store it then. `events` takes event names or `'*'` for all of them.
+
+```ts
+const { id, secret } = await skalp.webhooks.create({ url: 'https://example.com/skalp', events: ['order.paid', 'subscription.renewed'] })
+```
+
 A webhook with the default events receives every purchase as both `order.paid` and its legacy name `purchase.completed`. Handle `order.paid` and deduplicate on `data.idempotencyKey`.
 
-`order.created`, `order.updated`, `order.canceled`, `order.replaced`, `query.created`, `query.replied`, `feedback.received` and the subscription events `subscription.updated`, `subscription.trial_started`, `subscription.trial_ended` and `subscription.upcoming` are not in the default list either: subscribe the webhook to them by name, and `event.type` narrows `event.data` to the right payload. `order.created`, `order.updated` and `order.canceled` carry the order as `orders.get` returns it, plus `previousStatus`; `order.replaced` adds `reason` and the new keys in `replacements[].key`. Every one of them, like `query.created`, `query.replied` and `feedback.received`, carries a `data.idempotencyKey` that stays the same on every retry of the same event, so deduplicate on it. The three trial and upcoming events are accepted by the API but the backend does not send them yet.
+`order.created`, `order.updated`, `order.canceled`, `order.replaced`, `query.created`, `query.replied`, `feedback.received` and the subscription events `subscription.trial_started`, `subscription.trial_ended` and `subscription.upcoming` are not in the default list either: subscribe the webhook to them by name, and `event.type` narrows `event.data` to the right payload. `order.created`, `order.updated` and `order.canceled` carry the order as `orders.get` returns it, plus `previousStatus`; `order.replaced` adds `reason` and the new keys in `replacements[].key`. Every one of them, like `query.created`, `query.replied` and `feedback.received`, carries a `data.idempotencyKey` that stays the same on every retry of the same event, so deduplicate on it. `subscription.trial_started` follows `subscription.created` when a subscription starts with a trial, free or paid, `subscription.trial_ended` comes when the trial is over, and `subscription.upcoming` comes before a renewal is charged.
 
 `product.created`, `product.updated` and `product.stock` are not in the default list: subscribe the webhook to them by name. `product.stock` carries `stock`, `previousStock` and `change` whenever the number of available keys changes.
 

package/dist/cjs/index.d.ts

@@ -1,6 +1,6 @@
-import type { AccessRule, AddAccessRuleParams, AddSerialsParams, AddSerialsResult, AppealFeedbackParams, ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CoinCheckout, CoinCheckoutStatus, Coupon, CreateCheckoutParams, CreateCoinCheckoutParams, CreateCouponParams, CreateCustomerParams, CreateProductGroupParams, CreateProductParams, CreateStoreCategoryParams, CreateSubscriptionCheckoutParams, CreateUsageChargeParams, Customer, CustomerDetails, CustomerList, Deleted, Feedback, FeedbackList, HeartbeatParams, Invoice, LicenseKeyInfo, LicenseValidation, LicenseVerification, ListAccessRulesParams, ListCustomersParams, ListFeedbackParams, ListOrdersParams, ListProductsParams, ListQueriesParams, ListSerialsParams, ListSubscriptionsParams, Order, OrderKeysReplaced, OrderList, Product, ProductGroup, ProductStock, ReplaceOrderKeysParams, ReplyParams, SerialList, SkalpEvent, StoreCategory, StoreCategoryWithCount, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, SupportQueryDetails, SupportQueryList, ResetLicenseDevicesParams, UpdateCouponParams, UpdateCustomerParams, UpdateProductGroupParams, UpdateProductParams, UpdateStoreCategoryParams, UsageCharge, ValidateLicenseParams, VerifyLicenseParams } from './types.js';
+import type { AccessRule, AddAccessRuleParams, AddSerialsParams, AddSerialsResult, AppealFeedbackParams, ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CoinCheckout, CoinCheckoutStatus, Coupon, CreateCheckoutParams, CreateCoinCheckoutParams, CreateCouponParams, CreateCustomerParams, CreateProductGroupParams, CreateProductParams, CreateStoreCategoryParams, CreateSubscriptionCheckoutParams, CreateUsageChargeParams, CreateWebhookParams, CreatedWebhookEndpoint, Customer, CustomerDetails, CustomerList, Deleted, Feedback, FeedbackList, HeartbeatParams, Invoice, LicenseKeyInfo, LicenseValidation, LicenseVerification, ListAccessRulesParams, ListCustomersParams, ListFeedbackParams, ListOrdersParams, ListProductsParams, ListQueriesParams, ListSerialsParams, ListSubscriptionsParams, Me, Order, OrderKeysReplaced, OrderList, Product, ProductGroup, ProductStock, ReplaceOrderKeysParams, ReplyParams, SerialList, SkalpEvent, StoreCategory, StoreCategoryWithCount, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, SupportQueryDetails, SupportQueryList, ResetLicenseDevicesParams, UpdateCouponParams, UpdateCustomerParams, UpdateProductGroupParams, UpdateProductParams, UpdateStoreCategoryParams, UsageCharge, ValidateLicenseParams, VerifyLicenseParams, WebhookEndpoint } from './types.js';
 export type * from './types.js';
-export declare const VERSION = "1.6.0";
+export declare const VERSION = "1.8.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -31,8 +31,9 @@ export declare class SkalpSignatureError extends Error {
 export declare class Skalp {
     #private;
     constructor(options?: string | SkalpOptions);
+    readonly me: () => Promise<Me>;
     readonly checkout: {
-        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields }: CreateCheckoutParams) => Promise<CheckoutSession>;
+        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields, player }: CreateCheckoutParams) => Promise<CheckoutSession>;
         get: (id: string) => Promise<CheckoutSessionStatus>;
     };
     readonly orders: {
@@ -129,6 +130,12 @@ export declare class Skalp {
         }>;
     };
     readonly webhooks: {
+        list: () => Promise<WebhookEndpoint[]>;
+        create: ({ url, events, productIds }: CreateWebhookParams) => Promise<CreatedWebhookEndpoint>;
+        delete: (id: string) => Promise<{
+            id: string;
+            deleted: true;
+        }>;
         verify: (payload: WebhookPayload, signature: SignatureSource, secret?: string) => Promise<boolean>;
         constructEvent: (payload: WebhookPayload, signature: SignatureSource, secret?: string) => Promise<SkalpEvent>;
     };

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Skalp = exports.SkalpSignatureError = exports.SkalpConnectionError = exports.SkalpError = exports.VERSION = void 0;
-exports.VERSION = '1.6.0';
+exports.VERSION = '1.8.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
 const PRODUCT_PAGE = 100;
@@ -60,6 +60,7 @@ const PRODUCT_FIELDS = [
     'fulfillmentType',
     'billingInterval',
     'trialPeriodDays',
+    'trialPrice',
     'dynamicUrl',
     'licenseDeviceLimit',
     'licenseDurationDays',
@@ -81,6 +82,9 @@ const PRODUCT_FIELDS = [
     'volumeDiscounts',
     'upsells',
     'prices',
+    'poolsEnabled',
+    'upgradeFrom',
+    'includes',
 ];
 const COUPON_FIELDS = [
     'discountType',
@@ -92,6 +96,8 @@ const COUPON_FIELDS = [
     'maxUses',
     'minPurchaseAmount',
     'oneTimePerUser',
+    'subscriptionDuration',
+    'subscriptionMonths',
 ];
 const GROUP_FIELDS = ['title', 'productIds', 'description', 'image', 'sortPriority', 'unlisted'];
 function pick(source, keys) {
@@ -122,9 +128,10 @@ class Skalp {
             throw new Error('Skalp: your API key is a secret and must never reach the browser. Call the SDK from server code, or pass dangerouslyAllowBrowser: true if you really know what you are doing.');
         }
     }
+    me = () => this.#request('GET', '/v1/me');
     checkout = {
-        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields }) => this.#request('POST', '/v1/checkout/sessions', {
-            body: { items: [{ productId, quantity }], customerEmail, metadata, couponCode, returnUrl, customFields },
+        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields, player }) => this.#request('POST', '/v1/checkout/sessions', {
+            body: { items: [{ productId, quantity }], customerEmail, metadata, couponCode, returnUrl, customFields, player },
         }),
         get: (id) => this.#request('GET', `/v1/checkout/sessions/${segment(id)}`),
     };
@@ -302,6 +309,9 @@ class Skalp {
         }),
     };
     webhooks = {
+        list: () => this.#request('GET', '/v1/webhooks'),
+        create: ({ url, events, productIds }) => this.#request('POST', '/v1/webhooks', { body: { url, events, productIds } }),
+        delete: (id) => this.#request('DELETE', `/v1/webhooks/${segment(id)}`),
         verify: async (payload, signature, secret) => (await this.#checkSignature(payload, signature, secret)) === undefined,
         constructEvent: async (payload, signature, secret) => {
             const failure = await this.#checkSignature(payload, signature, secret);
@@ -415,10 +425,10 @@ function parseSignature(header) {
 function toBytes(payload, encoder) {
     if (typeof payload === 'string')
         return encoder.encode(payload);
-    if (payload instanceof ArrayBuffer)
+    if (ArrayBuffer.isView(payload))
+        return new Uint8Array(payload.buffer, payload.byteOffset, payload.byteLength);
+    if (Object.prototype.toString.call(payload) === '[object ArrayBuffer]')
         return new Uint8Array(payload);
-    if (payload instanceof Uint8Array)
-        return payload;
     throw new TypeError('Skalp: webhook payload must be the raw request body (string, Buffer or ArrayBuffer). A parsed JSON object cannot be verified, because re-serializing it changes the bytes that were signed.');
 }
 function retryAfterSeconds(res, attempt) {

package/dist/cjs/types.d.ts

@@ -3,12 +3,21 @@ export type FulfillmentType = 'FILE' | 'SERIAL' | 'GAME' | 'SERVICE' | 'DYNAMIC'
 export type ProductStatus = 'DRAFT' | 'PENDING_REVIEW' | 'PROCESSING' | 'PROCESSING_FAILED' | 'ACTIVE' | 'REJECTED' | 'ARCHIVED';
 export type ProductType = 'ONE_TIME' | 'RECURRING' | 'COINS';
 export type Game = 'fivem' | 'minecraft' | 'rust';
-export type BillingInterval = 'WEEK' | 'MONTH' | 'YEAR';
+export type BillingInterval = 'WEEK' | 'MONTH' | 'QUARTER' | 'HALF_YEAR' | 'YEAR';
 export type OrderStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'REFUNDED' | 'DISPUTED' | 'CANCELED';
-export type PaymentProvider = 'STRIPE' | 'NOWPAYMENTS' | 'PAYPAL';
+export type PaymentProvider = 'STRIPE' | 'NOWPAYMENTS' | 'PAYPAL' | 'PAYSSION';
 export type DeliveryStatus = 'PENDING' | 'PROCESSING' | 'DELIVERED' | 'FAILED';
 export type SubscriptionStatus = 'ACTIVE' | 'CANCELED' | 'PAST_DUE' | 'UNPAID' | 'INCOMPLETE' | 'INCOMPLETE_EXPIRED' | 'TRIALING' | 'PAUSED';
 export type Metadata = Record<string, string>;
+export type PlayerIdKey = 'fivem' | 'license2' | 'steam' | 'discord' | 'xbl' | 'live' | 'fivemId' | 'mc_uuid' | 'mc_name' | 'steamid64';
+export interface PlayerInput {
+    name?: string;
+    ids?: Partial<Record<PlayerIdKey, string>>;
+}
+export interface Player {
+    name: string | null;
+    ids: Partial<Record<PlayerIdKey, string>>;
+}
 export interface CreateCheckoutParams {
     productId: string;
     /** Units to sell, within the product's minQuantity and maxQuantity. Defaults to minQuantity. */
@@ -19,6 +28,7 @@ export interface CreateCheckoutParams {
     returnUrl?: string;
     /** Answers you already have, by field key; the buyer adds the rest on the pay page. */
     customFields?: Record<string, string>;
+    player?: PlayerInput;
 }
 export interface CheckoutSession {
     id: string;
@@ -28,7 +38,7 @@ export interface CheckoutSession {
 }
 export interface CheckoutSessionStatus {
     id: string;
-    status: 'pending' | 'completed' | 'failed';
+    status: 'pending' | 'completed' | 'failed' | 'canceled';
     orderNumber: string;
     amount: number;
     currency: Currency;
@@ -45,23 +55,24 @@ export interface Order {
     vatRate: number | null;
     currency: Currency;
     discountAmount: number;
+    serviceFee: number | null;
     couponCode: string | null;
     productId: string;
     productName: string;
     productSlug: string;
     /** Units of productId. */
     quantity: number;
-    fulfillmentType: FulfillmentType;
+    fulfillmentType: FulfillmentType | null;
     bundleId: string | null;
     buyerEmail: string;
     buyerCountry: string | null;
     paymentProvider: PaymentProvider | null;
     isGift: boolean;
-    granted?: boolean;
+    granted: boolean;
     deliveryStatus: DeliveryStatus | null;
     serialsCount?: number;
     serialsReplaced?: number;
-    /** Delivered and replaced keys by id, never their values. Only orders.get and orders.cancel fill it in. */
+    /** Delivered and replaced keys by id, never their values. Filled in by orders.get, orders.cancel and orders.redeliver. */
     serials?: Array<OrderSerial>;
     createdAt: string;
     updatedAt: string;
@@ -199,6 +210,7 @@ export interface Product {
     productType: ProductType;
     billingInterval: BillingInterval | null;
     trialPeriodDays: number;
+    trialPrice: number | null;
     fulfillmentType: FulfillmentType | null;
     game: Game | null;
     category: string;
@@ -239,6 +251,9 @@ export interface Product {
     volumeDiscounts: Array<VolumeDiscount>;
     /** Products offered on this product's checkout page. */
     upsells: Array<ProductUpsell>;
+    poolsEnabled: boolean | null;
+    upgradeFrom: Array<string>;
+    includes: Array<string>;
     stock: number | null;
     sale: ProductSale | null;
     salesCount: number;
@@ -281,6 +296,7 @@ interface ProductFields {
     fulfillmentType?: FulfillmentType;
     billingInterval?: BillingInterval;
     trialPeriodDays?: number;
+    trialPrice?: number | null;
     dynamicUrl?: string | null;
     licenseDeviceLimit?: number;
     licenseDurationDays?: number | null;
@@ -311,6 +327,9 @@ interface ProductFields {
     upsells?: Array<ProductUpsellInput> | null;
     /** Up to 3 currencies other than the store currency, not for coin packs; the list replaces the old one, [] or null removes them all. */
     prices?: Array<ProductPrice> | null;
+    poolsEnabled?: boolean;
+    upgradeFrom?: Array<string>;
+    includes?: Array<string>;
 }
 export interface CreateProductParams extends ProductFields {
     name: string;
@@ -368,6 +387,39 @@ export interface Deleted {
     id: string;
     deleted: true;
 }
+export interface Me {
+    store: {
+        id: string;
+        name: string;
+        slug: string;
+        currency: Currency;
+        url: string;
+    };
+    key: {
+        name: string;
+        scopes: Array<string>;
+    };
+}
+export type WebhookEventName = SkalpEventType | '*';
+export interface WebhookEndpoint {
+    id: string;
+    url: string;
+    events: Array<WebhookEventName>;
+    format: 'skalp' | (string & {});
+    isActive: boolean;
+    createdAt: string;
+}
+export interface CreateWebhookParams {
+    url: string;
+    events: Array<WebhookEventName>;
+    productIds?: Array<string>;
+}
+export interface CreatedWebhookEndpoint {
+    id: string;
+    url: string;
+    events: Array<WebhookEventName>;
+    secret: string;
+}
 export interface StoreCategory {
     id: string;
     name: string;
@@ -421,6 +473,7 @@ export interface UpdateProductGroupParams {
     unlisted?: boolean;
 }
 export type CouponDiscountType = 'PERCENT' | 'FIXED';
+export type CouponDuration = 'ONCE' | 'REPEATING' | 'FOREVER';
 export interface Coupon {
     id: string;
     code: string;
@@ -430,6 +483,8 @@ export interface Coupon {
     discountAmount: number | null;
     productIds: Array<string>;
     disabledWithVolumeDiscounts: boolean;
+    subscriptionDuration: CouponDuration;
+    subscriptionMonths: number | null;
     validFrom: string;
     validTo: string | null;
     maxUses: number | null;
@@ -453,6 +508,8 @@ export interface CreateCouponParams {
     maxUses?: number;
     minPurchaseAmount?: number;
     oneTimePerUser?: boolean;
+    subscriptionDuration?: CouponDuration;
+    subscriptionMonths?: number;
 }
 export interface UpdateCouponParams {
     discountType?: CouponDiscountType;
@@ -467,6 +524,8 @@ export interface UpdateCouponParams {
     minPurchaseAmount?: number | null;
     oneTimePerUser?: boolean;
     isActive?: boolean;
+    subscriptionDuration?: CouponDuration;
+    subscriptionMonths?: number | null;
 }
 export interface Customer {
     id: string;
@@ -477,6 +536,10 @@ export interface Customer {
     ordersCount: number;
     totalSpent: number;
     currency: Currency;
+    spent: Array<{
+        currency: Currency;
+        amount: number;
+    }>;
     firstOrderAt: string | null;
     lastOrderAt: string | null;
     createdAt: string;
@@ -484,6 +547,17 @@ export interface Customer {
 }
 export interface CustomerDetails extends Customer {
     recentOrders: Array<Order>;
+    recentSubscriptionPayments: Array<SubscriptionPayment>;
+}
+export interface SubscriptionPayment {
+    id: string;
+    orderNumber: string | null;
+    status: 'COMPLETED' | 'REFUNDED';
+    amount: number;
+    currency: Currency;
+    productName: string;
+    subscriptionId: string;
+    createdAt: string;
 }
 export interface ListCustomersParams {
     search?: string;
@@ -613,7 +687,7 @@ export interface CreateSubscriptionCheckoutParams {
     customerEmail?: string;
     externalRef?: string;
     metadata?: Metadata;
-    currency?: 'EUR' | 'USD' | 'PLN';
+    currency?: 'EUR' | 'USD' | 'PLN' | 'BRL';
     returnUrl?: string;
 }
 export interface SubscriptionCheckout {
@@ -690,7 +764,7 @@ export interface Invoice {
 }
 export interface CreateUsageChargeParams {
     amount: number;
-    currency: 'EUR' | 'USD' | 'PLN';
+    currency: Currency;
     description: string;
     idempotencyKey: string;
     periodStart: string | Date;
@@ -822,6 +896,7 @@ export interface OrderPaidData {
     customFields: Record<string, string>;
     deliveryType?: string;
     deliveryCommand?: string;
+    player?: Player;
 }
 export interface OrderRefundedData {
     orderId: string;
@@ -837,6 +912,8 @@ export interface OrderRefundedData {
     fullRefund: boolean;
     licenses: Array<WebhookLicense>;
     revocations: Array<Revocation>;
+    upgradedTo?: string;
+    player?: Player;
 }
 export interface Revocation {
     productId: string;
@@ -889,6 +966,9 @@ export interface SubscriptionEventData {
     licenseKey: string | null;
     licenseStatus: string | null;
     licenseExpiresAt: string | null;
+    deliveryType?: string;
+    deliveryCommand?: string;
+    player?: Player;
 }
 export interface ProductEventData {
     productId: string;
@@ -951,7 +1031,10 @@ export interface FeedbackReceivedData {
     customerName: string | null;
     createdAt: string;
 }
-export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.canceled', OrderEventData> | Envelope<'order.replaced', OrderReplacedData> | Envelope<'order.paid' | 'purchase.completed', OrderPaidData> | Envelope<'order.refunded', OrderRefundedData> | Envelope<'order.disputed' | 'account.suspend', OrderDisputedData> | Envelope<'account.restore', AccountRestoreData> | Envelope<'subscription.created' | 'subscription.updated' | 'subscription.trial_started' | 'subscription.trial_ended' | 'subscription.upcoming', SubscriptionEventData> | Envelope<'subscription.renewed', SubscriptionEventData & {
+export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.canceled', OrderEventData> | Envelope<'order.replaced', OrderReplacedData> | Envelope<'order.paid' | 'purchase.completed', OrderPaidData> | Envelope<'order.refunded', OrderRefundedData> | Envelope<'order.disputed' | 'account.suspend', OrderDisputedData> | Envelope<'account.restore', AccountRestoreData> | Envelope<'subscription.created' | 'subscription.updated' | 'subscription.trial_started' | 'subscription.trial_ended', SubscriptionEventData> | Envelope<'subscription.upcoming', SubscriptionEventData & {
+    amountDue: number;
+    nextPaymentAttempt: string | null;
+}> | Envelope<'subscription.renewed', SubscriptionEventData & {
     invoiceId: string;
     amountPaid: number;
     periodExtendedTo: string;
@@ -961,7 +1044,7 @@ export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.can
     nextPaymentAttempt: string | null;
 }> | Envelope<'subscription.canceled', SubscriptionEventData & {
     endedAt: string | null;
-    cancelReason: 'requested' | 'payment_failure' | 'dispute' | 'stripe';
+    cancelReason: 'requested' | 'payment_failure' | 'dispute' | 'stripe' | 'expired';
     revokeCommand?: string;
 }> | Envelope<'subscription.refunded', SubscriptionEventData & {
     invoiceId: string;

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
-import type { AccessRule, AddAccessRuleParams, AddSerialsParams, AddSerialsResult, AppealFeedbackParams, ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CoinCheckout, CoinCheckoutStatus, Coupon, CreateCheckoutParams, CreateCoinCheckoutParams, CreateCouponParams, CreateCustomerParams, CreateProductGroupParams, CreateProductParams, CreateStoreCategoryParams, CreateSubscriptionCheckoutParams, CreateUsageChargeParams, Customer, CustomerDetails, CustomerList, Deleted, Feedback, FeedbackList, HeartbeatParams, Invoice, LicenseKeyInfo, LicenseValidation, LicenseVerification, ListAccessRulesParams, ListCustomersParams, ListFeedbackParams, ListOrdersParams, ListProductsParams, ListQueriesParams, ListSerialsParams, ListSubscriptionsParams, Order, OrderKeysReplaced, OrderList, Product, ProductGroup, ProductStock, ReplaceOrderKeysParams, ReplyParams, SerialList, SkalpEvent, StoreCategory, StoreCategoryWithCount, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, SupportQueryDetails, SupportQueryList, ResetLicenseDevicesParams, UpdateCouponParams, UpdateCustomerParams, UpdateProductGroupParams, UpdateProductParams, UpdateStoreCategoryParams, UsageCharge, ValidateLicenseParams, VerifyLicenseParams } from './types.js';
+import type { AccessRule, AddAccessRuleParams, AddSerialsParams, AddSerialsResult, AppealFeedbackParams, ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CoinCheckout, CoinCheckoutStatus, Coupon, CreateCheckoutParams, CreateCoinCheckoutParams, CreateCouponParams, CreateCustomerParams, CreateProductGroupParams, CreateProductParams, CreateStoreCategoryParams, CreateSubscriptionCheckoutParams, CreateUsageChargeParams, CreateWebhookParams, CreatedWebhookEndpoint, Customer, CustomerDetails, CustomerList, Deleted, Feedback, FeedbackList, HeartbeatParams, Invoice, LicenseKeyInfo, LicenseValidation, LicenseVerification, ListAccessRulesParams, ListCustomersParams, ListFeedbackParams, ListOrdersParams, ListProductsParams, ListQueriesParams, ListSerialsParams, ListSubscriptionsParams, Me, Order, OrderKeysReplaced, OrderList, Product, ProductGroup, ProductStock, ReplaceOrderKeysParams, ReplyParams, SerialList, SkalpEvent, StoreCategory, StoreCategoryWithCount, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, SupportQueryDetails, SupportQueryList, ResetLicenseDevicesParams, UpdateCouponParams, UpdateCustomerParams, UpdateProductGroupParams, UpdateProductParams, UpdateStoreCategoryParams, UsageCharge, ValidateLicenseParams, VerifyLicenseParams, WebhookEndpoint } from './types.js';
 export type * from './types.js';
-export declare const VERSION = "1.6.0";
+export declare const VERSION = "1.8.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -31,8 +31,9 @@ export declare class SkalpSignatureError extends Error {
 export declare class Skalp {
     #private;
     constructor(options?: string | SkalpOptions);
+    readonly me: () => Promise<Me>;
     readonly checkout: {
-        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields }: CreateCheckoutParams) => Promise<CheckoutSession>;
+        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields, player }: CreateCheckoutParams) => Promise<CheckoutSession>;
         get: (id: string) => Promise<CheckoutSessionStatus>;
     };
     readonly orders: {
@@ -129,6 +130,12 @@ export declare class Skalp {
         }>;
     };
     readonly webhooks: {
+        list: () => Promise<WebhookEndpoint[]>;
+        create: ({ url, events, productIds }: CreateWebhookParams) => Promise<CreatedWebhookEndpoint>;
+        delete: (id: string) => Promise<{
+            id: string;
+            deleted: true;
+        }>;
         verify: (payload: WebhookPayload, signature: SignatureSource, secret?: string) => Promise<boolean>;
         constructEvent: (payload: WebhookPayload, signature: SignatureSource, secret?: string) => Promise<SkalpEvent>;
     };

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-export const VERSION = '1.6.0';
+export const VERSION = '1.8.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
 const PRODUCT_PAGE = 100;
@@ -54,6 +54,7 @@ const PRODUCT_FIELDS = [
     'fulfillmentType',
     'billingInterval',
     'trialPeriodDays',
+    'trialPrice',
     'dynamicUrl',
     'licenseDeviceLimit',
     'licenseDurationDays',
@@ -75,6 +76,9 @@ const PRODUCT_FIELDS = [
     'volumeDiscounts',
     'upsells',
     'prices',
+    'poolsEnabled',
+    'upgradeFrom',
+    'includes',
 ];
 const COUPON_FIELDS = [
     'discountType',
@@ -86,6 +90,8 @@ const COUPON_FIELDS = [
     'maxUses',
     'minPurchaseAmount',
     'oneTimePerUser',
+    'subscriptionDuration',
+    'subscriptionMonths',
 ];
 const GROUP_FIELDS = ['title', 'productIds', 'description', 'image', 'sortPriority', 'unlisted'];
 function pick(source, keys) {
@@ -116,9 +122,10 @@ export class Skalp {
             throw new Error('Skalp: your API key is a secret and must never reach the browser. Call the SDK from server code, or pass dangerouslyAllowBrowser: true if you really know what you are doing.');
         }
     }
+    me = () => this.#request('GET', '/v1/me');
     checkout = {
-        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields }) => this.#request('POST', '/v1/checkout/sessions', {
-            body: { items: [{ productId, quantity }], customerEmail, metadata, couponCode, returnUrl, customFields },
+        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields, player }) => this.#request('POST', '/v1/checkout/sessions', {
+            body: { items: [{ productId, quantity }], customerEmail, metadata, couponCode, returnUrl, customFields, player },
         }),
         get: (id) => this.#request('GET', `/v1/checkout/sessions/${segment(id)}`),
     };
@@ -296,6 +303,9 @@ export class Skalp {
         }),
     };
     webhooks = {
+        list: () => this.#request('GET', '/v1/webhooks'),
+        create: ({ url, events, productIds }) => this.#request('POST', '/v1/webhooks', { body: { url, events, productIds } }),
+        delete: (id) => this.#request('DELETE', `/v1/webhooks/${segment(id)}`),
         verify: async (payload, signature, secret) => (await this.#checkSignature(payload, signature, secret)) === undefined,
         constructEvent: async (payload, signature, secret) => {
             const failure = await this.#checkSignature(payload, signature, secret);
@@ -408,10 +418,10 @@ function parseSignature(header) {
 function toBytes(payload, encoder) {
     if (typeof payload === 'string')
         return encoder.encode(payload);
-    if (payload instanceof ArrayBuffer)
+    if (ArrayBuffer.isView(payload))
+        return new Uint8Array(payload.buffer, payload.byteOffset, payload.byteLength);
+    if (Object.prototype.toString.call(payload) === '[object ArrayBuffer]')
         return new Uint8Array(payload);
-    if (payload instanceof Uint8Array)
-        return payload;
     throw new TypeError('Skalp: webhook payload must be the raw request body (string, Buffer or ArrayBuffer). A parsed JSON object cannot be verified, because re-serializing it changes the bytes that were signed.');
 }
 function retryAfterSeconds(res, attempt) {

package/dist/esm/types.d.ts

@@ -3,12 +3,21 @@ export type FulfillmentType = 'FILE' | 'SERIAL' | 'GAME' | 'SERVICE' | 'DYNAMIC'
 export type ProductStatus = 'DRAFT' | 'PENDING_REVIEW' | 'PROCESSING' | 'PROCESSING_FAILED' | 'ACTIVE' | 'REJECTED' | 'ARCHIVED';
 export type ProductType = 'ONE_TIME' | 'RECURRING' | 'COINS';
 export type Game = 'fivem' | 'minecraft' | 'rust';
-export type BillingInterval = 'WEEK' | 'MONTH' | 'YEAR';
+export type BillingInterval = 'WEEK' | 'MONTH' | 'QUARTER' | 'HALF_YEAR' | 'YEAR';
 export type OrderStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'REFUNDED' | 'DISPUTED' | 'CANCELED';
-export type PaymentProvider = 'STRIPE' | 'NOWPAYMENTS' | 'PAYPAL';
+export type PaymentProvider = 'STRIPE' | 'NOWPAYMENTS' | 'PAYPAL' | 'PAYSSION';
 export type DeliveryStatus = 'PENDING' | 'PROCESSING' | 'DELIVERED' | 'FAILED';
 export type SubscriptionStatus = 'ACTIVE' | 'CANCELED' | 'PAST_DUE' | 'UNPAID' | 'INCOMPLETE' | 'INCOMPLETE_EXPIRED' | 'TRIALING' | 'PAUSED';
 export type Metadata = Record<string, string>;
+export type PlayerIdKey = 'fivem' | 'license2' | 'steam' | 'discord' | 'xbl' | 'live' | 'fivemId' | 'mc_uuid' | 'mc_name' | 'steamid64';
+export interface PlayerInput {
+    name?: string;
+    ids?: Partial<Record<PlayerIdKey, string>>;
+}
+export interface Player {
+    name: string | null;
+    ids: Partial<Record<PlayerIdKey, string>>;
+}
 export interface CreateCheckoutParams {
     productId: string;
     /** Units to sell, within the product's minQuantity and maxQuantity. Defaults to minQuantity. */
@@ -19,6 +28,7 @@ export interface CreateCheckoutParams {
     returnUrl?: string;
     /** Answers you already have, by field key; the buyer adds the rest on the pay page. */
     customFields?: Record<string, string>;
+    player?: PlayerInput;
 }
 export interface CheckoutSession {
     id: string;
@@ -28,7 +38,7 @@ export interface CheckoutSession {
 }
 export interface CheckoutSessionStatus {
     id: string;
-    status: 'pending' | 'completed' | 'failed';
+    status: 'pending' | 'completed' | 'failed' | 'canceled';
     orderNumber: string;
     amount: number;
     currency: Currency;
@@ -45,23 +55,24 @@ export interface Order {
     vatRate: number | null;
     currency: Currency;
     discountAmount: number;
+    serviceFee: number | null;
     couponCode: string | null;
     productId: string;
     productName: string;
     productSlug: string;
     /** Units of productId. */
     quantity: number;
-    fulfillmentType: FulfillmentType;
+    fulfillmentType: FulfillmentType | null;
     bundleId: string | null;
     buyerEmail: string;
     buyerCountry: string | null;
     paymentProvider: PaymentProvider | null;
     isGift: boolean;
-    granted?: boolean;
+    granted: boolean;
     deliveryStatus: DeliveryStatus | null;
     serialsCount?: number;
     serialsReplaced?: number;
-    /** Delivered and replaced keys by id, never their values. Only orders.get and orders.cancel fill it in. */
+    /** Delivered and replaced keys by id, never their values. Filled in by orders.get, orders.cancel and orders.redeliver. */
     serials?: Array<OrderSerial>;
     createdAt: string;
     updatedAt: string;
@@ -199,6 +210,7 @@ export interface Product {
     productType: ProductType;
     billingInterval: BillingInterval | null;
     trialPeriodDays: number;
+    trialPrice: number | null;
     fulfillmentType: FulfillmentType | null;
     game: Game | null;
     category: string;
@@ -239,6 +251,9 @@ export interface Product {
     volumeDiscounts: Array<VolumeDiscount>;
     /** Products offered on this product's checkout page. */
     upsells: Array<ProductUpsell>;
+    poolsEnabled: boolean | null;
+    upgradeFrom: Array<string>;
+    includes: Array<string>;
     stock: number | null;
     sale: ProductSale | null;
     salesCount: number;
@@ -281,6 +296,7 @@ interface ProductFields {
     fulfillmentType?: FulfillmentType;
     billingInterval?: BillingInterval;
     trialPeriodDays?: number;
+    trialPrice?: number | null;
     dynamicUrl?: string | null;
     licenseDeviceLimit?: number;
     licenseDurationDays?: number | null;
@@ -311,6 +327,9 @@ interface ProductFields {
     upsells?: Array<ProductUpsellInput> | null;
     /** Up to 3 currencies other than the store currency, not for coin packs; the list replaces the old one, [] or null removes them all. */
     prices?: Array<ProductPrice> | null;
+    poolsEnabled?: boolean;
+    upgradeFrom?: Array<string>;
+    includes?: Array<string>;
 }
 export interface CreateProductParams extends ProductFields {
     name: string;
@@ -368,6 +387,39 @@ export interface Deleted {
     id: string;
     deleted: true;
 }
+export interface Me {
+    store: {
+        id: string;
+        name: string;
+        slug: string;
+        currency: Currency;
+        url: string;
+    };
+    key: {
+        name: string;
+        scopes: Array<string>;
+    };
+}
+export type WebhookEventName = SkalpEventType | '*';
+export interface WebhookEndpoint {
+    id: string;
+    url: string;
+    events: Array<WebhookEventName>;
+    format: 'skalp' | (string & {});
+    isActive: boolean;
+    createdAt: string;
+}
+export interface CreateWebhookParams {
+    url: string;
+    events: Array<WebhookEventName>;
+    productIds?: Array<string>;
+}
+export interface CreatedWebhookEndpoint {
+    id: string;
+    url: string;
+    events: Array<WebhookEventName>;
+    secret: string;
+}
 export interface StoreCategory {
     id: string;
     name: string;
@@ -421,6 +473,7 @@ export interface UpdateProductGroupParams {
     unlisted?: boolean;
 }
 export type CouponDiscountType = 'PERCENT' | 'FIXED';
+export type CouponDuration = 'ONCE' | 'REPEATING' | 'FOREVER';
 export interface Coupon {
     id: string;
     code: string;
@@ -430,6 +483,8 @@ export interface Coupon {
     discountAmount: number | null;
     productIds: Array<string>;
     disabledWithVolumeDiscounts: boolean;
+    subscriptionDuration: CouponDuration;
+    subscriptionMonths: number | null;
     validFrom: string;
     validTo: string | null;
     maxUses: number | null;
@@ -453,6 +508,8 @@ export interface CreateCouponParams {
     maxUses?: number;
     minPurchaseAmount?: number;
     oneTimePerUser?: boolean;
+    subscriptionDuration?: CouponDuration;
+    subscriptionMonths?: number;
 }
 export interface UpdateCouponParams {
     discountType?: CouponDiscountType;
@@ -467,6 +524,8 @@ export interface UpdateCouponParams {
     minPurchaseAmount?: number | null;
     oneTimePerUser?: boolean;
     isActive?: boolean;
+    subscriptionDuration?: CouponDuration;
+    subscriptionMonths?: number | null;
 }
 export interface Customer {
     id: string;
@@ -477,6 +536,10 @@ export interface Customer {
     ordersCount: number;
     totalSpent: number;
     currency: Currency;
+    spent: Array<{
+        currency: Currency;
+        amount: number;
+    }>;
     firstOrderAt: string | null;
     lastOrderAt: string | null;
     createdAt: string;
@@ -484,6 +547,17 @@ export interface Customer {
 }
 export interface CustomerDetails extends Customer {
     recentOrders: Array<Order>;
+    recentSubscriptionPayments: Array<SubscriptionPayment>;
+}
+export interface SubscriptionPayment {
+    id: string;
+    orderNumber: string | null;
+    status: 'COMPLETED' | 'REFUNDED';
+    amount: number;
+    currency: Currency;
+    productName: string;
+    subscriptionId: string;
+    createdAt: string;
 }
 export interface ListCustomersParams {
     search?: string;
@@ -613,7 +687,7 @@ export interface CreateSubscriptionCheckoutParams {
     customerEmail?: string;
     externalRef?: string;
     metadata?: Metadata;
-    currency?: 'EUR' | 'USD' | 'PLN';
+    currency?: 'EUR' | 'USD' | 'PLN' | 'BRL';
     returnUrl?: string;
 }
 export interface SubscriptionCheckout {
@@ -690,7 +764,7 @@ export interface Invoice {
 }
 export interface CreateUsageChargeParams {
     amount: number;
-    currency: 'EUR' | 'USD' | 'PLN';
+    currency: Currency;
     description: string;
     idempotencyKey: string;
     periodStart: string | Date;
@@ -822,6 +896,7 @@ export interface OrderPaidData {
     customFields: Record<string, string>;
     deliveryType?: string;
     deliveryCommand?: string;
+    player?: Player;
 }
 export interface OrderRefundedData {
     orderId: string;
@@ -837,6 +912,8 @@ export interface OrderRefundedData {
     fullRefund: boolean;
     licenses: Array<WebhookLicense>;
     revocations: Array<Revocation>;
+    upgradedTo?: string;
+    player?: Player;
 }
 export interface Revocation {
     productId: string;
@@ -889,6 +966,9 @@ export interface SubscriptionEventData {
     licenseKey: string | null;
     licenseStatus: string | null;
     licenseExpiresAt: string | null;
+    deliveryType?: string;
+    deliveryCommand?: string;
+    player?: Player;
 }
 export interface ProductEventData {
     productId: string;
@@ -951,7 +1031,10 @@ export interface FeedbackReceivedData {
     customerName: string | null;
     createdAt: string;
 }
-export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.canceled', OrderEventData> | Envelope<'order.replaced', OrderReplacedData> | Envelope<'order.paid' | 'purchase.completed', OrderPaidData> | Envelope<'order.refunded', OrderRefundedData> | Envelope<'order.disputed' | 'account.suspend', OrderDisputedData> | Envelope<'account.restore', AccountRestoreData> | Envelope<'subscription.created' | 'subscription.updated' | 'subscription.trial_started' | 'subscription.trial_ended' | 'subscription.upcoming', SubscriptionEventData> | Envelope<'subscription.renewed', SubscriptionEventData & {
+export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.canceled', OrderEventData> | Envelope<'order.replaced', OrderReplacedData> | Envelope<'order.paid' | 'purchase.completed', OrderPaidData> | Envelope<'order.refunded', OrderRefundedData> | Envelope<'order.disputed' | 'account.suspend', OrderDisputedData> | Envelope<'account.restore', AccountRestoreData> | Envelope<'subscription.created' | 'subscription.updated' | 'subscription.trial_started' | 'subscription.trial_ended', SubscriptionEventData> | Envelope<'subscription.upcoming', SubscriptionEventData & {
+    amountDue: number;
+    nextPaymentAttempt: string | null;
+}> | Envelope<'subscription.renewed', SubscriptionEventData & {
     invoiceId: string;
     amountPaid: number;
     periodExtendedTo: string;
@@ -961,7 +1044,7 @@ export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.can
     nextPaymentAttempt: string | null;
 }> | Envelope<'subscription.canceled', SubscriptionEventData & {
     endedAt: string | null;
-    cancelReason: 'requested' | 'payment_failure' | 'dispute' | 'stripe';
+    cancelReason: 'requested' | 'payment_failure' | 'dispute' | 'stripe' | 'expired';
     revokeCommand?: string;
 }> | Envelope<'subscription.refunded', SubscriptionEventData & {
     invoiceId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skalpgg/sdk",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "Official Skalp SDK for Node.js and edge runtimes: checkout, subscriptions, catalog and key stock, webhooks and license verification.",
   "license": "MIT",
   "homepage": "https://skalp.gg/docs/sdk",