@metagptx/web-sdk 0.0.1 → 0.0.3

package/README.md

@@ -83,19 +83,21 @@ client.auth.toLogin();
 
 Provides dynamic CRUD operations for any entity type. Access entities using property syntax: `client.entities.{entityName}.{operation}()`.
 
+**Note:** The `fields` parameter (array) will be automatically converted to a comma-separated string, and the `query` parameter (object) will be automatically converted to a JSON string before sending to the API.
+
 #### `entities[entityName].query(params?)`
 
 Query entities with filtering, sorting, and pagination.
 
 **HTTP Details:**
 - **Method:** `GET`
-- **Path:** `/api/entities/{entityName}`
+- **Path:** `/api/v1/entities/{entityName}`
 - **Parameters:**
-  - `query` (optional): Query conditions object
+  - `query` (optional): Query conditions object (will be converted to JSON string)
   - `sort` (optional): Sort field and order (e.g., `"-createdAt"`)
   - `limit` (optional): Maximum number of results
   - `skip` (optional): Number of results to skip
-  - `fields` (optional): Array of fields to return
+  - `fields` (optional): Array of fields to return (will be converted to comma-separated string)
 
 **Example:**
 ```typescript
@@ -106,6 +108,7 @@ const response = await client.entities.users.query({
   skip: 0,
   fields: ['id', 'name', 'email'],
 });
+// Actual API call: GET /api/v1/entities/users?query={"status":"active"}&sort=-createdAt&limit=10&skip=0&fields=id,name,email
 ```
 
 #### `entities[entityName].get(params)`
@@ -114,10 +117,10 @@ Get a single entity by ID.
 
 **HTTP Details:**
 - **Method:** `GET`
-- **Path:** `/api/entities/{entityName}/{id}`
+- **Path:** `/api/v1/entities/{entityName}/{id}`
 - **Parameters:**
   - `id` (required): Entity ID
-  - `fields` (optional): Array of fields to return
+  - `fields` (optional): Array of fields to return (will be converted to comma-separated string)
 
 **Example:**
 ```typescript
@@ -125,6 +128,7 @@ const response = await client.entities.users.get({
   id: '12345',
   fields: ['id', 'name', 'email'],
 });
+// Actual API call: GET /api/v1/entities/users/12345?fields=id,name,email
 ```
 
 #### `entities[entityName].create(params)`
@@ -133,7 +137,7 @@ Create a new entity.
 
 **HTTP Details:**
 - **Method:** `POST`
-- **Path:** `/api/entities/{entityName}`
+- **Path:** `/api/v1/entities/{entityName}`
 - **Body:**
   - `data` (required): Entity data object
 
@@ -154,7 +158,7 @@ Update an existing entity.
 
 **HTTP Details:**
 - **Method:** `PUT`
-- **Path:** `/api/entities/{entityName}/{id}`
+- **Path:** `/api/v1/entities/{entityName}/{id}`
 - **Body:**
   - `id` (required): Entity ID
   - `data` (required): Updated entity data
@@ -176,7 +180,7 @@ Delete a single entity by ID.
 
 **HTTP Details:**
 - **Method:** `DELETE`
-- **Path:** `/api/entities/{entityName}/{id}`
+- **Path:** `/api/v1/entities/{entityName}/{id}`
 - **Parameters:**
   - `id` (required): Entity ID
 
@@ -191,7 +195,7 @@ Create multiple entities in a single request.
 
 **HTTP Details:**
 - **Method:** `POST`
-- **Path:** `/api/entities/{entityName}/batch`
+- **Path:** `/api/v1/entities/{entityName}/batch`
 - **Body:**
   - `data` (required): Array of entity data objects
 
@@ -211,7 +215,7 @@ Update multiple entities in a single request.
 
 **HTTP Details:**
 - **Method:** `PUT`
-- **Path:** `/api/entities/{entityName}/batch`
+- **Path:** `/api/v1/entities/{entityName}/batch`
 - **Body:**
   - `data` (required): Array of entity data objects (must include `id` for each)
 
@@ -231,7 +235,7 @@ Delete multiple entities by their IDs.
 
 **HTTP Details:**
 - **Method:** `DELETE`
-- **Path:** `/api/entities/{entityName}/batch`
+- **Path:** `/api/v1/entities/{entityName}/batch`
 - **Body:**
   - `ids` (required): Array of entity IDs
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metagptx/web-sdk",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "packageManager": "pnpm@10.15.0+sha512.486ebc259d3e999a4e8691ce03b5cac4a71cbeca39372a9b762cb500cfdf0873e2cb16abe3d951b1ee2cf012503f027b98b6584e4df22524e0c7450d9ec7aa7b",
   "description": "TypeScript SDK for interacting with FuncSea API",
   "author": "MetaGPTX",

package/dist/index.d.ts

