setup for typescript, eslint, prettier git hooks & nx configuration

src/middleware/packages/activitypub/services/activitypub/subservices/inbox.js

@@ -3,6 +3,7 @@ const { objectIdToCurrent, collectionPermissionsWithAnonRead } = require('../../
 const ControlledCollectionMixin = require('../../../mixins/controlled-collection');
 const { ACTOR_TYPES } = require('../../../constants');
 
+/** @type {import('moleculer').ServiceSchema} */
 const InboxService = {
   name: 'activitypub.inbox',
   mixins: [ControlledCollectionMixin],

src/middleware/packages/backup/index.js

@@ -2,28 +2,31 @@ const { CronJob } = require('cron');
 const fsCopy = require('./utils/fsCopy');
 const ftpCopy = require('./utils/ftpCopy');
 const rsyncCopy = require('./utils/rsyncCopy');
+/**
+ * @typedef {import('moleculer').Context} Context
+ */
 
 /** @type {import('./indexTypes').BackupService} */
 const BackupService = {
   name: 'backup',
   settings: {
     localServer: {
       fusekiBackupsPath: null,
-      otherDirsPaths: {}
+      otherDirsPaths: {},
     },
-    copyMethod: 'rsync', // rsync, ftp or fs
+    copyMethod: 'rsync', // rsync, ftp, or fs
     remoteServer: {
       path: null, // Required
       user: null, // Required by rsync and ftp
       password: null, // Required by rsync and ftp
       host: null, // Required by rsync and ftp
-      port: null // Required by ftp
+      port: null, // Required by ftp
     },
     // Required for automated backups
     cronJob: {
       time: null,
-      timeZone: 'Europe/Paris'
-    }
+      timeZone: 'Europe/Paris',
+    },
   },
   dependencies: ['triplestore'],
   started() {
@@ -46,7 +49,7 @@ const BackupService = {
         return;
       }
 
-      // Generate new backup of all datasets
+      // Generate a new backup of all datasets
       const datasets = await ctx.call('triplestore.dataset.list');
       for (const dataset of datasets) {
         this.logger.info(`Backing up dataset: ${dataset}`);
@@ -92,10 +95,10 @@ const BackupService = {
           break;
 
         default:
-          throw new Error(`Unknow copy method: ${copyMethod}`);
+          throw new Error(`Unknown copy method: ${copyMethod}`);
       }
-    }
-  }
+    },
+  },
 };
 
 module.exports = BackupService;

src/middleware/packages/backup/indexTypes.d.ts

@@ -0,0 +1,41 @@
+import { Context, ServiceSchema, CallingOptions } from 'moleculer';
+import { CronJob } from 'cron';
+
+interface LocalServerSettings {
+  fusekiBackupsPath: string | null;
+  otherDirsPaths: Record<string, string>;
+}
+
+interface RemoteServerSettings {
+  path: string | null;
+  user?: string | null;
+  password?: string | null;
+  host?: string | null;
+  port?: number | null;
+}
+
+interface CronJobSettings {
+  time: string | null;
+  timeZone?: string;
+}
+
+interface BackupServiceSettings {
+  localServer: LocalServerSettings;
+  copyMethod: 'rsync' | 'ftp' | 'fs';
+  remoteServer: RemoteServerSettings;
+  cronJob: CronJobSettings;
+}
+
+interface BackupServiceActions {
+  backupAll: (ctx: Context, opts?: CallingOptions | undefined) => Promise<void>;
+  backupDatasets: (ctx: Context, opts?: CallingOptions | undefined) => Promise<void>;
+  backupOtherDirs: (ctx: Context, opts?: CallingOptions | undefined) => Promise<void>;
+  copyToRemoteServer: (ctx: Context, opts?: CallingOptions | undefined) => Promise<void>;
+}
+
+export interface BackupService extends ServiceSchema {
+  name: 'backup';
+  settings: BackupServiceSettings;
+  dependencies: ['triplestore'];
+  actions: BackupServiceActions & ServiceSchema['actions'];
+}

src/middleware/packages/backup/package.json

@@ -16,5 +16,8 @@
   },
   "engines": {
     "node": ">=14"
+  },
+  "devDependencies": {
+    "@types/cron": "^2.0.1"
   }
 }

src/middleware/packages/core/service.d.ts

@@ -0,0 +1,28 @@
+import { Context, ServiceSettingSchema } from 'moleculer';
+
+export interface CoreServiceSettings extends ServiceSettingSchema {
+  baseUrl: string;
+  baseDir: string;
+  triplestore: {
+    url: string;
+    user: string;
+    password: string;
+    mainDataset: string;
+  };
+  // Optional
+  containers?: string;
+  jsonContext?: string;
+  ontologies?: string;
+  // Services configurations, TODO
+  activitypub: object;
+  api: object;
+  jsonld: object;
+  ldp: object;
+  signature: object;
+  sparqlEndpoint: object;
+  void: object;
+  webacl: object;
+  webfinger: object;
+}
+
+export interface MethodAuthenticateContext extends Context {}

