mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[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
This commit is contained in:
Denys Vuika
GitHub
52
lib/js-api/.eslintrc.json
Normal file
52
lib/js-api/.eslintrc.json
Normal file
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"extends": ["../../.eslintrc.js"],
|
||||
"ignorePatterns": ["!**/*"],
|
||||
"overrides": [
|
||||
{
|
||||
"files": ["*.ts"],
|
||||
"extends": ["plugin:@nrwl/nx/angular"],
|
||||
"rules": {
|
||||
"no-underscore-dangle": ["warn", { "allowAfterThis": true }],
|
||||
"@typescript-eslint/dot-notation": "off",
|
||||
"@typescript-eslint/explicit-member-accessibility": [
|
||||
"off",
|
||||
{
|
||||
"accessibility": "explicit"
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/no-floating-promises": "off",
|
||||
"@typescript-eslint/no-inferrable-types": "off",
|
||||
"@typescript-eslint/no-require-imports": "off",
|
||||
"@typescript-eslint/no-var-requires": "error",
|
||||
"comma-dangle": "error",
|
||||
"default-case": "error",
|
||||
"import/order": "off",
|
||||
"max-len": [
|
||||
"error",
|
||||
{
|
||||
"code": 240
|
||||
}
|
||||
],
|
||||
"no-bitwise": "off",
|
||||
"no-duplicate-imports": "error",
|
||||
"no-multiple-empty-lines": "error",
|
||||
"no-return-await": "error",
|
||||
|
||||
"unicorn/filename-case": "off",
|
||||
"@typescript-eslint/no-unused-expressions": "off",
|
||||
"@typescript-eslint/consistent-type-assertions": "off",
|
||||
"jsdoc/check-param-names": "off",
|
||||
"jsdoc/require-returns": "off",
|
||||
"jsdoc/require-param": "off",
|
||||
"jsdoc/check-tag-names": "off",
|
||||
"@typescript-eslint/no-shadow": "warn",
|
||||
"@typescript-eslint/member-ordering": "off",
|
||||
"@typescript-eslint/no-namespace": "off",
|
||||
"@typescript-eslint/consistent-type-definitions": "off",
|
||||
"no-redeclare": "off",
|
||||
"space-before-function-paren": "off",
|
||||
"@typescript-eslint/no-empty-interface": "warn"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
7
lib/js-api/.mocharc.json
Normal file
7
lib/js-api/.mocharc.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"extensions": ["ts"],
|
||||
"spec": ["lib/js-api/test/**/*.spec.ts"],
|
||||
"node-option": [
|
||||
"loader=ts-node/register"
|
||||
]
|
||||
}
|
||||
0
lib/js-api/docs/audit/.gitkeep
Normal file
0
lib/js-api/docs/audit/.gitkeep
Normal file
22
lib/js-api/docs/audit/audit-info-4.10.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-4.10.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 4.10.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 4.10.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 41
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-4.11.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-4.11.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 4.11.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 4.11.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 41
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-4.7.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-4.7.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 4.7.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 4.7.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-4.8.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-4.8.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 4.8.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 4.8.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-4.9.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-4.9.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 4.9.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 4.9.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 41
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-5.0.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-5.0.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 5.0.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 5.0.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 41
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-5.1.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-5.1.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 5.1.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 5.1.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 42
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-5.2.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-5.2.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 5.2.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 5.2.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 42
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-5.3.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-5.3.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 5.3.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 5.3.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 42
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-5.4.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-5.4.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 5.4.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 5.4.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 42
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-5.5.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-5.5.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 5.5.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 5.5.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 39
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-6.0.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-6.0.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 6.0.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 6.0.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed: 39
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
22
lib/js-api/docs/audit/audit-info-6.1.0.md
Normal file
22
lib/js-api/docs/audit/audit-info-6.1.0.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 6.1.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 6.1.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
24
lib/js-api/docs/audit/audit-info-6.2.0.md
Normal file
24
lib/js-api/docs/audit/audit-info-6.2.0.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 6.2.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 6.2.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 1
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|moderate | semver | "<7.5.2" |
|
||||
|
||||
|
||||
23
lib/js-api/docs/audit/audit-info-7.0.0.md
Normal file
23
lib/js-api/docs/audit/audit-info-7.0.0.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 7.0.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 7.0.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
|
||||
23
lib/js-api/docs/audit/audit-info-7.1.0.md
Normal file
23
lib/js-api/docs/audit/audit-info-7.1.0.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 7.1.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 7.1.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
|
||||
23
lib/js-api/docs/audit/audit-info-7.2.0.md
Normal file
23
lib/js-api/docs/audit/audit-info-7.2.0.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
Title: Audit info, @alfresco/js-api 7.2.0
|
||||
---
|
||||
|
||||
# Audit information for @alfresco/js-api 7.2.0
|
||||
|
||||
This page lists the security audit of the dependencies this project depends on.
|
||||
|
||||
## Risks
|
||||
|
||||
- Critical risk: 0
|
||||
- High risk: 0
|
||||
- Moderate risk: 0
|
||||
- Low risk: 0
|
||||
|
||||
Dependencies analyzed:
|
||||
|
||||
## Libraries
|
||||
|
||||
| Severity | Module | Vulnerable versions |
|
||||
| --- | --- | --- |
|
||||
|
||||
|
||||
320
lib/js-api/docs/authentication.md
Normal file
320
lib/js-api/docs/authentication.md
Normal file
@@ -0,0 +1,320 @@
|
||||
# Authentication JS-API
|
||||
|
||||
## Login
|
||||
|
||||
AlfrescoApi({alfrescoHost, activitiHost, contextRoot, ticket});
|
||||
|
||||
| Property | Description | default value |
|
||||
|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
|
||||
| hostEcm | (Optional) The Ip or Name of the host where your Alfresco instance is running | http://127.0.0.1:8080 |
|
||||
| hostBpm | (Optional) The Ip or Name of the host where your Activiti instance is running | http://127.0.0.1:9999 |
|
||||
| authType | (Optional) can be 'BASIC' or 'OAUTH' | 'BASIC' |
|
||||
| oauth2 | (Optional) configuration for SSO | |
|
||||
| contextRoot | (Optional) that define the context Root of the Alfresco ECM API default value is alfresco | alfresco |
|
||||
| contextRootBpm | (Optional) that define the context Root of the Activiti API default value is activiti-app | alfresco |
|
||||
| tenant | (Optional) needed in case of multi tenant content service | '-default-' |
|
||||
| provider | (Optional) default value is ECM. This parameter can accept as value ECM BPM or ALL to use the API and Login in the ECM, Activiti BPM or Both | alfresco |
|
||||
| ticket | (Optional) only if you want login with the ticket see example below | |
|
||||
| disableCsrf | To disable CSRF Token to be submitted. Only for Activiti call | false |
|
||||
| withCredentials | (Optional) configuration for SSO, requires CORS on ECM | false |
|
||||
| oauthInit | (Optional) if false skip the OAuth2 initialization | true |
|
||||
|
||||
### Login with Username and Password BPM and ECM
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi({ provider: 'ALL' });
|
||||
|
||||
try {
|
||||
await alfrescoJsApi.login('admin', 'admin');
|
||||
console.log('API called successfully Login in BPM and ECM performed ');
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
```
|
||||
|
||||
### Login with Username and Password ECM
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoJsApi = new AlfrescoApi();
|
||||
|
||||
try {
|
||||
const data = await alfrescoJsApi.login('admin', 'admin');
|
||||
|
||||
console.log('API called successfully Login ticket:' + data);
|
||||
// The output will be: API called successfully Login ticket: TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
```
|
||||
|
||||
### Login with ticket
|
||||
|
||||
If you already know thw ticket when you invoke the constructor you can pass it as parameter in the constructor otherwise you can call the login with ticket that will validate the ticket against the server
|
||||
|
||||
#### Login with ticket ECM
|
||||
|
||||
This authentication validate also the ticket against the server
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const ticket = 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1';
|
||||
|
||||
try {
|
||||
await alfrescoJsApi.loginTicket(ticket);
|
||||
console.log('valid ticket you are logged in');
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
```
|
||||
|
||||
#### Login with ticket ECM/BPM as parameter in the constructor
|
||||
|
||||
With this authentication the ticket is not validated against the server
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
|
||||
// Login with ECM ticket
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
ticketEcm:'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1',
|
||||
hostEcm:'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
// Login with BPM ticket
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
ticketBpm: 'Basic YWRtaW46YWRtaW4=',
|
||||
hostBpm:'http://127.0.0.1:9999'
|
||||
});
|
||||
|
||||
// Login with ECM and BPM tickets
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
ticketEcm:'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1',
|
||||
ticketBpm: 'Basic YWRtaW46YWRtaW4=',
|
||||
hostEcm:'http://127.0.0.1:8080',
|
||||
hostBpm:'http://127.0.0.1:9999'
|
||||
});
|
||||
```
|
||||
|
||||
### Login with Username and Password BPM
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi({ provider:'BPM' });
|
||||
|
||||
try {
|
||||
await alfrescoJsApi.login('admin', 'admin');
|
||||
console.log('API called successfully Login in Activiti BPM performed ');
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
```
|
||||
|
||||
### Login with OAUTH2 Alfresco authorization server
|
||||
|
||||
#### Implicit Flow
|
||||
|
||||
If your want to redirect to the authorization server and login there, you can use the implicit flow to login
|
||||
|
||||
**oauth2 properties**
|
||||
|
||||
| Property | Description | Default Value |
|
||||
|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
|
||||
| host | Your oauth2 server URL | null |
|
||||
| clientId | Your clientId oauth2 | null |
|
||||
| secret | Your secret oauth2 | null |
|
||||
| scope | Your scope | null |
|
||||
| implicitFlow | true/false | false |
|
||||
| redirectUri | url to be redirect after login | null |
|
||||
| redirectLogout | url to be redirect after logout optional, if is nor present the redirectUri will be used | null |
|
||||
| refreshTokenTimeout | millisecond value, after how many millisecond you want refresh the token | 30000 |
|
||||
| redirectSilentIframeUri | url to be redirect after silent refresh login | /assets/silent-refresh.html |
|
||||
| silentLogin | direct execute the implicit login without the need to call AlfrescoJsApi.implicitLogin() method | false |
|
||||
| publicUrls | list of public urls that don't need authorization. It is possible too pass absolute paths and string patterns. In patterns you can use * or ** wildcards. Single means that you can have anything in one part of URL for example http://some-public-url/path/* matches with http://some-public-url/path/test. Double means that you can have anything in any number of parts, for example http://some-public-url/path/** matches with http://some-public-url/path/test/some-test. |
|
||||
| authorizationUrl | authorization url, relative to the host | /protocol/openid-connect/auth |
|
||||
| tokenUrl | token url, relative to the host | /protocol/openid-connect/token |
|
||||
| logoutUrl | logout url, relative to the host | /protocol/openid-connect/logout |
|
||||
|
||||
The api/js-api will automatically redirect you to the login page anf refresh the token if necessary
|
||||
|
||||
**Events**
|
||||
|
||||
| Property | Description | Default Value |
|
||||
|-------------------|--------------------------------------------------------------------------------------------------------------|---------------|
|
||||
| implicit_redirect | triggered when the user is redirect to the auth server return url parameter of the redirect | |
|
||||
| discovery | triggered when all the openId discovery url phase is terminated return an object with all the discovered url | |
|
||||
| token_issued | triggered when a new token is issued | |
|
||||
|
||||
The api/js-api will automatically redirect you to the login page and refresh the token if necessary
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
oauth2: {
|
||||
host: 'HOST_OAUTH2_SERVER',
|
||||
clientId: 'YOUR_CLIENT_ID',
|
||||
secret: 'SECRET',
|
||||
scope: 'openid',
|
||||
implicitFlow: true,
|
||||
redirectUri: 'YOUR_HOME_APP_URL',
|
||||
silentRefreshTimeout: '600000' //Optional parameter 10 minutes default value
|
||||
},
|
||||
authType: 'OAUTH',
|
||||
provider: 'ALL'
|
||||
});
|
||||
|
||||
alfrescoJsApi.implicitLogin();
|
||||
```
|
||||
|
||||
**Example skip login form (implicitFlow)**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
oauth2: {
|
||||
host: 'HOST_OAUTH2_SERVER',
|
||||
clientId: 'YOUR_CLIENT_ID',
|
||||
secret: 'SECRET',
|
||||
scope: 'openid',
|
||||
implicitFlow: true,
|
||||
redirectUri: 'YOUR_HOME_APP_URL',
|
||||
silentRefreshTimeout: '600000', // Optional parameter 10 minutes default value,
|
||||
silentLogin: true,
|
||||
publicUrls: ['PUBLIC_URL', 'URL_PATTERN']
|
||||
},
|
||||
authType: 'OAUTH',
|
||||
provider: 'ALL'
|
||||
});
|
||||
```
|
||||
|
||||
#### Password Flow
|
||||
|
||||
If your auth endpoint is different from the standard one "/oauth/token" you can override it through the property authPath
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
oauth2: {
|
||||
host: 'HOST_OAUTH2_SERVER',
|
||||
clientId: 'YOUR_CLIENT_ID',
|
||||
secret: 'SECRET',
|
||||
authPath:'my-custom-auth-endpoint/token'
|
||||
},
|
||||
authType: 'OAUTH',
|
||||
provider: 'ALL'
|
||||
});
|
||||
|
||||
try {
|
||||
await alfrescoJsApi.login('admin', 'admin');
|
||||
console.log('API called successfully Login in with authorization server performed');
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
```
|
||||
|
||||
After the login if you want refresh your token you can use this call
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
try {
|
||||
await alfrescoJsApi.refreshToken();
|
||||
console.log('Your token has been refreshed');
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
```
|
||||
|
||||
## Logout
|
||||
|
||||
```javascript
|
||||
alfrescoJsApi.logout();
|
||||
```
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
try {
|
||||
await alfrescoJsApi.logout();
|
||||
console.log('Successfully logged out');
|
||||
} catch (error) {
|
||||
console.error('Error logging out');
|
||||
}
|
||||
```
|
||||
|
||||
## isLoggedIn
|
||||
|
||||
```javascript
|
||||
alfrescoJsApi.isLoggedIn()
|
||||
```
|
||||
|
||||
Returns `true` if you are logged in, and `false` if you are not.
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
|
||||
const isLoggedIn = alfrescoJsApi.isLoggedIn();
|
||||
|
||||
if (isLoggedIn) {
|
||||
console.log('You are logged in');
|
||||
} else {
|
||||
console.log('You are not logged in');
|
||||
}
|
||||
```
|
||||
|
||||
## Get tickets
|
||||
|
||||
### getTicketEcm()
|
||||
|
||||
After the log in you can retrieve you ECM ticket
|
||||
|
||||
```javascript
|
||||
const ecmTicket = alfrescoJsApi.getTicketEcm() ;
|
||||
|
||||
console.log('This is your ECM ticket ' + ecmTicket);
|
||||
```
|
||||
|
||||
### getTicketBpm()
|
||||
|
||||
After the log in you can retrieve you BPM ticket
|
||||
|
||||
```javascript
|
||||
const bpmTicket = alfrescoJsApi.getTicketBpm();
|
||||
|
||||
console.log('This is your BPM ticket ' + bpmTicket);
|
||||
```
|
||||
|
||||
**Events login/logout**
|
||||
|
||||
The login/logout are also an EventEmitter which you can register to listen to any of the following event types:
|
||||
|
||||
- unauthorized (If this event is triggered a call to the Api was unauthorized)
|
||||
- success (If this event is triggered the login was success you can use this event > instead the login promise)
|
||||
- logout (If this event is triggered the client is successfully logout)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
alfrescoJsApi.login('admin', 'admin')
|
||||
.on('unauthorized', () => {
|
||||
console.log('You are unauthorized you can use this event to redirect to login');
|
||||
});
|
||||
|
||||
alfrescoJsApi.login('admin', 'admin')
|
||||
.on('success', () => {
|
||||
console.log('Success Login');
|
||||
});
|
||||
|
||||
alfrescoJsApi.logout()
|
||||
.on('logout', () => {
|
||||
console.log('Successfully Logout');
|
||||
});
|
||||
```
|
||||
563
lib/js-api/docs/bpm-example.md
Normal file
563
lib/js-api/docs/bpm-example.md
Normal file
@@ -0,0 +1,563 @@
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [BPM](#bpm)
|
||||
* [Task Api](#task-api)
|
||||
+ [List Task](#list-task)
|
||||
+ [Get Task](#get-task)
|
||||
+ [Filter Tasks](#filter-tasks)
|
||||
+ [Complete Task](#complete-task)
|
||||
+ [Get Task Form](#get-task-form)
|
||||
+ [Complete Task Form](#complete-task-form)
|
||||
* [Process Api](#process-api)
|
||||
+ [Get Process Instances](#get-process-instances)
|
||||
* [Models Api](#models-api)
|
||||
+ [Get Model](#get-model)
|
||||
* [Report Api](#report-api)
|
||||
+ [Create default Reports](#create-default-reports)
|
||||
+ [Get Reports](#get-reports)
|
||||
+ [Report Params](#report-params)
|
||||
* [Report Process Definitions](#report-process-definitions)
|
||||
* [Tasks of process definition](#tasks-of-process-definition)
|
||||
* [Generate reports](#generate-reports)
|
||||
* [Update report details](#update-report-details)
|
||||
* [Export to csv](#export-to-csv)
|
||||
* [Save Report](#save-report)
|
||||
* [Delete report](#delete-report)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
# BPM
|
||||
|
||||
A complete list of all the BPM methods is available here: [Activiti API](../src/api/activiti-rest-api/README.md).
|
||||
|
||||
Below you can find some common examples.
|
||||
|
||||
## Task Api
|
||||
|
||||
Below you can find some example relative to the Activiti process api for all the possible method go to [Tasks Api](../src/api/activiti-rest-api/docs/TasksApi.md) documentation.
|
||||
|
||||
### List Task
|
||||
|
||||
```javascript
|
||||
TasksApi.listTasks(tasksQuery)
|
||||
```
|
||||
|
||||
return a list of task based on the `tasksQuery` query
|
||||
|
||||
#### Example
|
||||
|
||||
```javascript
|
||||
import { TasksApi, TaskQueryRepresentation } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const taskApi = TasksApi(alfrescoApi);
|
||||
|
||||
const tasksQuery = new TaskQueryRepresentation();
|
||||
|
||||
taskApi.listTasks(tasksQuery).then(
|
||||
(data) => {
|
||||
console.log('listTasks ' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
### Get Task
|
||||
|
||||
```javascript
|
||||
TasksApi.getTask(taskId)
|
||||
```
|
||||
|
||||
Returns the [TaskRepresentation](/src/api/activiti-rest-api/docs/TaskRepresentation.md) of single task by id
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|--------|--------|-------------|
|
||||
| taskId | String | taskId |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const taskApi = TasksApi(this.alfrescoApi);
|
||||
|
||||
const taskId = '10'; // String | taskId
|
||||
|
||||
taskApi.getTask(taskId).then(
|
||||
(data) => {
|
||||
console.log('Task representation ' + data);
|
||||
}, (error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
### Filter Tasks
|
||||
|
||||
```javascript
|
||||
TasksApi.filterTasks(requestTasks)
|
||||
```
|
||||
|
||||
Returns the [ResultListDataRepresentation](../src/api/activiti-rest-api/docs/ResultListDataRepresentation«TaskRepresentation».md) that is a filtered list of all the tasks.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|--------------|------------------------------------------------------------------------------------------------------|--------------|
|
||||
| requestTasks | [TaskFilterRequestRepresentation](../src/api/activiti-rest-api/docs/TaskFilterRequestRepresentation.md) | requestTasks |
|
||||
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const taskApi = TasksApi(alfrescoApi);
|
||||
|
||||
const requestTasks = new TaskFilterRequestRepresentation({
|
||||
appDefinitionId: 1
|
||||
});
|
||||
|
||||
taskApi.filterTasks(requestTasks).then(
|
||||
(data) => {
|
||||
console.log('Task filter list ' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
### Complete Task
|
||||
|
||||
```javascript
|
||||
TasksApi.completeTask(taskId)
|
||||
```
|
||||
|
||||
To complete a task (standalone or without a task form).
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------|------------|-------------|
|
||||
| **taskId** | **String** | taskId |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const taskApi = TasksApi(alfrescoApi);
|
||||
|
||||
const taskId = '10'; // String | taskId
|
||||
|
||||
taskApi.taskApi.completeTask(taskId).then(
|
||||
() => {
|
||||
console.log('Task completed');
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
### Get Task Form
|
||||
|
||||
```javascript
|
||||
TasksApi.getTaskForm(taskId)
|
||||
```
|
||||
|
||||
Retrieve the [Task Form](../src/api/activiti-rest-api/docs/FormDefinitionRepresentation.md) representation.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------|------------|-------------|
|
||||
| **taskId** | **String** | taskId |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const taskApi = TasksApi(this.alfrescoApi);
|
||||
|
||||
const taskId = '10';
|
||||
|
||||
taskApi.getTaskForm(taskId).then(
|
||||
(data) => {
|
||||
console.log('Task form representation' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
### Complete Task Form
|
||||
|
||||
completeTaskForm(taskId, completeTaskFormRepresentation)
|
||||
|
||||
Complete a Task Form
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|--------------------------------|--------------------------------------------------------------------------------------------|--------------------------------|
|
||||
| taskId | String | taskId |
|
||||
| completeTaskFormRepresentation | [CompleteFormRepresentation](../src/api/activiti-rest-api/docs/CompleteFormRepresentation.md) | completeTaskFormRepresentation |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const taskApi = TasksApi(this.alfrescoApi);
|
||||
|
||||
const taskId = '10'; // String | taskId
|
||||
|
||||
taskApi.completeTaskForm(taskId, completeTaskFormRepresentation).then(
|
||||
() => {
|
||||
console.log('Task completed');
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
## Process Api
|
||||
|
||||
### Get Process Instances
|
||||
|
||||
```javascript
|
||||
ProcessInstancesApi.getProcessInstances(requestNode)
|
||||
```
|
||||
|
||||
Retrieve a list of process instances, see [ResultListDataRepresentationProcessInstanceRepresentation](../src/api/activiti-rest-api/docs/ResultListDataRepresentation«ProcessInstanceRepresentation».md)
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|-------------|------------------------------------------------------------------------------------------------------------|-------------|
|
||||
| requestNode | [ProcessInstanceQueryRepresentation](../src/api/activiti-rest-api/docs/ProcessInstanceQueryRepresentation.md) | requestNode |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const processApi = ProcessApi(alfrescoApi);
|
||||
const requestNode = new ProcessInstanceQueryRepresentation();
|
||||
|
||||
processApi.getProcessInstances(requestNode).then(
|
||||
(data) => {
|
||||
console.log('All processes' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
Filtered process:
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const processApi = ProcessApi(this.alfrescoApi);
|
||||
|
||||
const requestNode = new ProcessInstanceQueryRepresentation({
|
||||
page: 0,
|
||||
sort: 'created-desc',
|
||||
state: 'completed'
|
||||
});
|
||||
|
||||
processApi.getProcessInstances(requestNode).then(
|
||||
(data) => {
|
||||
console.log('All processes completed' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
## Models Api
|
||||
|
||||
Below you can find some example relative to the Activiti process api for all the possible method go to [Models Api](../src/api/activiti-rest-api/docs/ModelsApi.md) documentation.
|
||||
|
||||
### Get Model
|
||||
|
||||
getModel(modelId, opts)
|
||||
|
||||
To retrieve details about a particular model (process, form, decision rule or app) return a [ModelRepresentation](../src/api/activiti-rest-api/docs/ModelRepresentation.md)
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|--------------------|---------|--------------------|------------|
|
||||
| modelId | Number | modelId | |
|
||||
| includePermissions | Boolean | includePermissions | [optional] |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const modelsApi = new ModelsApi(alfrescoApi);
|
||||
|
||||
const opts = {
|
||||
filter: 'myReusableForms',
|
||||
modelType: 2
|
||||
};
|
||||
|
||||
modelsApi.getModels(opts).then(
|
||||
(data) => {
|
||||
console.log('All your reusable forms' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
|
||||
## Report Api
|
||||
|
||||
Below you can find some example relative to the Activiti report api for all the possible method go to [Report Api documentation](../src/api/activiti-rest-api/docs/ReportApi.md)
|
||||
|
||||
### Create Default Reports
|
||||
|
||||
```javascript
|
||||
ReportApi.createDefaultReports()
|
||||
```
|
||||
|
||||
Creates the default reports
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
reportApi.createDefaultReports();
|
||||
```
|
||||
|
||||
### Get Reports
|
||||
|
||||
```javascript
|
||||
ReportApi.getReportList()
|
||||
```
|
||||
|
||||
Retrieve the available report list
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
reportApi.getReportList();
|
||||
```
|
||||
|
||||
### Report Params
|
||||
|
||||
```javascript
|
||||
ReportApi.getReportParams(reportId)
|
||||
```
|
||||
|
||||
> Retrieve the parameters referring to the reportId.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|----------|--------|-------------|
|
||||
| reportId | String | reportId |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
reportApi.getReportParams(reportId);
|
||||
```
|
||||
|
||||
## Report Process Definitions
|
||||
|
||||
```javascript
|
||||
ReportApi.getProcessDefinitions()
|
||||
```
|
||||
|
||||
Retrieve the process definition list for all the apps.
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
reportApi.getProcessDefinitions();
|
||||
```
|
||||
|
||||
## Tasks of Process Definition
|
||||
|
||||
getTasksByProcessDefinitionId(reportId, processDefinitionId)
|
||||
|
||||
Retrieves all tasks that refer to the processDefinitionId
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------------------|--------|-----------------------|
|
||||
| reportId | String | reportId |
|
||||
| processDefinitionId | String | process definition id |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
const processDefinitionId = '1';
|
||||
|
||||
reportApi.getTasksByProcessDefinitionId(reportId, processDefinitionId);
|
||||
```
|
||||
|
||||
## Generate reports
|
||||
|
||||
```javascript
|
||||
ReportApi.getReportsByParams(reportId, paramsQuery)
|
||||
```
|
||||
|
||||
Generate the reports based on the input parameters
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|-------------|--------|------------------|
|
||||
| reportId | String | reportId |
|
||||
| paramsQuery | Object | Query parameters |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
const paramsQuery = { status: 'ALL' };
|
||||
|
||||
reportApi.getReportsByParams(reportId, paramsQuery);
|
||||
```
|
||||
## Update report details
|
||||
|
||||
```javascript
|
||||
ReportApi.updateReport(reportId, name)
|
||||
```
|
||||
|
||||
Update the report details
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|----------|--------|-----------------|
|
||||
| reportId | String | reportId |
|
||||
| name | String | The report name |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
const name = 'new report name';
|
||||
|
||||
reportApi.updateReport(reportId, name);
|
||||
```
|
||||
|
||||
## Export to CSV
|
||||
|
||||
```javascript
|
||||
ReportApi.exportToCsv(reportId, queryParams)
|
||||
```
|
||||
|
||||
Export a report as csv
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|-------------|--------|------------------|
|
||||
| reportId | String | reportId |
|
||||
| queryParams | Object | Query parameters |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
const queryParams = {
|
||||
processDefinitionId: 'TEST:99:999',
|
||||
dateRange: {
|
||||
startDate: '2017-01-01T00:00:00.000Z',
|
||||
endDate: '2017-01-24T23:59:59.999Z',
|
||||
rangeId: 'currentYear'
|
||||
},
|
||||
slowProcessInstanceInteger: 10,
|
||||
status: 'All',
|
||||
__reportName: 'FAKE_REPORT_NAME'
|
||||
};
|
||||
|
||||
reportApi.exportToCsv(reportId, queryParams);
|
||||
```
|
||||
|
||||
## Save Report
|
||||
|
||||
```javascript
|
||||
ReportApi.saveReport(reportId, queryParams)
|
||||
```
|
||||
|
||||
Save a report
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|-------------|--------|------------------|
|
||||
| reportId | String | reportId |
|
||||
| queryParams | Object | Query parameters |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
const queryParams = {
|
||||
processDefinitionId: 'TEST:99:999',
|
||||
dateRange: {
|
||||
startDate: '2017-01-01T00:00:00.000Z',
|
||||
endDate: '2017-01-24T23:59:59.999Z',
|
||||
rangeId: 'currentYear'
|
||||
},
|
||||
slowProcessInstanceInteger: 10,
|
||||
status: 'All',
|
||||
__reportName: 'FAKE_REPORT_NAME'
|
||||
};
|
||||
|
||||
reportApi.saveReport(reportId, queryParams);
|
||||
```
|
||||
|
||||
## Delete report
|
||||
|
||||
```javascript
|
||||
ReportApi.deleteReport(reportId)
|
||||
```
|
||||
|
||||
Delete a report
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|----------|--------|-------------|
|
||||
| reportId | String | reportId |
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const reportApi = ReportApi(alfrescoApi);
|
||||
|
||||
const reportId = '1';
|
||||
|
||||
reportApi.deleteReport(reportId);
|
||||
```
|
||||
36
lib/js-api/docs/calling-custom-endpoints.md
Normal file
36
lib/js-api/docs/calling-custom-endpoints.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Calling Custom Endpoints
|
||||
|
||||
Content service and process service has two different clients:
|
||||
|
||||
- AlfrescoJsApi.ProcessClient
|
||||
- AlfrescoJsApi.ContentClient
|
||||
|
||||
Both clients expose a method ***callApi**
|
||||
|
||||
```typescript
|
||||
function callApi(
|
||||
path: string,
|
||||
httpMethod: string,
|
||||
pathParams?: any,
|
||||
queryParams?: any,
|
||||
headerParams?: any,
|
||||
formParams?: any,
|
||||
bodyParam?: any,
|
||||
contentTypes?: string[],
|
||||
accepts?: string[],
|
||||
returnType?: any,
|
||||
contextRoot?: string,
|
||||
responseType?: string
|
||||
): Promise<any> {};
|
||||
```
|
||||
|
||||
If you want call your custom rest point in one of those two service use the corresponding client.
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
alfrescoJsApi.bpmClient.callApi(
|
||||
'/api/enterprise/app-version', 'GET',
|
||||
{}, {}, {}, {}, {}, ['application/json'], ['application/json'], {'String': 'String'}
|
||||
)
|
||||
```
|
||||
0
lib/js-api/docs/changelog/.gitkeep
Normal file
0
lib/js-api/docs/changelog/.gitkeep
Normal file
18
lib/js-api/docs/changelog/changelog-4.10.0.md
Normal file
18
lib/js-api/docs/changelog/changelog-4.10.0.md
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v4.10.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [b9c450cd4](https://github.com/Alfresco/alfresco-js-api/commit/b9c450cd4) Update .mergify.yml
|
||||
- [ee63a51a6](https://github.com/Alfresco/alfresco-js-api/commit/ee63a51a6) Update js-api-build.yml
|
||||
- [83db6f6e3](https://github.com/Alfresco/alfresco-js-api/commit/83db6f6e3) Update js-api-build.yml
|
||||
- [d09f7601c](https://github.com/Alfresco/alfresco-js-api/commit/d09f7601c) Update js-api-build.yml
|
||||
- [c158ba2ec](https://github.com/Alfresco/alfresco-js-api/commit/c158ba2ec) Update js-api-build.yml (#1358)
|
||||
- [445a36953](https://github.com/Alfresco/alfresco-js-api/commit/445a36953) fix build
|
||||
- [be9ccaa78](https://github.com/Alfresco/alfresco-js-api/commit/be9ccaa78) Update js-api-build.yml
|
||||
- [bc3ee9017](https://github.com/Alfresco/alfresco-js-api/commit/bc3ee9017) Update README.md
|
||||
- [20abc2960](https://github.com/Alfresco/alfresco-js-api/commit/20abc2960) Move to github actions (#1353)
|
||||
- [d7f899b49](https://github.com/Alfresco/alfresco-js-api/commit/d7f899b49) Update package.json
|
||||
- [2730595bd](https://github.com/Alfresco/alfresco-js-api/commit/2730595bd) [AAE-7657] Let js-api depend on generic http client (#1332)
|
||||
|
||||
15
lib/js-api/docs/changelog/changelog-4.11.0.md
Normal file
15
lib/js-api/docs/changelog/changelog-4.11.0.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v4.11.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [0c345b466](https://github.com/Alfresco/alfresco-js-api/commit/0c345b466) remove mergify config (#1371)
|
||||
- [a50e297eb](https://github.com/Alfresco/alfresco-js-api/commit/a50e297eb) feat: rename and export LegacyAlfrescoApi in public-api (#1382)
|
||||
- [e19d6ce50](https://github.com/Alfresco/alfresco-js-api/commit/e19d6ce50) Expose the api to fetch userinfo (#1381)
|
||||
- [c7273a2ee](https://github.com/Alfresco/alfresco-js-api/commit/c7273a2ee) Check out and npm ci
|
||||
- [f074f6d0e](https://github.com/Alfresco/alfresco-js-api/commit/f074f6d0e) Create a different flow for upstream manually (#1380)
|
||||
- [75ba2574e](https://github.com/Alfresco/alfresco-js-api/commit/75ba2574e) Being able to trigger the adf trigger from workflow (#1379)
|
||||
- [470d9c3ed](https://github.com/Alfresco/alfresco-js-api/commit/470d9c3ed) [AAE-8649] Being able to use input values of discovery (#1378)
|
||||
- [005b96df6](https://github.com/Alfresco/alfresco-js-api/commit/005b96df6) Ability to pass client secret (#1373)
|
||||
|
||||
8
lib/js-api/docs/changelog/changelog-4.7.0.md
Normal file
8
lib/js-api/docs/changelog/changelog-4.7.0.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v4.7.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [14f1b3ba](https://github.com/Alfresco/alfresco-js-api/commit/14f1b3ba) release reports generation (#1258)
|
||||
- [e55cff6b](https://github.com/Alfresco/alfresco-js-api/commit/e55cff6b) Update publish.sh
|
||||
8
lib/js-api/docs/changelog/changelog-4.8.0.md
Normal file
8
lib/js-api/docs/changelog/changelog-4.8.0.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v4.8.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [39afcf33](https://github.com/Alfresco/alfresco-js-api/commit/39afcf33) Bump typescript from 4.5.3 to 4.5.4 (#1273)
|
||||
- [f2e43b36](https://github.com/Alfresco/alfresco-js-api/commit/f2e43b36) Support custom OAuth endpoints (#1259)
|
||||
9
lib/js-api/docs/changelog/changelog-4.9.0.md
Normal file
9
lib/js-api/docs/changelog/changelog-4.9.0.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v4.9.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [cdeecd6f6](https://github.com/Alfresco/alfresco-js-api/commit/cdeecd6f6) Revert the superagent upgrade (#1340)
|
||||
- [6dc7e489d](https://github.com/Alfresco/alfresco-js-api/commit/6dc7e489d) Make ADF possible to update on request (#1339)
|
||||
- [c8db476cb](https://github.com/Alfresco/alfresco-js-api/commit/c8db476cb) revert superagent (#1338)
|
||||
11
lib/js-api/docs/changelog/changelog-5.0.0.md
Normal file
11
lib/js-api/docs/changelog/changelog-5.0.0.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v5.0.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [73acb91ed](https://github.com/Alfresco/alfresco-js-api/commit/73acb91ed) Fix problems around legacyAlfrescoApi (#1403)
|
||||
- [434c24ea6](https://github.com/Alfresco/alfresco-js-api/commit/434c24ea6) Fix the order of httpClient testing conditions (#1402)
|
||||
- [8240936f2](https://github.com/Alfresco/alfresco-js-api/commit/8240936f2) [AAE-9334] Improve update project script (#1395)
|
||||
- [a7fc2e92a](https://github.com/Alfresco/alfresco-js-api/commit/a7fc2e92a) [MNT-22840] Use ticket parameter instead of alf_ticket when withCredentials configuration is enabled (#1392)
|
||||
|
||||
10
lib/js-api/docs/changelog/changelog-5.1.0.md
Normal file
10
lib/js-api/docs/changelog/changelog-5.1.0.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v5.1.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [ADF-5501] fix: change the guard for progress event detection (#1441)
|
||||
- add missing tslib dependency (#1437)
|
||||
- [APPS-1732] Removed AuthorityType and clearance parameters from GET AuthorityClearance endpoint (#1435)
|
||||
- [AAE-9473] feat: extract http client to handle custom implementations (#1412) (#1392)
|
||||
9
lib/js-api/docs/changelog/changelog-5.2.0.md
Normal file
9
lib/js-api/docs/changelog/changelog-5.2.0.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v5.2.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- 90ab51c26 [MNT-23143] Add withCredentials to isLoggedIn
|
||||
- 80106a493 [MNT-23143] Move withCredentials check to correct method
|
||||
- f80ed199a [MNT-23143] withCredentials reflected in isBpmLoggedIn
|
||||
20
lib/js-api/docs/changelog/changelog-5.3.0.md
Normal file
20
lib/js-api/docs/changelog/changelog-5.3.0.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v5.3.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- 86fec25ec [ACS-4118] create a tag from tags list
|
||||
- 11252d0e0 [ACS-4413] upgrade CodeQL to v2 (#1493)
|
||||
- 3d8e2851a [ACS-4118] Update readme file
|
||||
- 4b58f0f60 [ACS-4118] Little correction for documentation
|
||||
- b9809fa36 [ACS-4118] Allow to return tags for specified name
|
||||
- e692367a7 [ACS-4118] Use callApi and write some documentation for tags creation
|
||||
- cfd2b60b4 [ACS-4118] Update api for tags creation
|
||||
- ddc565fa2 [ACS-4240] delete category api change (#1484)
|
||||
- 4286228b5 [ACS-4115] Added module annotation to categoriesApi and added category models to index
|
||||
- 6ee349878 [ACS-4116]update of updateCategory endpoint.
|
||||
- f0c6e8e45 added module annotation to categoriesApi and other models to index
|
||||
- 22d5c2940 [ACS-4114] Export categories api
|
||||
- 1c1305e91 [ACS-4114] Export categories api
|
||||
- 2ebce874f [ACS-4114] Add categories api (#1477)
|
||||
16
lib/js-api/docs/changelog/changelog-5.4.0.md
Normal file
16
lib/js-api/docs/changelog/changelog-5.4.0.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v5.4.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [4b9b21f4f](https://github.com/Alfresco/alfresco-js-api/commit/4b9b21f4f) fix-js-api-upstream (#1526)
|
||||
- [4152c12f3](https://github.com/Alfresco/alfresco-js-api/commit/4152c12f3) [ACS-4331] Add deleteTag method to tags API (#1490)
|
||||
- [d979e35be](https://github.com/Alfresco/alfresco-js-api/commit/d979e35be) [ACS-4590] cleanup performance tests (#1516)
|
||||
- [90d83635c](https://github.com/Alfresco/alfresco-js-api/commit/90d83635c) [ACS-4611] Check proper storage (#1515)
|
||||
- [41e31845e](https://github.com/Alfresco/alfresco-js-api/commit/41e31845e) Improved ESLint setup (#1509)
|
||||
- [26bbe4e18](https://github.com/Alfresco/alfresco-js-api/commit/26bbe4e18) Fix GHA warnings for upcoming changes for setup-node action (#1508)
|
||||
- [009444391](https://github.com/Alfresco/alfresco-js-api/commit/009444391) [ADF-5515] disable integration tests until config fixes (#1505)
|
||||
- [fea47c040](https://github.com/Alfresco/alfresco-js-api/commit/fea47c040) [ACS-4412] Unit tests for createTags function (#1499)
|
||||
- [39b3c3004](https://github.com/Alfresco/alfresco-js-api/commit/39b3c3004) AAE-12059: Removed createProcessInstanceVariables method from process instance variavles api (#1494)
|
||||
|
||||
17
lib/js-api/docs/changelog/changelog-5.5.0.md
Normal file
17
lib/js-api/docs/changelog/changelog-5.5.0.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v5.5.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [3939ed803](https://github.com/Alfresco/alfresco-js-api/commit/3939ed803) use the gh strategy (#1565)
|
||||
- [e90fb3c62](https://github.com/Alfresco/alfresco-js-api/commit/e90fb3c62) [ACS-4126] viewer allow assigning tags to content basic (#1557)
|
||||
- [b4b9ffe28](https://github.com/Alfresco/alfresco-js-api/commit/b4b9ffe28) [ACS-4753] list of tags is not rendered because of missing count field in backend response (#1546)
|
||||
- [c3dcf1c39](https://github.com/Alfresco/alfresco-js-api/commit/c3dcf1c39) Use token as part of workflow (#1544)
|
||||
- [835bb11f7](https://github.com/Alfresco/alfresco-js-api/commit/835bb11f7) fix tab
|
||||
- [9bd75b802](https://github.com/Alfresco/alfresco-js-api/commit/9bd75b802) Inverte release order (#1543)
|
||||
- [d697c7623](https://github.com/Alfresco/alfresco-js-api/commit/d697c7623) Rely on action to create npmrc (#1542)
|
||||
- [3dea8b143](https://github.com/Alfresco/alfresco-js-api/commit/3dea8b143) Publish js pkgs on gh pkg registry (#1538)
|
||||
- [2414d226f](https://github.com/Alfresco/alfresco-js-api/commit/2414d226f) [ACS-4724] remove minimatch dependency (#1536)
|
||||
- [a7c0cee18](https://github.com/Alfresco/alfresco-js-api/commit/a7c0cee18) [ACS-4723] Remove fs-extra dependency (#1535)
|
||||
|
||||
11
lib/js-api/docs/changelog/changelog-6.0.0.md
Normal file
11
lib/js-api/docs/changelog/changelog-6.0.0.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v6.0.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [e70da65bc](https://github.com/Alfresco/alfresco-js-api/commit/e70da65bc) ACS-5040 Renamed one left reference to Alfresco (#1573)
|
||||
- [c93b633ca](https://github.com/Alfresco/alfresco-js-api/commit/c93b633ca) [AAE-13902] - Create the release tag using the github API (#1572)
|
||||
- [5cdab4525](https://github.com/Alfresco/alfresco-js-api/commit/5cdab4525) split testing jobs and add error reporting (#1567)
|
||||
- [22938d88c](https://github.com/Alfresco/alfresco-js-api/commit/22938d88c) [ACS-5040] update license headers to reflect hyland copyright guidelines (#1561)
|
||||
|
||||
8
lib/js-api/docs/changelog/changelog-6.1.0.md
Normal file
8
lib/js-api/docs/changelog/changelog-6.1.0.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v6.1.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [a1c51dfec](git@github.com:Alfresco/alfresco-js-api/commit/a1c51dfec) [ADF-5510] Upgrade to Node 18 (#1579)
|
||||
|
||||
11
lib/js-api/docs/changelog/changelog-6.2.0.md
Normal file
11
lib/js-api/docs/changelog/changelog-6.2.0.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v6.2.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [b7cd96b84](https://github.com/Alfresco/alfresco-js-api/commit/b7cd96b84) do not escape basic auth credentials (#1599)
|
||||
- [a55266731](https://github.com/Alfresco/alfresco-js-api/commit/a55266731) fix child assocs pagination (#1598)
|
||||
- [58d8c4dff](https://github.com/Alfresco/alfresco-js-api/commit/58d8c4dff) fix missing parentId for declareRecord (#1597)
|
||||
- [409e47e09](https://github.com/Alfresco/alfresco-js-api/commit/409e47e09) Fix git tag creation failing on master (#1592)
|
||||
|
||||
31
lib/js-api/docs/changelog/changelog-7.0.0.md
Normal file
31
lib/js-api/docs/changelog/changelog-7.0.0.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v7.0.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [a67a0222e](https://github.com/Alfresco/alfresco-js-api/commit/a67a0222e) [ACS-5946] aps documentation enhancements (#1659)
|
||||
- [2f1de4ec6](https://github.com/Alfresco/alfresco-js-api/commit/2f1de4ec6) Add relations to site entry (#1658)
|
||||
- [7d6d1882b](https://github.com/Alfresco/alfresco-js-api/commit/7d6d1882b) [ACS-5946] documentation improvements (#1652)
|
||||
- [4e3b831bd](https://github.com/Alfresco/alfresco-js-api/commit/4e3b831bd) [ACS-5839] api typings and docs improvements (#1651)
|
||||
- [76f951f67](https://github.com/Alfresco/alfresco-js-api/commit/76f951f67) [ACS-5839] api typings and docs (#1650)
|
||||
- [8ca4ed0a1](https://github.com/Alfresco/alfresco-js-api/commit/8ca4ed0a1) [ACS-5839] GS Api enhancements and typings(#1649)
|
||||
- [0e9673d8b](https://github.com/Alfresco/alfresco-js-api/commit/0e9673d8b) [ACS-5839] fix security groups api
|
||||
- [7119cbe0f](https://github.com/Alfresco/alfresco-js-api/commit/7119cbe0f) [ACS-5839] minor fix to trigger gha deployment
|
||||
- [03c641de2](https://github.com/Alfresco/alfresco-js-api/commit/03c641de2) [ACS-5839] bump to 7.0.0, api enhancements (#1648)
|
||||
- [277b79f3e](https://github.com/Alfresco/alfresco-js-api/commit/277b79f3e) [ACS-5839] typing fixes (#1646)
|
||||
- [de66ea713](https://github.com/Alfresco/alfresco-js-api/commit/de66ea713) [ACS-5839] api fixes and improvements (#1645)
|
||||
- [12567fefe](https://github.com/Alfresco/alfresco-js-api/commit/12567fefe) [ACS-5839] improved typing support (#1638)
|
||||
- [877bae3f7](https://github.com/Alfresco/alfresco-js-api/commit/877bae3f7) [ACS-5839] improved documentation and TypeScript support (#1636)
|
||||
- [241a47ee6](https://github.com/Alfresco/alfresco-js-api/commit/241a47ee6) [ACS-5839] improved API typings (#1635)
|
||||
- [b7b8dbbbc](https://github.com/Alfresco/alfresco-js-api/commit/b7b8dbbbc) [ACS-5845] Remove deprecated apis, documentation updates (#1629)
|
||||
- [54c609427](https://github.com/Alfresco/alfresco-js-api/commit/54c609427) [ACS-5839] Make `contextRoot` optional as per documentation (#1628)
|
||||
- [8cc1d4cdd](https://github.com/Alfresco/alfresco-js-api/commit/8cc1d4cdd) [ACS-5845] remove Alfresco Compatibility usage (#1627)
|
||||
- [e274913c7](https://github.com/Alfresco/alfresco-js-api/commit/e274913c7) [ACS-5839] Improved typings for model classes (#1626)
|
||||
- [5ecfdb2f1](https://github.com/Alfresco/alfresco-js-api/commit/5ecfdb2f1) Remove console logs from auth and fix promise rejections (#1621)
|
||||
- [8faeff9bb](https://github.com/Alfresco/alfresco-js-api/commit/8faeff9bb) [ACS-5839] more TS typings support for Content API models (#1622)
|
||||
- [f1e55ab17](https://github.com/Alfresco/alfresco-js-api/commit/f1e55ab17) Fix FormFieldRepresentation typings, add missing "fields" property (#1623)
|
||||
- [e736ce8ec](https://github.com/Alfresco/alfresco-js-api/commit/e736ce8ec) Update dependencies and various audit fixes (#1620)
|
||||
- [14129b977](https://github.com/Alfresco/alfresco-js-api/commit/14129b977) bump superagent (#1614)
|
||||
- [70e78e889](https://github.com/Alfresco/alfresco-js-api/commit/70e78e889) [AAE-12502] Handle Storage as a singleton to fix on ADF the alf_ticket in not added to the content api because config.ticketECM is undefined (#1616)
|
||||
|
||||
12
lib/js-api/docs/changelog/changelog-7.1.0.md
Normal file
12
lib/js-api/docs/changelog/changelog-7.1.0.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v7.1.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [f00bc51ed](git@github.com:Alfresco/alfresco-js-api/commit/f00bc51ed) [ACA-4724] Use jsdom directly instead of mocha-jsdom in unit test (#1693)
|
||||
- [ca1ef4f45](git@github.com:Alfresco/alfresco-js-api/commit/ca1ef4f45) [ACS-5994] Add multiple nodes deletion support (#1687)
|
||||
- [9d1c6a752](git@github.com:Alfresco/alfresco-js-api/commit/9d1c6a752) Break various dependencies on 3rd party libs (#1679)
|
||||
- [2ee68fbec](git@github.com:Alfresco/alfresco-js-api/commit/2ee68fbec) remove mocha-jsdom dependency due to security issues and deprecated status (#1678)
|
||||
- [8f3c66976](git@github.com:Alfresco/alfresco-js-api/commit/8f3c66976) [ACTIVITI-4914] updated getProcessesAndTasksOnContent (#1672)
|
||||
|
||||
10
lib/js-api/docs/changelog/changelog-7.2.0.md
Normal file
10
lib/js-api/docs/changelog/changelog-7.2.0.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
Title: Changelog for @alfresco/js-api v7.2.0
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
- [b41cc2629](https://github.com/Alfresco/alfresco-js-api/commit/b41cc2629) [ACS-6231] cleanup old codegen (#1716)
|
||||
- [8d02eb4ea](https://github.com/Alfresco/alfresco-js-api/commit/8d02eb4ea) [ACS-6231] cleanup old angular projects and break dependency on remove env (#1715)
|
||||
- [928f9cd91](https://github.com/Alfresco/alfresco-js-api/commit/928f9cd91) [ACS-6231] preparation cleanup before supporting Nx (#1714)
|
||||
|
||||
494
lib/js-api/docs/ecm-example.md
Normal file
494
lib/js-api/docs/ecm-example.md
Normal file
@@ -0,0 +1,494 @@
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [ECM](#ecm)
|
||||
* [Get Node content](#get-node--content)
|
||||
* [Get File or Folder Info](#get-file-or-folder-info)
|
||||
* [Get Folder Children Info](#get-folder-children-info)
|
||||
* [Create Folder](#create-folder)
|
||||
* [Upload File](#upload-file)
|
||||
* [Events Upload File](#events-upload-file)
|
||||
* [Delete File or Folder](#delete-file-or-folder)
|
||||
* [Delete File or Folder Permanent](#delete-file-or-folder-permanent)
|
||||
* [Get thumbnail Url](#get-thumbnail-url)
|
||||
* [Get preview Url](#get-preview-url)
|
||||
* [Get content Url](#get-content-url)
|
||||
* [Custom web scripts call](#custom-web-scripts-call)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
# ECM
|
||||
|
||||
A complete list of all the ECM methods is available here: [Content API](../src/api/content-rest-api/README.md).
|
||||
Below you can find some common examples.
|
||||
|
||||
## Get Node Content
|
||||
|
||||
```javascript
|
||||
NodesApi.getFileContent(nodeId, opts)
|
||||
```
|
||||
|
||||
Returns the file content of the node with identifier **nodeId**.
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const fs = require('fs');
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
const nodeId = '80a94ac8-3ece-47ad-864e-5d939424c47c';
|
||||
|
||||
nodesApi.getNodeContent(nodeId).then(
|
||||
(data) => {
|
||||
fs.writeFile('./test/grass.jpg', data, (error) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
return;
|
||||
}
|
||||
console.log('The file was saved!');
|
||||
});
|
||||
},
|
||||
(error) => {
|
||||
console.error(error);
|
||||
});
|
||||
```
|
||||
|
||||
## Get a Node Info
|
||||
|
||||
```javascript
|
||||
NodesApi.getNodeInfo(nodeId, opts)
|
||||
```
|
||||
|
||||
Get information for the File/Folder with the identifier nodeId.
|
||||
You can also use one of these well-known aliases: `-my-`, `-shared-` or `-root-` as `nodeId` value.
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodeId = '80a94ac8-3ece-47ad-864e-5d939424c47c';
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
nodesApi.getNode(nodeId, opts).then(
|
||||
(nodeEntry) => {
|
||||
console.log('This is the name' + nodeEntry.entry.name );
|
||||
},
|
||||
(error) => {
|
||||
console.log('This node does not exist');
|
||||
});
|
||||
```
|
||||
## Get Folder Children Info
|
||||
|
||||
```javascript
|
||||
NodesApi.getNodeChildren(fileOrFolderId, opts)
|
||||
```
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the include parameter to return additional information.
|
||||
returns a promise with the Info about the children of the node if resolved and `{error}` if rejected.
|
||||
|
||||
You can also use one of these well-known aliases: `-my-`, `-shared-` or `-root-` as `nodeId` value.
|
||||
|
||||
**Example**:
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodeId = '80a94ac8-3ece-47ad-864e-5d939424c47c';
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
nodesApi.listNodeChildren(nodeId, opts).then(
|
||||
(data) => {
|
||||
console.log(
|
||||
'The number of children in this folder are ' + data.list.pagination.count
|
||||
);
|
||||
},
|
||||
(error) => {
|
||||
console.log('This node does not exist');
|
||||
});
|
||||
```
|
||||
## Create Folder
|
||||
|
||||
```javascript
|
||||
NodesApi.addNode(nodeId, nodeBody, opts)
|
||||
```
|
||||
|
||||
Returns a promise that is resolved if the folder is created and `{error}` if rejected.
|
||||
|
||||
You can also use one of these well-known aliases: `-my-`, `-shared-` or `-root-` as `nodeId` value.
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
const nodeBody = {
|
||||
'name': 'newFolderName',
|
||||
'nodeType': 'cm:folder',
|
||||
'relativePath': relativePath
|
||||
};
|
||||
|
||||
nodesApi.addNode('-root-', nodeBody).then(
|
||||
(data) => {
|
||||
console.log('The folder is created in root');
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error in creation of this folder or folder already exist' + error);
|
||||
});
|
||||
```
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
const nodeBody = {
|
||||
'name': 'newFolderName',
|
||||
'nodeType': 'cm:folder',
|
||||
'relativePath': 'folderA/folderB'
|
||||
};
|
||||
|
||||
nodesApi.addNode('-root-', nodeBody).then(
|
||||
(data) => {
|
||||
console.log('The folder is created in folderA/folderB from root');
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error in creation of this folder or folder already exist' + error);
|
||||
});
|
||||
```
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
const nodeBody = {
|
||||
'name': 'newFolderName',
|
||||
'nodeType': 'cm:folder',
|
||||
'relativePath': 'folderA/folderB'
|
||||
};
|
||||
const parentFolder = '80a94ac8-3ece-47ad-864e-5d939424c47c'
|
||||
|
||||
nodesApi.addNode(parentFolder, nodeBody).then(
|
||||
(data) => {
|
||||
console.log('The folder is created in folderA/folderB from parentFolder:' + parentFolder);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error in creation of this folder or folder already exist' + error);
|
||||
});
|
||||
```
|
||||
|
||||
**CreateFolder With Auto Rename**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const nodesApi = new NodesApi(this.alfrescoApi);
|
||||
|
||||
const nodeBody = {
|
||||
name: 'newFolderName',
|
||||
nodeType: 'cm:folder',
|
||||
autoRename: true,
|
||||
relativePath: 'folderA/folderB'
|
||||
};
|
||||
|
||||
nodesApi.addNode('-root-', nodeBody).then(
|
||||
(data) => {
|
||||
console.log('The folder is created in root');
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error in creation of this folder or folder already exist' + error);
|
||||
});
|
||||
```
|
||||
|
||||
## Upload File
|
||||
|
||||
```javascript
|
||||
UploadApi.uploadFile(fileDefinition, relativePath, nodeId, nodeBody, opts)
|
||||
```
|
||||
|
||||
Returns a promise that is resolved if the file is successful uploaded and `{error}` if rejected.
|
||||
|
||||
The `fileDefinition` provides information about files and allows JavaScript to access their content.
|
||||
|
||||
**Web**
|
||||
|
||||
File Definition are generally retrieved from a FileList object returned as a result of a user selecting files using the `<input>` element
|
||||
|
||||
**Node**
|
||||
|
||||
File Definition are generally retrieved from a read stream
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const fs = require('fs');
|
||||
|
||||
const fileToUpload = fs.createReadStream('./folderA/folderB/newFile.txt');
|
||||
const uploadApi = new UploadApi(alfrescoApi);
|
||||
|
||||
uploadApi.uploadFile(fileToUpload).then(
|
||||
() => {
|
||||
console.log('File Uploaded in the root');
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error during the upload' + error);
|
||||
});
|
||||
|
||||
uploadApi.uploadFile(fileToUpload, null, null, null, { autoRename: true })
|
||||
.then(() => {
|
||||
console.log('File Uploaded in the root');
|
||||
}, (error) => {
|
||||
console.log('Error during the upload' + error);
|
||||
});
|
||||
|
||||
uploadApi.uploadFile(fileToUpload, 'folderX/folderY/folderZ')
|
||||
.then(() => {
|
||||
console.log('File Uploaded in the from root folderX/folderY/folderZ');
|
||||
}, (error) => {
|
||||
console.log('Error during the upload' + error);
|
||||
});
|
||||
|
||||
const parentFolder = '80a94ac8-3ece-47ad-864e-5d939424c47c';
|
||||
|
||||
uploadApi.uploadFile(fileToUpload, 'folderX/folderY/folderZ', parentFolder )
|
||||
.then(() => {
|
||||
console.log('File Uploaded in the from parentFolder ' + parentFolder + ' n folderX/folderY/folderZ');
|
||||
}, (error) => {
|
||||
console.log('Error during the upload' + error);
|
||||
});
|
||||
```
|
||||
|
||||
The default behaviour of the Upload API will not create any thumbnail.
|
||||
|
||||
In order to create a thumbnail you have to perform to pass the parameter `{renditions: 'doclib'}` as in the example below.
|
||||
This parameter will basically perform also a call to the Rendition API.
|
||||
|
||||
For more information about the Rendition API :
|
||||
|
||||
* [Rendition API](../src/api/content-rest-api/docs/RenditionsApi.md)
|
||||
* [Rendition service Wiki](https://wiki.alfresco.com/wiki/Rendition_Service)
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const fs = require('fs');
|
||||
|
||||
const fileToUpload = fs.createReadStream('./folderA/folderB/newFile.txt');
|
||||
const uploadApi = new UploadApi(alfrescoApi);
|
||||
|
||||
uploadApi.uploadFile(fileToUpload, null, null, null, {renditions: 'doclib'})
|
||||
.then(() => {
|
||||
console.log('File Uploaded in the root');
|
||||
}, (error) => {
|
||||
console.log('Error during the upload' + error);
|
||||
});
|
||||
```
|
||||
|
||||
To abort a file uploading:
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const fs = require('fs');
|
||||
|
||||
const fileToUpload = fs.createReadStream('./folderA/folderB/newFile.txt');
|
||||
const uploadApi = new UploadApi(alfrescoApi);
|
||||
|
||||
const promiseUpload = uploadApi.uploadFile(fileToUpload)
|
||||
.once('abort', function () {
|
||||
console.log('File Uploaded aborted');
|
||||
});
|
||||
|
||||
promiseUpload.abort();
|
||||
```
|
||||
|
||||
### Upload File Events
|
||||
|
||||
The `uploadFile` is also an `EventEmitter` which you can register to listen to any of the following event types:
|
||||
|
||||
* progress
|
||||
* success
|
||||
* abort
|
||||
* error
|
||||
* unauthorized
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const fs = require('fs');
|
||||
|
||||
const fileToUpload = fs.createReadStream('./folderA/folderB/newFile.txt');
|
||||
const uploadApi = new UploadApi(alfrescoApi);
|
||||
|
||||
uploadApi.uploadFile(fileToUpload)
|
||||
.on('progress', (progress) => {
|
||||
console.log( 'Total :' + progress.total );
|
||||
console.log( 'Loaded :' + progress.loaded );
|
||||
console.log( 'Percent :' + progress.percent );
|
||||
})
|
||||
.on('success', () => {
|
||||
console.log( 'Your File is uploaded');
|
||||
})
|
||||
.on('abort', () => {
|
||||
console.log( 'Upload Aborted');
|
||||
})
|
||||
.on('error', () => {
|
||||
console.log( 'Error during the upload');
|
||||
})
|
||||
.on('unauthorized', () => {
|
||||
console.log('You are unauthorized');
|
||||
})
|
||||
```
|
||||
|
||||
## Delete a Node
|
||||
|
||||
```javascript
|
||||
NodesApi.deleteNode(fileOrFolderId, opts)
|
||||
```
|
||||
|
||||
Delete File/Folder with the identifier nodeId, if the nodeId is a folder, then its children are also deleted.
|
||||
Deleted nodes are moved to the trash bin, and it is still possible to recover them.
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const fileOrFolderId = '80a94ac8-3ece-47ad-864e-5d939424c47c';
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
nodesApi.deleteNode(fileOrFolderId).then(
|
||||
(data) => {
|
||||
console.log('The file/folder is deleted');
|
||||
},
|
||||
(error) => {
|
||||
console.log('This node does not exist');
|
||||
});
|
||||
```
|
||||
|
||||
### Delete a Node Permanently
|
||||
|
||||
```javascript
|
||||
NodesApi.deleteNode(fileOrFolderId, { permanent: true })
|
||||
```
|
||||
|
||||
Delete File/Folder with the identifier nodeId, if the nodeId is a folder, then its children are also deleted.
|
||||
It will not be possible to recover the files after this call.
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const fileOrFolderId = '80a94ac8-3ece-47ad-864e-5d939424c47c';
|
||||
const nodesApi = new NodesApi(alfrescoApi);
|
||||
|
||||
nodesApi.deleteNode(fileOrFolderId, { permanent: true }).then(
|
||||
(data) => {
|
||||
console.log('The file/folder is deleted');
|
||||
},
|
||||
(error) => {
|
||||
console.log('This node does not exist');
|
||||
});
|
||||
```
|
||||
|
||||
## Get Thumbnail Url
|
||||
|
||||
```javascript
|
||||
ContentApi.getDocumentThumbnailUrl(documentId)
|
||||
```
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const contentApi = new ContentApi(alfrescoApi);
|
||||
|
||||
const thumbnailUrl = contentApi.getDocumentThumbnailUrl('1a0b110f-1e09-4ca2-b367-fe25e4964a4');
|
||||
```
|
||||
|
||||
## Get Preview Url
|
||||
|
||||
```javascript
|
||||
ContentApi.getDocumentPreviewUrl(documentId)
|
||||
```
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const contentApi = new ContentApi(alfrescoApi);
|
||||
|
||||
const previewUrl = contentApi.getDocumentPreviewUrl('1a0b110f-1e09-4ca2-b367-fe25e4964a4');
|
||||
```
|
||||
|
||||
## Get Content Url
|
||||
|
||||
```javascript
|
||||
ContentApi.getContentUrl(documentId)
|
||||
```
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const contentApi = new ContentApi(alfrescoApi);
|
||||
|
||||
const contentUrl = contentApi.getContentUrl('1a0b110f-1e09-4ca2-b367-fe25e4964a4');
|
||||
```
|
||||
|
||||
## Custom WebScript Calls
|
||||
|
||||
For mor information about web scripts read the [Wiki](https://wiki.alfresco.com/wiki/Web_Scripts) and the [Wiki with Web ScriptsExamples](https://wiki.alfresco.com/wiki/Web_Scripts_Examples)
|
||||
|
||||
```javascript
|
||||
executeWebScript(httpMethod, scriptPath, scriptArgs, contextRoot, servicePath, postBody)
|
||||
```
|
||||
|
||||
Anatomy of a Web Script URI:
|
||||
|
||||
```text
|
||||
http(s)://(host):(port)/(contextPath)/(servicePath)/(scriptPath)?(scriptArgs)
|
||||
```
|
||||
|
||||
A Web Script is simply a service bound to a URI which responds to HTTP methods such as GET, POST, PUT and DELETE.
|
||||
While using the same underlying code, there are broadly two kinds of Web Scripts.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Description |
|
||||
|-----------------|-----------------------------------------------------------------|
|
||||
| **httpMethod** | possible value GET, POST, PUT and DELETE |
|
||||
| **scriptPath** | path to Web Script (as defined by Web Script) |
|
||||
| **scriptArgs** | arguments to pass to Web Script |
|
||||
| **contextRoot** | path where application is deployed default value 'alfresco' |
|
||||
| **servicePath** | path where Web Script service is mapped default value 'service' |
|
||||
| **postBody** | post body |
|
||||
|
||||
```javascript
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const webscriptApi = new WebscriptApi(alfrescoApi);
|
||||
|
||||
// Call a GET on a Web Scripts available at the following URIs: http://127.0.01:8080/alfresco/service/mytasks
|
||||
|
||||
webscriptApi.executeWebScript('GET', 'mytasks').then(
|
||||
(data) => {
|
||||
console.log('Data received form http://127.0.01:8080/alfresco/service/mytasks' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
|
||||
// Call a GET on a Web Scripts available at the following URIs: http://127.0.01:8080/share/service/mytasks
|
||||
|
||||
webscriptApi.executeWebScript('GET', 'mytasks', null, 'share').then(
|
||||
(data)=> {
|
||||
console.log('Data received form http://127.0.01:8080/share/service/mytasks' + data);
|
||||
},
|
||||
(error)=> {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
|
||||
// Call a GET on a Web Scripts available at the following URIs: http://127.0.01:8080/share/differentServiceSlug/mytasks
|
||||
|
||||
webscriptApi.executeWebScript('GET', 'mytasks', null, 'share', 'differentServiceSlug').then(
|
||||
(data)=> {
|
||||
console.log('Data received form http://127.0.01:8080/share/differentServiceSlug/mytasks' + data);
|
||||
},
|
||||
(error) => {
|
||||
console.log('Error' + error);
|
||||
});
|
||||
```
|
||||
11
lib/js-api/docs/error-events.md
Normal file
11
lib/js-api/docs/error-events.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Error Events
|
||||
|
||||
The api/js-api has an error handler event where you can subscribe
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
alfrescoJsApi.on('error', error => {
|
||||
console.log(error);
|
||||
});
|
||||
```
|
||||
0
lib/js-api/docs/licences/.gitkeep
Normal file
0
lib/js-api/docs/licences/.gitkeep
Normal file
55
lib/js-api/docs/licences/license-info-4.10.0.md
Normal file
55
lib/js-api/docs/licences/license-info-4.10.0.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 4.10.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 4.10.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 4.10.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
55
lib/js-api/docs/licences/license-info-4.11.0.md
Normal file
55
lib/js-api/docs/licences/license-info-4.11.0.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 4.11.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 4.11.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 4.11.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
47
lib/js-api/docs/licences/license-info-4.7.0.md
Normal file
47
lib/js-api/docs/licences/license-info-4.7.0.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 4.7.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 4.7.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 4.7.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 1.1.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [concat-map](https://github.com/substack/node-concat-map) | 0.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.0.7 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.4.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 3.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.9.4 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
|
||||
47
lib/js-api/docs/licences/license-info-4.8.0.md
Normal file
47
lib/js-api/docs/licences/license-info-4.8.0.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 4.8.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 4.8.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 4.8.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 1.1.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [concat-map](https://github.com/substack/node-concat-map) | 0.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.0.7 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.4.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 3.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.9.4 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
|
||||
55
lib/js-api/docs/licences/license-info-4.9.0.md
Normal file
55
lib/js-api/docs/licences/license-info-4.9.0.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 4.9.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 4.9.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 4.9.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
55
lib/js-api/docs/licences/license-info-5.0.0.md
Normal file
55
lib/js-api/docs/licences/license-info-5.0.0.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 5.0.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 5.0.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 5.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
55
lib/js-api/docs/licences/license-info-5.1.0.md
Normal file
55
lib/js-api/docs/licences/license-info-5.1.0.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 5.1.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 5.1.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 5.1.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.4.0 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
56
lib/js-api/docs/licences/license-info-5.2.0.md
Normal file
56
lib/js-api/docs/licences/license-info-5.2.0.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 5.2.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 5.2.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 5.2.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.4.0 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
56
lib/js-api/docs/licences/license-info-5.3.0.md
Normal file
56
lib/js-api/docs/licences/license-info-5.3.0.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 5.3.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 5.3.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 5.3.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.10.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.4.0 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
56
lib/js-api/docs/licences/license-info-5.4.0.md
Normal file
56
lib/js-api/docs/licences/license-info-5.4.0.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 5.4.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 5.4.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 5.4.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [minimatch](https://github.com/isaacs/minimatch) | 5.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.5.0 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
53
lib/js-api/docs/licences/license-info-5.5.0.md
Normal file
53
lib/js-api/docs/licences/license-info-5.5.0.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 5.5.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 5.5.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 5.5.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.5.0 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
53
lib/js-api/docs/licences/license-info-6.0.0.md
Normal file
53
lib/js-api/docs/licences/license-info-6.0.0.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 6.0.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 6.0.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 6.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.5.0 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
53
lib/js-api/docs/licences/license-info-6.1.0.md
Normal file
53
lib/js-api/docs/licences/license-info-6.1.0.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 6.1.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 6.1.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 6.1.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.5.2 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
53
lib/js-api/docs/licences/license-info-6.2.0.md
Normal file
53
lib/js-api/docs/licences/license-info-6.2.0.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 6.2.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 6.2.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 6.2.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 1.2.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [inherits](https://github.com/isaacs/inherits) | 2.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/visionmedia/superagent) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.5.3 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
53
lib/js-api/docs/licences/license-info-7.0.0.md
Normal file
53
lib/js-api/docs/licences/license-info-7.0.0.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 7.0.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 7.0.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 7.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asap](https://github.com/kriskowal/asap) | 2.0.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/debug-js/debug) | 4.3.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [dezalgo](https://github.com/npm/dezalgo) | 1.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [hexoid](https://github.com/lukeed/hexoid) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [once](https://github.com/isaacs/once) | 1.4.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.5.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/ladjs/superagent) | 8.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.6.2 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [wrappy](https://github.com/npm/wrappy) | 1.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
90
lib/js-api/docs/licences/license-info-7.1.0.md
Normal file
90
lib/js-api/docs/licences/license-info-7.1.0.md
Normal file
@@ -0,0 +1,90 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 7.1.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 7.1.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 7.1.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [@tootallnate/once](https://github.com/TooTallNate/once) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [abab](https://github.com/jsdom/abab) | 2.0.6 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [agent-base](https://github.com/TooTallNate/node-agent-base) | 6.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [asap](https://github.com/kriskowal/asap) | 2.0.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cssstyle](https://github.com/jsdom/cssstyle) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [data-urls](https://github.com/jsdom/data-urls) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [debug](https://github.com/debug-js/debug) | 4.3.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [decimal.js](https://github.com/MikeMcl/decimal.js) | 10.4.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [dezalgo](https://github.com/npm/dezalgo) | 1.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [domexception](https://github.com/jsdom/domexception) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [entities](https://github.com/fb55/entities) | 4.5.0 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-proto](https://github.com/inspect-js/has-proto) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [hexoid](https://github.com/lukeed/hexoid) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [html-encoding-sniffer](https://github.com/jsdom/html-encoding-sniffer) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) | 5.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent) | 5.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [iconv-lite](https://github.com/ashtuchkin/iconv-lite) | 0.6.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [is-potential-custom-element-name](https://github.com/mathiasbynens/is-potential-custom-element-name) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [jsdom](https://github.com/jsdom/jsdom) | 22.1.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [nwsapi](https://github.com/dperini/nwsapi) | 2.2.7 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [once](https://github.com/isaacs/once) | 1.4.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [parse5](https://github.com/inikulin/parse5) | 7.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [psl](https://github.com/lupomontero/psl) | 1.9.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [punycode](https://github.com/mathiasbynens/punycode.js) | 2.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [querystringify](https://github.com/unshiftio/querystringify) | 2.2.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [requires-port](https://github.com/unshiftio/requires-port) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [rrweb-cssom](https://github.com/rrweb-io/CSSOM) | 0.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [safer-buffer](https://github.com/ChALkeR/safer-buffer) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [saxes](https://github.com/lddubeau/saxes) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.5.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/ladjs/superagent) | 8.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [symbol-tree](https://github.com/jsdom/js-symbol-tree) | 3.2.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tough-cookie](https://github.com/salesforce/tough-cookie) | 4.1.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [tr46](https://github.com/jsdom/tr46) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.6.2 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [universalify](https://github.com/RyanZim/universalify) | 0.2.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [url-parse](https://github.com/unshiftio/url-parse) | 1.5.10 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [w3c-xmlserializer](https://github.com/jsdom/w3c-xmlserializer) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [webidl-conversions](https://github.com/jsdom/webidl-conversions) | 7.0.0 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) |
|
||||
| [whatwg-encoding](https://github.com/jsdom/whatwg-encoding) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [whatwg-mimetype](https://github.com/jsdom/whatwg-mimetype) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [whatwg-url](https://github.com/jsdom/whatwg-url) | 12.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [wrappy](https://github.com/npm/wrappy) | 1.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [ws](https://github.com/websockets/ws) | 8.14.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [xml-name-validator](https://github.com/jsdom/xml-name-validator) | 4.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [xmlchars](https://github.com/lddubeau/xmlchars) | 2.2.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
54
lib/js-api/docs/licences/license-info-7.2.0.md
Normal file
54
lib/js-api/docs/licences/license-info-7.2.0.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
Title: License info, @alfresco/js-api 7.2.0
|
||||
---
|
||||
|
||||
# License information for @alfresco/js-api 7.2.0
|
||||
|
||||
This page lists all third party libraries the project depends on.
|
||||
|
||||
## Libraries
|
||||
|
||||
| Name | Version | License |
|
||||
| --- | --- | --- |
|
||||
| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 7.2.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
|
||||
| [asap](https://github.com/kriskowal/asap) | 2.0.6 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [call-bind](https://github.com/ljharb/call-bind) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [debug](https://github.com/debug-js/debug) | 4.3.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [dezalgo](https://github.com/npm/dezalgo) | 1.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.51 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [form-data](https://github.com/form-data/form-data) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [formidable](https://github.com/node-formidable/formidable) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [function-bind](https://github.com/Raynos/function-bind) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [get-intrinsic](https://github.com/ljharb/get-intrinsic) | 1.2.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-proto](https://github.com/inspect-js/has-proto) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has-symbols](https://github.com/inspect-js/has-symbols) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [has](https://github.com/tarruda/has) | 1.0.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [hexoid](https://github.com/lukeed/hexoid) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-db](https://github.com/jshttp/mime-db) | 1.40.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime-types](https://github.com/jshttp/mime-types) | 2.1.24 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [mime](https://github.com/broofa/mime) | 2.6.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [object-inspect](https://github.com/inspect-js/object-inspect) | 1.12.3 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [once](https://github.com/isaacs/once) | 1.4.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [qs](https://github.com/ljharb/qs) | 6.11.0 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) |
|
||||
| [semver](https://github.com/npm/node-semver) | 7.5.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [side-channel](https://github.com/ljharb/side-channel) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [superagent](https://github.com/ladjs/superagent) | 8.1.2 | [MIT](http://www.opensource.org/licenses/MIT) |
|
||||
| [tslib](https://github.com/Microsoft/tslib) | 2.6.2 | [0BSD](http://landley.net/toybox/license.html) |
|
||||
| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [wrappy](https://github.com/npm/wrappy) | 1.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) |
|
||||
|
||||
177
lib/js-api/src/LICENSE.txt
Normal file
177
lib/js-api/src/LICENSE.txt
Normal file
@@ -0,0 +1,177 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
52
lib/js-api/src/README.md
Normal file
52
lib/js-api/src/README.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Alfresco JavaScript API
|
||||
|
||||
JavaScript client API for the Alfresco REST API and Activiti REST API.
|
||||
|
||||
## API clients documentation
|
||||
|
||||
- [Authentication Api](src/api/auth-rest-api/README.md)
|
||||
- [Content Api](src/api/content-rest-api/README.md)
|
||||
- [Model Api](src/api/model-rest-api/README.md)
|
||||
- [Process Api (AAE)](src/api/activiti-rest-api/README.md)
|
||||
- [Search Api](src/api/search-rest-api/README.md)
|
||||
- [Governance Classification Api](src/api/gs-classification-rest-api/README.md)
|
||||
- [Governance Core Api](src/api/gs-core-rest-api/README.md)
|
||||
- [Discovery Content API](src/api/discovery-rest-api/README.md)
|
||||
|
||||
## Guides
|
||||
|
||||
- [Authentication](docs/authentication.md)
|
||||
- [Calling Custom Endpoints](docs/calling-custom-endpoints.md)
|
||||
- [Error Events](docs/error-events.md)
|
||||
- [ECM Examples](docs/ecm-example.md), full docs: [Content API](src/api/content-rest-api/README.md)
|
||||
- [BPM Examples](docs/bpm-example.md), full docs: [APS 2.X API](src/api/activiti-rest-api/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
The minimal supported versions are:
|
||||
|
||||
- Alfresco Platform Repository: version [5.2.a-EA](https://wiki.alfresco.com/wiki/Community_file_list_201606-EA) or newer
|
||||
- Activiti: 1.5
|
||||
- Node.js ([Long Term Support](https://nodejs.org/en/) version)
|
||||
|
||||
## Installing
|
||||
|
||||
Using NPM:
|
||||
|
||||
```sh
|
||||
npm install @alfresco/js-api
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
To run the build
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
|
||||
To run the test
|
||||
|
||||
```sh
|
||||
npm run test
|
||||
```
|
||||
576
lib/js-api/src/alfrescoApi.ts
Normal file
576
lib/js-api/src/alfrescoApi.ts
Normal file
@@ -0,0 +1,576 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import ee, { EmitterMethod, Emitter } from 'event-emitter';
|
||||
import { ContentAuth } from './authentication/contentAuth';
|
||||
import { ProcessAuth } from './authentication/processAuth';
|
||||
import { Oauth2Auth } from './authentication/oauth2Auth';
|
||||
import { ContentClient } from './contentClient';
|
||||
import { ProcessClient } from './processClient';
|
||||
import { Storage } from './storage';
|
||||
import { AlfrescoApiConfig } from './alfrescoApiConfig';
|
||||
import { Authentication } from './authentication/authentication';
|
||||
import { AlfrescoApiType } from './to-deprecate/alfresco-api-type';
|
||||
import { HttpClient } from './api-clients/http-client.interface';
|
||||
|
||||
export class AlfrescoApi implements Emitter, AlfrescoApiType {
|
||||
__type = 'legacy-client';
|
||||
storage: Storage;
|
||||
config: AlfrescoApiConfig;
|
||||
contentClient: ContentClient;
|
||||
contentPrivateClient: ContentClient;
|
||||
processClient: ProcessClient;
|
||||
searchClient: ContentClient;
|
||||
discoveryClient: ContentClient;
|
||||
gsClient: ContentClient;
|
||||
authClient: ContentClient;
|
||||
oauth2Auth: Oauth2Auth;
|
||||
processAuth: ProcessAuth;
|
||||
contentAuth: ContentAuth;
|
||||
|
||||
on: EmitterMethod;
|
||||
off: EmitterMethod;
|
||||
once: EmitterMethod;
|
||||
|
||||
bufferEvents: string[] = [];
|
||||
|
||||
emit: (type: string, ...args: any[]) => void;
|
||||
|
||||
username: string;
|
||||
|
||||
constructor(config?: AlfrescoApiConfig, public httpClient?: HttpClient) {
|
||||
ee(this);
|
||||
|
||||
if (config) {
|
||||
this.setConfig(config);
|
||||
}
|
||||
}
|
||||
|
||||
setConfig(config: AlfrescoApiConfig) {
|
||||
if (!config) {
|
||||
config = {};
|
||||
}
|
||||
|
||||
this.storage = Storage.getInstance();
|
||||
this.storage.setDomainPrefix(config.domainPrefix);
|
||||
|
||||
this.config = new AlfrescoApiConfig(config);
|
||||
|
||||
this.clientsFactory();
|
||||
|
||||
this.errorListeners();
|
||||
if (this.config.oauthInit) {
|
||||
this.initAuth(config);
|
||||
|
||||
if (this.isLoggedIn()) {
|
||||
this.emitBuffer('logged-in');
|
||||
}
|
||||
}
|
||||
|
||||
return config;
|
||||
}
|
||||
|
||||
private initAuth(config: AlfrescoApiConfig): void {
|
||||
if (this.isOauthConfiguration()) {
|
||||
if (!this.oauth2Auth) {
|
||||
this.oauth2Auth = new Oauth2Auth(this.config, this, this.httpClient);
|
||||
} else {
|
||||
this.oauth2Auth.setConfig(this.config, this);
|
||||
}
|
||||
|
||||
this.oauth2Auth?.on('logged-in', () => {
|
||||
this.emitBuffer('logged-in');
|
||||
});
|
||||
|
||||
this.setAuthenticationClientECMBPM(this.oauth2Auth.getAuthentication(), this.oauth2Auth.getAuthentication());
|
||||
} else {
|
||||
if (!this.processAuth) {
|
||||
this.processAuth = new ProcessAuth(this.config, this.httpClient);
|
||||
} else {
|
||||
this.processAuth.setConfig(this.config);
|
||||
}
|
||||
|
||||
this.processAuth?.on('logged-in', () => {
|
||||
this.emitBuffer('logged-in');
|
||||
});
|
||||
|
||||
if (!this.contentAuth) {
|
||||
this.contentAuth = new ContentAuth(this.config, this, this.httpClient);
|
||||
} else {
|
||||
this.contentAuth.setConfig(config);
|
||||
}
|
||||
|
||||
this.contentAuth?.on('logged-in', () => {
|
||||
this.emitBuffer('logged-in');
|
||||
});
|
||||
|
||||
this.setAuthenticationClientECMBPM(this.contentAuth.getAuthentication(), this.processAuth.getAuthentication());
|
||||
}
|
||||
}
|
||||
|
||||
private clientsFactory() {
|
||||
if (!this.contentPrivateClient) {
|
||||
this.contentPrivateClient = new ContentClient(this.config, `/api/${this.config.tenant}/private/alfresco/versions/1`, this.httpClient);
|
||||
} else {
|
||||
this.contentPrivateClient.setConfig(this.config, `/api/${this.config.tenant}/private/alfresco/versions/1`);
|
||||
}
|
||||
|
||||
if (!this.contentClient) {
|
||||
this.contentClient = new ContentClient(this.config, `/api/${this.config.tenant}/public/alfresco/versions/1`, this.httpClient);
|
||||
} else {
|
||||
this.contentClient.setConfig(this.config, `/api/${this.config.tenant}/public/alfresco/versions/1`);
|
||||
}
|
||||
|
||||
if (!this.authClient) {
|
||||
this.authClient = new ContentClient(this.config, `/api/${this.config.tenant}/public/authentication/versions/1`, this.httpClient);
|
||||
} else {
|
||||
this.authClient.setConfig(this.config, `/api/${this.config.tenant}/public/authentication/versions/1`);
|
||||
}
|
||||
|
||||
if (!this.searchClient) {
|
||||
this.searchClient = new ContentClient(this.config, `/api/${this.config.tenant}/public/search/versions/1`, this.httpClient);
|
||||
} else {
|
||||
this.searchClient.setConfig(this.config, `/api/${this.config.tenant}/public/search/versions/1`);
|
||||
}
|
||||
|
||||
if (!this.discoveryClient) {
|
||||
this.discoveryClient = new ContentClient(this.config, `/api`, this.httpClient);
|
||||
} else {
|
||||
this.discoveryClient.setConfig(this.config, `/api`);
|
||||
}
|
||||
|
||||
if (!this.gsClient) {
|
||||
this.gsClient = new ContentClient(this.config, `/api/${this.config.tenant}/public/gs/versions/1`, this.httpClient);
|
||||
} else {
|
||||
this.gsClient.setConfig(this.config, `/api/${this.config.tenant}/public/gs/versions/1`);
|
||||
}
|
||||
|
||||
if (!this.processClient) {
|
||||
this.processClient = new ProcessClient(this.config, this.httpClient);
|
||||
} else {
|
||||
this.processClient.setConfig(this.config);
|
||||
}
|
||||
}
|
||||
|
||||
/**@private? */
|
||||
errorListeners() {
|
||||
this.contentClient.off('error', () => {});
|
||||
this.authClient.off('error', () => {});
|
||||
this.contentPrivateClient.off('error', () => {});
|
||||
this.processClient.off('error', () => {});
|
||||
this.searchClient.off('error', () => {});
|
||||
this.discoveryClient.off('error', () => {});
|
||||
this.gsClient.off('error', () => {});
|
||||
|
||||
this.contentClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
|
||||
this.authClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
|
||||
this.contentPrivateClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
|
||||
this.processClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
|
||||
this.searchClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
|
||||
this.discoveryClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
|
||||
this.gsClient.on('error', (error: any) => {
|
||||
this.errorHandler(error);
|
||||
});
|
||||
}
|
||||
|
||||
/**@private? */
|
||||
errorHandler(error: { status?: number }) {
|
||||
if (error.status === 401) {
|
||||
this.invalidateSession();
|
||||
}
|
||||
|
||||
this.emitBuffer('error', error);
|
||||
}
|
||||
|
||||
changeWithCredentialsConfig(withCredentials: boolean) {
|
||||
this.config.withCredentials = withCredentials;
|
||||
}
|
||||
|
||||
changeCsrfConfig(disableCsrf: boolean) {
|
||||
this.config.disableCsrf = disableCsrf;
|
||||
this.processAuth.changeCsrfConfig(disableCsrf);
|
||||
}
|
||||
|
||||
changeEcmHost(hostEcm: string) {
|
||||
this.config.hostEcm = hostEcm;
|
||||
this.contentAuth.changeHost();
|
||||
this.contentClient.changeHost();
|
||||
this.authClient.changeHost();
|
||||
}
|
||||
|
||||
changeBpmHost(hostBpm: string) {
|
||||
this.config.hostBpm = hostBpm;
|
||||
this.processAuth.changeHost();
|
||||
this.processClient.changeHost();
|
||||
}
|
||||
|
||||
/**
|
||||
* login Alfresco API
|
||||
*
|
||||
* @param username Username to login
|
||||
* @param password Password to login
|
||||
* @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected.
|
||||
*/
|
||||
login(username: string, password: string): Promise<any> {
|
||||
if (!this.isCredentialValid(username) || !this.isCredentialValid(password)) {
|
||||
return Promise.reject(new Error('missing username or password'));
|
||||
}
|
||||
|
||||
if (username) {
|
||||
username = username.trim();
|
||||
}
|
||||
|
||||
this.username = username;
|
||||
|
||||
if (this.isOauthConfiguration()) {
|
||||
const promise = this.oauth2Auth.login(username, password);
|
||||
promise.then((accessToken) => {
|
||||
this.config.accessToken = accessToken;
|
||||
});
|
||||
return promise;
|
||||
} else {
|
||||
if (this.isBpmConfiguration()) {
|
||||
const promise = this.processAuth.login(username, password);
|
||||
promise.then((ticketBpm) => {
|
||||
this.config.ticketBpm = ticketBpm;
|
||||
});
|
||||
return promise;
|
||||
} else if (this.isEcmConfiguration()) {
|
||||
const promise = this.contentAuth.login(username, password);
|
||||
promise.then((ticketEcm) => {
|
||||
this.setAuthenticationClientECMBPM(this.contentAuth.getAuthentication(), null);
|
||||
this.config.ticketEcm = ticketEcm;
|
||||
});
|
||||
return promise;
|
||||
} else if (this.isEcmBpmConfiguration()) {
|
||||
const contentProcessPromise = this.loginBPMECM(username, password);
|
||||
|
||||
contentProcessPromise.then((data) => {
|
||||
this.config.ticketEcm = data[0];
|
||||
this.config.ticketBpm = data[1];
|
||||
});
|
||||
|
||||
return contentProcessPromise;
|
||||
} else {
|
||||
return Promise.reject(new Error('Unknown configuration'));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
isCredentialValid(credential: string): boolean {
|
||||
return credential !== undefined && credential !== null && credential !== '';
|
||||
}
|
||||
|
||||
implicitLogin(): Promise<any> {
|
||||
if (!this.isOauthConfiguration()) {
|
||||
return Promise.reject(new Error('Missing the required oauth2 configuration'));
|
||||
}
|
||||
|
||||
return new Promise(() => {
|
||||
this.oauth2Auth.implicitLogin();
|
||||
});
|
||||
}
|
||||
|
||||
setAuthenticationClientECMBPM(authECM: Authentication, authBPM: Authentication) {
|
||||
this.contentClient.setAuthentications(authECM);
|
||||
this.authClient.setAuthentications(authECM);
|
||||
this.searchClient.setAuthentications(authECM);
|
||||
this.contentPrivateClient.setAuthentications(authECM);
|
||||
this.processClient.setAuthentications(authBPM);
|
||||
this.searchClient.setAuthentications(authECM);
|
||||
this.discoveryClient.setAuthentications(authECM);
|
||||
this.gsClient.setAuthentications(authECM);
|
||||
}
|
||||
|
||||
/**
|
||||
* login Tickets
|
||||
*
|
||||
* @param ticketEcm alfresco ticket
|
||||
* @param ticketBpm alfresco ticket
|
||||
*/
|
||||
loginTicket(ticketEcm: string, ticketBpm: string): Promise<string> {
|
||||
this.config.ticketEcm = ticketEcm;
|
||||
this.config.ticketBpm = ticketBpm;
|
||||
|
||||
return this.contentAuth.validateTicket();
|
||||
}
|
||||
|
||||
private loginBPMECM(username: string, password: string): Promise<[string, string]> {
|
||||
const contentPromise = this.contentAuth.login(username, password);
|
||||
const processPromise = this.processAuth.login(username, password);
|
||||
|
||||
const promise: any = new Promise<[string, string]>((resolve, reject) => {
|
||||
Promise.all([contentPromise, processPromise]).then(
|
||||
(data) => {
|
||||
promise.emit('success');
|
||||
resolve(data);
|
||||
},
|
||||
(error) => {
|
||||
this.contentAuth.invalidateSession();
|
||||
this.processAuth.invalidateSession();
|
||||
|
||||
if (error.status === 401) {
|
||||
promise.emit('unauthorized');
|
||||
}
|
||||
promise.emit('error');
|
||||
reject(error);
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
ee(promise); // jshint ignore:line
|
||||
return promise;
|
||||
}
|
||||
|
||||
/**
|
||||
* logout Alfresco API
|
||||
*/
|
||||
logout(): Promise<void> {
|
||||
this.username = null;
|
||||
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.oauth2Auth.logOut();
|
||||
}
|
||||
|
||||
if (this.isBpmConfiguration()) {
|
||||
return this.processAuth.logout();
|
||||
}
|
||||
|
||||
if (this.isEcmConfiguration()) {
|
||||
const contentPromise = this.contentAuth.logout();
|
||||
contentPromise.then(
|
||||
() => (this.config.ticket = undefined),
|
||||
() => {}
|
||||
);
|
||||
return contentPromise;
|
||||
}
|
||||
|
||||
if (this.isEcmBpmConfiguration()) {
|
||||
return this._logoutBPMECM();
|
||||
}
|
||||
|
||||
return Promise.resolve();
|
||||
}
|
||||
|
||||
private _logoutBPMECM(): Promise<void> {
|
||||
const contentPromise = this.contentAuth.logout();
|
||||
const processPromise = this.processAuth.logout();
|
||||
|
||||
const promise: any = new Promise<void>((resolve, reject) => {
|
||||
Promise.all([contentPromise, processPromise]).then(
|
||||
() => {
|
||||
this.config.ticket = undefined;
|
||||
promise.emit('logout');
|
||||
resolve();
|
||||
},
|
||||
(error) => {
|
||||
if (error.status === 401) {
|
||||
promise.emit('unauthorized');
|
||||
}
|
||||
promise.emit('error');
|
||||
reject(error);
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
ee(promise); // jshint ignore:line
|
||||
return promise;
|
||||
}
|
||||
|
||||
/**
|
||||
* If the client is logged in return true
|
||||
*/
|
||||
isLoggedIn(): boolean {
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.oauth2Auth.isLoggedIn();
|
||||
}
|
||||
|
||||
if (this.isBpmConfiguration()) {
|
||||
return this.processAuth.isLoggedIn();
|
||||
}
|
||||
|
||||
if (this.isEcmConfiguration()) {
|
||||
return this.config.withCredentials ? true : this.contentAuth.isLoggedIn();
|
||||
}
|
||||
|
||||
if (this.isEcmBpmConfiguration()) {
|
||||
return this.config.withCredentials ? true : this.contentAuth.isLoggedIn() && this.processAuth.isLoggedIn();
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
isBpmLoggedIn(): boolean {
|
||||
if (this.isBpmConfiguration() || this.isEcmBpmConfiguration()) {
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.oauth2Auth.isLoggedIn();
|
||||
} else {
|
||||
return this.processAuth.isLoggedIn();
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
isEcmLoggedIn(): boolean {
|
||||
if (this.isEcmConfiguration() || this.isEcmBpmConfiguration()) {
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.oauth2Auth.isLoggedIn();
|
||||
} else {
|
||||
return this.config.withCredentials ? true : this.contentAuth.isLoggedIn();
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
getBpmUsername(): string {
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.username || this.oauth2Auth.storage.getItem('USERNAME');
|
||||
} else {
|
||||
return this.username || this.processAuth.storage.getItem('APS_USERNAME');
|
||||
}
|
||||
}
|
||||
|
||||
getEcmUsername(): string {
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.username || this.oauth2Auth.storage.getItem('USERNAME');
|
||||
} else {
|
||||
return this.username || this.contentAuth.storage.getItem('ACS_USERNAME');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* refresh token
|
||||
*/
|
||||
refreshToken(): Promise<any> {
|
||||
if (!this.isOauthConfiguration()) {
|
||||
return Promise.reject(new Error('Missing the required oauth2 configuration'));
|
||||
}
|
||||
|
||||
if (this.config.oauth2.implicitFlow) {
|
||||
return Promise.reject(new Error('Manual refresh token not possible in implicit flow'));
|
||||
}
|
||||
|
||||
return this.oauth2Auth.refreshToken();
|
||||
}
|
||||
|
||||
getTicketAuth(): string {
|
||||
return this.oauth2Auth?.getToken();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the current Ticket
|
||||
*
|
||||
* @param ticketEcm ecm ticket
|
||||
* @param ticketBpm bpm ticket
|
||||
*/
|
||||
setTicket(ticketEcm: string, ticketBpm: string) {
|
||||
if (this.contentAuth) {
|
||||
this.contentAuth.setTicket(ticketEcm);
|
||||
}
|
||||
if (this.processAuth) {
|
||||
this.processAuth.setTicket(ticketBpm);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* invalidate the current session
|
||||
*/
|
||||
invalidateSession() {
|
||||
if (this.oauth2Auth) {
|
||||
this.oauth2Auth.invalidateSession();
|
||||
} else {
|
||||
this.contentAuth.invalidateSession();
|
||||
this.processAuth.invalidateSession();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current Ticket for the Bpm
|
||||
*/
|
||||
getTicketBpm(): string {
|
||||
return this.processAuth?.getTicket();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current Ticket for the Ecm
|
||||
*/
|
||||
getTicketEcm(): string {
|
||||
return this.contentAuth?.getTicket();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current Ticket for the Ecm and BPM
|
||||
*/
|
||||
getTicket(): [string, string] {
|
||||
return [this.contentAuth.getTicket(), this.processAuth.getTicket()];
|
||||
}
|
||||
|
||||
isBpmConfiguration(): boolean {
|
||||
return this.config.provider && this.config.provider.toUpperCase() === 'BPM';
|
||||
}
|
||||
|
||||
isEcmConfiguration(): boolean {
|
||||
return this.config.provider && this.config.provider.toUpperCase() === 'ECM';
|
||||
}
|
||||
|
||||
isOauthConfiguration(): boolean {
|
||||
return this.config.authType === 'OAUTH';
|
||||
}
|
||||
|
||||
isPublicUrl(): boolean {
|
||||
if (this.isOauthConfiguration()) {
|
||||
return this.oauth2Auth.isPublicUrl();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
isEcmBpmConfiguration(): boolean {
|
||||
return this.config.provider && this.config.provider.toUpperCase() === 'ALL';
|
||||
}
|
||||
|
||||
private emitBuffer(event: string, callback?: any): void {
|
||||
this.emit(event, callback);
|
||||
this.bufferEvents.push(event);
|
||||
}
|
||||
|
||||
reply(event: string, callback?: any): void {
|
||||
if (this.bufferEvents.indexOf(event) >= 0) {
|
||||
// eslint-disable-next-line prefer-rest-params
|
||||
Function.prototype.apply.call(callback, this, arguments);
|
||||
} else {
|
||||
this.on(event, callback);
|
||||
}
|
||||
}
|
||||
}
|
||||
396
lib/js-api/src/alfrescoApiClient.ts
Normal file
396
lib/js-api/src/alfrescoApiClient.ts
Normal file
@@ -0,0 +1,396 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import ee from 'event-emitter';
|
||||
import { AlfrescoApiConfig } from './alfrescoApiConfig';
|
||||
import { Authentication } from './authentication/authentication';
|
||||
import { SuperagentHttpClient } from './superagentHttpClient';
|
||||
import { Emitters, HttpClient, LegacyHttpClient, RequestOptions, SecurityOptions } from './api-clients/http-client.interface';
|
||||
import { paramToString } from './utils';
|
||||
import { Storage } from './storage';
|
||||
|
||||
declare const Buffer: any;
|
||||
|
||||
export type AlfrescoApiClientPromise<T = any> = Promise<T> & {
|
||||
on: ee.EmitterMethod;
|
||||
off: ee.EmitterMethod;
|
||||
once: ee.EmitterMethod;
|
||||
emit: (type: string, ...args: any[]) => void;
|
||||
abort?: () => void;
|
||||
};
|
||||
|
||||
/**
|
||||
* Builds a string representation of an array-type actual parameter, according to the given collection format.
|
||||
*
|
||||
* @param param An array parameter.
|
||||
* @param collectionFormat The array element separator strategy.
|
||||
* @returns A string representation of the supplied collection, using the specified delimiter. Returns
|
||||
* <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
|
||||
*/
|
||||
export function buildCollectionParam(param: string[], collectionFormat: string): string | any[] {
|
||||
if (!param) {
|
||||
return null;
|
||||
}
|
||||
|
||||
switch (collectionFormat) {
|
||||
case 'csv':
|
||||
return param.map(paramToString).join(',');
|
||||
case 'ssv':
|
||||
return param.map(paramToString).join(' ');
|
||||
case 'tsv':
|
||||
return param.map(paramToString).join('\t');
|
||||
case 'pipes':
|
||||
return param.map(paramToString).join('|');
|
||||
case 'multi':
|
||||
// return the array directly as SuperAgent will handle it as expected
|
||||
return param.map(paramToString);
|
||||
default:
|
||||
throw new Error('Unknown collection format: ' + collectionFormat);
|
||||
}
|
||||
}
|
||||
|
||||
export class AlfrescoApiClient implements ee.Emitter, LegacyHttpClient {
|
||||
on: ee.EmitterMethod;
|
||||
off: ee.EmitterMethod;
|
||||
once: ee.EmitterMethod;
|
||||
emit: (type: string, ...args: any[]) => void;
|
||||
|
||||
storage: Storage;
|
||||
host: string;
|
||||
className: string;
|
||||
config: AlfrescoApiConfig;
|
||||
url: string;
|
||||
/**
|
||||
* The base URL against which to resolve every API call's (relative) path.
|
||||
*/
|
||||
basePath = '';
|
||||
|
||||
/**
|
||||
* The authentication methods to be included for all API calls.
|
||||
*/
|
||||
authentications: Authentication = {
|
||||
basicAuth: {
|
||||
ticket: ''
|
||||
},
|
||||
type: 'basic'
|
||||
};
|
||||
/**
|
||||
* The default HTTP headers to be included for all API calls.
|
||||
*/
|
||||
defaultHeaders = {};
|
||||
|
||||
/**
|
||||
* The default HTTP timeout for all API calls.
|
||||
*/
|
||||
timeout: number | { deadline?: number; response?: number } = undefined;
|
||||
|
||||
contentTypes = {
|
||||
JSON: ['application/json']
|
||||
};
|
||||
|
||||
httpClient: HttpClient;
|
||||
|
||||
constructor(host?: string, httpClient?: HttpClient) {
|
||||
this.host = host;
|
||||
|
||||
this.storage = Storage.getInstance();
|
||||
|
||||
// fallback for backward compatibility
|
||||
this.httpClient = httpClient || new SuperagentHttpClient();
|
||||
|
||||
ee(this);
|
||||
}
|
||||
|
||||
request<T = any>(options: RequestOptions): Promise<T> {
|
||||
return this.buildRequestCall(this.basePath, options, this.httpClient.request.bind(this.httpClient));
|
||||
}
|
||||
|
||||
post<T = any>(options: RequestOptions): AlfrescoApiClientPromise<T> {
|
||||
const url = this.getCallApiUrl(options);
|
||||
return this.buildRequestCall(url, options, this.httpClient.post.bind(this.httpClient));
|
||||
}
|
||||
|
||||
put<T = any>(options: RequestOptions): AlfrescoApiClientPromise<T> {
|
||||
const url = this.getCallApiUrl(options);
|
||||
return this.buildRequestCall(url, options, this.httpClient.put.bind(this.httpClient));
|
||||
}
|
||||
|
||||
get<T = any>(options: RequestOptions): AlfrescoApiClientPromise<T> {
|
||||
const url = this.getCallApiUrl(options);
|
||||
return this.buildRequestCall(url, options, this.httpClient.get.bind(this.httpClient));
|
||||
}
|
||||
|
||||
delete<T = void>(options: RequestOptions): AlfrescoApiClientPromise<T> {
|
||||
const url = this.getCallApiUrl(options);
|
||||
return this.buildRequestCall<T>(url, options, this.httpClient.delete.bind(this.httpClient));
|
||||
}
|
||||
|
||||
callApi(
|
||||
path: string,
|
||||
httpMethod: string,
|
||||
pathParams?: any,
|
||||
queryParams?: any,
|
||||
headerParams?: any,
|
||||
formParams?: any,
|
||||
bodyParam?: any,
|
||||
contentTypes?: string[],
|
||||
accepts?: string[],
|
||||
returnType?: any,
|
||||
contextRoot?: string,
|
||||
responseType?: string,
|
||||
url?: string
|
||||
): AlfrescoApiClientPromise<any> {
|
||||
const callApiUrl = url ?? this.getCallApiUrl({ contextRoot, path, pathParams });
|
||||
|
||||
const options: RequestOptions = {
|
||||
path,
|
||||
httpMethod,
|
||||
pathParams,
|
||||
queryParams,
|
||||
headerParams,
|
||||
formParams,
|
||||
bodyParam,
|
||||
contentTypes,
|
||||
accepts,
|
||||
returnType,
|
||||
contextRoot,
|
||||
responseType,
|
||||
url
|
||||
};
|
||||
|
||||
return this.buildRequestCall(callApiUrl, options, this.httpClient.request.bind(this.httpClient));
|
||||
}
|
||||
|
||||
callCustomApi(
|
||||
path: string,
|
||||
httpMethod: string,
|
||||
pathParams?: any,
|
||||
queryParams?: any,
|
||||
headerParams?: any,
|
||||
formParams?: any,
|
||||
bodyParam?: any,
|
||||
contentTypes?: string[],
|
||||
accepts?: string[],
|
||||
returnType?: any,
|
||||
contextRoot?: string,
|
||||
responseType?: string
|
||||
): AlfrescoApiClientPromise<any> {
|
||||
const customApiUrl = AlfrescoApiClient.buildUrl(path, '', pathParams);
|
||||
const options: RequestOptions = {
|
||||
path,
|
||||
httpMethod,
|
||||
pathParams,
|
||||
queryParams,
|
||||
headerParams,
|
||||
formParams,
|
||||
bodyParam,
|
||||
contentTypes,
|
||||
accepts,
|
||||
returnType,
|
||||
contextRoot,
|
||||
responseType
|
||||
};
|
||||
|
||||
return this.buildRequestCall(customApiUrl, options, this.httpClient.request.bind(this.httpClient));
|
||||
}
|
||||
|
||||
isCsrfEnabled(): boolean {
|
||||
if (this.config) {
|
||||
return !this.config.disableCsrf;
|
||||
} else {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
isBpmRequest(): boolean {
|
||||
return this.className === 'ProcessAuth' || this.className === 'ProcessClient';
|
||||
}
|
||||
|
||||
basicAuth(username: string, password: string): string {
|
||||
const str = username + ':' + password;
|
||||
|
||||
let base64;
|
||||
|
||||
if (typeof Buffer === 'function') {
|
||||
base64 = Buffer.from(str, 'binary').toString('base64');
|
||||
} else {
|
||||
base64 = btoa(str);
|
||||
}
|
||||
|
||||
return 'Basic ' + base64;
|
||||
}
|
||||
|
||||
isWithCredentials(): boolean {
|
||||
return !!this.config?.withCredentials;
|
||||
}
|
||||
|
||||
getAlfTicket(ticket: string): string {
|
||||
const ticketParam = this.isWithCredentials() ? '&ticket=' : '&alf_ticket=';
|
||||
|
||||
if (ticket) {
|
||||
return ticketParam + ticket;
|
||||
} else if (this.config.ticketEcm) {
|
||||
return ticketParam + this.config.ticketEcm;
|
||||
} else if (this.storage.getItem('ticket-ECM')) {
|
||||
return ticketParam + this.storage.getItem('ticket-ECM');
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds full URL by appending the given path to the base URL and replacing path parameter place-holders
|
||||
* with parameter values
|
||||
*/
|
||||
private static buildUrl(basePath: string, path: string, pathParams: any): string {
|
||||
if (path && path !== '' && !path.match(/^\//)) {
|
||||
path = '/' + path;
|
||||
}
|
||||
const url = basePath + path;
|
||||
|
||||
return AlfrescoApiClient.addParamsToUrl(url, pathParams);
|
||||
}
|
||||
|
||||
private static addParamsToUrl(path: string, pathParams: any) {
|
||||
return path.replace(/\{([\w-]+)}/g, (fullMatch, key) => {
|
||||
let value;
|
||||
|
||||
if (Object.prototype.hasOwnProperty.call(pathParams, key)) {
|
||||
value = paramToString(pathParams[key]);
|
||||
} else {
|
||||
value = fullMatch;
|
||||
}
|
||||
|
||||
return encodeURIComponent(value);
|
||||
});
|
||||
}
|
||||
|
||||
private getCallApiUrl({ contextRoot, path, pathParams }: { contextRoot?: string; path: string; pathParams?: any }): string {
|
||||
const basePath = contextRoot ? `${this.host}/${contextRoot}` : this.basePath;
|
||||
|
||||
return AlfrescoApiClient.buildUrl(basePath, path, pathParams);
|
||||
}
|
||||
|
||||
private buildRequestCall<T = any>(
|
||||
url: string,
|
||||
options: RequestOptions,
|
||||
httpCall: (url: string, options: RequestOptions, security: SecurityOptions, emitters: Emitters) => Promise<T>
|
||||
): AlfrescoApiClientPromise<T> {
|
||||
const security = this.getSecurityOptions();
|
||||
const emitters = this.getEventEmitters();
|
||||
const httpRequestOptions = this.getRequestOptionsWithAcceptAndContentType(options);
|
||||
const promise = httpCall(url, httpRequestOptions, security, emitters);
|
||||
|
||||
return this.addPromiseListeners(promise, emitters.eventEmitter);
|
||||
}
|
||||
|
||||
private getSecurityOptions(): SecurityOptions {
|
||||
return {
|
||||
isBpmRequest: this.isBpmRequest(),
|
||||
enableCsrf: this.isCsrfEnabled(),
|
||||
withCredentials: this.isWithCredentials(),
|
||||
authentications: this.authentications,
|
||||
defaultHeaders: this.defaultHeaders
|
||||
};
|
||||
}
|
||||
|
||||
private getEventEmitters(): Emitters {
|
||||
const apiClientEmitter = {
|
||||
on: this.on.bind(this),
|
||||
off: this.off.bind(this),
|
||||
once: this.once.bind(this),
|
||||
emit: this.emit.bind(this)
|
||||
};
|
||||
|
||||
return {
|
||||
apiClientEmitter,
|
||||
eventEmitter: ee({})
|
||||
};
|
||||
}
|
||||
|
||||
private getRequestOptionsWithAcceptAndContentType(options: RequestOptions): RequestOptions {
|
||||
const contentType = AlfrescoApiClient.jsonPreferredMime(options.contentTypes);
|
||||
const accept = AlfrescoApiClient.jsonPreferredMime(options.accepts);
|
||||
|
||||
return {
|
||||
...options,
|
||||
contentType,
|
||||
accept
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
|
||||
*
|
||||
* @param contentTypes content types
|
||||
* @returns The chosen content type, preferring JSON.
|
||||
*/
|
||||
private static jsonPreferredMime(contentTypes: readonly string[]): string {
|
||||
if (!contentTypes?.length) {
|
||||
return 'application/json';
|
||||
}
|
||||
|
||||
for (const item of contentTypes) {
|
||||
if (AlfrescoApiClient.isJsonMime(item)) {
|
||||
return item;
|
||||
}
|
||||
}
|
||||
return contentTypes[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the given content type represents JSON.<br>
|
||||
*
|
||||
* JSON content type examples:<br>
|
||||
* <ul>
|
||||
* <li>application/json</li>
|
||||
* <li>application/json; charset=UTF8</li>
|
||||
* <li>APPLICATION/JSON</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param contentType The MIME content type to check.
|
||||
* @returns <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
|
||||
*/
|
||||
private static isJsonMime(contentType: string): boolean {
|
||||
return Boolean(contentType?.match(/^application\/json(;.*)?$/i));
|
||||
}
|
||||
|
||||
private addPromiseListeners<T = any>(promise: Promise<T>, eventEmitter: ee.Emitter): AlfrescoApiClientPromise<T> {
|
||||
return Object.assign(promise, {
|
||||
on() {
|
||||
// eslint-disable-next-line prefer-spread,prefer-rest-params
|
||||
eventEmitter.on.apply(eventEmitter, arguments);
|
||||
return this;
|
||||
},
|
||||
once() {
|
||||
// eslint-disable-next-line prefer-spread,prefer-rest-params
|
||||
eventEmitter.once.apply(eventEmitter, arguments);
|
||||
return this;
|
||||
},
|
||||
emit() {
|
||||
// eslint-disable-next-line prefer-spread,prefer-rest-params
|
||||
eventEmitter.emit.apply(eventEmitter, arguments);
|
||||
return this;
|
||||
},
|
||||
off() {
|
||||
// eslint-disable-next-line prefer-spread,prefer-rest-params
|
||||
eventEmitter.off.apply(eventEmitter, arguments);
|
||||
return this;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
54
lib/js-api/src/alfrescoApiConfig.ts
Normal file
54
lib/js-api/src/alfrescoApiConfig.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { Oauth2Config } from './authentication/oauth2Config';
|
||||
|
||||
export class AlfrescoApiConfig {
|
||||
ticket?: string;
|
||||
hostEcm?: string = 'http://127.0.0.1:8080';
|
||||
hostBpm?: string = 'http://127.0.0.1:9999';
|
||||
hostOauth2?: string;
|
||||
authType?: string = 'BASIC';
|
||||
oauth2?: Oauth2Config;
|
||||
contextRoot? = 'alfresco';
|
||||
tenant?: string = '-default-';
|
||||
contextRootBpm?: string = 'activiti-app';
|
||||
domainPrefix?: string = '';
|
||||
provider?: string = 'ECM';
|
||||
ticketEcm?: string;
|
||||
ticketBpm?: string;
|
||||
accessToken?: string;
|
||||
disableCsrf?: boolean = false;
|
||||
withCredentials?: boolean = false;
|
||||
oauthInit?: boolean = true;
|
||||
|
||||
constructor(input: any = { oauth2: {} }) {
|
||||
Object.assign(this, input);
|
||||
|
||||
this.hostEcm = input.hostEcm ? input.hostEcm : 'http://127.0.0.1:8080';
|
||||
this.hostBpm = input.hostBpm ? input.hostBpm : 'http://127.0.0.1:9999';
|
||||
this.authType = input.authType ? input.authType : 'BASIC';
|
||||
this.contextRoot = input.contextRoot ? input.contextRoot : 'alfresco';
|
||||
this.contextRootBpm = input.contextRootBpm ? input.contextRootBpm : 'activiti-app';
|
||||
this.tenant = input.tenant ? input.tenant : '-default-';
|
||||
this.provider = input.provider ? input.provider : 'ECM';
|
||||
this.disableCsrf = input.disableCsrf ? input.disableCsrf : false;
|
||||
this.domainPrefix = input.domainPrefix ? input.domainPrefix : '';
|
||||
this.withCredentials = input.withCredentials ? input.withCredentials : false;
|
||||
this.oauth2 = input.oauth2;
|
||||
}
|
||||
}
|
||||
59
lib/js-api/src/api-clients/api-client.ts
Normal file
59
lib/js-api/src/api-clients/api-client.ts
Normal file
@@ -0,0 +1,59 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { AlfrescoApiType } from '../to-deprecate/alfresco-api-type';
|
||||
import { LegacyHttpClient, RequestOptions } from './http-client.interface';
|
||||
|
||||
export abstract class ApiClient {
|
||||
protected alfrescoApi: AlfrescoApiType;
|
||||
protected httpClient: LegacyHttpClient;
|
||||
|
||||
get apiClient(): LegacyHttpClient {
|
||||
return this.httpClient;
|
||||
}
|
||||
|
||||
constructor(legacyApi?: AlfrescoApiType);
|
||||
constructor(httpClient: LegacyHttpClient);
|
||||
constructor(httpClient?: AlfrescoApiType & LegacyHttpClient) {
|
||||
if (httpClient?.__type === 'legacy-client') {
|
||||
// TODO: remove legacyApi?: AlfrescoApi option and clean up this code. BREAKING CHANGE!
|
||||
this.alfrescoApi = httpClient;
|
||||
} else {
|
||||
this.httpClient = httpClient;
|
||||
}
|
||||
}
|
||||
|
||||
post<T = any>(options: RequestOptions): Promise<T> {
|
||||
return this.apiClient.post<T>(options);
|
||||
}
|
||||
|
||||
put<T = any>(options: RequestOptions): Promise<T> {
|
||||
return this.apiClient.put<T>(options);
|
||||
}
|
||||
|
||||
get<T = any>(options: RequestOptions): Promise<T> {
|
||||
return this.apiClient.get<T>(options);
|
||||
}
|
||||
|
||||
delete<T = void>(options: RequestOptions): Promise<T> {
|
||||
return this.apiClient.delete(options);
|
||||
}
|
||||
|
||||
errorMessage(param: string, methodName: string) {
|
||||
return `Missing param ${param} in ${methodName}`;
|
||||
}
|
||||
}
|
||||
106
lib/js-api/src/api-clients/http-client.interface.ts
Normal file
106
lib/js-api/src/api-clients/http-client.interface.ts
Normal file
@@ -0,0 +1,106 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { Authentication } from '../authentication/authentication';
|
||||
import { Emitter } from 'event-emitter';
|
||||
|
||||
export interface RequestOptions {
|
||||
path: string;
|
||||
httpMethod?: string;
|
||||
pathParams?: any;
|
||||
queryParams?: any;
|
||||
headerParams?: any;
|
||||
formParams?: any;
|
||||
bodyParam?: any;
|
||||
contentTypes?: string[];
|
||||
accepts?: string[];
|
||||
returnType?: any;
|
||||
contextRoot?: string;
|
||||
responseType?: string;
|
||||
url?: string;
|
||||
readonly accept?: string;
|
||||
readonly contentType?: string;
|
||||
}
|
||||
|
||||
export interface HttpClientConfig {
|
||||
contextRoot?: string;
|
||||
host?: string; // Should be mandatory but can't make it because of AlfrescoApiConfig incompatibility 😕
|
||||
servicePath?: string; // Should be mandatory but can't make it because of AlfrescoApiConfig incompatibility 😕
|
||||
}
|
||||
|
||||
export interface LegacyHttpClient {
|
||||
basePath: string;
|
||||
config: HttpClientConfig;
|
||||
|
||||
request<T = any>(options: RequestOptions): Promise<T>;
|
||||
post<T = any>(options: RequestOptions): Promise<T>;
|
||||
put<T = any>(options: RequestOptions): Promise<T>;
|
||||
get<T = any>(options: RequestOptions): Promise<T>;
|
||||
delete<T = void>(options: RequestOptions): Promise<T>;
|
||||
/** @deprecated */
|
||||
callApi(
|
||||
path: string,
|
||||
httpMethod: string,
|
||||
pathParams?: any,
|
||||
queryParams?: any,
|
||||
headerParams?: any,
|
||||
formParams?: any,
|
||||
bodyParam?: any,
|
||||
contentTypes?: string[],
|
||||
accepts?: string[],
|
||||
returnType?: any,
|
||||
contextRoot?: string,
|
||||
responseType?: string,
|
||||
url?: string
|
||||
): Promise<any>;
|
||||
/** @deprecated */
|
||||
callCustomApi(
|
||||
path: string,
|
||||
httpMethod: string,
|
||||
pathParams?: any,
|
||||
queryParams?: any,
|
||||
headerParams?: any,
|
||||
formParams?: any,
|
||||
bodyParam?: any,
|
||||
contentTypes?: string[],
|
||||
accepts?: string[],
|
||||
returnType?: any,
|
||||
contextRoot?: string,
|
||||
responseType?: string
|
||||
): Promise<any>;
|
||||
}
|
||||
|
||||
export interface SecurityOptions {
|
||||
readonly isBpmRequest: boolean;
|
||||
readonly enableCsrf?: boolean;
|
||||
readonly withCredentials?: boolean;
|
||||
readonly authentications: Authentication;
|
||||
readonly defaultHeaders: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface Emitters {
|
||||
readonly eventEmitter: Emitter;
|
||||
readonly apiClientEmitter: Emitter;
|
||||
}
|
||||
|
||||
export interface HttpClient {
|
||||
request<T = any>(url: string, options: RequestOptions, security: SecurityOptions, emitters: Emitters): Promise<T>;
|
||||
post<T = any>(url: string, options: RequestOptions, security: SecurityOptions, emitters: Emitters): Promise<T>;
|
||||
put<T = any>(url: string, options: RequestOptions, security: SecurityOptions, emitters: Emitters): Promise<T>;
|
||||
get<T = any>(url: string, options: RequestOptions, security: SecurityOptions, emitters: Emitters): Promise<T>;
|
||||
delete<T = void>(url: string, options: RequestOptions, security: SecurityOptions, emitters: Emitters): Promise<T>;
|
||||
}
|
||||
55
lib/js-api/src/api/activiti-rest-api/README.md
Normal file
55
lib/js-api/src/api/activiti-rest-api/README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# **Process API**
|
||||
|
||||
Provides access to the complete features provided by Alfresco Process Services powered by Activiti.
|
||||
|
||||
You can use this API to integrate Alfresco Process Services with external applications.
|
||||
|
||||
## Endpoint Clients
|
||||
|
||||
All URIs are relative to:
|
||||
|
||||
```text
|
||||
/activiti-app/api
|
||||
```
|
||||
|
||||
- [AboutApi](docs/AboutApi.md)
|
||||
- [AccountIntegrationApi](docs/AccountIntegrationApi.md)
|
||||
- [AdminEndpointsApi](docs/AdminEndpointsApi.md)
|
||||
- [AdminGroupsApi](docs/AdminGroupsApi.md)
|
||||
- [AdminTenantsApi](docs/AdminTenantsApi.md)
|
||||
- [AdminUsersApi](docs/AdminUsersApi.md)
|
||||
- [AppDefinitionsApi](docs/AppDefinitionsApi.md)
|
||||
- [ChecklistsApi](docs/ChecklistsApi.md)
|
||||
- [CommentsApi](docs/CommentsApi.md)
|
||||
- [ContentApi](docs/ContentApi.md)
|
||||
- [DataSourcesApi](docs/DataSourcesApi.md)
|
||||
- [DecisionAuditsApi](docs/DecisionAuditsApi.md)
|
||||
- [EndpointsApi](docs/EndpointsApi.md)
|
||||
- [FormModelsApi](docs/FormModelsApi.md)
|
||||
- [GroupsApi](docs/GroupsApi.md)
|
||||
- [IDMSyncApi](docs/IDMSyncApi.md)
|
||||
- [IntegrationAlfrescoOnPremiseApi](docs/IntegrationAlfrescoOnPremiseApi.md)
|
||||
- [IntegrationBoxApi](docs/IntegrationBoxApi.md)
|
||||
- [IntegrationDriveApi](docs/IntegrationDriveApi.md)
|
||||
- [ModelsApi](docs/ModelsApi.md)
|
||||
- [ModelsBpmnApi](docs/ModelsBpmnApi.md)
|
||||
- [ModelsHistoryApi](docs/ModelsHistoryApi.md)
|
||||
- [ProcessDefinitionsApi](docs/ProcessDefinitionsApi.md)
|
||||
- [ProcessInstancesApi](docs/ProcessInstancesApi.md)
|
||||
- [ProcessInstanceVariablesApi](docs/ProcessInstanceVariablesApi.md)
|
||||
- [ProcessScopesApi](docs/ProcessScopesApi.md)
|
||||
- [RuntimeAppDefinitionsApi](docs/RuntimeAppDefinitionsApi.md)
|
||||
- [RuntimeAppDeploymentsApi](docs/RuntimeAppDeploymentsApi.md)
|
||||
- [ScriptFilesApi](docs/ScriptFilesApi.md)
|
||||
- [SubmittedFormsApi](docs/SubmittedFormsApi.md)
|
||||
- [SystemPropertiesApi](docs/SystemPropertiesApi.md)
|
||||
- [TaskActionsApi](docs/TaskActionsApi.md)
|
||||
- [TaskFormsApi](docs/TaskFormsApi.md)
|
||||
- [TasksApi](docs/TasksApi.md)
|
||||
- [TaskVariablesApi](docs/TaskVariablesApi.md)
|
||||
- [UserFiltersApi](docs/UserFiltersApi.md)
|
||||
- [UserProfileApi](docs/UserProfileApi.md)
|
||||
- [UsersApi](docs/UsersApi.md)
|
||||
- [ReportApi](docs/ReportApi.md)
|
||||
- [ModelJsonBpmnApi](docs/ModelJsonBpmnApi.md)
|
||||
- [TemporaryApi](docs/TemporaryApi.md)
|
||||
35
lib/js-api/src/api/activiti-rest-api/api/about.api.ts
Normal file
35
lib/js-api/src/api/activiti-rest-api/api/about.api.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { BaseApi } from './base.api';
|
||||
|
||||
/**
|
||||
* About service.
|
||||
*/
|
||||
export class AboutApi extends BaseApi {
|
||||
/**
|
||||
* Get server type and version
|
||||
* Provides information about the running Alfresco Process Services Suite. The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition.
|
||||
*
|
||||
* @return Promise<{ [key: string]: string; }>
|
||||
*/
|
||||
getAppVersion(): Promise<{ [key: string]: string }> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/app-version'
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ResultListDataRepresentationAccountRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
|
||||
/**
|
||||
* AccountIntegrationApi service.
|
||||
*/
|
||||
export class AccountIntegrationApi extends BaseApi {
|
||||
/**
|
||||
* Retrieve external account information
|
||||
* Accounts are used to integrate with third party apps and clients
|
||||
*
|
||||
* @return Promise<ResultListDataRepresentationAccountRepresentation>
|
||||
*/
|
||||
getAccounts(): Promise<ResultListDataRepresentationAccountRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/account/integration'
|
||||
});
|
||||
}
|
||||
}
|
||||
251
lib/js-api/src/api/activiti-rest-api/api/adminEndpoints.api.ts
Normal file
251
lib/js-api/src/api/activiti-rest-api/api/adminEndpoints.api.ts
Normal file
@@ -0,0 +1,251 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { CreateEndpointBasicAuthRepresentation, EndpointBasicAuthRepresentation, EndpointConfigurationRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* AdminEndpointsApi service.
|
||||
*/
|
||||
export class AdminEndpointsApi extends BaseApi {
|
||||
/**
|
||||
* Add an endpoint authorization
|
||||
*
|
||||
* @param createRepresentation createRepresentation
|
||||
* @return Promise<EndpointBasicAuthRepresentation>
|
||||
*/
|
||||
createBasicAuthConfiguration(createRepresentation: CreateEndpointBasicAuthRepresentation): Promise<EndpointBasicAuthRepresentation> {
|
||||
throwIfNotDefined(createRepresentation, 'createRepresentation');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/basic-auths',
|
||||
bodyParam: createRepresentation,
|
||||
returnType: EndpointBasicAuthRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an endpoint
|
||||
*
|
||||
* @param representation representation
|
||||
* @return Promise<EndpointConfigurationRepresentation>
|
||||
*/
|
||||
createEndpointConfiguration(representation: EndpointConfigurationRepresentation): Promise<EndpointConfigurationRepresentation> {
|
||||
throwIfNotDefined(representation, 'representation');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/endpoints',
|
||||
bodyParam: representation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an endpoint authorization
|
||||
*
|
||||
* @param basicAuthId basicAuthId
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<EndpointBasicAuthRepresentation>
|
||||
*/
|
||||
getBasicAuthConfiguration(basicAuthId: number, tenantId: number): Promise<EndpointBasicAuthRepresentation> {
|
||||
throwIfNotDefined(basicAuthId, 'basicAuthId');
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
basicAuthId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/basic-auths/{basicAuthId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: EndpointBasicAuthRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List endpoint authorizations
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<EndpointBasicAuthRepresentation>
|
||||
*/
|
||||
getBasicAuthConfigurations(tenantId: number): Promise<EndpointBasicAuthRepresentation> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const queryParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/basic-auths',
|
||||
queryParams,
|
||||
returnType: EndpointBasicAuthRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an endpoint
|
||||
*
|
||||
* @param endpointConfigurationId endpointConfigurationId
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<EndpointConfigurationRepresentation>
|
||||
*/
|
||||
getEndpointConfiguration(endpointConfigurationId: number, tenantId: number): Promise<EndpointConfigurationRepresentation> {
|
||||
throwIfNotDefined(endpointConfigurationId, 'endpointConfigurationId');
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
endpointConfigurationId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/endpoints/{endpointConfigurationId}',
|
||||
pathParams,
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List endpoints
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<EndpointConfigurationRepresentation>
|
||||
*/
|
||||
getEndpointConfigurations(tenantId: number): Promise<EndpointConfigurationRepresentation> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const queryParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/endpoints',
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an endpoint authorization
|
||||
*
|
||||
* @param basicAuthId basicAuthId
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
removeBasicAuthConfiguration(basicAuthId: number, tenantId: number): Promise<void> {
|
||||
throwIfNotDefined(basicAuthId, 'basicAuthId');
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
basicAuthId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/basic-auths/{basicAuthId}',
|
||||
pathParams,
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an endpoint
|
||||
*
|
||||
* @param endpointConfigurationId endpointConfigurationId
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
removeEndpointConfiguration(endpointConfigurationId: number, tenantId: number): Promise<void> {
|
||||
throwIfNotDefined(endpointConfigurationId, 'endpointConfigurationId');
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
endpointConfigurationId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/endpoints/{endpointConfigurationId}',
|
||||
pathParams,
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update an endpoint authorization
|
||||
*
|
||||
* @param basicAuthId basicAuthId
|
||||
* @param createRepresentation createRepresentation
|
||||
* @return Promise<EndpointBasicAuthRepresentation>
|
||||
*/
|
||||
updateBasicAuthConfiguration(
|
||||
basicAuthId: number,
|
||||
createRepresentation: CreateEndpointBasicAuthRepresentation
|
||||
): Promise<EndpointBasicAuthRepresentation> {
|
||||
throwIfNotDefined(basicAuthId, 'basicAuthId');
|
||||
throwIfNotDefined(createRepresentation, 'createRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
basicAuthId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/admin/basic-auths/{basicAuthId}',
|
||||
pathParams,
|
||||
bodyParam: createRepresentation,
|
||||
returnType: EndpointBasicAuthRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update an endpoint
|
||||
*
|
||||
* @param endpointConfigurationId endpointConfigurationId
|
||||
* @param representation representation
|
||||
* @return Promise<EndpointConfigurationRepresentation>
|
||||
*/
|
||||
updateEndpointConfiguration(
|
||||
endpointConfigurationId: number,
|
||||
representation: EndpointConfigurationRepresentation
|
||||
): Promise<EndpointConfigurationRepresentation> {
|
||||
throwIfNotDefined(endpointConfigurationId, 'endpointConfigurationId');
|
||||
throwIfNotDefined(representation, 'representation');
|
||||
|
||||
const pathParams = {
|
||||
endpointConfigurationId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/admin/endpoints/{endpointConfigurationId}',
|
||||
pathParams,
|
||||
bodyParam: representation
|
||||
});
|
||||
}
|
||||
}
|
||||
362
lib/js-api/src/api/activiti-rest-api/api/adminGroups.api.ts
Normal file
362
lib/js-api/src/api/activiti-rest-api/api/adminGroups.api.ts
Normal file
@@ -0,0 +1,362 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
AbstractGroupRepresentation,
|
||||
AddGroupCapabilitiesRepresentation,
|
||||
GroupRepresentation,
|
||||
LightGroupRepresentation,
|
||||
ResultListDataRepresentationLightUserRepresentation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* AdminGroupsApi service.
|
||||
*/
|
||||
export class AdminGroupsApi extends BaseApi {
|
||||
/**
|
||||
* Activate a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
activate(groupId: number): Promise<any> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/action/activate',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add users to a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
addAllUsersToGroup(groupId: number): Promise<any> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/add-all-users',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add capabilities to a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param addGroupCapabilitiesRepresentation addGroupCapabilitiesRepresentation
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
addGroupCapabilities(groupId: number, addGroupCapabilitiesRepresentation: AddGroupCapabilitiesRepresentation): Promise<any> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(addGroupCapabilitiesRepresentation, 'addGroupCapabilitiesRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/capabilities',
|
||||
pathParams,
|
||||
bodyParam: addGroupCapabilitiesRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a user to a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param userId userId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
addGroupMember(groupId: number, userId: number): Promise<any> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
|
||||
const pathParams = {
|
||||
groupId,
|
||||
userId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/members/{userId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a related group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param relatedGroupId relatedGroupId
|
||||
* @param type type
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
addRelatedGroup(groupId: number, relatedGroupId: number, type: string): Promise<any> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(relatedGroupId, 'relatedGroupId');
|
||||
throwIfNotDefined(type, 'type');
|
||||
|
||||
const pathParams = {
|
||||
groupId,
|
||||
relatedGroupId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
type
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId}',
|
||||
pathParams,
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a group
|
||||
*
|
||||
* @param groupRepresentation groupRepresentation
|
||||
* @return Promise<GroupRepresentation>
|
||||
*/
|
||||
createNewGroup(groupRepresentation: GroupRepresentation): Promise<GroupRepresentation> {
|
||||
throwIfNotDefined(groupRepresentation, 'groupRepresentation');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/groups',
|
||||
bodyParam: groupRepresentation,
|
||||
returnType: GroupRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a capability from a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param groupCapabilityId groupCapabilityId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteGroupCapability(groupId: number, groupCapabilityId: number): Promise<void> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(groupCapabilityId, 'groupCapabilityId');
|
||||
|
||||
const pathParams = {
|
||||
groupId,
|
||||
groupCapabilityId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/capabilities/{groupCapabilityId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a member from a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param userId userId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteGroupMember(groupId: number, userId: number): Promise<void> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
|
||||
const pathParams = {
|
||||
groupId,
|
||||
userId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/members/{userId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteGroup(groupId: number): Promise<void> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/groups/{groupId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a related group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param relatedGroupId relatedGroupId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteRelatedGroup(groupId: number, relatedGroupId: number): Promise<void> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(relatedGroupId, 'relatedGroupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId,
|
||||
relatedGroupId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List group capabilities
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @return Promise<string>
|
||||
*/
|
||||
getCapabilities(groupId: number): Promise<string> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/potential-capabilities',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get group members
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationLightUserRepresentation>
|
||||
*/
|
||||
getGroupUsers(
|
||||
groupId: number,
|
||||
opts?: { filter?: string; page?: number; pageSize?: number }
|
||||
): Promise<ResultListDataRepresentationLightUserRepresentation> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/users',
|
||||
pathParams,
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<AbstractGroupRepresentation>
|
||||
*/
|
||||
getGroup(groupId: number, opts?: { includeAllUsers?: boolean; summary?: boolean }): Promise<AbstractGroupRepresentation> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/groups/{groupId}',
|
||||
pathParams,
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query groups
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<LightGroupRepresentation>
|
||||
*/
|
||||
getGroups(opts?: { tenantId?: number; functional?: boolean; summary?: boolean }): Promise<LightGroupRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/groups',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get related groups
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @return Promise<LightGroupRepresentation>
|
||||
*/
|
||||
getRelatedGroups(groupId: number): Promise<LightGroupRepresentation> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/groups/{groupId}/related-groups',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @param groupRepresentation groupRepresentation
|
||||
* @return Promise<GroupRepresentation>
|
||||
*/
|
||||
updateGroup(groupId: number, groupRepresentation: GroupRepresentation): Promise<GroupRepresentation> {
|
||||
throwIfNotDefined(groupId, 'groupId');
|
||||
throwIfNotDefined(groupRepresentation, 'groupRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/admin/groups/{groupId}',
|
||||
pathParams,
|
||||
bodyParam: groupRepresentation,
|
||||
returnType: GroupRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
182
lib/js-api/src/api/activiti-rest-api/api/adminTenants.api.ts
Normal file
182
lib/js-api/src/api/activiti-rest-api/api/adminTenants.api.ts
Normal file
@@ -0,0 +1,182 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { CreateTenantRepresentation, ImageUploadRepresentation, LightTenantRepresentation, TenantEvent, TenantRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* AdminTenantsApi service.
|
||||
*/
|
||||
export class AdminTenantsApi extends BaseApi {
|
||||
/**
|
||||
* Create a tenant
|
||||
* Only a tenant manager may access this endpoint
|
||||
*
|
||||
* @param createTenantRepresentation createTenantRepresentation
|
||||
* @return Promise<LightTenantRepresentation>
|
||||
*/
|
||||
createTenant(createTenantRepresentation: CreateTenantRepresentation): Promise<LightTenantRepresentation> {
|
||||
throwIfNotDefined(createTenantRepresentation, 'groupId');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/tenants',
|
||||
bodyParam: createTenantRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a tenant
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteTenant(tenantId: number): Promise<void> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/admin/tenants/{tenantId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get tenant events
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<TenantEvent>
|
||||
*/
|
||||
getTenantEvents(tenantId: number): Promise<TenantEvent> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/tenants/{tenantId}/events',
|
||||
pathParams,
|
||||
returnType: TenantEvent
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a tenant's logo
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
getTenantLogo(tenantId: number): Promise<any> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/tenants/{tenantId}/logo',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a tenant
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @return Promise<TenantRepresentation>
|
||||
*/
|
||||
getTenant(tenantId: number): Promise<TenantRepresentation> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
|
||||
const pathParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/tenants/{tenantId}',
|
||||
pathParams,
|
||||
returnType: TenantRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List tenants
|
||||
* Only a tenant manager may access this endpoint
|
||||
*
|
||||
* @return Promise<LightTenantRepresentation>
|
||||
*/
|
||||
getTenants(): Promise<LightTenantRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/tenants'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a tenant
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @param createTenantRepresentation createTenantRepresentation
|
||||
* @return Promise<TenantRepresentation>
|
||||
*/
|
||||
update(tenantId: number, createTenantRepresentation: CreateTenantRepresentation): Promise<TenantRepresentation> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
throwIfNotDefined(createTenantRepresentation, 'createTenantRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/admin/tenants/{tenantId}',
|
||||
pathParams,
|
||||
bodyParam: createTenantRepresentation,
|
||||
returnType: TenantRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a tenant's logo
|
||||
*
|
||||
* @param tenantId tenantId
|
||||
* @param file file
|
||||
* @return Promise<ImageUploadRepresentation>
|
||||
*/
|
||||
uploadTenantLogo(tenantId: number, file: any): Promise<ImageUploadRepresentation> {
|
||||
throwIfNotDefined(tenantId, 'tenantId');
|
||||
throwIfNotDefined(file, 'file');
|
||||
|
||||
const pathParams = {
|
||||
tenantId
|
||||
};
|
||||
|
||||
const formParams = {
|
||||
file
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/tenants/{tenantId}/logo',
|
||||
pathParams,
|
||||
formParams,
|
||||
contentTypes: ['multipart/form-data'],
|
||||
returnType: ImageUploadRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
131
lib/js-api/src/api/activiti-rest-api/api/adminUsers.api.ts
Normal file
131
lib/js-api/src/api/activiti-rest-api/api/adminUsers.api.ts
Normal file
@@ -0,0 +1,131 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
AbstractUserRepresentation,
|
||||
BulkUserUpdateRepresentation,
|
||||
ResultListDataRepresentationAbstractUserRepresentation,
|
||||
UserRepresentation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
export interface GetUsersOpts {
|
||||
filter?: string;
|
||||
status?: string;
|
||||
accountType?: string;
|
||||
sort?: string;
|
||||
company?: string;
|
||||
start?: number;
|
||||
page?: number;
|
||||
size?: number;
|
||||
groupId?: number;
|
||||
tenantId?: number;
|
||||
summary?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* AdminUsersApi service.
|
||||
*/
|
||||
export class AdminUsersApi extends BaseApi {
|
||||
/**
|
||||
* Bulk update a list of users
|
||||
*
|
||||
* @param update update
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
bulkUpdateUsers(update: BulkUserUpdateRepresentation): Promise<any> {
|
||||
throwIfNotDefined(update, 'update');
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/admin/users',
|
||||
bodyParam: update
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a user
|
||||
*
|
||||
* @param userRepresentation userRepresentation
|
||||
* @return Promise<UserRepresentation>
|
||||
*/
|
||||
createNewUser(userRepresentation: UserRepresentation): Promise<UserRepresentation> {
|
||||
throwIfNotDefined(userRepresentation, 'userRepresentation');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/admin/users',
|
||||
bodyParam: userRepresentation,
|
||||
returnType: UserRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a user
|
||||
*
|
||||
* @param userId userId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<AbstractUserRepresentation>
|
||||
*/
|
||||
getUser(userId: number, opts?: { summary?: boolean }): Promise<AbstractUserRepresentation> {
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
|
||||
const pathParams = {
|
||||
userId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/users/{userId}',
|
||||
pathParams,
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query users
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationAbstractUserRepresentation>
|
||||
*/
|
||||
getUsers(opts?: GetUsersOpts): Promise<ResultListDataRepresentationAbstractUserRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/admin/users',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a user
|
||||
*
|
||||
* @param userId userId
|
||||
* @param userRepresentation userRepresentation
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
updateUserDetails(userId: number, userRepresentation: UserRepresentation): Promise<any> {
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
throwIfNotDefined(userRepresentation, 'userRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
userId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/admin/users/{userId}',
|
||||
pathParams,
|
||||
bodyParam: userRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
207
lib/js-api/src/api/activiti-rest-api/api/appDefinitions.api.ts
Normal file
207
lib/js-api/src/api/activiti-rest-api/api/appDefinitions.api.ts
Normal file
@@ -0,0 +1,207 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
AppDefinitionPublishRepresentation,
|
||||
AppDefinitionRepresentation,
|
||||
AppDefinitionSaveRepresentation,
|
||||
AppDefinitionUpdateResultRepresentation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* AppDefinitionsApi service.
|
||||
*/
|
||||
export class AppDefinitionsApi extends BaseApi {
|
||||
/**
|
||||
* deleteAppDefinition
|
||||
*
|
||||
* @param appDefinitionId appDefinitionId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteAppDefinition(appDefinitionId: number): Promise<void> {
|
||||
throwIfNotDefined(appDefinitionId, 'appDefinitionId');
|
||||
|
||||
const pathParams = {
|
||||
appDefinitionId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/app-definitions/{appDefinitionId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Export an app definition
|
||||
*
|
||||
* This will return a zip file containing the app definition model and all related models (process definitions and forms).
|
||||
*
|
||||
* @param modelId modelId from a runtime app or the id of an app definition model
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
exportAppDefinition(modelId: number): Promise<any> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
const contentTypes = ['application/json'];
|
||||
const accepts = ['application/json', 'application/zip'];
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/app-definitions/{modelId}/export',
|
||||
pathParams,
|
||||
contentTypes,
|
||||
accepts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an app definition
|
||||
*
|
||||
* @param modelId Application definition ID
|
||||
* @return Promise<AppDefinitionRepresentation>
|
||||
*/
|
||||
getAppDefinition(modelId: number): Promise<AppDefinitionRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/app-definitions/{modelId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* importAndPublishApp
|
||||
*
|
||||
* @param file file
|
||||
* @param opts options
|
||||
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
||||
*/
|
||||
importAndPublishApp(file: any, opts?: { renewIdmEntries?: boolean }): Promise<AppDefinitionUpdateResultRepresentation> {
|
||||
throwIfNotDefined(file, 'file');
|
||||
|
||||
const formParams = {
|
||||
file
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
renewIdmEntries: opts?.renewIdmEntries
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/app-definitions/publish-app',
|
||||
formParams,
|
||||
queryParams,
|
||||
contentTypes: ['multipart/form-data']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Import a new app definition
|
||||
*
|
||||
* Allows a zip file to be uploaded containing an app definition and any number of included models.
|
||||
* <p>This is useful to bootstrap an environment (for users or continuous integration).<p>
|
||||
* Before using any processes included in the import the app must be published and deployed.
|
||||
*
|
||||
* @param file file
|
||||
* @param opts Optional parameters
|
||||
* @param opts.renewIdmEntries Whether to renew user and group identifiers (default to false)
|
||||
* @return Promise<AppDefinitionRepresentation>
|
||||
*/
|
||||
importAppDefinition(file: any, opts?: { renewIdmEntries?: string }): Promise<AppDefinitionRepresentation> {
|
||||
throwIfNotDefined(file, 'file');
|
||||
|
||||
const formParams = {
|
||||
file
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/app-definitions/import',
|
||||
queryParams: opts,
|
||||
formParams,
|
||||
contentTypes: ['multipart/form-data']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Publish an app definition
|
||||
*
|
||||
* Publishing an app definition makes it available for use. The application must not have any validation errors or an error will be returned.<p>Before an app definition can be used by other users, it must also be deployed for their use
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param publishModel publishModel
|
||||
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
||||
*/
|
||||
publishAppDefinition(modelId: number, publishModel: AppDefinitionPublishRepresentation): Promise<AppDefinitionUpdateResultRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(publishModel, 'publishModel');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/app-definitions/{modelId}/publish',
|
||||
pathParams,
|
||||
bodyParam: publishModel
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update an app definition
|
||||
*
|
||||
* @param modelId Application definition ID
|
||||
* @param updatedModel updatedModel |
|
||||
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
||||
*/
|
||||
updateAppDefinition(modelId: number, updatedModel: AppDefinitionSaveRepresentation | any): Promise<any> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(updatedModel, 'updatedModel');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
if (!updatedModel['appDefinition']) {
|
||||
const formParams = {
|
||||
file: updatedModel
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/app-definitions/{modelId}/import',
|
||||
pathParams,
|
||||
formParams,
|
||||
bodyParam: updatedModel,
|
||||
contentTypes: ['multipart/form-data']
|
||||
});
|
||||
} else {
|
||||
return this.put({
|
||||
path: '/api/enterprise/app-definitions/{modelId}',
|
||||
pathParams,
|
||||
bodyParam: updatedModel
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
25
lib/js-api/src/api/activiti-rest-api/api/base.api.ts
Normal file
25
lib/js-api/src/api/activiti-rest-api/api/base.api.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ApiClient } from '../../../api-clients/api-client';
|
||||
import { LegacyHttpClient } from '../../../api-clients/http-client.interface';
|
||||
|
||||
export abstract class BaseApi extends ApiClient {
|
||||
override get apiClient(): LegacyHttpClient {
|
||||
return this.httpClient ?? this.alfrescoApi.processClient;
|
||||
}
|
||||
}
|
||||
92
lib/js-api/src/api/activiti-rest-api/api/checklists.api.ts
Normal file
92
lib/js-api/src/api/activiti-rest-api/api/checklists.api.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ChecklistOrderRepresentation } from '../model/checklistOrderRepresentation';
|
||||
import { ResultListDataRepresentationTaskRepresentation } from '../model/resultListDataRepresentationTaskRepresentation';
|
||||
import { TaskRepresentation } from '../model/taskRepresentation';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* Checklists service.
|
||||
*/
|
||||
export class ChecklistsApi extends BaseApi {
|
||||
/**
|
||||
* Create a task checklist
|
||||
*
|
||||
* @param taskId taskId
|
||||
* @param taskRepresentation taskRepresentation
|
||||
* @return Promise<TaskRepresentation>
|
||||
*/
|
||||
addSubtask(taskId: string, taskRepresentation: TaskRepresentation): Promise<TaskRepresentation> {
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
throwIfNotDefined(taskRepresentation, 'taskRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/tasks/{taskId}/checklist',
|
||||
pathParams,
|
||||
bodyParam: taskRepresentation,
|
||||
returnType: TaskRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get checklist for a task
|
||||
*
|
||||
* @param taskId taskId
|
||||
* @return Promise<ResultListDataRepresentationTaskRepresentation>
|
||||
*/
|
||||
getChecklist(taskId: string): Promise<ResultListDataRepresentationTaskRepresentation> {
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/tasks/{taskId}/checklist',
|
||||
pathParams,
|
||||
returnType: ResultListDataRepresentationTaskRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Change the order of items on a checklist
|
||||
*
|
||||
* @param taskId taskId
|
||||
* @param orderRepresentation orderRepresentation
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
orderChecklist(taskId: string, orderRepresentation: ChecklistOrderRepresentation): Promise<any> {
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
throwIfNotDefined(orderRepresentation, 'orderRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/tasks/{taskId}/checklist',
|
||||
bodyParam: orderRepresentation,
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
}
|
||||
119
lib/js-api/src/api/activiti-rest-api/api/comments.api.ts
Normal file
119
lib/js-api/src/api/activiti-rest-api/api/comments.api.ts
Normal file
@@ -0,0 +1,119 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { CommentRepresentation } from '../model/commentRepresentation';
|
||||
import { ResultListDataRepresentationCommentRepresentation } from '../model/resultListDataRepresentationCommentRepresentation';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* Comments service.
|
||||
*/
|
||||
export class ActivitiCommentsApi extends BaseApi {
|
||||
/**
|
||||
* Add a comment to a process instance
|
||||
*
|
||||
* @param commentRequest commentRequest
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<CommentRepresentation>
|
||||
*/
|
||||
addProcessInstanceComment(commentRequest: CommentRepresentation, processInstanceId: string): Promise<CommentRepresentation> {
|
||||
throwIfNotDefined(commentRequest, 'commentRequest');
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/comments',
|
||||
pathParams,
|
||||
bodyParam: commentRequest,
|
||||
returnType: CommentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment to a task
|
||||
*
|
||||
* @param commentRequest commentRequest
|
||||
* @param taskId taskId
|
||||
* @return Promise<CommentRepresentation>
|
||||
*/
|
||||
addTaskComment(commentRequest: CommentRepresentation, taskId: string): Promise<CommentRepresentation> {
|
||||
throwIfNotDefined(commentRequest, 'commentRequest');
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/tasks/{taskId}/comments',
|
||||
pathParams,
|
||||
bodyParam: commentRequest,
|
||||
returnType: CommentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get comments for a process
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationCommentRepresentation>
|
||||
*/
|
||||
getProcessInstanceComments(
|
||||
processInstanceId: string,
|
||||
opts?: { latestFirst?: boolean }
|
||||
): Promise<ResultListDataRepresentationCommentRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/comments',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
returnType: ResultListDataRepresentationCommentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get comments for a task
|
||||
*
|
||||
* @param taskId taskId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationCommentRepresentation>
|
||||
*/
|
||||
getTaskComments(taskId: string, opts?: { latestFirst?: boolean }): Promise<ResultListDataRepresentationCommentRepresentation> {
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/tasks/{taskId}/comments',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
returnType: ResultListDataRepresentationCommentRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
321
lib/js-api/src/api/activiti-rest-api/api/content.api.ts
Normal file
321
lib/js-api/src/api/activiti-rest-api/api/content.api.ts
Normal file
@@ -0,0 +1,321 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
RelatedContentRepresentation,
|
||||
ResultListDataRepresentationRelatedContentRepresentation,
|
||||
ResultListDataRepresentationRelatedProcessTask
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* Content service.
|
||||
*/
|
||||
export class ContentApi extends BaseApi {
|
||||
/**
|
||||
* Attach existing content to a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param relatedContent relatedContent
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<RelatedContentRepresentation>
|
||||
*/
|
||||
createRelatedContentOnProcessInstance(
|
||||
processInstanceId: string,
|
||||
relatedContent: RelatedContentRepresentation | any,
|
||||
opts?: { isRelatedContent?: boolean }
|
||||
): Promise<RelatedContentRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(relatedContent, 'relatedContent');
|
||||
|
||||
opts = opts || {};
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
if (relatedContent instanceof RelatedContentRepresentation) {
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/content',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
bodyParam: relatedContent,
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
} else {
|
||||
const formParams = {
|
||||
file: relatedContent
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/raw-content',
|
||||
pathParams,
|
||||
formParams,
|
||||
queryParams: opts,
|
||||
contentTypes: ['multipart/form-data'],
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Attach existing content to a task
|
||||
*
|
||||
* @param taskId taskId
|
||||
* @param relatedContent relatedContent
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<RelatedContentRepresentation>
|
||||
*/
|
||||
createRelatedContentOnTask(
|
||||
taskId: string,
|
||||
relatedContent: RelatedContentRepresentation | any,
|
||||
opts?: { isRelatedContent?: boolean }
|
||||
): Promise<RelatedContentRepresentation> {
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
throwIfNotDefined(relatedContent, 'relatedContent');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
if (relatedContent instanceof RelatedContentRepresentation) {
|
||||
return this.post({
|
||||
path: '/api/enterprise/tasks/{taskId}/content',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
bodyParam: relatedContent,
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
} else {
|
||||
const formParams = {
|
||||
file: relatedContent
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/tasks/{taskId}/raw-content',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
formParams,
|
||||
contentTypes: ['multipart/form-data'],
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Upload content and create a local representation
|
||||
*
|
||||
* @param file file
|
||||
* @return Promise<RelatedContentRepresentation>
|
||||
*/
|
||||
createTemporaryRawRelatedContent(file: any): Promise<RelatedContentRepresentation> {
|
||||
throwIfNotDefined(file, 'file');
|
||||
|
||||
const formParams = {
|
||||
file
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/content/raw',
|
||||
formParams,
|
||||
contentTypes: ['multipart/form-data'],
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a local representation of content from a remote repository
|
||||
*
|
||||
* @param relatedContent relatedContent
|
||||
* @return Promise<RelatedContentRepresentation>
|
||||
*/
|
||||
createTemporaryRelatedContent(relatedContent: RelatedContentRepresentation): Promise<RelatedContentRepresentation> {
|
||||
throwIfNotDefined(relatedContent, 'relatedContent');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/content',
|
||||
bodyParam: relatedContent,
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a local content representation
|
||||
*
|
||||
* @param contentId contentId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteContent(contentId: number): Promise<void> {
|
||||
throwIfNotDefined(contentId, 'contentId');
|
||||
|
||||
const pathParams = {
|
||||
contentId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/content/{contentId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a local content representation
|
||||
*
|
||||
* @param contentId contentId
|
||||
* @return Promise<RelatedContentRepresentation>
|
||||
*/
|
||||
getContent(contentId: number): Promise<RelatedContentRepresentation> {
|
||||
throwIfNotDefined(contentId, 'contentId');
|
||||
|
||||
const pathParams = {
|
||||
contentId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/content/{contentId}',
|
||||
pathParams,
|
||||
returnType: RelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get content Raw URL for the given contentId
|
||||
*
|
||||
* @param contentId contentId
|
||||
*/
|
||||
getRawContentUrl(contentId: number): string {
|
||||
return `${this.apiClient.basePath}/api/enterprise/content/${contentId}/raw`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stream content rendition
|
||||
*
|
||||
* @param contentId contentId
|
||||
* @param renditionType renditionType
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
getRawContent(contentId: number, renditionType?: string): Promise<any> {
|
||||
throwIfNotDefined(contentId, 'contentId');
|
||||
|
||||
if (renditionType) {
|
||||
const pathParams = {
|
||||
contentId,
|
||||
renditionType
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/content/{contentId}/rendition/{renditionType}',
|
||||
pathParams,
|
||||
returnType: 'blob',
|
||||
responseType: 'blob'
|
||||
});
|
||||
} else {
|
||||
const pathParams = {
|
||||
contentId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/content/{contentId}/raw',
|
||||
pathParams,
|
||||
returnType: 'blob',
|
||||
responseType: 'blob'
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* List content attached to a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
|
||||
*/
|
||||
getRelatedContentForProcessInstance(
|
||||
processInstanceId: string,
|
||||
opts?: { isRelatedContent?: boolean }
|
||||
): Promise<ResultListDataRepresentationRelatedContentRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
opts = opts || {};
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/content',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
returnType: ResultListDataRepresentationRelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List content attached to a task
|
||||
*
|
||||
* @param taskId taskId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
|
||||
*/
|
||||
getRelatedContentForTask(
|
||||
taskId: string,
|
||||
opts?: { isRelatedContent?: boolean }
|
||||
): Promise<ResultListDataRepresentationRelatedContentRepresentation> {
|
||||
throwIfNotDefined(taskId, 'taskId');
|
||||
|
||||
const pathParams = {
|
||||
taskId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/tasks/{taskId}/content',
|
||||
pathParams,
|
||||
queryParams: opts,
|
||||
returnType: ResultListDataRepresentationRelatedContentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Lists processes and tasks on workflow started with provided document
|
||||
*
|
||||
* @param sourceId - id of the document that workflow or task has been started with
|
||||
* @param source - source of the document that workflow or task has been started with
|
||||
* @param size - size of the entries to get
|
||||
* @param page - page number
|
||||
* @return Promise<ResultListDataRepresentationRelatedProcessTask>
|
||||
*/
|
||||
getProcessesAndTasksOnContent(
|
||||
sourceId: string,
|
||||
source: string,
|
||||
size?: number,
|
||||
page?: number
|
||||
): Promise<ResultListDataRepresentationRelatedProcessTask> {
|
||||
throwIfNotDefined(sourceId, 'sourceId');
|
||||
throwIfNotDefined(source, 'source');
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/document-runtime',
|
||||
queryParams: {
|
||||
sourceId,
|
||||
source,
|
||||
size,
|
||||
page
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
37
lib/js-api/src/api/activiti-rest-api/api/dataSources.api.ts
Normal file
37
lib/js-api/src/api/activiti-rest-api/api/dataSources.api.ts
Normal file
@@ -0,0 +1,37 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ResultListDataRepresentationDataSourceRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
|
||||
/**
|
||||
* DataSourcesApi service.
|
||||
*/
|
||||
export class DataSourcesApi extends BaseApi {
|
||||
/**
|
||||
* Get data sources
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationDataSourceRepresentation>
|
||||
*/
|
||||
getDataSources(opts?: { tenantId?: number }): Promise<ResultListDataRepresentationDataSourceRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/data-sources',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { DecisionAuditRepresentation } from '../model/decisionAuditRepresentation';
|
||||
import { ResultListDataRepresentationDecisionAuditRepresentation } from '../model/resultListDataRepresentationDecisionAuditRepresentation';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* DecisionAuditsApi service.
|
||||
*/
|
||||
export class DecisionAuditsApi extends BaseApi {
|
||||
/**
|
||||
* Get an audit trail
|
||||
*
|
||||
* @param auditTrailId auditTrailId
|
||||
* @return Promise<DecisionAuditRepresentation>
|
||||
*/
|
||||
getAuditTrail(auditTrailId: number): Promise<DecisionAuditRepresentation> {
|
||||
throwIfNotDefined(auditTrailId, 'taskId');
|
||||
|
||||
const pathParams = {
|
||||
auditTrailId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/decisions/audits/{auditTrailId}',
|
||||
pathParams,
|
||||
returnType: DecisionAuditRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query decision table audit trails
|
||||
*
|
||||
* @param decisionKey decisionKey
|
||||
* @param dmnDeploymentId dmnDeploymentId
|
||||
* @return Promise<ResultListDataRepresentationDecisionAuditRepresentation>
|
||||
*/
|
||||
getAuditTrails(decisionKey: string, dmnDeploymentId: number): Promise<ResultListDataRepresentationDecisionAuditRepresentation> {
|
||||
throwIfNotDefined(decisionKey, 'decisionKey');
|
||||
throwIfNotDefined(dmnDeploymentId, 'dmnDeploymentId');
|
||||
|
||||
const queryParams = {
|
||||
decisionKey,
|
||||
dmnDeploymentId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/decisions/audits',
|
||||
queryParams,
|
||||
returnType: ResultListDataRepresentationDecisionAuditRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { JsonNode, ResultListDataRepresentationRuntimeDecisionTableRepresentation, RuntimeDecisionTableRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
export interface GetDecisionTablesOpts {
|
||||
nameLike?: string;
|
||||
keyLike?: string;
|
||||
tenantIdLike?: string;
|
||||
deploymentId?: number;
|
||||
sort?: string;
|
||||
order?: string;
|
||||
start?: number;
|
||||
size?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* DecisionTablesApi service.
|
||||
*/
|
||||
export class DecisionTablesApi extends BaseApi {
|
||||
/**
|
||||
* Get definition for a decision table
|
||||
*
|
||||
* @param decisionTableId decisionTableId
|
||||
* @return Promise<JsonNode>
|
||||
*/
|
||||
getDecisionTableEditorJson(decisionTableId: number): Promise<JsonNode> {
|
||||
throwIfNotDefined(decisionTableId, 'decisionTableId');
|
||||
|
||||
const pathParams = {
|
||||
decisionTableId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/decisions/decision-tables/{decisionTableId}/editorJson',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a decision table
|
||||
*
|
||||
* @param decisionTableId decisionTableId
|
||||
* @return Promise<RuntimeDecisionTableRepresentation>
|
||||
*/
|
||||
getDecisionTable(decisionTableId: number): Promise<RuntimeDecisionTableRepresentation> {
|
||||
throwIfNotDefined(decisionTableId, 'decisionTableId');
|
||||
|
||||
const pathParams = {
|
||||
decisionTableId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/decisions/decision-tables/{decisionTableId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query decision tables
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
|
||||
*/
|
||||
getDecisionTables(opts?: GetDecisionTablesOpts): Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/decisions/decision-tables',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
}
|
||||
55
lib/js-api/src/api/activiti-rest-api/api/endpoints.api.ts
Normal file
55
lib/js-api/src/api/activiti-rest-api/api/endpoints.api.ts
Normal file
@@ -0,0 +1,55 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { EndpointConfigurationRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* Endpoints service.
|
||||
*/
|
||||
export class EndpointsApi extends BaseApi {
|
||||
/**
|
||||
* Get an endpoint configuration
|
||||
*
|
||||
* @param endpointConfigurationId endpointConfigurationId
|
||||
* @return Promise<EndpointConfigurationRepresentation>
|
||||
*/
|
||||
getEndpointConfiguration(endpointConfigurationId: number): Promise<EndpointConfigurationRepresentation> {
|
||||
throwIfNotDefined(endpointConfigurationId, 'endpointConfigurationId');
|
||||
|
||||
const pathParams = {
|
||||
endpointConfigurationId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/endpoints/{endpointConfigurationId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List endpoint configurations
|
||||
*
|
||||
* @return Promise<EndpointConfigurationRepresentation>
|
||||
*/
|
||||
getEndpointConfigurations(): Promise<EndpointConfigurationRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/endpoints'
|
||||
});
|
||||
}
|
||||
}
|
||||
184
lib/js-api/src/api/activiti-rest-api/api/formModels.api.ts
Normal file
184
lib/js-api/src/api/activiti-rest-api/api/formModels.api.ts
Normal file
@@ -0,0 +1,184 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
FormDefinitionRepresentation,
|
||||
FormRepresentation,
|
||||
FormSaveRepresentation,
|
||||
ResultListDataRepresentationFormRepresentation,
|
||||
ResultListDataRepresentationRuntimeFormRepresentation,
|
||||
ValidationErrorRepresentation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
export interface GetFormsOpts {
|
||||
nameLike?: string;
|
||||
appId?: number;
|
||||
tenantId?: number;
|
||||
start?: number;
|
||||
sort?: string;
|
||||
order?: string;
|
||||
size?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* FormModelsApi service.
|
||||
*/
|
||||
export class FormModelsApi extends BaseApi {
|
||||
/**
|
||||
* Get form content
|
||||
*
|
||||
* @param formId formId
|
||||
* @return Promise<FormDefinitionRepresentation>
|
||||
*/
|
||||
getFormEditorJson(formId: number): Promise<FormDefinitionRepresentation> {
|
||||
throwIfNotDefined(formId, 'formId');
|
||||
|
||||
const pathParams = {
|
||||
formId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/forms/{formId}/editorJson',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get form history
|
||||
*
|
||||
* @param formId formId
|
||||
* @param formHistoryId formHistoryId
|
||||
* @return Promise<FormRepresentation>
|
||||
*/
|
||||
getFormHistory(formId: number, formHistoryId: number): Promise<FormRepresentation> {
|
||||
throwIfNotDefined(formId, 'formId');
|
||||
throwIfNotDefined(formHistoryId, 'formHistoryId');
|
||||
|
||||
const pathParams = {
|
||||
formId,
|
||||
formHistoryId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/form-models/{formId}/history/{formHistoryId}',
|
||||
pathParams,
|
||||
returnType: FormRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a form model
|
||||
*
|
||||
* @param formId {number} formId
|
||||
* @return Promise<FormRepresentation>
|
||||
*/
|
||||
getForm(formId: number): Promise<FormRepresentation> {
|
||||
throwIfNotDefined(formId, 'formId');
|
||||
|
||||
const pathParams = {
|
||||
formId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/form-models/{formId}',
|
||||
pathParams,
|
||||
returnType: FormRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get forms
|
||||
*
|
||||
* @param input input
|
||||
* @return Promise<FormRepresentation>
|
||||
*/
|
||||
getForms(
|
||||
input: string[] | GetFormsOpts
|
||||
): Promise<FormRepresentation | ResultListDataRepresentationRuntimeFormRepresentation | ResultListDataRepresentationFormRepresentation> {
|
||||
if (typeof input === 'string') {
|
||||
const queryParams = {
|
||||
formId: buildCollectionParam(input, 'multi')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/form-models/values',
|
||||
queryParams,
|
||||
returnType: FormRepresentation
|
||||
});
|
||||
} else if (typeof input === 'object') {
|
||||
return this.get({
|
||||
path: '/api/enterprise/forms',
|
||||
queryParams: input
|
||||
});
|
||||
} else {
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/form-models',
|
||||
returnType: ResultListDataRepresentationFormRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update form model content
|
||||
*
|
||||
* @param formId ID of the form to update
|
||||
* @param saveRepresentation saveRepresentation
|
||||
* @return Promise<FormRepresentation>
|
||||
*/
|
||||
saveForm(formId: number, saveRepresentation: FormSaveRepresentation): Promise<FormRepresentation> {
|
||||
throwIfNotDefined(formId, 'formId');
|
||||
throwIfNotDefined(saveRepresentation, 'saveRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
formId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/editor/form-models/{formId}',
|
||||
pathParams,
|
||||
bodyParam: saveRepresentation,
|
||||
returnType: FormRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate form model content
|
||||
*
|
||||
* The model content to be validated must be specified in the POST body
|
||||
*
|
||||
* @param formId formId
|
||||
* @param saveRepresentation saveRepresentation
|
||||
* @return Promise<ValidationErrorRepresentation>
|
||||
*/
|
||||
validateModel(formId: number, saveRepresentation: FormSaveRepresentation): Promise<ValidationErrorRepresentation> {
|
||||
throwIfNotDefined(formId, 'formId');
|
||||
throwIfNotDefined(saveRepresentation, 'saveRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
formId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/editor/form-models/{formId}/validate',
|
||||
pathParams,
|
||||
bodyParam: saveRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
65
lib/js-api/src/api/activiti-rest-api/api/groups.api.ts
Normal file
65
lib/js-api/src/api/activiti-rest-api/api/groups.api.ts
Normal file
@@ -0,0 +1,65 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ResultListDataRepresentationLightGroupRepresentation, ResultListDataRepresentationLightUserRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
export interface GetGroupsOpts {
|
||||
filter?: string;
|
||||
groupId?: number;
|
||||
externalId?: string;
|
||||
externalIdCaseInsensitive?: string;
|
||||
tenantId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Groups service.
|
||||
*/
|
||||
export class ActivitiGroupsApi extends BaseApi {
|
||||
/**
|
||||
* Query groups
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationLightGroupRepresentation>
|
||||
*/
|
||||
getGroups(opts?: GetGroupsOpts): Promise<ResultListDataRepresentationLightGroupRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/groups',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List members of a group
|
||||
*
|
||||
* @param groupId groupId
|
||||
* @return Promise<ResultListDataRepresentationLightUserRepresentation>
|
||||
*/
|
||||
getUsersForGroup(groupId: number): Promise<ResultListDataRepresentationLightUserRepresentation> {
|
||||
throwIfNotDefined(groupId, 'formId');
|
||||
|
||||
const pathParams = {
|
||||
groupId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/groups/{groupId}/users',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
}
|
||||
62
lib/js-api/src/api/activiti-rest-api/api/iDMSync.api.ts
Normal file
62
lib/js-api/src/api/activiti-rest-api/api/iDMSync.api.ts
Normal file
@@ -0,0 +1,62 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { SyncLogEntryRepresentation } from '../model/syncLogEntryRepresentation';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* IDMSyncApi service.
|
||||
*/
|
||||
export class IDMSyncApi extends BaseApi {
|
||||
/**
|
||||
* Get log file for a sync log entry
|
||||
*
|
||||
* @param syncLogEntryId syncLogEntryId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
getLogFile(syncLogEntryId: number): Promise<any> {
|
||||
throwIfNotDefined(syncLogEntryId, 'syncLogEntryId');
|
||||
|
||||
const pathParams = {
|
||||
syncLogEntryId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/idm-sync-log-entries/{syncLogEntryId}/logfile',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List sync log entries
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @param opts.tenantId {number} tenantId
|
||||
* @param opts.page {number} page
|
||||
* @param opts.start {number} start
|
||||
* @param opts.size {number} size
|
||||
* @return Promise<SyncLogEntryRepresentation>
|
||||
*/
|
||||
getSyncLogEntries(opts?: { tenantId?: number; page?: number; start?: number; size?: number }): Promise<SyncLogEntryRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/idm-sync-log-entries',
|
||||
queryParams: opts,
|
||||
returnType: SyncLogEntryRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
62
lib/js-api/src/api/activiti-rest-api/api/index.ts
Normal file
62
lib/js-api/src/api/activiti-rest-api/api/index.ts
Normal file
@@ -0,0 +1,62 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
export * from './about.api';
|
||||
export * from './accountIntegration.api';
|
||||
export * from './adminEndpoints.api';
|
||||
export * from './adminGroups.api';
|
||||
export * from './adminTenants.api';
|
||||
export * from './adminUsers.api';
|
||||
export * from './appDefinitions.api';
|
||||
export * from './checklists.api';
|
||||
export * from './comments.api';
|
||||
import { ContentApi as ActivitiContentApi } from './content.api';
|
||||
export { ActivitiContentApi };
|
||||
export * from './dataSources.api';
|
||||
export * from './decisionAudits.api';
|
||||
export * from './decisionTables.api';
|
||||
export * from './endpoints.api';
|
||||
export * from './formModels.api';
|
||||
export * from './groups.api';
|
||||
export * from './iDMSync.api';
|
||||
export * from './integrationAlfrescoCloud.api';
|
||||
export * from './integrationAlfrescoOnPremise.api';
|
||||
export * from './integrationBox.api';
|
||||
export * from './integrationDrive.api';
|
||||
export * from './models.api';
|
||||
export * from './modelsBpmn.api';
|
||||
export * from './modelsHistory.api';
|
||||
export * from './processDefinitions.api';
|
||||
export * from './processInstances.api';
|
||||
export * from './processInstanceVariables.api';
|
||||
export * from './processScopes.api';
|
||||
export * from './runtimeAppDefinitions.api';
|
||||
export * from './runtimeAppDeployments.api';
|
||||
export * from './scriptFiles.api';
|
||||
export * from './submittedForms.api';
|
||||
export * from './systemProperties.api';
|
||||
export * from './taskActions.api';
|
||||
export * from './taskForms.api';
|
||||
export * from './tasks.api';
|
||||
export * from './taskVariables.api';
|
||||
export * from './userFilters.api';
|
||||
export * from './userProfile.api';
|
||||
export * from './users.api';
|
||||
export * from './report.api';
|
||||
export * from './modelJsonBpmn.api';
|
||||
export * from './temporary.api';
|
||||
export * from './types';
|
||||
@@ -0,0 +1,151 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
ResultListDataRepresentationAlfrescoContentRepresentation,
|
||||
ResultListDataRepresentationAlfrescoNetworkRepresenation,
|
||||
ResultListDataRepresentationAlfrescoSiteRepresenation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* IntegrationAlfrescoCloudApi service.
|
||||
*/
|
||||
export class IntegrationAlfrescoCloudApi extends BaseApi {
|
||||
/**
|
||||
* Alfresco Cloud Authorization
|
||||
* Returns Alfresco OAuth HTML Page
|
||||
*
|
||||
* @param code code
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
confirmAuthorisation(code: string): Promise<any> {
|
||||
throwIfNotDefined(code, 'code');
|
||||
|
||||
const queryParams = {
|
||||
code
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco-cloud/confirm-auth-request',
|
||||
queryParams,
|
||||
accepts: ['text/html']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List Alfresco networks
|
||||
*
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation>
|
||||
*/
|
||||
getAllNetworks(): Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco-cloud/networks'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List Alfresco sites
|
||||
* Returns ALL Sites
|
||||
*
|
||||
* @param networkId networkId
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
|
||||
*/
|
||||
getAllSites(networkId: string): Promise<ResultListDataRepresentationAlfrescoSiteRepresenation> {
|
||||
throwIfNotDefined(networkId, 'networkId');
|
||||
|
||||
const pathParams = {
|
||||
networkId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco-cloud/networks/{networkId}/sites',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders inside a specific folder identified by path
|
||||
*
|
||||
* @param networkId networkId
|
||||
* @param opts Optional parameters
|
||||
* @param opts.siteId {string} siteId
|
||||
* @param opts.path {string} path
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||
*/
|
||||
getContentInFolderPath(
|
||||
networkId: string,
|
||||
opts?: { siteId?: string; path?: string }
|
||||
): Promise<ResultListDataRepresentationAlfrescoContentRepresentation> {
|
||||
throwIfNotDefined(networkId, 'networkId');
|
||||
|
||||
const pathParams = {
|
||||
networkId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/folderpath/{folderPath}/content',
|
||||
pathParams,
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders inside a specific folder
|
||||
*
|
||||
* @param networkId networkId
|
||||
* @param folderId folderId
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||
*/
|
||||
getContentInFolder(networkId: string, folderId: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation> {
|
||||
throwIfNotDefined(networkId, 'networkId');
|
||||
throwIfNotDefined(folderId, 'folderId');
|
||||
|
||||
const pathParams = {
|
||||
networkId,
|
||||
folderId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco-cloud/networks/{networkId}/folders/{folderId}/content',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders inside a specific site
|
||||
*
|
||||
* @param networkId networkId
|
||||
* @param siteId siteId
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||
*/
|
||||
getContentInSite(networkId: string, siteId: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation> {
|
||||
throwIfNotDefined(networkId, 'networkId');
|
||||
throwIfNotDefined(siteId, 'siteId');
|
||||
|
||||
const pathParams = {
|
||||
networkId,
|
||||
siteId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/content',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
ResultListDataRepresentationAlfrescoContentRepresentation,
|
||||
ResultListDataRepresentationAlfrescoEndpointRepresentation,
|
||||
ResultListDataRepresentationAlfrescoSiteRepresenation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* IntegrationAlfrescoOnPremiseApi service.
|
||||
*/
|
||||
export class IntegrationAlfrescoOnPremiseApi extends BaseApi {
|
||||
/**
|
||||
* List Alfresco sites
|
||||
* Returns ALL Sites
|
||||
*
|
||||
* @param repositoryId repositoryId
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
|
||||
*/
|
||||
getAllSites(repositoryId: string): Promise<ResultListDataRepresentationAlfrescoSiteRepresenation> {
|
||||
throwIfNotDefined(repositoryId, 'networkId');
|
||||
|
||||
const pathParams = {
|
||||
repositoryId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco/{repositoryId}/sites',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders inside a specific folder identified by folder path
|
||||
*
|
||||
* @param repositoryId repositoryId
|
||||
* @param siteId siteId
|
||||
* @param folderPath folderPath
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||
*/
|
||||
getContentInFolderPath(
|
||||
repositoryId: string,
|
||||
siteId: string,
|
||||
folderPath: string
|
||||
): Promise<ResultListDataRepresentationAlfrescoContentRepresentation> {
|
||||
throwIfNotDefined(repositoryId, 'networkId');
|
||||
throwIfNotDefined(siteId, 'siteId');
|
||||
throwIfNotDefined(folderPath, 'folderPath');
|
||||
|
||||
const pathParams = {
|
||||
repositoryId,
|
||||
siteId,
|
||||
folderPath
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/rest/integration/alfresco/{repositoryId}/sites/{siteId}/folderpath/{folderPath}/content',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders inside a specific folder
|
||||
*
|
||||
* @param repositoryId repositoryId
|
||||
* @param folderId folderId
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||
*/
|
||||
getContentInFolder(repositoryId: string, folderId: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation> {
|
||||
throwIfNotDefined(repositoryId, 'networkId');
|
||||
throwIfNotDefined(folderId, 'folderId');
|
||||
|
||||
const pathParams = {
|
||||
repositoryId,
|
||||
folderId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco/{repositoryId}/folders/{folderId}/content',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders inside a specific site
|
||||
*
|
||||
* @param repositoryId repositoryId
|
||||
* @param siteId siteId
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||
*/
|
||||
getContentInSite(repositoryId: string, siteId: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation> {
|
||||
throwIfNotDefined(repositoryId, 'networkId');
|
||||
throwIfNotDefined(siteId, 'siteId');
|
||||
|
||||
const pathParams = {
|
||||
repositoryId,
|
||||
siteId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/alfresco/{repositoryId}/sites/{siteId}/content',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List Alfresco repositories
|
||||
*
|
||||
* A tenant administrator can configure one or more Alfresco repositories to use when working with content.
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @param opts.tenantId {string} tenantId
|
||||
* @param opts.includeAccounts {boolean} includeAccounts (default to true)
|
||||
* @return Promise<ResultListDataRepresentationAlfrescoEndpointRepresentation>
|
||||
*/
|
||||
getRepositories(opts?: { tenantId?: string; includeAccounts?: boolean }): Promise<ResultListDataRepresentationAlfrescoEndpointRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/profile/accounts/alfresco',
|
||||
queryParams: opts,
|
||||
returnType: ResultListDataRepresentationAlfrescoEndpointRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
155
lib/js-api/src/api/activiti-rest-api/api/integrationBox.api.ts
Normal file
155
lib/js-api/src/api/activiti-rest-api/api/integrationBox.api.ts
Normal file
@@ -0,0 +1,155 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ResultListDataRepresentationBoxContent, UserAccountCredentialsRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* IntegrationBoxApi service.
|
||||
*/
|
||||
export class IntegrationBoxApi extends BaseApi {
|
||||
/**
|
||||
* Box Authorization
|
||||
* Returns Box OAuth HTML Page
|
||||
*
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
confirmAuthorisation(): Promise<any> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/box/confirm-auth-request',
|
||||
accepts: ['text/html']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add Box account
|
||||
*
|
||||
* @param userId userId
|
||||
* @param credentials credentials
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
createRepositoryAccount(userId: number, credentials: UserAccountCredentialsRepresentation): Promise<any> {
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
throwIfNotDefined(credentials, 'credentials');
|
||||
|
||||
const pathParams = {
|
||||
userId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/integration/box/{userId}/account',
|
||||
pathParams,
|
||||
bodyParam: credentials
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete account information
|
||||
*
|
||||
* @param userId userId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteRepositoryAccount(userId: number): Promise<void> {
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
|
||||
const pathParams = {
|
||||
userId
|
||||
};
|
||||
|
||||
const accepts = ['*/*'];
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/integration/box/{userId}/account',
|
||||
pathParams,
|
||||
accepts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get status information
|
||||
*
|
||||
* @return Promise<boolean>
|
||||
*/
|
||||
getBoxPluginStatus(): Promise<boolean> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/box/status',
|
||||
accepts: ['*/*']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List file and folders
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @param opts.filter filter
|
||||
* @param opts.parent parent
|
||||
* @return Promise<ResultListDataRepresentationBoxContent>
|
||||
*/
|
||||
getFiles(opts?: { filter?: string; parent?: string }): Promise<ResultListDataRepresentationBoxContent> {
|
||||
opts = opts || {};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/box/files',
|
||||
queryParams: opts,
|
||||
accepts: ['*/*']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get account information
|
||||
*
|
||||
* @param userId userId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
getRepositoryAccount(userId: number): Promise<any> {
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
|
||||
const pathParams = {
|
||||
userId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/box/{userId}/account',
|
||||
pathParams,
|
||||
accepts: ['*/*']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update account information
|
||||
*
|
||||
* @param userId userId
|
||||
* @param credentials credentials
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
updateRepositoryAccount(userId: number, credentials: UserAccountCredentialsRepresentation): Promise<any> {
|
||||
throwIfNotDefined(userId, 'userId');
|
||||
throwIfNotDefined(credentials, 'credentials');
|
||||
|
||||
const pathParams = {
|
||||
userId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/integration/box/{userId}/account',
|
||||
pathParams,
|
||||
bodyParam: credentials,
|
||||
accepts: ['*/*']
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ResultListDataRepresentationGoogleDriveContent } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
|
||||
/**
|
||||
* IntegrationDriveApi service.
|
||||
*/
|
||||
export class IntegrationDriveApi extends BaseApi {
|
||||
/**
|
||||
* Drive Authorization
|
||||
* Returns Drive OAuth HTML Page
|
||||
*
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
confirmAuthorisation(): Promise<any> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/google-drive/confirm-auth-request',
|
||||
accepts: ['text/html']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List files and folders
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @param opts.filter {string} filter
|
||||
* @param opts.parent {string} parent
|
||||
* @param opts.currentFolderOnly {boolean} currentFolderOnly
|
||||
* @return Promise<ResultListDataRepresentationGoogleDriveContent>
|
||||
*/
|
||||
getFiles(opts?: { filter?: string; parent?: string; currentFolderOnly?: boolean }): Promise<ResultListDataRepresentationGoogleDriveContent> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/integration/google-drive/files',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
export class ModelJsonBpmnApi extends BaseApi {
|
||||
/**
|
||||
* Export a previous process definition model to a JSON
|
||||
*
|
||||
* @param processModelId processModelId
|
||||
* @param processModelHistoryId processModelHistoryId
|
||||
*/
|
||||
getHistoricEditorDisplayJsonClient(processModelId: number, processModelHistoryId: number) {
|
||||
throwIfNotDefined(processModelId, 'processModelId');
|
||||
throwIfNotDefined(processModelHistoryId, 'processModelHistoryId');
|
||||
|
||||
const pathParams = {
|
||||
processModelId,
|
||||
processModelHistoryId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/app/rest/models/{processModelId}/history/{processModelHistoryId}/model-json',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Export a process definition model to a JSON
|
||||
*
|
||||
* @param processModelId processModelId
|
||||
*/
|
||||
getEditorDisplayJsonClient(processModelId: number) {
|
||||
throwIfNotDefined(processModelId, 'processModelId');
|
||||
|
||||
const pathParams = {
|
||||
processModelId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/app/rest/models/{processModelId}/model-json',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to receive the result of the getModelJSONForProcessDefinition operation.
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
*/
|
||||
getModelJSON(processDefinitionId: string) {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/app/rest/process-definitions/{processDefinitionId}/model-json',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to receive the result of the getModelHistoryJSON operation.
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
*/
|
||||
getModelJSONForProcessDefinition(processInstanceId: string) {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/app/rest/process-instances/{processInstanceId}/model-json',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
}
|
||||
314
lib/js-api/src/api/activiti-rest-api/api/models.api.ts
Normal file
314
lib/js-api/src/api/activiti-rest-api/api/models.api.ts
Normal file
@@ -0,0 +1,314 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ModelRepresentation, ObjectNode, ResultListDataRepresentationModelRepresentation, ValidationErrorRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
export interface GetModelsQuery {
|
||||
filter?: string;
|
||||
sort?: string;
|
||||
modelType?: number;
|
||||
referenceId?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Models service.
|
||||
*/
|
||||
export class ModelsApi extends BaseApi {
|
||||
/**
|
||||
* Create a new model
|
||||
*
|
||||
* @param modelRepresentation modelRepresentation
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
createModel(modelRepresentation: ModelRepresentation): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelRepresentation, 'modelRepresentation');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/models',
|
||||
bodyParam: modelRepresentation,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a model
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param opts Optional parameters
|
||||
* @param opts.cascade cascade
|
||||
* @param opts.deleteRuntimeApp deleteRuntimeApp
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteModel(modelId: number, opts?: { cascade?: boolean; deleteRuntimeApp?: boolean }): Promise<any> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
cascade: opts?.cascade,
|
||||
deleteRuntimeApp: opts?.deleteRuntimeApp
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/models/{modelId}',
|
||||
pathParams,
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Duplicate an existing model
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param modelRepresentation modelRepresentation
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
duplicateModel(modelId: number, modelRepresentation: ModelRepresentation): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(modelRepresentation, 'modelRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/models/{modelId}/clone',
|
||||
pathParams,
|
||||
bodyParam: modelRepresentation,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get model content
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @return Promise<ObjectNode>
|
||||
*/
|
||||
getModelJSON(modelId: number): Promise<ObjectNode> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{modelId}/editor/json',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a model's thumbnail image
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @return Promise<string>
|
||||
*/
|
||||
getModelThumbnail(modelId: number): Promise<string> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{modelId}/thumbnail',
|
||||
pathParams,
|
||||
accepts: ['image/png']
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a model
|
||||
*
|
||||
* Models act as containers for process, form, decision table and app definitions
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
getModel(modelId: number, opts?: { includePermissions?: boolean }): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
includePermissions: opts?.includePermissions
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{modelId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List process definition models shared with the current user
|
||||
*
|
||||
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
||||
*/
|
||||
getModelsToIncludeInAppDefinition(): Promise<ResultListDataRepresentationModelRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/models-for-app-definition',
|
||||
returnType: ResultListDataRepresentationModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List models (process, form, decision rule or app)
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
||||
*/
|
||||
getModels(opts?: GetModelsQuery): Promise<ResultListDataRepresentationModelRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/models',
|
||||
queryParams: opts,
|
||||
returnType: ResultListDataRepresentationModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new version of a model
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param file file
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
importNewVersion(modelId: number, file: any): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(file, 'file');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
const formParams = {
|
||||
file
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/models/{modelId}/newversion',
|
||||
pathParams,
|
||||
formParams,
|
||||
contentTypes: ['multipart/form-data'],
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Import a BPMN 2.0 XML file
|
||||
*
|
||||
* @param file file
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
importProcessModel(file: any): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(file, 'file');
|
||||
|
||||
const formParams = {
|
||||
file
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-models/import',
|
||||
contentTypes: ['multipart/form-data'],
|
||||
formParams,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update model content
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param values values
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
saveModel(modelId: number, values: any): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(values, 'values');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/models/{modelId}/editor/json',
|
||||
pathParams,
|
||||
bodyParam: values,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a model
|
||||
*
|
||||
* This method allows you to update the metadata of a model. In order to update the content of the model you will need to call the specific endpoint for that model type.
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param updatedModel updatedModel
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
updateModel(modelId: number, updatedModel: ModelRepresentation): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(updatedModel, 'updatedModel');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/models/{modelId}',
|
||||
pathParams,
|
||||
bodyParam: updatedModel,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate model content
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param opts Optional parameters
|
||||
* @param opts.values values
|
||||
* @return Promise<ValidationErrorRepresentation>
|
||||
*/
|
||||
validateModel(modelId: number, opts?: { values?: any }): Promise<ValidationErrorRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const postBody = opts?.values;
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/models/{modelId}/editor/validate',
|
||||
pathParams,
|
||||
bodyParam: postBody,
|
||||
contentTypes: ['application/x-www-form-urlencoded']
|
||||
});
|
||||
}
|
||||
}
|
||||
71
lib/js-api/src/api/activiti-rest-api/api/modelsBpmn.api.ts
Normal file
71
lib/js-api/src/api/activiti-rest-api/api/modelsBpmn.api.ts
Normal file
@@ -0,0 +1,71 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* ModelsBpmnApi service.
|
||||
*/
|
||||
export class ModelsBpmnApi extends BaseApi {
|
||||
/**
|
||||
* Export a historic version of a process definition as BPMN 2.0 XML
|
||||
*
|
||||
* @param processModelId processModelId
|
||||
* @param processModelHistoryId processModelHistoryId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
getHistoricProcessModelBpmn20Xml(processModelId: number, processModelHistoryId: number): Promise<any> {
|
||||
throwIfNotDefined(processModelId, 'processModelId');
|
||||
throwIfNotDefined(processModelHistoryId, 'processModelHistoryId');
|
||||
|
||||
const pathParams = {
|
||||
processModelId,
|
||||
processModelHistoryId
|
||||
};
|
||||
|
||||
const accepts = ['application/xml'];
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{processModelId}/history/{processModelHistoryId}/bpmn20',
|
||||
pathParams,
|
||||
accepts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Export a process definition as BPMN 2.0 XML
|
||||
*
|
||||
* @param processModelId processModelId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
getProcessModelBpmn20Xml(processModelId: number): Promise<any> {
|
||||
throwIfNotDefined(processModelId, 'processModelId');
|
||||
|
||||
const pathParams = {
|
||||
processModelId
|
||||
};
|
||||
|
||||
const accepts = ['application/xml'];
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{processModelId}/bpmn20',
|
||||
pathParams,
|
||||
accepts
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ModelRepresentation } from '../model/modelRepresentation';
|
||||
import { ResultListDataRepresentationModelRepresentation } from '../model/resultListDataRepresentationModelRepresentation';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* ModelsHistoryApi service.
|
||||
*/
|
||||
export class ModelsHistoryApi extends BaseApi {
|
||||
/**
|
||||
* List a model's historic versions
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param opts Optional parameters
|
||||
* @param opts.includeLatestVersion includeLatestVersion
|
||||
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
||||
*/
|
||||
getModelHistoryCollection(modelId: number, opts?: { includeLatestVersion?: boolean }): Promise<ResultListDataRepresentationModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
|
||||
const pathParams = {
|
||||
modelId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
includeLatestVersion: opts?.includeLatestVersion
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{modelId}/history',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: ResultListDataRepresentationModelRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a historic version of a model
|
||||
*
|
||||
* @param modelId modelId
|
||||
* @param modelHistoryId modelHistoryId
|
||||
* @return Promise<ModelRepresentation>
|
||||
*/
|
||||
getProcessModelHistory(modelId: number, modelHistoryId: number): Promise<ModelRepresentation> {
|
||||
throwIfNotDefined(modelId, 'modelId');
|
||||
throwIfNotDefined(modelHistoryId, 'modelHistoryId');
|
||||
|
||||
const pathParams = {
|
||||
modelId,
|
||||
modelHistoryId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/models/{modelId}/history/{modelHistoryId}',
|
||||
pathParams,
|
||||
returnType: ModelRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,259 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
FormDefinitionRepresentation,
|
||||
FormValueRepresentation,
|
||||
IdentityLinkRepresentation,
|
||||
ResultListDataRepresentationProcessDefinitionRepresentation,
|
||||
ResultListDataRepresentationRuntimeDecisionTableRepresentation,
|
||||
ResultListDataRepresentationRuntimeFormRepresentation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* ProcessDefinitionsApi service.
|
||||
*/
|
||||
export class ProcessDefinitionsApi extends BaseApi {
|
||||
/**
|
||||
* Add a user or group involvement to a process definition
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @param identityLinkRepresentation identityLinkRepresentation
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
createIdentityLink(processDefinitionId: string, identityLinkRepresentation: IdentityLinkRepresentation): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
throwIfNotDefined(identityLinkRepresentation, 'identityLinkRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/identitylinks',
|
||||
pathParams,
|
||||
bodyParam: identityLinkRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a user or group involvement from a process definition
|
||||
*
|
||||
* @param processDefinitionId Process definition ID
|
||||
* @param family Identity type
|
||||
* @param identityId User or group ID
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteIdentityLink(processDefinitionId: string, family: string, identityId: string): Promise<void> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
throwIfNotDefined(family, 'family');
|
||||
throwIfNotDefined(identityId, 'identityId');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId,
|
||||
family,
|
||||
identityId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a user or group involvement with a process definition
|
||||
*
|
||||
* @param processDefinitionId Process definition ID
|
||||
* @param family Identity type
|
||||
* @param identityId User or group ID
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
getIdentityLinkType(processDefinitionId: string, family: string, identityId: string): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
throwIfNotDefined(family, 'family');
|
||||
throwIfNotDefined(identityId, 'identityId');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId,
|
||||
family,
|
||||
identityId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List either the users or groups involved with a process definition
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @param family Identity type
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
getIdentityLinksForFamily(processDefinitionId: string, family: string): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
throwIfNotDefined(family, 'family');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId,
|
||||
family
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List the users and groups involved with a process definition
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
getIdentityLinks(processDefinitionId: string): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/identitylinks',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List the decision tables associated with a process definition
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
|
||||
*/
|
||||
getProcessDefinitionDecisionTables(processDefinitionId: string): Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/decision-tables',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List the forms associated with a process definition
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @return Promise<ResultListDataRepresentationRuntimeFormRepresentation>
|
||||
*/
|
||||
getProcessDefinitionForms(processDefinitionId: string): Promise<ResultListDataRepresentationRuntimeFormRepresentation> {
|
||||
throwIfNotDefined(processDefinitionId, 'processDefinitionId');
|
||||
|
||||
const pathParams = {
|
||||
processDefinitionId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/forms',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the start form for a process definition
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @return Promise<FormDefinitionRepresentation>
|
||||
*/
|
||||
getProcessDefinitionStartForm(processDefinitionId: string): Promise<FormDefinitionRepresentation> {
|
||||
const pathParams = {
|
||||
processDefinitionId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/start-form',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a list of process definitions
|
||||
*
|
||||
* Get a list of process definitions (visible within the tenant of the user)
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @return Promise<ResultListDataRepresentationProcessDefinitionRepresentation>
|
||||
*/
|
||||
getProcessDefinitions(opts?: {
|
||||
latest?: boolean;
|
||||
appDefinitionId?: number;
|
||||
deploymentId?: string;
|
||||
}): Promise<ResultListDataRepresentationProcessDefinitionRepresentation> {
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions',
|
||||
queryParams: opts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve field values (e.g. the typeahead field)
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @param field field
|
||||
* @return Promise<FormValueRepresentation[]>
|
||||
*/
|
||||
getRestFieldValues(processDefinitionId: string, field: string): Promise<FormValueRepresentation[]> {
|
||||
const pathParams = {
|
||||
processDefinitionId,
|
||||
field
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve field values (eg. the table field)
|
||||
*
|
||||
* @param processDefinitionId processDefinitionId
|
||||
* @param field field
|
||||
* @param column column
|
||||
* @return Promise<FormValueRepresentation []>
|
||||
*/
|
||||
getRestTableFieldValues(processDefinitionId: string, field: string, column: string): Promise<FormValueRepresentation[]> {
|
||||
const pathParams = {
|
||||
processDefinitionId,
|
||||
field,
|
||||
column
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}/{column}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,135 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { RestVariable } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* ProcessInstanceVariablesApi service.
|
||||
*/
|
||||
export class ProcessInstanceVariablesApi extends BaseApi {
|
||||
/**
|
||||
* Create or update variables
|
||||
*
|
||||
* @param processInstanceId Process instance ID
|
||||
* @param restVariables restVariables
|
||||
* @return Promise<RestVariable>
|
||||
*/
|
||||
createOrUpdateProcessInstanceVariables(processInstanceId: string, restVariables: RestVariable[]): Promise<RestVariable[]> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(restVariables, 'restVariables');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/variables',
|
||||
pathParams,
|
||||
bodyParam: restVariables
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a variable
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param variableName variableName
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteProcessInstanceVariable(processInstanceId: string, variableName: string): Promise<void> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(variableName, 'variableName');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId,
|
||||
variableName
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/variables/{variableName}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a variable
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param variableName variableName
|
||||
* @return Promise<RestVariable>
|
||||
*/
|
||||
getProcessInstanceVariable(processInstanceId: string, variableName: string): Promise<RestVariable> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(variableName, 'variableName');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId,
|
||||
variableName
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/variables/{variableName}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List variables
|
||||
*
|
||||
* @param processInstanceId Process instance ID
|
||||
* @return Promise<RestVariable>
|
||||
*/
|
||||
getProcessInstanceVariables(processInstanceId: string): Promise<RestVariable[]> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/variables',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a variable
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param variableName variableName
|
||||
* @param restVariable restVariable
|
||||
* @return Promise<RestVariable>
|
||||
*/
|
||||
updateProcessInstanceVariable(processInstanceId: string, variableName: string, restVariable: RestVariable): Promise<RestVariable> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(variableName, 'variableName');
|
||||
throwIfNotDefined(restVariable, 'restVariable');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId,
|
||||
variableName
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/variables/{variableName}',
|
||||
pathParams,
|
||||
bodyParam: restVariable
|
||||
});
|
||||
}
|
||||
}
|
||||
453
lib/js-api/src/api/activiti-rest-api/api/processInstances.api.ts
Normal file
453
lib/js-api/src/api/activiti-rest-api/api/processInstances.api.ts
Normal file
@@ -0,0 +1,453 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {
|
||||
CreateProcessInstanceRepresentation,
|
||||
FormDefinitionRepresentation,
|
||||
HistoricProcessInstanceQueryRepresentation,
|
||||
IdentityLinkRepresentation,
|
||||
ProcessInstanceAuditInfoRepresentation,
|
||||
ProcessInstanceFilterRequestRepresentation,
|
||||
ProcessInstanceQueryRepresentation,
|
||||
ProcessInstanceRepresentation,
|
||||
ProcessInstanceVariableRepresentation,
|
||||
ResultListDataRepresentationDecisionTaskRepresentation,
|
||||
ResultListDataRepresentationProcessContentRepresentation,
|
||||
ResultListDataRepresentationProcessInstanceRepresentation
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* Process Instances service.
|
||||
*/
|
||||
export class ProcessInstancesApi extends BaseApi {
|
||||
/**
|
||||
* Activate a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ProcessInstanceRepresentation>
|
||||
*/
|
||||
activateProcessInstance(processInstanceId: string): Promise<ProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/activate',
|
||||
pathParams,
|
||||
returnType: ProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a user or group involvement to a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param identityLinkRepresentation identityLinkRepresentation
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
createIdentityLink(processInstanceId: string, identityLinkRepresentation: IdentityLinkRepresentation): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(identityLinkRepresentation, 'identityLinkRepresentation');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/identitylinks',
|
||||
pathParams,
|
||||
bodyParam: identityLinkRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a user or group involvement from a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param family family
|
||||
* @param identityId identityId
|
||||
* @param type type
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteIdentityLink(processInstanceId: string, family: string, identityId: string, type: string): Promise<void> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(family, 'family');
|
||||
throwIfNotDefined(identityId, 'identityId');
|
||||
throwIfNotDefined(type, 'type');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId,
|
||||
family,
|
||||
identityId,
|
||||
type
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/identitylinks/{family}/{identityId}/{type}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel or remove a process instance
|
||||
*
|
||||
* If the process instance has not yet been completed, it will be cancelled. If it has already finished or been cancelled then the process instance will be removed and will no longer appear in queries.
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<{}>
|
||||
*/
|
||||
deleteProcessInstance(processInstanceId: string): Promise<void> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List process instances using a filter
|
||||
*
|
||||
* The request body provided must define either a valid filterId value or filter object
|
||||
*
|
||||
* @param filterRequest filterRequest
|
||||
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
||||
*/
|
||||
filterProcessInstances(
|
||||
filterRequest: ProcessInstanceFilterRequestRepresentation
|
||||
): Promise<ResultListDataRepresentationProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(filterRequest, 'filterRequest');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances/filter',
|
||||
bodyParam: filterRequest,
|
||||
returnType: ResultListDataRepresentationProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get decision tasks in a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ResultListDataRepresentationDecisionTaskRepresentation>
|
||||
*/
|
||||
getHistoricProcessInstanceDecisionTasks(processInstanceId: string): Promise<ResultListDataRepresentationDecisionTaskRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/decision-tasks',
|
||||
pathParams,
|
||||
returnType: ResultListDataRepresentationDecisionTaskRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get historic variables for a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ProcessInstanceVariableRepresentation>
|
||||
*/
|
||||
getHistoricProcessInstanceVariables(processInstanceId: string): Promise<ProcessInstanceVariableRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/historic-variables',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query historic process instances
|
||||
*
|
||||
* @param queryRequest queryRequest
|
||||
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
||||
*/
|
||||
getHistoricProcessInstances(
|
||||
queryRequest: HistoricProcessInstanceQueryRepresentation
|
||||
): Promise<ResultListDataRepresentationProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(queryRequest, 'queryRequest');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/historic-process-instances/query',
|
||||
bodyParam: queryRequest,
|
||||
returnType: ResultListDataRepresentationProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a user or group involvement with a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param family family
|
||||
* @param identityId identityId
|
||||
* @param type type
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
getIdentityLinkType(processInstanceId: string, family: string, identityId: string, type: string): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(family, 'family');
|
||||
throwIfNotDefined(identityId, 'identityId');
|
||||
throwIfNotDefined(type, 'type');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId,
|
||||
family,
|
||||
identityId,
|
||||
type
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/identitylinks/{family}/{identityId}/{type}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List either the users or groups involved with a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @param family family
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
getIdentityLinksForFamily(processInstanceId: string, family: string): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
throwIfNotDefined(family, 'family');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId,
|
||||
family
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/identitylinks/{family}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List the users and groups involved with a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<IdentityLinkRepresentation>
|
||||
*/
|
||||
getIdentityLinks(processInstanceId: string): Promise<IdentityLinkRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/identitylinks',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List content attached to process instance fields
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ResultListDataRepresentationProcessContentRepresentation>
|
||||
*/
|
||||
getProcessInstanceContent(processInstanceId: string): Promise<ResultListDataRepresentationProcessContentRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/field-content',
|
||||
pathParams,
|
||||
returnType: ResultListDataRepresentationProcessContentRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the process diagram for the process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<string>
|
||||
*/
|
||||
getProcessInstanceDiagram(processInstanceId: string): Promise<string> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
const accepts = ['image/png'];
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/diagram',
|
||||
pathParams,
|
||||
accepts
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a process instance start form
|
||||
*
|
||||
* The start form for a process instance can be retrieved when the process definition has a start form defined (hasStartForm = true on the process instance)
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<FormDefinitionRepresentation>
|
||||
*/
|
||||
getProcessInstanceStartForm(processInstanceId: string): Promise<FormDefinitionRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/start-form',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ProcessInstanceRepresentation>
|
||||
*/
|
||||
getProcessInstance(processInstanceId: string): Promise<ProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}',
|
||||
pathParams,
|
||||
returnType: ProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query process instances
|
||||
*
|
||||
* @param processInstancesQuery processInstancesQuery
|
||||
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
||||
*/
|
||||
getProcessInstances(
|
||||
processInstancesQuery: ProcessInstanceQueryRepresentation
|
||||
): Promise<ResultListDataRepresentationProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(processInstancesQuery, 'processInstancesQuery');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances/query',
|
||||
bodyParam: processInstancesQuery,
|
||||
returnType: ResultListDataRepresentationProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the audit log for a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ProcessInstanceAuditInfoRepresentation>
|
||||
*/
|
||||
getTaskAuditLog(processInstanceId: string): Promise<ProcessInstanceAuditInfoRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/audit-log',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the process audit in the PDF format
|
||||
*
|
||||
* @param processInstanceId processId
|
||||
* @returns process audit
|
||||
*/
|
||||
getProcessAuditPdf(processInstanceId: string): Promise<Blob> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
const responseType = 'blob';
|
||||
|
||||
return this.get({
|
||||
path: '/app/rest/process-instances/{processInstanceId}/audit',
|
||||
pathParams,
|
||||
responseType
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Start a process instance
|
||||
*
|
||||
* @param startRequest startRequest
|
||||
* @return Promise<ProcessInstanceRepresentation>
|
||||
*/
|
||||
startNewProcessInstance(startRequest: CreateProcessInstanceRepresentation): Promise<ProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(startRequest, 'startRequest');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-instances',
|
||||
bodyParam: startRequest,
|
||||
returnType: ProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Suspend a process instance
|
||||
*
|
||||
* @param processInstanceId processInstanceId
|
||||
* @return Promise<ProcessInstanceRepresentation>
|
||||
*/
|
||||
suspendProcessInstance(processInstanceId: string): Promise<ProcessInstanceRepresentation> {
|
||||
throwIfNotDefined(processInstanceId, 'processInstanceId');
|
||||
|
||||
const pathParams = {
|
||||
processInstanceId
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/api/enterprise/process-instances/{processInstanceId}/suspend',
|
||||
pathParams,
|
||||
returnType: ProcessInstanceRepresentation
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { ProcessScopeRepresentation, ProcessScopesRequestRepresentation } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
|
||||
/**
|
||||
* ProcessScopesApi service.
|
||||
*/
|
||||
export class ProcessScopesApi extends BaseApi {
|
||||
/**
|
||||
* List runtime process scopes
|
||||
*
|
||||
* @param processScopesRequest processScopesRequest
|
||||
* @return Promise<ProcessScopeRepresentation>
|
||||
*/
|
||||
getRuntimeProcessScopes(processScopesRequest: ProcessScopesRequestRepresentation): Promise<ProcessScopeRepresentation> {
|
||||
throwIfNotDefined(processScopesRequest, 'processScopesRequest');
|
||||
|
||||
return this.post({
|
||||
path: '/api/enterprise/process-scopes',
|
||||
bodyParam: processScopesRequest
|
||||
});
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user