@liveblocks/node 1.0.2 → 1.0.6-test2

package/README.md

@@ -32,8 +32,9 @@ npm install @liveblocks/node
 
 ## Documentation
 
-Read the [documentation](https://liveblocks.io/docs) for guides and API
-references.
+Read the
+[documentation](https://liveblocks.io/docs/api-reference/liveblocks-node) for
+guides and API references.
 
 ## Examples
 

package/dist/index.d.ts

@@ -1,5 +1,55 @@
 import { IncomingHttpHeaders } from 'http';
 
+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 can be used to get information about the connected users in the room (name, avatar, etc).
+     * It can also be used to generate a token that gives access to a private room where the userId is configured in the room accesses.
+     * Liveblocks uses the userId to calculate your account's Monthly Active Users.
+     */
+    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;
+    /**
+     * The ids of the groups to which the user belongs. It should be used to generate a token that gives access to a private room and at least one of the group is configured in the room accesses.
+     */
+    groupIds?: string[];
+};
+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",
+ *   userInfo: {    // Optional
+ *     name: "Ada Lovelace"
+ *   },
+ *   groupIds: ["group1"] // Optional
+ * });
+ * return res.status(response.status).end(response.body);
+ * }
+ */
+declare function authorize(options: AuthorizeOptions): Promise<AuthorizeResponse>;
+
 declare class WebhookHandler {
     private secretBuffer;
     private static secretPrefix;
@@ -122,54 +172,4 @@ declare type RoomDeletedEvent = {
     };
 };
 
-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 can be used to get information about the connected users in the room (name, avatar, etc).
-     * It can also be used to generate a token that gives access to a private room where the userId is configured in the room accesses.
-     * Liveblocks uses the userId to calculate your account's Monthly Active Users.
-     */
-    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;
-    /**
-     * The ids of the groups to which the user belongs. It should be used to generate a token that gives access to a private room and at least one of the group is configured in the room accesses.
-     */
-    groupIds?: string[];
-};
-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",
- *   userInfo: {    // Optional
- *     name: "Ada Lovelace"
- *   },
- *   groupIds: ["group1"] // Optional
- * });
- * return res.status(response.status).end(response.body);
- * }
- */
-declare function authorize(options: AuthorizeOptions): Promise<AuthorizeResponse>;
-
 export { StorageUpdatedEvent, UserEnteredEvent, UserLeftEvent, WebhookEvent, WebhookHandler, WebhookRequest, authorize };

package/dist/index.js

@@ -19,8 +19,64 @@
   });
 };
 
-// src/index.ts
+// src/authorize.ts
 var _nodefetch = require('node-fetch'); var _nodefetch2 = _interopRequireDefault(_nodefetch);
