@super_studio/ecforce-ai-agent-server 1.1.1 → 1.2.0-canary.0

package/dist/sdk/index.cjs

@@ -2,6 +2,21 @@ const require_constants = require('../lib/constants.cjs');
 const require_index = require('./__generated__/index.cjs');
 
 //#region src/sdk/index.ts
+/**
+* ecforce AIエージェントのAPIを呼び出すサーバークライアントを生成します。
+* `params` を省略した場合、`apiKey` は `AI_AGENT_API_KEY`、
+* `baseUrl` は `AI_AGENT_API_ENDPOINT` または既定の本番APIエンドポイントを使います。
+*
+* @example
+* 環境変数の既定値を使う場合
+* ```ts
+* import { createClient } from "@super_studio/ecforce-ai-agent-server";
+*
+* const client = createClient();
+*
+* const agents = await client.agents.agentsList();
+* ```
+*/
 function createClient(params) {
 	var _ref, _params$baseUrl, _params$apiKey;
 	const baseUrl = `${(_ref = (_params$baseUrl = params === null || params === void 0 ? void 0 : params.baseUrl) !== null && _params$baseUrl !== void 0 ? _params$baseUrl : process.env.AI_AGENT_API_ENDPOINT) !== null && _ref !== void 0 ? _ref : require_constants.API_ENDPOINT}/api`;

package/dist/sdk/index.d.cts

@@ -16,6 +16,21 @@ type CreateClientParams = {
   baseUrl?: string;
 };
 type AgentApi = Api<unknown>;
+/**
+ * ecforce AIエージェントのAPIを呼び出すサーバークライアントを生成します。
+ * `params` を省略した場合、`apiKey` は `AI_AGENT_API_KEY`、
+ * `baseUrl` は `AI_AGENT_API_ENDPOINT` または既定の本番APIエンドポイントを使います。
+ *
+ * @example
+ * 環境変数の既定値を使う場合
+ * ```ts
+ * import { createClient } from "@super_studio/ecforce-ai-agent-server";
+ *
+ * const client = createClient();
+ *
+ * const agents = await client.agents.agentsList();
+ * ```
+ */
 declare function createClient(params?: CreateClientParams): AgentApi;
 //#endregion
 export { CreateClientParams, createClient };

package/dist/sdk/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/sdk/index.ts"],"sourcesContent":[],"mappings":";;;KAKY,kBAAA;EAAA;AAaV;AAIF;;;;;;;;;;;KAFK,QAAA,GAAW;iBAEA,YAAA,UAAsB,qBAAqB"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/sdk/index.ts"],"sourcesContent":[],"mappings":";;;KAKY,kBAAA;EAAA;AAaV;AAmBF;;;;;;;;;;;KAjBK,QAAA,GAAW;;;;;;;;;;;;;;;;iBAiBA,YAAA,UAAsB,qBAAqB"}

package/dist/sdk/index.d.mts

@@ -16,6 +16,21 @@ type CreateClientParams = {
   baseUrl?: string;
 };
 type AgentApi = Api<unknown>;
+/**
+ * ecforce AIエージェントのAPIを呼び出すサーバークライアントを生成します。
+ * `params` を省略した場合、`apiKey` は `AI_AGENT_API_KEY`、
+ * `baseUrl` は `AI_AGENT_API_ENDPOINT` または既定の本番APIエンドポイントを使います。
+ *
+ * @example
+ * 環境変数の既定値を使う場合
+ * ```ts
+ * import { createClient } from "@super_studio/ecforce-ai-agent-server";
+ *
+ * const client = createClient();
+ *
+ * const agents = await client.agents.agentsList();
+ * ```
+ */
 declare function createClient(params?: CreateClientParams): AgentApi;
 //#endregion
 export { CreateClientParams, createClient };

