@icanbwell/bwell-sdk-ts 0.1.0-rc.1713985944

package/README.md

@@ -0,0 +1,61 @@
+# BWell SDK Typescript
+
+## Set-Up
+
+After pulling the code base from the GIT repo follow the next steps to install and run the sdk.
+
+1. Open a terminal in the home directory of the typescript sdk:
+
+```bash
+cd ./bwell-sdk-typescript
+```
+
+2. Install dependencies
+
+```bash
+npm install
+```
+
+## Commands
+
+### Build
+
+Compiles typescript to `dist` directory after cleaning directory
+
+```bash
+npm run build
+```
+
+### Testing
+
+Runs all test verbosely and reports coverage
+
+```bash
+npm test
+```
+
+#### Coverage
+
+Open coverage report in browser.
+
+```bash
+npm run coverage
+```
+
+### Formatting
+
+Run [prettier](https://prettier.io/) and format all files that do not conform to
+[prettier config](./prettier.config.js).
+
+```bash
+npm run format
+```
+
+### Linting
+
+Runs [eslint](https://eslint.org/) and reports any warnings or errors. Does not fix
+errors.
+
+```bash
+npm run lint
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export declare class BWellSDK {
+    hello(): string;
+}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BWellSDK = void 0;
+class BWellSDK {
+    hello() {
+        return "World!";
+    }
+}
+exports.BWellSDK = BWellSDK;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@icanbwell/bwell-sdk-ts",
+  "version": "0.1.0-rc.1713985944",
+  "description": "b.well TypeScript SDK",
+  "license": "UNLICENSED",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/icanbwell/bwell-sdk",
+    "directory": "bwell-sdk-typescript"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf ./dist",
+    "coverage": "open ./coverage/lcov-report/index.html",
+    "format": "prettier . --write",
+    "lint": "eslint .",
+    "prebuild": "npm run clean",
+    "prettier": "prettier",
+    "prepublishOnly": "npm run build",
+    "prepare": "cd .. && node ./bwell-sdk-typescript/.husky/install.mjs",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.0.0",
+    "@types/jest": "^29.5.12",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-sonarjs": "^0.25.1",
+    "globals": "^15.0.0",
+    "husky": "^9.0.11",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.4",
+    "typescript-eslint": "^7.6.0"
+  },
+  "lint-staged": {
+    "*.{js,ts}": "eslint --cache",
+    "*.{js,ts,md}": "prettier --write"
+  }
+}