Initial commit

Author: sh1nj1

.cspell.json

@@ -0,0 +1,20 @@
+// cSpell Settings
+{
+  // Version of the setting file.  Always 0.1
+  "version": "0.1",
+  // language - current active spelling language
+  "language": "en",
+  // words - list of words to be always considered correct
+  "words": ["vrerv"],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": ["hte"],
+  "ignorePaths": [
+    "package.json",
+    "package-lock.json",
+    "node_modules/**",
+    "examples/**/node_modules/**",
+    "build/**"
+  ]
+}

.eslintignore

@@ -0,0 +1 @@
+/build

.eslintrc.js

@@ -0,0 +1,30 @@
+/* eslint-env node */
+
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
+  env: {
+    node: true,
+    commonjs: true,
+  },
+  rules: {
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        args: "all",
+        argsIgnorePattern: "^_",
+        // Allow assertion types.
+        varsIgnorePattern: "^_assert",
+        caughtErrors: "none",
+        ignoreRestSiblings: true,
+      },
+    ],
+    "no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
+  },
+}

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 15.x, 16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm run build
+      - run: npm run lint
+      - run: npm test

.github/workflows/semgrep.yml

@@ -0,0 +1,22 @@
+name: Security - Semgrep
+
+on:
+  pull_request: {}
+  workflow_dispatch: {}
+  push:
+    branches-ignore: ["main"]
+  schedule:
+    - cron: "20 17 * * *"
+
+jobs:
+  semgrep:
+    name: semgrep/ci
+    runs-on: ubuntu-latest
+    container:
+      image: returntocorp/semgrep
+    timeout-minutes: 480
+    steps:
+      - uses: actions/checkout@v3
+      - run: semgrep ci
+        env:
+          SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP }}

.gitignore

@@ -0,0 +1,11 @@
+node_modules
+
+package-lock.json
+/build
+
+/examples/**/node_modules
+/examples/**/package-lock.json
+/examples/**/.env
+
+.vscode
+.idea

.nvmrc

@@ -0,0 +1 @@
+lts/fermium

.prettierignore

@@ -0,0 +1,2 @@
+build
+.github/**/*.md

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "arrowParens": "avoid",
+  "semi": false,
+  "trailingComma": "es5",
+  "endOfLine": "lf"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VReRV
+
+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.

README.md

@@ -0,0 +1,27 @@
+<div align="center">
+	<h1>Node package template</h1>
+	<p>
+		<b>A node package template project</b>
+	</p>
+	<br>
+</div>
+
+![Build status](https://github.com/vrerv/node-package-template/actions/workflows/ci.yml/badge.svg)
+[![npm version](https://badge.fury.io/js/%40vrerv%2Fnode-package-template.svg)](https://www.npmjs.com/package/@vrerv/node-package-template)
+
+## Usage
+
+TODO: build software and write usage instructions
+
+## Requirements
+
+This package supports the following minimum versions:
+
+- Runtime: `node >= 14`
+- Type definitions (optional): `typescript >= 4.5`
+
+Earlier versions may still work, but we encourage people building new applications to upgrade to the current stable.
+
+## References
+
+- This codebase has been stripped down from the original [notion-sdk-js](https://github.com/makenotion/notion-sdk-js)

examples/example-project/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "arrowParens": "avoid",
+  "tabWidth": 2,
+  "semi": false,
+  "trailingComma": "es5",
+  "endOfLine": "lf",
+  "singleQuote": false
+}

examples/example-project/README.md

@@ -0,0 +1 @@
+# Example Project Sample

examples/example-project/index.js

@@ -0,0 +1,9 @@
+import { Example } from "@vrerv/node-package-template"
+
+const sdk = new Example()
+
+async function main() {
+  await sdk.hello()
+}
+
+main()

examples/example-project/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "example-project",
+  "version": "1.0.0",
+  "description": "Example of using sdk.",
+  "main": "index.js",
+  "type": "module",
+  "engines": {
+    "node": "12.x"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "ts-run": "node --loader ts-node/esm index.ts"
+  },
+  "dependencies": {
+    "@vrerv/node-package-template": "file:../../"
+  },
+  "author": "VReRV",
+  "license": "MIT"
+}

examples/example-project/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "sourceMap": false,
+
+    "target": "ESNext",
+    "module": "commonjs",
+
+    "moduleResolution": "Node",
+
+    "allowSyntheticDefaultImports": true,
+
+    "useDefineForClassFields": false,
+
+    "strict": false,
+    "suppressImplicitAnyIndexErrors": true,
+
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "noUncheckedIndexedAccess": true,
+    "allowJs": true,
+    "checkJs": false
+  },
+  "include": ["src/**/*"]
+}

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+}

