nucleus-core-ts 0.8.0

package/schemas/config.nucleus.json

@@ -0,0 +1,1010 @@
+{
+	"$id": "config.nucleus.json",
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"title": "Nucleus Config",
+	"description": "Generated from NucleusConfigOptions interface in types.ts",
+	"type": "object",
+	"properties": {
+		"$schema": {
+			"type": "string",
+			"description": "JSON Schema reference"
+		},
+		"appId": {
+			"type": "string",
+			"description": "Application ID",
+			"minLength": 1
+		},
+		"mode": {
+			"type": "string",
+			"enum": ["development", "production"],
+			"default": "development"
+		},
+		"database": {
+			"type": "object",
+			"properties": {
+				"url": {
+					"type": "string",
+					"description": "Environment variable name for database URL"
+				},
+				"type": {
+					"type": "string",
+					"enum": ["postgres"],
+					"default": "postgres"
+				},
+				"isMultiTenant": {
+					"type": "boolean",
+					"default": false
+				},
+				"schemas": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"default": ["main"]
+				},
+				"allowDataLoss": {
+					"type": "boolean",
+					"default": false
+				}
+			}
+		},
+		"redis": {
+			"type": "object",
+			"properties": {
+				"url": {
+					"type": "string",
+					"description": "Environment variable name for Redis URL"
+				},
+				"host": {
+					"type": "string"
+				},
+				"port": {
+					"type": "number"
+				},
+				"withDapr": {
+					"type": "boolean"
+				},
+				"stateStoreName": {
+					"type": "string"
+				}
+			}
+		},
+		"authentication": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean",
+					"default": false
+				},
+				"accessToken": {
+					"type": "object",
+					"properties": {
+						"secret": {
+							"type": "string",
+							"description": "Environment variable name for JWT secret"
+						},
+						"expiresIn": {
+							"type": "string",
+							"description": "Token expiration (e.g., \"15m\", \"7d\")"
+						},
+						"algorithm": {
+							"type": "string",
+							"enum": [
+								"HS256",
+								"HS384",
+								"HS512",
+								"RS256",
+								"RS384",
+								"RS512",
+								"ES256",
+								"ES384",
+								"ES512",
+								"PS256",
+								"PS384",
+								"PS512"
+							],
+							"description": "JWT algorithm"
+						},
+						"issuer": {
+							"type": "string",
+							"description": "Token issuer"
+						},
+						"audience": {
+							"type": "string",
+							"description": "Token audience"
+						},
+						"name": {
+							"type": "string",
+							"description": "Cookie name"
+						},
+						"setHeadersEnabled": {
+							"type": "boolean",
+							"description": "Set token in response headers"
+						},
+						"returnJson": {
+							"type": "boolean",
+							"description": "Return token in JSON response"
+						}
+					}
+				},
+				"refreshToken": {
+					"type": "object",
+					"properties": {
+						"secret": {
+							"type": "string",
+							"description": "Environment variable name for JWT secret"
+						},
+						"expiresIn": {
+							"type": "string",
+							"description": "Token expiration (e.g., \"15m\", \"7d\")"
+						},
+						"algorithm": {
+							"type": "string",
+							"enum": [
+								"HS256",
+								"HS384",
+								"HS512",
+								"RS256",
+								"RS384",
+								"RS512",
+								"ES256",
+								"ES384",
+								"ES512",
+								"PS256",
+								"PS384",
+								"PS512"
+							],
+							"description": "JWT algorithm"
+						},
+						"issuer": {
+							"type": "string",
+							"description": "Token issuer"
+						},
+						"audience": {
+							"type": "string",
+							"description": "Token audience"
+						},
+						"name": {
+							"type": "string",
+							"description": "Cookie name"
+						},
+						"setHeadersEnabled": {
+							"type": "boolean",
+							"description": "Set token in response headers"
+						},
+						"returnJson": {
+							"type": "boolean",
+							"description": "Return token in JSON response"
+						}
+					}
+				},
+				"sessionToken": {
+					"type": "object",
+					"properties": {
+						"secret": {
+							"type": "string",
+							"description": "Environment variable name for JWT secret"
+						},
+						"expiresIn": {
+							"type": "string",
+							"description": "Token expiration (e.g., \"15m\", \"7d\")"
+						},
+						"algorithm": {
+							"type": "string",
+							"enum": [
+								"HS256",
+								"HS384",
+								"HS512",
+								"RS256",
+								"RS384",
+								"RS512",
+								"ES256",
+								"ES384",
+								"ES512",
+								"PS256",
+								"PS384",
+								"PS512"
+							],
+							"description": "JWT algorithm"
+						},
+						"issuer": {
+							"type": "string",
+							"description": "Token issuer"
+						},
+						"audience": {
+							"type": "string",
+							"description": "Token audience"
+						},
+						"name": {
+							"type": "string",
+							"description": "Cookie name"
+						},
+						"setHeadersEnabled": {
+							"type": "boolean",
+							"description": "Set token in response headers"
+						},
+						"returnJson": {
+							"type": "boolean",
+							"description": "Return token in JSON response"
+						}
+					}
+				},
+				"login": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string"
+						},
+						"rememberMe": {
+							"type": "boolean"
+						},
+						"isPublic": {
+							"type": "boolean"
+						},
+						"enabled": {
+							"type": "boolean"
+						}
+					}
+				},
+				"register": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string",
+							"description": "Custom route path"
+						},
+						"isPublic": {
+							"type": "boolean",
+							"description": "Route is public (no auth required)"
+						},
+						"enabled": {
+							"type": "boolean",
+							"description": "Route is enabled"
+						}
+					}
+				},
+				"logout": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string",
+							"description": "Custom route path"
+						},
+						"isPublic": {
+							"type": "boolean",
+							"description": "Route is public (no auth required)"
+						},
+						"enabled": {
+							"type": "boolean",
+							"description": "Route is enabled"
+						}
+					}
+				},
+				"refresh": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string",
+							"description": "Custom route path"
+						},
+						"isPublic": {
+							"type": "boolean",
+							"description": "Route is public (no auth required)"
+						},
+						"enabled": {
+							"type": "boolean",
+							"description": "Route is enabled"
+						}
+					}
+				},
+				"passwordReset": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string"
+						},
+						"isPublic": {
+							"type": "boolean"
+						},
+						"enabled": {
+							"type": "boolean"
+						},
+						"redirectUrl": {
+							"type": "string"
+						}
+					}
+				},
+				"passwordChange": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string",
+							"description": "Custom route path"
+						},
+						"isPublic": {
+							"type": "boolean",
+							"description": "Route is public (no auth required)"
+						},
+						"enabled": {
+							"type": "boolean",
+							"description": "Route is enabled"
+						}
+					}
+				},
+				"sessions": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string"
+						},
+						"isPublic": {
+							"type": "boolean"
+						},
+						"enabled": {
+							"type": "boolean"
+						},
+						"maxActiveSessions": {
+							"type": "number"
+						},
+						"inactivityTimeout": {
+							"type": "string"
+						},
+						"allowMultipleDevices": {
+							"type": "boolean"
+						},
+						"trustNewDevices": {
+							"type": "boolean"
+						},
+						"notifyOnNewDevice": {
+							"type": "boolean"
+						}
+					}
+				},
+				"magicLink": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string"
+						},
+						"verifyRoute": {
+							"type": "string"
+						},
+						"isPublic": {
+							"type": "boolean"
+						},
+						"enabled": {
+							"type": "boolean"
+						},
+						"expiresIn": {
+							"type": "string"
+						},
+						"redirectUrl": {
+							"type": "string"
+						}
+					}
+				},
+				"me": {
+					"type": "object",
+					"properties": {
+						"route": {
+							"type": "string"
+						},
+						"isPublic": {
+							"type": "boolean"
+						},
+						"enabled": {
+							"type": "boolean"
+						},
+						"includeProfile": {
+							"type": "boolean"
+						},
+						"includeAddresses": {
+							"type": "boolean"
+						},
+						"includePhones": {
+							"type": "boolean"
+						},
+						"includeFiles": {
+							"type": "boolean"
+						}
+					}
+				}
+			}
+		},
+		"authorization": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean",
+					"default": false
+				},
+				"autoSeedClaims": {
+					"type": "boolean",
+					"default": true
+				},
+				"skipTables": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"skipColumns": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"excludedPaths": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"publicPaths": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"godminEmail": {
+					"type": "string"
+				},
+				"godminPassword": {
+					"type": "string"
+				}
+			}
+		},
+		"audit": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean",
+					"default": false
+				},
+				"actions": {
+					"type": "object",
+					"properties": {
+						"GET": {
+							"type": "boolean"
+						},
+						"INSERT": {
+							"type": "boolean"
+						},
+						"UPDATE": {
+							"type": "boolean"
+						},
+						"DELETE": {
+							"type": "boolean"
+						},
+						"TOGGLE": {
+							"type": "boolean"
+						},
+						"VERIFICATION": {
+							"type": "boolean"
+						}
+					}
+				}
+			}
+		},
+		"verification": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean"
+				},
+				"autoResetOnRejection": {
+					"type": "boolean"
+				},
+				"requireSignatureByDefault": {
+					"type": "boolean"
+				},
+				"diffTrackingEnabled": {
+					"type": "boolean"
+				},
+				"endpoints": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"basePath": {
+							"type": "string"
+						}
+					}
+				}
+			}
+		},
+		"notification": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean"
+				},
+				"portalEnabled": {
+					"type": "boolean"
+				},
+				"emailEnabled": {
+					"type": "boolean"
+				},
+				"defaultChannel": {
+					"type": "string",
+					"enum": ["portal", "email", "both"]
+				},
+				"templateVariables": {
+					"type": "object",
+					"additionalProperties": {
+						"type": "string"
+					}
+				}
+			}
+		},
+		"rateLimit": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean"
+				},
+				"strategy": {
+					"type": "string",
+					"enum": ["sliding-window", "fixed-window", "token-bucket"]
+				},
+				"keyPrefix": {
+					"type": "string"
+				},
+				"authRoutes": {
+					"type": "object",
+					"properties": {
+						"window": {
+							"type": "string"
+						},
+						"max": {
+							"type": "number"
+						},
+						"login": {
+							"type": "object",
+							"properties": {
+								"window": {
+									"type": "string",
+									"description": "Time window (e.g., \"1m\", \"1h\")"
+								},
+								"max": {
+									"type": "number",
+									"description": "Maximum requests in window"
+								},
+								"blockDuration": {
+									"type": "string",
+									"description": "Block duration after limit exceeded"
+								}
+							}
+						},
+						"register": {
+							"type": "object",
+							"properties": {
+								"window": {
+									"type": "string",
+									"description": "Time window (e.g., \"1m\", \"1h\")"
+								},
+								"max": {
+									"type": "number",
+									"description": "Maximum requests in window"
+								},
+								"blockDuration": {
+									"type": "string",
+									"description": "Block duration after limit exceeded"
+								}
+							}
+						},
+						"passwordReset": {
+							"type": "object",
+							"properties": {
+								"window": {
+									"type": "string",
+									"description": "Time window (e.g., \"1m\", \"1h\")"
+								},
+								"max": {
+									"type": "number",
+									"description": "Maximum requests in window"
+								},
+								"blockDuration": {
+									"type": "string",
+									"description": "Block duration after limit exceeded"
+								}
+							}
+						},
+						"magicLink": {
+							"type": "object",
+							"properties": {
+								"window": {
+									"type": "string",
+									"description": "Time window (e.g., \"1m\", \"1h\")"
+								},
+								"max": {
+									"type": "number",
+									"description": "Maximum requests in window"
+								},
+								"blockDuration": {
+									"type": "string",
+									"description": "Block duration after limit exceeded"
+								}
+							}
+						}
+					}
+				},
+				"publicRoutes": {
+					"type": "object",
+					"properties": {
+						"window": {
+							"type": "string"
+						},
+						"max": {
+							"type": "number"
+						}
+					}
+				},
+				"privateRoutes": {
+					"type": "object",
+					"properties": {
+						"window": {
+							"type": "string"
+						},
+						"max": {
+							"type": "number"
+						}
+					}
+				},
+				"byIp": {
+					"type": "boolean"
+				},
+				"byUserId": {
+					"type": "boolean"
+				},
+				"byEndpoint": {
+					"type": "boolean"
+				},
+				"skipSuccessfulRequests": {
+					"type": "boolean"
+				},
+				"headers": {
+					"type": "object",
+					"properties": {
+						"remaining": {
+							"type": "string"
+						},
+						"reset": {
+							"type": "string"
+						},
+						"limit": {
+							"type": "string"
+						}
+					}
+				},
+				"whitelist": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"blacklist": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			}
+		},
+		"monitoring": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean"
+				},
+				"system": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"collectInterval": {
+							"type": "string"
+						},
+						"metrics": {
+							"type": "object",
+							"properties": {
+								"cpu": {
+									"type": "boolean"
+								},
+								"memory": {
+									"type": "boolean"
+								},
+								"disk": {
+									"type": "boolean"
+								},
+								"network": {
+									"type": "boolean"
+								},
+								"process": {
+									"type": "boolean"
+								}
+							}
+						}
+					}
+				},
+				"application": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"metrics": {
+							"type": "object",
+							"properties": {
+								"requests": {
+									"type": "boolean"
+								},
+								"responseTime": {
+									"type": "boolean"
+								},
+								"errors": {
+									"type": "boolean"
+								},
+								"rateLimits": {
+									"type": "boolean"
+								}
+							}
+						}
+					}
+				},
+				"database": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"metrics": {
+							"type": "object",
+							"properties": {
+								"connections": {
+									"type": "boolean"
+								},
+								"queryTime": {
+									"type": "boolean"
+								},
+								"slowQueryThreshold": {
+									"type": "string"
+								}
+							}
+						}
+					}
+				},
+				"redis": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						}
+					}
+				},
+				"persistence": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"flushInterval": {
+							"type": "string"
+						},
+						"retentionDays": {
+							"type": "number"
+						}
+					}
+				},
+				"alerts": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"email": {
+							"type": "object",
+							"properties": {
+								"enabled": {
+									"type": "boolean"
+								},
+								"recipients": {
+									"type": "array",
+									"items": {
+										"type": "string"
+									}
+								}
+							}
+						},
+						"thresholds": {
+							"type": "object",
+							"properties": {
+								"cpuPercent": {
+									"type": "number"
+								},
+								"memoryPercent": {
+									"type": "number"
+								},
+								"diskPercent": {
+									"type": "number"
+								},
+								"errorRatePercent": {
+									"type": "number"
+								},
+								"responseTimeMs": {
+									"type": "number"
+								},
+								"rateLimitBlocksPerMinute": {
+									"type": "number"
+								}
+							}
+						},
+						"cooldown": {
+							"type": "string"
+						}
+					}
+				},
+				"endpoints": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"basePath": {
+							"type": "string"
+						},
+						"stream": {
+							"type": "object",
+							"properties": {
+								"enabled": {
+									"type": "boolean"
+								},
+								"path": {
+									"type": "string"
+								},
+								"interval": {
+									"type": "string"
+								}
+							}
+						},
+						"snapshot": {
+							"type": "object",
+							"properties": {
+								"enabled": {
+									"type": "boolean"
+								},
+								"path": {
+									"type": "string"
+								}
+							}
+						},
+						"history": {
+							"type": "object",
+							"properties": {
+								"enabled": {
+									"type": "boolean"
+								},
+								"path": {
+									"type": "string"
+								},
+								"maxMinutes": {
+									"type": "number"
+								}
+							}
+						},
+						"alerts": {
+							"type": "object",
+							"properties": {
+								"enabled": {
+									"type": "boolean"
+								},
+								"path": {
+									"type": "string"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"email": {
+			"type": "object",
+			"properties": {
+				"gmail": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"json_file_path": {
+							"type": "string"
+						},
+						"from_email": {
+							"type": "string"
+						},
+						"from_name": {
+							"type": "string"
+						}
+					}
+				}
+			}
+		},
+		"storage": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean"
+				},
+				"basePath": {
+					"type": "string"
+				},
+				"maxFileSizeBytes": {
+					"type": "number"
+				},
+				"allowedMimeTypes": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"blockedMimeTypes": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"cdn": {
+					"type": "object",
+					"properties": {
+						"enabled": {
+							"type": "boolean"
+						},
+						"basePath": {
+							"type": "string"
+						},
+						"cacheMaxAge": {
+							"type": "number"
+						},
+						"enableRangeRequests": {
+							"type": "boolean"
+						},
+						"enableEtag": {
+							"type": "boolean"
+						},
+						"corsOrigins": {
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						}
+					}
+				},
+				"formData": {
+					"type": "object",
+					"properties": {
+						"filesField": {
+							"type": "string"
+						},
+						"dataField": {
+							"type": "string"
+						},
+						"maxFiles": {
+							"type": "number"
+						}
+					}
+				}
+			}
+		},
+		"entities": {
+			"type": "array",
+			"description": "Entity/table definitions",
+			"items": {
+				"$ref": "table.schema.json"
+			}
+		}
+	},
+	"required": ["appId", "entities"],
+	"additionalProperties": false
+}