@mherod/get-cookie 4.4.3 → 4.5.0

package/biome.json

@@ -1,117 +0,0 @@
-{
-  "$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
-  "vcs": {
-    "enabled": true,
-    "clientKind": "git",
-    "useIgnoreFile": true,
-    "defaultBranch": "main"
-  },
-  "files": {
-    "ignoreUnknown": false,
-    "includes": [
-      "**",
-      "!**/dist/**",
-      "!**/node_modules/**",
-      "!**/coverage/**",
-      "!**/docs/.vitepress/cache/**",
-      "!**/*.log",
-      "!**/.parcel-cache/**"
-    ]
-  },
-  "formatter": {
-    "enabled": true,
-    "useEditorconfig": true,
-    "formatWithErrors": false,
-    "indentStyle": "space",
-    "indentWidth": 2,
-    "lineEnding": "lf",
-    "lineWidth": 80,
-    "attributePosition": "auto",
-    "bracketSpacing": true
-  },
-  "assist": { "actions": { "source": { "organizeImports": "off" } } },
-  "linter": {
-    "enabled": true,
-    "rules": {
-      "recommended": true,
-      "correctness": {
-        "noUnusedImports": "error",
-        "noUnusedVariables": "error"
-      },
-      "style": {
-        "useImportType": "error",
-        "noNamespace": "error",
-        "noNonNullAssertion": "error",
-        "useAsConstAssertion": "error",
-        "useBlockStatements": "error",
-        "useConst": "error",
-        "useLiteralEnumMembers": "error",
-        "noParameterAssign": "error",
-        "useDefaultParameterLast": "error",
-        "useEnumInitializers": "error",
-        "useSelfClosingElements": "error",
-        "useSingleVarDeclarator": "error",
-        "noUnusedTemplateLiteral": "error",
-        "useNumberNamespace": "error",
-        "noInferrableTypes": "error",
-        "noUselessElse": "error",
-        "useArrayLiterals": "off"
-      },
-      "complexity": {
-        "noStaticOnlyClass": "error",
-        "noUselessCatch": "error",
-        "noUselessConstructor": "error",
-        "noUselessTypeConstraint": "error",
-        "useOptionalChain": "error"
-      },
-      "suspicious": {
-        "noConfusingVoidType": "error",
-        "noDoubleEquals": "error",
-        "noExplicitAny": "error",
-        "noExtraNonNullAssertion": "error",
-        "noMisleadingInstantiator": "error",
-        "noPrototypeBuiltins": "error",
-        "noUnsafeDeclarationMerging": "error",
-        "useAwait": "off",
-        "useNamespaceKeyword": "error",
-        "noAsyncPromiseExecutor": "error",
-        "noMisleadingCharacterClass": "error",
-        "noThenProperty": "error",
-        "noVar": "error"
-      },
-      "nursery": {
-        "useSortedClasses": "off"
-      }
-    }
-  },
-  "javascript": {
-    "formatter": {
-      "jsxQuoteStyle": "double",
-      "quoteProperties": "asNeeded",
-      "trailingCommas": "all",
-      "semicolons": "always",
-      "arrowParentheses": "always",
-      "bracketSameLine": false,
-      "quoteStyle": "double",
-      "attributePosition": "auto",
-      "bracketSpacing": true
-    },
-    "globals": ["exports"]
-  },
-  "overrides": [
-    {
-      "includes": ["**/.prettierrc/**", "**/.parcelrc/**"],
-      "formatter": { "indentWidth": 2 }
-    },
-    {
-      "includes": ["**/*.test.ts", "**/*.spec.ts", "**/BinaryCodable*.ts"],
-      "linter": {
-        "rules": {
-          "style": {
-            "noNonNullAssertion": "off"
-          }
-        }
-      }
-    }
-  ]
-}

package/commitlint.config.js

@@ -1,12 +0,0 @@
-export default {
-  extends: ["@commitlint/config-conventional"],
-  rules: {
-    "body-max-line-length": [2, "always", 100],
-    "header-max-length": [2, "always", 72],
-    "subject-case": [
-      2,
-      "never",
-      ["sentence-case", "start-case", "pascal-case", "upper-case"],
-    ],
-  },
-};

package/eslint.config.js

