@kubun/store-connector 0.15.0 → 0.17.0

package/lib/api.d.ts

@@ -24,10 +24,21 @@ export type PendingAuthRecord = {
     /** A recovery recipient's DID in a form that can be encrypted to. See the table type. */
     controllerWrappableDID?: string | null;
     createdAt: number;
+    /** The callback's redirect target, needed to complete the token exchange. */
+    redirectURL: string;
+    /** The scopes requested at authorize time. */
+    scopes: Array<string>;
+    expiresAt: number;
 };
 export type ConnectorStoreAPI = {
     getSyncState(connectorName: string, ownerDID: string): Promise<SyncState | null>;
     setSyncState(connectorName: string, ownerDID: string, state: SyncState): Promise<void>;
+    updateSyncProgress(connectorName: string, ownerDID: string, progress: {
+        checkpoint: unknown;
+        lastSyncedAt: string;
+        entityCount: number;
+        error?: string | null;
+    }): Promise<void>;
     deleteSyncState(connectorName: string, ownerDID: string): Promise<void>;
     listSyncStatesForConnector(connectorName: string): Promise<Array<SyncStateEntry>>;
     createPendingAuth(record: PendingAuthRecord): Promise<void>;

package/lib/api.js

@@ -27,9 +27,8 @@ export function createConnectorStore(db, _adapter) {
             return rowToSyncState(row);
         },
         async setSyncState (connectorName, ownerDID, state) {
-            // The `lease_expires_at` column is dead (the lease moved to the workflow
-            // engine); a fresh INSERT sets it null and a conflicting update leaves it
-            // untouched.
+            // `lease_expires_at` is dead: a fresh INSERT sets it null and a conflicting
+            // update leaves it untouched.
             await db.insertInto('kubun_connector_sync_state').values({
                 connector_name: connectorName,
                 owner_did: ownerDID,
@@ -50,6 +49,28 @@ export function createConnectorStore(db, _adapter) {
                     error: state.error ?? null
                 })).execute();
         },
+        async updateSyncProgress (connectorName, ownerDID, progress) {
+            const checkpoint = progress.checkpoint != null ? JSON.stringify(progress.checkpoint) : null;
+            const error = progress.error ?? null;
+            await db.insertInto('kubun_connector_sync_state').values({
+                connector_name: connectorName,
+                owner_did: ownerDID,
+                checkpoint,
+                last_synced_at: progress.lastSyncedAt,
+                entity_count: progress.entityCount,
+                status: 'idle',
+                error,
+                lease_expires_at: null
+            }).onConflict((oc)=>oc.columns([
+                    'connector_name',
+                    'owner_did'
+                ]).doUpdateSet({
+                    checkpoint,
+                    last_synced_at: progress.lastSyncedAt,
+                    entity_count: progress.entityCount,
+                    error
+                })).execute();
+        },
         async deleteSyncState (connectorName, ownerDID) {
             await db.deleteFrom('kubun_connector_sync_state').where('connector_name', '=', connectorName).where('owner_did', '=', ownerDID).execute();
         },
@@ -70,7 +91,10 @@ export function createConnectorStore(db, _adapter) {
                 owner_did: record.ownerDID,
                 owner_wrappable_did: record.ownerWrappableDID ?? null,
                 controller_wrappable_did: record.controllerWrappableDID ?? null,
-                created_at: record.createdAt
+                created_at: record.createdAt,
+                redirect_url: record.redirectURL,
+                scopes: JSON.stringify(record.scopes),
+                expires_at: record.expiresAt
             }).execute();
         },
         async consumePendingAuth (state) {
@@ -85,11 +109,23 @@ export function createConnectorStore(db, _adapter) {
                 ownerDID: row.owner_did,
                 ownerWrappableDID: row.owner_wrappable_did,
                 controllerWrappableDID: row.controller_wrappable_did,
-                createdAt: row.created_at
+                createdAt: row.created_at,
+                redirectURL: row.redirect_url,
+                // ParseJSONResultsPlugin may have already parsed this column, same as
+                // `checkpoint` in `rowToSyncState`.
+                scopes: typeof row.scopes === 'string' ? JSON.parse(row.scopes) : row.scopes,
+                expiresAt: row.expires_at
             };
         },
         async deleteExpiredPendingAuth (cutoffMs) {
-            await db.deleteFrom('kubun_connector_pending_auth').where('created_at', '<', cutoffMs).execute();
+            // Strict `<` matches @kokuin/oauth `completeAuthorization`, which treats a
+            // record as expired only when `expiresAt < now`. A record at exactly
+            // `expiresAt === cutoffMs` is therefore still consumable and is kept here
+            // (the next sweep, once `now > expiresAt`, removes it). This intentionally
+            // keeps one more record than the `PendingAuthStore.deleteExpired` port doc
+            // ("at or before nowMs") so the sweep and the consume check agree on the
+            // expiry boundary.
+            await db.deleteFrom('kubun_connector_pending_auth').where('expires_at', '<', cutoffMs).execute();
         }
     };
 }

