@object-ui/data-objectstack 17.5.0 → 17.7.0

package/src/contracts.ts

@@ -1,115 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/**
- * Contracts module integration for @objectstack/spec v3.0.0
- * Provides plugin contract validation and marketplace publishing utilities.
- */
-
-export interface PluginContract {
-  /** Plugin name */
-  name: string;
-  /** Plugin version */
-  version: string;
-  /** Required peer dependencies */
-  peerDependencies?: Record<string, string>;
-  /** Exported component types */
-  exports: PluginExport[];
-  /** Required permissions */
-  permissions?: string[];
-  /** API surface contract */
-  api?: PluginAPIContract;
-}
-
-export interface PluginExport {
-  /** Export name */
-  name: string;
-  /** Export type */
-  type: 'component' | 'hook' | 'utility' | 'provider';
-  /** Description */
-  description?: string;
-}
-
-export interface PluginAPIContract {
-  /** Consumed data sources */
-  dataSources?: string[];
-  /** Required object schemas */
-  requiredSchemas?: string[];
-  /** Event subscriptions */
-  events?: string[];
-}
-
-export interface ContractValidationResult {
-  valid: boolean;
-  errors: ContractValidationError[];
-  warnings: string[];
-}
-
-export interface ContractValidationError {
-  field: string;
-  message: string;
-  code: string;
-}
-
-/**
- * Validate a plugin contract against the ObjectStack spec.
- */
-export function validatePluginContract(contract: PluginContract): ContractValidationResult {
-  const errors: ContractValidationError[] = [];
-  const warnings: string[] = [];
-
-  if (!contract.name || contract.name.trim().length === 0) {
-    errors.push({ field: 'name', message: 'Plugin name is required', code: 'MISSING_NAME' });
-  }
-
-  if (!contract.version || !/^\d+\.\d+\.\d+/.test(contract.version)) {
-    errors.push({ field: 'version', message: 'Valid semver version is required', code: 'INVALID_VERSION' });
-  }
-
-  if (!contract.exports || contract.exports.length === 0) {
-    errors.push({ field: 'exports', message: 'At least one export is required', code: 'NO_EXPORTS' });
-  }
-
-  if (contract.exports) {
-    const validTypes = ['component', 'hook', 'utility', 'provider'];
-    for (const exp of contract.exports) {
-      if (!exp.name) {
-        errors.push({ field: 'exports.name', message: 'Export name is required', code: 'MISSING_EXPORT_NAME' });
-      }
-      if (!validTypes.includes(exp.type)) {
-        errors.push({ field: 'exports.type', message: `Invalid export type: ${exp.type}`, code: 'INVALID_EXPORT_TYPE' });
-      }
-    }
-  }
-
-  if (!contract.permissions || contract.permissions.length === 0) {
-    warnings.push('No permissions declared — plugin will have minimal access');
-  }
-
-  return { valid: errors.length === 0, errors, warnings };
-}
-
-/**
- * Generate a plugin contract manifest for marketplace publishing.
- */
-export function generateContractManifest(contract: PluginContract): Record<string, unknown> {
-  return {
-    $schema: 'https://objectui.org/schemas/plugin-contract-v1.json',
-    name: contract.name,
-    version: contract.version,
-    peerDependencies: contract.peerDependencies ?? {},
-    exports: contract.exports.map(exp => ({
-      name: exp.name,
-      type: exp.type,
-      description: exp.description ?? '',
-    })),
-    permissions: contract.permissions ?? [],
-    api: contract.api ?? {},
-    generatedAt: new Date().toISOString(),
-  };
-}

package/src/deleteView.homes.test.ts

