build: initial commit

.eslintignore

@@ -0,0 +1,3 @@
+jest.config.js
+.eslintrc.js
+dist/*

.eslintrc.js

@@ -0,0 +1,28 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'node', 'eslint-plugin-tsdoc', 'prettier'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:node/recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:prettier/recommended',
+  ],
+  rules: {
+    'prettier/prettier': 'warn',
+    'node/no-missing-import': 'off',
+    'node/no-unsupported-features/es-syntax': 'off',
+    'node/no-empty-function': 'off',
+    'node/shebang': 'off',
+    quotes: ['warn', 'single', { avoidEscape: true }],
+    'node/no-unpublished-import': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    'tsdoc/syntax': 'warn',
+  },
+};

.gitattributes

@@ -0,0 +1,2 @@
+# Set the repository to show as TypeScript rather than JS in GitHub
+*.js linguist-detectable=false

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,78 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    attributes:
+      label: Confirm this is a new bug report
+      description: >
+        Select the checkboxes that apply to this bug report. If you're not sure about any of these, don't worry! We'll help you figure it out.
+      options:
+        - label: Possible new bug in VideoDB Python Client
+          required: false
+        - label: Potential new bug in VideoDB API
+          required: false
+        - label: I've checked the current issues, and there's no record of this bug
+          required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: >
+        A clear and concise description of what the bug is.
+      placeholder: >
+        I intended to perform action X, but unexpectedly encountered outcome Y.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: >
+        A clear and concise description of what you expected to happen.
+      placeholder: >
+        I expected outcome Y to occur.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: >
+        Steps to reproduce the behavior:
+      placeholder: |
+        1. Fetch a '...'
+        2. Update the '....'
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Relevant Logs and/or Screenshots
+      description: >
+        If applicable, add logs and/or screenshots to help explain your problem.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        Please complete the following information:
+        eg:
+        - OS: Ubuntu 20.04
+        - nodejs: 20.11.0 
+        - Videodb: 0.0.1
+      value: |
+        - OS: 
+        - Python: 
+        - Videodb:
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: >
+        Add any other context about the problem here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,48 @@
+name: Feature
+description: Submit a proposal/request for a new feature
+labels: ['enhancement']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: checkboxes
+    attributes:
+      label: Confirm this is a new feature request
+      description: >
+        Select the checkboxes that apply to this feature request. If you're not sure about any of these, don't worry! We'll help you figure it out.
+      options:
+        - label: Possible new feature in VideoDB Python Client
+          required: false
+        - label: Potential new feature in VideoDB API
+          required: false
+        - label: I've checked the current issues, and there's no record of this feature request
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe the feature
+      description: >
+        A clear and concise description of what the feature is and why it's needed. 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: |
+        A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: >
+        A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: >
+        Add any other context about the feature request here.
+    validations:
+      required: false

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+## Pull Request
+
+**Description:**
+Describe the purpose of this pull request.
+
+**Changes:**
+- [ ] Feature A
+- [ ] Bugfix B
+
+**Related Issues:**
+- Closes #123
+- Addresses #456
+
+**Testing:**
+Describe any testing steps that have been taken or are necessary.
+Make sure to take in account any existing code change that require some feature to be re-tested.
+
+
+**Checklist:**
+- [ ] Code follows project coding standards
+- [ ] Tests have been added or updated
+- [ ] Code Review
+- [ ] Manual test after merge
+- [ ] All checks passed

.github/workflows/release-package.yml

@@ -0,0 +1,34 @@
+name: videoDB-node
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+coverage

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

.npmrc

@@ -0,0 +1 @@
+@Spext:registry=https://npm.pkg.github.com

.nvmrc

@@ -0,0 +1 @@
+v20.10.0

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "arrowParens": "avoid",
+  "printWidth": 80
+}