feat!: publish on npm

BREAKING CHANGE: please update your registry url to use the public registry instead of the private

Author: GuiHash

.gitignore

@@ -1,7 +1,9 @@
 # See https://help.github.com/ignore-files/ for more about ignoring files.
 
 #build
-**/build
+packages/**/build
+packages/**/docs
+packages/**/README.md
 
 # dependencies
 /node_modules

.yarnrc

@@ -5,21 +5,21 @@ Take control of your Hubstairs Display.
 - [Foreword](#foreword)
 - [About](#about)
 - Integrations
-  - [React](./docs/REACT_INTEGRATION.md)
-  - [Advanced](./docs/ADVANCED_INTEGRATION.md)
+  - [React](docs/REACT_INTEGRATION.md)
+  - [Advanced](docs/ADVANCED_INTEGRATION.md)
 - [Installation](#installation)
 - [Getting Started](#getting-started)
 - [Browser Support](#browser-support)
 - [Troubleshooting](#troubleshooting)
-- [Display Controller API](./docs/API.md#display-controller-api)
-  - [Constructor](./docs/API.md#constructor)
-  - [Events](./docs/API.md#events)
-  - [Functions](./docs/API.md#functions)
-- [Contributing](./docs/CONTRIBUTING.md)
+- [Display Controller API](docs/API.md#display-controller-api)
+  - [Constructor](docs/API.md#constructor)
+  - [Events](docs/API.md#events)
+  - [Functions](docs/API.md#functions)
+- [Contributing](docs/CONTRIBUTING.md)
 
 ## Foreword
 
-This documentation evolves along with the development of the [Display Controller API](./docs/API.md#display-controller-api). This means that you can find options or features that are pretty new and they may not be totally stable. To mark those new things we use the following `badges`:
+This documentation evolves along with the development of the [Display Controller API](docs/API.md#display-controller-api). This means that you can find options or features that are pretty new and they may not be totally stable. To mark those new things we use the following `badges`:
 
 - ![draft] : documentation is still "Work in progress" (it concerns only the documentation)
 - ![beta] : early option/feature, its usage may change
@@ -36,7 +36,7 @@ Features:
 - Access to content information
 - Call functions
 
-Info: If you use `React` on your website, we recommend you to follow the [`React integration instructions`](./docs/REACT_INTEGRATION.md) instead. It allows you to manipulate your Display as a Component and keep the exact same features.
+Info: If you use `React` on your website, we recommend you to follow the [`React integration instructions`](docs/REACT_INTEGRATION.md) instead. It allows you to manipulate your Display as a Component and keep the exact same features.
 
 ## Installation
 
@@ -48,11 +48,11 @@ npm i @hubstairs/display-js
 yarn add @hubstairs/display-js
 ```
 
-Info: If you do not use `npm` as a package manager, you can follow the [script integration instructions](./docs/ADVANCED_INTEGRATION.md#using-a-cdn)
+Info: If you do not use `npm` as a package manager, you can follow the [script integration instructions](docs/ADVANCED_INTEGRATION.md#using-a-cdn)
 
 ## Getting started
 
-After having set your Display up on [Hubstairs™](https://app.hubstairs.com) you will received your `display id` and your access `token`. Those information are needed to instantiate your Display. Pass the parent `DOM element` to the [Display constructor](./docs/API#constructor).
+After having set your Display up on [Hubstairs™](https://app.hubstairs.com) you will received your `display id` and your access `token`. Those information are needed to instantiate your Display. Pass the parent `DOM element` to the [Display constructor](docs/API#constructor).
 
 ```html
 <div id="display">
@@ -90,7 +90,7 @@ display.nextScene().then(() => {
 })
 ```
 
-To go further there are [few advanced integration](./docs/ADVANCED_INTEGRATION.md) mode.
+To go further there are [few advanced integration](docs/ADVANCED_INTEGRATION.md) mode.
 
 ## Browser Support
 

README.md

@@ -4,7 +4,7 @@
 
 Already have a Display on the page? Pass the iframe to the Display constructor and you are ready to go.
 
-> ⚠ This mode is incompatible with [`responsive` option](./API.md#constructor)
+> ⚠ This mode is incompatible with [`responsive` option](API.md#constructor)
 
 ```html
 <iframe
@@ -28,7 +28,7 @@ Already have a Display on the page? Pass the iframe to the Display constructor a
 
 ## Automatically with HTML attributes
 
-When the library loads, it will scan your page for elements with Hubstairs attributes. Each element must have at least a `data-hubstairs-displayid` or `data-hubstairs-url` attribute to create the Display automatically. You can also add attributes for any of the [Display constructor options](./API.md#constructor) prefixed with `data-hubstairs`.
+When the library loads, it will scan your page for elements with Hubstairs attributes. Each element must have at least a `data-hubstairs-displayid` or `data-hubstairs-url` attribute to create the Display automatically. You can also add attributes for any of the [Display constructor options](API.md#constructor) prefixed with `data-hubstairs`.
 
 ```html
 <div data-hubstairs-displayid="5e417dbac5d2651adbe509ec" id="display"></div>

docs/ADVANCED_INTEGRATION.md

@@ -4,5 +4,6 @@
   "packages": [
     "packages/*"
   ],
+  "changelogPreset": "conventionalcommits",
   "version": "0.2.0"
 }

lerna.json

@@ -3,6 +3,11 @@
   "private": true,
   "version": "0.0.0",
   "license": "MIT",
+  "homepage": "https:/www.hubstairs.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hubstairs/display-controller.git"
+  },
   "author": "Guillaume HERTAULT <[email protected]>",
   "workspaces": [
     "packages/*"
@@ -14,6 +19,7 @@
     "@babel/core": "^7.11.1",
     "@babel/preset-env": "^7.11.0",
     "babel-eslint": "^10.1.0",
+    "conventional-changelog-conventionalcommits": "^4.4.0",
     "eslint": "^7.6.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-compat": "^3.8.0",

package.json

@@ -1,18 +1,25 @@
 {
   "name": "@hubstairs/display-js",
   "version": "0.2.0",
+  "homepage": "https:/www.hubstairs.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hubstairs/display-controller.git"
+  },
   "description": "Interact with and control an embedded Hubstairs display.",
   "license": "MIT",
   "author": "Guillaume HERTAULT <[email protected]>",
   "scripts": {
     "start": "NODE_ENV=development rollup -c --watch",
+    "prebuild": "cp ../../README.md . && cp -R ../../docs .",
     "build": "NODE_ENV=production rollup -c",
     "lint": "eslint src",
     "test": "jest --config ../../jest.config.js --rootDir ."
   },
-  "main": "build/display.js",
-  "module": "build/display.esm.js",
+  "main": "build/index.js",
+  "module": "build/index.esm.js",
   "files": [
+    "docs",
     "build"
   ],
   "keywords": [
@@ -24,6 +31,9 @@
     "javascript",
     "postMessage"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@babel/cli": "^7.10.5",
     "@babel/core": "^7.11.1",

packages/display-js/package.json

@@ -7,7 +7,7 @@ import filesize from 'rollup-plugin-filesize'
 import pkg from './package.json'
 
 const globalName = 'Hubstairs.Controller'
-const input = './src/display.js'
+const input = './src/index.js'
 
 const name = `${pkg.name} v${pkg.version}`
 const copyright = `(c) ${new Date().getFullYear()} Hubstairs`

packages/display-js/rollup.config.js

@@ -1,36 +1,24 @@
 /*global html*/
 
-import Display from './display'
+import Display from './index'
 import { HubstairsError } from './lib/functions'
 
 describe('constructor', () => {
   test('accepts only Hubstairs embeds', () => {
     expect(() => {
-      void new Display(
-        html`
-          <div data-hubstairs-initialized><iframe></iframe></div>
-        `,
-      )
+      void new Display(html` <div data-hubstairs-initialized><iframe></iframe></div> `)
     }).toThrow()
 
     expect(() => {
       void new Display('string')
     }).toThrow()
 
     expect(() => {
-      void new Display(
-        html`
-          <iframe></iframe>
-        `,
-      )
+      void new Display(html` <iframe></iframe> `)
     }).toThrow()
 
     expect(() => {
-      void new Display(
-        html`
-          <iframe src="https://www.youtube.com/embed/Uj3_KqkI9Zo"></iframe>
-        `,
-      )
+      void new Display(html` <iframe src="https://www.youtube.com/embed/Uj3_KqkI9Zo"></iframe> `)
     }).toThrow()
   })
 
@@ -81,11 +69,7 @@ describe('constructor', () => {
   })
 
   test('throws if displayId is bad', async () => {
-    const display1 = new Display(
-      html`
-        <div data-hubstairs-displayid="guihash"></div>
-      `,
-    )
+    const display1 = new Display(html` <div data-hubstairs-displayid="guihash"></div> `)
     await expect(display1.ready()).rejects.toThrow()
   })
 })
@@ -94,11 +78,7 @@ describe('methods', () => {
   test('future calls to destroyed display should not not work', async () => {
     expect.assertions(4)
 
-    const display1 = new Display(
-      html`
-        <iframe id="to-destroy" src="https://display.hubstairs.com/v1/1234"></iframe>
-      `,
-    )
+    const display1 = new Display(html` <iframe id="to-destroy" src="https://display.hubstairs.com/v1/1234"></iframe> `)
 
     await expect(display1.destroy()).resolves.toBeUndefined()
     expect(document.querySelector('#to-destroy')).toBeFalsy()

packages/display-js/src/display.js renamed to packages/display-js/src/index.js

@@ -142,7 +142,7 @@ export function initializeEmbeds(parent = document) {
  * @return {void}
  */
 export function resizeEmbeds(parent = document) {
-  // Prevent execution if users include the display.js script multiple times.
+  // Prevent execution if users include the display script multiple times.
   if (window.HubstairsDisplayResizeEmbeds_) {
     return
   }

packages/display-js/src/display.test.js renamed to packages/display-js/src/index.test.js

@@ -1,18 +1,26 @@
 {
   "name": "@hubstairs/display-react",
   "version": "0.2.0",
+  "homepage": "https:/www.hubstairs.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hubstairs/display-controller.git"
+  },
+  "url": "https://github.com/hubstairs/display-controller",
   "description": "Interact with and control an embedded Hubstairs display with a React component.",
   "license": "MIT",
   "author": "Guillaume HERTAULT <[email protected]>",
   "scripts": {
     "start": "NODE_ENV=development rollup -c --watch",
+    "prebuild": "cp ../../README.md . && cp -R ../../docs .",
     "build": "NODE_ENV=production rollup -c",
     "lint": "eslint src",
     "test": "jest --config ../../jest.config.js --rootDir . --passWithNoTests"
   },
   "main": "build/index.js",
   "module": "build/index.esm.js",
   "files": [
+    "docs",
     "build"
   ],
   "keywords": [
@@ -43,6 +51,9 @@
     "rollup": "^2.25.0",
     "rollup-plugin-filesize": "^9.0.2"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "peerDependencies": {
     "react": ">= 16.8"
   },

packages/display-js/src/lib/embed.js

@@ -3851,6 +3851,14 @@ compare-func@^1.3.1:
     array-ify "^1.0.0"
     dot-prop "^3.0.0"
 
+compare-func@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/compare-func/-/compare-func-2.0.0.tgz#fb65e75edbddfd2e568554e8b5b05fff7a51fcb3"
+  integrity sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==
+  dependencies:
+    array-ify "^1.0.0"
+    dot-prop "^5.1.0"
+
 compare-versions@^3.6.0:
   version "3.6.0"
   resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-3.6.0.tgz#1a5689913685e5a87637b8d3ffca75514ec41d62"
@@ -3917,6 +3925,15 @@ conventional-changelog-angular@^5.0.3:
     compare-func "^1.3.1"
     q "^1.5.1"
 
+conventional-changelog-conventionalcommits@^4.4.0:
+  version "4.4.0"
+  resolved "https://registry.yarnpkg.com/conventional-changelog-conventionalcommits/-/conventional-changelog-conventionalcommits-4.4.0.tgz#8d96687141c9bbd725a89b95c04966d364194cd4"
+  integrity sha512-ybvx76jTh08tpaYrYn/yd0uJNLt5yMrb1BphDe4WBredMlvPisvMghfpnJb6RmRNcqXeuhR6LfGZGewbkRm9yA==
+  dependencies:
+    compare-func "^2.0.0"
+    lodash "^4.17.15"
+    q "^1.5.1"
+
 conventional-changelog-core@^3.1.6:
   version "3.2.3"
   resolved "https://registry.npmjs.org/conventional-changelog-core/-/conventional-changelog-core-3.2.3.tgz#b31410856f431c847086a7dcb4d2ca184a7d88fb"
@@ -4350,6 +4367,13 @@ dot-prop@^4.2.0:
   dependencies:
     is-obj "^1.0.0"
 
+dot-prop@^5.1.0:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/dot-prop/-/dot-prop-5.2.0.tgz#c34ecc29556dc45f1f4c22697b6f4904e0cc4fcb"
+  integrity sha512-uEUyaDKoSQ1M4Oq8l45hSE26SnTxL6snNnqvK/VWx5wJhmff5z0FUVJDKDanor/6w3kzE3i7XZOk+7wC0EXr1A==
+  dependencies:
+    is-obj "^2.0.0"
+
 [email protected], duplexer@^0.1.1:
   version "0.1.1"
   resolved "https://registry.npmjs.org/duplexer/-/duplexer-0.1.1.tgz#ace6ff808c1ce66b57d1ebf97977acb02334cfc1"
@@ -5908,6 +5932,11 @@ is-obj@^1.0.0, is-obj@^1.0.1:
   resolved "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f"
   integrity sha1-PkcprB9f3gJc19g6iW2rn09n2w8=
 
+is-obj@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-2.0.0.tgz#473fb05d973705e3fd9620545018ca8e22ef4982"
+  integrity sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==
+
 is-plain-obj@^1.0.0, is-plain-obj@^1.1.0:
   version "1.1.0"
   resolved "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz#71a50c8429dfca773c92a390a4a03b39fcd51d3e"