@opentermsarchive/engine 0.21.0 → 0.23.0

package/README.md

@@ -371,7 +371,7 @@ The default configuration can be found in `config/default.json`. The full refere
 }
 ```
 
-The default configuration is merged with (and overridden by) environment-specific configuration that can be specified at startup with the `NODE_ENV` environment variable. For example, running `NODE_ENV=vagrant npm start` will load the `vagrant.json` configuration file. See [node-config](https://github.com/node-config/node-config) for more information about configuration files.
+The default configuration is merged with (and overridden by) environment-specific configuration that can be specified at startup with the `NODE_ENV` environment variable. See [node-config](https://github.com/node-config/node-config) for more information about configuration files.
 
 In order to have a local configuration that override all exisiting config, it is recommended to create a `config/development.json` file with overridden values.
 
@@ -426,8 +426,7 @@ If an outgoing HTTP/HTTPS proxy to access the Internet is required, it is possib
 
 ## Deploying
 
-Deployment is managed with [Ansible](https://www.ansible.com). See the [Open Terms Archive deployment Ansible collection](https://github.com/OpenTermsArchive/ota.deployment-ansible-collection).
-
+Deployment recipes are available in a [dedicated repository](https://github.com/OpenTermsArchive/deployment). Look at the [README](https://github.com/OpenTermsArchive/deployment#readme) to know how to deploy the engine.
 ## Contributing
 
 ### Getting a copy

package/config/production.json

@@ -1,7 +1,4 @@
 {
-  "services": {
-    "declarationsPath": "../declarations/declarations"
-  },
   "recorder": {
     "versions": {
       "storage": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://github.com/ambanum/OpenTermsArchive#readme",
   "bugs": {
@@ -100,6 +100,9 @@
     "sinon": "^12.0.1",
     "sinon-chai": "^3.7.0"
   },
+  "peerDependencies": {
+    "@opentermsarchive/terms-types": "~0.1.1"
+  },
   "engines": {
     "node": ">=16.0.0"
   }

package/src/archivist/services/index.js

@@ -1,7 +1,8 @@
 import fsApi from 'fs';
 import path from 'path';
-import { fileURLToPath, pathToFileURL } from 'url';
+import { pathToFileURL } from 'url';
 
+import TERMS_TYPES from '@opentermsarchive/terms-types';
 import config from 'config';
 
 import DocumentDeclaration from './documentDeclaration.js';
@@ -9,10 +10,9 @@ import PageDeclaration from './pageDeclaration.js';
 import Service from './service.js';
 
 const fs = fsApi.promises;
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const declarationsPath = path.resolve(process.cwd(), config.get('services.declarationsPath'));
 
-export const DOCUMENT_TYPES = JSON.parse(fsApi.readFileSync(path.resolve(__dirname, './documentTypes.json')));
+export const DOCUMENT_TYPES = TERMS_TYPES;
 
 export async function load(servicesIdsToLoad = []) {
   let servicesIds = await getDeclaredServicesIds();

package/config/contrib.json

@@ -1,35 +0,0 @@
-{
-  "services": {
-    "repository": "https://github.com/OpenTermsArchive/contrib-declarations.git"
-  },
-  "recorder": {
-    "versions": {
-      "storage": {
-        "git": {
-          "snapshotIdentiferTemplate": "mongo://contrib/open-terms-archive/snapshots/%SNAPSHOT_ID",
-          "repository": "git@github.com:OpenTermsArchive/contrib-versions.git"
-        }
-      }
-    },
-    "snapshots": {
-      "storage": {
-        "type": "mongo"
-      }
-    }
-  },
-  "notifier": {
-    "sendInBlue": {
-      "updatesListId": 596,
-      "updateTemplateId": 39
-    }
-  },
-  "tracker": {
-    "githubIssues": {
-      "repository": "OpenTermsArchive/contrib-declarations"
-    }
-  },
-  "dataset": {
-    "title": "contrib",
-    "versionsRepositoryURL": "https://github.com/OpenTermsArchive/contrib-versions"
-  }
-}

package/config/dating.json

@@ -1,37 +0,0 @@
-{
-  "services": {
-    "repository": "https://github.com/OpenTermsArchive/dating-declarations.git"
-  },
-  "recorder": {
-    "versions": {
-      "storage": {
-        "git": {
-          "snapshotIdentiferTemplate": "https://github.com/OpenTermsArchive/dating-snapshots/commit/%SNAPSHOT_ID",
-          "repository": "git@github.com:OpenTermsArchive/dating-versions.git"
-        }
-      }
-    },
-    "snapshots": {
-      "storage": {
-        "git": {
-          "repository": "git@github.com:OpenTermsArchive/dating-snapshots.git"
-        }
-      }
-    }
-  },
-  "notifier": {
-    "sendInBlue": {
-      "updatesListId": 594,
-      "updateTemplateId": 40
-    }
-  },
-  "tracker": {
-    "githubIssues": {
-      "repository": "OpenTermsArchive/dating-declarations"
-    }
-  },
-  "dataset": {
-    "title": "dating",
-    "versionsRepositoryURL": "https://github.com/OpenTermsArchive/dating-versions"
-  }
-}

package/config/france.json

@@ -1,40 +0,0 @@
-{
-  "services": {
-    "repository": "https://github.com/OpenTermsArchive/france-declarations.git"
-  },
-  "recorder": {
-    "versions": {
-      "storage": {
-        "git": {
-          "snapshotIdentiferTemplate": "https://github.com/OpenTermsArchive/france-snapshots/commit/%SNAPSHOT_ID",
-          "repository": "git@github.com:OpenTermsArchive/france-versions.git"
-        }
-      }
-    },
-    "snapshots": {
-      "storage": {
-        "git": {
-          "repository": "git@github.com:OpenTermsArchive/france-snapshots.git"
-        }
-      }
-    }
-  },
-  "fetcher": {
-    "language": "fr"
-  },
-  "notifier": {
-    "sendInBlue": {
-      "updatesListId": 595,
-      "updateTemplateId": 42
-    }
-  },
-  "tracker": {
-    "githubIssues": {
-      "repository": "OpenTermsArchive/france-declarations"
-    }
-  },
-  "dataset": {
-    "title": "france",
-    "versionsRepositoryURL": "https://github.com/OpenTermsArchive/france-versions"
-  }
-}

package/config/p2b-compliance.json

@@ -1,40 +0,0 @@
-{
-  "services": {
-    "repository": "https://github.com/OpenTermsArchive/p2b-compliance-declarations.git"
-  },
-  "recorder": {
-    "versions": {
-      "storage": {
-        "git": {
-          "snapshotIdentiferTemplate": "https://github.com/OpenTermsArchive/p2b-compliance-snapshots/commit/%SNAPSHOT_ID",
-          "repository": "git@github.com:OpenTermsArchive/p2b-compliance-versions.git"
-        }
-      }
-    },
-    "snapshots": {
-      "storage": {
-        "git": {
-          "repository": "git@github.com:OpenTermsArchive/p2b-compliance-snapshots.git"
-        }
-      }
-    }
-  },
-  "fetcher": {
-    "language": "en"
-  },
-  "notifier": {
-    "sendInBlue": {
-      "updatesListId": 861,
-      "updateTemplateId": 56
-    }
-  },
-  "tracker": {
-    "githubIssues": {
-      "repository": "OpenTermsArchive/p2b-compliance-declarations"
-    }
-  },
-  "dataset": {
-    "title": "p2b-compliance",
-    "versionsRepositoryURL": "https://github.com/OpenTermsArchive/p2b-compliance-versions"
-  }
-}

package/config/pga.json

@@ -1,40 +0,0 @@
-{
-  "services": {
-    "repository": "https://github.com/OpenTermsArchive/pga-declarations.git"
-  },
-  "recorder": {
-    "versions": {
-      "storage": {
-        "git": {
-          "snapshotIdentiferTemplate": "https://github.com/OpenTermsArchive/pga-snapshots/commit/%SNAPSHOT_ID",
-          "repository": "git@github.com:OpenTermsArchive/pga-versions.git"
-        }
-      }
-    },
-    "snapshots": {
-      "storage": {
-        "git": {
-          "repository": "git@github.com:OpenTermsArchive/pga-snapshots.git"
-        }
-      }
-    }
-  },
-  "fetcher": {
-    "language": "en"
-  },
-  "notifier": {
-    "sendInBlue": {
-      "updatesListId": 855,
-      "updateTemplateId": 41
-    }
-  },
-  "tracker": {
-    "githubIssues": {
-      "repository": "OpenTermsArchive/pga-declarations"
-    }
-  },
-  "dataset": {
-    "title": "pga",
-    "versionsRepositoryURL": "https://github.com/OpenTermsArchive/pga-versions"
-  }
-}

package/config/vagrant.json

@@ -1,24 +0,0 @@
-{
-  "services": {
-    "repository": "https://github.com/OpenTermsArchive/contrib-declarations.git"
-  },
-  "recorder": {
-    "versions": {
-      "storage": {
-        "git": {
-          "repository": "git@github.com:OpenTermsArchive/sandbox-versions.git"
-        }
-      }
-    },
-    "snapshots": {
-      "storage": {
-        "git": {
-          "repository": "git@github.com:OpenTermsArchive/sandbox-snapshots.git"
-        }
-      }
-    }
-  },
-  "logger": {
-    "sendMailOnError": false
-  }
-}

package/src/archivist/services/documentTypes.json

@@ -1,386 +0,0 @@
-{
-  "Terms of Service": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "end user’s service usage"
-    }
-  },
-  "Privacy Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "end user’s personal data"
-    }
-  },
-  "Imprint": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "everyone",
-      "object": "identification of content author and hosting service for official inquiries"
-    }
-  },
-  "Trackers Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "all tracking technologies, including cookies, session storage, fingerprints…"
-    }
-  },
-  "Parent Organization Terms": {
-    "commitment": {
-      "writer": "parent organization",
-      "audience": "end user",
-      "object": "products and services usage"
-    }
-  },
-  "Parent Organization Privacy Policy": {
-    "commitment": {
-      "writer": "parent organization",
-      "audience": "end user",
-      "object": "personal data"
-    }
-  },
-  "Developer Terms": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "developer",
-      "object": "APIs and programmatic access to content"
-    }
-  },
-  "Community Guidelines": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "public behaviour"
-    }
-  },
-  "Community Guidelines - Self-harm": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "content depicting, encouraging or glorifying suicide, eating disorders, self-harm"
-    }
-  },
-  "Community Guidelines - Hate Speech": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "content or behavior that threatens, incites violence against, dehumanizes an individual or a group on the basis of protected attributes such as race, ethnicity, gender, sexual orientation…"
-    }
-  },
-  "Community Guidelines - Child Exploitation": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "material that features or promotes the exploitation of minors (sexual, emotional…)"
-    }
-  },
-  "Community Guidelines - Violence Incitement": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "content threatening, inciting or facilitating offline violence"
-    }
-  },
-  "Community Guidelines - Violent Organizations": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "accounts for individuals or groups that engage in or promote offline violence or organized criminal activity"
-    }
-  },
-  "Community Guidelines - Spam": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "untargeted, irrelevant, obviously unwanted, unauthorized commercial or promotional content"
-    }
-  },
-  "Community Guidelines - Platform Manipulation": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "everyone",
-      "object": "behaviour aimed at artificially amplifying or suppressing content visibility (fake engagement, inauthentic behaviour…)"
-    }
-  },
-  "Community Guidelines - Regulated Goods": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "everyone",
-      "object": "selling, buying, or facilitating transactions in illegal or regulated goods or services (drugs, medication, weapons…)"
-    }
-  },
-  "Community Guidelines - Harassment": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "content containing or engaging others to use abusive language, doxxing, intimidation against an individual"
-    }
-  },
-  "Community Guidelines - Privacy Violations": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "content containing or inciting sharing people's private information or media without their permission"
-    }
-  },
-  "Community Guidelines - Misinformation": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "demonstrably false or misleading information which may lead to physical harm, electoral processes disruption or other systemic harms"
-    }
-  },
-  "Community Guidelines - Adult Nudity": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "consensually produced and distributed media containing adult genitalia or nipples"
-    }
-  },
-  "Community Guidelines - Sexual Solicitation": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "expressions of desire, requests for a romantic or sexual relationship"
-    }
-  },
-  "Community Guidelines - Intellectual Property": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "content-publishing user",
-      "object": "content containing copyrighted works"
-    }
-  },
-  "Deceased Users": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "relatives of a deceased user",
-      "object": "handling of information of a deceased individual"
-    }
-  },
-  "Acceptable Use Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "acceptable and unacceptable usage"
-    }
-  },
-  "Restricted Use Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "restrictions on specific usage"
-    }
-  },
-  "Commercial Terms": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "commercial partners, content creators in a platform",
-      "object": "business or commercial usage"
-    }
-  },
-  "Copyright Claims Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "copyrighted works rights holders",
-      "object": "how copyright complaints (DMCA…) will be handled"
-    }
-  },
-  "Law Enforcement Guidelines": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "law enforcement authorities",
-      "object": "account records access"
-    }
-  },
-  "Human Rights Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "shareholders",
-      "object": "human rights"
-    }
-  },
-  "In-App Purchases Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "in-app and other virtual goods purchase usage"
-    }
-  },
-  "Review Guidelines": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "developer",
-      "object": "review process of provided content"
-    }
-  },
-  "Brand Guidelines": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "developer",
-      "object": "usage of the service provider’s brand"
-    }
-  },
-  "Quality Guidelines": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "quality of content produced by means of the service"
-    }
-  },
-  "Data Controller Agreement": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "data controllers (in the sense of GDPR)",
-      "object": "end user personal data"
-    }
-  },
-  "Data Processor Agreement": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "data controllers (in the sense of GDPR)",
-      "object": "status of data processor (in the sense of GDPR) for the service provider"
-    }
-  },
-  "User Consent Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "data controllers (in the sense of GDPR)",
-      "object": "user consent collection and storage"
-    }
-  },
-  "Closed Captioning Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "closed captioning on streamed content"
-    }
-  },
-  "Seller Warranty": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "protection of end users that act as sellers"
-    }
-  },
-  "Single Sign-On Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "connecting user account to other services"
-    }
-  },
-  "Vulnerability Disclosure Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "vulnerability reporter",
-      "object": "how to report a security vulnerability or issue"
-    }
-  },
-  "Live Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "end user’s live service usage"
-    }
-  },
-  "Ad Publishing Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "end user",
-      "object": "acceptable and unacceptable usage"
-    }
-  },
-  "Complaints Policy": {
-    "commitment": {
-      "writer": "service provider",
-      "audience": "anyone",
-      "object": "how generic complaints will be handled"
-    }
-  },
-  "Conditions of Carriage": {
-    "commitment": {
-      "writer": "transportation operator (airline, railway, bus…)",
-      "audience": "passenger",
-      "object": "benefits and limitations associated with the transportation being provided"
-    }
-  },
-  "General Conditions of Sale": {
-    "commitment": {
-      "writer": "paid-for goods or service provider",
-      "audience": "buyer",
-      "object": "warranty, delivery, return of goods or services bought through a monetary transaction"
-    }
-  },
-  "Marketplace Buyers Conditions": {
-    "commitment": {
-      "writer": "online marketplace",
-      "audience": "buyer",
-      "object": "buying through a monetary transaction goods or services offered by sellers other than the marketplace itself"
-    }
-  },
-  "Marketplace Sellers Conditions": {
-    "commitment": {
-      "writer": "online marketplace",
-      "audience": "seller",
-      "object": "selling through a monetary transaction goods or services to buyers other than the marketplace itself"
-    }
-  },
-  "Ranking Parameters Description": {
-    "commitment": {
-      "writer": "search engine or intermediation service provider",
-      "audience": "users presented with a list of ranked results, or contributors of results that are ranked",
-      "object": "parameters determining ranking and the reasons for their relative importance"
-    },
-    "references": {
-      "Open Terms Archive Discussion": "https://github.com/ambanum/OpenTermsArchive/discussions/902",
-      "Article 5 of P2B Regulation 2019/1150": "https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex%3A32019R1150#d1e868-57-1",
-      "Article 6a of Directive 2011/83/EU": "https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A02011L0083-20220528#tocId12",
-      "Point (m) of Article 2(1) of Directive 2005/29/EC": "https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02005L0029-20220528#tocId5"
-    }
-  },
-  "Premium Partner Conditions": {
-    "commitment": {
-      "writer": "intermediation service provider",
-      "audience": "sellers of goods or services",
-      "object": "eligibility criteria, limitations and benefits of a privileged seller status programme"
-    },
-    "references": {
-      "Open Terms Archive Discussion": "https://github.com/ambanum/OpenTermsArchive/discussions/922"
-    }
-  },
-  "Platform to Business Notice": {
-    "commitment": {
-      "writer": "search engine or intermediation service provider",
-      "audience": "business user",
-      "object": "complaints handling, mediation, transparency and other rights and information mandated by the P2B regulation"
-    },
-    "references": {
-      "Open Terms Archive Discussion": "https://github.com/ambanum/OpenTermsArchive/discussions/940",
-      "P2B Regulation 2019/1150": "https://eur-lex.europa.eu/eli/reg/2019/1150/oj"
-    }
-  },
-  "Business Mediation Policy": {
-    "commitment": {
-      "writer": "intermediation service provider",
-      "audience": "business users",
-      "object": "eligibility and process of mediation after internal complaints handling failed"
-    },
-    "references": {
-      "Open Terms Archive discussion": "https://github.com/ambanum/OpenTermsArchive/discussions/933",
-      "P2B Regulation 2019/1150, Article 12": "https://eur-lex.europa.eu/eli/reg/2019/1150/oj#d1e1148-57-1"
-    }
-  },
-  "Business Privacy Policy": {
-    "commitment": {
-      "writer": "intermediation service provider",
-      "audience": "business user",
-      "object": "personal data of business users and of people acting on their behalf"
-    },
-    "references": {
-      "Open Terms Archive discussion": "https://github.com/ambanum/OpenTermsArchive/discussions/923"
-    }
-  }
-}