package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@vrerv/node-package-template",
+  "version": "2.2.15",
+  "description": "A node package template",
+  "engines": {
+    "node": ">=12"
+  },
+  "homepage": "https://vrerv.com",
+  "bugs": {
+    "url": "https://github.com/vrerv/node-package-template/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vrerv/node-package-template/"
+  },
+  "keywords": [
+    "vrerv"
+  ],
+  "main": "./build/src",
+  "types": "./build/src/index.d.ts",
+  "scripts": {
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run && npm run lint && npm run test",
+    "build": "tsc",
+    "prettier": "prettier --write .",
+    "lint": "prettier --check . && eslint . --ext .ts && cspell '**/*' ",
+    "test": "jest ./test",
+    "check-links": "git ls-files | grep md$ | xargs -n 1 markdown-link-check",
+    "prebuild": "npm run clean",
+    "clean": "rm -rf ./build"
+  },
+  "author": "",
+  "license": "MIT",
+  "files": [
+    "build/package.json",
+    "build/src/**"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@types/jest": "^28.1.4",
+    "@typescript-eslint/eslint-plugin": "^5.39.0",
+    "@typescript-eslint/parser": "^5.39.0",
+    "cspell": "^5.4.1",
+    "eslint": "^7.24.0",
+    "jest": "^28.1.2",
+    "markdown-link-check": "^3.8.7",
+    "prettier": "^2.8.8",
+    "ts-jest": "^28.0.5",
+    "typescript": "^4.8.4"
+  }
+}

src/Example.ts

@@ -0,0 +1,9 @@
+export class Example {
+  constructor() {
+    console.log("Example constructor")
+  }
+
+  hello() {
+    console.log("Hello Example")
+  }
+}

src/index.ts

@@ -0,0 +1,2 @@
+export { LogLevel, Logger } from "./logging"
+export { Example } from "./Example"

src/logging.ts

@@ -0,0 +1,36 @@
+import { assertNever } from "./utils"
+
+export enum LogLevel {
+  DEBUG = "debug",
+  INFO = "info",
+  WARN = "warn",
+  ERROR = "error",
+}
+
+export interface Logger {
+  (level: LogLevel, message: string, extraInfo: Record<string, unknown>): void
+}
+
+export function makeConsoleLogger(name: string): Logger {
+  return (level, message, extraInfo) => {
+    console[level](`${name} ${level}:`, message, extraInfo)
+  }
+}
+
+/**
+ * Transforms a log level into a comparable (numerical) value ordered by severity.
+ */
+export function logLevelSeverity(level: LogLevel): number {
+  switch (level) {
+    case LogLevel.DEBUG:
+      return 20
+    case LogLevel.INFO:
+      return 40
+    case LogLevel.WARN:
+      return 60
+    case LogLevel.ERROR:
+      return 80
+    default:
+      return assertNever(level)
+  }
+}

src/type-utils.ts

@@ -0,0 +1,8 @@
+/**
+ * Utilities for working with typescript types
+ */
+
+/**
+ * Assert U is assignable to T.
+ */
+export type Assert<T, U extends T> = U

src/utils.ts

@@ -0,0 +1,24 @@
+/**
+ * Utility for enforcing exhaustiveness checks in the type system.
+ *
+ * @see https://basarat.gitbook.io/typescript/type-system/discriminated-unions#throw-in-exhaustive-checks
+ *
+ * @param value The variable with no remaining values
+ */
+export function assertNever(value: never): never {
+  throw new Error(`Unexpected value should never occur: ${value}`)
+}
+
+type AllKeys<T> = T extends unknown ? keyof T : never
+
+export function pick<O, K extends AllKeys<O>>(
+  base: O,
+  keys: readonly K[]
+): Pick<O, K> {
+  const entries = keys.map(key => [key, base?.[key]])
+  return Object.fromEntries(entries)
+}
+
+export function isObject(o: unknown): o is Record<PropertyKey, unknown> {
+  return typeof o === "object" && o !== null
+}