macrocosmos 1.2.10 → 1.2.12

package/README.md

@@ -90,3 +90,25 @@ const cancelDataset = await client.cancelDataset({
   datasetId: 'dataset-id'
 });
 ```
+
+### SN13 Client
+
+The SN13 client provides an interface for the SN13 Validator API.
+
+```typescript
+import { Sn13Client } from 'macrocosmos';
+
+// Initialize the client
+const client = new Sn13Client({apiKey: 'your-api-key'});
+
+// Get the onDemandData response
+const response = await client.onDemandData({  
+  source: 'x',
+  usernames: ['nasa', 'spacex'],
+  keywords: ['photo', 'space', 'mars'],
+  startDate: '2024-04-01',
+  endDate: '2025-04-25',
+  limit: 3
+});
+
+```

package/dist/README.md

@@ -90,3 +90,25 @@ const cancelDataset = await client.cancelDataset({
   datasetId: 'dataset-id'
 });
 ```
+
+### SN13 Client
+
+The SN13 client provides an interface for the SN13 Validator API.
+
+```typescript
+import { Sn13Client } from 'macrocosmos';
+
+// Initialize the client
+const client = new Sn13Client({apiKey: 'your-api-key'});
+
+// Get the onDemandData response
+const response = await client.onDemandData({  
+  source: 'x',
+  usernames: ['nasa', 'spacex'],
+  keywords: ['photo', 'space', 'mars'],
+  startDate: '2024-04-01',
+  endDate: '2025-04-25',
+  limit: 3
+});
+
+```

package/dist/__tests__/setup.js

@@ -1,5 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const dotenv_1 = require("dotenv");
-// Load environment variables from .env file
 (0, dotenv_1.config)();

package/dist/__tests__/sn13/client.test.js

@@ -28,4 +28,30 @@ describe("Sn13Client", () => {
         // Log response for debugging
         console.log("Validation Response:", response);
     }, 30000); // Increase timeout to 30 seconds
+    it("should fetch on-demand data", async () => {
+        // Create Sn13Client
+        const client = new macrocosmos_1.Sn13Client({
+            apiKey: API_KEY,
+            appName: "sn13-client.test.ts",
+        });
+        // Create request
+        const request = {
+            source: "x",
+            usernames: ["nasa", "spacex"],
+            keywords: ["photo", "space", "mars"],
+            startDate: "2024-04-01",
+            endDate: "2025-04-25",
+            limit: 3,
+        };
+        // Fetch on-demand data
+        const response = await client.onDemandData(request);
+        // Verify response structure
+        expect(response).toBeDefined();
+        expect(typeof response.status).toBe("string");
+        expect(Array.isArray(response.data)).toBe(true);
+        expect(response.data.length).toBeLessThanOrEqual(request.limit);
+        expect(response.meta).toBeDefined();
+        // Log response for debugging
+        console.log("On-Demand Data Response:", response);
+    }, 30000); // Increase timeout to 30 seconds
 });

package/dist/generated/apex/v1/apex.d.ts

@@ -1,5 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { type CallOptions, ChannelCredentials, Client, type ClientOptions, type ClientReadableStream, type ClientUnaryCall, type handleServerStreamingCall, type handleUnaryCall, Metadata, type ServiceError, type UntypedServiceImplementation } from "@grpc/grpc-js";
+import { Empty } from "../../google/protobuf/empty";
 export declare const protobufPackage = "apex.v1";
 /**
  * A request to generate completions following Apex CompletionsRequest format.
@@ -332,7 +333,7 @@ export interface PromptTokensDetails {
     cachedTokens: number;
 }
 /**
- * A web retrival request from Apex
+ * A web retrieval request from Apex
  * Parsed from https://github.com/macrocosm-os/prompting/blob/main/validator_api/serializers.py
  */
 export interface WebRetrievalRequest {
@@ -369,6 +370,81 @@ export interface WebRetrievalResponse {
     /** results: the results of the web retrieval. */
     results: WebSearchResult[];
 }
+/** A response containing the deep researcher job submission details */
+export interface SubmitDeepResearcherJobResponse {
+    /** job_id: unique identifier for the submitted job */
+    jobId: string;
+    /** status: current status of the job */
+    status: string;
+    /** created_at: timestamp when the job was created */
+    createdAt: string;
+    /** updated_at: timestamp when the job was last updated */
+    updatedAt: string;
+}
+/** A response containing the deep researcher job status and results */
+export interface GetDeepResearcherJobResponse {
+    /** job_id: unique identifier for the job */
+    jobId: string;
+    /** status: current status of the job */
+    status: string;
+    /** created_at: timestamp when the job was created */
+    createdAt: string;
+    /** updated_at: timestamp when the job was last updated */
+    updatedAt: string;
+    /** result: array of result chunks */
+    result: DeepResearcherResultChunk[];
+    /** error: error message if the job failed */
+    error?: string | undefined;
+}
+/** A chunk of the deep researcher result */
+export interface DeepResearcherResultChunk {
+    /** seq_id: sequence identifier for the chunk */
+    seqId: number;
+    /** chunk: the content of the chunk */
+    chunk: string;
+}
+/** A request to get the status of a deep researcher job */
+export interface GetDeepResearcherJobRequest {
+    /** job_id: the ID of the job to retrieve */
+    jobId: string;
+}
+/** A GetChatSession message repeated in GetChatSessionsResponse */
+export interface ChatSession {
+    /** id: chat id */
+    id: string;
+    /** user_id: user id */
+    userId: string;
+    /** title: title of chat */
+    title: string;
+    /** chat_type: e.g. apex */
+    chatType: string;
+    /** created_at: when the chat was created */
+    createdAt?: Date | undefined;
+    /** updated_at: when the chat was updated */
+    updatedAt?: Date | undefined;
+}
+/** A GetChatSessionsResponse response */
+export interface GetChatSessionsResponse {
+    /** chat_sessions: the chat sessions */
+    chatSessions: ChatSession[];
+}
+/** Directly model the attributes as a map */
+export interface UpdateChatAttributeRequest {
+    /** chat_id: the unique id associated to a users chat message */
+    chatId: string;
+    /** attributes: the data attributes captured in the chat logging process */
+    attributes: {
+        [key: string]: string;
+    };
+}
+export interface UpdateChatAttributeRequest_AttributesEntry {
+    key: string;
+    value: string;
+}
+export interface UpdateChatAttributeResponse {
+    /** success: indicates if an attribute update was successful */
+    success: boolean;
+}
 export declare const ChatCompletionRequest: MessageFns<ChatCompletionRequest>;
 export declare const SamplingParameters: MessageFns<SamplingParameters>;
 export declare const ChatCompletionResponse: MessageFns<ChatCompletionResponse>;
@@ -395,6 +471,15 @@ export declare const PromptTokensDetails: MessageFns<PromptTokensDetails>;
 export declare const WebRetrievalRequest: MessageFns<WebRetrievalRequest>;
 export declare const WebSearchResult: MessageFns<WebSearchResult>;
 export declare const WebRetrievalResponse: MessageFns<WebRetrievalResponse>;
+export declare const SubmitDeepResearcherJobResponse: MessageFns<SubmitDeepResearcherJobResponse>;
+export declare const GetDeepResearcherJobResponse: MessageFns<GetDeepResearcherJobResponse>;
+export declare const DeepResearcherResultChunk: MessageFns<DeepResearcherResultChunk>;
+export declare const GetDeepResearcherJobRequest: MessageFns<GetDeepResearcherJobRequest>;
+export declare const ChatSession: MessageFns<ChatSession>;
+export declare const GetChatSessionsResponse: MessageFns<GetChatSessionsResponse>;
+export declare const UpdateChatAttributeRequest: MessageFns<UpdateChatAttributeRequest>;
+export declare const UpdateChatAttributeRequest_AttributesEntry: MessageFns<UpdateChatAttributeRequest_AttributesEntry>;
+export declare const UpdateChatAttributeResponse: MessageFns<UpdateChatAttributeResponse>;
 export type ApexServiceService = typeof ApexServiceService;
 export declare const ApexServiceService: {
     /** ChatCompletion generates a completion for a given request. */
@@ -427,6 +512,46 @@ export declare const ApexServiceService: {
         readonly responseSerialize: (value: WebRetrievalResponse) => Buffer<ArrayBuffer>;
         readonly responseDeserialize: (value: Buffer) => WebRetrievalResponse;
     };
+    /** SubmitDeepResearcherJob submits a new deep researcher job for processing. */
+    readonly submitDeepResearcherJob: {
+        readonly path: "/apex.v1.ApexService/SubmitDeepResearcherJob";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: ChatCompletionRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => ChatCompletionRequest;
+        readonly responseSerialize: (value: SubmitDeepResearcherJobResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => SubmitDeepResearcherJobResponse;
+    };
+    /** GetDeepResearcherJob retrieves the status and results of a deep researcher job. */
+    readonly getDeepResearcherJob: {
+        readonly path: "/apex.v1.ApexService/GetDeepResearcherJob";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: GetDeepResearcherJobRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => GetDeepResearcherJobRequest;
+        readonly responseSerialize: (value: GetDeepResearcherJobResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => GetDeepResearcherJobResponse;
+    };
+    /** GetChatSessions retrieves a user's chats */
+    readonly getChatSessions: {
+        readonly path: "/apex.v1.ApexService/GetChatSessions";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: Empty) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => Empty;
+        readonly responseSerialize: (value: GetChatSessionsResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => GetChatSessionsResponse;
+    };
+    /** UpdateChatAttribute updates attribute after asking LLM for one */
+    readonly updateChatAttribute: {
+        readonly path: "/apex.v1.ApexService/UpdateChatAttribute";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: UpdateChatAttributeRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => UpdateChatAttributeRequest;
+        readonly responseSerialize: (value: UpdateChatAttributeResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => UpdateChatAttributeResponse;
+    };
 };
 export interface ApexServiceServer extends UntypedServiceImplementation {
     /** ChatCompletion generates a completion for a given request. */
@@ -435,6 +560,14 @@ export interface ApexServiceServer extends UntypedServiceImplementation {
     chatCompletionStream: handleServerStreamingCall<ChatCompletionRequest, ChatCompletionChunkResponse>;
     /** WebRetrieval retrieves web search results for a given request. */
     webRetrieval: handleUnaryCall<WebRetrievalRequest, WebRetrievalResponse>;
+    /** SubmitDeepResearcherJob submits a new deep researcher job for processing. */
+    submitDeepResearcherJob: handleUnaryCall<ChatCompletionRequest, SubmitDeepResearcherJobResponse>;
+    /** GetDeepResearcherJob retrieves the status and results of a deep researcher job. */
+    getDeepResearcherJob: handleUnaryCall<GetDeepResearcherJobRequest, GetDeepResearcherJobResponse>;
+    /** GetChatSessions retrieves a user's chats */
+    getChatSessions: handleUnaryCall<Empty, GetChatSessionsResponse>;
+    /** UpdateChatAttribute updates attribute after asking LLM for one */
+    updateChatAttribute: handleUnaryCall<UpdateChatAttributeRequest, UpdateChatAttributeResponse>;
 }
 export interface ApexServiceClient extends Client {
     /** ChatCompletion generates a completion for a given request. */
@@ -448,6 +581,22 @@ export interface ApexServiceClient extends Client {
     webRetrieval(request: WebRetrievalRequest, callback: (error: ServiceError | null, response: WebRetrievalResponse) => void): ClientUnaryCall;
     webRetrieval(request: WebRetrievalRequest, metadata: Metadata, callback: (error: ServiceError | null, response: WebRetrievalResponse) => void): ClientUnaryCall;
     webRetrieval(request: WebRetrievalRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: WebRetrievalResponse) => void): ClientUnaryCall;
+    /** SubmitDeepResearcherJob submits a new deep researcher job for processing. */
+    submitDeepResearcherJob(request: ChatCompletionRequest, callback: (error: ServiceError | null, response: SubmitDeepResearcherJobResponse) => void): ClientUnaryCall;
+    submitDeepResearcherJob(request: ChatCompletionRequest, metadata: Metadata, callback: (error: ServiceError | null, response: SubmitDeepResearcherJobResponse) => void): ClientUnaryCall;
+    submitDeepResearcherJob(request: ChatCompletionRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: SubmitDeepResearcherJobResponse) => void): ClientUnaryCall;
+    /** GetDeepResearcherJob retrieves the status and results of a deep researcher job. */
+    getDeepResearcherJob(request: GetDeepResearcherJobRequest, callback: (error: ServiceError | null, response: GetDeepResearcherJobResponse) => void): ClientUnaryCall;
+    getDeepResearcherJob(request: GetDeepResearcherJobRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetDeepResearcherJobResponse) => void): ClientUnaryCall;
+    getDeepResearcherJob(request: GetDeepResearcherJobRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetDeepResearcherJobResponse) => void): ClientUnaryCall;
+    /** GetChatSessions retrieves a user's chats */
+    getChatSessions(request: Empty, callback: (error: ServiceError | null, response: GetChatSessionsResponse) => void): ClientUnaryCall;
+    getChatSessions(request: Empty, metadata: Metadata, callback: (error: ServiceError | null, response: GetChatSessionsResponse) => void): ClientUnaryCall;
+    getChatSessions(request: Empty, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetChatSessionsResponse) => void): ClientUnaryCall;
+    /** UpdateChatAttribute updates attribute after asking LLM for one */
+    updateChatAttribute(request: UpdateChatAttributeRequest, callback: (error: ServiceError | null, response: UpdateChatAttributeResponse) => void): ClientUnaryCall;
+    updateChatAttribute(request: UpdateChatAttributeRequest, metadata: Metadata, callback: (error: ServiceError | null, response: UpdateChatAttributeResponse) => void): ClientUnaryCall;
+    updateChatAttribute(request: UpdateChatAttributeRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: UpdateChatAttributeResponse) => void): ClientUnaryCall;
 }
 export declare const ApexServiceClient: {
     new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): ApexServiceClient;