v2.15.11 (#238)

* Examples improved. addWorklog, getAllWorklogs examples added

* 2.15.11

Author: MrRefactoring

.github/FUNDING.yml

@@ -1,5 +1,10 @@
 # Jira.js changelog
 
+### 2.15.11
+
+- All properties in `PageOfWorklogs` marked as required.
+- Examples improved.
+
 ### 2.15.10
 
 - `newErrorHandling` console message removed.

CHANGELOG.md

@@ -213,7 +213,7 @@ const client = new Version3Client({
 
 1. Example
 
-You can find out [example project here](https://github.com/MrRefactoring/jira.js/tree/master/example) or perform the following actions:
+You can find out [examples project here](https://github.com/MrRefactoring/jira.js/tree/master/examples) or perform the following actions:
 
    - Change the `host`, `email` and `apiToken` to your data
    - Run script

README.md

@@ -0,0 +1,71 @@
+# Jira.js usage examples
+
+## Table of contents
+
+1. [Initial steps](#initial-steps)
+2. Examples
+   1. [Basic example](#basic-example)
+   2. [Add worklog example](#add-worklog-example)
+   3. [Get all worklogs example](#get-all-worklogs-example)
+
+## Initial steps
+
+1. Install dependencies
+
+```shell
+npm i
+```
+
+2. Specify `host`, `email` and `apiToken` variables in `src/credentials.ts` file
+
+```ts
+const host = 'https://your-domain.atlassian.net';
+const email = 'YOUR_EMAIL';
+const apiToken = 'YOUR_API_TOKEN';
+```
+
+## Examples
+
+### Basic example
+
+> ⚠️ Attention, the following behavior is performed:
+> 1. If you don't have any projects yet, then a new project is created with the `PROJECT` key, called `My Project`
+> 2. If you already have a project, it will create a new `task` named `My first issue` in the first project that comes along
+
+To run the basic example, just run the `basic` script:
+
+```shell
+npm run basic
+```
+
+---
+
+### Add worklog example
+
+> ⚠️ Attention, the following behavior is performed:
+>
+> In the first project that comes along, a new task is created, and one new Workflow is added to it
+
+> If you haven't created a project yet, follow the [basic example](#basic-example)
+
+To add a `worklog` run the `addWorklog` script:
+
+```shell
+npm run addWorklog
+```
+
+---
+
+### Get all worklogs example
+
+> ⚠️ Attention, the following behavior is performed:
+>
+> The same as in [Add worklog example](#add-worklog-example), and will also get all the worklogs that have been added
+
+> If you haven't created a project yet, follow the [basic example](#basic-example)
+
+To get all worklogs run the `getAllWorklogs` script:
+
+```shell
+npm run getAllWorklogs
+```

example/README.md

@@ -1,15 +1,17 @@
 {
-  "name": "example",
+  "name": "jira.js-examples",
   "private": true,
   "version": "1.0.0",
   "description": "",
   "author": "Vladislav Tupikin <[email protected]>",
   "scripts": {
-    "start": "ts-node src/index.ts"
+    "basic": "ts-node src/basic.ts",
+    "addWorklog": "ts-node src/addWorklog.ts",
+    "getAllWorklogs": "ts-node src/getAllWorklogs.ts"
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^18.7.18",
+    "@types/node": "^18.7.22",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.3"
   },

example/.editorconfig renamed to examples/.editorconfig

@@ -0,0 +1,31 @@
+import { createIssue } from "./utils";
+import { Version3Client } from "jira.js";
+import { apiToken, email, host } from "./credentials";
+
+async function addWorklog() {
+  const client = new Version3Client({
+    host,
+    authentication: {
+      basic: { email, apiToken },
+    },
+    newErrorHandling: true,
+  });
+
+  // Used to reduce the amount of code that is not directly related to creating a worklog
+  const { id: issueIdOrKey } = await createIssue(client);
+
+  // The main part responsible for creating the worklog
+  const worklog = await client.issueWorklogs.addWorklog({
+    issueIdOrKey, // Required
+    comment: 'My first worklog', // Not requited
+    timeSpentSeconds: 60, // Required one of `timeSpentSeconds` or `timeSpent`
+  });
+
+  console.log(`Worklog successfully added for Issue Id: ${worklog.issueId}`)
+}
+
+addWorklog().catch(e => {
+  console.error(e);
+
+  throw new Error(e.errorMessages.join(' '));
+});