Bladeren bron

Doc rooms api (#1551)

* Rooms Api
number of parameters in the documentation was made 2 from 3 as api which is used to open a room with default configuration has only 2 parameters.
supun19 6 jaren geleden
bovenliggende
commit
eec51f9d62
4 gewijzigde bestanden met toevoegingen van 111 en 109 verwijderingen
  1. 2 1
      CHANGES.md
  2. 106 104
      package-lock.json
  3. 2 2
      package.json
  4. 1 2
      src/headless/converse-muc.js

+ 2 - 1
CHANGES.md

@@ -1,5 +1,6 @@
 # Changelog
-
+### Rooms Api document change
+  number of parameters in the documentation was made 2 from 3 as api which is used to open a room with default configuration has only 2 parameters
 ## 5.0.0 (Unreleased)
 
 - Bugfix: Don't set `muc_domain` for roomspanel if `locked_muc_domain` is `true`.

+ 106 - 104
package-lock.json

@@ -874,19 +874,6 @@
         "semver": "^5.5.0"
       }
     },
-    "@lerna/changed": {
-      "version": "3.13.3",
-      "resolved": "https://registry.npmjs.org/@lerna/changed/-/changed-3.13.3.tgz",
-      "integrity": "sha512-REMZ/1UvYrizUhN7ktlbfMUa0vhMf1ogAe97WQC4I8r3s973Orfhs3aselo1GwudUwM4tMHBH8A9vnll9or3iA==",
-      "dev": true,
-      "requires": {
-        "@lerna/collect-updates": "3.13.3",
-        "@lerna/command": "3.13.3",
-        "@lerna/listable": "3.13.0",
-        "@lerna/output": "3.13.0",
-        "@lerna/version": "3.13.3"
-      }
-    },
     "@lerna/check-working-tree": {
       "version": "3.13.3",
       "resolved": "https://registry.npmjs.org/@lerna/check-working-tree/-/check-working-tree-3.13.3.tgz",
@@ -1330,22 +1317,6 @@
         "semver": "^5.5.0"
       }
     },
-    "@lerna/import": {
-      "version": "3.13.3",
-      "resolved": "https://registry.npmjs.org/@lerna/import/-/import-3.13.3.tgz",
-      "integrity": "sha512-gDjLAFVavG/CMvj9leBfiwd7vrXqtdFXPIz1oXmghBMnje7nCTbodbNWFe4VDDWx7reDaZIN+6PxTSvrPcF//A==",
-      "dev": true,
-      "requires": {
-        "@lerna/child-process": "3.13.3",
-        "@lerna/command": "3.13.3",
-        "@lerna/prompt": "3.13.0",
-        "@lerna/pulse-till-done": "3.13.0",
-        "@lerna/validation-error": "3.13.0",
-        "dedent": "^0.7.0",
-        "fs-extra": "^7.0.0",
-        "p-map-series": "^1.0.0"
-      }
-    },
     "@lerna/init": {
       "version": "3.13.3",
       "resolved": "https://registry.npmjs.org/@lerna/init/-/init-3.13.3.tgz",
@@ -1697,44 +1668,6 @@
         }
       }
     },
-    "@lerna/publish": {
-      "version": "3.13.3",
-      "resolved": "https://registry.npmjs.org/@lerna/publish/-/publish-3.13.3.tgz",
-      "integrity": "sha512-Ni3pZKueIfgJJoL0OXfbAuWhGlJrDNwGx3CYWp2dbNqJmKD6uBZmsDtmeARKDp92oUK60W0drXCMydkIFFHMDQ==",
-      "dev": true,
-      "requires": {
-        "@lerna/batch-packages": "3.13.0",
-        "@lerna/check-working-tree": "3.13.3",
-        "@lerna/child-process": "3.13.3",
-        "@lerna/collect-updates": "3.13.3",
-        "@lerna/command": "3.13.3",
-        "@lerna/describe-ref": "3.13.3",
-        "@lerna/log-packed": "3.13.0",
-        "@lerna/npm-conf": "3.13.0",
-        "@lerna/npm-dist-tag": "3.13.0",
-        "@lerna/npm-publish": "3.13.2",
-        "@lerna/output": "3.13.0",
-        "@lerna/pack-directory": "3.13.1",
-        "@lerna/prompt": "3.13.0",
-        "@lerna/pulse-till-done": "3.13.0",
-        "@lerna/run-lifecycle": "3.13.0",
-        "@lerna/run-parallel-batches": "3.13.0",
-        "@lerna/validation-error": "3.13.0",
-        "@lerna/version": "3.13.3",
-        "figgy-pudding": "^3.5.1",
-        "fs-extra": "^7.0.0",
-        "libnpmaccess": "^3.0.1",
-        "npm-package-arg": "^6.1.0",
-        "npm-registry-fetch": "^3.9.0",
-        "npmlog": "^4.1.2",
-        "p-finally": "^1.0.0",
-        "p-map": "^1.2.0",
-        "p-pipe": "^1.2.0",
-        "p-reduce": "^1.0.0",
-        "pacote": "^9.5.0",
-        "semver": "^5.5.0"
-      }
-    },
     "@lerna/pulse-till-done": {
       "version": "3.13.0",
       "resolved": "https://registry.npmjs.org/@lerna/pulse-till-done/-/pulse-till-done-3.13.0.tgz",
@@ -1848,36 +1781,6 @@
         "npmlog": "^4.1.2"
       }
     },
