🤖 Merge PR DefinitelyTyped#74365 Add types for grenache-nodejs-link, and grenache-nodejs-ws by @ramioooz

Author: ramioooz

types/grenache-nodejs-link/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/grenache-nodejs-link/grenache-nodejs-link-tests.ts

@@ -0,0 +1,29 @@
+import Link from "grenache-nodejs-link";
+
+const link = new Link({
+    grape: "http://127.0.0.1:30001",
+});
+
+link.start();
+
+link.put({ hello: "world" }, (err, hash) => {
+    if (err) throw err;
+
+    if (hash) {
+        link.get(hash, (err, res) => {
+            if (err) throw err;
+            res;
+        });
+    }
+});
+
+link.lookup("test", (err, peers) => {
+    if (err) throw err;
+    peers?.forEach(p => p.toUpperCase());
+});
+
+link.startAnnouncing("test", 10000, err => {
+    if (err) throw err;
+});
+
+link.stop();

types/grenache-nodejs-link/index.d.ts

@@ -0,0 +1,73 @@
+/// <reference types="node" />
+
+import { EventEmitter } from "events";
+
+interface LinkOptions {
+    grape: string | string[];
+    monitorTimeout?: number | undefined;
+    requestTimeout?: number | undefined;
+    lruMaxSizeLookup?: number | undefined;
+    lruMaxAgeLookup?: number | undefined;
+}
+
+interface LookupOptions {
+    retry?: number | undefined;
+}
+
+interface AnnounceOptions {
+    interval?: number | undefined;
+    retry?: number | undefined;
+}
+
+type Callback<T = unknown> = (err: Error | null, data?: T) => void;
+
+declare class Link extends EventEmitter {
+    constructor(options: LinkOptions);
+
+    start(): this;
+    stop(): this;
+
+    put(value: unknown, callback: Callback<string>): void;
+    get(hash: string, callback: Callback<unknown>): void;
+
+    lookup(
+        name: string,
+        options: LookupOptions,
+        callback: Callback<string[]>,
+    ): void;
+
+    lookup(
+        name: string,
+        callback: Callback<string[]>,
+    ): void;
+
+    announce(
+        name: string,
+        port: number,
+        options: AnnounceOptions,
+        callback?: Callback<void>,
+    ): void;
+
+    announce(
+        name: string,
+        port: number,
+        callback?: Callback<void>,
+    ): void;
+
+    startAnnouncing(
+        name: string,
+        port: number,
+        options: AnnounceOptions,
+        callback?: Callback<void>,
+    ): void;
+
+    startAnnouncing(
+        name: string,
+        port: number,
+        callback?: Callback<void>,
+    ): void;
+
+    stopAnnouncing(name?: string, port?: number): this;
+}
+
+export = Link;

types/grenache-nodejs-link/package.json

@@ -0,0 +1,20 @@
+{
+    "private": true,
+    "name": "@types/grenache-nodejs-link",
+    "version": "1.0.9999",
+    "projects": [
+        "https://github.com/bitfinexcom/grenache-nodejs-link"
+    ],
+    "dependencies": {
+        "@types/node": "*"
+    },
+    "devDependencies": {
+        "@types/grenache-nodejs-link": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Rami Mohamed [https://rami.sd]",
+            "githubUsername": "ramioooz"
+        }
+    ]
+}

types/grenache-nodejs-link/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "grenache-nodejs-link-tests.ts"
+    ]
+}

types/grenache-nodejs-ws/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/grenache-nodejs-ws/grenache-nodejs-ws-tests.ts

@@ -0,0 +1,31 @@
+import Link = require("grenache-nodejs-link");
+import { PeerRPCClient, PeerRPCServer } from "grenache-nodejs-ws";
+
+const link = new Link({
+    grape: "http://127.0.0.1:30001",
+});
+
+link.start();
+
+const server = new PeerRPCServer(link);
+server.init();
+
+server.listen("test_service", (payload, cb) => {
+    payload;
+    cb(null, { ok: true });
+});
+
+const client = new PeerRPCClient(link);
+client.init();
+
+client.request(
+    "test_service",
+    { ping: true },
+    {},
+    (err, data) => {
+        if (err) throw err;
+        data;
+    },
+);
+
+link.stop();

types/grenache-nodejs-ws/index.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+
+import { EventEmitter } from "events";
+import Link = require("grenache-nodejs-link");
+
+export interface RPCOptions {
+    timeout?: number | undefined;
+    retry?: number | undefined;
+}
+
+export type Callback<T = unknown> = (err: Error | null, data?: T) => void;
+
+export type RequestHandler<TRequest = unknown, TResponse = unknown> = (
+    payload: TRequest,
+    callback: Callback<TResponse>,
+) => void;
+
+export class PeerRPCClient extends EventEmitter {
+    constructor(link: Link, options?: RPCOptions);
+
+    init(): void;
+
+    request<TResponse = unknown>(
+        service: string,
+        payload: unknown,
+        options: RPCOptions,
+        callback: Callback<TResponse>,
+    ): void;
+}
+
+export class PeerRPCServer extends EventEmitter {
+    constructor(link: Link, options?: RPCOptions);
+
+    init(): void;
+
+    listen<TRequest = unknown, TResponse = unknown>(
+        service: string,
+        handler: RequestHandler<TRequest, TResponse>,
+    ): void;
+}
+
+export class PeerSub extends EventEmitter {
+    constructor(link: Link, options?: RPCOptions);
+    init(): void;
+}
+
+export class PeerPub extends EventEmitter {
+    constructor(link: Link, options?: RPCOptions);
+    init(): void;
+}
+
+export class TransportRPCServer extends EventEmitter {
+    constructor(link: Link, options?: RPCOptions);
+    init(): void;
+}
+
+export class TransportRPCClient extends EventEmitter {
+    constructor(link: Link, options?: RPCOptions);
+    init(): void;
+}

types/grenache-nodejs-ws/package.json

@@ -0,0 +1,21 @@
+{
+    "private": true,
+    "name": "@types/grenache-nodejs-ws",
+    "version": "1.0.9999",
+    "projects": [
+        "https://github.com/bitfinexcom/grenache-nodejs-ws"
+    ],
+    "dependencies": {
+        "@types/node": "*",
+        "@types/grenache-nodejs-link": "*"
+    },
+    "devDependencies": {
+        "@types/grenache-nodejs-ws": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Rami Mohamed [https://rami.sd]",
+            "githubUsername": "ramioooz"
+        }
+    ]
+}

types/grenache-nodejs-ws/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "grenache-nodejs-ws-tests.ts"
+    ]
+}