@plaidev/karte-action-sdk 1.1.151 → 1.1.152-27999870.c0dc3627

package/dist/templates.cjs.d.ts

@@ -1,7 +1,35 @@
+/**
+ * 最新SDKに対応したアクションコードを生成する関数群
+ */
+/**
+ * アクションのアプリコード(App.svelte)の初期値の生成
+ *
+ * @internal
+ */
 declare function createAppScript(script?: string, icons?: string[]): string;
+/**
+ * アクションのエントリーコード(index.tsx)の初期値の生成
+ *
+ * @internal
+ */
 declare function createIndexTsx({ script, polyfill, }?: {
     script?: string;
     polyfill?: boolean;
 }): string;
+/**
+ * 後方互換のためのカスタムスクリプトの初期値の生成
+ *
+ * customScript.tsが存在しない場合の後方互換コードを生成する。
+ * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+ *
+ * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+ * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+ *
+ * @internal
+ */
+declare function createCompatibleCustomScript({ script, templateType, }?: {
+    script?: string;
+    templateType?: 'webpopup' | 'script';
+}): string;
 declare function createCustomScript(script?: string): string;
-export { createAppScript, createIndexTsx, createCustomScript };
+export { createAppScript, createIndexTsx, createCompatibleCustomScript, createCustomScript };

package/dist/templates.cjs.js

@@ -1,11 +1,18 @@
 'use strict';
 
+/**
+ * 最新SDKに対応したアクションコードを生成する関数群
+ */
+/**
+ * アクションのアプリコード(App.svelte)の初期値の生成
+ *
+ * @internal
+ */
 function createAppScript(script = '', icons = []) {
     // TODO: `script` should be validated!
     return `<script lang="ts">
-// SDK generated imports: DON'T TOUCH THIS
-// @ts-ignore
-import type { ActionProps, ActionVariables } from "@plaidev/karte-action-sdk";
+// DON'T TOUCH THIS: SDK generates the following imports
+import type { ActionProps, ActionVariables } from '@plaidev/karte-action-sdk';
 import type { Data, Props, Variables } from './gen';
 import { onMount } from 'svelte';
 import { writable } from 'svelte/store';
@@ -65,15 +72,20 @@ $: {
 }
 </script>`;
 }
+/**
+ * アクションのエントリーコード(index.tsx)の初期値の生成
+ *
+ * @internal
+ */
 function createIndexTsx({ script = '', polyfill = false, } = {}) {
     // TODO: `script` should be validated!
-    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";
+    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';
 
-import { props, localVariablesQuery } from "./gen";
-import App from "./App.svelte";
-import onCreate from "./customScript";
+import { props, localVariablesQuery } from './gen';
+import App from './App.svelte';
+import onCreate from './customScript';
 ${script}
 const action = (options: { send: Send; publish: Publish, props: Props; variables: Variables }): KarteAction => {
   return create(App, {
@@ -88,19 +100,41 @@ const action = (options: { send: Send; publish: Publish, props: Props; variables
 
 export default action;`;
 }
-function createCustomScript(script = '') {
-    // export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない
-    // 標準以外の使い方をするケースはサポートドキュメントでフォローする
+/**
+ * 後方互換のためのカスタムスクリプトの初期値の生成
+ *
+ * customScript.tsが存在しない場合の後方互換コードを生成する。
+ * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+ *
+ * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+ * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+ *
+ * @internal
+ */
+function createCompatibleCustomScript({ script = '', templateType = 'webpopup', } = {}) {
     // TODO: `script` should be validated!
+    if (templateType === 'script') {
+        return `\
+${script}
+export default ({ send, data }) => {
+  // ここにスクリプトを書いてください
+};`;
+    }
     return `\
-import { showAction } from "@plaidev/karte-action-sdk";
+import { showAction } from '@plaidev/karte-action-sdk';
 ${script}
 export default ({ send, data }) => {
   // ここにスクリプトを書いてください
   showAction();
 };`;
 }
+// 以下は後方互換。action-editor-frontをデプロイしたら削除可能。
+// @internal
+function createCustomScript(script = '') {
+    return createCompatibleCustomScript({ script });
+}
 
 exports.createAppScript = createAppScript;
+exports.createCompatibleCustomScript = createCompatibleCustomScript;
 exports.createCustomScript = createCustomScript;
 exports.createIndexTsx = createIndexTsx;

package/dist/templates.d.ts

@@ -1,7 +1,35 @@
+/**
+ * 最新SDKに対応したアクションコードを生成する関数群
+ */
+/**
+ * アクションのアプリコード(App.svelte)の初期値の生成
+ *
+ * @internal
+ */
 declare function createAppScript(script?: string, icons?: string[]): string;
+/**
+ * アクションのエントリーコード(index.tsx)の初期値の生成
+ *
+ * @internal
+ */
 declare function createIndexTsx({ script, polyfill, }?: {
     script?: string;
     polyfill?: boolean;
 }): string;
+/**
+ * 後方互換のためのカスタムスクリプトの初期値の生成
+ *
+ * customScript.tsが存在しない場合の後方互換コードを生成する。
+ * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+ *
+ * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+ * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+ *
+ * @internal
+ */
+declare function createCompatibleCustomScript({ script, templateType, }?: {
+    script?: string;
+    templateType?: 'webpopup' | 'script';
+}): string;
 declare function createCustomScript(script?: string): string;
-export { createAppScript, createIndexTsx, createCustomScript };
+export { createAppScript, createIndexTsx, createCompatibleCustomScript, createCustomScript };

package/dist/templates.js

@@ -1,9 +1,16 @@
+/**
+ * 最新SDKに対応したアクションコードを生成する関数群
+ */
+/**
+ * アクションのアプリコード(App.svelte)の初期値の生成
+ *
+ * @internal
+ */
 function createAppScript(script = '', icons = []) {
     // TODO: `script` should be validated!
     return `<script lang="ts">
-// SDK generated imports: DON'T TOUCH THIS
-// @ts-ignore
-import type { ActionProps, ActionVariables } from "@plaidev/karte-action-sdk";
+// DON'T TOUCH THIS: SDK generates the following imports
+import type { ActionProps, ActionVariables } from '@plaidev/karte-action-sdk';
 import type { Data, Props, Variables } from './gen';
 import { onMount } from 'svelte';
 import { writable } from 'svelte/store';
@@ -63,15 +70,20 @@ $: {
 }
 </script>`;
 }
+/**
+ * アクションのエントリーコード(index.tsx)の初期値の生成
+ *
+ * @internal
+ */
 function createIndexTsx({ script = '', polyfill = false, } = {}) {
     // TODO: `script` should be validated!
-    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";
+    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';
 
-import { props, localVariablesQuery } from "./gen";
-import App from "./App.svelte";
-import onCreate from "./customScript";
+import { props, localVariablesQuery } from './gen';
+import App from './App.svelte';
+import onCreate from './customScript';
 ${script}
 const action = (options: { send: Send; publish: Publish, props: Props; variables: Variables }): KarteAction => {
   return create(App, {
@@ -86,17 +98,38 @@ const action = (options: { send: Send; publish: Publish, props: Props; variables
 
 export default action;`;
 }
-function createCustomScript(script = '') {
-    // export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない
-    // 標準以外の使い方をするケースはサポートドキュメントでフォローする
+/**
+ * 後方互換のためのカスタムスクリプトの初期値の生成
+ *
+ * customScript.tsが存在しない場合の後方互換コードを生成する。
+ * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+ *
+ * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+ * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+ *
+ * @internal
+ */
+function createCompatibleCustomScript({ script = '', templateType = 'webpopup', } = {}) {
     // TODO: `script` should be validated!
+    if (templateType === 'script') {
+        return `\
+${script}
+export default ({ send, data }) => {
+  // ここにスクリプトを書いてください
+};`;
+    }
     return `\
-import { showAction } from "@plaidev/karte-action-sdk";
+import { showAction } from '@plaidev/karte-action-sdk';
 ${script}
 export default ({ send, data }) => {
   // ここにスクリプトを書いてください
   showAction();
 };`;
 }
+// 以下は後方互換。action-editor-frontをデプロイしたら削除可能。
+// @internal
+function createCustomScript(script = '') {
+    return createCompatibleCustomScript({ script });
+}
 
-export { createAppScript, createCustomScript, createIndexTsx };
+export { createAppScript, createCompatibleCustomScript, createCustomScript, createIndexTsx };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plaidev/karte-action-sdk",
-  "version": "1.1.151",
+  "version": "1.1.152-27999870.c0dc3627",
   "author": "Plaid Inc.",
   "license": "Apache-2.0",
   "module": "./dist/index.es.js",