@skalpgg/sdk 1.4.0 → 1.5.0

package/README.md

@@ -47,7 +47,7 @@ Create the key on the API keys page of your dashboard. Each key is bound to one
 | `orders.get(id)` | `orders:read` |
 | `orders.cancel(id)` | `orders:write` |
 | `orders.replace(id, { serialIds?, values?, reason? })` | `orders:write` |
-| `products.list({ status? })` | `products:read` |
+| `products.list({ status?, limit?, offset? })` | `products:read` |
 | `products.get(idOrSlug)` | `products:read` |
 | `products.create({ name, price, fulfillmentType?, submit?, ... })` | `products:write` |
 | `products.update(idOrSlug, { price?, status?: 'DRAFT' \| 'ARCHIVED', ... })` | `products:write` |

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';
 export type * from './types.js';
-export declare const VERSION = "1.4.0";
+export declare const VERSION = "1.5.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -42,7 +42,7 @@ export declare class Skalp {
         replace: (id: string, { serialIds, values, reason }?: ReplaceOrderKeysParams) => Promise<OrderKeysReplaced>;
     };
     readonly products: {
-        list: ({ status }?: ListProductsParams) => Promise<Product[]>;
+        list: ({ status, limit, offset }?: ListProductsParams) => Promise<Array<Product>>;
         get: (idOrSlug: string) => Promise<Product>;
         create: (params: CreateProductParams) => Promise<Product>;
         update: (idOrSlug: string, params: UpdateProductParams) => Promise<Product>;

package/dist/cjs/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Skalp = exports.SkalpSignatureError = exports.SkalpConnectionError = exports.SkalpError = exports.VERSION = void 0;
-exports.VERSION = '1.4.0';
+exports.VERSION = '1.5.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
+const PRODUCT_PAGE = 100;
 const USER_AGENT = `skalp-node/${exports.VERSION}`;
 const DEFAULT_TIMEOUT_MS = 30_000;
 const MAX_RETRY_WAIT_SECONDS = 10;
@@ -128,7 +129,21 @@ class Skalp {
         }),
     };
     products = {
-        list: ({ status } = {}) => this.#request('GET', '/v1/products', { query: { status } }),
+        list: async ({ status, limit, offset } = {}) => {
+            if (limit !== undefined || offset !== undefined) {
+                return (await this.#send('GET', '/v1/products', { query: { status, limit, offset } })).data;
+            }
+            const products = [];
+            for (;;) {
+                const page = await this.#send('GET', '/v1/products', {
+                    query: { status, limit: PRODUCT_PAGE, offset: products.length },
+                });
+                products.push(...page.data);
+                const total = Number(page.headers.get('x-total-count'));
+                if (page.data.length < PRODUCT_PAGE || products.length >= total)
+                    return products;
+            }
+        },
         get: (idOrSlug) => this.#request('GET', `/v1/products/${segment(idOrSlug)}`),
         create: (params) => this.#request('POST', '/v1/products', {
             body: pick(params, [...PRODUCT_FIELDS, 'productType', 'submit']),
@@ -294,7 +309,10 @@ class Skalp {
         const hmac = await crypto.subtle.importKey('raw', encoder.encode(key), { name: 'HMAC', hash: 'SHA-256' }, false, ['verify']);
         return (await crypto.subtle.verify('HMAC', hmac, parsed.signature, signed)) ? undefined : 'invalid';
     }
-    async #request(method, path, { body, query, auth = true } = {}) {
+    async #request(method, path, options = {}) {
+        return (await this.#send(method, path, options)).data;
+    }
+    async #send(method, path, { body, query, auth = true } = {}) {
         if (auth && !this.#apiKey) {
             throw new Error('Skalp: missing API key. Pass it to new Skalp(apiKey) or set SKALP_API_KEY.');
         }
@@ -339,7 +357,7 @@ class Skalp {
             }
             if (!res.ok)
                 throw toError(res.status, data);
-            return data;
+            return { data: data, headers: res.headers };
         }
     }
 }

package/dist/cjs/types.d.ts

