@fluxfiles/node 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +8 -0
  3. package/package.json +2 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 thai-pc
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -7,9 +7,17 @@ including encrypted BYOB (Bring Your Own Bucket) credentials — without running
7
7
 
8
8
  Zero runtime dependencies (built on `node:crypto`).
9
9
 
10
+ > **This package only issues tokens — it is not a backend.** You still run a
11
+ > FluxFiles **core service** (the file-manager backend that talks to storage; a
12
+ > PHP app, e.g. the Docker image) for the token to authenticate against.
13
+ > `@fluxfiles/node` simply removes the need for *your app* to be PHP in order to
14
+ > mint those tokens.
15
+
10
16
  ## Requirements
11
17
 
12
18
  - Node.js 16+
19
+ - A running FluxFiles **core service** the issued tokens authenticate against
20
+ (the SDK/iframe `endpoint` points at it).
13
21
  - The same **`FLUXFILES_SECRET`** your FluxFiles core server uses to verify tokens
14
22
  (HS256, **must be ≥ 32 bytes**). Keep it server-side only.
15
23
 
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@fluxfiles/node",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Server-side Node/TypeScript SDK for minting FluxFiles JWTs (plain + BYOB), byte-compatible with the PHP core",
5
5
  "license": "MIT",
6
+ "sideEffects": false,
6
7
  "main": "dist/index.js",
7
8
  "module": "dist/index.mjs",
8
9
  "types": "dist/index.d.ts",