@homecloud-platform/sdk 0.5.0 → 0.5.3

package/README.md

@@ -2,9 +2,9 @@
 
 Part of the **homecloud-sdk** monorepo — Python at repo root; Node in `js/`.
 
-**Expectation:** Node supports the **same product surface** as Python (`homecloud-sdk`), released under the **same** `v*` version. See [PARITY.md](./PARITY.md) for the checklist (what is shipped vs still TODO).
+**Expectation:** Node supports the **same product surface** as Python (`homecloud-sdk`), released under the **same** `v*` version. See [PARITY.md](./PARITY.md).
 
-Today’s npm package is an **MVP** (Functions / STS-first). Missing APIs are gaps to close, not “out of scope.”
+Shipped as of **0.5.0**: SO / MQ / Secrets / Mail / Functions / Apps / Accounts / Queues, typed errors, `fromEnv` / `fromProfile` / `fromCredentials` / `fromSts` / `fromFunctionContext`, console login helpers.
 
 ## Install
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homecloud-platform/sdk",
-  "version": "0.5.0",
+  "version": "0.5.3",
   "description": "HomeCloud Functions SDK for Node.js (ADR-033 / ADR-025e)",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/management.js

@@ -39,14 +39,23 @@ class QueuesAPI {
     this._c = client;
   }
 
-  async list() {
+  async list({ live = false } = {}) {
     this._c.requireConsole();
     const data = await this._c.consoleRequest(
       "GET",
-      `accounts/${this._c.accountId}/queues`
+      `accounts/${this._c.accountId}/queues`,
+      { params: live ? { live: "true" } : undefined }
     );
     return data.items || [];
   }
+
+  async get(queueName) {
+    this._c.requireConsole();
+    return this._c.consoleRequest(
+      "GET",
+      `accounts/${this._c.accountId}/queues/${encodeURIComponent(queueName)}`
+    );
+  }
 }
 
 class FunctionsAPI {

package/src/mq.js

@@ -1,5 +1,41 @@
 "use strict";
 
+const MQ_BATCH_MAX = 10;
+
+function entryBodyStr(value) {
+  if (typeof value === "string") {
+    if (!value) throw new Error("mq.send batch entry body must be non-empty");
+    return value;
+  }
+  return JSON.stringify(value);
+}
+
+function buildMqBatchEntries(items) {
+  if (!Array.isArray(items) || items.length < 1 || items.length > MQ_BATCH_MAX) {
+    throw new Error(`mq.send batch requires 1–${MQ_BATCH_MAX} messages`);
+  }
+  const entries = [];
+  const seenIds = new Set();
+  for (let index = 0; index < items.length; index += 1) {
+    const item = items[index];
+    let entry;
+    if (item && typeof item === "object" && typeof item.body === "string") {
+      const entryId = item.id != null ? String(item.id) : String(index);
+      if (!item.body) throw new Error("mq.send batch entry body must be non-empty");
+      entry = { id: entryId, body: item.body };
+      if (item.headers) entry.headers = item.headers;
+    } else {
+      entry = { id: String(index), body: entryBodyStr(item) };
+    }
+    if (seenIds.has(entry.id)) {
+      throw new Error("mq.send batch entry ids must be unique");
+    }
+    seenIds.add(entry.id);
+    entries.push(entry);
+  }
+  return entries;
+}
+
 class MqAPI {
   constructor(client) {
     this._c = client;
@@ -8,6 +44,15 @@ class MqAPI {
   async send(queueName, body, { headers } = {}) {
     this._c.requireAccessKey();
     const accountId = this._c.accountId;
+    if (Array.isArray(body)) {
+      if (headers != null) {
+        throw new Error("headers is only supported for single mq.send, not batch");
+      }
+      const reqPath = `/${accountId}/${queueName}/messages/batch`;
+      return this._c.dataPlaneRequest("mq", "POST", reqPath, {
+        json: { entries: buildMqBatchEntries(body) },
+      });
+    }
     const reqPath = `/${accountId}/${queueName}/messages`;
     const bodyStr = typeof body === "string" ? body : JSON.stringify(body);
     const payload = { body: bodyStr };
@@ -15,15 +60,53 @@ class MqAPI {
     return this._c.dataPlaneRequest("mq", "POST", reqPath, { json: payload });
   }
 
-  async receive(queueName, { maxMessages = 1, waitSeconds = 20 } = {}) {
+  async receive(queueName, { maxMessages = 1, waitSeconds = 20, delete: shouldDelete = false } = {}) {
     this._c.requireAccessKey();
     const accountId = this._c.accountId;
     const reqPath = `/${accountId}/${queueName}/messages`;
-    const data = await this._c.dataPlaneRequest("mq", "GET", reqPath, {
-      params: { max_messages: maxMessages, wait_seconds: waitSeconds },
-    });
+    const params = { max_messages: maxMessages, wait_seconds: waitSeconds };
+    if (shouldDelete) params.delete = "true";
+    const data = await this._c.dataPlaneRequest("mq", "GET", reqPath, { params });
     return data.items || [];
   }
+
+  async delete(queueName, sequence) {
+    this._c.requireAccessKey();
+    const accountId = this._c.accountId;
+    const reqPath = `/${accountId}/${queueName}/messages/${sequence}`;
+    await this._c.dataPlaneRequest("mq", "DELETE", reqPath);
+  }
+
+  async purge(queueName) {
+    this._c.requireAccessKey();
+    const accountId = this._c.accountId;
+    const reqPath = `/${accountId}/${queueName}/purge`;
+    await this._c.dataPlaneRequest("mq", "POST", reqPath);
+  }
+
+  async receiveDlq(queueName, { maxMessages = 1, waitSeconds = 20, delete: shouldDelete = false } = {}) {
+    this._c.requireAccessKey();
+    const accountId = this._c.accountId;
+    const reqPath = `/${accountId}/${queueName}/dlq/messages`;
+    const params = { max_messages: maxMessages, wait_seconds: waitSeconds };
+    if (shouldDelete) params.delete = "true";
+    const data = await this._c.dataPlaneRequest("mq", "GET", reqPath, { params });
+    return data.items || [];
+  }
+
+  async deleteDlq(queueName, sequence) {
+    this._c.requireAccessKey();
+    const accountId = this._c.accountId;
+    const reqPath = `/${accountId}/${queueName}/dlq/messages/${sequence}`;
+    await this._c.dataPlaneRequest("mq", "DELETE", reqPath);
+  }
+
+  async purgeDlq(queueName) {
+    this._c.requireAccessKey();
+    const accountId = this._c.accountId;
+    const reqPath = `/${accountId}/${queueName}/dlq/purge`;
+    await this._c.dataPlaneRequest("mq", "POST", reqPath);
+  }
 }
 
-module.exports = { MqAPI };
+module.exports = { MqAPI, buildMqBatchEntries, MQ_BATCH_MAX };