feat: create a shared /lib folder for the extensions (#41)

* feat: add lib folder for extensions

* test: fix tests

* feat: update script

* fix: npm i of the /lib

Author: alexey-yarmosh

Dockerfile

@@ -64,6 +64,10 @@ RUN npm run build
 
 # Build hooks/adopted-probe
 FROM node:18-alpine AS builder-09
+WORKDIR /builder/src/extensions/lib
+ADD ./src/extensions/lib/package.json ./src/extensions/lib/package-lock.json ./
+RUN npm ci
+COPY ./src/extensions/lib .
 WORKDIR /builder/src/extensions/hooks/adopted-probe
 ADD ./src/extensions/hooks/adopted-probe/package.json ./src/extensions/hooks/adopted-probe/package-lock.json ./
 RUN npm ci
@@ -134,16 +138,20 @@ RUN npm ci
 COPY ./src/extensions/hooks/gp-tokens .
 RUN npm run build
 
-# Build hooks/gp-tokens
+# Build hooks/directus-users
 FROM node:18-alpine AS builder-18
 WORKDIR /builder/src/extensions/hooks/directus-users
 ADD ./src/extensions/hooks/directus-users/package.json ./src/extensions/hooks/directus-users/package-lock.json ./
 RUN npm ci
 COPY ./src/extensions/hooks/directus-users .
 RUN npm run build
 
-# Build hooks/gp-tokens
+# Build hooks/location-verrides
 FROM node:18-alpine AS builder-19
+WORKDIR /builder/src/extensions/lib
+ADD ./src/extensions/lib/package.json ./src/extensions/lib/package-lock.json ./
+RUN npm ci
+COPY ./src/extensions/lib .
 WORKDIR /builder/src/extensions/hooks/location-overrides
 ADD ./src/extensions/hooks/location-overrides/package.json ./src/extensions/hooks/location-overrides/package-lock.json ./
 RUN npm ci

README.md

@@ -35,7 +35,7 @@ Add tests to extension:
 # From the extension folder call:
 original_dir=$PWD
 npm i --save-dev chai @types/chai mocha @types/mocha sinon @types/sinon ts-node
-jq --tab '.compilerOptions.module = "ESNext"' tsconfig.json > temp.json && mv temp.json tsconfig.json
+jq 'del(.compilerOptions.rootDir) | .compilerOptions.module = "ESNext" | .include = ["./src/**/*.ts", "../../lib/*.ts"]' tsconfig.json > temp.json && mv temp.json tsconfig.json
 jq --tab '.scripts.test = "TS_NODE_TRANSPILE_ONLY=true mocha"' package.json > temp.json && mv temp.json package.json
 mkdir test
 while [[ $PWD != */extensions ]]; do cd ..; done

scripts/test.sh

@@ -8,6 +8,9 @@ directories=$(find ./src -type d -name "node_modules" -prune -o -type f -name "p
 echo "Extensions directories:"
 echo "$directories"
 
+# /lib directory should be installed first
+directories="./src/extensions/lib $directories"
+
 for dir in $directories; do
 	(
 		echo "Directory: $dir"

src/extensions/hooks/adopted-probe/src/validate-fields.ts

@@ -4,7 +4,7 @@ import axios from 'axios';
 import { createError } from '@directus/errors';
 import { Fields } from './index.js';
 import { City, geonamesCache, getKey } from './geonames-cache.js';
-import { normalizeCityName } from './normalize-city.js';
+import { normalizeCityName } from '../../../lib/normalize-city.js';
 import { EventContext } from '@directus/types';
 import { getProbes, getUser } from './repositories/directus.js';
 

src/extensions/hooks/adopted-probe/tsconfig.json

@@ -26,10 +26,10 @@
 		"skipLibCheck": true,
 		"forceConsistentCasingInFileNames": true,
 		"allowSyntheticDefaultImports": true,
-		"isolatedModules": true,
-		"rootDir": "./src"
+		"isolatedModules": true
 	},
 	"include": [
-		"./src/**/*.ts"
+		"./src/**/*.ts",
+		"../../lib/*.ts"
 	]
 }

src/extensions/hooks/location-overrides/src/normalize-city.ts

@@ -3,7 +3,7 @@ import { createError } from '@directus/errors';
 import axios from 'axios';
 import ipaddr from 'ipaddr.js';
 import type { Fields } from './index.js';
-import { normalizeCityName } from './normalize-city.js';
+import { normalizeCityName } from '../../../lib/normalize-city.js';
 
 type City = {
 	lng: string;

src/extensions/hooks/location-overrides/src/validate-fields.ts

@@ -25,10 +25,10 @@
 		"forceConsistentCasingInFileNames": true,
 		"allowSyntheticDefaultImports": true,
 		"isolatedModules": true,
-		"rootDir": "./src",
 		"module": "ESNext"
 	},
 	"include": [
-		"./src/**/*.ts"
+		"./src/**/*.ts",
+		"../../lib/*.ts"
 	]
 }

src/extensions/hooks/location-overrides/tsconfig.json

@@ -0,0 +1,17 @@
+{
+	"name": "lib",
+	"version": "1.0.0",
+	"description": "",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"test": "echo 'No tests for that folder'",
+		"build": "echo 'No build step for that folder'"
+	},
+	"keywords": [],
+	"author": "",
+	"license": "ISC",
+	"dependencies": {
+		"any-ascii": "^0.3.2"
+	}
+}