@quba/sensitive-data-protection 0.1.0 → 0.2.2

package/docs/Action.md

@@ -0,0 +1,33 @@
+
+# Action
+
+What the browser extension does with a match, before the text is sent. `warn`: highlighted; the user may send it as it is. `enforce`: replaced with the rule\'s transformation before sending; sending is blocked when it can\'t be.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { Action } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies Action
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Action
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AnonymizeFileResponseBody.md

@@ -0,0 +1,43 @@
+
+# AnonymizeFileResponseBody
+
+Response from the document endpoint: the anonymized file and what changed in it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`usage` | [Usage](Usage.md)
+`models` | Array<string>
+`format` | string
+`results` | [Array<FileResult>](FileResult.md)
+`file` | string
+
+## Example
+
+```typescript
+import type { AnonymizeFileResponseBody } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "usage": null,
+  "models": null,
+  "format": null,
+  "results": null,
+  "file": null,
+} satisfies AnonymizeFileResponseBody
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AnonymizeFileResponseBody
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AnonymizeRequestBody.md

@@ -1,15 +1,16 @@
 
 # AnonymizeRequestBody
 
-Request body for the anonymize endpoint.  Carries the text to anonymize and the list of de-identification rules to apply. See ``AnonymizationCommand`` for field-level details.
+Request body for the anonymize endpoint.  Carries the text to anonymize and the list of de-identification rules to apply.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `text` | string
-`rules` | [Array<AnonymizeRequestBodyRulesInner>](AnonymizeRequestBodyRulesInner.md)
+`rules` | [Array<RuleBody>](RuleBody.md)
 `confidence_threshold` | number
+`models` | Array<string>
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "text": null,
   "rules": null,
   "confidence_threshold": null,
+  "models": null,
 } satisfies AnonymizeRequestBody
 
 console.log(example)

package/docs/AnonymizeResponseBody.md

@@ -8,8 +8,9 @@ Response from the anonymize endpoint: the anonymized text and a record of every
 Name | Type
 ------------ | -------------
 `text` | string
-`results` | [Array<AnonymizeResponseBodyResultsInner>](AnonymizeResponseBodyResultsInner.md)
+`results` | [Array<Applied>](Applied.md)
 `usage` | [Usage](Usage.md)
+`models` | Array<string>
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "text": null,
   "results": null,
   "usage": null,
+  "models": null,
 } satisfies AnonymizeResponseBody
 
 console.log(example)

package/docs/{AnonymizeResponseBodySpansInner.md → Applied.md}

@@ -1,6 +1,7 @@
 
-# AnonymizeResponseBodySpansInner
+# Applied
 
+One rewrite, from a model detection or a regex match.
 
 ## Properties
 
@@ -12,11 +13,12 @@ Name | Type
 `input` | [TextRange](TextRange.md)
 `output` | [TextRange](TextRange.md)
 `score` | number
+`action` | [Action](Action.md)
 
 ## Example
 
 ```typescript
-import type { AnonymizeResponseBodySpansInner } from '@quba/sensitive-data-protection'
+import type { Applied } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -26,7 +28,8 @@ const example = {
   "input": null,
   "output": null,
   "score": null,
-} satisfies AnonymizeResponseBodySpansInner
+  "action": null,
+} satisfies Applied
 
 console.log(example)
 
@@ -35,7 +38,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AnonymizeResponseBodySpansInner
+const exampleParsed = JSON.parse(exampleJSON) as Applied
 console.log(exampleParsed)
 ```
 

package/docs/At.md

@@ -0,0 +1,37 @@
+
+# At
+
+How far reading has got: the last unit of a batch.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | [Array<PathSegment>](PathSegment.md)
+`text` | string
+
+## Example
+
+```typescript
+import type { At } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "text": null,
+} satisfies At
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as At
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AttributeSegment.md

@@ -0,0 +1,37 @@
+
+# AttributeSegment
+
+An XML or HTML attribute of the element before it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { AttributeSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+} satisfies AttributeSegment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AttributeSegment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/{ValidationErrorLocInner.md → CellKind.md}

@@ -1,6 +1,7 @@
 
-# ValidationErrorLocInner
+# CellKind
 
+What a cell\'s text is when it is not its value.
 
 ## Properties
 
@@ -10,11 +11,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ValidationErrorLocInner } from '@quba/sensitive-data-protection'
+import type { CellKind } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies ValidationErrorLocInner
+} satisfies CellKind
 
 console.log(example)
 
@@ -23,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ValidationErrorLocInner
+const exampleParsed = JSON.parse(exampleJSON) as CellKind
 console.log(exampleParsed)
 ```
 

package/docs/CellNoteSegment.md

@@ -0,0 +1,35 @@
+
+# CellNoteSegment
+
+A workbook note on a cell (Excel\'s \"Note\", a legacy comment); it follows its cell.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+
+## Example
+
+```typescript
+import type { CellNoteSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+} satisfies CellNoteSegment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CellNoteSegment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CellSegment.md

