Confluence plugin (#32)

Co-authored-by: Cortex <[email protected]>
Co-authored-by: Fernando Cremer <[email protected]>

Author: 3 people

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Cortex
+Copyright (c) 2024 Cortex
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

plugins/confluence-plugin/.eslintignore

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

plugins/confluence-plugin/.eslintrc.js

@@ -0,0 +1,30 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    "plugin:react/jsx-runtime",
+    "plugin:react-hooks/recommended",
+    "standard-with-typescript",
+    "prettier",
+  ],
+  overrides: [],
+  parserOptions: {
+    ecmaVersion: "latest",
+    project: "tsconfig.json",
+    sourceType: "module",
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ["react"],
+  rules: {
+    // conflicts with no-extra-boolean-cast
+    "@typescript-eslint/strict-boolean-expressions": "off",
+    "no-console": ["error", { allow: ["warn", "error"] }],
+  },
+  settings: {
+    react: {
+      version: "detect",
+    },
+  },
+};

plugins/confluence-plugin/.gitignore

@@ -0,0 +1,12 @@
+# OSX
+*.DS_Store
+
+# IDEs
+.idea
+*.iml
+.vscode
+
+# This project
+node_modules/
+dist/
+yarn-error.log

plugins/confluence-plugin/.prettierignore

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

plugins/confluence-plugin/README.md

@@ -0,0 +1,36 @@
+# Cortex Confluence Plugin
+
+This plugin makes it possible to view Confluence assets alongside related entities in the service catalog, such as in this screenshot:
+
+![Cortex Confluence Plugin Screenshot](images/confluence-plugin-screenshot.png)
+
+This is a [Cortex](https://www.cortex.io/) plugin. To see how to run the plugin inside of Cortex, see [our docs](https://docs.cortex.io/docs/plugins).
+
+### Prerequisites
+
+The URL of your Confluence instance should be configured in `src/components/PageContent.tsx`. To do so, change the following line to match the URL of your server:
+
+```
+const baseConfluenceUrl = "https://confluence-server.atlassian.net";
+```
+
+Developing and building this plugin requires either [yarn](https://classic.yarnpkg.com/lang/en/docs/install/) or [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
+
+## Getting started
+
+1. Modify the `src/components/PageContent.tsx` file as described above
+2. Run `yarn` to download all dependencies
+3. Run `yarn build` to compile the plugin code into `./dist/ui.html`
+4. Upload `ui.html` into Cortex on a create or edit plugin page
+5. Add or update the code and repeat steps 2-3 as necessary
+
+## Adding Confluence Content
+
+Entities can be associated with Confluence Page IDs by adding a PageID tag to the `x-cortex-confluence` object. In the Entity yaml for the entity to the Page ID that you'd like to view inside of Cortex, such as:
+
+```
+x-cortex-confluence:
+  pageID: "123456"
+```
+
+You can do this for Custom Entities, as well as any Service entity.

plugins/confluence-plugin/__mocks__/fileMock.js

@@ -0,0 +1 @@
+module.exports = "test-file-stub";

plugins/confluence-plugin/__mocks__/styleMock.js

@@ -0,0 +1 @@
+module.exports = {};

plugins/confluence-plugin/babel.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  plugins: ["@babel/plugin-syntax-jsx"],
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+    ["@babel/preset-react", { runtime: "automatic" }],
+  ],
+};

plugins/confluence-plugin/cortex.yaml

@@ -0,0 +1,12 @@
+openapi: 3.0.1
+info:
+  title: Plugins Confluence Plugin
+  description: ""
+  x-cortex-tag: plugins-confluence-plugin
+  x-cortex-git:
+    github:
+      repository: cortexapps/cortex-plugins
+      basepath: plugins/confluence-plugin
+  x-cortex-custom-metadata:
+    cortex-template-version: 0.1.0
+    cortex-generated-timestamp: 2024-01-25T14:45:14.646626276