@kurrent/kurrentdb-client 0.1.0

package/README.md

@@ -0,0 +1,201 @@
+# @kurrent/kurrentdb-client
+
+[![npm][npm-badge]][npm-badge-url]
+[![Github action CI workflow][ci-badge]][ci-badge-url]
+[![license][license-badge]][license-badge-url]
+
+This is the package for the NodeJS client for KurrentDB 20+ and uses gRPC as the communication protocol.
+
+## Installation
+
+```shell script
+# Yarn
+$ yarn add @kurrent/kurrentdb-client
+
+# NPM
+$ npm install --save @kurrent/kurrentdb-client
+```
+
+## KurrentDB Server Compatibility
+
+Tests are run exclusively against Long-Term Support (LTS) versions. While the code may function with older versions, we do not provide any guarantees or support for them.
+
+Server setup instructions can be found under the installation section of the [Kurrent Docs]. Follow the Docker setup for the simplest configuration.
+
+## Example
+
+The following snippet showcases a simple example where we form a connection, then append and read events from the server.
+
+###### Javascript example:
+
+```javascript
+const {
+  KurrentDBClient,
+  jsonEvent,
+  FORWARDS,
+  START,
+} = require('@kurrent/kurrentdb-client');
+
+const client = new KurrentDBClient({
+  endpoint: "localhost:2113",
+});
+
+async function simpleTest() {
+  const streamName = "es_supported_clients";
+
+  const event = jsonEvent({
+    type: "grpc-client",
+    data: {
+      languages: ["typescript", "javascript"],
+      runtime: "NodeJS",
+    },
+  });
+
+  const appendResult = await client.appendToStream(streamName, [event]);
+
+    // read the event
+    const events = client.readStream(streamName, {
+      fromRevision: START,
+      direction: FORWARDS,
+      maxCount: 10,
+    });
+
+    for await (const { event } of events) {
+      console.log('Appended event: ', event);
+    }
+  } catch (error) {
+    console.error('An error occured: ', error);
+  } finally {
+    await client.dispose();
+  }
+})();
+```
+
+###### Typescript example:
+
+```typescript
+import {
+  KurrentDBClient,
+  jsonEvent,
+  FORWARDS,
+  START,
+  JSONEventType,
+} from '@kurrent/kurrentdb-client';
+
+const client = new KurrentDBClient({
+  endpoint: 'localhost:2113',
+});
+
+interface Reservation {
+  reservationId: string;
+  movieId: string;
+  userId: string;
+  seatId: string;
+}
+
+type SeatReservedEvent = JSONEventType<
+  'seat-reserved',
+  {
+    reservationId: string;
+    movieId: string;
+    userId: string;
+    seatId: string;
+  }
+>;
+
+type SeatChangedEvent = JSONEventType<
+  'seat-changed',
+  {
+    reservationId: string;
+    newSeatId: string;
+  }
+>;
+
+type ReservationEvents = SeatReservedEvent | SeatChangedEvent;
+
+async function simpleTest(): Promise<void> {
+  const streamName = 'booking-abc123';
+
+  const event = jsonEvent<SeatReservedEvent>({
+    type: 'seat-reserved',
+    data: {
+      reservationId: 'abc123',
+      movieId: 'tt0368226',
+      userId: 'nm0802995',
+      seatId: '4b',
+    },
+  });
+
+  const appendResult = await client.appendToStream<ReservationEvents>(
+    streamName,
+    event
+  );
+
+  // By reading the events in the stream, we can construct the current state of the booking
+
+  interface Reservation {
+    reservationId: string;
+    movieId: string;
+    userId: string;
+    seatId: string;
+  }
+
+  const events = client.readStream<ReservationEvents>(streamName, {
+    fromRevision: START,
+    direction: FORWARDS,
+    maxCount: 10,
+  });
+
+  const reservation: Partial<Reservation> = {};
+
+  for await (const { event } of events) {
+    switch (event.type) {
+      case 'seat-reserved': {
+        reservation.reservationId = event.data.reservationId;
+        reservation.movieId = event.data.movieId;
+        reservation.seatId = event.data.seatId;
+        reservation.userId = event.data.userId;
+        break;
+      }
+      case 'seat-changed': {
+        reservation.seatId = event.data.newSeatId;
+        break;
+      }
+      default: {
+        const _exhaustiveCheck: never = event;
+        break;
+      }
+    }
+  }
+}
+
+// Do something with our reservation
+console.log(reservation);
+```
+
+## Support
+
+Information on support can be found on our website: [Kurrent Support]
+
+## Communities
+
+- [Discuss]
+- [Discord (Kurrent)][discord-kurrent]
+- [Discord (ddd-cqrs-es)][discord-ddd-cqrs-es]
+
+## Contributing
+
+Refer to our [Contribution Guidelines]
+
+[Kurrent support]: https://kurrent.io/support/
+[discuss]: https://discuss.kurrent.io/
+[discord-kurrent]: https://discord.gg/Phn9pmCw3t
+[discord-ddd-cqrs-es]: https://discord.com/invite/sEZGSHNNbH
+[npm-badge]: https://img.shields.io/npm/v/@kurrent/kurrentdb-client.svg
+[npm-badge-url]: https://www.npmjs.com/package/@kurrent/kurrentdb-client
+[ci-badge]: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/workflows/CI/badge.svg?branch=master
+[ci-badge-url]: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions
+[license-badge]: https://img.shields.io/npm/l/@kurrent/kurrentdb-client.svg
+[license-badge-url]: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/blob/master/LICENSE
+[contribution guidelines]: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/blob/master/CONTRIBUTING.md
+[Kurrent docs]: https://docs.kurrent.io/server/v25.0/quick-start/installation.html