@@ -0,0 +1,43 @@
+
+# CellSegment
+
+A cell, from 1, in the data\'s order (a CSV\'s header line is row 1); `ref` in A1. No `kind` for its value.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`row` | number
+`column` | number
+`ref` | string
+`kind` | [CellKind](CellKind.md)
+
+## Example
+
+```typescript
+import type { CellSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "row": null,
+  "column": null,
+  "ref": null,
+  "kind": null,
+} satisfies CellSegment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CellSegment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CommentKind.md

@@ -0,0 +1,33 @@
+
+# CommentKind
+
+Its author\'s name or initials.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { CommentKind } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies CommentKind
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommentKind
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CommentSegment.md

@@ -0,0 +1,39 @@
+
+# CommentSegment
+
+A comment (Word `w:comment`, PowerPoint `p:cm`, Excel threaded comment), by its id in the file. In a workbook it follows its cell.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | string
+`kind` | [CommentKind](CommentKind.md)
+
+## Example
+
+```typescript
+import type { CommentSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "kind": null,
+} satisfies CommentSegment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommentSegment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ComponentSegment.md

@@ -0,0 +1,39 @@
+
+# ComponentSegment
+
+An HL7 v2 component of the field before it: `1` in `PID-5.1`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+`subcomponent` | number
+
+## Example
+
+```typescript
+import type { ComponentSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+  "subcomponent": null,
+} satisfies ComponentSegment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ComponentSegment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DetectRule.md

@@ -8,7 +8,8 @@ Report each matched value without changing it.  The match is recorded in the res
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { DetectRule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
 } satisfies DetectRule
 
 console.log(example)

package/docs/ElementSegment.md

@@ -0,0 +1,39 @@
+
+# ElementSegment
+
+An XML or HTML element, by its local name (no namespace prefix): a step towards a value, as in a path of element names.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+`index` | number
+
+## Example
+
+```typescript
+import type { ElementSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+  "index": null,
+} satisfies ElementSegment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ElementSegment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EncryptRule.md

@@ -8,7 +8,8 @@ Replace each matched value with a Fernet-encrypted token.  If no key is supplied
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 `key` | string
 
 ## Example
@@ -20,6 +21,7 @@ import type { EncryptRule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
   "key": null,
 } satisfies EncryptRule
 

package/docs/{DetectRuleEntitiesInner.md → EndnoteSegment.md}

@@ -1,24 +1,25 @@
 
-# DetectRuleEntitiesInner
+# EndnoteSegment
 
+An endnote (`w:endnote`), by its id.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`value` | string
+`id` | string
 
 ## Example
 
 ```typescript
-import type { DetectRuleEntitiesInner } from '@quba/sensitive-data-protection'
+import type { EndnoteSegment } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
-  "value": null,
-} satisfies DetectRuleEntitiesInner
+  "id": null,
+} satisfies EndnoteSegment
 
 console.log(example)
 
@@ -27,7 +28,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as DetectRuleEntitiesInner
+const exampleParsed = JSON.parse(exampleJSON) as EndnoteSegment
 console.log(exampleParsed)
 ```
 

package/docs/{EntitiesAnyOfInner.md → EntityBody.md}

@@ -1,6 +1,7 @@
 
-# EntitiesAnyOfInner
+# EntityBody
 
+An entity to target, chosen by its `type`.
 
 ## Properties
 
@@ -12,13 +13,13 @@ Name | Type
 ## Example
 
 ```typescript
-import type { EntitiesAnyOfInner } from '@quba/sensitive-data-protection'
+import type { EntityBody } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
   "value": null,
-} satisfies EntitiesAnyOfInner
+} satisfies EntityBody
 
 console.log(example)
 
@@ -27,7 +28,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as EntitiesAnyOfInner
+const exampleParsed = JSON.parse(exampleJSON) as EntityBody
 console.log(exampleParsed)
 ```
 

package/docs/ErrorCode.md

@@ -0,0 +1,33 @@
+
+# ErrorCode
+
+What went wrong, for callers to branch on. `invalid_json` (400): the body is not JSON. `invalid_request` (422): some fields are invalid, `details` says which. `unauthorized` (401), `not_found` (404), `method_not_allowed` (405). `internal` (500): the request failed; retrying may help. `unavailable` (503): the model is not loaded. `forbidden` (403): the caller\'s assigned policy sets the rules or threshold. `policy_unreadable` (409): that policy cannot be read.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ErrorCode } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ErrorCode
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorCode
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ErrorInfo.md

@@ -0,0 +1,39 @@
+
+# ErrorInfo
+
+The error itself.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | [ErrorCode](ErrorCode.md)
+`message` | string
+`details` | [Array<FieldError>](FieldError.md)
+
+## Example
+
+```typescript
+import type { ErrorInfo } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "details": null,
+} satisfies ErrorInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+