@molecule/api-jwt 1.0.2 → 1.0.4

package/LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -34,21 +35,33 @@
 
       "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.
+      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.
-
-      "Contribution" shall mean any work of authorship, including the
-      original version of the Work and any modifications or additions
-      to that Work, that is intentionally submitted to the 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.
+      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 the Licensor and
+      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
@@ -61,8 +74,18 @@
    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
-      patent license to make, have made, use, offer to sell, sell, import,
-      and otherwise transfer the Work.
+      (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
@@ -84,23 +107,87 @@
       (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.
-
-   5. Submission of Contributions.
+          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.
+      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 on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
-
-   8. Limitation of Liability. In no event and under no legal theory shall
-      any Contributor be liable to You for damages.
-
-   9. Accepting Warranty or Additional Liability.
-
-   Copyright 2026 Molecule Dev, Inc.
+      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.

package/README.md

@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
 Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
 Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
 To change this document, edit the module-level JSDoc in src/index.ts.
-Generated: 2026-08-04T01:48:23.941Z
+Generated: 2026-10-16T00:31:01.424Z
 -->
 
 # @molecule/api-jwt
@@ -49,55 +49,6 @@ npm install @molecule/api-jwt @molecule/api-bond
 
 ### Interfaces
 
-#### `JwtDecodeOptions`
-
-Options for decoding a JWT (without verification).
-
-```typescript
-interface JwtDecodeOptions {
-  complete?: boolean
-  json?: boolean
-}
-```
-
-#### `JwtPayload`
-
-Decoded JWT payload.
-
-```typescript
-interface JwtPayload {
-  [key: string]: unknown
-  iss?: string
-  sub?: string
-  aud?: string | string[]
-  exp?: number
-  nbf?: number
-  iat?: number
-  jti?: string
-}
-```
-
-#### `JwtProvider`
-
-JWT provider interface that all JWT bond packages must implement.
-
-Provides `sign`, `verify`, and `decode` operations. Key management
-and algorithm configuration are handled by the core package.
-
-```typescript
-interface JwtProvider {
-  sign(payload: JSONObject, options?: JwtSignOptions, privateKey?: string | Buffer): string
-
-  verify(
-    token: string,
-    options?: JwtVerifyOptions,
-    publicKey?: string | Buffer,
-  ): string | JwtPayload
-
-  decode(token: string, options?: JwtDecodeOptions): string | JwtPayload | null
-}
-```
-
 #### `JwtSignOptions`
 
 Options for signing a JWT.
@@ -139,25 +90,57 @@ interface JwtVerifyOptions {
 }
 ```
 
-### Types
+#### `JwtDecodeOptions`
 
-#### `JSONObject`
+Options for decoding a JWT (without verification).
 
-A plain JSON object whose values are `JSONValue`s. Used as the payload
-type for JWT signing operations.
+```typescript
+interface JwtDecodeOptions {
+  complete?: boolean
+  json?: boolean
+}
+```
+
+#### `JwtPayload`
+
+Decoded JWT payload.
 
 ```typescript
-type JSONObject = { [key: string]: JSONValue }
+interface JwtPayload {
+  [key: string]: unknown
+  iss?: string
+  sub?: string
+  aud?: string | string[]
+  exp?: number
+  nbf?: number
+  iat?: number
+  jti?: string
+}
 ```
 
-#### `JSONValue`
+#### `JwtProvider`
 
-Recursive JSON value type representing any valid JSON primitive, array, or object.
+JWT provider interface that all JWT bond packages must implement.
+
+Provides `sign`, `verify`, and `decode` operations. Key management
+and algorithm configuration are handled by the core package.
 
 ```typescript
-type JSONValue = string | number | boolean | null | JSONValue[] | { [key: string]: JSONValue }
+interface JwtProvider {
+  sign(payload: JSONObject, options?: JwtSignOptions, privateKey?: string | Buffer): string
+
+  verify(
+    token: string,
+    options?: JwtVerifyOptions,
+    publicKey?: string | Buffer,
+  ): string | JwtPayload
+
+  decode(token: string, options?: JwtDecodeOptions): string | JwtPayload | null
+}
 ```
 
+### Types
+
 #### `JwtAlgorithm`
 
 Supported JWT signing algorithms.
@@ -178,21 +161,24 @@ type JwtAlgorithm =
   | 'PS512'
 ```
 
-### Functions
-
-#### `decode(token, options)`
+#### `JSONValue`
 
-Decodes a JWT string without verifying its signature. Useful for inspecting
-token contents when verification is handled elsewhere.
+Recursive JSON value type representing any valid JSON primitive, array, or object.
 
 ```typescript
-function decode(token: string, options?: JwtDecodeOptions): string | JwtPayload | null
+type JSONValue = string | number | boolean | null | JSONValue[] | { [key: string]: JSONValue }
 ```
 
-- `token` — The JWT string to decode.
-- `options` — Decode options such as `complete` for full header+payload output.
+#### `JSONObject`
 
-**Returns:** The decoded payload, or `null` if the token cannot be decoded.
+A plain JSON object whose values are `JSONValue`s. Used as the payload
+type for JWT signing operations.
+
+```typescript
+type JSONObject = { [key: string]: JSONValue }
+```
+
+### Functions
 
 #### `generateKeyPairSync()`
 
@@ -204,6 +190,28 @@ function generateKeyPairSync(): { publicKey: string; privateKey: string }
 
 **Returns:** An object containing `publicKey` and `privateKey` as PEM strings.
 
+#### `writeKeys(outputPath)`
+
+Writes a freshly generated RSA key pair to disk as PEM files. Creates
+the output directory if it does not exist.
+
+```typescript
+function writeKeys(outputPath?: string): void
+```
+
+- `outputPath` — Directory to write the PEM files into; defaults to `{JWT_KEYS_DIR}/{NODE_ENV}/`.
+
+#### `setProvider(provider)`
+
+Registers a JWT provider as the active singleton. Called by bond
+packages during application startup.
+
+```typescript
+function setProvider(provider: JwtProvider): void
+```
+
+- `provider` — The JWT provider implementation to bond.
+
 #### `getProvider()`
 
 Retrieves the bonded JWT provider, throwing if none is configured.
@@ -224,17 +232,6 @@ function hasProvider(): boolean
 
 **Returns:** `true` if a JWT provider is bonded.
 
-#### `setProvider(provider)`
-
-Registers a JWT provider as the active singleton. Called by bond
-packages during application startup.
-
-```typescript
-function setProvider(provider: JwtProvider): void
-```
-
-- `provider` — The JWT provider implementation to bond.
-
 #### `sign(object, options, privateKey)`
 
 Signs a payload into a JWT string using the bonded provider. Uses the
@@ -276,39 +273,21 @@ function verify(
 
 **Returns:** The decoded payload string or object.
 
-#### `writeKeys(outputPath)`
-
-Writes a freshly generated RSA key pair to disk as PEM files. Creates
-the output directory if it does not exist.
-
-```typescript
-function writeKeys(outputPath?: string): void
-```
-
-- `outputPath` — Directory to write the PEM files into; defaults to `{JWT_KEYS_DIR}/{NODE_ENV}/`.
-
-### Constants
-
-#### `JWT_ALGORITHM`
+#### `decode(token, options)`
 
-The signing algorithm used for JWT operations. Read from the `JWT_ALGORITHM`
-environment variable, defaulting to `RS256`. An unrecognized value logs an
-actionable warning at module load and falls back to `RS256` rather than
-failing every `sign()`/`verify()` call later with an unexplained
-"invalid algorithm" error.
+Decodes a JWT string without verifying its signature. Useful for inspecting
+token contents when verification is handled elsewhere.
 
 ```typescript
-const JWT_ALGORITHM: JwtAlgorithm
+function decode(token: string, options?: JwtDecodeOptions): string | JwtPayload | null
 ```
 
-#### `JWT_EXPIRES_TIME`
+- `token` — The JWT string to decode.
+- `options` — Decode options such as `complete` for full header+payload output.
 
-Token lifetime in seconds. Read from the `JWT_EXPIRES_TIME` environment
-variable, defaulting to 604800 (1 week).
+**Returns:** The decoded payload, or `null` if the token cannot be decoded.
 
-```typescript
-const JWT_EXPIRES_TIME: number
-```
+### Constants
 
 #### `JWT_PRIVATE_KEY`
 
@@ -336,6 +315,27 @@ Throws at startup if no source provides a key.
 const JWT_PUBLIC_KEY: string | Buffer<ArrayBufferLike>
 ```
 
+#### `JWT_ALGORITHM`
+
+The signing algorithm used for JWT operations. Read from the `JWT_ALGORITHM`
+environment variable, defaulting to `RS256`. An unrecognized value logs an
+actionable warning at module load and falls back to `RS256` rather than
+failing every `sign()`/`verify()` call later with an unexplained
+"invalid algorithm" error.
+
+```typescript
+const JWT_ALGORITHM: JwtAlgorithm
+```
+
+#### `JWT_EXPIRES_TIME`
+
+Token lifetime in seconds. Read from the `JWT_EXPIRES_TIME` environment
+variable, defaulting to 604800 (1 week).
+
+```typescript
+const JWT_EXPIRES_TIME: number
+```
+
 #### `JWT_REFRESH_TIME`
 
 Refresh window in seconds — tokens are refreshed if they will expire within

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/api-jwt",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "JWT interface and key management for molecule.dev",
   "type": "module",
   "main": "dist/index.js",
@@ -31,7 +31,7 @@
     "@molecule/api-bond": "^1.0.1"
   },
   "devDependencies": {
-    "@molecule/api-bond": "1.0.1",
+    "@molecule/api-bond": "1.0.2",
     "@types/node": "26.1.2",
     "typescript": "6.0.3",
     "vitest": "4.1.11"
@@ -41,7 +41,7 @@
     "url": "https://github.com/molecule-dev/molecule.git",
     "directory": "packages/api/core/jwt"
   },
-  "homepage": "https://github.com/molecule-dev/molecule/tree/main/packages/api/core/jwt",
+  "homepage": "https://www.molecule.dev/packages/api-jwt",
   "bugs": "https://github.com/molecule-dev/molecule/issues",
   "publishConfig": {
     "access": "public"