@skalpgg/sdk 1.1.0 → 1.4.0

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
-import type { ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CreateCheckoutParams, CreateSubscriptionCheckoutParams, HeartbeatParams, Invoice, LicenseVerification, ListSubscriptionsParams, Order, Product, SkalpEvent, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, 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, 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.1.0";
+export declare const VERSION = "1.4.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -32,14 +32,80 @@ export declare class Skalp {
     #private;
     constructor(options?: string | SkalpOptions);
     readonly checkout: {
-        create: ({ productId, customerEmail, metadata, couponCode, returnUrl }: CreateCheckoutParams) => Promise<CheckoutSession>;
+        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields }: CreateCheckoutParams) => Promise<CheckoutSession>;
         get: (id: string) => Promise<CheckoutSessionStatus>;
     };
     readonly orders: {
+        list: ({ status, productId, email, createdAfter, createdBefore, updatedSince, limit, offset }?: ListOrdersParams) => Promise<OrderList>;
         get: (id: string) => Promise<Order>;
+        cancel: (id: string) => Promise<Order>;
+        replace: (id: string, { serialIds, values, reason }?: ReplaceOrderKeysParams) => Promise<OrderKeysReplaced>;
     };
     readonly products: {
-        list: () => Promise<Product[]>;
+        list: ({ status }?: ListProductsParams) => Promise<Product[]>;
+        get: (idOrSlug: string) => Promise<Product>;
+        create: (params: CreateProductParams) => Promise<Product>;
+        update: (idOrSlug: string, params: UpdateProductParams) => Promise<Product>;
+        archive: (idOrSlug: string) => Promise<Product>;
+        submit: (idOrSlug: string) => Promise<Product>;
+        stock: (idOrSlug: string) => Promise<ProductStock>;
+        listSerials: (idOrSlug: string, { status, limit, offset }?: ListSerialsParams) => Promise<SerialList>;
+        addSerials: (idOrSlug: string, { serials, text, delimiter }: AddSerialsParams) => Promise<AddSerialsResult>;
+        deleteSerial: (idOrSlug: string, serialId: string) => Promise<Deleted>;
+    };
+    readonly categories: {
+        list: () => Promise<StoreCategoryWithCount[]>;
+        create: ({ name }: CreateStoreCategoryParams) => Promise<StoreCategory>;
+        update: (id: string, { name, sortOrder }: UpdateStoreCategoryParams) => Promise<StoreCategory>;
+        delete: (id: string) => Promise<Deleted>;
+    };
+    readonly groups: {
+        list: () => Promise<ProductGroup[]>;
+        get: (id: string) => Promise<ProductGroup>;
+        create: (params: CreateProductGroupParams) => Promise<ProductGroup>;
+        update: (id: string, params: UpdateProductGroupParams) => Promise<ProductGroup>;
+        delete: (id: string) => Promise<Deleted>;
+    };
+    readonly coupons: {
+        list: () => Promise<Coupon[]>;
+        get: (id: string) => Promise<Coupon>;
+        create: (params: CreateCouponParams) => Promise<Coupon>;
+        update: (id: string, params: UpdateCouponParams) => Promise<Coupon>;
+        delete: (id: string) => Promise<Deleted>;
+    };
+    readonly customers: {
+        list: ({ search, limit, offset }?: ListCustomersParams) => Promise<CustomerList>;
+        get: (id: string) => Promise<CustomerDetails>;
+        create: ({ email, name, note }: CreateCustomerParams) => Promise<Customer>;
+        update: (id: string, { name, note }: UpdateCustomerParams) => Promise<Customer>;
+        delete: (id: string) => Promise<Deleted>;
+    };
+    readonly feedback: {
+        list: ({ productId, rating, limit, offset }?: ListFeedbackParams) => Promise<FeedbackList>;
+        get: (id: string) => Promise<Feedback>;
+        reply: (id: string, { message }: ReplyParams) => Promise<Feedback>;
+        appeal: (id: string, { reason }: AppealFeedbackParams) => Promise<Feedback>;
+    };
+    readonly queries: {
+        list: ({ status, limit, offset }?: ListQueriesParams) => Promise<SupportQueryList>;
+        get: (id: string) => Promise<SupportQueryDetails>;
+        reply: (id: string, { message }: ReplyParams) => Promise<SupportQueryDetails>;
+        close: (id: string) => Promise<SupportQueryDetails>;
+        reopen: (id: string) => Promise<SupportQueryDetails>;
+    };
+    readonly blacklist: {
+        list: ({ type }?: ListAccessRulesParams) => Promise<AccessRule[]>;
+        add: ({ type, value, note }: AddAccessRuleParams) => Promise<AccessRule>;
+        remove: (id: string) => Promise<Deleted>;
+    };
+    readonly whitelist: {
+        list: ({ type }?: ListAccessRulesParams) => Promise<AccessRule[]>;
+        add: ({ type, value, note }: AddAccessRuleParams) => Promise<AccessRule>;
+        remove: (id: string) => Promise<Deleted>;
+    };
+    readonly coins: {
+        createCheckout: ({ steamHex, coins, idempotencyKey, returnUrl }: CreateCoinCheckoutParams) => Promise<CoinCheckout>;
+        getCheckoutStatus: (reference: string) => Promise<CoinCheckoutStatus>;
     };
     readonly subscriptions: {
         createCheckout: ({ productId, productSlug, customerEmail, externalRef, metadata, currency, returnUrl, }: CreateSubscriptionCheckoutParams) => Promise<SubscriptionCheckout>;
@@ -48,6 +114,7 @@ export declare class Skalp {
         get: (id: string) => Promise<Subscription>;
         changePlan: (id: string, { productId, productSlug }: ChangeSubscriptionPlanParams) => Promise<Subscription>;
         cancel: (id: string) => Promise<Subscription>;
+        createUsageCharge: (id: string, { amount, currency, description, idempotencyKey, periodStart, periodEnd }: CreateUsageChargeParams) => Promise<UsageCharge>;
         listInvoices: (id: string) => Promise<Invoice[]>;
     };
     readonly licenses: {
@@ -55,6 +122,10 @@ export declare class Skalp {
         heartbeat: ({ licenseKey, serverIp }: HeartbeatParams) => Promise<{
             valid: boolean;
         }>;
+        validate: ({ key, productId, hardwareId }: ValidateLicenseParams) => Promise<LicenseValidation>;
+        resetDevices: ({ key, hardwareId }: ResetLicenseDevicesParams) => Promise<{
+            license: LicenseKeyInfo;
+        }>;
     };
     readonly webhooks: {
         verify: (payload: WebhookPayload, signature: SignatureSource, secret?: string) => Promise<boolean>;

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-export const VERSION = '1.1.0';
+export const VERSION = '1.4.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
 const USER_AGENT = `skalp-node/${VERSION}`;
@@ -34,6 +34,49 @@ export class SkalpSignatureError extends Error {
 }
 const env = (name) => globalThis.process?.env?.[name];
 const segment = (id) => encodeURIComponent(id);
+const isoDate = (value) => (value instanceof Date ? value.toISOString() : value);
+const optionalDate = (value) => value instanceof Date ? value.toISOString() : value;
+const PRODUCT_FIELDS = [
+    'name',
+    'slug',
+    'description',
+    'shortDescription',
+    'price',
+    'comparePrice',
+    'category',
+    'categoryId',
+    'storeCategoryId',
+    'tags',
+    'images',
+    'videoUrl',
+    'fulfillmentType',
+    'billingInterval',
+    'trialPeriodDays',
+    'dynamicUrl',
+    'licenseDeviceLimit',
+    'licenseDurationDays',
+];
+const COUPON_FIELDS = [
+    'discountType',
+    'discountPercent',
+    'discountAmount',
+    'productIds',
+    'disabledWithVolumeDiscounts',
+    'description',
+    'maxUses',
+    'minPurchaseAmount',
+    'oneTimePerUser',
+];
+const GROUP_FIELDS = ['title', 'productIds', 'description', 'image', 'sortPriority', 'unlisted'];
+function pick(source, keys) {
+    const picked = {};
+    for (const key of keys) {
+        const value = source[key];
+        if (value !== undefined)
+            picked[key] = value;
+    }
+    return picked;
+}
 export class Skalp {
     #apiKey;
     #webhookSecret;
@@ -54,16 +97,116 @@ export class Skalp {
         }
     }
     checkout = {
-        create: ({ productId, customerEmail, metadata, couponCode, returnUrl }) => this.#request('POST', '/v1/checkout/sessions', {
-            body: { items: [{ productId, quantity: 1 }], customerEmail, metadata, couponCode, returnUrl },
+        create: ({ productId, quantity, customerEmail, metadata, couponCode, returnUrl, customFields }) => this.#request('POST', '/v1/checkout/sessions', {
+            body: { items: [{ productId, quantity }], customerEmail, metadata, couponCode, returnUrl, customFields },
         }),
         get: (id) => this.#request('GET', `/v1/checkout/sessions/${segment(id)}`),
     };
     orders = {
+        list: ({ status, productId, email, createdAfter, createdBefore, updatedSince, limit, offset } = {}) => this.#request('GET', '/v1/orders', {
+            query: {
+                status,
+                productId,
+                email,
+                createdAfter: optionalDate(createdAfter),
+                createdBefore: optionalDate(createdBefore),
+                updatedSince: optionalDate(updatedSince),
+                limit,
+                offset,
+            },
+        }),
         get: (id) => this.#request('GET', `/v1/orders/${segment(id)}`),
