@artaio/node-api 0.32.0 → 0.32.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -5
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
### Pre-release notice
|
|
2
|
-
|
|
3
|
-
arta-node-api is in a pre-release beta. The package's API is unstable and expected to change prior to public release. Please only make use of the package in coordination with ARTA during this period.
|
|
4
|
-
|
|
5
1
|
Arta Node.js Library
|
|
6
2
|
===
|
|
7
3
|
|
|
@@ -44,9 +40,14 @@ const myHook: Webhook = items[0];
|
|
|
44
40
|
myHook.ping().then(console.log);
|
|
45
41
|
```
|
|
46
42
|
|
|
43
|
+
## Environment
|
|
44
|
+
**WARNING**: Arta Node SDK was meant to be used on server side javascript, and altough it only uses WebAPIs (fetch) it shouldn't be used on browsers as it requires a Private API Key.
|
|
45
|
+
|
|
46
|
+
This is a very tiny (about 12kb minified), 0 dependencies JS SDK for interacting with Arta backend that should be able to run in any javascript backend environment that supports fetch webapi.
|
|
47
|
+
|
|
47
48
|
## Contributing
|
|
48
49
|
|
|
49
50
|
Please be aware of our zero-dependency policy and ensure that there are no packages under "dependencies" in the `package.json`. Dev dependencies are fine, as these will not be contained in the final published package.
|
|
50
51
|
|
|
51
52
|
### Development
|
|
52
|
-
To develop a new function on the SDK, run `npm install` to install all the dependencies (only dev dependencies) and then run `npm run build` and the compiled JS code will be stored in the `dist/` folder which is the folder with the content published to NPM.
|
|
53
|
+
To develop a new function on the SDK, run `npm install` to install all the dependencies (only dev dependencies) and then run `npm run build` and the compiled JS code will be stored in the `dist/` folder which is the folder with the content published to NPM.
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artaio/node-api",
|
|
3
|
-
"version": "0.32.
|
|
3
|
+
"version": "0.32.2",
|
|
4
4
|
"description": "The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "npm run build:types && tsc -p tsconfig-build.json",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artaio/node-api",
|
|
3
|
-
"version": "0.32.
|
|
3
|
+
"version": "0.32.2",
|
|
4
4
|
"description": "The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "npm run build:types && tsc -p tsconfig-build.json",
|