@plaidev/karte-action-sdk 1.1.222 → 1.1.223

package/dist/hydrate/index.es.d.ts

@@ -192,25 +192,19 @@ type ActionTableQueryParams = {
 /**
  * アクションテーブルの設定情報
  *
- * @public
+ * @param api_key - API Key
+ * @param table - テーブル名
+ * @param endpoint - エンドポイント / 指定がない場合はデフォルトのエンドポイントを使用します。検証用途以外での通常利用では指定なしで大丈夫です。
  */
 type CollectionConfig = {
-    /**
-     * APIキー
-     */
     api_key: string;
-    /**
-     * テーブル名
-     */
     table: string;
-    /**
-     * エンドポイント
-     */ endpoint?: string;
+    endpoint?: string;
 };
 /**
  * アクションテーブルを管理するメソッドを取得する
  *
- * @param config - 設定情報
+ * @param config - アクションテーブル設定情報
  *
  * @returns メソッドを返します
  *
@@ -1761,25 +1755,19 @@ declare namespace widget {
     /**
      * アクションテーブルの設定情報
      *
-     * @public
+     * @param api_key - API Key
+     * @param table - テーブル名
+     * @param endpoint - エンドポイント / 指定がない場合はデフォルトのエンドポイントを使用します。検証用途以外での通常利用では指定なしで大丈夫です。
      */
     type CollectionConfig = {
-        /**
-         * APIキー
-         */
         api_key: string;
-        /**
-         * テーブル名
-         */
         table: string;
-        /**
-         * エンドポイント
-         */ endpoint?: string;
+        endpoint?: string;
     };
     /**
      * アクションテーブルを管理するメソッドを取得する
      *
-     * @param config - 設定情報
+     * @param config - アクションテーブル設定情報
      *
      * @returns メソッドを返します
      *

package/dist/hydrate/index.es.js

@@ -1338,7 +1338,7 @@ const DEFAULT_COLLECTION_ENDPOINT = typeof __FLYER_GEN_COLLECTION_API_ENDPOINT__
 /**
  * アクションテーブルを管理するメソッドを取得する
  *
- * @param config - 設定情報
+ * @param config - アクションテーブル設定情報
  *
  * @returns メソッドを返します
  *
@@ -1349,6 +1349,14 @@ function collection$1(config) {
     const api_key = config.api_key;
     const table = config.table;
     return {
+        /**
+         * キーを１つ、または複数指定して、対応するアクションテーブルの行を取得する
+         *
+         * @param key - 取得する行のキーを一つ、または複数配列で指定
+         * @param cb - テーブルの行を取得した後に実行するcallback関数
+         *
+         * @public
+         */
         get(key, cb) {
             if (Array.isArray(key)) {
                 return request(`${endpoint}/getByKeys`, {
@@ -1358,15 +1366,25 @@ function collection$1(config) {
                 }, cb);
             }
             else {
-                request(`${endpoint}/getByKey`, {
+                return request(`${endpoint}/getByKey`, {
                     api_key,
                     name: table,
                     key,
                 }, cb);
             }
         },
+        /**
+         * クエリーを指定して、アクションテーブルから行を取得する
+         * なお、クエリーは事前に管理画面で設定しておく必要があります。
+         *
+         * @param query_name - クエリー名
+         * @param params - クエリーに指定するパラメーター。 `{key: value}` の形式で指定
+         * @param cb - テーブルの行を取得した後に実行するcallback関数
+         *
+         * @public
+         */
         getByQuery(query_name, params, options, cb) {
-            request(`${endpoint}/getByQuery`, {
+            return request(`${endpoint}/getByQuery`, {
                 api_key,
                 name: table,
                 query_name,
@@ -1374,6 +1392,7 @@ function collection$1(config) {
                 options,
             }, cb);
         },
+        /** @internal */
         set(key, value, cb) {
             request(`${endpoint}/set`, {
                 api_key,

package/dist/index.es.d.ts

@@ -192,25 +192,19 @@ type ActionTableQueryParams = {
 /**
  * アクションテーブルの設定情報
  *
- * @public
+ * @param api_key - API Key
+ * @param table - テーブル名
+ * @param endpoint - エンドポイント / 指定がない場合はデフォルトのエンドポイントを使用します。検証用途以外での通常利用では指定なしで大丈夫です。
  */
 type CollectionConfig = {
-    /**
-     * APIキー
-     */
     api_key: string;
-    /**
-     * テーブル名
-     */
     table: string;
-    /**
-     * エンドポイント
-     */ endpoint?: string;
+    endpoint?: string;
 };
 /**
  * アクションテーブルを管理するメソッドを取得する
  *
- * @param config - 設定情報
+ * @param config - アクションテーブル設定情報
  *
  * @returns メソッドを返します
  *
@@ -1761,25 +1755,19 @@ declare namespace widget {
     /**
      * アクションテーブルの設定情報
      *
-     * @public
+     * @param api_key - API Key
+     * @param table - テーブル名
+     * @param endpoint - エンドポイント / 指定がない場合はデフォルトのエンドポイントを使用します。検証用途以外での通常利用では指定なしで大丈夫です。
      */
     type CollectionConfig = {
-        /**
-         * APIキー
-         */
         api_key: string;
-        /**
-         * テーブル名
-         */
         table: string;
-        /**
-         * エンドポイント
-         */ endpoint?: string;
+        endpoint?: string;
     };
     /**
      * アクションテーブルを管理するメソッドを取得する
      *
-     * @param config - 設定情報
+     * @param config - アクションテーブル設定情報
      *
      * @returns メソッドを返します
      *

package/dist/index.es.js

@@ -1361,7 +1361,7 @@ const DEFAULT_COLLECTION_ENDPOINT = typeof __FLYER_GEN_COLLECTION_API_ENDPOINT__
 /**
  * アクションテーブルを管理するメソッドを取得する
  *
- * @param config - 設定情報
+ * @param config - アクションテーブル設定情報
  *
  * @returns メソッドを返します
  *
@@ -1372,6 +1372,14 @@ function collection$1(config) {
     const api_key = config.api_key;
     const table = config.table;
     return {
+        /**
+         * キーを１つ、または複数指定して、対応するアクションテーブルの行を取得する
+         *
+         * @param key - 取得する行のキーを一つ、または複数配列で指定
+         * @param cb - テーブルの行を取得した後に実行するcallback関数
+         *
+         * @public
+         */
         get(key, cb) {
             if (Array.isArray(key)) {
                 return request(`${endpoint}/getByKeys`, {
@@ -1381,15 +1389,25 @@ function collection$1(config) {
                 }, cb);
             }
             else {
-                request(`${endpoint}/getByKey`, {
+                return request(`${endpoint}/getByKey`, {
                     api_key,
                     name: table,
                     key,
                 }, cb);
             }
         },
+        /**
+         * クエリーを指定して、アクションテーブルから行を取得する
+         * なお、クエリーは事前に管理画面で設定しておく必要があります。
+         *
+         * @param query_name - クエリー名
+         * @param params - クエリーに指定するパラメーター。 `{key: value}` の形式で指定
+         * @param cb - テーブルの行を取得した後に実行するcallback関数
+         *
+         * @public
+         */
         getByQuery(query_name, params, options, cb) {
-            request(`${endpoint}/getByQuery`, {
+            return request(`${endpoint}/getByQuery`, {
                 api_key,
                 name: table,
                 query_name,
@@ -1397,6 +1415,7 @@ function collection$1(config) {
                 options,
             }, cb);
         },
+        /** @internal */
         set(key, value, cb) {
             request(`${endpoint}/set`, {
                 api_key,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plaidev/karte-action-sdk",
-  "version": "1.1.222",
+  "version": "1.1.223",
   "author": "Plaid Inc.",
   "license": "Apache-2.0",
   "module": "./dist/index.es.js",
@@ -56,7 +56,6 @@
   "devDependencies": {
     "@microsoft/api-documenter": "7.19.28",
     "@microsoft/api-extractor": "7.33.8",
-    "@plaidev/action-compiler": "workspace:*",
     "@rollup/plugin-alias": "^4.0.0",
     "@rollup/plugin-commonjs": "^23.0.1",
     "@rollup/plugin-json": "^5.0.0",
@@ -96,7 +95,14 @@
     "tsx": "^3.12.3",
     "typescript": "^4.7.4",
     "vitepress": "1.0.0-alpha.30",
-    "vitest": "latest"
+    "vitest": "latest",
+    "@plaidev/action-compiler": "0.4.231"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@rollup/plugin-image": "^3.0.2"
   },
   "scripts": {
     "dev": "tsx ./scripts/preview.ts",
@@ -125,11 +131,5 @@
     "test:update": "vitest -u",
     "coverage": "vitest run test --coverage",
     "icons:update": "tsx ./scripts/update-icons.ts && prettier -w ./src/icons.ts"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "@rollup/plugin-image": "^3.0.2"
   }
-}
+}