@mherod/get-cookie 2.1.2 → 4.0.1

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/core/cookies/dynamicImports.ts"],"sourcesContent":["import type { RenderOptions } from \"../../types/CookieRender\";\nimport type { CookieSpec } from \"../../types/CookieSpec\";\nimport type { ExportedCookie } from \"../../types/ExportedCookie\";\n\n/**\n * Dynamic import for the getCookie function.\n * @internal\n * @returns Promise resolving to the getCookie function\n * @example\n * ```typescript\n * const getCookieFn = await getCookie();\n * const cookies = await getCookieFn({ domain: 'example.com' });\n * // Returns: [{ name: 'sessionId', value: 'abc123', domain: 'example.com' }, ...]\n * ```\n */\nexport const getCookie = (): Promise<\n  (cookieSpec: CookieSpec) => Promise<ExportedCookie[]>\n> => import(\"./getCookie\").then((module) => module.getCookie);\n\n/**\n * Dynamic import for Chrome-specific cookie retrieval.\n * @internal\n * @returns Promise resolving to the getChromeCookie function\n * @example\n * ```typescript\n * const chromeCookieFn = await getChromeCookie();\n * const cookies = await chromeCookieFn({ domain: 'example.com', secure: true });\n * // Returns Chrome-format cookies: [{ name: 'auth', value: 'xyz789', secure: true }, ...]\n * ```\n */\nexport const getChromeCookie = (): Promise<\n  (cookieSpec: CookieSpec) => Promise<ExportedCookie[]>\n> => import(\"./getChromeCookie\").then((module) => module.getChromeCookie);\n\n/**\n * Dynamic import for Firefox-specific cookie retrieval.\n * @internal\n * @returns Promise resolving to the getFirefoxCookie function\n * @example\n * ```typescript\n * const firefoxCookieFn = await getFirefoxCookie();\n * const cookies = await firefoxCookieFn({ path: '/api' });\n * // Returns Firefox-format cookies: [{ name: 'token', value: 'def456', path: '/api' }, ...]\n * ```\n */\nexport const getFirefoxCookie = (): Promise<\n  (cookieSpec: CookieSpec) => Promise<ExportedCookie[]>\n> => import(\"./getFirefoxCookie\").then((module) => module.getFirefoxCookie);\n\n/**\n * Dynamic import for retrieving grouped and rendered cookies.\n * @internal\n * @returns Promise resolving to the getGroupedRenderedCookies function\n * @example\n * ```typescript\n * const groupedCookiesFn = await getGroupedRenderedCookies();\n * const cookieStrings = await groupedCookiesFn({ domain: 'example.com' });\n * // Returns: ['sessionId=abc123; Domain=example.com', 'auth=xyz789; Domain=example.com']\n * ```\n */\nexport const getGroupedRenderedCookies = (): Promise<\n  (cookieSpec: CookieSpec) => Promise<string[]>\n> =>\n  import(\"./getGroupedRenderedCookies\").then(\n    (module) => module.getGroupedRenderedCookies,\n  );\n\n/**\n * Dynamic import for retrieving merged and rendered cookies.\n * @internal\n * @returns Promise resolving to the getMergedRenderedCookies function\n * @example\n * ```typescript\n * const mergedCookiesFn = await getMergedRenderedCookies();\n * const cookieString = await mergedCookiesFn(\n *   { domain: 'example.com' },\n *   { separator: '; ' }\n * );\n * // Returns: \"sessionId=abc123; auth=xyz789\"\n * ```\n */\nexport const getMergedRenderedCookies = (): Promise<\n  (\n    cookieSpec: CookieSpec,\n    options?: Omit<RenderOptions, \"format\">,\n  ) => Promise<string>\n> =>\n  import(\"./getMergedRenderedCookies\").then(\n    (module) => module.getMergedRenderedCookies,\n  );\n"],"mappings":"4BAeO,IAAMA,EAAY,IAEpB,OAAO,yBAAa,EAAE,KAAMC,GAAWA,EAAO,SAAS,EAa/CC,EAAkB,IAE1B,OAAO,+BAAmB,EAAE,KAAMD,GAAWA,EAAO,eAAe,EAa3DE,EAAmB,IAE3B,OAAO,gCAAoB,EAAE,KAAMF,GAAWA,EAAO,gBAAgB,EAa7DG,EAA4B,IAGvC,OAAO,yCAA6B,EAAE,KACnCH,GAAWA,EAAO,yBACrB,EAgBWI,EAA2B,IAMtC,OAAO,wCAA4B,EAAE,KAClCJ,GAAWA,EAAO,wBACrB","names":["getCookie","module","getChromeCookie","getFirefoxCookie","getGroupedRenderedCookies","getMergedRenderedCookies"]}

