@nutrient-sdk/viewer 1.9.0-nightly.20251021 → 1.9.0-nightly.20251022
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.
- package/dist/index.d.ts +190 -190
- package/dist/nutrient-viewer-lib/{chunk-848-290cc8d09c8a62eb.js → chunk-848-80625491767a05ef.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-core-worker-d5c4a73819f3a2c8.js → chunk-core-worker-578e4b7d9efc8f0c.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-gdpicture-341412d857d3e802.js → chunk-gdpicture-fde3610783829758.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-gdpicture-worker-0ace420ab65f45fa.js → chunk-gdpicture-worker-f606e2bd891fd7b2.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-lazy-sha-0e57f482fd247845.js → chunk-lazy-sha-93e09d791715558d.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ar-43c96ff8e7b1ef34.js → chunk-locale-ar-0cc2680e46ea0731.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-cs-90fe5e592105babc.js → chunk-locale-cs-71f65fc30bc849b8.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-cy-38b6835c1fdc79ba.js → chunk-locale-cy-db16f1e76288938b.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-da-677ccd6b0cdac2a0.js → chunk-locale-da-962474e9ae3ba049.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-de-4f7300ab8f359452.js → chunk-locale-de-c264a8eef21a23b8.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-el-3728248b9e22020d.js → chunk-locale-el-53483f3a7e6da311.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-en-GB-078a190958a5ca9d.js → chunk-locale-en-GB-888f55be45d1a13e.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-es-b9c630829d169f86.js → chunk-locale-es-478de82e2a5e9a55.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-fi-c34c04d1a10b7192.js → chunk-locale-fi-38eb3d4cfbc34144.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-fr-44f88e097de7b40f.js → chunk-locale-fr-38404a4acf00a3ea.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-fr-CA-ccd4183cf5dd3480.js → chunk-locale-fr-CA-1e543ee6b34e47b8.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-he-c1065910a8238a29.js → chunk-locale-he-d811d2de73b7526a.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-hr-207eeb5f645c585b.js → chunk-locale-hr-685988987e7f2a56.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-id-9ec0d2ef35be6bec.js → chunk-locale-id-419a9aaa59aeff3e.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-it-8fd7e614f7d4dbdd.js → chunk-locale-it-44cce014fd1948b5.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ja-62a9efd82dc73b3f.js → chunk-locale-ja-139385bc775b260c.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ko-b6cc7570c8e9e4e3.js → chunk-locale-ko-60b5d43b7ff7136f.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ms-03b64ce3cc81d631.js → chunk-locale-ms-64e2023c2325a67b.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-nb-NO-1380d003a643f7f4.js → chunk-locale-nb-NO-7d1ce2d96160c897.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-nl-15bbd92d6fe66297.js → chunk-locale-nl-43bf62f631d9fdf7.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-pl-d5834bf9f4f1bcc0.js → chunk-locale-pl-6eaf43f7fb1b9e5e.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-pt-cb3d957e65653d22.js → chunk-locale-pt-496e4dbf1c020d33.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-pt-PT-4c6d1f6735bbe3dd.js → chunk-locale-pt-PT-7c0774f2185287b6.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ru-8305ca6cf6d88a3c.js → chunk-locale-ru-bfb11cdc0344963d.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-sk-a35c1a8d7e9625c8.js → chunk-locale-sk-b38570ba631d555f.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-sl-974142b5a26ad6b8.js → chunk-locale-sl-977848a0c3245b6a.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-sv-bdd28322e123556f.js → chunk-locale-sv-5ea19db187f924f1.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-th-5cd20b08f585470e.js → chunk-locale-th-f52efd06b1ddf07d.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-tr-13db9b06934509d0.js → chunk-locale-tr-256d244cd6254d53.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-uk-e854165eaad75192.js → chunk-locale-uk-02dbcf19d011999f.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-zh-Hans-fc47717b30547c60.js → chunk-locale-zh-Hans-196a530a5a6dddfe.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-zh-Hant-de92d5a4c006e930.js → chunk-locale-zh-Hant-ad4adbed41157747.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-offscreen-renderer-worker-0aa3e9add97599e7.js → chunk-offscreen-renderer-worker-fa9d66555caaca38.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-server-a3935d361c06b4da.js → chunk-server-92d3da6a3bdb0ac0.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-server-instant-313216ff563b4265.js → chunk-server-instant-e7a8487177709ae8.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-server-rest-86cbab38918c3bb2.js → chunk-server-rest-a8811c9a9819e630.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-standalone-78376a398fcb4a1f.js → chunk-standalone-0f2535922637e79c.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-standalone-server-787746ff599eefac.js → chunk-standalone-server-77f2b920eecfe10f.js} +1 -1
- package/dist/nutrient-viewer-lib/core-worker.js +2 -2
- package/dist/nutrient-viewer-lib/dark-402cc98d3d69bff8.css +1 -1
- package/dist/nutrient-viewer-lib/gdpicture-worker.js +1 -1
- package/dist/nutrient-viewer-lib/{nutrient-viewer-1.9.0-4782e4f.css → nutrient-viewer-1.9.0-8860103.css} +1 -1
- package/dist/nutrient-viewer-lib/nutrient-viewer-26f239091dd2d0aa.wasm.js +1 -1
- package/dist/nutrient-viewer-lib/{nutrient-viewer-1cbf3123e7c11c4b.wasm → nutrient-viewer-4c09e75c6e152417.wasm} +0 -0
- package/dist/nutrient-viewer-lib/offscreen-render-worker.js +1 -1
- package/dist/nutrient-viewer.js +2 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -609,7 +609,7 @@ declare type AnnotationAdditionalActionsType = {
|
|
|
609
609
|
};
|
|
610
610
|
|
|
611
611
|
/** @inline */
|
|
612
|
-
declare type AnnotationBackendJSON<K extends BaseAnnotationJSON =
|
|
612
|
+
declare type AnnotationBackendJSON<K extends BaseAnnotationJSON = Serializers.AnnotationJSONUnion, R extends string = never> = { [P in
|
|
613
613
|
keyof K]?: NonNullable<K[P]> } &
|
|
614
614
|
{ [P in
|
|
615
615
|
Intersection<keyof K, BackendRequiredKeys | R>]-?: Exclude<NonNullable<K[P]>, undefined> };
|
|
@@ -619,10 +619,10 @@ declare type AnnotationJSONToAnnotation<T extends {
|
|
|
619
619
|
}> = AnnotationSerializerTypeMap[GetTypeFromAnnotationJSON<T>]['annotation'];
|
|
620
620
|
|
|
621
621
|
/**
|
|
622
|
-
* @deprecated Use {@link
|
|
622
|
+
* @deprecated Use {@link Serializers.AnnotationJSONUnion} instead.
|
|
623
623
|
* @hidden
|
|
624
624
|
*/
|
|
625
|
-
export declare type AnnotationJSONUnion =
|
|
625
|
+
export declare type AnnotationJSONUnion = Serializers.AnnotationJSONUnion;
|
|
626
626
|
|
|
627
627
|
/**
|
|
628
628
|
* @class
|
|
@@ -969,7 +969,7 @@ export declare namespace Annotations {
|
|
|
969
969
|
|
|
970
970
|
}
|
|
971
971
|
|
|
972
|
-
declare type AnnotationsBackendJSONUnion = AnnotationBackendJSON<
|
|
972
|
+
declare type AnnotationsBackendJSONUnion = AnnotationBackendJSON<Serializers.InkAnnotationJSON> | AnnotationBackendJSON<Serializers.LineAnnotationJSON> | AnnotationBackendJSON<Serializers.RectangleAnnotationJSON> | AnnotationBackendJSON<Serializers.EllipseAnnotationJSON> | AnnotationBackendJSON<Serializers.PolygonAnnotationJSON> | AnnotationBackendJSON<Serializers.PolylineAnnotationJSON> | AnnotationBackendJSON<Serializers.LinkAnnotationJSON> | AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON> | AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON> | AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON> | AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON> | AnnotationBackendJSON<Serializers.RedactionAnnotationJSON> | AnnotationBackendJSON<Serializers.TextAnnotationJSON> | AnnotationBackendJSON<Serializers.NoteAnnotationJSON> | AnnotationBackendJSON<Serializers.ImageAnnotationJSON> | AnnotationBackendJSON<Serializers.StampAnnotationJSON, 'color'> | AnnotationBackendJSON<Serializers.WidgetAnnotationJSON> | AnnotationBackendJSON<Serializers.CommentMarkerAnnotationJSON> | AnnotationBackendJSON<Serializers.UnknownAnnotationJSON> | AnnotationBackendJSON<Serializers.MediaAnnotationJSON>;
|
|
973
973
|
|
|
974
974
|
declare function AnnotationSelectionMixin<T extends Class<BaseMixin>>(Base: T): {
|
|
975
975
|
new (...args: any[]): {
|
|
@@ -1084,122 +1084,122 @@ declare type AnnotationSerializerTypeMap = {
|
|
|
1084
1084
|
'pspdfkit/ink': {
|
|
1085
1085
|
serializer: InkAnnotationSerializer;
|
|
1086
1086
|
annotation: InkAnnotation;
|
|
1087
|
-
json:
|
|
1088
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1087
|
+
json: Serializers.InkAnnotationJSON;
|
|
1088
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.InkAnnotationJSON>;
|
|
1089
1089
|
};
|
|
1090
1090
|
'pspdfkit/shape/line': {
|
|
1091
1091
|
serializer: LineAnnotationSerializer;
|
|
1092
1092
|
annotation: LineAnnotation;
|
|
1093
|
-
json:
|
|
1094
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1093
|
+
json: Serializers.LineAnnotationJSON;
|
|
1094
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.LineAnnotationJSON>;
|
|
1095
1095
|
};
|
|
1096
1096
|
'pspdfkit/shape/rectangle': {
|
|
1097
1097
|
serializer: RectangleAnnotationSerializer;
|
|
1098
1098
|
annotation: RectangleAnnotation;
|
|
1099
|
-
json:
|
|
1100
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1099
|
+
json: Serializers.RectangleAnnotationJSON;
|
|
1100
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.RectangleAnnotationJSON>;
|
|
1101
1101
|
};
|
|
1102
1102
|
'pspdfkit/shape/ellipse': {
|
|
1103
1103
|
serializer: EllipseAnnotationSerializer;
|
|
1104
1104
|
annotation: EllipseAnnotation;
|
|
1105
|
-
json:
|
|
1106
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1105
|
+
json: Serializers.EllipseAnnotationJSON;
|
|
1106
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.EllipseAnnotationJSON>;
|
|
1107
1107
|
};
|
|
1108
1108
|
'pspdfkit/shape/polygon': {
|
|
1109
1109
|
serializer: PolygonAnnotationSerializer;
|
|
1110
1110
|
annotation: PolygonAnnotation;
|
|
1111
|
-
json:
|
|
1112
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1111
|
+
json: Serializers.PolygonAnnotationJSON;
|
|
1112
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.PolygonAnnotationJSON>;
|
|
1113
1113
|
};
|
|
1114
1114
|
'pspdfkit/shape/polyline': {
|
|
1115
1115
|
serializer: PolylineAnnotationSerializer;
|
|
1116
1116
|
annotation: PolylineAnnotation;
|
|
1117
|
-
json:
|
|
1118
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1117
|
+
json: Serializers.PolylineAnnotationJSON;
|
|
1118
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.PolylineAnnotationJSON>;
|
|
1119
1119
|
};
|
|
1120
1120
|
'pspdfkit/link': {
|
|
1121
1121
|
serializer: LinkAnnotationSerializer;
|
|
1122
1122
|
annotation: LinkAnnotation;
|
|
1123
|
-
json:
|
|
1124
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1123
|
+
json: Serializers.LinkAnnotationJSON;
|
|
1124
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.LinkAnnotationJSON>;
|
|
1125
1125
|
};
|
|
1126
1126
|
'pspdfkit/markup/highlight': {
|
|
1127
1127
|
serializer: TextMarkupAnnotationSerializer;
|
|
1128
1128
|
annotation: HighlightAnnotation;
|
|
1129
|
-
json:
|
|
1130
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1129
|
+
json: Serializers.TextMarkupAnnotationJSON;
|
|
1130
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON>;
|
|
1131
1131
|
};
|
|
1132
1132
|
'pspdfkit/markup/squiggly': {
|
|
1133
1133
|
serializer: TextMarkupAnnotationSerializer;
|
|
1134
1134
|
annotation: SquiggleAnnotation;
|
|
1135
|
-
json:
|
|
1136
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1135
|
+
json: Serializers.TextMarkupAnnotationJSON;
|
|
1136
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON>;
|
|
1137
1137
|
};
|
|
1138
1138
|
'pspdfkit/markup/strikeout': {
|
|
1139
1139
|
serializer: TextMarkupAnnotationSerializer;
|
|
1140
1140
|
annotation: StrikeOutAnnotation;
|
|
1141
|
-
json:
|
|
1142
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1141
|
+
json: Serializers.TextMarkupAnnotationJSON;
|
|
1142
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON>;
|
|
1143
1143
|
};
|
|
1144
1144
|
'pspdfkit/markup/underline': {
|
|
1145
1145
|
serializer: TextMarkupAnnotationSerializer;
|
|
1146
1146
|
annotation: UnderlineAnnotation;
|
|
1147
|
-
json:
|
|
1148
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1147
|
+
json: Serializers.TextMarkupAnnotationJSON;
|
|
1148
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON>;
|
|
1149
1149
|
};
|
|
1150
1150
|
'pspdfkit/markup/redaction': {
|
|
1151
1151
|
serializer: RedactionAnnotationSerializer;
|
|
1152
1152
|
annotation: RedactionAnnotation;
|
|
1153
|
-
json:
|
|
1154
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1153
|
+
json: Serializers.RedactionAnnotationJSON;
|
|
1154
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.RedactionAnnotationJSON>;
|
|
1155
1155
|
};
|
|
1156
1156
|
'pspdfkit/text': {
|
|
1157
1157
|
serializer: TextAnnotationSerializer;
|
|
1158
1158
|
annotation: TextAnnotation;
|
|
1159
|
-
json:
|
|
1160
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1159
|
+
json: Serializers.TextAnnotationJSON;
|
|
1160
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.TextAnnotationJSON>;
|
|
1161
1161
|
};
|
|
1162
1162
|
'pspdfkit/note': {
|
|
1163
1163
|
serializer: NoteAnnotationSerializer;
|
|
1164
1164
|
annotation: NoteAnnotation;
|
|
1165
|
-
json:
|
|
1166
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1165
|
+
json: Serializers.NoteAnnotationJSON;
|
|
1166
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.NoteAnnotationJSON>;
|
|
1167
1167
|
};
|
|
1168
1168
|
'pspdfkit/image': {
|
|
1169
1169
|
serializer: ImageAnnotationSerializer;
|
|
1170
1170
|
annotation: ImageAnnotation;
|
|
1171
|
-
json:
|
|
1172
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1171
|
+
json: Serializers.ImageAnnotationJSON;
|
|
1172
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.ImageAnnotationJSON>;
|
|
1173
1173
|
};
|
|
1174
1174
|
'pspdfkit/stamp': {
|
|
1175
1175
|
serializer: StampAnnotationSerializer;
|
|
1176
1176
|
annotation: StampAnnotation;
|
|
1177
|
-
json:
|
|
1178
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1177
|
+
json: Serializers.StampAnnotationJSON;
|
|
1178
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.StampAnnotationJSON, 'color'>;
|
|
1179
1179
|
};
|
|
1180
1180
|
'pspdfkit/widget': {
|
|
1181
1181
|
serializer: WidgetAnnotationSerializer;
|
|
1182
1182
|
annotation: WidgetAnnotation;
|
|
1183
|
-
json:
|
|
1184
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1183
|
+
json: Serializers.WidgetAnnotationJSON;
|
|
1184
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.WidgetAnnotationJSON>;
|
|
1185
1185
|
};
|
|
1186
1186
|
'pspdfkit/comment-marker': {
|
|
1187
1187
|
serializer: CommentMarkerAnnotationSerializer;
|
|
1188
1188
|
annotation: CommentMarkerAnnotation;
|
|
1189
|
-
json:
|
|
1190
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1189
|
+
json: Serializers.CommentMarkerAnnotationJSON;
|
|
1190
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.CommentMarkerAnnotationJSON>;
|
|
1191
1191
|
};
|
|
1192
1192
|
'pspdfkit/unknown': {
|
|
1193
1193
|
serializer: UnknownAnnotationSerializer;
|
|
1194
1194
|
annotation: UnknownAnnotation;
|
|
1195
|
-
json:
|
|
1196
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1195
|
+
json: Serializers.UnknownAnnotationJSON;
|
|
1196
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.UnknownAnnotationJSON>;
|
|
1197
1197
|
};
|
|
1198
1198
|
'pspdfkit/media': {
|
|
1199
1199
|
serializer: MediaAnnotationSerializer;
|
|
1200
1200
|
annotation: MediaAnnotation;
|
|
1201
|
-
json:
|
|
1202
|
-
jsonForBackend: AnnotationBackendJSON<
|
|
1201
|
+
json: Serializers.MediaAnnotationJSON;
|
|
1202
|
+
jsonForBackend: AnnotationBackendJSON<Serializers.MediaAnnotationJSON>;
|
|
1203
1203
|
};
|
|
1204
1204
|
};
|
|
1205
1205
|
|
|
@@ -1838,7 +1838,7 @@ declare interface BaseAnnotationJSON extends ICollaboratorPermissionsOptions {
|
|
|
1838
1838
|
bbox: IRectJSON;
|
|
1839
1839
|
opacity?: number;
|
|
1840
1840
|
flags?: ('noPrint' | 'noZoom' | 'noRotate' | 'noView' | 'hidden' | 'locked' | 'lockedContents' | 'readOnly')[] | null;
|
|
1841
|
-
action?:
|
|
1841
|
+
action?: Serializers.ActionJSON | null;
|
|
1842
1842
|
note?: string | null;
|
|
1843
1843
|
createdAt?: string | Date;
|
|
1844
1844
|
updatedAt?: string | Date;
|
|
@@ -2033,7 +2033,7 @@ export declare class Bookmark extends Bookmark_base {
|
|
|
2033
2033
|
/** Bookmark serializer. Converts a bookmark to InstantJSON compliant objects. */
|
|
2034
2034
|
static toSerializableObject: typeof toJSON;
|
|
2035
2035
|
/** Bookmark deserializer. Converts a bookmark object to a {@link NutrientViewer.Bookmark}. */
|
|
2036
|
-
static fromSerializableObject: (bookmark:
|
|
2036
|
+
static fromSerializableObject: (bookmark: Serializers.BookmarkJSON) => Bookmark;
|
|
2037
2037
|
}
|
|
2038
2038
|
|
|
2039
2039
|
declare const Bookmark_base: Immutable.Record.Factory<BookmarkProps>;
|
|
@@ -4392,14 +4392,14 @@ declare class Comment_2 extends Comment_base {
|
|
|
4392
4392
|
* @param comment - The comment to serialize.
|
|
4393
4393
|
* @returns The serialized comment.
|
|
4394
4394
|
*/
|
|
4395
|
-
static toSerializableObject: (comment: Comment_2) =>
|
|
4395
|
+
static toSerializableObject: (comment: Comment_2) => Serializers.CommentJSON;
|
|
4396
4396
|
/**
|
|
4397
4397
|
* Comment deserializer. Converts a comment object to a {@link NutrientViewer.Comment}.
|
|
4398
4398
|
*
|
|
4399
4399
|
* @param comment - The comment to deserialize.
|
|
4400
4400
|
* @returns The deserialized comment.
|
|
4401
4401
|
*/
|
|
4402
|
-
static fromSerializableObject: (comment:
|
|
4402
|
+
static fromSerializableObject: (comment: Serializers.CommentJSON) => Comment_2;
|
|
4403
4403
|
/**
|
|
4404
4404
|
* A method that returns a set of user IDs that are mentioned in the comment.
|
|
4405
4405
|
*
|
|
@@ -4448,8 +4448,8 @@ export declare class CommentMarkerAnnotation extends Annotation {
|
|
|
4448
4448
|
declare class CommentMarkerAnnotationSerializer extends AnnotationSerializer {
|
|
4449
4449
|
annotation: CommentMarkerAnnotation;
|
|
4450
4450
|
constructor(annotation: CommentMarkerAnnotation);
|
|
4451
|
-
toJSON():
|
|
4452
|
-
static fromJSON(id: InstantID | null, json: Omit<
|
|
4451
|
+
toJSON(): Serializers.CommentMarkerAnnotationJSON;
|
|
4452
|
+
static fromJSON(id: InstantID | null, json: Omit<Serializers.CommentMarkerAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): CommentMarkerAnnotation;
|
|
4453
4453
|
}
|
|
4454
4454
|
|
|
4455
4455
|
declare type CommentParams = {
|
|
@@ -5532,7 +5532,7 @@ declare type DelimiterSettings = {
|
|
|
5532
5532
|
* @param options - The options for the form field.
|
|
5533
5533
|
* @returns The deserialized form field.
|
|
5534
5534
|
*/
|
|
5535
|
-
declare function deserializeFormField(id: ID, payload:
|
|
5535
|
+
declare function deserializeFormField(id: ID, payload: Serializers.FormFieldJSON, options?: ICollaboratorPermissionsOptions): FormField;
|
|
5536
5536
|
|
|
5537
5537
|
export declare namespace DigitalSignatures {
|
|
5538
5538
|
/**
|
|
@@ -7358,15 +7358,15 @@ export declare class EllipseAnnotation extends ShapeAnnotation<IEllipseAnnotatio
|
|
|
7358
7358
|
}
|
|
7359
7359
|
|
|
7360
7360
|
/**
|
|
7361
|
-
* @deprecated Use {@link
|
|
7361
|
+
* @deprecated Use {@link Serializers.EllipseAnnotationJSON} instead.
|
|
7362
7362
|
* @hidden
|
|
7363
7363
|
*/
|
|
7364
|
-
export declare type EllipseAnnotationJSON =
|
|
7364
|
+
export declare type EllipseAnnotationJSON = Serializers.EllipseAnnotationJSON;
|
|
7365
7365
|
|
|
7366
7366
|
declare class EllipseAnnotationSerializer extends ShapeAnnotationSerializer {
|
|
7367
7367
|
annotation: EllipseAnnotation;
|
|
7368
|
-
toJSON():
|
|
7369
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
7368
|
+
toJSON(): Serializers.EllipseAnnotationJSON;
|
|
7369
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.EllipseAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): EllipseAnnotation;
|
|
7370
7370
|
}
|
|
7371
7371
|
|
|
7372
7372
|
/**
|
|
@@ -10507,7 +10507,7 @@ path?: Array<string | number>)
|
|
|
10507
10507
|
*
|
|
10508
10508
|
* @param annotation - Serialized Annotation
|
|
10509
10509
|
*/
|
|
10510
|
-
declare function fromSerializableObject<K extends
|
|
10510
|
+
declare function fromSerializableObject<K extends Serializers.AnnotationJSONUnion | AnnotationsBackendJSONUnion>(annotation: K): AnnotationJSONToAnnotation<K>;
|
|
10511
10511
|
|
|
10512
10512
|
/**
|
|
10513
10513
|
*
|
|
@@ -11321,16 +11321,16 @@ export declare class ImageAnnotation extends Annotation<IImageAnnotation> {
|
|
|
11321
11321
|
}
|
|
11322
11322
|
|
|
11323
11323
|
/**
|
|
11324
|
-
* @deprecated Use {@link
|
|
11324
|
+
* @deprecated Use {@link Serializers.ImageAnnotationJSON} instead.
|
|
11325
11325
|
* @hidden
|
|
11326
11326
|
*/
|
|
11327
|
-
export declare type ImageAnnotationJSON =
|
|
11327
|
+
export declare type ImageAnnotationJSON = Serializers.ImageAnnotationJSON;
|
|
11328
11328
|
|
|
11329
11329
|
declare class ImageAnnotationSerializer extends AnnotationSerializer {
|
|
11330
11330
|
annotation: ImageAnnotation;
|
|
11331
11331
|
constructor(annotation: ImageAnnotation);
|
|
11332
|
-
toJSON():
|
|
11333
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
11332
|
+
toJSON(): Serializers.ImageAnnotationJSON;
|
|
11333
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.ImageAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): ImageAnnotation;
|
|
11334
11334
|
}
|
|
11335
11335
|
|
|
11336
11336
|
declare interface IMauiBridge {
|
|
@@ -11561,16 +11561,16 @@ export declare class InkAnnotation extends Annotation<IInkAnnotation> {
|
|
|
11561
11561
|
}
|
|
11562
11562
|
|
|
11563
11563
|
/**
|
|
11564
|
-
* @deprecated Use {@link
|
|
11564
|
+
* @deprecated Use {@link Serializers.InkAnnotationJSON} instead.
|
|
11565
11565
|
* @hidden
|
|
11566
11566
|
*/
|
|
11567
|
-
export declare type InkAnnotationJSON =
|
|
11567
|
+
export declare type InkAnnotationJSON = Serializers.InkAnnotationJSON;
|
|
11568
11568
|
|
|
11569
11569
|
declare class InkAnnotationSerializer extends AnnotationSerializer {
|
|
11570
11570
|
annotation: InkAnnotation;
|
|
11571
11571
|
constructor(annotation: InkAnnotation);
|
|
11572
|
-
toJSON():
|
|
11573
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
11572
|
+
toJSON(): Serializers.InkAnnotationJSON;
|
|
11573
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.InkAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): InkAnnotation;
|
|
11574
11574
|
_linesToJSON(): {
|
|
11575
11575
|
points: [number, number][][];
|
|
11576
11576
|
intensities: number[][];
|
|
@@ -13086,15 +13086,15 @@ export declare class LineAnnotation extends ShapeAnnotation<ILineAnnotation> {
|
|
|
13086
13086
|
}
|
|
13087
13087
|
|
|
13088
13088
|
/**
|
|
13089
|
-
* @deprecated Use {@link
|
|
13089
|
+
* @deprecated Use {@link Serializers.LineAnnotationJSON} instead.
|
|
13090
13090
|
* @hidden
|
|
13091
13091
|
*/
|
|
13092
|
-
export declare type LineAnnotationJSON =
|
|
13092
|
+
export declare type LineAnnotationJSON = Serializers.LineAnnotationJSON;
|
|
13093
13093
|
|
|
13094
13094
|
declare class LineAnnotationSerializer extends ShapeAnnotationSerializer {
|
|
13095
13095
|
annotation: LineAnnotation;
|
|
13096
|
-
toJSON():
|
|
13097
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
13096
|
+
toJSON(): Serializers.LineAnnotationJSON;
|
|
13097
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.LineAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): LineAnnotation;
|
|
13098
13098
|
}
|
|
13099
13099
|
|
|
13100
13100
|
/**
|
|
@@ -13203,8 +13203,8 @@ export declare class LinkAnnotation extends Annotation<ILinkAnnotation> {
|
|
|
13203
13203
|
declare class LinkAnnotationSerializer extends AnnotationSerializer {
|
|
13204
13204
|
annotation: LinkAnnotation;
|
|
13205
13205
|
constructor(annotation: LinkAnnotation);
|
|
13206
|
-
toJSON():
|
|
13207
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
13206
|
+
toJSON(): Serializers.LinkAnnotationJSON;
|
|
13207
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.LinkAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): LinkAnnotation;
|
|
13208
13208
|
}
|
|
13209
13209
|
|
|
13210
13210
|
/**
|
|
@@ -14844,8 +14844,8 @@ export declare class MediaAnnotation extends Annotation<IMediaAnnotation> {
|
|
|
14844
14844
|
declare class MediaAnnotationSerializer extends AnnotationSerializer {
|
|
14845
14845
|
annotation: MediaAnnotation;
|
|
14846
14846
|
constructor(annotation: MediaAnnotation);
|
|
14847
|
-
toJSON():
|
|
14848
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
14847
|
+
toJSON(): Serializers.MediaAnnotationJSON;
|
|
14848
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.MediaAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): MediaAnnotation;
|
|
14849
14849
|
}
|
|
14850
14850
|
|
|
14851
14851
|
export declare type MentionableUser = {
|
|
@@ -15879,16 +15879,16 @@ export declare class NoteAnnotation<T extends INoteAnnotation = INoteAnnotation>
|
|
|
15879
15879
|
}
|
|
15880
15880
|
|
|
15881
15881
|
/**
|
|
15882
|
-
* @deprecated Use {@link
|
|
15882
|
+
* @deprecated Use {@link Serializers.NoteAnnotationJSON} instead.
|
|
15883
15883
|
* @hidden
|
|
15884
15884
|
*/
|
|
15885
|
-
export declare type NoteAnnotationJSON =
|
|
15885
|
+
export declare type NoteAnnotationJSON = Serializers.NoteAnnotationJSON;
|
|
15886
15886
|
|
|
15887
15887
|
declare class NoteAnnotationSerializer extends AnnotationSerializer {
|
|
15888
15888
|
annotation: NoteAnnotation;
|
|
15889
15889
|
constructor(annotation: NoteAnnotation);
|
|
15890
|
-
toJSON():
|
|
15891
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
15890
|
+
toJSON(): Serializers.NoteAnnotationJSON;
|
|
15891
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.NoteAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): NoteAnnotation;
|
|
15892
15892
|
}
|
|
15893
15893
|
|
|
15894
15894
|
/**
|
|
@@ -17114,15 +17114,15 @@ export declare class PolygonAnnotation extends ShapeAnnotation<IPolygonAnnotatio
|
|
|
17114
17114
|
}
|
|
17115
17115
|
|
|
17116
17116
|
/**
|
|
17117
|
-
* @deprecated Use {@link
|
|
17117
|
+
* @deprecated Use {@link Serializers.PolygonAnnotationJSON} instead.
|
|
17118
17118
|
* @hidden
|
|
17119
17119
|
*/
|
|
17120
|
-
export declare type PolygonAnnotationJSON =
|
|
17120
|
+
export declare type PolygonAnnotationJSON = Serializers.PolygonAnnotationJSON;
|
|
17121
17121
|
|
|
17122
17122
|
declare class PolygonAnnotationSerializer extends ShapeAnnotationSerializer {
|
|
17123
17123
|
annotation: PolygonAnnotation;
|
|
17124
|
-
toJSON():
|
|
17125
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
17124
|
+
toJSON(): Serializers.PolygonAnnotationJSON;
|
|
17125
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.PolygonAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: IObject): PolygonAnnotation;
|
|
17126
17126
|
}
|
|
17127
17127
|
|
|
17128
17128
|
/**
|
|
@@ -17184,15 +17184,15 @@ export declare class PolylineAnnotation extends ShapeAnnotation<IPolyLineAnnotat
|
|
|
17184
17184
|
}
|
|
17185
17185
|
|
|
17186
17186
|
/**
|
|
17187
|
-
* @deprecated Use {@link
|
|
17187
|
+
* @deprecated Use {@link Serializers.PolylineAnnotationJSON} instead.
|
|
17188
17188
|
* @hidden
|
|
17189
17189
|
*/
|
|
17190
|
-
export declare type PolylineAnnotationJSON =
|
|
17190
|
+
export declare type PolylineAnnotationJSON = Serializers.PolylineAnnotationJSON;
|
|
17191
17191
|
|
|
17192
17192
|
declare class PolylineAnnotationSerializer extends ShapeAnnotationSerializer {
|
|
17193
17193
|
annotation: PolylineAnnotation;
|
|
17194
|
-
toJSON():
|
|
17195
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
17194
|
+
toJSON(): Serializers.PolylineAnnotationJSON;
|
|
17195
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.PolylineAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): PolylineAnnotation;
|
|
17196
17196
|
}
|
|
17197
17197
|
|
|
17198
17198
|
/**
|
|
@@ -18380,15 +18380,15 @@ export declare class RectangleAnnotation extends ShapeAnnotation<IRectangleAnnot
|
|
|
18380
18380
|
}
|
|
18381
18381
|
|
|
18382
18382
|
/**
|
|
18383
|
-
* @deprecated Use {@link
|
|
18383
|
+
* @deprecated Use {@link Serializers.RectangleAnnotationJSON} instead.
|
|
18384
18384
|
* @hidden
|
|
18385
18385
|
*/
|
|
18386
|
-
export declare type RectangleAnnotationJSON =
|
|
18386
|
+
export declare type RectangleAnnotationJSON = Serializers.RectangleAnnotationJSON;
|
|
18387
18387
|
|
|
18388
18388
|
declare class RectangleAnnotationSerializer extends ShapeAnnotationSerializer {
|
|
18389
18389
|
annotation: RectangleAnnotation;
|
|
18390
|
-
toJSON():
|
|
18391
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
18390
|
+
toJSON(): Serializers.RectangleAnnotationJSON;
|
|
18391
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.RectangleAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): RectangleAnnotation;
|
|
18392
18392
|
}
|
|
18393
18393
|
|
|
18394
18394
|
/**
|
|
@@ -18449,10 +18449,10 @@ export declare class RedactionAnnotation extends TextMarkupAnnotation<IRedaction
|
|
|
18449
18449
|
}
|
|
18450
18450
|
|
|
18451
18451
|
/**
|
|
18452
|
-
* @deprecated Use {@link
|
|
18452
|
+
* @deprecated Use {@link Serializers.RedactionAnnotationJSON} instead.
|
|
18453
18453
|
* @hidden
|
|
18454
18454
|
*/
|
|
18455
|
-
export declare type RedactionAnnotationJSON =
|
|
18455
|
+
export declare type RedactionAnnotationJSON = Serializers.RedactionAnnotationJSON;
|
|
18456
18456
|
|
|
18457
18457
|
/**
|
|
18458
18458
|
*
|
|
@@ -18524,8 +18524,8 @@ export declare type RedactionAnnotationPreset = {
|
|
|
18524
18524
|
declare class RedactionAnnotationSerializer extends BaseTextMarkupSerializer {
|
|
18525
18525
|
annotation: RedactionAnnotation;
|
|
18526
18526
|
constructor(annotation: RedactionAnnotation);
|
|
18527
|
-
toJSON():
|
|
18528
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
18527
|
+
toJSON(): Serializers.RedactionAnnotationJSON;
|
|
18528
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.RedactionAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): RedactionAnnotation;
|
|
18529
18529
|
}
|
|
18530
18530
|
|
|
18531
18531
|
declare function RedactionsMixin<T extends Class<BaseMixin>>(Base: T): {
|
|
@@ -20130,6 +20130,79 @@ declare interface Seq<K, V> extends Collection<K, V> {
|
|
|
20130
20130
|
: this;
|
|
20131
20131
|
}
|
|
20132
20132
|
|
|
20133
|
+
declare function serializeAnnotation(annotation: InkAnnotation): AnnotationBackendJSON<Serializers.InkAnnotationJSON>;
|
|
20134
|
+
|
|
20135
|
+
declare function serializeAnnotation(annotation: LineAnnotation): AnnotationBackendJSON<Serializers.LineAnnotationJSON>;
|
|
20136
|
+
|
|
20137
|
+
declare function serializeAnnotation(annotation: RectangleAnnotation): AnnotationBackendJSON<Serializers.RectangleAnnotationJSON>;
|
|
20138
|
+
|
|
20139
|
+
declare function serializeAnnotation(annotation: EllipseAnnotation): AnnotationBackendJSON<Serializers.EllipseAnnotationJSON>;
|
|
20140
|
+
|
|
20141
|
+
declare function serializeAnnotation(annotation: PolygonAnnotation): AnnotationBackendJSON<Serializers.PolygonAnnotationJSON>;
|
|
20142
|
+
|
|
20143
|
+
declare function serializeAnnotation(annotation: PolylineAnnotation): AnnotationBackendJSON<Serializers.PolylineAnnotationJSON>;
|
|
20144
|
+
|
|
20145
|
+
declare function serializeAnnotation(annotation: TextAnnotation): AnnotationBackendJSON<Serializers.TextAnnotationJSON>;
|
|
20146
|
+
|
|
20147
|
+
declare function serializeAnnotation(annotation: NoteAnnotation): AnnotationBackendJSON<Serializers.NoteAnnotationJSON>;
|
|
20148
|
+
|
|
20149
|
+
declare function serializeAnnotation(annotation: StampAnnotation): AnnotationBackendJSON<Serializers.StampAnnotationJSON, 'color'>;
|
|
20150
|
+
|
|
20151
|
+
declare function serializeAnnotation(annotation: ImageAnnotation): AnnotationBackendJSON<Serializers.ImageAnnotationJSON>;
|
|
20152
|
+
|
|
20153
|
+
declare function serializeAnnotation(annotation: MediaAnnotation): AnnotationBackendJSON<Serializers.MediaAnnotationJSON>;
|
|
20154
|
+
|
|
20155
|
+
declare function serializeAnnotation(annotation: LinkAnnotation): AnnotationBackendJSON<Serializers.LinkAnnotationJSON>;
|
|
20156
|
+
|
|
20157
|
+
declare function serializeAnnotation(annotation: WidgetAnnotation): AnnotationBackendJSON<Serializers.WidgetAnnotationJSON>;
|
|
20158
|
+
|
|
20159
|
+
declare function serializeAnnotation(annotation: TextMarkupAnnotation): AnnotationBackendJSON<Serializers.TextMarkupAnnotationJSON>;
|
|
20160
|
+
|
|
20161
|
+
declare function serializeAnnotation(annotation: RedactionAnnotation): AnnotationBackendJSON<Serializers.RedactionAnnotationJSON>;
|
|
20162
|
+
|
|
20163
|
+
declare function serializeAnnotation(annotation: CommentMarkerAnnotation): AnnotationBackendJSON<Serializers.CommentMarkerAnnotationJSON>;
|
|
20164
|
+
|
|
20165
|
+
declare function serializeAnnotation(annotation: UnknownAnnotation): AnnotationBackendJSON<Serializers.UnknownAnnotationJSON>;
|
|
20166
|
+
|
|
20167
|
+
declare function serializeAnnotation(annotation: AnnotationsUnion): AnnotationsBackendJSONUnion;
|
|
20168
|
+
|
|
20169
|
+
/** @inline */
|
|
20170
|
+
declare type SerializedAdditionalActionsType = { [key in
|
|
20171
|
+
ActionTriggerEventType | FormFieldEventTriggerType | FormFieldInputEventTriggerType | WidgetActionTriggerEventType as string]?: {
|
|
20172
|
+
type: string;
|
|
20173
|
+
[key: string]: unknown;
|
|
20174
|
+
} };
|
|
20175
|
+
|
|
20176
|
+
declare type SerializedJSON = {
|
|
20177
|
+
skippedPdfObjectIds?: number[];
|
|
20178
|
+
annotations?: Serializers.AnnotationJSONUnion[];
|
|
20179
|
+
formFields?: Serializers.FormFieldJSON[];
|
|
20180
|
+
skippedPdfFormFieldIds?: number[];
|
|
20181
|
+
formFieldValues?: Record<string, any>[];
|
|
20182
|
+
comments?: Record<string, any>[];
|
|
20183
|
+
skippedComments?: number[];
|
|
20184
|
+
attachments?: Record<string, {
|
|
20185
|
+
binary: string;
|
|
20186
|
+
contentType: string;
|
|
20187
|
+
}>;
|
|
20188
|
+
skippedPdfBookmarkIds?: string[];
|
|
20189
|
+
bookmarks?: Serializers.BookmarkJSON[];
|
|
20190
|
+
};
|
|
20191
|
+
|
|
20192
|
+
/**
|
|
20193
|
+
* Form field serializer. Converts one of the supported {@link NutrientViewer.FormFields} to InstantJSON compliant objects.
|
|
20194
|
+
*
|
|
20195
|
+
* @returns The serialized form field.
|
|
20196
|
+
*/
|
|
20197
|
+
declare function serializeFormField(formField: FormField): Serializers.FormFieldJSON;
|
|
20198
|
+
|
|
20199
|
+
/**
|
|
20200
|
+
* Annotation preset serializer. Converts a {@link AnnotationPreset} to an object.
|
|
20201
|
+
*
|
|
20202
|
+
* @param preset - Annotation preset to serialize.
|
|
20203
|
+
*/
|
|
20204
|
+
declare function serializePreset(preset: AnnotationPreset): Record<string, any>;
|
|
20205
|
+
|
|
20133
20206
|
/**
|
|
20134
20207
|
* This namespace contains types and interfaces for serializing and deserializing
|
|
20135
20208
|
* PDF annotations, form fields, comments, bookmarks, and related data
|
|
@@ -20188,7 +20261,7 @@ declare interface Seq<K, V> extends Collection<K, V> {
|
|
|
20188
20261
|
* @see {@link NutrientViewer.Bookmark.toSerializableObject} | {@link NutrientViewer.Bookmark.fromSerializableObject}
|
|
20189
20262
|
* @see {@link NutrientViewer.Comment.toSerializableObject} | {@link NutrientViewer.Comment.fromSerializableObject}
|
|
20190
20263
|
*/
|
|
20191
|
-
export declare namespace
|
|
20264
|
+
export declare namespace Serializers {
|
|
20192
20265
|
/**
|
|
20193
20266
|
* @group FormField
|
|
20194
20267
|
*/
|
|
@@ -20555,79 +20628,6 @@ export declare namespace Serialisers {
|
|
|
20555
20628
|
export type ActionJSON = CoreActionJSON;
|
|
20556
20629
|
}
|
|
20557
20630
|
|
|
20558
|
-
declare function serializeAnnotation(annotation: InkAnnotation): AnnotationBackendJSON<Serialisers.InkAnnotationJSON>;
|
|
20559
|
-
|
|
20560
|
-
declare function serializeAnnotation(annotation: LineAnnotation): AnnotationBackendJSON<Serialisers.LineAnnotationJSON>;
|
|
20561
|
-
|
|
20562
|
-
declare function serializeAnnotation(annotation: RectangleAnnotation): AnnotationBackendJSON<Serialisers.RectangleAnnotationJSON>;
|
|
20563
|
-
|
|
20564
|
-
declare function serializeAnnotation(annotation: EllipseAnnotation): AnnotationBackendJSON<Serialisers.EllipseAnnotationJSON>;
|
|
20565
|
-
|
|
20566
|
-
declare function serializeAnnotation(annotation: PolygonAnnotation): AnnotationBackendJSON<Serialisers.PolygonAnnotationJSON>;
|
|
20567
|
-
|
|
20568
|
-
declare function serializeAnnotation(annotation: PolylineAnnotation): AnnotationBackendJSON<Serialisers.PolylineAnnotationJSON>;
|
|
20569
|
-
|
|
20570
|
-
declare function serializeAnnotation(annotation: TextAnnotation): AnnotationBackendJSON<Serialisers.TextAnnotationJSON>;
|
|
20571
|
-
|
|
20572
|
-
declare function serializeAnnotation(annotation: NoteAnnotation): AnnotationBackendJSON<Serialisers.NoteAnnotationJSON>;
|
|
20573
|
-
|
|
20574
|
-
declare function serializeAnnotation(annotation: StampAnnotation): AnnotationBackendJSON<Serialisers.StampAnnotationJSON, 'color'>;
|
|
20575
|
-
|
|
20576
|
-
declare function serializeAnnotation(annotation: ImageAnnotation): AnnotationBackendJSON<Serialisers.ImageAnnotationJSON>;
|
|
20577
|
-
|
|
20578
|
-
declare function serializeAnnotation(annotation: MediaAnnotation): AnnotationBackendJSON<Serialisers.MediaAnnotationJSON>;
|
|
20579
|
-
|
|
20580
|
-
declare function serializeAnnotation(annotation: LinkAnnotation): AnnotationBackendJSON<Serialisers.LinkAnnotationJSON>;
|
|
20581
|
-
|
|
20582
|
-
declare function serializeAnnotation(annotation: WidgetAnnotation): AnnotationBackendJSON<Serialisers.WidgetAnnotationJSON>;
|
|
20583
|
-
|
|
20584
|
-
declare function serializeAnnotation(annotation: TextMarkupAnnotation): AnnotationBackendJSON<Serialisers.TextMarkupAnnotationJSON>;
|
|
20585
|
-
|
|
20586
|
-
declare function serializeAnnotation(annotation: RedactionAnnotation): AnnotationBackendJSON<Serialisers.RedactionAnnotationJSON>;
|
|
20587
|
-
|
|
20588
|
-
declare function serializeAnnotation(annotation: CommentMarkerAnnotation): AnnotationBackendJSON<Serialisers.CommentMarkerAnnotationJSON>;
|
|
20589
|
-
|
|
20590
|
-
declare function serializeAnnotation(annotation: UnknownAnnotation): AnnotationBackendJSON<Serialisers.UnknownAnnotationJSON>;
|
|
20591
|
-
|
|
20592
|
-
declare function serializeAnnotation(annotation: AnnotationsUnion): AnnotationsBackendJSONUnion;
|
|
20593
|
-
|
|
20594
|
-
/** @inline */
|
|
20595
|
-
declare type SerializedAdditionalActionsType = { [key in
|
|
20596
|
-
ActionTriggerEventType | FormFieldEventTriggerType | FormFieldInputEventTriggerType | WidgetActionTriggerEventType as string]?: {
|
|
20597
|
-
type: string;
|
|
20598
|
-
[key: string]: unknown;
|
|
20599
|
-
} };
|
|
20600
|
-
|
|
20601
|
-
declare type SerializedJSON = {
|
|
20602
|
-
skippedPdfObjectIds?: number[];
|
|
20603
|
-
annotations?: Serialisers.AnnotationJSONUnion[];
|
|
20604
|
-
formFields?: Serialisers.FormFieldJSON[];
|
|
20605
|
-
skippedPdfFormFieldIds?: number[];
|
|
20606
|
-
formFieldValues?: Record<string, any>[];
|
|
20607
|
-
comments?: Record<string, any>[];
|
|
20608
|
-
skippedComments?: number[];
|
|
20609
|
-
attachments?: Record<string, {
|
|
20610
|
-
binary: string;
|
|
20611
|
-
contentType: string;
|
|
20612
|
-
}>;
|
|
20613
|
-
skippedPdfBookmarkIds?: string[];
|
|
20614
|
-
bookmarks?: Serialisers.BookmarkJSON[];
|
|
20615
|
-
};
|
|
20616
|
-
|
|
20617
|
-
/**
|
|
20618
|
-
* Form field serializer. Converts one of the supported {@link NutrientViewer.FormFields} to InstantJSON compliant objects.
|
|
20619
|
-
*
|
|
20620
|
-
* @returns The serialized form field.
|
|
20621
|
-
*/
|
|
20622
|
-
declare function serializeFormField(formField: FormField): Serialisers.FormFieldJSON;
|
|
20623
|
-
|
|
20624
|
-
/**
|
|
20625
|
-
* Annotation preset serializer. Converts a {@link AnnotationPreset} to an object.
|
|
20626
|
-
*
|
|
20627
|
-
* @param preset - Annotation preset to serialize.
|
|
20628
|
-
*/
|
|
20629
|
-
declare function serializePreset(preset: AnnotationPreset): Record<string, any>;
|
|
20630
|
-
|
|
20631
20631
|
declare interface ServerConfiguration extends SharedConfiguration {
|
|
20632
20632
|
/**
|
|
20633
20633
|
* ***required, Server only***
|
|
@@ -21214,8 +21214,8 @@ export declare abstract class ShapeAnnotation<T extends IShapeAnnotation = IShap
|
|
|
21214
21214
|
|
|
21215
21215
|
declare abstract class ShapeAnnotationSerializer extends AnnotationSerializer {
|
|
21216
21216
|
annotation: ShapeAnnotationsUnion;
|
|
21217
|
-
toJSON():
|
|
21218
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
21217
|
+
toJSON(): Serializers.ShapeAnnotationJSON;
|
|
21218
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.ShapeAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): {
|
|
21219
21219
|
strokeWidth: number | null;
|
|
21220
21220
|
strokeColor: Color | null;
|
|
21221
21221
|
fillColor: Color | null;
|
|
@@ -23598,16 +23598,16 @@ export declare class StampAnnotation extends Annotation<IStampAnnotation> {
|
|
|
23598
23598
|
}
|
|
23599
23599
|
|
|
23600
23600
|
/**
|
|
23601
|
-
* @deprecated Use {@link
|
|
23601
|
+
* @deprecated Use {@link Serializers.StampAnnotationJSON} instead.
|
|
23602
23602
|
* @hidden
|
|
23603
23603
|
*/
|
|
23604
|
-
export declare type StampAnnotationJSON =
|
|
23604
|
+
export declare type StampAnnotationJSON = Serializers.StampAnnotationJSON;
|
|
23605
23605
|
|
|
23606
23606
|
declare class StampAnnotationSerializer extends AnnotationSerializer {
|
|
23607
23607
|
annotation: StampAnnotation;
|
|
23608
23608
|
constructor(annotation: StampAnnotation);
|
|
23609
|
-
toJSON():
|
|
23610
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
23609
|
+
toJSON(): Serializers.StampAnnotationJSON;
|
|
23610
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.StampAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): StampAnnotation;
|
|
23611
23611
|
}
|
|
23612
23612
|
|
|
23613
23613
|
declare function StampAnnotationTemplatesMixin<T extends Class<BaseMixin>>(Base: T): {
|
|
@@ -24510,16 +24510,16 @@ export declare class TextAnnotation extends Annotation<ITextAnnotation> {
|
|
|
24510
24510
|
}
|
|
24511
24511
|
|
|
24512
24512
|
/**
|
|
24513
|
-
* @deprecated Use {@link
|
|
24513
|
+
* @deprecated Use {@link Serializers.TextAnnotationJSON} instead.
|
|
24514
24514
|
* @hidden
|
|
24515
24515
|
*/
|
|
24516
|
-
export declare type TextAnnotationJSON =
|
|
24516
|
+
export declare type TextAnnotationJSON = Serializers.TextAnnotationJSON;
|
|
24517
24517
|
|
|
24518
24518
|
declare class TextAnnotationSerializer extends AnnotationSerializer {
|
|
24519
24519
|
annotation: TextAnnotation;
|
|
24520
24520
|
constructor(annotation: TextAnnotation);
|
|
24521
|
-
toJSON():
|
|
24522
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
24521
|
+
toJSON(): Serializers.TextAnnotationJSON;
|
|
24522
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.TextAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): TextAnnotation;
|
|
24523
24523
|
_calloutToJSON(): {
|
|
24524
24524
|
start: [number, number];
|
|
24525
24525
|
knee: [number, number] | null;
|
|
@@ -24527,7 +24527,7 @@ declare class TextAnnotationSerializer extends AnnotationSerializer {
|
|
|
24527
24527
|
cap: ILineCap | null;
|
|
24528
24528
|
innerRectInset: InsetJSON | null;
|
|
24529
24529
|
} | null;
|
|
24530
|
-
static _JSONToCallout(calloutJSON:
|
|
24530
|
+
static _JSONToCallout(calloutJSON: Serializers.TextAnnotationJSON['callout']): Callout | null | undefined;
|
|
24531
24531
|
}
|
|
24532
24532
|
|
|
24533
24533
|
declare type TextComparisonAction = ReturnType<ActionCreators[keyof ActionCreators]>;
|
|
@@ -25092,16 +25092,16 @@ export declare class TextMarkupAnnotation<T extends ITextMarkupAnnotation = ITex
|
|
|
25092
25092
|
}
|
|
25093
25093
|
|
|
25094
25094
|
/**
|
|
25095
|
-
* @deprecated Use {@link
|
|
25095
|
+
* @deprecated Use {@link Serializers.TextMarkupAnnotationJSON} instead.
|
|
25096
25096
|
* @hidden
|
|
25097
25097
|
*/
|
|
25098
|
-
export declare type TextMarkupAnnotationJSON =
|
|
25098
|
+
export declare type TextMarkupAnnotationJSON = Serializers.TextMarkupAnnotationJSON;
|
|
25099
25099
|
|
|
25100
25100
|
declare class TextMarkupAnnotationSerializer extends BaseTextMarkupSerializer {
|
|
25101
25101
|
annotation: TextMarkupAnnotationsUnion;
|
|
25102
25102
|
constructor(annotation: TextMarkupAnnotationsUnion);
|
|
25103
|
-
toJSON():
|
|
25104
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
25103
|
+
toJSON(): Serializers.TextMarkupAnnotationJSON;
|
|
25104
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.TextMarkupAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): TextMarkupAnnotationsUnion;
|
|
25105
25105
|
typeForAnnotation(): "pspdfkit/markup/highlight" | "pspdfkit/markup/squiggly" | "pspdfkit/markup/strikeout" | "pspdfkit/markup/underline" | "pspdfkit/markup/redaction";
|
|
25106
25106
|
}
|
|
25107
25107
|
|
|
@@ -25646,7 +25646,7 @@ declare type TimestampType = {
|
|
|
25646
25646
|
password?: string;
|
|
25647
25647
|
};
|
|
25648
25648
|
|
|
25649
|
-
declare function toJSON(bookmark: Bookmark):
|
|
25649
|
+
declare function toJSON(bookmark: Bookmark): Serializers.BookmarkJSON;
|
|
25650
25650
|
|
|
25651
25651
|
/**
|
|
25652
25652
|
* Describes the properties of a Toolbar Item.
|
|
@@ -26249,10 +26249,10 @@ export declare class UnknownAnnotation extends Annotation {}
|
|
|
26249
26249
|
|
|
26250
26250
|
|
|
26251
26251
|
/**
|
|
26252
|
-
* @deprecated Use {@link
|
|
26252
|
+
* @deprecated Use {@link Serializers.UnknownAnnotationJSON} instead.
|
|
26253
26253
|
* @hidden
|
|
26254
26254
|
*/
|
|
26255
|
-
export declare type UnknownAnnotationJSON =
|
|
26255
|
+
export declare type UnknownAnnotationJSON = Serializers.UnknownAnnotationJSON;
|
|
26256
26256
|
|
|
26257
26257
|
/**
|
|
26258
26258
|
* Unknown annotations are used when we discover an annotation type during deserializing that we
|
|
@@ -26261,8 +26261,8 @@ export declare type UnknownAnnotationJSON = Serialisers.UnknownAnnotationJSON;
|
|
|
26261
26261
|
declare class UnknownAnnotationSerializer extends AnnotationSerializer {
|
|
26262
26262
|
annotation: UnknownAnnotation;
|
|
26263
26263
|
constructor(annotation: UnknownAnnotation);
|
|
26264
|
-
toJSON():
|
|
26265
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
26264
|
+
toJSON(): Serializers.UnknownAnnotationJSON;
|
|
26265
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.UnknownAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): UnknownAnnotation;
|
|
26266
26266
|
}
|
|
26267
26267
|
|
|
26268
26268
|
/**
|
|
@@ -26957,16 +26957,16 @@ declare type WidgetAnnotationAdditionalActionsType = {
|
|
|
26957
26957
|
};
|
|
26958
26958
|
|
|
26959
26959
|
/**
|
|
26960
|
-
* @deprecated Use {@link
|
|
26960
|
+
* @deprecated Use {@link Serializers.WidgetAnnotationJSON} instead.
|
|
26961
26961
|
* @hidden
|
|
26962
26962
|
*/
|
|
26963
|
-
export declare type WidgetAnnotationJSON =
|
|
26963
|
+
export declare type WidgetAnnotationJSON = Serializers.WidgetAnnotationJSON;
|
|
26964
26964
|
|
|
26965
26965
|
declare class WidgetAnnotationSerializer extends AnnotationSerializer {
|
|
26966
26966
|
annotation: WidgetAnnotation;
|
|
26967
26967
|
constructor(annotation: WidgetAnnotation);
|
|
26968
|
-
toJSON():
|
|
26969
|
-
static fromJSON(id: ID | null, json: Omit<
|
|
26968
|
+
toJSON(): Serializers.WidgetAnnotationJSON;
|
|
26969
|
+
static fromJSON(id: ID | null, json: Omit<Serializers.WidgetAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): WidgetAnnotation;
|
|
26970
26970
|
}
|
|
26971
26971
|
|
|
26972
26972
|
/** @inline */
|