+function authorize(options) {
+  return __async(this, null, function* () {
+    try {
+      const { room, secret, userId, userInfo, groupIds } = options;
+      if (!(typeof room === "string" && 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"
+        );
+      }
+      if (!(typeof userId === "string" && userId.length > 0)) {
+        throw new Error(
+          "Invalid userId. Please provide a non-empty string as the userId. For more information: https://liveblocks.io/docs/api-reference/liveblocks-node#authorize"
+        );
+      }
+      const result = yield _nodefetch2.default.call(void 0, 
+        buildLiveblocksAuthorizeEndpoint(options, room),
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${secret}`,
+            "Content-Type": "application/json"
+          },
+          body: JSON.stringify({
+            userId,
+            userInfo,
+            groupIds
+          })
+        }
+      );
+      if (!result.ok) {
+        return {
+          status: 403,
+          body: yield result.text()
+        };
+      }
+      return {
+        status: 200,
+        body: yield result.text()
+      };
+    } catch (er) {
+      return {
+        status: 403,
+        body: 'Call to "https://api.liveblocks.io/v2/rooms/:roomId/authorize" failed. See "error" for more information.',
+        error: er
+      };
+    }
+  });
+}
+function buildLiveblocksAuthorizeEndpoint(options, roomId) {
+  if (options.liveblocksAuthorizeEndpoint) {
+    return options.liveblocksAuthorizeEndpoint.replace("{roomId}", roomId);
+  }
+  return `https://api.liveblocks.io/v2/rooms/${encodeURIComponent(
+    roomId
+  )}/authorize`;
+}
 
 // src/webhooks.ts
 var _crypto = require('crypto'); var _crypto2 = _interopRequireDefault(_crypto);
@@ -35,6 +91,9 @@ var _WebhookHandler = class {
     const secretKey = secret.slice(_WebhookHandler.secretPrefix.length);
     this.secretBuffer = Buffer.from(secretKey, "base64");
   }
+  /**
+   * Verifies a webhook request and returns the event
+   */
   verifyRequest(request) {
     const { webhookId, timestamp, rawSignatures } = this.verifyHeaders(
       request.headers
@@ -53,6 +112,9 @@ var _WebhookHandler = class {
     this.verifyWebhookEventType(event);
     return event;
   }
+  /**
+   * Verifies the headers and returns the webhookId, timestamp and rawSignatures
+   */
   verifyHeaders(headers) {
     const sanitizedHeaders = {};
     Object.keys(headers).forEach((key) => {
@@ -69,9 +131,17 @@ var _WebhookHandler = class {
       throw new Error("Invalid webhook-signature header");
     return { webhookId, timestamp, rawSignatures };
   }
+  /**
+   * Signs the content with the secret
+   * @param content
+   * @returns `string`
+   */
   sign(content) {
     return _crypto2.default.createHmac("sha256", this.secretBuffer).update(content).digest("base64");
   }
+  /**
+   * Verifies that the timestamp is not too old or in the future
+   */
   verifyTimestamp(timestampHeader) {
     const now = Math.floor(Date.now() / 1e3);
     const timestamp = parseInt(timestampHeader, 10);
@@ -85,6 +155,10 @@ var _WebhookHandler = class {
       throw new Error("Timestamp in the future");
     }
   }
+  /**
+   * Ensures that the event is a known event type
+   * or throws and prompts the user to upgrade to a higher version of @liveblocks/node
+   */
   verifyWebhookEventType(event) {
     if (event && event.type && [
       "storageUpdated",
@@ -104,64 +178,6 @@ WebhookHandler.secretPrefix = "whsec_";
 var WEBHOOK_TOLERANCE_IN_SECONDS = 5 * 60;
 var isNotUndefined = (value) => value !== void 0;
 
-// src/index.ts
-function authorize(options) {
-  return __async(this, null, function* () {
-    try {
-      const { room, secret, userId, userInfo, groupIds } = options;
-      if (!(typeof room === "string" && 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"
-        );
-      }
-      if (!(typeof userId === "string" && userId.length > 0)) {
-        throw new Error(
-          "Invalid userId. Please provide a non-empty string as the userId. For more information: https://liveblocks.io/docs/api-reference/liveblocks-node#authorize"
-        );
-      }
-      const result = yield _nodefetch2.default.call(void 0, 
-        buildLiveblocksAuthorizeEndpoint(options, room),
-        {
-          method: "POST",
-          headers: {
-            Authorization: `Bearer ${secret}`,
-            "Content-Type": "application/json"
-          },
-          body: JSON.stringify({
-            userId,
-            userInfo,
-            groupIds
-          })
-        }
-      );
-      if (!result.ok) {
-        return {
-          status: 403,
-          body: yield result.text()
-        };
-      }
-      return {
-        status: 200,
-        body: yield result.text()
-      };
-    } catch (er) {
-      return {
-        status: 403,
-        body: 'Call to "https://api.liveblocks.io/v2/rooms/:roomId/authorize" failed. See "error" for more information.',
-        error: er
-      };
-    }
-  });
-}
-function buildLiveblocksAuthorizeEndpoint(options, roomId) {
-  if (options.liveblocksAuthorizeEndpoint) {
-    return options.liveblocksAuthorizeEndpoint.replace("{roomId}", roomId);
-  }
-  return `https://api.liveblocks.io/v2/rooms/${encodeURIComponent(
-    roomId
-  )}/authorize`;
-}
-
 
 
 exports.WebhookHandler = WebhookHandler; exports.authorize = authorize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/node",
-  "version": "1.0.2",
+  "version": "1.0.6-test2",
   "description": "A server-side utility that lets you set up a Liveblocks authentication endpoint. Liveblocks is the all-in-one toolkit to build collaborative products like Figma, Notion, and more.",
   "license": "Apache-2.0",
   "main": "./dist/index.js",