@codesoul-co/hypha-adapters-local / remote-sandbox-provider-factory

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/remote-sandbox-provider-factory.ts
• Exports: 3

Using this module

Use the Remote sandbox provider factory module for binding external or local providers to Hypha ports. It exports 1 class, 1 constant, 1 interface.

Import from the package entrypoint

import {
  RemoteSandboxProviderFactory,
  REMOTE_SANDBOX_PROVIDER_ID,
} from '@codesoul-co/hypha-adapters-local';

import type {
  RemoteSandboxProviderFactoryOptions,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• Use the 1 type/interface export 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 1 constant/enum export provides stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
RemoteSandboxProviderFactory	class	new RemoteSandboxProviderFactory(options: RemoteSandboxProviderFactoryOptions): RemoteSandboxProviderFactory	Explicit composition boundary for a remote Sandbox deployment. Credentials remain late-bound through the transport credentialProvider so rotation does not require rebuilding the registry or retaining a token in the Factory.
REMOTE_SANDBOX_PROVIDER_ID	constant	const REMOTE_SANDBOX_PROVIDER_ID: "provider.remote-sandbox"	REMOTE SANDBOX PROVIDER ID constant exported by the remote-sandbox-provider-factory module.
RemoteSandboxProviderFactoryOptions	interface	interface RemoteSandboxProviderFactoryOptions extends Omit<RemoteSandboxHttpTransportOptions, 'baseUrl'>	Remote Sandbox Provider Factory Options interface with 10 public fields or methods.

RemoteSandboxProviderFactory

Explicit composition boundary for a remote Sandbox deployment. Credentials remain late-bound through the transport credentialProvider so rotation does not require rebuilding the registry or retaining a token in the Factory.

• Kind: class
• Import: import { RemoteSandboxProviderFactory } from '@codesoul-co/hypha-adapters-local';
• Source module: remote-sandbox-provider-factory

Declaration

export declare class RemoteSandboxProviderFactory implements SandboxProviderFactory {
    readonly providerType: "remote_sandbox";
    readonly providerId: string;
    constructor(options: RemoteSandboxProviderFactoryOptions);
    create(): SandboxProvider;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: RemoteSandboxProviderFactoryOptions): RemoteSandboxProviderFactory	Creates an instance of this class.
create	method	create(): SandboxProvider	Public method; parameters and return type are shown in the signature.
providerId	property	readonly providerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerType	property	readonly providerType: "remote_sandbox"	Public property; its type, readonly modifier and optionality are shown in the signature.

REMOTE_SANDBOX_PROVIDER_ID

REMOTE SANDBOX PROVIDER ID constant exported by the remote-sandbox-provider-factory module.

• Kind: constant
• Import: import { REMOTE_SANDBOX_PROVIDER_ID } from '@codesoul-co/hypha-adapters-local';
• Source module: remote-sandbox-provider-factory

Declaration

export declare const REMOTE_SANDBOX_PROVIDER_ID: "provider.remote-sandbox";

RemoteSandboxProviderFactoryOptions

Remote Sandbox Provider Factory Options interface with 10 public fields or methods.

• Kind: interface
• Import: import type { RemoteSandboxProviderFactoryOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: remote-sandbox-provider-factory

Declaration

export interface RemoteSandboxProviderFactoryOptions extends Omit<RemoteSandboxHttpTransportOptions, 'baseUrl'> {
    baseUrl: string;
    providerId?: string;
    transport?: RemoteSandboxTransport;
}

Contract members

Member	Kind	Signature	Description
baseUrl	property	baseUrl: string	Public property; its type, readonly modifier and optionality are shown in the signature.
credentialProvider	method	credentialProvider(): Promise<RemoteSandboxHttpCredential>	Public method; parameters and return type are shown in the signature.
fetch	method	fetch?(url: string, request: RemoteSandboxHttpRequest): Promise<RemoteSandboxHttpResponse>	Public method; parameters and return type are shown in the signature.
maxCredentialTtlMs	property	maxCredentialTtlMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxNdjsonLineCharacters	property	maxNdjsonLineCharacters?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
minCredentialRemainingMs	property	minCredentialRemainingMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): number	Public method; parameters and return type are shown in the signature.
providerId	property	providerId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
requestTimeoutMs	property	requestTimeoutMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
transport	property	transport?: RemoteSandboxTransport	Public property; its type, readonly modifier and optionality are shown in the signature.