@mymehq/sdk 3.8.0 → 4.0.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { MergeStrategy, ConflictSnapshot, MergePolicy, ItemState, Item, CreateItemInput, PaginatedResult, ItemWithMetadata, Version, Edge, Metadata, SearchResult, CreateEdgeInput, EdgeTypeSchema, TypeSchema, CreateKeyInput, ApiKey, UpdateKeyInput, CreateWebhookInput, Webhook, UpdateWebhookInput, WebhookDelivery, TenantConfig } from '@mymehq/shared';
+import { MergeStrategy, ConflictSnapshot, MergePolicy, ItemState, Tier, Item, 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';
 
 /**
@@ -94,9 +94,9 @@ interface UpdateOptions {
     conflict?: ConflictStrategy;
     /** Custom conflict resolver (required when `conflict` is `"callback"`). */
     resolve?: ConflictResolver;
-    /** Toggle library / ambient state. Independent of the version-merge path
-     *  for `properties`; a library-only update never conflicts. */
-    library?: boolean;
+    /** Toggle the tier (`library` ↔ `feed`). Independent of the version-merge
+     *  path for `properties`; a tier-only update never conflicts. */
+    tier?: Tier;
     /**
      * 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 —
@@ -115,10 +115,9 @@ interface ListFilters {
     type?: string;
     state?: ItemState;
     source?: string;
-    /** Tri-value library filter. `true` restricts to library items; `false`
-     * restricts to ambient items; omitting the field returns both (the V0
-     * default). */
-    library?: boolean;
+    /** Tier filter. `"library"` restricts to library items; `"feed"` restricts
+     * to feed items; `"all"` (or omitting the field) returns both. */
+    tier?: Tier | "all";
     tags?: string[];
     /** Filter-language expression, e.g. `edge[parent-of] eq "<id>"` or
      *  `edge[parent-of] not_exists`. The filter language replaces the
@@ -152,8 +151,8 @@ type ItemWithExtensions = Item & {
 interface SearchFilters {
     type?: string;
     state?: ItemState;
-    /** Tri-value library filter, matching `ListFilters.library`. */
-    library?: boolean;
+    /** Tier filter, matching `ListFilters.tier`. */
+    tier?: Tier | "all";
     /** Items must have ALL specified tags (AND semantics). Matches
      *  `ListFilters.tags` and `/items?tags=`. */
     tags?: string[];
@@ -170,7 +169,7 @@ interface BulkItemInput {
     type: string;
     properties?: Record<string, unknown>;
     state?: ItemState;
-    library?: boolean;
+    tier?: Tier;
     timestamp?: string;
     /** Ignored on the wire — server stamps `source` from the credential.
      *  Kept on the input shape for round-trip parity with /export output. */
@@ -265,7 +264,7 @@ interface BulkActionFilter {
     type?: string;
     state?: ItemState;
     source?: string;
-    library?: boolean;
+    tier?: Tier | "all";
     tags?: string[];
     since?: string;
     until?: string;
@@ -295,8 +294,8 @@ type BulkActionInput = (BulkActionBase & {
     add?: string[];
     remove?: string[];
 }) | (BulkActionBase & {
-    action: "update_library";
-    library: boolean;
+    action: "update_tier";
+    tier: Tier;
 }) | (BulkActionBase & {
     action: "update_properties";
     patch: Record<string, unknown>;
@@ -486,7 +485,7 @@ declare class MymeClient {
     readonly keys: {
         /** Creates an API key. The raw key value is returned exactly once on
          * creation; the rest of the shape mirrors the persisted ApiKey record
-         * (source, default_origin, default_library, type_permissions, and
+         * (source, default_origin, default_tier, type_permissions, and
          * extension_permissions are all stamped at create time and visible
          * here so the caller doesn't need a follow-up GET /keys to inspect
          * them). */
@@ -574,6 +573,40 @@ declare class ConflictError extends MymeError {
     constructor(current: ConflictSnapshot, ancestor: ConflictSnapshot, conflictingFields: string[], clientPatch: Record<string, unknown>);
 }
 
+/**
+ * Authoring helper for declaring custom Myme types in TypeScript (TSC42 §7).
+ *
+ * The function is a no-op at runtime — it returns its input unchanged. Its
+ * value is at the type level: `defineType` constrains the argument to a
+ * structurally-valid `TypeSchema`, surfacing field-shape mistakes at compile
+ * time rather than at `POST /types` rejection time. Pair with the SDK's
+ * `client.types.register(schema)` call to register the type with the server.
+ *
+ * Example:
+ *
+ * ```ts
+ * import { defineType } from "@mymehq/sdk";
+ *
+ * export const acmeDeal = defineType({
+ *   id: "acme.deal",
+ *   label: "Deal",
+ *   description: "A sales pipeline opportunity",
+ *   version: 1,
+ *   fields: {
+ *     name: { type: "string", description: "Deal name", required: true },
+ *     amount: { type: "number", description: "Deal value (USD)" },
+ *   },
+ * });
+ *
+ * await client.types.register(acmeDeal);
+ * ```
+ *
+ * The helper preserves the literal types of the schema (via the generic
+ * parameter), so downstream code that reads `acmeDeal.fields.name.type` sees
+ * the narrowed literal `"string"` rather than the wide `FieldType` union.
+ */
+declare function defineType<T extends TypeSchema>(schema: T): T;
+
 /**
  * Reason a webhook signature did not validate. Receivers should treat
  * any non-`valid` result as "do not trust this delivery".
@@ -626,4 +659,4 @@ interface VerifyWebhookSignatureInput {
  */
 declare function verifyWebhookSignature(input: VerifyWebhookSignatureInput): WebhookVerifyResult;
 
-export { type BulkActionErrorEntry, type BulkActionFilter, type BulkActionInput, type BulkActionResult, type BulkEdgeInput, type BulkEdgeInputItem, type BulkEdgeResult, type BulkEdgeResultEntry, type BulkInput, type BulkItemInput, type BulkMode, type BulkOutcome, type BulkResult, type BulkResultEntry, 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, type VerifyWebhookSignatureInput, type WebhookVerifyReason, type WebhookVerifyResult, verifyWebhookSignature };
+export { type BulkActionErrorEntry, type BulkActionFilter, type BulkActionInput, type BulkActionResult, type BulkEdgeInput, type BulkEdgeInputItem, type BulkEdgeResult, type BulkEdgeResultEntry, type BulkInput, type BulkItemInput, type BulkMode, type BulkOutcome, type BulkResult, type BulkResultEntry, 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, type VerifyWebhookSignatureInput, type WebhookVerifyReason, type WebhookVerifyResult, defineType, verifyWebhookSignature };

package/dist/index.js

@@ -239,7 +239,7 @@ function toConflictError(response, clientPatch) {
     clientPatch
   );
 }
-async function handleConflictUpdate(transport, itemId, itemType, clientPatch, version, strategy, resolver, library, onAutoMerge) {
+async function handleConflictUpdate(transport, itemId, itemType, clientPatch, version, strategy, resolver, tier, onAutoMerge) {
   let properties = clientPatch;
   let currentVersion = version;
   let pendingAutoMergeEvent;
@@ -248,7 +248,7 @@ async function handleConflictUpdate(transport, itemId, itemType, clientPatch, ve
       body: {
         properties,
         version: currentVersion,
-        ...library !== void 0 && { library }
+        ...tier !== void 0 && { tier }
       }
     });
     if (!isConflictResponse(result)) {
@@ -401,7 +401,7 @@ var MymeClient = class {
         version,
         strategy,
         options?.resolve,
-        options?.library,
+        options?.tier,
         onAutoMerge
       );
     },
@@ -750,7 +750,7 @@ var MymeClient = class {
   keys = {
     /** Creates an API key. The raw key value is returned exactly once on
      * creation; the rest of the shape mirrors the persisted ApiKey record
-     * (source, default_origin, default_library, type_permissions, and
+     * (source, default_origin, default_tier, type_permissions, and
      * extension_permissions are all stamped at create time and visible
      * here so the caller doesn't need a follow-up GET /keys to inspect
      * them). */
@@ -862,6 +862,11 @@ var MymeClient = class {
   }
 };
 
+// src/define-type.ts
+function defineType(schema) {
+  return schema;
+}
+
 // src/webhooks.ts
 import { createHmac, timingSafeEqual } from "crypto";
 var STRIPE_HEADER_RE = /^t=(\d+),v1=([0-9a-f]+)$/;
@@ -900,5 +905,6 @@ export {
   NotFoundError,
   UnauthorizedError,
   ValidationError,
+  defineType,
   verifyWebhookSignature
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mymehq/sdk",
-  "version": "3.8.0",
+  "version": "4.0.0",
   "type": "module",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
@@ -16,13 +16,13 @@
     "dist"
   ],
   "dependencies": {
-    "@mymehq/shared": "3.5.0"
+    "@mymehq/shared": "4.0.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.2",
-    "@mymehq/server": "0.0.1"
+    "@mymehq/server": "1.0.0"
   },
   "scripts": {
     "build": "tsup",