package/dist/Client/ServerFeatures.d.ts

@@ -0,0 +1,17 @@
+import type { MethodDefinition, ServiceError } from "@grpc/grpc-js";
+import { ServerFeaturesClient } from "../../generated/serverfeatures_grpc_pb";
+import type { SupportedMethods } from "../../generated/serverfeatures_pb";
+import type { GRPCClientConstructor } from "../types";
+type ExecuteClientCapabilities = [
+    GRPCClientConstructor<ServerFeaturesClient>,
+    string,
+    (c: ServerFeaturesClient) => Promise<ServerFeatures>
+];
+export declare class ServerFeatures {
+    #private;
+    serverVersion: string;
+    static readonly createServerFeatures: ExecuteClientCapabilities;
+    constructor(error: ServiceError | null, supportedMethods: SupportedMethods);
+    supports: (method: MethodDefinition<any, any>, feature?: string) => boolean;
+}
+export {};

package/dist/Client/ServerFeatures.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerFeatures = void 0;
+const shared_pb_1 = require("../../generated/shared_pb");
+const serverfeatures_grpc_pb_1 = require("../../generated/serverfeatures_grpc_pb");
+const utils_1 = require("../utils");
+const constants_1 = require("@grpc/grpc-js/build/src/constants");
+const UNKNOWN = "unknown";
+class ServerFeatures {
+    serverVersion = UNKNOWN;
+    #supported = new Map();
+    static createServerFeatures = [
+        serverfeatures_grpc_pb_1.ServerFeaturesClient,
+        "getSupportedMethods",
+        (client) => new Promise((resolve, reject) => {
+            utils_1.debug.connection("Fetching server features");
+            client.getSupportedMethods(new shared_pb_1.Empty(), (error, supportedMethods) => {
+                if (error && error.code !== constants_1.Status.UNIMPLEMENTED) {
+                    return reject(error);
+                }
+                return resolve(new ServerFeatures(error, supportedMethods));
+            });
+        }),
+    ];
+    constructor(error, supportedMethods) {
+        if (error) {
+            utils_1.debug.connection("Failed to fetch server features with error: %s", error.message);
+            utils_1.debug.connection("Assuming unknown server version.");
+            return;
+        }
+        this.serverVersion = supportedMethods.getEventStoreServerVersion();
+        utils_1.debug.connection("Connected to server version %s", this.serverVersion);
+        for (const method of supportedMethods.getMethodsList()) {
+            const path = `/${method.getServiceName()}/${method.getMethodName()}`.toLowerCase();
+            const features = method.getFeaturesList();
+            this.#supported.set(path, new Set(features));
+        }
+    }
+    supports = (
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    method, feature) => {
+        const path = method.path.toLowerCase();
+        const isSupported = feature
+            ? !!this.#supported.get(path)?.has(feature)
+            : this.#supported.has(path);
+        if (isSupported) {
+            utils_1.debug.connection("%s %s is Supported", path, feature ?? "");
+        }
+        else {
+            utils_1.debug.connection("%s %s is not Supported", path, feature ?? "");
+        }
+        return isSupported;
+    };
+}
+exports.ServerFeatures = ServerFeatures;
+//# sourceMappingURL=ServerFeatures.js.map

