@openapi-typescript-infra/service 1.1.0 → 1.1.1

package/Makefile

@@ -0,0 +1,71 @@
+# This Makefile is intended to be called by higher level/project Makefiles
+# It bakes in a number of standard practices include the use of the src
+# directory (choose your build dir as appropriate).
+#
+# It also includes database scripts, which technically aren't the concern of this
+# module, but very often services do have a database component but don't need
+# any sort of service-specific database modules (just plain pg). So this Makefile
+# has targets for setting up a database for the service, and generating types
+# using kysely, and using db-migrate for schema managment.
+#
+# With all that, you can have a Makefile that does this:
+#
+# .PHONY: all service dbi ts
+#
+# export DB_NAME ?= cool_db
+# export SERVICE_NAME ?= my-cool-serv
+#
+# include node_modules/@openapi-typescript-infra/service/Makefile
+#
+# all: service dbi ts
+#
+
+build_dir := $(node -e "console.log(require('./package.json').main.replace(/^.\//, '').split('/')[0])")
+src_files := $(shell find src -name '*.ts')
+build_files := $(patsubst src/%.ts,$(build_dir)/%.js,$(src_files))
+
+# General utilities
+clean:
+	yarn dlx rimraf ./$(build_dir) src/generated
+
+# Typescript items
+ts: $(word 1, $(build_files))
+
+$(word 1, $(build_files)): $(src_files)
+	./node_modules/.bin/tsc -p tsconfig.build.json
+
+service: src/generated/service/index.ts
+
+src/generated/service/index.ts: api/${SERVICE_NAME}.yaml
+	echo "Building service interface"
+	yarn dlx openapi-typescript-express ./api/${SERVICE_NAME}.yaml \
+		--output ./src/generated/service/index.ts
+	./node_modules/.bin/prettier ./src/generated/service/index.ts --write
+
+# Postgres database things
+export PGUSER ?= postgres
+export PGPASSWORD ?= postgres
+export PGHOST ?= localhost
+
+db-ci:
+	yarn run-pg-sql -q postgres ./migrations/setup/ci_setup.sql
+	yarn run-pg-sql -q postgres ./migrations/setup/db_setup.sql
+	yarn migration:apply
+	yarn run-pg-sql $(DB_NAME) ./migrations/setup/dev_setup.sql
+
+db-drop:
+	yarn run-pg-sql -q postgres -e "DROP DATABASE IF EXISTS $(DB_NAME);"
+
+db+:
+	yarn migration:apply
+
+db-:
+	yarn migration:undo
+
+db-clean: db-drop db-ci
+
+dbi:
+	echo "Generating database types"
+	DATABASE_URL=postgres://$(PGUSER):$(PGPASSWORD)@$(PGHOST)/$(DB_NAME) yarn kysely-codegen \
+		--dialect postgres --schema public \
+		--out-file src/generated/database.ts

package/README.md

@@ -38,3 +38,4 @@ This module has the following core functionality:
 7. Setup infrastructure for interservice calls with tracing.
 8. Provide a central service runner that handles loading your service and getting to a running state in both development and production environments.
 
+Please see the plop-based [project builder](../create) for an easy way to build an example project.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "An opinionated framework for building configuration driven services - web, api, or job. Uses OpenAPI, pino logging, express, confit, Typescript and Jest.",
   "main": "build/index.js",
   "scripts": {
     "test": "jest",
     "lint": "eslint .",
-    "build": "tsc -p tsconfig.build.json && yarn dlx chmodx build/bin/*",
+    "build": "tsc -p tsconfig.build.json && yarn dlx glob-chmod 755 build/bin/*",
     "watch": "tsc -p tsconfig.json -w --preserveWatchOutput",
     "clean": "npx rimraf ./build",
     "prepublishOnly": "yarn build",