simplex-chat 6.5.0-beta.4.2 → 6.5.0-beta.4.4

package/README.md

@@ -14,7 +14,7 @@ Please share your use cases and implementations.
 ## Quick start: a simple bot
 
 ```
-npm i simplex-chat@6.5.0-beta.4.2
+npm i simplex-chat@6.5.0-beta.4.4
 ```
 
 Simple bot that replies with squares of numbers you send to it:
@@ -28,7 +28,7 @@ Simple bot that replies with squares of numbers you send to it:
     profile: {displayName: "Squaring bot example", fullName: ""},
     dbOpts: {dbFilePrefix: "./squaring_bot", dbKey: ""},
     options: {
-      addressSettings: {welcomeMessage: "If you send me a number, I will calculate its square."},
+      addressSettings: {welcomeMessage: "Send a number, I will square it.",
     },
     onMessage: async (ci, content) => {
       const n = +content.text
@@ -44,9 +44,11 @@ Simple bot that replies with squares of numbers you send to it:
 If you installed this package as dependency, you can run this example with:
 
 ```sh
-node ./node_modules/simplex-chat/examples/squaring-bot-readme.js`
+node ./node_modules/simplex-chat/examples/squaring-bot-readme.js
 ```
 
+If you run it on Mac, the first time it will take 20-30 seconds for MacOS to verify the library.
+
 If you cloned this repository, you can:
 
 ```

package/binding.gyp

@@ -9,15 +9,15 @@
       "dependencies": [
         "<!(node -p \"require('node-addon-api').gyp\")"
       ],
-      "libraries": [
-        "-L<(module_root_dir)/libs",
-        "-lsimplex"
-      ],
       "cflags!": [ "-fno-exceptions" ],
       "cflags_cc!": [ "-fno-exceptions" ],
       "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
       "conditions": [
         ["OS=='mac'", {
+          "libraries": [
+            "-L<(module_root_dir)/libs",
+            "-lsimplex"
+          ],
           "xcode_settings": {
             "OTHER_LDFLAGS": [
               "-Wl,-rpath,@loader_path/../../libs"
@@ -25,9 +25,24 @@
           }
         }],
         ["OS=='linux'", {
+          "libraries": [
+            "-L<(module_root_dir)/libs",
+            "-lsimplex"
+          ],
           "ldflags": [
             "-Wl,-rpath,'$$ORIGIN'/../../libs"
           ]
+        }],
+        ["OS=='win'", {
+          "libraries": [
+            "<(module_root_dir)/libs/libsimplex.lib"
+          ],
+          "copies": [{
+            "destination": "<(PRODUCT_DIR)",
+            "files": [
+              "<(module_root_dir)/libs/*"
+            ]
+          }]
         }]
       ]
     }

package/cpp/simplex.cc

@@ -10,6 +10,17 @@ namespace simplex {
 using namespace Napi;
 
 void haskell_init() {
+#ifdef _WIN32
+  // non-moving GC is broken on windows with GHC 9.4-9.6.3
+  int argc = 5;
+  const char *argv[] = {
+      "simplex",
+      "+RTS",  // requires `hs_init_with_rtsopts`
+      "-A64m", // chunk size for new allocations
+      "-H64m", // initial heap size
+      "--install-signal-handlers=no",
+      nullptr};
+#else
   int argc = 6;
   const char *argv[] = {
       "simplex",
@@ -19,6 +30,7 @@ void haskell_init() {
       "-xn",   // non-moving GC
       "--install-signal-handlers=no",
       nullptr};
+#endif
   char **pargv = const_cast<char **>(argv);
   hs_init_with_rtsopts(&argc, &pargv);
 }

package/dist/index.d.ts

@@ -1,4 +1,19 @@
+/**
+ * A simple declarative API to run a chat-bot with a single function call.
+ * It automates creating and updating of the bot profile, address and bot commands shown in the app UI.
+ */
+export * as bot from "./bot";
+/**
+ * An API to send chat commands and receive chat events to/from chat core.
+ * You need to use it in bot event handlers, and for any other use cases.
+ */
+export * as api from "./api";
+/**
+ * A low level API to the core library - the same that is used in desktop clients.
+ * You are unlikely to ever need to use this module directly.
+ */
 export * as core from "./core";
+/**
+ * Useful functions for chat events and types.
+ */
 export * as util from "./util";
-export * as api from "./api";
-export * as bot from "./bot";

package/dist/index.js

@@ -1,8 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bot = exports.api = exports.util = exports.core = void 0;
+exports.util = exports.core = exports.api = exports.bot = void 0;
+/**
+ * A simple declarative API to run a chat-bot with a single function call.
+ * It automates creating and updating of the bot profile, address and bot commands shown in the app UI.
+ */
+exports.bot = require("./bot");
+/**
+ * An API to send chat commands and receive chat events to/from chat core.
+ * You need to use it in bot event handlers, and for any other use cases.
+ */
+exports.api = require("./api");
+/**
+ * A low level API to the core library - the same that is used in desktop clients.
+ * You are unlikely to ever need to use this module directly.
+ */
 exports.core = require("./core");
+/**
+ * Useful functions for chat events and types.
+ */
 exports.util = require("./util");
-exports.api = require("./api");
-exports.bot = require("./bot");
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAC9B,iCAA8B;AAC9B,+BAA4B;AAC5B,+BAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+BAA4B;AAE5B;;;GAGG;AACH,+BAA4B;AAE5B;;;GAGG;AACH,iCAA8B;AAE9B;;GAEG;AACH,iCAA8B"}

package/examples/squaring-bot-readme.js

@@ -4,7 +4,7 @@
     profile: {displayName: "Squaring bot example", fullName: ""},
     dbOpts: {dbFilePrefix: "./squaring_bot", dbKey: ""},
     options: {
-      addressSettings: {welcomeMessage: "If you send me a number, I will calculate its square."},
+      addressSettings: {welcomeMessage: "Send a number, I will square it."},
     },
     onMessage: async (ci, content) => {
       const n = +content.text

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simplex-chat",
-  "version": "6.5.0-beta.4.2",
+  "version": "6.5.0-beta.4.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [