o2g-node-sdk 2.5.1 → 2.5.2
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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../src/subscription.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../src/subscription.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAchE,cAAM,WAAW;IACb,OAAO,CAAC,SAAS,CAAa;;IAM9B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;IAIjC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,YAAY;CAGvD;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,OAAO;IACpB;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAE/C;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,EAAE,MAAM,OAAO,CAAC;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAElD;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,EAAE,MAAM,OAAO,CAAC;IAEtC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,yBAAyB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAwB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;OAiBG;IACH,2BAA2B,EAAE,MAAM,OAAO,CAAC;IAE3C;;;;;;;;OAQG;IACH,6BAA6B,EAAE,MAAM,OAAO,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,EAAE,MAAM,OAAO,CAAC;IAEpC;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;IAEvC;;;;;OAKG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;IAEvC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;IAE1C;;;;OAIG;IACH,KAAK,EAAE,MAAM,YAAY,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,8BAAsB,YAAY;IAC9B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAiB;IAYjC,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,MAAM,IAAI,WAAW,CAExB;IAED,IAAI,OAAO,IAAI,OAAO,GAAG,IAAI,CAE5B;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,CAgGlB;CACR"}
|
|
@@ -76,4 +76,50 @@ export interface EventMap {
|
|
|
76
76
|
OnRouteRequest: OnRouteRequest;
|
|
77
77
|
OnRouteEnd: OnRouteEnd;
|
|
78
78
|
}
|
|
79
|
+
/**
|
|
80
|
+
* Dispatches O2G events received on a Webhook endpoint to the SDK event system.
|
|
81
|
+
* <p>
|
|
82
|
+
* When a subscription is created with a Webhook URL, the SDK initialises an
|
|
83
|
+
* `EventDispatcher` instance that the application must use to forward incoming
|
|
84
|
+
* HTTP event payloads into the SDK.
|
|
85
|
+
* <p>
|
|
86
|
+
* The dispatcher is provided by the SDK after a successful
|
|
87
|
+
* {@link O2G.subscribe} call with a Webhook-based subscription. The application
|
|
88
|
+
* is responsible for exposing the Webhook endpoint and calling
|
|
89
|
+
* {@link dispatch} for each received request body.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```typescript
|
|
93
|
+
* // Set up the Webhook endpoint in your Express application
|
|
94
|
+
* app.post('/events', (req: Request, res: Response) => {
|
|
95
|
+
* if (!dispatcher) {
|
|
96
|
+
* res.status(404).send();
|
|
97
|
+
* } else {
|
|
98
|
+
* dispatcher.dispatch(req.body);
|
|
99
|
+
* res.status(200).send();
|
|
100
|
+
* }
|
|
101
|
+
* });
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
104
|
+
* @see O2G.subscribe
|
|
105
|
+
*/
|
|
106
|
+
export interface EventDispatcher {
|
|
107
|
+
/**
|
|
108
|
+
* Dispatches an event payload received on the Webhook endpoint into the SDK.
|
|
109
|
+
* <p>
|
|
110
|
+
* The payload must be the raw JSON body of the HTTP POST request sent by
|
|
111
|
+
* the O2G server to the Webhook URL. The SDK will parse the event name and
|
|
112
|
+
* route it to the appropriate registered listeners.
|
|
113
|
+
* <p>
|
|
114
|
+
* If the dispatcher has not been initialised — for example because no
|
|
115
|
+
* subscription is active — the application should return an HTTP `404`
|
|
116
|
+
* response and not call this method.
|
|
117
|
+
*
|
|
118
|
+
* @param event the raw event payload from the Webhook HTTP request body
|
|
119
|
+
*/
|
|
120
|
+
dispatch(event: {
|
|
121
|
+
eventName: keyof EventMap;
|
|
122
|
+
[key: string]: any;
|
|
123
|
+
}): void;
|
|
124
|
+
}
|
|
79
125
|
//# sourceMappingURL=events.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/types/events/events.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AACrF,OAAO,EACH,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,yBAAyB,EAC5B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACxG,OAAO,EACH,gCAAgC,EAChC,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,iBAAiB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EACH,WAAW,EACX,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EACH,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,UAAU,EACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,aAAa,EACb,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAExF;;;;;GAKG;AACH,qBAAa,oBAAoB;;IAG7B,OAAO;IAgBP;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACJ;AAED,MAAM,WAAW,QAAQ;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAG3C,qBAAqB,EAAE,qBAAqB,CAAC;IAG7C,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,aAAa,CAAC;IAG7B,aAAa,EAAE,aAAa,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,mBAAmB,EAAE,mBAAmB,CAAC;IAGzC,qBAAqB,EAAE,qBAAqB,CAAC;IAG7C,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,eAAe,EAAE,eAAe,CAAC;IACjC,iBAAiB,EAAE,iBAAiB,CAAC;IAGrC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,oBAAoB,EAAE,oBAAoB,CAAC;IAG3C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,2BAA2B,EAAE,2BAA2B,CAAC;IAGzD,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,yBAAyB,EAAE,yBAAyB,CAAC;IAGrD,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,kBAAkB,EAAE,kBAAkB,CAAC;IAGvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,mBAAmB,EAAE,gCAAgC,CAAC;IACtD,mBAAmB,EAAE,gCAAgC,CAAC;IACtD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,iBAAiB,EAAE,iBAAiB,CAAC;IAGrC,kBAAkB,EAAE,kBAAkB,CAAC;IAGvC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CAC1B"}
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/types/events/events.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AACrF,OAAO,EACH,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,yBAAyB,EAC5B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACxG,OAAO,EACH,gCAAgC,EAChC,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,iBAAiB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EACH,WAAW,EACX,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EACH,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,UAAU,EACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,aAAa,EACb,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAExF;;;;;GAKG;AACH,qBAAa,oBAAoB;;IAG7B,OAAO;IAgBP;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACJ;AAED,MAAM,WAAW,QAAQ;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAG3C,qBAAqB,EAAE,qBAAqB,CAAC;IAG7C,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,aAAa,CAAC;IAG7B,aAAa,EAAE,aAAa,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,mBAAmB,EAAE,mBAAmB,CAAC;IAGzC,qBAAqB,EAAE,qBAAqB,CAAC;IAG7C,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,eAAe,EAAE,eAAe,CAAC;IACjC,iBAAiB,EAAE,iBAAiB,CAAC;IAGrC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,oBAAoB,EAAE,oBAAoB,CAAC;IAG3C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,2BAA2B,EAAE,2BAA2B,CAAC;IAGzD,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,yBAAyB,EAAE,yBAAyB,CAAC;IAGrD,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,kBAAkB,EAAE,kBAAkB,CAAC;IAGvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,mBAAmB,EAAE,gCAAgC,CAAC;IACtD,mBAAmB,EAAE,gCAAgC,CAAC;IACtD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,iBAAiB,EAAE,iBAAiB,CAAC;IAGrC,kBAAkB,EAAE,kBAAkB,CAAC;IAGvC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CAC1B;AAGD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,eAAe;IAE5B;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;CAC5E"}
|
package/package.json
CHANGED