rename: highlevel -> porcelain, OPA -> OPAClient

Signed-off-by: Stephan Renatus <stephan@styra.com>

Author: srenatus

.genignore

@@ -1,5 +1,5 @@
 LICENSE
 /src/helpers
-/src/highlevel
+/src/porcelain
 /src/index.ts
 /.eslintrc.js

.gitignore

@@ -8,4 +8,4 @@
 /cjs
 /node_modules
 /.tsbuildinfo
-/highlevel
+/porcelain

README.md

@@ -29,11 +29,11 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 All the code examples that follow assume that the high-level SDK module has been imported, and that an `OPA` instance was created:
 
 ```ts
-import { OPA } from "opa/highlevel";
+import { OPAClient } from "@styra/opa";
 
 const serverURL = "http://opa-host:8181";
 const path = "authz/allow";
-const opa = new OPA(serverURL);
+const opa = new OPAClient(serverURL);
 ```
 
 ### Simple query
@@ -70,7 +70,7 @@ Input is provided as a second (optional) argument to `authorize`:
 
 ```ts
 const input = { user: "alice" };
-const allowed = await new OPA(serverURL).authorize(path, input);
+const allowed = await opa.authorize(path, input);
 console.log(allowed ? "allowed!" : "denied!");
 ```
 

src/highlevel/index.ts

@@ -3,4 +3,4 @@
  */
 
 export * from "./lib/config";
-export * from "./highlevel";
+export * from "./porcelain";

src/index.ts

@@ -0,0 +1 @@
+export * from "./porcelain";

src/porcelain/index.ts

@@ -20,11 +20,11 @@ function implementsToInput(object: any): object is ToInput {
   return u.toInput !== undefined && typeof u.toInput == "function";
 }
 
-/** OPA is the starting point for using the high-level API.
+/** OPAClient is the starting point for using the high-level API.
  *
  * Use {@link Opa} if you need some low-level customization.
  */
-export class OPA {
+export class OPAClient {
   private opa: Opa;
 
   constructor(serverURL: string) {

src/highlevel/highlevel.ts renamed to src/porcelain/porcelain.ts

@@ -1,7 +1,7 @@
 import { describe, before, after, it } from "node:test";
 import assert from "node:assert";
 import { GenericContainer, StartedTestContainer, Wait } from "testcontainers";
-import { OPA, ToInput, Input, Result } from "../src/highlevel";
+import { OPAClient, ToInput, Input, Result } from "../src/porcelain";
 
 // Run these locally, with debug output from testcontainers, like this:
 // DEBUG='testcontainers*' node --require ts-node/register --test tests/**/*.ts
@@ -54,17 +54,20 @@ it_is := true
   });
 
   it("can be called without types, without input", async () => {
-    const res = await new OPA(serverURL).authorize("test/p_bool");
+    const res = await new OPAClient(serverURL).authorize("test/p_bool");
     assert.strictEqual(res, true);
   });
 
   it("can be called with input==false", async () => {
-    const res = await new OPA(serverURL).authorize("test/p_bool_false", false);
+    const res = await new OPAClient(serverURL).authorize(
+      "test/p_bool_false",
+      false,
+    );
     assert.strictEqual(res, true);
   });
 
   it("supports rules with slashes", async () => {
-    const res = await new OPA(serverURL).authorize(
+    const res = await new OPAClient(serverURL).authorize(
       "has/weird%2fpackage/but/it_is",
     );
     assert.strictEqual(res, true);
@@ -79,7 +82,7 @@ it_is := true
       foo: string;
     }
     const inp: myInput = { name: "alice", list: [1, 2, true] };
-    const res = await new OPA(serverURL).authorize<myInput, myResult>(
+    const res = await new OPAClient(serverURL).authorize<myInput, myResult>(
       "test/compound_input",
       inp,
     );
@@ -91,7 +94,7 @@ it_is := true
       type: string;
     }
     const inp = true;
-    const res = await new OPA(serverURL).authorize<boolean, typeResult>(
+    const res = await new OPAClient(serverURL).authorize<boolean, typeResult>(
       "test/has_type",
       inp,
     );
@@ -114,7 +117,7 @@ it_is := true
     interface myResult {
       foo: string;
     }
-    const res = await new OPA(serverURL).authorize<A, myResult>(
+    const res = await new OPAClient(serverURL).authorize<A, myResult>(
       "test/compound_input",
       inp,
     );
@@ -141,15 +144,15 @@ it_is := true
     interface myResult {
       foo: string;
     }
-    const res = await new OPA(serverURL).authorize<A, myResult>(
+    const res = await new OPAClient(serverURL).authorize<A, myResult>(
       "test/compound_input",
       inp,
     );
     assert.deepStrictEqual(res, { foo: "bar" });
   });
 
   it("supports result class implementing FromResult", async () => {
-    const res = await new OPA(serverURL).authorize<any, boolean>(
+    const res = await new OPAClient(serverURL).authorize<any, boolean>(
       "test/compound_result",
       undefined, // input
       (r?: Result) => (r as Record<string, any>)["allowed"] ?? false,