@oaiz/sdk 0.0.0-stage → 0.1.4128

package/dist/test.d.mts

@@ -0,0 +1,63 @@
+import { Plugin } from "vite";
+interface OaizTestOptions {
+  /** The app's tests folder, relative to the Vite root: `databases/` and `members.json`. */
+  directory?: string;
+}
+/**
+ * Serves OAIZ sign-in, row requests and function calls under `/__oaiz-test/` from local test
+ * databases, on the dev server of `vite --mode oaiz-test` only. The folder is read on the first
+ * such request and again on every reset request.
+ */
+export declare function oaizTest({ directory }?: OaizTestOptions): Plugin;
+interface OaizTestServerOptions {
+  /**
+   * The app's tests folder: `databases/<id>.sql` is the schema of the database with that id,
+   * `databases/<id>.seed.sql` its seed, and `members.json` who can sign in.
+   */
+  directory: string;
+}
+/** Answers an app's OAIZ requests under `/__oaiz-test/` from one local test database per id. */
+interface OaizTestServer {
+  handle(request: Request): Promise<Response>;
+  /** An access token that signs memberId in to the app clientId. */
+  issueToken(memberId: string, clientId: string): string;
+  /**
+   * Reads the folder again, then empties every open database and runs its seed. A database whose
+   * schema file changed is built again; one whose schema file is gone is closed.
+   */
+  reset(): Promise<void>;
+  close(): Promise<void>;
+}
+/**
+ * Reads the folder and signs in its members. A database is built from its schema and seeded on its
+ * first request, so a test that reads one of an app's databases runs one PGlite.
+ */
+export declare function createTestServer(options: OaizTestServerOptions): Promise<OaizTestServer>;
+/** A team of the test organisation. */
+interface OaizTestTeam {
+  id: string;
+  name: string;
+}
+/** A member of the test organisation who can sign in to the app. */
+interface OaizTestMember {
+  id: string;
+  name: string;
+  /** An address on `example.test`, never a real one. */
+  email: string;
+  /** The ids of the member's teams. */
+  teams?: string[];
+  /** The member's organisation role; `member` when omitted. */
+  role?: "member" | "administrator";
+}
+/** The grant the app has on one database. */
+type OaizTestGrant = "view" | "edit";
+/**
+ * `tests/members.json`: who can sign in, and the app's grant on each database. A database the
+ * grants leave out gets `edit`.
+ */
+interface OaizTestMembers {
+  teams: OaizTestTeam[];
+  members: OaizTestMember[];
+  grants: Record<string, OaizTestGrant>;
+}
+export type { OaizTestGrant, OaizTestMember, OaizTestMembers, OaizTestOptions, OaizTestServer, OaizTestServerOptions, OaizTestTeam };