src/middleware/packages/core/service.js

@@ -13,21 +13,28 @@ const { WebAclService } = require('@semapps/webacl');
 const { WebfingerService } = require('@semapps/webfinger');
 const defaultOntologies = require('./config/ontologies.json');
 
+/**
+ * @typedef {import('http').ServerResponse} ServerResponse
+ * @typedef {import('http').IncomingMessage} IncomingMessage
+ * @typedef {import('./serviceTypes').CoreServiceSettings} CoreServiceSettings
+ */
+
+/** @type {import('moleculer').ServiceSchema<CoreServiceSettings>} */
 const CoreService = {
   name: 'core',
   settings: {
-    baseUrl: null,
-    baseDir: null,
+    baseUrl: undefined,
+    baseDir: undefined,
     triplestore: {
-      url: null,
-      user: null,
-      password: null,
-      mainDataset: null
+      url: undefined,
+      user: undefined,
+      password: undefined,
+      mainDataset: undefined
     },
     // Optional
-    containers: null,
-    jsonContext: null,
-    ontologies: null,
+    containers: undefined,
+    jsonContext: undefined,
+    ontologies: undefined,
     // Services configurations
     activitypub: {},
     api: {},
@@ -47,6 +54,7 @@ const CoreService = {
 
     if (this.settings.activitypub !== false) {
       this.broker.createService(ActivityPubService, {
+        // Type support for settings could be given, once moleculer type definitions improve...
         settings: {
           baseUri: baseUrl,
           jsonContext: jsonContext || defaultJsonContext,

src/middleware/packages/core/serviceTypes.d.ts

@@ -0,0 +1,28 @@
+import { Context, ServiceSettingSchema } from 'moleculer';
+
+export interface CoreServiceSettings extends ServiceSettingSchema {
+  baseUrl?: string;
+  baseDir?: string;
+  triplestore: {
+    url?: string;
+    user?: string;
+    password?: string;
+    mainDataset?: string;
+  };
+  // Optional
+  containers?: string;
+  jsonContext?: string;
+  ontologies?: string;
+  // Services configurations, no typings yet.
+  activitypub: object;
+  api: object;
+  jsonld: object;
+  ldp: object;
+  signature: object;
+  sparqlEndpoint: object;
+  void: object;
+  webacl: object;
+  webfinger: object;
+}
+
+export interface MethodAuthenticateContext extends Context {}

src/middleware/packages/webacl/package.json

@@ -16,6 +16,7 @@
     "url": "https://github.com/assemblee-virtuelle/semapps/issues"
   },
   "dependencies": {
+    "@semapps/ldp": "0.5.1",
     "@semapps/middlewares": "0.5.1",
     "@semapps/mime-types": "0.5.1",
     "@semapps/triplestore": "0.5.1",

src/middleware/tsconfig.json

@@ -1,12 +1,16 @@
 {
   "compilerOptions": {
+    "lib": ["es2020"],
     "allowJs": true,
+    "checkJs": true,
+    "resolveJsonModule": true,
     "declaration": true,
     "noEmit": true,
     "noLib": false,
     "skipLibCheck": true,
     "sourceMap": true,
     "strictNullChecks": true
   },
+  "include": ["**/*.js", "**/*.ts"],
   "exclude": ["node_modules"]
 }

src/middleware/yarn.lock

@@ -1775,6 +1775,14 @@
   dependencies:
     "@types/node" "*"
 
+"@types/cron@^2.0.1":
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/@types/cron/-/cron-2.0.1.tgz#d8bf7a24475f64197c7ac868c362b41be596e5f8"
+  integrity sha512-WHa/1rtNtD2Q/H0+YTTZoty+/5rcE66iAFX2IY+JuUoOACsevYyFkSYu/2vdw+G5LrmO7Lxowrqm0av4k3qWNQ==
+  dependencies:
+    "@types/luxon" "*"
+    "@types/node" "*"
+
 "@types/express-serve-static-core@^4.17.18":
   version "4.17.27"
   resolved "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.27.tgz"
@@ -1866,6 +1874,11 @@
   dependencies:
     "@types/node" "*"
 
+"@types/luxon@*":
+  version "3.3.0"
+  resolved "https://registry.yarnpkg.com/@types/luxon/-/luxon-3.3.0.tgz#a61043a62c0a72696c73a0a305c544c96501e006"
+  integrity sha512-uKRI5QORDnrGFYgcdAVnHvEIvEZ8noTpP/Bg+HeUzZghwinDlIS87DEenV5r1YoOF9G4x600YsUXLWZ19rmTmg==
+
 "@types/mime@^1":
   version "1.3.2"
   resolved "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz"