yamlock 0.2.4 → 0.2.8

package/README.md

@@ -4,6 +4,9 @@
 ░░▀░░▀░▀░▀░░░▀░▀▀▀░▀▀▀░▀▀▀░▀░▀░
 ```
 
+[![npm version](https://img.shields.io/npm/v/yamlock)](https://www.npmjs.com/package/yamlock)
+[![Tests](https://img.shields.io/badge/tests-node--test-green)](https://github.com/phoenixweiss/yamlock/actions)
+
 # yamlock
 
 Value-level encryption for YAML and JSON configuration files. The name **yamlock** combines "YAML" and "lock" while also sounding like "warlock", hinting at a little configuration magic.
@@ -65,7 +68,8 @@ Options of note:
 - `--output <file>` writes the result to a separate file instead of overwriting the input.
 - `--paths <path1,path2>` targets only the specified fields (dot/bracket notation like `db.password` or `users[0].token`).
 - Command `keygen` produces a random key and shows how to store it (shell export or `.env`).
-- Commands `version` and `algorithms` print the installed CLI version and the list of supported ciphers respectively.
+- Command `algorithms` prints two lists: tested presets (covered by yamlock) and additional ciphers available from the runtime.
+- Command `version` prints the installed CLI version.
 
 ### Node.js API
 
@@ -114,6 +118,12 @@ const restored = processConfig(processed, {
 });
 ```
 
+## Advanced usage
+
+- **Selective encryption**: combine `--paths` on the CLI or `paths: []` in `processConfig` to encrypt only sensitive sections of a config file.
+- **CI/CD flows**: see [examples/docs/ci-cd.md](examples/docs/ci-cd.md) for a GitHub Actions job that decrypts configs for builds and re-encrypts them before publishing artifacts.
+- **Key rotation**: follow [examples/docs/key-rotation.md](examples/docs/key-rotation.md) for a step-by-step process, including scripting tips for large repos.
+
 ### Supported algorithms
 
 | Algorithm | Type | Notes |
@@ -125,6 +135,11 @@ const restored = processConfig(processed, {
 
 You can also pass any algorithm supported by the current Node.js runtime (`crypto.getCiphers()`), along with custom `keyLength`, `ivLength`, or `authTagLength` overrides. Only the algorithms above are actively tested; additional presets may be added or revised in future releases.
 
+## Release information
+
+- The badges at the top show the latest npm version and the status of the Node test suite.
+- See [CHANGELOG.md](CHANGELOG.md) for detailed release notes; install a specific tag via `npm install yamlock@<version>`.
+
 ### Encrypted value format
 
 Every locked string follows the format:

package/dist/cli/cli.js

@@ -8,7 +8,7 @@ import { randomBytes } from 'node:crypto';
 import yaml from 'js-yaml';
 
 import { processConfig } from '../utils/config.js';
-import { listSupportedAlgorithms } from '../crypto/utils.js';
+import { listSupportedAlgorithms, TESTED_ALGORITHMS } from '../crypto/utils.js';
 
 const require = createRequire(import.meta.url);
 const packageJson = require('../../package.json');
@@ -161,8 +161,18 @@ export async function runCli(argv = process.argv) {
 
   if (command === 'algorithms') {
     const algorithms = listSupportedAlgorithms();
-    print('Supported algorithms:');
-    algorithms.forEach((name) => print(`- ${name}`));
+    const tested = TESTED_ALGORITHMS.slice().sort();
+    const testedSet = new Set(tested);
+    const additional = algorithms.filter((name) => !testedSet.has(name));
+
+    print('Tested algorithms (covered by yamlock fixtures):');
+    tested.forEach((name) => print(`- ${name}`));
+
+    if (additional.length > 0) {
+      print('\nAdditional algorithms available in this runtime:');
+      additional.forEach((name) => print(`- ${name}`));
+      print('\nUse at your own risk; these ciphers are not part of the official test matrix yet.');
+    }
     return exit(0);
   }
 

package/dist/crypto/utils.js

@@ -9,6 +9,7 @@ export const ALGORITHM_PRESETS = {
   'aes-128-cbc': { keyLength: 16, ivLength: 16, authTagLength: 0 },
   'chacha20-poly1305': { keyLength: 32, ivLength: 12, authTagLength: 16 }
 };
+export const TESTED_ALGORITHMS = Object.keys(ALGORITHM_PRESETS);
 
 /**
  * Returns the sorted list of cipher algorithms supported by the current runtime.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yamlock",
-  "version": "0.2.4",
+  "version": "0.2.8",
   "author": "PAVEL TKACHEV (phoenixweiss) <mail@phoenixweiss.me>",
   "description": "Value-level encryption for YAML/JSON configuration files with CLI + Node.js APIs.",
   "license": "MIT",