package/dist/Client/ServerFeatures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerFeatures.js","sourceRoot":"","sources":["../../src/Client/ServerFeatures.ts"],"names":[],"mappings":";;;AAEA,yDAAkD;AAClD,mFAA8E;AAG9E,oCAAiC;AAEjC,iEAA2D;AAQ3D,MAAM,OAAO,GAAG,SAAS,CAAC;AAE1B,MAAa,cAAc;IAClB,aAAa,GAAW,OAAO,CAAC;IAEvC,UAAU,GAAG,IAAI,GAAG,EAAuB,CAAC;IAE5C,MAAM,CAAU,oBAAoB,GAA8B;QAChE,6CAAoB;QACpB,qBAAqB;QACrB,CAAC,MAA4B,EAAE,EAAE,CAC/B,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9C,aAAK,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;YAC7C,MAAM,CAAC,mBAAmB,CAAC,IAAI,iBAAK,EAAE,EAAE,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE;gBAClE,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAM,CAAC,aAAa,EAAE,CAAC;oBACjD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;gBACD,OAAO,OAAO,CAAC,IAAI,cAAc,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;KACL,CAAC;IAEF,YAAY,KAA0B,EAAE,gBAAkC;QACxE,IAAI,KAAK,EAAE,CAAC;YACV,aAAK,CAAC,UAAU,CACd,gDAAgD,EAChD,KAAK,CAAC,OAAO,CACd,CAAC;YACF,aAAK,CAAC,UAAU,CAAC,kCAAkC,CAAC,CAAC;YACrD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC,0BAA0B,EAAE,CAAC;QAEnE,aAAK,CAAC,UAAU,CAAC,gCAAgC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAEvE,KAAK,MAAM,MAAM,IAAI,gBAAgB,CAAC,cAAc,EAAE,EAAE,CAAC;YACvD,MAAM,IAAI,GACR,IAAI,MAAM,CAAC,cAAc,EAAE,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC,WAAW,EAAE,CAAC;YACxE,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;YAC1C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAEM,QAAQ,GAAG;IAChB,8DAA8D;IAC9D,MAAkC,EAClC,OAAgB,EACP,EAAE;QACX,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,WAAW,GAAG,OAAO;YACzB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;YAC3C,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,WAAW,EAAE,CAAC;YAChB,aAAK,CAAC,UAAU,CAAC,oBAAoB,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QAC9D,CAAC;aAAM,CAAC;YACN,aAAK,CAAC,UAAU,CAAC,wBAAwB,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;;AA3DJ,wCA4DC"}

package/dist/Client/discovery.d.ts

@@ -0,0 +1,15 @@
+import { ChannelCredentials } from "@grpc/grpc-js";
+import { EndPoint, NodePreference, VNodeState } from "../types";
+import type { DNSClusterOptions, GossipClusterOptions } from ".";
+export interface MemberInfo {
+    instanceId?: string;
+    timeStamp: number;
+    state: VNodeState;
+    isAlive: boolean;
+    httpEndpoint?: EndPoint;
+}
+export declare const discoverEndpoint: ({ discoveryInterval, maxDiscoverAttempts, gossipTimeout, nodePreference, ...settings }: DNSClusterOptions | GossipClusterOptions, credentials: ChannelCredentials, failedEndpoint?: EndPoint) => Promise<EndPoint>;
+export declare const isInAllowedState: (member: MemberInfo) => boolean;
+export declare const filterAndOrderMembers: (preference: NodePreference, members: MemberInfo[]) => MemberInfo[];
+export declare const determineBestNode: (preference: NodePreference, members: MemberInfo[]) => EndPoint | undefined;
+export declare const delay: (timeout: number) => Promise<void>;

