@pbvision/fastify-firestore-service 0.0.50

package/docs/build.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+cd "`dirname \"$0\"`"
+script_path="`pwd`"
+
+cd ..
+embed-markdown # Update .md files before embedding the .md files into docs
+
+cd "$script_path"
+rm -rf generated
+
+npx jsdoc --configure jsdoc.config.json --destination generated/libs/api --readme api.md ../src/api
+npx jsdoc --configure jsdoc.config.json ../src/plugins `find ../src -type f -not -name index.js`
+
+sed -e "s/docs\\/api[.]md/libs\\/api\\/index.html/g" generated/index.html > generated/tmp
+mv generated/tmp generated/index.html
+
+if [ "$GITHUB_SHA" = "" ]; then
+    gitHash=`git rev-parse HEAD`
+else
+    gitHash=$GITHUB_SHA
+fi
+newLine="Generated from <a href=\"https:\\/\\/github.com\\/pbv-public\\/fastify-firestore-service\\/tree\\/$gitHash\">$gitHash<\\/a><\\/article>"
+cat ./generated/index.html | sed -e "s/[<][/]article[>]/$newLine/g" > tmp
+mv tmp ./generated/index.html

package/docs/jsdoc.config.json

@@ -0,0 +1,22 @@
+{
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false,
+        "default": {
+            "outputSourceFiles": true
+        },
+        "useCollapsibles": true,
+        "name": "Fastify Firestore Service Guide"
+    },
+    "opts": {
+        "access": "protected,public,undefined",
+        "encoding": "utf8",
+        "destination": "generated",
+        "template": "../node_modules/tui-jsdoc-template",
+        "recurse": true,
+        "readme": "../README.md"
+    }
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@pbvision/fastify-firestore-service",
+  "version": "0.0.50",
+  "description": "Web Framework using Fastify and Firestore ORM",
+  "license": "Apache-2.0",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": "./src/index.js",
+  "scripts": {
+    "build-doc": "./docs/build.sh",
+    "debug": "GCLOUD_PROJECT=localhost-emulator INDEBUGGER=1 ./node_modules/nodemon/bin/nodemon.js --no-lazy --legacy-watch --watch ./src --watch ./examples --watch ./test --inspect=9229 --experimental-vm-modules ./node_modules/jest/bin/jest.js --coverage --config=./jest.config.json --runInBand",
+    "setup": "yarn install --frozen-lockfile && pip install -r requirements.txt",
+    "start-local-db": "./node_modules/@pbvision/firestore-orm/scripts/start-local-db.sh",
+    "test": "yarn -s start-local-db && yarn -s test-without-starting-db",
+    "test-without-starting-db": "GCLOUD_PROJECT=localhost-emulator node --experimental-vm-modules ./node_modules/jest/bin/jest.js --config=./jest.config.json --coverage"
+  },
+  "contributors": [
+    "David Underhill",
+    "Yu Guan",
+    "Solaman Huq",
+    "Shimul Bhowmik"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pbv-public/fastify-firestore-service.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "src/**",
+    "!src/app.js",
+    "docs/**",
+    "test/environment.js",
+    "test/base-test.js"
+  ],
+  "dependencies": {
+    "@fastify/compress": "^6.1.1",
+    "@fastify/cookie": "^9.2.0",
+    "@fastify/static": "^6.12",
+    "@fastify/swagger": "^8.1.0",
+    "@fastify/swagger-ui": "^2.0.1",
+    "@pbvision/firestore-orm": "^0.0.22",
+    "@sentry/node": "^7.91.0",
+    "fastify": "^4.10.0",
+    "fastify-plugin": "^4.5.1",
+    "node-fetch": "^3.3.2",
+    "ua-parser-js": "^1.0.37",
+    "word-wrap": "^1.2.3"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.12",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/plugin-transform-class-properties": "^7.12.1",
+    "@babel/preset-env": "^7.17.12",
+    "@pbvision/jest-unit-test": "^0.2.3",
+    "babel-loader": "^9.1.3",
+    "eslint": "^8.22.0",
+    "eslint-config-standard": "17.1.0",
+    "eslint-import-resolver-webpack": "^0.13.8",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "firebase-tools": "^13.5.2",
+    "jest": "^29.7.0",
+    "jsdoc": "3.6.11",
+    "license-webpack-plugin": "^4.0.2",
+    "nodemon": "^3.0.2",
+    "standard": "^17.1.0",
+    "superagent": "^8",
+    "superagent-defaults": "^0.1.14",
+    "supertest": "^6.3.3",
+    "tui-jsdoc-template": "^1.2.2",
+    "webpack": "^5.13.0",
+    "webpack-cli": "^5.1.4"
+  },
+  "standard": {
+    "envs": [
+      "jest"
+    ],
+    "globals": [
+      "fail"
+    ],
+    "ignore": [
+      "**/node_modules/**"
+    ],
+    "parser": "@babel/eslint-parser"
+  }
+}