@@ -1,389 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import { describe, it, expect, vi } from 'vitest';
-import { ObjectStackAdapter } from './index';
-import { MetadataClient } from './metadata-client';
-
-/**
- * `deleteView` removes every home the view has (#4479).
- *
- * A view has two possible homes — the pending per-item DRAFT
- * (`DELETE /meta/view/:name?state=draft`) and the PUBLISHED overlay
- * (`DELETE /meta/view/:name`) — and `deleteView` used to address only the
- * published one. The three cases, and what each used to do:
- *
- * | case               | before #4479                                        |
- * |--------------------|-----------------------------------------------------|
- * | draft-only view    | BUG — hits the published overlay, `reset:false`, the |
- * |                    | draft survives and the tab is back after reload      |
- * | published-only     | correct — `reset:true`, tab gone                     |
- * | published + draft  | ACCIDENTALLY correct — the published row goes, so    |
- * |                    | the tab goes; the orphan draft is left behind        |
- *
- * The third row is why the mirror of #4139 is NOT mechanical.
- * `persistRuntimeMetadata` (app-shell) stages **every** runtime edit as a
- * draft, so "publish a view, then edit it" routinely produces a pair — and a
- * naive draft-FIRST-only mirror would have discarded just the draft there,
- * silently downgrading **Delete view** into **Discard draft**, which is a
- * different operation that already exists (`discardRuntimeDraft`).
- *
- * The ruling on #4479: delete BOTH homes, draft first. Draft first because a
- * failure between the two calls then leaves the PUBLISHED overlay intact and
- * the operation cleanly retryable — the reverse order strands a draft-only
- * view, which is this card's original bug shape.
- *
- * ## The wire these pins model
- *
- * Every receipt below is the framework's own, read verbatim from
- * `packages/metadata-protocol/src/protocol.ts` (`deleteMetaItem`) — the
- * no-row branch and the delete-ful branch. Both no-row answers are a **200**
- * carrying `reset:false`, NOT a 404:
- *
- * - no draft pending  -> `{success:true, reset:false, message:"No pending draft for view/x."}`
- * - no published row  -> `{success:true, reset:false, message:"No view 'x' found — nothing to delete."}`
- *
- * That measurement is what makes a blind two-call implementation legitimate
- * here: neither "missing home" answer is an error, so there is nothing for a
- * probe to protect against and the probe `updateView` needs (its read must
- * resolve the row it is about to merge onto) has no counterpart for a delete.
- *
- * Nothing here mocks `deleteView`. The adapter is real and drives a
- * wire-shaped `fetch`; the SDK stand-in on `ds.client.meta.deleteItem`
- * mirrors the real client's transport (same URL, same `unwrapResponse`) so
- * that the pins address the REQUEST, not the transport that issued it.
- */
-
-const VIEW = 'account.my_pipeline';
-
-/** Framework receipt: a draft row existed and was discarded. */
-const DRAFT_DISCARDED = {
-  success: true,
-  reset: true,
-  seq: 41,
-  message: `Draft discarded — view/${VIEW}. [seq=41]`,
-};
-/** Framework receipt: nothing pending. 200, not 404. */
-const NO_DRAFT = {
-  success: true,
-  reset: false,
-  message: `No pending draft for view/${VIEW}.`,
-};
-/** Framework receipt: a runtime-only published row existed and is gone. */
-const PUBLISHED_DELETED = {
-  success: true,
-  reset: true,
-  seq: 42,
-  message: `Deleted view '${VIEW}' — it no longer exists. [seq=42]`,
-};
-/** Framework receipt: no published row. 200, not 404 — the answer #4479 quoted. */
-const NO_PUBLISHED = {
-  success: true,
-  reset: false,
-  message: `No view '${VIEW}' found — nothing to delete.`,
-};
-
-interface Call {
-  /** `'draft'` when the request carried `?state=draft`, else `'published'`. */
-  home: 'draft' | 'published';
-  method: string;
-  url: string;
-}
-
-interface Harness {
-  ds: any;
-  /** Every DELETE against `/meta/view/...`, in issue order. */
-  deletes: Call[];
-  /** Just the home of each DELETE, in issue order — the ordering pin. */
-  order: () => Array<'draft' | 'published'>;
-  /** Keys passed to `metadataCache.invalidate`, in order. */
-  invalidated: string[];
-  baseUrl: string;
-  fetchImpl: any;
-}
-
-/**
- * Adapter whose two delete addresses answer independently.
- *
- * @param opts.draft      receipt (or Error/status) for `DELETE ...?state=draft`
- * @param opts.published  receipt (or Error/status) for `DELETE ...` (active)
- */
-function makeDS(opts: {
-  draft?: unknown | { failStatus: number };
-  published?: unknown | { failStatus: number };
-} = {}): Harness {
-  const deletes: Call[] = [];
-  const invalidated: string[] = [];
-  const baseUrl = 'http://test.local';
-
-  const json = (body: unknown, status = 200) =>
-    new Response(JSON.stringify(body), {
-      status,
-      headers: { 'Content-Type': 'application/json' },
-    });
-
-  const answer = (spec: unknown) => {
-    if (spec && typeof spec === 'object' && 'failStatus' in (spec as any)) {
-      const status = (spec as any).failStatus as number;
-      return json({ error: { message: 'boom', code: 'server_error' } }, status);
-    }
-    return json(spec);
-  };
-
-  const fetchImpl = vi.fn(async (input: RequestInfo | URL, init?: RequestInit) => {
-    const url = String(input);
-    const method = init?.method ?? 'GET';
-    if (url.includes('/meta/view/')) {
-      if (method === 'DELETE') {
-        const home = url.includes('state=draft') ? 'draft' : 'published';
-        deletes.push({ home, method, url });
-        return answer(home === 'draft' ? opts.draft ?? NO_DRAFT : opts.published ?? NO_PUBLISHED);
-      }
-      return json({ error: 'not found' }, 404);
-    }
-    return json({ success: true, data: { capabilities: {}, routes: {} } });
-  });
-
-  const ds: any = new ObjectStackAdapter({ baseUrl, fetch: fetchImpl });
-  ds.connected = true;
-  ds.connectionState = 'connected';
-
-  ds.metadataCache = {
-    get: async (_key: string, loader: () => Promise<any>) => loader(),
-    invalidate: (key: string) => {
-      invalidated.push(key);
-    },
-    getCachedSync: () => undefined,
-    getStats: () => ({}),
-  };
-
-  // SDK transport stand-in. NOT a stub of the behaviour under test: it issues
-  // the same real request the shipped `client.meta.deleteItem` issues
-  // (`${baseUrl}/api/v1/meta/:type/:name`, DELETE) and unwraps the
-  // `{success, data}` envelope exactly as `unwrapResponse` does, so the
-  // published half is observed at the WIRE whichever transport carries it.
-  ds.client = {
-    meta: {
-      deleteItem: async (type: string, name: string) => {
-        const res = await fetchImpl(
-          `${baseUrl}/api/v1/meta/${encodeURIComponent(type)}/${encodeURIComponent(name)}`,
-          { method: 'DELETE' },
-        );
-        const body: any = await res.json();
-        if (!res.ok) {
-          throw Object.assign(new Error(body?.error?.message ?? 'request failed'), {
-            httpStatus: res.status,
-          });
-        }
-        if (body && typeof body.success === 'boolean' && 'data' in body) return body.data;
-        return body;
-      },
-      getItem: vi.fn(async () => {
-        throw Object.assign(new Error('Metadata item not found'), { httpStatus: 404 });
-      }),
-      saveItem: vi.fn(async () => ({ success: true })),
-      getItems: vi.fn(async () => ({ items: [] })),
-    },
-  };
-
-  return {
-    ds,
-    deletes,
-    order: () => deletes.map((c) => c.home),
-    invalidated,
-    baseUrl,
-    fetchImpl,
-  };
-}
-
-describe('deleteView removes every home the view has (#4479)', () => {
-  // ── Row 1: draft-only — the reported bug ────────────────────────────────
-  describe('draft-only view (the #4479 bug row)', () => {
-    it('deletes the draft home, so the view is actually gone', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: NO_PUBLISHED });
-
-      const receipt = await h.ds.deleteView('account', VIEW);
-
-      // The user-visible symptom first: before #4479 the only request issued
-      // was the unqualified one, the server answered `reset:false` /
-      // "nothing to delete", and this receipt came back `{deleted:false}`
-      // with the draft untouched and the tab back after reload.
-      expect(receipt.deleted).toBe(true);
-      // ...because the draft home was never addressed.
-      expect(h.order()).toContain('draft');
-    });
-
-    it('reports the draft home as the one that had the row', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: NO_PUBLISHED });
-
-      const receipt = await h.ds.deleteView('account', VIEW);
-
-      expect(receipt.draft?.removed).toBe(true);
-      expect(receipt.published?.removed).toBe(false);
-    });
-  });
-
-  // ── Row 2: published-only — correct before, must stay correct ───────────
-  describe('published-only view (correct before #4479)', () => {
-    it('still deletes the published home and still reports deleted', async () => {
-      const h = makeDS({ draft: NO_DRAFT, published: PUBLISHED_DELETED });
-
-      const receipt = await h.ds.deleteView('account', VIEW);
-
-      expect(h.order()).toContain('published');
-      // Unchanged from before #4479 — this half was never broken.
-      expect(receipt.deleted).toBe(true);
-    });
-
-    it('addresses both homes even when only one answers with a row', async () => {
-      const h = makeDS({ draft: NO_DRAFT, published: PUBLISHED_DELETED });
-
-      const receipt = await h.ds.deleteView('account', VIEW);
-
-      expect(h.order()).toEqual(['draft', 'published']);
-      expect(receipt.draft?.removed).toBe(false);
-      expect(receipt.published?.removed).toBe(true);
-    });
-  });
-
-  // ── Row 3: the pair — accidentally correct before; MUST NOT REGRESS ─────
-  describe('published + pending draft pair (must-not-change + the anti-mirror guard)', () => {
-    it('MUST NOT CHANGE: the published home is still deleted, so the tab still goes', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-
-      const receipt = await h.ds.deleteView('account', VIEW);
-
-      // This is the assertion a naive draft-first mirror of #4139 would have
-      // broken: it would have discarded the draft and returned, leaving the
-      // published row serving the view and the tab present after reload.
-      expect(h.order()).toContain('published');
-      expect(receipt.deleted).toBe(true);
-    });
-
-    it('also discards the orphan draft, so a republish cannot resurrect the view', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-
-      const receipt = await h.ds.deleteView('account', VIEW);
-
-      expect(h.order()).toEqual(['draft', 'published']);
-      expect(receipt.draft?.removed).toBe(true);
-      expect(receipt.published?.removed).toBe(true);
-    });
-
-    it('invalidates both view cache keys exactly once (#4363 rule, unchanged)', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-
-      await h.ds.deleteView('account', VIEW);
-
-      // Two homes deleted, still ONE ordered pair: the #4363 rule is per
-      // WRITE METHOD, not per request.
-      expect(h.invalidated).toEqual([`view:account:${VIEW}`, 'view-overrides:account']);
-    });
-  });
-
-  // ── Row 4: neither home — the control ───────────────────────────────────
-  it('MUST NOT CHANGE: a view with no home at all reports deleted:false', async () => {
-    const h = makeDS({ draft: NO_DRAFT, published: NO_PUBLISHED });
-
-    const receipt = await h.ds.deleteView('account', VIEW);
-
-    // Both homes answer 200 `reset:false`. Nothing was removed and the
-    // receipt has never claimed otherwise — that answer is preserved.
-    expect(receipt.deleted).toBe(false);
-  });
-
-  // ── Ordering ────────────────────────────────────────────────────────────
-  it('addresses the draft home strictly before the published one', async () => {
-    const h = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-
-    await h.ds.deleteView('account', VIEW);
-
-    expect(h.order()).toEqual(['draft', 'published']);
-    expect(h.deletes[0].url).toContain('state=draft');
-    expect(h.deletes[1].url).not.toContain('state=draft');
-  });
-
-  // ── One transport, one error contract ───────────────────────────────────
-  it('sends both deletes to the same `/api/v1/meta/view/:name` route', async () => {
-    const h = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-
-    await h.ds.deleteView('account', VIEW);
-
-    const base = `${h.baseUrl}/api/v1/meta/view/${encodeURIComponent(VIEW)}`;
-    expect(h.deletes[0].url).toBe(`${base}?state=draft`);
-    expect(h.deletes[1].url).toBe(base);
-  });
-
-  // ── Failure paths — updateView's convention: throw, never degrade ───────
-  describe('partial failure', () => {
-    it('a failing draft delete throws and leaves the published home untouched', async () => {
-      const h = makeDS({ draft: { failStatus: 500 }, published: PUBLISHED_DELETED });
-
-      await expect(h.ds.deleteView('account', VIEW)).rejects.toThrow();
-
-      // The whole reason the ruling put the draft FIRST: a mid-operation
-      // failure must leave the published overlay serving the view, so the
-      // user retries a delete rather than being left with the draft-only
-      // shape that is this card's original bug.
-      expect(h.order()).toEqual(['draft']);
-    });
-
-    it('a failing published delete throws rather than reporting deleted:true', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: { failStatus: 500 } });
-
-      await expect(h.ds.deleteView('account', VIEW)).rejects.toThrow();
-
-      expect(h.order()).toEqual(['draft', 'published']);
-    });
-
-    it('the published-half failure carries the partial outcome, never rounds it to true', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: { failStatus: 500 } });
-
-      const err: any = await h.ds.deleteView('account', VIEW).catch((e: any) => e);
-
-      // "draft gone, overlay left" is exactly what the old
-      // `{ deleted: boolean }` could not express.
-      expect(err.outcome?.deleted).toBe(false);
-      expect(err.outcome?.draft?.removed).toBe(true);
-      expect(err.outcome?.published?.removed).toBe(false);
-      expect(err.cause).toBeDefined();
-    });
-
-    it('still invalidates the view cache keys when a half fails', async () => {
-      const h = makeDS({ draft: DRAFT_DISCARDED, published: { failStatus: 500 } });
-
-      await h.ds.deleteView('account', VIEW).catch(() => undefined);
-
-      // The draft row IS gone, so a cache still holding it is stale for the
-      // full TTL. #4363's asymmetry decides it: an unnecessary invalidation
-      // costs one refetch, a missed one costs five minutes of stale overrides.
-      expect(h.invalidated).toEqual([`view:account:${VIEW}`, 'view-overrides:account']);
-    });
-  });
-
-  // ── discardRuntimeDraft stays a DIFFERENT operation ─────────────────────
-  it('stays distinct from Discard draft, which touches only the draft home', async () => {
-    // `discardRuntimeDraft` (app-shell `runtime-metadata-persistence.ts`) is
-    // documented as "the published overlay is untouched" and is exactly this
-    // one call. Driven here through the same primitive rather than imported,
-    // because app-shell is downstream of this package — the point is that the
-    // two operations issue DIFFERENT request sets against the same wire.
-    const h = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-
-    await new MetadataClient({ baseUrl: h.baseUrl, fetch: h.fetchImpl }).reset('view', VIEW, {
-      state: 'draft',
-    });
-    expect(h.order()).toEqual(['draft']);
-
-    // Same wire, same view: Delete view addresses BOTH homes. If these two
-    // ever issue the same request set, one of the operations has been lost.
-    const fresh = makeDS({ draft: DRAFT_DISCARDED, published: PUBLISHED_DELETED });
-    await fresh.ds.deleteView('account', VIEW);
-    expect(fresh.order()).toEqual(['draft', 'published']);
-  });
-});