package/dist/Client/discovery.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.delay = exports.determineBestNode = exports.filterAndOrderMembers = exports.isInAllowedState = exports.discoverEndpoint = void 0;
+const grpc_js_1 = require("@grpc/grpc-js");
+const gossip_grpc_pb_1 = require("../../generated/gossip_grpc_pb");
+const shared_pb_1 = require("../../generated/shared_pb");
+const types_1 = require("../types");
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const discoverEndpoint = async ({ discoveryInterval = 100, maxDiscoverAttempts = 10, gossipTimeout = 5, nodePreference = constants_1.LEADER, ...settings }, credentials, failedEndpoint) => {
+    let discoverAttempts = 0;
+    while (discoverAttempts < maxDiscoverAttempts) {
+        discoverAttempts++;
+        try {
+            const candidates = "endpoints" in settings ? settings.endpoints : [settings.discover];
+            utils_1.debug.connection(`Starting discovery for candidates: %O`, candidates);
+            const candidateDiscoveryOrder = [...candidates]
+                .sort(shuffle)
+                .sort((a) => {
+                // Move failed endpoint to the last
+                if (a.address === failedEndpoint?.address &&
+                    a.port === failedEndpoint?.port) {
+                    return 1;
+                }
+                return 0;
+            });
+            for (const candidate of candidateDiscoveryOrder) {
+                try {
+                    const members = await listClusterMembers(candidate, credentials, createDeadline(gossipTimeout));
+                    const endpoint = (0, exports.determineBestNode)(nodePreference, members);
+                    if (endpoint)
+                        return Promise.resolve(endpoint);
+                }
+                catch (error) {
+                    utils_1.debug.connection(`Failed to get cluster list from ${candidate.address}:${candidate.port}`, error.toString());
+                    continue;
+                }
+            }
+        }
+        catch (error) {
+            utils_1.debug.connection(`Failed to resolve dns: `, error.toString());
+        }
+        await (0, exports.delay)(discoveryInterval);
+    }
+    throw new Error(`Failed to discover after ${discoverAttempts} attempts.`);
+};
+exports.discoverEndpoint = discoverEndpoint;
+const allowedStates = new Set([
+    types_1.VNodeState.FOLLOWER,
+    types_1.VNodeState.LEADER,
+    types_1.VNodeState.READONLYREPLICA,
+    types_1.VNodeState.PREREADONLYREPLICA,
+    types_1.VNodeState.READONLYLEADERLESS,
+]);
+const isInAllowedState = (member) => member.isAlive && allowedStates.has(member.state);
+exports.isInAllowedState = isInAllowedState;
+// getPreferedStates, higher index is better
+const getPreferedStates = (preference) => {
+    switch (preference) {
+        case constants_1.LEADER:
+            return [types_1.VNodeState.LEADER];
+        case constants_1.FOLLOWER:
+            return [types_1.VNodeState.FOLLOWER];
+        case constants_1.READ_ONLY_REPLICA:
+            return [
+                types_1.VNodeState.READONLYLEADERLESS,
+                types_1.VNodeState.PREREADONLYREPLICA,
+                types_1.VNodeState.READONLYREPLICA,
+            ];
+        default:
+            return [];
+    }
+};
+const compareByPreference = (preference) => {
+    const preferedStates = getPreferedStates(preference);
+    return (a, b) => preferedStates.indexOf(b.state) - preferedStates.indexOf(a.state);
+};
+const shuffle = () => Math.random() - 0.5;
+const filterAndOrderMembers = (preference, members) => members
+    .filter(exports.isInAllowedState)
+    .sort(shuffle)
+    .sort(compareByPreference(preference));
+exports.filterAndOrderMembers = filterAndOrderMembers;
+const determineBestNode = (preference, members) => {
+    utils_1.debug.connection(`Determining best node with preference "%s" from members: %O`, preference, members);
+    const [chosenMember] = (0, exports.filterAndOrderMembers)(preference, members);
+    if (!chosenMember || !chosenMember.httpEndpoint)
+        return undefined;
+    utils_1.debug.connection(`Chose member: %O`, chosenMember);
+    return {
+        address: chosenMember.httpEndpoint.address,
+        port: chosenMember.httpEndpoint.port,
+    };
+};
+exports.determineBestNode = determineBestNode;
+function createDeadline(seconds) {
+    const deadline = new Date();
+    deadline.setSeconds(deadline.getSeconds() + seconds);
+    return deadline;
+}
+function listClusterMembers(seed, credentials, deadline) {
+    const uri = `${seed.address}:${seed.port}`;
+    const client = new gossip_grpc_pb_1.GossipClient(uri, credentials, {});
+    return new Promise((resolve, reject) => {
+        client.read(new shared_pb_1.Empty(), new grpc_js_1.Metadata(), { deadline }, (error, info) => {
+            // regardless of the outcome, we are done with this client.
+            client.close();
+            if (error)
+                return reject(error);
+            const members = [];
+            for (const grpcMember of info.getMembersList()) {
+                let httpEndpoint;
+                const grpcHttpEndpoint = grpcMember.getHttpEndPoint();
+                if (grpcHttpEndpoint) {
+                    httpEndpoint = {
+                        address: grpcHttpEndpoint.getAddress(),
+                        port: grpcHttpEndpoint.getPort(),
+                    };
+                }
+                const member = {
+                    instanceId: (0, utils_1.parseUUID)(grpcMember.getInstanceId()),
+                    timeStamp: parseInt(grpcMember.getTimeStamp(), 10),
+                    state: grpcMember.getState(),
+                    isAlive: grpcMember.getIsAlive(),
+                    httpEndpoint,
+                };
+                members.push(member);
+            }
+            return resolve(members);
+        });
+    });
+}
+const delay = (timeout) => new Promise((resolve) => setTimeout(resolve, timeout));
+exports.delay = delay;
+//# sourceMappingURL=discovery.js.map

