@mpgd/adapter-devvit 0.10.0 → 0.11.0

package/dist/catalog-products.d.ts

@@ -0,0 +1,49 @@
+import type { ProductInfo, ProductType } from '@mpgd/platform';
+import { type DevvitCommerceProduct } from './payments.js';
+/** The catalog target whose `platformProductIds` entry is the Devvit SKU. */
+export declare const defaultDevvitCatalogTarget = "reddit";
+/**
+* The product catalog fields this module reads (`ProductCatalog` from
+* `@mpgd/catalog` fits). Structural so the adapter adds no catalog dependency.
+*/
+export interface DevvitCatalogProductLike {
+  readonly id: string;
+  readonly type: ProductType;
+  readonly platformProductIds: Readonly<Partial<Record<string, string>>>;
+}
+export interface DevvitCatalogLike {
+  readonly products: readonly DevvitCatalogProductLike[];
+}
+/** A logical product paired with its Devvit SKU, as the server bridge handler takes it. */
+export interface DevvitCatalogBridgeProduct {
+  readonly productId: string;
+  readonly sku: string;
+}
+export interface CreateDevvitCommerceProductsOptions {
+  /** Defaults to `reddit`. */
+  readonly target?: string;
+  /**
+  * Static product info for the webview provider's `fetchProducts`. Devvit
+  * prices live products in Reddit Gold on the server (`payments.getProducts`),
+  * so the default lists the logical id as title with a Reddit Gold price
+  * placeholder; a game that wants localized copy supplies its own.
+  */
+  readonly describe?: (product: DevvitCatalogProductLike, sku: string) => Pick<ProductInfo, 'title' | 'description' | 'price'>;
+}
+/**
+* The `{ productId, sku }` pairs `createDevvitCommerceV2BridgeHandler` takes,
+* read from the catalog's `platformProductIds[target]` entries. The catalog is
+* the single source of the Devvit SKUs and its rules apply, as
+* `resolveProductPlatformId` reads them: the SKU is trimmed, and a product
+* without an entry, or with a blank one, is not sold on Reddit. A subscription
+* is skipped because Devvit sells one-time goods only. Duplicate product ids
+* and SKUs are rejected.
+*/
+export declare function createDevvitCommerceBridgeProducts(catalog: DevvitCatalogLike, target?: string): readonly DevvitCatalogBridgeProduct[];
+/**
+* The webview products for `createDevvitPlatformGateway({ commerce: { products } })`
+* and `createDevvitCommerceAdapter`, derived from the same catalog entries as
+* `createDevvitCommerceBridgeProducts`, so the webview and the server agree on
+* every SKU.
+*/
+export declare function createDevvitCommerceProducts(catalog: DevvitCatalogLike, options?: CreateDevvitCommerceProductsOptions): readonly DevvitCommerceProduct[];

package/dist/catalog-products.js

@@ -0,0 +1,79 @@
+import { normalizeDevvitCommerceProducts } from './payments.js';
+/** The catalog target whose `platformProductIds` entry is the Devvit SKU. */
+export const defaultDevvitCatalogTarget = 'reddit';
+/**
+ * The `{ productId, sku }` pairs `createDevvitCommerceV2BridgeHandler` takes,
+ * read from the catalog's `platformProductIds[target]` entries. The catalog is
+ * the single source of the Devvit SKUs and its rules apply, as
+ * `resolveProductPlatformId` reads them: the SKU is trimmed, and a product
+ * without an entry, or with a blank one, is not sold on Reddit. A subscription
+ * is skipped because Devvit sells one-time goods only. Duplicate product ids
+ * and SKUs are rejected.
+ */
+export function createDevvitCommerceBridgeProducts(catalog, target = defaultDevvitCatalogTarget) {
+    const skus = new Set();
+    const productIds = new Set();
+    const products = [];
+    for (const product of catalog.products) {
+        const sku = readSku(product, target);
+        if (sku === undefined || product.type === 'subscription') {
+            continue;
+        }
+        if (productIds.has(product.id)) {
+            throw new TypeError(`Duplicate Devvit logical product ID: ${product.id}`);
+        }
+        if (skus.has(sku)) {
+            throw new TypeError(`Duplicate Devvit product SKU: ${sku}`);
+        }
+        productIds.add(product.id);
+        skus.add(sku);
+        products.push(Object.freeze({ productId: product.id, sku }));
+    }
+    return Object.freeze(products);
+}
+/**
+ * The webview products for `createDevvitPlatformGateway({ commerce: { products } })`
+ * and `createDevvitCommerceAdapter`, derived from the same catalog entries as
+ * `createDevvitCommerceBridgeProducts`, so the webview and the server agree on
+ * every SKU.
+ */
+export function createDevvitCommerceProducts(catalog, options = {}) {
+    const target = options.target ?? defaultDevvitCatalogTarget;
+    const describe = options.describe ?? describeDevvitProduct;
+    const bridgeProducts = createDevvitCommerceBridgeProducts(catalog, target);
+    const byId = new Map(catalog.products.map((product) => [product.id, product]));
+    return normalizeDevvitCommerceProducts(bridgeProducts.map((bridgeProduct) => {
+        const product = byId.get(bridgeProduct.productId);
+        if (product === undefined) {
+            throw new TypeError(`Devvit product ${bridgeProduct.productId} is missing from the catalog.`);
+        }
+        return {
+            info: {
+                id: product.id,
+                type: product.type,
+                ...describe(product, bridgeProduct.sku),
+            },
+            sku: bridgeProduct.sku,
+        };
+    }));
+}
+function describeDevvitProduct(product) {
+    return {
+        title: product.id,
+        description: '',
+        price: { formatted: 'Reddit Gold', currencyCode: 'GOLD' },
+    };
+}
+/** The catalog's reading of a platform id: own key only, trimmed, blank as unsold. */
+function readSku(product, target) {
+    const identifiers = product.platformProductIds;
+    if (!Object.prototype.hasOwnProperty.call(identifiers, target)) {
+        return undefined;
+    }
+    const value = identifiers[target];
+    if (typeof value !== 'string') {
+        return undefined;
+    }
+    const sku = value.trim();
+    return sku.length === 0 ? undefined : sku;
+}

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { type CreateDevvitCommerceProviderInput, type DevvitOrderSource } from '
 export * from './commerce-contract.js';
 export * from './commerce-provider.js';
 export * from './payments.js';
