foxx-builder/manifest.json at master · skitsanos/foxx-builder · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
{
  "$schema": "http://json.schemastore.org/foxx-manifest",
  "name": "foxx-service",
  "version": "2.4.0",
  "author": "Skitsanos",
  "main": "src/index.js",
  "scripts": {
    "setup": "src/setup.js",
    "telegram_chat_message": "src/scripts/telegram_chat_message.js"
  },
  "engines": {
    "arangodb": "^3.0.0"
  },
  "configuration": {
    "useAuth": {
      "default": false,
      "type": "boolean",
      "description": "Whether to enable JWT authentication middleware"
    },
    "emailProviders": {
      "type": "json",
      "default": {
        "default": "resend",
        "resend": {
          "apiKey": "re_",
          "defaultFrom": "Foxx Builder <noreply@example.com>"
        }
      },
      "description": "Email provider configurations"
    },
    "emailEnabled": {
      "default": false,
      "type": "boolean",
      "description": "Whether to enable email sending functionality"
    },
    "jwtSecret": {
      "type": "string",
      "default": "SuperSecretWord"
    },
    "authExemptPaths": {
      "type": "json",
      "default": ["/*", "/login", "/signup", "/status", "/health"],
      "description": "Paths exempt from authentication (supports wildcards with *)"
    },
    "showExecTime": {
      "default": false,
      "type": "boolean"
    },
    "sessionTtl": {
      "default": 3600,
      "type": "integer",
      "description": "The time in seconds since the last update until a session will be considered expired"
    },
    "useTokenExpiration": {
      "default": true,
      "type": "boolean",
      "description": "Whether tokens should expire. If false, tokens will never expire."
    },
    "useRefreshTokens": {
      "default": false,
      "type": "boolean",
      "description": "Whether to use refresh tokens for extending session lifetime."
    },
    "refreshTokenTtl": {
      "default": 2592000,
      "type": "integer",
      "description": "The time in seconds until a refresh token expires (default: 30 days)"
    },
    "googleAnalyticsId": {
      "default": "G-Y32FMJEM1W",
      "type": "string",
      "description": "Google Analytics Measurement ID"
    },
    "telegramToken": {
      "default": "xyz",
      "type": "string",
      "description": "Telegram bot token, ref: https://core.telegram.org/bots/api#authorizing-your-bot"
    },
    "useRateLimiting": {
      "default": false,
      "type": "boolean",
      "description": "Whether to enable rate limiting middleware"
    },
    "requestsPerMinute": {
      "default": 60,
      "type": "integer",
      "description": "Maximum number of requests allowed per minute per client"
    },
    "rateLimitExemptPaths": {
      "type": "json",
      "default": ["/status", "/health"],
      "description": "Paths exempt from rate limiting (supports wildcards with *)"
    },
    "rateLimitExemptRoles": {
      "type": "json",
      "default": ["admin"],
      "description": "User roles exempt from rate limiting"
    }
  }
}