@burojs/test-helpers 0.3.0 → 0.4.0

package/dist/index.js

@@ -1,311 +1,170 @@
-import { validateMutationResult, resolveDataCapability, isDataError, validateBatchResult } from '@burojs/core';
-import { describe, it, expect } from 'vitest';
-
-// src/form-view.ts
+//#region src/form-view.ts
 function createFormView(page, resource, view) {
-  return {
-    field: (fieldName) => {
-      page.getByTestId(`form-field:${resource}:${view}:${fieldName}`);
-      return {
-        input: () => page.getByTestId(`form-field-input:${resource}:${view}:${fieldName}`),
-        error: () => page.getByTestId(`form-field-error:${resource}:${view}:${fieldName}`),
-        help: () => page.getByTestId(`form-field-help:${resource}:${view}:${fieldName}`)
-      };
-    },
-    section: (sectionKey) => page.getByTestId(`form-section:${resource}:${view}:${sectionKey}`),
-    submit: () => page.getByTestId(`form-submit:${resource}:${view}`),
-    cancel: () => page.getByTestId(`form-cancel:${resource}:${view}`),
-    action: (actionName) => page.getByTestId(`form-action:${resource}:${view}:${actionName}`)
-  };
-}
-
-// src/list-view.ts
+	return {
+		field: (fieldName) => {
+			page.getByTestId(`form-field:${resource}:${view}:${fieldName}`);
+			return {
+				input: () => page.getByTestId(`form-field-input:${resource}:${view}:${fieldName}`),
+				error: () => page.getByTestId(`form-field-error:${resource}:${view}:${fieldName}`),
+				help: () => page.getByTestId(`form-field-help:${resource}:${view}:${fieldName}`)
+			};
+		},
+		group: (groupKey) => page.getByTestId(`form-group:${resource}:${view}:${groupKey}`),
+		submit: () => page.getByTestId(`form-submit:${resource}:${view}`),
+		cancel: () => page.getByTestId(`form-cancel:${resource}:${view}`),
+		action: (actionName) => page.getByTestId(`form-action:${resource}:${view}:${actionName}`)
+	};
+}
+//#endregion
+//#region src/list-view.ts
 function pathStr(path) {
-  return path.join("-");
+	return path.join("-");
 }
 function createListView(page, resource, options = {}) {
-  const path = options.basePath ?? `/${resource}`;
-  const filterBase = `list-filter:${resource}`;
-  const rowBase = (rowPath) => `${filterBase}:row:${pathStr(rowPath)}`;
-  const groupBase = (groupPath) => `${filterBase}:group:${pathStr(groupPath)}`;
-  return {
-    goto: async () => {
-      await page.goto(path);
-    },
-    row: (recordId) => createRowObject(page, resource, recordId),
-    search: () => page.getByTestId(`list-search:${resource}`),
-    filtersContainer: () => page.getByTestId(`list-filters:${resource}`),
-    filterButton: () => page.getByTestId(`${filterBase}:button`),
-    filterPanel: () => page.getByTestId(`${filterBase}:panel`),
-    filterAddRow: (groupPath = []) => page.getByTestId(`${groupBase(groupPath)}:add-row`),
-    filterRowField: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:field`),
-    filterRowFieldOption: (rowPath, field) => page.getByTestId(`${rowBase(rowPath)}:field:option:${field}`),
-    filterRowOp: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:op`),
-    filterRowOpOption: (rowPath, op) => page.getByTestId(`${rowBase(rowPath)}:op:option:${op}`),
-    filterRowValue: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:value`),
-    filterRowRemove: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:remove`),
-    filterApply: () => page.getByTestId(`${filterBase}:apply`),
-    filterReset: () => page.getByTestId(`${filterBase}:reset`),
-    filterBadge: (index) => page.getByTestId(`${filterBase}:badge:${index}`),
-    filterBadgeRemove: (index) => page.getByTestId(`${filterBase}:badge:${index}:remove`),
-    filterClearAll: () => page.getByTestId(`${filterBase}:clear-all`),
-    filterPinned: (field) => page.getByTestId(`${filterBase}:pinned:${field}`),
-    paginationPrev: () => page.getByTestId(`list-pagination-prev:${resource}`),
-    paginationNext: () => page.getByTestId(`list-pagination-next:${resource}`),
-    empty: () => page.getByTestId(`list-empty:${resource}`),
-    toolbar: () => page.getByTestId(`list-toolbar:${resource}`),
-    table: () => page.getByTestId(`list-table:${resource}`)
-  };
+	const path = options.basePath ?? `/${resource}`;
+	const filterBase = `list-filter:${resource}`;
+	const sortBase = (field) => `list-sort:${resource}:${field}`;
+	const rowBase = (rowPath) => `${filterBase}:row:${pathStr(rowPath)}`;
+	const groupBase = (groupPath) => `${filterBase}:group:${pathStr(groupPath)}`;
+	return {
+		goto: async () => {
+			await page.goto(path);
+		},
+		row: (recordId) => createRowObject(page, resource, recordId),
+		rows: () => page.locator(`[data-testid^="list-row:${resource}:"]`),
+		column: (fieldName) => page.locator(`[data-testid^="list-cell:${resource}:"][data-testid$=":${fieldName}"]`),
+		columnMenu: (fieldName) => page.getByTestId(sortBase(fieldName)),
+		columnSort: (fieldName, direction) => page.getByTestId(`${sortBase(fieldName)}:sort-${direction}`),
+		columnMove: (fieldName, direction) => page.getByTestId(`${sortBase(fieldName)}:move-${direction}`),
+		columnsToggle: () => page.getByTestId(`list-columns:${resource}`),
+		columnsOption: (columnId) => page.getByTestId(`list-columns-option:${resource}:${columnId}`),
+		pageSize: () => page.getByTestId(`list-page-size:${resource}`),
+		search: () => page.getByTestId(`list-search:${resource}`),
+		filtersContainer: () => page.getByTestId(`list-filters:${resource}`),
+		filterButton: () => page.getByTestId(`${filterBase}:button`),
+		filterPanel: () => page.getByTestId(`${filterBase}:panel`),
+		filterAddRow: (groupPath = []) => page.getByTestId(`${groupBase(groupPath)}:add-row`),
+		filterRowField: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:field`),
+		filterRowFieldOption: (rowPath, field) => page.getByTestId(`${rowBase(rowPath)}:field:option:${field}`),
+		filterRowOp: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:op`),
+		filterRowOpOption: (rowPath, op) => page.getByTestId(`${rowBase(rowPath)}:op:option:${op}`),
+		filterRowValue: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:value`),
+		filterRowRemove: (rowPath) => page.getByTestId(`${rowBase(rowPath)}:remove`),
+		filterApply: () => page.getByTestId(`${filterBase}:apply`),
+		filterReset: () => page.getByTestId(`${filterBase}:reset`),
+		filterBadge: (index) => page.getByTestId(`${filterBase}:badge:${index}`),
+		filterBadgeRemove: (index) => page.getByTestId(`${filterBase}:badge:${index}:remove`),
+		filterClearAll: () => page.getByTestId(`${filterBase}:clear-all`),
+		filterPinned: (field) => page.getByTestId(`${filterBase}:pinned:${field}`),
+		bulkBar: () => page.getByTestId(`list-bulk-bar:${resource}`),
+		bulkAction: (actionName) => page.getByTestId(`bulk-action:${resource}:${actionName}`),
+		paginationPrev: () => page.getByTestId(`list-pagination-prev:${resource}`),
+		paginationNext: () => page.getByTestId(`list-pagination-next:${resource}`),
+		loadMore: () => page.getByTestId("cursor-load-more"),
+		empty: () => page.getByTestId(`list-empty:${resource}`),
+		toolbar: () => page.getByTestId(`list-toolbar:${resource}`),
+		table: () => page.getByTestId(`list-table:${resource}`),
+		savedViews: () => page.getByTestId(`list-saved-views:${resource}`),
+		savedViewsMenu: () => page.getByTestId(`list-saved-views-menu:${resource}`),
+		savedViewEntries: () => page.locator(`[data-testid^="list-saved-view:${resource}:"]`),
+		savedView: (viewId) => page.getByTestId(`list-saved-view:${resource}:${viewId}`),
+		savedViewSave: () => page.getByTestId(`list-saved-view-save:${resource}`),
+		savedViewSaveInput: () => page.getByTestId(`list-saved-view-save-input:${resource}`),
+		savedViewSaveConfirm: () => page.getByTestId(`list-saved-view-save-confirm:${resource}`),
+		savedViewManage: () => page.getByTestId(`list-saved-view-manage:${resource}`),
+		savedViewManageDelete: (viewId) => page.getByTestId(`list-saved-view-manage-delete:${resource}:${viewId}`)
+	};
 }
 function createRowObject(page, resource, recordId) {
-  const rowId = `list-row:${resource}:${recordId}`;
-  return {
-    cell: (fieldName) => page.getByTestId(`list-cell:${resource}:${recordId}:${fieldName}`),
-    action: (actionName) => page.getByTestId(`list-row-action:${resource}:${recordId}:${actionName}`),
-    checkbox: () => page.getByTestId(`list-row-checkbox:${resource}:${recordId}`),
-    open: async () => {
-      await page.getByTestId(rowId).click();
-    }
-  };
-}
-
-// src/picker-object.ts
+	const rowId = `list-row:${resource}:${recordId}`;
+	return {
+		root: () => page.getByTestId(rowId),
+		cell: (fieldName) => page.getByTestId(`list-cell:${resource}:${recordId}:${fieldName}`),
+		action: (actionName) => page.getByTestId(`list-row-action:${resource}:${recordId}:${actionName}`),
+		checkbox: () => page.getByTestId(`list-row-checkbox:${resource}:${recordId}`),
+		open: async () => {
+			await page.getByTestId(rowId).click();
+		}
+	};
+}
+//#endregion
+//#region src/picker-object.ts
 function createPickerObject(page, targetResource) {
-  return {
-    dialog: () => page.getByTestId(`picker-dialog:${targetResource}`),
-    popover: () => page.getByTestId(`picker-popover:${targetResource}`),
-    option: (value) => page.getByTestId(`picker-option:${targetResource}:${value}`),
-    search: () => page.getByTestId(`picker-search:${targetResource}`),
-    clear: () => page.getByTestId(`picker-clear:${targetResource}`),
-    quickCreate: () => page.getByTestId(`picker-quickcreate:${targetResource}`)
-  };
-}
-
-// src/show-view.ts
-function createShowView(page, resource) {
-  return createFormView(page, resource, "show");
-}
-
-// src/resource-object.ts
+	const prefix = `relation-picker:${targetResource}`;
+	return {
+		trigger: () => page.getByTestId(prefix),
+		search: () => page.getByTestId(`${prefix}:search`),
+		list: () => page.getByTestId(`${prefix}:list`),
+		option: (value) => page.getByTestId(`${prefix}:option:${value}`),
+		empty: () => page.getByTestId(`${prefix}:empty`),
+		clear: () => page.getByTestId(`${prefix}:clear`),
+		advanced: () => page.getByTestId(`${prefix}:advanced`),
+		viewAll: () => page.getByTestId(`${prefix}:view-all`),
+		dialog: () => page.getByTestId(`relation-picker-dialog:${targetResource}`),
+		dialogSearch: () => page.getByTestId(`relation-picker-dialog:${targetResource}:search`),
+		unregistered: () => page.getByTestId(`${prefix}:unregistered`)
+	};
+}
+//#endregion
+//#region src/show-view.ts
+function createShowView(page, resource, recordId) {
+	return {
+		...createFormView(page, resource, "show"),
+		root: () => page.getByTestId(`page-show:${resource}:${recordId}`)
+	};
+}
+//#endregion
+//#region src/resource-object.ts
 function createResourceObject(page, name) {
-  return {
-    name,
-    list: (options) => createListView(page, name, options),
-    edit: (_recordId) => createFormView(page, name, "edit"),
-    show: (_recordId) => createShowView(page, name),
-    create: () => createFormView(page, name, "create"),
-    picker: () => createPickerObject(page, name)
-  };
-}
-
-// src/buro-page.ts
+	return {
+		name,
+		list: (options) => createListView(page, name, options),
+		edit: (_recordId) => createFormView(page, name, "edit"),
+		show: (recordId) => createShowView(page, name, recordId),
+		create: () => createFormView(page, name, "create"),
+		picker: () => createPickerObject(page, name)
+	};
+}
+//#endregion
+//#region src/buro-page.ts
 function createBuroPage(page) {
-  return {
-    resource: (name) => createResourceObject(page, name),
-    contextPicker: (sliceName) => page.getByTestId(`context-picker:${sliceName}`),
-    notification: (type) => page.getByTestId(`notification:${type}`),
-    actionConfirm: (resource, scope, actionName) => page.getByTestId(`action-confirm-dialog:${resource}:${scope}:${actionName}`),
-    page
-  };
-}
-
-// src/confirm-dialog.ts
+	return {
+		resource: (name) => createResourceObject(page, name),
+		navMenuItem: (resource) => page.getByTestId(`nav-menu-item:${resource}`),
+		sidebarCustomPage: (pageKey) => page.getByTestId(`sidebar-custompage:${pageKey}`),
+		contextPicker: (sliceName) => page.getByTestId(`context-picker:${sliceName}`),
+		contextPickerOption: (sliceName, value) => page.getByTestId(`context-picker-option:${sliceName}:${value}`),
+		languageSwitch: () => page.getByTestId("language-switch"),
+		languageSwitchOption: (localeCode) => page.getByTestId(`language-switch:${localeCode}`),
+		login: () => ({
+			email: () => page.getByTestId("login-email"),
+			password: () => page.getByTestId("login-password"),
+			submit: () => page.getByTestId("login-submit")
+		}),
+		taskRun: (name) => ({
+			root: () => page.getByTestId(`task-run:${name}`),
+			progress: () => page.getByTestId(`task-run-progress:${name}`),
+			failure: (subject) => page.getByTestId(`task-run-failure:${name}:${subject}`)
+		}),
+		notification: (type) => page.getByTestId(`notification:${type}`),
+		actionConfirm: (resource, scope, actionName) => page.getByTestId(`action-confirm-dialog:${resource}:${scope}:${actionName}`),
+		page
+	};
+}
+//#endregion
+//#region src/confirm-dialog.ts
 function createConfirmDialog(page, resource, scope, actionName) {
-  return {
-    dialog: () => page.getByTestId(`action-confirm-dialog:${resource}:${scope}:${actionName}`),
-    yes: () => page.getByTestId(`action-confirm-yes:${resource}:${scope}:${actionName}`),
-    no: () => page.getByTestId(`action-confirm-no:${resource}:${scope}:${actionName}`)
-  };
-}
-var SESSION = Object.freeze({
-  sessionKey: "contract-session",
-  scopeKey: "contract-scope",
-  generation: 1
-});
-var REQUEST_CONTEXT = Object.freeze({ contract: "provider" });
-function context(signal) {
-  return Object.freeze({
-    signal,
-    requestContext: REQUEST_CONTEXT,
-    session: SESSION,
-    providerServiceKey: "contract-provider"
-  });
-}
-function queryShape(kind, value) {
-  if (kind === "custom") return;
-  expect(value).toBeTypeOf("object");
-  if (kind === "list" || kind === "many")
-    expect(value.data).toBeInstanceOf(Array);
-  if (kind === "one") expect(value).toHaveProperty("data");
-  if (kind === "count")
-    expect([null, "number"]).toContain(typeof value.total);
-}
-function observed(fixture, expected, signal) {
-  expect(fixture.observeCalls()).toContainEqual(expect.objectContaining({ ...expected, signal }));
-}
-async function assertBatch(provider, fixture, operations, expected) {
-  expect(provider.batch?.queries).toBeTypeOf("function");
-  const controller = new AbortController();
-  const result = await provider.batch.queries(operations, context(controller.signal));
-  validateBatchResult(operations, result);
-  if (expected !== void 0) expect(result).toEqual(expected);
-  for (const entry of result.results) if (entry.status === "error") dataError(entry.error);
-  observed(
-    fixture,
-    { lifecycle: "batch", descriptors: operations.map((operation) => operation.descriptor) },
-    controller.signal
-  );
-}
-function dataError(value) {
-  expect(isDataError(value)).toBe(true);
-}
-function livePlan(value) {
-  expect(value, "descriptors.live was supplied, so live.open must return a plan").not.toBeNull();
-  expect(value).toBeTypeOf("object");
-  expect(value?.subscribe).toBeTypeOf("function");
-}
-function liveDescriptorRequired(hasLiveSlot, descriptor) {
-  if (!hasLiveSlot) return;
-  expect(
-    descriptor,
-    "the provider exposes a `live` slot, so the fixture must supply `descriptors.live` \u2014 omitting it silently skips the whole live cell"
-  ).toBeDefined();
-}
-function dataProviderContract(name, fixture) {
-  describe(`${name} data provider contract`, () => {
-    for (const kind of ["list", "one", "many", "count", "custom"]) {
-      it(`preserves the ${kind} query descriptor and AbortSignal`, async () => {
-        const provider = await fixture.create();
-        const descriptor = fixture.descriptors.queries?.[kind];
-        const handler = provider.queries?.[kind];
-        if (descriptor === void 0 || handler === void 0) return;
-        const controller = new AbortController();
-        const result = await handler(descriptor, context(controller.signal));
-        queryShape(kind, result);
-        const expected = fixture.descriptors.expected?.queries?.[kind];
-        if (expected !== void 0) expect(result).toEqual(expected);
-        observed(fixture, { lifecycle: "query", kind, descriptor }, controller.signal);
-      });
-    }
-    for (const kind of [
-      "createOne",
-      "createMany",
-      "updateOne",
-      "updateMany",
-      "deleteOne",
-      "deleteMany",
-      "custom"
-    ]) {
-      it(`validates ${kind} mutation output and preserves its request`, async () => {
-        const provider = await fixture.create();
-        const descriptor = fixture.descriptors.mutations?.[kind];
-        const handler = provider.mutations?.[kind];
-        if (descriptor === void 0 || handler === void 0) return;
-        const controller = new AbortController();
-        const result = await handler(descriptor, context(controller.signal));
-        validateMutationResult(descriptor, result);
-        const expected = fixture.descriptors.expected?.mutations?.[kind];
-        if (expected !== void 0) expect(result).toEqual(expected);
-        observed(fixture, { lifecycle: "mutation", kind, descriptor }, controller.signal);
-      });
-    }
-    for (const specimen of fixture.descriptors.errors ?? []) {
-      it(`returns a structured error for the ${specimen.lifecycle}.${specimen.kind} error specimen`, async () => {
-        const provider = await fixture.create();
-        const controller = new AbortController();
-        const handler = specimen.lifecycle === "query" ? provider.queries?.[specimen.kind] : provider.mutations?.[specimen.kind];
-        expect(handler).toBeTypeOf("function");
-        try {
-          await handler(specimen.descriptor, context(controller.signal));
-          throw new Error("Provider error specimen resolved instead of rejecting.");
-        } catch (error) {
-          dataError(error);
-        }
-        observed(
-          fixture,
-          { lifecycle: specimen.lifecycle, kind: specimen.kind, descriptor: specimen.descriptor },
-          controller.signal
-        );
-      });
-    }
-    it("reports absent optional capabilities without invoking fallback handlers", async () => {
-      const provider = await fixture.create();
-      const before = fixture.observeCalls().length;
-      for (const kind of ["list", "one", "many", "count", "custom"]) {
-        if (provider.queries?.[kind] === void 0) {
-          const capability = resolveDataCapability(provider, { lifecycle: "query", kind });
-          expect(capability).toMatchObject({ kind: "capability", code: "missing-data-capability" });
-        }
-      }
-      for (const kind of [
-        "createOne",
-        "createMany",
-        "updateOne",
-        "updateMany",
-        "deleteOne",
-        "deleteMany",
-        "custom"
-      ]) {
-        if (provider.mutations?.[kind] === void 0) {
-          const capability = resolveDataCapability(provider, { lifecycle: "mutation", kind });
-          expect(capability).toMatchObject({ kind: "capability", code: "missing-data-capability" });
-        }
-      }
-      expect(fixture.observeCalls()).toHaveLength(before);
-    });
-    it("validates batch IDs, kinds, partial errors, and the shared AbortSignal", async () => {
-      const provider = await fixture.create();
-      const operations = fixture.descriptors.batch;
-      if (provider.batch?.queries === void 0 || operations === void 0) return;
-      await assertBatch(provider, fixture, operations, fixture.descriptors.expected?.batch);
-    });
-    for (const [index, operations] of (fixture.descriptors.batchGroups ?? []).entries()) {
-      it(`keeps batch group ${index + 1} isolated and validates its partial results`, async () => {
-        const provider = await fixture.create();
-        await assertBatch(provider, fixture, operations, void 0);
-      });
-    }
-    for (const kind of ["offset", "cursor"]) {
-      it(`preserves ${kind} pagination and its mapped total/page shape`, async () => {
-        const provider = await fixture.create();
-        const descriptor = fixture.descriptors.pagination?.[kind];
-        if (descriptor === void 0 || provider.queries?.list === void 0) return;
-        const controller = new AbortController();
-        const result = await provider.queries.list(descriptor, context(controller.signal));
-        queryShape("list", result);
-        const expected = fixture.descriptors.expected?.pagination?.[kind];
-        if (expected !== void 0) expect(result).toEqual(expected);
-        observed(fixture, { lifecycle: "query", kind: "list", descriptor }, controller.signal);
-      });
-    }
-    it("opens live plans with the complete descriptor and subscribes with an AbortSignal", async () => {
-      const provider = await fixture.create();
-      const descriptor = fixture.descriptors.live;
-      liveDescriptorRequired(provider.live !== void 0, descriptor);
-      if (provider.live === void 0 || descriptor === void 0) return;
-      const openController = new AbortController();
-      const plan = await provider.live.open(descriptor, context(openController.signal));
-      observed(fixture, { lifecycle: "live-open", descriptor }, openController.signal);
-      livePlan(plan);
-      if (plan === null) return;
-      const subscribeController = new AbortController();
-      const observer = {
-        next: () => void 0,
-        status: () => void 0,
-        error: () => void 0,
-        complete: () => void 0
-      };
-      const unsubscribe = await plan.subscribe(observer, { signal: subscribeController.signal });
-      observed(fixture, { lifecycle: "live-subscribe" }, subscribeController.signal);
-      await unsubscribe();
-    });
-  });
-}
-
-// src/index.ts
-var PACKAGE_NAME = "@burojs/test-helpers";
-var PACKAGE_VERSION = "0.0.0";
+	return {
+		dialog: () => page.getByTestId(`action-confirm-dialog:${resource}:${scope}:${actionName}`),
+		yes: () => page.getByTestId(`action-confirm-yes:${resource}:${scope}:${actionName}`),
+		no: () => page.getByTestId(`action-confirm-no:${resource}:${scope}:${actionName}`)
+	};
+}
+//#endregion
+//#region src/index.ts
+const PACKAGE_NAME = "@burojs/test-helpers";
+const PACKAGE_VERSION = "0.0.0";
+//#endregion
+export { PACKAGE_NAME, PACKAGE_VERSION, createBuroPage, createConfirmDialog, createFormView, createListView, createPickerObject, createResourceObject, createShowView };
 
-export { PACKAGE_NAME, PACKAGE_VERSION, createBuroPage, createConfirmDialog, createFormView, createListView, createPickerObject, createResourceObject, createShowView, dataProviderContract };
-//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map