@managani/express 0.1.0

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.
Files changed (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +55 -0
  3. package/index.js +63 -0
  4. package/package.json +40 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Helpmonks
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # @managani/express
2
+
3
+ Express middleware for Managani activity tracking.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install @managani/express
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```js
14
+ const { managaniTracking } = require('@managani/express');
15
+
16
+ app.use(managaniTracking({
17
+ baseUrl: process.env.MANAGANI_URL,
18
+ projectKey: process.env.MANAGANI_PUBLIC_KEY,
19
+ projectSecret: process.env.MANAGANI_PROJECT_SECRET,
20
+ getUser(req) {
21
+ return req.user;
22
+ },
23
+ getMetadata(req) {
24
+ return {
25
+ page: req.originalUrl,
26
+ app_instance: process.env.APP_INSTANCE,
27
+ };
28
+ },
29
+ }));
30
+
31
+ app.post('/checkout', async function(req, res) {
32
+ await req.managani.track('checkout_started', {
33
+ metadata: {
34
+ plan: req.body.plan,
35
+ },
36
+ });
37
+ res.sendStatus(204);
38
+ });
39
+ ```
40
+
41
+ ## Request API
42
+
43
+ The middleware attaches `req.managani`.
44
+
45
+ ### `req.managani.track(event, data, user)`
46
+
47
+ Tracks an event for the resolved request user, or an explicit user.
48
+
49
+ ### `req.managani.signUser(user)`
50
+
51
+ Returns a signed widget user token.
52
+
53
+ ## License
54
+
55
+ MIT
package/index.js ADDED
@@ -0,0 +1,63 @@
1
+ const { createManaganiClient, signUser, normalizeUser } = require('@managani/node');
2
+
3
+ function managaniTracking(options) {
4
+ const config = options || {};
5
+ const client = createManaganiClient(config);
6
+ return function managaniTrackingMiddleware(req, res, next) {
7
+ req.managani = buildRequestApi(client, config, req);
8
+ if (!config.autoTrack) return next();
9
+ next();
10
+ if (!shouldAutoTrack(config, req)) return;
11
+ req.managani.track(resolveEvent(config, req), resolveMetadata(config, req)).catch(function(error) {
12
+ const logger = resolveOption(config.logger);
13
+ if (logger && typeof logger.error === 'function') {
14
+ logger.error('Managani auto tracking failed:', error.message || error);
15
+ }
16
+ });
17
+ };
18
+ }
19
+
20
+ function buildRequestApi(client, config, req) {
21
+ return {
22
+ client,
23
+ signUser(user, options) {
24
+ return client.signUser(user || resolveUser(config, req), options);
25
+ },
26
+ track(event, data, user) {
27
+ return client.track(user || resolveUser(config, req), event, {
28
+ ...resolveMetadata(config, req),
29
+ ...(data || {}),
30
+ });
31
+ },
32
+ };
33
+ }
34
+
35
+ function shouldAutoTrack(config, req) {
36
+ if (typeof config.shouldTrack === 'function') return config.shouldTrack(req) !== false;
37
+ return true;
38
+ }
39
+
40
+ function resolveUser(config, req) {
41
+ return typeof config.getUser === 'function' ? config.getUser(req) : req.user;
42
+ }
43
+
44
+ function resolveEvent(config, req) {
45
+ if (typeof config.getEvent === 'function') return config.getEvent(req);
46
+ return req.method === 'GET' ? 'pageview' : 'user_action';
47
+ }
48
+
49
+ function resolveMetadata(config, req) {
50
+ const metadata = typeof config.getMetadata === 'function' ? config.getMetadata(req) : {};
51
+ return metadata || {};
52
+ }
53
+
54
+ function resolveOption(value) {
55
+ return typeof value === 'function' ? value() : value;
56
+ }
57
+
58
+ module.exports = {
59
+ createManaganiClient,
60
+ managaniTracking,
61
+ signUser,
62
+ normalizeUser,
63
+ };
package/package.json ADDED
@@ -0,0 +1,40 @@
1
+ {
2
+ "name": "@managani/express",
3
+ "version": "0.1.0",
4
+ "description": "Express middleware for Managani tracking",
5
+ "main": "index.js",
6
+ "type": "commonjs",
7
+ "license": "MIT",
8
+ "files": [
9
+ "index.js",
10
+ "README.md",
11
+ "LICENSE"
12
+ ],
13
+ "keywords": [
14
+ "managani",
15
+ "express",
16
+ "middleware",
17
+ "tracking",
18
+ "analytics"
19
+ ],
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/kumbukum/managani.git",
23
+ "directory": "packages/express"
24
+ },
25
+ "bugs": {
26
+ "url": "https://github.com/kumbukum/managani/issues"
27
+ },
28
+ "publishConfig": {
29
+ "access": "public"
30
+ },
31
+ "engines": {
32
+ "node": ">=18"
33
+ },
34
+ "dependencies": {
35
+ "@managani/node": "^0.1.0"
36
+ },
37
+ "peerDependencies": {
38
+ "express": ">=4"
39
+ }
40
+ }