taskchef 8.6.2 → 8.7.0

package/node_modules/@napi-rs/keyring/README.md

@@ -0,0 +1,45 @@
+# `@napi-rs/keyring`
+
+![https://github.com/Brooooooklyn/keyring-node/actions](https://github.com/Brooooooklyn/keyring-node/workflows/CI/badge.svg)
+[![install size](https://packagephobia.com/badge?p=@napi-rs/keyring)](https://packagephobia.com/result?p=@napi-rs/keyring)
+[![Downloads](https://img.shields.io/npm/dm/@napi-rs/keyring.svg?sanitize=true)](https://npmcharts.com/compare/@napi-rs/keyring?minimal=true)
+
+> https://github.com/hwchen/keyring-rs Node.js binding via https://napi.rs
+
+# Usage
+
+```js
+import { Entry } from '@napi-rs/keyring'
+
+const entry = new Entry('my_service', 'my_name')
+entry.setPassword('topS3cr3tP4$$w0rd')
+const password = entry.getPassword()
+console.log('My password is ', password)
+entry.deletePassword()
+```
+
+# Linux backend selection
+
+On Linux, `Entry` and `AsyncEntry` pick a credential store automatically: the
+[Secret Service](https://crates.io/crates/dbus-secret-service-keyring-store) (gnome-keyring, KWallet,
+keepassxc, ...) is tried first, and the binding silently falls back to the
+[kernel keyutils keyring](https://crates.io/crates/linux-keyutils-keyring-store) when no Secret Service
+is available.
+
+You can pin an entry to one specific store by passing the options bag as the last argument (the
+option is accepted on every platform but only meaningful on Linux):
+
+```js
+new Entry('my_service', 'my_name', { linux: { store: 'secret-service' } }) // require Secret Service
+new Entry('my_service', 'my_name', { linux: { store: 'keyutils' } }) // require the kernel keyring
+Entry.withTarget('target', 'my_service', 'my_name', { linux: { store: 'keyutils' } })
+```
+
+When a store is required, the constructor throws if that store is unavailable — there is no silent
+fallback. When `withTarget` is combined with the keyutils store, the target is used as the kernel key
+description, so distinct targets keep distinct credentials.
+
+> **Note:** the keyutils store keeps credentials in kernel memory: per the
+> [linux-keyutils-keyring-store](https://crates.io/crates/linux-keyutils-keyring-store) docs, the key
+> management facility "is completely in-memory and will not persist across reboots". Prefer
+> `secret-service` for credentials that must survive a restart.

package/node_modules/@napi-rs/keyring/index.d.ts

@@ -0,0 +1,232 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+export declare class AsyncEntry {
+  /**
+   * Create an entry for the given service and username.
+   *
+   * The default credential builder is used.
+   *
+   * An optional [EntryOptions] bag controls platform-specific behavior; it is
+   * accepted on all platforms but currently only used on Linux, where it can
+   * pin the entry to a specific credential store.
+   */
+  constructor(service: string, username: string, options?: EntryOptions | undefined | null)
+  /**
+   * Create an entry for the given target, service, and username.
+   *
+   * The default credential builder is used.
+   *
+   * An optional [EntryOptions] bag controls platform-specific behavior; it is
+   * accepted on all platforms but currently only used on Linux, where it can
+   * pin the entry to a specific credential store.
+   */
+  static withTarget(target: string, service: string, username: string, options?: EntryOptions | undefined | null): AsyncEntry
+  /**
+   * Set the password for this entry.
+   *
+   * Can return an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  setPassword(password: string, signal?: AbortSignal | undefined | null): Promise<void>
+  /**
+   * Set the secret for this entry.
+   *
+   * Can return an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  setSecret(secret: Uint8Array, signal?: AbortSignal | undefined | null): Promise<void>
+  /**
+   * Retrieve the password saved for this entry.
+   *
+   * Returns no password if there isn't one.
+   *
+   * Can return an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  getPassword(signal?: AbortSignal | undefined | null): Promise<string | undefined>
+  /**
+   * Retrieve the secret saved for this entry.
+   *
+   * Returns no secret if there isn't one.
+   *
+   * Rejects if the credential store cannot be read, for example when it is
+   * locked or inaccessible.
+   *
+   * Can reject with an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  getSecret(signal?: AbortSignal | undefined | null): Promise<Uint8Array | undefined>
+  /**
+   * Delete the underlying credential for this entry.
+   *
+   * Resolves `true` if a credential was deleted, and `false` if there was no
+   * credential to delete.
+   *
+   * Rejects if the credential exists but could not be deleted, for example
+   * when the store is locked or inaccessible. A failed deletion is never
+   * reported as `false`, so a `false` result always means the credential is
+   * absent from the store.
+   *
+   * Can reject with an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   *
+   * Note: This does _not_ affect the lifetime of the [Entry]
+   * structure, which is controlled by Rust.  It only
+   * affects the underlying credential store.
+   */
+  deleteCredential(signal?: AbortSignal | undefined | null): Promise<boolean>
+  /** Alias for `deleteCredential` */
+  deletePassword(signal?: AbortSignal | undefined | null): Promise<boolean>
+}
+
+export declare class Entry {
+  /**
+   * Create an entry for the given service and username.
+   *
+   * The default credential builder is used.
+   *
+   * An optional [EntryOptions] bag controls platform-specific behavior; it is
+   * accepted on all platforms but currently only used on Linux, where it can
+   * pin the entry to a specific credential store.
+   */
+  constructor(service: string, username: string, options?: EntryOptions | undefined | null)
+  /**
+   * Create an entry for the given target, service, and username.
+   *
+   * The default credential builder is used.
+   *
+   * An optional [EntryOptions] bag controls platform-specific behavior; it is
+   * accepted on all platforms but currently only used on Linux, where it can
+   * pin the entry to a specific credential store.
+   */
+  static withTarget(target: string, service: string, username: string, options?: EntryOptions | undefined | null): Entry
+  /**
+   * Set the password for this entry.
+   *
+   * Can return an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  setPassword(password: string): void
+  /**
+   * Set the secret for this entry.
+   *
+   * Can return an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  setSecret(secret: Uint8Array): void
+  /**
+   * Retrieve the password saved for this entry.
+   *
+   * Returns no password if there isn't one.
+   *
+   * Can return an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  getPassword(): string | null
+  /**
+   * Retrieve the secret saved for this entry.
+   *
+   * Returns no secret if there isn't one.
+   *
+   * Throws if the credential store cannot be read, for example when it is
+   * locked or inaccessible.
+   *
+   * Can throw an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   */
+  getSecret(): Array<number> | null
+  /**
+   * Delete the underlying credential for this entry.
+   *
+   * Returns `true` if a credential was deleted, and `false` if there was no
+   * credential to delete.
+   *
+   * Throws if the credential exists but could not be deleted, for example
+   * when the store is locked or inaccessible. A failed deletion is never
+   * reported as `false`, so a `false` result always means the credential is
+   * absent from the store.
+   *
+   * Can throw an [Ambiguous](Error::Ambiguous) error
+   * if there is more than one platform credential
+   * that matches this entry.  This can only happen
+   * on some platforms, and then only if a third-party
+   * application wrote the ambiguous credential.
+   *
+   * Note: This does _not_ affect the lifetime of the [Entry]
+   * structure, which is controlled by Rust.  It only
+   * affects the underlying credential store.
+   */
+  deleteCredential(): boolean
+  /** Alias for `deleteCredential` */
+  deletePassword(): boolean
+}
+
+export interface Credential {
+  account: string
+  password: string
+}
+
+/**
+ * Options for creating an `Entry` or `AsyncEntry`.
+ *
+ * All options are platform-specific: they are accepted on every platform but
+ * only take effect where documented. Leaving an option absent keeps the
+ * current default behavior.
+ */
+export interface EntryOptions {
+  /** Linux-only options; ignored on other platforms. */
+  linux?: LinuxEntryOptions
+}
+
+/** find credentials by service name */
+export declare function findCredentials(service: string, target?: string | undefined | null): Array<Credential>
+
+/** find credentials by service name */
+export declare function findCredentialsAsync(service: string, target?: string | undefined | null, signal?: AbortSignal | undefined | null): Promise<Array<Credential>>
+
+/** Linux-only entry options; ignored on other platforms. */
+export interface LinuxEntryOptions {
+  /**
+   * Require a specific Linux credential store. When absent, the default
+   * auto-fallback selection is used (Secret Service, falling back to the
+   * kernel keyring). Requiring a store that is unavailable throws instead of
+   * falling back.
+   */
+  store?: LinuxStore
+}
+
+/**
+ * A Linux credential store that entries can be pinned to.
+ *
+ * Linux only; ignored on other platforms. Requiring a store that is
+ * unavailable on this machine throws instead of falling back.
+ */
+export type LinuxStore = 'secret-service' | 'keyutils'