@anonymask/core 0.1.0

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 (4) hide show
  1. package/README.md +48 -0
  2. package/index.d.ts +21 -0
  3. package/index.js +315 -0
  4. package/package.json +60 -0
package/README.md ADDED
@@ -0,0 +1,48 @@
1
+ # Anonymask Node.js Package
2
+
3
+ This package provides Node.js bindings for the Anonymask core library, enabling secure anonymization and de-anonymization of PII data.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @anonymask/node
9
+ ```
10
+
11
+ ## Building from Source
12
+
13
+ 1. Ensure you have Rust and Node.js installed.
14
+ 2. Clone the repository and navigate to the `anonymask-node` directory.
15
+ 3. Install dependencies:
16
+
17
+ ```bash
18
+ npm install
19
+ ```
20
+
21
+ 4. Build the package:
22
+
23
+ ```bash
24
+ npm run build
25
+ ```
26
+
27
+ This will compile the Rust code and generate the native Node.js module.
28
+
29
+ ## Usage
30
+
31
+ ```javascript
32
+ const { Anonymizer } = require('@anonymask/node');
33
+
34
+ const anonymizer = new Anonymizer(['email', 'phone']);
35
+ const result = anonymizer.anonymize('Contact john@email.com or call 555-123-4567');
36
+
37
+ console.log(result.anonymized_text); // "Contact EMAIL_xxx or call PHONE_xxx"
38
+ console.log(result.mapping); // { "EMAIL_xxx": "john@email.com", "PHONE_xxx": "555-123-4567" }
39
+ ```
40
+
41
+ ## Publishing to npm
42
+
43
+ 1. Ensure you have an npm account and are logged in (`npm login`).
44
+ 2. Update the version in `package.json`.
45
+ 3. Build the package: `npm run build`.
46
+ 4. Publish: `npm publish`.
47
+
48
+ Note: The package will automatically build before publishing due to the `prepublishOnly` script.
package/index.d.ts ADDED
@@ -0,0 +1,21 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+
4
+ /* auto-generated by NAPI-RS */
5
+
6
+ export interface Entity {
7
+ entityType: string
8
+ value: string
9
+ start: number
10
+ end: number
11
+ }
12
+ export interface AnonymizationResult {
13
+ anonymizedText: string
14
+ mapping: Record<string, string>
15
+ entities: Array<Entity>
16
+ }
17
+ export declare class Anonymizer {
18
+ constructor(entityTypes: Array<string>)
19
+ anonymize(text: string): AnonymizationResult
20
+ deanonymize(text: string, mapping: Record<string, string>): string
21
+ }
package/index.js ADDED
@@ -0,0 +1,315 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /* prettier-ignore */
4
+
5
+ /* auto-generated by NAPI-RS */
6
+
7
+ const { existsSync, readFileSync } = require('fs')
8
+ const { join } = require('path')
9
+
10
+ const { platform, arch } = process
11
+
12
+ let nativeBinding = null
13
+ let localFileExisted = false
14
+ let loadError = null
15
+
16
+ function isMusl() {
17
+ // For Node 10
18
+ if (!process.report || typeof process.report.getReport !== 'function') {
19
+ try {
20
+ const lddPath = require('child_process').execSync('which ldd').toString().trim()
21
+ return readFileSync(lddPath, 'utf8').includes('musl')
22
+ } catch (e) {
23
+ return true
24
+ }
25
+ } else {
26
+ const { glibcVersionRuntime } = process.report.getReport().header
27
+ return !glibcVersionRuntime
28
+ }
29
+ }
30
+
31
+ switch (platform) {
32
+ case 'android':
33
+ switch (arch) {
34
+ case 'arm64':
35
+ localFileExisted = existsSync(join(__dirname, 'anonymask.android-arm64.node'))
36
+ try {
37
+ if (localFileExisted) {
38
+ nativeBinding = require('./anonymask.android-arm64.node')
39
+ } else {
40
+ nativeBinding = require('@anonymask/core-android-arm64')
41
+ }
42
+ } catch (e) {
43
+ loadError = e
44
+ }
45
+ break
46
+ case 'arm':
47
+ localFileExisted = existsSync(join(__dirname, 'anonymask.android-arm-eabi.node'))
48
+ try {
49
+ if (localFileExisted) {
50
+ nativeBinding = require('./anonymask.android-arm-eabi.node')
51
+ } else {
52
+ nativeBinding = require('@anonymask/core-android-arm-eabi')
53
+ }
54
+ } catch (e) {
55
+ loadError = e
56
+ }
57
+ break
58
+ default:
59
+ throw new Error(`Unsupported architecture on Android ${arch}`)
60
+ }
61
+ break
62
+ case 'win32':
63
+ switch (arch) {
64
+ case 'x64':
65
+ localFileExisted = existsSync(
66
+ join(__dirname, 'anonymask.win32-x64-msvc.node')
67
+ )
68
+ try {
69
+ if (localFileExisted) {
70
+ nativeBinding = require('./anonymask.win32-x64-msvc.node')
71
+ } else {
72
+ nativeBinding = require('@anonymask/core-win32-x64-msvc')
73
+ }
74
+ } catch (e) {
75
+ loadError = e
76
+ }
77
+ break
78
+ case 'ia32':
79
+ localFileExisted = existsSync(
80
+ join(__dirname, 'anonymask.win32-ia32-msvc.node')
81
+ )
82
+ try {
83
+ if (localFileExisted) {
84
+ nativeBinding = require('./anonymask.win32-ia32-msvc.node')
85
+ } else {
86
+ nativeBinding = require('@anonymask/core-win32-ia32-msvc')
87
+ }
88
+ } catch (e) {
89
+ loadError = e
90
+ }
91
+ break
92
+ case 'arm64':
93
+ localFileExisted = existsSync(
94
+ join(__dirname, 'anonymask.win32-arm64-msvc.node')
95
+ )
96
+ try {
97
+ if (localFileExisted) {
98
+ nativeBinding = require('./anonymask.win32-arm64-msvc.node')
99
+ } else {
100
+ nativeBinding = require('@anonymask/core-win32-arm64-msvc')
101
+ }
102
+ } catch (e) {
103
+ loadError = e
104
+ }
105
+ break
106
+ default:
107
+ throw new Error(`Unsupported architecture on Windows: ${arch}`)
108
+ }
109
+ break
110
+ case 'darwin':
111
+ localFileExisted = existsSync(join(__dirname, 'anonymask.darwin-universal.node'))
112
+ try {
113
+ if (localFileExisted) {
114
+ nativeBinding = require('./anonymask.darwin-universal.node')
115
+ } else {
116
+ nativeBinding = require('@anonymask/core-darwin-universal')
117
+ }
118
+ break
119
+ } catch {}
120
+ switch (arch) {
121
+ case 'x64':
122
+ localFileExisted = existsSync(join(__dirname, 'anonymask.darwin-x64.node'))
123
+ try {
124
+ if (localFileExisted) {
125
+ nativeBinding = require('./anonymask.darwin-x64.node')
126
+ } else {
127
+ nativeBinding = require('@anonymask/core-darwin-x64')
128
+ }
129
+ } catch (e) {
130
+ loadError = e
131
+ }
132
+ break
133
+ case 'arm64':
134
+ localFileExisted = existsSync(
135
+ join(__dirname, 'anonymask.darwin-arm64.node')
136
+ )
137
+ try {
138
+ if (localFileExisted) {
139
+ nativeBinding = require('./anonymask.darwin-arm64.node')
140
+ } else {
141
+ nativeBinding = require('@anonymask/core-darwin-arm64')
142
+ }
143
+ } catch (e) {
144
+ loadError = e
145
+ }
146
+ break
147
+ default:
148
+ throw new Error(`Unsupported architecture on macOS: ${arch}`)
149
+ }
150
+ break
151
+ case 'freebsd':
152
+ if (arch !== 'x64') {
153
+ throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
154
+ }
155
+ localFileExisted = existsSync(join(__dirname, 'anonymask.freebsd-x64.node'))
156
+ try {
157
+ if (localFileExisted) {
158
+ nativeBinding = require('./anonymask.freebsd-x64.node')
159
+ } else {
160
+ nativeBinding = require('@anonymask/core-freebsd-x64')
161
+ }
162
+ } catch (e) {
163
+ loadError = e
164
+ }
165
+ break
166
+ case 'linux':
167
+ switch (arch) {
168
+ case 'x64':
169
+ if (isMusl()) {
170
+ localFileExisted = existsSync(
171
+ join(__dirname, 'anonymask.linux-x64-musl.node')
172
+ )
173
+ try {
174
+ if (localFileExisted) {
175
+ nativeBinding = require('./anonymask.linux-x64-musl.node')
176
+ } else {
177
+ nativeBinding = require('@anonymask/core-linux-x64-musl')
178
+ }
179
+ } catch (e) {
180
+ loadError = e
181
+ }
182
+ } else {
183
+ localFileExisted = existsSync(
184
+ join(__dirname, 'anonymask.linux-x64-gnu.node')
185
+ )
186
+ try {
187
+ if (localFileExisted) {
188
+ nativeBinding = require('./anonymask.linux-x64-gnu.node')
189
+ } else {
190
+ nativeBinding = require('@anonymask/core-linux-x64-gnu')
191
+ }
192
+ } catch (e) {
193
+ loadError = e
194
+ }
195
+ }
196
+ break
197
+ case 'arm64':
198
+ if (isMusl()) {
199
+ localFileExisted = existsSync(
200
+ join(__dirname, 'anonymask.linux-arm64-musl.node')
201
+ )
202
+ try {
203
+ if (localFileExisted) {
204
+ nativeBinding = require('./anonymask.linux-arm64-musl.node')
205
+ } else {
206
+ nativeBinding = require('@anonymask/core-linux-arm64-musl')
207
+ }
208
+ } catch (e) {
209
+ loadError = e
210
+ }
211
+ } else {
212
+ localFileExisted = existsSync(
213
+ join(__dirname, 'anonymask.linux-arm64-gnu.node')
214
+ )
215
+ try {
216
+ if (localFileExisted) {
217
+ nativeBinding = require('./anonymask.linux-arm64-gnu.node')
218
+ } else {
219
+ nativeBinding = require('@anonymask/core-linux-arm64-gnu')
220
+ }
221
+ } catch (e) {
222
+ loadError = e
223
+ }
224
+ }
225
+ break
226
+ case 'arm':
227
+ if (isMusl()) {
228
+ localFileExisted = existsSync(
229
+ join(__dirname, 'anonymask.linux-arm-musleabihf.node')
230
+ )
231
+ try {
232
+ if (localFileExisted) {
233
+ nativeBinding = require('./anonymask.linux-arm-musleabihf.node')
234
+ } else {
235
+ nativeBinding = require('@anonymask/core-linux-arm-musleabihf')
236
+ }
237
+ } catch (e) {
238
+ loadError = e
239
+ }
240
+ } else {
241
+ localFileExisted = existsSync(
242
+ join(__dirname, 'anonymask.linux-arm-gnueabihf.node')
243
+ )
244
+ try {
245
+ if (localFileExisted) {
246
+ nativeBinding = require('./anonymask.linux-arm-gnueabihf.node')
247
+ } else {
248
+ nativeBinding = require('@anonymask/core-linux-arm-gnueabihf')
249
+ }
250
+ } catch (e) {
251
+ loadError = e
252
+ }
253
+ }
254
+ break
255
+ case 'riscv64':
256
+ if (isMusl()) {
257
+ localFileExisted = existsSync(
258
+ join(__dirname, 'anonymask.linux-riscv64-musl.node')
259
+ )
260
+ try {
261
+ if (localFileExisted) {
262
+ nativeBinding = require('./anonymask.linux-riscv64-musl.node')
263
+ } else {
264
+ nativeBinding = require('@anonymask/core-linux-riscv64-musl')
265
+ }
266
+ } catch (e) {
267
+ loadError = e
268
+ }
269
+ } else {
270
+ localFileExisted = existsSync(
271
+ join(__dirname, 'anonymask.linux-riscv64-gnu.node')
272
+ )
273
+ try {
274
+ if (localFileExisted) {
275
+ nativeBinding = require('./anonymask.linux-riscv64-gnu.node')
276
+ } else {
277
+ nativeBinding = require('@anonymask/core-linux-riscv64-gnu')
278
+ }
279
+ } catch (e) {
280
+ loadError = e
281
+ }
282
+ }
283
+ break
284
+ case 's390x':
285
+ localFileExisted = existsSync(
286
+ join(__dirname, 'anonymask.linux-s390x-gnu.node')
287
+ )
288
+ try {
289
+ if (localFileExisted) {
290
+ nativeBinding = require('./anonymask.linux-s390x-gnu.node')
291
+ } else {
292
+ nativeBinding = require('@anonymask/core-linux-s390x-gnu')
293
+ }
294
+ } catch (e) {
295
+ loadError = e
296
+ }
297
+ break
298
+ default:
299
+ throw new Error(`Unsupported architecture on Linux: ${arch}`)
300
+ }
301
+ break
302
+ default:
303
+ throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
304
+ }
305
+
306
+ if (!nativeBinding) {
307
+ if (loadError) {
308
+ throw loadError
309
+ }
310
+ throw new Error(`Failed to load native binding`)
311
+ }
312
+
313
+ const { Anonymizer } = nativeBinding
314
+
315
+ module.exports.Anonymizer = Anonymizer
package/package.json ADDED
@@ -0,0 +1,60 @@
1
+ {
2
+ "name": "@anonymask/core",
3
+ "version": "0.1.0",
4
+ "description": "Secure anonymization/de-anonymization library for PII data",
5
+ "main": "index.js",
6
+ "types": "index.d.ts",
7
+ "publishConfig": {
8
+ "access": "public",
9
+ "registry": "https://registry.npmjs.org/"
10
+ },
11
+ "files": [
12
+ "index.js",
13
+ "index.d.ts"
14
+ ],
15
+ "scripts": {
16
+ "build": "napi build --platform --release",
17
+ "build:debug": "napi build --platform",
18
+ "test": "jest",
19
+ "prepublishOnly": "npm run build"
20
+ },
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "https://github.com/gokul-viswanathan/anonymask.git"
24
+ },
25
+ "homepage": "https://github.com/gokul-viswanathan/anonymask",
26
+ "bugs": {
27
+ "url": "https://github.com/gokul-viswanathan/anonymask/issues"
28
+ },
29
+ "keywords": [
30
+ "anonymization",
31
+ "PII",
32
+ "privacy",
33
+ "LLM",
34
+ "RAG",
35
+ "security",
36
+ "data-protection"
37
+ ],
38
+ "author": "Gokul Viswanathan <gokulviswanathan25@gmail.com>",
39
+ "license": "MIT",
40
+ "engines": {
41
+ "node": ">=14.0.0"
42
+ },
43
+ "devDependencies": {
44
+ "@napi-rs/cli": "^2.18.0",
45
+ "jest": "^30.2.0"
46
+ },
47
+ "napi": {
48
+ "name": "anonymask",
49
+ "cargoManifestPath": "./Cargo.toml",
50
+ "triples": {
51
+ "defaults": true,
52
+ "additional": [
53
+ "aarch64-apple-darwin",
54
+ "x86_64-unknown-linux-gnu",
55
+ "x86_64-apple-darwin",
56
+ "x86_64-pc-windows-msvc"
57
+ ]
58
+ }
59
+ }
60
+ }