@fedify/vocab-runtime 2.4.0-dev.1508 → 2.4.0-dev.1531

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/deno.json +2 -1
  2. package/dist/docloader-DnUMWHaJ.d.cts +202 -0
  3. package/dist/docloader-xRGn1azD.d.ts +202 -0
  4. package/dist/internal/jsonld-cache.cjs +279 -0
  5. package/dist/internal/jsonld-cache.d.cts +48 -0
  6. package/dist/internal/jsonld-cache.d.ts +48 -0
  7. package/dist/internal/jsonld-cache.js +275 -0
  8. package/dist/mod.cjs +85 -190
  9. package/dist/mod.d.cts +18 -200
  10. package/dist/mod.d.ts +18 -200
  11. package/dist/mod.js +75 -184
  12. package/dist/tests/decimal.test.cjs +2 -2
  13. package/dist/tests/decimal.test.mjs +2 -2
  14. package/dist/tests/{docloader-0m6FCm4u.mjs → docloader-Bfj7NaT_.mjs} +75 -10
  15. package/dist/tests/{docloader-60uMNsd3.cjs → docloader-Cvdl8PIZ.cjs} +80 -9
  16. package/dist/tests/docloader.test.cjs +58 -6
  17. package/dist/tests/docloader.test.mjs +58 -6
  18. package/dist/tests/jsonld-cache.test.cjs +652 -0
  19. package/dist/tests/jsonld-cache.test.d.cts +1 -0
  20. package/dist/tests/jsonld-cache.test.d.mts +1 -0
  21. package/dist/tests/jsonld-cache.test.mjs +651 -0
  22. package/dist/tests/{request-CO5esooK.mjs → request-B5Su2gl0.mjs} +1 -1
  23. package/dist/tests/{request-CcBmdgDa.cjs → request-DJvOZdo7.cjs} +1 -1
  24. package/dist/tests/request.test.cjs +1 -1
  25. package/dist/tests/request.test.mjs +1 -1
  26. package/dist/tests/{url-C20FhC7p.cjs → url-2XwVbUS_.cjs} +108 -0
  27. package/dist/tests/{url-m9Qzxy-Y.mjs → url-YWJbnRlf.mjs} +85 -1
  28. package/dist/tests/url.test.cjs +104 -1
  29. package/dist/tests/url.test.mjs +105 -2
  30. package/dist/url-BAdyyqAa.cjs +315 -0
  31. package/dist/url-BuxPHxK2.js +261 -0
  32. package/package.json +11 -1
  33. package/src/docloader.test.ts +102 -6
  34. package/src/docloader.ts +76 -8
  35. package/src/internal/jsonld-cache.ts +538 -0
  36. package/src/jsonld-cache.test.ts +554 -0
  37. package/src/mod.ts +4 -0
  38. package/src/url.test.ts +252 -1
  39. package/src/url.ts +141 -0
  40. package/tsdown.config.ts +6 -1
package/dist/mod.cjs CHANGED
@@ -1,12 +1,11 @@
1
1
 
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
3
  const require_chunk = require("./chunk-M78iaK0I.cjs");
4
+ const require_url = require("./url-BAdyyqAa.cjs");
4
5
  let _logtape_logtape = require("@logtape/logtape");
5
6
  let _opentelemetry_api = require("@opentelemetry/api");
6
7
  let node_process = require("node:process");
7
8
  node_process = require_chunk.__toESM(node_process, 1);
8
- let node_dns_promises = require("node:dns/promises");
9
- let node_net = require("node:net");
10
9
  let asn1js = require("asn1js");
11
10
  let byte_encodings_base64 = require("byte-encodings/base64");
12
11
  let byte_encodings_base64url = require("byte-encodings/base64url");
@@ -4346,7 +4345,7 @@ const preloadedContexts = {
4346
4345
  //#endregion
4347
4346
  //#region deno.json
4348
4347
  var name = "@fedify/vocab-runtime";
4349
- var version = "2.4.0-dev.1508+68519bf4";
4348
+ var version = "2.4.0-dev.1531+0896bc51";
4350
4349
  //#endregion
4351
4350
  //#region src/link.ts
4352
4351
  const parametersNeedLowerCase = ["rel", "type"];
@@ -4599,179 +4598,6 @@ function logRequest(logger, request) {
4599
4598
  });
4600
4599
  }
4601
4600
  //#endregion
4602
- //#region src/url.ts
4603
- var UrlError = class extends Error {
4604
- constructor(message) {
4605
- super(message);
4606
- this.name = "UrlError";
4607
- }
4608
- };
4609
- /**
4610
- * Validates a URL to prevent SSRF attacks.
4611
- */
4612
- async function validatePublicUrl(url) {
4613
- const parsed = new URL(url);
4614
- if (parsed.protocol !== "http:" && parsed.protocol !== "https:") throw new UrlError(`Unsupported protocol: ${parsed.protocol}`);
4615
- let hostname = parsed.hostname;
4616
- if (hostname.startsWith("[") && hostname.endsWith("]")) hostname = hostname.slice(1, -1);
4617
- if (hostname === "localhost") throw new UrlError("Localhost is not allowed");
4618
- const hostnameFamily = (0, node_net.isIP)(hostname);
4619
- if (hostnameFamily !== 0) {
4620
- validatePublicIpAddress(hostname, hostnameFamily);
4621
- return;
4622
- }
4623
- if ("Deno" in globalThis && !(0, node_net.isIP)(hostname)) {
4624
- if ((await Deno.permissions.query({ name: "net" })).state !== "granted") return;
4625
- }
4626
- if ("Bun" in globalThis) {
4627
- if (hostname === "example.com" || hostname.endsWith(".example.com")) return;
4628
- else if (hostname === "fedify-test.internal") throw new UrlError("Invalid or private address: fedify-test.internal");
4629
- }
4630
- let addresses;
4631
- try {
4632
- addresses = await (0, node_dns_promises.lookup)(hostname, { all: true });
4633
- } catch {
4634
- addresses = [];
4635
- }
4636
- for (const { address, family } of addresses) validatePublicIpAddress(address, family);
4637
- }
4638
- function validatePublicIpAddress(address, family) {
4639
- if (family === 4 && isValidPublicIPv4Address(address) || family === 6 && isValidPublicIPv6Address(address)) return;
4640
- throw new UrlError(`Invalid or private address: ${address}`);
4641
- }
4642
- function isValidPublicIPv4Address(address) {
4643
- const parts = parseIPv4Address(address);
4644
- if (parts == null) return false;
4645
- const value = ipv4PartsToNumber(parts);
4646
- return !nonPublicIPv4Prefixes.some(({ base, prefix }) => matchesIPv4Prefix(value, base, prefix));
4647
- }
4648
- function isValidPublicIPv6Address(address) {
4649
- const words = parseIPv6Address(address);
4650
- if (words == null) return false;
4651
- if (nonPublicIPv6Prefixes.some(({ words: prefixWords, prefix }) => matchesIPv6Prefix(words, prefixWords, prefix))) return false;
4652
- for (const { extractIPv4, prefix, words: prefixWords } of ipv6WithIPv4Prefixes) {
4653
- if (!matchesIPv6Prefix(words, prefixWords, prefix)) continue;
4654
- const ipv4Address = extractIPv4(words);
4655
- if (ipv4Address != null && !isValidPublicIPv4Address(ipv4Address)) return false;
4656
- }
4657
- return true;
4658
- }
4659
- function expandIPv6Address(address) {
4660
- address = address.toLowerCase();
4661
- const ipv4Delimiter = address.lastIndexOf(":");
4662
- if (address.includes(".") && ipv4Delimiter >= 0) {
4663
- const ipv4Parts = parseIPv4Address(address.substring(ipv4Delimiter + 1));
4664
- if (ipv4Parts == null) return address;
4665
- const high = (ipv4Parts[0] << 8) + ipv4Parts[1];
4666
- const low = (ipv4Parts[2] << 8) + ipv4Parts[3];
4667
- address = address.substring(0, ipv4Delimiter + 1) + high.toString(16) + ":" + low.toString(16);
4668
- }
4669
- if (address === "::") return "0000:0000:0000:0000:0000:0000:0000:0000";
4670
- if (address.startsWith("::")) address = "0000" + address;
4671
- if (address.endsWith("::")) address = address + "0000";
4672
- address = address.replace("::", ":0000".repeat(8 - (address.match(/:/g) || []).length) + ":");
4673
- return address.split(":").map((part) => part.padStart(4, "0")).join(":");
4674
- }
4675
- const nonPublicIPv4Prefixes = [
4676
- ipv4Prefix("0.0.0.0/8", "RFC 6890"),
4677
- ipv4Prefix("10.0.0.0/8", "RFC 1918"),
4678
- ipv4Prefix("100.64.0.0/10", "RFC 6598"),
4679
- ipv4Prefix("127.0.0.0/8", "RFC 1122"),
4680
- ipv4Prefix("169.254.0.0/16", "RFC 3927"),
4681
- ipv4Prefix("172.16.0.0/12", "RFC 1918"),
4682
- ipv4Prefix("192.0.0.0/24", "RFC 6890"),
4683
- ipv4Prefix("192.0.2.0/24", "RFC 5737"),
4684
- ipv4Prefix("192.88.99.0/24", "RFC 7526"),
4685
- ipv4Prefix("192.168.0.0/16", "RFC 1918"),
4686
- ipv4Prefix("198.18.0.0/15", "RFC 2544"),
4687
- ipv4Prefix("198.51.100.0/24", "RFC 5737"),
4688
- ipv4Prefix("203.0.113.0/24", "RFC 5737"),
4689
- ipv4Prefix("224.0.0.0/4", "RFC 5771"),
4690
- ipv4Prefix("240.0.0.0/4", "RFC 1112")
4691
- ];
4692
- const nonPublicIPv6Prefixes = [
4693
- ipv6Prefix("::/16", "RFC 4291"),
4694
- ipv6Prefix("2001::/32", "RFC 4380"),
4695
- ipv6Prefix("2002::/16", "RFC 3056"),
4696
- ipv6Prefix("64:ff9b:1::/48", "RFC 8215"),
4697
- ipv6Prefix("fc00::/7", "RFC 4193"),
4698
- ipv6Prefix("fe80::/10", "RFC 4291"),
4699
- ipv6Prefix("ff00::/8", "RFC 4291")
4700
- ];
4701
- const ipv6WithIPv4Prefixes = [{
4702
- ...ipv6Prefix("64:ff9b::/96", "RFC 6052"),
4703
- extractIPv4: (words) => ipv4FromWords(words[6], words[7])
4704
- }];
4705
- function ipv4Prefix(cidr, rfc) {
4706
- const [address, prefixText] = cidr.split("/");
4707
- const prefix = parseInt(prefixText, 10);
4708
- const parts = parseIPv4Address(address);
4709
- if (parts == null || !Number.isInteger(prefix) || prefix < 0 || prefix > 32) throw new Error(`Invalid IPv4 prefix: ${cidr}`);
4710
- return {
4711
- cidr,
4712
- base: ipv4PartsToNumber(parts),
4713
- prefix,
4714
- rfc
4715
- };
4716
- }
4717
- function ipv6Prefix(cidr, rfc) {
4718
- const [address, prefixText] = cidr.split("/");
4719
- const prefix = parseInt(prefixText, 10);
4720
- const words = parseIPv6Address(address);
4721
- if (words == null || !Number.isInteger(prefix) || prefix < 0 || prefix > 128) throw new Error(`Invalid IPv6 prefix: ${cidr}`);
4722
- return {
4723
- cidr,
4724
- words,
4725
- prefix,
4726
- rfc
4727
- };
4728
- }
4729
- function parseIPv4Address(address) {
4730
- const parts = address.split(".").map((part) => {
4731
- if (!/^\d+$/.test(part)) return NaN;
4732
- return parseInt(part, 10);
4733
- });
4734
- if (parts.length !== 4 || parts.some((part) => !Number.isInteger(part) || part < 0 || part > 255)) return null;
4735
- return parts;
4736
- }
4737
- function parseIPv6Address(address) {
4738
- const parts = expandIPv6Address(address).split(":");
4739
- if (parts.length !== 8) return null;
4740
- const words = parts.map((part) => {
4741
- if (!/^[0-9a-f]{1,4}$/i.test(part)) return NaN;
4742
- return parseInt(part, 16);
4743
- });
4744
- if (words.some((word) => !Number.isInteger(word) || word < 0 || word > 65535)) return null;
4745
- return words;
4746
- }
4747
- function ipv4PartsToNumber(parts) {
4748
- return parts[0] * 2 ** 24 + parts[1] * 2 ** 16 + parts[2] * 2 ** 8 + parts[3];
4749
- }
4750
- function ipv4FromWords(highWord, lowWord) {
4751
- return [
4752
- highWord >> 8,
4753
- highWord & 255,
4754
- lowWord >> 8,
4755
- lowWord & 255
4756
- ].join(".");
4757
- }
4758
- function matchesIPv4Prefix(address, prefixBase, prefixLength) {
4759
- const blockSize = 2 ** (32 - prefixLength);
4760
- return Math.floor(address / blockSize) === Math.floor(prefixBase / blockSize);
4761
- }
4762
- function matchesIPv6Prefix(address, prefixWords, prefixLength) {
4763
- let remaining = prefixLength;
4764
- for (let i = 0; i < 8 && remaining > 0; i++) if (remaining >= 16) {
4765
- if (address[i] !== prefixWords[i]) return false;
4766
- remaining -= 16;
4767
- } else {
4768
- const mask = 65535 << 16 - remaining & 65535;
4769
- if ((address[i] & mask) !== (prefixWords[i] & mask)) return false;
4770
- remaining = 0;
4771
- }
4772
- return true;
4773
- }
4774
- //#endregion
4775
4601
  //#region src/docloader.ts
