docs improvements

.github/workflows/ci.yaml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci --force
+      - run: npm ci
       - name: Create .env file
         run: |
           touch .env

.github/workflows/publish.yml

@@ -13,7 +13,7 @@ jobs:
           node-version: 16
           registry-url: https://registry.npmjs.org/
       - name: Install dependencies
-        run: npm ci --force
+        run: npm ci
       - name: Create .env file
         run: |
           touch .env

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Jira.js changelog
 
-### UNRELEASED
+### 2.19.0
 
 - Version 2, Version 3:
   - `jqlFunctionsApps` API added.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "jira.js is a powerful Node.JS/Browser module that allows you to interact with the Jira API very easily",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -72,7 +72,7 @@
     "@typescript-eslint/eslint-plugin": "^5.59.8",
     "@typescript-eslint/parser": "^5.59.8",
     "ava": "^5.3.0",
-    "dotenv": "^16.1.3",
+    "dotenv": "^16.1.4",
     "eslint": "^8.42.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",
@@ -82,7 +82,7 @@
     "prettier-plugin-jsdoc": "^0.4.2",
     "sinon": "^15.1.0",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.24.7",
+    "typedoc": "^0.24.8",
     "typedoc-plugin-extras": "^2.3.3",
     "typescript": "^5.1.3"
   },

src/version2/issueSecuritySchemes.ts

@@ -251,7 +251,7 @@ export class IssueSecuritySchemes {
    * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of issue
    * security schemes.\
    * If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you
-   * filter by. Use {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to
+   * filter by. Use {@link Parameters.SearchProjectsUsingSecuritySchemes} to
    * obtain all projects related to scheme.
    *
    * Only issue security schemes in the context of classic projects are returned.
@@ -267,7 +267,7 @@ export class IssueSecuritySchemes {
    * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of issue
    * security schemes.\
    * If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you
-   * filter by. Use {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to
+   * filter by. Use {@link Parameters.SearchProjectsUsingSecuritySchemes} to
    * obtain all projects related to scheme.
    *
    * Only issue security schemes in the context of classic projects are returned.

src/version2/models/index.ts

@@ -111,6 +111,7 @@ export * from './dashboardGadgetResponse';
 export * from './dashboardGadgetSettings';
 export * from './dashboardGadgetUpdateRequest';
 export * from './dashboardUser';
+export * from './defaultLevelValue';
 export * from './defaultShareScope';
 export * from './defaultWorkflow';
 export * from './deleteAndReplaceVersion';
@@ -192,6 +193,7 @@ export * from './issuePickerSuggestions';
 export * from './issuePickerSuggestionsIssueType';
 export * from './issuesAndJQLQueries';
 export * from './issueSecurityLevelMember';
+export * from './issueSecuritySchemeToProjectMapping';
 export * from './issuesJqlMetaData';
 export * from './issuesMeta';
 export * from './issuesUpdate';
@@ -431,11 +433,14 @@ export * from './searchAutoCompleteFilter';
 export * from './searchRequest';
 export * from './searchResults';
 export * from './securityLevel';
+export * from './securityLevelMember';
 export * from './securityScheme';
 export * from './securitySchemeId';
+export * from './securitySchemeLevel';
 export * from './securitySchemeLevelMember';
 export * from './securitySchemeMembersRequest';
 export * from './securitySchemes';
+export * from './securitySchemeWithProjects';
 export * from './serverInformation';
 export * from './setDefaultLevelsRequest';
 export * from './setDefaultPriorityRequest';
@@ -507,6 +512,7 @@ export * from './versionUnresolvedIssuesCount';
 export * from './versionUsageInCustomField';
 export * from './visibility';
 export * from './votes';
+export * from './warningCollection';
 export * from './watchers';
 export * from './webhook';
 export * from './webhookDetails';

src/version3/issueSecuritySchemes.ts

@@ -56,7 +56,8 @@ export class IssueSecuritySchemes {
     parameters?: Parameters.CreateIssueSecurityScheme,
     callback?: Callback<T>,
   ): Promise<void | T> {
-    const config: RequestConfig = { // todo
+    const config: RequestConfig = {
+      // todo
       url: '/rest/api/3/issuesecurityschemes',
       method: 'POST',
       data: {
@@ -249,9 +250,8 @@ export class IssueSecuritySchemes {
   /**
    * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of issue
    * security schemes. If you specify the project ID parameter, the result will contain issue security schemes and
-   * related project IDs you filter by. Use
-   * {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to obtain all
-   * projects related to scheme.
+   * related project IDs you filter by. Use {@link Parameters.SearchProjectsUsingSecuritySchemes} to obtain all projects
+   * related to scheme.
    *
    * Only issue security schemes in the context of classic projects are returned.
    *
@@ -265,9 +265,8 @@ export class IssueSecuritySchemes {
   /**
    * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of issue
    * security schemes. If you specify the project ID parameter, the result will contain issue security schemes and
-   * related project IDs you filter by. Use
-   * {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to obtain all
-   * projects related to scheme.
+   * related project IDs you filter by. Use {@link Parameters.SearchProjectsUsingSecuritySchemes} to obtain all projects
+   * related to scheme.
    *
    * Only issue security schemes in the context of classic projects are returned.
    *

src/version3/models/index.ts

@@ -112,6 +112,7 @@ export * from './dashboardGadgetResponse';
 export * from './dashboardGadgetSettings';
 export * from './dashboardGadgetUpdateRequest';
 export * from './dashboardUser';
+export * from './defaultLevelValue';
 export * from './defaultShareScope';
 export * from './defaultWorkflow';
 export * from './deleteAndReplaceVersion';
@@ -195,6 +196,7 @@ export * from './issuePickerSuggestions';
 export * from './issuePickerSuggestionsIssueType';
 export * from './issuesAndJQLQueries';
 export * from './issueSecurityLevelMember';
+export * from './issueSecuritySchemeToProjectMapping';
 export * from './issuesJqlMetaData';
 export * from './issuesMeta';
 export * from './issuesUpdate';
@@ -441,10 +443,14 @@ export * from './searchAutoCompleteFilter';
 export * from './searchRequest';
 export * from './searchResults';
 export * from './securityLevel';
+export * from './securityLevelMember';
 export * from './securityScheme';
 export * from './securitySchemeId';
+export * from './securitySchemeLevel';
+export * from './securitySchemeLevelMember';
 export * from './securitySchemeMembersRequest';
 export * from './securitySchemes';
+export * from './securitySchemeWithProjects';
 export * from './serverInformation';
 export * from './setDefaultLevelsRequest';
 export * from './setDefaultPriorityRequest';