@codesoul-co/hypha-memory / managed-credentials

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/managed-credentials.ts
• Exports: 5

Using this module

Use the Managed credentials module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 function, 3 interfaces.

Import from the package entrypoint

import {
  RenewableCredentialManager,
  staticCredentialProvider,
} from '@codesoul-co/hypha-memory';

import type {
  ManagedCredentialLease,
  RenewableCredentialManagerOptions,
  RenewableCredentialProvider,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 3 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 1 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
RenewableCredentialManager	class	new RenewableCredentialManager(options: RenewableCredentialManagerOptions): RenewableCredentialManager	Renewable Credential Manager class with 4 public constructor or member entries; its exact declarations are listed below.
staticCredentialProvider	function	staticCredentialProvider(token: string, tokenType: ManagedCredentialLease["tokenType"]): RenewableCredentialProvider	Static Credential Provider function with 1 public call signature; parameters and return types are listed below.
ManagedCredentialLease	interface	interface ManagedCredentialLease	Managed Credential Lease interface with 3 public fields or methods.
RenewableCredentialManagerOptions	interface	interface RenewableCredentialManagerOptions	Renewable Credential Manager Options interface with 3 public fields or methods.
RenewableCredentialProvider	interface	interface RenewableCredentialProvider	Renewable Credential Provider interface with 3 public fields or methods.

RenewableCredentialManager

Renewable Credential Manager class with 4 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { RenewableCredentialManager } from '@codesoul-co/hypha-memory';
• Source module: managed-credentials

Declaration

export declare class RenewableCredentialManager {
    constructor(options: RenewableCredentialManagerOptions);
    get(signal?: AbortSignal): Promise<ManagedCredentialLease>;
    invalidate(): void;
    close(signal?: AbortSignal): Promise<void>;
}

Public members

Member	Kind	Signature	Description
close	method	close(signal?: AbortSignal): Promise<void>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: RenewableCredentialManagerOptions): RenewableCredentialManager	Creates an instance of this class.
get	method	get(signal?: AbortSignal): Promise<ManagedCredentialLease>	Public method; parameters and return type are shown in the signature.
invalidate	method	invalidate(): void	Public method; parameters and return type are shown in the signature.

staticCredentialProvider

Static Credential Provider function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { staticCredentialProvider } from '@codesoul-co/hypha-memory';
• Source module: managed-credentials

Declaration

export declare function staticCredentialProvider(token: string, tokenType: ManagedCredentialLease['tokenType']): RenewableCredentialProvider;

Call signature

staticCredentialProvider(token: string, tokenType: ManagedCredentialLease["tokenType"]): RenewableCredentialProvider

Parameters

Parameter	Type	Required	Description
token	string	Yes	Required parameter; accepted values are defined by the type column.
tokenType	"api_token" | "oauth_bearer"	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: RenewableCredentialProvider
• Description: The return contract is defined by the type shown above.

ManagedCredentialLease

Managed Credential Lease interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ManagedCredentialLease } from '@codesoul-co/hypha-memory';
• Source module: managed-credentials

Declaration

export interface ManagedCredentialLease {
    token: string;
    tokenType: 'api_token' | 'oauth_bearer';
    expiresAt?: string;
}

Contract members

Member	Kind	Signature	Description
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
token	property	token: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tokenType	property	tokenType: "api_token" | "oauth_bearer"	Public property; its type, readonly modifier and optionality are shown in the signature.

RenewableCredentialManagerOptions

Renewable Credential Manager Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { RenewableCredentialManagerOptions } from '@codesoul-co/hypha-memory';
• Source module: managed-credentials

Declaration

export interface RenewableCredentialManagerOptions {
    provider: RenewableCredentialProvider;
    refreshSkewMs?: number;
    now?: () => Date;
}

Contract members

Member	Kind	Signature	Description
now	method	now?(): Date	Public method; parameters and return type are shown in the signature.
provider	property	provider: RenewableCredentialProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
refreshSkewMs	property	refreshSkewMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

RenewableCredentialProvider

Renewable Credential Provider interface with 3 public fields or methods.

• Kind: interface
• Import: import type { RenewableCredentialProvider } from '@codesoul-co/hypha-memory';
• Source module: managed-credentials

Declaration

export interface RenewableCredentialProvider {
    acquire(signal?: AbortSignal): Promise<ManagedCredentialLease>;
    revoke?(lease: ManagedCredentialLease, signal?: AbortSignal): Promise<void>;
    close?(): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
acquire	method	acquire(signal?: AbortSignal): Promise<ManagedCredentialLease>	Public method; parameters and return type are shown in the signature.
close	method	close?(): Promise<void>	Public method; parameters and return type are shown in the signature.
revoke	method	revoke?(lease: ManagedCredentialLease, signal?: AbortSignal): Promise<void>	Public method; parameters and return type are shown in the signature.