@mymehq/sdk 3.2.0 → 3.3.1

package/dist/index.d.ts

@@ -1,11 +1,14 @@
-import { ConflictSnapshot, ItemState, CreateItemInput, Item, PaginatedResult, ItemWithMetadata, Version, Edge, Metadata, SearchResult, CreateEdgeInput, EdgeTypeSchema, TypeSchema, CreateKeyInput, ApiKey, UpdateKeyInput, CreateWebhookInput, Webhook, UpdateWebhookInput, WebhookDelivery, TenantConfig } from '@mymehq/shared';
-export { ApiKey, ConflictSnapshot, CreateItemInput, CreateKeyInput, Item, ItemState, Metadata, PaginatedResult, SearchResult, TypeSchema, UpdateKeyInput, Version } from '@mymehq/shared';
+import { MergeStrategy, ConflictSnapshot, MergePolicy, Item, ItemState, CreateItemInput, PaginatedResult, ItemWithMetadata, Version, Edge, Metadata, SearchResult, CreateEdgeInput, EdgeTypeSchema, TypeSchema, CreateKeyInput, ApiKey, UpdateKeyInput, CreateWebhookInput, Webhook, UpdateWebhookInput, WebhookDelivery, TenantConfig } from '@mymehq/shared';
+export { ApiKey, ConflictSnapshot, CreateItemInput, CreateKeyInput, Item, ItemState, MergePolicy, MergeStrategy, Metadata, PaginatedResult, SearchResult, TypeSchema, UpdateKeyInput, Version } from '@mymehq/shared';
 
 /**
  * Conflict resolution strategy for item updates.
  *
- * - `"auto"` (default): Non-conflicting field changes merge automatically.
- *   Conflicting fields use the server's current value. Retries up to 3 times.
+ * - `"auto"` (default): policy-aware. Per-field strategies declared on the
+ *   type drive the merge. `last_writer_wins` fields take the server's value;
+ *   `keep_both_copies` fields spawn a sibling item tagged `conflicted-copy`
+ *   with the client's value, leaving the original at the server's value.
+ *   The default for fields not listed in the policy is `last_writer_wins`.
  * - `"manual"`: Throws a `ConflictError` with both versions and the list of
  *   conflicting fields. The caller decides how to resolve.
  * - `"callback"`: Calls a custom `ConflictResolver` function with the conflict
@@ -17,8 +20,32 @@ interface ConflictData {
     ancestor: ConflictSnapshot;
     conflictingFields: string[];
     clientPatch: Record<string, unknown>;
+    /** Resolved per-field merge policy for the conflicting item's type. */
+    mergePolicy: MergePolicy;
 }
 type ConflictResolver = (conflict: ConflictData) => Record<string, unknown> | Promise<Record<string, unknown>>;