package/dist/sdk/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/sdk/index.ts"],"sourcesContent":[],"mappings":";;;KAKY,kBAAA;EAAA;AAaV;AAIF;;;;;;;;;;;KAFK,QAAA,GAAW;iBAEA,YAAA,UAAsB,qBAAqB"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/sdk/index.ts"],"sourcesContent":[],"mappings":";;;KAKY,kBAAA;EAAA;AAaV;AAmBF;;;;;;;;;;;KAjBK,QAAA,GAAW;;;;;;;;;;;;;;;;iBAiBA,YAAA,UAAsB,qBAAqB"}

package/dist/sdk/index.mjs

@@ -2,6 +2,21 @@ import { API_ENDPOINT } from "../lib/constants.mjs";
 import { Api, ContentType, HttpClient } from "./__generated__/index.mjs";
 
 //#region src/sdk/index.ts
+/**
+* ecforce AIエージェントのAPIを呼び出すサーバークライアントを生成します。
+* `params` を省略した場合、`apiKey` は `AI_AGENT_API_KEY`、
+* `baseUrl` は `AI_AGENT_API_ENDPOINT` または既定の本番APIエンドポイントを使います。
+*
+* @example
+* 環境変数の既定値を使う場合
+* ```ts
+* import { createClient } from "@super_studio/ecforce-ai-agent-server";
+*
+* const client = createClient();
+*
+* const agents = await client.agents.agentsList();
+* ```
+*/
 function createClient(params) {
 	var _ref, _params$baseUrl, _params$apiKey;
 	const baseUrl = `${(_ref = (_params$baseUrl = params === null || params === void 0 ? void 0 : params.baseUrl) !== null && _params$baseUrl !== void 0 ? _params$baseUrl : process.env.AI_AGENT_API_ENDPOINT) !== null && _ref !== void 0 ? _ref : API_ENDPOINT}/api`;

package/dist/sdk/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/sdk/index.ts"],"sourcesContent":["import { API_ENDPOINT } from \"@/lib/constants\";\nimport { Api } from \"./__generated__\";\n\nexport * from \"./__generated__\";\n\nexport type CreateClientParams = {\n  /**\n   * 管理画面から作られたAPIキー。\n   * `AI_AGENT_API_KEY`の環境変数からも設定可能。\n   */\n  apiKey?: string;\n  /**\n   * エージェントのAPIエンドポイント。\n   * `AI_AGENT_API_ENDPOINT`の環境変数からも設定可能。\n   * デフォルトは本番のAPIエンドポイント。\n   * 基本的には変更不要。\n   */\n  baseUrl?: string;\n};\n\ntype AgentApi = Api<unknown>;\n\nexport function createClient(params?: CreateClientParams): AgentApi {\n  const baseUrl = `${params?.baseUrl ?? process.env.AI_AGENT_API_ENDPOINT ?? API_ENDPOINT}/api`;\n  const apiKey = params?.apiKey ?? process.env.AI_AGENT_API_KEY;\n\n  if (!apiKey) {\n    throw new Error(\"APIキーが設定されていません。\");\n  }\n  if (!baseUrl) {\n    throw new Error(\"APIエンドポイントが設定されていません。\");\n  }\n\n  return new Api({\n    baseUrl,\n    baseApiParams: {\n      secure: true,\n    },\n    async securityWorker() {\n      return {\n        headers: {\n          Authorization: `Bearer ${apiKey}`,\n        },\n      };\n    },\n  });\n}\n"],"mappings":";;;;AAsBA,SAAgB,aAAa,QAAuC;;CAClE,MAAM,UAAU,8EAAG,OAAQ,oEAAW,QAAQ,IAAI,4DAAyB,aAAa;CACxF,MAAM,2EAAS,OAAQ,iEAAU,QAAQ,IAAI;AAE7C,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,mBAAmB;AAErC,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,wBAAwB;AAG1C,QAAO,IAAI,IAAI;EACb;EACA,eAAe,EACb,QAAQ,MACT;EACD,MAAM,iBAAiB;AACrB,UAAO,EACL,SAAS,EACP,eAAe,UAAU,UAC1B,EACF;;EAEJ,CAAC"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/sdk/index.ts"],"sourcesContent":["import { API_ENDPOINT } from \"@/lib/constants\";\nimport { Api } from \"./__generated__\";\n\nexport * from \"./__generated__\";\n\nexport type CreateClientParams = {\n  /**\n   * 管理画面から作られたAPIキー。\n   * `AI_AGENT_API_KEY`の環境変数からも設定可能。\n   */\n  apiKey?: string;\n  /**\n   * エージェントのAPIエンドポイント。\n   * `AI_AGENT_API_ENDPOINT`の環境変数からも設定可能。\n   * デフォルトは本番のAPIエンドポイント。\n   * 基本的には変更不要。\n   */\n  baseUrl?: string;\n};\n\ntype AgentApi = Api<unknown>;\n\n/**\n * ecforce AIエージェントのAPIを呼び出すサーバークライアントを生成します。\n * `params` を省略した場合、`apiKey` は `AI_AGENT_API_KEY`、\n * `baseUrl` は `AI_AGENT_API_ENDPOINT` または既定の本番APIエンドポイントを使います。\n *\n * @example\n * 環境変数の既定値を使う場合\n * ```ts\n * import { createClient } from \"@super_studio/ecforce-ai-agent-server\";\n *\n * const client = createClient();\n *\n * const agents = await client.agents.agentsList();\n * ```\n */\nexport function createClient(params?: CreateClientParams): AgentApi {\n  const baseUrl = `${params?.baseUrl ?? process.env.AI_AGENT_API_ENDPOINT ?? API_ENDPOINT}/api`;\n  const apiKey = params?.apiKey ?? process.env.AI_AGENT_API_KEY;\n\n  if (!apiKey) {\n    throw new Error(\"APIキーが設定されていません。\");\n  }\n  if (!baseUrl) {\n    throw new Error(\"APIエンドポイントが設定されていません。\");\n  }\n\n  return new Api({\n    baseUrl,\n    baseApiParams: {\n      secure: true,\n    },\n    async securityWorker() {\n      return {\n        headers: {\n          Authorization: `Bearer ${apiKey}`,\n        },\n      };\n    },\n  });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAqCA,SAAgB,aAAa,QAAuC;;CAClE,MAAM,UAAU,8EAAG,OAAQ,oEAAW,QAAQ,IAAI,4DAAyB,aAAa;CACxF,MAAM,2EAAS,OAAQ,iEAAU,QAAQ,IAAI;AAE7C,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,mBAAmB;AAErC,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,wBAAwB;AAG1C,QAAO,IAAI,IAAI;EACb;EACA,eAAe,EACb,QAAQ,MACT;EACD,MAAM,iBAAiB;AACrB,UAAO,EACL,SAAS,EACP,eAAe,UAAU,UAC1B,EACF;;EAEJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@super_studio/ecforce-ai-agent-server",
-  "version": "1.1.1",
+  "version": "1.2.0-canary.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",

package/src/sdk/index.ts

@@ -20,6 +20,21 @@ export type CreateClientParams = {
 
 type AgentApi = Api<unknown>;
 
+/**
+ * ecforce AIエージェントのAPIを呼び出すサーバークライアントを生成します。
+ * `params` を省略した場合、`apiKey` は `AI_AGENT_API_KEY`、
+ * `baseUrl` は `AI_AGENT_API_ENDPOINT` または既定の本番APIエンドポイントを使います。
+ *
+ * @example
+ * 環境変数の既定値を使う場合
+ * ```ts
+ * import { createClient } from "@super_studio/ecforce-ai-agent-server";
+ *
+ * const client = createClient();
+ *
+ * const agents = await client.agents.agentsList();
+ * ```
+ */
 export function createClient(params?: CreateClientParams): AgentApi {
   const baseUrl = `${params?.baseUrl ?? process.env.AI_AGENT_API_ENDPOINT ?? API_ENDPOINT}/api`;
   const apiKey = params?.apiKey ?? process.env.AI_AGENT_API_KEY;