@fedify/fedify 1.1.0-dev.427 → 1.1.0-dev.428
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGES.md +4 -0
- package/FEDERATION.md +2 -0
- package/esm/vocab/dislike.yaml +2 -0
- package/esm/vocab/emojireact.yaml +17 -0
- package/esm/vocab/like.yaml +2 -0
- package/esm/vocab/vocab.js +2761 -2578
- package/package.json +1 -1
- package/types/vocab/vocab.d.ts +537 -364
- package/types/vocab/vocab.d.ts.map +1 -1
package/types/vocab/vocab.d.ts
CHANGED
@@ -967,26 +967,82 @@ 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.
|
971
975
|
*/
|
972
|
-
export declare class
|
976
|
+
export declare class Activity extends Object {
|
973
977
|
#private;
|
974
|
-
readonly id: URL | null;
|
975
|
-
protected get _documentLoader(): DocumentLoader | undefined;
|
976
|
-
protected get _contextLoader(): DocumentLoader | undefined;
|
977
978
|
/**
|
978
|
-
* The type URI of {@link
|
979
|
+
* The type URI of {@link Activity}: `https://www.w3.org/ns/activitystreams#Activity`.
|
979
980
|
*/
|
980
981
|
static get typeId(): URL;
|
981
982
|
/**
|
982
|
-
* Constructs a new instance of
|
983
|
+
* Constructs a new instance of Activity with the given values.
|
983
984
|
* @param values The values to initialize the instance with.
|
984
985
|
* @param options The options to use for initialization.
|
985
986
|
*/
|
986
987
|
constructor(values: {
|
987
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)[];
|
988
997
|
name?: string | LanguageString | null;
|
989
|
-
|
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)[];
|
990
1046
|
}, { documentLoader, contextLoader, }?: {
|
991
1047
|
documentLoader?: DocumentLoader;
|
992
1048
|
contextLoader?: DocumentLoader;
|
@@ -999,295 +1055,253 @@ export declare class PropertyValue {
|
|
999
1055
|
*/
|
1000
1056
|
clone(values?: {
|
1001
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)[];
|
1002
1066
|
name?: string | LanguageString | null;
|
1003
|
-
|
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)[];
|
1004
1115
|
}, options?: {
|
1005
1116
|
documentLoader?: DocumentLoader;
|
1006
1117
|
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;
|
1118
|
+
}): Activity;
|
1014
1119
|
/**
|
1015
|
-
*
|
1016
|
-
* @
|
1017
|
-
*
|
1018
|
-
`expand`.
|
1019
|
-
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1020
|
-
* - `context`: The JSON-LD context to use. Not applicable
|
1021
|
-
when `format` is set to `'expand'`.
|
1022
|
-
* @returns The JSON-LD representation of this object.
|
1120
|
+
* Similar to
|
1121
|
+
* {@link Activity.getActor},
|
1122
|
+
* but returns its `@id` URL instead of the object itself.
|
1023
1123
|
*/
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
}): Promise<unknown>;
|
1029
|
-
protected isCompactable(): boolean;
|
1030
|
-
/**
|
1031
|
-
* Converts a JSON-LD structure to an object of this type.
|
1032
|
-
* @param json The JSON-LD structure to convert.
|
1033
|
-
* @returns The object of this type.
|
1034
|
-
* @throws {TypeError} If the given `json` is invalid.
|
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}.
|
1035
1128
|
*/
|
1036
|
-
|
1129
|
+
getActor(options?: {
|
1037
1130
|
documentLoader?: DocumentLoader;
|
1038
1131
|
contextLoader?: DocumentLoader;
|
1039
|
-
|
1040
|
-
|
1041
|
-
}
|
1042
|
-
/** A proof that can be added to any activity or object, allowing recipients to
|
1043
|
-
* verify the identity of the actor and the integrity of the data.
|
1044
|
-
*/
|
1045
|
-
export declare class DataIntegrityProof {
|
1046
|
-
#private;
|
1047
|
-
readonly id: URL | null;
|
1048
|
-
protected get _documentLoader(): DocumentLoader | undefined;
|
1049
|
-
protected get _contextLoader(): DocumentLoader | undefined;
|
1050
|
-
/**
|
1051
|
-
* The type URI of {@link DataIntegrityProof}: `https://w3id.org/security#DataIntegrityProof`.
|
1052
|
-
*/
|
1053
|
-
static get typeId(): URL;
|
1132
|
+
suppressError?: boolean;
|
1133
|
+
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1054
1134
|
/**
|
1055
|
-
*
|
1056
|
-
* @
|
1057
|
-
*
|
1135
|
+
* Similar to
|
1136
|
+
* {@link Activity.getActors},
|
1137
|
+
* but returns their `@id`s instead of the objects themselves.
|
1058
1138
|
*/
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1064
|
-
proofValue?: Uint8Array | null;
|
1065
|
-
created?: dntShim.Temporal.Instant | null;
|
1066
|
-
}, { documentLoader, contextLoader, }?: {
|
1067
|
-
documentLoader?: DocumentLoader;
|
1068
|
-
contextLoader?: DocumentLoader;
|
1069
|
-
});
|
1070
|
-
/**
|
1071
|
-
* Clones this instance, optionally updating it with the given values.
|
1072
|
-
* @param values The values to update the clone with.
|
1073
|
-
* @options The options to use for cloning.
|
1074
|
-
* @returns The cloned instance.
|
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}.
|
1075
1143
|
*/
|
1076
|
-
|
1077
|
-
id?: URL | null;
|
1078
|
-
cryptosuite?: "eddsa-jcs-2022" | null;
|
1079
|
-
verificationMethod?: Multikey | URL | null;
|
1080
|
-
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1081
|
-
proofValue?: Uint8Array | null;
|
1082
|
-
created?: dntShim.Temporal.Instant | null;
|
1083
|
-
}, options?: {
|
1144
|
+
getActors(options?: {
|
1084
1145
|
documentLoader?: DocumentLoader;
|
1085
1146
|
contextLoader?: DocumentLoader;
|
1086
|
-
|
1087
|
-
|
1088
|
-
*/
|
1089
|
-
get cryptosuite(): "eddsa-jcs-2022" | null;
|
1147
|
+
suppressError?: boolean;
|
1148
|
+
}): AsyncIterable<Application | Group | Organization | Person | Service>;
|
1090
1149
|
/**
|
1091
1150
|
* Similar to
|
1092
|
-
* {@link
|
1151
|
+
* {@link Activity.getObject},
|
1093
1152
|
* but returns its `@id` URL instead of the object itself.
|
1094
1153
|
*/
|
1095
|
-
get
|
1096
|
-
/**
|
1097
|
-
*
|
1098
|
-
*
|
1099
|
-
* [1]: https://w3id.org/fep/521a
|
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.
|
1100
1158
|
*/
|
1101
|
-
|
1159
|
+
getObject(options?: {
|
1102
1160
|
documentLoader?: DocumentLoader;
|
1103
1161
|
contextLoader?: DocumentLoader;
|
1104
1162
|
suppressError?: boolean;
|
1105
|
-
}): Promise<
|
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.
|
1116
|
-
*/
|
1117
|
-
get proofValue(): Uint8Array | null;
|
1118
|
-
/** The date and time the proof was created.
|
1119
|
-
*/
|
1120
|
-
get created(): dntShim.Temporal.Instant | null;
|
1163
|
+
}): Promise<Object | null>;
|
1121
1164
|
/**
|
1122
|
-
*
|
1123
|
-
* @
|
1124
|
-
*
|
1125
|
-
`expand`.
|
1126
|
-
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1127
|
-
* - `context`: The JSON-LD context to use. Not applicable
|
1128
|
-
when `format` is set to `'expand'`.
|
1129
|
-
* @returns The JSON-LD representation of this object.
|
1165
|
+
* Similar to
|
1166
|
+
* {@link Activity.getObjects},
|
1167
|
+
* but returns their `@id`s instead of the objects themselves.
|
1130
1168
|
*/
|
1131
|
-
|
1132
|
-
|
1133
|
-
|
1134
|
-
|
1135
|
-
}): Promise<unknown>;
|
1136
|
-
protected isCompactable(): boolean;
|
1137
|
-
/**
|
1138
|
-
* Converts a JSON-LD structure to an object of this type.
|
1139
|
-
* @param json The JSON-LD structure to convert.
|
1140
|
-
* @returns The object of this type.
|
1141
|
-
* @throws {TypeError} If the given `json` is invalid.
|
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.
|
1142
1173
|
*/
|
1143
|
-
|
1174
|
+
getObjects(options?: {
|
1144
1175
|
documentLoader?: DocumentLoader;
|
1145
1176
|
contextLoader?: DocumentLoader;
|
1146
|
-
|
1147
|
-
|
1148
|
-
}
|
1149
|
-
/** A key owned by an actor.
|
1150
|
-
*/
|
1151
|
-
export declare class CryptographicKey {
|
1152
|
-
#private;
|
1153
|
-
readonly id: URL | null;
|
1154
|
-
protected get _documentLoader(): DocumentLoader | undefined;
|
1155
|
-
protected get _contextLoader(): DocumentLoader | undefined;
|
1177
|
+
suppressError?: boolean;
|
1178
|
+
}): AsyncIterable<Object>;
|
1156
1179
|
/**
|
1157
|
-
*
|
1180
|
+
* Similar to
|
1181
|
+
* {@link Activity.getTarget},
|
1182
|
+
* but returns its `@id` URL instead of the object itself.
|
1158
1183
|
*/
|
1159
|
-
|
1160
|
-
/**
|
1161
|
-
*
|
1162
|
-
*
|
1163
|
-
*
|
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.
|
1164
1191
|
*/
|
1165
|
-
|
1166
|
-
id?: URL | null;
|
1167
|
-
owner?: Application | Group | Organization | Person | Service | URL | null;
|
1168
|
-
publicKey?: dntShim.CryptoKey | null;
|
1169
|
-
}, { documentLoader, contextLoader, }?: {
|
1192
|
+
getTarget(options?: {
|
1170
1193
|
documentLoader?: DocumentLoader;
|
1171
1194
|
contextLoader?: DocumentLoader;
|
1172
|
-
|
1195
|
+
suppressError?: boolean;
|
1196
|
+
}): Promise<Object | null>;
|
1173
1197
|
/**
|
1174
|
-
*
|
1175
|
-
* @
|
1176
|
-
*
|
1177
|
-
* @returns The cloned instance.
|
1198
|
+
* Similar to
|
1199
|
+
* {@link Activity.getTargets},
|
1200
|
+
* but returns their `@id`s instead of the objects themselves.
|
1178
1201
|
*/
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
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?: {
|
1184
1211
|
documentLoader?: DocumentLoader;
|
1185
1212
|
contextLoader?: DocumentLoader;
|
1186
|
-
|
1213
|
+
suppressError?: boolean;
|
1214
|
+
}): AsyncIterable<Object>;
|
1187
1215
|
/**
|
1188
1216
|
* Similar to
|
1189
|
-
* {@link
|
1217
|
+
* {@link Activity.getResult},
|
1190
1218
|
* but returns its `@id` URL instead of the object itself.
|
1191
1219
|
*/
|
1192
|
-
get
|
1193
|
-
/**
|
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.
|
1194
1224
|
*/
|
1195
|
-
|
1225
|
+
getResult(options?: {
|
1196
1226
|
documentLoader?: DocumentLoader;
|
1197
1227
|
contextLoader?: DocumentLoader;
|
1198
1228
|
suppressError?: boolean;
|
1199
|
-
}): Promise<
|
1200
|
-
/** A PEM-encoded public key.
|
1201
|
-
*/
|
1202
|
-
get publicKey(): dntShim.CryptoKey | null;
|
1229
|
+
}): Promise<Object | null>;
|
1203
1230
|
/**
|
1204
|
-
*
|
1205
|
-
* @
|
1206
|
-
*
|
1207
|
-
`expand`.
|
1208
|
-
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1209
|
-
* - `context`: The JSON-LD context to use. Not applicable
|
1210
|
-
when `format` is set to `'expand'`.
|
1211
|
-
* @returns The JSON-LD representation of this object.
|
1231
|
+
* Similar to
|
1232
|
+
* {@link Activity.getResults},
|
1233
|
+
* but returns their `@id`s instead of the objects themselves.
|
1212
1234
|
*/
|
1213
|
-
|
1214
|
-
|
1215
|
-
|
1216
|
-
|
1217
|
-
}): Promise<unknown>;
|
1218
|
-
protected isCompactable(): boolean;
|
1219
|
-
/**
|
1220
|
-
* Converts a JSON-LD structure to an object of this type.
|
1221
|
-
* @param json The JSON-LD structure to convert.
|
1222
|
-
* @returns The object of this type.
|
1223
|
-
* @throws {TypeError} If the given `json` is invalid.
|
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.
|
1224
1239
|
*/
|
1225
|
-
|
1240
|
+
getResults(options?: {
|
1226
1241
|
documentLoader?: DocumentLoader;
|
1227
1242
|
contextLoader?: DocumentLoader;
|
1228
|
-
|
1229
|
-
|
1230
|
-
}
|
1231
|
-
/** Represents a key owned by an actor according to [FEP-521a: Representing
|
1232
|
-
* actor's public keys.][1]
|
1233
|
-
*
|
1234
|
-
* [1]: https://w3id.org/fep/521a
|
1235
|
-
*/
|
1236
|
-
export declare class Multikey {
|
1237
|
-
#private;
|
1238
|
-
readonly id: URL | null;
|
1239
|
-
protected get _documentLoader(): DocumentLoader | undefined;
|
1240
|
-
protected get _contextLoader(): DocumentLoader | undefined;
|
1243
|
+
suppressError?: boolean;
|
1244
|
+
}): AsyncIterable<Object>;
|
1241
1245
|
/**
|
1242
|
-
*
|
1246
|
+
* Similar to
|
1247
|
+
* {@link Activity.getOrigin},
|
1248
|
+
* but returns its `@id` URL instead of the object itself.
|
1243
1249
|
*/
|
1244
|
-
|
1245
|
-
/**
|
1246
|
-
*
|
1247
|
-
*
|
1248
|
-
*
|
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".
|
1249
1255
|
*/
|
1250
|
-
|
1251
|
-
id?: URL | null;
|
1252
|
-
controller?: Application | Group | Organization | Person | Service | URL | null;
|
1253
|
-
publicKey?: dntShim.CryptoKey | null;
|
1254
|
-
}, { documentLoader, contextLoader, }?: {
|
1256
|
+
getOrigin(options?: {
|
1255
1257
|
documentLoader?: DocumentLoader;
|
1256
1258
|
contextLoader?: DocumentLoader;
|
1257
|
-
|
1259
|
+
suppressError?: boolean;
|
1260
|
+
}): Promise<Object | null>;
|
1258
1261
|
/**
|
1259
|
-
*
|
1260
|
-
* @
|
1261
|
-
*
|
1262
|
-
* @returns The cloned instance.
|
1262
|
+
* Similar to
|
1263
|
+
* {@link Activity.getOrigins},
|
1264
|
+
* but returns their `@id`s instead of the objects themselves.
|
1263
1265
|
*/
|
1264
|
-
|
1265
|
-
|
1266
|
-
|
1267
|
-
|
1268
|
-
|
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?: {
|
1269
1273
|
documentLoader?: DocumentLoader;
|
1270
1274
|
contextLoader?: DocumentLoader;
|
1271
|
-
|
1275
|
+
suppressError?: boolean;
|
1276
|
+
}): AsyncIterable<Object>;
|
1272
1277
|
/**
|
1273
1278
|
* Similar to
|
1274
|
-
* {@link
|
1279
|
+
* {@link Activity.getInstrument},
|
1275
1280
|
* but returns its `@id` URL instead of the object itself.
|
1276
1281
|
*/
|
1277
|
-
get
|
1278
|
-
/**
|
1282
|
+
get instrumentId(): URL | null;
|
1283
|
+
/** Identifies one or more objects used (or to be used) in the completion of
|
1284
|
+
* an {@link Activity}.
|
1279
1285
|
*/
|
1280
|
-
|
1286
|
+
getInstrument(options?: {
|
1281
1287
|
documentLoader?: DocumentLoader;
|
1282
1288
|
contextLoader?: DocumentLoader;
|
1283
1289
|
suppressError?: boolean;
|
1284
|
-
}): Promise<
|
1285
|
-
/**
|
1286
|
-
*
|
1287
|
-
*
|
1288
|
-
*
|
1290
|
+
}): Promise<Object | null>;
|
1291
|
+
/**
|
1292
|
+
* Similar to
|
1293
|
+
* {@link Activity.getInstruments},
|
1294
|
+
* but returns their `@id`s instead of the objects themselves.
|
1289
1295
|
*/
|
1290
|
-
get
|
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>;
|
1291
1305
|
/**
|
1292
1306
|
* Converts this object to a JSON-LD structure.
|
1293
1307
|
* @param options The options to use.
|
@@ -1313,23 +1327,19 @@ export declare class Multikey {
|
|
1313
1327
|
static fromJsonLd(json: unknown, options?: {
|
1314
1328
|
documentLoader?: DocumentLoader;
|
1315
1329
|
contextLoader?: DocumentLoader;
|
1316
|
-
}): Promise<
|
1330
|
+
}): Promise<Activity>;
|
1317
1331
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1318
1332
|
}
|
1319
|
-
/**
|
1320
|
-
* that may happen, is currently happening, or has already happened.
|
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.
|
1333
|
+
/** Represents an emoji reaction. See also [FEP-c0e0](https://w3id.org/fep/c0e0).
|
1324
1334
|
*/
|
1325
|
-
export declare class
|
1335
|
+
export declare class EmojiReact extends Activity {
|
1326
1336
|
#private;
|
1327
1337
|
/**
|
1328
|
-
* The type URI of {@link
|
1338
|
+
* The type URI of {@link EmojiReact}: `http://litepub.social/ns#EmojiReact`.
|
1329
1339
|
*/
|
1330
1340
|
static get typeId(): URL;
|
1331
1341
|
/**
|
1332
|
-
* Constructs a new instance of
|
1342
|
+
* Constructs a new instance of EmojiReact with the given values.
|
1333
1343
|
* @param values The values to initialize the instance with.
|
1334
1344
|
* @param options The options to use for initialization.
|
1335
1345
|
*/
|
@@ -1464,193 +1474,356 @@ export declare class Activity extends Object {
|
|
1464
1474
|
}, options?: {
|
1465
1475
|
documentLoader?: DocumentLoader;
|
1466
1476
|
contextLoader?: DocumentLoader;
|
1467
|
-
}):
|
1477
|
+
}): EmojiReact;
|
1468
1478
|
/**
|
1469
|
-
*
|
1470
|
-
*
|
1471
|
-
*
|
1479
|
+
* Converts this object to a JSON-LD structure.
|
1480
|
+
* @param options The options to use.
|
1481
|
+
* - `format`: The format of the output: `compact` or
|
1482
|
+
`expand`.
|
1483
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1484
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1485
|
+
when `format` is set to `'expand'`.
|
1486
|
+
* @returns The JSON-LD representation of this object.
|
1472
1487
|
*/
|
1473
|
-
|
1474
|
-
|
1475
|
-
|
1476
|
-
|
1488
|
+
toJsonLd(options?: {
|
1489
|
+
format?: "compact" | "expand";
|
1490
|
+
contextLoader?: DocumentLoader;
|
1491
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1492
|
+
}): Promise<unknown>;
|
1493
|
+
protected isCompactable(): boolean;
|
1494
|
+
/**
|
1495
|
+
* Converts a JSON-LD structure to an object of this type.
|
1496
|
+
* @param json The JSON-LD structure to convert.
|
1497
|
+
* @returns The object of this type.
|
1498
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1477
1499
|
*/
|
1478
|
-
|
1500
|
+
static fromJsonLd(json: unknown, options?: {
|
1479
1501
|
documentLoader?: DocumentLoader;
|
1480
1502
|
contextLoader?: DocumentLoader;
|
1481
|
-
|
1482
|
-
|
1503
|
+
}): Promise<EmojiReact>;
|
1504
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1505
|
+
}
|
1506
|
+
/** A pair of property name and value.
|
1507
|
+
*/
|
1508
|
+
export declare class PropertyValue {
|
1509
|
+
#private;
|
1510
|
+
readonly id: URL | null;
|
1511
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1512
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1483
1513
|
/**
|
1484
|
-
*
|
1485
|
-
* {@link Activity.getActors},
|
1486
|
-
* but returns their `@id`s instead of the objects themselves.
|
1514
|
+
* The type URI of {@link PropertyValue}: `http://schema.org#PropertyValue`.
|
1487
1515
|
*/
|
1488
|
-
get
|
1489
|
-
/**
|
1490
|
-
*
|
1491
|
-
*
|
1516
|
+
static get typeId(): URL;
|
1517
|
+
/**
|
1518
|
+
* Constructs a new instance of PropertyValue with the given values.
|
1519
|
+
* @param values The values to initialize the instance with.
|
1520
|
+
* @param options The options to use for initialization.
|
1492
1521
|
*/
|
1493
|
-
|
1522
|
+
constructor(values: {
|
1523
|
+
id?: URL | null;
|
1524
|
+
name?: string | LanguageString | null;
|
1525
|
+
value?: string | LanguageString | null;
|
1526
|
+
}, { documentLoader, contextLoader, }?: {
|
1494
1527
|
documentLoader?: DocumentLoader;
|
1495
1528
|
contextLoader?: DocumentLoader;
|
1496
|
-
|
1497
|
-
|
1529
|
+
});
|
1530
|
+
/**
|
1531
|
+
* Clones this instance, optionally updating it with the given values.
|
1532
|
+
* @param values The values to update the clone with.
|
1533
|
+
* @options The options to use for cloning.
|
1534
|
+
* @returns The cloned instance.
|
1535
|
+
*/
|
1536
|
+
clone(values?: {
|
1537
|
+
id?: URL | null;
|
1538
|
+
name?: string | LanguageString | null;
|
1539
|
+
value?: string | LanguageString | null;
|
1540
|
+
}, options?: {
|
1541
|
+
documentLoader?: DocumentLoader;
|
1542
|
+
contextLoader?: DocumentLoader;
|
1543
|
+
}): PropertyValue;
|
1544
|
+
/** The name of a property.
|
1545
|
+
*/
|
1546
|
+
get name(): string | LanguageString | null;
|
1547
|
+
/** The value of a property.
|
1548
|
+
*/
|
1549
|
+
get value(): string | LanguageString | null;
|
1550
|
+
/**
|
1551
|
+
* Converts this object to a JSON-LD structure.
|
1552
|
+
* @param options The options to use.
|
1553
|
+
* - `format`: The format of the output: `compact` or
|
1554
|
+
`expand`.
|
1555
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1556
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1557
|
+
when `format` is set to `'expand'`.
|
1558
|
+
* @returns The JSON-LD representation of this object.
|
1559
|
+
*/
|
1560
|
+
toJsonLd(options?: {
|
1561
|
+
format?: "compact" | "expand";
|
1562
|
+
contextLoader?: DocumentLoader;
|
1563
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1564
|
+
}): Promise<unknown>;
|
1565
|
+
protected isCompactable(): boolean;
|
1566
|
+
/**
|
1567
|
+
* Converts a JSON-LD structure to an object of this type.
|
1568
|
+
* @param json The JSON-LD structure to convert.
|
1569
|
+
* @returns The object of this type.
|
1570
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1571
|
+
*/
|
1572
|
+
static fromJsonLd(json: unknown, options?: {
|
1573
|
+
documentLoader?: DocumentLoader;
|
1574
|
+
contextLoader?: DocumentLoader;
|
1575
|
+
}): Promise<PropertyValue>;
|
1576
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1577
|
+
}
|
1578
|
+
/** A proof that can be added to any activity or object, allowing recipients to
|
1579
|
+
* verify the identity of the actor and the integrity of the data.
|
1580
|
+
*/
|
1581
|
+
export declare class DataIntegrityProof {
|
1582
|
+
#private;
|
1583
|
+
readonly id: URL | null;
|
1584
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1585
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1586
|
+
/**
|
1587
|
+
* The type URI of {@link DataIntegrityProof}: `https://w3id.org/security#DataIntegrityProof`.
|
1588
|
+
*/
|
1589
|
+
static get typeId(): URL;
|
1590
|
+
/**
|
1591
|
+
* Constructs a new instance of DataIntegrityProof with the given values.
|
1592
|
+
* @param values The values to initialize the instance with.
|
1593
|
+
* @param options The options to use for initialization.
|
1594
|
+
*/
|
1595
|
+
constructor(values: {
|
1596
|
+
id?: URL | null;
|
1597
|
+
cryptosuite?: "eddsa-jcs-2022" | null;
|
1598
|
+
verificationMethod?: Multikey | URL | null;
|
1599
|
+
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1600
|
+
proofValue?: Uint8Array | null;
|
1601
|
+
created?: dntShim.Temporal.Instant | null;
|
1602
|
+
}, { documentLoader, contextLoader, }?: {
|
1603
|
+
documentLoader?: DocumentLoader;
|
1604
|
+
contextLoader?: DocumentLoader;
|
1605
|
+
});
|
1606
|
+
/**
|
1607
|
+
* Clones this instance, optionally updating it with the given values.
|
1608
|
+
* @param values The values to update the clone with.
|
1609
|
+
* @options The options to use for cloning.
|
1610
|
+
* @returns The cloned instance.
|
1611
|
+
*/
|
1612
|
+
clone(values?: {
|
1613
|
+
id?: URL | null;
|
1614
|
+
cryptosuite?: "eddsa-jcs-2022" | null;
|
1615
|
+
verificationMethod?: Multikey | URL | null;
|
1616
|
+
proofPurpose?: "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1617
|
+
proofValue?: Uint8Array | null;
|
1618
|
+
created?: dntShim.Temporal.Instant | null;
|
1619
|
+
}, options?: {
|
1620
|
+
documentLoader?: DocumentLoader;
|
1621
|
+
contextLoader?: DocumentLoader;
|
1622
|
+
}): DataIntegrityProof;
|
1623
|
+
/** The cryptographic suite used to create the proof.
|
1624
|
+
*/
|
1625
|
+
get cryptosuite(): "eddsa-jcs-2022" | null;
|
1498
1626
|
/**
|
1499
1627
|
* Similar to
|
1500
|
-
* {@link
|
1628
|
+
* {@link DataIntegrityProof.getVerificationMethod},
|
1501
1629
|
* but returns its `@id` URL instead of the object itself.
|
1502
1630
|
*/
|
1503
|
-
get
|
1504
|
-
/**
|
1505
|
-
*
|
1506
|
-
*
|
1631
|
+
get verificationMethodId(): URL | null;
|
1632
|
+
/** A key owned by an actor according to [FEP-521a: Representing actor's public
|
1633
|
+
* keys][1].
|
1634
|
+
*
|
1635
|
+
* [1]: https://w3id.org/fep/521a
|
1507
1636
|
*/
|
1508
|
-
|
1637
|
+
getVerificationMethod(options?: {
|
1509
1638
|
documentLoader?: DocumentLoader;
|
1510
1639
|
contextLoader?: DocumentLoader;
|
1511
1640
|
suppressError?: boolean;
|
1512
|
-
}): Promise<
|
1641
|
+
}): Promise<Multikey | null>;
|
1642
|
+
/** The reason the proof was created.
|
1643
|
+
*
|
1644
|
+
* - `"assertionMethod"`
|
1645
|
+
* - `"authentication"`
|
1646
|
+
* - `"capabilityInvocation"`
|
1647
|
+
* - `"capabilityDelegation"`
|
1648
|
+
* - `"keyAgreement"`
|
1649
|
+
*/
|
1650
|
+
get proofPurpose(): "assertionMethod" | "authentication" | "capabilityInvocation" | "capabilityDelegation" | "keyAgreement" | null;
|
1651
|
+
/** The proof value.
|
1652
|
+
*/
|
1653
|
+
get proofValue(): Uint8Array | null;
|
1654
|
+
/** The date and time the proof was created.
|
1655
|
+
*/
|
1656
|
+
get created(): dntShim.Temporal.Instant | null;
|
1513
1657
|
/**
|
1514
|
-
*
|
1515
|
-
*
|
1516
|
-
*
|
1658
|
+
* Converts this object to a JSON-LD structure.
|
1659
|
+
* @param options The options to use.
|
1660
|
+
* - `format`: The format of the output: `compact` or
|
1661
|
+
`expand`.
|
1662
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1663
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1664
|
+
when `format` is set to `'expand'`.
|
1665
|
+
* @returns The JSON-LD representation of this object.
|
1517
1666
|
*/
|
1518
|
-
|
1519
|
-
|
1520
|
-
|
1521
|
-
|
1667
|
+
toJsonLd(options?: {
|
1668
|
+
format?: "compact" | "expand";
|
1669
|
+
contextLoader?: DocumentLoader;
|
1670
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1671
|
+
}): Promise<unknown>;
|
1672
|
+
protected isCompactable(): boolean;
|
1673
|
+
/**
|
1674
|
+
* Converts a JSON-LD structure to an object of this type.
|
1675
|
+
* @param json The JSON-LD structure to convert.
|
1676
|
+
* @returns The object of this type.
|
1677
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1522
1678
|
*/
|
1523
|
-
|
1679
|
+
static fromJsonLd(json: unknown, options?: {
|
1524
1680
|
documentLoader?: DocumentLoader;
|
1525
1681
|
contextLoader?: DocumentLoader;
|
1526
|
-
|
1527
|
-
|
1682
|
+
}): Promise<DataIntegrityProof>;
|
1683
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1684
|
+
}
|
1685
|
+
/** A key owned by an actor.
|
1686
|
+
*/
|
1687
|
+
export declare class CryptographicKey {
|
1688
|
+
#private;
|
1689
|
+
readonly id: URL | null;
|
1690
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1691
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1528
1692
|
/**
|
1529
|
-
*
|
1530
|
-
* {@link Activity.getTarget},
|
1531
|
-
* but returns its `@id` URL instead of the object itself.
|
1693
|
+
* The type URI of {@link CryptographicKey}: `https://w3id.org/security#Key`.
|
1532
1694
|
*/
|
1533
|
-
get
|
1534
|
-
/**
|
1535
|
-
*
|
1536
|
-
*
|
1537
|
-
*
|
1538
|
-
* the target of the activity is John's wishlist. An activity can have more
|
1539
|
-
* than one target.
|
1695
|
+
static get typeId(): URL;
|
1696
|
+
/**
|
1697
|
+
* Constructs a new instance of CryptographicKey with the given values.
|
1698
|
+
* @param values The values to initialize the instance with.
|
1699
|
+
* @param options The options to use for initialization.
|
1540
1700
|
*/
|
1541
|
-
|
1701
|
+
constructor(values: {
|
1702
|
+
id?: URL | null;
|
1703
|
+
owner?: Application | Group | Organization | Person | Service | URL | null;
|
1704
|
+
publicKey?: dntShim.CryptoKey | null;
|
1705
|
+
}, { documentLoader, contextLoader, }?: {
|
1542
1706
|
documentLoader?: DocumentLoader;
|
1543
1707
|
contextLoader?: DocumentLoader;
|
1544
|
-
|
1545
|
-
}): Promise<Object | null>;
|
1708
|
+
});
|
1546
1709
|
/**
|
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.
|
1710
|
+
* Clones this instance, optionally updating it with the given values.
|
1711
|
+
* @param values The values to update the clone with.
|
1712
|
+
* @options The options to use for cloning.
|
1713
|
+
* @returns The cloned instance.
|
1558
1714
|
*/
|
1559
|
-
|
1715
|
+
clone(values?: {
|
1716
|
+
id?: URL | null;
|
1717
|
+
owner?: Application | Group | Organization | Person | Service | URL | null;
|
1718
|
+
publicKey?: dntShim.CryptoKey | null;
|
1719
|
+
}, options?: {
|
1560
1720
|
documentLoader?: DocumentLoader;
|
1561
1721
|
contextLoader?: DocumentLoader;
|
1562
|
-
|
1563
|
-
}): AsyncIterable<Object>;
|
1722
|
+
}): CryptographicKey;
|
1564
1723
|
/**
|
1565
1724
|
* Similar to
|
1566
|
-
* {@link
|
1725
|
+
* {@link CryptographicKey.getOwner},
|
1567
1726
|
* but returns its `@id` URL instead of the object itself.
|
1568
1727
|
*/
|
1569
|
-
get
|
1570
|
-
/**
|
1571
|
-
* results in the creation of a new resource, the result property can be used
|
1572
|
-
* to describe that new resource.
|
1728
|
+
get ownerId(): URL | null;
|
1729
|
+
/** An actor who owns this key.
|
1573
1730
|
*/
|
1574
|
-
|
1731
|
+
getOwner(options?: {
|
1575
1732
|
documentLoader?: DocumentLoader;
|
1576
1733
|
contextLoader?: DocumentLoader;
|
1577
1734
|
suppressError?: boolean;
|
1578
|
-
}): Promise<
|
1579
|
-
/**
|
1580
|
-
* Similar to
|
1581
|
-
* {@link Activity.getResults},
|
1582
|
-
* but returns their `@id`s instead of the objects themselves.
|
1735
|
+
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1736
|
+
/** A PEM-encoded public key.
|
1583
1737
|
*/
|
1584
|
-
get
|
1585
|
-
/**
|
1586
|
-
*
|
1587
|
-
*
|
1738
|
+
get publicKey(): dntShim.CryptoKey | null;
|
1739
|
+
/**
|
1740
|
+
* Converts this object to a JSON-LD structure.
|
1741
|
+
* @param options The options to use.
|
1742
|
+
* - `format`: The format of the output: `compact` or
|
1743
|
+
`expand`.
|
1744
|
+
* - `contextLoader`: The loader for remote JSON-LD contexts.
|
1745
|
+
* - `context`: The JSON-LD context to use. Not applicable
|
1746
|
+
when `format` is set to `'expand'`.
|
1747
|
+
* @returns The JSON-LD representation of this object.
|
1588
1748
|
*/
|
1589
|
-
|
1590
|
-
|
1749
|
+
toJsonLd(options?: {
|
1750
|
+
format?: "compact" | "expand";
|
1591
1751
|
contextLoader?: DocumentLoader;
|
1592
|
-
|
1593
|
-
}):
|
1752
|
+
context?: string | Record<string, string> | (string | Record<string, string>)[];
|
1753
|
+
}): Promise<unknown>;
|
1754
|
+
protected isCompactable(): boolean;
|
1594
1755
|
/**
|
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".
|
1756
|
+
* Converts a JSON-LD structure to an object of this type.
|
1757
|
+
* @param json The JSON-LD structure to convert.
|
1758
|
+
* @returns The object of this type.
|
1759
|
+
* @throws {TypeError} If the given `json` is invalid.
|
1604
1760
|
*/
|
1605
|
-
|
1761
|
+
static fromJsonLd(json: unknown, options?: {
|
1606
1762
|
documentLoader?: DocumentLoader;
|
1607
1763
|
contextLoader?: DocumentLoader;
|
1608
|
-
|
1609
|
-
|
1764
|
+
}): Promise<CryptographicKey>;
|
1765
|
+
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1766
|
+
}
|
1767
|
+
/** Represents a key owned by an actor according to [FEP-521a: Representing
|
1768
|
+
* actor's public keys.][1]
|
1769
|
+
*
|
1770
|
+
* [1]: https://w3id.org/fep/521a
|
1771
|
+
*/
|
1772
|
+
export declare class Multikey {
|
1773
|
+
#private;
|
1774
|
+
readonly id: URL | null;
|
1775
|
+
protected get _documentLoader(): DocumentLoader | undefined;
|
1776
|
+
protected get _contextLoader(): DocumentLoader | undefined;
|
1610
1777
|
/**
|
1611
|
-
*
|
1612
|
-
* {@link Activity.getOrigins},
|
1613
|
-
* but returns their `@id`s instead of the objects themselves.
|
1778
|
+
* The type URI of {@link Multikey}: `https://w3id.org/security#Multikey`.
|
1614
1779
|
*/
|
1615
|
-
get
|
1616
|
-
/**
|
1617
|
-
*
|
1618
|
-
*
|
1619
|
-
*
|
1780
|
+
static get typeId(): URL;
|
1781
|
+
/**
|
1782
|
+
* Constructs a new instance of Multikey with the given values.
|
1783
|
+
* @param values The values to initialize the instance with.
|
1784
|
+
* @param options The options to use for initialization.
|
1620
1785
|
*/
|
1621
|
-
|
1786
|
+
constructor(values: {
|
1787
|
+
id?: URL | null;
|
1788
|
+
controller?: Application | Group | Organization | Person | Service | URL | null;
|
1789
|
+
publicKey?: dntShim.CryptoKey | null;
|
1790
|
+
}, { documentLoader, contextLoader, }?: {
|
1622
1791
|
documentLoader?: DocumentLoader;
|
1623
1792
|
contextLoader?: DocumentLoader;
|
1624
|
-
|
1625
|
-
}): AsyncIterable<Object>;
|
1793
|
+
});
|
1626
1794
|
/**
|
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}.
|
1795
|
+
* Clones this instance, optionally updating it with the given values.
|
1796
|
+
* @param values The values to update the clone with.
|
1797
|
+
* @options The options to use for cloning.
|
1798
|
+
* @returns The cloned instance.
|
1634
1799
|
*/
|
1635
|
-
|
1800
|
+
clone(values?: {
|
1801
|
+
id?: URL | null;
|
1802
|
+
controller?: Application | Group | Organization | Person | Service | URL | null;
|
1803
|
+
publicKey?: dntShim.CryptoKey | null;
|
1804
|
+
}, options?: {
|
1636
1805
|
documentLoader?: DocumentLoader;
|
1637
1806
|
contextLoader?: DocumentLoader;
|
1638
|
-
|
1639
|
-
}): Promise<Object | null>;
|
1807
|
+
}): Multikey;
|
1640
1808
|
/**
|
1641
1809
|
* Similar to
|
1642
|
-
* {@link
|
1643
|
-
* but returns
|
1810
|
+
* {@link Multikey.getController},
|
1811
|
+
* but returns its `@id` URL instead of the object itself.
|
1644
1812
|
*/
|
1645
|
-
get
|
1646
|
-
/**
|
1647
|
-
* an {@link Activity}.
|
1813
|
+
get controllerId(): URL | null;
|
1814
|
+
/** An actor who owns this key.
|
1648
1815
|
*/
|
1649
|
-
|
1816
|
+
getController(options?: {
|
1650
1817
|
documentLoader?: DocumentLoader;
|
1651
1818
|
contextLoader?: DocumentLoader;
|
1652
1819
|
suppressError?: boolean;
|
1653
|
-
}):
|
1820
|
+
}): Promise<Application | Group | Organization | Person | Service | null>;
|
1821
|
+
/** A [Multibase]-encoded value of a [Multicodec] prefix and the key.
|
1822
|
+
*
|
1823
|
+
* [Multibase]: https://www.w3.org/TR/vc-data-integrity/#multibase-0
|
1824
|
+
* [Multicodec]: https://github.com/multiformats/multicodec/
|
1825
|
+
*/
|
1826
|
+
get publicKey(): dntShim.CryptoKey | null;
|
1654
1827
|
/**
|
1655
1828
|
* Converts this object to a JSON-LD structure.
|
1656
1829
|
* @param options The options to use.
|
@@ -1676,7 +1849,7 @@ export declare class Activity extends Object {
|
|
1676
1849
|
static fromJsonLd(json: unknown, options?: {
|
1677
1850
|
documentLoader?: DocumentLoader;
|
1678
1851
|
contextLoader?: DocumentLoader;
|
1679
|
-
}): Promise<
|
1852
|
+
}): Promise<Multikey>;
|
1680
1853
|
protected _getCustomInspectProxy(): Record<string, unknown>;
|
1681
1854
|
}
|
1682
1855
|
/** Indicates that the `actor` accepts the `object`. The `target` property can be
|