Update resource group definitions

Author: nikitaeverywhere

.gitignore

@@ -2,5 +2,5 @@
 /lib
 /types
 /node_modules
-/service-groups.json
+/resource-groups.json
 /tsconfig.tsbuildinfo

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "@dataunlocker/service-groups",
-  "version": "1.1.0",
-  "description": "Default service group definitions for DataUnlocker.",
+  "name": "@dataunlocker/resource-groups",
+  "version": "2.0.0",
+  "description": "Default resource group definitions for DataUnlocker.",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -10,25 +10,25 @@
     "lib",
     "!lib/**/*.test.js",
     "!lib/**/*.test.d.ts",
-    "service-groups.yml",
-    "service-groups.json"
+    "resource-groups.yml",
+    "resource-groups.json"
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dataunlocker/service-groups.git"
+    "url": "git+https://github.com/dataunlocker/resource-groups.git"
   },
   "bugs": {
-    "url": "https://github.com/dataunlocker/service-groups/issues"
+    "url": "https://github.com/dataunlocker/resource-groups/issues"
   },
-  "homepage": "https://github.com/dataunlocker/service-groups#readme",
+  "homepage": "https://github.com/dataunlocker/resource-groups#readme",
   "scripts": {
     "build": "tsc && tsc-alias && node ./bin/build.js",
     "test": "node ./bin/verify.js && node --test",
     "test:local": "npm run build && npm run test"
   },
   "keywords": [
     "dataunlocker",
-    "service",
+    "resource",
     "groups"
   ],
   "author": "DataUnlocker",

package.json

@@ -1,48 +1,30 @@
-# DataUnlocker service groups
+# DataUnlocker Resource Groups
 
