couchdb-web-node-plugin 2.0.830 → 2.0.832

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "couchdb-web-node-plugin",
-  "version": "2.0.830",
+  "version": "2.0.832",
   "description": "A couchdb server, model instance conflict handler, rest api, authentication, session management, schema validator and model relation guarantee for webNode.",
   "keywords": [
     "api",
@@ -82,11 +82,11 @@
     "@types/webpack-env": "^1.18.8",
     "@typescript-eslint/eslint-plugin": "^8.57.2",
     "@typescript-eslint/parser": "^8.57.2",
-    "clientnode": "^4.0.1364",
+    "clientnode": "^4.0.1369",
     "documentation-website": "^1.0.401",
     "eslint": "^10.1.0",
     "eslint-config-google": "^0.14.0",
-    "eslint-plugin-jsdoc": "^62.8.0",
+    "eslint-plugin-jsdoc": "^62.8.1",
     "express": "^5.2.1",
     "express-pouchdb": "^4.2.0",
     "jest": "^30.3.0",
@@ -97,7 +97,7 @@
     "rimraf": "^6.1.3",
     "typescript-eslint": "^8.57.2",
     "web-node": "^1.0.577",
-    "weboptimizer": "^3.0.15"
+    "weboptimizer": "^3.0.16"
   },
   "peerDependencies": {
     "@babel/runtime": "*",
@@ -258,7 +258,7 @@
         "since": "now",
         "timeout": false
       },
-      "removeDanglingForeignKeysChangesStream": {
+      "updateForeignKeysChangesStream": {
         "include_docs": true,
         "live": true,
         "return_docs": false,
@@ -266,6 +266,14 @@
         "style": "all_docs",
         "timeout": false
       },
+      "removeDanglingForeignKeysChangesStream": {
+        "include_docs": false,
+        "live": true,
+        "return_docs": false,
+        "since": "now",
+        "style": "all_docs",
+        "timeout": false
+      },
       "updateMaterializedViewsChangesStream": {
         "include_docs": true,
         "live": true,
@@ -298,7 +306,6 @@
       "createGenericFlatIndex": true,
       "databaseName": "main",
       "debug": false,
-      "removeDanglingForeignKeys": false,
       "ensureAdminPresence": true,
       "ensureSecuritySettingsPresence": true,
       "ensureUserPresence": true,

package/readme.md

@@ -33,3 +33,33 @@ Use case
 
 PouchDB with model specification/checking, user authentication and right
 management as web-node plugin.
+
+Foreign Key management
+----------------------
+
+The plugin provides a foreign key management for PouchDB. It allows to define
+foreign keys in the model specification and automatically checks the existence 
+of the referenced documents when creating or updating documents. It also
+provides a way to automatically delete or update the referenced documents when
+the referencing document is deleted or updated.
+
+### Mechanism
+
+#### Initialization
+
+During application start the plugin analyzes the model specification and
+creates a map of model types to properties that are defined as foreign keys and
+which model type they reference.
+
+It than goes through all documents having referencing properties and checks if
+the referenced documents exist. If not, it deletes the reference and if yes, it
+stores the reference in an internal map of referenced documents to referencing
+documents.
+
+#### Document creation and update
+
+When creating or updating a document, the plugin checks if the document has
+referencing properties. If yes, it checks if the referenced documents exist. If
+not, it deletes the reference and if yes, it stores the reference in the
+internal map of referenced documents to referencing documents. It also removes
+references from the internal map if they are no longer present.

package/type.d.ts

@@ -38,6 +38,9 @@ export type DatabaseFetch = PouchDB.Core.Options['fetch'];
 export type DatabaseResponse = PouchDB.Core.Response;
 export type Document<Type extends object = PlainObject> = PouchDB.Core.Document<Type>;
 export type ExistingDocument<Type extends object = PlainObject> = PouchDB.Core.ExistingDocument<Type>;
+export type DocumentDeleteMeta = PouchDB.Core.IdMeta & {
+    _deleted: boolean;
+};
 export type DocumentGetMeta = PouchDB.Core.GetMeta;
 export type DocumentIDMeta = PouchDB.Core.IdMeta;
 export type DocumentRevisionIDMeta = PouchDB.Core.RevisionIdMeta;
@@ -292,6 +295,7 @@ export interface CoreConfiguration<Type extends object = Mapping<unknown>, Attac
     };
     numberOfParallelChangesRunner: number;
     removeDanglingForeignKeysChangesStream: ChangesStreamOptions;
+    updateForeignKeysChangesStream: ChangesStreamOptions;
     updateMaterializedViewsChangesStream: ChangesStreamOptions;
     connector: ConnectorConfiguration;
     security: {
@@ -299,7 +303,6 @@ export interface CoreConfiguration<Type extends object = Mapping<unknown>, Attac
         _users: SecuritySettings;
         [key: string]: SecuritySettings;
     };
-    removeDanglingForeignKeys: boolean;
     createGenericFlatIndex: boolean;
     databaseName: string;
     debug: boolean;
@@ -333,14 +336,31 @@ export interface CoreConfiguration<Type extends object = Mapping<unknown>, Attac
 export type Configuration<ConfigurationType = Mapping<unknown>> = BaseConfiguration<{
     couchdb: CoreConfiguration;
 }> & ConfigurationType;
+export interface StaticForeignKey {
+    propertySelector: Array<string>;
+    targetModelName: string;
+}
+export type StaticForeignKeys = Array<StaticForeignKey>;
+export interface RuntimeForeignKey {
+    propertySelector: Array<string>;
+    id: string;
+}
+export type RuntimeForeignKeys = Array<RuntimeForeignKey>;
 export interface CouchDB<Type extends object = Mapping<unknown>> {
     changesStream: ChangesStream;
     lastChangesSequenceIdentifier?: number | string;
     reinitializeMaterializedViews?: () => Promise<void>;
+    foreignKeys: {
+        static: Mapping<StaticForeignKeys>;
+        runtime: Mapping<RuntimeForeignKeys>;
+    };
+    removeDanglingForeignKeys?: () => Promise<void>;
     updateMaterializedViewsChangesStream?: ChangesStream;
     lastUpdateMaterializedViewsChangesSequenceIdentifier?: number | string;
     removeDanglingForeignKeysChangesStream?: ChangesStream;
     lastRemoveDanglingForeignKeysChangesSequenceIdentifier?: number | string;
+    updateForeignKeysChangesStream?: ChangesStream;
+    lastUpdateForeignKeysChangesSequenceIdentifier?: number | string;
     backendConnector: Connector;
     connection: Connection<Type>;
     connector: Connector;