package/dist/Client/discovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../../src/Client/discovery.ts"],"names":[],"mappings":";;;AAAA,2CAA6D;AAE7D,mEAA8D;AAC9D,yDAAkD;AAElD,oCAAgE;AAChE,4CAAmE;AACnE,oCAA4C;AAWrC,MAAM,gBAAgB,GAAG,KAAK,EACnC,EACE,iBAAiB,GAAG,GAAG,EACvB,mBAAmB,GAAG,EAAE,EACxB,aAAa,GAAG,CAAC,EACjB,cAAc,GAAG,kBAAM,EACvB,GAAG,QAAQ,EAC8B,EAC3C,WAA+B,EAC/B,cAAyB,EACN,EAAE;IACrB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IAEzB,OAAO,gBAAgB,GAAG,mBAAmB,EAAE,CAAC;QAC9C,gBAAgB,EAAE,CAAC;QAEnB,IAAI,CAAC;YACH,MAAM,UAAU,GACd,WAAW,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAErE,aAAK,CAAC,UAAU,CAAC,uCAAuC,EAAE,UAAU,CAAC,CAAC;YAEtE,MAAM,uBAAuB,GAAG,CAAC,GAAG,UAAU,CAAC;iBAC5C,IAAI,CAAC,OAAO,CAAC;iBACb,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,mCAAmC;gBACnC,IACE,CAAC,CAAC,OAAO,KAAK,cAAc,EAAE,OAAO;oBACrC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE,IAAI,EAC/B,CAAC;oBACD,OAAO,CAAC,CAAC;gBACX,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;YAEL,KAAK,MAAM,SAAS,IAAI,uBAAuB,EAAE,CAAC;gBAChD,IAAI,CAAC;oBACH,MAAM,OAAO,GAAG,MAAM,kBAAkB,CACtC,SAAS,EACT,WAAW,EACX,cAAc,CAAC,aAAa,CAAC,CAC9B,CAAC;oBACF,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC;oBAC5D,IAAI,QAAQ;wBAAE,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACjD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,aAAK,CAAC,UAAU,CACd,mCAAmC,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,EACxE,KAAK,CAAC,QAAQ,EAAE,CACjB,CAAC;oBACF,SAAS;gBACX,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAK,CAAC,UAAU,CAAC,yBAAyB,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,IAAA,aAAK,EAAC,iBAAiB,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,gBAAgB,YAAY,CAAC,CAAC;AAC5E,CAAC,CAAC;AA5DW,QAAA,gBAAgB,oBA4D3B;AAEF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,kBAAU,CAAC,QAAQ;IACnB,kBAAU,CAAC,MAAM;IACjB,kBAAU,CAAC,eAAe;IAC1B,kBAAU,CAAC,kBAAkB;IAC7B,kBAAU,CAAC,kBAAkB;CAC9B,CAAC,CAAC;AAEI,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAAW,EAAE,CAC9D,MAAM,CAAC,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AADvC,QAAA,gBAAgB,oBACuB;AAEpD,4CAA4C;AAC5C,MAAM,iBAAiB,GAAG,CAAC,UAA0B,EAAE,EAAE;IACvD,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,kBAAM;YACT,OAAO,CAAC,kBAAU,CAAC,MAAM,CAAC,CAAC;QAC7B,KAAK,oBAAQ;YACX,OAAO,CAAC,kBAAU,CAAC,QAAQ,CAAC,CAAC;QAC/B,KAAK,6BAAiB;YACpB,OAAO;gBACL,kBAAU,CAAC,kBAAkB;gBAC7B,kBAAU,CAAC,kBAAkB;gBAC7B,kBAAU,CAAC,eAAe;aAC3B,CAAC;QACJ;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAGF,MAAM,mBAAmB,GAAG,CAC1B,UAA0B,EACH,EAAE;IACzB,MAAM,cAAc,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACrD,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACd,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC;AACF,MAAM,OAAO,GAAuB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC;AAEvD,MAAM,qBAAqB,GAAG,CACnC,UAA0B,EAC1B,OAAqB,EACP,EAAE,CAChB,OAAO;KACJ,MAAM,CAAC,wBAAgB,CAAC;KACxB,IAAI,CAAC,OAAO,CAAC;KACb,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;AAP9B,QAAA,qBAAqB,yBAOS;AAEpC,MAAM,iBAAiB,GAAG,CAC/B,UAA0B,EAC1B,OAAqB,EACC,EAAE;IACxB,aAAK,CAAC,UAAU,CACd,6DAA6D,EAC7D,UAAU,EACV,OAAO,CACR,CAAC;IAEF,MAAM,CAAC,YAAY,CAAC,GAAG,IAAA,6BAAqB,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAElE,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,YAAY;QAAE,OAAO,SAAS,CAAC;IAElE,aAAK,CAAC,UAAU,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;IAEnD,OAAO;QACL,OAAO,EAAE,YAAY,CAAC,YAAY,CAAC,OAAO;QAC1C,IAAI,EAAE,YAAY,CAAC,YAAY,CAAC,IAAI;KACrC,CAAC;AACJ,CAAC,CAAC;AApBW,QAAA,iBAAiB,qBAoB5B;AAEF,SAAS,cAAc,CAAC,OAAe;IACrC,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,CAAC;IACrD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAc,EACd,WAA+B,EAC/B,QAAc;IAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IAC3C,MAAM,MAAM,GAAG,IAAI,6BAAY,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IAEtD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,IAAI,iBAAK,EAAE,EAAE,IAAI,kBAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACrE,2DAA2D;YAC3D,MAAM,CAAC,KAAK,EAAE,CAAC;YAEf,IAAI,KAAK;gBAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAiB,EAAE,CAAC;YAEjC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,IAAI,YAAY,CAAC;gBACjB,MAAM,gBAAgB,GAAG,UAAU,CAAC,eAAe,EAAE,CAAC;gBAEtD,IAAI,gBAAgB,EAAE,CAAC;oBACrB,YAAY,GAAG;wBACb,OAAO,EAAE,gBAAgB,CAAC,UAAU,EAAE;wBACtC,IAAI,EAAE,gBAAgB,CAAC,OAAO,EAAE;qBACjC,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAe;oBACzB,UAAU,EAAE,IAAA,iBAAS,EAAC,UAAU,CAAC,aAAa,EAAE,CAAC;oBACjD,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,EAAE,CAAC;oBAClD,KAAK,EAAE,UAAU,CAAC,QAAQ,EAAE;oBAC5B,OAAO,EAAE,UAAU,CAAC,UAAU,EAAE;oBAChC,YAAY;iBACb,CAAC;gBAEF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAEM,MAAM,KAAK,GAAG,CAAC,OAAe,EAAiB,EAAE,CACtD,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAD5C,QAAA,KAAK,SACuC"}