-Default service group definitions for DataUnlocker.
+Resource group definitions for [DataUnlocker](https://www.dataunlocker.com).
 
-To simplify third-party proxy configuration (what to proxy and what not), DataUnlocker
-uses a concept of "Service Groups". DataUnlocker customers can specify whether to enable
-or disable DataUnlocker's proxy for the entire service group, instead of each individual
-service (domain).
+<img width="589" height="364" alt="Image" src="https://github.com/user-attachments/assets/ad6f883e-1f59-48ea-ae75-217be90ef1cd" />
 
-Each Service Group contains a list of services (domains) like `google.com`. Original service
-groups are defined in [service-groups.yml](./service-groups.yml) and are additionally
-exported as:
+To simplify third-party proxy configuration (what to proxy and what not), DataUnlocker uses a concept of [Resource Groups](https://docs.dataunlocker.com/setup/config/traffic).
+Website with DataUnlocker installed can specify whether to enable or disable DataUnlocker's proxy for the entire resource group, instead of each individual resource (domain).
 
-- `service-groups.yml`
-- `service-groups.json` (built within the package)
-- JavaScript bindings (see below)
-
-## Installation
-
-This package uses NodeJS 20+.
-
-```sh
-npm install @dataunlocker/service-groups
-```
-
-```ts
-import { getServiceGroupIdByDomain } from "@dataunlocker/service-groups";
+Each Resource Group contains a list of resources (domains suffixes) like `google.com`.
+Original resource groups are defined in [resource-groups.yml](./resource-groups.yml) and are additionally exported from this package as:
 
-getServiceGroupIdByDomain("google.com.ua"); // "google"
-getServiceGroupIdByDomain("googletagmanager.com"); // "google"
-```
+- `resource-groups.json` (built within the package)
+- JavaScript bindings (see below)
 
-## Syntax
+## Syntax and structure
 
 ```yaml
-service-id:
-  - service-name.com
-  - service-name.com.au
-  - service-name.io
+resource-name:
+  - resource-name.com
+  - resource-name.com.au
+  - resource-name.io
 ```
 
 ## Contributing
 
-Pull requests to [service-groups.yml](./service-groups.yml) are welcome. For anything more
-complex please create an issue.
+Pull requests to [resource-groups.yml](./resource-groups.yml) are welcome.
+For anything more complex please create an issue.
 
-DataUnlocker's infrastructure will gradually pick up service group definitions from this
-package after your contribution.
+DataUnlocker's infrastructure will gradually pick up resource group definitions from this package after your contribution.

readme.md

@@ -3,6 +3,9 @@ adroll:
   - adroll.com
   - adroll.mgr.consensu.org
 
+amazon:
+  - amazon-adsystem.com
+
 amplitude:
   - amplitude.com
 
@@ -11,17 +14,19 @@ cloudflare:
   - cdnjs.cloudflare.com
   - cloudflareinsights.com
 
+criteo:
+  - criteo.com
+  - criteo.net
+
 dataunlocker:
   - dataunlocker.com
   - defender
 
-meta:
-  - facebook.com
-  - facebook.net
-  - instagram.com
-  - fbcdn.net
-  - fbsbx.com
-  - cdninstagram.com
+fathom:
+  - fathom.com
+
+fullstory:
+  - fullstory.com
 
 google:
   - doubleclick.net
@@ -273,16 +278,45 @@ linkedin:
   - ads.linkedin.com
   - snap.licdn.com
 
+meta:
+  - facebook.com
+  - facebook.net
+  - instagram.com
+  - fbcdn.net
+  - fbsbx.com
+  - cdninstagram.com
+
 microsoft:
   - ajax.microsoft.com
-  - bat.bing.com
-  - c.bing.com
+  - bing.com
+  - bing.net
   - clarity.ms
 
 mixpanel:
   - mixpanel.com
   - mxpnl.com
 
+optimizely:
+  - optimizely.com
+  - optimizely.s3.amazonaws.com
+  - cdn-assets-prod.s3.amazonaws.com
+
+pinterest:
+  - pinterest.com
+
+plausible:
+  - plausible.io
+
+posthog:
+  - posthog.com
+
+quora:
+  - quora.com
+
+reddit:
+  - reddit.com # events.reddit.com
+  - redditstatic.com
+
 segment:
   - segment.io
   - segment.com
@@ -291,16 +325,26 @@ sentry:
   - sentry-cdn.com
   - sentry.io
 
+snapchat:
+  - snapchat.com
+  - sc-static.net
+
 tiktok:
-  - analytics.tiktok.com
+  - tiktok.com
+  - tiktokw.us
 
 vercel:
   - vercel-insights.com
 
+visualwebsiteoptimizer:
+  - visualwebsiteoptimizer.com
+  - vwo.com
+
 x:
   - ads-twitter.com
-  - twitter.com
+  - analytics.twitter.com
   - x.com
+  - t.co
 
 yandex:
   - yandex.az

service-groups.yml renamed to resource-groups.yml

@@ -1,25 +1,28 @@
-import { ServiceGroupsJson, ServiceGroupsReversedMap } from "@/types/index.js";
+import {
+  ResourceGroupsJson,
+  ResourceGroupsReversedMap,
+} from "@/types/index.js";
 import { readFileSync, writeFileSync } from "fs";
 import JSON5 from "json5";
 import { parse, stringify } from "yaml";
 
-const FILE_SOURCE_YML = "service-groups.yml";
-const FILE_SOURCE_JSON = "service-groups.json";
+const FILE_SOURCE_YML = "resource-groups.yml";
+const FILE_SOURCE_JSON = "resource-groups.json";
 const FILE_SOURCE_REVERSE_MAP = "./lib/_generated/map-reverse.js";
 const FILE_SOURCE_MAP = "./lib/_generated/map.js";
 
-export const source: ServiceGroupsJson = parse(
+export const source: ResourceGroupsJson = parse(
   readFileSync(FILE_SOURCE_YML).toString()
 );
 
-export const write = (json: ServiceGroupsJson) =>
+export const write = (json: ResourceGroupsJson) =>
   writeFileSync(FILE_SOURCE_YML, stringify(json));
-export const writeJson = (json: ServiceGroupsJson) =>
+export const writeJson = (json: ResourceGroupsJson) =>
   writeFileSync(FILE_SOURCE_JSON, JSON.stringify(json, null, 2));
 
-export const writeReverseMap = (json: ServiceGroupsJson) => {
+export const writeReverseMap = (json: ResourceGroupsJson) => {
   const serviceGroupIds: string[] = [];
-  const map: ServiceGroupsReversedMap = {};
+  const map: ResourceGroupsReversedMap = {};
 
   for (const serviceGroupId in json) {
     const serviceGroupIdKey = serviceGroupIds.length;
@@ -61,7 +64,7 @@ export const map = ${stringifiedMap};
   );
 };
 
-export const writeMap = (json: ServiceGroupsJson) => {
+export const writeMap = (json: ResourceGroupsJson) => {
   writeFileSync(
     FILE_SOURCE_MAP,
     `export const map = ${JSON5.stringify(json)};

src/bin/common.ts

@@ -1,6 +1,6 @@
 import { source } from "./common.js";
 
-// Verify the "google" service config is not missing domains officially announced by Google.
+// Verify the "google" resource config is not missing domains officially announced by Google.
 await (async () => {
   const googleDomainsRequest = await fetch(
     "https://www.google.com/supported_domains"
@@ -22,7 +22,7 @@ await (async () => {
   }
 })();
 
-// Verify no duplicates among service groups and inside a service group.
+// Verify no duplicates among resource groups and inside a resource group.
 await (async () => {
   const allServices = new Set();
 

src/bin/verify.ts

@@ -3,12 +3,12 @@
  * WARNING: this file is automatically generated and replaced on build.
  */
 
-import { ServiceGroupsReversedMap } from "@/types/index.js";
+import { ResourceGroupsReversedMap } from "@/types/index.js";
 
 /** Sample data will be overridden on build. */
 
 export const mapKeys = ["google"];
-export const map: ServiceGroupsReversedMap = {
+export const map: ResourceGroupsReversedMap = {
   com: {
     google: 0,
   },

src/lib/_generated/map-reverse.ts

@@ -3,10 +3,10 @@
  * WARNING: this file is automatically generated and replaced on build.
  */
 
-import { ServiceGroupsJson } from "@/types/index.js";
+import { ResourceGroupsJson } from "@/types/index.js";
 
 /** Sample data will be overridden on build. */
 
-export const map: ServiceGroupsJson = {
+export const map: ResourceGroupsJson = {
   google: ["google.com", "google.com.ua"],
 };

src/lib/_generated/map.ts

@@ -1,9 +1,9 @@
-import { ServiceGroupsJson } from "@/types/index.js";
+import { ResourceGroupsJson } from "@/types/index.js";
 import { map } from "./_generated/map.js";
 
 /** Returns a list of domains in a service group. */
 export const getDomainsByServiceGroupId = (serviceGroupId: string): string[] =>
   map[serviceGroupId] || [];
 
 /** Returns a map of service group ID to a list of domains of this service group. */
-export const getServiceGroupsMap = (): ServiceGroupsJson => map;
+export const getServiceGroupsMap = (): ResourceGroupsJson => map;