@opensecret/react 1.5.4 → 3.0.0-alpha.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2024 OpenSecret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.d.ts

@@ -31,6 +31,35 @@ declare function acceptInvite(code: string): Promise<{
  */
 declare function addConversationItems(conversationId: string, items: Partial<ConversationItem>[]): Promise<Conversation>;
 
+export declare type AgentCreatedBy = "user" | "agent";
+
+export declare type AgentDeletedObjectResponse = {
+    id: string;
+    object: string;
+    deleted: boolean;
+};
+
+export declare type AgentDoneEvent = {
+    total_steps: number;
+    total_messages: number;
+};
+
+export declare type AgentErrorEvent = {
+    error: string;
+};
+
+export declare type AgentItemsListParams = {
+    limit?: number;
+    after?: string;
+    order?: string;
+    include?: string[];
+};
+
+export declare type AgentMessageEvent = {
+    messages: string[];
+    step: number;
+};
+
 declare namespace api {
     export {
         setApiUrl,
@@ -99,6 +128,16 @@ declare namespace api {
         updateInstruction,
         deleteInstruction,
         setDefaultInstruction,
+        getMainAgent,
+        deleteMainAgent,
+        listMainAgentItems,
+        getMainAgentItem,
+        listSubagents,
+        getSubagent,
+        createSubagent,
+        deleteSubagent,
+        listSubagentItems,
+        getSubagentItem,
         LoginResponse,
         UserResponse,
         KVListItem,
@@ -150,7 +189,18 @@ declare namespace api {
         InstructionUpdateRequest,
         InstructionListParams,
         InstructionListResponse,
-        InstructionDeleteResponse
+        InstructionDeleteResponse,
+        CreateSubagentRequest,
+        AgentCreatedBy,
+        MainAgentResponse,
+        SubagentResponse,
+        AgentItemsListParams,
+        ListSubagentsParams,
+        SubagentListResponse,
+        AgentDeletedObjectResponse,
+        AgentMessageEvent,
+        AgentDoneEvent,
+        AgentErrorEvent
     }
 }
 
@@ -442,11 +492,11 @@ export declare type Conversation = {
     id: string;
     object: "conversation";
     created_at: number;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 };
 
 export declare type ConversationCreateRequest = {
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 };
 
 export declare type ConversationDeleteResponse = {
@@ -491,7 +541,7 @@ export declare type ConversationsListResponse = {
 };
 
 export declare type ConversationUpdateRequest = {
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 };
 
 declare function convertGuestToEmailAccount(email: string, password: string, name?: string | null): Promise<void>;
@@ -541,7 +591,7 @@ export declare function createApiKey(name: string): Promise<ApiKeyCreateResponse
  *
  * @deprecated Use openai.conversations.create() instead
  */
-declare function createConversation(metadata?: Record<string, any>): Promise<Conversation>;
+declare function createConversation(metadata?: Record<string, unknown>): Promise<Conversation>;
 
 export declare function createCustomFetch(options?: CustomFetchOptions): (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
 
@@ -605,7 +655,14 @@ declare function createProjectSecret(orgId: string, projectId: string, keyName:
  * });
  * ```
  */
-declare function createResponse(request: ResponsesCreateRequest): Promise<any>;
+declare function createResponse(request: ResponsesCreateRequest): Promise<ResponsesRetrieveResponse>;
+
+export declare function createSubagent(request: CreateSubagentRequest): Promise<SubagentResponse>;
+
+export declare type CreateSubagentRequest = {
+    display_name?: string;
+    purpose: string;
+};
 
 export declare interface CustomFetchOptions {
     apiKey?: string;
@@ -746,6 +803,8 @@ declare function deleteConversations(): Promise<ConversationsDeleteResponse>;
  */
 declare function deleteInstruction(instructionId: string): Promise<InstructionDeleteResponse>;
 
+export declare function deleteMainAgent(): Promise<AgentDeletedObjectResponse>;
+
 declare function deleteOrganization(orgId: string): Promise<void>;
 
 declare function deleteOrganizationInvite(orgId: string, inviteCode: string): Promise<{
@@ -779,6 +838,8 @@ declare function deleteProjectSecret(orgId: string, projectId: string, keyName:
  */
 declare function deleteResponse(responseId: string): Promise<ResponsesDeleteResponse>;
 
+export declare function deleteSubagent(id: string): Promise<AgentDeletedObjectResponse>;
+
 declare type DeveloperResponse = PlatformUser & {
     organizations: PlatformOrg[];
 };
@@ -1098,6 +1159,10 @@ declare function getEmailSettings(orgId: string, projectId: string): Promise<Ema
  */
 declare function getInstruction(instructionId: string): Promise<Instruction>;
 
+export declare function getMainAgent(): Promise<MainAgentResponse>;
+
+export declare function getMainAgentItem(itemId: string): Promise<ConversationItem>;
+
 declare function getOAuthSettings(orgId: string, projectId: string): Promise<OAuthSettings>;
 
 declare function getOrganizationInvite(orgId: string, inviteCode: string): Promise<OrganizationInvite>;
@@ -1106,6 +1171,10 @@ declare function getPlatformApiUrl(): string;
 
 declare function getProject(orgId: string, projectId: string): Promise<Project>;
 
+export declare function getSubagent(id: string): Promise<SubagentResponse>;
+
+export declare function getSubagentItem(id: string, itemId: string): Promise<ConversationItem>;
+
 export declare type GithubAuthResponse = {
     auth_url: string;
     csrf_token: string;
@@ -1366,6 +1435,8 @@ declare function listConversations(params?: {
  */
 declare function listInstructions(params?: InstructionListParams): Promise<InstructionListResponse>;
 
+export declare function listMainAgentItems(params?: AgentItemsListParams): Promise<ConversationItemsResponse>;
+
 declare function listOrganizationInvites(orgId: string): Promise<OrganizationInvite[]>;
 
 declare function listOrganizationMembers(orgId: string): Promise<OrganizationMember[]>;
@@ -1376,6 +1447,17 @@ declare function listProjects(orgId: string): Promise<Project[]>;
 
 declare function listProjectSecrets(orgId: string, projectId: string): Promise<ProjectSecret[]>;
 
+export declare function listSubagentItems(id: string, params?: AgentItemsListParams): Promise<ConversationItemsResponse>;
+
+export declare function listSubagents(params?: ListSubagentsParams): Promise<SubagentListResponse>;
+
+export declare type ListSubagentsParams = {
+    limit?: number;
+    after?: string;
+    order?: string;
+    created_by?: AgentCreatedBy;
+};
+
 export declare type LoginResponse = {
     id: string;
     email?: string;
@@ -1383,6 +1465,16 @@ export declare type LoginResponse = {
     refresh_token: string;
 };
 
+export declare type MainAgentResponse = {
+    id: string;
+    object: "agent.main";
+    kind: "main";
+    conversation_id: string;
+    display_name: string;
+    created_at: number;
+    updated_at: number;
+};
+
 declare type MeResponse = {
     user: PlatformUser;
     organizations: PlatformOrg[];
@@ -2866,7 +2958,7 @@ export declare type ResponsesCreateRequest = {
     };
     previous_response_id?: string;
     stream?: boolean;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 };
 
 export declare type ResponsesDeleteResponse = {
@@ -2907,7 +2999,7 @@ export declare type ResponsesRetrieveResponse = {
         };
         total_tokens: number;
     };
-    output?: string | any[];
+    output?: string | unknown[];
 };
 
 declare function setApiUrl(url: string): void;
@@ -2991,6 +3083,26 @@ declare type SignMessageResponse = {
     message_hash: string;
 };
 
+export declare type SubagentListResponse = {
+    object: "list";
+    data: SubagentResponse[];
+    first_id?: string;
+    last_id?: string;
+    has_more: boolean;
+};
+
+export declare type SubagentResponse = {
+    id: string;
+    object: "agent.subagent";
+    kind: "subagent";
+    conversation_id: string;
+    display_name: string;
+    purpose: string;
+    created_by: AgentCreatedBy;
+    created_at: number;
+    updated_at: number;
+};
+
 declare type ThirdPartyTokenRequest = {
     audience?: string;
 };
@@ -3061,7 +3173,7 @@ declare function transcribeAudio(file: File | Blob, model?: string, language?: s
  * });
  * ```
  */
-declare function updateConversation(conversationId: string, metadata: Record<string, any>): Promise<Conversation>;
+declare function updateConversation(conversationId: string, metadata: Record<string, unknown>): Promise<Conversation>;
 
 declare function updateEmailSettings(orgId: string, projectId: string, settings: EmailSettings): Promise<EmailSettings>;