Document not found (404)
-This URL is invalid, sorry. Please use the navigation bar or search to continue.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/book/design.html b/docs/book/design.html
deleted file mode 100644
index 154eec3..0000000
--- a/docs/book/design.html
+++ /dev/null
@@ -1,875 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Configuration (
-The
-Version Tracking (
-
-
-
-
-
-
-
-
-
-
- Database Migrations
-Nova provides a simple, file-based database migration tool accessible directly through the nova command-line binary. It allows you to manage database schema changes using plain SQL files stored in a dedicated folder, driven by simple commands.
-
-
- CLI Driven: Manage migrations using
nova migrate <action>.
- - Plain SQL: Write standard SQL for your target database. -
- Version Tracking: Automatically tracks the applied migration version in a dedicated schema table. -
- Up/Down Migrations: Each migration file contains SQL for both applying (
up) and reverting (down) the change.
- - Timestamp-Based Ordering: Migration files are ordered based on a timestamp prefix in their filename. -
- Step Control: Apply or roll back all pending migrations or a specific number of steps via command arguments. -
- Environment Configuration: Reads database connection details from the
DATABASE_URLenvironment variable (supports.envfiles).
- - Driver Detection: Automatically detects the database driver (
postgres,mysql,sqlite) based on theDATABASE_URLprefix.
- - Low dependencies: Relies only on the Go standard library and database drivers for Postgres, MySQL/MariaDB and SQLite. -
Table of Contents
--
-
- Getting Started -
- Configuration (
DATABASE_URL)
- - Core Concepts - - -
- CLI Commands - - -
- Programmatic Usage (Advanced) - - -
Getting Started
--
-
-
-
Set
-DATABASE_URL: Ensure theDATABASE_URLenvironment variable is set correctly for your target database. You can also place it in a.envfile in the directory where you runnova.
-# Example for PostgreSQL -export DATABASE_URL="postgres://user:password@host:port/dbname?sslmode=disable" - -# Example for SQLite -export DATABASE_URL="file:./my_app_data.db" -
- -
-
Create the
-migrationsFolder: In the root of your project (or where you runnova), create the folder:
-mkdir migrations -
- -
-
Create Your First Migration: Use the
-newcommand:
-nova migrate new create_users_table -# Output: Created new migration: migrations/1678886400_create_users_table.sql (timestamp will vary) -
- -
-
Edit the SQL File: Open the generated
-.sqlfile and add your SQL statements under the appropriate delimiters:
--- migrations/1678886400_create_users_table.sql - --- migrate:up -CREATE TABLE users ( - id SERIAL PRIMARY KEY, - username VARCHAR(50) UNIQUE NOT NULL, - created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP -); - --- migrate:down -DROP TABLE IF EXISTS users; -
- -
-
Apply the Migration: Use the
-upcommand:
-nova migrate up -# Output: Applied migration migrations/1678886400_create_users_table.sql -# Output: Successfully applied 1 migration(s). -Your database schema is now updated!
-
-
Configuration (DATABASE_URL)
-The nova migrate command requires the DATABASE_URL environment variable to connect to your database.
-
-
- Format: Use a standard DSN (Data Source Name) URL format. -
- Supported Drivers (Auto-Detected):
-
-
-
- PostgreSQL (
postgres://...)
- - MySQL (
mysql://...)
- - SQLite (
file:...or path ending in.db)
-
- - PostgreSQL (
.envFile: If a.envfile exists in the current directory,nova migratewill attempt to load environment variables from it. Variables already present in the environment take precedence.
-
Core Concepts
-These concepts explain how the migration files and tracking work.
-The migrations Folder
--
-
- Must be named
migrations.
- - Must exist in the directory where you execute the
nova migratecommand or call the programmatic functions.
- - Contains all your
.sqlmigration files.
-
Migration File Naming
--
-
- Format:
<version>_<descriptive_name>.sql
- <version>: An integer, typically a Unix timestamp (e.g.,1678886400), used for ordering. Generated automatically bynova migrate new.
-<descriptive_name>: Briefly explains the migration’s purpose (e.g.,create_users_table).
-
Migration File Structure
--
-
- Plain SQL file (
.sql).
- - Must contain
-- migrate:upand-- migrate:downdelimiters.
- - SQL statements under
-- migrate:upare executed bynova migrate up.
- - SQL statements under
-- migrate:downare executed bynova migrate down.
-
-- migrations/TIMESTAMP_add_email_to_users.sql
-
--- migrate:up
-ALTER TABLE users ADD COLUMN email VARCHAR(255) UNIQUE;
-CREATE INDEX idx_users_email ON users(email);
-
--- migrate:down
-DROP INDEX IF EXISTS idx_users_email;
-ALTER TABLE users DROP COLUMN IF EXISTS email;
-Version Tracking (schema_version table)
--
-
- The first time
nova migrate upornova migrate downruns (either via CLI or programmatically), it automatically creates a table namedschema_versionin your database.
- - This table stores the
<version>number of the most recently applied migration.
- - The migration commands use this table to determine which migrations need to be applied or rolled back. -
CLI Commands
-Manage your database schema using these subcommands of nova migrate.
nova migrate new
-Creates a new migration file skeleton.
--
-
- Syntax:
nova migrate new <migration_name>
- - Arguments:
-
-
-
<migration_name>(Required): A descriptive name for the migration (e.g.,add_indexes_to_orders). Use underscores for spaces.
-
- - Behavior:
-
-
-
- Creates the
migrationsfolder if needed.
- - Generates a filename:
<timestamp>_<migration_name>.sql.
- - Writes the basic
-- migrate:upand-- migrate:downtemplate into the file.
-
- - Creates the
- Example:
-
-nova migrate new add_last_login_to_users -# Creates migrations/1678886402_add_last_login_to_users.sql (example) -
-
nova migrate up
-Applies pending migrations to the database.
--
-
-
-
Syntax:
-nova migrate up [steps]
- -
-
Arguments:
--
-
[steps](Optional): An integer specifying the maximum number of migrations to apply. If omitted or0, applies all pending migrations.
-
- -
-
Behavior:
--
-
- Connects to the database using
DATABASE_URL.
- - Reads the current version from the
schema_versiontable.
- - Finds all
.sqlfiles in themigrationsfolder with a version greater than the current version.
- - Sorts these pending migrations chronologically. -
- Executes the SQL statements under
-- migrate:upfor each pending migration, up to the specified[steps]limit.
- - Updates the
schema_versiontable after each successful migration file application.
- - Prints status messages. -
- - Connects to the database using
-
-
Examples:
-
-# Apply all pending migrations -nova migrate up - -# Apply only the next 2 pending migrations -nova migrate up 2 -
-
nova migrate down
-Rolls back previously applied migrations.
--
-
-
-
Syntax:
-nova migrate down [steps]
- -
-
Arguments:
--
-
[steps](Optional): An integer specifying the exact number of migrations to roll back. If omitted or0, defaults to rolling back one migration.
-
- -
-
Behavior:
--
-
- Connects to the database using
DATABASE_URL.
- - Reads the current version from the
schema_versiontable.
- - Finds all
.sqlfiles in themigrationsfolder with a version less than or equal to the current version.
- - Sorts these applied migrations in reverse chronological order. -
- Executes the SQL statements under
-- migrate:downfor the most recent applied migrations, up to the specified number of[steps].
- - Updates the
schema_versiontable after each successful rollback to reflect the new latest version.
- - Prints status messages. -
- - Connects to the database using
-
-
Examples:
-
-# Roll back the single most recent migration -nova migrate down -# OR -nova migrate down 1 - -# Roll back the last 3 applied migrations -nova migrate down 3 -
-
Programmatic Usage (Advanced)
-While the nova migrate CLI command is the recommended way to manage migrations, the underlying functions are exported and can be used directly within your Go code if you need more control or want to embed migration logic into your application’s startup sequence or custom tooling.
Note: When using these functions programmatically, you are responsible for obtaining the *sql.DB database connection handle yourself. The functions do not read the DATABASE_URL environment variable out of the box.
CreateNewMigration
-func CreateNewMigration(name string) error
-Identical in behavior to the CLI’s new action, but called from Go code.
-
-
- Parameters:
-
-
-
name(string): Descriptive name for the migration.
-
- - Returns: An error if file creation fails, otherwise
nil.
-
Usage:
-import "github.com/xlc-dev/nova/nova"
-
-// ... inside your Go code ...
-err := nova.CreateNewMigration("seed_initial_data")
-if err != nil {
- log.Printf("Failed to create migration file: %v", err)
- // Handle error appropriately
-}
-MigrateUp
-func MigrateUp(db *sql.DB, steps int) error
-Identical in behavior to the CLI’s up action, but called from Go code.
-
-
- Parameters:
-
-
-
db(*sql.DB): An active database connection handle obtained viasql.Open.
-steps(int): Max number of migrations to apply (0 = all).
-
- - Returns: An error if any migration step fails, otherwise
nil.
-
Usage:
-import (
- "database/sql"
-
- _ "github.com/lib/pq" // Import your DB driver
- "github.com/xlc-dev/nova/nova"
-)
-
-// ... inside your Go code ...
-db, err := sql.Open("postgres", "your_connection_string")
-if err != nil { /* handle error */ }
-defer db.Close()
-
-log.Println("Applying database migrations...")
-// Apply all pending migrations during application startup
-err = nova.MigrateUp(db, 0)
-if err != nil {
- log.Fatalf("Database migration failed: %v", err) // Critical error on startup
-}
-log.Println("Database migrations applied successfully.")
-MigrateDown
-func MigrateDown(db *sql.DB, steps int) error
-Identical in behavior to the CLI’s down action, but called from Go code.
-
-
- Parameters:
-
-
-
db(*sql.DB): An active database connection handle.
-steps(int): Number of migrations to roll back (0 or negative = 1).
-
- - Returns: An error if any rollback step fails, otherwise
nil.
-
Usage:
-import (
- "database/sql"
-
- _ "github.com/lib/pq" // Import your DB driver
- "github.com/xlc-dev/nova/nova"
-)
-
-// ... inside custom tooling or specific Go code ...
-db, err := sql.Open("postgres", "your_connection_string")
-if err != nil { /* handle error */ }
-defer db.Close()
-
-log.Println("Rolling back the last migration...")
-// Roll back one migration
-err = nova.MigrateDown(db, 1)
-if err != nil {
- log.Printf("Rollback failed: %v", err)
- // Handle error appropriately
-} else {
- log.Println("Rollback successful.")
-}
-Important: When using these functions programmatically, the status messages (Applied migration..., Rolled back migration...) are still printed to standard output. You might want to capture/redirect stdout if integrating into a larger system where this output is undesirable.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/book/elasticlunr.min.js b/docs/book/elasticlunr.min.js
deleted file mode 100644
index 94b20dd..0000000
--- a/docs/book/elasticlunr.min.js
+++ /dev/null
@@ -1,10 +0,0 @@
-/**
- * elasticlunr - http://weixsong.github.io
- * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
- *
- * Copyright (C) 2017 Oliver Nightingale
- * Copyright (C) 2017 Wei Song
- * MIT Licensed
- * @license
- */
-!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Helper:
-Helper:
-Flow: Router Initialization (
-Flow: Route Registration (
-Flow: Group Creation & Handling (
-Flow: Middleware Registration (
-Flow: Subrouter Creation (
-Flow: Request Dispatching (
-Flow: URL Parameter Retrieval (
-Flow:
-Flow:
-Flow:
-Flow:
-Flow:
-Flow:
-Flow:
-Flow:
-
-
-
-
- Design
-This document describes the design of the Nova framework and its architecture.
-Table of Contents
--
-
- Design Philosophy - - -
- Architecture & Flow
-
-
-
- CLI - - -
- Router
-
-
-
- Main Router Operations -
- Flow: Router Initialization (
NewRouter)
- - Flow: Route Registration (
Router.Handle)
- - Flow: Group Creation & Handling (
Router.Group&Group.Handle)
- - Flow: Middleware Registration (
Router.Use)
- - Flow: Subrouter Creation (
Router.Subrouter)
- - Flow: Request Dispatching - (
Router.ServeHTTP)
- - Flow: URL Parameter Retrieval (
Router.URLParam)
-
- - Scaffolding -
- Migrations - - -
- OpenAPI - - -
-
Design Philosophy
-Nova is designed to be lightweight and flexible. It’s built on top of the standard library,
-without any external dependencies except fsnotify
-for file watching and database drivers for migrations and database/sql support.
The supported database drivers are:
- -it is very easy to add a new databse driver -to nova if requested, as long as it follows the design philosophy of the framework.
-The goal of the framework is to be modular and extensible, so it is designed to follow as many -standards as possible wihtin the Go community, with the goal being able to plug and play different components within the framework.
-Design Principles
--
-
- Minimal Dependencies: Nova is designed to have as few dependencies as possible. -
- Simplicity: Nova is designed to be simple and easy to use. Follow pattenrs that Golang developers are already familiar with. -
- Stable: Nova is designed to be stable and reliable. That is another benifit of only using the standard library which is known to be stable. -
- Reduce Boilerplate: Nova is designed to reduce boilerplate code, so the developr can focus on what is the most important: the business logic. -
- Batteries Included: Nova comes with batteries included. It comes with many components like a CLI and router, removing decision fatique, needing to write boilerplate code or installing external dependencies. -
- Undocumented features are bugs: Undocmunted code or unwritten documentation is concidered a bug, allowing for actual up to date documentation. -
Architecture & Flow
-In this chapter you will find diagrams of the architecture of the Nova framework.
-CLI
-One of the core components of the Nova framework is the CLI. -The CLI is able to parse any command line arguments and flags, and execute actions based on the provided flags.
-The overall execution flow can be broken down into several key stages:
-Main CLI Execution Flow: Initialization & Global Flags
-This initial stage of CLI.Run handles the setup and processing of global aspects of the command.
-It verifies that the CLI has been properly initialized. Then, it separates the provided arguments into global flags and the remaining arguments (which might contain a command and its specific flags).
-Global flags are parsed and validated. A special check for a --version flag is performed to allow for quick version printing without further processing.
-If global flag parsing or validation fails, the process terminates with an error. Otherwise, it proceeds to find and execute a command.
flowchart TB
- A["CLI.Run(args)"] --> B{"CLI Initialized?"}
- B -- No --> B_ERR["ERR: CLI not initialized"]
- B_ERR --> Z_END_INIT_ERR["End (Error)"]
- B -- Yes --> C["Split args: global flags & rest"]
- C --> D["Parse Global Flags (uses parseFlagSet helper)"]
- D --> D_CTX["Create initial Context (w/ globalSet)"]
- D_CTX --> E{"Global Parse Err?"}
- E -- Yes --> E_ERR["ERR: Global parse failed"]
- E_ERR --> Z_END_GLOBAL_PARSE_ERR["End (Error)"]
- E -- No --> F{"--version flag?"}
- F -- Yes --> G["Print Version"]
- G --> Z_SUCCESS_VERSION["End (Success)"]
- F -- No --> H["Validate Global Flags (uses validateFlags helper)"]
- H --> I{"Global Validate Err?"}
- I -- Yes --> I_ERR["ERR: Global validate failed"]
- I_ERR --> Z_END_GLOBAL_VALIDATE_ERR["End (Error)"]
- I -- No --> J_LINK["Proceed to: Command Search & Execution"]
-
- subgraph subGraph0_ref["Ref: parseFlagSet Helper"]
- direction TB
- REF_PF["(See 'Helper: parseFlagSet' diagram)"]
- end
-
- subgraph subGraph1_ref["Ref: validateFlags Helper"]
- direction TB
- REF_VF["(See 'Helper: validateFlags' diagram)"]
- end
-
- D -.-> REF_PF
- H -.-> REF_VF
-
-Helper: parseFlagSet
-This helper function is responsible for the mechanics of parsing a set of flags.
-It takes a list of flag definitions, the arguments to parse, a name for the flag set (often “global” or the command name), and an output stream (for help messages).
-It creates a standard flag.FlagSet instance, applies the defined flags to this set, and then calls the Parse method on the set with the provided arguments.
-It returns the populated FlagSet and any error encountered during parsing.
flowchart TB - subgraph subGraph0["Helper: parseFlagSet"] - direction TB - PF1["In: flags, args, name, out"] - PF2["Create flag.FlagSet"] - PF3["Apply Flags to Set"] - PF4["FlagSet.Parse(args)"] - PF5["Return FlagSet, err"] - end - PF1 --> PF2 - PF2 --> PF3 - PF3 --> PF4 - PF4 --> PF5 --
Helper: validateFlags
-After flags are parsed by parseFlagSet, this helper function is used to perform custom validation on each flag.
-It iterates through a list of flag definitions and, for each flag, calls its Validate method, passing in the FlagSet (which contains the parsed values).
-If any flag’s Validate method returns an error, these errors are combined and returned. If all flags validate successfully, it returns nil.
flowchart TB
- subgraph subGraph1["Helper: validateFlags"]
- direction TB
- VF1["In: flags, flagSet"]
- VF2["For each Flag"]
- VF3["Flag.Validate(flagSet)"]
- VF4{"Any Errors?"}
- VF5["Return combined err"]
- VF6["Return nil"]
- end
- VF1 --> VF2
- VF2 --> VF3
- VF3 --> VF4
- VF4 -- Yes --> VF5
- VF4 -- No --> VF6
-
-Command Processing Flow
-Once global flags are successfully parsed and validated, the CLI attempts to identify and execute a specific command.
-It searches for a command based on the first argument in restArgs (the arguments remaining after global flags). This search includes registered commands, their aliases, and a built-in help command.
If a command is found:
--
-
- If it’s the
helpcommand, the context is prepared for help output, and the help action is executed.
- - If it’s a user-defined command, its specific flags are parsed (using
parseFlagSet) and validated (usingvalidateFlags). The CLI context is updated with command-specific information. If parsing or validation fails, an error is reported. Otherwise, the command’s action is executed.
-
If no command is found matching the first argument, the flow proceeds to the fallback mechanisms.
-flowchart TB
- J_START["From: Global Flag Validation Success"] --> J_NODE
- J_NODE["Find Command (in restArgs[0]). iterates cmds, aliases, 'help'"] --> K{"Cmd Found?"}
- K -- Yes --> L{"Cmd is 'help'?"}
- L -- Yes --> M["Ctx args for 'help', Exec 'help' Action"]
- M --> Z_SUCCESS_HELP["End (Success)"]
- L -- No (User Cmd) --> N["Parse Cmd Flags (uses parseFlagSet helper)"]
- N --> N_CTX["Update Context (w/ Cmd, cmdSet)"]
- N_CTX --> O{"Cmd Parse Err?"}
- O -- Yes --> O_ERR["ERR: Cmd parse failed"]
- O_ERR --> Z_END_CMD_PARSE_ERR["End (Error)"]
- O -- No --> P["Validate Cmd Flags (uses validateFlags helper)"]
- P --> Q{"Cmd Validate Err?"}
- Q -- Yes --> Q_ERR["ERR: Cmd validate failed"]
- Q_ERR --> Z_END_CMD_VALIDATE_ERR["End (Error)"]
- Q -- No --> R["Set ctx args, Exec Cmd Action"]
- R --> Z_SUCCESS_CMD_EXEC["End (Success)"]
-
- K -- No --> S_LINK["Proceed to: Fallback Flow (Global Action / Unknown Cmd)"]
-
- subgraph subGraph0_ref_cmd["Ref: parseFlagSet Helper"]
- direction TB
- REF_PF_CMD["(See 'Helper: parseFlagSet' diagram)"]
- end
-
- subgraph subGraph1_ref_cmd["Ref: validateFlags Helper"]
- direction TB
- REF_VF_CMD["(See 'Helper: validateFlags' diagram)"]
- end
-
- N -.-> REF_PF_CMD
- P -.-> REF_VF_CMD
-
-Fallback Flow: Global Action / Unknown Command / Main Help
-This flow is triggered if no specific command is identified from the arguments. -The CLI checks if a global action (an action to be performed if no command is specified) has been defined.
--
-
- If a global action exists, the remaining arguments (
restArgs) are set in the context, and the global action is executed.
- - If no global action is defined, the CLI checks if there were any
restArgs. --
-
- If
restArgsexist, it implies the user tried to run a command that doesn’t exist, so an “Unknown command” error is shown.
- - If no
restArgsexist (meaning only global flags or no arguments were provided, and no command was matched), the main help message for the CLI application is displayed.
-
- - If
flowchart TB
- S_START["From: Command Not Found"] --> S{"Global Action Defined?"}
- S -- Yes --> T["Set ctx args (restArgs), Exec Global Action"]
- T --> Z_SUCCESS_GLOBAL_ACTION["End (Success)"]
- S -- No --> U{"restArgs exist (unknown cmd)?"}
- U -- Yes --> V["ERR: Unknown command"]
- V --> Z_END_UNKNOWN_CMD_ERR["End (Error)"]
- U -- No --> W["Show Main Help"]
- W --> Z_SUCCESS_MAIN_HELP["End (Success)"]
-
-Router
-The nova Router is responsible for directing incoming HTTP requests to the appropriate handler functions based on the request’s method and URL path.
-It supports dynamic path parameters with optional regex validation, middleware, sub-routers for modular organization, and route groups for applying common prefixes and middleware to a set of routes.
Main Router Operations
-Users primarily interact with the Router by creating a new instance, -registering routes with associated handlers and middleware, potentially mounting sub-routers or creating route groups.
-flowchart TD
- A_USER_ACTION{"User Configures & Uses Router"}
- A_USER_ACTION --> A1["Calls NewRouter()"]
- A_USER_ACTION --> A2["Calls router.Handle() (or Get(), Post(), etc.)"]
- A_USER_ACTION --> A3["Calls router.Use(middleware)"]
- A_USER_ACTION --> A4["Calls router.Subrouter(prefix)"]
- A_USER_ACTION --> A5["Calls router.Group(prefix)"]
- A_USER_ACTION --> A6["Router used as http.Handler"]
-
- A1 --> REF_NEW_ROUTER["(Details in 'Flow: Router Initialization')"]
- A2 --> REF_HANDLE["(Details in 'Flow: Route Registration')"]
- A3 --> REF_USE_MW["(Details in 'Flow: Middleware Registration')"]
- A4 --> REF_SUBROUTER["(Details in 'Flow: Subrouter Creation')"]
- A5 --> REF_GROUP["(Details in 'Flow: Group Creation & Handling')"]
- A6 --> REF_SERVE_HTTP["(Details in 'Flow: Request Dispatching - ServeHTTP')"]
-
- REF_NEW_ROUTER --> Z_END_CONFIG["Router Configured"]
- REF_HANDLE --> Z_END_CONFIG
- REF_USE_MW --> Z_END_CONFIG
- REF_SUBROUTER --> Z_END_CONFIG
- REF_GROUP --> Z_END_CONFIG
- REF_SERVE_HTTP --> Z_END_REQUEST_HANDLED["Request Handled / Error"]
-
-Flow: Router Initialization (NewRouter)
-This function creates a new, empty Router instance. It initializes internal slices for routes and sub-routers, sets up a unique context key for URL parameters, and establishes a default (passthrough) middleware chain.
flowchart TD - NR_START["Start NewRouter()"] --> NR1["Initialize Router struct: empty routes, subrouters, middlewares"] - NR1 --> NR2["Set unique paramsKey for context"] - NR2 --> NR3["Set basePath to empty"] - NR3 --> NR4["Initialize middleware chain (default: passthrough)"] - NR4 --> NR_OUTPUT["Output: New Router Instance"] - NR_OUTPUT --> NR_END["End NewRouter"] --
Flow: Route Registration (Router.Handle)
-This is the core method for defining a route. It takes an HTTP method, a URL pattern, and a handler function. The URL pattern is compiled into segments (literals or parameters with optional regex). If the router has a basePath (e.g., if it’s a subrouter), this path is prepended to the given pattern. The compiled route is then stored. Helper methods like Get(), Post() internally call Handle().
flowchart TD - RH_START["Start router.Handle(method, pattern, handler, opts...)"] --> RH1["Check if router has basePath"] - RH1 -- Yes --> RH2_JOIN["Prepend router.basePath to pattern (uses joinPaths)"] - RH1 -- No --> RH2_COMPILE - RH2_JOIN --> RH2_COMPILE["Compile fullPattern into segments (uses compilePattern)"] - RH2_COMPILE -- Error (Invalid Pattern) --> RH_PANIC["Panic: Invalid Route Pattern"] - RH2_COMPILE -- Success (segments) --> RH3["Create route struct (method, handler, segments, options)"] - RH3 --> RH4["Append new route to router.routes slice"] - RH4 --> RH_END["End router.Handle"] --
Internal Detail: compilePattern(pattern)
-This helper parses a URL pattern string (e.g., /users/{id:\d+}) into a sequence of segment structs. Each segment is either a literal string or a parameter (e.g., id). Parameters can include an optional regex (e.g., \d+) which is pre-compiled for efficient matching.
Flow: Group Creation & Handling (Router.Group & Group.Handle)
-A Group allows defining a common prefix and/or middleware for a set of routes. Router.Group() creates a Group instance, storing the prefix and any group-specific middleware. When Group.Handle() (or group.Get(), etc.) is called, it prepends the group’s prefix to the route pattern, wraps the handler with the group’s middleware, and then calls the underlying router.Handle() method.
flowchart TD - %% Router.Group - RG_START_ROUTER["Start router.Group(prefix, mws...)"] --> RG1["Join router.basePath with group prefix"] - RG1 --> RG2["Create Group struct (prefix, router instance, group middlewares)"] - RG2 --> RG_OUTPUT["Output: New Group Instance"] - RG_OUTPUT --> RG_END_ROUTER["End router.Group"] - - %% Group.Handle - GH_START["Start group.Handle(method, pattern, handler, opts...)"] --> GH1["Prepend group.prefix to pattern (uses joinPaths)"] - GH1 --> GH2_WRAP["Wrap provided handler with group's middlewares"] - GH2_WRAP --> GH3_FORWARD["Call underlying router.Handle(method, fullPattern, wrappedHandler, opts...)"] - GH3_FORWARD --> REF_ROUTER_HANDLE["(Uses 'Flow: Route Registration')"] - REF_ROUTER_HANDLE --> GH_END["End group.Handle"] --
Flow: Middleware Registration (Router.Use)
-This method allows adding one or more Middleware functions to the router. These middlewares are applied globally to all routes handled by this router (and inherited by its subrouters). After adding new middleware, the router’s internal middleware chain is rebuilt.
flowchart TD - MWU_START["Start router.Use(mws...)"] --> MWU1["Append new middleware(s) to router.middlewares slice"] - MWU1 --> MWU2["Rebuild router's middleware chain (rebuildChain)"] - MWU2 --> MWU_END["End router.Use"] --
Internal Detail: rebuildChain()
-This function iterates through the registered middlewares in reverse order, wrapping the final handler (or the previously wrapped handler) with each middleware. This creates a single composed http.Handler that executes all middlewares in the correct sequence before reaching the route-specific handler.
Flow: Subrouter Creation (Router.Subrouter)
-Subrouter allows mounting another Router instance at a specified path prefix. The new subrouter inherits the parent’s context key for parameters, its global middleware chain, and custom error handlers. The basePath of the subrouter is set by joining the parent’s basePath with the new prefix.
flowchart TD - SR_START["Start router.Subrouter(prefix)"] --> SR1["Initialize new Router instance"] - SR1 --> SR2["Inherit paramsKey from parent"] - SR2 --> SR3["Copy parent's middlewares & rebuild chain for subrouter"] - SR3 --> SR4["Set subrouter.basePath (join parent.basePath + prefix)"] - SR4 --> SR5["Inherit notFoundHandler & methodNotAllowedHandler"] - SR5 --> SR6["Append new subrouter to parent's subrouters slice"] - SR6 --> SR_OUTPUT["Output: New Subrouter Instance"] - SR_OUTPUT --> SR_END["End router.Subrouter"] --
Flow: Request Dispatching (Router.ServeHTTP)
-This is the core of the router, implementing http.Handler. When a request arrives:
-
-
- It first checks if the request path matches the
basePathof any registered subrouters. If so, the request is delegated to that subrouter’sServeHTTPmethod.
- - If no subrouter matches, it iterates through its own registered routes. For each route:
-
-
-
- It attempts to match the request path against the route’s compiled segments (
matchSegments).
- - If the path pattern matches:
-
-
-
- It then checks if the HTTP method matches. -
- If both path and method match, URL parameters are extracted and added to the request’s context. The router’s middleware chain is applied to the route’s handler, and the resulting handler serves the request. -
- If the path matches but the method does not, a 405 Method Not Allowed error is triggered. -
-
- - It attempts to match the request path against the route’s compiled segments (
- If no route pattern matches at all, a 404 Not Found error is triggered. Custom handlers for 404 and 405 errors can be set. -
flowchart TD
- SH_START["Start router.ServeHTTP(w, req)"] --> SH1_SUBROUTERS{"Check Subrouters: Path matches subrouter.basePath?"}
- SH1_SUBROUTERS -- Yes, matches SR --> SH2_DELEGATE_SR["Delegate to sr.ServeHTTP(w, req) & return"]
- SH1_SUBROUTERS -- No subrouter match --> SH3_LOOP_ROUTES{"Loop own routes: Attempt to match req.URL.Path (matchSegments)"}
-
- SH3_LOOP_ROUTES -- No match in loop --> SH_HANDLE_404["Pattern Not Matched: Trigger 404 Not Found (custom or default)"]
- SH_HANDLE_404 --> SH_END_REQUEST["End Request"]
-
- SH3_LOOP_ROUTES -- Path Pattern Matched (ok, params) --> SH4_CHECK_METHOD{"Method Matches rt.method?"}
- SH4_CHECK_METHOD -- Yes (Full Match) --> SH5_ADD_PARAMS["Add URL params to req.Context (if any)"]
- SH5_ADD_PARAMS --> SH6_APPLY_CHAIN["Apply router's middleware chain to rt.handler"]
- SH6_APPLY_CHAIN --> SH7_EXEC_HANDLER["Execute finalHandler.ServeHTTP(w, req) & return"]
-
- SH4_CHECK_METHOD -- No (Path matched, method didn't) --> SH_HANDLE_405["Pattern Matched, Method Mismatch: Trigger 405 Method Not Allowed (custom or default)"]
- SH_HANDLE_405 --> SH_END_REQUEST
-
- SH2_DELEGATE_SR --> SH_END_REQUEST
- SH7_EXEC_HANDLER --> SH_END_REQUEST
-
-Internal Detail: matchSegments(path, segments)
-This helper compares the parts of an incoming URL path against a route’s pre-compiled segments. It checks literal matches and, for parameter segments, validates against any compiled regex and extracts the parameter value. It returns true and a map of parameters if matched.
Flow: URL Parameter Retrieval (Router.URLParam)
-A simple utility to retrieve a named URL parameter that was extracted during routing. It accesses the parameters map stored in the request’s context using the router’s unique paramsKey.
flowchart TD
- UP_START["Start router.URLParam(req, key)"] --> UP1["Get params map from req.Context using router.paramsKey"]
- UP1 --> UP2{"Params map found & key exists?"}
- UP2 -- Yes --> UP3_RETURN_VALUE["Output: Parameter value (string)"]
- UP2 -- No --> UP4_RETURN_EMPTY["Output: Empty string"]
- UP3_RETURN_VALUE --> UP_END["End URLParam"]
- UP4_RETURN_EMPTY --> UP_END
-
-Scaffolding
-Scaffolding provides functionality to generate new Go project structures from predefined, embedded templates. -It customizes directory names, filenames, and file contents based on user input (like project name and database choice), -effectively bootstrapping a new application with a chosen layout.
-The core logic resides in the createFromTemplate function, w -hich is invoked by higher-level functions like CreateMinimal, or CreateStructured. -It systematically processes template items to build the new project. If any step fails, the scaffolding process is halted, and an error is returned.
-flowchart TD
- A_USER_CALL["User calls CreateMinimal or CreateStructured"] --> B_INVOKE_CFT["Invoke createFromTemplate(name, templateConfig, dbImport)"]
-
- B_INVOKE_CFT --> C_START_CFT["Start createFromTemplate"]
-
- C_START_CFT --> D_MKDIR_ROOT["Create Project Root Directory (os.Mkdir)"]
- D_MKDIR_ROOT -- Error --> Z_ERROR["Scaffolding Failed"]
- D_MKDIR_ROOT -- Success --> E_PREPARE_DATA["Prepare Template Data (name, dbImport, getDBAdapter() -> templateData)"]
-
- E_PREPARE_DATA --> F_WALK_FS_SETUP["Setup fs.WalkDir to iterate over embedded templates"]
- F_WALK_FS_SETUP -- Walk Setup Error --> Z_ERROR
- F_WALK_FS_SETUP -- Start Iteration --> G_WALK_CALLBACK{"fs.WalkDir Callback for each entry (originalPath, dirEntry, err)"}
-
- G_WALK_CALLBACK -- Error from WalkDir itself --> Z_ERROR
- G_WALK_CALLBACK -- Process Entry --> H_PROCESS_PATH["Process Path Template - Get relative path - Strip .tmpl - Execute path as template - Result: targetPath"]
- H_PROCESS_PATH -- Error --> Z_ERROR_CALLBACK["Return error from callback"]
- H_PROCESS_PATH -- Success (targetPath) --> I_IS_DIR{"Is Entry a Directory?"}
-
- I_IS_DIR -- Yes --> J_HANDLE_DIR["Create Directory (handleDirectory) (os.MkdirAll at targetPath, log if verbose)"]
- J_HANDLE_DIR -- Error --> Z_ERROR_CALLBACK
- J_HANDLE_DIR -- Success --> G_WALK_CALLBACK_NEXT["Return nil (continue walk)"]
-
-
- I_IS_DIR -- No (File) --> K_HANDLE_FILE_START["Process & Write File (handleFile)"]
- K_HANDLE_FILE_START --> L_READ_TEMPLATE["Read Template File Content (fs.ReadFile from originalPath)"]
- L_READ_TEMPLATE -- Error --> Z_ERROR_CALLBACK
- L_READ_TEMPLATE -- Success (rawContent) --> M_PROCESS_CONTENT["Process Content Template (processContentTemplate) (Execute rawContent with templateData)"]
- M_PROCESS_CONTENT -- Error --> Z_ERROR_CALLBACK
- M_PROCESS_CONTENT -- Success (processedContent) --> N_WRITE_FILE["Write Processed Content to disk (os.WriteFile at targetPath, log if verbose)"]
- N_WRITE_FILE -- Error --> Z_ERROR_CALLBACK
- N_WRITE_FILE -- Success --> G_WALK_CALLBACK_NEXT
-
- Z_ERROR_CALLBACK --> G_WALK_TERMINATES_ERROR["fs.WalkDir terminates with error"]
- G_WALK_CALLBACK_NEXT --> G_WALK_CALLBACK_CONTINUE["fs.WalkDir continues to next entry or finishes"]
-
- G_WALK_CALLBACK_CONTINUE -- More Entries --> G_WALK_CALLBACK
- G_WALK_CALLBACK_CONTINUE -- All Entries Processed (WalkDir returns nil) --> Y_SUCCESS["createFromTemplate Successful"]
-
- G_WALK_TERMINATES_ERROR --> Z_ERROR
-
- Y_SUCCESS --> Z_SUCCESS["Scaffolding Succeeded"]
-
- Z_SUCCESS --> Z_END["End"]
- Z_ERROR --> Z_END
-
-Migrations
-Nova provides database migrations through versioned SQL files. This allows for creating new migrations, applying pending changes (migrating up), and reverting applied changes (migrating down).
-Migration Actions
-Users interact with the migration system by calling one of three main functions:
-CreateNewMigration to scaffold a new migration file, MigrateUp to apply pending schema changes to the database, or MigrateDown to roll back previously applied changes from the database.
-Each of these actions follows a distinct flow.
flowchart TD
- A_USER_ACTION{"User Initiates Migration Task"}
- A_USER_ACTION --> A1["Calls CreateNewMigration(name)"]
- A_USER_ACTION --> A2["Calls MigrateUp(db, steps)"]
- A_USER_ACTION --> A3["Calls MigrateDown(db, steps)"]
-
- A1 --> REF_CREATE["(Details in 'Flow: CreateNewMigration')"]
- A2 --> REF_UP["(Details in 'Flow: MigrateUp')"]
- A3 --> REF_DOWN["(Details in 'Flow: MigrateDown')"]
-
- REF_CREATE --> Z_END_ACTION["End User Action"]
- REF_UP --> Z_END_ACTION
- REF_DOWN --> Z_END_ACTION
-
-Flow: CreateNewMigration
-This function is responsible for scaffolding a new SQL migration file.
-It generates a unique, timestamped filename, ensures the migrations directory exists (creating it if necessary),
-and then writes a basic template into the new file.
-This template includes the "-- migrate:up" and "-- migrate:down" delimiters to guide the user in adding their SQL statements.
flowchart TD - CNM_START["Start CreateNewMigration(name)"] --> CNM1["Generate Timestamped Filename (e.g., 123_name.sql)"] - CNM1 --> CNM2["Ensure 'migrations' Folder Exists (Create if not)"] - CNM2 --> CNM3["Write SQL Template (up/down sections) to New File"] - CNM3 -- Success --> CNM_SUCCESS["Output: New .sql File Created"] - CNM3 -- Error --> CNM_ERROR["Output: Error During File Creation"] - CNM_SUCCESS --> CNM_END["End CreateNewMigration"] - CNM_ERROR --> CNM_END --
Flow: MigrateUp
-The MigrateUp function applies pending schema changes to the database.
-It first determines the current version of the database.
-Then, it identifies all migration files in the migrations folder that have a version number greater than the current database version.
-These pending migrations are sorted chronologically (oldest first) and applied sequentially, up to an optional steps limit.
-For each migration applied, its “up” SQL statements are executed, and the database version is updated.
flowchart TD
- MU_START["Start MigrateUp(db, steps)"] --> MU1["Get Current DB Version"]
- MU1 -- Error --> MU_END_ERROR_INIT["End (Error Initializing)"]
- MU1 -- Success (currentDBVer) --> MU2["Get & Sort Migration Files (Oldest First)"]
- MU2 -- Error --> MU_END_ERROR_INIT
- MU2 -- Success (sortedFiles) --> MU3_LOOP_START{"Loop: For each file (respect 'steps' limit)"}
-
- MU3_LOOP_START -- No More Applicable Files / Limit Reached --> MU_REPORT["Report Status (Applied count or No pending)"]
- MU_REPORT --> MU_END_SUCCESS["End (MigrateUp Finished)"]
-
- MU3_LOOP_START -- Next File --> MU4_CHECK_VER{"Check: File Version > currentDBVer?"}
- MU4_CHECK_VER -- No (Skip) --> MU3_LOOP_START
- MU4_CHECK_VER -- Yes (Pending) --> MU5_APPLY["Action: Read File & Apply 'Up' SQL Statements"]
- MU5_APPLY -- Error --> MU_END_ERROR_APPLY["End (Error Applying SQL)"]
- MU5_APPLY -- Success --> MU6_UPDATE_DB["Action: Update DB Version to This File's Version"]
- MU6_UPDATE_DB -- Error --> MU_END_ERROR_DBUPDATE["End (Error Updating DB Version)"]
- MU6_UPDATE_DB -- Success --> MU7_LOG["Action: Log Applied & Increment Count"]
- MU7_LOG --> MU3_LOOP_START
-
-Flow: MigrateDown
-The MigrateDown function reverts previously applied migrations.
-It starts by getting the current database version.
-It then considers migration files sorted in reverse chronological order (newest first).
-For each migration whose version is less than or equal to the current database version (and within the steps limit, which defaults to 1),
-its “down” SQL statements are executed. After a successful rollback, the database version is updated to reflect the state before that migration was applied.
flowchart TD
- MD_START["Start MigrateDown(db, steps)"] --> MD0["1. Set 'steps' (default 1 if 0 or less)"]
- MD0 --> MD1["2. Get Current DB Version"]
- MD1 -- Error --> MD_END_ERROR_INIT["End (Error Initializing)"]
- MD1 -- Success (currentDBVer) --> MD2["3. Get & Sort Migration Files (Newest First)"]
- MD2 -- Error --> MD_END_ERROR_INIT
- MD2 -- Success (sortedFiles) --> MD3_LOOP_START{"4. Loop: For each file (respect 'steps' limit)"}
-
- MD3_LOOP_START -- No More Applicable Files / Limit Reached --> MD_REPORT["7. Report Status (Rolled back count or None)"]
- MD_REPORT --> MD_END_SUCCESS["End (MigrateDown Finished)"]
-
- MD3_LOOP_START -- Next File --> MD4_CHECK_VER{"5a. File Version <= currentDBVer AND currentDBVer > 0?"}
- MD4_CHECK_VER -- No (Skip) --> MD3_LOOP_START
- MD4_CHECK_VER -- Yes (Can Rollback) --> MD5_APPLY["5b. Read File & Apply 'Down' SQL Statements"]
- MD5_APPLY -- Error --> MD_END_ERROR_APPLY["End (Error Applying SQL)"]
- MD5_APPLY -- Success --> MD6_UPDATE_DB["5c. Update DB Version (to version before this file)"]
- MD6_UPDATE_DB -- Error --> MD_END_ERROR_DBUPDATE["End (Error Updating DB Version)"]
- MD6_UPDATE_DB -- Success --> MD7_LOG["5d. Log Rolled Back & Increment Count"]
- MD7_LOG --> MD3_LOOP_START
-
-OpenAPI
-The nova framework can automatically generate an OpenAPI 3.0 specification from your router definitions and associated Go types.
-This allows for easy documentation and client generation. The process involves collecting route information, building operation details,
-and generating JSON schemas for request/response bodies and parameters.
-The generated specification can then be served as a JSON file, and an embedded Swagger UI can be hosted to visualize and interact with the API.
Overall OpenAPI Process
-The generation of the OpenAPI specification is primarily orchestrated by GenerateOpenAPISpec.
-This function initializes the spec and then recursively traverses the router structure using collectRoutes to populate path and operation details.
-Once generated, ServeOpenAPISpec can expose it via an HTTP endpoint, and ServeSwaggerUI can provide an interactive API console.
flowchart TD
- A_USER_CALLS["User calls Router.ServeOpenAPISpec() or Router.ServeSwaggerUI()"]
-
- A_USER_CALLS --> B_SERVE_SPEC_OR_UI{"Serve Spec or UI?"}
-
- B_SERVE_SPEC_OR_UI -- ServeOpenAPISpec --> C1_GEN_SPEC["Invoke GenerateOpenAPISpec(router, config)"]
- C1_GEN_SPEC --> REF_GEN_SPEC["(Details in 'Flow: GenerateOpenAPISpec')"]
- REF_GEN_SPEC --> C2_MARSHAL["Marshal Spec to JSON"]
- C2_MARSHAL --> C3_SERVE_JSON["Register Handler to Serve JSON at specified path"]
- C3_SERVE_JSON --> Z_END_ACTION["End User Action"]
-
- B_SERVE_SPEC_OR_UI -- ServeSwaggerUI --> D1_SERVE_UI["Invoke ServeSwaggerUI(prefix)"]
- D1_SERVE_UI --> REF_SERVE_UI["(Details in 'Flow: ServeSwaggerUI')"]
- REF_SERVE_UI --> Z_END_ACTION
-
-Flow: GenerateOpenAPISpec
-This is the main function responsible for constructing the complete OpenAPI specification object.
-It initializes the basic structure of the spec (like OpenAPI version, info)
-and then kicks off the route collection process.
-It uses a schemaGenCtx to manage and reuse generated schemas in the components section.
flowchart TD - GEN_START["Start GenerateOpenAPISpec(router, config)"] --> GEN1["Initialize OpenAPI Spec (Version, Info, Servers, empty Paths, empty Components)"] - GEN1 --> GEN2["Initialize schemaGenCtx (for managing component schemas)"] - GEN2 --> GEN3_COLLECT["Call collectRoutes"] - GEN3_COLLECT --> REF_COLLECT_ROUTES["(Details in 'Flow: collectRoutes')"] - REF_COLLECT_ROUTES --> GEN4["Populate spec.Components.Schemas from schemaCtx (if any)"] - GEN4 --> GEN_OUTPUT["Output: Populated OpenAPI Spec Object"] - GEN_OUTPUT --> GEN_END["End GenerateOpenAPISpec"] --
Flow: collectRoutes (Recursive)
-This function recursively traverses the router and its sub-routers.
-For each route it encounters, it constructs the full path string,
-creates or retrieves the corresponding PathItem in the OpenAPI spec,
-and then builds the Operation object for that specific HTTP method and path.
flowchart TD
- CR_START["Start collectRoutes(router, spec, schemaCtx, parentPath)"]
- CR_START --> CR1_LOOP_ROUTES{"For each route in router.routes"}
- CR1_LOOP_ROUTES -- Next Route --> CR2_BUILD_PATH["Build Full Path String (uses buildPathString)"]
- CR2_BUILD_PATH --> CR3_GET_PATHITEM["Get/Create PathItem in spec.Paths"]
- CR3_GET_PATHITEM --> CR4_BUILD_OP["Build Operation (uses buildOperation)"]
- CR4_BUILD_OP --> REF_BUILD_OP["(Details in 'Flow: buildOperation')"]
- REF_BUILD_OP --> CR5_ASSIGN_OP["Assign Operation to PathItem (e.g., pathItem.Get = op)"]
- CR5_ASSIGN_OP --> CR1_LOOP_ROUTES
- CR1_LOOP_ROUTES -- All Routes Processed --> CR6_LOOP_SUBROUTERS{"For each subrouter in router.subrouters"}
-
- CR6_LOOP_SUBROUTERS -- Next Subrouter --> CR7_RECURSE["Recursive Call: collectRoutes(subrouter, spec, schemaCtx, subrouter.basePath)"]
- CR7_RECURSE --> CR6_LOOP_SUBROUTERS
- CR6_LOOP_SUBROUTERS -- All Subrouters Processed --> CR_END["End collectRoutes"]
-
-Flow: buildOperation
-For a given route, this function constructs an OpenAPI Operation object.
-It populates details like tags, summary, description, and parameters based on route.options.
-It also handles the generation of schemas for request bodies and responses by calling generateSchema.
-Path parameters defined in the route segments are also ensured to be part of the operation’s parameters.
flowchart TD
- BO_START["Start buildOperation(route, schemaCtx)"] --> BO1["Initialize Operation Object (empty Responses, Parameters)"]
- BO1 --> BO2_CHECK_OPTS{"Route Options Defined?"}
- BO2_CHECK_OPTS -- No --> BO_PROCESS_PATH_PARAMS
- BO2_CHECK_OPTS -- Yes (opts exist) --> BO3_POPULATE_META["Populate Meta (Tags, Summary, Desc, OpID, Deprecated)"]
- BO3_POPULATE_META --> BO4_REQ_BODY{"RequestBody Option?"}
- BO4_REQ_BODY -- Yes --> BO5_BUILD_REQ_BODY["Create RequestBodyObject, call generateSchema for its content"]
- BO5_BUILD_REQ_BODY --> REF_GEN_SCHEMA_REQ["(Uses 'Flow: generateSchema')"]
- REF_GEN_SCHEMA_REQ --> BO6_RESPONSES
- BO4_REQ_BODY -- No --> BO6_RESPONSES
-
- BO6_RESPONSES{"Loop Response Options"}
- BO6_RESPONSES -- Next ResponseOpt --> BO7_BUILD_RESP["Create ResponseObject, call generateSchema for body"]
- BO7_BUILD_RESP --> REF_GEN_SCHEMA_RESP["(Uses 'Flow: generateSchema')"]
- REF_GEN_SCHEMA_RESP --> BO6_RESPONSES
- BO6_RESPONSES -- Done --> BO8_PARAMS{"Loop Parameter Options"}
-
- BO8_PARAMS -- Next ParamOpt --> BO9_BUILD_PARAM["Create ParameterObject, call generateSchema for schema"]
- BO9_BUILD_PARAM --> REF_GEN_SCHEMA_PARAM["(Uses 'Flow: generateSchema')"]
- REF_GEN_SCHEMA_PARAM --> BO8_PARAMS
- BO8_PARAMS -- Done --> BO_PROCESS_PATH_PARAMS
-
- BO_PROCESS_PATH_PARAMS["Ensure Path Parameters from route.segments are added (if not already from options)"]
- BO_PROCESS_PATH_PARAMS --> BO10_DEFAULT_RESP{"Add Default '200 OK' Response if none specified"}
- BO10_DEFAULT_RESP --> BO_OUTPUT["Output: Populated Operation Object"]
- BO_OUTPUT --> BO_END["End buildOperation"]
-
-Flow: generateSchema (Recursive & Type Handling)
-This is the core schema generation logic.
-Given a Go interface{} instance,
-it uses reflection to determine its type and generate a corresponding OpenAPI SchemaObject.
-It handles basic Go types (string, int, bool, etc.), structs, slices/arrays, and maps.
-For structs, it generates named schemas and stores them in schemaCtx.componentsSchemas to allow for reuse via $ref pointers, preventing duplication and handling circular dependencies.
flowchart TD
- GS_START["Start generateSchema(instance, schemaCtx)"] --> GS1{"Handle nil/ptr, Get reflect.Type & Value"}
- GS1 --> GS2_CHECK_CACHE{"Struct & Already Generated (in schemaCtx)?"}
- GS2_CHECK_CACHE -- Yes --> GS_RETURN_REF["Output: SchemaObject with $ref"]
-
- GS2_CHECK_CACHE -- No --> GS3_SWITCH_KIND{"Switch on Type Kind"}
- GS3_SWITCH_KIND -- Struct --> GS_STRUCT["Handle Struct"]
- GS_STRUCT --> GS_STRUCT_TIME{"time.Time?"}
- GS_STRUCT_TIME -- Yes --> GS_TIME_SCHEMA["Set type:string, format:date-time"]
- GS_STRUCT_TIME -- No --> GS_STRUCT_NAME["Generate/Get Unique Schema Name"]
- GS_STRUCT_NAME --> GS_STRUCT_RESERVE["Add to schemaCtx (initially nil for cycle breaking)"]
- GS_STRUCT_RESERVE --> GS_STRUCT_PROPS["Iterate Fields: Get JSON name, recursively call generateSchema for field type, add to Properties"]
- GS_STRUCT_PROPS --> REF_GS_FIELD["(Recursive calls use 'Flow: generateSchema')"]
- REF_GS_FIELD --> GS_STRUCT_REQ["Determine Required Fields"]
- GS_STRUCT_REQ --> GS_STRUCT_STORE["Store final schema in schemaCtx"]
- GS_STRUCT_STORE --> GS_RETURN_REF
-
- GS3_SWITCH_KIND -- Slice/Array --> GS_ARRAY["Handle Slice/Array: Set type:array, recursively call generateSchema for Items"]
- GS_ARRAY --> REF_GS_ITEMS["(Recursive call uses 'Flow: generateSchema')"]
- REF_GS_ITEMS --> GS_SCHEMA_BUILT
-
- GS3_SWITCH_KIND -- Map --> GS_MAP["Handle Map: Set type:object, recursively call generateSchema for AdditionalProperties"]
- GS_MAP --> REF_GS_ADD_PROPS["(Recursive call uses 'Flow: generateSchema')"]
- REF_GS_ADD_PROPS --> GS_SCHEMA_BUILT
-
- GS3_SWITCH_KIND -- Primitives (string, int, bool, etc.) --> GS_PRIMITIVE["Handle Primitives: Set type & format"]
- GS_PRIMITIVE --> GS_SCHEMA_BUILT
-
- GS3_SWITCH_KIND -- Other/Unsupported --> GS_UNSUPPORTED["Handle Unsupported: Log warning, set basic object type"]
- GS_UNSUPPORTED --> GS_SCHEMA_BUILT
-
- GS_TIME_SCHEMA --> GS_SCHEMA_BUILT
- GS_SCHEMA_BUILT["Schema Object Constructed (without $ref)"] --> GS_OUTPUT_DIRECT["Output: SchemaObject"]
-
- GS_OUTPUT_DIRECT --> GS_END["End generateSchema"]
- GS_RETURN_REF --> GS_END
-
-Flow: ServeSwaggerUI
-This function sets up HTTP handlers to serve the embedded Swagger UI static assets. It handles requests for the UI’s root path (redirecting if necessary), the index.html file, and other assets like CSS and JavaScript files, serving them from the embedded filesystem.
flowchart TD
- SSUI_START["Start ServeSwaggerUI(prefix)"] --> SSUI1["Get Sub-Filesystem for embedded 'swagger-ui' assets"]
- SSUI1 -- Error --> SSUI_PANIC["Panic: Failed to locate assets"]
- SSUI1 -- Success --> SSUI2_HANDLE_ROOT["Register Handler for 'prefix': Redirects to 'prefix/'"]
- SSUI2_HANDLE_ROOT --> SSUI3_HANDLE_INDEX["Register Handler for 'prefix/': Serves 'index.html' from embedded FS"]
- SSUI3_HANDLE_INDEX --> SSUI4_HANDLE_ASSETS["Register Handler for 'prefix/{file}': Serves other static assets (CSS, JS, etc.) from embedded FS with correct Content-Type"]
- SSUI4_HANDLE_ASSETS --> SSUI5_LOG["Log Swagger UI served"]
- SSUI5_LOG --> SSUI_END["End ServeSwaggerUI"]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/book/favicon.png b/docs/book/favicon.png
deleted file mode 100644
index a5b1aa1..0000000
Binary files a/docs/book/favicon.png and /dev/null differ
diff --git a/docs/book/favicon.svg b/docs/book/favicon.svg
deleted file mode 100644
index 90e0ea5..0000000
--- a/docs/book/favicon.svg
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
diff --git a/docs/book/fonts/OPEN-SANS-LICENSE.txt b/docs/book/fonts/OPEN-SANS-LICENSE.txt
deleted file mode 100644
index d645695..0000000
--- a/docs/book/fonts/OPEN-SANS-LICENSE.txt
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/docs/book/fonts/SOURCE-CODE-PRO-LICENSE.txt b/docs/book/fonts/SOURCE-CODE-PRO-LICENSE.txt
deleted file mode 100644
index 366206f..0000000
--- a/docs/book/fonts/SOURCE-CODE-PRO-LICENSE.txt
+++ /dev/null
@@ -1,93 +0,0 @@
-Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded,
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting -- in part or in whole -- any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/docs/book/fonts/fonts.css b/docs/book/fonts/fonts.css
deleted file mode 100644
index 858efa5..0000000
--- a/docs/book/fonts/fonts.css
+++ /dev/null
@@ -1,100 +0,0 @@
-/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
-/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
-
-/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 300;
- src: local('Open Sans Light'), local('OpenSans-Light'),
- url('open-sans-v17-all-charsets-300.woff2') format('woff2');
-}
-
-/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 300;
- src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
- url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
-}
-
-/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 400;
- src: local('Open Sans Regular'), local('OpenSans-Regular'),
- url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
-}
-
-/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 400;
- src: local('Open Sans Italic'), local('OpenSans-Italic'),
- url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
-}
-
-/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 600;
- src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
- url('open-sans-v17-all-charsets-600.woff2') format('woff2');
-}
-
-/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 600;
- src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
- url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
-}
-
-/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 700;
- src: local('Open Sans Bold'), local('OpenSans-Bold'),
- url('open-sans-v17-all-charsets-700.woff2') format('woff2');
-}
-
-/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 700;
- src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
- url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
-}
-
-/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 800;
- src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
- url('open-sans-v17-all-charsets-800.woff2') format('woff2');
-}
-
-/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 800;
- src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
- url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
-}
-
-/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Source Code Pro';
- font-style: normal;
- font-weight: 500;
- src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
-}
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-300.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-300.woff2
deleted file mode 100644
index 9f51be3..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-300.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-300italic.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-300italic.woff2
deleted file mode 100644
index 2f54544..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-300italic.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-600.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-600.woff2
deleted file mode 100644
index f503d55..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-600.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-600italic.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-600italic.woff2
deleted file mode 100644
index c99aabe..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-600italic.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-700.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-700.woff2
deleted file mode 100644
index 421a1ab..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-700.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-700italic.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-700italic.woff2
deleted file mode 100644
index 12ce3d2..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-700italic.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-800.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-800.woff2
deleted file mode 100644
index c94a223..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-800.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-800italic.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-800italic.woff2
deleted file mode 100644
index eed7d3c..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-800italic.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-italic.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-italic.woff2
deleted file mode 100644
index 398b68a..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-italic.woff2 and /dev/null differ
diff --git a/docs/book/fonts/open-sans-v17-all-charsets-regular.woff2 b/docs/book/fonts/open-sans-v17-all-charsets-regular.woff2
deleted file mode 100644
index 8383e94..0000000
Binary files a/docs/book/fonts/open-sans-v17-all-charsets-regular.woff2 and /dev/null differ
diff --git a/docs/book/fonts/source-code-pro-v11-all-charsets-500.woff2 b/docs/book/fonts/source-code-pro-v11-all-charsets-500.woff2
deleted file mode 100644
index 7222456..0000000
Binary files a/docs/book/fonts/source-code-pro-v11-all-charsets-500.woff2 and /dev/null differ
diff --git a/docs/book/highlight.css b/docs/book/highlight.css
deleted file mode 100644
index 352c79b..0000000
--- a/docs/book/highlight.css
+++ /dev/null
@@ -1,83 +0,0 @@
-/*
- * An increased contrast highlighting scheme loosely based on the
- * "Base16 Atelier Dune Light" theme by Bram de Haan
- * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
- * Original Base16 color scheme by Chris Kempson
- * (https://github.com/chriskempson/base16)
- */
-
-/* Comment */
-.hljs-comment,
-.hljs-quote {
- color: #575757;
-}
-
-/* Red */
-.hljs-variable,
-.hljs-template-variable,
-.hljs-attribute,
-.hljs-attr,
-.hljs-tag,
-.hljs-name,
-.hljs-regexp,
-.hljs-link,
-.hljs-name,
-.hljs-selector-id,
-.hljs-selector-class {
- color: #d70025;
-}
-
-/* Orange */
-.hljs-number,
-.hljs-meta,
-.hljs-built_in,
-.hljs-builtin-name,
-.hljs-literal,
-.hljs-type,
-.hljs-params {
- color: #b21e00;
-}
-
-/* Green */
-.hljs-string,
-.hljs-symbol,
-.hljs-bullet {
- color: #008200;
-}
-
-/* Blue */
-.hljs-title,
-.hljs-section {
- color: #0030f2;
-}
-
-/* Purple */
-.hljs-keyword,
-.hljs-selector-tag {
- color: #9d00ec;
-}
-
-.hljs {
- display: block;
- overflow-x: auto;
- background: #f6f7f6;
- color: #000;
-}
-
-.hljs-emphasis {
- font-style: italic;
-}
-
-.hljs-strong {
- font-weight: bold;
-}
-
-.hljs-addition {
- color: #22863a;
- background-color: #f0fff4;
-}
-
-.hljs-deletion {
- color: #b31d28;
- background-color: #ffeef0;
-}
diff --git a/docs/book/highlight.js b/docs/book/highlight.js
deleted file mode 100644
index 18d2434..0000000
--- a/docs/book/highlight.js
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- Highlight.js 10.1.1 (93fd0d73)
- License: BSD-3-Clause
- Copyright (c) 2006-2020, Ivan Sagalaev
-*/
-var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- FAQ
-How do I get JSON data from the body of a request (e.g., POST, PUT)?
-With nova, you can use the rc.Bind() method on the ResponseContext to automatically decode JSON from the request body into your struct. This avoids manual decoding and error handling boilerplate.
Here is a complete example using PostFunc and rc.Bind():
package main
-
-import (
- "log"
- "net/http"
-
- "github.com/xlc-dev/nova/nova"
-)
-
-// MyData defines the structure of our expected JSON payload.
-type MyData struct {
- Name string `json:"name"`
- Value int `json:"value"`
-}
-
-// handleJsonRequest uses nova's ResponseContext to simplify data binding and response.
-func handleJsonRequest(rc *nova.ResponseContext) error {
- var data MyData
-
- // Bind the incoming JSON request body to the 'data' struct.
- if err := rc.BindJSON(&data); err != nil {
- // If binding fails (e.g., malformed JSON), return a 400 Bad Request.
- log.Printf("Error binding JSON: %v", err)
- return rc.JSONError(http.StatusBadRequest, "Invalid JSON payload")
- }
-
- log.Printf("Received data: Name=%s, Value=%d\n", data.Name, data.Value)
-
- // Send a success response using the JSON helper.
- response := map[string]any{
- "status": "success",
- "received_name": data.Name,
- }
- return rc.JSON(http.StatusOK, response)
-}
-
-func main() {
- router := nova.NewRouter()
- router.PostFunc("/data", handleJsonRequest)
-
- log.Println("Server starting on :8080")
- if err := http.ListenAndServe(":8080", router); err != nil {
- log.Fatalf("Server failed to start: %v", err)
- }
-}
-How do I get data from a GET request?
-GET requests typically pass data in two ways: URL query parameters (e.g., ?id=123) or path parameters (e.g., /items/123). nova makes handling both easy.
1. Reading Query Parameters
-For query parameters, you can access the standard http.Request object via rc.Request() and use its URL.Query() method.
// handleGetWithQuery processes data from URL query parameters.
-// Example request: GET /items?name=widget&id=123
-func handleGetWithQuery(rc *nova.ResponseContext) error {
- // Access the underlying request to get query parameters.
- queryParams := rc.Request().URL.Query()
-
- name := queryParams.Get("name")
- idStr := queryParams.Get("id")
-
- if name == "" || idStr == "" {
- return rc.JSONError(http.StatusBadRequest, "Missing 'name' or 'id' query parameter")
- }
-
- log.Printf("Processed query: name=%s, id=%s\n", name, idStr)
-
- response := map[string]string{
- "item_name": name,
- "item_id": idStr,
- }
- return rc.JSON(http.StatusOK, response)
-}
-
-// In main():
-// router.GetFunc("/items", handleGetWithQuery)
-2. Reading Path Parameters
-For path parameters defined in your route (e.g., /{id}), nova provides the much cleaner rc.URLParam() helper.
// handleGetWithPathVar processes data from a URL path parameter.
-// Example request: GET /users/42
-func handleGetWithPathVar(rc *nova.ResponseContext) error {
- // Use the URLParam helper to get the 'id' from the path.
- userID := rc.URLParam("id")
-
- log.Printf("Processed request for user ID: %s\n", userID)
-
- response := map[string]string{
- "status": "found",
- "user_id": userID,
- }
- return rc.JSON(http.StatusOK, response)
-}
-
-// In main():
-// router.GetFunc("/users/{id}", handleGetWithPathVar)
-How do I validate incoming request data?
-Nova has powerful, built-in validation. Instead of rc.Bind(), use rc.BindValidated(). It automatically binds the data and then runs validations based on the struct tags you’ve defined (required, minlength, format, etc.).
If validation fails, it returns a detailed error, which you can send back to the client.
-package main
-
-import (
- "log"
- "net/http"
-
- "github.com/xlc-dev/nova/nova"
-)
-
-// UserSignup defines a struct with validation tags.
-type UserSignup struct {
- Username string `json:"username" minlength:"3" maxlength:"20" format:"alphanumeric"`
- Email string `json:"email" format:"email"`
- // omitempty is not used, so this field is required by default.
- Password string `json:"password" format:"password"`
-}
-
-// handleUserSignup binds and validates the request body in one step.
-func handleUserSignup(rc *nova.ResponseContext) error {
- var user UserSignup
-
- // Bind AND validate the incoming JSON.
- if err := rc.BindValidated(&user); err != nil {
- // e.g., "validation failed: Field 'username' must contain only alphanumeric characters"
- log.Printf("Validation failed: %v", err)
- return rc.JSONError(http.StatusBadRequest, err.Error())
- }
-
- log.Printf("Successfully validated and created user: %s", user.Username)
-
- response := map[string]string{
- "status": "user_created",
- "username": user.Username,
- }
- return rc.JSON(http.StatusCreated, response)
-}
-
-func main() {
- router := nova.NewRouter()
- router.PostFunc("/signup", handleUserSignup)
-
- log.Println("Server starting on :8080")
- if err := http.ListenAndServe(":8080", router); err != nil {
- log.Fatalf("Server failed to start: %v", err)
- }
-}
-":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/book/mark.min.js b/docs/book/mark.min.js
deleted file mode 100644
index 1636231..0000000
--- a/docs/book/mark.min.js
+++ /dev/null
@@ -1,7 +0,0 @@
-/*!***************************************************
-* mark.js v8.11.1
-* https://markjs.io/
-* Copyright (c) 2014–2018, Julian Kühnel
-* Released under the MIT license https://git.io/vwTVl
-*****************************************************/
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Nova
-Welcome to Nova.
-Nova is a flexible framework that simplifies creating both RESTful APIs and web UIs. -It extends Go’s standard library with sensible defaults and helper utilities for components like routing, middleware, OpenAPI, and HTML templating, minimizing decision fatique. -Making it easier than ever to build powerful web applications in Go.
-Why Choose Nova?
-Nova is designed to be a lightweight framework that has as little dependencies as possible. -It is built on top of Go’s standard library, making it easy to integrate with existing Go codebases and libraries.
-Together with the CLI tool, Nova provides a streamlined development experience for building web applications.
-Key Features:
--
-
- 🛠️ CLI Tooling: Integrated command-line tooling to build any CLI for your application. -
- 🏗️ Project Scaffolding: Quickly generate new projects with a sensible default structure using
nova new.
- - 🗃️ Database Migrations: Manage database migrations effortlessly with the
novabinary.
- - 🛠️ Streamlined REST APIs: Simplified routing, request handling, and response generation. -
- 🚧 OpenAPI: Built-in support for request validation and OpenAPI (Swagger) spec generation. -
- 🧩 Middleware Support: Easily add and manage middleware for enhanced functionality. -
- 📄 Templating Engine: Built-in support for building HTML templates within Go files. -
Getting Started
-To get started with Nova, read the Quickstart guide, or check out the example project.
-License
-This project is licensed under the MIT License.
- -"),"placeholderToBreak"),FG=o(t=>t.replace(nd,"#br#"),"breakToPlaceholder"),e3e=o(t=>{let e="";return t&&(e=window.location.protocol+"//"+window.location.host+window.location.pathname+window.location.search,e=e.replaceAll(/\(/g,"\\("),e=e.replaceAll(/\)/g,"\\)")),e},"getUrl"),fr=o(t=>!(t===!1||["false","null","0"].includes(String(t).trim().toLowerCase())),"evaluate"),t3e=o(function(...t){let e=t.filter(r=>!isNaN(r));return Math.max(...e)},"getMax"),r3e=o(function(...t){let e=t.filter(r=>!isNaN(r));return Math.min(...e)},"getMin"),ec=o(function(t){let e=t.split(/(,)/),r=[];for(let n=0;n
${i}
`:`${i}
`).join("").replace(eA,(i,a)=>r.renderToString(a,{throwOnError:!0,displayMode:!0,output:n}).replace(/\n/g," ").replace(/"},r),Ze.lineBreakRegex.test(t)))return t;let n=t.split(" ").filter(Boolean),i=[],a="";return n.forEach((s,l)=>{let u=ra(`${s} `,r),h=ra(a,r);if(u>e){let{hyphenatedStrings:p,remainingWord:m}=ACe(s,e,"-",r);i.push(a,...p),a=m}else h+u>=e?(i.push(a),a=s):a=[a,s].filter(Boolean).join(" ");l+1===n.length&&i.push(a)}),i.filter(s=>s!=="").join(r.joinWith)},(t,e,r)=>`${t}${e}${r.fontSize}${r.fontWeight}${r.fontFamily}${r.joinWith}`),ACe=H0((t,e,r="-",n)=>{n=Object.assign({fontSize:12,fontWeight:400,fontFamily:"Arial",margin:0},n);let i=[...t],a=[],s="";return i.forEach((l,u)=>{let h=`${s}${l}`;if(ra(h,n)>=e){let d=u+1,p=i.length===d,m=`${h}${r}`;a.push(p?h:m),s=""}else s=h}),{hyphenatedStrings:a,remainingWord:s}},(t,e,r="-",n)=>`${t}${e}${r}${n.fontSize}${n.fontWeight}${n.fontFamily}`);o(dw,"calculateTextHeight");o(ra,"calculateTextWidth");Q9=H0((t,e)=>{let{fontSize:r=12,fontFamily:n="Arial",fontWeight:i=400}=e;if(!t)return{width:0,height:0};let[,a]=Bo(r),s=["sans-serif",n],l=t.split(Ze.lineBreakRegex),u=[],h=Ge("body");if(!h.remove)return{width:0,height:0,lineHeight:0};let f=h.append("svg");for(let p of s){let m=0,g={width:0,height:0,lineHeight:0};for(let y of l){let v=SCe();v.text=y||H9;let x=CCe(f,v).style("font-size",a).style("font-weight",i).style("font-family",p),b=(x._groups||x)[0][0].getBBox();if(b.width===0&&b.height===0)throw new Error("svg element not in render tree");g.width=Math.round(Math.max(g.width,b.width)),m=Math.round(b.height),g.height+=m,g.lineHeight=Math.round(Math.max(g.lineHeight,m))}u.push(g)}f.remove();let d=isNaN(u[1].height)||isNaN(u[1].width)||isNaN(u[1].lineHeight)||u[0].height>u[1].height&&u[0].width>u[1].width&&u[0].lineHeight>u[1].lineHeight?0:1;return u[d]},(t,e)=>`${t}${e.fontSize}${e.fontWeight}${e.fontFamily}`),U9=class{constructor(e=!1,r){this.count=0;this.count=r?r.length:0,this.next=e?()=>this.count++:()=>Date.now()}static{o(this,"InitIDGenerator")}},_Ce=o(function(t){return fw=fw||document.createElement("div"),t=escape(t).replace(/%26/g,"&").replace(/%23/g,"#").replace(/%3B/g,";"),fw.innerHTML=t,unescape(fw.textContent)},"entityDecode");o(Z9,"isDetailedError");DCe=o((t,e,r,n)=>{if(!n)return;let i=t.node()?.getBBox();i&&t.append("text").text(n).attr("text-anchor","middle").attr("x",i.x+i.width/2).attr("y",-r).attr("class",e)},"insertTitle"),Bo=o(t=>{if(typeof t=="number")return[t,t+"px"];let e=parseInt(t??"",10);return Number.isNaN(e)?[void 0,void 0]:t===String(e)?[e,t+"px"]:[e,t]},"parseFontSize");o(Fi,"cleanAndMerge");Gt={assignWithDepth:Gn,wrapLabel:K9,calculateTextHeight:dw,calculateTextWidth:ra,calculateTextDimensions:Q9,cleanAndMerge:Fi,detectInit:gCe,detectDirective:MX,isSubstringInArray:yCe,interpolateToCurve:W9,calcLabelPosition:wCe,calcCardinalityPosition:TCe,calcTerminalLabelPosition:kCe,formatUrl:vCe,getStylesFromArray:Y9,generateId:X9,random:j9,runFunc:xCe,entityDecode:_Ce,insertTitle:DCe,parseFontSize:Bo,InitIDGenerator:U9},PX=o(function(t){let e=t;return e=e.replace(/style.*:\S*#.*;/g,function(r){return r.substring(0,r.length-1)}),e=e.replace(/classDef.*:\S*#.*;/g,function(r){return r.substring(0,r.length-1)}),e=e.replace(/#\w+;/g,function(r){let n=r.substring(1,r.length-1);return/^\+?\d+$/.test(n)?"\uFB02\xB0\xB0"+n+"\xB6\xDF":"\uFB02\xB0"+n+"\xB6\xDF"}),e},"encodeEntities"),na=o(function(t){return t.replace(/fl°°/g,"&#").replace(/fl°/g,"&").replace(/¶ß/g,";")},"decodeEntities"),$h=o((t,e,{counter:r=0,prefix:n,suffix:i},a)=>a||`${n?`${n}_`:""}${t}_${e}_${r}${i?`_${i}`:""}`,"getEdgeId");o($n,"handleUndefinedAttr")});function Cl(t,e,r,n,i){if(!e[t].width)if(r)e[t].text=K9(e[t].text,i,n),e[t].textLines=e[t].text.split(Ze.lineBreakRegex).length,e[t].width=i,e[t].height=dw(e[t].text,n);else{let a=e[t].text.split(Ze.lineBreakRegex);e[t].textLines=a.length;let s=0;e[t].height=0,e[t].width=0;for(let l of a)e[t].width=Math.max(ra(l,n),e[t].width),s=dw(l,n),e[t].height=e[t].height+s}}function GX(t,e,r,n,i){let a=new yw(i);a.data.widthLimit=r.data.widthLimit/Math.min(J9,n.length);for(let[s,l]of n.entries()){let u=0;l.image={width:0,height:0,Y:0},l.sprite&&(l.image.width=48,l.image.height=48,l.image.Y=u,u=l.image.Y+l.image.height);let h=l.wrap&&Vt.wrap,f=pw(Vt);if(f.fontSize=f.fontSize+2,f.fontWeight="bold",Cl("label",l,h,f,a.data.widthLimit),l.label.Y=u+8,u=l.label.Y+l.label.height,l.type&&l.type.text!==""){l.type.text="["+l.type.text+"]";let g=pw(Vt);Cl("type",l,h,g,a.data.widthLimit),l.type.Y=u+5,u=l.type.Y+l.type.height}if(l.descr&&l.descr.text!==""){let g=pw(Vt);g.fontSize=g.fontSize-2,Cl("descr",l,h,g,a.data.widthLimit),l.descr.Y=u+20,u=l.descr.Y+l.descr.height}if(s==0||s%J9===0){let g=r.data.startx+Vt.diagramMarginX,y=r.data.stopy+Vt.diagramMarginY+u;a.setData(g,g,y,y)}else{let g=a.data.stopx!==a.data.startx?a.data.stopx+Vt.diagramMarginX:a.data.startx,y=a.data.starty;a.setData(g,g,y,y)}a.name=l.alias;let d=i.db.getC4ShapeArray(l.alias),p=i.db.getC4ShapeKeys(l.alias);p.length>0&&zX(a,t,d,p),e=l.alias;let m=i.db.getBoundarys(e);m.length>0&&GX(t,e,a,m,i),l.alias!=="global"&&$X(t,l,a),r.data.stopy=Math.max(a.data.stopy+Vt.c4ShapeMargin,r.data.stopy),r.data.stopx=Math.max(a.data.stopx+Vt.c4ShapeMargin,r.data.stopx),mw=Math.max(mw,r.data.stopx),gw=Math.max(gw,r.data.stopy)}}var mw,gw,FX,J9,Vt,yw,eD,a2,pw,LCe,$X,zX,_s,BX,RCe,NCe,MCe,tD,VX=N(()=>{"use strict";dr();Bq();vt();$C();gr();uA();zt();s0();ir();Ei();mw=0,gw=0,FX=4,J9=2;Ty.yy=Qy;Vt={},yw=class{static{o(this,"Bounds")}constructor(e){this.name="",this.data={},this.data.startx=void 0,this.data.stopx=void 0,this.data.starty=void 0,this.data.stopy=void 0,this.data.widthLimit=void 0,this.nextData={},this.nextData.startx=void 0,this.nextData.stopx=void 0,this.nextData.starty=void 0,this.nextData.stopy=void 0,this.nextData.cnt=0,eD(e.db.getConfig())}setData(e,r,n,i){this.nextData.startx=this.data.startx=e,this.nextData.stopx=this.data.stopx=r,this.nextData.starty=this.data.starty=n,this.nextData.stopy=this.data.stopy=i}updateVal(e,r,n,i){e[r]===void 0?e[r]=n:e[r]=i(n,e[r])}insert(e){this.nextData.cnt=this.nextData.cnt+1;let r=this.nextData.startx===this.nextData.stopx?this.nextData.stopx+e.margin:this.nextData.stopx+e.margin*2,n=r+e.width,i=this.nextData.starty+e.margin*2,a=i+e.height;(r>=this.data.widthLimit||n>=this.data.widthLimit||this.nextData.cnt>FX)&&(r=this.nextData.startx+e.margin+Vt.nextLinePaddingX,i=this.nextData.stopy+e.margin*2,this.nextData.stopx=n=r+e.width,this.nextData.starty=this.nextData.stopy,this.nextData.stopy=a=i+e.height,this.nextData.cnt=1),e.x=r,e.y=i,this.updateVal(this.data,"startx",r,Math.min),this.updateVal(this.data,"starty",i,Math.min),this.updateVal(this.data,"stopx",n,Math.max),this.updateVal(this.data,"stopy",a,Math.max),this.updateVal(this.nextData,"startx",r,Math.min),this.updateVal(this.nextData,"starty",i,Math.min),this.updateVal(this.nextData,"stopx",n,Math.max),this.updateVal(this.nextData,"stopy",a,Math.max)}init(e){this.name="",this.data={startx:void 0,stopx:void 0,starty:void 0,stopy:void 0,widthLimit:void 0},this.nextData={startx:void 0,stopx:void 0,starty:void 0,stopy:void 0,cnt:0},eD(e.db.getConfig())}bumpLastMargin(e){this.data.stopx+=e,this.data.stopy+=e}},eD=o(function(t){Gn(Vt,t),t.fontFamily&&(Vt.personFontFamily=Vt.systemFontFamily=Vt.messageFontFamily=t.fontFamily),t.fontSize&&(Vt.personFontSize=Vt.systemFontSize=Vt.messageFontSize=t.fontSize),t.fontWeight&&(Vt.personFontWeight=Vt.systemFontWeight=Vt.messageFontWeight=t.fontWeight)},"setConf"),a2=o((t,e)=>({fontFamily:t[e+"FontFamily"],fontSize:t[e+"FontSize"],fontWeight:t[e+"FontWeight"]}),"c4ShapeFont"),pw=o(t=>({fontFamily:t.boundaryFontFamily,fontSize:t.boundaryFontSize,fontWeight:t.boundaryFontWeight}),"boundaryFont"),LCe=o(t=>({fontFamily:t.messageFontFamily,fontSize:t.messageFontSize,fontWeight:t.messageFontWeight}),"messageFont");o(Cl,"calcC4ShapeTextWH");$X=o(function(t,e,r){e.x=r.data.startx,e.y=r.data.starty,e.width=r.data.stopx-r.data.startx,e.height=r.data.stopy-r.data.starty,e.label.y=Vt.c4ShapeMargin-35;let n=e.wrap&&Vt.wrap,i=pw(Vt);i.fontSize=i.fontSize+2,i.fontWeight="bold";let a=ra(e.label.text,i);Cl("label",e,n,i,a),kl.drawBoundary(t,e,Vt)},"drawBoundary"),zX=o(function(t,e,r,n){let i=0;for(let a of n){i=0;let s=r[a],l=a2(Vt,s.typeC4Shape.text);switch(l.fontSize=l.fontSize-2,s.typeC4Shape.width=ra("\xAB"+s.typeC4Shape.text+"\xBB",l),s.typeC4Shape.height=l.fontSize+2,s.typeC4Shape.Y=Vt.c4ShapePadding,i=s.typeC4Shape.Y+s.typeC4Shape.height-4,s.image={width:0,height:0,Y:0},s.typeC4Shape.text){case"person":case"external_person":s.image.width=48,s.image.height=48,s.image.Y=i,i=s.image.Y+s.image.height;break}s.sprite&&(s.image.width=48,s.image.height=48,s.image.Y=i,i=s.image.Y+s.image.height);let u=s.wrap&&Vt.wrap,h=Vt.width-Vt.c4ShapePadding*2,f=a2(Vt,s.typeC4Shape.text);if(f.fontSize=f.fontSize+2,f.fontWeight="bold",Cl("label",s,u,f,h),s.label.Y=i+8,i=s.label.Y+s.label.height,s.type&&s.type.text!==""){s.type.text="["+s.type.text+"]";let m=a2(Vt,s.typeC4Shape.text);Cl("type",s,u,m,h),s.type.Y=i+5,i=s.type.Y+s.type.height}else if(s.techn&&s.techn.text!==""){s.techn.text="["+s.techn.text+"]";let m=a2(Vt,s.techn.text);Cl("techn",s,u,m,h),s.techn.Y=i+5,i=s.techn.Y+s.techn.height}let d=i,p=s.label.width;if(s.descr&&s.descr.text!==""){let m=a2(Vt,s.typeC4Shape.text);Cl("descr",s,u,m,h),s.descr.Y=i+20,i=s.descr.Y+s.descr.height,p=Math.max(s.label.width,s.descr.width),d=i-s.descr.textLines*5}p=p+Vt.c4ShapePadding,s.width=Math.max(s.width||Vt.width,p,Vt.width),s.height=Math.max(s.height||Vt.height,d,Vt.height),s.margin=s.margin||Vt.c4ShapeMargin,t.insert(s),kl.drawC4Shape(e,s,Vt)}t.bumpLastMargin(Vt.c4ShapeMargin)},"drawC4ShapeArray"),_s=class{static{o(this,"Point")}constructor(e,r){this.x=e,this.y=r}},BX=o(function(t,e){let r=t.x,n=t.y,i=e.x,a=e.y,s=r+t.width/2,l=n+t.height/2,u=Math.abs(r-i),h=Math.abs(n-a),f=h/u,d=t.height/t.width,p=null;return n==a&&r
'+(n?a:pc(a,!0))+`"+(n?a:pc(a,!0))+`-${this.parser.parse(e)}-`}html({text:e}){return e}heading({tokens:e,depth:r}){return`
-`}list(e){let r=e.ordered,n=e.start,i="";for(let l=0;l
${this.parser.parseInline(e)}
-`}table(e){let r="",n="";for(let a=0;a${pc(e,!0)}`}br(e){return""}del({tokens:e}){return`
An error occurred:
"+pc(n.message+"",!0)+"";return r?Promise.resolve(i):i}if(r)return Promise.reject(n);throw n}}},Md=new yD;o(Jr,"marked");Jr.options=Jr.setOptions=function(t){return Md.setOptions(t),Jr.defaults=Md.defaults,Gj(Jr.defaults),Jr};Jr.getDefaults=vD;Jr.defaults=Id;Jr.use=function(...t){return Md.use(...t),Jr.defaults=Md.defaults,Gj(Jr.defaults),Jr};Jr.walkTokens=function(t,e){return Md.walkTokens(t,e)};Jr.parseInline=Md.parseInline;Jr.Parser=_l;Jr.parser=_l.parse;Jr.Renderer=fm;Jr.TextRenderer=p2;Jr.Lexer=Al;Jr.lexer=Al.lex;Jr.Tokenizer=hm;Jr.Hooks=um;Jr.parse=Jr;dkt=Jr.options,pkt=Jr.setOptions,mkt=Jr.use,gkt=Jr.walkTokens,ykt=Jr.parseInline,vkt=_l.parse,xkt=Al.lex});function G8e(t,{markdownAutoWrap:e}){let n=t.replace(/
").replace(/ /g," "):i.text.replace(/\n */g,"
"):i.type==="strong"?`${i.tokens?.map(n).join("")}`:i.type==="em"?`${i.tokens?.map(n).join("")}`:i.type==="paragraph"?`
${i.tokens?.map(n).join("")}
`:i.type==="space"?"":i.type==="html"?`${i.text}`:i.type==="escape"?i.text:`Unsupported markdown: ${i.type}`}return o(n,"output"),r.map(n).join("")}var tK=N(()=>{"use strict";Zj();PC();o(G8e,"preprocessMarkdown");o(Jj,"markdownToLines");o(eK,"markdownToHTML")});function V8e(t){return Intl.Segmenter?[...new Intl.Segmenter().segment(t)].map(e=>e.segment):[...t]}function U8e(t,e){let r=V8e(e.content);return rK(t,[],r,e.type)}function rK(t,e,r,n){if(r.length===0)return[{content:e.join(""),type:n},{content:"",type:n}];let[i,...a]=r,s=[...e,i];return t([{content:s.join(""),type:n}])?rK(t,s,a,n):(e.length===0&&i&&(e.push(i),r.shift()),[{content:e.join(""),type:n},{content:r.join(""),type:n}])}function nK(t,e){if(t.some(({content:r})=>r.includes(` -`)))throw new Error("splitLineToFitWidth does not support newlines in the line");return CD(t,e)}function CD(t,e,r=[],n=[]){if(t.length===0)return n.length>0&&r.push(n),r.length>0?r:[];let i="";t[0].content===" "&&(i=" ",t.shift());let a=t.shift()??{content:" ",type:"normal"},s=[...n];if(i!==""&&s.push({content:i,type:"normal"}),s.push(a),e(s))return CD(t,e,r,s);if(n.length>0)r.push(n),t.unshift(a);else if(a.content){let[l,u]=U8e(e,a);r.push([l]),u.content&&t.unshift(u)}return CD(t,e,r)}var iK=N(()=>{"use strict";o(V8e,"splitTextToChars");o(U8e,"splitWordToFitWidth");o(rK,"splitWordToFitWidthRecursion");o(nK,"splitLineToFitWidth");o(CD,"splitLineToFitWidthRecursion")});function aK(t,e){e&&t.attr("style",e)}async function H8e(t,e,r,n,i=!1){let a=t.append("foreignObject");a.attr("width",`${10*r}px`),a.attr("height",`${10*r}px`);let s=a.append("xhtml:div"),l=e.label;e.label&&pi(e.label)&&(l=await mh(e.label.replace(Ze.lineBreakRegex,` -`),me()));let u=e.isNode?"nodeLabel":"edgeLabel",h=s.append("span");h.html(l),aK(h,e.labelStyle),h.attr("class",`${u} ${n}`),aK(s,e.labelStyle),s.style("display","table-cell"),s.style("white-space","nowrap"),s.style("line-height","1.5"),s.style("max-width",r+"px"),s.style("text-align","center"),s.attr("xmlns","http://www.w3.org/1999/xhtml"),i&&s.attr("class","labelBkg");let f=s.node().getBoundingClientRect();return f.width===r&&(s.style("display","table"),s.style("white-space","break-spaces"),s.style("width",r+"px"),f=s.node().getBoundingClientRect()),a.node()}function AD(t,e,r){return t.append("tspan").attr("class","text-outer-tspan").attr("x",0).attr("y",e*r-.1+"em").attr("dy",r+"em")}function W8e(t,e,r){let n=t.append("text"),i=AD(n,1,e);_D(i,r);let a=i.node().getComputedTextLength();return n.remove(),a}function sK(t,e,r){let n=t.append("text"),i=AD(n,1,e);_D(i,[{content:r,type:"normal"}]);let a=i.node()?.getBoundingClientRect();return a&&n.remove(),a}function q8e(t,e,r,n=!1){let a=e.append("g"),s=a.insert("rect").attr("class","background").attr("style","stroke: none"),l=a.append("text").attr("y","-10.1"),u=0;for(let h of r){let f=o(p=>W8e(a,1.1,p)<=t,"checkWidth"),d=f(h)?[h]:nK(h,f);for(let p of d){let m=AD(l,u,1.1);_D(m,p),u++}}if(n){let h=l.node().getBBox(),f=2;return s.attr("x",h.x-f).attr("y",h.y-f).attr("width",h.width+2*f).attr("height",h.height+2*f),a.node()}else return l.node()}function _D(t,e){t.text(""),e.forEach((r,n)=>{let i=t.append("tspan").attr("font-style",r.type==="em"?"italic":"normal").attr("class","text-inner-tspan").attr("font-weight",r.type==="strong"?"bold":"normal");n===0?i.text(r.content):i.text(" "+r.content)})}function DD(t){return t.replace(/fa[bklrs]?:fa-[\w-]+/g,e=>``)}var Hn,to=N(()=>{"use strict";zt();gr();dr();vt();tK();ir();iK();o(aK,"applyStyle");o(H8e,"addHtmlSpan");o(AD,"createTspan");o(W8e,"computeWidthOfText");o(sK,"computeDimensionOfText");o(q8e,"createFormattedText");o(_D,"updateTextContentAndStyles");o(DD,"replaceIconSubstring");Hn=o(async(t,e="",{style:r="",isTitle:n=!1,classes:i="",useHtmlLabels:a=!0,isNode:s=!0,width:l=200,addSvgBackground:u=!1}={},h)=>{if(Y.debug("XYZ createText",e,r,n,i,a,s,"addSvgBackground: ",u),a){let f=eK(e,h),d=DD(na(f)),p=e.replace(/\\\\/g,"\\"),m={isNode:s,label:pi(e)?p:d,labelStyle:r.replace("fill:","color:")};return await H8e(t,m,l,i,u)}else{let f=e.replace(/"),d=Jj(f.replace("
","
"),h),p=q8e(l,t,d,e?u:!1);if(s){/stroke:/.exec(r)&&(r=r.replace("stroke:","lineColor:"));let m=r.replace(/stroke:[^;]+;?/g,"").replace(/stroke-width:[^;]+;?/g,"").replace(/fill:[^;]+;?/g,"").replace(/color:/g,"fill:");Ge(p).attr("style",m)}else{let m=r.replace(/stroke:[^;]+;?/g,"").replace(/stroke-width:[^;]+;?/g,"").replace(/fill:[^;]+;?/g,"").replace(/background:/g,"fill:");Ge(p).select("rect").attr("style",m.replace(/background:/g,"fill:"));let g=r.replace(/stroke:[^;]+;?/g,"").replace(/stroke-width:[^;]+;?/g,"").replace(/fill:[^;]+;?/g,"").replace(/color:/g,"fill:");Ge(p).select("text").attr("style",g)}return p}},"createText")});function Xt(t){let e=t.map((r,n)=>`${n===0?"M":"L"}${r.x},${r.y}`);return e.push("Z"),e.join(" ")}function Fo(t,e,r,n,i,a){let s=[],u=r-t,h=n-e,f=u/a,d=2*Math.PI/f,p=e+h/2;for(let m=0;m<=50;m++){let g=m/50,y=t+g*u,v=p+i*Math.sin(d*(y-t));s.push({x:y,y:v})}return s}function Lw(t,e,r,n,i,a){let s=[],l=i*Math.PI/180,f=(a*Math.PI/180-l)/(n-1);for(let d=0;d
"),Y.info("vertexText"+i);let a={isNode:n,label:na(i).replace(/fa[blrs]?:fa-[\w-]+/g,l=>``),labelStyle:e&&e.replace("fill:","color:")};return await v_e(a)}else{let a=document.createElementNS("http://www.w3.org/2000/svg","text");a.setAttribute("style",e.replace("color:","fill:"));let s=[];typeof i=="string"?s=i.split(/\\n|\n|
"):p,e.labelStyle,!0,!0)),y=g.children[0],v=Ge(g);d=y.getBoundingClientRect(),v.attr("width",d.width),v.attr("height",d.height);let x=(e.padding||0)/2;Ge(g).attr("transform","translate( "+(d.width>m.width?0:(m.width-d.width)/2)+", "+(m.height+x+5)+")"),Ge(f).attr("transform","translate( "+(d.width
").length,d.innerHTML.includes("")&&(f+=d.innerHTML.split("
")),s.classed("hover",!0)}).on("mouseout",a=>{r.transition().duration(500).style("opacity",0),Ge(a.currentTarget).classed("hover",!1)})}clear(e="gen-2"){this.vertices=new Map,this.classes=new Map,this.edges=[],this.funs=[this.setupToolTips.bind(this)],this.subGraphs=[],this.subGraphLookup=new Map,this.subCount=0,this.tooltips=new Map,this.firstGraphFlag=!0,this.version=e,this.config=me(),Ar()}setGen(e){this.version=e||"gen-2"}defaultStyle(){return"fill:#ffa;stroke: #f66; stroke-width: 3px; stroke-dasharray: 5, 5;fill:#ffa;stroke: #666;"}addSubGraph(e,r,n){let i=e.text.trim(),a=n.text;e===n&&/\s/.exec(n.text)&&(i=void 0);let s=o(f=>{let d={boolean:{},number:{},string:{}},p=[],m;return{nodeList:f.filter(function(y){let v=typeof y;return y.stmt&&y.stmt==="dir"?(m=y.value,!1):y.trim()===""?!1:v in d?d[v].hasOwnProperty(y)?!1:d[v][y]=!0:p.includes(y)?!1:p.push(y)}),dir:m}},"uniq"),{nodeList:l,dir:u}=s(r.flat());if(this.version==="gen-1")for(let f=0;f