@rafads/plugin-keychain 1.5.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # @rafads/plugin-keychain
2
+
3
+ OS-keychain-backed secret store for the executor. Reads and writes secrets to:
4
+
5
+ - **macOS / iOS** — Keychain
6
+ - **Linux** — Secret Service (GNOME Keyring, KWallet)
7
+ - **Windows** — Credential Manager
8
+
9
+ Secrets are encrypted at rest by the operating system and never touch your project's filesystem.
10
+
11
+ ## Install
12
+
13
+ ```sh
14
+ bun add @rafads/sdk @rafads/plugin-keychain
15
+ # or
16
+ npm install @rafads/sdk @rafads/plugin-keychain
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```ts
22
+ import { createExecutor } from "@rafads/sdk";
23
+ import { keychainPlugin } from "@rafads/plugin-keychain";
24
+
25
+ const executor = await createExecutor({
26
+ onElicitation: "accept-all",
27
+ plugins: [keychainPlugin()] as const,
28
+ });
29
+
30
+ // Check whether the current OS has a supported keychain
31
+ if (executor.keychain.isSupported) {
32
+ await executor.secrets.set({
33
+ id: "github-token",
34
+ name: "GitHub Token",
35
+ value: "ghp_...",
36
+ scope: executor.scopes[0]!.id,
37
+ });
38
+
39
+ const value = await executor.secrets.get("github-token");
40
+ }
41
+ ```
42
+
43
+ Secrets written through this plugin are available to every other plugin that resolves secrets by ID — so you can store a token once and use it across `@rafads/plugin-openapi`, `@rafads/plugin-graphql`, etc. via `{ secretId, prefix }` headers.
44
+
45
+ ## Using with Effect
46
+
47
+ If you're building on `@rafads/sdk/core` (the raw Effect entry), import this plugin from its `/core` subpath instead — it returns the Effect-shaped plugin with `Effect.Effect<...>`-returning methods rather than promisified wrappers:
48
+
49
+ ```ts
50
+ import { keychainPlugin } from "@rafads/plugin-keychain/core";
51
+ ```
52
+
53
+ ## Status
54
+
55
+ Pre-`1.0`. APIs may still change between beta releases. Part of the [executor monorepo](https://github.com/UsefulSoftwareCo/executor).
56
+
57
+ ## License
58
+
59
+ MIT
@@ -0,0 +1,152 @@
1
+ // src/index.ts
2
+ import { Effect as Effect3 } from "effect";
3
+ import { definePlugin } from "@rafads/sdk";
4
+
5
+ // src/keyring.ts
6
+ import { createRequire } from "module";
7
+ import { Effect } from "effect";
8
+
9
+ // src/errors.ts
10
+ import { Data } from "effect";
11
+ var KeychainError = class extends Data.TaggedError("KeychainError") {
12
+ };
13
+
14
+ // src/keyring.ts
15
+ var DEFAULT_SERVICE_NAME = "executor";
16
+ var SERVICE_NAME_ENV = "EXECUTOR_KEYCHAIN_SERVICE_NAME";
17
+ var isSupportedPlatform = () => process.platform === "darwin" || process.platform === "linux" || process.platform === "win32";
18
+ var displayName = () => process.platform === "darwin" ? "macOS Keychain" : process.platform === "win32" ? "Windows Credential Manager" : "Desktop Keyring";
19
+ var resolveServiceName = (explicit) => explicit?.trim() || process.env[SERVICE_NAME_ENV]?.trim() || DEFAULT_SERVICE_NAME;
20
+ var entryCtorPromise = null;
21
+ var loadEntryCtor = async () => {
22
+ const directPath = process.env.EXECUTOR_KEYRING_NATIVE_PATH;
23
+ if (directPath) {
24
+ const req = createRequire(import.meta.url);
25
+ return req(directPath).Entry;
26
+ }
27
+ const { Entry } = await import("@napi-rs/keyring");
28
+ return Entry;
29
+ };
30
+ var loadEntry = () => isSupportedPlatform() ? Effect.tryPromise({
31
+ try: async () => {
32
+ entryCtorPromise ??= loadEntryCtor();
33
+ return await entryCtorPromise;
34
+ },
35
+ catch: (cause) => new KeychainError({
36
+ message: "Failed loading native keyring",
37
+ cause
38
+ })
39
+ }) : Effect.fail(
40
+ new KeychainError({
41
+ message: `Failed loading native keyring: unsupported platform '${process.platform}'`
42
+ })
43
+ );
44
+ var createEntry = (serviceName, account) => Effect.flatMap(
45
+ loadEntry(),
46
+ (Entry) => Effect.try({
47
+ try: () => new Entry(serviceName, account),
48
+ catch: (cause) => new KeychainError({
49
+ message: "Failed creating keyring entry",
50
+ cause
51
+ })
52
+ })
53
+ );
54
+ var getPassword = (serviceName, account) => Effect.flatMap(
55
+ createEntry(serviceName, account),
56
+ (entry) => Effect.try({
57
+ try: () => entry.getPassword(),
58
+ catch: () => new KeychainError({ message: `Failed reading secret for account '${account}'` })
59
+ })
60
+ );
61
+ var setPassword = (serviceName, account, value) => Effect.flatMap(
62
+ createEntry(serviceName, account),
63
+ (entry) => Effect.try({
64
+ try: () => entry.setPassword(value),
65
+ catch: (cause) => new KeychainError({
66
+ message: "Failed writing secret",
67
+ cause
68
+ })
69
+ }).pipe(Effect.asVoid)
70
+ );
71
+ var deletePassword = (serviceName, account) => Effect.flatMap(
72
+ createEntry(serviceName, account),
73
+ (entry) => Effect.try({
74
+ try: () => {
75
+ entry.deletePassword();
76
+ return true;
77
+ },
78
+ catch: () => new KeychainError({ message: `Failed deleting secret for account '${account}'` })
79
+ })
80
+ );
81
+
82
+ // src/provider.ts
83
+ import { Effect as Effect2 } from "effect";
84
+ import {
85
+ StorageError,
86
+ ProviderKey
87
+ } from "@rafads/sdk";
88
+ var toStorageError = (cause) => {
89
+ const { cause: underlyingCause } = cause;
90
+ return new StorageError({ message: cause.message, cause: underlyingCause ?? cause });
91
+ };
92
+ var KEYCHAIN_PROVIDER_KEY = ProviderKey.make("keychain");
93
+ var makeKeychainProvider = (serviceName) => ({
94
+ key: KEYCHAIN_PROVIDER_KEY,
95
+ writable: true,
96
+ get: (id) => getPassword(serviceName, id).pipe(Effect2.mapError(toStorageError)),
97
+ has: (id) => getPassword(serviceName, id).pipe(
98
+ Effect2.map((value) => value !== null),
99
+ Effect2.mapError(toStorageError)
100
+ ),
101
+ set: (id, value) => setPassword(serviceName, id, value).pipe(Effect2.mapError(toStorageError)),
102
+ delete: (id) => deletePassword(serviceName, id).pipe(Effect2.asVoid, Effect2.mapError(toStorageError)),
103
+ // Keychain doesn't support enumerating — you need to know the account name.
104
+ list: void 0
105
+ });
106
+
107
+ // src/index.ts
108
+ var PROBE_VALUE = "probe";
109
+ var probeAccount = () => `__executor_keychain_probe__:${process.pid}:${Date.now()}:${Math.random().toString(36).slice(2)}`;
110
+ var makeKeychainExtension = (_ctx, options) => {
111
+ const serviceName = resolveServiceName(options?.serviceName);
112
+ return {
113
+ /** Human-readable name for the keychain on this platform */
114
+ displayName: displayName(),
115
+ /** Whether the current platform supports system keychain */
116
+ isSupported: isSupportedPlatform(),
117
+ /** Check if a secret exists in the system keychain. `id` is the opaque
118
+ * provider item id (the keychain account); v2 has no scope partitioning. */
119
+ has: (id) => getPassword(serviceName, id).pipe(
120
+ Effect3.map((value) => value !== null),
121
+ Effect3.orElseSucceed(() => false)
122
+ )
123
+ };
124
+ };
125
+ var keychainPlugin = definePlugin((options) => ({
126
+ id: "keychain",
127
+ storage: () => ({}),
128
+ extension: (ctx) => makeKeychainExtension(ctx, options),
129
+ credentialProviders: () => Effect3.gen(function* () {
130
+ const serviceName = resolveServiceName(options?.serviceName);
131
+ const account = probeAccount();
132
+ const reachable = yield* setPassword(serviceName, account, PROBE_VALUE).pipe(
133
+ Effect3.andThen(deletePassword(serviceName, account).pipe(Effect3.catch(() => Effect3.void))),
134
+ Effect3.as(true),
135
+ Effect3.catch(
136
+ () => Effect3.logWarning("keychain unavailable, skipping provider registration").pipe(
137
+ Effect3.as(false)
138
+ )
139
+ )
140
+ );
141
+ return reachable ? [makeKeychainProvider(serviceName)] : [];
142
+ })
143
+ }));
144
+
145
+ export {
146
+ KeychainError,
147
+ isSupportedPlatform,
148
+ displayName,
149
+ makeKeychainProvider,
150
+ keychainPlugin
151
+ };
152
+ //# sourceMappingURL=chunk-G7JVMQOY.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/keyring.ts","../src/errors.ts","../src/provider.ts"],"sourcesContent":["import { Effect } from \"effect\";\n\nimport { definePlugin, type CredentialProvider, type PluginCtx } from \"@rafads/sdk\";\n\nimport {\n deletePassword,\n displayName,\n getPassword,\n isSupportedPlatform,\n resolveServiceName,\n setPassword,\n} from \"./keyring\";\nimport { makeKeychainProvider } from \"./provider\";\n\n// Probe the keychain by writing and then deleting a sentinel entry. A\n// read-only probe isn't enough — on some Linux environments (WSL2,\n// headless CI) `getPassword` for a missing key returns null without\n// error, but `setPassword` fails because the secret-service backend\n// isn't actually reachable. Writing is the capability the executor\n// cares about, so test it directly.\nconst PROBE_VALUE = \"probe\";\nconst probeAccount = (): string =>\n `__executor_keychain_probe__:${process.pid}:${Date.now()}:${Math.random().toString(36).slice(2)}`;\n\n// ---------------------------------------------------------------------------\n// Re-exports\n// ---------------------------------------------------------------------------\n\nexport { KeychainError } from \"./errors\";\nexport { makeKeychainProvider } from \"./provider\";\nexport { isSupportedPlatform, displayName } from \"./keyring\";\n\n// ---------------------------------------------------------------------------\n// Plugin config\n// ---------------------------------------------------------------------------\n\nexport interface KeychainPluginConfig {\n /** Override the keychain service name (default: \"executor\") */\n readonly serviceName?: string;\n}\n\n// ---------------------------------------------------------------------------\n// Plugin extension — public API on executor.keychain\n// ---------------------------------------------------------------------------\n\nexport type KeychainExtension = ReturnType<typeof makeKeychainExtension>;\n\n// ---------------------------------------------------------------------------\n// Plugin definition\n// ---------------------------------------------------------------------------\n\nconst makeKeychainExtension = (\n _ctx: PluginCtx<unknown>,\n options: KeychainPluginConfig | undefined,\n) => {\n const serviceName = resolveServiceName(options?.serviceName);\n return {\n /** Human-readable name for the keychain on this platform */\n displayName: displayName(),\n\n /** Whether the current platform supports system keychain */\n isSupported: isSupportedPlatform(),\n\n /** Check if a secret exists in the system keychain. `id` is the opaque\n * provider item id (the keychain account); v2 has no scope partitioning. */\n has: (id: string) =>\n getPassword(serviceName, id).pipe(\n Effect.map((value: string | null) => value !== null),\n Effect.orElseSucceed(() => false),\n ),\n };\n};\n\nexport const keychainPlugin = definePlugin((options?: KeychainPluginConfig) => ({\n id: \"keychain\" as const,\n storage: () => ({}),\n\n extension: (ctx: PluginCtx<unknown>): KeychainExtension => makeKeychainExtension(ctx, options),\n\n credentialProviders: (): Effect.Effect<readonly CredentialProvider[]> =>\n Effect.gen(function* () {\n const serviceName = resolveServiceName(options?.serviceName);\n const account = probeAccount();\n const reachable = yield* setPassword(serviceName, account, PROBE_VALUE).pipe(\n Effect.andThen(deletePassword(serviceName, account).pipe(Effect.catch(() => Effect.void))),\n Effect.as(true),\n Effect.catch(() =>\n Effect.logWarning(\"keychain unavailable, skipping provider registration\").pipe(\n Effect.as(false),\n ),\n ),\n );\n return reachable ? [makeKeychainProvider(serviceName)] : [];\n }),\n}));\n","import { createRequire } from \"node:module\";\n\nimport { Effect } from \"effect\";\n\nimport { KeychainError } from \"./errors\";\n\n// ---------------------------------------------------------------------------\n// Constants\n// ---------------------------------------------------------------------------\n\nconst DEFAULT_SERVICE_NAME = \"executor\";\nconst SERVICE_NAME_ENV = \"EXECUTOR_KEYCHAIN_SERVICE_NAME\";\n\n// ---------------------------------------------------------------------------\n// Platform helpers\n// ---------------------------------------------------------------------------\n\nexport const isSupportedPlatform = () =>\n process.platform === \"darwin\" || process.platform === \"linux\" || process.platform === \"win32\";\n\nexport const displayName = () =>\n process.platform === \"darwin\"\n ? \"macOS Keychain\"\n : process.platform === \"win32\"\n ? \"Windows Credential Manager\"\n : \"Desktop Keyring\";\n\nexport const resolveServiceName = (explicit?: string): string =>\n explicit?.trim() || process.env[SERVICE_NAME_ENV]?.trim() || DEFAULT_SERVICE_NAME;\n\n// ---------------------------------------------------------------------------\n// Lazy-load @napi-rs/keyring (native module)\n// ---------------------------------------------------------------------------\n\ntype EntryConstructor = (typeof import(\"@napi-rs/keyring\"))[\"Entry\"];\n\nlet entryCtorPromise: Promise<EntryConstructor> | null = null;\n\n// In compiled bun binaries (`bun build --compile`) `.node` modules aren't\n// included in bunfs and there's no node_modules at runtime, so\n// @napi-rs/keyring's loader can't find its platform-specific binding.\n// `apps/cli/src/build.ts` copies the .node next to the executor and\n// `apps/cli/src/main.ts` exports its absolute path here. We load it\n// directly because @napi-rs/keyring@1.2.0's NAPI_RS_NATIVE_LIBRARY_PATH\n// branch is buggy (assigns to a local that gets overwritten before return).\nconst loadEntryCtor = async (): Promise<EntryConstructor> => {\n const directPath = process.env.EXECUTOR_KEYRING_NATIVE_PATH;\n if (directPath) {\n const req = createRequire(import.meta.url);\n return (req(directPath) as { Entry: EntryConstructor }).Entry;\n }\n const { Entry } = await import(\"@napi-rs/keyring\");\n return Entry;\n};\n\nconst loadEntry = (): Effect.Effect<EntryConstructor, KeychainError> =>\n isSupportedPlatform()\n ? Effect.tryPromise({\n try: async () => {\n entryCtorPromise ??= loadEntryCtor();\n return await entryCtorPromise;\n },\n catch: (cause) =>\n new KeychainError({\n message: \"Failed loading native keyring\",\n cause,\n }),\n })\n : Effect.fail(\n new KeychainError({\n message: `Failed loading native keyring: unsupported platform '${process.platform}'`,\n }),\n );\n\nconst createEntry = (serviceName: string, account: string) =>\n Effect.flatMap(loadEntry(), (Entry) =>\n Effect.try({\n try: () => new Entry(serviceName, account),\n catch: (cause) =>\n new KeychainError({\n message: \"Failed creating keyring entry\",\n cause,\n }),\n }),\n );\n\n// ---------------------------------------------------------------------------\n// Low-level keychain operations\n// ---------------------------------------------------------------------------\n\nexport const getPassword = (\n serviceName: string,\n account: string,\n): Effect.Effect<string | null, KeychainError> =>\n Effect.flatMap(createEntry(serviceName, account), (entry) =>\n Effect.try({\n try: () => entry.getPassword(),\n catch: () => new KeychainError({ message: `Failed reading secret for account '${account}'` }),\n }),\n );\n\nexport const setPassword = (\n serviceName: string,\n account: string,\n value: string,\n): Effect.Effect<void, KeychainError> =>\n Effect.flatMap(createEntry(serviceName, account), (entry) =>\n Effect.try({\n try: () => entry.setPassword(value),\n catch: (cause) =>\n new KeychainError({\n message: \"Failed writing secret\",\n cause,\n }),\n }).pipe(Effect.asVoid),\n );\n\nexport const deletePassword = (\n serviceName: string,\n account: string,\n): Effect.Effect<boolean, KeychainError> =>\n Effect.flatMap(createEntry(serviceName, account), (entry) =>\n Effect.try({\n try: () => {\n entry.deletePassword();\n return true;\n },\n catch: () =>\n new KeychainError({ message: `Failed deleting secret for account '${account}'` }),\n }),\n );\n","import { Data } from \"effect\";\n\nexport class KeychainError extends Data.TaggedError(\"KeychainError\")<{\n readonly message: string;\n readonly cause?: unknown;\n}> {}\n","import { Effect } from \"effect\";\n\nimport {\n StorageError,\n ProviderKey,\n type CredentialProvider,\n type ProviderItemId,\n} from \"@rafads/sdk\";\n\nimport type { KeychainError } from \"./errors\";\nimport { getPassword, setPassword, deletePassword } from \"./keyring\";\n\n// ---------------------------------------------------------------------------\n// CredentialProvider adapter — bridges keyring into the v2 resolution chain.\n//\n// The underlying `@napi-rs/keyring` sync API encodes \"no entry\" as an\n// ordinary return value (`getPassword()` → `null`, `deletePassword()` →\n// `false`), and only throws on real failures (keychain locked, permission\n// denied, platform init failure, etc.). `keyring.ts` wraps those thrown\n// failures as `KeychainError`. We translate `KeychainError` →\n// `StorageError` so the HTTP edge can capture it to telemetry and surface\n// an opaque `InternalError({ traceId })` — previously `orElseSucceed`\n// silently converted every failure into \"nothing found\", which made it\n// impossible to debug why secrets weren't resolving.\n//\n// v2: the provider sees only an opaque `ProviderItemId` (the keychain\n// account). There is NO scope arg — the connection row owns the (tenant,\n// owner, subject) partition. We use a single, flat keychain service name;\n// the connection's opaque id is the account that uniquely keys the entry.\n// ---------------------------------------------------------------------------\n\nconst toStorageError = (cause: KeychainError) => {\n const { cause: underlyingCause } = cause;\n // oxlint-disable-next-line executor/no-unknown-error-message -- boundary: typed KeychainError message becomes StorageError message\n return new StorageError({ message: cause.message, cause: underlyingCause ?? cause });\n};\n\nconst KEYCHAIN_PROVIDER_KEY = ProviderKey.make(\"keychain\");\n\nexport const makeKeychainProvider = (serviceName: string): CredentialProvider => ({\n key: KEYCHAIN_PROVIDER_KEY,\n writable: true,\n get: (id: ProviderItemId) => getPassword(serviceName, id).pipe(Effect.mapError(toStorageError)),\n has: (id: ProviderItemId) =>\n getPassword(serviceName, id).pipe(\n Effect.map((value: string | null) => value !== null),\n Effect.mapError(toStorageError),\n ),\n set: (id: ProviderItemId, value: string) =>\n setPassword(serviceName, id, value).pipe(Effect.mapError(toStorageError)),\n delete: (id: ProviderItemId) =>\n deletePassword(serviceName, id).pipe(Effect.asVoid, Effect.mapError(toStorageError)),\n // Keychain doesn't support enumerating — you need to know the account name.\n list: undefined,\n});\n"],"mappings":";AAAA,SAAS,UAAAA,eAAc;AAEvB,SAAS,oBAA6D;;;ACFtE,SAAS,qBAAqB;AAE9B,SAAS,cAAc;;;ACFvB,SAAS,YAAY;AAEd,IAAM,gBAAN,cAA4B,KAAK,YAAY,eAAe,EAGhE;AAAC;;;ADKJ,IAAM,uBAAuB;AAC7B,IAAM,mBAAmB;AAMlB,IAAM,sBAAsB,MACjC,QAAQ,aAAa,YAAY,QAAQ,aAAa,WAAW,QAAQ,aAAa;AAEjF,IAAM,cAAc,MACzB,QAAQ,aAAa,WACjB,mBACA,QAAQ,aAAa,UACnB,+BACA;AAED,IAAM,qBAAqB,CAAC,aACjC,UAAU,KAAK,KAAK,QAAQ,IAAI,gBAAgB,GAAG,KAAK,KAAK;AAQ/D,IAAI,mBAAqD;AASzD,IAAM,gBAAgB,YAAuC;AAC3D,QAAM,aAAa,QAAQ,IAAI;AAC/B,MAAI,YAAY;AACd,UAAM,MAAM,cAAc,YAAY,GAAG;AACzC,WAAQ,IAAI,UAAU,EAAkC;AAAA,EAC1D;AACA,QAAM,EAAE,MAAM,IAAI,MAAM,OAAO,kBAAkB;AACjD,SAAO;AACT;AAEA,IAAM,YAAY,MAChB,oBAAoB,IAChB,OAAO,WAAW;AAAA,EAChB,KAAK,YAAY;AACf,yBAAqB,cAAc;AACnC,WAAO,MAAM;AAAA,EACf;AAAA,EACA,OAAO,CAAC,UACN,IAAI,cAAc;AAAA,IAChB,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AACL,CAAC,IACD,OAAO;AAAA,EACL,IAAI,cAAc;AAAA,IAChB,SAAS,wDAAwD,QAAQ,QAAQ;AAAA,EACnF,CAAC;AACH;AAEN,IAAM,cAAc,CAAC,aAAqB,YACxC,OAAO;AAAA,EAAQ,UAAU;AAAA,EAAG,CAAC,UAC3B,OAAO,IAAI;AAAA,IACT,KAAK,MAAM,IAAI,MAAM,aAAa,OAAO;AAAA,IACzC,OAAO,CAAC,UACN,IAAI,cAAc;AAAA,MAChB,SAAS;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACL,CAAC;AACH;AAMK,IAAM,cAAc,CACzB,aACA,YAEA,OAAO;AAAA,EAAQ,YAAY,aAAa,OAAO;AAAA,EAAG,CAAC,UACjD,OAAO,IAAI;AAAA,IACT,KAAK,MAAM,MAAM,YAAY;AAAA,IAC7B,OAAO,MAAM,IAAI,cAAc,EAAE,SAAS,sCAAsC,OAAO,IAAI,CAAC;AAAA,EAC9F,CAAC;AACH;AAEK,IAAM,cAAc,CACzB,aACA,SACA,UAEA,OAAO;AAAA,EAAQ,YAAY,aAAa,OAAO;AAAA,EAAG,CAAC,UACjD,OAAO,IAAI;AAAA,IACT,KAAK,MAAM,MAAM,YAAY,KAAK;AAAA,IAClC,OAAO,CAAC,UACN,IAAI,cAAc;AAAA,MAChB,SAAS;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACL,CAAC,EAAE,KAAK,OAAO,MAAM;AACvB;AAEK,IAAM,iBAAiB,CAC5B,aACA,YAEA,OAAO;AAAA,EAAQ,YAAY,aAAa,OAAO;AAAA,EAAG,CAAC,UACjD,OAAO,IAAI;AAAA,IACT,KAAK,MAAM;AACT,YAAM,eAAe;AACrB,aAAO;AAAA,IACT;AAAA,IACA,OAAO,MACL,IAAI,cAAc,EAAE,SAAS,uCAAuC,OAAO,IAAI,CAAC;AAAA,EACpF,CAAC;AACH;;;AElIF,SAAS,UAAAC,eAAc;AAEvB;AAAA,EACE;AAAA,EACA;AAAA,OAGK;AAwBP,IAAM,iBAAiB,CAAC,UAAyB;AAC/C,QAAM,EAAE,OAAO,gBAAgB,IAAI;AAEnC,SAAO,IAAI,aAAa,EAAE,SAAS,MAAM,SAAS,OAAO,mBAAmB,MAAM,CAAC;AACrF;AAEA,IAAM,wBAAwB,YAAY,KAAK,UAAU;AAElD,IAAM,uBAAuB,CAAC,iBAA6C;AAAA,EAChF,KAAK;AAAA,EACL,UAAU;AAAA,EACV,KAAK,CAAC,OAAuB,YAAY,aAAa,EAAE,EAAE,KAAKC,QAAO,SAAS,cAAc,CAAC;AAAA,EAC9F,KAAK,CAAC,OACJ,YAAY,aAAa,EAAE,EAAE;AAAA,IAC3BA,QAAO,IAAI,CAAC,UAAyB,UAAU,IAAI;AAAA,IACnDA,QAAO,SAAS,cAAc;AAAA,EAChC;AAAA,EACF,KAAK,CAAC,IAAoB,UACxB,YAAY,aAAa,IAAI,KAAK,EAAE,KAAKA,QAAO,SAAS,cAAc,CAAC;AAAA,EAC1E,QAAQ,CAAC,OACP,eAAe,aAAa,EAAE,EAAE,KAAKA,QAAO,QAAQA,QAAO,SAAS,cAAc,CAAC;AAAA;AAAA,EAErF,MAAM;AACR;;;AHlCA,IAAM,cAAc;AACpB,IAAM,eAAe,MACnB,+BAA+B,QAAQ,GAAG,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC;AA6BjG,IAAM,wBAAwB,CAC5B,MACA,YACG;AACH,QAAM,cAAc,mBAAmB,SAAS,WAAW;AAC3D,SAAO;AAAA;AAAA,IAEL,aAAa,YAAY;AAAA;AAAA,IAGzB,aAAa,oBAAoB;AAAA;AAAA;AAAA,IAIjC,KAAK,CAAC,OACJ,YAAY,aAAa,EAAE,EAAE;AAAA,MAC3BC,QAAO,IAAI,CAAC,UAAyB,UAAU,IAAI;AAAA,MACnDA,QAAO,cAAc,MAAM,KAAK;AAAA,IAClC;AAAA,EACJ;AACF;AAEO,IAAM,iBAAiB,aAAa,CAAC,aAAoC;AAAA,EAC9E,IAAI;AAAA,EACJ,SAAS,OAAO,CAAC;AAAA,EAEjB,WAAW,CAAC,QAA+C,sBAAsB,KAAK,OAAO;AAAA,EAE7F,qBAAqB,MACnBA,QAAO,IAAI,aAAa;AACtB,UAAM,cAAc,mBAAmB,SAAS,WAAW;AAC3D,UAAM,UAAU,aAAa;AAC7B,UAAM,YAAY,OAAO,YAAY,aAAa,SAAS,WAAW,EAAE;AAAA,MACtEA,QAAO,QAAQ,eAAe,aAAa,OAAO,EAAE,KAAKA,QAAO,MAAM,MAAMA,QAAO,IAAI,CAAC,CAAC;AAAA,MACzFA,QAAO,GAAG,IAAI;AAAA,MACdA,QAAO;AAAA,QAAM,MACXA,QAAO,WAAW,sDAAsD,EAAE;AAAA,UACxEA,QAAO,GAAG,KAAK;AAAA,QACjB;AAAA,MACF;AAAA,IACF;AACA,WAAO,YAAY,CAAC,qBAAqB,WAAW,CAAC,IAAI,CAAC;AAAA,EAC5D,CAAC;AACL,EAAE;","names":["Effect","Effect","Effect","Effect"]}
package/dist/core.js ADDED
@@ -0,0 +1,15 @@
1
+ import {
2
+ KeychainError,
3
+ displayName,
4
+ isSupportedPlatform,
5
+ keychainPlugin,
6
+ makeKeychainProvider
7
+ } from "./chunk-G7JVMQOY.js";
8
+ export {
9
+ KeychainError,
10
+ displayName,
11
+ isSupportedPlatform,
12
+ keychainPlugin,
13
+ makeKeychainProvider
14
+ };
15
+ //# sourceMappingURL=core.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
@@ -0,0 +1,9 @@
1
+ declare const KeychainError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
2
+ readonly _tag: "KeychainError";
3
+ } & Readonly<A>;
4
+ export declare class KeychainError extends KeychainError_base<{
5
+ readonly message: string;
6
+ readonly cause?: unknown;
7
+ }> {
8
+ }
9
+ export {};
@@ -0,0 +1,28 @@
1
+ import { Effect } from "effect";
2
+ import { type PluginCtx } from "@rafads/sdk";
3
+ export { KeychainError } from "./errors";
4
+ export { makeKeychainProvider } from "./provider";
5
+ export { isSupportedPlatform, displayName } from "./keyring";
6
+ export interface KeychainPluginConfig {
7
+ /** Override the keychain service name (default: "executor") */
8
+ readonly serviceName?: string;
9
+ }
10
+ export type KeychainExtension = ReturnType<typeof makeKeychainExtension>;
11
+ declare const makeKeychainExtension: (_ctx: PluginCtx<unknown>, options: KeychainPluginConfig | undefined) => {
12
+ /** Human-readable name for the keychain on this platform */
13
+ displayName: string;
14
+ /** Whether the current platform supports system keychain */
15
+ isSupported: boolean;
16
+ /** Check if a secret exists in the system keychain. `id` is the opaque
17
+ * provider item id (the keychain account); v2 has no scope partitioning. */
18
+ has: (id: string) => Effect.Effect<boolean, never, never>;
19
+ };
20
+ export declare const keychainPlugin: import("@rafads/sdk").ConfiguredPlugin<"keychain", {
21
+ /** Human-readable name for the keychain on this platform */
22
+ displayName: string;
23
+ /** Whether the current platform supports system keychain */
24
+ isSupported: boolean;
25
+ /** Check if a secret exists in the system keychain. `id` is the opaque
26
+ * provider item id (the keychain account); v2 has no scope partitioning. */
27
+ has: (id: string) => Effect.Effect<boolean, never, never>;
28
+ }, {}, KeychainPluginConfig, undefined, import("effect/Layer").Layer<unknown, never, never>, import("effect/unstable/httpapi/HttpApiGroup").Any>;
package/dist/index.js ADDED
@@ -0,0 +1,10 @@
1
+ import {
2
+ keychainPlugin
3
+ } from "./chunk-G7JVMQOY.js";
4
+
5
+ // src/promise.ts
6
+ var keychainPlugin2 = (config) => keychainPlugin(config);
7
+ export {
8
+ keychainPlugin2 as keychainPlugin
9
+ };
10
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/promise.ts"],"sourcesContent":["import { type Plugin } from \"@rafads/sdk\";\n\nimport {\n keychainPlugin as keychainPluginEffect,\n type KeychainExtension,\n type KeychainPluginConfig,\n} from \"./index\";\n\nexport type { KeychainPluginConfig } from \"./index\";\n\n// Explicit return type so the emitted dist/promise.d.ts references\n// `import(\"@rafads/sdk\").Plugin` rather than the Promise-surface\n// root specifier (which doesn't re-export Plugin).\nexport const keychainPlugin = (\n config?: KeychainPluginConfig,\n): Plugin<\"keychain\", KeychainExtension, Record<string, never>> => keychainPluginEffect(config);\n"],"mappings":";;;;;AAaO,IAAMA,kBAAiB,CAC5B,WACiE,eAAqB,MAAM;","names":["keychainPlugin"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ import { Effect } from "effect";
2
+ import { KeychainError } from "./errors";
3
+ export declare const isSupportedPlatform: () => boolean;
4
+ export declare const displayName: () => "macOS Keychain" | "Windows Credential Manager" | "Desktop Keyring";
5
+ export declare const resolveServiceName: (explicit?: string) => string;
6
+ export declare const getPassword: (serviceName: string, account: string) => Effect.Effect<string | null, KeychainError>;
7
+ export declare const setPassword: (serviceName: string, account: string, value: string) => Effect.Effect<void, KeychainError>;
8
+ export declare const deletePassword: (serviceName: string, account: string) => Effect.Effect<boolean, KeychainError>;
@@ -0,0 +1,4 @@
1
+ import { type Plugin } from "@rafads/sdk";
2
+ import { type KeychainExtension, type KeychainPluginConfig } from "./index";
3
+ export type { KeychainPluginConfig } from "./index";
4
+ export declare const keychainPlugin: (config?: KeychainPluginConfig) => Plugin<"keychain", KeychainExtension, Record<string, never>>;
@@ -0,0 +1,2 @@
1
+ import { type CredentialProvider } from "@rafads/sdk";
2
+ export declare const makeKeychainProvider: (serviceName: string) => CredentialProvider;
package/package.json ADDED
@@ -0,0 +1,57 @@
1
+ {
2
+ "name": "@rafads/plugin-keychain",
3
+ "version": "1.5.38",
4
+ "homepage": "https://github.com/UsefulSoftwareCo/executor/tree/main/packages/plugins/keychain",
5
+ "bugs": {
6
+ "url": "https://github.com/UsefulSoftwareCo/executor/issues"
7
+ },
8
+ "license": "MIT",
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "git+https://github.com/UsefulSoftwareCo/executor.git",
12
+ "directory": "packages/plugins/keychain"
13
+ },
14
+ "files": [
15
+ "dist"
16
+ ],
17
+ "type": "module",
18
+ "exports": {
19
+ ".": {
20
+ "import": {
21
+ "types": "./dist/promise.d.ts",
22
+ "default": "./dist/index.js"
23
+ }
24
+ },
25
+ "./core": {
26
+ "import": {
27
+ "types": "./dist/index.d.ts",
28
+ "default": "./dist/core.js"
29
+ }
30
+ }
31
+ },
32
+ "publishConfig": {
33
+ "access": "public"
34
+ },
35
+ "scripts": {
36
+ "build": "tsup && tsc --declaration --emitDeclarationOnly --outDir dist --rootDir src",
37
+ "typecheck": "tsgo --noEmit",
38
+ "test": "vitest run",
39
+ "test:watch": "vitest",
40
+ "typecheck:slow": "bunx tsc --noEmit -p tsconfig.json"
41
+ },
42
+ "dependencies": {
43
+ "@napi-rs/keyring": "^1.2.0",
44
+ "@rafads/sdk": "1.5.38"
45
+ },
46
+ "devDependencies": {
47
+ "@effect/vitest": "4.0.0-beta.59",
48
+ "@types/node": "^24.3.1",
49
+ "bun-types": "^1.2.22",
50
+ "effect": "4.0.0-beta.59",
51
+ "tsup": "^8.5.0",
52
+ "vitest": "^4.1.5"
53
+ },
54
+ "peerDependencies": {
55
+ "effect": "4.0.0-beta.59"
56
+ }
57
+ }