@@ -1,255 +0,0 @@
-import tsPlugin from "@typescript-eslint/eslint-plugin";
-import tsParser from "@typescript-eslint/parser";
-import importPlugin from "eslint-plugin-import";
-import jsdocPlugin from "eslint-plugin-jsdoc";
-import globals from "globals";
-
-export default [
-  {
-    ignores: [
-      "dist/**/*",
-      "node_modules/**/*",
-      "coverage/**/*",
-      "docs/.vitepress/cache/**/*",
-    ],
-  },
-  {
-    files: ["**/*.js", "**/*.mjs"],
-    languageOptions: {
-      ecmaVersion: "latest",
-      sourceType: "module",
-      globals: {
-        ...globals.node,
-      },
-    },
-  },
-  {
-    files: ["**/*.ts"],
-    languageOptions: {
-      parser: tsParser,
-      parserOptions: {
-        ecmaVersion: "latest",
-        sourceType: "module",
-        project: ["./tsconfig.json", "./tsconfig.build.json"],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      globals: {
-        ...globals.node,
-        ...globals.es2022,
-      },
-    },
-    plugins: {
-      "@typescript-eslint": tsPlugin,
-      import: importPlugin,
-      jsdoc: jsdocPlugin,
-    },
-    rules: {
-      ...tsPlugin.configs.recommended.rules,
-      ...tsPlugin.configs["recommended-requiring-type-checking"].rules,
-      ...tsPlugin.configs.strict.rules,
-      ...importPlugin.configs.typescript.rules,
-      ...jsdocPlugin.configs["recommended-typescript"].rules,
-      "@typescript-eslint/explicit-function-return-type": [
-        "error",
-        {
-          allowExpressions: true,
-          allowTypedFunctionExpressions: true,
-        },
-      ],
-      "@typescript-eslint/no-explicit-any": "error",
-      "@typescript-eslint/explicit-member-accessibility": [
-        "error",
-        {
-          accessibility: "explicit",
-        },
-      ],
-      "@typescript-eslint/no-floating-promises": "error",
-      "@typescript-eslint/no-misused-promises": [
-        "error",
-        {
-          checksVoidReturn: {
-            arguments: false,
-            attributes: false,
-            properties: false,
-            returns: true,
-            variables: true,
-          },
-          checksConditionals: true,
-        },
-      ],
-      "@typescript-eslint/await-thenable": "error",
-      "@typescript-eslint/require-await": "error",
-      "@typescript-eslint/promise-function-async": "error",
-      "@typescript-eslint/prefer-promise-reject-errors": "error",
-      "@typescript-eslint/prefer-nullish-coalescing": "error",
-      "@typescript-eslint/prefer-optional-chain": "error",
-      "@typescript-eslint/strict-boolean-expressions": "error",
-      "@typescript-eslint/no-unnecessary-condition": "error",
-      "@typescript-eslint/no-unsafe-assignment": "error",
-      "@typescript-eslint/no-unsafe-return": "error",
-      "@typescript-eslint/no-unsafe-member-access": "error",
-      "@typescript-eslint/no-unsafe-call": "error",
-      "@typescript-eslint/no-unsafe-argument": "error",
-      "@typescript-eslint/no-unsafe-enum-comparison": "error",
-      "@typescript-eslint/prefer-readonly": "error",
-      "import/order": [
-        "error",
-        {
-          groups: [
-            "builtin",
-            "external",
-            "internal",
-            "parent",
-            "sibling",
-            "index",
-          ],
-          pathGroups: [
-            {
-              pattern: "@core/**",
-              group: "internal",
-            },
-            {
-              pattern: "@utils/**",
-              group: "internal",
-            },
-            {
-              pattern: "@/**",
-              group: "internal",
-            },
-          ],
-          pathGroupsExcludedImportTypes: ["builtin"],
-          "newlines-between": "always",
-          alphabetize: { order: "asc", caseInsensitive: true },
-        },
-      ],
-      "import/newline-after-import": "error",
-      "no-prototype-builtins": "error",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          argsIgnorePattern: "^_",
-          varsIgnorePattern: "^_",
-          destructuredArrayIgnorePattern: "^_",
-          caughtErrorsIgnorePattern: "^_",
-        },
-      ],
-      "no-useless-catch": "error",
-      "@typescript-eslint/ban-ts-comment": [
-        "error",
-        {
-          "ts-expect-error": "allow-with-description",
-          "ts-ignore": false,
-          "ts-nocheck": false,
-          "ts-check": false,
-          minimumDescriptionLength: 10,
-        },
-      ],
-      "jsdoc/require-jsdoc": [
-        "error",
-        {
-          publicOnly: true,
-          require: {
-            ArrowFunctionExpression: true,
-            ClassDeclaration: true,
-            ClassExpression: true,
-            FunctionDeclaration: true,
-            MethodDefinition: true,
-          },
-          contexts: [
-            "ExportDefaultDeclaration",
-            "ExportNamedDeclaration",
-            "TSInterfaceDeclaration",
-            "TSTypeAliasDeclaration",
-            "TSEnumDeclaration",
-            "PropertyDefinition",
-          ],
-        },
-      ],
-      "jsdoc/require-description": [
-        "error",
-        {
-          contexts: ["any"],
-          checkConstructors: true,
-          checkGetters: true,
-          checkSetters: true,
-          exemptedBy: ["internal", "private", "test"],
-        },
-      ],
-      "jsdoc/require-description-complete-sentence": "off",
-      "jsdoc/check-line-alignment": "error",
-      "jsdoc/check-syntax": "error",
-      "jsdoc/check-values": "error",
-      "jsdoc/check-types": "error",
-      "jsdoc/check-property-names": "error",
-      "jsdoc/check-indentation": "error",
-      "jsdoc/multiline-blocks": "error",
-      "jsdoc/require-hyphen-before-param-description": "error",
-      "jsdoc/require-throws": "error",
-      "jsdoc/require-yields": "error",
-      "jsdoc/sort-tags": "error",
-      "jsdoc/check-examples": "off",
-      "jsdoc/require-example": "off",
-      "jsdoc/check-tag-names": [
-        "error",
-        {
-          definedTags: [
-            "remarks",
-            "internal",
-            "private",
-            "test",
-            "throws",
-            "yields",
-            "example",
-          ],
-        },
-      ],
-      "jsdoc/require-param-type": "off",
-      "jsdoc/require-returns-type": "off",
-      "jsdoc/require-property": "error",
-      "jsdoc/require-property-description": "error",
-      "jsdoc/require-property-name": "error",
-      "jsdoc/require-property-type": "off",
-      "jsdoc/require-returns": [
-        "error",
-        {
-          checkGetters: true,
-          checkConstructors: false,
-        },
-      ],
-      "jsdoc/check-param-names": [
-        "error",
-        {
-          checkRestProperty: true,
-          enableFixer: true,
-          allowExtraTrailingParamDocs: true,
-        },
-      ],
-      "jsdoc/require-param-description": "error",
-      "jsdoc/require-returns-description": "error",
-      eqeqeq: ["error", "always"],
-      "no-return-await": "error",
-      "prefer-const": "error",
-      "no-var": "error",
-      curly: ["error", "all"],
-      "max-depth": ["error", 3],
-      "max-lines-per-function": ["error", { max: 50 }],
-      complexity: ["error", 10],
-      "jsdoc/no-types": "off",
-    },
-  },
-  {
-    files: [
-      "**/__tests__/**",
-      "**/__mocks__/**",
-      "**/tests/**",
-      "**/utils/**",
-      "**/types/**",
-      "**/browsers/**",
-    ],
-    rules: {
-      "jsdoc/require-example": "off",
-      "jsdoc/require-description": "off",
-      "max-lines-per-function": ["error", { max: 100 }],
-    },
-  },
-];

