feat: add Run Report activity (#1)

Co-authored-by: Ryan Cooney <[email protected]>

.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+    extends: [require.resolve("@vertigis/workflow-sdk/config/.eslintrc")],
+    parserOptions: {
+        tsconfigRootDir: __dirname,
+    },
+    plugins: ["prettier"],
+    rules: {},
+};

.github/workflows/ci-cd.yml

@@ -0,0 +1,66 @@
+name: CI/CD
+
+on:
+    push:
+        branches:
+            - main
+            - beta
+    pull_request:
+        branches:
+            - main
+            - beta
+
+env:
+    CI: true
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Use Node.js 16
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 16.x
+
+            - run: npm install
+
+            - run: npm run build
+
+            - run: npm run lint
+
+    release:
+        runs-on: ubuntu-latest
+        needs:
+            - test
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/beta'
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  # Pulls all commits (needed for semantic release to correctly version)
+                  # See https://github.com/semantic-release/semantic-release/issues/1526
+                  fetch-depth: "0"
+                  persist-credentials: false
+
+            # Pulls all tags (needed for semantic release to correctly version)
+            - name: Fetch git tags
+              run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+
+            - name: Use Node.js 16
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 16.x
+
+            - run: npm install
+
+            - run: npm run build
+
+            - run: cp LICENSE package.json README.md build
+
+            - name: Release 🚀
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+              run: npx semantic-release@^19 --dry-run
+              working-directory: ./build

.github/workflows/lint-pr.yml

@@ -0,0 +1,17 @@
+name: "Lint PR"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+build/
+node_modules/

.npmrc

@@ -0,0 +1 @@
+access=public

.prettierrc

@@ -0,0 +1,4 @@
+{
+    "endOfLine":"auto",
+    "tabWidth": 4
+}

.releaserc.json

@@ -0,0 +1,11 @@
+{
+    "preset": "conventionalcommits",
+    "branches": [
+        "+([0-9])?(.{+([0-9]),x}).x",
+        "main",
+        "next",
+        "next-major",
+        { "name": "beta", "prerelease": true },
+        { "name": "alpha", "prerelease": true }
+    ]
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["dbaeumer.vscode-eslint"]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules\\typescript\\lib"
+}

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+## Cloning the repository
+
+If you are a member of our organization and have push permissions to this repository, you can simply clone this repository, create a branch, and begin making changes. Otherwise you can follow this guide to forking a repository: https://help.github.com/en/github/getting-started-with-github/fork-a-repo.
+
+Once you're happy with your changes and have committed them to a branch, you can submit a pull request in this project where a maintainer can review and merge your changes.
+
+## Pull request guidelines
+
+This project uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate the versioning and deployment of this repository. **The version used during release is determined based on the title of the merged pull request. The title should follow the [Conventional Commits standard](https://www.conventionalcommits.org/).**

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 VertiGIS North America Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,59 @@
-# workflow-activities-reporting-client
-VertiGIS Studio Reporting activities for VertiGIS Studio Workflow
+[![CI/CD](https://github.com/vertigis/workflow-activities-reporting-client/workflows/CI/CD/badge.svg)](https://github.com/vertigis/workflow-activities-reporting-client/actions)
+[![npm](https://img.shields.io/npm/v/@vertigis/workflow-activities-reporting-client)](https://www.npmjs.com/package/@vertigis/workflow-activities-reporting-client)
+
+This project contains activities for interacting with [VertiGIS Studio Reporting](https://vertigisstudio.com/products/vertigis-studio-reporting/) in a [VertiGIS Studio Workflow](https://vertigisstudio.com/products/vertigis-studio-workflow/). It uses the [@vertigis/reporting-client](https://github.com/vertigis/vertigis-reporting-client-js) library.
+
+Note: this activity pack is intended for workflow authors that require lower level APIs for working with reports. In most scenarios the out-of-the-box `Run Report` activity should be preferred.
+
+## Requirements
+
+### VertiGIS Studio Workflow Versions
+
+These activities are designed to work with VertiGIS Studio Workflow versions `5.30.1` and above.
+
+## Usage
+To use these activities in [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/) you need to register an activity pack and then add the activities to a workflow.
+
+### Register the Utility Network activity pack
+
+1. Sign in to ArcGIS Online or Portal for ArcGIS
+1. Go to **My Content**
+1. Select **Add Item > An application**
+    - Type: `Web Mapping`
+    - Purpose: `Ready To Use`
+    - API: `JavaScript`
+    - URL: The URL to this activity pack manifest
+        - Use https://unpkg.com/@vertigis/workflow-activities-reporting-client/activitypack.json for the latest version
+        - Use https://unpkg.com/@vertigis/[email protected]/activitypack.json for a specific version
+    - Title: Your desired title
+    - Tags: Must include `geocortex-workflow-activity-pack`
+1. Reload [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/)
+1. These activities will now appear in the activity toolbox in an `Reporting Client` category
+
+## Development
+
+This project was bootstrapped with the [VertiGIS Studio Workflow SDK](https://github.com/vertigis/vertigis-workflow-sdk). Before you can use your activity pack in the [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/), you will need to [register the activity pack](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview#register-the-activity-pack).
+
+## Available Scripts
+
+Inside the newly created project, you can run some built-in commands:
+
+### `npm run generate`
+
+Interactively generate a new activity or form element.
+
+### `npm start`
+
+Runs the project in development mode. Your activity pack will be available at [http://localhost:5000/main.js](http://localhost:5000/main.js). The HTTPS certificate of the development server is a self-signed certificate that web browsers will warn about. To work around this open [`https://localhost:5000/main.js`](https://localhost:5000/main.js) in a web browser and allow the invalid certificate as an exception. For creating a locally-trusted HTTPS certificate see the [Configuring a HTTPS Certificate](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate) section on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/).
+
+### `npm run build`
+
+Builds the activity pack for production to the `build` folder. It optimizes the build for the best performance.
+
+Your custom activity pack is now ready to be deployed!
+
+See the [section about deployment](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#deployment) in the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/) for more information.
+
+## Documentation
+
+Find [further documentation on the SDK](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/) on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/)