bm-webapp-sdk 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,75 @@
+# Installation
+
+## CDN
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/bm-webapp-sdk@latest/dist/bm-webapp-sdk.min.js"></script>
+```
+
+## NPM
+
+```
+npm i --save-dev bm-webapp-sdk
+```
+
+# Usage
+
+## Browser
+
+Include script from CDN. You can then use a script like that:
+
+```javascript
+const handler = new BotMarketing.WebAppHandler({
+  scenarioCode: 'my-scenario-code',
+});
+
+await handler.init();
+
+if (handler.isActive()) {
+  await handler.request('my-request-code', { param: 'value' });
+  
+  // To get any value from session variables
+  handler.data.variables.response;
+}
+```
+
+## Webpack
+
+Import handler class:
+
+```javascript
+import { WebAppHandler } from 'bm-webapp-sdk';
+```
+
+You can then basically do same as for browser:
+
+```javascript
+const handler = new WebAppHandler({
+  scenarioCode: 'my-scenario-code',
+});
+
+await handler.init();
+
+if (handler.isActive()) {
+  await handler.request('my-request-code', { param: 'value' });
+  
+  // To get any value from session variables
+  handler.data.variables.response;
+}
+```
+
+## Telegram support
+
+When running inside Telegram, handler can automatically init session. You need to pass `scenarioCode` when initializing
+the handler.
+
+Scenario must be within a project, project must have telegram api token defined in param `tg_api_token`. You can change
+param name by setting `botTokenParamName` option. Also, project can have only one telegram bot messenger set in project settings.
+
+__Remember that you have still to include telegram mini app scripts to enable telegram support.__
+
+## Request timeout
+
+This library automatically handles request timeout which is 20s by default. If scenario is handling request too long,
+we will wait until it finishes handling by polling session data each `retryDelayOnTimeout` (2000 by default) milliseconds.
+But at most `requestTimeout` (60000) milliseconds.

package/dist/index.d.ts

@@ -1,8 +1,63 @@
-import WebAppHandler from './WebAppHandler';
-import { TelegramWebApps } from 'telegram-webapps-types';
+interface HandlerOptions {
+    sessionHash?: string;
+    scenarioCode?: string;
+    initVariables?: TData;
+    botTokenParamName?: string;
+    userApiToken?: string;
+    retryDelayOnTimeout?: number;
+    requestTimeout?: number;
+    responseVar?: string;
+    apiEndpoint?: string;
+}
+type TData = {
+    [key: string]: any;
+};
+interface INodeEventsDecl {
+    inbox: boolean;
+    outbox: boolean;
+    anyInbox: boolean;
+    dialogClosed: boolean;
+    invoicePaid: boolean;
+    externalRequest: boolean;
+    buttons: boolean;
+    customEvents: boolean;
+}
+interface INode {
+    id: number;
+    title: string;
+    typeName: "basic" | "event" | "eventListener" | "condition" | "conditionBranch";
+    waitingForEvents?: INodeEventsDecl;
+}
+type TScenarioSessionStatus = "active" | "stopped" | "ended" | "unknownError" | "tunnelDisabled" | "expired" | "userDisabled" | "stepDeleted" | "transitionsLimit" | "parentStopped";
+interface ScenarioSession {
+    id: number;
+    hash: string;
+    statusName: TScenarioSessionStatus;
+    ref: string | null;
+    variables: TData;
+    isTransitioning: boolean;
+    currentNode: INode | null;
+}
+export default class WebAppHandler {
+    readonly options: HandlerOptions;
+    data?: ScenarioSession;
+    private currentRequest?;
+    constructor(options: HandlerOptions);
+    isActive(): boolean;
+    init(): Promise<WebAppHandler>;
+    refreshData(): Promise<WebAppHandler>;
+    request(code: string, params?: TData, async?: boolean): Promise<WebAppHandler>;
+    abort(): void;
+    isTelegramInitAvailable(): boolean;
+    protected initNewSession(): Promise<WebAppHandler>;
+    protected makeRequest(method: string, path: string, json?: TData, signal?: AbortSignal): Promise<any>;
+    private waitUntilSessionFinishesTransition;
+}
+
 export { WebAppHandler };
 declare global {
     interface Window {
-        Telegram: TelegramWebApps.SDK | undefined;
+        Telegram: any;
     }
 }
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bm-webapp-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "",
   "main": "dist/bundle.js",
   "types": "dist/index.d.ts",
@@ -22,5 +22,8 @@
     "typescript": "^5.3.3",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^5.0.2"
+  },
+  "dependencies": {
+    "typescript-declaration-webpack-plugin": "^0.3.0"
   }
 }

package/dist/WebAppHandler.d.ts

@@ -1,56 +0,0 @@
-interface HandlerOptions {
-    sessionHash?: string;
-    scenarioCode?: string;
-    initVariables?: TData;
-    botTokenParamName?: string;
-    userApiToken?: string;
-    retryDelayOnTimeout?: number;
-    requestTimeout?: number;
-    responseVar?: string;
-    apiEndpoint?: string;
-}
-type TData = {
-    [key: string]: any;
-};
-interface INodeEventsDecl {
-    inbox: boolean;
-    outbox: boolean;
-    anyInbox: boolean;
-    dialogClosed: boolean;
-    invoicePaid: boolean;
-    externalRequest: boolean;
-    buttons: boolean;
-    customEvents: boolean;
-}
-interface INode {
-    id: number;
-    title: string;
-    typeName: "basic" | "event" | "eventListener" | "condition" | "conditionBranch";
-    waitingForEvents?: INodeEventsDecl;
-}
-type TScenarioSessionStatus = "active" | "stopped" | "ended" | "unknownError" | "tunnelDisabled" | "expired" | "userDisabled" | "stepDeleted" | "transitionsLimit" | "parentStopped";
-interface ScenarioSession {
-    id: number;
-    hash: string;
-    statusName: TScenarioSessionStatus;
-    ref: string | null;
-    variables: TData;
-    isTransitioning: boolean;
-    currentNode: INode | null;
-}
-export default class WebAppHandler {
-    readonly options: HandlerOptions;
-    data?: ScenarioSession;
-    private currentRequest?;
-    constructor(options: HandlerOptions);
-    isActive(): boolean;
-    init(): Promise<WebAppHandler>;
-    refreshData(): Promise<WebAppHandler>;
-    request(code: string, params?: TData, async?: boolean): Promise<WebAppHandler>;
-    abort(): void;
-    isTelegramInitAvailable(): boolean;
-    protected initNewSession(): Promise<WebAppHandler>;
-    protected makeRequest(method: string, path: string, json?: TData, signal?: AbortSignal): Promise<any>;
-    private waitUntilSessionFinishesTransition;
-}
-export {};