import { Effect, Redacted, Schema } from "effect"; import { definePlugin, StorageError, ToolResult, tool, ProviderItemId, ProviderKey, type CredentialProvider, type Owner, type PluginCtx, type PluginBlobStore, type ProviderEntry, type StaticToolSchema, type StorageFailure, } from "@executor-js/sdk/core"; import { OnePasswordAuth, OnePasswordConfig, RedactedOnePasswordConfig, Vault, ConnectionStatus, redactConfig, } from "./types"; import { OnePasswordError } from "./errors"; import { makeOnePasswordService, type ResolvedAuth, type OnePasswordService } from "./service"; // --------------------------------------------------------------------------- // Constants // --------------------------------------------------------------------------- const CREDENTIAL_FIELD = "credential"; const DEFAULT_TIMEOUT_MS = 15_000; const CONFIG_KEY = "config"; const PROVIDER_KEY = ProviderKey.make("onepassword"); const schemaToStaticToolSchema = (schema: Schema.Decoder): StaticToolSchema => Schema.toStandardSchemaV1(Schema.toStandardJSONSchemaV1(schema) as never) as StaticToolSchema< A, I >; const OnePasswordConfigureInput = Schema.Struct({ auth: OnePasswordAuth, vaultId: Schema.String, name: Schema.String, }); const OnePasswordConfigureOutput = Schema.Struct({ configured: Schema.Boolean, }); const OnePasswordGetConfigOutput = Schema.Struct({ config: Schema.NullOr(RedactedOnePasswordConfig), }); const OnePasswordListVaultsInput = OnePasswordAuth; const OnePasswordListVaultsOutput = Schema.Struct({ vaults: Schema.Array(Vault), }); const OnePasswordRemoveConfigOutput = Schema.Struct({ removed: Schema.Boolean, }); const OnePasswordStatusOutput = ConnectionStatus; const OnePasswordConfigureInputStd = schemaToStaticToolSchema< typeof OnePasswordConfigureInput.Type, typeof OnePasswordConfigureInput.Encoded >(OnePasswordConfigureInput); const OnePasswordConfigureOutputStd = schemaToStaticToolSchema(OnePasswordConfigureOutput); const OnePasswordGetConfigOutputStd = schemaToStaticToolSchema(OnePasswordGetConfigOutput); const OnePasswordListVaultsInputStd = schemaToStaticToolSchema< typeof OnePasswordListVaultsInput.Type, typeof OnePasswordListVaultsInput.Encoded >(OnePasswordListVaultsInput); const OnePasswordListVaultsOutputStd = schemaToStaticToolSchema(OnePasswordListVaultsOutput); const OnePasswordRemoveConfigOutputStd = schemaToStaticToolSchema(OnePasswordRemoveConfigOutput); const OnePasswordStatusOutputStd = schemaToStaticToolSchema(OnePasswordStatusOutput); // --------------------------------------------------------------------------- // Shared failure alias. // // Every extension method either touches storage (`ctx.storage` blobs) or // reaches the 1Password backend. Storage I/O surfaces as `StorageFailure`; // the HTTP edge (`withCapture`) translates `StorageError` to // `InternalError({ traceId })`. Domain problems (not configured, backend RPC // failure) stay as `OnePasswordError` and encode to 502 via the schema // annotation on the class. // --------------------------------------------------------------------------- export type OnePasswordExtensionFailure = OnePasswordError | StorageFailure; // --------------------------------------------------------------------------- // Typed config store — single blob, JSON encoded, owner-partitioned. The // stored config carries the auth credential (desktop account name, or // service-account token) plus the selected vault. v1 keyed this by executor // scope; v2 partitions by `owner` — the plugin-owned config row owns the // partition, mirroring the connection model. Blob I/O failures surface as // `StorageError`; decode failures stay `OnePasswordError`. // --------------------------------------------------------------------------- export interface OnePasswordStore { readonly getConfig: () => Effect.Effect< OnePasswordConfig | null, StorageError | OnePasswordError >; readonly saveConfig: ( config: OnePasswordConfig, owner: Owner, ) => Effect.Effect; readonly deleteConfig: (owner: Owner) => Effect.Effect; } const decodeConfig = Schema.decodeUnknownEffect(Schema.fromJsonString(OnePasswordConfig)); const blobStorageError = (operation: string) => (cause: unknown): StorageError => new StorageError({ message: `onepassword blob ${operation} failed`, cause, }); export const makeOnePasswordStore = (blobs: PluginBlobStore): OnePasswordStore => ({ getConfig: () => blobs.get(CONFIG_KEY).pipe( Effect.mapError(blobStorageError("read")), Effect.flatMap((raw) => { if (raw === null) return Effect.succeed(null); return decodeConfig(raw).pipe( Effect.mapError( () => new OnePasswordError({ operation: "config decode", message: "Failed to decode 1Password config", }), ), ); }), ), saveConfig: (config, owner) => blobs .put( CONFIG_KEY, JSON.stringify({ auth: config.auth, vaultId: config.vaultId, name: config.name, }), { owner }, ) .pipe(Effect.mapError(blobStorageError("write"))), deleteConfig: (owner) => blobs.delete(CONFIG_KEY, { owner }).pipe(Effect.mapError(blobStorageError("delete"))), }); // --------------------------------------------------------------------------- // Helpers — auth resolution + service construction // --------------------------------------------------------------------------- const resolveAuth = (auth: OnePasswordAuth): ResolvedAuth => auth.kind === "desktop-app" ? { kind: "desktop-app", accountName: auth.accountName } : { kind: "service-account", token: auth.token }; const getServiceFromConfig = ( config: OnePasswordConfig, timeoutMs: number, preferSdk: boolean | undefined, ): Effect.Effect => makeOnePasswordService(resolveAuth(config.auth), { timeoutMs, preferSdk }); const configuredVaultUri = (config: OnePasswordConfig, itemId: string): string | null => { if (!itemId.startsWith("op://")) { return `op://${config.vaultId}/${itemId}/${CREDENTIAL_FIELD}`; } const match = itemId.match(/^op:\/\/([^/]+)\/.+/); if (!match || match[1] !== config.vaultId) return null; return itemId; }; // --------------------------------------------------------------------------- // CredentialProvider — read-only, resolves op:// URIs or vaultId-based lookups. // // v2: `get(id)` receives only an opaque `ProviderItemId` — no scope. The id is // either a fully-qualified `op://vault/item/field` URI or a bare item id that // the stored config's vault scopes. The plugin's stored config supplies the // auth + vault binding; the provider never writes (writable: false). // --------------------------------------------------------------------------- const makeProvider = ( ctx: PluginCtx, timeoutMs: number, preferSdk: boolean | undefined, ): CredentialProvider => ({ key: PROVIDER_KEY, writable: false, get: (id: ProviderItemId): Effect.Effect | null, StorageFailure> => ctx.storage.getConfig().pipe( Effect.flatMap((config) => { if (!config) return Effect.succeed | null>(null); const uri = configuredVaultUri(config, id); if (uri === null) return Effect.succeed | null>(null); return getServiceFromConfig(config, timeoutMs, preferSdk).pipe( Effect.flatMap((svc) => svc.resolveSecret(uri)), Effect.map((v): Redacted.Redacted | null => Redacted.make(v)), Effect.orElseSucceed(() => null), ); }), Effect.catch(() => Effect.succeed | null>(null)), ), list: (): Effect.Effect => ctx.storage.getConfig().pipe( Effect.flatMap((config) => { if (!config) return Effect.succeed([] as readonly ProviderEntry[]); return getServiceFromConfig(config, timeoutMs, preferSdk).pipe( Effect.flatMap((svc) => svc.listItems(config.vaultId)), Effect.map((items): readonly ProviderEntry[] => items.map((item) => ({ id: ProviderItemId.make(item.id), name: item.title })), ), ); }), Effect.catch(() => Effect.succeed([] as readonly ProviderEntry[])), ), }); // --------------------------------------------------------------------------- // Owner resolution — config is a single shared 1Password binding. We persist // it under the `user` partition when the executor is bound to a subject, else // the shared `org` partition. // --------------------------------------------------------------------------- const ownerForCtx = (ctx: PluginCtx): Owner => ctx.owner.subject === null ? "org" : "user"; const makeOnePasswordExtension = ( ctx: PluginCtx, timeoutMs: number, preferSdk: boolean | undefined, ) => { return { configure: (config: OnePasswordConfig) => ctx.storage.saveConfig(config, ownerForCtx(ctx)), getConfig: (): Effect.Effect< RedactedOnePasswordConfig | null, StorageError | OnePasswordError > => ctx.storage.getConfig().pipe(Effect.map((config) => (config ? redactConfig(config) : null))), removeConfig: () => ctx.storage.deleteConfig(ownerForCtx(ctx)), status: () => Effect.gen(function* () { const config = yield* ctx.storage.getConfig(); if (!config) { return ConnectionStatus.make({ connected: false, error: "Not configured", }); } const svc = yield* getServiceFromConfig(config, timeoutMs, preferSdk); const vaults = yield* svc.listVaults(); const vault = vaults.find((v) => v.id === config.vaultId); return ConnectionStatus.make({ connected: true, vaultName: vault?.title, }); }), listVaults: (auth: OnePasswordAuth) => Effect.gen(function* () { const svc = yield* makeOnePasswordService(resolveAuth(auth), { timeoutMs, preferSdk, }); const vaults = yield* svc.listVaults(); return vaults .map((v) => Vault.make({ id: v.id, name: v.title })) .sort((a, b) => a.name.localeCompare(b.name)); }), resolve: (uri: string) => Effect.gen(function* () { const config = yield* ctx.storage.getConfig(); if (!config) { return yield* new OnePasswordError({ operation: "resolve", message: "1Password is not configured", }); } const scopedUri = configuredVaultUri(config, uri); if (scopedUri === null) { return yield* new OnePasswordError({ operation: "resolve", message: "1Password secret URI is outside the configured vault", }); } const svc = yield* getServiceFromConfig(config, timeoutMs, preferSdk); return yield* svc.resolveSecret(scopedUri); }), }; }; export type OnePasswordExtension = ReturnType; // --------------------------------------------------------------------------- // Plugin factory // --------------------------------------------------------------------------- export interface OnePasswordPluginOptions { /** Request timeout in ms (default: 15000) */ readonly timeoutMs?: number; /** Force use of the native SDK instead of the CLI (default: false) */ readonly preferSdk?: boolean; } export const onepasswordPlugin = definePlugin((options?: OnePasswordPluginOptions) => { const timeoutMs = options?.timeoutMs ?? DEFAULT_TIMEOUT_MS; const preferSdk = options?.preferSdk; return { id: "onepassword" as const, packageName: "@executor-js/plugin-onepassword", storage: ({ blobs }) => makeOnePasswordStore(blobs), extension: (ctx) => makeOnePasswordExtension(ctx, timeoutMs, preferSdk), staticIntegrations: (self) => [ { id: "onepassword", kind: "executor", name: "1Password", tools: [ tool({ name: "status", description: "Check whether the 1Password credential provider is configured and can reach its selected vault. This returns status only, never secret values.", outputSchema: OnePasswordStatusOutputStd, execute: () => Effect.map(self.status(), ToolResult.ok), }), tool({ name: "getConfig", description: "Read the current 1Password provider configuration. This returns account/vault metadata only; service-account token values are never returned.", outputSchema: OnePasswordGetConfigOutputStd, execute: () => Effect.map(self.getConfig(), (config) => ToolResult.ok({ config })), }), tool({ name: "listVaults", description: "List available 1Password vaults before configuring the provider. For service-account auth, pass the service account token directly.", inputSchema: OnePasswordListVaultsInputStd, outputSchema: OnePasswordListVaultsOutputStd, execute: (input) => Effect.map(self.listVaults(input), (vaults) => ToolResult.ok({ vaults })), }), tool({ name: "configure", description: "Configure the 1Password credential provider for the acting owner. Use desktop-app auth for local biometric access, or service-account auth with the token. The token is stored in the plugin's owner-partitioned config and never surfaced again.", annotations: { requiresApproval: true, approvalDescription: "Configure the 1Password credential provider", }, inputSchema: OnePasswordConfigureInputStd, outputSchema: OnePasswordConfigureOutputStd, execute: (input) => Effect.as( self.configure({ auth: input.auth, vaultId: input.vaultId, name: input.name }), ToolResult.ok({ configured: true }), ), }), tool({ name: "removeConfig", description: "Remove the 1Password provider configuration for the acting owner. Future 1Password secret resolution stops until reconfigured.", annotations: { requiresApproval: true, approvalDescription: "Remove the 1Password credential provider configuration", }, outputSchema: OnePasswordRemoveConfigOutputStd, execute: () => Effect.as(self.removeConfig(), ToolResult.ok({ removed: true })), }), ], }, ], credentialProviders: (ctx) => [makeProvider(ctx, timeoutMs, preferSdk)], }; // HTTP transport (routes/handlers/extensionService) is layered on by // the api-aware factory in `@executor-js/plugin-onepassword/api`. Hosts // that want the HTTP surface import the plugin from there; SDK-only // consumers stay on this entry and avoid the server-only deps. });