lucos_search_component 0.0.2

package/.circleci/config.yml

@@ -0,0 +1,14 @@
+version: 2.1
+orbs:
+  lucos: lucos/deploy@0
+
+workflows:
+  version: 2
+  publish:
+    jobs:
+      - lucos/component-publish:
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              ignore: /.*/

package/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "07:00"
+  open-pull-requests-limit: 10
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "07:00"

package/.github/workflows/auto-merge.yml

@@ -0,0 +1,17 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]'
+    steps:
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '37 16 * * *'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

package/README.md

@@ -0,0 +1,30 @@
+# lucos_search_component
+Web Component for searching lucOS data
+
+## Technologies used
+* ES Modules
+* Web Components
+
+## Usage
+Include the following in your javascript:
+```
+import 'lucos_search_component';
+```
+
+Include the following in your html:
+```
+<lucos-search></lucos-search>
+```
+
+## Manual Testing
+
+Expects a `.env` file in the root directory with the following environment variables:
+* KEY_LUCOS_ARACHNE - an API for lucos_arachne, as set by lucos_creds
+
+(The `.env` file can be automatically generated using the command `scp -P 2202 "creds.l42.eu:${PWD##*/}/development/.env" .`, assuming the correct credentials are in place)
+
+Run:
+```
+npm run example
+```
+This uses webpack to build the javascript and then opens a html page which includes the web component

package/example/example.js

@@ -0,0 +1 @@
+import '../index.js';

package/example/index.html

@@ -0,0 +1,9 @@
+<html>
+	<head>
+		<title>Hello World Search Component</title>
+		<script src="./built.js"></script>
+	</head>
+	<body>
+		<lucos-search api-key="${KEY_LUCOS_ARACHNE}"></lucos-search>
+	</body>
+</html>

package/example/webpack.config.js

@@ -0,0 +1,11 @@
+import { URL } from 'url';
+export default {
+  entry: {
+    example: './example/example.js',
+  },
+  output: {
+    filename: 'built.js',
+    path: new URL('.', import.meta.url).pathname,
+  },
+  mode: 'development',
+};

package/index.js

@@ -0,0 +1,8 @@
+class LucosSearchComponent extends HTMLElement {
+	constructor() {
+		super();
+		const shadow = this.attachShadow({mode: 'closed'});
+		console.log("Search Component initiated")
+	}
+}
+customElements.define('lucos-search', LucosSearchComponent);

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "lucos_search_component",
+  "version": "0.0.2",
+  "description": "Web Component for searching lucOS data",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "example": "source .env && KEY_LUCOS_ARACHNE=$KEY_LUCOS_ARACHNE envsubst < example/index.html > example/built.html && webpack -c example/webpack.config.js && open example/built.html"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lucas42/lucos_search_component.git"
+  },
+  "keywords": [
+    "lucos",
+    "search"
+  ],
+  "author": "Luke Blaney",
+  "bugs": {
+    "url": "https://github.com/lucas42/lucos_search_component/issues"
+  },
+  "homepage": "https://github.com/lucas42/lucos_search_component#readme",
+  "devDependencies": {
+    "webpack-cli": "^6.0.1"
+  }
+}