@jskit-ai/connectors-core 0.2.15 → 0.2.16

package/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- connector_authorization_attempts declares its foreign key, connection_key to connector_connections.connection_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. `knexConnectionStore.test.js` proves it matches the migration on the connector test database.
 - `@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 knex connection store (`./server/storage`) has them through its database.
 - `createKnexConnectionStore` owns the connector tables through resource-runtime's `createStandaloneResources`, with the connection store's declared system scope, instead of building a resource runtime and host of its own.
 - `connectors.core` without a store requires `connectors.store` again, with a hint, so the kernel's startup error names the missing capability and says to register `createConnectionStoreFeature({ protection })` or pass `createConnectorsFeature({ store })`, instead of a check in its own setup.

package/README.md

@@ -426,6 +426,14 @@ Import `createKnexConnectionStore` and `createCredentialProtection` from
 `@jskit-ai/connectors-core/server/storage`. Use the application's existing Knex
 client, with its selected JSKIT MySQL or PostgreSQL driver.
 
+`./server/storage` imports `@jskit-ai/resource-runtime`, which this package
+takes as an optional peer, so npm does not install it. An application using the
+database-backed store declares `@jskit-ai/resource-runtime` and
+`@jskit-ai/database-runtime` itself, at the catalog's versions, as a JSKIT
+application on a database already does; without them, importing
+`./server/storage` fails with `ERR_MODULE_NOT_FOUND`. An application on file
+storage imports `./server/file-storage` and needs neither.
+
 ```js
 const protection = createCredentialProtection({
   keys: { current: decoded32ByteSecretKey },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/connectors-core",
-  "version": "0.2.15",
+  "version": "0.2.16",
   "description": "Portable integration configuration and server-side account connection runtime.",
   "type": "module",
   "scripts": {
@@ -15,7 +15,7 @@
     "./locales/en.json": "./locales/en.json"
   },
   "dependencies": {
-    "@jskit-ai/resource-core": "0.1.205",
+    "@jskit-ai/resource-core": "0.1.206",
     "jose": "^6.1.3",
     "json-rest-schema": "^1.0.17",
     "oauth4webapi": "3.8.8",
@@ -56,10 +56,10 @@
     }
   },
   "peerDependencies": {
-    "@jskit-ai/database-runtime": "0.1.263",
-    "@jskit-ai/http-runtime": "0.2.14",
-    "@jskit-ai/kernel": "0.2.14",
-    "@jskit-ai/resource-runtime": "0.2.12"
+    "@jskit-ai/database-runtime": "0.1.264",
+    "@jskit-ai/http-runtime": "0.2.15",
+    "@jskit-ai/kernel": "0.2.15",
+    "@jskit-ai/resource-runtime": "0.2.13"
   },
   "peerDependenciesMeta": {
     "@jskit-ai/database-runtime": {

package/src/server/connectorResources.js

@@ -26,6 +26,7 @@ const connectorAuthorizationAttemptResource = defineTableResource({
   name: "connectorAuthorizationAttempts",
   tableName: "connector_authorization_attempts",
   ownership: "public",
+  foreignKeys: [{ columns: ["connectionKey"], referencedTableName: "connector_connections", referencedColumns: ["connection_key"] }],
   idProperty: "attempt_key",
   sortableFields: ["expiresAt"],
   schema: {

package/test/knexConnectionStore.test.js

@@ -10,6 +10,8 @@ import { fileURLToPath } from "node:url";
 import test from "node:test";
 import createKnex from "knex";
 import migration from "../migrations/connectors_core_initial.cjs";
+import { checkForeignKeys } from "@jskit-ai/resource-runtime/server";
+import { CONNECTOR_TABLES } from "../src/server/connectorResources.js";
 import { createCredentialProtection, createKnexConnectionStore } from "../src/server/storage.js";
 
 test("credential protection binds ciphertext to its record and supports key rotation", async () => {
@@ -42,6 +44,12 @@ test("durable connector storage on an isolated SQL database", { skip: !databaseU
   const connection = { tokens: { accessToken: "private-access", refreshToken: "private-refresh" }, version: 0 };
   await migration.up(knex);
   try {
+    await t.test("the table resources declare exactly the foreign keys the migration creates", async () => {
+      const resources = CONNECTOR_TABLES.map(({ resource }) => resource);
+      const tables = resources.map((resource) => resource.tableName);
+      assert.deepEqual(await checkForeignKeys({ knex, resources, tables }), { missing: [], undeclared: [] });
+    });
+
     await t.test("persists encrypted records and reopens them through another database pool", async () => {
       await store.withConnection(scope, async ({ save }) => save(connection));
       const rows = await knex("connector_connections").select();