+        cancel: (id) => this.#request('POST', `/v1/orders/${segment(id)}/cancel`),
+        replace: (id, { serialIds, values, reason } = {}) => this.#request('POST', `/v1/orders/${segment(id)}/replacement`, {
+            body: { serialIds, values, reason },
+        }),
     };
     products = {
-        list: () => this.#request('GET', '/v1/products'),
+        list: ({ status } = {}) => this.#request('GET', '/v1/products', { query: { status } }),
+        get: (idOrSlug) => this.#request('GET', `/v1/products/${segment(idOrSlug)}`),
+        create: (params) => this.#request('POST', '/v1/products', {
+            body: pick(params, [...PRODUCT_FIELDS, 'productType', 'submit']),
+        }),
+        update: (idOrSlug, params) => this.#request('PATCH', `/v1/products/${segment(idOrSlug)}`, {
+            body: pick(params, [...PRODUCT_FIELDS, 'status']),
+        }),
+        archive: (idOrSlug) => this.#request('DELETE', `/v1/products/${segment(idOrSlug)}`),
+        submit: (idOrSlug) => this.#request('POST', `/v1/products/${segment(idOrSlug)}/submit`),
+        stock: (idOrSlug) => this.#request('GET', `/v1/products/${segment(idOrSlug)}/stock`),
+        listSerials: (idOrSlug, { status, limit, offset } = {}) => this.#request('GET', `/v1/products/${segment(idOrSlug)}/serials`, {
+            query: { status, limit, offset },
+        }),
+        addSerials: (idOrSlug, { serials, text, delimiter }) => this.#request('POST', `/v1/products/${segment(idOrSlug)}/serials`, {
+            body: { serials, text, delimiter },
+        }),
+        deleteSerial: (idOrSlug, serialId) => this.#request('DELETE', `/v1/products/${segment(idOrSlug)}/serials/${segment(serialId)}`),
+    };
+    categories = {
+        list: () => this.#request('GET', '/v1/categories'),
+        create: ({ name }) => this.#request('POST', '/v1/categories', { body: { name } }),
+        update: (id, { name, sortOrder }) => this.#request('PATCH', `/v1/categories/${segment(id)}`, { body: { name, sortOrder } }),
+        delete: (id) => this.#request('DELETE', `/v1/categories/${segment(id)}`),
+    };
+    groups = {
+        list: () => this.#request('GET', '/v1/groups'),
+        get: (id) => this.#request('GET', `/v1/groups/${segment(id)}`),
+        create: (params) => this.#request('POST', '/v1/groups', { body: pick(params, GROUP_FIELDS) }),
+        update: (id, params) => this.#request('PATCH', `/v1/groups/${segment(id)}`, { body: pick(params, GROUP_FIELDS) }),
+        delete: (id) => this.#request('DELETE', `/v1/groups/${segment(id)}`),
+    };
+    coupons = {
+        list: () => this.#request('GET', '/v1/coupons'),
+        get: (id) => this.#request('GET', `/v1/coupons/${segment(id)}`),
+        create: (params) => this.#request('POST', '/v1/coupons', {
+            body: {
+                ...pick(params, [...COUPON_FIELDS, 'code']),
+                validFrom: optionalDate(params.validFrom),
+                validTo: optionalDate(params.validTo),
+            },
+        }),
+        update: (id, params) => this.#request('PATCH', `/v1/coupons/${segment(id)}`, {
+            body: {
+                ...pick(params, [...COUPON_FIELDS, 'isActive']),
+                validFrom: optionalDate(params.validFrom),
+                validTo: optionalDate(params.validTo),
+            },
+        }),
+        delete: (id) => this.#request('DELETE', `/v1/coupons/${segment(id)}`),
+    };
+    customers = {
+        list: ({ search, limit, offset } = {}) => this.#request('GET', '/v1/customers', { query: { search, limit, offset } }),
+        get: (id) => this.#request('GET', `/v1/customers/${segment(id)}`),
+        create: ({ email, name, note }) => this.#request('POST', '/v1/customers', { body: { email, name, note } }),
+        update: (id, { name, note }) => this.#request('PATCH', `/v1/customers/${segment(id)}`, { body: { name, note } }),
+        delete: (id) => this.#request('DELETE', `/v1/customers/${segment(id)}`),
+    };
+    feedback = {
+        list: ({ productId, rating, limit, offset } = {}) => this.#request('GET', '/v1/feedback', { query: { productId, rating, limit, offset } }),
+        get: (id) => this.#request('GET', `/v1/feedback/${segment(id)}`),
+        reply: (id, { message }) => this.#request('POST', `/v1/feedback/${segment(id)}/reply`, { body: { message } }),
+        appeal: (id, { reason }) => this.#request('POST', `/v1/feedback/${segment(id)}/appeal`, { body: { reason } }),
+    };
+    queries = {
+        list: ({ status, limit, offset } = {}) => this.#request('GET', '/v1/queries', { query: { status, limit, offset } }),
+        get: (id) => this.#request('GET', `/v1/queries/${segment(id)}`),
+        reply: (id, { message }) => this.#request('POST', `/v1/queries/${segment(id)}/reply`, { body: { message } }),
+        close: (id) => this.#request('POST', `/v1/queries/${segment(id)}/close`),
+        reopen: (id) => this.#request('POST', `/v1/queries/${segment(id)}/reopen`),
+    };
+    blacklist = this.#accessRules('blacklist');
+    whitelist = this.#accessRules('whitelist');
+    #accessRules(list) {
+        return {
+            list: ({ type } = {}) => this.#request('GET', `/v1/${list}`, { query: { type } }),
+            add: ({ type, value, note }) => this.#request('POST', `/v1/${list}`, { body: { type, value, note } }),
+            remove: (id) => this.#request('DELETE', `/v1/${list}/${segment(id)}`),
+        };
+    }
+    coins = {
+        createCheckout: ({ steamHex, coins, idempotencyKey, returnUrl }) => this.#request('POST', '/coins/checkout', {
+            body: { steamHex, coins, idempotencyKey, returnUrl },
+        }),
+        getCheckoutStatus: (reference) => this.#request('GET', `/coins/checkout/${segment(reference)}/status`),
     };
     subscriptions = {
         createCheckout: ({ productId, productSlug, customerEmail, externalRef, metadata, currency, returnUrl, }) => this.#request('POST', '/v1/subscriptions/checkout', {
@@ -84,6 +227,16 @@ export class Skalp {
             body: { productId, productSlug },
         }),
         cancel: (id) => this.#request('DELETE', `/v1/subscriptions/${segment(id)}`),
