seam 0.0.2 → 0.1.0

package/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2023 Seam Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,27 +1,196 @@
-Seam
-=============
+# Seam JavaScript SDK
 
-Attach JS behavior to your HTML in a universal with declarative binding.
+[![npm](https://img.shields.io/npm/v/seam.svg)](https://www.npmjs.com/package/seam)
+[![GitHub Actions](https://github.com/seamapi/javascript-next/actions/workflows/check.yml/badge.svg)](https://github.com/seamapi/javascript-next/actions/workflows/check.yml)
 
-Installation
-============
+JavaScript SDK for the Seam API written in TypeScript.
 
-```bash
-npm install seam
+_This is a preview of the next major version of the Seam SDK.
+This SDK is available for early preview.
+It will eventually replace the [seamapi](https://github.com/seamapi/javascript/) package._
+
+## Description
+
+[Seam] makes it easy to integrate IoT devices with your applications.
+This is an official SDK for the Seam API.
+Please refer to the official [Seam Docs] to get started.
+
+The SDK is fully tree-shakeable
+and optimized for use in both client and server applications.
+
+The package does not contain any code, it re-exports from a core set of Seam modules:
+
+- [@seamapi/types]: TypeScript types for the Seam API.
+- [@seamapi/http]: JavaScript HTTP client for the Seam API written in TypeScript.
+- [@seamapi/webhook]: Webhook SDK for the Seam API written in TypeScript.
+
+[Seam]: https://www.seam.co/
+[Seam Docs]: https://docs.seam.co/latest/
+[@seamapi/types]: https://github.com/seamapi/types
+[@seamapi/http]: https://github.com/seamapi/javascript-http
+[@seamapi/webhook]: https://github.com/seamapi/javascript-webhook
+
+## Installation
+
+Add this as a dependency to your project using [npm] with
+
+```
+$ npm install seam
+```
+
+[npm]: https://www.npmjs.com/
+
+### Usage
+
+#### Unlock a door
+
+```ts
+import Seam from 'seam'
+
+const seam = new Seam()
+const lock = await seam.locks.get({ name: 'Front Door' })
+await seam.locks.unlockDoor({ device_id: lock.device_id })
+```
+
+#### Parse and validate a webhook
+
+```ts
+import { SeamWebhook } from 'seam'
+
+const webhook = new SeamWebhook('webhook-secret')
+const data = webhook.verify(payload, headers)
 ```
 
-How to use
-==========
+## Development and Testing
 
-Require seam:
+### Quickstart
 
-```js
-var Seam = require("seam");
 ```
+$ git clone https://github.com/seamapi/javascript-next.git
+$ cd javascript-next
+$ nvm install
+$ npm install
+```
+
+Primary development tasks are defined under `scripts` in `package.json`
+and available via `npm run`.
+View them with
+
+```
+$ npm run
+```
+
+### Source code
+
+The [source code] is hosted on GitHub.
+Clone the project with
+
+```
+$ git clone git@github.com:seamapi/javascript-next.git
+```
+
+[source code]: https://github.com/seamapi/javascript-next
+
+### Requirements
+
+You will need [Node.js] with [npm] and a [Node.js debugging] client.
+
+Be sure that all commands run under the correct Node version, e.g.,
+if using [nvm], install the correct version with
+
+```
+$ nvm install
+```
+
+Set the active version for each shell session with
+
+```
+$ nvm use
+```
+
+Install the development dependencies with
+
+```
+$ npm install
+```
+
+[Node.js]: https://nodejs.org/
+[Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
+[npm]: https://www.npmjs.com/
+[nvm]: https://github.com/creationix/nvm
+
+### Publishing
+
+#### Automatic
+
+New versions are released automatically with [semantic-release]
+as long as commits follow the [Angular Commit Message Conventions].
+
+[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
+[semantic-release]: https://semantic-release.gitbook.io/
+
+#### Manual
+
+Publish a new version by triggering a [version workflow_dispatch on GitHub Actions].
+The `version` input will be passed as the first argument to [npm-version].
+
+This may be done on the web or using the [GitHub CLI] with
+
+```
+$ gh workflow run version.yml --raw-field version=<version>
+```
+
+[GitHub CLI]: https://cli.github.com/
+[npm-version]: https://docs.npmjs.com/cli/version
+[version workflow_dispatch on GitHub Actions]: https://github.com/seamapi/javascript-next/actions?query=workflow%3Aversion
+
+## GitHub Actions
+
+_GitHub Actions should already be configured: this section is for reference only._
+
+The following repository secrets must be set on [GitHub Actions]:
+
+- `NPM_TOKEN`: npm token for installing and publishing packages.
+- `GH_TOKEN`: A personal access token for the bot user with
+  and `contents:write` permission.
+- `GIT_USER_NAME`: The GitHub bot user's real name.
+- `GIT_USER_EMAIL`: The GitHub bot user's email.
+- `GPG_PRIVATE_KEY`: The GitHub bot user's [GPG private key].
+- `GPG_PASSPHRASE`: The GitHub bot user's GPG passphrase.
+
+[GitHub Actions]: https://github.com/features/actions
+[GPG private key]: https://github.com/marketplace/actions/import-gpg#prerequisites
+
+## Contributing
+
+> If using squash merge, edit and ensure the commit message follows the [Angular Commit Message Conventions] specification.
+> Otherwise, each individual commit must follow the [Angular Commit Message Conventions] specification.
+
+1. Create your feature branch (`git checkout -b my-new-feature`).
+2. Make changes.
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new draft pull request.
+6. Ensure all checks pass.
+7. Mark your pull request ready for review.
+8. Wait for the required approval from the code owners.
+9. Merge when ready.
+
+[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
+
+## License
 
-doc is coming
+This npm package is licensed under the MIT license.
 
-LICENSE
-=======
+## Warranty
 
-MIT
+This software is provided by the copyright holders and contributors "as is" and
+any express or implied warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose are
+disclaimed. In no event shall the copyright holder or contributors be liable for
+any direct, indirect, incidental, special, exemplary, or consequential damages
+(including, but not limited to, procurement of substitute goods or services;
+loss of use, data, or profits; or business interruption) however caused and on
+any theory of liability, whether in contract, strict liability, or tort
+(including negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.

package/dist/index.cjs

@@ -0,0 +1,38 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var connect = require('@seamapi/http/connect');
+var connect$1 = require('@seamapi/types/connect');
+var webhook = require('@seamapi/webhook');
+
+
+
+Object.defineProperty(exports, "Seam", {
+  enumerable: true,
+  get: function () { return connect.SeamHttp; }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () { return connect.SeamHttp; }
+});
+Object.keys(connect).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return connect[k]; }
+  });
+});
+Object.keys(connect$1).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return connect$1[k]; }
+  });
+});
+Object.keys(webhook).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return webhook[k]; }
+  });
+});
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA,SAAS,YAAY,YAAY;AAEjC,cAAc;AACd,cAAc;AACd,cAAc","sourcesContent":["import { SeamHttp as Seam } from '@seamapi/http/connect'\n\nexport * from '@seamapi/http/connect'\nexport * from '@seamapi/types/connect'\nexport * from '@seamapi/webhook'\nexport { Seam }\nexport { Seam as default }\n"]}

