probably-china 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-PRESENT Mu-Tsun Tsai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+
+# probably-china
+
+> A lucky guess that we are probably in China or facing a Chinese user.
+
+This is a simple package for the browser environment that makes a quick guess
+to see if the current webpage is running in China, or if the user is from China,
+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.

package/index.d.ts

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

package/index.js

@@ -0,0 +1,14 @@
+
+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;

package/package.json

@@ -0,0 +1,13 @@
+{
+	"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"
+}