package/examples/README.md

@@ -1,71 +0,0 @@
-# get-cookie Examples
-
-This directory contains example scripts demonstrating various ways to use get-cookie.
-
-## Shell Script Examples
-
-### Quick Start
-- **`quick-start.sh`**: Essential patterns for immediate use. Perfect for getting started quickly with basic cookie extraction and one-liner curl commands. Includes a reusable shell function for your `.bashrc/.zshrc`.
-
-### Comprehensive Guides
-- **`curl-integration.sh`**: Complete guide for using get-cookie with curl. Covers everything from basic single-cookie requests to complex multi-cookie authentication, POST requests, and cookie validation. Includes colored output and reusable functions.
-
-- **`github-auth.sh`**: Complete GitHub authentication reference. Demonstrates session cookie filtering, endpoint testing, private repository access patterns, and clarifies the difference between web and API authentication.
-
-- **`features-demo.sh`**: All CLI features in one place. Demonstrates profile listing and selection, cookie deduplication, expired cookie filtering, browser-specific extraction, and how to combine features.
-
-### Development Examples
-- **`cli-examples.sh`**: Basic reference for development. Shows how to use the command-line interface for common tasks using `pnpm tsx` for local development.
-
-## TypeScript/Node.js Examples
-
-- **`basic-usage.ts`**: Demonstrates basic Node.js module usage
-- **`advanced-usage.ts`**: Shows advanced usage with browser-specific strategies
-
-## Running the Examples
-
-### Shell Script Examples
-
-```bash
-# Make the script executable
-chmod +x quick-start.sh
-chmod +x curl-integration.sh
-chmod +x github-auth.sh
-chmod +x features-demo.sh
-
-# Run the examples
-./quick-start.sh          # Quick start guide
-./curl-integration.sh     # Comprehensive curl integration
-./github-auth.sh          # GitHub authentication patterns
-./features-demo.sh        # All CLI features
-```
-
-### Development Examples
-
-```bash
-# For cli-examples.sh (uses pnpm tsx)
-chmod +x cli-examples.sh
-./cli-examples.sh
-```
-
-### TypeScript Examples
-
-```bash
-# Install dependencies if you haven't already
-pnpm install
-
-# Run TypeScript examples
-ts-node basic-usage.ts
-ts-node advanced-usage.ts
-```
-
-## Example File Organization
-
-The examples are organized by use case:
-
-1. **Quick Start** → Start here for immediate practical patterns
-2. **curl Integration** → For HTTP/API automation workflows
-3. **GitHub Auth** → For GitHub-specific authentication scenarios
-4. **Features Demo** → For understanding all CLI capabilities
-
-Note: Make sure you have get-cookie installed either globally or as a project dependency before running the examples.

