@brimble/consul 1.0.1 → 1.0.2

package/README.md

@@ -24,6 +24,7 @@ See the official [HTTP API][consul-docs-api] docs for more information.
   - [Connect](#catalog-connect)
   - [Node](#catalog-node)
   - [Service](#catalog-service)
+* [Config](#config)
 * [Event](#event)
 * [Health](#health)
 * [Intention](#intention)
@@ -1067,6 +1068,101 @@ Result
 ]
 ```
 
+<a id="config"></a>
+
+### consul.config
+
+- [list](#config-list)
+- [get](#config-get)
+- [set](#config-set)
+- [destroy](#config-destroy)
+
+<a id="config-list"></a>
+
+### consul.config.list(options)
+
+Lists config entries for a given kind.
+
+Options
+
+- kind (String): config entry kind
+- dc (String, optional): datacenter
+
+Usage
+
+```javascript
+await consul.config.list("service-resolver");
+```
+
+<a id="config-get"></a>
+
+### consul.config.get(options)
+
+Gets a config entry.
+
+Options
+
+- kind (String): config entry kind
+- name (String): config entry name
+- dc (String, optional): datacenter
+
+Usage
+
+```javascript
+await consul.config.get({
+  kind: "service-resolver",
+  name: "salary-index-ng",
+});
+```
+
+<a id="config-set"></a>
+
+### consul.config.set(entry[, options])
+
+Creates or updates a config entry.
+
+Options
+
+- entry (Object): Consul config entry payload
+- token (String, optional): ACL token
+- dc (String, optional): datacenter
+
+Usage
+
+```javascript
+await consul.config.set(
+  {
+    Kind: "service-resolver",
+    Name: "salary-index-ng",
+    Redirect: {
+      Service: "6a3ea78d3d66fd3ab1dbbb12",
+    },
+  },
+  { token: process.env.CONSUL_HTTP_TOKEN },
+);
+```
+
+<a id="config-destroy"></a>
+
+### consul.config.destroy(options)
+
+Deletes a config entry. Alias: `consul.config.delete(options)`.
+
+Options
+
+- kind (String): config entry kind
+- name (String): config entry name
+- dc (String, optional): datacenter
+
+Usage
+
+```javascript
+await consul.config.destroy({
+  kind: "service-resolver",
+  name: "salary-index-ng",
+});
+```
+
 <a id="event"></a>
 
 ### consul.event

package/lib/config.d.ts

@@ -0,0 +1,55 @@
+import { CommonOptions, Consul } from "./consul";
+
+interface ConfigEntry {
+  Kind: string;
+  Name: string;
+  Namespace?: string;
+  Partition?: string;
+  Meta?: Record<string, string>;
+  CreateIndex?: number;
+  ModifyIndex?: number;
+  [key: string]: unknown;
+}
+
+interface ListOptions extends CommonOptions {
+  kind: string;
+}
+
+type ListResult = ConfigEntry[];
+
+interface GetOptions extends CommonOptions {
+  kind: string;
+  name: string;
+}
+
+type GetResult = ConfigEntry;
+
+type SetOptions = CommonOptions;
+
+type SetResult = boolean;
+
+interface DestroyOptions extends CommonOptions {
+  kind: string;
+  name: string;
+}
+
+type DestroyResult = boolean;
+
+declare class Config {
+  constructor(consul: Consul);
+
+  consul: Consul;
+
+  list(options: ListOptions): Promise<ListResult>;
+  list(kind: string): Promise<ListResult>;
+
+  get(options: GetOptions): Promise<GetResult>;
+
+  set(entry: ConfigEntry, options?: SetOptions): Promise<SetResult>;
+
+  destroy(options: DestroyOptions): Promise<DestroyResult>;
+
+  delete(options: DestroyOptions): Promise<DestroyResult>;
+}
+
+export { Config, ConfigEntry };

package/lib/config.js

@@ -0,0 +1,117 @@
+const errors = require("./errors");
+const utils = require("./utils");
+
+class Config {
+  constructor(consul) {
+    this.consul = consul;
+  }
+
+  /**
+   * Lists config entries for a kind
+   */
+  async list(opts) {
+    if (typeof opts === "string") {
+      opts = { kind: opts };
+    }
+
+    opts = utils.normalizeKeys(opts);
+    opts = utils.defaults(opts, this.consul._defaults);
+
+    const req = {
+      name: "config.list",
+      path: "/config/{kind}",
+      params: { kind: opts.kind },
+      query: {},
+    };
+
+    if (!opts.kind) {
+      throw this.consul._err(errors.Validation("kind required"), req);
+    }
+
+    utils.options(req, opts);
+
+    return await this.consul._get(req, utils.body);
+  }
+
+  /**
+   * Gets a config entry
+   */
+  async get(opts) {
+    opts = utils.normalizeKeys(opts);
+    opts = utils.defaults(opts, this.consul._defaults);
+
+    const req = {
+      name: "config.get",
+      path: "/config/{kind}/{name}",
+      params: { kind: opts.kind, name: opts.name },
+      query: {},
+    };
+
+    if (!opts.kind) {
+      throw this.consul._err(errors.Validation("kind required"), req);
+    }
+    if (!opts.name) {
+      throw this.consul._err(errors.Validation("name required"), req);
+    }
+
+    utils.options(req, opts);
+
+    return await this.consul._get(req, utils.body);
+  }
+
+  /**
+   * Creates or updates a config entry
+   */
+  async set(entry, opts) {
+    opts = utils.normalizeKeys(opts);
+    opts = utils.defaults(opts, this.consul._defaults);
+
+    const req = {
+      name: "config.set",
+      path: "/config",
+      query: {},
+      type: "json",
+      body: entry,
+    };
+
+    if (!entry) {
+      throw this.consul._err(errors.Validation("entry required"), req);
+    }
+
+    utils.options(req, opts);
+
+    return await this.consul._put(req, utils.body);
+  }
+
+  /**
+   * Deletes a config entry
+   */
+  async destroy(opts) {
+    opts = utils.normalizeKeys(opts);
+    opts = utils.defaults(opts, this.consul._defaults);
+
+    const req = {
+      name: "config.destroy",
+      path: "/config/{kind}/{name}",
+      params: { kind: opts.kind, name: opts.name },
+      query: {},
+    };
+
+    if (!opts.kind) {
+      throw this.consul._err(errors.Validation("kind required"), req);
+    }
+    if (!opts.name) {
+      throw this.consul._err(errors.Validation("name required"), req);
+    }
+
+    utils.options(req, opts);
+
+    return await this.consul._delete(req, utils.body);
+  }
+
+  delete() {
+    return this.destroy.apply(this, arguments);
+  }
+}
+
+exports.Config = Config;

package/lib/consul.d.ts

@@ -3,6 +3,7 @@ import { Agent as httpsAgent } from "https";
 import { Acl } from "./acl";
 import { Agent } from "./agent";
 import { Catalog } from "./catalog";
+import { Config } from "./config";
 import { Event } from "./event";
 import { Health } from "./health";
 import { Intention } from "./intention";
@@ -51,6 +52,7 @@ declare class Consul {
   acl: Acl;
   agent: Agent;
   catalog: Catalog;
+  config: Config;
   event: Event;
   health: Health;
   intention: Intention;
@@ -63,6 +65,7 @@ declare class Consul {
   static Acl: typeof Acl;
   static Agent: typeof Agent;
   static Catalog: typeof Catalog;
+  static Config: typeof Config;
   static Event: typeof Event;
   static Health: typeof Health;
   static Intention: typeof Intention;

package/lib/consul.js

@@ -3,6 +3,7 @@ const papi = require("papi");
 const Acl = require("./acl").Acl;
 const Agent = require("./agent").Agent;
 const Catalog = require("./catalog").Catalog;
+const Config = require("./config").Config;
 const Event = require("./event").Event;
 const Health = require("./health").Health;
 const Intention = require("./intention").Intention;
@@ -52,6 +53,7 @@ class Consul extends papi.Client {
     this.acl = new Consul.Acl(this);
     this.agent = new Consul.Agent(this);
     this.catalog = new Consul.Catalog(this);
+    this.config = new Consul.Config(this);
     this.event = new Consul.Event(this);
     this.health = new Consul.Health(this);
     this.intention = new Consul.Intention(this);
@@ -84,6 +86,7 @@ class Consul extends papi.Client {
 Consul.Acl = Acl;
 Consul.Agent = Agent;
 Consul.Catalog = Catalog;
+Consul.Config = Config;
 Consul.Event = Event;
 Consul.Health = Health;
 Consul.Intention = Intention;

package/lib/index.d.ts

@@ -1,18 +1,3 @@
-import { Consul, SelectionAlgorithm } from "./consul";
-import {
-  ConsulResolverConfig,
-  ServiceInfo,
-  OptimalServiceResult,
-  ServiceMetrics,
-  Resolver,
-} from "./resolver";
+import { Consul } from "./consul";
 
 export = Consul;
-
-export type {
-  ConsulResolverConfig,
-  ServiceInfo,
-  OptimalServiceResult,
-  ServiceMetrics,
-};
-export { SelectionAlgorithm, Resolver };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brimble/consul",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Consul client",
   "main": "./lib",
   "types": "./lib/index.d.ts",