@quba/sensitive-data-protection 0.0.12 → 0.2.0

package/docs/KeySegment.md

@@ -0,0 +1,37 @@
+
+# KeySegment
+
+A JSON object\'s key: a step towards a value, as in a JSON Pointer.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { KeySegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+} satisfies KeySegment
+
+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 KeySegment
+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/Kind.md

@@ -0,0 +1,33 @@
+
+# Kind
+
+What the text is in an Office file, named after its ECMA-376 element or property.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { Kind } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies Kind
+
+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 Kind
+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/LineSegment.md

@@ -0,0 +1,39 @@
+
+# LineSegment
+
+Where a value starts in a text file, from 1, as an editor shows it; in an image, the line read (in reading order) and the character in it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`line` | number
+`column` | number
+
+## Example
+
+```typescript
+import type { LineSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "line": null,
+  "column": null,
+} satisfies LineSegment
+
+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 LineSegment
+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/MaskRule.md

@@ -8,7 +8,8 @@ Mask part of each matched value with a repeated character.  By default the whole
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 `masking_char` | string
 `chars_to_mask` | number
 `from_end` | boolean
@@ -22,6 +23,7 @@ import type { MaskRule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
   "masking_char": null,
   "chars_to_mask": null,
   "from_end": null,

package/docs/ModelEntity.md

@@ -1,7 +1,7 @@
 
 # ModelEntity
 
-An AI-model entity type to target, e.g. \'PERSON\', \'EMAIL\', \'LOCATION\'.
+An AI-model entity type to target, e.g. \'person\', \'email\', \'phone_number\'.
 
 ## Properties
 

package/docs/ModelError.md

@@ -0,0 +1,35 @@
+
+# ModelError
+
+Every error response\'s body.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | [ErrorInfo](ErrorInfo.md)
+
+## Example
+
+```typescript
+import type { ModelError } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies ModelError
+
+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 ModelError
+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/ModelResult.md

@@ -1,7 +1,7 @@
 
 # ModelResult
 
-Record of an AI model detection and its anonymization.  Created when an AI model identifies an entity (e.g. PERSON, EMAIL) and a rule anonymizes the matched text.
+Record of an AI model detection and its anonymization.  Created when an AI model identifies an entity (e.g. person, email) and a rule anonymizes the matched text.
 
 ## Properties
 
@@ -13,6 +13,7 @@ Name | Type
 `input` | [TextRange](TextRange.md)
 `output` | [TextRange](TextRange.md)
 `score` | number
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -27,6 +28,7 @@ const example = {
   "input": null,
   "output": null,
   "score": null,
+  "action": null,
 } satisfies ModelResult
 
 console.log(example)

package/docs/ModelStatus.md

@@ -0,0 +1,45 @@
+
+# ModelStatus
+
+One model the server offers.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | [ModelType](ModelType.md)
+`_default` | boolean
+`ready` | boolean
+`description` | string
+`error` | string
+
+## Example
+
+```typescript
+import type { ModelStatus } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "_default": null,
+  "ready": null,
+  "description": null,
+  "error": null,
+} satisfies ModelStatus
+
+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 ModelStatus
+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/{Entities.md → ModelType.md}

@@ -1,6 +1,7 @@
 
-# Entities
+# ModelType
 
+What a model reads.
 
 ## Properties
 
@@ -10,11 +11,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { Entities } from '@quba/sensitive-data-protection'
+import type { ModelType } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies Entities
+} satisfies ModelType
 
 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 Entities
+const exampleParsed = JSON.parse(exampleJSON) as ModelType
 console.log(exampleParsed)
 ```
 

package/docs/ParagraphKind.md

@@ -0,0 +1,33 @@
+
+# ParagraphKind
+
+What a paragraph\'s text is when it is not its own text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ParagraphKind } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ParagraphKind
+
+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 ParagraphKind
+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/ParagraphSegment.md

@@ -0,0 +1,39 @@
+
+# ParagraphSegment
+
+A paragraph (`w:p`, `a:p`), numbered from 1 in what holds it (the part, a shape, a cell, a comment, a footnote). No `kind` for its own text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+`kind` | [ParagraphKind](ParagraphKind.md)
+
+## Example
+
+```typescript
+import type { ParagraphSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+  "kind": null,
+} satisfies ParagraphSegment
+
+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 ParagraphSegment
+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/PartSegment.md

@@ -0,0 +1,39 @@
+
+# PartSegment
+
+Any other file in an Office zip, e.g. `word/document.xml`, `docProps/core.xml`. `kind` until finer segments (paragraphs, properties) say where its text is.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`part` | string
+`kind` | [Kind](Kind.md)
+
+## Example
+
+```typescript
+import type { PartSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "part": null,
+  "kind": null,
+} satisfies PartSegment
+
+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 PartSegment
+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/PathSegment.md