@@ -205,6 +205,13 @@ export interface Product {
     deliveryType: DeliveryType | null;
     /** Server stores: what the game server runs after payment. */
     deliveryPayload: string | null;
+    revokePayload: string | null;
+    coinConfig: CoinConfig | null;
+    pendingChanges: {
+        submittedAt: string;
+        changes: Partial<Record<ReviewedProductField, unknown>>;
+    } | null;
+    pendingChangesRejection: string | null;
     visibility: ProductVisibility;
     /** Higher comes first on the store page. */
     sortPriority: number;
@@ -232,8 +239,24 @@ export interface Product {
     createdAt: string;
     updatedAt: string;
 }
+export interface CoinBonusTier {
+    thresholdCoins: number;
+    bonusPercent: number;
+}
+export interface CoinConfig {
+    unitPriceCents: number;
+    minQty: number;
+    maxQty: number;
+    step: number;
+    currency: string;
+    bonusTiers: Array<CoinBonusTier>;
+}
+export type CoinConfigInput = Omit<CoinConfig, 'currency'>;
+export type ReviewedProductField = 'name' | 'shortDescription' | 'description' | 'images' | 'videoUrl' | 'features' | 'requirements' | 'customFields' | 'deliveryNote' | 'termsOfService' | 'warrantyText' | 'deliveryType' | 'deliveryPayload' | 'revokePayload';
 export interface ListProductsParams {
     status?: ProductStatus | 'all';
+    limit?: number;
+    offset?: number;
 }
 interface ProductFields {
     slug?: string;
@@ -255,6 +278,8 @@ interface ProductFields {
     deliveryType?: DeliveryType;
     /** Required for a server store; needs a placeholder such as {steamhex}. */
     deliveryPayload?: string;
+    revokePayload?: string;
+    coinConfig?: CoinConfigInput;
     visibility?: ProductVisibility;
     sortPriority?: number;
     /** null or an empty string clears it. */
@@ -279,7 +304,7 @@ export interface CreateProductParams extends ProductFields {
     name: string;
     price: number;
     comparePrice?: number;
-    productType?: 'ONE_TIME' | 'RECURRING';
+    productType?: 'ONE_TIME' | 'RECURRING' | 'COINS';
     submit?: boolean;
 }
 export interface UpdateProductParams extends ProductFields {
@@ -799,6 +824,16 @@ export interface OrderRefundedData {
     granted?: boolean;
     fullRefund: boolean;
     licenses: Array<WebhookLicense>;
+    revocations: Array<Revocation>;
+}
+export interface Revocation {
+    productId: string;
+    productSlug: string;
+    productName: string;
+    deliveryKey: string;
+    delivered: boolean;
+    deliveryType: DeliveryType;
+    revokeCommand: string;
 }
 export interface OrderDisputedData {
     orderId: string;
@@ -914,6 +949,7 @@ export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.can
 }> | Envelope<'subscription.canceled', SubscriptionEventData & {
     endedAt: string | null;
     cancelReason: 'requested' | 'payment_failure' | 'dispute' | 'stripe';
+    revokeCommand?: string;
 }> | Envelope<'subscription.refunded', SubscriptionEventData & {
     invoiceId: string;
     amountRefunded: number;

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';
 export type * from './types.js';
-export declare const VERSION = "1.4.0";
+export declare const VERSION = "1.5.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -42,7 +42,7 @@ export declare class Skalp {
         replace: (id: string, { serialIds, values, reason }?: ReplaceOrderKeysParams) => Promise<OrderKeysReplaced>;
     };
     readonly products: {
-        list: ({ status }?: ListProductsParams) => Promise<Product[]>;
+        list: ({ status, limit, offset }?: ListProductsParams) => Promise<Array<Product>>;
         get: (idOrSlug: string) => Promise<Product>;
         create: (params: CreateProductParams) => Promise<Product>;
         update: (idOrSlug: string, params: UpdateProductParams) => Promise<Product>;

package/dist/esm/index.js

@@ -1,6 +1,7 @@
-export const VERSION = '1.4.0';
+export const VERSION = '1.5.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
+const PRODUCT_PAGE = 100;
 const USER_AGENT = `skalp-node/${VERSION}`;
 const DEFAULT_TIMEOUT_MS = 30_000;
 const MAX_RETRY_WAIT_SECONDS = 10;
@@ -122,7 +123,21 @@ export class Skalp {
         }),
     };
     products = {
-        list: ({ status } = {}) => this.#request('GET', '/v1/products', { query: { status } }),
+        list: async ({ status, limit, offset } = {}) => {
+            if (limit !== undefined || offset !== undefined) {
+                return (await this.#send('GET', '/v1/products', { query: { status, limit, offset } })).data;
+            }
+            const products = [];
+            for (;;) {
+                const page = await this.#send('GET', '/v1/products', {
+                    query: { status, limit: PRODUCT_PAGE, offset: products.length },
+                });
+                products.push(...page.data);
+                const total = Number(page.headers.get('x-total-count'));
+                if (page.data.length < PRODUCT_PAGE || products.length >= total)
+                    return products;
+            }
+        },
         get: (idOrSlug) => this.#request('GET', `/v1/products/${segment(idOrSlug)}`),
         create: (params) => this.#request('POST', '/v1/products', {
             body: pick(params, [...PRODUCT_FIELDS, 'productType', 'submit']),
@@ -288,7 +303,10 @@ export class Skalp {
         const hmac = await crypto.subtle.importKey('raw', encoder.encode(key), { name: 'HMAC', hash: 'SHA-256' }, false, ['verify']);
         return (await crypto.subtle.verify('HMAC', hmac, parsed.signature, signed)) ? undefined : 'invalid';
     }
-    async #request(method, path, { body, query, auth = true } = {}) {
+    async #request(method, path, options = {}) {
+        return (await this.#send(method, path, options)).data;
+    }
+    async #send(method, path, { body, query, auth = true } = {}) {
         if (auth && !this.#apiKey) {
             throw new Error('Skalp: missing API key. Pass it to new Skalp(apiKey) or set SKALP_API_KEY.');
         }
@@ -333,7 +351,7 @@ export class Skalp {
             }
             if (!res.ok)
                 throw toError(res.status, data);
-            return data;
+            return { data: data, headers: res.headers };
         }
     }
 }

package/dist/esm/types.d.ts

@@ -205,6 +205,13 @@ export interface Product {
     deliveryType: DeliveryType | null;
     /** Server stores: what the game server runs after payment. */
     deliveryPayload: string | null;
+    revokePayload: string | null;
+    coinConfig: CoinConfig | null;
+    pendingChanges: {
+        submittedAt: string;
+        changes: Partial<Record<ReviewedProductField, unknown>>;
+    } | null;
+    pendingChangesRejection: string | null;
     visibility: ProductVisibility;
     /** Higher comes first on the store page. */
     sortPriority: number;
@@ -232,8 +239,24 @@ export interface Product {
     createdAt: string;
     updatedAt: string;
 }
+export interface CoinBonusTier {
+    thresholdCoins: number;
+    bonusPercent: number;
+}
+export interface CoinConfig {
+    unitPriceCents: number;
+    minQty: number;
+    maxQty: number;
+    step: number;
+    currency: string;
+    bonusTiers: Array<CoinBonusTier>;
+}
+export type CoinConfigInput = Omit<CoinConfig, 'currency'>;
+export type ReviewedProductField = 'name' | 'shortDescription' | 'description' | 'images' | 'videoUrl' | 'features' | 'requirements' | 'customFields' | 'deliveryNote' | 'termsOfService' | 'warrantyText' | 'deliveryType' | 'deliveryPayload' | 'revokePayload';
 export interface ListProductsParams {
     status?: ProductStatus | 'all';
+    limit?: number;
+    offset?: number;
 }
 interface ProductFields {
     slug?: string;
@@ -255,6 +278,8 @@ interface ProductFields {
     deliveryType?: DeliveryType;
     /** Required for a server store; needs a placeholder such as {steamhex}. */
     deliveryPayload?: string;
+    revokePayload?: string;
+    coinConfig?: CoinConfigInput;
     visibility?: ProductVisibility;
     sortPriority?: number;
     /** null or an empty string clears it. */
@@ -279,7 +304,7 @@ export interface CreateProductParams extends ProductFields {
     name: string;
     price: number;
     comparePrice?: number;
-    productType?: 'ONE_TIME' | 'RECURRING';
+    productType?: 'ONE_TIME' | 'RECURRING' | 'COINS';
     submit?: boolean;
 }
 export interface UpdateProductParams extends ProductFields {
@@ -799,6 +824,16 @@ export interface OrderRefundedData {
     granted?: boolean;
     fullRefund: boolean;
     licenses: Array<WebhookLicense>;
+    revocations: Array<Revocation>;
+}
+export interface Revocation {
+    productId: string;
+    productSlug: string;
+    productName: string;
+    deliveryKey: string;
+    delivered: boolean;
+    deliveryType: DeliveryType;
+    revokeCommand: string;
 }
 export interface OrderDisputedData {
     orderId: string;
@@ -914,6 +949,7 @@ export type SkalpEvent = Envelope<'order.created' | 'order.updated' | 'order.can
 }> | Envelope<'subscription.canceled', SubscriptionEventData & {
     endedAt: string | null;
     cancelReason: 'requested' | 'payment_failure' | 'dispute' | 'stripe';
+    revokeCommand?: string;
 }> | Envelope<'subscription.refunded', SubscriptionEventData & {
     invoiceId: string;
     amountRefunded: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skalpgg/sdk",
-  "version": "1.4.0",
+  "version": "1.5.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",