@nekosuneprojects/vector-sdk 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Luke Larsen
+
+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,91 @@
+# Vector Bot SDK (Node.js)
+
+A JavaScript/TypeScript port of the Vector Bot SDK that mirrors the structure of the original Rust crate while staying idiomatic for the Node.js ecosystem. It provides helpers for creating Vector bots, sending encrypted private messages and files, building metadata, subscribing to gift-wrap events, and uploading data through a NIP-96 server.
+
+## Highlights
+
+- `VectorBot` and `Channel` classes that wrap a Nostr client for message, reaction, typing, and file flows.
+- Metadata builders, filters, and utilities ported from the Rust implementation.
+- AES-256-GCM file encryption helpers and attachment helpers with extension inference.
+- Upload helpers that target the trusted NIP-96 server used by Vector and emit progress callbacks.
+
+## Getting Started
+
+```bash
+npm install @vector/vector-sdk
+```
+
+Then import the pieces you need:
+
+```ts
+import { VectorBotClient } from '@vector/vector-sdk';
+
+const client = new VectorBotClient({
+  privateKey: process.env.NOSTR_PRIVATE_KEY,
+  relays: (process.env.NOSTR_RELAYS ?? 'wss://jskitty.cat/nostr')
+    .split(',')
+    .map((relay) => relay.trim())
+    .filter(Boolean),
+  debug: process.env.DEBUG === '1',
+  reconnect: true,
+  reconnectIntervalMs: 15000,
+  profile: {
+    name: 'testnekobot',
+    displayName: 'NekoSune TestBOT',
+    about: 'Vector bot created with the SDK',
+    picture: 'https://example.com/avatar.png',
+    banner: 'https://example.com/banner.png',
+  },
+});
+
+client.on('ready', ({ pubkey, profile }) => {
+  const name = profile?.displayName || profile?.name || 'unknown';
+  console.log(`Logged in as ${name} (${pubkey})`);
+});
+
+client.on('disconnect', ({ relay, error }) => {
+  const reason = error instanceof Error ? error.message : String(error ?? '');
+  console.warn(`Disconnected from ${relay}${reason ? `: ${reason}` : ''}`);
+});
+
+client.on('reconnect', ({ relay }) => {
+  console.log(`Reconnected to ${relay}`);
+});
+
+client.on('error', (error) => {
+  console.error('Bot error:', error);
+});
+
+client.on('message', async (channel, tags, message, self) => {
+  if (self) return;
+
+  console.log(`${channel}: ${message}`);
+
+  if (message.startsWith('!ping')) {
+    await client.sendMessage(channel, 'pong');
+    return;
+  }
+
+  if (message.startsWith('!upload')) {
+    if (!process.env.UPLOAD_FILE_PATH) {
+      await client.sendMessage(channel, 'Set UPLOAD_FILE_PATH to send a file.');
+      return;
+    }
+    await client.sendFile(channel, process.env.UPLOAD_FILE_PATH);
+  }
+});
+
+client.connect().catch((error) => {
+  console.error('Bot failed to start:', error);
+  process.exit(1);
+});
+
+process.on('SIGINT', () => {
+  client.close();
+  process.exit(0);
+});
+```
+
+## Building
+
+The package is authored in TypeScript. Run `npm run build` to emit the `dist/` artifacts used by consumers.

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@nekosuneprojects/vector-sdk",
+  "version": "1.0.1",
+  "description": "Node.js reimplementation of the Vector Bot SDK",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NekoSuneProjects/vector-sdk-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/NekoSuneProjects/vector-sdk-js/issues"
+  },
+  "keywords": [
+    "nostr",
+    "vector",
+    "bot",
+    "crypto",
+    "sdk"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@noble/hashes": "^1.5.0",
+    "@noble/secp256k1": "^1.5.0",
+    "file-type": "^18.0.0",
+    "form-data": "^4.0.5",
+    "mime-types": "^3.0.2",
+    "node-fetch": "^3.3.1",
+    "nostr-tools": "^2.19.4"
+  },
+  "devDependencies": {
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^20.7.0",
+    "typescript": "^5.5.2"
+  }
+}