[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)

* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
2025-07-31 17:38:48 +00:00 · 2023-11-21 10:27:51 +00:00
parent 804fa2ffd4
commit ea2c0ce229
1334 changed files with 82605 additions and 1068 deletions
--- a/lib/js-api/src/api/discovery-rest-api/docs/DiscoveryApi.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/DiscoveryApi.md
@@ -0,0 +1,42 @@
+# DiscoveryApi
+
+All URIs are relative to *https://localhost/alfresco/api*
+
+| Method                                                                   | HTTP request       | Description                |
+|--------------------------------------------------------------------------|--------------------|----------------------------|
+| [**getRepositoryInformation**](DiscoveryApi.md#getRepositoryInformation) | **GET** /discovery | Get repository information |
+
+<a name="getRepositoryInformation"></a>
+## getRepositoryInformation
+> DiscoveryEntry getRepositoryInformation()
+
+Get repository information
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+Retrieves the capabilities and detailed version information from the repository.
+
+**Example**
+
+```javascript
+import { AlfrescoApi, DiscoveryApi} from '@alfresco/js-api';
+
+const alfrescoApi = new AlfrescoApi({
+    hostEcm: 'http://127.0.0.1:8080'
+});
+
+const discoveryApi = new DiscoveryApi(alfrescoApi);
+
+discoveryApi.getRepositoryInformation().then(
+    (data) => {
+      console.log('API called successfully. Returned data: ' + data);
+    }, 
+    (error) => {
+        console.error(error);
+    });
+```
+
+### Return type
+
+[**DiscoveryEntry**](DiscoveryEntry.md)
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/DiscoveryEntry.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/DiscoveryEntry.md
@@ -0,0 +1,8 @@
+# DiscoveryEntry
+
+## Properties
+| Name      | Type                                      | Notes             |
+|-----------|-------------------------------------------|-------------------|
+| entry | [RepositoryEntry](RepositoryEntry.md) | [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/EntitlementsInfo.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/EntitlementsInfo.md
@@ -0,0 +1,12 @@
+# EntitlementsInfo
+
+## Properties
+
+| Name               | Type    | Notes                        |
+|--------------------|---------|------------------------------|
+| maxUsers           | number  | [optional] [default to null] |
+| maxDocs            | number  | [optional] [default to null] |
+| isClusterEnabled   | boolean | [optional] [default to null] |
+| isCryptodocEnabled | boolean | [optional] [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/Error.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/Error.md
@@ -0,0 +1,9 @@
+# ModelError
+
+## Properties
+
+| Name      | Type                            | Description | Notes                        |
+|-----------|---------------------------------|-------------|------------------------------|
+| **error** | [**ErrorError**](ErrorError.md) |             | [optional] [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/Error_error.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/Error_error.md
@@ -0,0 +1,14 @@
+# ErrorError
+
+## Properties
+
+| Name           | Type   | Notes                        |
+|----------------|--------|------------------------------|
+| errorKey       | string | [optional] [default to null] |
+| statusCode     | number | [default to null]            |
+| briefSummary   | string | [default to null]            |
+| stackTrace     | string | [default to null]            |
+| descriptionURL | string | [default to null]            |
+| logId          | string | [optional] [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/LicenseInfo.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/LicenseInfo.md
@@ -0,0 +1,14 @@
+# LicenseInfo
+
+## Properties
+
+| Name          | Type                                    | Notes                        |
+|---------------|-----------------------------------------|------------------------------|
+| issuedAt      | [Date](Date.md)                         | [default to null]            |
+| expiresAt     | [Date](Date.md)                         | [default to null]            |
+| remainingDays | number                                  | [default to null]            |
+| holder        | string                                  | [default to null]            |
+| mode          | string                                  | [default to null]            |
+| entitlements  | [EntitlementsInfo](EntitlementsInfo.md) | [optional] [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/ModuleInfo.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/ModuleInfo.md
@@ -0,0 +1,16 @@
+# ModuleInfo
+
+## Properties
+
+| Name         | Type                | Notes                        |
+|--------------|---------------------|------------------------------|
+| id           | string              | [optional] [default to null] |
+| title        | string              | [optional] [default to null] |
+| description  | string              | [optional] [default to null] |
+| version      | string              | [optional] [default to null] |
+| installDate  | [**Date**](Date.md) | [optional] [default to null] |
+| installState | string              | [optional] [default to null] |
+| versionMin   | string              | [optional] [default to null] |
+| versionMax   | string              | [optional] [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/RepositoryEntry.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/RepositoryEntry.md
@@ -0,0 +1,9 @@
+# RepositoryEntry
+
+## Properties
+
+| Name       | Type                                | Notes             |
+|------------|-------------------------------------|-------------------|
+| repository | [RepositoryInfo](RepositoryInfo.md) | [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/RepositoryInfo.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/RepositoryInfo.md
@@ -0,0 +1,13 @@
+# RepositoryInfo
+
+## Properties
+
+| Name    | Type                              | Notes                        |
+|---------|-----------------------------------|------------------------------|
+| edition | string                            | [default to null]            |
+| version | [VersionInfo](VersionInfo.md)     | [default to null]            |
+| status  | [StatusInfo](StatusInfo.md)       | [default to null]            |
+| license | [LicenseInfo](LicenseInfo.md)     | [optional] [default to null] |
+| modules | [ModuleInfo**[]**](ModuleInfo.md) | [optional] [default to null] |
+
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/StatusInfo.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/StatusInfo.md
@@ -0,0 +1,12 @@
+# StatusInfo
+
+## Properties
+
+| Name                         | Type    |
+|------------------------------|---------|
+| isReadOnly                   | boolean | 
+| isAuditEnabled               | boolean |
+| isQuickShareEnabled          | boolean |
+| isThumbnailGenerationEnabled | boolean |
+| isDirectAccessUrlEnabled     | boolean |
+
--- a/lib/js-api/src/api/discovery-rest-api/docs/VersionInfo.md
+++ b/lib/js-api/src/api/discovery-rest-api/docs/VersionInfo.md
@@ -0,0 +1,15 @@
+# VersionInfo
+
+## Properties
+
+| Name    | Type   | Notes             |
+|---------|--------|-------------------|
+| major   | string | [default to null] |
+| minor   | string | [default to null] |
+| patch   | string | [default to null] |
+| hotfix  | string | [default to null] |
+| schema  | number | [default to null] |
+| label   | string | [default to null] |
+| display | string | [default to null] |
+
+