wilcocrypt 2.2.0 → 2.2.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 (9) hide show
  1. package/.github/ISSUE_TEMPLATE/bug.md +58 -64
  2. package/CHANGELOG.md +38 -0
  3. package/DOCS.md +286 -94
  4. package/README.md +15 -14
  5. package/SECURITY.md +12 -12
  6. package/package.json +11 -8
  7. package/src/cli.js +40 -37
  8. package/src/wilcocrypt.js +260 -53
  9. package/types/wilcocrypt.d.ts +189 -18
package/.github/ISSUE_TEMPLATE/bug.md CHANGED
@@ -4,75 +4,69 @@ title: "[BUG] "
4
4
  labels: ["bug"]
5
5
 
6
6
  body:
7
- - type: markdown
8
- attributes:
9
- value: "## Bug report"
10
7
 
11
- - type: textarea
12
- id: description
13
- attributes:
14
- label: Description
15
- description: Describe what went wrong
16
- placeholder: Clearly explain the issue
17
- validations:
18
- required: true
8
+ - type: markdown
9
+ attributes:
10
+ value: "## Bug report"
19
11
 
20
- - type: textarea
21
- id: steps
22
- attributes:
23
- label: Steps to reproduce
24
- description: How can this issue be reproduced?
25
- value: |
26
- 1.
27
- 2.
28
- 3.
29
- validations:
30
- required: true
12
+ - type: textarea
13
+ id: description
14
+ attributes:
15
+ label: Description
16
+ description: Describe what went wrong
17
+ placeholder: Clearly explain the issue
18
+ validations:
19
+ required: true
31
20
 
32
- - type: textarea
33
- id: expected
34
- attributes:
35
- label: Expected behavior
36
- description: What did you expect to happen?
37
- validations:
38
- required: true
21
+ - type: textarea
22
+ id: steps
23
+ attributes:
24
+ label: Steps to reproduce
25
+ description: How can this issue be reproduced?
26
+ value: | 1. 2. 3.
27
+ validations:
28
+ required: true
39
29
 
40
- - type: textarea
41
- id: actual
42
- attributes:
43
- label: Actual behavior
44
- description: What actually happened?
45
- validations:
46
- required: true
30
+ - type: textarea
31
+ id: expected
32
+ attributes:
33
+ label: Expected behavior
34
+ description: What did you expect to happen?
35
+ validations:
36
+ required: true
47
37
 
48
- - type: input
49
- id: version
50
- attributes:
51
- label: WilcoCrypt version
52
- placeholder: e.g. 2.1.1
53
- validations:
54
- required: true
38
+ - type: textarea
39
+ id: actual
40
+ attributes:
41
+ label: Actual behavior
42
+ description: What actually happened?
43
+ validations:
44
+ required: true
55
45
 
56
- - type: input
57
- id: node
58
- attributes:
59
- label: Node.js version
60
- placeholder: e.g. 22.x
46
+ - type: input
47
+ id: version
48
+ attributes:
49
+ label: WilcoCrypt version
50
+ placeholder: e.g. 2.1.1
51
+ validations:
52
+ required: true
61
53
 
62
- - type: dropdown
63
- id: environment
64
- attributes:
65
- label: Environment
66
- options:
67
- - Linux
68
- - Windows
69
- - macOS
70
- - Other
71
- validations:
72
- required: true
54
+ - type: input
55
+ id: node
56
+ attributes:
57
+ label: Node.js version
58
+ placeholder: e.g. 22.x
73
59
 
74
- - type: textarea
75
- id: additional
76
- attributes:
77
- label: Additional context
78
- description: Logs, errors, or anything else
60
+ - type: dropdown
61
+ id: environment
62
+ attributes:
63
+ label: Environment
64
+ options: - Linux - Windows - macOS - Other
65
+ validations:
66
+ required: true
67
+
68
+ - type: textarea
69
+ id: additional
70
+ attributes:
71
+ label: Additional context
72
+ description: Logs, errors, or anything else
package/CHANGELOG.md CHANGED
@@ -4,6 +4,43 @@ All notable changes to WilcoCrypt are documented here.
4
4
 
5
5
  ---
6
6
 
7
+ ## [2.2.1] - 2026-06-06
8
+
9
+ ### Added
10
+
11
+ * **Asynchronous API**:
12
+
13
+ * `encryptDataAsync()`
14
+ * `decryptDataAsync()`
15
+ * `encryptFileAsync()`
16
+ * `decryptFileAsync()`
17
+
18
+ These methods provide Promise-based alternatives to the existing synchronous API and integrate naturally with `async` / `await`.
19
+
20
+ ### Changed
21
+
22
+ * **TypeScript definitions** significantly expanded and improved:
23
+
24
+ * Added detailed JSDoc documentation throughout the public API.
25
+ * Added parameter descriptions for internal helper functions.
26
+ * Added return value documentation.
27
+ * Added exception documentation (`@throws`) where applicable.
28
+ * Improved overload documentation for `decryptFile()` and `decryptFileAsync()`.
29
+ * Added payload format documentation to stream APIs.
30
+
31
+ * **Dependencies updated** to the latest compatible versions.
32
+
33
+ * **Code style** migrated from semistandard-only documentation to explicit **Prettier** formatting support.
34
+
35
+ ### Documentation
36
+
37
+ * Updated `README.md` examples and feature descriptions.
38
+ * Updated `DOCS.md` API documentation.
39
+ * Improved TypeScript API reference consistency.
40
+ * Improved JSDoc coverage across the entire codebase.
41
+
42
+ ---
43
+
7
44
  ## [2.2.0] - 2026-05-01
8
45
 
9
46
  ### Added
@@ -38,6 +75,7 @@ All notable changes to WilcoCrypt are documented here.
38
75
  ### Fixed Bugs
39
76
 
40
77
  - Fixed the bug where the CLI tool would not work when running with npx or global
78
+ - Fixed package.json issue with bin not being an object
41
79
 
42
80
  ---
43
81