+export * from './catalog-products.js';
 export declare const defaultDevvitRpcEndpoint = "/api/mpgd/rpc";
 /** Bridge error of `createDevvitOrpcBridge` when the oRPC request itself failed. */
 export declare const devvitBridgeNetworkErrorCode: 'DEVVIT_BRIDGE_NETWORK_ERROR';

package/dist/index.js

@@ -7,6 +7,7 @@ import { createDevvitCommerceProvider, } from './commerce-provider.js';
 export * from './commerce-contract.js';
 export * from './commerce-provider.js';
 export * from './payments.js';
+export * from './catalog-products.js';
 export const defaultDevvitRpcEndpoint = defaultBridgeRpcEndpoint;
 /** Bridge error of `createDevvitOrpcBridge` when the oRPC request itself failed. */
 export const devvitBridgeNetworkErrorCode = 'DEVVIT_BRIDGE_NETWORK_ERROR';

package/dist/server/index.d.ts

@@ -1,4 +1,5 @@
 export * from './commerce-bridge.js';
+export { createDevvitCommerceBridgeProducts, defaultDevvitCatalogTarget, type DevvitCatalogBridgeProduct, type DevvitCatalogLike, type DevvitCatalogProductLike, } from '../catalog-products.js';
 export * from './payment-order.js';
 export * from './post-operation.js';
 export * from './redis-post-operation-store.js';

package/dist/server/index.js

@@ -1,4 +1,5 @@
 export * from './commerce-bridge.js';
+export { createDevvitCommerceBridgeProducts, defaultDevvitCatalogTarget, } from '../catalog-products.js';
 export * from './payment-order.js';
 export * from './post-operation.js';
 export * from './redis-post-operation-store.js';

package/dist/web.d.ts

@@ -1,4 +1,5 @@
 import type { ShareResult } from '@mpgd/platform';
+import type { DevvitCheckoutResult, DevvitPaymentsClient } from './payments.js';
 import { type DevvitSurfaceOptions, type DevvitSurfaceResult } from './surface.js';
 import { type DevvitPreviewViewModeOptions, type DevvitPreviewViewModeResult, type DevvitViewModeOptions, type DevvitViewModeResult } from './view-mode.js';
 export type { DevvitSurfaceClient, DevvitSurfaceMode, DevvitSurfaceOptions, DevvitSurfaceResult, } from './surface.js';
