Skip to content
This repository has been archived by the owner on Feb 8, 2024. It is now read-only.

Commit

Permalink
[ACS-6231] preparation cleanup before supporting Nx (#1714)
Browse files Browse the repository at this point in the history
* move examples to docs

* remove unused header template

* cleanup npm ignore settings

* cleanup unused assets folder

* fix running double-testing

* cleanup lint scripts

* move jsdom to dev dependencies
  • Loading branch information
DenysVuika authored Oct 30, 2023
1 parent 68e9644 commit 928f9cd
Show file tree
Hide file tree
Showing 12 changed files with 72 additions and 89 deletions.
7 changes: 2 additions & 5 deletions .github/workflows/js-api-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ jobs:
run: npm ci

- name: Lint
run: |
./scripts/lint.sh
run: npm run lint

- name: Build
run: |
Expand All @@ -69,9 +68,7 @@ jobs:

- name: Unit test
shell: bash
run: |
npm run test || exit 1
npm run coverage
run: npm test

test-performance:
needs: build
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ target
*.d.ts
/bundles/
.env
.nyc_output
10 changes: 0 additions & 10 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,32 +1,22 @@
/coverage
/.travis.yml
/.editorconfig
/tslint.json
/pom.xml
*.iml
.mergify.yml
bpm-example.md
ecm-example.md
cspell.json
/.idea
/test/
/assets/
*.tgz
*.DS_Store
/package/
/.github/
/api-codegen
/.vscode
/definitions
/performance
/scripts
webpack.config.js
tsconfig.json
/.make-packages.js
/.make-helpers.js
/tsconfig.base.json
/tools/
/target/
/.history/
/tsconfig/
/src/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ JavaScript client API for the Alfresco REST API and Activiti REST API.
- [Authentication](docs/authentication.md)
- [Calling Custom Endpoints](docs/calling-custom-endpoints.md)
- [Error Events](docs/error-events.md)
- [ECM Examples](ecm-example.md), full docs: [Content API](src/api/content-rest-api/README.md)
- [BPM Examples](bpm-example.md), full docs: [APS 2.X API](src/api/activiti-rest-api/README.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

Expand Down
Binary file removed assets/alfresco.png
Binary file not shown.
16 changes: 0 additions & 16 deletions assets/license.txt

This file was deleted.

22 changes: 11 additions & 11 deletions bpm-example.md → docs/bpm-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@

# BPM

A complete list of all the BPM methods is available here: [Activiti API](src/api/activiti-rest-api/README.md).
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.
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

Expand Down Expand Up @@ -103,13 +103,13 @@ taskApi.getTask(taskId).then(
TasksApi.filterTasks(requestTasks)
```

Returns the [ResultListDataRepresentation](src/api/activiti-rest-api/docs/ResultListDataRepresentation«TaskRepresentation».md) that is a filtered list of all the tasks.
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 |
| requestTasks | [TaskFilterRequestRepresentation](../src/api/activiti-rest-api/docs/TaskFilterRequestRepresentation.md) | requestTasks |


**Example**
Expand Down Expand Up @@ -167,7 +167,7 @@ taskApi.taskApi.completeTask(taskId).then(
TasksApi.getTaskForm(taskId)
```

Retrieve the [Task Form](src/api/activiti-rest-api/docs/FormDefinitionRepresentation.md) representation.
Retrieve the [Task Form](../src/api/activiti-rest-api/docs/FormDefinitionRepresentation.md) representation.

**Parameters**

Expand Down Expand Up @@ -203,7 +203,7 @@ Complete a Task Form
| Name | Type | Description |
|--------------------------------|--------------------------------------------------------------------------------------------|--------------------------------|
| taskId | String | taskId |
| completeTaskFormRepresentation | [CompleteFormRepresentation](src/api/activiti-rest-api/docs/CompleteFormRepresentation.md) | completeTaskFormRepresentation |
| completeTaskFormRepresentation | [CompleteFormRepresentation](../src/api/activiti-rest-api/docs/CompleteFormRepresentation.md) | completeTaskFormRepresentation |

**Example**

Expand All @@ -230,13 +230,13 @@ taskApi.completeTaskForm(taskId, completeTaskFormRepresentation).then(
ProcessInstancesApi.getProcessInstances(requestNode)
```

Retrieve a list of process instances, see [ResultListDataRepresentationProcessInstanceRepresentation](src/api/activiti-rest-api/docs/ResultListDataRepresentation«ProcessInstanceRepresentation».md)
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 |
| requestNode | [ProcessInstanceQueryRepresentation](../src/api/activiti-rest-api/docs/ProcessInstanceQueryRepresentation.md) | requestNode |

**Example**

Expand Down Expand Up @@ -277,13 +277,13 @@ processApi.getProcessInstances(requestNode).then(

## 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.
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)
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**

Expand Down Expand Up @@ -314,7 +314,7 @@ modelsApi.getModels(opts).then(

## 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)
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

Expand Down
4 changes: 2 additions & 2 deletions ecm-example.md → docs/ecm-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

# ECM

A complete list of all the ECM methods is available here: [Content API](src/api/content-rest-api/README.md).
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
Expand Down Expand Up @@ -267,7 +267,7 @@ 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 API](../src/api/content-rest-api/docs/RenditionsApi.md)
* [Rendition service Wiki](https://wiki.alfresco.com/wiki/Rendition_Service)

```javascript
Expand Down
Loading

0 comments on commit 928f9cd

Please sign in to comment.