@devvit/shared-types 0.11.0-next-2024-07-11-9d8f8bdd4.0 → 0.11.0-next-2024-07-11-0bd3fccfe.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.11.0-next-2024-07-11-9d8f8bdd4.0",
+  "version": "0.11.0-next-2024-07-11-0bd3fccfe.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,12 +23,12 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.0-next-2024-07-11-9d8f8bdd4.0"
+    "@devvit/protos": "0.11.0-next-2024-07-11-0bd3fccfe.0"
   },
   "devDependencies": {
-    "@devvit/eslint-config": "0.11.0-next-2024-07-11-9d8f8bdd4.0",
-    "@devvit/repo-tools": "0.11.0-next-2024-07-11-9d8f8bdd4.0",
-    "@devvit/tsconfig": "0.11.0-next-2024-07-11-9d8f8bdd4.0",
+    "@devvit/eslint-config": "0.11.0-next-2024-07-11-0bd3fccfe.0",
+    "@devvit/repo-tools": "0.11.0-next-2024-07-11-0bd3fccfe.0",
+    "@devvit/tsconfig": "0.11.0-next-2024-07-11-0bd3fccfe.0",
     "@types/redis-mock": "0.17.1",
     "eslint": "8.9.0",
     "lit": "2.2.8",
@@ -41,5 +41,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "ab73c91617d9a9609c4eb6a89e969436f97616a9"
+  "gitHead": "34e01d0e14da9f0ee92761e0977b71cd78671c65"
 }

package/payments/Order.d.ts

@@ -0,0 +1,39 @@
+import type { Order as OrderProto } from '@devvit/protos/payments.js';
+import { OrderStatus as OrderStatusProto } from '@devvit/protos/payments.js';
+import type { Product } from './Product.js';
+/**
+ * The status of an order.
+ */
+export declare const enum OrderStatus {
+    UNDEFINED = "UNDEFINED",
+    NEW = "NEW",
+    CREATED = "CREATED",
+    PAID = "PAID",
+    DELIVERED = "DELIVERED",
+    CANCELED = "CANCELED",
+    REVERTED = "REVERTED"
+}
+/**
+ * Maps an OrderStatus enum to the corresponding protobuf enum value.
+ */
+export declare function mapOrderStatusToProto(status: OrderStatus): OrderStatusProto;
+/**
+ * An order for products purchased through Devvit by a Reddit user.
+ */
+export type Order = {
+    /** Unique identifer for the order */
+    id: string;
+    /** Where the order is in its lifecycle */
+    status: OrderStatus;
+    /** When the order was created */
+    createdAt: Date | undefined;
+    /** When the order was last updated */
+    updatedAt: Date | undefined;
+    /** The products that were ordered */
+    products: Product[];
+};
+/**
+ * Converts an Order protobuf message to an Order object.
+ */
+export declare function fromProto(data: OrderProto): Order;
+//# sourceMappingURL=Order.d.ts.map

package/payments/Order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../src/payments/Order.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,WAAW,IAAI,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAG5C;;GAEG;AACH,0BAAkB,WAAW;IAC3B,SAAS,cAAc;IACvB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,WAAW,GAAG,gBAAgB,CAiB3E;AAwBD;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,0CAA0C;IAC1C,MAAM,EAAE,WAAW,CAAC;IACpB,iCAAiC;IACjC,SAAS,EAAE,IAAI,GAAG,SAAS,CAAC;IAC5B,sCAAsC;IACtC,SAAS,EAAE,IAAI,GAAG,SAAS,CAAC;IAC5B,qCAAqC;IACrC,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,KAAK,CAQjD"}

package/payments/Order.js

