@apps-in-toss/web-bridge 1.5.2 → 1.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
1
  export interface AppsInTossSignTossCertParams {
2
2
  txId: string;
3
+ skipConfirmDoc?: boolean;
3
4
  }
4
5
  /**
5
6
  * @public
@@ -9,6 +10,7 @@ export interface AppsInTossSignTossCertParams {
9
10
  *
10
11
  * @param {AppsInTossSignTossCertParams} params - 서명에 필요한 파라미터를 포함하는 객체예요.
11
12
  * @param {string} params.txId - 토스인증서를 사용한 본인확인이나 간편인증, 전자서명에서 사용하는 Transaction Id예요.
13
+ * @param {boolean} params.skipConfirmDoc - (선택) 토스 원터치 인증방식을 사용하기 위한 옵션이예요. true 설정 시 최소 버전: Android 5.236.0, iOS 5.236.0 (default: false)
12
14
  *
13
15
  * @example
14
16
  * ```tsx
@@ -4,29 +4,33 @@
4
4
  * @kind function
5
5
  * @name getTossShareLink
6
6
  * @description
7
- * `getTossShareLink` 함수는 사용자가 지정한 경로를 토스 앱에서 열 수 있는 공유 링크를 반환해요.
8
- * 이 링크를 다른 사람과 공유하면 토스 앱이 실행되면서 지정한 경로로 진입해요. 토스앱이 없는 사람은 iOS 일 때는 앱스토어로 이동하고, Android 일 때는 플레이스토어로 이동해요.
7
+ * 사용자가 지정한 경로를 토스 앱에서 열 수 있는 공유 링크를 생성해요.
9
8
  *
10
- * 경로는 토스 내부 특정 화면을 나타내는 딥링크(deep link) 형식이어야 해요.
11
- * 예를 들어 `intoss://<앱 이름>`이나 `intoss://<앱 이름>/about?name=test`처럼 작성해요.
9
+ * 생성된 링크를 다른 사람과 공유하면:
10
+ * - 토스 앱이 설치되어 있으면: 토스 앱이 실행되면서 지정한 경로로 이동해요.
11
+ * - 토스 앱이 없으면: iOS는 앱스토어로, Android는 플레이스토어로 이동해요.
12
12
  *
13
- * 함수를 사용하면 `deep_link_value`를 포함한 완성된 공유 링크를 만들 수 있어요.
14
- *
15
- * @param path - 딥링크로 열고 싶은 경로예요. `intoss://`로 시작하는 문자열이어야 해요.
16
- * @returns {Promise<string>} `deep_link_value`가 포함된 토스 공유 링크를 반환해요.
13
+ * @param path - 딥링크 경로예요. `intoss://`로 시작하는 문자열이어야 해요. (예: `intoss://my-app`, `intoss://my-app/detail?id=123`)
14
+ * @param ogImageUrl - (선택) 공유 시 표시될 커스텀 OG 이미지 URL이에요. 최소 버전: Android 5.240.0, iOS 5.239.0
15
+ * @returns {Promise<string>} 생성된 토스 공유 링크
17
16
  *
18
17
  * @example
19
18
  * ```tsx
20
19
  * import { share } from '@apps-in-toss/web-framework';
21
20
  * import { getTossShareLink } from '@apps-in-toss/web-framework';
22
21
  *
23
- * // '/' 경로를 딥링크로 포함한 토스 공유 링크를 생성해요.
22
+ * // 기본 사용법
24
23
  * const tossLink = await getTossShareLink('intoss://my-app');
25
- *
26
- * // 생성한 링크를 메시지로 공유해요.
27
24
  * await share({ message: tossLink });
25
+ *
26
+ * // 커스텀 OG 이미지와 함께 사용
27
+ * const linkWithImage = await getTossShareLink(
28
+ * 'intoss://my-app/event',
29
+ * 'https://example.com/og-image.png'
30
+ * );
31
+ * await share({ message: linkWithImage });
28
32
  * ```
29
33
  */
30
- export declare function getTossShareLink(path: string): Promise<string>;
34
+ export declare function getTossShareLink(path: string, ogImageUrl?: string): Promise<string>;
31
35
 
32
36
  export {};
package/built/index.d.cts CHANGED
@@ -821,13 +821,7 @@ declare function isMinVersionSupported(minVersions: {
821
821
  ios: `${number}.${number}.${number}` | 'always' | 'never';
822
822
  }): boolean;
823
823
 
824
- type AppsInTossEvent = {
825
- entryMessageExited: {
826
- onEvent: () => void;
827
- onError?: (error: Error) => void;
828
- options: undefined;
829
- };
830
- };
824
+ type AppsInTossEvent = {};
831
825
  declare const appsInTossEvent: {
832
826
  addEventListener: <K extends keyof AppsInTossEvent>(event: K, { onEvent, onError, options, }: {
833
827
  onEvent: AppsInTossEvent[K]["onEvent"];
package/built/index.d.ts CHANGED
@@ -821,13 +821,7 @@ declare function isMinVersionSupported(minVersions: {
821
821
  ios: `${number}.${number}.${number}` | 'always' | 'never';
822
822
  }): boolean;
823
823
 
824
- type AppsInTossEvent = {
825
- entryMessageExited: {
826
- onEvent: () => void;
827
- onError?: (error: Error) => void;
828
- options: undefined;
829
- };
830
- };
824
+ type AppsInTossEvent = {};
831
825
  declare const appsInTossEvent: {
832
826
  addEventListener: <K extends keyof AppsInTossEvent>(event: K, { onEvent, onError, options, }: {
833
827
  onEvent: AppsInTossEvent[K]["onEvent"];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@apps-in-toss/web-bridge",
3
3
  "type": "module",
4
- "version": "1.5.2",
4
+ "version": "1.5.3",
5
5
  "description": "Web Bridge for Apps In Toss",
6
6
  "scripts": {
7
7
  "prepack": "yarn build",
@@ -28,11 +28,11 @@
28
28
  "built"
29
29
  ],
30
30
  "dependencies": {
31
- "@apps-in-toss/types": "1.5.2"
31
+ "@apps-in-toss/types": "1.5.3"
32
32
  },
33
33
  "devDependencies": {
34
- "@apps-in-toss/bridge-core": "1.5.2",
35
- "@apps-in-toss/framework": "1.5.2",
34
+ "@apps-in-toss/bridge-core": "1.5.3",
35
+ "@apps-in-toss/framework": "1.5.3",
36
36
  "@swc/core": "^1.12.7",
37
37
  "picocolors": "^1.1.1",
38
38
  "ts-morph": "^26.0.0",
@@ -46,5 +46,5 @@
46
46
  "publishConfig": {
47
47
  "access": "public"
48
48
  },
49
- "gitHead": "8224b90876f7d9e0feac0cd38ef80be42a5d784f"
49
+ "gitHead": "b6152cb5bd176d6fd1863ff00638b38f17269e09"
50
50
  }