@@ -30,3 +31,30 @@ export declare function requestDevvitExpandedMode(event: MouseEvent, entry: stri
 * completed sharing. Devvit does not report a completion callback.
 */
 export declare function presentDevvitShareSheet(options: DevvitShareSheetOptions): Promise<ShareResult>;
+/** `OrderResultEvent` of `@devvit/payments/client`, as the webview reads it. */
+export interface DevvitOrderResultEventLike {
+  /** `OrderResultStatus`: 0 cancelled, 1 success, 2 error (or its name). */
+  readonly status: number | string;
+  readonly orderId?: string | undefined;
+  readonly errorCode?: number | undefined;
+  readonly errorMessage?: string | undefined;
+}
+/** The checkout half of `DevvitPaymentsClient`; the v2 provider needs nothing else. */
+export type DevvitWebPaymentsClient = Pick<DevvitPaymentsClient, 'purchase'>;
+/**
+* Maps one Reddit checkout answer to the adapter's `DevvitCheckoutResult`:
+* `STATUS_SUCCESS` with an order id is `completed` (the order id is Reddit's;
+* the backend ledger decides the grant), `STATUS_SUCCESS` without one is
+* `pending` so the reconciler resolves it from the paid-order list,
+* `STATUS_CANCELLED` is `cancelled`, and `STATUS_ERROR` is `failed` with the
+* platform code kept as `storeCode`. An unknown status is `pending`: an order
+* may exist and nothing is granted or dropped on the client.
+*/
+export declare function toDevvitCheckoutResult(event: DevvitOrderResultEventLike): DevvitCheckoutResult;
+/**
+* `purchase()` from `@devvit/payments/client` (re-exported by
+* `@devvit/web/client`) as the checkout client of `createDevvitPlatformGateway({
+* commerce: { client } })`. One SKU per checkout, no client metadata: Reddit's
+* order id is the only identity the purchase carries.
+*/
+export declare function createDevvitWebPaymentsClient(): DevvitWebPaymentsClient;

package/dist/web.js

@@ -65,3 +65,67 @@ function isAbortError(error) {
             && error !== null
             && error.name === 'AbortError';
 }
+const successStatuses = new Set([1, 'STATUS_SUCCESS', 'SUCCESS']);
+const cancelledStatuses = new Set([
+    0,
+    'STATUS_CANCELLED',
+    'CANCELLED',
+]);
+const errorStatuses = new Set([2, 'STATUS_ERROR', 'ERROR']);
+/**
+ * Maps one Reddit checkout answer to the adapter's `DevvitCheckoutResult`:
+ * `STATUS_SUCCESS` with an order id is `completed` (the order id is Reddit's;
+ * the backend ledger decides the grant), `STATUS_SUCCESS` without one is
+ * `pending` so the reconciler resolves it from the paid-order list,
+ * `STATUS_CANCELLED` is `cancelled`, and `STATUS_ERROR` is `failed` with the
+ * platform code kept as `storeCode`. An unknown status is `pending`: an order
+ * may exist and nothing is granted or dropped on the client.
+ */
+export function toDevvitCheckoutResult(event) {
+    const orderId = typeof event.orderId === 'string' && event.orderId.trim().length > 0
+        ? event.orderId.trim()
+        : undefined;
+    if (successStatuses.has(event.status)) {
+        return orderId === undefined ? { status: 'pending' } : { status: 'completed', orderId };
+    }
+    if (cancelledStatuses.has(event.status)) {
+        return {
+            status: 'cancelled',
+            ...(orderId === undefined ? {} : { orderId }),
+            error: { code: 'USER_CANCELLED', storeCode: 'DEVVIT_CHECKOUT_CANCELLED', retryable: false },
+        };
+    }
+    if (errorStatuses.has(event.status)) {
+        const storeCode = event.errorCode === undefined
+            ? 'DEVVIT_CHECKOUT_FAILED'
+            : String(event.errorCode);
+        return {
+            status: 'failed',
+            ...(orderId === undefined ? {} : { orderId }),
+            error: {
+                code: storeCode,
+                storeCode,
+                ...(typeof event.errorMessage === 'string' && event.errorMessage.length > 0
+                    ? { message: event.errorMessage }
+                    : {}),
+            },
+        };
+    }
+    return { status: 'pending', ...(orderId === undefined ? {} : { orderId }) };
+}
+/**
+ * `purchase()` from `@devvit/payments/client` (re-exported by
+ * `@devvit/web/client`) as the checkout client of `createDevvitPlatformGateway({
+ * commerce: { client } })`. One SKU per checkout, no client metadata: Reddit's
+ * order id is the only identity the purchase carries.
+ */
+export function createDevvitWebPaymentsClient() {
+    return {
+        async purchase(sku) {
+            if (typeof sku !== 'string' || sku.trim().length === 0) {
+                throw new TypeError('Devvit checkout requires a non-empty SKU.');
+            }
+            return toDevvitCheckoutResult(await browserClient.purchase(sku));
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/adapter-devvit",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Reddit Devvit Web platform adapter for mpgd games.",
   "license": "MIT",
   "repository": {
@@ -55,9 +55,9 @@
   ],
   "dependencies": {
     "@devvit/web": "0.14.1",
-    "@mpgd/bridge": "0.12.2",
-    "@mpgd/game-services": "0.21.1",
-    "@mpgd/platform": "0.21.0"
+    "@mpgd/game-services": "0.23.0",
+    "@mpgd/bridge": "0.12.3",
+    "@mpgd/platform": "0.22.0"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",