@blocksdiy/blocks-client-sdk 1.6.2 → 1.8.0

package/dist/ReactClientSdk.jsx

@@ -252,17 +252,10 @@ export const useClient = () => {
  * @returns {string} returns.status - Current status of the query: 'idle', 'loading', 'success', 'error', or 'pending'
  * @example
  * ```tsx
- * // Define a Item entity configuration
- * const itemConfig = {
- *   tableBlockId: 'items-table',
- *   instanceType: {} as {
- *     name: string;
- *     price: number;
- *   }
- * };
+ * import { ItemEntity } from '@/product-types';
  *
  * function ItemsList() {
- *   const { data: items, isLoading } = useEntityGetAll(itemConfig);
+ *   const { data: items, isLoading } = useEntityGetAll(ItemEntity);
  *
  *   if (isLoading) return <div>Loading...</div>;
  *   return (
@@ -319,14 +312,7 @@ export const useEntityGetAll = (entityConfig, filters, queryOptions = {}) => {
  * @returns {string} returns.status - Current status of the query: 'idle', 'loading', 'success', 'error', or 'pending'
  * @example
  * ```tsx
- * // Define the entity configuration
- * const userConfig = {
- *   tableBlockId: 'users-table',
- *   instanceType: {} as {
- *     name: string;
- *     email: string;
- *   }
- * };
+ * import { UserEntity } from '@/product-types';
  *
  * function UserProfile({ userEmail }) {
  *   const { data: user, isLoading } = useEntityGetOne(UserEntity, { email: userEmail });
@@ -377,17 +363,10 @@ export const useEntityGetOne = (entityConfig, filters, queryOptions = {}) => {
  * @returns {Object} Mutation object with create function, loading state, and error
  * @example
  * ```tsx
- * // Define the entity configuration
- * const userConfig = {
- *   tableBlockId: 'users-table',
- *   instanceType: {} as {
- *     name: string;
- *     email: string;
- *   }
- * };
+ * import { UserEntity } from '@/product-types';
  *
  * function CreateUserForm() {
- *   const { createFunction, isLoading } = useEntityCreate(userConfig);
+ *   const { createFunction, isLoading } = useEntityCreate(UserEntity);
  *   const [name, setName] = useState('');
  *   const [email, setEmail] = useState('');
  *
@@ -445,18 +424,10 @@ export const useEntityCreate = (entityConfig) => {
  * @returns {Object} Mutation object with createMany function, loading state, and error
  * @example
  * ```tsx
- * // Define the entity configuration
- * const taskConfig = {
- *   tableBlockId: 'tasks-table',
- *   instanceType: {} as {
- *     title: string;
- *     status: 'todo' | 'in_progress' | 'done';
- *     assigneeId: string;
- *   }
- * };
+ * import { TaskEntity } from '@/product-types';
  *
  * function ImportTasksButton() {
- *   const { createManyFunction, isLoading } = useEntityCreateMany(taskConfig);
+ *   const { createManyFunction, isLoading } = useEntityCreateMany(TaskEntity);
  *
  *   const handleImport = async () => {
  *     const tasksToCreate = [
@@ -507,17 +478,10 @@ export const useEntityCreateMany = (entityConfig) => {
  * @returns {Object} Mutation object with update function, loading state, and error
  * @example
  * ```tsx
- * // Define the entity configuration
- * const userConfig = {
- *   tableBlockId: 'users-table',
- *   instanceType: {} as {
- *     name: string;
- *     email: string;
- *   }
- * };
+ * import { UserEntity } from '@/product-types';
  *
  * function EditUserForm({ user }) {
- *   const { updateFunction, isLoading } = useEntityUpdate(userConfig);
+ *   const { updateFunction, isLoading } = useEntityUpdate(UserEntity);
  *   const [name, setName] = useState(user.name);
  *
  *   const handleSubmit = async (e) => {
@@ -568,17 +532,10 @@ export const useEntityUpdate = (entityConfig) => {
  * @returns {Object} Mutation object with delete function, loading state, and error
  * @example
  * ```tsx
- * // Define the entity configuration
- * const userConfig = {
- *   tableBlockId: 'users-table',
- *   instanceType: {} as {
- *     name: string;
- *     email: string;
- *   }
- * };
+ * import { UserEntity } from '@/product-types';
  *
  * function DeleteUserButton({ userId }) {
- *   const { deleteFunction, isLoading } = useEntityDelete(userConfig);
+ *   const { deleteFunction, isLoading } = useEntityDelete(UserEntity);
  *
  *   const handleDelete = async () => {
  *     if (confirm('Are you sure?')) {
@@ -625,17 +582,10 @@ export const useEntityDelete = (entityConfig) => {
  * @returns {Object} Mutation object with delete many function, loading state, and error
  * @example
  * ```tsx
- * // Define the entity configuration
- * const userConfig = {
- *   tableBlockId: 'users-table',
- *   instanceType: {} as {
- *     name: string;
- *     email: string;
- *   }
- * };
+ * import { UserEntity } from '@/product-types';
  *
  * function DeleteSelectedUsersButton({ selectedUserIds }) {
- *   const { deleteManyFunction, isLoading } = useEntityDeleteMany(userConfig);
+ *   const { deleteManyFunction, isLoading } = useEntityDeleteMany(UserEntity);
  *
  *   const handleDeleteSelected = async () => {
  *     if (confirm(`Delete ${selectedUserIds.length} users?`)) {
@@ -706,24 +656,10 @@ export const useEntityDeleteMany = (entityConfig) => {
  * @returns {Function} returns.clear - Function to clear result and streamResult values
  * @example
  * ```tsx
- * // Example 1: Process payment action
- * const processPaymentConfig = {
- *   actionBlockId: 'process-payment',
- *   inputInstanceType: {} as {
- *     amount: number;
- *     paymentMethod: string;
- *     currency: string;
- *   },
- *   outputInstanceType: {} as {
- *     success: boolean;
- *     transactionId: string;
- *     receiptUrl?: string;
- *     error?: string;
- *   }
- * };
+ * import { ExportDataAction, ProcessPaymentAction } from '@/product-types';
  *
  * function PaymentForm() {
- *   const { executeFunction, result, isLoading, error } = useExecuteAction(processPaymentConfig);
+ *   const { executeFunction, result, isLoading, error } = useExecuteAction(ProcessPaymentAction);
  *   const [amount, setAmount] = useState('');
  *   const [paymentMethod, setPaymentMethod] = useState('credit_card');
  *
@@ -761,22 +697,8 @@ export const useEntityDeleteMany = (entityConfig) => {
  *   );
  * }
  *
- * // Example 2: Data export action (with streaming)
- * const exportDataConfig = {
- *   actionBlockId: 'export-data',
- *   inputInstanceType: {} as {
- *     format: 'csv' | 'json';
- *     filters: Record<string, any>;
- *   },
- *   outputInstanceType: {} as {
- *     progress: number;
- *     downloadUrl?: string;
- *     status: string;
- *   }
- * };
- *
  * function DataExportTool() {
- *   const { executeFunction, result, isLoading, isDone } = useExecuteAction(exportDataConfig);
+ *   const { executeFunction, result, isLoading, isDone } = useExecuteAction(ExportDataAction);
  *   const [format, setFormat] = useState<'csv' | 'json'>('csv');
  *
  *   const handleExport = async () => {
@@ -870,13 +792,10 @@ export const useExecuteAction = (actionConfig) => {
  * @returns {AgentChat<ACC>} An AgentChat instance for the given configuration
  * @example
  * ```tsx
- * // Define the agent chat configuration
- * const agentChatConfig = {
- *   agentChatId: 'agent-chat-id'
- * };
+ * import { CustomerSupportChatAgent } from '@/product-types';
  *
  * function AgentChatComponent() {
- *   const agentChat = useAgentChat(agentChatConfig);
+ *   const agentChat = useAgentChat(CustomerSupportChatAgent);
  *   return <AgentChat agentChat={agentChat} />;
  * }
  * ```
@@ -885,6 +804,33 @@ export const useAgentChat = (agentChatConfig) => {
     const client = useClient();
     return client.agentChat(agentChatConfig);
 };
+/**
+ * Hook to get an Agent instance from a generated agent configuration.
+ *
+ * Import generated agent configs from `@/product-types`, then pass one to
+ * `useAgent()` to read typed agent metadata such as name, title, avatarUrl,
+ * photoUrl, and harness.
+ *
+ * @template AC - Agent configuration type
+ * @param {AC} agentConfig - Generated agent configuration from product-types
+ * @returns {Agent<AC>} An Agent instance for the given configuration
+ * @example
+ * ```tsx
+ * import { useAgent } from '@blocksdiy/blocks-client-sdk/reactSdk';
+ * import { CustomerSupportAgent } from '@/product-types';
+ *
+ * function AgentHeader() {
+ *   const agent = useAgent(CustomerSupportAgent);
+ *   const { name, title, avatarUrl, photoUrl } = agent.getAgentProps();
+ *
+ *   return <img src={avatarUrl ?? photoUrl} alt={name} />;
+ * }
+ * ```
+ */
+export const useAgent = (agentConfig) => {
+    const client = useClient();
+    return client.agent(agentConfig);
+};
 /**
  * Hook to handle file uploads
  *

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./Action.js";
+export * from "./Agent.js";
 export * from "./AgentChat.js";
 export * from "./ClientSdk.js";
 export * from "./Entity.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from "./Action.js";
+export * from "./Agent.js";
 export * from "./AgentChat.js";
 export * from "./ClientSdk.js";
 export * from "./Entity.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocksdiy/blocks-client-sdk",
-  "version": "1.6.2",
+  "version": "1.8.0",
   "type": "module",
   "description": "Blocks client sdk",
   "keywords": [],
@@ -48,7 +48,7 @@
   "dependencies": {
     "@tanstack/react-query": "^5.90.21",
     "@blocksdiy/blocks-client-api": "1.5.0",
-    "@blocksdiy/react-common": "1.23.0"
+    "@blocksdiy/react-common": "1.5.2"
   },
   "devDependencies": {
     "tsc-alias": "^1.8.10",