@runnerpro/backend 0.0.0-development

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Snyk Labs
+
+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

@@ -0,0 +1,29 @@
+# modern-npm-package
+
+An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format (CJS). It can be used in Node.js and browser applications.
+
+## Get Started
+
+1. Run `npm install` in your terminal
+1. Then run `npm run build`
+1. Update the `package.json` file "name" field with your own package name. Example `@username/package-name`
+1. Create an account with [npm](https://www.npmjs.com/signup) if you don't have one already. Also be sure to enable [two-factor authentication](https://docs.npmjs.com/configuring-two-factor-authentication)
+1. Sign in to your npm account in your terminal with `npm login`
+1. Run `npm publish --access=public` to publish your package
+
+### Testing
+
+1. Install developer dependencies using the following command in your terminal `npm i -D mocha @types/mocha chai @types/chai ts-node`
+1. Create a new file `.mocharc.json` in the root directory with the following contents:
+   ```json
+   {
+     "extension": ["ts"],
+     "spec": "./**/*.spec.ts",
+     "require": "ts-node/register"
+   }
+   ```
+1. Create a `tests` folder
+1. Create an `index.spec.ts` file in the `tests` folder
+1. Write unit tests in the `index.spec.ts` file to test the code in `index.ts`
+1. Add a `"test"` property in the `package.json` file and give it a value of `"mocha"`
+1. Run `npm test` in your terminal from the root folder of the project

package/lib/cjs/HelloWorld/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.helloWorld = void 0;
+function helloWorld() {
+    const message = 'Hello World from my example modern npm package!';
+    return message;
+}
+exports.helloWorld = helloWorld;
+exports.default = {
+    helloWorld,
+};

package/lib/cjs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.goodBye = void 0;
+function goodBye() {
+    const message = 'Goodbye from my example modern npm package!';
+    return message;
+}
+exports.goodBye = goodBye;
+exports.default = {
+    goodBye,
+};
+// export { default as NotificationToClient } from './NotificationToClient';
+// export * from './NotificationToClient';

package/lib/cjs/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "runnerpro-common-backend",
+  "version": "0.0.5-development",
+  "description": "A collection of common backend functions",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./types/index.d.ts",
+        "default": "./index.js"
+      }
+    }
+  },
+  "types": "./types/index.d.ts",
+  "main": "./index.js",
+  "files": [
+    "**/*"
+  ],
+  "scripts": {
+    "clean": "del-cli ./lib",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -p ./configs/tsconfig.esm.json && move-file lib/esm/index.js lib/esm/index.mjs",
+    "build:cjs": "tsc -p ./configs/tsconfig.cjs.json",
+    "test": "mocha",
+    "semantic-release": "semantic-release"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/runner-pro/commons.git"
+  },
+  "keywords": [
+    "npm",
+    "javascript",
+    "typescript",
+    "esm",
+    "cjs",
+    "nodejs",
+    "commonjs",
+    "ecmascript",
+    "beginner",
+    "example",
+    "demonstration"
+  ],
+  "author": "Runner Pro",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/runner-pro/commons/-/issues"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.3",
+    "@types/mocha": "^9.1.1",
+    "chai": "^4.3.6",
+    "del-cli": "^5.0.0",
+    "mocha": "^10.0.0",
+    "move-file-cli": "^3.0.0",
+    "semantic-release": "^19.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  }
+}

package/lib/cjs/types/HelloWorld/index.d.ts

@@ -0,0 +1,6 @@
+export declare function helloWorld(): string;
+declare const _default: {
+    helloWorld: typeof helloWorld;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/types/HelloWorld/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/HelloWorld/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,WAGzB;;;;AAED,wBAEE"}

package/lib/cjs/types/index.d.ts

@@ -0,0 +1,6 @@
+export declare function goodBye(): string;
+declare const _default: {
+    goodBye: typeof goodBye;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,WAGtB;;;;AAED,wBAEE"}

package/lib/esm/HelloWorld/index.js

@@ -0,0 +1,7 @@
+export function helloWorld() {
+    const message = 'Hello World from my example modern npm package!';
+    return message;
+}
+export default {
+    helloWorld,
+};

package/lib/esm/index.mjs

@@ -0,0 +1,9 @@
+export function goodBye() {
+    const message = 'Goodbye from my example modern npm package!';
+    return message;
+}
+export default {
+    goodBye,
+};
+// export { default as NotificationToClient } from './NotificationToClient';
+// export * from './NotificationToClient';

package/lib/esm/types/HelloWorld/index.d.ts

@@ -0,0 +1,6 @@
+export declare function helloWorld(): string;
+declare const _default: {
+    helloWorld: typeof helloWorld;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/types/HelloWorld/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/HelloWorld/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,WAGzB;;;;AAED,wBAEE"}

package/lib/esm/types/index.d.ts

@@ -0,0 +1,6 @@
+export declare function goodBye(): string;
+declare const _default: {
+    goodBye: typeof goodBye;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,WAGtB;;;;AAED,wBAEE"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@runnerpro/backend",
+  "version": "0.0.0-development",
+  "description": "A collection of common backend functions",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/esm/types/index.d.ts",
+        "default": "./lib/esm/index.mjs"
+      },
+      "require": {
+        "types": "./lib/cjs/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "types": "./lib/cjs/types/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "clean": "del-cli ./lib",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -p ./configs/tsconfig.esm.json && move-file lib/esm/index.js lib/esm/index.mjs",
+    "build:cjs": "tsc -p ./configs/tsconfig.cjs.json",
+    "test": "mocha",
+    "semantic-release": "semantic-release"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/runner-pro/commons.git"
+  },
+  "keywords": [
+    "npm",
+    "javascript",
+    "typescript",
+    "esm",
+    "cjs",
+    "nodejs",
+    "commonjs",
+    "ecmascript",
+    "beginner",
+    "example",
+    "demonstration"
+  ],
+  "author": "Runner Pro",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/runner-pro/commons/-/issues"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.3",
+    "@types/mocha": "^9.1.1",
+    "chai": "^4.3.6",
+    "del-cli": "^5.0.0",
+    "mocha": "^10.0.0",
+    "move-file-cli": "^3.0.0",
+    "semantic-release": "^19.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  }
+}