@liveblocks/node 0.17.0 → 0.17.1-beta1

package/index.d.ts

@@ -0,0 +1,46 @@
+declare type AuthorizeOptions = {
+  /**
+   * The secret api provided at https://liveblocks.io/dashboard/apikeys
+   */
+  secret: string;
+  /**
+   * The room provided in the authorization request body
+   */
+  room: string;
+  /**
+   * The id of the user that try to connect. It should be used to get information about the connected users in the room (name, avatar, etc).
+   */
+  userId?: string;
+  /**
+   * The info associated to the user. Can be used to store the name or the profile picture to implement avatar for example. Can't exceed 1KB when serialized as JSON
+   */
+  userInfo?: unknown;
+};
+declare type AuthorizeResponse = {
+  status: number;
+  body: string;
+  error?: Error;
+};
+/**
+ * @example
+ * export default async function auth(req, res) {
+ *
+ * // Implement your own security here.
+ *
+ * const room = req.body.room;
+ * const response = await authorize({
+ *   room,
+ *   secret,
+ *   userId: "123", // Optional
+ *   userInfo: {    // Optional
+ *     name: "Ada Lovelace"
+ *   }
+ * });
+ * return res.status(response.status).end(response.body);
+ * }
+ */
+declare function authorize(
+  options: AuthorizeOptions
+): Promise<AuthorizeResponse>;
+
+export { authorize };

package/index.js

@@ -0,0 +1,45 @@
+"use strict";
+function _interopDefaultLegacy(e) {
+  return e && "object" == typeof e && "default" in e ? e : { default: e };
+}
+Object.defineProperty(exports, "__esModule", { value: !0 });
+var fetch__default = _interopDefaultLegacy(require("node-fetch"));
+exports.authorize = async function (options) {
+  try {
+    const {
+      room: room,
+      secret: secret,
+      userId: userId,
+      userInfo: userInfo,
+    } = options;
+    if (!("string" == typeof room && room.length > 0))
+      throw new Error(
+        "Invalid room. Please provide a non-empty string as the room. For more information: https://liveblocks.io/docs/api-reference/liveblocks-node#authorize"
+      );
+    const result = await fetch__default.default(
+      options.liveblocksAuthorizeEndpoint ||
+        "https://liveblocks.io/api/authorize",
+      {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer: ${secret}`,
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+          room: room,
+          userId: userId,
+          userInfo: userInfo,
+        }),
+      }
+    );
+    return result.ok
+      ? { status: 200, body: await result.text() }
+      : { status: 403, body: await result.text() };
+  } catch (er) {
+    return {
+      status: 403,
+      body: 'Call to "https://liveblocks.io/api/authorize" failed. See "error" for more information.',
+      error: er,
+    };
+  }
+};

package/index.mjs

@@ -0,0 +1,73 @@
+import fetch from "node-fetch";
+function __awaiter(thisArg, _arguments, P, generator) {
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+    function rejected(value) {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+    function step(result) {
+      var value;
+      result.done
+        ? resolve(result.value)
+        : ((value = result.value),
+          value instanceof P
+            ? value
+            : new P(function (resolve) {
+                resolve(value);
+              })).then(fulfilled, rejected);
+    }
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
+}
+function authorize(options) {
+  return __awaiter(this, void 0, void 0, function* () {
+    try {
+      const {
+        room: room,
+        secret: secret,
+        userId: userId,
+        userInfo: userInfo,
+      } = options;
+      if (!("string" == typeof room && room.length > 0))
+        throw new Error(
+          "Invalid room. Please provide a non-empty string as the room. For more information: https://liveblocks.io/docs/api-reference/liveblocks-node#authorize"
+        );
+      const result = yield fetch(
+        options.liveblocksAuthorizeEndpoint ||
+          "https://liveblocks.io/api/authorize",
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer: ${secret}`,
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify({
+            room: room,
+            userId: userId,
+            userInfo: userInfo,
+          }),
+        }
+      );
+      return result.ok
+        ? { status: 200, body: yield result.text() }
+        : { status: 403, body: yield result.text() };
+    } catch (er) {
+      return {
+        status: 403,
+        body: 'Call to "https://liveblocks.io/api/authorize" failed. See "error" for more information.',
+        error: er,
+      };
+    }
+  });
+}
+export { authorize };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@liveblocks/node",
-  "version": "0.17.0",
+  "version": "0.17.1-beta1",
   "description": "A server-side utility that lets you set up a Liveblocks authentication endpoint.",
-  "main": "./lib/cjs/index.js",
-  "module": "./lib/esm/index.js",
+  "main": "./index.js",
+  "module": "./index.mjs",
+  "types": "./index.d.ts",
   "files": [
-    "lib/"
+    "**"
   ],
   "keywords": [
     "node",