@mpgd/platform 0.20.0 → 0.21.0

package/dist/commerce.d.ts

@@ -1,6 +1,6 @@
 import { type tags } from 'typia';
 import { PlatformOperationError, type CommerceAdapter, type CommerceCapabilities } from './index.js';
-import type { ActiveSubscription, CommerceErrorCode, CommerceErrorInfo, CommerceEvent, CommerceLogicalProductId, CommerceProvider, FetchProductsInput, FinishTransactionInput, FinishTransactionResult, GetAvailablePurchasesInput, IsoTimestamp, NonEmptyString, NonNegativeInteger, PurchaseKind, RequestPurchaseInput, RequestPurchaseResult, StoreId, StoreProduct, StorePurchase } from './commerce-contract.js';
+import type { ActiveSubscription, CommerceErrorCode, CommerceErrorInfo, CommerceEvent, CommerceLogicalProductId, CommerceProvider, FetchProductsInput, FinishTransactionInput, FinishTransactionResult, GetAvailablePurchasesInput, IsoTimestamp, NonEmptyString, NonNegativeInteger, PositiveQuantity, PurchaseKind, RequestPurchaseInput, RequestPurchaseResult, StoreId, StoreProduct, StorePurchase } from './commerce-contract.js';
 export { createUnsupportedCommerceCapabilities, deriveLegacyCommerceCapabilities, type LegacyCommerceCapabilities, } from './commerce-capabilities.js';
 export type { CommerceAccountBindingPolicy, CommerceAuthorityCapabilities, CommerceCapabilities, CommerceCatalogCapabilities, CommerceEvidenceAuthority, CommerceFinishOwner, CommerceLifecycleCapabilities, CommercePurchaseCapabilities, } from './index.js';
 /**
@@ -46,6 +46,12 @@ export interface CreditSpendInput {
   readonly currency: NonEmptyString;
   readonly amount: number & tags.ExclusiveMinimum<0>;
   readonly idempotencyKey: NonEmptyString;
+  /**
+  * The offer being bought; the wallet prices the spend against it and issues
+  * an entitlement. Without it the spend is a plain debit of `amount` with no
+  * entitlement, an owner-side form the conformance vectors use; a wallet
+  * service should require it from game clients.
+  */
   readonly logicalId?: CommerceLogicalProductId;
 }
 export interface CreditDebit {
@@ -56,6 +62,8 @@ export type CreditSpendResult = {
   readonly status: 'debited';
   readonly entitlementId: NonEmptyString;
   readonly debits: readonly CreditDebit[];
+  /** When the wallet settled the spend; a replay repeats the original time. */
+  readonly createdAt?: IsoTimestamp;
   /** A repeated idempotency key returns the original debits. */
   readonly alreadyProcessed?: boolean;
 } | {
@@ -69,6 +77,8 @@ export interface CreditEntitlement {
   readonly idempotencyKey: NonEmptyString;
   readonly createdAt: IsoTimestamp;
   readonly debits: readonly CreditDebit[];
+  /** Units bought at spend time; the provider reports it rather than deriving one from today's price. */
+  readonly quantity?: PositiveQuantity;
 }
 export interface CreditBalance {
   readonly titleId: NonEmptyString;
@@ -99,6 +109,13 @@ export interface CreditLot {
   /** Derived from the origin, never supplied by the caller. */
   readonly spendScope: CreditLotSpendScope;
 }
+/**
+* The client a consuming project implements against its wallet service.
+* `createCreditCommerceProvider` (`@mpgd/platform/commerce-wallet`) turns it
+* into a `CommerceProvider`. A `spend` of a membership offer starts the
+* membership under the spend's idempotency key as its subscription id; the
+* wallet service alone renews, lapses, and expires it.
+*/
 export interface CreditWalletClient {
   readonly store: StoreId;
   listOffers(input: {
@@ -108,6 +125,7 @@ export interface CreditWalletClient {
   listUnredeemed(input: {
     readonly titleId: string;
   }): Promise<readonly CreditEntitlement[]>;
+  /** Redeems an entitlement for the ledger entry that granted it; the wallet service verifies the pair. */
   redeem(input: {
     readonly entitlementId: string;
     readonly ledgerEntryId: string;
@@ -117,7 +135,15 @@ export interface CreditWalletClient {
   getBalance(input: {
     readonly titleId: string;
   }): Promise<CreditBalance>;
-  subscribe?(listener: (event: CommerceEvent) => void): () => void;
+  /** Memberships the wallet service reports as active for the title; absent when the wallet sells none. */
+  getActiveSubscriptions?(input: {
+    readonly titleId: string;
+  }): Promise<readonly ActiveSubscription[]>;
+  /** With `input.titleId`, only events that concern that title (platform memberships concern every title). */
+  subscribe?(listener: (event: CommerceEvent) => void, input?: CreditWalletSubscribeInput): () => void;
+}
+export interface CreditWalletSubscribeInput {
+  readonly titleId?: string;
 }
 export interface CommerceBridgeGetCapabilitiesPayload {
   readonly protocol: typeof commerceProtocol;

package/dist/commerce.js

@@ -3650,7 +3650,7 @@ export const assertCreditSpendInput = (() => {
 })();
 export const assertCreditSpendResult = (() => {
     const _iv0 = new Set(["ACCOUNT_BINDING_REQUIRED", "ACTION_REQUIRED", "ALREADY_OWNED", "CONFIGURATION_REQUIRED", "INSUFFICIENT_BALANCE", "INVALID_RESPONSE", "IN_PROGRESS", "ITEM_UNAVAILABLE", "NETWORK", "NOT_PREPARED", "OUTCOME_UNKNOWN", "STORE_UNAVAILABLE", "UNKNOWN", "USER_CANCELLED"]);
-    const _ae0 = "({ readonly status: \"debited\"; readonly entitlementId: NonEmptyString; readonly debits: readonly CreditDebit[]; readonly alreadyProcessed?: boolean; } | { readonly status: \"rejected\"; readonly error: CommerceErrorInfo; })";
+    const _ae0 = "({ readonly status: \"debited\"; readonly entitlementId: NonEmptyString; readonly debits: readonly CreditDebit[]; readonly createdAt?: IsoTimestamp; readonly alreadyProcessed?: boolean; } | { readonly status: \"rejected\"; readonly error: CommerceErrorInfo; })";
     const _av0 = new Set(["ACCOUNT_BINDING_REQUIRED", "ACTION_REQUIRED", "ALREADY_OWNED", "CONFIGURATION_REQUIRED", "INSUFFICIENT_BALANCE", "INVALID_RESPONSE", "IN_PROGRESS", "ITEM_UNAVAILABLE", "NETWORK", "NOT_PREPARED", "OUTCOME_UNKNOWN", "STORE_UNAVAILABLE", "UNKNOWN", "USER_CANCELLED"]);
     const _ae1 = "(\"ACCOUNT_BINDING_REQUIRED\" | \"ACTION_REQUIRED\" | \"ALREADY_OWNED\" | \"CONFIGURATION_REQUIRED\" | \"INSUFFICIENT_BALANCE\" | \"INVALID_RESPONSE\" | \"IN_PROGRESS\" | \"ITEM_UNAVAILABLE\" | \"NETWORK\" | \"NOT_PREPARED\" | \"OUTCOME_UNKNOWN\" | \"STORE_UNAVAILABLE\" | \"UNKNOWN\" | \"USER_CANCELLED\")";
     const _ao0 = (input, _path, _exceptionable = true) => ("debited" === input.status || _assertGuard_1._assertGuard(_exceptionable, {
@@ -3688,13 +3688,23 @@ export const assertCreditSpendResult = (() => {
         path: _path + ".debits",
         expected: "ReadonlyArray<CreditDebit>",
         value: input.debits
+    }, _errorFactory)) && (undefined === input.createdAt || "string" === typeof input.createdAt && (_isFormatDateTime_1._isFormatDateTime(input.createdAt) || _assertGuard_1._assertGuard(_exceptionable, {
+        method: "typia.createAssertEquals",
+        path: _path + ".createdAt",
+        expected: "string & CommerceDateTimeFormat",
+        value: input.createdAt
+    }, _errorFactory)) || _assertGuard_1._assertGuard(_exceptionable, {
+        method: "typia.createAssertEquals",
+        path: _path + ".createdAt",
+        expected: "((string & CommerceDateTimeFormat) | undefined)",
+        value: input.createdAt
     }, _errorFactory)) && (undefined === input.alreadyProcessed || "boolean" === typeof input.alreadyProcessed || _assertGuard_1._assertGuard(_exceptionable, {
         method: "typia.createAssertEquals",
         path: _path + ".alreadyProcessed",
         expected: "(boolean | undefined)",
         value: input.alreadyProcessed
     }, _errorFactory)) && (3 === Object.keys(input).length || (false === _exceptionable || Object.keys(input).every(key => {
-        if (["status", "entitlementId", "debits", "alreadyProcessed"].some(prop => key === prop))
+        if (["status", "entitlementId", "debits", "createdAt", "alreadyProcessed"].some(prop => key === prop))
             return true;
         const value = input[key];
         if (undefined === value)
@@ -3813,8 +3823,8 @@ export const assertCreditSpendResult = (() => {
                 value: input
             }, _errorFactory);
     })();
-    const _io0 = (input, _exceptionable = true) => "debited" === input.status && ("string" === typeof input.entitlementId && 1 <= input.entitlementId.length) && (Array.isArray(input.debits) && input.debits.every((elem, _index1) => "object" === typeof elem && null !== elem && _io1(elem, true && _exceptionable))) && (undefined === input.alreadyProcessed || "boolean" === typeof input.alreadyProcessed) && (3 === Object.keys(input).length || Object.keys(input).every(key => {
-        if (["status", "entitlementId", "debits", "alreadyProcessed"].some(prop => key === prop))
+    const _io0 = (input, _exceptionable = true) => "debited" === input.status && ("string" === typeof input.entitlementId && 1 <= input.entitlementId.length) && (Array.isArray(input.debits) && input.debits.every((elem, _index1) => "object" === typeof elem && null !== elem && _io1(elem, true && _exceptionable))) && (undefined === input.createdAt || "string" === typeof input.createdAt && _isFormatDateTime_1._isFormatDateTime(input.createdAt)) && (undefined === input.alreadyProcessed || "boolean" === typeof input.alreadyProcessed) && (3 === Object.keys(input).length || Object.keys(input).every(key => {
+        if (["status", "entitlementId", "debits", "createdAt", "alreadyProcessed"].some(prop => key === prop))
             return true;
         const value = input[key];
         if (undefined === value)
@@ -3944,8 +3954,23 @@ export const assertCreditEntitlement = (() => {
         path: _path + ".debits",
         expected: "ReadonlyArray<CreditDebit>",
         value: input.debits
+    }, _errorFactory)) && (undefined === input.quantity || "number" === typeof input.quantity && (_isTypeUint32_1._isTypeUint32(input.quantity) || _assertGuard_1._assertGuard(_exceptionable, {
+        method: "typia.createAssertEquals",
+        path: _path + ".quantity",
+        expected: "number & CommerceUint32",
+        value: input.quantity
+    }, _errorFactory)) && (1 <= input.quantity || _assertGuard_1._assertGuard(_exceptionable, {
+        method: "typia.createAssertEquals",
+        path: _path + ".quantity",
+        expected: "number & CommerceMinimum<1>",
+        value: input.quantity
+    }, _errorFactory)) || _assertGuard_1._assertGuard(_exceptionable, {
+        method: "typia.createAssertEquals",
+        path: _path + ".quantity",
+        expected: "((number & CommerceUint32 & CommerceMinimum<1>) | undefined)",
+        value: input.quantity
     }, _errorFactory)) && (6 === Object.keys(input).length || (false === _exceptionable || Object.keys(input).every(key => {
-        if (["entitlementId", "titleId", "logicalId", "idempotencyKey", "createdAt", "debits"].some(prop => key === prop))
+        if (["entitlementId", "titleId", "logicalId", "idempotencyKey", "createdAt", "debits", "quantity"].some(prop => key === prop))
             return true;
         const value = input[key];
         if (undefined === value)
@@ -3990,8 +4015,8 @@ export const assertCreditEntitlement = (() => {
             value: value
         }, _errorFactory);
     })));
-    const _io0 = (input, _exceptionable = true) => "string" === typeof input.entitlementId && 1 <= input.entitlementId.length && ("string" === typeof input.titleId && 1 <= input.titleId.length) && ("string" === typeof input.logicalId && 1 <= input.logicalId.length) && ("string" === typeof input.idempotencyKey && 1 <= input.idempotencyKey.length) && ("string" === typeof input.createdAt && _isFormatDateTime_1._isFormatDateTime(input.createdAt)) && (Array.isArray(input.debits) && input.debits.every((elem, _index1) => "object" === typeof elem && null !== elem && _io1(elem, true && _exceptionable))) && (6 === Object.keys(input).length || Object.keys(input).every(key => {
-        if (["entitlementId", "titleId", "logicalId", "idempotencyKey", "createdAt", "debits"].some(prop => key === prop))
+    const _io0 = (input, _exceptionable = true) => "string" === typeof input.entitlementId && 1 <= input.entitlementId.length && ("string" === typeof input.titleId && 1 <= input.titleId.length) && ("string" === typeof input.logicalId && 1 <= input.logicalId.length) && ("string" === typeof input.idempotencyKey && 1 <= input.idempotencyKey.length) && ("string" === typeof input.createdAt && _isFormatDateTime_1._isFormatDateTime(input.createdAt)) && (Array.isArray(input.debits) && input.debits.every((elem, _index1) => "object" === typeof elem && null !== elem && _io1(elem, true && _exceptionable))) && (undefined === input.quantity || "number" === typeof input.quantity && (_isTypeUint32_1._isTypeUint32(input.quantity) && 1 <= input.quantity)) && (6 === Object.keys(input).length || Object.keys(input).every(key => {
+        if (["entitlementId", "titleId", "logicalId", "idempotencyKey", "createdAt", "debits", "quantity"].some(prop => key === prop))
             return true;
         const value = input[key];
         if (undefined === value)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/platform",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Shared platform gateway, monetization, ads, leaderboard, identity, lifecycle, and storage contracts for mpgd games.",
   "license": "MIT",
   "repository": {
@@ -56,6 +56,10 @@
     "./commerce-conformance": {
       "types": "./dist/commerce-conformance.d.ts",
       "default": "./dist/commerce-conformance.js"
+    },
+    "./commerce-wallet": {
+      "types": "./dist/commerce-wallet.d.ts",
+      "default": "./dist/commerce-wallet.js"
     }
   },
   "files": [
@@ -80,6 +84,6 @@
     "lint": "ttsc --noEmit",
     "format": "ttsc format",
     "fix": "ttsc fix",
-    "test": "vitest run && node test/capability-conformance-dist-import.mjs && node test/storage-conformance-dist-import.mjs && node test/ads-dist-import.mjs && node test/commerce-dist-import.mjs && node test/commerce-conformance-dist-import.mjs && cd ../.. && node tools/run-ttsx.mjs packages/platform/test/commerce-derived-key-parity.ts"
+    "test": "vitest run && node test/capability-conformance-dist-import.mjs && node test/storage-conformance-dist-import.mjs && node test/ads-dist-import.mjs && node test/commerce-dist-import.mjs && node test/commerce-conformance-dist-import.mjs && node test/wallet-commerce-dist-import.mjs && cd ../.. && node tools/run-ttsx.mjs packages/platform/test/commerce-derived-key-parity.ts"
   }
 }