@@ -1,108 +0,0 @@
-import * as axios0 from "axios";
-import { AxiosRequestConfig } from "axios";
-
-//#region src/utils/request.d.ts
-/**
- * Request instance configuration options
- */
-interface RequestConfig extends AxiosRequestConfig {
-  baseURL?: string;
-  timeout?: number;
-  onUnauthorized?: () => void;
-}
-/**
- * Creates an axios request instance with default configuration
- * @param config - Optional configuration for the request instance
- * @returns Configured axios instance
- */
-//#endregion
-//#region src/client.d.ts
-interface ClientConfig extends RequestConfig {}
-declare const createClient: (config?: ClientConfig) => {
-  auth: {
-    me(): Promise<axios0.AxiosResponse<any, any, {}>>;
-    logout(): Promise<axios0.AxiosResponse<any, any, {}>>;
-    toLogin: () => void;
-  };
-  entities: Record<string, {
-    query<T = any>(params?: {
-      query?: Record<string, unknown>;
-      sort?: string;
-      limit?: number;
-      skip?: number;
-      fields?: string[];
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    get<T = any>(params: {
-      id: string;
-      fields?: string[];
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    create<T = any>(params: {
-      data: Record<string, unknown>;
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    update<T = any>(params: {
-      id: string;
-      data: Record<string, unknown>;
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    delete<T = any>(params: {
-      id: string;
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    deleteBatch<T = any>(params: {
-      ids: string[];
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    createBatch<T = any>(params: {
-      data: Record<string, unknown>[];
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-    updateBatch<T = any>(params: {
-      data: Record<string, unknown>[];
-    }): Promise<axios0.AxiosResponse<T, any, {}>>;
-  }>;
-  apiCall: {
-    invoke<T = any>(params: ApiCallParams): Promise<axios0.AxiosResponse<T, any, {}>>;
-  };
-  integrations: Record<string, Record<string, IntegrationFunction>>;
-};
-//#endregion
-//#region src/types/index.d.ts
-/**
- * Common reusable types for the funcsea-websdk
- */
-type AnyType = any;
-//#endregion
-//#region src/modules/apiCall.d.ts
-/**
- * API call parameters interface
- */
-interface ApiCallParams {
-  url: string;
-  method?: string;
-  data?: Record<string, AnyType>;
-  options?: AxiosRequestConfig;
-}
-/**
- * Creates an API call module for making custom HTTP requests
- * @param params - Configuration object
- * @param params.requestInstance - Axios instance for making HTTP requests
- * @returns Object containing invoke method for API calls
- */
-//#endregion
-//#region src/modules/integrations.d.ts
-/**
- * Integration function parameters interface
- */
-interface IntegrationParams {
-  payload?: Record<string, AnyType> | FormData;
-  option?: Record<string, AnyType>;
-}
-/**
- * Integration function type
- */
-type IntegrationFunction = (params?: IntegrationParams) => Promise<AnyType>;
-/**
- * Creates an integrations module using proxy for dynamic package and function access
- * @param params - Configuration object
- * @param params.requestInstance - Axios instance for making HTTP requests
- * @returns Proxy object that dynamically creates integration calls
- */
-
-//#endregion
-export { type AnyType, type ApiCallParams, type ClientConfig, type IntegrationFunction, type IntegrationParams, type RequestConfig, createClient };

package/dist/index.js

@@ -1 +0,0 @@
-import e from"axios";import t from"qs";const n=(n={})=>{let{onUnauthorized:r,...i}=n,a={timeout:6e4,paramsSerializer:e=>t.stringify(e,{arrayFormat:`brackets`}),...i,headers:{"Content-Type":`application/json`,...i.headers}},o=e.create(a);return o.interceptors.request.use(e=>e,e=>Promise.reject(e)),o.interceptors.response.use(e=>e,e=>(e.response?.status===401&&r&&r(),Promise.reject(e))),o},r=e=>typeof e==`string`?e.startsWith(`_`)||e.startsWith(`$`)||e===`constructor`||e===`toString`||e===`valueOf`||e===`inspect`||e===`toJSON`:!0,i=()=>{let e=window.location.href,t=new URLSearchParams({from_url:e});window.location.href=`/api/v1/auth/login?${t.toString()}`},a=e=>{let{requestInstance:t}=e;return{async me(){return t.get(`/api/v1/auth/me`)},async logout(){return t.post(`/api/v1/auth/logout`)},toLogin:i}},o=e=>{let{requestInstance:t,entityName:n}=e,r=`/api/entities/${n}`;return{async query(e){return t.get(r,{params:e})},async get(e){let{id:n,...i}=e;return t.get(`${r}/${n}`,{params:i})},async create(e){return t.post(r,e.data)},async update(e){return t.put(`${r}/${e.id}`,e.data)},async delete(e){return t.delete(`${r}/${e.id}`)},async deleteBatch(e){return t.delete(`${r}/batch`,{data:{ids:e.ids}})},async createBatch(e){return t.post(`${r}/batch`,e.data)},async updateBatch(e){return t.put(`${r}/batch`,e.data)}}},s=e=>{let{requestInstance:t}=e,n=new Map;return new Proxy({},{get(e,i){if(!r(i))return n.has(i)||n.set(i,o({requestInstance:t,entityName:i})),n.get(i)}})},c=e=>{let{requestInstance:t}=e;return{async invoke(e){let{url:n,method:r=`GET`,data:i,options:a={}}=e,o={method:r.toUpperCase(),url:n,...a};return i&&[`POST`,`PUT`,`PATCH`].includes(o.method)?o.data=i:i&&[`GET`,`DELETE`].includes(o.method)&&(o.params=i),t.request(o)}}},l=e=>{let{requestInstance:t}=e;return new Proxy({},{get(e,n){if(!r(n))return new Proxy({},{get(e,i){if(!r(i))return(e={})=>{let r=`/api/integrations/core/${i}`;n!==`core`&&(r=`/api/integrations/providers/${n}/${i}`);let{payload:a={},option:o={}}=e,s=a instanceof FormData?{...o,headers:{...o.headers,"Content-Type":void 0}}:o;return t.post(r,a,s)}}})}})},u=(e={})=>{let t=n({baseURL:`/`,...e,onUnauthorized:i}),r=a({requestInstance:t}),o=s({requestInstance:t}),u=c({requestInstance:t}),d=l({requestInstance:t});return{auth:r,entities:o,apiCall:u,integrations:d}};export{u as createClient};