package/examples/advanced-usage.ts

@@ -1,56 +0,0 @@
-/**
- * @module
- * @internal
- */
-
-/**
- * @description
- * This example demonstrates advanced usage of the cookie retrieval functions.
- * It shows how to retrieve cookies using different patterns and filters.
- * @internal
- * @example
- * ```typescript
- * import { getCookie } from "@mherod/get-cookie";
- *
- * // Get all cookies for a domain
- * const cookies = await getCookie({
- *   name: "*",
- *   domain: "github.com"
- * });
- *
- * // Get specific cookies
- * const authCookie = await getCookie({
- *   name: "auth",
- *   domain: "api.github.com"
- * });
- * ```
- */
-
-import { getCookie } from "../src";
-
-/**
- * @description
- * Run advanced examples of cookie retrieval.
- * @internal
- * @returns A promise that resolves when all examples have completed.
- */
-export async function runAdvancedExamples(): Promise<void> {
-  // Example 1: Get a specific cookie by name and domain
-  const cookie = await getCookie({
-    name: "session",
-    domain: "github.com",
-  });
-
-  console.log("Example 1 - Specific cookie:", cookie);
-
-  // Example 2: Get all cookies for a domain using wildcard
-  const cookies = await getCookie({
-    name: "*",
-    domain: "github.com",
-  });
-
-  console.log("Example 2 - All domain cookies:", cookies);
-}
-
-// Execute the examples
-runAdvancedExamples().catch(console.error);

package/examples/auth-tokens.ts

