is-x-browser 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ryohidaka
+
+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,40 @@
+# is-x-browser
+
+[![CI](https://github.com/ryohidaka/is-x-browser/actions/workflows/ci.yml/badge.svg)](https://github.com/ryohidaka/is-x-browser/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+JavaScript library to detect if it's an X In-app browser
+
+## Installation
+
+```bash
+npm i is-x-browser
+```
+
+## Usage
+
+```typescript
+import isXBrowser from 'is-x-browser';
+
+if (isXBrowser()) {
+	console.log('Inside X browser');
+} else {
+	console.log('Regular browser');
+}
+```
+
+## Demo
+
+* [Demo](https://ryohidaka.github.io/is-x-browser/)
+
+| iOS App                                      | Android App                                      | Browser                                     |
+| -------------------------------------------- | ------------------------------------------------ | ------------------------------------------- |
+| <img src="./images/ios-app.jpg" width=500 /> | <img src="./images/android-app.png" width=500 /> | <img src="./images/normal.png" width=500 /> |
+
+## Contributing
+
+Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+/**
+* Detect X (Twitter) in-app browser.
+*
+* Checks `navigator.userAgent` and `document.referrer`.
+*
+* @returns {boolean} Return `true` if inside X WebView, otherwise `false`.
+*
+* @example
+* ```ts
+* import isXBrowser from 'is-x-browser'
+*
+* if (isXBrowser()) {
+*   console.log('Inside X browser')
+* } else {
+*   console.log('Regular browser')
+* }
+* ```
+*/
+declare function isXBrowser(): boolean;
+export { isXBrowser as default };

package/dist/index.js

@@ -0,0 +1,20 @@
+// src/index.ts
+function isXBrowser() {
+  try {
+    if (typeof navigator === "undefined" || typeof document === "undefined") {
+      console.error("navigator or document is not defined.");
+      return false;
+    }
+    const ua = navigator.userAgent;
+    const referer = document.referrer.toLowerCase();
+    const isUAWithX = /Twitter for i(Phone|Pad)|TwitterAndroid/i.test(ua);
+    const isRefererFromX = referer.includes("t.co");
+    return isUAWithX || isRefererFromX;
+  } catch (err) {
+    console.error("Error occurred while detecting X browser.", err);
+    return false;
+  }
+}
+export {
+  isXBrowser as default
+};

package/package.json

@@ -0,0 +1,67 @@
+{
+	"name": "is-x-browser",
+	"version": "0.1.0",
+	"description": "JavaScript library to detect if it's an X In-app browser",
+	"keywords": [
+		"twitter",
+		"x",
+		"browser",
+		"useragent",
+		"user-agent"
+	],
+	"homepage": "https://github.com/ryohidaka/is-x-browser#readme",
+	"bugs": {
+		"url": "https://github.com/ryohidaka/is-x-browser/issues"
+	},
+	"license": "MIT",
+	"files": [
+		"dist"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ryohidaka/is-x-browser.git"
+	},
+	"scripts": {
+		"build": "bunup",
+		"dev": "bunup --watch",
+		"postinstall": "bun simple-git-hooks",
+		"lint": "biome check .",
+		"lint:fix": "biome check --write .",
+		"release": "bumpp --commit --push --tag",
+		"test": "bun test",
+		"test:coverage": "bun test --coverage",
+		"test:watch": "bun test --watch",
+		"type-check": "tsc --noEmit"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.3.11",
+		"@types/bun": "^1.3.5",
+		"bumpp": "^10.3.2",
+		"bunup": "^0.16.17",
+		"simple-git-hooks": "^2.13.1",
+		"typescript": "^5.9.3"
+	},
+	"peerDependencies": {
+		"typescript": ">=4.5.0"
+	},
+	"peerDependenciesMeta": {
+		"typescript": {
+			"optional": true
+		}
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			}
+		},
+		"./package.json": "./package.json"
+	},
+	"module": "./dist/index.js",
+	"simple-git-hooks": {
+		"pre-commit": "bun run lint && bun run type-check"
+	},
+	"types": "./dist/index.d.ts"
+}