package/lib/migrations.js

@@ -19,7 +19,14 @@ export function getConnectorMigrations(ctx) {
             // callback so the mint can add the controller recovery wrap.
             .addColumn('controller_wrappable_did', t.text)// ms-epoch (Date.now) overflows int32 on Postgres; bigint holds it and
             // the adapter's int8 parser reads it back as a JS number.
-            .addColumn('created_at', t.bigint, (col)=>col.notNull()).execute();
+            .addColumn('created_at', t.bigint, (col)=>col.notNull())// The callback's redirect target and the scopes requested at authorize
+            // time, both needed to complete the token exchange and to fill in
+            // `PendingAuthRecord`'s required fields.
+            .addColumn('redirect_url', t.text, (col)=>col.notNull())// JSON-encoded `Array<string>`.
+            .addColumn('scopes', t.text, (col)=>col.notNull())// ms-epoch (Date.now) overflows int32 on Postgres; bigint holds it and
+            // the adapter's int8 parser reads it back as a JS number. The sweep in
+            // `deleteExpiredPendingAuth` keys off this column, not `created_at`.
+            .addColumn('expires_at', t.bigint, (col)=>col.notNull()).execute();
         },
         async down (db) {
             await db.schema.dropTable('kubun_connector_pending_auth').ifExists().execute();

package/lib/tables.d.ts

@@ -28,6 +28,10 @@ export type ConnectorPendingAuthTable = {
      */
     controller_wrappable_did: string | null;
     created_at: number;
+    redirect_url: string;
+    /** JSON-encoded `Array<string>`. See `PendingAuthRecord.scopes`. */
+    scopes: string;
+    expires_at: number;
 };
 export type ConnectorPendingAuth = Selectable<ConnectorPendingAuthTable>;
 export type ConnectorTables = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/store-connector",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -15,13 +15,13 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@kubun/db": "^0.15.0",
-    "@kubun/db-adapter": "^0.15.0",
+    "@kubun/db": "^0.17.0",
+    "@kubun/db-adapter": "^0.17.0",
     "kysely": "^0.29.5"
   },
   "devDependencies": {
-    "@kubun/db-better-sqlite": "^0.15.0",
-    "@kubun/db-postgres": "^0.15.0",
+    "@kubun/db-better-sqlite": "^0.17.0",
+    "@kubun/db-postgres": "^0.17.0",
     "@testcontainers/postgresql": "^12.1.0"
   },
   "publishConfig": {
@@ -30,8 +30,8 @@
   "scripts": {
     "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
     "build:clean": "del lib",
-    "build:js": "swc src -d ./lib --config-file ../../node_modules/@kigu/dev/swc.json --strip-leading-paths",
-    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build:js": "del 'lib/**/*.js' && swc src -d ./lib --config-file ../../node_modules/@kigu/dev/swc.json --strip-leading-paths",
+    "build:types": "del 'lib/**/*.d.ts' 'lib/**/*.d.ts.map' && tsc --emitDeclarationOnly --skipLibCheck",
     "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
     "test": "pnpm run test:types && pnpm run test:unit",
     "test:types": "tsc --noEmit -p tsconfig.test.json",