@thisismissem/adonisjs-atproto-tap 0.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+# AdonisJS AT Protocol Tap
+
+This package provides a small [Adonis.js](https://adonisjs.com) provider and services for `@atproto/tap`, which allows interacting with [Tap](https://docs.bsky.app/blog/introducing-tap) for AT Protocol development.
+
+## Installation
+
+```sh
+node ace add @thisismissem/adonisjs-atproto-tap
+```
+
+### Configuring
+
+If you didn't use `node ace add` you can later run the configuration using:
+
+```sh
+node ace configure @thisismissem/adonisjs-atproto-tap
+```
+
+## Indexer
+
+The Tap Indexer (`SimpleIndexer`) can be accessed using:
+
+```ts
+import indexer from '@thisismissem/adonisjs-atproto-tap/services/indexer'
+```
+
+If you've installed using the instructions above, you will have the file `start/indexer.ts` created, which is where you can add the logic to handle the events from Tap. The provider automatically connects the `indexer.error()` handler to the [Adonis.js logger](https://docs.adonisjs.com/guides/digging-deeper/logger).
+
+You can find out more in the [`@atproto/tap` documentation](https://github.com/bluesky-social/atproto/blob/main/packages/tap/README.md)
+
+## Tap API
+
+The Tap Client API for adding and removing repositories, resolving DIDs and such is accessible via:
+
+```ts
+import tap from '@thisismissem/adonisjs-atproto-tap/services/tap'
+```
+
+Which provides the following methods for interacting with the Tap server:
+
+- `addRepos(dids: string[]): Promise<void>` - Add repos to track (triggers backfill)
+- `removeRepos(dids: string[]): Promise<void>` - Stop tracking repos
+- `resolveDid(did: string): Promise<DidDocument | null>` - Resolve a DID to its DID document
+- `getRepoInfo(did: string): Promise<RepoInfo>` - Get info about a tracked repo
+
+## Docker Setup for Tap
+
+To run Tap locally, you'll likely want a `docker-compose.yaml` file with the following contents:
+
+```yaml
+services:
+  tap:
+    image: ghcr.io/bluesky-social/indigo/tap:latest
+    platform: linux/amd64
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:2480/health"]
+      interval: 2s
+      retries: 5
+      start_period: 10s
+      timeout: 10s
+    volumes:
+      - ./data/tap:/data
+    env_file: tap.env
+    environment:
+      TAP_BIND: :2480
+    ports:
+      - "127.0.0.1:2480:2480"
+```
+
+The `tap.env` file looks like:
+
+```sh
+TAP_SIGNAL_COLLECTION=fyi.questionable.actor.profile
+TAP_COLLECTION_FILTERS=fyi.questionable.*
+TAP_ADMIN_PASSWORD=admin-password
+```
+
+For the full configuration see the [Tap documentation](https://github.com/bluesky-social/indigo/blob/main/cmd/tap/README.md). You cannot use `TAP_WEBHOOK_URL` with this package, since it depends on the WebSocket interface.

package/build/configure.d.ts

@@ -0,0 +1,2 @@
+import type ConfigureCommand from '@adonisjs/core/commands/configure';
+export declare function configure(command: ConfigureCommand): Promise<void>;

package/build/configure.js

@@ -0,0 +1,51 @@
+/*
+|--------------------------------------------------------------------------
+| Configure hook
+|--------------------------------------------------------------------------
+|
+| The configure hook is called when someone runs "node ace configure <package>"
+| command. You are free to perform any operations inside this function to
+| configure the package.
+|
+| To make things easier, you have access to the underlying "ConfigureCommand"
+| instance and you can use codemods to modify the source files.
+|
+*/
+import { stubsRoot } from './stubs/main.js';
+export async function configure(command) {
+    /**
+     * Prompt when `install` or `--no-install` flags are
+     * not used
+     */
+    let shouldInstallPackages = command.parsedFlags.install;
+    if (shouldInstallPackages === undefined) {
+        shouldInstallPackages = await command.prompt.confirm('Do you want to install additional packages required by "@thisismissem/adonisjs-atproto-tap"?');
+    }
+    const codemods = await command.createCodemods();
+    const packagesToInstall = [{ name: '@atproto/tap', isDevDependency: false }];
+    if (shouldInstallPackages) {
+        await codemods.installPackages(packagesToInstall);
+    }
+    else {
+        await codemods.listPackagesToInstall(packagesToInstall);
+    }
+    // Publish config file
+    await codemods.makeUsingStub(stubsRoot, 'config/tap.stub', {});
+    await codemods.makeUsingStub(stubsRoot, 'start/indexer.stub', {});
+    // Add provider to rc file
+    await codemods.updateRcFile((rcFile) => {
+        rcFile.addProvider('@thisismissem/adonisjs-atproto-tap/provider');
+        rcFile.addPreloadFile('#start/indexer');
+    });
+    await codemods.defineEnvVariables({
+        TAP_URL: 'http://localhost:2480/',
+        TAP_ADMIN_PASSWORD: 'admin-password',
+    });
+    await codemods.defineEnvValidations({
+        variables: {
+            TAP_URL: `Env.schema.string({ format: 'url', tld: false, protocol: true })`,
+            TAP_ADMIN_PASSWORD: `Env.schema.string.optional()`,
+        },
+        leadingComment: 'Variables for configuring the AT Protocol Tap client',
+    });
+}

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';

package/build/index.js

@@ -0,0 +1,10 @@
+/*
+|--------------------------------------------------------------------------
+| Package entrypoint
+|--------------------------------------------------------------------------
+|
+| Export values from the package entrypoint as you see fit.
+|
+*/
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';

package/build/providers/tap_provider.d.ts

@@ -0,0 +1,19 @@
+import { Tap, SimpleIndexer } from '@atproto/tap';
+import type { ApplicationService } from '@adonisjs/core/types';
+import TapApi from '../src/api.js';
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        'tap.client': Tap;
+        'tap.indexer': SimpleIndexer;
+        'tap.api': TapApi;
+    }
+}
+export default class TapProvider {
+    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

@@ -0,0 +1,48 @@
+import { RuntimeException } from '@adonisjs/core/exceptions';
+import { Tap, SimpleIndexer } from '@atproto/tap';
+import TapApi from '../src/api.js';
+export default class TapProvider {
+    app;
+    channel;
+    constructor(app) {
+        this.app = app;
+    }
+    register() {
+        this.app.container.singleton('tap.client', async () => {
+            const config = this.app.config.get('tap', {});
+            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);
+        });
+    }
+    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/services/indexer.d.ts

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

package/build/services/indexer.js

@@ -0,0 +1,15 @@
+/*
+ * @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 () => {
+    console.log('Tap booted');
+    indexer = await app.container.make('tap.indexer');
+});
+export { indexer as default };

package/build/services/tap.d.ts

@@ -0,0 +1,3 @@
+import type TapApi from '../src/api.js';
+declare let tap: TapApi;
+export { tap as default };

package/build/services/tap.js

@@ -0,0 +1,6 @@
+import app from '@adonisjs/core/services/app';
+let tap;
+await app.booted(async () => {
+    tap = await app.container.make('tap.api');
+});
+export { tap as default };

package/build/src/api.d.ts

@@ -0,0 +1,32 @@
+import { Tap as TapClient } from '@atproto/tap';
+import { Tap } from './types.js';
+export default class TapApi implements Tap {
+    protected client: TapClient;
+    constructor(client: TapClient);
+    addRepos(dids: string[]): Promise<void>;
+    removeRepos(dids: string[]): Promise<void>;
+    resolveDid(did: string): Promise<{
+        id: string;
+        alsoKnownAs?: string[] | undefined;
+        verificationMethod?: {
+            id: string;
+            type: string;
+            controller: string;
+            publicKeyMultibase?: string | undefined;
+        }[] | undefined;
+        service?: {
+            id: string;
+            type: string;
+            serviceEndpoint: string | Record<string, unknown>;
+        }[] | undefined;
+    } | null>;
+    getRepoInfo(did: string): Promise<{
+        did: string;
+        rev: string;
+        handle: string;
+        state: string;
+        records: number;
+        error?: string | undefined;
+        retries?: number | undefined;
+    }>;
+}

package/build/src/api.js

@@ -0,0 +1,18 @@
+export default class TapApi {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async addRepos(dids) {
+        return this.client.addRepos(dids);
+    }
+    async removeRepos(dids) {
+        return this.client.removeRepos(dids);
+    }
+    async resolveDid(did) {
+        return this.client.resolveDid(did);
+    }
+    async getRepoInfo(did) {
+        return this.client.getRepoInfo(did);
+    }
+}

package/build/src/define_config.d.ts

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

package/build/src/define_config.js

@@ -0,0 +1,15 @@
+export function defineConfig(config) {
+    const tapConfig = {
+        url: config.url,
+        config: {},
+    };
+    // Sensible default:
+    if (typeof tapConfig.url === 'undefined') {
+        config.url = 'http://localhost:2480/';
+    }
+    // Copy across the admin password if any:
+    if (config && typeof config.adminPassword === 'string') {
+        tapConfig.config.adminPassword = config.adminPassword;
+    }
+    return tapConfig;
+}

package/build/src/types.d.ts

@@ -0,0 +1,10 @@
+import { TapConfig, Tap as TapClient } from '@atproto/tap';
+export type Config = {
+    url: string;
+    adminPassword?: string;
+};
+export type TapProviderConfig = {
+    url: Config['url'];
+    config: TapConfig;
+};
+export type Tap = Pick<TapClient, 'addRepos' | 'removeRepos' | 'getRepoInfo' | 'resolveDid'>;

package/build/src/types.js

@@ -0,0 +1 @@
+export {};

package/build/stubs/config/tap.stub

@@ -0,0 +1,12 @@
+{{{
+  exports({ to: app.configPath('tap.ts') })
+}}}
+import { defineConfig } from '@thisismissem/adonisjs-atproto-tap'
+import env from "#start/env"
+
+export default defineConfig({
+  url: env.get('TAP_URL'),
+  config: {
+    adminPassword: env.get('TAP_ADMIN_PASSWORD'),
+  },
+})

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,7 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export const stubsRoot = dirname(fileURLToPath(import.meta.url));

package/build/stubs/start/indexer.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.startPath('indexer.ts') })
+}}}
+{{#var identityEvt = '`${evt.did} updated identity: ${evt.handle} (${evt.status})`' }}
+{{#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'
+
+indexer.identity(async (evt) => {
+  console.log({{ identityEvt }})
+})
+
+indexer.record(async (evt) => {
+  const uri = {{ atUri }}
+  if (evt.action === 'create' || evt.action === 'update') {
+    console.log({{ upsertEvt }})
+  } else {
+    console.log({{ deleteEvt }})
+  }
+})

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@thisismissem/adonisjs-atproto-tap",
+  "description": "Adonis.js provider for AT Protocol Tap Client",
+  "version": "0.0.0",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "type": "module",
+  "files": [
+    "build/src",
+    "build/providers",
+    "build/services",
+    "build/stubs",
+    "build/index.d.ts",
+    "build/index.js",
+    "build/configure.d.ts",
+    "build/configure.js"
+  ],
+  "exports": {
+    ".": "./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": [
+    "adonisjs",
+    "adonis",
+    "atproto",
+    "at protocol",
+    "tap"
+  ],
+  "author": "Emelia Smith",
+  "license": "MIT",
+  "contributors": [
+    {
+      "name": "Emelia Smith",
+      "url": "https://github.com/thisismissem"
+    }
+  ],
+  "repository": {
+    "url": "https://github.com/ThisIsMissEm/adonisjs-atproto-tap"
+  },
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.12.0",
+    "@adonisjs/eslint-config": "2.1.2",
+    "@adonisjs/prettier-config": "^1.4.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@changesets/changelog-github": "^0.5.2",
+    "@changesets/cli": "^2.29.8",
+    "@japa/assert": "^4.2.0",
+    "@japa/runner": "^5.0.0",
+    "@swc/core": "^1.6.3",
+    "@types/node": "^22.19.3",
+    "c8": "^10.1.2",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.15.0",
+    "np": "^10.0.6",
+    "prettier": "^3.3.2",
+    "ts-node-maintained": "^10.9.4",
+    "typescript": "^5.4.5",
+    "yalc": "1.0.0-pre.53"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.2.0",
+    "@atproto/tap": "^0.0.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "scripts": {
+    "changeset": "changeset",
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "pnpm run typecheck && eslint .",
+    "format": "prettier --write .",
+    "format:write": "prettier --ignore-path .gitignore --write",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "pnpm run lint",
+    "test": "c8 pnpm run quick:test",
+    "types:check": "attw --pack . --profile esm-only --profile node16 --ignore-rules=cjs-resolves-to-esm",
+    "prebuild": "pnpm run lint && pnpm run clean",
+    "build": "tsc",
+    "postbuild": "pnpm run copy:templates",
+    "version-packages": "changeset version && pnpm run format:write CHANGELOG.md && git add package.json CHANGELOG.md",
+    "release": "pnpm run build && changeset publish"
+  }
+}