+/**
+ * Notification payload emitted by the auto-merge path. Surfaces the per-field
+ * outcome so callers can present an accurate UI affordance (e.g. "your edit
+ * was saved as a conflicted copy").
+ *
+ * - `itemId` — the original item that was being updated.
+ * - `mergedItemId` — the same id; included so listeners that care about
+ *   identity in event streams have a stable field.
+ * - `conflictedCopyId` — present when at least one `keep_both_copies` field
+ *   conflicted; the id of the spawned sibling that carries the client's edit.
+ * - `fields` — the list of fields that conflicted.
+ * - `strategy` — keyed by field name, the strategy applied to each.
+ */
+interface ConflictAutoMergedEvent {
+    itemId: string;
+    mergedItemId: string;
+    conflictedCopyId?: string;
+    fields: string[];
+    strategy: Record<string, MergeStrategy>;
+}
+/** Optional callback fired when the auto-merge path completes successfully. */
+type ConflictAutoMergeListener = (event: ConflictAutoMergedEvent) => void | Promise<void>;
 
 interface ClientConfig {
     url: string;
@@ -31,6 +58,13 @@ interface ClientConfig {
      * use the server's value.
      */
     conflictStrategy?: ConflictStrategy;
+    /**
+     * Default listener invoked after the auto-merge path completes successfully.
+     * Receives a `ConflictAutoMergedEvent` describing the per-field outcome and
+     * any spawned conflicted-copy id. Per-call overridable via
+     * `UpdateOptions.onAutoMerge`.
+     */
+    onConflictAutoMerge?: ConflictAutoMergeListener;
     timeoutMs?: number;
     cdnBaseUrl?: string;
 }
@@ -48,6 +82,16 @@ interface UpdateOptions {
     /** Toggle library / ambient state. Independent of the version-merge path
      *  for `properties`; a library-only update never conflicts. */
     library?: boolean;
+    /**
+     * Item type. Required by the `auto` strategy when a `keep_both_copies`
+     * conflict spawns a sibling item. Omit to let the SDK pre-fetch it.
+     */
+    type?: string;
+    /**
+     * Listener invoked after the auto-merge path completes successfully.
+     * Overrides the client's default `onConflictAutoMerge` for this call.
+     */
+    onAutoMerge?: ConflictAutoMergeListener;
 }
 interface ListFilters {
     type?: string;
@@ -68,7 +112,25 @@ interface ListFilters {
     until?: string;
     limit?: number;
     cursor?: string;
+    /**
+     * Opt-in hydrations on the list response. Comma-separated values; each
+     * value widens the per-item shape. Prefer the typed helpers
+     * (`listWithMetadata`, `listWithExtensions`) over raw strings.
+     *
+     * - `metadata` — wraps each entry as `{ item, metadata }`.
+     * - `edges` — hydrates outbound edges per item grouped by type.
+     * - `extensions` — hydrates extension namespaces (filtered by caller
+     *   permissions, same rule as `GET /items/:id/extensions`).
+     *
+     * Lists are lean by default; opt into extras when the UI needs them
+     * to avoid N+1 per-item round trips.
+     */
+    include?: string;
 }
+/** Item paired with its hydrated extension namespaces. */
+type ItemWithExtensions = Item & {
+    extensions: Record<string, Record<string, unknown>>;
+};
 interface SearchFilters {
     type?: string;
     state?: ItemState;
@@ -86,6 +148,7 @@ interface MetadataInput {
 declare class MymeClient {
     private readonly transport;
     private readonly defaultConflictStrategy;
+    private readonly defaultOnConflictAutoMerge?;
     private readonly apiBaseUrl;
     private readonly cdnBaseUrl?;
     constructor(config: ClientConfig);
@@ -98,6 +161,14 @@ declare class MymeClient {
         get: (id: string) => Promise<Item>;
         list: (filters?: ListFilters) => Promise<PaginatedResult<Item>>;
         listWithMetadata: (filters?: Omit<ListFilters, "include">) => Promise<PaginatedResult<ItemWithMetadata>>;
+        /**
+         * List items with their extension namespaces hydrated inline. Avoids
+         * the N+1 pattern of listing then calling `GET /items/:id/extensions`
+         * per item. Extensions are filtered by the caller's permissions —
+         * admins see every namespace, members see what they can read or
+         * write.
+         */
+        listWithExtensions: (filters?: Omit<ListFilters, "include">) => Promise<PaginatedResult<ItemWithExtensions>>;
         update: (id: string, properties: Record<string, unknown>, options?: UpdateOptions) => Promise<Item>;
         delete: (id: string) => Promise<void>;
         /** Permanently delete a trashed item (admin only). Item must already
@@ -281,4 +352,4 @@ declare class ConflictError extends MymeError {
     constructor(current: ConflictSnapshot, ancestor: ConflictSnapshot, conflictingFields: string[], clientPatch: Record<string, unknown>);
 }
 
-export { type ClientConfig, type ConflictData, ConflictError, type ConflictResolver, type ConflictStrategy, ForbiddenError, type ListFilters, type MetadataInput, MymeClient, MymeError, NotFoundError, type SearchFilters, UnauthorizedError, type UpdateOptions, ValidationError };
+export { type ClientConfig, type ConflictAutoMergeListener, type ConflictAutoMergedEvent, type ConflictData, ConflictError, type ConflictResolver, type ConflictStrategy, ForbiddenError, type ItemWithExtensions, type ListFilters, type MetadataInput, MymeClient, MymeError, NotFoundError, type SearchFilters, UnauthorizedError, type UpdateOptions, ValidationError };

package/dist/index.js

@@ -156,14 +156,41 @@ var MAX_RETRIES = 3;
 function isConflictResponse(body) {
   return typeof body === "object" && body !== null && "error" in body && "current" in body && "conflicting_fields" in body;
 }
-function autoMerge(conflict) {
+function strategyFor(field, policy) {
+  return policy?.fields?.[field] ?? policy?.default ?? "last_writer_wins";
+}
+function planAutoMerge(conflict) {
   const merged = { ...conflict.current.properties };
+  const keepBothFields = [];
+  const strategyByField = {};
   for (const [key, value] of Object.entries(conflict.clientPatch)) {
-    if (!conflict.conflictingFields.includes(key)) {
+    const isConflicting = conflict.conflictingFields.includes(key);
+    if (!isConflicting) {
       merged[key] = value;
+      continue;
+    }
+    const strategy = strategyFor(key, conflict.mergePolicy);
+    strategyByField[key] = strategy;
+    if (strategy === "keep_both_copies") {
+      keepBothFields.push(key);
     }
   }
-  return merged;
+  return { merged, keepBothFields, strategyByField };
+}
+async function keepBothFlow(transport, type, current, clientPatch, keepBothFields) {
+  const properties = { ...current };
+  for (const field of keepBothFields) {
+    properties[field] = clientPatch[field];
+  }
+  const input = {
+    type,
+    properties,
+    tags: ["conflicted-copy"]
+  };
+  const res = await transport.request("POST", "/items", {
+    body: input
+  });
+  return res.item;
 }
 function toConflictError(response, clientPatch) {
   return new ConflictError(
@@ -173,9 +200,10 @@ function toConflictError(response, clientPatch) {
     clientPatch
   );
 }
-async function handleConflictUpdate(transport, itemId, clientPatch, version, strategy, resolver, library) {
+async function handleConflictUpdate(transport, itemId, itemType, clientPatch, version, strategy, resolver, library, onAutoMerge) {
   let properties = clientPatch;
   let currentVersion = version;
+  let pendingAutoMergeEvent;
   for (let attempt = 0; attempt <= MAX_RETRIES; attempt++) {
     const result = await transport.requestWithConflict("PATCH", `/items/${itemId}`, {
       body: {
@@ -185,6 +213,9 @@ async function handleConflictUpdate(transport, itemId, clientPatch, version, str
       }
     });
     if (!isConflictResponse(result)) {
+      if (pendingAutoMergeEvent && onAutoMerge) {
+        await onAutoMerge(pendingAutoMergeEvent);
+      }
       return result.item;
     }
     if (strategy === "manual") {
@@ -197,10 +228,30 @@ async function handleConflictUpdate(transport, itemId, clientPatch, version, str
       current: result.current,
       ancestor: result.ancestor,
       conflictingFields: result.conflicting_fields,
-      clientPatch
+      clientPatch,
+      mergePolicy: result.merge_policy
     };
     if (strategy === "auto") {
-      properties = autoMerge(conflict);
+      const plan = planAutoMerge(conflict);
+      let conflictedCopyId;
+      if (plan.keepBothFields.length > 0) {
+        const sibling = await keepBothFlow(
+          transport,
+          itemType,
+          result.current.properties,
+          clientPatch,
+          plan.keepBothFields
+        );
+        conflictedCopyId = sibling.id;
+      }
+      properties = plan.merged;
+      pendingAutoMergeEvent = {
+        itemId,
+        mergedItemId: itemId,
+        conflictedCopyId,
+        fields: conflict.conflictingFields,
+        strategy: plan.strategyByField
+      };
     } else {
       if (!resolver) {
         throw toConflictError(result, clientPatch);
@@ -221,6 +272,7 @@ async function handleConflictUpdate(transport, itemId, clientPatch, version, str
 var MymeClient = class {
   transport;
   defaultConflictStrategy;
+  defaultOnConflictAutoMerge;
   apiBaseUrl;
   cdnBaseUrl;
   constructor(config) {
@@ -232,6 +284,7 @@ var MymeClient = class {
       timeoutMs: config.timeoutMs
     });
     this.defaultConflictStrategy = config.conflictStrategy ?? "auto";
+    this.defaultOnConflictAutoMerge = config.onConflictAutoMerge;
     this.cdnBaseUrl = config.cdnBaseUrl;
   }
   // ---- Items ----
@@ -268,21 +321,45 @@ var MymeClient = class {
         }
       );
     },
+    /**
+     * List items with their extension namespaces hydrated inline. Avoids
+     * the N+1 pattern of listing then calling `GET /items/:id/extensions`
+     * per item. Extensions are filtered by the caller's permissions —
+     * admins see every namespace, members see what they can read or
+     * write.
+     */
+    listWithExtensions: async (filters) => {
+      return this.transport.request(
+        "GET",
+        "/items",
+        {
+          query: {
+            ...filters,
+            include: "extensions"
+          }
+        }
+      );
+    },
     update: async (id, properties, options) => {
       let version = options?.version;
-      if (version === void 0) {
+      let type = options?.type;
+      if (version === void 0 || type === void 0) {
         const item = await this.items.get(id);
-        version = item.version;
+        version ??= item.version;
+        type ??= item.type;
       }
       const strategy = options?.conflict ?? this.defaultConflictStrategy;
+      const onAutoMerge = options?.onAutoMerge ?? this.defaultOnConflictAutoMerge;
       return handleConflictUpdate(
         this.transport,
         id,
+        type,
         properties,
         version,
         strategy,
         options?.resolve,
-        options?.library
+        options?.library,
+        onAutoMerge
       );
     },
     delete: async (id) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mymehq/sdk",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "type": "module",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
@@ -16,7 +16,7 @@
     "dist"
   ],
   "dependencies": {
-    "@mymehq/shared": "3.2.0"
+    "@mymehq/shared": "3.3.1"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",