package/dist/Client/http.d.ts

@@ -0,0 +1,19 @@
+import { IncomingMessage } from "http";
+import type { Credentials, BaseOptions } from "../types";
+import type { ChannelCredentialOptions, Client } from "./";
+type TransformError = (statusCode: number, statusMessage: string, res: IncomingMessage) => Error | undefined;
+export interface HTTPRequestOptions extends BaseOptions {
+    headers?: Record<string, string>;
+    searchParams?: Record<string, string | undefined>;
+    transformError?: TransformError;
+}
+type HTTPMethod = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
+export declare class HTTP {
+    #private;
+    constructor(client: Client, channelCredentials: ChannelCredentialOptions, defaultUserCredentials?: Credentials);
+    request: <T = unknown>(method: HTTPMethod, path: string, { searchParams, ...options }: HTTPRequestOptions, body?: string) => Promise<T>;
+    private makeRequest;
+    private createURL;
+    private getChannel;
+}
+export {};

package/dist/Client/http.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTP = void 0;
+const http_1 = require("http");
+const https_1 = require("https");
+const url_1 = require("url");
+const utils_1 = require("../utils");
+class HTTP {
+    #client;
+    #channelCredentials;
+    #defaultUserCredentials;
+    #insecure;
+    constructor(client, channelCredentials, defaultUserCredentials) {
+        this.#client = client;
+        this.#channelCredentials = channelCredentials;
+        this.#defaultUserCredentials = defaultUserCredentials;
+        this.#insecure = !!channelCredentials.insecure;
+    }
+    request = async (method, path, { searchParams, ...options }, body) => {
+        const url = await this.createURL(path, searchParams);
+        return this.makeRequest(method, url, options, body);
+    };
+    makeRequest = async (method, url, options, body) => new Promise((resolve, reject) => {
+        const headers = {
+            "content-type": "application/json",
+            ...(options.headers ?? {}),
+        };
+        const credentials = options.credentials ?? this.#defaultUserCredentials;
+        if (!this.#insecure && credentials) {
+            headers["Authorization"] = `Basic ${Buffer.from(`${credentials.username}:${credentials.password}`).toString("base64")}`;
+        }
+        const ca = this.#channelCredentials.rootCertificate
+            ? [this.#channelCredentials.rootCertificate]
+            : undefined;
+        const callback = (res) => {
+            if (res.statusCode === 307) {
+                return resolve(this.makeRequest(method, new url_1.URL(res.headers.location, url), options, body));
+            }
+            if (res.statusCode < 200 || res.statusCode >= 300) {
+                const error = options.transformError?.(res.statusCode, res.statusMessage, res) ??
+                    defaultTransformError(res.statusCode, res.statusMessage, res);
+                return reject(error);
+            }
+            let response = "";
+            res.on("data", (d) => {
+                response += d;
+            });
+            res.on("end", () => {
+                return resolve(JSON.parse(response));
+            });
+        };
+        utils_1.debug.connection(`Making %s call to %s with headers %h`, method, url.toString(), headers);
+        const req = this.#insecure
+            ? (0, http_1.request)(url, {
+                method,
+                headers,
+            }, callback)
+            : (0, https_1.request)(url, {
+                method,
+                headers,
+                ca,
+            }, callback);
+        req.on("error", (error) => {
+            reject(error);
+        });
+        if (body) {
+            req.write(body);
+        }
+        req.end();
+    });
+    createURL = async (pathname, searchParams = {}) => {
+        const channel = await this.getChannel.call(this.#client);
+        const protocol = this.#insecure ? "http://" : "https://";
+        const target = channel.getTarget().replace(/^[a-z]*:/, protocol);
+        const url = new url_1.URL(target);
+        url.pathname = pathname;
+        for (const [key, value] of Object.entries(searchParams)) {
+            if (value != null) {
+                url.searchParams.set(key, value);
+            }
+        }
+        return url;
+    };
+    getChannel() {
+        return this.getChannel();
+    }
+}
+exports.HTTP = HTTP;
+const defaultTransformError = (statusCode, statusMessage) => {
+    switch (statusCode) {
+        case 401: {
+            return new utils_1.AccessDeniedError();
+        }
+    }
+    return new utils_1.UnknownError(undefined, statusMessage);
+};
+//# sourceMappingURL=http.js.map

package/dist/Client/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/Client/http.ts"],"names":[],"mappings":";;;AAEA,+BAA+D;AAC/D,iCAAgD;AAChD,6BAA0B;AAG1B,oCAAkE;AA2BlE,MAAa,IAAI;IACf,OAAO,CAAU;IACjB,mBAAmB,CAA4B;IAC/C,uBAAuB,CAAe;IACtC,SAAS,CAAU;IAEnB,YACE,MAAc,EACd,kBAA4C,EAC5C,sBAAoC;QAEpC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;QAC9C,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC;IACjD,CAAC;IAEM,OAAO,GAAG,KAAK,EACpB,MAAkB,EAClB,IAAY,EACZ,EAAE,YAAY,EAAE,GAAG,OAAO,EAAsB,EAChD,IAAa,EACD,EAAE;QACd,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,WAAW,CAAI,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC;IAEM,WAAW,GAAG,KAAK,EACzB,MAAkB,EAClB,GAAQ,EACR,OAA2B,EAC3B,IAAa,EACb,EAAE,CACF,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACjC,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;YAClC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;SAC3B,CAAC;QACF,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,uBAAuB,CAAC;QAExE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,WAAW,EAAE,CAAC;YACnC,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,MAAM,CAAC,IAAI,CAC7C,GAAG,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,EAAE,CAClD,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,eAAe;YACjD,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC;YAC5C,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,QAAQ,GAAG,CAAC,GAAoB,EAAE,EAAE;YACxC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC3B,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,CACd,MAAM,EACN,IAAI,SAAG,CAAC,GAAG,CAAC,OAAO,CAAC,QAAS,EAAE,GAAG,CAAC,EACnC,OAAO,EACP,IAAI,CACL,CACF,CAAC;YACJ,CAAC;YAED,IAAI,GAAG,CAAC,UAAW,GAAG,GAAG,IAAI,GAAG,CAAC,UAAW,IAAI,GAAG,EAAE,CAAC;gBACpD,MAAM,KAAK,GACT,OAAO,CAAC,cAAc,EAAE,CACtB,GAAG,CAAC,UAAW,EACf,GAAG,CAAC,aAAc,EAClB,GAAG,CACJ;oBACD,qBAAqB,CAAC,GAAG,CAAC,UAAW,EAAE,GAAG,CAAC,aAAc,EAAE,GAAG,CAAC,CAAC;gBAElE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;gBACnB,QAAQ,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,aAAK,CAAC,UAAU,CACd,sCAAsC,EACtC,MAAM,EACN,GAAG,CAAC,QAAQ,EAAE,EACd,OAAO,CACR,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS;YACxB,CAAC,CAAC,IAAA,cAAW,EACT,GAAG,EACH;gBACE,MAAM;gBACN,OAAO;aACR,EACD,QAAQ,CACT;YACH,CAAC,CAAC,IAAA,eAAY,EACV,GAAG,EACH;gBACE,MAAM;gBACN,OAAO;gBACP,EAAE;aACH,EACD,QAAQ,CACT,CAAC;QAEN,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACxB,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,EAAE,CAAC;YACT,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAED,GAAG,CAAC,GAAG,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEG,SAAS,GAAG,KAAK,EACvB,QAAgB,EAChB,eAAmD,EAAE,EACvC,EAAE;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QACzD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACjE,MAAM,GAAG,GAAG,IAAI,SAAG,CAAC,MAAM,CAAC,CAAC;QAC5B,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAExB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEM,UAAU;QAChB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;CACF;AA/ID,oBA+IC;AAED,MAAM,qBAAqB,GAAmB,CAAC,UAAU,EAAE,aAAa,EAAE,EAAE;IAC1E,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,GAAG,CAAC,CAAC,CAAC;YACT,OAAO,IAAI,yBAAiB,EAAE,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,oBAAY,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACpD,CAAC,CAAC"}