@plaidev/karte-action-sdk 1.1.149-27994099.35b889f8 → 1.1.149-27996838.2c24786b

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

@@ -1116,6 +1116,12 @@ declare function onChangeState<Props extends _Props$0, Variables>(fn: ActionChan
  * @public
  */
 type SendFunction = (event_name: string, values?: any) => void;
+/**
+ * アクションの publish 関数
+ *
+ * @public
+ */
+type PublishFunction = (topic: string, values?: any) => void;
 /**
  * アクションのプロパティ
  *
@@ -1126,6 +1132,10 @@ interface ActionProps<Props, Variables> {
      * アクションでイベントがトリガーされたときに受信するための関数
      */
     send: SendFunction;
+    /**
+     * アクション内でタグのQueueにリクエストを発行する関数
+     */
+    publish: PublishFunction;
     /**
      * アクションで使用されるデータ
      */
@@ -1146,11 +1156,17 @@ interface ActionProps<Props, Variables> {
  */
 interface ActionOptions<Props, Variables, VariablesQuery> {
     /**
-     * アクションでイベントがトリガーされたときに受信するための関数
+     * アクション内でイベントを発火する関数
      *
      * @defaultValue `() => {}`
      */
     send?: SendFunction;
+    /**
+     * アクション内でタグのQueueにリクエストを発行する関数
+     *
+     * @defaultValue `() => {}`
+     */
+    publish?: PublishFunction;
     /**
      * アクションで使用されるプロパティ
      *
@@ -2530,6 +2546,12 @@ declare namespace widget {
      * @public
      */
     type SendFunction = (event_name: string, values?: any) => void;
+    /**
+     * アクションの publish 関数
+     *
+     * @public
+     */
+    type PublishFunction = (topic: string, values?: any) => void;
     /**
      * アクションのプロパティ
      *
@@ -2540,6 +2562,10 @@ declare namespace widget {
          * アクションでイベントがトリガーされたときに受信するための関数
          */
         send: SendFunction;
+        /**
+         * アクション内でタグのQueueにリクエストを発行する関数
+         */
+        publish: PublishFunction;
         /**
          * アクションで使用されるデータ
          */
@@ -2560,11 +2586,17 @@ declare namespace widget {
      */
     interface ActionOptions<Props, Variables, VariablesQuery> {
         /**
-         * アクションでイベントがトリガーされたときに受信するための関数
+         * アクション内でイベントを発火する関数
          *
          * @defaultValue `() => {}`
          */
         send?: SendFunction;
+        /**
+         * アクション内でタグのQueueにリクエストを発行する関数
+         *
+         * @defaultValue `() => {}`
+         */
+        publish?: PublishFunction;
         /**
          * アクションで使用されるプロパティ
          *

package/dist/hydrate/index.es.js

@@ -1486,6 +1486,7 @@ function onChangeState(fn) {
  */
 function create(App, options = {
     send: () => { },
+    publish: () => { },
     props: {},
     variables: {},
     localVariablesQuery: undefined,
@@ -1496,7 +1497,11 @@ function create(App, options = {
         ...options.variables,
         ...getVariables(),
     };
-    const actionProps = { send: options.send, data };
+    const actionProps = {
+        send: options.send,
+        publish: options.publish,
+        data,
+    };
     const handleDestroy = () => {
         const { onDestroyHandlers } = getInternalHandlers();
         onDestroyHandlers?.forEach(h => {
@@ -1522,7 +1527,7 @@ function create(App, options = {
             onCloseHandlers.forEach(h => {
                 const actionHookLog = { name: 'onClose', values: { trigger } };
                 console.info(`${ACTION_HOOK_LABEL}:${JSON.stringify(actionHookLog)}`);
-                h({ send: options.send, data }, trigger);
+                h({ send: options.send, publish: options.publish, data }, trigger);
             });
         }
         finalize();
@@ -1555,6 +1560,7 @@ function create(App, options = {
             hydrate: true,
             props: {
                 send: options.send,
+                publish: options.publish,
                 data,
                 onShow: (props) => {
                     const { onShowHandlers } = getInternalHandlers();
@@ -1633,7 +1639,7 @@ function create(App, options = {
     const { onCreateHandlers } = getInternalHandlers();
     if (onCreateHandlers) {
         onCreateHandlers.forEach(h => {
-            h({ send: options.send, data });
+            h({ send: options.send, publish: options.publish, data });
             console.debug(`${ACTION_HOOK_LABEL}: onCreate`);
         });
     }
@@ -1915,6 +1921,7 @@ const close = closeAction;
  */
 function createApp(App, options = {
     send: () => { },
+    publish: () => { },
     props: {},
     variables: {},
     localVariablesQuery: undefined,
@@ -1930,6 +1937,7 @@ function createApp(App, options = {
         target: null,
         props: {
             send: options.send,
+            publish: options.publish,
             close,
             data: {
                 ...options.props,

package/dist/index.es.d.ts

@@ -1116,6 +1116,12 @@ declare function onChangeState<Props extends _Props$0, Variables>(fn: ActionChan
  * @public
  */
 type SendFunction = (event_name: string, values?: any) => void;
+/**
+ * アクションの publish 関数
+ *
+ * @public
+ */
+type PublishFunction = (topic: string, values?: any) => void;
 /**
  * アクションのプロパティ
  *
@@ -1126,6 +1132,10 @@ interface ActionProps<Props, Variables> {
      * アクションでイベントがトリガーされたときに受信するための関数
      */
     send: SendFunction;
+    /**
+     * アクション内でタグのQueueにリクエストを発行する関数
+     */
+    publish: PublishFunction;
     /**
      * アクションで使用されるデータ
      */
@@ -1146,11 +1156,17 @@ interface ActionProps<Props, Variables> {
  */
 interface ActionOptions<Props, Variables, VariablesQuery> {
     /**
-     * アクションでイベントがトリガーされたときに受信するための関数
+     * アクション内でイベントを発火する関数
      *
      * @defaultValue `() => {}`
      */
     send?: SendFunction;
+    /**
+     * アクション内でタグのQueueにリクエストを発行する関数
+     *
+     * @defaultValue `() => {}`
+     */
+    publish?: PublishFunction;
     /**
      * アクションで使用されるプロパティ
      *
@@ -2530,6 +2546,12 @@ declare namespace widget {
      * @public
      */
     type SendFunction = (event_name: string, values?: any) => void;
+    /**
+     * アクションの publish 関数
+     *
+     * @public
+     */
+    type PublishFunction = (topic: string, values?: any) => void;
     /**
      * アクションのプロパティ
      *
@@ -2540,6 +2562,10 @@ declare namespace widget {
          * アクションでイベントがトリガーされたときに受信するための関数
          */
         send: SendFunction;
+        /**
+         * アクション内でタグのQueueにリクエストを発行する関数
+         */
+        publish: PublishFunction;
         /**
          * アクションで使用されるデータ
          */
@@ -2560,11 +2586,17 @@ declare namespace widget {
      */
     interface ActionOptions<Props, Variables, VariablesQuery> {
         /**
-         * アクションでイベントがトリガーされたときに受信するための関数
+         * アクション内でイベントを発火する関数
          *
          * @defaultValue `() => {}`
          */
         send?: SendFunction;
+        /**
+         * アクション内でタグのQueueにリクエストを発行する関数
+         *
+         * @defaultValue `() => {}`
+         */
+        publish?: PublishFunction;
         /**
          * アクションで使用されるプロパティ
          *

package/dist/index.es.js

@@ -1569,6 +1569,7 @@ function onChangeState(fn) {
  */
 function create(App, options = {
     send: () => { },
+    publish: () => { },
     props: {},
     variables: {},
     localVariablesQuery: undefined,
@@ -1579,7 +1580,11 @@ function create(App, options = {
         ...options.variables,
         ...getVariables(),
     };
-    const actionProps = { send: options.send, data };
+    const actionProps = {
+        send: options.send,
+        publish: options.publish,
+        data,
+    };
     const handleDestroy = () => {
         const { onDestroyHandlers } = getInternalHandlers();
         onDestroyHandlers?.forEach(h => {
@@ -1605,7 +1610,7 @@ function create(App, options = {
             onCloseHandlers.forEach(h => {
                 const actionHookLog = { name: 'onClose', values: { trigger } };
                 console.info(`${ACTION_HOOK_LABEL}:${JSON.stringify(actionHookLog)}`);
-                h({ send: options.send, data }, trigger);
+                h({ send: options.send, publish: options.publish, data }, trigger);
             });
         }
         finalize();
@@ -1638,6 +1643,7 @@ function create(App, options = {
             hydrate: false,
             props: {
                 send: options.send,
+                publish: options.publish,
                 data,
                 onShow: (props) => {
                     const { onShowHandlers } = getInternalHandlers();
@@ -1742,7 +1748,7 @@ function create(App, options = {
     const { onCreateHandlers } = getInternalHandlers();
     if (onCreateHandlers) {
         onCreateHandlers.forEach(h => {
-            h({ send: options.send, data });
+            h({ send: options.send, publish: options.publish, data });
             console.debug(`${ACTION_HOOK_LABEL}: onCreate`);
         });
     }
@@ -2023,6 +2029,7 @@ const close = closeAction;
  */
 function createApp(App, options = {
     send: () => { },
+    publish: () => { },
     props: {},
     variables: {},
     localVariablesQuery: undefined,
@@ -2038,6 +2045,7 @@ function createApp(App, options = {
         target: null,
         props: {
             send: options.send,
+            publish: options.publish,
             close,
             data: {
                 ...options.props,

package/dist/templates.cjs.js

@@ -67,7 +67,7 @@ $: {
 }
 function createIndexTsx({ script = '', polyfill = false, } = {}) {
     // TODO: `script` should be validated!
-    return `import type { KarteAction, Send, Props, Variables } from "./gen";
+    return `import type { KarteAction, Send, Publish, Props, Variables } from "./gen";
 ${polyfill ? `import "https://polyfill.io/v3/polyfill.min.js?features=IntersectionObserver";` : ''}
 import { create } from "@plaidev/karte-action-sdk";
 
@@ -75,10 +75,11 @@ import { props, localVariablesQuery } from "./gen";
 import App from "./App.svelte";
 import onCreate from "./customScript";
 ${script}
-const action = (options: { send: Send; props: Props; variables: Variables }): KarteAction => {
+const action = (options: { send: Send; publish: Publish, props: Props; variables: Variables }): KarteAction => {
   return create(App, {
     props,
     send: options.send,
+    publish: options.publish,
     variables: options.variables,
     localVariablesQuery,
     onCreate,
@@ -88,6 +89,8 @@ const action = (options: { send: Send; props: Props; variables: Variables }): Ka
 export default action;`;
 }
 function createCustomScript(script = '') {
+    // export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない
+    // 標準以外の使い方をするケースはサポートドキュメントでフォローする
     // TODO: `script` should be validated!
     return `\
 import { showAction } from "@plaidev/karte-action-sdk";

package/dist/templates.js

@@ -65,7 +65,7 @@ $: {
 }
 function createIndexTsx({ script = '', polyfill = false, } = {}) {
     // TODO: `script` should be validated!
-    return `import type { KarteAction, Send, Props, Variables } from "./gen";
+    return `import type { KarteAction, Send, Publish, Props, Variables } from "./gen";
 ${polyfill ? `import "https://polyfill.io/v3/polyfill.min.js?features=IntersectionObserver";` : ''}
 import { create } from "@plaidev/karte-action-sdk";
 
@@ -73,10 +73,11 @@ import { props, localVariablesQuery } from "./gen";
 import App from "./App.svelte";
 import onCreate from "./customScript";
 ${script}
-const action = (options: { send: Send; props: Props; variables: Variables }): KarteAction => {
+const action = (options: { send: Send; publish: Publish, props: Props; variables: Variables }): KarteAction => {
   return create(App, {
     props,
     send: options.send,
+    publish: options.publish,
     variables: options.variables,
     localVariablesQuery,
     onCreate,
@@ -86,6 +87,8 @@ const action = (options: { send: Send; props: Props; variables: Variables }): Ka
 export default action;`;
 }
 function createCustomScript(script = '') {
+    // export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない
+    // 標準以外の使い方をするケースはサポートドキュメントでフォローする
     // TODO: `script` should be validated!
     return `\
 import { showAction } from "@plaidev/karte-action-sdk";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plaidev/karte-action-sdk",
-  "version": "1.1.149-27994099.35b889f8",
+  "version": "1.1.149-27996838.2c24786b",
   "author": "Plaid Inc.",
   "license": "Apache-2.0",
   "module": "./dist/index.es.js",