key-rotation-manager 1.0.4 → 1.0.6

package/README.md

@@ -22,7 +22,7 @@ This library is designed for backend systems that need safe, extensible, and tra
 ## Installation
 
 ```bash
-npm install rotate-key
+npm install key-rotation-manager
 ```
 
 ---
@@ -30,19 +30,20 @@ npm install rotate-key
 ## Quick Start
 
 ```typescript
-import { create } from 'rotate-key';
+import { create, km } from 'key-rotation-manager';
 
 const keyManager = create({});
+// or 
+const keyManager = km({});
 
 const { key, path } = await keyManager.newKey({
   type: 'api',
+  ...options
 });
-
-console.log(key, path);
 ```
 
 This will:
-- Create a `keys/` directory
+- Create a `keys/` directory base on {{path}}/{{filename}}.{{fileExt}}
 - Generate a new key
 - Save it using default storage rules
 
@@ -53,9 +54,11 @@ This will:
 ### Initialize KeyManager
 
 ```typescript
-import { create } from 'rotate-key';
+import { create, km } from 'key-rotation-manager';
 
 const keyManager = create({});
+// or 
+const keyManager = km({});
 ```
 
 On initialization:
@@ -71,7 +74,7 @@ On initialization:
   file: ['{{type}}', 'v', '{{version}}'],
   fileSplitor: '_',
   fileExt: 'json',