package/eslint.config.js

@@ -0,0 +1,243 @@
+import tsParser from "@typescript-eslint/parser";
+import tsPlugin from "@typescript-eslint/eslint-plugin";
+import importPlugin from "eslint-plugin-import";
+import jsdocPlugin from "eslint-plugin-jsdoc";
+import globals from "globals";
+
+export default [
+  {
+    ignores: ["dist/**/*", "node_modules/**/*"],
+  },
+  {
+    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",
+      "@typescript-eslint/await-thenable": "error",
+      "@typescript-eslint/no-unnecessary-type-assertion": "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",
+      "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": [
+        "error",
+        {
+          contexts: [
+            "ExportDefaultDeclaration",
+            "ExportNamedDeclaration:not(TSTypeAliasDeclaration)",
+            "ExportNamedDeclaration:not(TSInterfaceDeclaration)",
+            "FunctionDeclaration",
+            "MethodDefinition",
+          ],
+          exemptedBy: ["internal", "private", "test"],
+          exemptNoArguments: true,
+          checkConstructors: true,
+          checkGetters: true,
+          checkSetters: true,
+        },
+      ],
+      "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,
+        },
+      ],
+      "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",
+    },
+  },
+];

package/jest.setup.js

@@ -0,0 +1,4 @@
+// Mock the logger
+jest.mock("@utils/logger");
+
+// Add any other global setup here 

package/package.json

@@ -1,56 +1,102 @@
 {
   "name": "@mherod/get-cookie",
-  "version": "2.1.2",
+  "version": "4.0.1",
   "description": "Node.js module for querying a local user's Chrome cookie",
+  "type": "module",
   "source": "src/index.ts",
-  "bin": "dist/cli.js",
+  "bin": "dist/cli/cli.js",
   "main": "dist/index.js",
-  "types": "dist/types.d.ts",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./cli": {
+      "types": "./dist/cli/cli.d.ts",
+      "import": "./dist/cli/cli.mjs",
+      "require": "./dist/cli/cli.js"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "clean": "git clean -fdX && rm -rf dist && yarn install",
-    "tsc": "tsc",
-    "build": "bun build src/index.ts --target=node --outdir=dist && bun build src/cli.ts --target=node --outdir=dist && tsc --emitDeclarationOnly",
-    "test": "jest",
-    "prepublish": "bun run build",
-    "install:global": "bun run build && npm install --global .",
-    "prettier": "prettier --write .",
-    "copy-files": "cp -r src/cli.js dist/cli.js && cp -r src/index.js dist/index.js && cp -r src/types.d.ts dist/types.d.ts"
-  },
   "engines": {
-    "node": ">= 16"
+    "node": "^20.0.0 || ^22.0.0"
   },
   "keywords": [],
   "author": "Matthew Herod",
   "license": "ISC",
   "dependencies": {
-    "consola": "3.2.3",
-    "cross-fetch": "^4.0.0",
-    "destr": "2.0.2",
-    "fast-glob": "^3.3.1",
-    "jsonwebtoken": "9.0.0",
+    "consola": "^3.3.3",
+    "destr": "^2.0.3",
+    "fast-glob": "^3.3.2",
+    "jsonwebtoken": "^9.0.2",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
-    "lru-cache": "^7.14.0",
-    "minimist": "^1.2.7",
-    "tough-cookie": "^4.1.2"
+    "lru-cache": "^11.0.2",
+    "minimist": "^1.2.8",
+    "tough-cookie": "^5.0.0",
+    "tsconfig-paths": "^4.2.0",
+    "zod": "^3.24.1"
   },
   "devDependencies": {
+    "@commitlint/cli": "19.6.1",
+    "@commitlint/config-conventional": "19.6.0",
     "@jest/globals": "^29.7.0",
-    "@types/bun": "^1.1.3",
-    "@types/jest": "^29.5.6",
-    "@types/jsonwebtoken": "^8.5.9",
-    "@types/lodash": "^4.14.186",
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^18.19.34",
-    "@types/tough-cookie": "^4.0.2",
-    "@types/user-agents": "^1.0.2",
+    "@types/better-sqlite3": "^7.6.12",
+    "@types/jest": "^29.5.14",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/lodash": "^4.17.13",
+    "@types/minimist": "^1.2.5",
+    "@types/node": "^22.10.4",
+    "@types/tough-cookie": "^4.0.5",
+    "@typescript-eslint/eslint-plugin": "^8.19.0",
+    "@typescript-eslint/parser": "^8.19.0",
+    "better-sqlite3": "^11.7.0",
+    "eslint": "^9.17.0",
+    "eslint-formatter-codeframe": "^7.32.1",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jsdoc": "^50.6.1",
+    "globals": "15.14.0",
+    "husky": "^9.1.7",
     "jest": "^29.7.0",
-    "prettier": "^3.0.3",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "lint-staged": "^15.3.0",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.10",
+    "tsup": "^8.3.5",
+    "tsx": "4.19.2",
+    "typedoc": "^0.27.6",
+    "typedoc-plugin-markdown": "^4.4.1",
+    "typescript": "^5.7.2",
+    "vitepress": "^1.5.0"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --fix --format=codeframe",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "scripts": {
+    "clean": "rm -rf dist node_modules && pnpm install",
+    "build": "tsup src/index.ts src/cli/cli.ts --format cjs,esm --dts --clean --sourcemap --minify",
+    "test": "jest",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint . --format=codeframe",
+    "lint:fix": "eslint . --format=codeframe --fix",
+    "validate": "pnpm run type-check && pnpm run lint && pnpm run test",
+    "format": "prettier --write .",
+    "dev": "tsc -w -p tsconfig.json & tsc-alias -w -p tsconfig.json",
+    "read-github": "NODE_OPTIONS=\"-r tsconfig-paths/register\" tsx scripts/readGithubCookies.ts",
+    "docs": "typedoc && ./scripts/fix-typedoc.sh && vitepress build docs",
+    "docs:dev": "vitepress dev docs",
+    "docs:preview": "vitepress preview docs"
   }
-}
+}

package/tsconfig.build.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["build-indexes.ts", "jest.config.ts"],
+  "exclude": ["node_modules", "dist"]
+} 

package/typedoc.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": [
+    "src/index.ts",
+    "src/cli/cli.ts",
+    "src/types/ExportedCookie.ts",
+    "src/types/CookieSpec.ts",
+    "src/types/CookieRender.ts"
+  ],
+  "out": "docs/reference",
+  "plugin": ["typedoc-plugin-markdown"],
+  "readme": "none",
+  "cleanOutputDir": true,
+  "githubPages": false,
+  "hideBreadcrumbs": true,
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeExternals": true,
+  "includeVersion": true,
+  "categorizeByGroup": true,
+  "categoryOrder": ["Core", "Browsers", "CLI", "*"]
+}

package/.parcelrc

@@ -1,7 +0,0 @@
-{
-  "extends": "@parcel/config-default",
-  "transformers": {
-    "*.{ts,tsx}": ["@parcel/transformer-typescript-tsc", "..."],
-    "*": ["..."]
-  }
-}

package/.prettierignore

@@ -1,5 +0,0 @@
-.idea/**/workspace.xml
-*.log
-node_modules/
-.parcel-cache
-dist

package/.prettierrc

@@ -1,12 +0,0 @@
-{
-  "useTabs": false,
-  "overrides": [
-    {
-      "files": [".prettierrc", ".parcelrc"],
-      "options": {
-        "parser": "json",
-        "tabWidth": 2
-      }
-    }
-  ]
-}

package/.terserrc

@@ -1,26 +0,0 @@
-{
-  "toplevel": true,
-  "keep_fnames": true,
-  "keep_classnames": true,
-  "parse": {
-    "bare_returns": true,
-    "html5_comments": true,
-    "shebang": true,
-  },
-  "compress": {
-    "drop_console": false,
-    "toplevel": true,
-    "evaluate": true,
-    "passes": 3,
-    "keep_fnames": true,
-    "keep_classnames": true,
-    "hoist_funs": true,
-  },
-  "mangle": {
-    "toplevel": true,
-  },
-  "format": {
-    "comments": false,
-    "beautify": false,
-  }
-}

package/build-indexes.ts

@@ -1,108 +0,0 @@
-//#!/usr/bin/env bun run
-
-import consola from "consola";
-import { groupBy, orderBy } from "lodash";
-import path from "path";
-import { existsSync, readFileSync, writeFileSync } from "fs";
-import { sync } from "fast-glob";
-import prettier from "prettier";
-
-async function main() {
-  // find all ts files in src and build indexes
-
-  const files = sync("src/**/*.ts", {
-    dot: true,
-    onlyFiles: true,
-    ignore: [
-      "**/index.ts",
-      "**/*.d.ts",
-      "**/*.test.{ts,tsx}",
-      "**/*.spec.{ts,tsx}",
-      "**/*.stories.tsx",
-    ],
-    //
-  });
-
-  // group files by directory
-  const groups = groupBy(files, (file: string) => {
-    const parts = file.split("/");
-    parts.pop();
-    return parts.join("/");
-  });
-  // order by depth, so that we build indexes for subdirectories first
-  const dirs = orderBy(
-    Object.keys(groups),
-    (dir) => dir.split("/").length,
-    //
-  );
-
-  // build index for each directory
-  for (const dir of dirs) {
-    consola.info(`building index for ${dir}`);
-    const files = groups[dir].filter((file: string) => file.match(/\.ts$/));
-    const indexes = files
-      .map((file: string) => {
-        const content = readFileSync(file, "utf-8").split("\n");
-        if (!content.some((line) => line.trim().startsWith("export"))) {
-          // if none of the lines in the file start with an export, then we should not include it in the index
-          return "";
-        }
-        const name = path
-          .relative(dir, file) //
-          .replace(/\.ts$/, ""); //
-        return `export * from './${name}';`;
-      })
-      .filter(Boolean)
-      .sort() as string[];
-
-    // then find subdirectories and build index for them
-
-    const subIndex = sync(`${dir}/*/index.ts`, {
-      dot: true,
-      onlyFiles: true,
-      //
-    });
-
-    if (subIndex.length > 0) {
-      indexes.push(
-        ...subIndex.map((file: string) => {
-          const name = path
-            .relative(dir, file) //
-            .replace(/\/index\.ts$/, ""); //
-          return `export * from './${name}';`;
-        }),
-      );
-    }
-
-    const index = indexes.join("\n");
-
-    // const indexFile = `${dir}/index.ts`
-    const indexFile = path.join(dir, "index.ts");
-
-    const output = await prettier.format(index, { parser: "babel" });
-
-    if (existsSync(indexFile)) {
-      const existingContent = readFileSync(indexFile, "utf8");
-      if (existingContent === output) {
-        continue;
-      }
-      const lines = existingContent.split("\n");
-      if (lines.every((line) => line.startsWith("export * from")) == false) {
-        // if the existing index file is not an export index, then we should not overwrite it
-        continue;
-      }
-    }
-
-    if (output.length > 0) {
-      console.log(`writing ${dir}/index.ts`, output.length);
-
-      writeFileSync(
-        indexFile,
-        output,
-        //
-      );
-    }
-  }
-}
-
-main().catch(consola.error);