@quba/sensitive-data-protection 0.0.12 → 0.2.0

package/docs/SlideSegment.md

@@ -0,0 +1,41 @@
+
+# SlideSegment
+
+A slide, numbered as PowerPoint shows it, and its part. `kind` until shapes hold all of a slide\'s text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+`part` | string
+`kind` | [Kind](Kind.md)
+
+## Example
+
+```typescript
+import type { SlideSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+  "part": null,
+  "kind": null,
+} satisfies SlideSegment
+
+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 SlideSegment
+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/SpeakerNotesSegment.md

@@ -0,0 +1,41 @@
+
+# SpeakerNotesSegment
+
+A slide\'s speaker notes (`speaker_notes`): the slide\'s number, and the notes\' part. `kind` until shapes hold all of their text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`slide` | number
+`part` | string
+`kind` | [Kind](Kind.md)
+
+## Example
+
+```typescript
+import type { SpeakerNotesSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "slide": null,
+  "part": null,
+  "kind": null,
+} satisfies SpeakerNotesSegment
+
+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 SpeakerNotesSegment
+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/TableSegment.md

@@ -0,0 +1,37 @@
+
+# TableSegment
+
+A table in a Word document or on a slide, numbered from 1 in what holds it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+
+## Example
+
+```typescript
+import type { TableSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+} satisfies TableSegment
+
+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 TableSegment
+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/TagSegment.md

@@ -0,0 +1,41 @@
+
+# TagSegment
+
+A DICOM attribute: its tag, as four hex digits each, and its keyword (`PatientName`) when the standard names it; none for a private one.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`group` | string
+`element` | string
+`keyword` | string
+
+## Example
+
+```typescript
+import type { TagSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "group": null,
+  "element": null,
+  "keyword": null,
+} satisfies TagSegment
+
+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 TagSegment
+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/TextSegment.md

@@ -0,0 +1,39 @@
+
+# TextSegment
+
+The last segment of a found value\'s path: its piece in the object the path leads to, in the file as it was and as it is now. Offsets from the start of the cell (xlsx, CSV, TSV), the paragraph (docx, pptx), the line (other text files) or the JSON value, as `/anonymize` counts them.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`input` | [TextRange](TextRange.md)
+`output` | [TextRange](TextRange.md)
+
+## Example
+
+```typescript
+import type { TextSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "input": null,
+  "output": null,
+} satisfies TextSegment
+
+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 TextSegment
+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/package.json

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