@quba/sensitive-data-protection 0.2.2 → 0.2.4

package/docs/FileModelResult.md

@@ -15,6 +15,7 @@ Name | Type
 `input` | string
 `output` | string
 `path` | Array<Array<PathSegment>>
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -31,6 +32,7 @@ const example = {
   "input": null,
   "output": null,
   "path": null,
+  "action": null,
 } satisfies FileModelResult
 
 console.log(example)

package/docs/FileRegexResult.md

@@ -14,6 +14,7 @@ Name | Type
 `input` | string
 `output` | string
 `path` | Array<Array<PathSegment>>
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -29,6 +30,7 @@ const example = {
   "input": null,
   "output": null,
   "path": null,
+  "action": null,
 } satisfies FileRegexResult
 
 console.log(example)

package/docs/FileResult.md

@@ -15,6 +15,7 @@ Name | Type
 `input` | string
 `output` | string
 `path` | Array<Array<PathSegment>>
+`action` | [Action](Action.md)
 `content_type` | string
 
 ## Example
@@ -32,6 +33,7 @@ const example = {
   "input": null,
   "output": null,
   "path": null,
+  "action": null,
   "content_type": null,
 } satisfies FileResult
 

package/docs/HMACRule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 `key` | string
 `length` | number
 
@@ -23,6 +24,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
   "key": null,
   "length": null,
 } satisfies HMACRule

package/docs/MaskRule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 `masking_char` | string
 `chars_to_mask` | number
 `from_end` | boolean
@@ -24,6 +25,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
   "masking_char": null,
   "chars_to_mask": null,
   "from_end": null,

package/docs/ModelEntity.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `type` | string
 `value` | string
+`threshold` | number
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { ModelEntity } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "value": null,
+  "threshold": null,
 } satisfies ModelEntity
 
 console.log(example)

package/docs/PolicyDocument.md

@@ -10,6 +10,8 @@ Name | Type
 `schema_version` | number
 `name` | string
 `confidence_threshold` | number
+`embedded_rules` | string
+`models` | Array<string>
 `rules` | [Array<PolicyDocumentRulesInner>](PolicyDocumentRulesInner.md)
 
 ## Example
@@ -22,6 +24,8 @@ const example = {
   "schema_version": null,
   "name": null,
   "confidence_threshold": null,
+  "embedded_rules": null,
+  "models": null,
   "rules": null,
 } satisfies PolicyDocument
 

package/docs/PolicyDocumentRulesInner.md

@@ -9,6 +9,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 `replacement` | string
 `masking_char` | string
 `chars_to_mask` | number
@@ -27,6 +28,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
   "replacement": null,
   "masking_char": null,
   "chars_to_mask": null,

package/docs/PseudonymizeRule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 `tag` | string
 
 ## Example
@@ -22,6 +23,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
   "tag": null,
 } satisfies PseudonymizeRule
 

package/docs/RedactRule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
 } satisfies RedactRule
 
 console.log(example)

package/docs/ReplaceRule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 `replacement` | string
 
 ## Example
@@ -22,6 +23,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
   "replacement": null,
 } satisfies ReplaceRule
 

package/docs/RuleBody.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 `replacement` | string
 `key` | string
 `masking_char` | string
@@ -28,6 +29,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
   "replacement": null,
   "key": null,
   "masking_char": null,

package/docs/SHA256Rule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
 } satisfies SHA256Rule
 
 console.log(example)

package/docs/SHA512Rule.md

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `entities` | [Array<EntityBody>](EntityBody.md)
 `action` | [Action](Action.md)
+`when` | string
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "type": null,
   "entities": null,
   "action": null,
+  "when": null,
 } satisfies SHA512Rule
 
 console.log(example)

package/docs/SensitiveDataProtectionApi.md