+        createUsageCharge: (id, { amount, currency, description, idempotencyKey, periodStart, periodEnd }) => this.#request('POST', `/v1/subscriptions/${segment(id)}/usage-charges`, {
+            body: {
+                amount,
+                currency,
+                description,
+                idempotencyKey,
+                periodStart: isoDate(periodStart),
+                periodEnd: isoDate(periodEnd),
+            },
+        }),
         listInvoices: (id) => this.#request('GET', `/v1/subscriptions/${segment(id)}/invoices`).then((r) => r.data),
     };
     licenses = {
@@ -95,6 +248,16 @@ export class Skalp {
             body: { licenseKey, serverIp },
             auth: false,
         }),
+        // Keys sold with the "License key" delivery. Needs the licenses:validate
+        // scope; a key with only that scope may ship inside your app.
+        validate: ({ key, productId, hardwareId }) => this.#request('POST', '/v1/licenses/validate', {
+            body: { key, productId, hardwareId },
+        }),
+        // Frees the machines a key is bound to. Needs licenses:write; call it
+        // from your server only.
+        resetDevices: ({ key, hardwareId }) => this.#request('POST', '/v1/licenses/devices/reset', {
+            body: { key, hardwareId },
+        }),
     };
     webhooks = {
         verify: async (payload, signature, secret) => (await this.#checkSignature(payload, signature, secret)) === undefined,