probably-china 1.0.0 → 1.1.0

package/README.md

@@ -10,4 +10,18 @@ based on the available browser info. It currently uses two strategies:
 1. Check if the current browser favors simplified Chinese or related languages.
 2. Check if the current timezone is one of the Chinese timezones.
 
-The use case for this package is not to avoid showing information that are sensitive in China.
+The use case for this package is not to avoid showing information that are sensitive in China.
+
+## Usage
+
+Install the package:
+
+```bash
+pnpm add probably-china
+```
+
+And it exports a single boolean constant:
+
+```js
+import { probablyChina } from "probably-china";
+```

package/{index.d.ts → dist/index.d.ts}

@@ -1,7 +1,6 @@
-
-/**
- * A lucky guess that we are probably in China or facing a Chinese user.
- */
-export const probablyChina: boolean;
-
-export default probablyChina;
+/**
+ * A lucky guess that we are probably in China or facing a Chinese user.
+ */
+export declare const probablyChina: boolean;
+
+export default probablyChina;

package/dist/index.js

@@ -0,0 +1,37 @@
+
+const detectChinaLanguage = ["zh-CN", "zh-CHS", "zh-Hans", "zh-HK", "zh-MO"];
+const detectChinaTimeZone = ["Asia/Shanghai", "Asia/Urumqi", "Asia/Hong_Kong", "Asia/Macau"];
+
+function checkTimeZone() {
+	if(typeof Intl !== "undefined") {
+		const timeZone = new Intl.DateTimeFormat().resolvedOptions().timeZone;
+		return detectChinaTimeZone.indexOf(timeZone) >= 0;
+	} else {
+		// legacy browser
+		const str = new Date().toString();
+		return str.indexOf("\u4e2d") > 0 || str.indexOf("\u9999") > 0;
+	}
+}
+
+function checkChinaLanguages() {
+	if(navigator.languages) { // https://caniuse.com/mdn-api_navigator_languages
+		for(let i = 0; i < navigator.languages.length; i++) {
+			const l = navigator.languages[i];
+			// Some Taiwanese users might also have "zh-CN" in their language list.
+			// We use the following criteria to eliminate such false-positive,
+			// so that it returns false if "zh-TW" comes first in the language list.
+			if(l === "zh-TW") return false;
+			if(detectChinaLanguage.indexOf(l) >= 0) return true;
+		}
+		return false;
+	}
+	// legacy browser
+	return detectChinaLanguage.indexOf(navigator.language) >= 0;
+}
+
+/**
+ * A lucky guess that we are probably in China or facing a Chinese user.
+ */
+export const probablyChina = checkTimeZone() || checkChinaLanguages();
+
+export default probablyChina;

package/package.json

@@ -1,13 +1,23 @@
 {
-	"name": "probably-china",
-	"version": "1.0.0",
-	"description": "A lucky guess that we are probably in China or facing a Chinese user.",
-	"main": "index.js",
-	"types": "index.d.ts",
-	"keywords": [
-		"China"
-	],
-	"author": "Mu-Tsun Tsai <don.m.t.tsai@gmail.com> (https://github.com/MuTsunTsai)",
-	"repository": "github:MuTsunTsai/probably-china",
-	"license": "MIT"
-}
+  "name": "probably-china",
+  "version": "1.1.0",
+  "description": "A lucky guess that we are probably in China or facing a Chinese user.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "China"
+  ],
+  "author": "Mu-Tsun Tsai <don.m.t.tsai@gmail.com> (https://github.com/MuTsunTsai)",
+  "repository": "github:MuTsunTsai/probably-china",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "eslint": "^9.17.0",
+    "eslint-plugin-compat": "^6.0.2"
+  },
+  "scripts": {
+    "start": "pnpx http-server -o /test"
+  }
+}

package/index.js

@@ -1,14 +0,0 @@
-
-const detectChinaLanguage = ["zh-CN", "zh-CHS", "zh-Hans", "zh-HK", "zh-MO"];
-const detectChinaTimeZone = ["Asia/Shanghai", "Asia/Urumqi", "Asia/Hong_Kong", "Asia/Macau"];
-const timeZone = new Intl.DateTimeFormat().resolvedOptions().timeZone;
-
-/**
- * A lucky guess that we are probably in China or facing a Chinese user.
- */
-export const probablyChina =
-	detectChinaTimeZone.includes(timeZone) ||
-	detectChinaLanguage.includes(navigator.language) ||
-	navigator.languages.some(l => detectChinaLanguage.includes(l));
-
-export default probablyChina;