@@ -44,7 +44,7 @@ async function example() {
     rules: rules_example,
     // number | Minimum score for model detections. Does not affect regex matches. (optional)
     confidence_threshold: 8.14,
-    // string | Embedded content (embedded files, OLE objects, a FHIR JSON photo\\\'s base64 `data` on Patient, Practitioner, RelatedPerson or Person). `anonymize` (default): what can be read (an Office or text file; a PNG, JPEG, WebP, BMP or TIFF image where this server reads images) is anonymized as a file of its own and written back, the rest removed. `anonymize_or_keep`: the same, the rest kept unread. `remove`: all removed. `keep`: all kept unread. Thumbnails are always removed; fonts and printer settings always kept; an Office file\\\'s pictures are read and masked where this server reads images, whatever the rule. (optional)
+    // string | Embedded content (embedded files, OLE objects, a FHIR JSON photo\\\'s base64 `data` on Patient, Practitioner, RelatedPerson or Person). `anonymize` (default): what can be read (an Office or text file; a PNG, JPEG, WebP, BMP or TIFF image where this server reads images) is anonymized as a file of its own and written back, the rest removed. `anonymize_or_keep`: the same, the rest kept unread. `remove`: all removed. `keep`: all kept unread. Thumbnails are always removed; fonts and printer settings always kept; an Office file\\\'s pictures are read and masked where this server reads images, whatever the rule. A whole file this server can\\\'t read (its format, size or state) follows it too: `anonymize_or_keep` and `keep` return it unchanged with no results; the others refuse it with a 422 on `file`. (optional)
     embedded_rules: embedded_rules_example,
     // string | CSV, TSV and xlsx only: where a table\\\'s headers are, in the data\\\'s order (field 1, column A), so each value is read with its header. (optional)
     table_headers: table_headers_example,
@@ -74,7 +74,7 @@ example().catch(console.error);
 | **file** | `Blob` | The file: docx, xlsx, pptx, csv, tsv, txt, md, log, json, jsonl, xml, html, hl7 (HL7 v2), png, jpg, webp, bmp, tiff (one page) or dcm (DICOM Part 10). Office files, images, DICOM, XML, HTML, HL7 v2 and FHIR JSON are told by their bytes; other text by its part\\\'s `Content-Type` when specific, else its name\\\'s extension. | [Defaults to `undefined`] |
 | **rules** | `string` | The de-identification rules, a JSON array as for `/anonymize`. Omit for the default rules. | [Optional] [Defaults to `undefined`] |
 | **confidence_threshold** | `number` | Minimum score for model detections. Does not affect regex matches. | [Optional] [Defaults to `0.5`] |
-| **embedded_rules** | `anonymize`, `anonymize_or_keep`, `remove`, `keep` | Embedded content (embedded files, OLE objects, a FHIR JSON photo\\\'s base64 `data` on Patient, Practitioner, RelatedPerson or Person). `anonymize` (default): what can be read (an Office or text file; a PNG, JPEG, WebP, BMP or TIFF image where this server reads images) is anonymized as a file of its own and written back, the rest removed. `anonymize_or_keep`: the same, the rest kept unread. `remove`: all removed. `keep`: all kept unread. Thumbnails are always removed; fonts and printer settings always kept; an Office file\\\'s pictures are read and masked where this server reads images, whatever the rule. | [Optional] [Defaults to `'anonymize'`] [Enum: anonymize, anonymize_or_keep, remove, keep] |
+| **embedded_rules** | `anonymize`, `anonymize_or_keep`, `remove`, `keep` | Embedded content (embedded files, OLE objects, a FHIR JSON photo\\\'s base64 `data` on Patient, Practitioner, RelatedPerson or Person). `anonymize` (default): what can be read (an Office or text file; a PNG, JPEG, WebP, BMP or TIFF image where this server reads images) is anonymized as a file of its own and written back, the rest removed. `anonymize_or_keep`: the same, the rest kept unread. `remove`: all removed. `keep`: all kept unread. Thumbnails are always removed; fonts and printer settings always kept; an Office file\\\'s pictures are read and masked where this server reads images, whatever the rule. A whole file this server can\\\'t read (its format, size or state) follows it too: `anonymize_or_keep` and `keep` return it unchanged with no results; the others refuse it with a 422 on `file`. | [Optional] [Defaults to `'anonymize'`] [Enum: anonymize, anonymize_or_keep, remove, keep] |
 | **table_headers** | `none`, `first_row`, `first_column`, `last_column` | CSV, TSV and xlsx only: where a table\\\'s headers are, in the data\\\'s order (field 1, column A), so each value is read with its header. | [Optional] [Defaults to `'none'`] [Enum: none, first_row, first_column, last_column] |
 | **models** | `string` | Ids from `GET /models`, comma-separated (or the field repeated), each type\\\'s in order of preference: the first `ready` text model runs, and, for a file with images (an image, a DICOM file\\\'s pixels, an Office file\\\'s images), the first `ready` image reader. A type named none of runs on the first ready of all, largest first, waiting at startup until one is. None named of a type is ready: a 503, with `Retry-After` while one still loads. An unknown id: a 422. Omit for the defaults. | [Optional] [Defaults to `undefined`] |
 | **dicom_options** | `string` | DICOM only: the options of the Basic Application Level Confidentiality Profile (PS3.15 Annex E) to apply, comma-separated, of: `clean_descriptors`, `retain_longitudinal_full_dates`, `retain_patient_characteristics`, `retain_device_identity`, `retain_institution_identity`, `retain_uids`. Empty for none. `clean_descriptors` scans descriptions and comments with the rules instead of removing them. | [Optional] [Defaults to `'clean_descriptors'`] |

package/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "type": "module",
   "homepage": "https://www.quba.co",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "keywords": [
     "sensitive data protection",
     "sdp",