@devvit/shared-types 0.11.0-next-2024-07-11-178fc80d6.0 → 0.11.0-next-2024-07-11-e9f4bb9f6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.11.0-next-2024-07-11-178fc80d6.0",
+  "version": "0.11.0-next-2024-07-11-e9f4bb9f6.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -9,12 +9,13 @@
   "type": "module",
   "main": "./index.js",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && yarn postbuild:copy-payments-schema",
     "clean": "rm -rf .turbo coverage dist",
     "clobber": "yarn clean && rm -rf node_modules",
     "dev": "tsc -w",
     "lint": "redlint .",
     "lint:fix": "yarn lint --fix",
+    "postbuild:copy-payments-schema": "cp -a -f  ./src/payments/products.schema.json ./dist/payments",
     "prepublishOnly": "publish-package-json",
     "test": "yarn test:unit && yarn test:types",
     "test:types": "tsc --noEmit",
@@ -23,12 +24,13 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.0-next-2024-07-11-178fc80d6.0"
+    "@devvit/protos": "0.11.0-next-2024-07-11-e9f4bb9f6.0",
+    "jsonschema": "1.4.1"
   },
   "devDependencies": {
-    "@devvit/eslint-config": "0.11.0-next-2024-07-11-178fc80d6.0",
-    "@devvit/repo-tools": "0.11.0-next-2024-07-11-178fc80d6.0",
-    "@devvit/tsconfig": "0.11.0-next-2024-07-11-178fc80d6.0",
+    "@devvit/eslint-config": "0.11.0-next-2024-07-11-e9f4bb9f6.0",
+    "@devvit/repo-tools": "0.11.0-next-2024-07-11-e9f4bb9f6.0",
+    "@devvit/tsconfig": "0.11.0-next-2024-07-11-e9f4bb9f6.0",
     "@types/redis-mock": "0.17.1",
     "eslint": "8.9.0",
     "lit": "2.2.8",
@@ -41,5 +43,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "0f366f5ec72eb7e0abb8cd2b26e66369c5570f57"
+  "gitHead": "3a5151a046edd96647784eeefd3796033cf88464"
 }

package/payments/Order.d.ts

@@ -35,5 +35,5 @@ export type Order = {
 /**
  * Converts an Order protobuf message to an Order object.
  */
-export declare function fromProto(data: OrderProto): Order;
+export declare function orderFromProto(data: OrderProto): Order;
 //# sourceMappingURL=Order.d.ts.map

package/payments/Order.d.ts.map

@@ -1 +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"}
+{"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,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,KAAK,CAQtD"}

package/payments/Order.js

@@ -1,5 +1,5 @@
 import { OrderStatus as OrderStatusProto } from '@devvit/protos/payments.js';
-import { fromProto as productFromProto } from './Product.js';
+import { productFromProto } from './Product.js';
 /**
  * The status of an order.
  */
@@ -58,7 +58,7 @@ function mapProtoToOrderStatus(status) {
 /**
  * Converts an Order protobuf message to an Order object.
  */
-export function fromProto(data) {
+export function orderFromProto(data) {
     return {
         id: data.id,
         status: mapProtoToOrderStatus(data.status),

package/payments/Product.d.ts

@@ -11,9 +11,12 @@ export type Product = {
     sku: SKU;
     price: number;
     metadata: Readonly<Record<string, string>>;
+    images?: {
+        icon: string;
+    };
 };
 /**
  * Converts an Product protobuf message to an Product object.
  */
-export declare function fromProto(data: ProductProto): Product;
+export declare function productFromProto(data: ProductProto): Product;
 //# sourceMappingURL=Product.d.ts.map

package/payments/Product.d.ts.map

@@ -1 +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"}
+{"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;IAC3C,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAQ5D"}

package/payments/Product.js

@@ -2,7 +2,7 @@ import { assertNonNull } from '../NonNull.js';
 /**
  * Converts an Product protobuf message to an Product object.
  */
-export function fromProto(data) {
+export function productFromProto(data) {
     // Validate the incoming data
     assertNonNull(data.price, 'Product price is null or undefined');
     return {

package/payments/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Order.js';
+export * from './Product.js';
+//# sourceMappingURL=index.d.ts.map

package/payments/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/payments/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/payments/index.js

@@ -0,0 +1,2 @@
+export * from './Order.js';
+export * from './Product.js';

package/payments/productSchemaJSONValidator.d.ts

@@ -0,0 +1,7 @@
+import type { Product } from './Product.js';
+/**
+ * This function validates the `products.json` file of a devvit project and returns the parsed
+ * objects
+ */
+export declare function validateProductsJson(json: unknown): Product[];
+//# sourceMappingURL=productSchemaJSONValidator.d.ts.map

package/payments/productSchemaJSONValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"productSchemaJSONValidator.d.ts","sourceRoot":"","sources":["../../src/payments/productSchemaJSONValidator.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAG5C;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,EAAE,CAO7D"}

package/payments/productSchemaJSONValidator.js

@@ -0,0 +1,13 @@
+import jsonschema from 'jsonschema/lib/index.js';
+import productSchema from './products.schema.json' assert { type: 'json' };
+/**
+ * This function validates the `products.json` file of a devvit project and returns the parsed
+ * objects
+ */
+export function validateProductsJson(json) {
+    const validationResult = jsonschema.validate(json, productSchema);
+    if (!validationResult.valid) {
+        throw new Error(validationResult.errors.map((e) => e.toString()).join('\n'));
+    }
+    return validationResult.instance.products ?? [];
+}

package/payments/productSchemaJSONValidator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"productSchemaJSONValidator.test.d.ts","sourceRoot":"","sources":["../../src/payments/productSchemaJSONValidator.test.ts"],"names":[],"mappings":""}

package/payments/products.schema.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "id": "https://developers.reddit.com/payments/products.schema.json",
+  "title": "Devvit Payments - Product Schema",
+  "description": "Schema for Devvit products",
+  "type": "object",
+  "properties": {
+    "products": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "sku": {
+            "description": "The product sku used as a unique identifier",
+            "maxLength": 50,
+            "type": "string",
+            "pattern": "^[A-z0-9-_]+$"
+          },
+          "displayName": {
+            "description": "The product display name",
+            "maxLength": 50,
+            "type": "string",
+            "pattern": "^(?!\\s)[a-zA-Z0-9\\s]+(?<!\\s)$"
+          },
+          "description": {
+            "description": "The product description",
+            "type": "string",
+            "maxLength": 250
+          },
+          "price": {
+            "description": "The price of the product (unit: Reddit Gold)",
+            "type": "integer",
+            "minimum": 0
+          },
+          "images": {
+            "description": "The images associated with this product",
+            "type": "object",
+            "properties": {
+              "icon": {
+                "description": "The icon image URL (should be a path relative to /assets)",
+                "type": "string"
+              }
+            },
+            "patternProperties": {
+              "^.*$": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "icon"
+            ]
+          },
+          "metadata": {
+            "description": "Additional metadata associated with this product",
+            "type": "object",
+            "patternProperties": {
+              "^.*$": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "required": [
+          "sku",
+          "displayName",
+          "price"
+        ]
+      }
+    }
+  }
+}