@fedify/fedify 1.1.0-dev.427 → 1.1.0-dev.429
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/CHANGES.md +46 -0
- package/FEDERATION.md +2 -0
- package/esm/vocab/application.yaml +13 -0
- package/esm/vocab/arrive.yaml +1 -1
- package/esm/vocab/didservice.yaml +22 -0
- package/esm/vocab/dislike.yaml +2 -0
- package/esm/vocab/emojireact.yaml +17 -0
- package/esm/vocab/export.yaml +9 -0
- package/esm/vocab/group.yaml +13 -0
- package/esm/vocab/like.yaml +2 -0
- package/esm/vocab/organization.yaml +13 -0
- package/esm/vocab/person.yaml +13 -0
- package/esm/vocab/service.yaml +13 -0
- package/esm/vocab/vocab.js +4165 -2543
- package/package.json +1 -1
- package/types/vocab/vocab.d.ts +879 -386
- package/types/vocab/vocab.d.ts.map +1 -1
package/types/vocab/vocab.d.ts
CHANGED
@@ -967,26 +967,441 @@ export declare class ChatMessage extends Object {
|
|
967
967
|
}): Promise<ChatMessage>;
|
968
968
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
969
969
|
}
|
970
|
-
/**
|
970
|
+
/** An Activity is a subtype of {@link Object} that describes some form of action
|
971
|
+
* that may happen, is currently happening, or has already happened.
|
972
|
+
* The {@link Activity} type itself serves as an abstract base type for all types
|
973
|
+
* of activities. It is important to note that the {@link Activity} type itself
|
974
|
+
* does not carry any specific semantics about the kind of action being taken.
|
975
|
+
*/
|
976
|
+
export declare class Activity extends Object {
|
977
|
+
#private;
|
978
|
+
/**
|
979
|
+
* The type URI of {@link Activity}: `https://www.w3.org/ns/activitystreams#Activity`.
|
980
|
+
*/
|
981
|
+
static get typeId(): URL;
|
982
|
+
/**
|
983
|
+
* Constructs a new instance of Activity with the given values.
|
984
|
+
* @param values The values to initialize the instance with.
|
985
|
+
* @param options The options to use for initialization.
|
986
|
+
*/
|
987
|
+
constructor(values: {
|
988
|
+
id?: URL | null;
|
989
|
+
attachments?: (Object | Link | PropertyValue | URL)[];
|
990
|
+
attribution?: Application | Group | Organization | Person | Service | URL | null;
|
991
|
+
attributions?: (Application | Group | Organization | Person | Service | URL)[];
|
992
|
+
audience?: Object | URL | null;
|
993
|
+
audiences?: (Object | URL)[];
|
994
|
+
content?: string | LanguageString | null;
|
995
|
+
contents?: ((string | LanguageString))[];
|
996
|
+
contexts?: (Object | Link | URL)[];
|
997
|
+
name?: string | LanguageString | null;
|
998
|
+
names?: ((string | LanguageString))[];
|
999
|
+
endTime?: dntShim.Temporal.Instant | null;
|
1000
|
+
generators?: (Object | Link | URL)[];
|
1001
|
+
icon?: Image | URL | null;
|
1002
|
+
icons?: (Image | URL)[];
|
1003
|
+
image?: Image | URL | null;
|
1004
|
+
images?: (Image | URL)[];
|
1005
|
+
replyTarget?: Object | Link | URL | null;
|
1006
|
+
replyTargets?: (Object | Link | URL)[];
|
1007
|
+
location?: Object | Link | URL | null;
|
1008
|
+
locations?: (Object | Link | URL)[];
|
1009
|
+
preview?: Link | Object | URL | null;
|
1010
|
+
previews?: (Link | Object | URL)[];
|
1011
|
+
published?: dntShim.Temporal.Instant | null;
|
1012
|
+
replies?: Collection | URL | null;
|
1013
|
+
startTime?: dntShim.Temporal.Instant | null;
|
1014
|
+
summary?: string | LanguageString | null;
|
1015
|
+
summaries?: ((string | LanguageString))[];
|
1016
|
+
tags?: (Object | Link | URL)[];
|
1017
|
+
updated?: dntShim.Temporal.Instant | null;
|
1018
|
+
url?: URL | Link | null;
|
1019
|
+
urls?: ((URL | Link))[];
|
1020
|
+
to?: Object | URL | null;
|
1021
|
+
tos?: (Object | URL)[];
|
1022
|
+
bto?: Object | URL | null;
|
1023
|
+
btos?: (Object | URL)[];
|
1024
|
+
cc?: Object | URL | null;
|
1025
|
+
ccs?: (Object | URL)[];
|
1026
|
+
bcc?: Object | URL | null;
|
1027
|
+
bccs?: (Object | URL)[];
|
1028
|
+
mediaType?: string | null;
|
1029
|
+
duration?: dntShim.Temporal.Duration | null;
|
1030
|
+
sensitive?: boolean | null;
|
1031
|
+
source?: Source | null;
|
1032
|
+
proof?: DataIntegrityProof | URL | null;
|
1033
|
+
proofs?: (DataIntegrityProof | URL)[];
|
1034
|
+
actor?: Application | Group | Organization | Person | Service | URL | null;
|
1035
|
+
actors?: (Application | Group | Organization | Person | Service | URL)[];
|
1036
|
+
object?: Object | URL | null;
|
1037
|
+
objects?: (Object | URL)[];
|
1038
|
+
target?: Object | URL | null;
|
1039
|
+
targets?: (Object | URL)[];
|
1040
|
+
result?: Object | URL | null;
|
1041
|
+
results?: (Object | URL)[];
|
1042
|
+
origin?: Object | URL | null;
|
1043
|
+
origins?: (Object | URL)[];
|
1044
|
+
instrument?: Object | URL | null;
|
1045
|
+
instruments?: (Object | URL)[];
|
1046
|
+
}, { documentLoader, contextLoader, }?: {
|
1047
|
+
documentLoader?: DocumentLoader;
|
1048
|
+
contextLoader?: DocumentLoader;
|
1049
|
+
});
|
1050
|
+
/**
|
1051
|
+
* Clones this instance, optionally updating it with the given values.
|
1052
|
+
* @param values The values to update the clone with.
|
1053
|
+
* @options The options to use for cloning.
|
1054
|
+
* @returns The cloned instance.
|
1055
|
+
*/
|
1056
|
+
clone(values?: {
|
1057
|
+
id?: URL | null;
|
1058
|
+
attachments?: (Object | Link | PropertyValue | URL)[];
|
1059
|
+
attribution?: Application | Group | Organization | Person | Service | URL | null;
|
1060
|
+
attributions?: (Application | Group | Organization | Person | Service | URL)[];
|
1061
|
+
audience?: Object | URL | null;
|
1062
|
+
audiences?: (Object | URL)[];
|
1063
|
+
content?: string | LanguageString | null;
|
1064
|
+
contents?: ((string | LanguageString))[];
|
1065
|
+
contexts?: (Object | Link | URL)[];
|
1066
|
+
name?: string | LanguageString | null;
|
1067
|
+
names?: ((string | LanguageString))[];
|
1068
|
+
endTime?: dntShim.Temporal.Instant | null;
|
1069
|
+
generators?: (Object | Link | URL)[];
|
1070
|
+
icon?: Image | URL | null;
|
1071
|
+
icons?: (Image | URL)[];
|
1072
|
+
image?: Image | URL | null;
|
1073
|
+
images?: (Image | URL)[];
|
1074
|
+
replyTarget?: Object | Link | URL | null;
|
1075
|
+
replyTargets?: (Object | Link | URL)[];
|
1076
|
+
location?: Object | Link | URL | null;
|
1077
|
+
locations?: (Object | Link | URL)[];
|
1078
|
+
preview?: Link | Object | URL | null;
|
1079
|
+
previews?: (Link | Object | URL)[];
|
1080
|
+
published?: dntShim.Temporal.Instant | null;
|
1081
|
+
replies?: Collection | URL | null;
|
1082
|
+
startTime?: dntShim.Temporal.Instant | null;
|
1083
|
+
summary?: string | LanguageString | null;
|
1084
|
+
summaries?: ((string | LanguageString))[];
|
1085
|
+
tags?: (Object | Link | URL)[];
|
1086
|
+
updated?: dntShim.Temporal.Instant | null;
|
1087
|
+
url?: URL | Link | null;
|
1088
|
+
urls?: ((URL | Link))[];
|
1089
|
+
to?: Object | URL | null;
|
1090
|
+
tos?: (Object | URL)[];
|
1091
|
+
bto?: Object | URL | null;
|
1092
|
+
btos?: (Object | URL)[];
|
1093
|
+
cc?: Object | URL | null;
|
1094
|
+
ccs?: (Object | URL)[];
|
1095
|
+
bcc?: Object | URL | null;
|
1096
|
+
bccs?: (Object | URL)[];
|
1097
|
+
mediaType?: string | null;
|
1098
|
+
duration?: dntShim.Temporal.Duration | null;
|
1099
|
+
sensitive?: boolean | null;
|
1100
|
+
source?: Source | null;
|
1101
|
+
proof?: DataIntegrityProof | URL | null;
|
1102
|
+
proofs?: (DataIntegrityProof | URL)[];
|
1103
|
+
actor?: Application | Group | Organization | Person | Service | URL | null;
|
1104
|
+
actors?: (Application | Group | Organization | Person | Service | URL)[];
|
1105
|
+
object?: Object | URL | null;
|
1106
|
+
objects?: (Object | URL)[];
|
1107
|
+
target?: Object | URL | null;
|
1108
|
+
targets?: (Object | URL)[];
|
1109
|
+
result?: Object | URL | null;
|
1110
|
+
results?: (Object | URL)[];
|
1111
|
+
origin?: Object | URL | null;
|
1112
|
+
origins?: (Object | URL)[];
|
1113
|
+
instrument?: Object | URL | null;
|
1114
|
+
instruments?: (Object | URL)[];
|
1115
|
+
}, options?: {
|
1116
|
+
documentLoader?: DocumentLoader;
|
1117
|
+
contextLoader?: DocumentLoader;
|
1118
|
+
}): Activity;
|
1119
|
+
/**
|
1120
|
+
* Similar to
|
1121
|
+
* {@link Activity.getActor},
|
1122
|
+
* but returns its `@id` URL instead of the object itself.
|
1123
|
+
*/
|
1124
|
+
get actorId(): URL | null;
|
1125
|
+
/** Describes one or more entities that either performed or are expected to
|
1126
|
+
* perform the activity. Any single activity can have multiple actors.
|
1127
|
+
* The actor MAY be specified using an indirect {@link Link}.
|
1128
|
+
*/
|
1129
|
+
getActor(options?: {
|
1130
|
+
documentLoader?: DocumentLoader;
|
1131
|
+
contextLoader?: DocumentLoader;
|
1132
|
+
suppressError?: boolean;
|
1133
|
+
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1134
|
+
/**
|
1135
|
+
* Similar to
|
1136
|
+
* {@link Activity.getActors},
|
1137
|
+
* but returns their `@id`s instead of the objects themselves.
|
1138
|
+
*/
|
1139
|
+
get actorIds(): URL[];
|
1140
|
+
/** Describes one or more entities that either performed or are expected to
|
1141
|
+
* perform the activity. Any single activity can have multiple actors.
|
1142
|
+
* The actor MAY be specified using an indirect {@link Link}.
|
1143
|
+
*/
|
1144
|
+
getActors(options?: {
|
1145
|
+
documentLoader?: DocumentLoader;
|
1146
|
+
contextLoader?: DocumentLoader;
|
1147
|
+
suppressError?: boolean;
|
1148
|
+
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
1149
|
+
/**
|
1150
|
+
* Similar to
|
1151
|
+
* {@link Activity.getObject},
|
1152
|
+
* but returns its `@id` URL instead of the object itself.
|
1153
|
+
*/
|
1154
|
+
get objectId(): URL | null;
|
1155
|
+
/** When used within an {@link Activity}, describes the direct object of
|
1156
|
+
* the activity. For instance, in the activity "John added a movie to his
|
1157
|
+
* wishlist", the object of the activity is the movie added.
|
1158
|
+
*/
|
1159
|
+
getObject(options?: {
|
1160
|
+
documentLoader?: DocumentLoader;
|
1161
|
+
contextLoader?: DocumentLoader;
|
1162
|
+
suppressError?: boolean;
|
1163
|
+
}): Promise<Object | null>;
|
1164
|
+
/**
|
1165
|
+
* Similar to
|
1166
|
+
* {@link Activity.getObjects},
|
1167
|
+
* but returns their `@id`s instead of the objects themselves.
|
1168
|
+
*/
|
1169
|
+
get objectIds(): URL[];
|
1170
|
+
/** When used within an {@link Activity}, describes the direct object of
|
1171
|
+
* the activity. For instance, in the activity "John added a movie to his
|
1172
|
+
* wishlist", the object of the activity is the movie added.
|
1173
|
+
*/
|
1174
|
+
getObjects(options?: {
|
1175
|
+
documentLoader?: DocumentLoader;
|
1176
|
+
contextLoader?: DocumentLoader;
|
1177
|
+
suppressError?: boolean;
|
1178
|
+
}): AsyncIterable<Object>;
|
1179
|
+
/**
|
1180
|
+
* Similar to
|
1181
|
+
* {@link Activity.getTarget},
|
1182
|
+
* but returns its `@id` URL instead of the object itself.
|
1183
|
+
*/
|
1184
|
+
get targetId(): URL | null;
|
1185
|
+
/** Describes the indirect object, or target, of the activity. The precise
|
1186
|
+
* meaning of the target is largely dependent on the type of action being
|
1187
|
+
* described but will often be the object of the English preposition "to".
|
1188
|
+
* For instance, in the activity "John added a movie to his wishlist",
|
1189
|
+
* the target of the activity is John's wishlist. An activity can have more
|
1190
|
+
* than one target.
|
1191
|
+
*/
|
1192
|
+
getTarget(options?: {
|
1193
|
+
documentLoader?: DocumentLoader;
|
1194
|
+
contextLoader?: DocumentLoader;
|
1195
|
+
suppressError?: boolean;
|
1196
|
+
}): Promise<Object | null>;
|
1197
|
+
/**
|
1198
|
+
* Similar to
|
1199
|
+
* {@link Activity.getTargets},
|
1200
|
+
* but returns their `@id`s instead of the objects themselves.
|
1201
|
+
*/
|
1202
|
+
get targetIds(): URL[];
|
1203
|
+
/** Describes the indirect object, or target, of the activity. The precise
|
1204
|
+
* meaning of the target is largely dependent on the type of action being
|
1205
|
+
* described but will often be the object of the English preposition "to".
|
1206
|
+
* For instance, in the activity "John added a movie to his wishlist",
|
1207
|
+
* the target of the activity is John's wishlist. An activity can have more
|
1208
|
+
* than one target.
|
1209
|
+
*/
|
1210
|
+
getTargets(options?: {
|
1211
|
+
documentLoader?: DocumentLoader;
|
1212
|
+
contextLoader?: DocumentLoader;
|
1213
|
+
suppressError?: boolean;
|
1214
|
+
}): AsyncIterable<Object>;
|
1215
|
+
/**
|
1216
|
+
* Similar to
|
1217
|
+
* {@link Activity.getResult},
|
1218
|
+
* but returns its `@id` URL instead of the object itself.
|
1219
|
+
*/
|
1220
|
+
get resultId(): URL | null;
|
1221
|
+
/** Describes the result of the activity. For instance, if a particular action
|
1222
|
+
* results in the creation of a new resource, the result property can be used
|
1223
|
+
* to describe that new resource.
|
1224
|
+
*/
|
1225
|
+
getResult(options?: {
|
1226
|
+
documentLoader?: DocumentLoader;
|
1227
|
+
contextLoader?: DocumentLoader;
|
1228
|
+
suppressError?: boolean;
|
1229
|
+
}): Promise<Object | null>;
|
1230
|
+
/**
|
1231
|
+
* Similar to
|
1232
|
+
* {@link Activity.getResults},
|
1233
|
+
* but returns their `@id`s instead of the objects themselves.
|
1234
|
+
*/
|
1235
|
+
get resultIds(): URL[];
|
1236
|
+
/** Describes the result of the activity. For instance, if a particular action
|
1237
|
+
* results in the creation of a new resource, the result property can be used
|
1238
|
+
* to describe that new resource.
|
1239
|
+
*/
|
1240
|
+
getResults(options?: {
|
1241
|
+
documentLoader?: DocumentLoader;
|
1242
|
+
contextLoader?: DocumentLoader;
|
1243
|
+
suppressError?: boolean;
|
1244
|
+
}): AsyncIterable<Object>;
|
1245
|
+
/**
|
1246
|
+
* Similar to
|
1247
|
+
* {@link Activity.getOrigin},
|
1248
|
+
* but returns its `@id` URL instead of the object itself.
|
1249
|
+
*/
|
1250
|
+
get originId(): URL | null;
|
1251
|
+
/** Describes an indirect object of the activity from which the activity is
|
1252
|
+
* directed. The precise meaning of the origin is the object of the English
|
1253
|
+
* preposition "from". For instance, in the activity "John moved an item to
|
1254
|
+
* List B from List A", the origin of the activity is "List A".
|
1255
|
+
*/
|
1256
|
+
getOrigin(options?: {
|
1257
|
+
documentLoader?: DocumentLoader;
|
1258
|
+
contextLoader?: DocumentLoader;
|
1259
|
+
suppressError?: boolean;
|
1260
|
+
}): Promise<Object | null>;
|
1261
|
+
/**
|
1262
|
+
* Similar to
|
1263
|
+
* {@link Activity.getOrigins},
|
1264
|
+
* but returns their `@id`s instead of the objects themselves.
|
1265
|
+
*/
|
1266
|
+
get originIds(): URL[];
|
1267
|
+
/** Describes an indirect object of the activity from which the activity is
|
1268
|
+
* directed. The precise meaning of the origin is the object of the English
|
1269
|
+
* preposition "from". For instance, in the activity "John moved an item to
|
1270
|
+
* List B from List A", the origin of the activity is "List A".
|
1271
|
+
*/
|
1272
|
+
getOrigins(options?: {
|
1273
|
+
documentLoader?: DocumentLoader;
|
1274
|
+
contextLoader?: DocumentLoader;
|
1275
|
+
suppressError?: boolean;
|
1276
|
+
}): AsyncIterable<Object>;
|
1277
|
+
/**
|
1278
|
+
* Similar to
|
1279
|
+
* {@link Activity.getInstrument},
|
1280
|
+
* but returns its `@id` URL instead of the object itself.
|
1281
|
+
*/
|
1282
|
+
get instrumentId(): URL | null;
|
1283
|
+
/** Identifies one or more objects used (or to be used) in the completion of
|
1284
|
+
* an {@link Activity}.
|
1285
|
+
*/
|
1286
|
+
getInstrument(options?: {
|
1287
|
+
documentLoader?: DocumentLoader;
|
1288
|
+
contextLoader?: DocumentLoader;
|
1289
|
+
suppressError?: boolean;
|
1290
|
+
}): Promise<Object | null>;
|
1291
|
+
/**
|
1292
|
+
* Similar to
|
1293
|
+
* {@link Activity.getInstruments},
|
1294
|
+
* but returns their `@id`s instead of the objects themselves.
|
1295
|
+
*/
|
1296
|
+
get instrumentIds(): URL[];
|
1297
|
+
/** Identifies one or more objects used (or to be used) in the completion of
|
1298
|
+
* an {@link Activity}.
|
1299
|
+
*/
|
1300
|
+
getInstruments(options?: {
|
1301
|
+
documentLoader?: DocumentLoader;
|
1302
|
+
contextLoader?: DocumentLoader;
|
1303
|
+
suppressError?: boolean;
|
1304
|
+
}): AsyncIterable<Object>;
|
1305
|
+
/**
|
1306
|
+
* Converts this object to a JSON-LD structure.
|
1307
|
+
* @param options The options to use.
|
1308
|
+
* - `format`: The format of the output: `compact` or
|
1309
|
+
`expand`.
|
1310
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1311
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1312
|
+
when `format` is set to `'expand'`.
|
1313
|
+
* @returns The JSON-LD representation of this object.
|
1314
|
+
*/
|
1315
|
+
toJsonLd(options?: {
|
1316
|
+
format?: "compact" | "expand";
|
1317
|
+
contextLoader?: DocumentLoader;
|
1318
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1319
|
+
}): Promise<unknown>;
|
1320
|
+
protected isCompactable(): boolean;
|
1321
|
+
/**
|
1322
|
+
* Converts a JSON-LD structure to an object of this type.
|
1323
|
+
* @param json The JSON-LD structure to convert.
|
1324
|
+
* @returns The object of this type.
|
1325
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1326
|
+
*/
|
1327
|
+
static fromJsonLd(json: unknown, options?: {
|
1328
|
+
documentLoader?: DocumentLoader;
|
1329
|
+
contextLoader?: DocumentLoader;
|
1330
|
+
}): Promise<Activity>;
|
1331
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1332
|
+
}
|
1333
|
+
/** Represents an emoji reaction. See also [FEP-c0e0](https://w3id.org/fep/c0e0).
|
971
1334
|
*/
|
972
|
-
export declare class
|
1335
|
+
export declare class EmojiReact extends Activity {
|
973
1336
|
#private;
|
974
|
-
readonly id: URL | null;
|
975
|
-
protected get _documentLoader(): DocumentLoader | undefined;
|
976
|
-
protected get _contextLoader(): DocumentLoader | undefined;
|
977
1337
|
/**
|
978
|
-
* The type URI of {@link
|
1338
|
+
* The type URI of {@link EmojiReact}: `http://litepub.social/ns#EmojiReact`.
|
979
1339
|
*/
|
980
1340
|
static get typeId(): URL;
|
981
1341
|
/**
|
982
|
-
* Constructs a new instance of
|
1342
|
+
* Constructs a new instance of EmojiReact with the given values.
|
983
1343
|
* @param values The values to initialize the instance with.
|
984
1344
|
* @param options The options to use for initialization.
|
985
1345
|
*/
|
986
1346
|
constructor(values: {
|
987
1347
|
id?: URL | null;
|
1348
|
+
attachments?: (Object | Link | PropertyValue | URL)[];
|
1349
|
+
attribution?: Application | Group | Organization | Person | Service | URL | null;
|
1350
|
+
attributions?: (Application | Group | Organization | Person | Service | URL)[];
|
1351
|
+
audience?: Object | URL | null;
|
1352
|
+
audiences?: (Object | URL)[];
|
1353
|
+
content?: string | LanguageString | null;
|
1354
|
+
contents?: ((string | LanguageString))[];
|
1355
|
+
contexts?: (Object | Link | URL)[];
|
988
1356
|
name?: string | LanguageString | null;
|
989
|
-
|
1357
|
+
names?: ((string | LanguageString))[];
|
1358
|
+
endTime?: dntShim.Temporal.Instant | null;
|
1359
|
+
generators?: (Object | Link | URL)[];
|
1360
|
+
icon?: Image | URL | null;
|
1361
|
+
icons?: (Image | URL)[];
|
1362
|
+
image?: Image | URL | null;
|
1363
|
+
images?: (Image | URL)[];
|
1364
|
+
replyTarget?: Object | Link | URL | null;
|
1365
|
+
replyTargets?: (Object | Link | URL)[];
|
1366
|
+
location?: Object | Link | URL | null;
|
1367
|
+
locations?: (Object | Link | URL)[];
|
1368
|
+
preview?: Link | Object | URL | null;
|
1369
|
+
previews?: (Link | Object | URL)[];
|
1370
|
+
published?: dntShim.Temporal.Instant | null;
|
1371
|
+
replies?: Collection | URL | null;
|
1372
|
+
startTime?: dntShim.Temporal.Instant | null;
|
1373
|
+
summary?: string | LanguageString | null;
|
1374
|
+
summaries?: ((string | LanguageString))[];
|
1375
|
+
tags?: (Object | Link | URL)[];
|
1376
|
+
updated?: dntShim.Temporal.Instant | null;
|
1377
|
+
url?: URL | Link | null;
|
1378
|
+
urls?: ((URL | Link))[];
|
1379
|
+
to?: Object | URL | null;
|
1380
|
+
tos?: (Object | URL)[];
|
1381
|
+
bto?: Object | URL | null;
|
1382
|
+
btos?: (Object | URL)[];
|
1383
|
+
cc?: Object | URL | null;
|
1384
|
+
ccs?: (Object | URL)[];
|
1385
|
+
bcc?: Object | URL | null;
|
1386
|
+
bccs?: (Object | URL)[];
|
1387
|
+
mediaType?: string | null;
|
1388
|
+
duration?: dntShim.Temporal.Duration | null;
|
1389
|
+
sensitive?: boolean | null;
|
1390
|
+
source?: Source | null;
|
1391
|
+
proof?: DataIntegrityProof | URL | null;
|
1392
|
+
proofs?: (DataIntegrityProof | URL)[];
|
1393
|
+
actor?: Application | Group | Organization | Person | Service | URL | null;
|
1394
|
+
actors?: (Application | Group | Organization | Person | Service | URL)[];
|
1395
|
+
object?: Object | URL | null;
|
1396
|
+
objects?: (Object | URL)[];
|
1397
|
+
target?: Object | URL | null;
|
1398
|
+
targets?: (Object | URL)[];
|
1399
|
+
result?: Object | URL | null;
|
1400
|
+
results?: (Object | URL)[];
|
1401
|
+
origin?: Object | URL | null;
|
1402
|
+
origins?: (Object | URL)[];
|
1403
|
+
instrument?: Object | URL | null;
|
1404
|
+
instruments?: (Object | URL)[];
|
990
1405
|
}, { documentLoader, contextLoader, }?: {
|
991
1406
|
documentLoader?: DocumentLoader;
|
992
1407
|
contextLoader?: DocumentLoader;
|
@@ -999,18 +1414,67 @@ export declare class PropertyValue {
|
|
999
1414
|
*/
|
1000
1415
|
clone(values?: {
|
1001
1416
|
id?: URL | null;
|
1417
|
+
attachments?: (Object | Link | PropertyValue | URL)[];
|
1418
|
+
attribution?: Application | Group | Organization | Person | Service | URL | null;
|
1419
|
+
attributions?: (Application | Group | Organization | Person | Service | URL)[];
|
1420
|
+
audience?: Object | URL | null;
|
1421
|
+
audiences?: (Object | URL)[];
|
1422
|
+
content?: string | LanguageString | null;
|
1423
|
+
contents?: ((string | LanguageString))[];
|
1424
|
+
contexts?: (Object | Link | URL)[];
|
1002
1425
|
name?: string | LanguageString | null;
|
1003
|
-
|
1426
|
+
names?: ((string | LanguageString))[];
|
1427
|
+
endTime?: dntShim.Temporal.Instant | null;
|
1428
|
+
generators?: (Object | Link | URL)[];
|
1429
|
+
icon?: Image | URL | null;
|
1430
|
+
icons?: (Image | URL)[];
|
1431
|
+
image?: Image | URL | null;
|
1432
|
+
images?: (Image | URL)[];
|
1433
|
+
replyTarget?: Object | Link | URL | null;
|
1434
|
+
replyTargets?: (Object | Link | URL)[];
|
1435
|
+
location?: Object | Link | URL | null;
|
1436
|
+
locations?: (Object | Link | URL)[];
|
1437
|
+
preview?: Link | Object | URL | null;
|
1438
|
+
previews?: (Link | Object | URL)[];
|
1439
|
+
published?: dntShim.Temporal.Instant | null;
|
1440
|
+
replies?: Collection | URL | null;
|
1441
|
+
startTime?: dntShim.Temporal.Instant | null;
|
1442
|
+
summary?: string | LanguageString | null;
|
1443
|
+
summaries?: ((string | LanguageString))[];
|
1444
|
+
tags?: (Object | Link | URL)[];
|
1445
|
+
updated?: dntShim.Temporal.Instant | null;
|
1446
|
+
url?: URL | Link | null;
|
1447
|
+
urls?: ((URL | Link))[];
|
1448
|
+
to?: Object | URL | null;
|
1449
|
+
tos?: (Object | URL)[];
|
1450
|
+
bto?: Object | URL | null;
|
1451
|
+
btos?: (Object | URL)[];
|
1452
|
+
cc?: Object | URL | null;
|
1453
|
+
ccs?: (Object | URL)[];
|
1454
|
+
bcc?: Object | URL | null;
|
1455
|
+
bccs?: (Object | URL)[];
|
1456
|
+
mediaType?: string | null;
|
1457
|
+
duration?: dntShim.Temporal.Duration | null;
|
1458
|
+
sensitive?: boolean | null;
|
1459
|
+
source?: Source | null;
|
1460
|
+
proof?: DataIntegrityProof | URL | null;
|
1461
|
+
proofs?: (DataIntegrityProof | URL)[];
|
1462
|
+
actor?: Application | Group | Organization | Person | Service | URL | null;
|
1463
|
+
actors?: (Application | Group | Organization | Person | Service | URL)[];
|
1464
|
+
object?: Object | URL | null;
|
1465
|
+
objects?: (Object | URL)[];
|
1466
|
+
target?: Object | URL | null;
|
1467
|
+
targets?: (Object | URL)[];
|
1468
|
+
result?: Object | URL | null;
|
1469
|
+
results?: (Object | URL)[];
|
1470
|
+
origin?: Object | URL | null;
|
1471
|
+
origins?: (Object | URL)[];
|
1472
|
+
instrument?: Object | URL | null;
|
1473
|
+
instruments?: (Object | URL)[];
|
1004
1474
|
}, options?: {
|
1005
1475
|
documentLoader?: DocumentLoader;
|
1006
1476
|
contextLoader?: DocumentLoader;
|
1007
|
-
}):
|
1008
|
-
/** The name of a property.
|
1009
|
-
*/
|
1010
|
-
get name(): string | LanguageString | null;
|
1011
|
-
/** The value of a property.
|
1012
|
-
*/
|
1013
|
-
get value(): string | LanguageString | null;
|
1477
|
+
}): EmojiReact;
|
1014
1478
|
/**
|
1015
1479
|
* Converts this object to a JSON-LD structure.
|
1016
1480
|
* @param options The options to use.
|
@@ -1036,33 +1500,29 @@ export declare class PropertyValue {
|
|
1036
1500
|
static fromJsonLd(json: unknown, options?: {
|
1037
1501
|
documentLoader?: DocumentLoader;
|
1038
1502
|
contextLoader?: DocumentLoader;
|
1039
|
-
}): Promise<
|
1503
|
+
}): Promise<EmojiReact>;
|
1040
1504
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1041
1505
|
}
|
1042
|
-
/** A
|
1043
|
-
* verify the identity of the actor and the integrity of the data.
|
1506
|
+
/** A pair of property name and value.
|
1044
1507
|
*/
|
1045
|
-
export declare class
|
1508
|
+
export declare class PropertyValue {
|
1046
1509
|
#private;
|
1047
1510
|
readonly id: URL | null;
|
1048
1511
|
protected get _documentLoader(): DocumentLoader | undefined;
|
1049
1512
|
protected get _contextLoader(): DocumentLoader | undefined;
|
1050
1513
|
/**
|
1051
|
-
* The type URI of {@link
|
1514
|
+
* The type URI of {@link PropertyValue}: `http://schema.org#PropertyValue`.
|
1052
1515
|
*/
|
1053
1516
|
static get typeId(): URL;
|
1054
1517
|
/**
|
1055
|
-
* Constructs a new instance of
|
1518
|
+
* Constructs a new instance of PropertyValue with the given values.
|
1056
1519
|
* @param values The values to initialize the instance with.
|
1057
1520
|
* @param options The options to use for initialization.
|
1058
1521
|
*/
|
1059
1522
|
constructor(values: {
|
1060
1523
|
id?: URL | null;
|
1061
|
-
|
1062
|
-
|
1063
|
-
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1064
|
-
proofValue?: Uint8Array | null;
|
1065
|
-
created?: dntShim.Temporal.Instant | null;
|
1524
|
+
name?: string | LanguageString | null;
|
1525
|
+
value?: string | LanguageString | null;
|
1066
1526
|
}, { documentLoader, contextLoader, }?: {
|
1067
1527
|
documentLoader?: DocumentLoader;
|
1068
1528
|
contextLoader?: DocumentLoader;
|
@@ -1075,49 +1535,18 @@ export declare class DataIntegrityProof {
|
|
1075
1535
|
*/
|
1076
1536
|
clone(values?: {
|
1077
1537
|
id?: URL | null;
|
1078
|
-
|
1079
|
-
|
1080
|
-
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1081
|
-
proofValue?: Uint8Array | null;
|
1082
|
-
created?: dntShim.Temporal.Instant | null;
|
1538
|
+
name?: string | LanguageString | null;
|
1539
|
+
value?: string | LanguageString | null;
|
1083
1540
|
}, options?: {
|
1084
1541
|
documentLoader?: DocumentLoader;
|
1085
1542
|
contextLoader?: DocumentLoader;
|
1086
|
-
}):
|
1087
|
-
/** The
|
1088
|
-
*/
|
1089
|
-
get cryptosuite(): "eddsa-jcs-2022" | null;
|
1090
|
-
/**
|
1091
|
-
* Similar to
|
1092
|
-
* {@link DataIntegrityProof.getVerificationMethod},
|
1093
|
-
* but returns its `@id` URL instead of the object itself.
|
1094
|
-
*/
|
1095
|
-
get verificationMethodId(): URL | null;
|
1096
|
-
/** A key owned by an actor according to [FEP-521a: Representing actor's public
|
1097
|
-
* keys][1].
|
1098
|
-
*
|
1099
|
-
* [1]: https://w3id.org/fep/521a
|
1100
|
-
*/
|
1101
|
-
getVerificationMethod(options?: {
|
1102
|
-
documentLoader?: DocumentLoader;
|
1103
|
-
contextLoader?: DocumentLoader;
|
1104
|
-
suppressError?: boolean;
|
1105
|
-
}): Promise<Multikey | null>;
|
1106
|
-
/** The reason the proof was created.
|
1107
|
-
*
|
1108
|
-
* - `"assertionMethod"`
|
1109
|
-
* - `"authentication"`
|
1110
|
-
* - `"capabilityInvocation"`
|
1111
|
-
* - `"capabilityDelegation"`
|
1112
|
-
* - `"keyAgreement"`
|
1113
|
-
*/
|
1114
|
-
get proofPurpose(): "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1115
|
-
/** The proof value.
|
1543
|
+
}): PropertyValue;
|
1544
|
+
/** The name of a property.
|
1116
1545
|
*/
|
1117
|
-
get
|
1118
|
-
/** The
|
1546
|
+
get name(): string | LanguageString | null;
|
1547
|
+
/** The value of a property.
|
1119
1548
|
*/
|
1120
|
-
get
|
1549
|
+
get value(): string | LanguageString | null;
|
1121
1550
|
/**
|
1122
1551
|
* Converts this object to a JSON-LD structure.
|
1123
1552
|
* @param options The options to use.
|
@@ -1143,29 +1572,32 @@ export declare class DataIntegrityProof {
|
|
1143
1572
|
static fromJsonLd(json: unknown, options?: {
|
1144
1573
|
documentLoader?: DocumentLoader;
|
1145
1574
|
contextLoader?: DocumentLoader;
|
1146
|
-
}): Promise<
|
1575
|
+
}): Promise<PropertyValue>;
|
1147
1576
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1148
1577
|
}
|
1149
|
-
/**
|
1578
|
+
/** Means of communicating or interacting with the DID subject or associated
|
1579
|
+
* entities via one or more service endpoints. Examples include discovery
|
1580
|
+
* services, agent services, social networking services, file storage services,
|
1581
|
+
* and verifiable credential repository services.
|
1150
1582
|
*/
|
1151
|
-
export declare class
|
1583
|
+
export declare class DidService {
|
1152
1584
|
#private;
|
1153
1585
|
readonly id: URL | null;
|
1154
1586
|
protected get _documentLoader(): DocumentLoader | undefined;
|
1155
1587
|
protected get _contextLoader(): DocumentLoader | undefined;
|
1156
1588
|
/**
|
1157
|
-
* The type URI of {@link
|
1589
|
+
* The type URI of {@link DidService}: `https://www.w3.org/ns/did#Service`.
|
1158
1590
|
*/
|
1159
1591
|
static get typeId(): URL;
|
1160
1592
|
/**
|
1161
|
-
* Constructs a new instance of
|
1593
|
+
* Constructs a new instance of DidService with the given values.
|
1162
1594
|
* @param values The values to initialize the instance with.
|
1163
1595
|
* @param options The options to use for initialization.
|
1164
1596
|
*/
|
1165
1597
|
constructor(values: {
|
1166
1598
|
id?: URL | null;
|
1167
|
-
|
1168
|
-
|
1599
|
+
endpoint?: URL | null;
|
1600
|
+
endpoints?: (URL)[];
|
1169
1601
|
}, { documentLoader, contextLoader, }?: {
|
1170
1602
|
documentLoader?: DocumentLoader;
|
1171
1603
|
contextLoader?: DocumentLoader;
|
@@ -1178,28 +1610,20 @@ export declare class CryptographicKey {
|
|
1178
1610
|
*/
|
1179
1611
|
clone(values?: {
|
1180
1612
|
id?: URL | null;
|
1181
|
-
|
1182
|
-
|
1613
|
+
endpoint?: URL | null;
|
1614
|
+
endpoints?: (URL)[];
|
1183
1615
|
}, options?: {
|
1184
1616
|
documentLoader?: DocumentLoader;
|
1185
1617
|
contextLoader?: DocumentLoader;
|
1186
|
-
}):
|
1187
|
-
/**
|
1188
|
-
*
|
1189
|
-
* {@link CryptographicKey.getOwner},
|
1190
|
-
* but returns its `@id` URL instead of the object itself.
|
1191
|
-
*/
|
1192
|
-
get ownerId(): URL | null;
|
1193
|
-
/** An actor who owns this key.
|
1618
|
+
}): DidService;
|
1619
|
+
/** A network address, such as an HTTP URL, at which services operate on behalf
|
1620
|
+
* of a DID subject.
|
1194
1621
|
*/
|
1195
|
-
|
1196
|
-
|
1197
|
-
|
1198
|
-
suppressError?: boolean;
|
1199
|
-
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1200
|
-
/** A PEM-encoded public key.
|
1622
|
+
get endpoint(): URL | null;
|
1623
|
+
/** A network address, such as an HTTP URL, at which services operate on behalf
|
1624
|
+
* of a DID subject.
|
1201
1625
|
*/
|
1202
|
-
get
|
1626
|
+
get endpoints(): (URL)[];
|
1203
1627
|
/**
|
1204
1628
|
* Converts this object to a JSON-LD structure.
|
1205
1629
|
* @param options The options to use.
|
@@ -1225,32 +1649,26 @@ export declare class CryptographicKey {
|
|
1225
1649
|
static fromJsonLd(json: unknown, options?: {
|
1226
1650
|
documentLoader?: DocumentLoader;
|
1227
1651
|
contextLoader?: DocumentLoader;
|
1228
|
-
}): Promise<
|
1652
|
+
}): Promise<DidService>;
|
1229
1653
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1230
1654
|
}
|
1231
|
-
/**
|
1232
|
-
* actor's public keys.][1]
|
1233
|
-
*
|
1234
|
-
* [1]: https://w3id.org/fep/521a
|
1655
|
+
/** "Export Actor" service.
|
1235
1656
|
*/
|
1236
|
-
export declare class
|
1657
|
+
export declare class Export extends DidService {
|
1237
1658
|
#private;
|
1238
|
-
readonly id: URL | null;
|
1239
|
-
protected get _documentLoader(): DocumentLoader | undefined;
|
1240
|
-
protected get _contextLoader(): DocumentLoader | undefined;
|
1241
1659
|
/**
|
1242
|
-
* The type URI of {@link
|
1660
|
+
* The type URI of {@link Export}: `https://w3id.org/fep/9091#Export`.
|
1243
1661
|
*/
|
1244
1662
|
static get typeId(): URL;
|
1245
1663
|
/**
|
1246
|
-
* Constructs a new instance of
|
1664
|
+
* Constructs a new instance of Export with the given values.
|
1247
1665
|
* @param values The values to initialize the instance with.
|
1248
1666
|
* @param options The options to use for initialization.
|
1249
1667
|
*/
|
1250
1668
|
constructor(values: {
|
1251
1669
|
id?: URL | null;
|
1252
|
-
|
1253
|
-
|
1670
|
+
endpoint?: URL | null;
|
1671
|
+
endpoints?: (URL)[];
|
1254
1672
|
}, { documentLoader, contextLoader, }?: {
|
1255
1673
|
documentLoader?: DocumentLoader;
|
1256
1674
|
contextLoader?: DocumentLoader;
|
@@ -1259,35 +1677,16 @@ export declare class Multikey {
|
|
1259
1677
|
* Clones this instance, optionally updating it with the given values.
|
1260
1678
|
* @param values The values to update the clone with.
|
1261
1679
|
* @options The options to use for cloning.
|
1262
|
-
* @returns The cloned instance.
|
1263
|
-
*/
|
1264
|
-
clone(values?: {
|
1265
|
-
id?: URL | null;
|
1266
|
-
controller?: Application | Group | Organization | Person | Service | URL | null;
|
1267
|
-
publicKey?: dntShim.CryptoKey | null;
|
1268
|
-
}, options?: {
|
1269
|
-
documentLoader?: DocumentLoader;
|
1270
|
-
contextLoader?: DocumentLoader;
|
1271
|
-
}): Multikey;
|
1272
|
-
/**
|
1273
|
-
* Similar to
|
1274
|
-
* {@link Multikey.getController},
|
1275
|
-
* but returns its `@id` URL instead of the object itself.
|
1276
|
-
*/
|
1277
|
-
get controllerId(): URL | null;
|
1278
|
-
/** An actor who owns this key.
|
1279
|
-
*/
|
1280
|
-
getController(options?: {
|
1281
|
-
documentLoader?: DocumentLoader;
|
1282
|
-
contextLoader?: DocumentLoader;
|
1283
|
-
suppressError?: boolean;
|
1284
|
-
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1285
|
-
/** A [Multibase]-encoded value of a [Multicodec] prefix and the key.
|
1286
|
-
*
|
1287
|
-
* [Multibase]: https://www.w3.org/TR/vc-data-integrity/#multibase-0
|
1288
|
-
* [Multicodec]: https://github.com/multiformats/multicodec/
|
1680
|
+
* @returns The cloned instance.
|
1289
1681
|
*/
|
1290
|
-
|
1682
|
+
clone(values?: {
|
1683
|
+
id?: URL | null;
|
1684
|
+
endpoint?: URL | null;
|
1685
|
+
endpoints?: (URL)[];
|
1686
|
+
}, options?: {
|
1687
|
+
documentLoader?: DocumentLoader;
|
1688
|
+
contextLoader?: DocumentLoader;
|
1689
|
+
}): Export;
|
1291
1690
|
/**
|
1292
1691
|
* Converts this object to a JSON-LD structure.
|
1293
1692
|
* @param options The options to use.
|
@@ -1313,85 +1712,33 @@ export declare class Multikey {
|
|
1313
1712
|
static fromJsonLd(json: unknown, options?: {
|
1314
1713
|
documentLoader?: DocumentLoader;
|
1315
1714
|
contextLoader?: DocumentLoader;
|
1316
|
-
}): Promise<
|
1715
|
+
}): Promise<Export>;
|
1317
1716
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1318
1717
|
}
|
1319
|
-
/**
|
1320
|
-
*
|
1321
|
-
* The {@link Activity} type itself serves as an abstract base type for all types
|
1322
|
-
* of activities. It is important to note that the {@link Activity} type itself
|
1323
|
-
* does not carry any specific semantics about the kind of action being taken.
|
1718
|
+
/** A proof that can be added to any activity or object, allowing recipients to
|
1719
|
+
* verify the identity of the actor and the integrity of the data.
|
1324
1720
|
*/
|
1325
|
-
export declare class
|
1721
|
+
export declare class DataIntegrityProof {
|
1326
1722
|
#private;
|
1723
|
+
readonly id: URL | null;
|
1724
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1725
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1327
1726
|
/**
|
1328
|
-
* The type URI of {@link
|
1727
|
+
* The type URI of {@link DataIntegrityProof}: `https://w3id.org/security#DataIntegrityProof`.
|
1329
1728
|
*/
|
1330
1729
|
static get typeId(): URL;
|
1331
1730
|
/**
|
1332
|
-
* Constructs a new instance of
|
1731
|
+
* Constructs a new instance of DataIntegrityProof with the given values.
|
1333
1732
|
* @param values The values to initialize the instance with.
|
1334
1733
|
* @param options The options to use for initialization.
|
1335
1734
|
*/
|
1336
1735
|
constructor(values: {
|
1337
1736
|
id?: URL | null;
|
1338
|
-
|
1339
|
-
|
1340
|
-
|
1341
|
-
|
1342
|
-
|
1343
|
-
content?: string | LanguageString | null;
|
1344
|
-
contents?: ((string | LanguageString))[];
|
1345
|
-
contexts?: (Object | Link | URL)[];
|
1346
|
-
name?: string | LanguageString | null;
|
1347
|
-
names?: ((string | LanguageString))[];
|
1348
|
-
endTime?: dntShim.Temporal.Instant | null;
|
1349
|
-
generators?: (Object | Link | URL)[];
|
1350
|
-
icon?: Image | URL | null;
|
1351
|
-
icons?: (Image | URL)[];
|
1352
|
-
image?: Image | URL | null;
|
1353
|
-
images?: (Image | URL)[];
|
1354
|
-
replyTarget?: Object | Link | URL | null;
|
1355
|
-
replyTargets?: (Object | Link | URL)[];
|
1356
|
-
location?: Object | Link | URL | null;
|
1357
|
-
locations?: (Object | Link | URL)[];
|
1358
|
-
preview?: Link | Object | URL | null;
|
1359
|
-
previews?: (Link | Object | URL)[];
|
1360
|
-
published?: dntShim.Temporal.Instant | null;
|
1361
|
-
replies?: Collection | URL | null;
|
1362
|
-
startTime?: dntShim.Temporal.Instant | null;
|
1363
|
-
summary?: string | LanguageString | null;
|
1364
|
-
summaries?: ((string | LanguageString))[];
|
1365
|
-
tags?: (Object | Link | URL)[];
|
1366
|
-
updated?: dntShim.Temporal.Instant | null;
|
1367
|
-
url?: URL | Link | null;
|
1368
|
-
urls?: ((URL | Link))[];
|
1369
|
-
to?: Object | URL | null;
|
1370
|
-
tos?: (Object | URL)[];
|
1371
|
-
bto?: Object | URL | null;
|
1372
|
-
btos?: (Object | URL)[];
|
1373
|
-
cc?: Object | URL | null;
|
1374
|
-
ccs?: (Object | URL)[];
|
1375
|
-
bcc?: Object | URL | null;
|
1376
|
-
bccs?: (Object | URL)[];
|
1377
|
-
mediaType?: string | null;
|
1378
|
-
duration?: dntShim.Temporal.Duration | null;
|
1379
|
-
sensitive?: boolean | null;
|
1380
|
-
source?: Source | null;
|
1381
|
-
proof?: DataIntegrityProof | URL | null;
|
1382
|
-
proofs?: (DataIntegrityProof | URL)[];
|
1383
|
-
actor?: Application | Group | Organization | Person | Service | URL | null;
|
1384
|
-
actors?: (Application | Group | Organization | Person | Service | URL)[];
|
1385
|
-
object?: Object | URL | null;
|
1386
|
-
objects?: (Object | URL)[];
|
1387
|
-
target?: Object | URL | null;
|
1388
|
-
targets?: (Object | URL)[];
|
1389
|
-
result?: Object | URL | null;
|
1390
|
-
results?: (Object | URL)[];
|
1391
|
-
origin?: Object | URL | null;
|
1392
|
-
origins?: (Object | URL)[];
|
1393
|
-
instrument?: Object | URL | null;
|
1394
|
-
instruments?: (Object | URL)[];
|
1737
|
+
cryptosuite?: "eddsa-jcs-2022" | null;
|
1738
|
+
verificationMethod?: Multikey | URL | null;
|
1739
|
+
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1740
|
+
proofValue?: Uint8Array | null;
|
1741
|
+
created?: dntShim.Temporal.Instant | null;
|
1395
1742
|
}, { documentLoader, contextLoader, }?: {
|
1396
1743
|
documentLoader?: DocumentLoader;
|
1397
1744
|
contextLoader?: DocumentLoader;
|
@@ -1404,253 +1751,219 @@ export declare class Activity extends Object {
|
|
1404
1751
|
*/
|
1405
1752
|
clone(values?: {
|
1406
1753
|
id?: URL | null;
|
1407
|
-
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
content?: string | LanguageString | null;
|
1413
|
-
contents?: ((string | LanguageString))[];
|
1414
|
-
contexts?: (Object | Link | URL)[];
|
1415
|
-
name?: string | LanguageString | null;
|
1416
|
-
names?: ((string | LanguageString))[];
|
1417
|
-
endTime?: dntShim.Temporal.Instant | null;
|
1418
|
-
generators?: (Object | Link | URL)[];
|
1419
|
-
icon?: Image | URL | null;
|
1420
|
-
icons?: (Image | URL)[];
|
1421
|
-
image?: Image | URL | null;
|
1422
|
-
images?: (Image | URL)[];
|
1423
|
-
replyTarget?: Object | Link | URL | null;
|
1424
|
-
replyTargets?: (Object | Link | URL)[];
|
1425
|
-
location?: Object | Link | URL | null;
|
1426
|
-
locations?: (Object | Link | URL)[];
|
1427
|
-
preview?: Link | Object | URL | null;
|
1428
|
-
previews?: (Link | Object | URL)[];
|
1429
|
-
published?: dntShim.Temporal.Instant | null;
|
1430
|
-
replies?: Collection | URL | null;
|
1431
|
-
startTime?: dntShim.Temporal.Instant | null;
|
1432
|
-
summary?: string | LanguageString | null;
|
1433
|
-
summaries?: ((string | LanguageString))[];
|
1434
|
-
tags?: (Object | Link | URL)[];
|
1435
|
-
updated?: dntShim.Temporal.Instant | null;
|
1436
|
-
url?: URL | Link | null;
|
1437
|
-
urls?: ((URL | Link))[];
|
1438
|
-
to?: Object | URL | null;
|
1439
|
-
tos?: (Object | URL)[];
|
1440
|
-
bto?: Object | URL | null;
|
1441
|
-
btos?: (Object | URL)[];
|
1442
|
-
cc?: Object | URL | null;
|
1443
|
-
ccs?: (Object | URL)[];
|
1444
|
-
bcc?: Object | URL | null;
|
1445
|
-
bccs?: (Object | URL)[];
|
1446
|
-
mediaType?: string | null;
|
1447
|
-
duration?: dntShim.Temporal.Duration | null;
|
1448
|
-
sensitive?: boolean | null;
|
1449
|
-
source?: Source | null;
|
1450
|
-
proof?: DataIntegrityProof | URL | null;
|
1451
|
-
proofs?: (DataIntegrityProof | URL)[];
|
1452
|
-
actor?: Application | Group | Organization | Person | Service | URL | null;
|
1453
|
-
actors?: (Application | Group | Organization | Person | Service | URL)[];
|
1454
|
-
object?: Object | URL | null;
|
1455
|
-
objects?: (Object | URL)[];
|
1456
|
-
target?: Object | URL | null;
|
1457
|
-
targets?: (Object | URL)[];
|
1458
|
-
result?: Object | URL | null;
|
1459
|
-
results?: (Object | URL)[];
|
1460
|
-
origin?: Object | URL | null;
|
1461
|
-
origins?: (Object | URL)[];
|
1462
|
-
instrument?: Object | URL | null;
|
1463
|
-
instruments?: (Object | URL)[];
|
1754
|
+
cryptosuite?: "eddsa-jcs-2022" | null;
|
1755
|
+
verificationMethod?: Multikey | URL | null;
|
1756
|
+
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1757
|
+
proofValue?: Uint8Array | null;
|
1758
|
+
created?: dntShim.Temporal.Instant | null;
|
1464
1759
|
}, options?: {
|
1465
1760
|
documentLoader?: DocumentLoader;
|
1466
1761
|
contextLoader?: DocumentLoader;
|
1467
|
-
}):
|
1762
|
+
}): DataIntegrityProof;
|
1763
|
+
/** The cryptographic suite used to create the proof.
|
1764
|
+
*/
|
1765
|
+
get cryptosuite(): "eddsa-jcs-2022" | null;
|
1468
1766
|
/**
|
1469
1767
|
* Similar to
|
1470
|
-
* {@link
|
1768
|
+
* {@link DataIntegrityProof.getVerificationMethod},
|
1471
1769
|
* but returns its `@id` URL instead of the object itself.
|
1472
1770
|
*/
|
1473
|
-
get
|
1474
|
-
/**
|
1475
|
-
*
|
1476
|
-
*
|
1771
|
+
get verificationMethodId(): URL | null;
|
1772
|
+
/** A key owned by an actor according to [FEP-521a: Representing actor's public
|
1773
|
+
* keys][1].
|
1774
|
+
*
|
1775
|
+
* [1]: https://w3id.org/fep/521a
|
1477
1776
|
*/
|
1478
|
-
|
1777
|
+
getVerificationMethod(options?: {
|
1479
1778
|
documentLoader?: DocumentLoader;
|
1480
1779
|
contextLoader?: DocumentLoader;
|
1481
1780
|
suppressError?: boolean;
|
1482
|
-
}): Promise<
|
1483
|
-
/**
|
1484
|
-
*
|
1485
|
-
*
|
1486
|
-
*
|
1781
|
+
}): Promise<Multikey | null>;
|
1782
|
+
/** The reason the proof was created.
|
1783
|
+
*
|
1784
|
+
* - `"assertionMethod"`
|
1785
|
+
* - `"authentication"`
|
1786
|
+
* - `"capabilityInvocation"`
|
1787
|
+
* - `"capabilityDelegation"`
|
1788
|
+
* - `"keyAgreement"`
|
1487
1789
|
*/
|
1488
|
-
get
|
1489
|
-
/**
|
1490
|
-
* perform the activity. Any single activity can have multiple actors.
|
1491
|
-
* The actor MAY be specified using an indirect {@link Link}.
|
1790
|
+
get proofPurpose(): "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1791
|
+
/** The proof value.
|
1492
1792
|
*/
|
1493
|
-
|
1494
|
-
|
1495
|
-
contextLoader?: DocumentLoader;
|
1496
|
-
suppressError?: boolean;
|
1497
|
-
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
1498
|
-
/**
|
1499
|
-
* Similar to
|
1500
|
-
* {@link Activity.getObject},
|
1501
|
-
* but returns its `@id` URL instead of the object itself.
|
1793
|
+
get proofValue(): Uint8Array | null;
|
1794
|
+
/** The date and time the proof was created.
|
1502
1795
|
*/
|
1503
|
-
get
|
1504
|
-
/**
|
1505
|
-
*
|
1506
|
-
*
|
1796
|
+
get created(): dntShim.Temporal.Instant | null;
|
1797
|
+
/**
|
1798
|
+
* Converts this object to a JSON-LD structure.
|
1799
|
+
* @param options The options to use.
|
1800
|
+
* - `format`: The format of the output: `compact` or
|
1801
|
+
`expand`.
|
1802
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1803
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1804
|
+
when `format` is set to `'expand'`.
|
1805
|
+
* @returns The JSON-LD representation of this object.
|
1507
1806
|
*/
|
1508
|
-
|
1509
|
-
|
1807
|
+
toJsonLd(options?: {
|
1808
|
+
format?: "compact" | "expand";
|
1510
1809
|
contextLoader?: DocumentLoader;
|
1511
|
-
|
1512
|
-
}): Promise<
|
1810
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1811
|
+
}): Promise<unknown>;
|
1812
|
+
protected isCompactable(): boolean;
|
1513
1813
|
/**
|
1514
|
-
*
|
1515
|
-
*
|
1516
|
-
*
|
1517
|
-
|
1518
|
-
get objectIds(): URL[];
|
1519
|
-
/** When used within an {@link Activity}, describes the direct object of
|
1520
|
-
* the activity. For instance, in the activity "John added a movie to his
|
1521
|
-
* wishlist", the object of the activity is the movie added.
|
1814
|
+
* Converts a JSON-LD structure to an object of this type.
|
1815
|
+
* @param json The JSON-LD structure to convert.
|
1816
|
+
* @returns The object of this type.
|
1817
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1522
1818
|
*/
|
1523
|
-
|
1819
|
+
static fromJsonLd(json: unknown, options?: {
|
1524
1820
|
documentLoader?: DocumentLoader;
|
1525
1821
|
contextLoader?: DocumentLoader;
|
1526
|
-
|
1527
|
-
|
1528
|
-
|
1529
|
-
|
1530
|
-
|
1531
|
-
|
1532
|
-
|
1533
|
-
|
1534
|
-
|
1535
|
-
|
1536
|
-
|
1537
|
-
*
|
1538
|
-
* the target of the activity is John's wishlist. An activity can have more
|
1539
|
-
* than one target.
|
1822
|
+
}): Promise<DataIntegrityProof>;
|
1823
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1824
|
+
}
|
1825
|
+
/** A key owned by an actor.
|
1826
|
+
*/
|
1827
|
+
export declare class CryptographicKey {
|
1828
|
+
#private;
|
1829
|
+
readonly id: URL | null;
|
1830
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1831
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1832
|
+
/**
|
1833
|
+
* The type URI of {@link CryptographicKey}: `https://w3id.org/security#Key`.
|
1540
1834
|
*/
|
1541
|
-
|
1835
|
+
static get typeId(): URL;
|
1836
|
+
/**
|
1837
|
+
* Constructs a new instance of CryptographicKey with the given values.
|
1838
|
+
* @param values The values to initialize the instance with.
|
1839
|
+
* @param options The options to use for initialization.
|
1840
|
+
*/
|
1841
|
+
constructor(values: {
|
1842
|
+
id?: URL | null;
|
1843
|
+
owner?: Application | Group | Organization | Person | Service | URL | null;
|
1844
|
+
publicKey?: dntShim.CryptoKey | null;
|
1845
|
+
}, { documentLoader, contextLoader, }?: {
|
1542
1846
|
documentLoader?: DocumentLoader;
|
1543
1847
|
contextLoader?: DocumentLoader;
|
1544
|
-
|
1545
|
-
}): Promise<Object | null>;
|
1848
|
+
});
|
1546
1849
|
/**
|
1547
|
-
*
|
1548
|
-
*
|
1549
|
-
*
|
1550
|
-
|
1551
|
-
get targetIds(): URL[];
|
1552
|
-
/** Describes the indirect object, or target, of the activity. The precise
|
1553
|
-
* meaning of the target is largely dependent on the type of action being
|
1554
|
-
* described but will often be the object of the English preposition "to".
|
1555
|
-
* For instance, in the activity "John added a movie to his wishlist",
|
1556
|
-
* the target of the activity is John's wishlist. An activity can have more
|
1557
|
-
* than one target.
|
1850
|
+
* Clones this instance, optionally updating it with the given values.
|
1851
|
+
* @param values The values to update the clone with.
|
1852
|
+
* @options The options to use for cloning.
|
1853
|
+
* @returns The cloned instance.
|
1558
1854
|
*/
|
1559
|
-
|
1855
|
+
clone(values?: {
|
1856
|
+
id?: URL | null;
|
1857
|
+
owner?: Application | Group | Organization | Person | Service | URL | null;
|
1858
|
+
publicKey?: dntShim.CryptoKey | null;
|
1859
|
+
}, options?: {
|
1560
1860
|
documentLoader?: DocumentLoader;
|
1561
1861
|
contextLoader?: DocumentLoader;
|
1562
|
-
|
1563
|
-
}): AsyncIterable<Object>;
|
1862
|
+
}): CryptographicKey;
|
1564
1863
|
/**
|
1565
1864
|
* Similar to
|
1566
|
-
* {@link
|
1865
|
+
* {@link CryptographicKey.getOwner},
|
1567
1866
|
* but returns its `@id` URL instead of the object itself.
|
1568
1867
|
*/
|
1569
|
-
get
|
1570
|
-
/**
|
1571
|
-
* results in the creation of a new resource, the result property can be used
|
1572
|
-
* to describe that new resource.
|
1868
|
+
get ownerId(): URL | null;
|
1869
|
+
/** An actor who owns this key.
|
1573
1870
|
*/
|
1574
|
-
|
1871
|
+
getOwner(options?: {
|
1575
1872
|
documentLoader?: DocumentLoader;
|
1576
1873
|
contextLoader?: DocumentLoader;
|
1577
1874
|
suppressError?: boolean;
|
1578
|
-
}): Promise<
|
1579
|
-
/**
|
1580
|
-
* Similar to
|
1581
|
-
* {@link Activity.getResults},
|
1582
|
-
* but returns their `@id`s instead of the objects themselves.
|
1875
|
+
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1876
|
+
/** A PEM-encoded public key.
|
1583
1877
|
*/
|
1584
|
-
get
|
1585
|
-
/**
|
1586
|
-
*
|
1587
|
-
*
|
1878
|
+
get publicKey(): dntShim.CryptoKey | null;
|
1879
|
+
/**
|
1880
|
+
* Converts this object to a JSON-LD structure.
|
1881
|
+
* @param options The options to use.
|
1882
|
+
* - `format`: The format of the output: `compact` or
|
1883
|
+
`expand`.
|
1884
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1885
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1886
|
+
when `format` is set to `'expand'`.
|
1887
|
+
* @returns The JSON-LD representation of this object.
|
1588
1888
|
*/
|
1589
|
-
|
1590
|
-
|
1889
|
+
toJsonLd(options?: {
|
1890
|
+
format?: "compact" | "expand";
|
1591
1891
|
contextLoader?: DocumentLoader;
|
1592
|
-
|
1593
|
-
}):
|
1892
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1893
|
+
}): Promise<unknown>;
|
1894
|
+
protected isCompactable(): boolean;
|
1594
1895
|
/**
|
1595
|
-
*
|
1596
|
-
*
|
1597
|
-
*
|
1598
|
-
|
1599
|
-
get originId(): URL | null;
|
1600
|
-
/** Describes an indirect object of the activity from which the activity is
|
1601
|
-
* directed. The precise meaning of the origin is the object of the English
|
1602
|
-
* preposition "from". For instance, in the activity "John moved an item to
|
1603
|
-
* List B from List A", the origin of the activity is "List A".
|
1896
|
+
* Converts a JSON-LD structure to an object of this type.
|
1897
|
+
* @param json The JSON-LD structure to convert.
|
1898
|
+
* @returns The object of this type.
|
1899
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1604
1900
|
*/
|
1605
|
-
|
1901
|
+
static fromJsonLd(json: unknown, options?: {
|
1606
1902
|
documentLoader?: DocumentLoader;
|
1607
1903
|
contextLoader?: DocumentLoader;
|
1608
|
-
|
1609
|
-
|
1904
|
+
}): Promise<CryptographicKey>;
|
1905
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1906
|
+
}
|
1907
|
+
/** Represents a key owned by an actor according to [FEP-521a: Representing
|
1908
|
+
* actor's public keys.][1]
|
1909
|
+
*
|
1910
|
+
* [1]: https://w3id.org/fep/521a
|
1911
|
+
*/
|
1912
|
+
export declare class Multikey {
|
1913
|
+
#private;
|
1914
|
+
readonly id: URL | null;
|
1915
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1916
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1610
1917
|
/**
|
1611
|
-
*
|
1612
|
-
* {@link Activity.getOrigins},
|
1613
|
-
* but returns their `@id`s instead of the objects themselves.
|
1918
|
+
* The type URI of {@link Multikey}: `https://w3id.org/security#Multikey`.
|
1614
1919
|
*/
|
1615
|
-
get
|
1616
|
-
/**
|
1617
|
-
*
|
1618
|
-
*
|
1619
|
-
*
|
1920
|
+
static get typeId(): URL;
|
1921
|
+
/**
|
1922
|
+
* Constructs a new instance of Multikey with the given values.
|
1923
|
+
* @param values The values to initialize the instance with.
|
1924
|
+
* @param options The options to use for initialization.
|
1620
1925
|
*/
|
1621
|
-
|
1926
|
+
constructor(values: {
|
1927
|
+
id?: URL | null;
|
1928
|
+
controller?: Application | Group | Organization | Person | Service | URL | null;
|
1929
|
+
publicKey?: dntShim.CryptoKey | null;
|
1930
|
+
}, { documentLoader, contextLoader, }?: {
|
1622
1931
|
documentLoader?: DocumentLoader;
|
1623
1932
|
contextLoader?: DocumentLoader;
|
1624
|
-
|
1625
|
-
}): AsyncIterable<Object>;
|
1933
|
+
});
|
1626
1934
|
/**
|
1627
|
-
*
|
1628
|
-
*
|
1629
|
-
*
|
1630
|
-
|
1631
|
-
get instrumentId(): URL | null;
|
1632
|
-
/** Identifies one or more objects used (or to be used) in the completion of
|
1633
|
-
* an {@link Activity}.
|
1935
|
+
* Clones this instance, optionally updating it with the given values.
|
1936
|
+
* @param values The values to update the clone with.
|
1937
|
+
* @options The options to use for cloning.
|
1938
|
+
* @returns The cloned instance.
|
1634
1939
|
*/
|
1635
|
-
|
1940
|
+
clone(values?: {
|
1941
|
+
id?: URL | null;
|
1942
|
+
controller?: Application | Group | Organization | Person | Service | URL | null;
|
1943
|
+
publicKey?: dntShim.CryptoKey | null;
|
1944
|
+
}, options?: {
|
1636
1945
|
documentLoader?: DocumentLoader;
|
1637
1946
|
contextLoader?: DocumentLoader;
|
1638
|
-
|
1639
|
-
}): Promise<Object | null>;
|
1947
|
+
}): Multikey;
|
1640
1948
|
/**
|
1641
1949
|
* Similar to
|
1642
|
-
* {@link
|
1643
|
-
* but returns
|
1950
|
+
* {@link Multikey.getController},
|
1951
|
+
* but returns its `@id` URL instead of the object itself.
|
1644
1952
|
*/
|
1645
|
-
get
|
1646
|
-
/**
|
1647
|
-
* an {@link Activity}.
|
1953
|
+
get controllerId(): URL | null;
|
1954
|
+
/** An actor who owns this key.
|
1648
1955
|
*/
|
1649
|
-
|
1956
|
+
getController(options?: {
|
1650
1957
|
documentLoader?: DocumentLoader;
|
1651
1958
|
contextLoader?: DocumentLoader;
|
1652
1959
|
suppressError?: boolean;
|
1653
|
-
}):
|
1960
|
+
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1961
|
+
/** A [Multibase]-encoded value of a [Multicodec] prefix and the key.
|
1962
|
+
*
|
1963
|
+
* [Multibase]: https://www.w3.org/TR/vc-data-integrity/#multibase-0
|
1964
|
+
* [Multicodec]: https://github.com/multiformats/multicodec/
|
1965
|
+
*/
|
1966
|
+
get publicKey(): dntShim.CryptoKey | null;
|
1654
1967
|
/**
|
1655
1968
|
* Converts this object to a JSON-LD structure.
|
1656
1969
|
* @param options The options to use.
|
@@ -1676,7 +1989,7 @@ export declare class Activity extends Object {
|
|
1676
1989
|
static fromJsonLd(json: unknown, options?: {
|
1677
1990
|
documentLoader?: DocumentLoader;
|
1678
1991
|
contextLoader?: DocumentLoader;
|
1679
|
-
}): Promise<
|
1992
|
+
}): Promise<Multikey>;
|
1680
1993
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1681
1994
|
}
|
1682
1995
|
/** Indicates that the `actor` accepts the `object`. The `target` property can be
|
@@ -2287,6 +2600,8 @@ export declare class Application extends Object {
|
|
2287
2600
|
indexable?: boolean | null;
|
2288
2601
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
2289
2602
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
2603
|
+
service?: DidService | URL | null;
|
2604
|
+
services?: (DidService | URL)[];
|
2290
2605
|
cat?: boolean | null;
|
2291
2606
|
}, { documentLoader, contextLoader, }?: {
|
2292
2607
|
documentLoader?: DocumentLoader;
|
@@ -2367,6 +2682,8 @@ export declare class Application extends Object {
|
|
2367
2682
|
indexable?: boolean | null;
|
2368
2683
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
2369
2684
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
2685
|
+
service?: DidService | URL | null;
|
2686
|
+
services?: (DidService | URL)[];
|
2370
2687
|
cat?: boolean | null;
|
2371
2688
|
}, options?: {
|
2372
2689
|
documentLoader?: DocumentLoader;
|
@@ -2647,6 +2964,38 @@ export declare class Application extends Object {
|
|
2647
2964
|
contextLoader?: DocumentLoader;
|
2648
2965
|
suppressError?: boolean;
|
2649
2966
|
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
2967
|
+
/**
|
2968
|
+
* Similar to
|
2969
|
+
* {@link Application.getService},
|
2970
|
+
* but returns its `@id` URL instead of the object itself.
|
2971
|
+
*/
|
2972
|
+
get serviceId(): URL | null;
|
2973
|
+
/** Means of communicating or interacting with the DID subject or associated
|
2974
|
+
* entities via one or more service endpoints. Examples include discovery
|
2975
|
+
* services, agent services, social networking services, file storage services,
|
2976
|
+
* and verifiable credential repository services.
|
2977
|
+
*/
|
2978
|
+
getService(options?: {
|
2979
|
+
documentLoader?: DocumentLoader;
|
2980
|
+
contextLoader?: DocumentLoader;
|
2981
|
+
suppressError?: boolean;
|
2982
|
+
}): Promise<DidService | null>;
|
2983
|
+
/**
|
2984
|
+
* Similar to
|
2985
|
+
* {@link Application.getServices},
|
2986
|
+
* but returns their `@id`s instead of the objects themselves.
|
2987
|
+
*/
|
2988
|
+
get serviceIds(): URL[];
|
2989
|
+
/** Means of communicating or interacting with the DID subject or associated
|
2990
|
+
* entities via one or more service endpoints. Examples include discovery
|
2991
|
+
* services, agent services, social networking services, file storage services,
|
2992
|
+
* and verifiable credential repository services.
|
2993
|
+
*/
|
2994
|
+
getServices(options?: {
|
2995
|
+
documentLoader?: DocumentLoader;
|
2996
|
+
contextLoader?: DocumentLoader;
|
2997
|
+
suppressError?: boolean;
|
2998
|
+
}): AsyncIterable<DidService>;
|
2650
2999
|
/** Used on actors to indicate that they in some way identify as a cat,
|
2651
3000
|
* expressed as a boolean value. If this property is set to `true`,
|
2652
3001
|
* displaying the actor or their notes will have some special effects
|
@@ -5506,6 +5855,8 @@ export declare class Group extends Object {
|
|
5506
5855
|
indexable?: boolean | null;
|
5507
5856
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
5508
5857
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
5858
|
+
service?: DidService | URL | null;
|
5859
|
+
services?: (DidService | URL)[];
|
5509
5860
|
cat?: boolean | null;
|
5510
5861
|
}, { documentLoader, contextLoader, }?: {
|
5511
5862
|
documentLoader?: DocumentLoader;
|
@@ -5586,6 +5937,8 @@ export declare class Group extends Object {
|
|
5586
5937
|
indexable?: boolean | null;
|
5587
5938
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
5588
5939
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
5940
|
+
service?: DidService | URL | null;
|
5941
|
+
services?: (DidService | URL)[];
|
5589
5942
|
cat?: boolean | null;
|
5590
5943
|
}, options?: {
|
5591
5944
|
documentLoader?: DocumentLoader;
|
@@ -5866,6 +6219,38 @@ export declare class Group extends Object {
|
|
5866
6219
|
contextLoader?: DocumentLoader;
|
5867
6220
|
suppressError?: boolean;
|
5868
6221
|
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
6222
|
+
/**
|
6223
|
+
* Similar to
|
6224
|
+
* {@link Group.getService},
|
6225
|
+
* but returns its `@id` URL instead of the object itself.
|
6226
|
+
*/
|
6227
|
+
get serviceId(): URL | null;
|
6228
|
+
/** Means of communicating or interacting with the DID subject or associated
|
6229
|
+
* entities via one or more service endpoints. Examples include discovery
|
6230
|
+
* services, agent services, social networking services, file storage services,
|
6231
|
+
* and verifiable credential repository services.
|
6232
|
+
*/
|
6233
|
+
getService(options?: {
|
6234
|
+
documentLoader?: DocumentLoader;
|
6235
|
+
contextLoader?: DocumentLoader;
|
6236
|
+
suppressError?: boolean;
|
6237
|
+
}): Promise<DidService | null>;
|
6238
|
+
/**
|
6239
|
+
* Similar to
|
6240
|
+
* {@link Group.getServices},
|
6241
|
+
* but returns their `@id`s instead of the objects themselves.
|
6242
|
+
*/
|
6243
|
+
get serviceIds(): URL[];
|
6244
|
+
/** Means of communicating or interacting with the DID subject or associated
|
6245
|
+
* entities via one or more service endpoints. Examples include discovery
|
6246
|
+
* services, agent services, social networking services, file storage services,
|
6247
|
+
* and verifiable credential repository services.
|
6248
|
+
*/
|
6249
|
+
getServices(options?: {
|
6250
|
+
documentLoader?: DocumentLoader;
|
6251
|
+
contextLoader?: DocumentLoader;
|
6252
|
+
suppressError?: boolean;
|
6253
|
+
}): AsyncIterable<DidService>;
|
5869
6254
|
/** Used on actors to indicate that they in some way identify as a cat,
|
5870
6255
|
* expressed as a boolean value. If this property is set to `true`,
|
5871
6256
|
* displaying the actor or their notes will have some special effects
|
@@ -8186,6 +8571,8 @@ export declare class Organization extends Object {
|
|
8186
8571
|
indexable?: boolean | null;
|
8187
8572
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
8188
8573
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
8574
|
+
service?: DidService | URL | null;
|
8575
|
+
services?: (DidService | URL)[];
|
8189
8576
|
cat?: boolean | null;
|
8190
8577
|
}, { documentLoader, contextLoader, }?: {
|
8191
8578
|
documentLoader?: DocumentLoader;
|
@@ -8266,6 +8653,8 @@ export declare class Organization extends Object {
|
|
8266
8653
|
indexable?: boolean | null;
|
8267
8654
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
8268
8655
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
8656
|
+
service?: DidService | URL | null;
|
8657
|
+
services?: (DidService | URL)[];
|
8269
8658
|
cat?: boolean | null;
|
8270
8659
|
}, options?: {
|
8271
8660
|
documentLoader?: DocumentLoader;
|
@@ -8546,6 +8935,38 @@ export declare class Organization extends Object {
|
|
8546
8935
|
contextLoader?: DocumentLoader;
|
8547
8936
|
suppressError?: boolean;
|
8548
8937
|
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
8938
|
+
/**
|
8939
|
+
* Similar to
|
8940
|
+
* {@link Organization.getService},
|
8941
|
+
* but returns its `@id` URL instead of the object itself.
|
8942
|
+
*/
|
8943
|
+
get serviceId(): URL | null;
|
8944
|
+
/** Means of communicating or interacting with the DID subject or associated
|
8945
|
+
* entities via one or more service endpoints. Examples include discovery
|
8946
|
+
* services, agent services, social networking services, file storage services,
|
8947
|
+
* and verifiable credential repository services.
|
8948
|
+
*/
|
8949
|
+
getService(options?: {
|
8950
|
+
documentLoader?: DocumentLoader;
|
8951
|
+
contextLoader?: DocumentLoader;
|
8952
|
+
suppressError?: boolean;
|
8953
|
+
}): Promise<DidService | null>;
|
8954
|
+
/**
|
8955
|
+
* Similar to
|
8956
|
+
* {@link Organization.getServices},
|
8957
|
+
* but returns their `@id`s instead of the objects themselves.
|
8958
|
+
*/
|
8959
|
+
get serviceIds(): URL[];
|
8960
|
+
/** Means of communicating or interacting with the DID subject or associated
|
8961
|
+
* entities via one or more service endpoints. Examples include discovery
|
8962
|
+
* services, agent services, social networking services, file storage services,
|
8963
|
+
* and verifiable credential repository services.
|
8964
|
+
*/
|
8965
|
+
getServices(options?: {
|
8966
|
+
documentLoader?: DocumentLoader;
|
8967
|
+
contextLoader?: DocumentLoader;
|
8968
|
+
suppressError?: boolean;
|
8969
|
+
}): AsyncIterable<DidService>;
|
8549
8970
|
/** Used on actors to indicate that they in some way identify as a cat,
|
8550
8971
|
* expressed as a boolean value. If this property is set to `true`,
|
8551
8972
|
* displaying the actor or their notes will have some special effects
|
@@ -8815,6 +9236,8 @@ export declare class Person extends Object {
|
|
8815
9236
|
indexable?: boolean | null;
|
8816
9237
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
8817
9238
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
9239
|
+
service?: DidService | URL | null;
|
9240
|
+
services?: (DidService | URL)[];
|
8818
9241
|
cat?: boolean | null;
|
8819
9242
|
}, { documentLoader, contextLoader, }?: {
|
8820
9243
|
documentLoader?: DocumentLoader;
|
@@ -8895,6 +9318,8 @@ export declare class Person extends Object {
|
|
8895
9318
|
indexable?: boolean | null;
|
8896
9319
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
8897
9320
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
9321
|
+
service?: DidService | URL | null;
|
9322
|
+
services?: (DidService | URL)[];
|
8898
9323
|
cat?: boolean | null;
|
8899
9324
|
}, options?: {
|
8900
9325
|
documentLoader?: DocumentLoader;
|
@@ -9175,6 +9600,38 @@ export declare class Person extends Object {
|
|
9175
9600
|
contextLoader?: DocumentLoader;
|
9176
9601
|
suppressError?: boolean;
|
9177
9602
|
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
9603
|
+
/**
|
9604
|
+
* Similar to
|
9605
|
+
* {@link Person.getService},
|
9606
|
+
* but returns its `@id` URL instead of the object itself.
|
9607
|
+
*/
|
9608
|
+
get serviceId(): URL | null;
|
9609
|
+
/** Means of communicating or interacting with the DID subject or associated
|
9610
|
+
* entities via one or more service endpoints. Examples include discovery
|
9611
|
+
* services, agent services, social networking services, file storage services,
|
9612
|
+
* and verifiable credential repository services.
|
9613
|
+
*/
|
9614
|
+
getService(options?: {
|
9615
|
+
documentLoader?: DocumentLoader;
|
9616
|
+
contextLoader?: DocumentLoader;
|
9617
|
+
suppressError?: boolean;
|
9618
|
+
}): Promise<DidService | null>;
|
9619
|
+
/**
|
9620
|
+
* Similar to
|
9621
|
+
* {@link Person.getServices},
|
9622
|
+
* but returns their `@id`s instead of the objects themselves.
|
9623
|
+
*/
|
9624
|
+
get serviceIds(): URL[];
|
9625
|
+
/** Means of communicating or interacting with the DID subject or associated
|
9626
|
+
* entities via one or more service endpoints. Examples include discovery
|
9627
|
+
* services, agent services, social networking services, file storage services,
|
9628
|
+
* and verifiable credential repository services.
|
9629
|
+
*/
|
9630
|
+
getServices(options?: {
|
9631
|
+
documentLoader?: DocumentLoader;
|
9632
|
+
contextLoader?: DocumentLoader;
|
9633
|
+
suppressError?: boolean;
|
9634
|
+
}): AsyncIterable<DidService>;
|
9178
9635
|
/** Used on actors to indicate that they in some way identify as a cat,
|
9179
9636
|
* expressed as a boolean value. If this property is set to `true`,
|
9180
9637
|
* displaying the actor or their notes will have some special effects
|
@@ -10647,6 +11104,8 @@ export declare class Service extends Object {
|
|
10647
11104
|
indexable?: boolean | null;
|
10648
11105
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
10649
11106
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
11107
|
+
service?: DidService | URL | null;
|
11108
|
+
services?: (DidService | URL)[];
|
10650
11109
|
cat?: boolean | null;
|
10651
11110
|
}, { documentLoader, contextLoader, }?: {
|
10652
11111
|
documentLoader?: DocumentLoader;
|
@@ -10727,6 +11186,8 @@ export declare class Service extends Object {
|
|
10727
11186
|
indexable?: boolean | null;
|
10728
11187
|
alias?: Application | Group | Organization | Person | Service | URL | null;
|
10729
11188
|
aliases?: (Application | Group | Organization | Person | Service | URL)[];
|
11189
|
+
service?: DidService | URL | null;
|
11190
|
+
services?: (DidService | URL)[];
|
10730
11191
|
cat?: boolean | null;
|
10731
11192
|
}, options?: {
|
10732
11193
|
documentLoader?: DocumentLoader;
|
@@ -11007,6 +11468,38 @@ export declare class Service extends Object {
|
|
11007
11468
|
contextLoader?: DocumentLoader;
|
11008
11469
|
suppressError?: boolean;
|
11009
11470
|
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
11471
|
+
/**
|
11472
|
+
* Similar to
|
11473
|
+
* {@link Service.getService},
|
11474
|
+
* but returns its `@id` URL instead of the object itself.
|
11475
|
+
*/
|
11476
|
+
get serviceId(): URL | null;
|
11477
|
+
/** Means of communicating or interacting with the DID subject or associated
|
11478
|
+
* entities via one or more service endpoints. Examples include discovery
|
11479
|
+
* services, agent services, social networking services, file storage services,
|
11480
|
+
* and verifiable credential repository services.
|
11481
|
+
*/
|
11482
|
+
getService(options?: {
|
11483
|
+
documentLoader?: DocumentLoader;
|
11484
|
+
contextLoader?: DocumentLoader;
|
11485
|
+
suppressError?: boolean;
|
11486
|
+
}): Promise<DidService | null>;
|
11487
|
+
/**
|
11488
|
+
* Similar to
|
11489
|
+
* {@link Service.getServices},
|
11490
|
+
* but returns their `@id`s instead of the objects themselves.
|
11491
|
+
*/
|
11492
|
+
get serviceIds(): URL[];
|
11493
|
+
/** Means of communicating or interacting with the DID subject or associated
|
11494
|
+
* entities via one or more service endpoints. Examples include discovery
|
11495
|
+
* services, agent services, social networking services, file storage services,
|
11496
|
+
* and verifiable credential repository services.
|
11497
|
+
*/
|
11498
|
+
getServices(options?: {
|
11499
|
+
documentLoader?: DocumentLoader;
|
11500
|
+
contextLoader?: DocumentLoader;
|
11501
|
+
suppressError?: boolean;
|
11502
|
+
}): AsyncIterable<DidService>;
|
11010
11503
|
/** Used on actors to indicate that they in some way identify as a cat,
|
11011
11504
|
* expressed as a boolean value. If this property is set to `true`,
|
11012
11505
|
* displaying the actor or their notes will have some special effects
|