@jskit-ai/payments-core 0.2.3 → 0.2.4

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- `PAYMENT_STORE_FEATURE` is no longer exported from `PaymentStoreFeature.js` (no public entry point offered it): the feature's id is written as `"payments.store"`, so `jskit check` sees a module that requires that capability where it names it.
+- payment_entries declares its foreign key, account_key to payment_accounts.account_key (`foreignKeys`), so json-rest-api 3.1.0 can skip the visibility query a system-context read makes for a record such a key guarantees exists. `jskit test --databases` checks each against an app's test database. `paymentStore.mysql.test.js` proves it matches the migration on MariaDB.
 - `@jskit-ai/database-runtime` and `@jskit-ai/resource-runtime` are optional peer dependencies, as they are of assistant-runtime, instead of dependencies: an app without a database installs, composes and starts the package without them, where installing them made boot refuse it for want of a database driver. An app that uses its payment store has them through its database.
 - On json-rest-api 3.0.0's release candidate, an account's changed state is written with one read of the locked row before its UPDATE, where it took two.
 - The payment store locks or creates each account and catalogue row with its handle's `lockOrCreate`, in place of a helper of its own with the same behaviour.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/payments-core",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "type": "module",
   "description": "Application-owned payment configuration, subscription access and transactional usage credits.",
   "exports": {
@@ -23,7 +23,7 @@
     "test": "jskit test"
   },
   "dependencies": {
-    "@jskit-ai/resource-core": "0.1.205",
+    "@jskit-ai/resource-core": "0.1.206",
     "@paddle/paddle-node-sdk": "3.10.0",
     "ajv": "8.20.0",
     "stripe": "22.6.2"
@@ -69,9 +69,9 @@
     }
   },
   "peerDependencies": {
-    "@jskit-ai/database-runtime": "0.1.263",
-    "@jskit-ai/kernel": "0.2.14",
-    "@jskit-ai/resource-runtime": "0.2.12"
+    "@jskit-ai/database-runtime": "0.1.264",
+    "@jskit-ai/kernel": "0.2.15",
+    "@jskit-ai/resource-runtime": "0.2.13"
   },
   "peerDependenciesMeta": {
     "@jskit-ai/database-runtime": {

package/src/server/PaymentStoreFeature.js

@@ -2,13 +2,14 @@ import { defineFeature } from "@jskit-ai/kernel/server/features";
 import { PAYMENT_TABLES } from "./paymentResources.js";
 import { createPaymentStore } from "./paymentStore.js";
 
-const PAYMENT_STORE_FEATURE = "payments.store";
 const PAYMENT_STORE_SYSTEM_SCOPE = "payment rows are keyed by their merchant and billable subject, which is their scope, not by a workspace or user";
 
 // The owner of the payment tables in a JSKIT application: it provides the payment store on their handles as
 // `payments.store`. An application that keeps payments elsewhere passes its own store and leaves this feature out.
 const PaymentStoreFeature = defineFeature({
-  id: PAYMENT_STORE_FEATURE,
+  // The id is written out, not exported as a constant: `jskit check` sees a module that requires payments.store only
+  // where it names it.
+  id: "payments.store",
   domain: "payments",
   owns: PAYMENT_TABLES,
   systemScope: PAYMENT_STORE_SYSTEM_SCOPE,
@@ -25,4 +26,4 @@ const PaymentStoreFeature = defineFeature({
   }
 });
 
-export { PAYMENT_STORE_FEATURE, PAYMENT_STORE_SYSTEM_SCOPE, PaymentStoreFeature };
+export { PAYMENT_STORE_SYSTEM_SCOPE, PaymentStoreFeature };

package/src/server/paymentResources.js

@@ -26,6 +26,7 @@ const paymentEntryResource = defineTableResource({
   name: "paymentEntries",
   tableName: "payment_entries",
   ownership: "public",
+  foreignKeys: [{ columns: ["accountKey"], referencedTableName: "payment_accounts", referencedColumns: ["account_key"] }],
   idProperty: "entry_key",
   schema: {
     id: key("entry_key"),

package/test/paymentStore.mysql.test.js

@@ -5,6 +5,8 @@ import { requireTestDatabase } from "@jskit-ai/database-runtime/server/testDatab
 import migration from "../migrations/payments_core_initial.cjs";
 import { createPaymentService } from "../src/server/service.js";
 import { validatePaymentConfiguration } from "../src/shared/configuration.js";
+import { checkForeignKeys } from "@jskit-ai/resource-runtime/server";
+import { PAYMENT_TABLES } from "../src/server/paymentResources.js";
 import { createTestPaymentStore } from "./support/paymentStore.js";
 
 // The payment store's behaviour on MariaDB, through its public functions, as PaymentStoreFeature provides it: what an
@@ -53,6 +55,14 @@ function gate() {
   return { opened, open };
 }
 
+test("the payment table resources declare exactly the foreign keys the migration creates", async (context) => {
+  requireTestDatabase(process.env);
+  const knex = await ownDatabase(context, "da_payments_keys");
+  const resources = PAYMENT_TABLES.map(({ resource }) => resource);
+  const tables = resources.map((resource) => resource.tableName);
+  assert.deepEqual(await checkForeignKeys({ knex, resources, tables }), { missing: [], undeclared: [] });
+});
+
 test("the store refuses incomplete scopes and identities before any work runs", async (context) => {
   requireTestDatabase(process.env);
   const store = await createTestPaymentStore(await ownDatabase(context, "da_pay_refusals"));