@memnexus-ai/typescript-sdk 1.44.0 → 1.46.0

package/dist/index.d.cts

@@ -1164,10 +1164,14 @@ declare const namedMemoryHistoryResponse: z.ZodObject<{
 declare const batchGetMemoriesRequest: z.ZodObject<{
     /** Array of memory IDs to retrieve */
     ids: z.ZodArray<z.ZodString, "many">;
+    /** Detail level for each memory. 'minimal' returns raw memory only (default, backward compatible). 'standard' adds topics, entities, facts, and relationships. */
+    detail: z.ZodOptional<z.ZodEnum<["minimal", "standard"]>>;
 }, "strip", z.ZodTypeAny, {
     ids: string[];
+    detail?: "minimal" | "standard" | undefined;
 }, {
     ids: string[];
+    detail?: "minimal" | "standard" | undefined;
 }>;
 declare const batchGetMemoriesMeta: z.ZodObject<{
     /** Number of IDs requested */
@@ -5178,6 +5182,360 @@ declare const digestResponse: z.ZodLazy<z.ZodObject<{
         conversation?: string | undefined;
     }[];
 }>>;
+declare const buildContextRequest: z.ZodObject<{
+    /** What you are about to work on */
+    context: z.ZodString;
+    /** File paths you will be touching */
+    files: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /** How far back to look for recent activity (hours, default 24) */
+    recentHours: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    context: string;
+    files?: string[] | undefined;
+    recentHours?: number | undefined;
+}, {
+    context: string;
+    files?: string[] | undefined;
+    recentHours?: number | undefined;
+}>;
+/**
+ * Most relevant active conversation, or null if none found
+ */
+declare const buildContextActiveWork: z.ZodNullable<z.ZodObject<{
+    /** Conversation ID */
+    conversationId: z.ZodString;
+    /** Conversation title */
+    title: z.ZodNullable<z.ZodString>;
+    /** ISO 8601 timestamp of last activity */
+    lastActivity: z.ZodString;
+    /** Most recent memory in this conversation */
+    lastMemory: z.ZodObject<{
+        /** Memory ID */
+        id: z.ZodString;
+        /** Truncated content summary */
+        summary: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        summary: string;
+    }, {
+        id: string;
+        summary: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    conversationId: string;
+    title: string | null;
+    lastActivity: string;
+    lastMemory: {
+        id: string;
+        summary: string;
+    };
+}, {
+    conversationId: string;
+    title: string | null;
+    lastActivity: string;
+    lastMemory: {
+        id: string;
+        summary: string;
+    };
+}>>;
+declare const buildContextFact: z.ZodObject<{
+    /** Fact subject */
+    subject: z.ZodString;
+    /** Fact predicate */
+    predicate: z.ZodString;
+    /** Fact object */
+    object: z.ZodString;
+    /** Confidence score (0-1) */
+    confidence: z.ZodNumber;
+    /** Memory this fact was extracted from */
+    sourceMemoryId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    object: string;
+    confidence: number;
+    subject: string;
+    predicate: string;
+    sourceMemoryId: string;
+}, {
+    object: string;
+    confidence: number;
+    subject: string;
+    predicate: string;
+    sourceMemoryId: string;
+}>;
+declare const buildContextGotcha: z.ZodObject<{
+    /** The gotcha fact text */
+    fact: z.ZodString;
+    /** Number of distinct source memories mentioning this */
+    sourceCount: z.ZodNumber;
+    /** Source memory IDs */
+    sourceMemories: z.ZodArray<z.ZodString, "many">;
+    /** ISO 8601 timestamp of most recent source */
+    lastSeen: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    fact: string;
+    sourceCount: number;
+    sourceMemories: string[];
+    lastSeen: string;
+}, {
+    fact: string;
+    sourceCount: number;
+    sourceMemories: string[];
+    lastSeen: string;
+}>;
+declare const buildContextActivity: z.ZodObject<{
+    /** Memory ID */
+    id: z.ZodString;
+    /** Truncated content summary (max 200 chars) */
+    summary: z.ZodString;
+    /** ISO 8601 timestamp */
+    date: z.ZodString;
+    /** Conversation ID */
+    conversationId: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    date: string;
+    conversationId: string | null;
+    summary: string;
+}, {
+    id: string;
+    date: string;
+    conversationId: string | null;
+    summary: string;
+}>;
+declare const buildContextPattern: z.ZodObject<{
+    /** Pattern description */
+    pattern: z.ZodString;
+    /** Confidence score (0-1) */
+    confidence: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    confidence: number;
+    pattern: string;
+}, {
+    confidence: number;
+    pattern: string;
+}>;
+/**
+ * Request metadata for transparency
+ */
+declare const buildContextMeta: z.ZodObject<{
+    /** Search terms extracted from the context and files */
+    contextTerms: z.ZodArray<z.ZodString, "many">;
+    /** Hours window used for recent activity */
+    recentHours: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    recentHours: number;
+    contextTerms: string[];
+}, {
+    recentHours: number;
+    contextTerms: string[];
+}>;
+declare const buildContextResponse: z.ZodLazy<z.ZodObject<{
+    /** Most relevant active conversation, or null if none found */
+    activeWork: z.ZodNullable<z.ZodObject<{
+        /** Conversation ID */
+        conversationId: z.ZodString;
+        /** Conversation title */
+        title: z.ZodNullable<z.ZodString>;
+        /** ISO 8601 timestamp of last activity */
+        lastActivity: z.ZodString;
+        /** Most recent memory in this conversation */
+        lastMemory: z.ZodObject<{
+            /** Memory ID */
+            id: z.ZodString;
+            /** Truncated content summary */
+            summary: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            summary: string;
+        }, {
+            id: string;
+            summary: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        conversationId: string;
+        title: string | null;
+        lastActivity: string;
+        lastMemory: {
+            id: string;
+            summary: string;
+        };
+    }, {
+        conversationId: string;
+        title: string | null;
+        lastActivity: string;
+        lastMemory: {
+            id: string;
+            summary: string;
+        };
+    }>>;
+    /** Facts related to the context terms */
+    relevantFacts: z.ZodArray<z.ZodObject<{
+        /** Fact subject */
+        subject: z.ZodString;
+        /** Fact predicate */
+        predicate: z.ZodString;
+        /** Fact object */
+        object: z.ZodString;
+        /** Confidence score (0-1) */
+        confidence: z.ZodNumber;
+        /** Memory this fact was extracted from */
+        sourceMemoryId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        object: string;
+        confidence: number;
+        subject: string;
+        predicate: string;
+        sourceMemoryId: string;
+    }, {
+        object: string;
+        confidence: number;
+        subject: string;
+        predicate: string;
+        sourceMemoryId: string;
+    }>, "many">;
+    /** Gotchas — facts appearing in 2+ source memories */
+    gotchas: z.ZodArray<z.ZodObject<{
+        /** The gotcha fact text */
+        fact: z.ZodString;
+        /** Number of distinct source memories mentioning this */
+        sourceCount: z.ZodNumber;
+        /** Source memory IDs */
+        sourceMemories: z.ZodArray<z.ZodString, "many">;
+        /** ISO 8601 timestamp of most recent source */
+        lastSeen: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        fact: string;
+        sourceCount: number;
+        sourceMemories: string[];
+        lastSeen: string;
+    }, {
+        fact: string;
+        sourceCount: number;
+        sourceMemories: string[];
+        lastSeen: string;
+    }>, "many">;
+    /** Recent relevant memories within the time window */
+    recentActivity: z.ZodArray<z.ZodObject<{
+        /** Memory ID */
+        id: z.ZodString;
+        /** Truncated content summary (max 200 chars) */
+        summary: z.ZodString;
+        /** ISO 8601 timestamp */
+        date: z.ZodString;
+        /** Conversation ID */
+        conversationId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        date: string;
+        conversationId: string | null;
+        summary: string;
+    }, {
+        id: string;
+        date: string;
+        conversationId: string | null;
+        summary: string;
+    }>, "many">;
+    /** Behavioral patterns related to the context */
+    relatedPatterns: z.ZodArray<z.ZodObject<{
+        /** Pattern description */
+        pattern: z.ZodString;
+        /** Confidence score (0-1) */
+        confidence: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        confidence: number;
+        pattern: string;
+    }, {
+        confidence: number;
+        pattern: string;
+    }>, "many">;
+    /** Request metadata for transparency */
+    meta: z.ZodObject<{
+        /** Search terms extracted from the context and files */
+        contextTerms: z.ZodArray<z.ZodString, "many">;
+        /** Hours window used for recent activity */
+        recentHours: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        recentHours: number;
+        contextTerms: string[];
+    }, {
+        recentHours: number;
+        contextTerms: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    meta: {
+        recentHours: number;
+        contextTerms: string[];
+    };
+    activeWork: {
+        conversationId: string;
+        title: string | null;
+        lastActivity: string;
+        lastMemory: {
+            id: string;
+            summary: string;
+        };
+    } | null;
+    relevantFacts: {
+        object: string;
+        confidence: number;
+        subject: string;
+        predicate: string;
+        sourceMemoryId: string;
+    }[];
+    gotchas: {
+        fact: string;
+        sourceCount: number;
+        sourceMemories: string[];
+        lastSeen: string;
+    }[];
+    recentActivity: {
+        id: string;
+        date: string;
+        conversationId: string | null;
+        summary: string;
+    }[];
+    relatedPatterns: {
+        confidence: number;
+        pattern: string;
+    }[];
+}, {
+    meta: {
+        recentHours: number;
+        contextTerms: string[];
+    };
+    activeWork: {
+        conversationId: string;
+        title: string | null;
+        lastActivity: string;
+        lastMemory: {
+            id: string;
+            summary: string;
+        };
+    } | null;
+    relevantFacts: {
+        object: string;
+        confidence: number;
+        subject: string;
+        predicate: string;
+        sourceMemoryId: string;
+    }[];
+    gotchas: {
+        fact: string;
+        sourceCount: number;
+        sourceMemories: string[];
+        lastSeen: string;
+    }[];
+    recentActivity: {
+        id: string;
+        date: string;
+        conversationId: string | null;
+        summary: string;
+    }[];
+    relatedPatterns: {
+        confidence: number;
+        pattern: string;
+    }[];
+}>>;
 
 /**
  * TypeScript types for API models.
@@ -5268,6 +5626,20 @@ type DigestTimeRange = z.infer<typeof digestTimeRange>;
 type DigestMetadata = z.infer<typeof digestMetadata>;
 type DigestSource = z.infer<typeof digestSource>;
 type DigestResponse = z.infer<typeof digestResponse>;
+type BuildContextRequest = z.infer<typeof buildContextRequest>;
+/**
+ * Most relevant active conversation, or null if none found
+ */
+type BuildContextActiveWork = z.infer<typeof buildContextActiveWork>;
+type BuildContextFact = z.infer<typeof buildContextFact>;
+type BuildContextGotcha = z.infer<typeof buildContextGotcha>;
+type BuildContextActivity = z.infer<typeof buildContextActivity>;
+type BuildContextPattern = z.infer<typeof buildContextPattern>;
+/**
+ * Request metadata for transparency
+ */
+type BuildContextMeta = z.infer<typeof buildContextMeta>;
+type BuildContextResponse = z.infer<typeof buildContextResponse>;
 
 /**
  * UsersService - User management and profile endpoints API operations.
@@ -5921,10 +6293,19 @@ declare class MonitoringService extends BaseService {
 declare class MemoriesService extends BaseService {
     /**
      * Get memory by ID
-     * Retrieve a specific memory by its ID
+     * Retrieve a specific memory by its ID with configurable detail level.
+  
+  **Detail levels:**
+  - `minimal` — raw memory only, no extra queries
+  - `standard` (default) — adds userTopics, extractedTopics, entities, facts, relationships
+  - `full` — adds conversationContext (title, memoryCount, position) and relationship target previews
+  
      * @param id - The memory ID
+     * @param detail - Detail level: minimal (raw memory), standard (default, + topics/entities/facts/relationships), full (+ conversation context and relationship previews)
      */
-    getMemoryById(id: string): Promise<HttpResponse<{
+    getMemoryById(id: string, options?: {
+        detail?: 'minimal' | 'standard' | 'full';
+    }): Promise<HttpResponse<{
         data: Memory;
     }>>;
     /**
@@ -6173,6 +6554,7 @@ declare class MemoriesService extends BaseService {
      */
     getMemoriesBatch(body: {
         ids: string[];
+        detail?: 'minimal' | 'standard';
     }): Promise<HttpResponse<{
         data: Memory[];
         meta: BatchGetMemoriesMeta;
@@ -6211,6 +6593,27 @@ declare class MemoriesService extends BaseService {
         metadata: DigestMetadata;
         sources: DigestSource[];
     }>>;
+    /**
+     * Build a context briefing
+     * Answers "What should I know before working on X?" by combining active work
+  detection, fact retrieval, gotcha detection, recent activity, and pattern
+  matching into a single call. Eliminates the 5+ round-trip pattern agents
+  use today.
+  
+     * @param body - Request body
+     */
+    buildContext(body: {
+        context: string;
+        files?: string[];
+        recentHours?: number;
+    }): Promise<HttpResponse<{
+        activeWork: BuildContextActiveWork;
+        relevantFacts: BuildContextFact[];
+        gotchas: BuildContextGotcha[];
+        recentActivity: BuildContextActivity[];
+        relatedPatterns: BuildContextPattern[];
+        meta: BuildContextMeta;
+    }>>;
     /**
      * Get version history for a named memory
      * Returns the full version chain for a named memory, ordered newest-first.
@@ -6231,11 +6634,14 @@ declare class MemoriesService extends BaseService {
     /**
      * Get a memory by name
      * Retrieve the current HEAD version of a named memory by its user-assigned name.
-  Returns the memory with topic breakdown and entities, same as GET /api/memories/{id}.
+  Supports the same detail levels as GET /api/memories/{id}.
   
      * @param name - Memory name (kebab-case, 2-64 chars)
+     * @param detail - Detail level: minimal (raw memory), standard (default, + topics/entities/facts/relationships), full (+ conversation context and relationship previews)
      */
-    getMemoryByName(name: string): Promise<HttpResponse<{
+    getMemoryByName(name: string, options?: {
+        detail?: 'minimal' | 'standard' | 'full';
+    }): Promise<HttpResponse<{
         data: Memory;
     }>>;
     /**
@@ -7220,4 +7626,4 @@ declare class Memnexus {
     setEnvironment(environment: Environment): void;
 }
 
-export { type AddMemoryToNarrativeRequest, AdminService, type ApiKey, ApiKeysService, type Artifact, ArtifactsService, type BatchGetMemoriesMeta, type BatchGetMemoriesRequest, type BatchGetMemoriesResponse, BehaviorService, type BillingOverview, BillingService, type CheckoutSessionResponse, type Community, ContentType, type Conversation, ConversationsService, type CreateArtifactRequest, type CreateCheckoutSessionRequest, type CreateConversationRequest, type CreateFactRequest, type CreateMemoryRelationshipRequest, type CreateMemoryRequest, type CreateMemoryResponse, type CreateMemoryResponseMeta, type CreateNarrativeRequest, type CreatePortalSessionRequest, type DigestMetadata, type DigestRequest, type DigestResponse, type DigestSource, type DigestTimeRange, EntitiesService, type Entity, type EntityNode, Environment, type Error$1 as Error, type ErrorDefinition, type Fact, type FactSearchRequest, FactsService, type GetMemoryResponse, type GetNarrativeResponse, type GraphRAGQueryRequest, type GraphRAGQueryResponse, GraphragService, type HealthCheck, HealthService, type Hook, type HttpError, type HttpMetadata, type HttpMethod, type HttpRequest, type HttpResponse, InvitesService, type Invoice, type ListInvoicesResponse, type ListNarrativesResponse, type ListPaymentMethodsResponse, Memnexus, MemoriesService, type Memory, type MemoryRelationship, type MemoryRelationshipsResponse, MonitoringService, type NamedMemoryHistoryResponse, type NarrativeMemory, type NarrativeThread, type NarrativeTimelineResponse, NarrativesService, type Pagination, type Pattern, PatternsService, type PaymentMethod, type PortalSessionResponse, type RelatedMemoryResult, type RequestParameter, type ResponseDefinition, type RetryOptions, type SdkConfig, type SearchRequest, type SearchResponse, type SearchResult, SerializationStyle, type ServiceCheck, type Subscription, SystemService, type TemporalMetadata, type Topic, type TopicReference, TopicsService, type UpdateArtifactRequest, type UpdateFactRequest, type UpdateMemoryRequest, type UpdateNamedMemoryRequest, type UpdateNarrativeRequest, type User, type UserUsage, UsersService, type ValidationOptions, addMemoryToNarrativeRequest, apiKey, artifact, batchGetMemoriesMeta, batchGetMemoriesRequest, batchGetMemoriesResponse, billingOverview, checkoutSessionResponse, community, conversation, createArtifactRequest, createCheckoutSessionRequest, createConversationRequest, createFactRequest, createMemoryRelationshipRequest, createMemoryRequest, createMemoryResponse, createMemoryResponseMeta, createNarrativeRequest, createPortalSessionRequest, Memnexus as default, digestMetadata, digestRequest, digestResponse, digestSource, digestTimeRange, entity, entityNode, error, fact, factSearchRequest, getMemoryResponse, getNarrativeResponse, graphRAGQueryRequest, graphRAGQueryResponse, healthCheck, invoice, listInvoicesResponse, listNarrativesResponse, listPaymentMethodsResponse, memory, memoryRelationship, memoryRelationshipsResponse, namedMemoryHistoryResponse, narrativeMemory, narrativeThread, narrativeTimelineResponse, pagination, pattern, paymentMethod, portalSessionResponse, relatedMemoryResult, searchRequest, searchResponse, searchResult, serviceCheck, subscription, temporalMetadata, topic, topicReference, updateArtifactRequest, updateFactRequest, updateMemoryRequest, updateNamedMemoryRequest, updateNarrativeRequest, user, userUsage };
+export { type AddMemoryToNarrativeRequest, AdminService, type ApiKey, ApiKeysService, type Artifact, ArtifactsService, type BatchGetMemoriesMeta, type BatchGetMemoriesRequest, type BatchGetMemoriesResponse, BehaviorService, type BillingOverview, BillingService, type BuildContextActiveWork, type BuildContextActivity, type BuildContextFact, type BuildContextGotcha, type BuildContextMeta, type BuildContextPattern, type BuildContextRequest, type BuildContextResponse, type CheckoutSessionResponse, type Community, ContentType, type Conversation, ConversationsService, type CreateArtifactRequest, type CreateCheckoutSessionRequest, type CreateConversationRequest, type CreateFactRequest, type CreateMemoryRelationshipRequest, type CreateMemoryRequest, type CreateMemoryResponse, type CreateMemoryResponseMeta, type CreateNarrativeRequest, type CreatePortalSessionRequest, type DigestMetadata, type DigestRequest, type DigestResponse, type DigestSource, type DigestTimeRange, EntitiesService, type Entity, type EntityNode, Environment, type Error$1 as Error, type ErrorDefinition, type Fact, type FactSearchRequest, FactsService, type GetMemoryResponse, type GetNarrativeResponse, type GraphRAGQueryRequest, type GraphRAGQueryResponse, GraphragService, type HealthCheck, HealthService, type Hook, type HttpError, type HttpMetadata, type HttpMethod, type HttpRequest, type HttpResponse, InvitesService, type Invoice, type ListInvoicesResponse, type ListNarrativesResponse, type ListPaymentMethodsResponse, Memnexus, MemoriesService, type Memory, type MemoryRelationship, type MemoryRelationshipsResponse, MonitoringService, type NamedMemoryHistoryResponse, type NarrativeMemory, type NarrativeThread, type NarrativeTimelineResponse, NarrativesService, type Pagination, type Pattern, PatternsService, type PaymentMethod, type PortalSessionResponse, type RelatedMemoryResult, type RequestParameter, type ResponseDefinition, type RetryOptions, type SdkConfig, type SearchRequest, type SearchResponse, type SearchResult, SerializationStyle, type ServiceCheck, type Subscription, SystemService, type TemporalMetadata, type Topic, type TopicReference, TopicsService, type UpdateArtifactRequest, type UpdateFactRequest, type UpdateMemoryRequest, type UpdateNamedMemoryRequest, type UpdateNarrativeRequest, type User, type UserUsage, UsersService, type ValidationOptions, addMemoryToNarrativeRequest, apiKey, artifact, batchGetMemoriesMeta, batchGetMemoriesRequest, batchGetMemoriesResponse, billingOverview, buildContextActiveWork, buildContextActivity, buildContextFact, buildContextGotcha, buildContextMeta, buildContextPattern, buildContextRequest, buildContextResponse, checkoutSessionResponse, community, conversation, createArtifactRequest, createCheckoutSessionRequest, createConversationRequest, createFactRequest, createMemoryRelationshipRequest, createMemoryRequest, createMemoryResponse, createMemoryResponseMeta, createNarrativeRequest, createPortalSessionRequest, Memnexus as default, digestMetadata, digestRequest, digestResponse, digestSource, digestTimeRange, entity, entityNode, error, fact, factSearchRequest, getMemoryResponse, getNarrativeResponse, graphRAGQueryRequest, graphRAGQueryResponse, healthCheck, invoice, listInvoicesResponse, listNarrativesResponse, listPaymentMethodsResponse, memory, memoryRelationship, memoryRelationshipsResponse, namedMemoryHistoryResponse, narrativeMemory, narrativeThread, narrativeTimelineResponse, pagination, pattern, paymentMethod, portalSessionResponse, relatedMemoryResult, searchRequest, searchResponse, searchResult, serviceCheck, subscription, temporalMetadata, topic, topicReference, updateArtifactRequest, updateFactRequest, updateMemoryRequest, updateNamedMemoryRequest, updateNarrativeRequest, user, userUsage };