@mherod/get-cookie 4.1.0 → 4.2.2

package/.env.example

@@ -0,0 +1,5 @@
+# Logging
+LOG_LEVEL=info # Set to 'debug' for verbose logging
+
+# System Paths
+# HOME=/path/to/home # Uncomment to override system HOME directory

package/.husky/commit-msg

@@ -1,2 +1,6 @@
-#!/bin/sh
-npx --no -- commitlint --edit ${1}
+# Try pnpm first, fallback to npx if pnpm not found
+if command -v pnpm >/dev/null 2>&1; then
+  pnpm exec commitlint --edit ${1}
+else
+  npx --no -- commitlint --edit ${1}
+fi

package/.husky/pre-commit

@@ -1,4 +1,6 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-pnpm lint-staged
+# Try pnpm first, fallback to npx if pnpm not found
+if command -v pnpm >/dev/null 2>&1; then
+  pnpm lint-staged
+else
+  npx --no -- lint-staged
+fi

package/.husky/pre-push

@@ -1,4 +1,6 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-pnpm run type-check && pnpm run test
+# Try pnpm first, fallback to npx if pnpm not found
+if command -v pnpm >/dev/null 2>&1; then
+  pnpm run validate
+else
+  npm run validate
+fi

package/README.md

@@ -1,151 +1,101 @@
 # get-cookie 🍪
 
-## What is it? 🤔
+Tired of manually copying cookies for API testing? `get-cookie` extracts authentication cookies directly from Chrome, Firefox, and Safari - perfect for testing, debugging, and automation.
 
-get-cookie is a powerful command-line utility and Node.js module that allows you to securely retrieve browser cookies from your locally installed browsers. Perfect for:
+## Quick Start 🚀
 