-    "@lerna/version": {
-      "version": "3.13.3",
-      "resolved": "https://registry.npmjs.org/@lerna/version/-/version-3.13.3.tgz",
-      "integrity": "sha512-o/yQGAwDHmyu17wTj4Kat1/uDhjYFMeG+H0Y0HC4zJ4a/T6rEiXx7jJrnucPTmTQTDcUBoH/It5LrPYGOPsExA==",
-      "dev": true,
-      "requires": {
-        "@lerna/batch-packages": "3.13.0",
-        "@lerna/check-working-tree": "3.13.3",
-        "@lerna/child-process": "3.13.3",
-        "@lerna/collect-updates": "3.13.3",
-        "@lerna/command": "3.13.3",
-        "@lerna/conventional-commits": "3.13.0",
-        "@lerna/github-client": "3.13.3",
-        "@lerna/output": "3.13.0",
-        "@lerna/prompt": "3.13.0",
-        "@lerna/run-lifecycle": "3.13.0",
-        "@lerna/validation-error": "3.13.0",
-        "chalk": "^2.3.1",
-        "dedent": "^0.7.0",
-        "minimatch": "^3.0.4",
-        "npmlog": "^4.1.2",
-        "p-map": "^1.2.0",
-        "p-pipe": "^1.2.0",
-        "p-reduce": "^1.0.0",
-        "p-waterfall": "^1.0.0",
-        "semver": "^5.5.0",
-        "slash": "^1.0.0",
-        "temp-write": "^3.4.0"
-      }
-    },
     "@lerna/write-log-file": {
       "version": "3.13.0",
       "resolved": "https://registry.npmjs.org/@lerna/write-log-file/-/write-log-file-3.13.0.tgz",
@@ -6986,28 +6889,127 @@
       }
     },
     "lerna": {
-      "version": "3.13.3",
-      "resolved": "https://registry.npmjs.org/lerna/-/lerna-3.13.3.tgz",
-      "integrity": "sha512-0TkG40F02A4wjKraJBztPtj87BjUezFmaZKAha8eLdtngZkSpAdrSANa5K7jnnA8mywmpQwrKJuBmjdNpm9cBw==",
+      "version": "3.13.4",
+      "resolved": "https://registry.npmjs.org/lerna/-/lerna-3.13.4.tgz",
+      "integrity": "sha512-qTp22nlpcgVrJGZuD7oHnFbTk72j2USFimc2Pj4kC0/rXmcU2xPtCiyuxLl8y6/6Lj5g9kwEuvKDZtSXujjX/A==",
       "dev": true,
       "requires": {
         "@lerna/add": "3.13.3",
         "@lerna/bootstrap": "3.13.3",
-        "@lerna/changed": "3.13.3",
+        "@lerna/changed": "3.13.4",
         "@lerna/clean": "3.13.3",
         "@lerna/cli": "3.13.0",
         "@lerna/create": "3.13.3",
         "@lerna/diff": "3.13.3",
         "@lerna/exec": "3.13.3",
-        "@lerna/import": "3.13.3",
+        "@lerna/import": "3.13.4",
         "@lerna/init": "3.13.3",
         "@lerna/link": "3.13.3",
         "@lerna/list": "3.13.3",
-        "@lerna/publish": "3.13.3",
+        "@lerna/publish": "3.13.4",
         "@lerna/run": "3.13.3",
-        "@lerna/version": "3.13.3",
+        "@lerna/version": "3.13.4",
         "import-local": "^1.0.0",
         "npmlog": "^4.1.2"
+      },
+      "dependencies": {
+        "@lerna/changed": {
+          "version": "3.13.4",
+          "resolved": "https://registry.npmjs.org/@lerna/changed/-/changed-3.13.4.tgz",
+          "integrity": "sha512-9lfOyRVObasw6L/z7yCSfsEl1QKy0Eamb8t2Krg1deIoAt+cE3JXOdGGC1MhOSli+7f/U9LyLXjJzIOs/pc9fw==",
+          "dev": true,
+          "requires": {
+            "@lerna/collect-updates": "3.13.3",
+            "@lerna/command": "3.13.3",
+            "@lerna/listable": "3.13.0",
+            "@lerna/output": "3.13.0",
+            "@lerna/version": "3.13.4"
+          }
+        },
+        "@lerna/import": {
+          "version": "3.13.4",
+          "resolved": "https://registry.npmjs.org/@lerna/import/-/import-3.13.4.tgz",
+          "integrity": "sha512-dn6eNuPEljWsifBEzJ9B6NoaLwl/Zvof7PBUPA4hRyRlqG5sXRn6F9DnusMTovvSarbicmTURbOokYuotVWQQA==",
+          "dev": true,
+          "requires": {
+            "@lerna/child-process": "3.13.3",
+            "@lerna/command": "3.13.3",
+            "@lerna/prompt": "3.13.0",
+            "@lerna/pulse-till-done": "3.13.0",
+            "@lerna/validation-error": "3.13.0",
+            "dedent": "^0.7.0",
+            "fs-extra": "^7.0.0",
+            "p-map-series": "^1.0.0"
+          }
+        },
+        "@lerna/publish": {
+          "version": "3.13.4",
+          "resolved": "https://registry.npmjs.org/@lerna/publish/-/publish-3.13.4.tgz",
+          "integrity": "sha512-v03pabiPlqCDwX6cVNis1PDdT6/jBgkVb5Nl4e8wcJXevIhZw3ClvtI94gSZu/wdoVFX0RMfc8QBVmaimSO0qg==",
+          "dev": true,
+          "requires": {
+            "@lerna/batch-packages": "3.13.0",
+            "@lerna/check-working-tree": "3.13.3",
+            "@lerna/child-process": "3.13.3",
+            "@lerna/collect-updates": "3.13.3",
+            "@lerna/command": "3.13.3",
+            "@lerna/describe-ref": "3.13.3",
+            "@lerna/log-packed": "3.13.0",
+            "@lerna/npm-conf": "3.13.0",
+            "@lerna/npm-dist-tag": "3.13.0",
+            "@lerna/npm-publish": "3.13.2",
+            "@lerna/output": "3.13.0",
+            "@lerna/pack-directory": "3.13.1",
+            "@lerna/prompt": "3.13.0",
+            "@lerna/pulse-till-done": "3.13.0",
+            "@lerna/run-lifecycle": "3.13.0",
+            "@lerna/run-parallel-batches": "3.13.0",
+            "@lerna/validation-error": "3.13.0",
+            "@lerna/version": "3.13.4",
+            "figgy-pudding": "^3.5.1",
+            "fs-extra": "^7.0.0",
+            "libnpmaccess": "^3.0.1",
+            "npm-package-arg": "^6.1.0",
+            "npm-registry-fetch": "^3.9.0",
+            "npmlog": "^4.1.2",
+            "p-finally": "^1.0.0",
+            "p-map": "^1.2.0",
+            "p-pipe": "^1.2.0",
+            "p-reduce": "^1.0.0",
+            "pacote": "^9.5.0",
+            "semver": "^5.5.0"
+          }
+        },
+        "@lerna/version": {
+          "version": "3.13.4",
+          "resolved": "https://registry.npmjs.org/@lerna/version/-/version-3.13.4.tgz",
+          "integrity": "sha512-pptWUEgN/lUTQZu34+gfH1g4Uhs7TDKRcdZY9A4T9k6RTOwpKC2ceLGiXdeR+ZgQJAey2C4qiE8fo5Z6Rbc6QA==",
+          "dev": true,
+          "requires": {
+            "@lerna/batch-packages": "3.13.0",
+            "@lerna/check-working-tree": "3.13.3",
+            "@lerna/child-process": "3.13.3",
+            "@lerna/collect-updates": "3.13.3",
+            "@lerna/command": "3.13.3",
+            "@lerna/conventional-commits": "3.13.0",
+            "@lerna/github-client": "3.13.3",
+            "@lerna/output": "3.13.0",
+            "@lerna/prompt": "3.13.0",
+            "@lerna/run-lifecycle": "3.13.0",
+            "@lerna/validation-error": "3.13.0",
+            "chalk": "^2.3.1",
+            "dedent": "^0.7.0",
+            "minimatch": "^3.0.4",
+            "npmlog": "^4.1.2",
+            "p-map": "^1.2.0",
+            "p-pipe": "^1.2.0",
+            "p-reduce": "^1.0.0",
+            "p-waterfall": "^1.0.0",
+            "semver": "^5.5.0",
+            "slash": "^1.0.0",
+            "temp-write": "^3.4.0"
+          }
+        }
       }
     },
     "levn": {

+ 2 - 2
package.json

@@ -53,8 +53,8 @@
     "eslint-plugin-lodash": "^2.3.3",
     "exports-loader": "^0.7.0",
     "fast-text-encoding": "^1.0.0",
-    "filesize": "^3.6.1",
     "file-loader": "^3.0.1",
+    "filesize": "^3.6.1",
     "formdata-polyfill": "^3.0.12",
     "hellojs": "^1.16.1",
     "http-server": "^0.10.0",
@@ -63,7 +63,7 @@
     "jasmine-core": "2.99.1",
     "jed": "1.1.1",
     "jsdoc": "^3.5.5",
-    "lerna": "^3.13.3",
+    "lerna": "^3.13.4",
     "lodash-template-loader": "^2.0.0",
     "lodash-template-webpack-loader": "jcbrand/lodash-template-webpack-loader",
     "long": "^3.1.0",

+ 1 - 2
src/headless/converse-muc.js

@@ -1597,8 +1597,7 @@ converse.plugins.add('converse-muc', {
                  *           'roomdesc': 'Comfy room for hanging out',
                  *           'whois': 'anyone'
                  *       }
-                 *     },
-                 *     true
+                 *     }
                  * );
                  */
                 'open': async function (jids, attrs, force=false) {