@hexagramio/saga-ts 0.9.293-4 → 0.9.293-5
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.
- package/README.md +158 -17
- package/dist/cjs/senders/socket.d.ts +2 -1
- package/dist/cjs/senders/socket.d.ts.map +1 -1
- package/dist/cjs/senders/socket.js +2 -1
- package/dist/cjs/senders/socket.js.map +1 -1
- package/dist/senders/socket.d.ts +2 -1
- package/dist/senders/socket.d.ts.map +1 -1
- package/dist/senders/socket.js +2 -1
- package/dist/senders/socket.js.map +1 -1
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -1,36 +1,177 @@
|
|
|
1
1
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
2
2
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
3
|
-
**Table of Contents**
|
|
4
|
-
|
|
5
|
-
- [Saga Typescript SDK](#saga-typescript-sdk)
|
|
6
|
-
- [Install](#install)
|
|
7
|
-
- [Tests](#tests)
|
|
8
|
-
- [Build](#build)
|
|
9
|
-
- [Usage](#usage)
|
|
10
|
-
|
|
11
3
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
12
4
|
|
|
13
5
|
# Saga Typescript SDK
|
|
14
6
|
|
|
15
|
-
Typescript SDK to interface with a Saga API host. The implementation is
|
|
7
|
+
Typescript SDK to interface with a Saga API host. The implementation is inspired by the Command Design Pattern. A command is send to a Reveiver. A command encapsulates all the data needed to call the API except the domain name. Currently there two kinds of command receivers, HTTP and Socket. Almost all commands except for logging and some user creation methods require a accessToken. If a command fails an exception is being thrown that mirrors SAGA API errors.
|
|
8
|
+
|
|
9
|
+
[Browse Complete Documentation](modules.md)
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```shell
|
|
14
|
+
npm install @hexagramio/saga-ts
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
16
19
|
|
|
17
|
-
|
|
20
|
+
|
|
21
|
+
### Register User
|
|
18
22
|
|
|
19
23
|
```js
|
|
20
24
|
|
|
21
25
|
import {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
26
|
+
RegisterUserCommand,
|
|
27
|
+
sendHTTPCommand} from "saga-ts";
|
|
28
|
+
|
|
29
|
+
const baseURL=new URL("https://saga-api.com");
|
|
30
|
+
const user = await sendHTTPCommand(baseUrl,RegisterUserCommand({username:`foo`,password:`bar`}))
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Login User and Add User Property
|
|
34
|
+
|
|
35
|
+
```js
|
|
25
36
|
|
|
26
37
|
import {
|
|
27
|
-
Lo,
|
|
28
38
|
Authentication,
|
|
29
|
-
|
|
39
|
+
AddUserPropertyCommand,
|
|
40
|
+
LoginUserCommand,
|
|
41
|
+
sendHTTPCommand} from "saga-ts";
|
|
42
|
+
|
|
43
|
+
const baseURL=new URL("https://saga-api.com");
|
|
44
|
+
const user = await sendHTTPCommand(baseUrl,LoginUserCommand({username:`foo`,password:`bar`}))
|
|
45
|
+
await sendHTTPCommand(baseUrl,AddUserPropertyCommand(user.accessToken,{parent_id:user._id,name:"hello",value:"world"}))
|
|
46
|
+
```
|
|
30
47
|
|
|
31
|
-
|
|
32
|
-
await authentication = await sendHTTPCommand()
|
|
48
|
+
### Paginate Listing, example using Listing
|
|
33
49
|
|
|
50
|
+
```js
|
|
51
|
+
|
|
52
|
+
import {
|
|
53
|
+
ListBotsCommand,
|
|
54
|
+
sendHTTPCommand} from "saga-ts";
|
|
55
|
+
|
|
56
|
+
const baseURL=new URL("https://saga-api.com");
|
|
57
|
+
const accessToken="123213132";//from cache
|
|
58
|
+
const botsListing = await sendHTTPCommand(baseUrl,ListBotsCommand(accessToken))
|
|
59
|
+
|
|
60
|
+
//do we have more? nextCommand contains all the data needed for the call
|
|
61
|
+
if (botsListing.nextCommand) {
|
|
62
|
+
const botsNext = await sendHTTPCommand(baseUrl, botsListing.nextCommand);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
//OR
|
|
66
|
+
|
|
67
|
+
//do we have some previous? prevcommand contains all the data needed for the call
|
|
68
|
+
if (botsListing.prevCommand) {
|
|
69
|
+
const botsPrev = await sendHTTPCommand(baseUrl, botsListing.prevCommand);
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Handle HTTP Error
|
|
74
|
+
|
|
75
|
+
```js
|
|
76
|
+
|
|
77
|
+
import {
|
|
78
|
+
ListUserCommand,
|
|
79
|
+
RegisterUserCommand,
|
|
80
|
+
sendHTTPCommand} from "saga-ts";
|
|
81
|
+
|
|
82
|
+
const baseURL=new URL("https://saga-api.com");
|
|
83
|
+
const accessToken="89012y417114211";//from cache
|
|
84
|
+
try{
|
|
85
|
+
await sendHTTPCommand(baseUrl,CreateBot(user.accessToken,{name:"ALREADY TAKEN"}))
|
|
86
|
+
} catch(e){
|
|
87
|
+
if(e.statusCode===422){
|
|
88
|
+
//e.errors contains [fieldName:string]: message
|
|
89
|
+
//handle the specific error messages
|
|
90
|
+
}
|
|
91
|
+
//...
|
|
92
|
+
}
|
|
34
93
|
|
|
35
94
|
```
|
|
36
95
|
|
|
96
|
+
### Inspect Missing Fields in failed HTTP Call
|
|
97
|
+
|
|
98
|
+
```js
|
|
99
|
+
|
|
100
|
+
import {
|
|
101
|
+
ListUserCommand,
|
|
102
|
+
RegisterUserCommand,
|
|
103
|
+
sendHTTPCommand} from "saga-ts";
|
|
104
|
+
|
|
105
|
+
const baseURL=new URL("https://saga-api.com");
|
|
106
|
+
const user = await sendHTTPCommand(baseUrl,RegisterUserCommand({username:`foo`,password:`bar`}))
|
|
107
|
+
try{
|
|
108
|
+
await sendHTTPCommand(baseUrl,ListUserCommand(user.accessToken,{parent_id:user._id,name:"hello",value:"world"}))
|
|
109
|
+
} catch(e){
|
|
110
|
+
//handle 401 and 403 for
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Subscribe to Socket Bot Property Changes
|
|
116
|
+
|
|
117
|
+
```js
|
|
118
|
+
|
|
119
|
+
import {
|
|
120
|
+
Authentication,
|
|
121
|
+
SocketSession} from "saga-ts";
|
|
122
|
+
|
|
123
|
+
const baseURL=new URL("https://saga-api.com");
|
|
124
|
+
const socketSession = new SocketSession(
|
|
125
|
+
baseUrl,
|
|
126
|
+
accessToken, //assumed existing
|
|
127
|
+
(error)=>console.error //disconnect errors need to be handled asynchronously
|
|
128
|
+
)
|
|
129
|
+
socketSession.on("/properties", (property)=>{
|
|
130
|
+
//do something with propterties
|
|
131
|
+
if(property.name="location"){
|
|
132
|
+
updateMapLocation(property);
|
|
133
|
+
}//....
|
|
134
|
+
})
|
|
135
|
+
//join bot command
|
|
136
|
+
await socketSession.emitCommand(JoinBotCommand("ID OF BOT TO JOIN"))
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Handle Socket Emit Comand Errors
|
|
140
|
+
|
|
141
|
+
```js
|
|
142
|
+
|
|
143
|
+
import {
|
|
144
|
+
Authentication,
|
|
145
|
+
SocketSession} from "saga-ts";
|
|
146
|
+
|
|
147
|
+
const baseURL=new URL("https://saga-api.com");
|
|
148
|
+
const socketSession = new SocketSession(
|
|
149
|
+
baseUrl,
|
|
150
|
+
accessToken, //assumed existing
|
|
151
|
+
(error)=>console.error //disconnect errors need to be handled asynchronously
|
|
152
|
+
)
|
|
153
|
+
|
|
154
|
+
try{
|
|
155
|
+
await socketSession.emitCommand(JoinBotCommand("Not access to id"))
|
|
156
|
+
} catch(e){
|
|
157
|
+
//deal with API Error like 401,403,404 and 422 depending on the comand
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Handle Socket Connection Error
|
|
163
|
+
|
|
164
|
+
```js
|
|
165
|
+
|
|
166
|
+
import {SocketSession} from "saga-ts";
|
|
167
|
+
const baseURL=new URL("https://saga-api.com");
|
|
168
|
+
new SocketSession(
|
|
169
|
+
baseUrl,
|
|
170
|
+
"bad token",
|
|
171
|
+
(err)=>{
|
|
172
|
+
//handleError
|
|
173
|
+
}
|
|
174
|
+
)
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
|
|
@@ -22,7 +22,8 @@ export interface SocketJoinCommand {
|
|
|
22
22
|
*/
|
|
23
23
|
export type SocketCommand = SocketJoinCommand;
|
|
24
24
|
/**
|
|
25
|
-
* Class that wraps saga socket connection logic and manages realtime saga socket events.
|
|
25
|
+
* Class that wraps saga socket connection logic and manages realtime saga socket events. SocketSession will attempt to reconnect 100x if the connection is failing to reconnect
|
|
26
|
+
* after loss of connection
|
|
26
27
|
*/
|
|
27
28
|
export declare class SocketSession {
|
|
28
29
|
private socket;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/senders/socket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAMpE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,GAAG,CAAC;CAEtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,GACrC,sBAAsB,GAAG,gBAAgB,GACzC,yBAAyB,GAAG,mBAAmB,GAC/C,SAAS,GAAG,eAAe,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAG9C
|
|
1
|
+
{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/senders/socket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAMpE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,GAAG,CAAC;CAEtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,GACrC,sBAAsB,GAAG,gBAAgB,GACzC,yBAAyB,GAAG,mBAAmB,GAC/C,SAAS,GAAG,eAAe,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAG9C;;;GAGG;AACH,qBAAa,aAAa;IAExB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAO;IAClC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;;OAKG;gBAED,IAAI,EAAE,GAAG,EACT,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,GAAG,EACrC,OAAO,CAAC,EAAC;QAAC,mBAAmB,CAAC,EAAC,MAAM,CAAC;QAAA,2BAA2B,CAAC,EAAC,MAAM,CAAA;KAAC;IAyD5E,OAAO,CAAC,mBAAmB;IAW3B,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI;IAK/E,GAAG,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI;IAKjF;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa;CA0BzC"}
|
|
@@ -18,7 +18,8 @@ const types_1 = require("../shared/types");
|
|
|
18
18
|
const debug_1 = __importDefault(require("debug"));
|
|
19
19
|
const debug = (0, debug_1.default)("saga-ts");
|
|
20
20
|
/**
|
|
21
|
-
* Class that wraps saga socket connection logic and manages realtime saga socket events.
|
|
21
|
+
* Class that wraps saga socket connection logic and manages realtime saga socket events. SocketSession will attempt to reconnect 100x if the connection is failing to reconnect
|
|
22
|
+
* after loss of connection
|
|
22
23
|
*/
|
|
23
24
|
class SocketSession {
|
|
24
25
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket.js","sourceRoot":"","sources":["../../../src/senders/socket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,wEAAkD;AAClD,2CAAoE;AAEpE,kDAA0B;AAC1B,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,SAAS,CAAC,CAAC;AAiC/B
|
|
1
|
+
{"version":3,"file":"socket.js","sourceRoot":"","sources":["../../../src/senders/socket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,wEAAkD;AAClD,2CAAoE;AAEpE,kDAA0B;AAC1B,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,SAAS,CAAC,CAAC;AAiC/B;;;GAGG;AACH,MAAa,aAAa;IAOxB;;;;;OAKG;IACH,YACE,IAAS,EACT,WAAmB,EACnB,WAAqC,EACrC,OAA0E;QAd3D,eAAU,GAAG,GAAG,CAAC;QAC1B,iBAAY,GAAoB,EAAE,CAAC;QACnC,UAAK,GAAG,KAAK,CAAC;QAgBpB,IAAI,CAAC,MAAM,GAAG,IAAA,0BAAQ,EAAC,IAAI,CAAC,QAAQ,EAAE,EAAE;YACtC,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YACpC,YAAY,EAAE,IAAI;YAClB,iBAAiB,EAAE,IAAI;YACvB,oBAAoB,EAAE,IAAI;YAC1B,oBAAoB,EAAE,IAAI,CAAC,UAAU;SACtC,CAAC;aACC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAClB,KAAK,CAAC,SAAS,CAAC,CAAC;YACjB,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,KAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,IAAG,CAAC,EAAE;gBACpE,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAC,WAAW,EAAC,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;aAClG;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAC,WAAW,EAAC,CAAC,CAAA;aAClD;YACD,IAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,2BAA2B,KAAI,OAAO,CAAC,2BAA2B,GAAC,CAAC,EAAC;gBAC/E,UAAU,CAAC,GAAG,EAAE;oBACd,OAAO,CAAC,2BAA2B,GAAC,CAAC,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;oBACxB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACtB,IAAI,CAAC,mBAAmB,EAAE,CAAA;gBAC5B,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;aACzC;YACD,oDAAoD;QAEtD,CAAC,CAAC;aACD,EAAE,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE;YACtB,IAAI,CAAC,KAAK,GAAC,KAAK,CAAC;YACjB,KAAK,CAAC,cAAc,GAAG,EAAE,CAAC,CAAC;QAE7B,CAAC,CAAC;aACD,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;YACjB,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;YACtB,WAAW,CAAC,IAAI,gBAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QAC7C,CAAC,CAAC;aACD,EAAE,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1B,KAAK,CAAC,cAAc,CAAC,CAAC;YACtB,WAAW,CAAC,IAAI,gBAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QAC7C,CAAC,CAAC;aACD,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACxB,KAAK,CAAC,eAAe,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAClC,KAAK,CAAC,WAAW,CAAC,CAAC;YACnB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;IAGJ,CAAC;IAGO,mBAAmB;QACzB,KAAK,CAAC,uBAAuB,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QACzD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE;YACvC,KAAK,CAAC,eAAe,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAa,EAAE,EAAE;gBACrG,KAAK,CAAC,2BAA2B,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAA;SACH;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;IACtF,CAAC;IAED,EAAE,CAA2B,IAAO,EAAE,QAAkC;QACtE,YAAY;QACZ,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED,GAAG,CAA2B,IAAO,EAAE,QAAmC;QACxE,YAAY;QACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACG,WAAW,CAAC,OAAsB;;YACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAErC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACf,KAAK,CAAC,kBAAkB,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;oBACxE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;iBAChC;qBAAM;oBACL,KAAK,CAAC,WAAW,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;oBACnC,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAA;oBACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAa,EAAE,EAAE;wBACjD,KAAK,CAAC,gBAAgB,QAAQ,CAAC,WAAW,QAAQ,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;wBACrE,IAAI,QAAQ,CAAC,WAAW,KAAK,GAAG,EAAE;4BAChC,MAAM,CAAC,IAAI,gBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;yBACvG;6BAAM;4BACL,gDAAgD;4BAChD,uCAAuC;4BACvC,IAAG,OAAO,CAAC,IAAI,KAAK,SAAS,EAAC;gCAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;6BAChC;4BACD,OAAO,CAAC,QAAQ,CAAC,CAAA;yBAClB;oBACH,CAAC,CACF,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;CACF;AA9HD,sCA8HC"}
|
package/dist/senders/socket.d.ts
CHANGED
|
@@ -22,7 +22,8 @@ export interface SocketJoinCommand {
|
|
|
22
22
|
*/
|
|
23
23
|
export type SocketCommand = SocketJoinCommand;
|
|
24
24
|
/**
|
|
25
|
-
* Class that wraps saga socket connection logic and manages realtime saga socket events.
|
|
25
|
+
* Class that wraps saga socket connection logic and manages realtime saga socket events. SocketSession will attempt to reconnect 100x if the connection is failing to reconnect
|
|
26
|
+
* after loss of connection
|
|
26
27
|
*/
|
|
27
28
|
export declare class SocketSession {
|
|
28
29
|
private socket;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../src/senders/socket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAMpE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,GAAG,CAAC;CAEtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,GACrC,sBAAsB,GAAG,gBAAgB,GACzC,yBAAyB,GAAG,mBAAmB,GAC/C,SAAS,GAAG,eAAe,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAG9C
|
|
1
|
+
{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../src/senders/socket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAMpE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,GAAG,CAAC;CAEtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,GACrC,sBAAsB,GAAG,gBAAgB,GACzC,yBAAyB,GAAG,mBAAmB,GAC/C,SAAS,GAAG,eAAe,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAG9C;;;GAGG;AACH,qBAAa,aAAa;IAExB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAO;IAClC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;;OAKG;gBAED,IAAI,EAAE,GAAG,EACT,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,GAAG,EACrC,OAAO,CAAC,EAAC;QAAC,mBAAmB,CAAC,EAAC,MAAM,CAAC;QAAA,2BAA2B,CAAC,EAAC,MAAM,CAAA;KAAC;IAyD5E,OAAO,CAAC,mBAAmB;IAW3B,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI;IAK/E,GAAG,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI;IAKjF;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa;CA0BzC"}
|
package/dist/senders/socket.js
CHANGED
|
@@ -12,7 +12,8 @@ import { APIError } from "../shared/types";
|
|
|
12
12
|
import Debug from "debug";
|
|
13
13
|
const debug = Debug("saga-ts");
|
|
14
14
|
/**
|
|
15
|
-
* Class that wraps saga socket connection logic and manages realtime saga socket events.
|
|
15
|
+
* Class that wraps saga socket connection logic and manages realtime saga socket events. SocketSession will attempt to reconnect 100x if the connection is failing to reconnect
|
|
16
|
+
* after loss of connection
|
|
16
17
|
*/
|
|
17
18
|
export class SocketSession {
|
|
18
19
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket.js","sourceRoot":"","sources":["../../src/senders/socket.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,QAAkB,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAC,QAAQ,EAA4B,MAAM,iBAAiB,CAAC;AAEpE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAiC/B
|
|
1
|
+
{"version":3,"file":"socket.js","sourceRoot":"","sources":["../../src/senders/socket.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,QAAkB,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAC,QAAQ,EAA4B,MAAM,iBAAiB,CAAC;AAEpE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAiC/B;;;GAGG;AACH,MAAM,OAAO,aAAa;IAOxB;;;;;OAKG;IACH,YACE,IAAS,EACT,WAAmB,EACnB,WAAqC,EACrC,OAA0E;QAd3D,eAAU,GAAG,GAAG,CAAC;QAC1B,iBAAY,GAAoB,EAAE,CAAC;QACnC,UAAK,GAAG,KAAK,CAAC;QAgBpB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE;YACtC,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YACpC,YAAY,EAAE,IAAI;YAClB,iBAAiB,EAAE,IAAI;YACvB,oBAAoB,EAAE,IAAI;YAC1B,oBAAoB,EAAE,IAAI,CAAC,UAAU;SACtC,CAAC;aACC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAClB,KAAK,CAAC,SAAS,CAAC,CAAC;YACjB,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,KAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,IAAG,CAAC,EAAE;gBACpE,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAC,WAAW,EAAC,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;aAClG;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAC,WAAW,EAAC,CAAC,CAAA;aAClD;YACD,IAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,2BAA2B,KAAI,OAAO,CAAC,2BAA2B,GAAC,CAAC,EAAC;gBAC/E,UAAU,CAAC,GAAG,EAAE;oBACd,OAAO,CAAC,2BAA2B,GAAC,CAAC,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;oBACxB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACtB,IAAI,CAAC,mBAAmB,EAAE,CAAA;gBAC5B,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;aACzC;YACD,oDAAoD;QAEtD,CAAC,CAAC;aACD,EAAE,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE;YACtB,IAAI,CAAC,KAAK,GAAC,KAAK,CAAC;YACjB,KAAK,CAAC,cAAc,GAAG,EAAE,CAAC,CAAC;QAE7B,CAAC,CAAC;aACD,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;YACjB,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;YACtB,WAAW,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QAC7C,CAAC,CAAC;aACD,EAAE,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1B,KAAK,CAAC,cAAc,CAAC,CAAC;YACtB,WAAW,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QAC7C,CAAC,CAAC;aACD,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACxB,KAAK,CAAC,eAAe,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAClC,KAAK,CAAC,WAAW,CAAC,CAAC;YACnB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;IAGJ,CAAC;IAGO,mBAAmB;QACzB,KAAK,CAAC,uBAAuB,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QACzD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE;YACvC,KAAK,CAAC,eAAe,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAa,EAAE,EAAE;gBACrG,KAAK,CAAC,2BAA2B,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAA;SACH;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;IACtF,CAAC;IAED,EAAE,CAA2B,IAAO,EAAE,QAAkC;QACtE,YAAY;QACZ,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED,GAAG,CAA2B,IAAO,EAAE,QAAmC;QACxE,YAAY;QACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACG,WAAW,CAAC,OAAsB;;YACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAErC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACf,KAAK,CAAC,kBAAkB,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;oBACxE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;iBAChC;qBAAM;oBACL,KAAK,CAAC,WAAW,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;oBACnC,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAA;oBACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAa,EAAE,EAAE;wBACjD,KAAK,CAAC,gBAAgB,QAAQ,CAAC,WAAW,QAAQ,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;wBACrE,IAAI,QAAQ,CAAC,WAAW,KAAK,GAAG,EAAE;4BAChC,MAAM,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;yBACvG;6BAAM;4BACL,gDAAgD;4BAChD,uCAAuC;4BACvC,IAAG,OAAO,CAAC,IAAI,KAAK,SAAS,EAAC;gCAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;6BAChC;4BACD,OAAO,CAAC,QAAQ,CAAC,CAAA;yBAClB;oBACH,CAAC,CACF,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hexagramio/saga-ts",
|
|
3
|
-
"version": "0.9.293-
|
|
3
|
+
"version": "0.9.293-5",
|
|
4
4
|
"description": "Saga SDK",
|
|
5
5
|
"types": "./dist/index.d.ts",
|
|
6
6
|
"scripts": {
|
|
@@ -8,8 +8,9 @@
|
|
|
8
8
|
"coverage": "jest --coverage --forceExit",
|
|
9
9
|
"lint": "eslint src/ --ext .ts",
|
|
10
10
|
"build": "npx tsc --project tsconfig.json && npx tsc --project tsconfig.cjs.json",
|
|
11
|
-
"typedoc": "rm -rf docs/; npx typedoc --tsconfig tsconfig.json
|
|
12
|
-
"
|
|
11
|
+
"typedoc": "rm -rf docs/; npx typedoc --tsconfig tsconfig.json --disableSources --hideGenerator src/index.ts",
|
|
12
|
+
"typedoc-md": "rm -rf docs-md/;typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs --disableSources --excludeReferences --includeVersion --out docs-md src/index.ts",
|
|
13
|
+
"prepare": "npm run build;"
|
|
13
14
|
},
|
|
14
15
|
"keywords": [],
|
|
15
16
|
"devDependencies": {
|
|
@@ -29,6 +30,7 @@
|
|
|
29
30
|
"taffydb": "^2.7.3",
|
|
30
31
|
"ts-jest": "^29.1.0",
|
|
31
32
|
"typedoc": "^0.24.8",
|
|
33
|
+
"typedoc-plugin-markdown": "^3.15.3",
|
|
32
34
|
"typescript": "^5.1.3"
|
|
33
35
|
},
|
|
34
36
|
"dependencies": {
|
|
@@ -41,4 +43,4 @@
|
|
|
41
43
|
"license": "MIT",
|
|
42
44
|
"homepage": "https://hexagram.io",
|
|
43
45
|
"author": "Hexagram <admin@hexagram.io> (https:/hexagram.io/)"
|
|
44
|
-
}
|
|
46
|
+
}
|