@@ -0,0 +1,79 @@
+
+# PathSegment
+
+One step of where a result is, outermost first: a container (a worksheet, a slide, another file in an Office zip), the shapes it is in, where the text is, then `text`: the characters found there, before and after. `kind`, on the segment before `text` only, says what the text is there.  Paths grow: later versions add segment types inside these (paragraphs, tables, comments, properties), so the same text may get a longer path. Read `text` and `kind` from the end and find segments by `type`; do not compare whole paths.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+`part` | string
+`number` | number
+`kind` | [RangeKind](RangeKind.md)
+`slide` | number
+`id` | string
+`row` | number
+`column` | number
+`ref` | string
+`line` | number
+`x` | number
+`y` | number
+`w` | number
+`h` | number
+`group` | string
+`element` | string
+`keyword` | string
+`index` | number
+`repetition` | number
+`subcomponent` | number
+`input` | [TextRange](TextRange.md)
+`output` | [TextRange](TextRange.md)
+
+## Example
+
+```typescript
+import type { PathSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+  "part": null,
+  "number": null,
+  "kind": null,
+  "slide": null,
+  "id": null,
+  "row": null,
+  "column": null,
+  "ref": null,
+  "line": null,
+  "x": null,
+  "y": null,
+  "w": null,
+  "h": null,
+  "group": null,
+  "element": null,
+  "keyword": null,
+  "index": null,
+  "repetition": null,
+  "subcomponent": null,
+  "input": null,
+  "output": null,
+} satisfies PathSegment
+
+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 PathSegment
+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/PoliciesApi.md

@@ -77,6 +77,8 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **201** | The created policy. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **403** | The caller may not do this. API keys hold no role, so they cannot change policies. |  -  |
 | **409** | A policy with that name already exists. |  -  |
 | **422** | The document failed validation. |  -  |
 
@@ -141,14 +143,17 @@ example().catch(console.error);
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **204** | Deleted. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **403** | The caller may not do this. API keys hold no role, so they cannot change policies. |  -  |
 | **404** | No such policy in this organization. |  -  |
+| **409** | Members or API keys are held to the policy. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -218,6 +223,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | The policy and its latest document. |  -  |
+| **401** | Missing or invalid API key. |  -  |
 | **404** | No such policy in this organization. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -280,6 +286,7 @@ This endpoint does not need any parameter.
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | The calling organization\'s policies. |  -  |
+| **401** | Missing or invalid API key. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -352,6 +359,8 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | The updated policy. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **403** | The caller may not do this. API keys hold no role, so they cannot change policies. |  -  |
 | **404** | No such policy in this organization. |  -  |
 | **409** | A policy with that name already exists. |  -  |
 | **422** | The document failed validation. |  -  |

package/docs/PolicyDocumentRulesInner.md

@@ -7,12 +7,15 @@
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 `replacement` | string
 `masking_char` | string
 `chars_to_mask` | number
 `from_end` | boolean
 `key` | string
+`tag` | string
+`length` | number
 
 ## Example
 
@@ -23,11 +26,14 @@ import type { PolicyDocumentRulesInner } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
   "replacement": null,
   "masking_char": null,
   "chars_to_mask": null,
   "from_end": null,
   "key": null,
+  "tag": null,
+  "length": null,
 } satisfies PolicyDocumentRulesInner
 
 console.log(example)

package/docs/{ValidationError.md → PropertySegment.md}

@@ -1,30 +1,25 @@
 
-# ValidationError
+# PropertySegment
 
+A document property: a core one by its element (`creator`, `title`, `lastModifiedBy`), an extended one likewise (`Company`, `Manager`), a custom one by its name.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`loc` | [Array<ValidationErrorLocInner>](ValidationErrorLocInner.md)
-`msg` | string
 `type` | string
-`input` | any
-`ctx` | object
+`name` | string
 
 ## Example
 
 ```typescript
-import type { ValidationError } from '@quba/sensitive-data-protection'
+import type { PropertySegment } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "loc": null,
-  "msg": null,
   "type": null,
-  "input": null,
-  "ctx": null,
-} satisfies ValidationError
+  "name": null,
+} satisfies PropertySegment
 
 console.log(example)
 
@@ -33,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 ValidationError
+const exampleParsed = JSON.parse(exampleJSON) as PropertySegment
 console.log(exampleParsed)
 ```
 

package/docs/PseudonymizeRule.md

@@ -0,0 +1,41 @@
+
+# PseudonymizeRule
+
+Replace each matched value with its label and a number, e.g. \'[PERSON_1]\'.  The same value gets the same tag throughout one request (or one file), a different value the next number. Each result pairs the tag with the value it stands for: the mapping to restore the values in a reply. It is not kept. Pseudonymize rules in one request number together: two rules tagging \'person\' never both give \'[PERSON_1]\'.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
+`tag` | string
+
+## Example
+
+```typescript
+import type { PseudonymizeRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+  "action": null,
+  "tag": null,
+} satisfies PseudonymizeRule
+
+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 PseudonymizeRule
+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/RangeKind.md

@@ -0,0 +1,33 @@
+
+# RangeKind
+
+A data validation\'s prompt, error message or list of values.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RangeKind } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RangeKind
+
+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 RangeKind
+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)
+
+