feat: initial prototype (#1)

### Explanation

_No response_

### Issue

_No response_

### Attestations

- [x] I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/)
- [x] I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/).
- [x] My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/).

### Dependencies

- [x] I have pinned the dependencies to a specific patch version.

### Style

- [x] I have run the linter and resolved any errors.
- [x] My pull request uses an appropriate title, matching the conventional commit standards.
- [x] My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request.

### Tests

- [ ] My contribution adds new code, and I have added tests to cover it.
- [ ] My contribution modifies existing code, and I have updated the tests to reflect these changes.
- [ ] All new and existing tests pass locally with my changes.
- [ ] Code coverage remains at or above the configured threshold.

### Documentation

_No response_

### Versioning

Major - My pull request introduces a breaking change.

Reviewed-on: #1
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>

.gitea/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Node.js CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Lint and Test
+
+    steps:
+      - name: Checkout Source Files
+        uses: actions/checkout@v4
+
+      - name: Use Node.js v22
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 9
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Lint Source Files
+        run: pnpm run lint
+
+      - name: Verify Build
+        run: pnpm run build
+
+      - name: Run Tests
+        run: pnpm run test

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+prod
+coverage
+
+# Ignore packed files so that npm pack can be run locally
+*.tgz

.npmignore

@@ -0,0 +1,9 @@
+/.gitea/
+/.vscode/
+eslint.config.js
+.gitattributes
+.gitignore
+/src/
+
+# Ignore packed files so that npm pack can be run locally
+*.tgz

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "eslint.validate": ["typescript"]
+}

README.md

@@ -1,20 +1,10 @@
-# New Repository Template
+# Logger
 
-This template contains all of our basic files for a new GitHub repository. There is also a handy workflow that will create an issue on a new repository made from this template, with a checklist for the steps we usually take in setting up a new repository.
+This is a custom logging utility which pipes errors and log messages to our alerting system.
-
-If you're starting a Node.JS project with TypeScript, we have a [specific template](https://github.com/naomi-lgbt/nodejs-typescript-template) for that purpose.
-
-## Readme
-
-Delete all of the above text (including this line), and uncomment the below text to use our standard readme template.
-
-<!-- # Project Name
-
-Project Description
 
 ## Live Version
 
-This page is currently deployed. [View the live website.]
+This page is currently deployed. [View the live website.](https://www.npmjs.com/package/@nhcarrigan/logger)
 
 ## Feedback and Bugs
 

eslint.config.js

@@ -0,0 +1,5 @@
+import NaomisConfig from "@nhcarrigan/eslint-config";
+
+export default [
+    ...NaomisConfig
+]

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@nhcarrigan/logger",
+  "version": "0.0.1",
+  "description": "Our custom logging package, which pipes logs to our alerts server.",
+  "type": "module",
+  "main": "prod/index.js",
+  "scripts": {
+    "lint": "eslint src --max-warnings 0",
+    "build": "rm -rf prod && tsc",
+    "test": "echo \"Error: no test specified\" && exit 0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git.nhcarrigan.com/nhcarrigan/logger.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "See license in LICENSE.md",
+  "bugs": {
+    "url": "https://git.nhcarrigan.com/nhcarrigan/logger/issues"
+  },
+  "homepage": "https://git.nhcarrigan.com/nhcarrigan/logger",
+  "devDependencies": {
+    "@nhcarrigan/eslint-config": "5.1.0",
+    "@nhcarrigan/typescript-config": "4.0.0",
+    "@types/node": "22.13.1",
+    "eslint": "9.20.0",
+    "typescript": "5.7.3"
+  }
+}

src/index.ts

@@ -0,0 +1,74 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+import type { Level } from "./types/level.js";
+
+/**
+ * This is a wrapper around our custom alert monitoring server. This class
+ * allows you to pipe errors and log messages to our server.
+ */
+export class Logger {
+  private readonly url: string;
+
+  /**
+   * Instantiates the class.
+   * @param application -- The name of the application (this will appear in logs).
+   * @param token -- Your API token for the monitoring service.
+   * @param url -- (Optional) The URL for your own alerting instance.
+   */
+  public constructor(
+    private readonly application: string,
+    private readonly token: string,
+    url?: string,
+  ) {
+    this.url = url ?? "https://alerts.nhcarrigan.com";
+  }
+
+  /**
+   * Sends a log message to the alerting service.
+   * @param level -- The level of the log message.
+   * @param message -- The message to send.
+   */
+  public async log(level: Level, message: string): Promise<void> {
+    await fetch(`${this.url}/log`, {
+      body: JSON.stringify({
+        application: this.application,
+        level:       level,
+        message:     message,
+      }),
+      headers: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- Standard header name.
+        "Authorization": this.token,
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- Standard header name.
+        "Content-Type":  "application/json",
+      },
+      method: "POST",
+    });
+  }
+
+  /**
+   * Sends an error to the alerting service.
+   * @param context -- A brief description of where the error occurred (E.G. Function name).
+   * @param error -- The Node.js error object.
+   */
+  public async error(context: string, error: Error): Promise<void> {
+    await fetch(`${this.url}/error`, {
+      body: JSON.stringify({
+        application: this.application,
+        context:     context,
+        message:     error.message,
+        stack:       error.stack ?? "No stack trace available.",
+      }),
+      headers: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- Standard header name.
+        "Authorization": this.token,
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- Standard header name.
+        "Content-Type":  "application/json",
+      },
+      method: "POST",
+    });
+  }
+}

src/types/level.ts

@@ -0,0 +1,12 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+/**
+ * Defines the levels we allow for logging. This is honestly
+ * entirely arbitrary, but ensures some level of consistency across
+ * our production applications.
+ */
+export type Level = "debug" | "info" | "warn";

tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "extends": "@nhcarrigan/typescript-config",
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./prod",
+        "sourceMap": true,
+        "declaration": true
+    },
+    "exclude": ["test/**/*.ts", "vitest.config.ts"]
+}