-  gitIgnore: true,
+  gitIgnore: true, // add resolved path to .gitignore
 
   crypto: {
     algorithm: 'aes-256-gcm',
@@ -105,7 +108,7 @@ keys/
 ### 1. Non-expiring Key
 
 ```typescript
-const { key } = await keyManager.newKey({
+const { key } = await km.newKey({
   type: 'service',
 });
 ```
@@ -113,7 +116,7 @@ const { key } = await keyManager.newKey({
 ### 2. Expiring / Rotating Key
 
 ```typescript
-const { key } = await keyManager.newKey({
+const { key } = await km.newKey({
   type: 'service',
   duration: 30,
   unit: 'seconds',
@@ -133,7 +136,7 @@ const { key } = await keyManager.newKey({
   duration: 30,
   unit: 'seconds',
   rotate: true,
-  merge: true,
+  merge: true, // Merge into 1 file {{path}}/{filename}
 });
 ```
 
@@ -142,12 +145,13 @@ const { key } = await keyManager.newKey({
 ## Custom Path & File Naming
 
 ```typescript
-import { create } from 'rotate-key';
+import { create } from 'key-rotation-manager';
 
 const keyManager = create({
   path: ['keys', 'custom'],
   file: '{{type}}',
   fileExt: 'txt',
+  ...options,
 });
 ```
 
@@ -155,6 +159,9 @@ Resulting structure:
 
 ```
 keys/custom/service.txt
+
+>> .gitignore
+keys/custom/*
 ```
 
 ---
@@ -195,7 +202,7 @@ Returned structure:
 ```typescript
 {
   ready: Key | null,
-  expired?: Key
+  expired: Key | null
 }
 ```
 
@@ -221,8 +228,8 @@ Expired rotate options not provided
 
 ```typescript
 const result = await keyManager.getKey({
-  path: 'keys/service_merge.json',
-  version: 'non-rotate',
+  path: 'path (full path return from km.newKey)',
+  version: 'version',
 });
 ```
 
@@ -240,7 +247,7 @@ keyManager.useGetKey(async () => {
     key: '...',
     hashed: '...',
     type: 'service',
-    version: 'rotate',
+    version: 'version',
     rotate: true,
   };
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "key-rotation-manager",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Simple, secure key rotation for Node.js",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -19,8 +19,7 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsup && npm run copy-files",
-    "copy-files": "node -e \"const fs=require('fs');['README.md','LICENSE'].forEach(f=>fs.copyFileSync(f,'dist/'+f))\"",
+    "build": "tsup",
     "clean": "rimraf dist",
     "lint": "eslint src --ext .ts",
     "lint:fix": "eslint src --ext .ts --fix",

package/dist/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/README.md

@@ -1,284 +0,0 @@
-# Rotate Key
-
-Flexible, file-based key management for Node.js.  
-It helps you **generate, store, rotate, and retrieve cryptographic keys** with support for expiration, versioning, merge strategies, custom storage logic, and lifecycle events.
-
-This library is designed for backend systems that need safe, extensible, and transparent key handling.
-
----
-
-## Features
-
-- 🔐 Secure key generation (AES-256-GCM by default)
-- 🔄 Key expiration & rotation
-- 🗂 File-based storage with configurable structure
-- 🧩 Merge & non-merge key strategies
-- 🔧 Custom save & get hooks
-- 📡 Event-driven lifecycle
-- 📁 Automatic `.gitignore` integration
-
----
-
-## Installation
-
-```bash
-npm install rotate-key
-```
-
----
-
-## Quick Start
-
-```typescript
-import { create } from 'rotate-key';
-
-const keyManager = create({});
-
-const { key, path } = await keyManager.newKey({
-  type: 'api',
-});
-
-console.log(key, path);
-```
-
-This will:
-- Create a `keys/` directory
-- Generate a new key
-- Save it using default storage rules
-
----
-
-## Basic Usage
-
-### Initialize KeyManager
-
-```typescript
-import { create } from 'rotate-key';
-
-const keyManager = create({});
-```
-
-On initialization:
-- The key storage folder is created
-- `.gitignore` is updated (if enabled)
-- A store initialization event is emitted
-
-### Default Configuration
-
-```typescript
-{
-  path: ['keys'],
-  file: ['{{type}}', 'v', '{{version}}'],
-  fileSplitor: '_',
-  fileExt: 'json',
-  gitIgnore: true,
-
-  crypto: {
-    algorithm: 'aes-256-gcm',
-    kdf: 'scrypt',
-    hashAlgorithm: 'sha256',
-    keyLength: 32,
-    ivLength: 16,
-    saltLength: 32,
-    tagLength: 16,
-    iterations: 100000,
-    encoding: 'base64',
-  },
-
-  versionGenerator: () => Date.now().toString()
-}
-```
-
-### File Structure
-
-With default settings, keys are stored as:
-
-```
-keys/
-└── api_v_1700000000000.json
-```
-
----
-
-## Creating Keys
-
-### 1. Non-expiring Key
-
-```typescript
-const { key } = await keyManager.newKey({
-  type: 'service',
-});
-```
-
-### 2. Expiring / Rotating Key
-
-```typescript
-const { key } = await keyManager.newKey({
-  type: 'service',
-  duration: 30,
-  unit: 'seconds',
-  rotate: true,
-});
-```
-
-The key expires after 30 seconds and requires rotation.
-
-### 3. Merge Strategy
-
-Merge mode stores multiple key versions in a single file.
-
-```typescript
-const { key } = await keyManager.newKey({
-  type: 'service',
-  duration: 30,
-  unit: 'seconds',
-  rotate: true,
-  merge: true,
-});
-```
-
----
-
-## Custom Path & File Naming
-
-```typescript
-import { create } from 'rotate-key';
-
-const keyManager = create({
-  path: ['keys', 'custom'],
-  file: '{{type}}',
-  fileExt: 'txt',
-});
-```
-
-Resulting structure:
-
-```
-keys/custom/service.txt
-```
-
----
-
-## Custom Save Logic
-
-Override how and where keys are saved:
-
-```typescript
-keyManager.useSaveKey(async () => {
-  return '/absolute/custom/path/key.json';
-});
-```
-
-The returned value becomes `key.path`.
-
----
-
-## Retrieving Keys
-
-### Rotate Key (Valid)
-
-```typescript
-const result = await keyManager.getKey({
-  path: 'keys/service_merge.json',
-  version: 'rotate',
-  onRotate: {
-    duration: 30,
-    unit: 'seconds',
-    rotate: true,
-    merge: true,
-  },
-});
-```
-
-Returned structure:
-
-```typescript
-{
-  ready: Key | null,
-  expired?: Key
-}
-```
-
-- `ready` → usable key
-- `expired` → expired key (if rotation occurred)
-
-### Rotate Key (Invalid – Missing Options)
-
-```typescript
-await keyManager.getKey({
-  path: 'keys/service_merge.json',
-  version: 'rotate-invalid',
-});
-```
-
-Throws:
-
-```
-Expired rotate options not provided
-```
-
-### Non-Rotating Key
-
-```typescript
-const result = await keyManager.getKey({
-  path: 'keys/service_merge.json',
-  version: 'non-rotate',
-});
-```
-
----
-
-## Custom Get Logic
-
-Override how keys are retrieved:
-
-```typescript
-keyManager.useGetKey(async () => {
-  return {
-    from: '2025-12-29T01:23:27.882Z',
-    to: '2099-12-29T01:23:57.882Z',
-    key: '...',
-    hashed: '...',
-    type: 'service',
-    version: 'rotate',
-    rotate: true,
-  };
-});
-```
-
-Return `null` to indicate an invalid or missing key.
-
----
-
-## Events
-
-KeyManager emits lifecycle events.
-
-### Store Initialization Event
-
-```typescript
-import { create, types } from 'rotate-key';
-const { EEvent } = types;
-const keyManager = create({});
-
-keyManager.once(EEvent.STORE_INIT_FOLDER, ({ storePath }) => {
-  console.log('Key store initialized at:', storePath);
-});
-```
-
----
-
-## Use Cases
-
-- API key management
-- Token & credential rotation
-- Secure file-based secrets
-- Multi-version key handling
-- Custom persistence strategies
-- Backend Node.js services
-
----
-
-## License
-
-MIT