A utility class for building the PolywrapClient config.
Supports building configs using method chaining or imperatively.
Initialize a ClientConfigBuilder using the constructor
// start with a blank slate (typical usage)
const builder = new PolywrapClientConfigBuilder();
Add client configuration with add, or flexibly mix and match builder configuration methods to add and remove configuration items.
// add multiple items to the configuration using the catch-all `add` method
builder.add({
envs: {},
interfaces: {},
redirects: {},
wrappers: {},
packages: {},
resolvers: [],
});
// add or remove items by chaining method calls
builder
.setPackage("wrap://plugin/package", httpPlugin({}) as IWrapPackage)
.removePackage("wrap://plugin/package")
.setPackages({
"wrap://plugin/http": httpPlugin({}) as IWrapPackage,
"wrap://plugin/filesystem": fileSystemPlugin({}) as IWrapPackage,
});
You can add the entire default client configuration bundle at once with addDefaults
builder.addDefaults();
Finally, build a ClientConfig or CoreClientConfig to pass to the PolywrapClient constructor.
// accepted by either the PolywrapClient or the PolywrapCoreClient
let coreClientConfig = builder.build();
// build with a custom cache
coreClientConfig = builder.build({
resolutionResultCache: new ResolutionResultCache(),
});
// or build with a custom resolver
coreClientConfig = builder.build({
resolver: RecursiveResolver.from([]),
});
A complete example using all or most of the available methods.
// init
const builder = new PolywrapClientConfigBuilder();
// add the default bundle first to override its entries later
builder.addDefaults();
// add many config items at once
builder.add({
envs: {},
interfaces: {},
redirects: {},
wrappers: {},
packages: {},
resolvers: [],
});
// add and remove wrappers
builder
.setWrapper(
"wrap://authority/wrapper",
await WasmWrapper.from(
new Uint8Array([1, 2, 3]),
new Uint8Array([1, 2, 3])
)
)
.removeWrapper("wrap://authority/wrapper")
.setWrappers({
"wrap://authority/wrapper": await WasmWrapper.from(
new Uint8Array([1, 2, 3]),
new Uint8Array([1, 2, 3])
),
});
// add and remove wrap packages
builder
.setPackage("wrap://plugin/package", httpPlugin({}) as IWrapPackage)
.removePackage("wrap://plugin/package")
.setPackages({
"wrap://plugin/package": httpPlugin({}) as IWrapPackage,
});
// add and remove Envs
builder
.addEnv("wrap://authority/wrapper", { key: "value" })
.removeEnv("wrap://authority/wrapper")
.addEnvs({
"wrap://authority/wrapper": { key: "value" },
});
// override existing Env, or add new Env if one is not registered at URI
builder.setEnv("wrap://authority/wrapper", { key: "value" });
// add or remove registration for an implementation of an interface
builder
.addInterfaceImplementation(
"wrap://authority/interface",
"wrap://authority/wrapper"
)
.removeInterfaceImplementation(
"wrap://authority/interface",
"wrap://authority/wrapper"
)
.addInterfaceImplementations("wrap://authority/interface", [
"wrap://authority/wrapper",
]);
// add or remove URI redirects
builder
.setRedirect("wrap://authority/from", "wrap://authority/to")
.removeRedirect("wrap://authority/from")
.setRedirects({
"wrap://authority/from": "wrap://authority/to",
});
// add resolvers
builder.addResolver(RecursiveResolver.from([]));
builder.addResolvers([]);
// build
const clientConfig = builder.build();
/**
* Instantiate a PolywrapClientConfigBuilder
*/
constructor()
/**
* Add a partial BuilderConfig
* This is equivalent to calling each of the plural add functions: `addEnvs`, `setWrappers`, etc.
*
* @param config: a partial BuilderConfig
* @returns ClientConfigBuilder (mutated self)
*/
add(config: Partial<BuilderConfig>): ClientConfigBuilder;
/**
* Add an embedded wrapper
*
* @param uri: uri of wrapper
* @param wrapper: wrapper to be added
* @returns ClientConfigBuilder (mutated self)
*/
setWrapper(uri: string, wrapper: Wrapper): ClientConfigBuilder;
/**
* Add one or more embedded wrappers.
* This is equivalent to calling setWrapper for each wrapper.
*
* @param uriWrappers: an object where keys are uris and wrappers are value
* @returns ClientConfigBuilder (mutated self)
*/
setWrappers(uriWrappers: Record<string, Wrapper>): ClientConfigBuilder;
/**
* Remove an embedded wrapper
*
* @param uri: the wrapper's URI
* @returns ClientConfigBuilder (mutated self)
*/
removeWrapper(uri: string): ClientConfigBuilder;
/**
* Add an embedded wrap package
*
* @param uri: uri of wrapper
* @param wrapPackage: package to be added
* @returns ClientConfigBuilder (mutated self)
*/
setPackage(uri: string, wrapPackage: IWrapPackage): ClientConfigBuilder;
/**
* Add one or more embedded wrap packages
* This is equivalent to calling setPackage for each package
*
* @param uriPackages: an object where keys are uris and packages are value
* @returns ClientConfigBuilder (mutated self)
*/
setPackages(uriPackages: Record<string, IWrapPackage>): ClientConfigBuilder;
/**
* Remove an embedded wrap package
*
* @param uri: the package's URI
* @returns ClientConfigBuilder (mutated self)
*/
removePackage(uri: string): ClientConfigBuilder;
/**
* Add an Env.
* If an Env is already associated with the uri, it is modified.
*
* @param uri: the wrapper's URI to associate with the Env
* @param env: an object with the env variables for the uri
* @returns ClientConfigBuilder (mutated self)
*/
addEnv(uri: string, env: Record<string, unknown>): ClientConfigBuilder;
/**
* Add one or more Envs
* This is equivalent to calling addEnv for each Env
*
* @param uriEnvs: and object where key is the uri and value is the another object with the env variables for the uri
* @returns ClientConfigBuilder (mutated self)
*/
addEnvs(
uriEnvs: Record<string, Record<string, unknown>>
): ClientConfigBuilder;
/**
* Remove an Env
*
* @param uri: the URI associated with the Env
* @returns ClientConfigBuilder (mutated self)
*/
removeEnv(uri: string): ClientConfigBuilder;
/**
* Add an Env.
* If an Env is already associated with the uri, it is replaced.
*
* @param uri: the wrapper's URI to associate with the Env
* @param env: an object with the environment variables for the uri
* @returns ClientConfigBuilder (mutated self)
*/
setEnv(uri: string, env: Record<string, unknown>): ClientConfigBuilder;
/**
* Register an implementation of a single interface
*
* @param interfaceUri: the URI of the interface
* @param implementationUri: the URI of the implementation
* @returns ClientConfigBuilder (mutated self)
*/
addInterfaceImplementation(
interfaceUri: string,
implementationUri: string
): ClientConfigBuilder;
/**
* Register one or more implementation of a single interface
*
* @param interfaceUri: the URI of the interface
* @param implementationUris: a list of URIs for the implementations
* @returns ClientConfigBuilder (mutated self)
*/
addInterfaceImplementations(
interfaceUri: string,
implementationUris: Array<string>
): ClientConfigBuilder;
/**
* Remove an implementation of a single interface
*
* @param interfaceUri: the URI of the interface
* @param implementationUri: the URI of the implementation
* @returns ClientConfigBuilder (mutated self)
*/
removeInterfaceImplementation(
interfaceUri: string,
implementationUri: string
): ClientConfigBuilder;
/**
* Add a redirect from one URI to another
*
* @param from: the URI to redirect from
* @param to: the URI to redirect to
* @returns ClientConfigBuilder (mutated self)
*/
setRedirect(from: string, to: string): ClientConfigBuilder;
/**
* Add an array of URI redirects
*
* @param redirects: an object where key is from and value is to
* @returns ClientConfigBuilder (mutated self)
*/
setRedirects(redirects: Record<string, string>): ClientConfigBuilder;
/**
* Remove a URI redirect
*
* @param from: the URI that is being redirected
* @returns ClientConfigBuilder (mutated self)
*/
removeRedirect(from: string): ClientConfigBuilder;
/**
* Add a URI Resolver, capable of resolving a URI to a wrapper
*
* @remarks
* A UriResolverLike can be any one of:
* IUriResolver<unknown>
* | IUriRedirect<string>
* | IUriPackage<string>
* | IUriWrapper<string>
* | UriResolverLike[];
*
* @param resolver: A UriResolverLike
* @returns ClientConfigBuilder (mutated self)
*/
addResolver(resolver: UriResolverLike): ClientConfigBuilder;
/**
* Add one or more URI Resolvers, capable of resolving URIs to wrappers
*
* @remarks
* A UriResolverLike can be any one of:
* IUriResolver<unknown>
* | IUriRedirect<string>
* | IUriPackage<string>
* | IUriWrapper<string>
* | UriResolverLike[];
*
* @param resolvers: A list of UriResolverLike
* @returns ClientConfigBuilder (mutated self)
*/
addResolvers(resolvers: UriResolverLike[]): ClientConfigBuilder;
/**
* Add the default configuration bundle
*
* @returns ClientConfigBuilder (mutated self)
*/
addDefaults(): ClientConfigBuilder;
/**
* Add a default configuration bundle
*
* @returns Promise<ClientConfigBuilder> (mutated self)
*/
addBundle(bundle: BundleName): ClientConfigBuilder;
/**
* Build a sanitized core client configuration that can be passed to the PolywrapClient or PolywrapCoreClient constructors
*
* @param options - Use a custom wrapper cache or resolver
* @returns CoreClientConfig that results from applying all the steps in the builder pipeline
*/
build(options?: BuildOptions): CoreClientConfig;
export type BundleName = "sys" | "web3";
Generated using TypeDoc