@singi-labs/sifa-sdk 0.11.9 → 0.11.11

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.
@@ -783,12 +783,15 @@ interface ResolveQuotedPostsOptions extends ApiFetchOptions {
783
783
  declare function resolveQuotedPosts(config: SifaApiConfig, uris: string[], options?: ResolveQuotedPostsOptions): Promise<Record<string, QuotedPostResult>>;
784
784
 
785
785
  /**
786
- * Reachability of an activity card's external destination, as reported by
787
- * sifa-api's `/api/activity` enrichment (see sifa-api `url-health-checker`).
786
+ * Liveness of an activity card's destination, as reported by sifa-api's
787
+ * `/api/activity` enrichment (see sifa-api `url-health-checker`). How liveness
788
+ * is measured depends on the card's health strategy (see `resolveCardHealth`):
789
+ * first-party permalinks (`record`) are checked by record existence on the PDS;
790
+ * foreign/derived targets (`url`) by HTTP reachability (HEAD, then GET).
788
791
  *
789
- * ok -- last HEAD returned 2xx/3xx
790
- * broken -- confirmed dead (>=2 consecutive 4xx, or >=5 consecutive 5xx)
791
- * unverifiable -- 403/429/network error; anti-bot or rate-limited, NOT dead
792
+ * ok -- record exists, or the URL returned 2xx/3xx
793
+ * broken -- confirmed dead (record deleted, or >=2 consecutive 4xx / >=5 consecutive 5xx)
794
+ * unverifiable -- 403/429, PDS unreachable, or network error; NOT dead
792
795
  * unknown -- newly seen, not yet checked
793
796
  *
794
797
  * Consumers should only suppress UI on `'broken'`. All other values
@@ -783,12 +783,15 @@ interface ResolveQuotedPostsOptions extends ApiFetchOptions {
783
783
  declare function resolveQuotedPosts(config: SifaApiConfig, uris: string[], options?: ResolveQuotedPostsOptions): Promise<Record<string, QuotedPostResult>>;
784
784
 
785
785
  /**
786
- * Reachability of an activity card's external destination, as reported by
787
- * sifa-api's `/api/activity` enrichment (see sifa-api `url-health-checker`).
786
+ * Liveness of an activity card's destination, as reported by sifa-api's
787
+ * `/api/activity` enrichment (see sifa-api `url-health-checker`). How liveness
788
+ * is measured depends on the card's health strategy (see `resolveCardHealth`):
789
+ * first-party permalinks (`record`) are checked by record existence on the PDS;
790
+ * foreign/derived targets (`url`) by HTTP reachability (HEAD, then GET).
788
791
  *
789
- * ok -- last HEAD returned 2xx/3xx
790
- * broken -- confirmed dead (>=2 consecutive 4xx, or >=5 consecutive 5xx)
791
- * unverifiable -- 403/429/network error; anti-bot or rate-limited, NOT dead
792
+ * ok -- record exists, or the URL returned 2xx/3xx
793
+ * broken -- confirmed dead (record deleted, or >=2 consecutive 4xx / >=5 consecutive 5xx)
794
+ * unverifiable -- 403/429, PDS unreachable, or network error; NOT dead
792
795
  * unknown -- newly seen, not yet checked
793
796
  *
794
797
  * Consumers should only suppress UI on `'broken'`. All other values