package/dist/index.d.cts

@@ -0,0 +1,4 @@
+export * from '@seamapi/http/connect';
+export { SeamHttp as Seam, SeamHttp as default } from '@seamapi/http/connect';
+export * from '@seamapi/types/connect';
+export * from '@seamapi/webhook';

package/index.d.ts

@@ -0,0 +1,6 @@
+import { SeamHttp as Seam } from '@seamapi/http/connect';
+export * from '@seamapi/http/connect';
+export * from '@seamapi/types/connect';
+export * from '@seamapi/webhook';
+export { Seam };
+export { Seam as default };

package/index.js

@@ -1,148 +1,7 @@
-/**
-* @license seam https://github.com/flams/seam
-*
-* The MIT License (MIT)
-*
-* Copyright (c) 2014 Olivier Scherrer <pode.fr@gmail.com>
-*/
-"use strict";
-
-var toArray = require("to-array"),
-    simpleLoop = require("simple-loop"),
-    getNodes = require("get-nodes"),
-    getDataset = require("get-dataset");
-
-/**
- * Seam makes it easy to attach JS behavior to your HTML/SVG via the data- attribute.
- * <div data-plugin="method: param, param, ..."></tag>
- *
- * JS behaviors are defined in plugins, which are plain JS objects with data and methods.
- */
-module.exports = function Seam($plugins) {
-
-    /**
-     * The list of plugins
-     * @private
-     */
-    var _plugins = {},
-
-    /**
-     * Just a "functionalification" of trim
-     * for code readability
-     * @private
-     */
-    trim = function trim(string) {
-        return string.trim();
-    },
-
-    /**
-     * Call the plugins methods, passing them the dom node
-     * A phrase can be :
-     * <tag data-plugin='method: param, param; method:param...'/>
-     * the function has to call every method of the plugin
-     * passing it the node, and the given params
-     * @private
-     */
-    applyPlugin = function applyPlugin(node, phrase, plugin) {
-        // Split the methods
-        phrase.split(";")
-        .forEach(function (couple) {
-            // Split the result between method and params
-            var split = couple.split(":"),
-            // Trim the name
-            method = split[0].trim(),
-            // And the params, if any
-            params = split[1] ? split[1].split(",").map(trim) : [];
-
-            // The first param must be the dom node
-            params.unshift(node);
-
-            if (_plugins[plugin] && _plugins[plugin][method]) {
-                // Call the method with the following params for instance :
-                // [node, "param1", "param2" .. ]
-                _plugins[plugin][method].apply(_plugins[plugin], params);
-            }
-
-        });
-    };
-
-    /**
-     * Add a plugin
-     *
-     * Note that once added, the function adds a "plugins" property to the plugin.
-     * It's an object that holds a name property, with the registered name of the plugin
-     * and an apply function, to use on new nodes that the plugin would generate
-     *
-     * @param {String} name the name of the data that the plugin should look for
-     * @param {Object} plugin the plugin that has the functions to execute
-     * @returns true if plugin successfully added.
-     */
-    this.add = function add(name, plugin) {
-        var propertyName = "plugins";
-
-        if (typeof name == "string" && typeof plugin == "object" && plugin) {
-            _plugins[name] = plugin;
-
-            plugin[propertyName] = {
-                    name: name,
-                    apply: function apply() {
-                        return this.apply.apply(this, arguments);
-                    }.bind(this)
-            };
-            return true;
-        } else {
-            return false;
-        }
-    };
-
-    /**
-     * Add multiple plugins at once
-     * @param {Object} list key is the plugin name and value is the plugin
-     * @returns true if correct param
-     */
-    this.addAll = function addAll(list) {
-        return simpleLoop(list, function (plugin, name) {
-            this.add(name, plugin);
-        }, this);
-    };
-
-    /**
-     * Get a previously added plugin
-     * @param {String} name the name of the plugin
-     * @returns {Object} the plugin
-     */
-    this.get = function get(name) {
-        return _plugins[name];
-    };
-
-    /**
-     * Delete a plugin from the list
-     * @param {String} name the name of the plugin
-     * @returns {Boolean} true if success
-     */
-    this.del = function del(name) {
-        return delete _plugins[name];
-    };
-
-    /**
-     * Apply the plugins to a NodeList
-     * @param {HTMLElement|SVGElement} dom the dom nodes on which to apply the plugins
-     * @returns {Boolean} true if the param is a dom node
-     */
-    this.apply = function apply(dom) {
-        var nodes = getNodes(dom);
-
-        simpleLoop(toArray(nodes), function (node) {
-            simpleLoop(getDataset(node), function (phrase, plugin) {
-                applyPlugin(node, phrase, plugin);
-            });
-        });
-
-        return dom;
-    };
-
-    if ($plugins) {
-        this.addAll($plugins);
-    }
-
-};
+import { SeamHttp as Seam } from '@seamapi/http/connect';
+export * from '@seamapi/http/connect';
+export * from '@seamapi/types/connect';
+export * from '@seamapi/webhook';
+export { Seam };
+export { Seam as default };
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAExD,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,CAAA;AACf,OAAO,EAAE,IAAI,IAAI,OAAO,EAAE,CAAA"}

