Merge pull request #47 from polywrap/nk/refactor-config-builder

fix!: client-config-builder name

Author: dOrgJelli

CHANGELOG.md

@@ -21,6 +21,14 @@
   * Valid config bundle packages are expected to export a `bundle` value, which is of type `Bundle`.
 
 ## Breaking Changes
+**`@polywrap/client-config-builder-js`:**
+* [PR-47](https://github.com/polywrap/javascript-client/pull/47) **Renaming For Improved Accuracy**
+  * Renamed `ClientConfigBuilder` to `PolywrapClientConfigBuilder`
+  * Renamed `IClientConfigBuilder` to `ClientConfigBuilder`
+  * Renamed `addWrapper(s)` to `setWrapper(s)`
+  * Renamed `addPackage(s)` to `setPackage(s)`
+  * Renamed `addRedirect(s)` to `setRedirect(s)`
+
 **`@polywrap/core-js`:**
 * [PR-32](https://github.com/polywrap/javascript-client/pull/32) **Rename `getEnvFromUriHistory` to `getEnvFromResolutionPath`**
 

packages/client/README.md

@@ -30,7 +30,7 @@ Use the PolywrapClient [constructor](#constructor) to instantiate the client wit
 Use the `@polywrap/client-config-builder-js` package to build a custom configuration for your project.
 
 ```ts
-  const config = new ClientConfigBuilder().addDefaults().build();
+  const config = new PolywrapClientConfigBuilder().addDefaults().build();
 
   const client = new PolywrapClient(config);
 ```
@@ -57,7 +57,7 @@ Invoke a wrapper.
 
 ## Configuration
 
-Below you will find a reference of object definitions which can be used to configure the Polywrap client. Please note that the intended way of configuring the client is to use the `ClientConfigBuilder`, as explained above.
+Below you will find a reference of object definitions which can be used to configure the Polywrap client. Please note that the intended way of configuring the client is to use the `PolywrapClientConfigBuilder`, as explained above.
 
 ## PolywrapClient
 

packages/client/examples/quickstart.ts

@@ -1,4 +1,4 @@
-import { ClientConfigBuilder, PolywrapClient } from "../build";
+import { PolywrapClientConfigBuilder, PolywrapClient } from "../build";
 
 export function instantiate(): PolywrapClient {
   // /* $: quickstart-instantiate */  import { PolywrapClient } from "@polywrap/client-js";
@@ -11,7 +11,7 @@ export function instantiate(): PolywrapClient {
 
 export function configure(): PolywrapClient {
   // $start: quickstart-configure
-  const config = new ClientConfigBuilder().addDefaults().build();
+  const config = new PolywrapClientConfigBuilder().addDefaults().build();
 
   const client = new PolywrapClient(config);
   // $end

packages/client/readme/README.md

@@ -43,7 +43,7 @@ $snippet: quickstart-invoke
 
 ## Configuration
 
-Below you will find a reference of object definitions which can be used to configure the Polywrap client. Please note that the intended way of configuring the client is to use the `ClientConfigBuilder`, as explained above.
+Below you will find a reference of object definitions which can be used to configure the Polywrap client. Please note that the intended way of configuring the client is to use the `PolywrapClientConfigBuilder`, as explained above.
 
 ## PolywrapClient
 

packages/client/src/PolywrapClient.ts

@@ -24,7 +24,7 @@ import {
   WrapManifest,
 } from "@polywrap/wrap-manifest-types-js";
 import { Tracer, TracerConfig } from "@polywrap/tracing-js";
-import { ClientConfigBuilder } from "@polywrap/client-config-builder-js";
+import { PolywrapClientConfigBuilder } from "@polywrap/client-config-builder-js";
 
 export class PolywrapClient extends PolywrapCoreClient {
   // $start: PolywrapClient-constructor
@@ -34,7 +34,7 @@ export class PolywrapClient extends PolywrapCoreClient {
    * @param config - a client configuration
    */
   constructor(config?: CoreClientConfig) /* $ */ {
-    super(config ?? new ClientConfigBuilder().addDefaults().build());
+    super(config ?? new PolywrapClientConfigBuilder().addDefaults().build());
   }
 
   /**

packages/client/src/__tests__/core/embedded-package.spec.ts

@@ -5,7 +5,7 @@ import { InMemoryFileReader, WasmPackage } from "@polywrap/wasm-js";
 import { IWrapPackage } from "@polywrap/core-js";
 import { Result, ResultErr, ResultOk } from "@polywrap/result";
 import { PolywrapClient } from "../../PolywrapClient";
-import { ClientConfigBuilder } from "@polywrap/client-config-builder-js";
+import { PolywrapClientConfigBuilder } from "@polywrap/client-config-builder-js";
 
 jest.setTimeout(200000);
 
@@ -20,9 +20,9 @@ describe("Embedded package", () => {
     );
 
     let wrapPackage = WasmPackage.from(manifestBuffer, wasmModuleBuffer);
-    const config = new ClientConfigBuilder()
+    const config = new PolywrapClientConfigBuilder()
       .addDefaults()
-      .addPackage(wrapperUri, wrapPackage)
+      .setPackage(wrapperUri, wrapPackage)
       .build();
     const client = new PolywrapClient(config);
 
@@ -141,9 +141,9 @@ const testEmbeddedPackageWithFile = async (
   filePath: string,
   fileText: string
 ) => {
-  const config = new ClientConfigBuilder()
+  const config = new PolywrapClientConfigBuilder()
     .addDefaults()
-    .addPackage(wrapperUri, wrapPackage)
+    .setPackage(wrapperUri, wrapPackage)
     .build();
 
   const client = new PolywrapClient(config);

packages/client/src/__tests__/core/embedded-wrapper.spec.ts

@@ -5,7 +5,7 @@ import { WasmWrapper, InMemoryFileReader } from "@polywrap/wasm-js";
 import { Wrapper } from "@polywrap/core-js";
 import { Result, ResultErr, ResultOk } from "@polywrap/result";
 import { PolywrapClient } from "../../PolywrapClient";
-import { ClientConfigBuilder } from "@polywrap/client-config-builder-js";
+import { PolywrapClientConfigBuilder } from "@polywrap/client-config-builder-js";
 
 jest.setTimeout(200000);
 
@@ -22,9 +22,9 @@ describe("Embedded wrapper", () => {
       wasmModuleBuffer
     );
 
-    const config = new ClientConfigBuilder()
+    const config = new PolywrapClientConfigBuilder()
       .addDefaults()
-      .addWrapper(simpleWrapperUri, wrapper)
+      .setWrapper(simpleWrapperUri, wrapper)
       .build();
     const client = new PolywrapClient(config);
 
@@ -135,9 +135,9 @@ const testEmbeddedWrapperWithFile = async (
   filePath: string,
   fileText: string
 ) => {
-  const config = new ClientConfigBuilder()
+  const config = new PolywrapClientConfigBuilder()
     .addDefaults()
-    .addWrapper(simpleWrapperUri, wrapper)
+    .setWrapper(simpleWrapperUri, wrapper)
     .build();
 
   const client = new PolywrapClient(config);

packages/client/src/__tests__/core/error-structure.spec.ts

@@ -8,7 +8,7 @@ import { WrapError, WrapErrorCode } from "@polywrap/core-js";
 import { mockPluginRegistration } from "../helpers";
 import { msgpackDecode, msgpackEncode } from "@polywrap/msgpack-js";
 import {
-  ClientConfigBuilder,
+  PolywrapClientConfigBuilder
 } from "@polywrap/client-config-builder-js";
 import * as SysBundle from "@polywrap/sys-config-bundle-js";
 
@@ -162,9 +162,9 @@ describe("Error structure", () => {
       });
 
       test("Subinvoke error two layers deep", async () => {
-        const config = new ClientConfigBuilder()
+        const config = new PolywrapClientConfigBuilder()
           .addDefaults()
-          .addRedirects({
+          .setRedirects({
             "ens/imported-invoke.eth": asInvokeWrapperUri.uri,
             "ens/imported-subinvoke.eth": asSubinvokeWrapperUri.uri,
           })
@@ -338,9 +338,9 @@ describe("Error structure", () => {
       });
 
       test("Subinvoke error two layers deep", async () => {
-        const config = new ClientConfigBuilder()
+        const config = new PolywrapClientConfigBuilder()
           .addDefaults()
-          .addRedirects({
+          .setRedirects({
             "ens/imported-invoke.eth": rsInvokeWrapperUri.uri,
             "ens/imported-subinvoke.eth": rsSubinvokeWrapperUri.uri,
           })
@@ -405,9 +405,9 @@ describe("Error structure", () => {
     describe("Plugin wrapper", () => {
       const createClient = async () => {
         const mockPlugin = mockPluginRegistration("plugin/mock")
-        const config = new ClientConfigBuilder()
+        const config = new PolywrapClientConfigBuilder()
           .addDefaults()
-          .addPackage(mockPlugin.uri.uri, mockPlugin.package)
+          .setPackage(mockPlugin.uri.uri, mockPlugin.package)
           .build();
         return new PolywrapClient(config);
       };

packages/client/src/__tests__/core/sanity.spec.ts

@@ -6,15 +6,15 @@ import { IUriPackage, IUriRedirect } from "@polywrap/core-js";
 import { ResultErr } from "@polywrap/result";
 import { StaticResolver, UriResolverLike } from "@polywrap/uri-resolvers-js";
 import { WasmPackage } from "@polywrap/wasm-js";
-import { ClientConfigBuilder } from "@polywrap/client-config-builder-js";
+import { PolywrapClientConfigBuilder } from "@polywrap/client-config-builder-js";
 import { CoreClientConfig } from "@polywrap/core-js";
 
 jest.setTimeout(200000);
 
 describe("sanity", () => {
   test("default client config", () => {
     const clientConfig = new PolywrapClient().getConfig();
-    const expectedConfig = new ClientConfigBuilder().addDefaults().build();
+    const expectedConfig = new PolywrapClientConfigBuilder().addDefaults().build();
 
     expect(
       JSON.stringify(clientConfig, null, 2)

packages/client/src/__tests__/core/type-test-cases.ts

@@ -2,15 +2,15 @@ import { memoryStoragePlugin, ErrResult } from "../helpers";
 import { PolywrapClient } from "../../PolywrapClient";
 
 import BigNumber from "bignumber.js";
-import { ClientConfigBuilder } from "@polywrap/client-config-builder-js";
+import { PolywrapClientConfigBuilder } from "@polywrap/client-config-builder-js";
 import { GetPathToTestWrappers } from "@polywrap/test-cases";
 
 export const typeTestCases = (implementation: string) => {
   describe("types test cases", () => {
     test(`asyncify ${implementation}`, async () => {
-      const config = new ClientConfigBuilder()
+      const config = new PolywrapClientConfigBuilder()
         .addDefaults()
-        .addPackage(
+        .setPackage(
           "wrap://ens/memory-storage.polywrap.eth",
           memoryStoragePlugin()
         )