Initial commit

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
+
+[*.yaml]
+indent_size = 2
+

.eslintignore

@@ -0,0 +1 @@
+dist/*

.eslintrc.cjs

@@ -0,0 +1,56 @@
+/** @type {import('eslint').Linter.Config } */
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+    },
+    env: {
+        browser: false,
+        commonjs: true,
+        node: true,
+    },
+    settings: {},
+    overrides: [
+        { files: '*.d.ts', rules: { strict: ['error', 'never'] } },
+        {
+            files: ['.eslintrc.cjs', '.eslintrc.js', 'jest.config.js'],
+            rules: {
+                'sort-keys': 'off',
+                'array-element-newline': 'off', //['warn', { multiline: true, minItems: 6 }],
+            },
+        },
+    ],
+    plugins: [],
+    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:node/recommended'],
+    rules: {
+        '@typescript-eslint/ban-ts-comment': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/no-empty-interface': 'error',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-inferrable-types': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        'newline-per-chained-call': ['warn', { ignoreChainWithDepth: 2 }],
+        'node/no-missing-import': 'off',
+        'node/no-missing-require': 'off',
+        'node/no-process-exit': 'off',
+        'node/no-unpublished-import': 'off',
+        'node/no-unpublished-require': 'off',
+        'node/no-unsupported-features/es-syntax': 'off',
+        'array-bracket-newline': ['warn', { multiline: true, minItems: 6 }],
+        'array-bracket-spacing': ['warn', 'always', { objectsInArrays: false }],
+        'array-element-newline': ['warn', { multiline: true, minItems: 6 }],
+        'eqeqeq': ['error', 'smart'],
+        'indent': ['warn', 4, { SwitchCase: 1 }],
+        'no-eval': 'error',
+        'no-var': 'error',
+        'object-curly-newline': [
+            'warn',
+            { ObjectExpression: { multiline: true, minProperties: 4 }, ObjectPattern: { multiline: true, minProperties: 4 }, ImportDeclaration: 'never' },
+        ],
+    },
+    ignorePatterns: ['dist/*', 'node_modules/*', '.vscode/*', 'configure-package.js'],
+};

.gitattributes

@@ -0,0 +1,15 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.editorconfig          export-ignore
+/.eslintignore          export-ignore
+/.eslintrc.js           export-ignore
+/.gitattributes         export-ignore
+/.github                export-ignore
+/.gitignore             export-ignore
+/.madgerc               export-ignore
+/.prettierignore        export-ignore
+/jest.config.js         export-ignore
+/prettier.config.js     export-ignore
+/tests                  export-ignore

.github/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+-   Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+-   Check to make sure your feature suggestion isn't already present within the project.
+-   Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+-   Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+-   Check the codebase to ensure that your feature doesn't already exist.
+-   Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+-   **Use Modern JS/TS** - Unless the project is specifically javascript, TypeScript is preferable.
+
+-   **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+-   **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+-   **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+-   **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+-   **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: permafrost-dev
+custom: https://permafrost.dev/open-source

.github/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+If you discover any security related issues, please email {{package.author.email}} instead of using the issue tracker.

.github/codecov.yml

@@ -0,0 +1,40 @@
+codecov:
+  branch: main
+  require_ci_to_pass: yes
+
+coverage:
+  status:
+    project:
+      default:
+        informational: true
+        target: auto
+        # this allows a 10% drop from the previous base commit coverage
+        threshold: 20%
+    patch:
+      default:
+        informational: true
+  precision: 2
+  round: up
+  range: '40...80'
+
+parsers:
+  javascript:
+    enable_partials: yes
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: 'reach,diff,flags,files,footer'
+  behavior: default
+  require_changes: true
+
+ignore:
+  - 'build/'
+  - 'dist/'
+  - '.eslintrc.js'
+  - 'jest.config.js'
+  - 'prettier.config.js'

.github/dependabot.yml

@@ -0,0 +1,23 @@
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    labels:
+      - 'dependencies'
+
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    allow:
+      - dependency-type: 'direct'
+    commit-message:
+      prefix: 'npm'
+      include: 'scope'
+    labels:
+      - 'dependencies'

.github/workflows/close-stale-issues-and-prs.yml

@@ -0,0 +1,20 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '30 1 * * 1'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v9
+        with:
+          stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days.'
+          stale-pr-message: 'This PR is stale because it has been open 30 days with no activity.'
+          close-issue-message: 'This issue was closed because it has been stalled for 14 days with no activity.'
+          days-before-issue-stale: 90
+          days-before-issue-close: 14
+          days-before-pr-stale: 30
+          days-before-pr-close: -1
+          exempt-issue-labels: 'awaiting-approval,work-in-progress,wip,todo'
+          exempt-pr-labels: 'awaiting-approval,work-in-progress,wip,todo'

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,51 @@
+name: 'CodeQL'
+
+on:
+  schedule:
+    - cron: '16 2 * * *'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    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@v4
+
+      # 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

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

@@ -0,0 +1,46 @@
+name: dependabot-auto-merge
+on: pull_request_target
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'
+          compat-lookup: true
+
+      - name: Auto-merge Dependabot PRs for semver-minor updates
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Auto-merge Dependabot PRs for semver-patch updates
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Auto-merge Dependabot PRs for Action major versions when compatibility is higher than 90%
+        if: ${{steps.metadata.outputs.package-ecosystem == 'github_actions' && steps.metadata.outputs.update-type == 'version-update:semver-major' && steps.metadata.outputs.compatibility-score >= 90}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Auto-merge Dependabot PRs for major versions when compatibility is >= 98%
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-major' && steps.metadata.outputs.compatibility-score >= 98}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/format-code.yml

@@ -0,0 +1,31 @@
+name: Check & fix styling
+
+on:
+  push:
+
+jobs:
+  format-code:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          ref: ${{ github.head_ref }}
+
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Format code
+        run: bun run fix
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Fix styling