4776
4602
  const logger = (0, _logtape_logtape.getLogger)([
4777
4603
  "fedify",
@@ -4779,6 +4605,66 @@ const logger = (0, _logtape_logtape.getLogger)([
4779
4605
  "docloader"
4780
4606
  ]);
4781
4607
  const DEFAULT_MAX_REDIRECTION = 20;
4608
+ const MAX_HTML_SIZE = 1024 * 1024;
4609
+ function createResponseMetadata(response) {
4610
+ return new Response(null, {
4611
+ headers: response.headers,
4612
+ status: response.status,
4613
+ statusText: response.statusText
4614
+ });
4615
+ }
4616
+ async function cancelResponseBody(response) {
4617
+ if (response.body != null) await response.body.cancel();
4618
+ }
4619
+ async function readBoundedText(response, maxBytes) {
4620
+ const contentLength = response.headers.get("Content-Length");
4621
+ if (contentLength != null) {
4622
+ const size = Number(contentLength);
4623
+ if (size > maxBytes) {
4624
+ await cancelResponseBody(response);
4625
+ return {
4626
+ text: "",
4627
+ size,
4628
+ tooLarge: true
4629
+ };
4630
+ }
4631
+ }
4632
+ if (response.body == null) return {
4633
+ text: "",
4634
+ size: 0,
4635
+ tooLarge: false
4636
+ };
4637
+ const reader = response.body.getReader();
4638
+ const decoder = new TextDecoder();
4639
+ let text = "";
4640
+ let size = 0;
4641
+ try {
4642
+ while (true) {
4643
+ const result = await reader.read();
4644
+ if (result.done) break;
4645
+ const chunkSize = result.value.byteLength;
4646
+ if (size + chunkSize > maxBytes) {
4647
+ size += chunkSize;
4648
+ await reader.cancel();
4649
+ return {
4650
+ text: "",
4651
+ size,
4652
+ tooLarge: true
4653
+ };
4654
+ }
4655
+ size += chunkSize;
4656
+ text += decoder.decode(result.value, { stream: true });
4657
+ }
4658
+ text += decoder.decode();
4659
+ return {
4660
+ text,
4661
+ size,
4662
+ tooLarge: false
4663
+ };
4664
+ } finally {
4665
+ reader.releaseLock();
4666
+ }
4667
+ }
4782
4668
  /**
4783
4669
  * Gets a {@link RemoteDocument} from the given response.
4784
4670
  * @param url The URL of the document to load.
@@ -4833,19 +4719,19 @@ async function getRemoteDocument(url, response, fetch) {
4833
4719
  }
4834
4720
  let document;
4835
4721
  if (!jsonLd && (contentType === "text/html" || contentType?.startsWith("text/html;") || contentType === "application/xhtml+xml" || contentType?.startsWith("application/xhtml+xml;"))) {
4836
- const MAX_HTML_SIZE = 1024 * 1024;
4837
- const html = await response.text();
4838
- if (html.length > MAX_HTML_SIZE) {
4722
+ const errorResponse = createResponseMetadata(response);
4723
+ const html = await readBoundedText(response, MAX_HTML_SIZE);
4724
+ if (html.tooLarge) {
4839
4725
  logger.warn("HTML response too large, skipping alternate link discovery: {url}", {
4840
4726
  url: documentUrl,
4841
- size: html.length
4727
+ size: html.size
4842
4728
  });
4843
- document = JSON.parse(html);
4729
+ throw new FetchError(documentUrl, `HTML document is too large to scan for an ActivityPub alternate link (Content-Type: ${contentType})`, errorResponse);
4844
4730
  } else {
4845
4731
  const tagPattern = /<(a|link)\s+([^>]*?)\s*\/?>/gi;
4846
4732
  const attrPattern = /([a-z][a-z:_-]*)=(?:"([^"]*)"|'([^']*)'|([^\s>]+))/gi;
4847
4733
  let tagMatch;
4848
- while ((tagMatch = tagPattern.exec(html)) !== null) {
4734
+ while ((tagMatch = tagPattern.exec(html.text)) !== null) {
4849
4735
  const tagContent = tagMatch[2];
4850
4736
  let attrMatch;
4851
4737
  const attribs = {};
@@ -4862,7 +4748,12 @@ async function getRemoteDocument(url, response, fetch) {
4862
4748
  return await fetch(new URL(attribs.href, docUrl).href);
4863
4749
  }
4864
4750
  }
4865
- document = JSON.parse(html);
4751
+ try {
4752
+ document = JSON.parse(html.text);
4753
+ } catch (error) {
4754
+ if (!(error instanceof SyntaxError)) throw error;
4755
+ throw new FetchError(documentUrl, `HTML document has no ActivityPub alternate link (Content-Type: ${contentType})`, errorResponse);
4756
+ }
4866
4757
  }
4867
4758
  } else document = await response.json();
4868
4759
  logger.debug("Fetched document: {status} {url} {headers}", {
@@ -4908,9 +4799,9 @@ function getDocumentLoader({ allowPrivateAddress, maxRedirection, skipPreloadedC
4908
4799
  };
4909
4800
  }
4910
4801
  if (!allowPrivateAddress) try {
4911
- await validatePublicUrl(currentUrl);
4802
+ await require_url.validatePublicUrl(currentUrl);
4912
4803
  } catch (error) {
4913
- if (error instanceof UrlError) logger.error("Disallowed private URL: {url}", {
4804
+ if (error instanceof require_url.UrlError) logger.error("Disallowed private URL: {url}", {
4914
4805
  url: currentUrl,
4915
4806
  error
4916
4807
  });
@@ -5569,26 +5460,30 @@ LanguageString.prototype[Symbol.for("nodejs.util.inspect.custom")] = function(_d
5569
5460
  //#endregion
5570
5461
  exports.FetchError = FetchError;
5571
5462
  exports.LanguageString = LanguageString;
5572
- exports.UrlError = UrlError;
5463
+ exports.UrlError = require_url.UrlError;
5573
5464
  exports.canParseDecimal = canParseDecimal;
5574
5465
  exports.createActivityPubRequest = createActivityPubRequest;
5575
5466
  exports.decodeMultibase = decodeMultibase;
5576
5467
  exports.encodeMultibase = encodeMultibase;
5577
5468
  exports.encodingFromBaseData = encodingFromBaseData;
5578
- exports.expandIPv6Address = expandIPv6Address;
5469
+ exports.expandIPv6Address = require_url.expandIPv6Address;
5579
5470
  exports.exportMultibaseKey = exportMultibaseKey;
5580
5471
  exports.exportSpki = exportSpki;
5472
+ exports.formatIri = require_url.formatIri;
5581
5473
  exports.getDocumentLoader = getDocumentLoader;
5582
5474
  exports.getRemoteDocument = getRemoteDocument;
5583
5475
  exports.getUserAgent = getUserAgent;
5476
+ exports.haveSameIriOrigin = require_url.haveSameIriOrigin;
5584
5477
  exports.importMultibaseKey = importMultibaseKey;
5585
5478
  exports.importPem = importPem;
5586
5479
  exports.importPkcs1 = importPkcs1;
5587
5480
  exports.importSpki = importSpki;
5588
5481
  exports.isDecimal = isDecimal;
5589
- exports.isValidPublicIPv4Address = isValidPublicIPv4Address;
5590
- exports.isValidPublicIPv6Address = isValidPublicIPv6Address;
5482
+ exports.isValidPublicIPv4Address = require_url.isValidPublicIPv4Address;
5483
+ exports.isValidPublicIPv6Address = require_url.isValidPublicIPv6Address;
5591
5484
  exports.logRequest = logRequest;
5592
5485
  exports.parseDecimal = parseDecimal;
5486
+ exports.parseIri = require_url.parseIri;
5487
+ exports.parseJsonLdId = require_url.parseJsonLdId;
5593
5488
  exports.preloadedContexts = preloadedContexts;
5594
- exports.validatePublicUrl = validatePublicUrl;
5489
+ exports.validatePublicUrl = require_url.validatePublicUrl;
package/dist/mod.d.cts CHANGED
@@ -1,208 +1,10 @@
1
1
  /// <reference lib="esnext.temporal" />
2
- import { Logger } from "@logtape/logtape";
2
+ import { a as DocumentLoaderOptions, c as getDocumentLoader, d as FetchError, f as GetUserAgentOptions, h as logRequest, i as DocumentLoaderFactoryOptions, l as getRemoteDocument, m as getUserAgent, n as DocumentLoader, o as GetDocumentLoaderOptions, p as createActivityPubRequest, r as DocumentLoaderFactory, s as RemoteDocument, t as AuthenticatedDocumentLoaderFactory, u as CreateRequestOptions } from "./docloader-DnUMWHaJ.cjs";
3
3
  import { TracerProvider } from "@opentelemetry/api";
4
4
 
5
5
  //#region src/contexts.d.ts
6
6
  declare const preloadedContexts: Record<string, unknown>;
7
7
  //#endregion
8
- //#region src/request.d.ts
9
- /**
10
- * Error thrown when fetching a JSON-LD document failed.
11
- */
12
- declare class FetchError extends Error {
13
- /**
14
- * The URL that failed to fetch.
15
- */
16
- url: URL;
17
- /**
18
- * The HTTP response that failed, if available.
19
- */
20
- response?: Response;
21
- /**
22
- * Constructs a new `FetchError`.
23
- *
24
- * @param url The URL that failed to fetch.
25
- * @param message Error message.
26
- * @param response The failed HTTP response, if available.
27
- */
28
- constructor(url: URL | string, message?: string, response?: Response);
29
- }
30
- /**
31
- * Options for creating a request.
32
- * @internal
33
- */
34
- interface CreateRequestOptions {
35
- userAgent?: GetUserAgentOptions | string;
36
- }
37
- /**
38
- * Creates a request for the given URL.
39
- * @param url The URL to create the request for.
40
- * @param options The options for the request.
41
- * @returns The created request.
42
- * @internal
43
- */
44
- declare function createActivityPubRequest(url: string, options?: CreateRequestOptions): Request;
45
- /**
46
- * Options for making `User-Agent` string.
47
- * @see {@link getUserAgent}
48
- * @since 1.3.0
49
- */
50
- interface GetUserAgentOptions {
51
- /**
52
- * An optional software name and version, e.g., `"Hollo/1.0.0"`.
53
- */
54
- software?: string | null;
55
- /**
56
- * An optional URL to append to the user agent string.
57
- * Usually the URL of the ActivityPub instance.
58
- */
59
- url?: string | URL | null;
60
- }
61
- /**
62
- * Gets the user agent string for the given application and URL.
63
- * @param options The options for making the user agent string.
64
- * @returns The user agent string.
65
- * @since 1.3.0
66
- */
67
- declare function getUserAgent({
68
- software,
69
- url
70
- }?: GetUserAgentOptions): string;
71
- /**
72
- * Logs the request.
73
- * @param request The request to log.
74
- * @internal
75
- */
76
- declare function logRequest(logger: Logger, request: Request): void;
77
- //#endregion
78
- //#region src/docloader.d.ts
79
- /**
80
- * A remote JSON-LD document and its context fetched by
81
- * a {@link DocumentLoader}.
82
- */
83
- interface RemoteDocument {
84
- /**
85
- * The URL of the context document.
86
- */
87
- contextUrl: string | null;
88
- /**
89
- * The fetched JSON-LD document.
90
- */
91
- document: unknown;
92
- /**
93
- * The URL of the fetched document.
94
- */
95
- documentUrl: string;
96
- }
97
- /**
98
- * Options for {@link DocumentLoader}.
99
- * @since 1.8.0
100
- */
101
- interface DocumentLoaderOptions {
102
- /**
103
- * An `AbortSignal` for cancellation.
104
- * @since 1.8.0
105
- */
106
- signal?: AbortSignal;
107
- }
108
- /**
109
- * A JSON-LD document loader that fetches documents from the Web.
110
- * @param url The URL of the document to load.
111
- * @param options The options for the document loader.
112
- * @returns The loaded remote document.
113
- */
114
- type DocumentLoader = (url: string, options?: DocumentLoaderOptions) => Promise<RemoteDocument>;
115
- /**
116
- * A factory function that creates a {@link DocumentLoader} with options.
117
- * @param options The options for the document loader.
118
- * @returns The document loader.
119
- * @since 1.4.0
120
- */
121
- type DocumentLoaderFactory = (options?: DocumentLoaderFactoryOptions) => DocumentLoader;
122
- /**
123
- * Options for {@link DocumentLoaderFactory}.
124
- * @see {@link DocumentLoaderFactory}
125
- * @see {@link AuthenticatedDocumentLoaderFactory}
126
- * @since 1.4.0
127
- */
128
- interface DocumentLoaderFactoryOptions {
129
- /**
130
- * Whether to allow fetching private network addresses.
131
- * Turned off by default.
132
- * @default `false``
133
- */
134
- allowPrivateAddress?: boolean;
135
- /**
136
- * Options for making `User-Agent` string.
137
- * If a string is given, it is used as the `User-Agent` header value.
138
- * If an object is given, it is passed to {@link getUserAgent} function.
139
- */
140
- userAgent?: GetUserAgentOptions | string;
141
- /**
142
- * The maximum number of redirections to follow.
143
- * @default `20`
144
- * @since 2.2.0
145
- */
146
- maxRedirection?: number;
147
- }
148
- /**
149
- * A factory function that creates an authenticated {@link DocumentLoader} for
150
- * a given identity. This is used for fetching documents that require
151
- * authentication.
152
- * @param identity The identity to create the document loader for.
153
- * The actor's key pair.
154
- * @param options The options for the document loader.
155
- * @returns The authenticated document loader.
156
- * @since 0.4.0
157
- */
158
- type AuthenticatedDocumentLoaderFactory = (identity: {
159
- keyId: URL;
160
- privateKey: CryptoKey;
161
- }, options?: DocumentLoaderFactoryOptions) => DocumentLoader;
162
- /**
163
- * Gets a {@link RemoteDocument} from the given response.
164
- * @param url The URL of the document to load.
165
- * @param response The response to get the document from.
166
- * @param fetch The function to fetch the document.
167
- * @returns The loaded remote document.
168
- * @throws {FetchError} If the response is not OK.
169
- * @internal
170
- */
171
- declare function getRemoteDocument(url: string, response: Response, fetch: (url: string, options?: DocumentLoaderOptions) => Promise<RemoteDocument>): Promise<RemoteDocument>;
172
- /**
173
- * Options for {@link getDocumentLoader}.
174
- * @since 1.3.0
175
- */
176
- interface GetDocumentLoaderOptions extends DocumentLoaderFactoryOptions {
177
- /**
178
- * Whether to preload the frequently used contexts.
179
- */
180
- skipPreloadedContexts?: boolean;
181
- }
182
- /**
183
- * Creates a JSON-LD document loader that utilizes the browser's `fetch` API.
184
- *
185
- * The created loader preloads the below frequently used contexts by default
186
- * (unless `options.skipPreloadedContexts` is set to `true`):
187
- *
188
- * - <https://www.w3.org/ns/activitystreams>
189
- * - <https://w3id.org/security/v1>
190
- * - <https://w3id.org/security/data-integrity/v1>
191
- * - <https://www.w3.org/ns/did/v1>
192
- * - <https://w3id.org/security/multikey/v1>
193
- * - <https://purl.archive.org/socialweb/webfinger>
194
- * - <http://schema.org/>
195
- * @param options Options for the document loader.
196
- * @returns The document loader.
197
- * @since 1.3.0
198
- */
199
- declare function getDocumentLoader({
200
- allowPrivateAddress,
201
- maxRedirection,
202
- skipPreloadedContexts,
203
- userAgent
204
- }?: GetDocumentLoaderOptions): DocumentLoader;
205
- //#endregion
206
8
  //#region src/key.d.ts
207
9
  /**
208
10
  * Imports a PEM-SPKI formatted public key.
@@ -461,6 +263,22 @@ declare class UrlError extends Error {
461
263
  constructor(message: string);
462
264
  }
463
265
  /**
266
+ * Parses a JSON-LD `@id` value as an IRI.
267
+ */
268
+ declare function parseJsonLdId(id: string | undefined, base?: string | URL): URL | undefined;
269
+ /**
270
+ * Parses an IRI as a URL, including FEP-ef61 portable ActivityPub IRIs.
271
+ */
272
+ declare function parseIri(iri: string | URL, base?: string | URL): URL;
273
+ /**
274
+ * Formats a URL as an IRI, including FEP-ef61 portable ActivityPub IRIs.
275
+ */
276
+ declare function formatIri(iri: string | URL): string;
277
+ /**
278
+ * Checks whether two IRIs have the same origin.
279
+ */
280
+ declare function haveSameIriOrigin(left: URL, right: URL): boolean;
281
+ /**
464
282
  * Validates a URL to prevent SSRF attacks.
465
283
  */
466
284
  declare function validatePublicUrl(url: string): Promise<void>;
@@ -468,4 +286,4 @@ declare function isValidPublicIPv4Address(address: string): boolean;
468
286
  declare function isValidPublicIPv6Address(address: string): boolean;
469
287
  declare function expandIPv6Address(address: string): string;
470
288
  //#endregion
471
- export { type AuthenticatedDocumentLoaderFactory, type CreateRequestOptions, type Decimal, type DocumentLoader, type DocumentLoaderFactory, type DocumentLoaderFactoryOptions, type DocumentLoaderOptions, FetchError, type GetDocumentLoaderOptions, type GetUserAgentOptions, type Json, LanguageString, type PropertyPreprocessor, type PropertyPreprocessorContext, type RemoteDocument, UrlError, canParseDecimal, createActivityPubRequest, decodeMultibase, encodeMultibase, encodingFromBaseData, expandIPv6Address, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, getUserAgent, importMultibaseKey, importPem, importPkcs1, importSpki, isDecimal, isValidPublicIPv4Address, isValidPublicIPv6Address, logRequest, parseDecimal, preloadedContexts, validatePublicUrl };
289
+ export { type AuthenticatedDocumentLoaderFactory, type CreateRequestOptions, type Decimal, type DocumentLoader, type DocumentLoaderFactory, type DocumentLoaderFactoryOptions, type DocumentLoaderOptions, FetchError, type GetDocumentLoaderOptions, type GetUserAgentOptions, type Json, LanguageString, type PropertyPreprocessor, type PropertyPreprocessorContext, type RemoteDocument, UrlError, canParseDecimal, createActivityPubRequest, decodeMultibase, encodeMultibase, encodingFromBaseData, expandIPv6Address, exportMultibaseKey, exportSpki, formatIri, getDocumentLoader, getRemoteDocument, getUserAgent, haveSameIriOrigin, importMultibaseKey, importPem, importPkcs1, importSpki, isDecimal, isValidPublicIPv4Address, isValidPublicIPv6Address, logRequest, parseDecimal, parseIri, parseJsonLdId, preloadedContexts, validatePublicUrl };