@clerk/electron 0.0.1

package/dist/types/storage/index.d.ts

@@ -0,0 +1,47 @@
+import type { TokenStorage } from '../shared/types';
+type StorageOptions = {
+    /**
+     * The name of the file (without extension) used to persist tokens.
+     *
+     * @default 'clerk-tokens'
+     */
+    name?: string;
+    /**
+     * The directory in which the token file is stored. Maps to `electron-store`'s `cwd` option.
+     * When omitted, the OS default user config directory is used.
+     */
+    path?: string;
+    /**
+     * When OS-level encryption is unavailable (e.g. a Linux machine without a keyring), tokens are
+     * not persisted by default, which signs the user out on the next app launch. Set this to `true`
+     * to instead persist tokens **unencrypted** in that scenario, keeping the user signed in across
+     * restarts at the cost of storing tokens in plaintext on disk.
+     *
+     * @default false
+     */
+    unencryptedFallback?: boolean;
+};
+/**
+ * Creates a secure {@link TokenStorage} adapter for the Electron main process.
+ *
+ * Tokens are persisted with `electron-store` and encrypted at rest using Electron's
+ * {@link safeStorage} API, which is backed by the OS keystore (Keychain on macOS, DPAPI on
+ * Windows, libsecret/kwallet on Linux). It uses Electron 42's async `safeStorage` API only when it
+ * reports itself available (which generally requires a code-signed app) and otherwise falls back to
+ * the synchronous API. Pass the result to `createClerkBridge({ storage: storage() })`.
+ *
+ * Behavior is secure by default: when OS encryption is unavailable the adapter does not persist
+ * tokens (the user will be signed out on restart) unless {@link StorageOptions.unencryptedFallback}
+ * is enabled. Undecryptable entries return `null`.
+ *
+ * @example
+ * ```ts
+ * import { createClerkBridge } from '@clerk/electron';
+ * import { storage } from '@clerk/electron/storage';
+ *
+ * createClerkBridge({ storage: storage({ name: 'my-app-tokens' }) });
+ * ```
+ */
+export declare function storage(options?: StorageOptions): TokenStorage;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/storage/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/storage/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,KAAK,cAAc,GAAG;IACpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AA6EF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,YAAY,CAwGlE"}

package/package.json

@@ -0,0 +1,121 @@
+{
+  "name": "@clerk/electron",
+  "version": "0.0.1",
+  "description": "Clerk SDK for Electron",
+  "keywords": [
+    "clerk",
+    "electron",
+    "auth",
+    "authentication",
+    "session",
+    "jwt",
+    "desktop"
+  ],
+  "homepage": "https://clerk.com/",
+  "bugs": {
+    "url": "https://github.com/clerk/javascript/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clerk/javascript.git",
+    "directory": "packages/electron"
+  },
+  "license": "MIT",
+  "author": "Clerk",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./preload": {
+      "import": {
+        "types": "./dist/types/preload/index.d.ts",
+        "default": "./dist/esm/preload/index.js"
+      },
+      "require": {
+        "types": "./dist/types/preload/index.d.ts",
+        "default": "./dist/cjs/preload/index.js"
+      }
+    },
+    "./storage": {
+      "import": {
+        "types": "./dist/types/storage/index.d.ts",
+        "default": "./dist/esm/storage/index.js"
+      },
+      "require": {
+        "types": "./dist/types/storage/index.d.ts",
+        "default": "./dist/cjs/storage/index.js"
+      }
+    },
+    "./react": {
+      "import": {
+        "types": "./dist/types/react/index.d.ts",
+        "default": "./dist/esm/react/index.js"
+      },
+      "require": {
+        "types": "./dist/types/react/index.d.ts",
+        "default": "./dist/cjs/react/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "preload"
+  ],
+  "dependencies": {
+    "tslib": "2.8.1",
+    "@clerk/clerk-js": "^6.16.1",
+    "@clerk/ui": "^1.16.1",
+    "@clerk/react": "^6.9.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.17",
+    "electron": "^39.2.6",
+    "electron-store": "^8.2.0"
+  },
+  "peerDependencies": {
+    "electron": ">=28",
+    "electron-store": "^8.2.0",
+    "react": "^18.0.0 || ~19.0.3 || ~19.1.4 || ~19.2.3 || ~19.3.0-0",
+    "react-dom": "^18.0.0 || ~19.0.3 || ~19.1.4 || ~19.2.3 || ~19.3.0-0"
+  },
+  "peerDependenciesMeta": {
+    "electron-store": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:declarations": "tsc -p tsconfig.declarations.json",
+    "clean": "rimraf ./dist",
+    "dev": "tsup --watch",
+    "format": "node ../../scripts/format-package.mjs",
+    "format:check": "node ../../scripts/format-package.mjs --check",
+    "lint": "eslint src",
+    "lint:attw": "attw --pack . --profile node16 --ignore-rules unexpected-module-syntax",
+    "lint:publint": "publint",
+    "test": "vitest run",
+    "test:ci": "vitest run --maxWorkers=70%",
+    "test:watch": "vitest"
+  }
+}