package/package.json

@@ -1,46 +1,83 @@
 {
   "name": "seam",
-  "description": "Attach JS behavior to your HTML in a universal way with declarative binding",
-  "version": "0.0.2",
-  "homepage": "https://github.com/flams/seam",
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "https://raw.github.com/flams/seam/master/LICENSE"
+  "version": "0.1.0",
+  "description": "JavaScript SDK for the Seam API written in TypeScript.",
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
-  ],
-  "files": [
-    "LICENSE",
-    "index.js"
-  ],
-  "author": "Olivier Scherrer <pode.fr@gmail.com>",
+  },
+  "module": "index.js",
+  "sideEffects": false,
   "keywords": [
-    "html",
-    "behavior",
-    "plugin",
-    "binding",
-    "template",
-    "declarative"
+    "node"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:flams/seam.git"
-  },
-  "bugs": {
-    "url": "https://github.com/flams/seam/issues"
+  "homepage": "https://github.com/seamapi/javascript-next",
+  "bugs": "https://github.com/seamapi/javascript-next/issues",
+  "repository": "seamapi/javascript-next",
+  "license": "MIT",
+  "author": {
+    "name": "Seam Labs, Inc.",
+    "email": "devops@getseam.com"
   },
+  "files": [
+    "index.js",
+    "index.js.map",
+    "index.d.ts",
+    "src",
+    "dist"
+  ],
   "scripts": {
-    "test": "jasmine-node test/"
+    "build": "npm run build:entrypoints",
+    "prebuild": "tsx src/index.ts",
+    "postbuild": "node ./index.js",
+    "build:entrypoints": "npm run build:ts",
+    "postbuild:entrypoints": "tsup",
+    "build:ts": "tsc --project tsconfig.build.json",
+    "prebuild:ts": "del 'index.*'",
+    "postbuild:ts": "tsc-alias --project tsconfig.build.json",
+    "typecheck": "tsc",
+    "test": "true",
+    "pretest": "tsx src/index.ts",
+    "lint": "eslint --ignore-path .gitignore .",
+    "prelint": "prettier --check --ignore-path .gitignore .",
+    "postversion": "git push --follow-tags",
+    "format": "eslint --ignore-path .gitignore --fix .",
+    "preformat": "prettier --write --ignore-path .gitignore ."
+  },
+  "engines": {
+    "node": ">=18.12.0",
+    "npm": ">= 9.0.0"
   },
-  "main": "index.js",
   "devDependencies": {
-    "jasmine-node": "~1.14.3",
-    "quick-dom": "0.0.1"
+    "@types/node": "^20.8.10",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.9.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-config-standard-with-typescript": "^43.0.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "prettier": "^3.0.0",
+    "tsc-alias": "^1.8.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.1.0"
   },
   "dependencies": {
-    "to-array": "~0.1.4",
-    "simple-loop": "0.0.2",
-    "get-nodes": "0.0.1",
-    "get-dataset": "0.0.1"
+    "@seamapi/http": "^0.14.0",
+    "@seamapi/types": "^1.81.0",
+    "@seamapi/webhook": "^0.1.0",
+    "seamapi-types": "^1.32.0"
   }
 }

package/src/index.ts

@@ -0,0 +1,7 @@
+import { SeamHttp as Seam } from '@seamapi/http/connect'
+
+export * from '@seamapi/http/connect'
+export * from '@seamapi/types/connect'
+export * from '@seamapi/webhook'
+export { Seam }
+export { Seam as default }

package/LICENSE

@@ -1,21 +0,0 @@
-/**
- * @license seam https://github.com/flams/seam
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2014 Olivier Scherrer <pode.fr@gmail.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
- * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */