Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
import { CloseCursor, ReadCursor, RunQuery } from "./query";
import { Schemas } from "./schema";

export const InterfaceDeclarations = {
CloseCursor,
ReadCursor,
RunQuery,
Schemas,
};

export { Datum } from "./datum";
export { Query } from "./query";
export {
Expand All @@ -6,6 +16,7 @@ export {
Schema,
SchemaDefinition,
SchemaInstance,
Schemas,
} from "./schema";
export { Selection, SingleSelection, Table } from "./selection";
export { Stream } from "./stream";
Expand Down
55 changes: 55 additions & 0 deletions src/tests/root-declarations.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import { execFileSync } from "node:child_process";
import path from "node:path";
import { expect } from "chai";
import * as declarations from "..";
import * as query from "../query";
import * as schema from "../schema";

const packageRoot = path.resolve(__dirname, "../..");
const declarationKeys = ["CloseCursor", "ReadCursor", "RunQuery", "Schemas"];

function verifyImportOrder(firstEntry: string, secondEntry: string) {
const source = `
const assert = require("node:assert/strict");
const path = require("node:path");
const packageRoot = ${JSON.stringify(packageRoot)};
const first = require(path.join(packageRoot, ${JSON.stringify(firstEntry)}));
const second = require(path.join(packageRoot, ${JSON.stringify(secondEntry)}));
const root = ${JSON.stringify(firstEntry)} === "dist/index.js" ? first : second;
const query = require(path.join(packageRoot, "dist/query.js"));
const schema = require(path.join(packageRoot, "dist/schema.js"));
assert.deepStrictEqual(Object.keys(root.InterfaceDeclarations).sort(), ${JSON.stringify(declarationKeys.sort())});
assert.strictEqual(root.InterfaceDeclarations.CloseCursor, query.CloseCursor);
assert.strictEqual(root.InterfaceDeclarations.ReadCursor, query.ReadCursor);
assert.strictEqual(root.InterfaceDeclarations.RunQuery, query.RunQuery);
assert.strictEqual(root.InterfaceDeclarations.Schemas, schema.Schemas);
assert.strictEqual(root.Schemas, schema.Schemas);
`;
execFileSync(process.execPath, ["-e", source]);
}

describe("root interface declarations", () => {
it("exports every canonical provider declaration", () => {
expect(
Object.keys(declarations.InterfaceDeclarations).sort(),
).to.deep.equal(declarationKeys.sort());
expect(declarations.InterfaceDeclarations.CloseCursor).to.equal(
query.CloseCursor,
);
expect(declarations.InterfaceDeclarations.ReadCursor).to.equal(
query.ReadCursor,
);
expect(declarations.InterfaceDeclarations.RunQuery).to.equal(
query.RunQuery,
);
expect(declarations.InterfaceDeclarations.Schemas).to.equal(schema.Schemas);
expect(declarations.Schemas).to.equal(schema.Schemas);
});

it("keeps canonical declarations in both import orders", () => {
verifyImportOrder("dist/index.js", "dist/schema.js");
verifyImportOrder("dist/schema.js", "dist/index.js");
verifyImportOrder("dist/index.js", "dist/query.js");
verifyImportOrder("dist/query.js", "dist/index.js");
});
});
Loading