Initial commit

bitfocus-developer-portal[bot] · web-flow · commit 0e2c6546425d · 2025-03-21T13:16:28.000Z
diff --git a/.github/workflows/companion-module-checks.yaml b/.github/workflows/companion-module-checks.yaml
@@ -0,0 +1,18 @@
+name: Companion Module Checks
+
+on:
+  push:
+
+jobs:
+  check:
+    name: Check module
+
+    if: ${{ !contains(github.repository, 'companion-module-template-') }}
+
+    permissions:
+      packages: read
+
+    uses: bitfocus/actions/.github/workflows/module-checks.yaml@main
+    # with:
+    #   upload-artifact: true # uncomment this to upload the built package as an artifact to this workflow that you can download and share with others
+
diff --git a/.github/workflows/node.yaml b/.github/workflows/node.yaml
@@ -0,0 +1,76 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22.x
+        # This should match the version of Node.js you have defined in the manifest.json runtime field
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - name: Prepare Environment
+        run: |
+          corepack enable
+      - name: Prepare Environment (For template repository)
+        # Only run this step if the repository is a template repository
+        # If you are using this in a module, you can remove this step
+        if: ${{ contains(github.repository, 'companion-module-template-') }}
+        run: |
+          # Perform an install to generate the lockfile
+          yarn install
+        env:
+          CI: false
+      - name: Prepare module
+        run: |
+          yarn install
+        env:
+          CI: true
+      - name: Build and check types
+        run: |
+          yarn build
+        env:
+          CI: true
+      - name: Run lint
+        run: |
+          yarn lint
+        env:
+          CI: true
+
+  # Uncomment this to enable running unit tests
+  # test:
+  #   name: Test
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 15
+
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - name: Use Node.js 22.x
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: 22.x
+  #     - name: Prepare Environment
+  #       run: |
+  #         corepack enable
+  #         yarn install
+  #       env:
+  #         CI: true
+  #     - name: Run tests
+  #       run: |
+  #         yarn test
+  #       env:
+  #         CI: true
+  #     - name: Send coverage
+  #       uses: codecov/codecov-action@v5
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+node_modules/
+package-lock.json
+/pkg
+/pkg.tgz
+/dist
+DEBUG-*
+/.yarn
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1 @@
+lint-staged
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+package.json
+/LICENSE.md
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1 @@
+nodeLinker: node-modules
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Bitfocus AS - Open Source
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# companion-module-[replace with module name]
+
+See [HELP.md](./companion/HELP.md) and [LICENSE](./LICENSE)
+
+## Getting started
+
+Executing a `yarn` command should perform all necessary steps to develop the module, if it does not then follow the steps below.
+
+The module can be built once with `yarn build`. This should be enough to get the module to be loadable by companion.
+
+While developing the module, by using `yarn dev` the compiler will be run in watch mode to recompile the files on change.
diff --git a/companion/HELP.md b/companion/HELP.md
@@ -0,0 +1,3 @@
+## Your module
+
+Write some help for your users here!
diff --git a/companion/manifest.json b/companion/manifest.json
@@ -0,0 +1,26 @@
+{
+	"id": "your-module-name",
+	"name": "your-module-name",
+	"shortname": "module-shortname",
+	"description": "A short one line description of your module",
+	"version": "0.0.0",
+	"license": "MIT",
+	"repository": "git+https://github.com/bitfocus/companion-module-your-module-name.git",
+	"bugs": "https://github.com/bitfocus/companion-module-your-module-name/issues",
+	"maintainers": [
+		{
+			"name": "Your name",
+			"email": "Your email"
+		}
+	],
+	"runtime": {
+		"type": "node22",
+		"api": "nodejs-ipc",
+		"apiVersion": "0.0.0",
+		"entrypoint": "../dist/main.js"
+	},
+	"legacyIds": [],
+	"manufacturer": "Your company",
+	"products": ["Your product"],
+	"keywords": []
+}
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,5 @@
+import { generateEslintConfig } from '@companion-module/tools/eslint/config.mjs'
+
+export default generateEslintConfig({
+	enableTypescript: true,
+})
diff --git a/package.json b/package.json
@@ -0,0 +1,45 @@
+{
+	"name": "your-module-name",
+	"version": "0.1.0",
+	"main": "dist/main.js",
+	"type": "module",
+	"scripts": {
+		"postinstall": "husky",
+		"format": "prettier -w .",
+		"package": "run build && companion-module-build",
+		"build": "rimraf dist && run build:main",
+		"build:main": "tsc -p tsconfig.build.json",
+		"dev": "tsc -p tsconfig.build.json --watch",
+		"lint:raw": "eslint",
+		"lint": "run lint:raw ."
+	},
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/bitfocus/companion-module-your-module-name.git"
+	},
+	"dependencies": {
+		"@companion-module/base": "~1.11.2"
+	},
+	"devDependencies": {
+		"@companion-module/tools": "^2.1.1",
+		"@types/node": "^22.10.2",
+		"eslint": "^9.17.0",
+		"husky": "^9.1.7",
+		"lint-staged": "^15.2.11",
+		"prettier": "^3.4.2",
+		"rimraf": "^6.0.1",
+		"typescript": "~5.5.4",
+		"typescript-eslint": "^8.18.1"
+	},
+	"prettier": "@companion-module/tools/.prettierrc.json",
+	"lint-staged": {
+		"*.{css,json,md,scss}": [
+			"prettier --write"
+		],
+		"*.{ts,tsx,js,jsx}": [
+			"yarn lint:raw --fix"
+		]
+	},
+	"packageManager": "yarn@4.5.3"
+}
diff --git a/src/actions.ts b/src/actions.ts
@@ -0,0 +1,22 @@
+import type { ModuleInstance } from './main.js'
+
+export function UpdateActions(self: ModuleInstance): void {
+	self.setActionDefinitions({
+		sample_action: {
+			name: 'My First Action',
+			options: [
+				{
+					id: 'num',
+					type: 'number',
+					label: 'Test',
+					default: 5,
+					min: 0,
+					max: 100,
+				},
+			],
+			callback: async (event) => {
+				console.log('Hello world!', event.options.num)
+			},
+		},
+	})
+}
diff --git a/src/config.ts b/src/config.ts
@@ -0,0 +1,27 @@
+import { Regex, type SomeCompanionConfigField } from '@companion-module/base'
+
+export interface ModuleConfig {
+	host: string
+	port: number
+}
+
+export function GetConfigFields(): SomeCompanionConfigField[] {
+	return [
+		{
+			type: 'textinput',
+			id: 'host',
+			label: 'Target IP',
+			width: 8,
+			regex: Regex.IP,
+		},
+		{
+			type: 'number',
+			id: 'port',
+			label: 'Target Port',
+			width: 4,
+			min: 1,
+			max: 65535,
+			default: 8000,
+		},
+	]
+}
diff --git a/src/feedbacks.ts b/src/feedbacks.ts
@@ -0,0 +1,33 @@
+import { combineRgb } from '@companion-module/base'
+import type { ModuleInstance } from './main.js'
+
+export function UpdateFeedbacks(self: ModuleInstance): void {
+	self.setFeedbackDefinitions({
+		ChannelState: {
+			name: 'Example Feedback',
+			type: 'boolean',
+			defaultStyle: {
+				bgcolor: combineRgb(255, 0, 0),
+				color: combineRgb(0, 0, 0),
+			},
+			options: [
+				{
+					id: 'num',
+					type: 'number',
+					label: 'Test',
+					default: 5,
+					min: 0,
+					max: 10,
+				},
+			],
+			callback: (feedback) => {
+				console.log('Hello world!', feedback.options.num)
+				if (Number(feedback.options.num) > 5) {
+					return true
+				} else {
+					return false
+				}
+			},
+		},
+	})
+}
diff --git a/src/main.ts b/src/main.ts
@@ -0,0 +1,51 @@
+import { InstanceBase, runEntrypoint, InstanceStatus, SomeCompanionConfigField } from '@companion-module/base'
+import { GetConfigFields, type ModuleConfig } from './config.js'
+import { UpdateVariableDefinitions } from './variables.js'
+import { UpgradeScripts } from './upgrades.js'
+import { UpdateActions } from './actions.js'
+import { UpdateFeedbacks } from './feedbacks.js'
+
+export class ModuleInstance extends InstanceBase<ModuleConfig> {
+	config!: ModuleConfig // Setup in init()
+
+	constructor(internal: unknown) {
+		super(internal)
+	}
+
+	async init(config: ModuleConfig): Promise<void> {
+		this.config = config
+
+		this.updateStatus(InstanceStatus.Ok)
+
+		this.updateActions() // export actions
+		this.updateFeedbacks() // export feedbacks
+		this.updateVariableDefinitions() // export variable definitions
+	}
+	// When module gets deleted
+	async destroy(): Promise<void> {
+		this.log('debug', 'destroy')
+	}
+
+	async configUpdated(config: ModuleConfig): Promise<void> {
+		this.config = config
+	}
+
+	// Return config fields for web config
+	getConfigFields(): SomeCompanionConfigField[] {
+		return GetConfigFields()
+	}
+
+	updateActions(): void {
+		UpdateActions(this)
+	}
+
+	updateFeedbacks(): void {
+		UpdateFeedbacks(this)
+	}
+
+	updateVariableDefinitions(): void {
+		UpdateVariableDefinitions(this)
+	}
+}
+
+runEntrypoint(ModuleInstance, UpgradeScripts)
diff --git a/src/upgrades.ts b/src/upgrades.ts
@@ -0,0 +1,16 @@
+import type { CompanionStaticUpgradeScript } from '@companion-module/base'
+import type { ModuleConfig } from './config.js'
+
+export const UpgradeScripts: CompanionStaticUpgradeScript<ModuleConfig>[] = [
+	/*
+	 * Place your upgrade scripts here
+	 * Remember that once it has been added it cannot be removed!
+	 */
+	// function (context, props) {
+	// 	return {
+	// 		updatedConfig: null,
+	// 		updatedActions: [],
+	// 		updatedFeedbacks: [],
+	// 	}
+	// },
+]
diff --git a/src/variables.ts b/src/variables.ts
@@ -0,0 +1,9 @@
+import type { ModuleInstance } from './main.js'
+
+export function UpdateVariableDefinitions(self: ModuleInstance): void {
+	self.setVariableDefinitions([
+		{ variableId: 'variable1', name: 'My first variable' },
+		{ variableId: 'variable2', name: 'My second variable' },
+		{ variableId: 'variable3', name: 'Another variable' },
+	])
+}
diff --git a/tsconfig.build.json b/tsconfig.build.json
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## Your module`
	`2`	`+`
	`3`	`+Write some help for your users here!`