@rockcarver/frodo-lib 0.11.0

package/.eslintrc

@@ -0,0 +1,32 @@
+{
+  "extends": ["airbnb", "prettier"],
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "requireConfigFile": false
+  },
+  "plugins": ["prettier", "jest"],
+  "rules": {
+    "prettier/prettier": ["error"],
+    "import/extensions": [
+      "error",
+      {
+        "js": "always",
+        "json": "always"
+      }
+    ],
+    "no-console": "off",
+    "no-underscore-dangle": "off",
+    "no-restricted-syntax": [
+      "error",
+      // "ForInStatement",
+      // "ForOfStatement",
+      "LabeledStatement",
+      "WithStatement"
+    ],
+    "no-multi-str": "off"
+  },
+  "env": {
+    "jest": true,
+    "jest/globals": true
+  }
+}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Run command with parameters '...'
+2. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots/command output to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for frodo
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/README.md

@@ -0,0 +1,121 @@
+<!-- README.md for GitHub; the one for NPM is ../README.md. -->
+# Frodo Library - @rockcarver/frodo-lib
+
+ForgeROck DO library, frodo-lib, a library to manage ForgeRock platform deployments supporting Identity Cloud tenants, ForgeOps deployments, and classic deployments.
+
+Frodo-lib powers [frodo-cli](https://github.com/rockcarver/frodo-cli), the command line tool to manage ForgeRock deployments.
+
+## Quick Nav
+
+- [Features](#features)
+- [Limitations](#limitations)
+- [Installing](#installing)
+- [Request features or report issues](#feature-requests)
+- [Contributing](#contributing)
+- [Maintaining](#maintaining)
+
+## Features
+
+Frodo allows an administrator to easily connect to and manage any number of Identity Cloud tenants, ForgeOps deployment instances, or classic deployment instances from the command line. The following tasks are currently supported:
+
+- User mode
+
+  Install and run pre-compiled single binaries without any dependencies for MacOS, Windows, and Linux.
+
+- Manage journeys/trees.
+
+  Export, import and pruning of journeys. Frodo handles referenced scripts and email templates.
+
+- Manage applications.
+
+  List, export, and import applications (OAuth2 clients).
+
+- Manage connection profiles.
+
+  Saving and reading credentials (for multiple ForgeRock deployments) from a configuration file.
+
+- Manage email templates.
+
+  List, export, and import email templates.
+
+- Manage IDM configuration.
+
+  Export of IDM configuration. Import is coming.
+
+- Print versions and tokens.
+
+  Obtain ForgeRock session token and admin access_tokens for a ForgeRock Identity Cloud or platform (ForgeOps) deployment
+
+- View Identity Cloud logs.
+
+  List available log sources and tail them.
+
+- Manage realms.
+
+  List realms and show realm details. Allow adding and removing of custom DNS names.
+
+- Manage scripts.
+
+  List, export, and import scripts.
+
+- Manage Identity Cloud environment specific variables and secrets.
+
+  List and view details of secrets and variables in Identity Cloud.
+
+- Platform admin tasks.
+
+  Common tasks administrators need to perform daily that are tedious and repetitive. Advanced tasks, which used to be involved and potentially dangerous if performed manually, now made easy and safe.
+
+  - Create an oauth2 client with admin privileges.
+  - Get an access token using client credentials grant type.
+  - List oauth2 clients with admin privileges.
+  - Grant an oauth2 client admin privileges.
+  - Revoke admin privileges from an oauth2 client.
+  - List oauth2 clients with custom privileges.
+  - List all subjects of static user mappings that are not oauth2 clients.
+  - Remove a subject's static user mapping.
+  - Add AutoId static user mapping to enable dashboards and other AutoId-based functionality.
+  - Hide generic extension attributes.
+  - Show generic extension attributes.
+  - Repair org model (beta).
+
+## Limitations
+
+`frodo` can't export passwords (including API secrets, etc), so these need to be manually added back to imported configuration or alternatively, edit the export file to add the missing fields before importing.
+
+## Installing
+
+### Developer Mode
+For those who want to contribute or are just curious about the build process.
+
+- Make sure you have Node.js v18 (the version used by developers) or newer and npm.
+- Clone this repo
+  ```console
+  git clone https://github.com/rockcarver/frodo-lib.git
+  ```
+- Install dependencies via NPM
+  ```console
+  cd frodo-lib
+  npm ci
+  ```
+
+### NPM package
+If you are a node developer and want to use frodo-lib as a library for your own applications, you can install the npm package:
+
+- To install the latest version as a dependency for you own application:
+  ```console
+  npm i --save @rockcarver/frodo-lib
+  ```
+- To install the latest pre-release:
+  ```console
+  npm i @rockcarver/frodo-lib@next
+  ```
+
+## Feature requests
+Please use the repository's [issues](https://github.com/rockcarver/frodo-lib/issues) to request new features/enhancements or report bugs/issues.
+
+## Contributing
+If you would like to contribute to frodo, please refer to the [contributing instructions](../docs/CONTRIBUTE.md).
+
+## Maintaining
+If you are a maintainer of this repository, please refer to the [pipeline and release process instructions](../docs/PIPELINE.md).

package/.github/workflows/pipeline.yml

@@ -0,0 +1,287 @@
+name: 'Frodo Library Release Pipeline'
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  smoke-tests:
+    name: 'Smoke Tests'
+    # You must use a Linux environment when using service containers or container jobs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18, 16, 14]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    # Service containers to run with `smoke-tests`
+    services:
+      # Label used to access the service container
+      squid:
+        # Docker Hub image
+        image: ubuntu/squid
+        #
+        ports:
+          # Maps tcp port 3128 on the host to the same port in the service container
+          - 3128:3128
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies and install frodo globally
+        run: |
+          npm ci
+          npm i -g
+
+      #
+      # Run tests.
+      #
+      - name: Test Suites
+        env:
+          FIDC_TENANT_URL: ${{ secrets.FIDC_TENANT_URL }}
+          FIDC_TENANT_ADMIN_USERNAME: ${{ secrets.FIDC_TENANT_ADMIN_USERNAME }}
+          FIDC_TENANT_ADMIN_PASSWORD: ${{ secrets.FIDC_TENANT_ADMIN_PASSWORD }}
+        run: |
+          npm test
+
+      - name: Security Audit
+        run: |
+          npm audit
+
+      # - name: Direct Tests
+      #   env:
+      #     FIDC_TENANT_URL: ${{ secrets.FIDC_TENANT_URL }}
+      #     FIDC_TENANT_ADMIN_USERNAME: ${{ secrets.FIDC_TENANT_ADMIN_USERNAME }}
+      #     FIDC_TENANT_ADMIN_PASSWORD: ${{ secrets.FIDC_TENANT_ADMIN_PASSWORD }}
+      #   run: |
+      #     frodo conn add "$FIDC_TENANT_URL" "$FIDC_TENANT_ADMIN_USERNAME" "$FIDC_TENANT_ADMIN_PASSWORD"
+      #     frodo info "$FIDC_TENANT_URL"
+
+      # - name: Proxy Tests
+      #   env:
+      #     HTTPS_PROXY: "http://127.0.0.1:3128"
+      #     FIDC_TENANT_URL: ${{ secrets.FIDC_TENANT_URL }}
+      #     FIDC_TENANT_ADMIN_USERNAME: ${{ secrets.FIDC_TENANT_ADMIN_USERNAME }}
+      #     FIDC_TENANT_ADMIN_PASSWORD: ${{ secrets.FIDC_TENANT_ADMIN_PASSWORD }}
+      #   run: |
+      #     frodo conn add "$FIDC_TENANT_URL" "$FIDC_TENANT_ADMIN_USERNAME" "$FIDC_TENANT_ADMIN_PASSWORD"
+      #     frodo info "$FIDC_TENANT_URL"
+
+  update-changelog:
+    needs: smoke-tests
+    name: 'Update Changelog'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout source code'
+        uses: 'actions/checkout@v2'
+        with:
+          ref: ${{ github.ref }}
+
+      - name: 'cat package.json'
+        run: cat ./package.json
+
+      - name: 'Prepare Version Bump'
+        id: prepare-version-bump
+        uses: 'phips28/gh-action-bump-version@master'
+        with:
+          major-wording: 'MAJOR RELEASE'
+          minor-wording: 'MINOR RELEASE'
+          patch-wording: 'PATCH RELEASE'
+          rc-wording: ''
+          tag-prefix: 'v'
+          default: prerelease
+          preid: ''
+          bump-policy: 'ignore'
+          skip-commit: 'true'
+          skip-tag: 'true'
+          skip-push: 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update Changelog
+        uses: thomaseizinger/keep-a-changelog-new-release@1.3.0
+        with:
+          tag: ${{ steps.prepare-version-bump.outputs.newTag }}
+
+      - name: 'Output Changelog'
+        run: cat CHANGELOG.md
+
+      - name: Commit updated changelog
+        id: commit-changelog
+        run: |
+          git add CHANGELOG.md
+          git commit --message "Updated changelog for release ${{ steps.prepare-version-bump.outputs.newTag }}"
+          git push
+
+      - name: 'Output Version'
+        env:
+          NEW_VERSION: ${{ steps.prepare-version-bump.outputs.newTag }}
+        run: echo "new tag $NEW_VERSION"
+
+  bump-version:
+    needs: update-changelog
+    name: 'Bump Version'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout Source Code'
+        uses: 'actions/checkout@v2'
+        with:
+          ref: ${{ github.ref }}
+
+      - name: 'cat package.json'
+        run: cat ./package.json
+
+      - name: 'Automated Version Bump'
+        id: version-bump
+        uses: 'phips28/gh-action-bump-version@master'
+        with:
+          major-wording: 'MAJOR RELEASE'
+          minor-wording: 'MINOR RELEASE'
+          patch-wording: 'PATCH RELEASE'
+          rc-wording: ''
+          tag-prefix: 'v'
+          default: prerelease
+          preid: ''
+          bump-policy: 'ignore'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 'cat package.json'
+        run: cat ./package.json
+
+      - name: 'Output Tag'
+        env:
+          NEW_TAG: ${{ steps.version-bump.outputs.newTag }}
+        run: echo "new tag $NEW_TAG"
+
+      - name: 'Version From Tag'
+        id: version-from-tag
+        run: echo "::set-output name=version::$(echo '${{ steps.version-bump.outputs.newTag }}' | sed 's/v//')"
+
+      - name: 'Output Version'
+        id: output-version
+        run: echo "Version = ${{ steps.version-from-tag.outputs.version }}"
+
+    outputs:
+      newTag: ${{ steps.version-bump.outputs.newTag }}
+      newVersion: ${{ steps.version-from-tag.outputs.version }}
+      preRelease: ${{ contains(steps.version-bump.outputs.newTag, '-') }}
+
+  release-notes:
+    needs: bump-version
+    name: 'Release Notes'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout Source Code'
+        uses: 'actions/checkout@v2'
+        with:
+          ref: ${{ github.ref }}
+
+      - name: 'Release Header'
+        id: release-header
+        run: echo "::set-output name=header::$(echo `grep '## \\[${{ needs.bump-version.outputs.newVersion }}] -' CHANGELOG.md | sed 's/## //' | sed 's/\\[//' | sed 's/]//'`)"
+
+      - name: 'Output Release Header'
+        id: output-release-header
+        run: echo "Release Header = ${{ steps.release-header.outputs.header }}"
+
+      - name: 'Extract Release Notes'
+        id: extract-release-notes
+        uses: 'dahlia/submark@main'
+        with:
+          input-file: 'CHANGELOG.md'
+          heading-level: 2
+          heading-title-text: '${{ steps.release-header.outputs.header }}'
+          ignore-case: true
+          omit-heading: true
+
+      # The output-file refers to the path of the temporary file which contains
+      # the only extracted part:
+      - name: 'Output Extracted Release Notes File'
+        run: cat ${{ steps.extract-release-notes.outputs.output-file }}
+
+      # The output-text contains the text of the extracted part.
+      - name: 'Output Extracted Release Notes'
+        run: echo "${{ steps.extract-release-notes.outputs.output-text }}"
+
+    outputs:
+      notes: ${{ steps.extract-release-notes.outputs.output-text }}
+
+  release:
+    needs: [bump-version, release-notes]
+    name: 'Release'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout Source Code'
+        uses: 'actions/checkout@v2'
+        with:
+          ref: ${{ github.ref }}
+
+      - name: 'Github SHA'
+        id: github-sha
+        run: echo ${{ github.sha }} > Release.txt
+
+      - name: 'Test Github SHA'
+        id: test-github-sha
+        run: cat Release.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: ${{ needs.bump-version.outputs.newVersion }}
+          tag_name: ${{ needs.bump-version.outputs.newTag }}
+          body: ${{ needs.release-notes.outputs.notes }}
+          prerelease: ${{ needs.bump-version.outputs.preRelease }}
+          generate_release_notes: ${{ contains(needs.bump-version.outputs.newTag, '-') }}
+          files: |
+            CHANGELOG.md
+            LICENSE
+            Release.txt
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+    outputs:
+      newTag: ${{ needs.bump-version.outputs.newTag }}
+      newVersion: ${{ needs.bump-version.outputs.newVersion }}
+
+  npm-release:
+    needs: [bump-version, release]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 14
+      - name: Pre-Release
+        if: ${{ fromJSON(needs.bump-version.outputs.preRelease) }}
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          tag: 'next'
+          token: ${{ secrets.NPM_ACCESS_TOKEN }}
+      - name: Release
+        if: ${{ ! fromJSON(needs.bump-version.outputs.preRelease) }}
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_ACCESS_TOKEN }}
+      - name: Remove Pre-Release Tag
+        if: ${{ ! fromJSON(needs.bump-version.outputs.preRelease) }}
+        run: |
+          export INPUT_TOKEN=${{ secrets.NPM_ACCESS_TOKEN }}
+          npm whoami
+          npm dist-tag rm @rockcarver/frodo-lib next

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 2,
+    "semi": true,
+    "singleQuote": true
+}