Adding extension dev-kit building files and also doc placeholder #743

bpatrik · Nov 25, 2023 · 70eec1a · 70eec1a
1 parent 4fe7f31
commit 70eec1a
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,4 @@ test.*
 /db/
 /test/cypress/screenshots/
 /extensions/
+/extension/lib/
diff --git a/extension/.npmignore b/extension/.npmignore
@@ -0,0 +1 @@
+*.tsconfig.json
diff --git a/extension/README.md b/extension/README.md
@@ -0,0 +1,3 @@
+# @pigallery2/extension-kit
+
+TODO.
diff --git a/extension/ext-enums.tsconfig.json b/extension/ext-enums.tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "extends": "./../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "sourceMap": false
+  },
+  "include": [
+    "./../src/common/entities/**/*",
+    "./../src/common/config/**/*"
+  ]
+}
diff --git a/extension/ext-interface.tsconfig.json b/extension/ext-interface.tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "extends": "./../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "sourceMap": false,
+    "outDir": "./lib"
+  },
+  "include": [
+    "./../src/**/*"
+  ]
+}
diff --git a/extension/index.ts b/extension/index.ts
@@ -0,0 +1,2 @@
+export {IServerExtension,IExtensionObject} from './lib/backend/model/extension/IExtension';
+
diff --git a/extension/package.json b/extension/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "pigallery2-extension-kit",
+  "version": "2.0.2-edge",
+  "description": "Interfaces for developing extensions for pigallery2",
+  "author": "Patrik J. Braun",
+  "homepage": "https://github.com/bpatrik/pigallery2",
+  "license": "MIT"
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pigallery2",
-  "version": "2.0.0",
+  "version": "2.0.2-edge",
   "description": "This is a photo gallery optimised for running low resource servers (especially on raspberry pi)",
   "author": "Patrik J. Braun",
   "homepage": "https://github.com/bpatrik/pigallery2",
@@ -25,7 +25,8 @@
     "lint": "ng lint",
     "start-e2e-server": "node ./test/folder-reset test/e2e && node ./src/backend/index --config-path=test/e2e/config.json --Database-dbFolder=test/e2e --Server-port=8080",
     "cypress:open": "cypress open",
-    "cypress:run": "cypress run"
+    "cypress:run": "cypress run",
+    "build-extension-interface": "tsc -p extension/ext-interface.tsconfig.json && tsc -p extension/ext-enums.tsconfig.json"
   },
   "repository": {
     "type": "git",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export {IServerExtension,IExtensionObject} from './lib/backend/model/extension/IExtension';
Check failure on line 1 in extension/index.ts View workflow job for this annotation GitHub Actions / test (18.x) `Cannot find module './lib/backend/model/extension/IExtension' or its corresponding type declarations.`