zinkee 0.1.44 → 0.1.45

package/src/api/displays.ts

@@ -1,337 +0,0 @@
-import { ApiClient } from "../client.js";
-import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
-
-export interface ApiDisplay {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  description?: string;
-  layoutTemplate?: string;
-  layout?: {
-    template?: string;
-    freeformLayouts?: unknown;
-    slots?: Array<Record<string, unknown>>;
-    tabs?: Array<Record<string, unknown>>;
-  };
-  variables?: Array<Record<string, unknown>>;
-  widgets?: Array<Record<string, unknown>>;
-  navigationTargets?: Array<Record<string, unknown>>;
-  crossWidgetFilter?: Array<Record<string, unknown>> | null;
-  folder?: { id?: string; name?: string | null; isRoot?: boolean };
-}
-
-export interface ApiDisplayTab {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  orientation?: string;
-}
-
-export interface ApiDisplayVariable {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  type?: string;
-}
-
-export interface ApiDisplayWidget {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  type?: string;
-}
-
-export interface ApiDisplayNavigationTarget {
-  [key: string]: unknown;
-  id?: string;
-  label?: string;
-}
-
-export interface ApiDisplayFolder {
-  [key: string]: unknown;
-  id?: string;
-  name?: string | null;
-  isRoot?: boolean;
-  displayCount?: number;
-}
-
-export interface MoveDisplayInput {
-  displayId: string;
-  targetFolderId: string;
-}
-
-export type DisplaySummary = ApiDisplay;
-export type DisplayResource = ApiDisplay;
-
-export interface CreateDisplayInput {
-  name: string;
-  description?: string;
-  layout: Record<string, unknown>;
-}
-
-export interface UpdateDisplayInput {
-  name?: string;
-  description?: string;
-}
-
-function jsonOptions(body: unknown, method: string): RequestInit {
-  return {
-    method,
-    headers: {
-      "content-type": "application/json",
-    },
-    body: JSON.stringify(body),
-  };
-}
-
-function selectorValue(selector: NormalizedUuidOrSlug): string {
-  return encodeURIComponent(selector.value);
-}
-
-function segment(value: string): string {
-  return encodeURIComponent(value);
-}
-
-export class DisplaysApi {
-  constructor(private readonly client: ApiClient) {}
-
-  listDisplays(): Promise<ApiDisplay[]> {
-    return this.client.getJson<ApiDisplay[]>("/api/v2/displays");
-  }
-
-  getDisplay(display: NormalizedUuidOrSlug): Promise<ApiDisplay> {
-    return this.client.getJson<ApiDisplay>(`/api/v2/displays/${selectorValue(display)}`);
-  }
-
-  createDisplay(body: CreateDisplayInput): Promise<ApiDisplay> {
-    return this.client.requestJson<ApiDisplay>("/api/v2/displays", jsonOptions(body, "POST"));
-  }
-
-  updateDisplay(
-    display: NormalizedUuidOrSlug,
-    body: UpdateDisplayInput,
-  ): Promise<ApiDisplay> {
-    return this.client.requestJson<ApiDisplay>(
-      `/api/v2/displays/${selectorValue(display)}`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  deleteDisplay(display: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  getLayout(display: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.getJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/layout`,
-    );
-  }
-
-  patchLayout(
-    display: NormalizedUuidOrSlug,
-    body: Record<string, unknown>,
-  ): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/layout`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  listTabs(display: NormalizedUuidOrSlug): Promise<ApiDisplayTab[]> {
-    return this.client.getJson<ApiDisplayTab[]>(
-      `/api/v2/displays/${selectorValue(display)}/tabs`,
-    );
-  }
-
-  createTab(
-    display: NormalizedUuidOrSlug,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayTab> {
-    return this.client.requestJson<ApiDisplayTab>(
-      `/api/v2/displays/${selectorValue(display)}/tabs`,
-      jsonOptions(body, "POST"),
-    );
-  }
-
-  updateTab(
-    display: NormalizedUuidOrSlug,
-    tabId: string,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayTab> {
-    return this.client.requestJson<ApiDisplayTab>(
-      `/api/v2/displays/${selectorValue(display)}/tabs/${segment(tabId)}`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  deleteTab(display: NormalizedUuidOrSlug, tabId: string): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/tabs/${segment(tabId)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  listVariables(display: NormalizedUuidOrSlug): Promise<ApiDisplayVariable[]> {
-    return this.client.getJson<ApiDisplayVariable[]>(
-      `/api/v2/displays/${selectorValue(display)}/variables`,
-    );
-  }
-
-  getVariable(display: NormalizedUuidOrSlug, variableId: string): Promise<ApiDisplayVariable> {
-    return this.client.getJson<ApiDisplayVariable>(
-      `/api/v2/displays/${selectorValue(display)}/variables/${segment(variableId)}`,
-    );
-  }
-
-  createVariable(
-    display: NormalizedUuidOrSlug,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayVariable> {
-    return this.client.requestJson<ApiDisplayVariable>(
-      `/api/v2/displays/${selectorValue(display)}/variables`,
-      jsonOptions(body, "POST"),
-    );
-  }
-
-  updateVariable(display: NormalizedUuidOrSlug, variableId: string, body: Record<string, unknown>): Promise<ApiDisplayVariable> {
-    return this.client.requestJson<ApiDisplayVariable>(
-      `/api/v2/displays/${selectorValue(display)}/variables/${segment(variableId)}`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  deleteVariable(display: NormalizedUuidOrSlug, variableId: string): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/variables/${segment(variableId)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  listWidgets(display: NormalizedUuidOrSlug): Promise<ApiDisplayWidget[]> {
-    return this.client.getJson<ApiDisplayWidget[]>(
-      `/api/v2/displays/${selectorValue(display)}/widgets`,
-    );
-  }
-
-  getWidget(display: NormalizedUuidOrSlug, widgetId: string): Promise<ApiDisplayWidget> {
-    return this.client.getJson<ApiDisplayWidget>(
-      `/api/v2/displays/${selectorValue(display)}/widgets/${segment(widgetId)}`,
-    );
-  }
-
-  createWidget(
-    display: NormalizedUuidOrSlug,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayWidget> {
-    return this.client.requestJson<ApiDisplayWidget>(
-      `/api/v2/displays/${selectorValue(display)}/widgets`,
-      jsonOptions(body, "POST"),
-    );
-  }
-
-  updateWidget(display: NormalizedUuidOrSlug, widgetId: string, body: Record<string, unknown>): Promise<ApiDisplayWidget> {
-    return this.client.requestJson<ApiDisplayWidget>(
-      `/api/v2/displays/${selectorValue(display)}/widgets/${segment(widgetId)}`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  deleteWidget(display: NormalizedUuidOrSlug, widgetId: string): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/widgets/${segment(widgetId)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  createNavigationTarget(
-    display: NormalizedUuidOrSlug,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayNavigationTarget> {
-    return this.client.requestJson<ApiDisplayNavigationTarget>(
-      `/api/v2/displays/${selectorValue(display)}/navigation-targets`,
-      jsonOptions(body, "POST"),
-    );
-  }
-
-  updateNavigationTarget(
-    display: NormalizedUuidOrSlug,
-    targetId: string,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayNavigationTarget> {
-    return this.client.requestJson<ApiDisplayNavigationTarget>(
-      `/api/v2/displays/${selectorValue(display)}/navigation-targets/${segment(targetId)}`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  deleteNavigationTarget(
-    display: NormalizedUuidOrSlug,
-    targetId: string,
-  ): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/navigation-targets/${segment(targetId)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  getCrossWidgetFilter(display: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.getJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/cross-widget-filter`,
-    );
-  }
-
-  setCrossWidgetFilter(
-    display: NormalizedUuidOrSlug,
-    body: unknown[],
-  ): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/cross-widget-filter`,
-      jsonOptions(body, "PUT"),
-    );
-  }
-
-  deleteCrossWidgetFilter(display: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/displays/${selectorValue(display)}/cross-widget-filter`,
-      { method: "DELETE" },
-    );
-  }
-
-  listFolders(): Promise<ApiDisplayFolder[]> {
-    return this.client.getJson<ApiDisplayFolder[]>("/api/v2/display-folders");
-  }
-
-  createFolder(body: Record<string, unknown>): Promise<ApiDisplayFolder> {
-    return this.client.requestJson<ApiDisplayFolder>(
-      "/api/v2/display-folders",
-      jsonOptions(body, "POST"),
-    );
-  }
-
-  updateFolder(
-    folder: NormalizedUuidOrSlug,
-    body: Record<string, unknown>,
-  ): Promise<ApiDisplayFolder> {
-    return this.client.requestJson<ApiDisplayFolder>(
-      `/api/v2/display-folders/${selectorValue(folder)}`,
-      jsonOptions(body, "PATCH"),
-    );
-  }
-
-  deleteFolder(folder: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/display-folders/${selectorValue(folder)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  moveDisplay(input: MoveDisplayInput): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      "/api/v2/display-folders/displays:move",
-      jsonOptions(input, "POST"),
-    );
-  }
-}

package/src/api/document-templates.ts

@@ -1,110 +0,0 @@
-import { ApiClient } from "../client.js";
-import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
-
-export interface ApiDocumentTemplateAsset {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  link?: string;
-}
-
-export interface ApiDocumentTemplate {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  assets?: ApiDocumentTemplateAsset[];
-  createdAt?: string;
-  updatedAt?: string;
-  createdBy?: string;
-  updatedBy?: string;
-}
-
-export interface CreateDocumentTemplateInput {
-  [key: string]: unknown;
-  name: string;
-  assets?: ApiDocumentTemplateAsset[];
-}
-
-export interface UpdateDocumentTemplateInput {
-  [key: string]: unknown;
-  name?: string;
-}
-
-function jsonOptions(body: unknown, method: string): RequestInit {
-  return {
-    method,
-    headers: {
-      "content-type": "application/json",
-    },
-    body: JSON.stringify(body),
-  };
-}
-
-function selectorValue(selector: NormalizedUuidOrSlug): string {
-  return encodeURIComponent(selector.value);
-}
-
-function segment(value: string): string {
-  return encodeURIComponent(value);
-}
-
-export class DocumentTemplatesApi {
-  constructor(private readonly client: ApiClient) {}
-
-  listTemplates(): Promise<ApiDocumentTemplate[]> {
-    return this.client.getJson<ApiDocumentTemplate[]>("/api/v2/document-templates");
-  }
-
-  createTemplate(input: CreateDocumentTemplateInput): Promise<ApiDocumentTemplate> {
-    return this.client.requestJson<ApiDocumentTemplate>(
-      "/api/v2/document-templates",
-      jsonOptions(input, "POST"),
-    );
-  }
-
-  updateTemplate(
-    template: NormalizedUuidOrSlug,
-    input: UpdateDocumentTemplateInput,
-  ): Promise<ApiDocumentTemplate> {
-    return this.client.requestJson<ApiDocumentTemplate>(
-      `/api/v2/document-templates/${selectorValue(template)}`,
-      jsonOptions(input, "PATCH"),
-    );
-  }
-
-  deleteTemplate(template: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/document-templates/${selectorValue(template)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  addAsset(
-    template: NormalizedUuidOrSlug,
-    input: FormData,
-  ): Promise<ApiDocumentTemplate> {
-    return this.client.requestJson<ApiDocumentTemplate>(
-      `/api/v2/document-templates/${selectorValue(template)}/assets`,
-      { method: "POST", body: input },
-    );
-  }
-
-  deleteAsset(
-    template: NormalizedUuidOrSlug,
-    assetId: string,
-  ): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/document-templates/${selectorValue(template)}/assets/${segment(assetId)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  downloadAsset(
-    template: NormalizedUuidOrSlug,
-    assetId: string,
-  ): Promise<ArrayBuffer> {
-    return this.client.requestBinary(
-      `/api/v2/document-templates/${selectorValue(template)}/assets/${segment(assetId)}/download`,
-    );
-  }
-}

package/src/api/files.ts

@@ -1,50 +0,0 @@
-import { ApiClient } from "../client.js";
-import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
-
-export interface ApiFile {
-  [key: string]: unknown;
-  id?: string;
-  name?: string;
-  filename?: string;
-  size?: number;
-  mimeType?: string;
-}
-
-export interface FileStorageInfo {
-  [key: string]: unknown;
-  usedBytes?: number;
-  totalBytes?: number;
-  availableBytes?: number;
-  used?: number;
-  limitBytes?: number;
-}
-
-function selectorValue(selector: NormalizedUuidOrSlug): string {
-  return selector.value;
-}
-
-export class FilesApi {
-  constructor(private readonly client: ApiClient) {}
-
-  uploadFile(input: FormData): Promise<ApiFile> {
-    return this.client.requestJson<ApiFile>("/api/v2/files", {
-      method: "POST",
-      body: input,
-    });
-  }
-
-  downloadFile(file: NormalizedUuidOrSlug): Promise<ArrayBuffer> {
-    return this.client.requestBinary(`/api/v2/files/${selectorValue(file)}`);
-  }
-
-  deleteFile(file: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
-    return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/files/${selectorValue(file)}`,
-      { method: "DELETE" },
-    );
-  }
-
-  getStorageInfo(): Promise<FileStorageInfo> {
-    return this.client.getJson<FileStorageInfo>("/api/v2/files/storage-info");
-  }
-}

package/src/api/formulas.test.ts

@@ -1,65 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-
-import { normalizeUuidOrSlug } from "../parsers/selectors.js";
-import { ApiClient } from "../client.js";
-import { FormulasApi } from "./formulas.js";
-
-function jsonResponse(body: unknown): Response {
-  return new Response(JSON.stringify(body), {
-    status: 202,
-    headers: { "content-type": "application/json" },
-  });
-}
-
-describe("FormulasApi", () => {
-  it.each([
-    {
-      input: {
-        scope: "FIELD" as const,
-        schema: normalizeUuidOrSlug("invoices"),
-        field: normalizeUuidOrSlug("total"),
-      },
-      body: { scope: "FIELD", schema: "invoices", field: "total" },
-    },
-    {
-      input: {
-        scope: "SCHEMA" as const,
-        schema: normalizeUuidOrSlug("550e8400-e29b-41d4-a716-446655440001"),
-      },
-      body: {
-        scope: "SCHEMA",
-        schema: "550e8400-e29b-41d4-a716-446655440001",
-      },
-    },
-    {
-      input: { scope: "WORKSPACE" as const },
-      body: { scope: "WORKSPACE" },
-    },
-  ])("posts the $input.scope payload to the recompute endpoint", async ({ input, body }) => {
-    const fetchMock = vi.fn<typeof fetch>().mockResolvedValue(
-      jsonResponse({
-        requestId: "request-1",
-        scope: input.scope,
-        formulaCount: 1,
-        skippedFormulaCount: 0,
-        eventsQueued: 1,
-        status: "QUEUED",
-      }),
-    );
-    const api = new FormulasApi(
-      new ApiClient({
-        baseUrl: "https://api.zinkee.test",
-        apiKey: "test-token",
-        fetch: fetchMock,
-      }),
-    );
-
-    await api.recompute(input);
-
-    expect(fetchMock).toHaveBeenCalledOnce();
-    const [url, init] = fetchMock.mock.calls[0]!;
-    expect(url).toBe("https://api.zinkee.test/api/v2/formulas:recompute");
-    expect(init?.method).toBe("POST");
-    expect(JSON.parse(String(init?.body))).toEqual(body);
-  });
-});

package/src/api/formulas.ts

@@ -1,67 +0,0 @@
-import { ApiClient } from "../client.js";
-import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
-
-export type FormulaRecomputeScope = "FIELD" | "SCHEMA" | "WORKSPACE";
-
-export interface FormulaRecomputeResponse {
-  requestId: string;
-  scope: FormulaRecomputeScope;
-  formulaCount: number;
-  skippedFormulaCount: number;
-  eventsQueued: number;
-  status: "QUEUED";
-}
-
-export type FormulaRecomputeInput =
-  | {
-      scope: "FIELD";
-      schema: NormalizedUuidOrSlug;
-      field: NormalizedUuidOrSlug;
-    }
-  | {
-      scope: "SCHEMA";
-      schema: NormalizedUuidOrSlug;
-    }
-  | {
-      scope: "WORKSPACE";
-    };
-
-function selectorValue(selector: NormalizedUuidOrSlug): string {
-  return selector.value;
-}
-
-function toRequestBody(input: FormulaRecomputeInput): Record<string, string> {
-  if (input.scope === "FIELD") {
-    return {
-      scope: input.scope,
-      schema: selectorValue(input.schema),
-      field: selectorValue(input.field),
-    };
-  }
-
-  if (input.scope === "SCHEMA") {
-    return {
-      scope: input.scope,
-      schema: selectorValue(input.schema),
-    };
-  }
-
-  return { scope: input.scope };
-}
-
-export class FormulasApi {
-  constructor(private readonly client: ApiClient) {}
-
-  recompute(input: FormulaRecomputeInput): Promise<FormulaRecomputeResponse> {
-    return this.client.requestJson<FormulaRecomputeResponse>(
-      "/api/v2/formulas:recompute",
-      {
-        method: "POST",
-        headers: {
-          "content-type": "application/json",
-        },
-        body: JSON.stringify(toRequestBody(input)),
-      },
-    );
-  }
-}

package/src/api/logs.ts

@@ -1,34 +0,0 @@
-import { ApiClient } from "../client.js";
-import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
-
-export interface ApiLogChange {
-  beforeValue?: string | null;
-  afterValue?: string | null;
-  author?: string;
-  operation?: string;
-}
-
-export interface ApiLog {
-  [key: string]: unknown;
-  recordId?: string;
-  timestamp?: string;
-  changeField?: string;
-  change?: ApiLogChange;
-}
-
-function selectorValue(selector: NormalizedUuidOrSlug): string {
-  return selector.value;
-}
-
-export class LogsApi {
-  constructor(private readonly client: ApiClient) {}
-
-  listLogs(
-    schema: NormalizedUuidOrSlug,
-    recordId: string,
-  ): Promise<ApiLog[]> {
-    return this.client.getJson<ApiLog[]>(
-      `/api/v2/schemas/${selectorValue(schema)}/records/${recordId}/logs`,
-    );
-  }
-}