@thisismissem/adonisjs-atproto-tap 1.0.1 → 2.0.0

package/build/providers/tap_provider.d.ts

@@ -1,19 +1,15 @@
-import { Tap, SimpleIndexer } from '@atproto/tap';
+import { Tap } from '@atproto/tap';
 import type { ApplicationService } from '@adonisjs/core/types';
 import TapApi from '../src/api.js';
+import { ContainerProviderContract } from '@adonisjs/core/types/app';
 declare module '@adonisjs/core/types' {
     interface ContainerBindings {
         'tap.client': Tap;
-        'tap.indexer': SimpleIndexer;
         'tap.api': TapApi;
     }
 }
-export default class TapProvider {
+export default class TapProvider implements ContainerProviderContract {
     protected app: ApplicationService;
-    private channel?;
     constructor(app: ApplicationService);
     register(): void;
-    boot(): Promise<void>;
-    start(): Promise<void>;
-    shutdown(): Promise<void>;
 }

package/build/providers/tap_provider.js

@@ -1,9 +1,8 @@
 import { RuntimeException } from '@adonisjs/core/exceptions';
-import { Tap, SimpleIndexer } from '@atproto/tap';
+import { Tap } from '@atproto/tap';
 import TapApi from '../src/api.js';
 export default class TapProvider {
     app;
-    channel;
     constructor(app) {
         this.app = app;
     }
@@ -13,36 +12,11 @@ export default class TapProvider {
             if (!config || !config.url) {
                 throw new RuntimeException('Invalid config exported from "config/tap.ts" file. Make sure to return an object with the url property defined');
             }
-            // FIXME: Workaround for https://github.com/bluesky-social/atproto/issues/4476
-            if (config.url.endsWith('/')) {
-                config.url = config.url.slice(0, -1);
-            }
             return new Tap(config.url, config.config ?? {});
         });
-        this.app.container.singleton('tap.indexer', () => {
-            return new SimpleIndexer();
-        });
         this.app.container.singleton('tap.api', async (resolver) => {
             const client = await resolver.make('tap.client');
-            return new TapApi(client);
+            return new TapApi(client, this.app);
         });
     }
-    async boot() {
-        const logger = await this.app.container.make('logger');
-        const indexer = await this.app.container.make('tap.indexer');
-        indexer.error((err) => logger.error(err, 'Tap indexer error'));
-    }
-    async start() {
-        if (this.app.getEnvironment() === 'web') {
-            const tap = await this.app.container.make('tap.client');
-            const indexer = await this.app.container.make('tap.indexer');
-            this.channel = tap.channel(indexer);
-            this.channel.start();
-        }
-    }
-    async shutdown() {
-        if (this.channel) {
-            await this.channel.destroy();
-        }
-    }
 }

package/build/src/api.d.ts

@@ -1,8 +1,13 @@
-import { Tap as TapClient } from '@atproto/tap';
+import { Tap as TapClient, TapHandler } from '@atproto/tap';
 import { Tap } from './types.js';