-- 🔐 Testing authenticated web applications
-- 🔍 Debugging cookie-related issues
-- 🤖 Automating browser cookie extraction
-- 🧪 Integration testing with real browser cookies
-
-## Documentation 📚
-
-Visit our [comprehensive documentation](https://mherod.github.io/get-cookie/) for:
-
-- Detailed API reference
-- Getting started guides
-- Advanced usage examples
-- TypeScript type definitions
-
-## Features ✨
-
-- 🌐 **Multi-Browser Support**: Works with Chrome, Firefox, and Safari
-- 🔒 **Secure**: Safe cookie extraction with proper encryption handling
-- 📝 **TypeScript Ready**: Built with TypeScript for excellent type safety
-- 🎯 **Flexible Querying**: Search by name, domain, or URL pattern
-- 🔄 **Multiple Output Formats**: JSON, rendered, or grouped results
-- 👥 **Profile Support**: Query cookies from different browser profiles
-
-## Installation 📦
+```bash
+# Install globally
+pnpm add -g @mherod/get-cookie
 
-Install from npm registry using your preferred package manager:
+# Get a cookie
+get-cookie auth example.com
 
-```bash
-# Using pnpm (recommended)
-pnpm add @mherod/get-cookie
+# Get all cookies for a domain
+get-cookie % example.com
+```
 
-# Using npm
-npm install @mherod/get-cookie
+```typescript
+// Node.js usage
+import { getCookie } from "@mherod/get-cookie";
 
-# Using yarn
-yarn add @mherod/get-cookie
+const cookies = await getCookie({
+  name: "auth",
+  domain: "example.com",
+});
 ```
 
-For global installation:
+⚠️ **Platform Support**:
 
-```bash
-# Using pnpm (recommended)
-pnpm add -g @mherod/get-cookie
+- Chrome: macOS only
+- Firefox: macOS and Linux
+- Safari: macOS only
 
-# Using npm
-npm install -g @mherod/get-cookie
+## Installation 📦
 
-# Using yarn
-yarn global add @mherod/get-cookie
+```bash
+pnpm add @mherod/get-cookie    # recommended
+npm install @mherod/get-cookie # or npm
+yarn add @mherod/get-cookie    # or yarn
 ```
 
-**Note: Currently only macOS is supported. Windows support is planned for a future release.** 🚧
+## Common Use Cases 🎯
 
-## How do I use it? 🚀
+- 🔐 Get auth cookies for API testing
+- 🔍 Debug cookie issues across browsers
+- 🤖 Automate cookie extraction
+- 🧪 Use real cookies in integration tests
 
-### CLI Usage 💻
+## Basic Usage Examples 💡
 
-Basic cookie retrieval:
+### CLI
 
 ```bash
-# Get a specific cookie
+# Get specific cookie
 get-cookie auth example.com
 
-# Get all cookies for a domain
-get-cookie % example.com
-
-# Get cookies with output formatting
+# Pretty print
 get-cookie auth example.com --render
-get-cookie auth example.com --dump-grouped
 
-# Get cookies from a specific URL
+# From URL
 get-cookie --url https://example.com/path
 ```
 
-### Node.js Module Usage 📚
-
-Basic usage:
-
-```typescript
-import { getCookie } from "@mherod/get-cookie";
-
-// Get a specific cookie
-const authCookies = await getCookie({
-  name: "auth",
-  domain: "example.com",
-});
-
-// Get all cookies for a domain
-const allCookies = await getCookie({
-  name: "%",
-  domain: "example.com",
-});
-
-// Get cookies from multiple specifications
-import { comboQueryCookieSpec } from "@mherod/get-cookie";
-
-const cookies = await comboQueryCookieSpec(
-  [
-    { name: "session", domain: "api.example.com" },
-    { name: "auth", domain: "auth.example.com" },
-  ],
-  {
-    removeExpired: true,
-    limit: 10,
-  },
-);
-```
-
-### Advanced Usage 🔧
-
-Using browser-specific strategies:
+### Node.js
 
 ```typescript
-import {
-  ChromeCookieQueryStrategy,
-  FirefoxCookieQueryStrategy,
-} from "@mherod/get-cookie";
-
-// Query Chrome cookies
-const chromeStrategy = new ChromeCookieQueryStrategy();
-const chromeCookies = await chromeStrategy.queryCookies(
-  "sessionId",
-  "example.com",
-);
-
-// Query Firefox cookies
-const firefoxStrategy = new FirefoxCookieQueryStrategy();
-const firefoxCookies = await firefoxStrategy.queryCookies(
-  "auth",
-  "example.com",
-);
+import { getCookie, type CookieSpec } from "@mherod/get-cookie";
+
+try {
+  // Get specific cookie
+  const authCookie = await getCookie({
+    name: "auth",
+    domain: "example.com",
+  });
+
+  // Get multiple cookies
+  const cookies = await getCookie({
+    name: "%", // all cookies
+    domain: "example.com",
+  });
+} catch (error) {
+  console.error("Failed:", error);
+}
 ```
 
-Using URL-based cookie extraction:
+## Features ✨
 
-```typescript
-import { cookieSpecsFromUrl } from "@mherod/get-cookie";
+- 🌐 **Multi-Browser Support**:
+  - Chrome (macOS)
+  - Firefox (macOS, Linux)
+  - Safari (macOS)
+- 🔒 **Secure**: Browser-specific encryption handling
+- 📝 **TypeScript Ready**: Full type safety with exported type definitions
+- 🎯 **Flexible Querying**: Search by name, domain, or use wildcards
+- 🔄 **Multiple Output Formats**: JSON, rendered, or grouped results
+- 👥 **Profile Support**: Chrome and Firefox multi-profile support
 
-// Get all cookies needed for a specific URL
-const specs = cookieSpecsFromUrl("https://example.com/dashboard");
-const cookies = await comboQueryCookieSpec(specs);
-```
+⚠️ **Note: Platform support varies by browser. See our [Platform Support Guide](https://mherod.github.io/get-cookie/guide/platform-support.html) for details.**
 
 ## Output Formats 📊
 
@@ -165,6 +115,15 @@ get-cookie auth example.com --render
 get-cookie auth example.com --dump-grouped
 ```
 
+## Documentation 📚
+
+Full docs at [mherod.github.io/get-cookie](https://mherod.github.io/get-cookie/)
+
+- API Reference
+- Advanced Usage
+- TypeScript Types
+- [Security Guide](https://mherod.github.io/get-cookie/guide/security.html) ⚠️
+
 ## Contributing 🤝
 
 Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
@@ -173,6 +132,6 @@ Contributions are welcome! Please feel free to submit a Pull Request. For major
 
 This project is licensed under the MIT License - see the LICENSE file for details.
 
-## Security 🛡️
+## Known Limitations 🚧
 
-This tool handles sensitive data (cookies). Always be careful when extracting and storing cookie information. Never share your cookies or use this tool on untrusted machines.
+For a comprehensive list of limitations and known issues, please see our [Known Limitations Guide](https://mherod.github.io/get-cookie/guide/limitations.html).