|
6 | 6 |
|
7 | 7 | ## Container Context |
8 | 8 |
|
9 | | - |
| 9 | +<img src="./diagrams/structurizr-Containers.png" alt="Container Diagram" style="max-width: 100%; height: auto;"> |
10 | 10 |
|
11 | 11 | --- |
12 | 12 |
|
13 | 13 | ## Container Information |
14 | 14 |
|
15 | | -<table> |
16 | | -<tbody> |
17 | | -<tr> |
18 | | -<td><strong>Name</strong></td> |
19 | | -<td>@chrislyons-dev/flarelette-jwt</td> |
20 | | -</tr> |
21 | | -<tr> |
22 | | -<td><strong>Type</strong></td> |
23 | | -<td><code>Service</code></td> |
24 | | -</tr> |
25 | | -<tr> |
26 | | -<td><strong>Description</strong></td> |
27 | | -<td>Environment-driven JWT authentication for Cloudflare Workers with secret-name indirection</td> |
28 | | -</tr> |
29 | | -<tr> |
30 | | -<td><strong>Tags</strong></td> |
31 | | -<td><code>Auto-generated</code></td> |
32 | | -</tr> |
33 | | -</tbody> |
34 | | -</table> |
35 | | - |
| 15 | +| Field | Value | |
| 16 | +| --- | --- | |
| 17 | +| **Name** | @chrislyons-dev/flarelette-jwt | |
| 18 | +| **Type** | `Service` | |
| 19 | +| **Description** | TypeScript implementation of the Flarelette JWT Kit: An environment-driven JWT authentication package for Cloudflare Workers || **Tags** | `Auto-generated` | |
36 | 20 | --- |
37 | 21 |
|
38 | 22 | ## Components |
39 | 23 |
|
40 | 24 |
|
41 | 25 | ### Component View |
42 | 26 |
|
43 | | - |
| 27 | +<img src="./diagrams/structurizr-Components__chrislyons_dev_flarelette_jwt.png" alt="Component Diagram" style="max-width: 100%; height: auto;"> |
44 | 28 |
|
45 | 29 | ### Component Details |
46 | 30 |
|
47 | | -<table> |
48 | | -<thead> |
49 | | -<tr> |
50 | | -<th>Component</th> |
51 | | -<th>Type</th> |
52 | | -<th>Description</th> |
53 | | -<th>Code</th> |
54 | | -</tr> |
55 | | -</thead> |
56 | | -<tbody> |
57 | | -<tr> |
58 | | -<td><strong>core</strong></td> |
59 | | -<td><code>module</code></td> |
60 | | -<td>CLI utility for generating JWT secrets. |
61 | | - |
62 | | -This script provides options to generate secrets in various formats, including JSON and dotenv. |
63 | | -It is designed to be executed as a standalone Node.js script. | Configuration utilities for JWT operations. |
64 | | - |
65 | | -This module provides functions to read environment variables and derive JWT-related configurations. |
66 | | -It includes support for both symmetric (HS512) and asymmetric (EdDSA) algorithms. | JWT signing utilities. |
67 | | - |
68 | | -This module provides functions to sign JWT tokens using either HS512 or EdDSA algorithms. |
69 | | -It supports custom claims and configuration overrides.</td> |
70 | | -<td><a href="./chrislyons_dev_flarelette_jwt__core.md">View →</a></td> |
71 | | -</tr> |
72 | | -<tr> |
73 | | -<td><strong>explicit</strong></td> |
74 | | -<td><code>module</code></td> |
75 | | -<td>Explicit configuration API for JWT operations. |
76 | | - |
77 | | -This module provides functions that accept explicit configuration objects |
78 | | -instead of relying on environment variables or global state. Use this API |
79 | | -when you need full control over configuration, especially in development |
80 | | -environments or when working with multiple JWT configurations.</td> |
81 | | -<td><a href="./chrislyons_dev_flarelette_jwt__explicit.md">View →</a></td> |
82 | | -</tr> |
83 | | -<tr> |
84 | | -<td><strong>util</strong></td> |
85 | | -<td><code>module</code></td> |
86 | | -<td>High-level JWT utilities for creating, delegating, verifying, and authorizing JWT tokens | Key generation utility for EdDSA keys. |
87 | | - |
88 | | -This script generates EdDSA key pairs and exports them in JWK format. |
89 | | -It is designed to be executed as a standalone Node.js script. | Secret generation and validation utilities. |
90 | | - |
91 | | -This module provides functions to generate secure secrets and validate base64url-encoded secrets. |
92 | | -It ensures compatibility with JWT signing requirements. | Utility functions for JWT operations. |
93 | | - |
94 | | -This module provides helper functions for parsing JWTs, checking expiration, and mapping OAuth scopes. |
95 | | -It is designed to support core JWT functionalities.</td> |
96 | | -<td><a href="./chrislyons_dev_flarelette_jwt__util.md">View →</a></td> |
97 | | -</tr> |
98 | | -<tr> |
99 | | -<td><strong>main</strong></td> |
100 | | -<td><code>module</code></td> |
101 | | -<td>Entry point for the flarelette-jwt library. |
102 | | - |
103 | | -This module re-exports core functionalities, including signing, verification, utilities, and type definitions. |
104 | | -It serves as the main interface for library consumers.</td> |
105 | | -<td><a href="./chrislyons_dev_flarelette_jwt__main.md">View →</a></td> |
106 | | -</tr> |
107 | | -<tr> |
108 | | -<td><strong>jwks</strong></td> |
109 | | -<td><code>module</code></td> |
110 | | -<td>JSON Web Key Set (JWKS) utilities. |
111 | | - |
112 | | -This module provides functions to fetch and manage JWKS, including caching and key lookup by key ID (kid). |
113 | | -It supports integration with external JWKS services.</td> |
114 | | -<td><a href="./chrislyons_dev_flarelette_jwt__jwks.md">View →</a></td> |
115 | | -</tr> |
116 | | -<tr> |
117 | | -<td><strong>types</strong></td> |
118 | | -<td><code>module</code></td> |
119 | | -<td>Type definitions for JWT operations. |
120 | | - |
121 | | -This module defines types for JWT headers, payloads, profiles, and related structures. |
122 | | -It ensures type safety and consistency across the library.</td> |
123 | | -<td><a href="./chrislyons_dev_flarelette_jwt__types.md">View →</a></td> |
124 | | -</tr> |
125 | | -<tr> |
126 | | -<td><strong>verify</strong></td> |
127 | | -<td><code>module</code></td> |
128 | | -<td>JWT verification utilities. |
129 | | - |
130 | | -This module provides functions to verify JWT tokens using either HS512 or EdDSA algorithms. |
131 | | -It supports integration with JWKS services and thumbprint pinning.</td> |
132 | | -<td><a href="./chrislyons_dev_flarelette_jwt__verify.md">View →</a></td> |
133 | | -</tr> |
134 | | -<tr> |
135 | | -<td><strong>adapters</strong></td> |
136 | | -<td><code>module</code></td> |
137 | | -<td>Component inferred from directory: adapters</td> |
138 | | -<td><a href="./chrislyons_dev_flarelette_jwt__adapters.md">View →</a></td> |
139 | | -</tr> |
140 | | -</tbody> |
141 | | -</table> |
| 31 | +| Component | Type | Description | Code | |
| 32 | +| --- | --- | --- | --- | |
| 33 | +| **core** | `module` | CLI utility for generating JWT secrets.<br><br>This script provides options to generate secrets in various formats, including JSON and dotenv.<br>It is designed to be executed as a standalone Node.js script. \| Configuration utilities for JWT operations.<br><br>This module provides functions to read environment variables and derive JWT-related configurations.<br>It includes support for both symmetric (HS512) and asymmetric (EdDSA) algorithms. \| JWT signing utilities.<br><br>This module provides functions to sign JWT tokens using either HS512 or EdDSA algorithms.<br>It supports custom claims and configuration overrides. | [View](./chrislyons_dev_flarelette_jwt__core.md) | |
| 34 | +| **explicit** | `module` | Explicit configuration API for JWT operations.<br><br>This module provides functions that accept explicit configuration objects<br>instead of relying on environment variables or global state. Use this API<br>when you need full control over configuration, especially in development<br>environments or when working with multiple JWT configurations. | [View](./chrislyons_dev_flarelette_jwt__explicit.md) | |
| 35 | +| **util** | `module` | High-level JWT utilities for creating, delegating, verifying, and authorizing JWT tokens \| Key generation utility for EdDSA and ECDSA keys.<br><br>Generates asymmetric key pairs and exports them in JWK format.<br>Designed to be executed as a standalone Node.js script. \| Secret generation and validation utilities.<br><br>This module provides functions to generate secure secrets and validate base64url-encoded secrets.<br>It ensures compatibility with JWT signing requirements. \| Utility functions for JWT operations.<br><br>This module provides helper functions for parsing JWTs, checking expiration, and mapping OAuth scopes.<br>It is designed to support core JWT functionalities. | [View](./chrislyons_dev_flarelette_jwt__util.md) | |
| 36 | +| **main** | `module` | Entry point for the flarelette-jwt library.<br><br>This module re-exports core functionalities, including signing, verification, utilities, and type definitions.<br>It serves as the main interface for library consumers. | [View](./chrislyons_dev_flarelette_jwt__main.md) | |
| 37 | +| **jwks** | `module` | JSON Web Key Set (JWKS) utilities.<br><br>This module provides functions to fetch and manage JWKS, including caching and key lookup by key ID (kid).<br>It supports integration with external JWKS services. | [View](./chrislyons_dev_flarelette_jwt__jwks.md) | |
| 38 | +| **types** | `module` | Type definitions for JWT operations.<br><br>This module defines types for JWT headers, payloads, profiles, and related structures.<br>It ensures type safety and consistency across the library. | [View](./chrislyons_dev_flarelette_jwt__types.md) | |
| 39 | +| **verify** | `module` | JWT verification utilities.<br><br>This module provides functions to verify JWT tokens using either HS512 or EdDSA algorithms.<br>It supports integration with JWKS services and thumbprint pinning. | [View](./chrislyons_dev_flarelette_jwt__verify.md) | |
| 40 | +| **adapters** | `module` | Component inferred from directory: adapters | [View](./chrislyons_dev_flarelette_jwt__adapters.md) | |
142 | 41 |
|
143 | 42 |
|
144 | 43 | --- |
145 | 44 |
|
146 | 45 | <div align="center"> |
147 | 46 | <sub><a href="./README.md">← Back to System Overview</a> | Generated with <a href="https://github.com/chrislyons-dev/archlette">Archlette</a></sub> |
148 | 47 | </div> |
| 48 | + |
0 commit comments