ui/client/features/story/services/StoryApi

Whether the story.md this url came from was authored in this repository ('local') or arrived from a clone ('foreign') -- drives the extra warning on first use (design 9.6). Defaults to 'local' on the server.

url

url: string

Defined in: ui/client/features/story/services/StoryApi.ts:12

Type Aliases#

StoryFetchResult#

StoryFetchResult = { ok: true; redirects: number; selectors: Record<string, { kind: "css" | "xpath"; value: string; }>; status: number; text: string; url: string; via: "server"; } | { code: "NEEDS_BRIDGE"; error: string; host: string; ok: false; via: "bridge"; } | { code: "CONSENT_REQUIRED"; error: string; host: string; ok: false; url: string; warning: boolean; } | { code: "CONSENT_DENIED"; error: string; host: string; ok: false; url: string; } | { code: string; error: string; ok: false; }

Defined in: ui/client/features/story/services/StoryApi.ts:22

StorySelector#

StorySelector = string | { css: string; } | { xpath: string; }

Defined in: ui/client/features/story/services/StoryApi.ts:9

A parse entry: a plain string is CSS; {css} / {xpath} are explicit (design 9.6b).

Variables#

StoryApi#

const StoryApi: object

Defined in: ui/client/features/story/services/StoryApi.ts:41

Type Declaration#

fetch()

fetch(request): Promise<StoryFetchResult>

One guarded fetch, strategy chosen per link (design 9.3). Never throws.

Parameters

request

StoryFetchRequest

Returns

Promise<StoryFetchResult>

listConsent()

listConsent(): Promise<{ approvals: StoryConsentApproval[]; ok: true; } | { error: string; ok: false; }>

The standing (host, url) approvals and denials, for the revoke list (design 9.6).

Returns

Promise<{ approvals: StoryConsentApproval[]; ok: true; } | { error: string; ok: false; }>

revokeConsent()

revokeConsent(id): Promise<{ ok: true; } | { error: string; ok: false; }>

Revoke one standing approval or denial.

Parameters

id

string

Returns

Promise<{ ok: true; } | { error: string; ok: false; }>