@quba/sensitive-data-protection 0.1.0 → 0.2.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 (78) hide show
  1. package/README.md +58 -6
  2. package/dist/index.cjs +2884 -569
  3. package/dist/index.d.cts +3059 -765
  4. package/dist/index.d.mts +3059 -765
  5. package/dist/index.mjs +2574 -535
  6. package/docs/Action.md +33 -0
  7. package/docs/AnonymizeFileResponseBody.md +43 -0
  8. package/docs/AnonymizeRequestBody.md +4 -2
  9. package/docs/AnonymizeResponseBody.md +3 -1
  10. package/docs/{AnonymizeResponseBodySpansInner.md → Applied.md} +7 -4
  11. package/docs/At.md +37 -0
  12. package/docs/AttributeSegment.md +37 -0
  13. package/docs/{ValidationErrorLocInner.md → CellKind.md} +5 -4
  14. package/docs/CellNoteSegment.md +35 -0
  15. package/docs/CellSegment.md +43 -0
  16. package/docs/CommentKind.md +33 -0
  17. package/docs/CommentSegment.md +39 -0
  18. package/docs/ComponentSegment.md +39 -0
  19. package/docs/DetectRule.md +3 -1
  20. package/docs/ElementSegment.md +39 -0
  21. package/docs/EncryptRule.md +3 -1
  22. package/docs/{DetectRuleEntitiesInner.md → EndnoteSegment.md} +7 -6
  23. package/docs/{EntitiesAnyOfInner.md → EntityBody.md} +5 -4
  24. package/docs/ErrorCode.md +33 -0
  25. package/docs/ErrorInfo.md +39 -0
  26. package/docs/FieldError.md +51 -0
  27. package/docs/FieldErrorCode.md +33 -0
  28. package/docs/{HTTPValidationError.md → FieldErrorPathInner.md} +5 -6
  29. package/docs/FieldSegment.md +39 -0
  30. package/docs/FileAttributeResult.md +47 -0
  31. package/docs/FileEmbeddedResult.md +43 -0
  32. package/docs/FileModelResult.md +49 -0
  33. package/docs/{AnonymizeResponseBodyResultsInner.md → FileRegexResult.md} +11 -8
  34. package/docs/FileResult.md +51 -0
  35. package/docs/FootnoteSegment.md +37 -0
  36. package/docs/FrameSegment.md +37 -0
  37. package/docs/HMACRule.md +43 -0
  38. package/docs/HeaderFooterSegment.md +37 -0
  39. package/docs/IndexSegment.md +37 -0
  40. package/docs/ItemSegment.md +37 -0
  41. package/docs/KeySegment.md +37 -0
  42. package/docs/Kind.md +33 -0
  43. package/docs/LineSegment.md +39 -0
  44. package/docs/MaskRule.md +3 -1
  45. package/docs/ModelError.md +2 -3
  46. package/docs/ModelResult.md +2 -0
  47. package/docs/ModelStatus.md +45 -0
  48. package/docs/{Entities.md → ModelType.md} +5 -4
  49. package/docs/ParagraphKind.md +33 -0
  50. package/docs/ParagraphSegment.md +39 -0
  51. package/docs/PartSegment.md +39 -0
  52. package/docs/PathSegment.md +79 -0
  53. package/docs/PolicyDocumentRulesInner.md +7 -1
  54. package/docs/{ValidationError.md → PropertySegment.md} +7 -12
  55. package/docs/PseudonymizeRule.md +41 -0
  56. package/docs/RangeKind.md +33 -0
  57. package/docs/RangeSegment.md +39 -0
  58. package/docs/RedactRule.md +3 -1
  59. package/docs/Refusal.md +36 -0
  60. package/docs/RegexResult.md +2 -0
  61. package/docs/RegionSegment.md +43 -0
  62. package/docs/ReplaceRule.md +3 -1
  63. package/docs/{AnonymizeRequestBodyRulesInner.md → RuleBody.md} +12 -5
  64. package/docs/SHA256Rule.md +3 -1
  65. package/docs/SHA512Rule.md +3 -1
  66. package/docs/ScanRequestBody.md +2 -0
  67. package/docs/ScanResponseBody.md +2 -0
  68. package/docs/SegmentSegment.md +39 -0
  69. package/docs/SensitiveDataProtectionApi.md +160 -3
  70. package/docs/ShapeKind.md +33 -0
  71. package/docs/ShapeSegment.md +41 -0
  72. package/docs/SheetSegment.md +39 -0
  73. package/docs/SlideSegment.md +41 -0
  74. package/docs/SpeakerNotesSegment.md +41 -0
  75. package/docs/TableSegment.md +37 -0
  76. package/docs/TagSegment.md +41 -0
  77. package/docs/TextSegment.md +39 -0
  78. package/package.json +1 -1
@@ -0,0 +1,41 @@
1
+
2
+ # TagSegment
3
+
4
+ A DICOM attribute: its tag, as four hex digits each, and its keyword (`PatientName`) when the standard names it; none for a private one.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `type` | string
11
+ `group` | string
12
+ `element` | string
13
+ `keyword` | string
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { TagSegment } from '@quba/sensitive-data-protection'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "type": null,
23
+ "group": null,
24
+ "element": null,
25
+ "keyword": null,
26
+ } satisfies TagSegment
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as TagSegment
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,39 @@
1
+
2
+ # TextSegment
3
+
4
+ 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.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `type` | string
11
+ `input` | [TextRange](TextRange.md)
12
+ `output` | [TextRange](TextRange.md)
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { TextSegment } from '@quba/sensitive-data-protection'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "type": null,
22
+ "input": null,
23
+ "output": null,
24
+ } satisfies TextSegment
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as TextSegment
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "license": "MIT",
6
6
  "type": "module",
7
7
  "homepage": "https://www.quba.co",
8
- "version": "0.1.0",
8
+ "version": "0.2.0",
9
9
  "keywords": [
10
10
  "sensitive data protection",
11
11
  "sdp",