@@ -1,143 +0,0 @@
-#!/usr/bin/env tsx
-/**
- * Example: Extracting authentication tokens from browser cookies
- * This demonstrates how to use get-cookie for extracting auth tokens
- * for API automation or testing purposes
- */
-
-import { getCookie } from "../src";
-
-interface AuthToken {
-  site: string;
-  tokenName: string;
-  value: string;
-  browser: string;
-  expiry: Date | string | number | null;
-}
-
-async function extractAuthTokens() {
-  console.log("🔐 Authentication Token Extraction Example\n");
-  console.log("=".repeat(50));
-
-  // Common authentication cookie patterns
-  const authPatterns = [
-    {
-      site: "github.com",
-      cookies: ["user_session", "_gh_sess", "dotcom_user"],
-    },
-    {
-      site: "google.com",
-      cookies: ["OSID", "SID", "HSID", "SSID", "APISID", "SAPISID"],
-    },
-    { site: "twitter.com", cookies: ["auth_token", "ct0", "kdt"] },
-    { site: "linkedin.com", cookies: ["li_at", "JSESSIONID"] },
-    { site: "stackoverflow.com", cookies: ["acct", "prov"] },
-  ];
-
-  const foundTokens: AuthToken[] = [];
-
-  for (const pattern of authPatterns) {
-    console.log(`\n🔍 Checking ${pattern.site}...`);
-
-    for (const cookieName of pattern.cookies) {
-      try {
-        const cookies = await getCookie({
-          name: cookieName,
-          domain: pattern.site,
-        });
-
-        if (cookies.length > 0) {
-          cookies.forEach((cookie) => {
-            foundTokens.push({
-              site: pattern.site,
-              tokenName: cookieName,
-              value: `${cookie.value.substring(0, 20)}...`, // Truncate for security
-              browser: cookie.meta?.browser || "Unknown",
-              expiry: cookie.expiry || null,
-            });
-
-            console.log(
-              `  ✓ Found ${cookieName} in ${cookie.meta?.browser || "Unknown"}`,
-            );
-          });
-        }
-      } catch (_error) {
-        // Cookie not found or error accessing
-      }
-    }
-  }
-
-  // Summary
-  console.log(`\n${"=".repeat(50)}`);
-  console.log("📊 Summary of Found Authentication Tokens\n");
-
-  if (foundTokens.length === 0) {
-    console.log(
-      "No authentication tokens found. Make sure you're logged into these sites.",
-    );
-  } else {
-    // Group by site
-    const bySite = foundTokens.reduce(
-      (acc, token) => {
-        if (!acc[token.site]) {
-          acc[token.site] = [];
-        }
-        acc[token.site]?.push(token);
-        return acc;
-      },
-      {} as Record<string, AuthToken[]>,
-    );
-
-    Object.entries(bySite).forEach(([site, tokens]) => {
-      console.log(`\n${site}:`);
-      tokens.forEach((token) => {
-        const expiryInfo =
-          token.expiry instanceof Date
-            ? `expires ${new Date(token.expiry).toLocaleDateString()}`
-            : token.expiry === "Infinity"
-              ? "session cookie"
-              : "unknown expiry";
-
-        console.log(`  • ${token.tokenName} (${token.browser}, ${expiryInfo})`);
-        console.log(`    Value: ${token.value}`);
-      });
-    });
-
-    // Security reminder
-    console.log("\n⚠️  Security Reminder:");
-    console.log("These are sensitive authentication tokens. Never:");
-    console.log("  - Share them publicly");
-    console.log("  - Commit them to version control");
-    console.log("  - Use them outside of their intended purpose");
-  }
-
-  // Example: Using tokens for API requests
-  console.log(`\n${"=".repeat(50)}`);
-  console.log("💡 Example: Using GitHub token for API request\n");
-
-  const githubSession = foundTokens.find(
-    (t) => t.site === "github.com" && t.tokenName === "user_session",
-  );
-
-  if (githubSession) {
-    console.log("To use this token with GitHub API:");
-    console.log("```javascript");
-    console.log(
-      "const response = await fetch('https://api.github.com/user', {",
-    );
-    console.log("  headers: {");
-    console.log("    'Cookie': `user_session=\\$\\{token\\}`,");
-    console.log("    'User-Agent': 'Your-App-Name'");
-    console.log("  }");
-    console.log("});");
-    console.log("```");
-    console.log("\nNote: Most modern APIs prefer OAuth tokens over cookies.");
-  } else {
-    console.log(
-      "No GitHub session found. Log into GitHub in your browser first.",
-    );
-  }
-}
-
-// Run the example
-extractAuthTokens().catch(console.error);

package/examples/basic-usage.ts

@@ -1,43 +0,0 @@
-/**
- * @module
- * @internal
- */
-
-/**
- * @description
- * This example demonstrates basic usage of the getCookie function.
- * It shows how to retrieve cookies from all supported browsers using a unified interface.
- * @internal
- * @example
- * ```typescript
- * import { getCookie } from "@mherod/get-cookie";
- *
- * // Get a cookie by name and domain
- * const cookie = await getCookie({
- *   name: "session",
- *   domain: "github.com"
- * });
- *
- * console.log(cookie);
- * ```
- */
-
-import { getCookie } from "@mherod/get-cookie";
-
-/**
- * @description
- * Basic example showing how to retrieve cookies from browsers.
- * @internal
- */
-async function main(): Promise<void> {
-  // Get all session cookies from github.com
-  const cookies = await getCookie({
-    name: "user_session",
-    domain: "github.com",
-  });
-
-  console.log("Found cookies:", cookies);
-}
-
-// Run the example
-void main();