+import { ApplicationService } from '@adonisjs/core/types';
 export default class TapApi implements Tap {
+    #private;
     protected client: TapClient;
-    constructor(client: TapClient);
+    protected app: ApplicationService;
+    constructor(client: TapClient, app: ApplicationService);
+    setIndexer(indexer: TapHandler): void;
+    startIndexer(): void;
     addRepos(dids: string[]): Promise<void>;
     removeRepos(dids: string[]): Promise<void>;
     resolveDid(did: string): Promise<{

package/build/src/api.js

@@ -1,7 +1,28 @@
+import { RuntimeException } from '@adonisjs/core/exceptions';
 export default class TapApi {
     client;
-    constructor(client) {
+    app;
+    #channel;
+    #indexer;
+    constructor(client, app) {
         this.client = client;
+        this.app = app;
+    }
+    setIndexer(indexer) {
+        this.#indexer = indexer;
+    }
+    startIndexer() {
+        if (!this.#indexer) {
+            throw new RuntimeException('tap.setIndexer was never called');
+        }
+        if (this.#channel) {
+            throw new RuntimeException('tap.startIndexer invoked multiple times');
+        }
+        this.#channel = this.client.channel(this.#indexer);
+        this.#channel.start();
+        this.app.terminating(async () => {
+            await this.#channel?.destroy();
+        });
     }
     async addRepos(dids) {
         return this.client.addRepos(dids);

package/build/src/define_config.d.ts

@@ -1,2 +1,2 @@
 import type { Config, TapProviderConfig } from './types.js';
-export declare function defineConfig<T extends Config>(config: T): TapProviderConfig;
+export declare function defineConfig<T extends Config>({ url, ...config }: T): TapProviderConfig;

package/build/src/define_config.js

@@ -1,15 +1,15 @@
-export function defineConfig(config) {
+export function defineConfig({ url, ...config }) {
     const tapConfig = {
-        url: config.url,
-        config: {},
+        url,
+        config,
     };
     // Sensible default:
     if (typeof tapConfig.url === 'undefined') {
-        config.url = 'http://localhost:2480/';
+        tapConfig.url = 'http://localhost:2480';
     }
-    // Copy across the admin password if any:
-    if (config && typeof config.adminPassword === 'string') {
-        tapConfig.config.adminPassword = config.adminPassword;
+    // FIXME: Workaround for https://github.com/bluesky-social/atproto/issues/4476
+    if (tapConfig.url.endsWith('/')) {
+        tapConfig.url = tapConfig.url.slice(0, -1);
     }
     return tapConfig;
 }

package/build/src/types.d.ts

@@ -1,8 +1,7 @@
 import { TapConfig, Tap as TapClient } from '@atproto/tap';
 export type Config = {
     url: string;
-    adminPassword?: string;
-};
+} & TapConfig;
 export type TapProviderConfig = {
     url: Config['url'];
     config: TapConfig;

package/build/stubs/config/tap.stub

@@ -6,7 +6,5 @@ import env from "#start/env"
 
 export default defineConfig({
   url: env.get('TAP_URL'),
-  config: {
-    adminPassword: env.get('TAP_ADMIN_PASSWORD'),
-  },
+  adminPassword: env.get('TAP_ADMIN_PASSWORD'),
 })

package/build/stubs/start/indexer.stub

@@ -5,7 +5,11 @@
 {{#var atUri = '`at://${evt.did}/${evt.collection}/${evt.rkey}`' }}
 {{#var upsertEvt = '`${evt.action}: ${uri}`' }}
 {{#var deleteEvt = '`deleted: ${uri}`' }}
-import indexer from '@thisismissem/adonisjs-atproto-tap/services/indexer'
+import tap from '@thisismissem/adonisjs-atproto-tap/services/tap'
+import { SimpleIndexer } from '@atproto/tap'
+
+// You can also use LexIndexer for a lexicon aware indexer:
+const indexer = new SimpleIndexer()
 
 indexer.identity(async (evt) => {
   console.log({{ identityEvt }})
@@ -19,3 +23,13 @@ indexer.record(async (evt) => {
     console.log({{ deleteEvt }})
   }
 })
+
+// Set the indexer to use with Tap:
+tap.setIndexer(indexer)
+
+// In production, you'll probably want to use a separate process to run the
+// indexer. e.g., have a node ace command that starts the app, and then calls
+// tap.startIndexer() one the app has started.
+if (app.getEnvironment() === 'web' && app.inDev) {
+  tap.startIndexer()
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thisismissem/adonisjs-atproto-tap",
   "description": "Adonis.js provider for AT Protocol Tap Client",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -20,7 +20,6 @@
     ".": "./build/index.js",
     "./provider": "./build/providers/tap_provider.js",
     "./services/tap": "./build/services/tap.js",
-    "./services/indexer": "./build/services/indexer.js",
     "./types": "./build/src/types.js"
   },
   "keywords": [
@@ -48,6 +47,7 @@
     "@adonisjs/prettier-config": "^1.4.0",
     "@adonisjs/tsconfig": "^1.3.0",
     "@arethetypeswrong/cli": "^0.18.2",
+    "@atproto/tap": "^0.1.3",
     "@changesets/changelog-github": "^0.5.2",
     "@changesets/cli": "^2.29.8",
     "@japa/assert": "^4.2.0",
@@ -66,7 +66,7 @@
   },
   "peerDependencies": {
     "@adonisjs/core": "^6.2.0",
-    "@atproto/tap": "^0.0.2"
+    "@atproto/tap": "^0.1.3"
   },
   "publishConfig": {
     "access": "public",

package/build/services/indexer.d.ts

@@ -1,3 +0,0 @@
-import { SimpleIndexer } from '@atproto/tap';
-declare let indexer: SimpleIndexer;
-export { indexer as default };

package/build/services/indexer.js

@@ -1,14 +0,0 @@
-/*
- * @adonisjs/transmit
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import app from '@adonisjs/core/services/app';
-let indexer;
-await app.booted(async () => {
-    indexer = await app.container.make('tap.indexer');
-});
-export { indexer as default };