@@ -0,0 +1,69 @@
+import { OrderStatus as OrderStatusProto } from '@devvit/protos/payments.js';
+import { fromProto as productFromProto } from './Product.js';
+/**
+ * The status of an order.
+ */
+export var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["UNDEFINED"] = "UNDEFINED";
+    OrderStatus["NEW"] = "NEW";
+    OrderStatus["CREATED"] = "CREATED";
+    OrderStatus["PAID"] = "PAID";
+    OrderStatus["DELIVERED"] = "DELIVERED";
+    OrderStatus["CANCELED"] = "CANCELED";
+    OrderStatus["REVERTED"] = "REVERTED";
+})(OrderStatus || (OrderStatus = {}));
+/**
+ * Maps an OrderStatus enum to the corresponding protobuf enum value.
+ */
+export function mapOrderStatusToProto(status) {
+    switch (status) {
+        case OrderStatus.NEW:
+            return OrderStatusProto.ORDER_STATUS_NEW;
+        case OrderStatus.CREATED:
+            return OrderStatusProto.ORDER_STATUS_CREATED;
+        case OrderStatus.PAID:
+            return OrderStatusProto.ORDER_STATUS_PAID;
+        case OrderStatus.DELIVERED:
+            return OrderStatusProto.ORDER_STATUS_DELIVERED;
+        case OrderStatus.CANCELED:
+            return OrderStatusProto.ORDER_STATUS_CANCELED;
+        case OrderStatus.REVERTED:
+            return OrderStatusProto.ORDER_STATUS_REVERTED;
+        default:
+            throw new Error(`Unrecognized OrderStatus: ${status}`);
+    }
+}
+/**
+ * Maps an OrderStatus protobuf enum value to the corresponding OrderStatus enum.
+ */
+function mapProtoToOrderStatus(status) {
+    switch (status) {
+        case OrderStatusProto.ORDER_STATUS_NEW:
+            return OrderStatus.NEW;
+        case OrderStatusProto.ORDER_STATUS_CREATED:
+            return OrderStatus.CREATED;
+        case OrderStatusProto.ORDER_STATUS_PAID:
+            return OrderStatus.PAID;
+        case OrderStatusProto.ORDER_STATUS_DELIVERED:
+            return OrderStatus.DELIVERED;
+        case OrderStatusProto.ORDER_STATUS_CANCELED:
+            return OrderStatus.CANCELED;
+        case OrderStatusProto.ORDER_STATUS_REVERTED:
+            return OrderStatus.REVERTED;
+        default:
+            throw new Error(`Unrecognized OrderStatus: ${status}`);
+    }
+}
+/**
+ * Converts an Order protobuf message to an Order object.
+ */
+export function fromProto(data) {
+    return {
+        id: data.id,
+        status: mapProtoToOrderStatus(data.status),
+        createdAt: data.createdAt,
+        updatedAt: data.updatedAt,
+        products: data.products.map(productFromProto),
+    };
+}

package/payments/Product.d.ts

@@ -0,0 +1,19 @@
+import type { Product as ProductProto } from '@devvit/protos/types/devvit/payments/v1alpha/product.js';
+/**
+ * A unique identifier for a product.
+ */
+export type SKU = string;
+/**
+ * A product that can be sold by Devvit developers
+ * and purchased by Reddit users.
+ */
+export type Product = {
+    sku: SKU;
+    price: number;
+    metadata: Readonly<Record<string, string>>;
+};
+/**
+ * Converts an Product protobuf message to an Product object.
+ */
+export declare function fromProto(data: ProductProto): Product;
+//# sourceMappingURL=Product.d.ts.map

package/payments/Product.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Product.d.ts","sourceRoot":"","sources":["../../src/payments/Product.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,yDAAyD,CAAC;AAGvG;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,GAAG,CAAC;IACT,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAQrD"}

package/payments/Product.js

@@ -0,0 +1,13 @@
+import { assertNonNull } from '../NonNull.js';
+/**
+ * Converts an Product protobuf message to an Product object.
+ */
+export function fromProto(data) {
+    // Validate the incoming data
+    assertNonNull(data.price, 'Product price is null or undefined');
+    return {
+        sku: data.sku,
+        price: data.price.amount, // In Reddit Gold
+        metadata: data.productMetadata,
+    };
+}