@aparte/plugin-cards 0.0.0-stage → 0.29.1

package/dist/kit/strings.d.ts

@@ -0,0 +1,139 @@
+/**
+ * A card's words, in the chat's language.
+ *
+ * Core's locale is a closed list of what CORE draws, so a plugin reads its own keys off
+ * `getLocale()` and defaults them at the call site (the localization guide). A card does
+ * that, with one step in between: this package carries its words in the ten languages
+ * `@aparte/locales` ships, picked by the locale's `tag`. An app that sets a key wins;
+ * a language the table does not have reads English.
+ *
+ *   aparteGlobalConfig.extendLocale({ cardsWeatherWind: 'Vent' });
+ */
+import type { AparteConfig } from '@aparte/core';
+/** The languages a card's words come in, beside English. */
+export type CardLanguage = 'fr' | 'de' | 'es' | 'it' | 'ja' | 'ko' | 'pt' | 'ru' | 'zh';
+/** One word or phrase, in English and in as many of the other languages as it has. */
+export type CardWord = {
+    en: string;
+} & Partial<Record<CardLanguage, string>>;
+/** The language part of the locale's tag: `pt-BR` → `pt`, `zh-CN` → `zh`, none → `en`. */
+export declare function languageOf(config: AparteConfig): string;
+/** The locale's tag for `Intl`, or `undefined` to follow the browser (never `''`, which throws). */
+export declare function intlTag(config: AparteConfig): string | undefined;
+/**
+ * The word for `key`: the app's locale first, then this package's table for the chat's
+ * language, then English. `{name}` placeholders are filled from `vars`.
+ */
+export declare function word(config: AparteConfig, key: string, table: CardWord, vars?: Record<string, string>): string;
+/** The words every card shares. */
+export declare const KIT_WORDS: {
+    cardsUnavailable: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsWaiting: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsRefused: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsLoading: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsPrevious: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsNext: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsSlide: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsRating: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+    cardsReviews: {
+        en: string;
+        fr: string;
+        de: string;
+        es: string;
+        it: string;
+        ja: string;
+        ko: string;
+        pt: string;
+        ru: string;
+        zh: string;
+    };
+};
+//# sourceMappingURL=strings.d.ts.map

package/dist/kit/strings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../../src/kit/strings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD,4DAA4D;AAC5D,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAExF,sFAAsF;AACtF,MAAM,MAAM,QAAQ,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAE9E,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAGvD;AAED,oGAAoG;AACpG,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAchE;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,MAAM,CAKlH;AAED,mCAAmC;AACnC,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCc,CAAC"}

package/dist/link/icons.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The link card's glyphs: the chain that names the card, one small badge per kind of page
+ * (an article, a video, a code repository, a product), and the play disc a video's preview
+ * wears.
+ *
+ * Drawn on a 24 × 24 grid in `currentColor`, so the sheet colours them through `color` and
+ * a theme follows. Constants of this package — the only markup the card parses.
+ */
+import type { LinkType } from './index.js';
+/** Two links of a chain: a link, and the card's one-line state glyph. */
+export declare const CHAIN: string;
+/** The play triangle, filled: it sits on a disc over a video's preview. */
+export declare const PLAY = "<svg viewBox=\"0 0 24 24\" fill=\"currentColor\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M8.5 5.6v12.8a1 1 0 0 0 1.5.86l10.2-6.4a1 1 0 0 0 0-1.72L10 4.74a1 1 0 0 0-1.5.86z\"/></svg>";
+/** The badge glyph for a kind of page; a plain website has none. */
+export declare function typeGlyph(type: Exclude<LinkType, 'website'>): string;
+//# sourceMappingURL=icons.d.ts.map

package/dist/link/icons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons.d.ts","sourceRoot":"","sources":["../../src/link/icons.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAK3C,yEAAyE;AACzE,eAAO,MAAM,KAAK,QAAwI,CAAC;AAE3J,2EAA2E;AAC3E,eAAO,MAAM,IAAI,iMAAyL,CAAC;AAa3M,oEAAoE;AACpE,wBAAgB,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,MAAM,CAEpE"}

package/dist/link/index.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @aparte/plugin-cards/link — a web page, previewed: its picture, its site, its title and
+ * what it says it is about, the whole card one link to it.
+ *
+ *   import { setupLinkCard } from '@aparte/plugin-cards/link';
+ *
+ *   setupLinkCard({ tool: 'unfurl' });                               // one page's Open Graph, as it is
+ *   setupLinkCard({ tool: 'web_search', map: (r) => r.items });      // search results
+ *
+ * One link, several (`[...]`), or `{ title, links: [...] }`. Three variants of one card:
+ * `card` (the picture on top, the site, the title, the description), `compact` (one row: the
+ * site's icon, the title, a small picture at the end) and `quote` (the block chat apps draw
+ * under an unfurled link, with a coloured rule down its side). Your tool keeps its own
+ * fields: `readLinks` reads Open Graph and Twitter keys, unfurlers' nested shapes and search
+ * results (Google's Custom Search, SerpAPI, Brave, Tavily, Exa), and `map` says the rest.
+ *
+ * The card fetches nothing the tool's data does not name: no page, and no address of its
+ * own making — no favicon service is asked, no icon guessed at `/favicon.ico`. A picture or an
+ * icon the data names is loaded as given, wherever it is hosted (Brave's results name icons
+ * on Brave's own proxy). A site without an icon in the data gets its initial on a tinted
+ * square, and a page without a picture gets no picture.
+ *
+ * Every value is text. Search engines highlight the query in their snippets with markup
+ * (Brave's `<strong>`): those tags are dropped and the usual entities decoded, and what is
+ * left goes in as text — never parsed.
+ */
+import type { AparteConfig } from '@aparte/core';
+import { type CardSetupOptions } from '../kit/define.js';
+export type LinkType = 'article' | 'video' | 'repo' | 'product' | 'website';
+export type LinkVariant = 'card' | 'compact' | 'quote';
+/**
+ * A link as `map` returns it. Only `url` is needed; every other field adds a line when it is
+ * there and nothing when it is not. `readLinks` also reads the usual aliases (listed on each
+ * field).
+ */
+export interface LinkInput {
+    /** An `http(s)` page. Also `link`, `href`, `og:url`. */
+    url: string;
+    /** Falls back to the page's host. Also `og:title`, `twitter:title`, `meta.title`, `name`. */
+    title?: string;
+    /** Also `og:description`, `snippet`, `summary`, `content`. */
+    description?: string;
+    /** Also `og:image`, `twitter:image`, `thumbnail`, `open_graph.images[0].url`, `pagemap.cse_image[0].src`. */
+    image?: string;
+    /** Falls back to the host without `www.`. Also `og:site_name`, `site`, `publisher`, `source`. */
+    siteName?: string;
+    /** The site's icon, loaded as given. Without it, the site's initial on a tinted square — no icon address is made up. Also `icon`, `logo`, Brave's `meta_url.favicon`. */
+    favicon?: string;
+    /** Also `byline`, `article:author`, `authors[0]`. */
+    author?: string;
+    /** An ISO date or an epoch. Also `datePublished`, `published_date`, `date`, `article:published_time`. */
+    publishedAt?: string | number | Date;
+    /** The badge it wears. Read from `og:type` and the host (GitHub → repo, YouTube → video) when absent. */
+    type?: LinkType;
+    /** A colour for the quote's side rule: `#rgb` or `#rrggbb`. Also `theme-color`. */
+    themeColor?: string;
+}
+/** A link as the card draws it, once read. */
+export interface Link {
+    url: string;
+    /** The page's host without `www.` — what stands in for a missing title or site name. */
+    host: string;
+    title?: string;
+    description?: string;
+    image?: string;
+    siteName?: string;
+    favicon?: string;
+    author?: string;
+    publishedAt?: Date;
+    type: LinkType;
+    themeColor?: string;
+}
+/** The card's data: one link or several, and the collection's title. */
+export interface LinkData {
+    title?: string;
+    links: Link[];
+}
+export type LinkCardOptions = CardSetupOptions<LinkData, LinkVariant>;
+/**
+ * The card's data from what `map` returns: one link (an object, or its address), an array,
+ * or a collection (`{ title?, links | results | items | organic_results | sources }`, and
+ * Brave's `web.results`). At most ten; `null` when not one has an `http(s)` address.
+ */
+export declare function readLinks(raw: unknown): LinkData | null;
+/** The link card — for `linkCard.segment(data)`. Plug it in with `setupLinkCard`. */
+export declare const linkCard: {
+    name: string;
+    variants: readonly LinkVariant[];
+    setup: (options?: CardSetupOptions<LinkData, LinkVariant>) => () => void;
+    segment: (raw: unknown, options?: {
+        id?: string;
+        variant?: LinkVariant | undefined;
+        config?: AparteConfig;
+    }) => import("../index.js").AparteCardSegment;
+};
+/** Draw a tool's links as this card — returns the function that stops it. */
+export declare function setupLinkCard(options?: LinkCardOptions): () => void;
+//# sourceMappingURL=index.d.ts.map

package/dist/link/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/link/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAgC,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAOvF,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAC5E,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,6FAA6F;IAC7F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6GAA6G;IAC7G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iGAAiG;IACjG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yKAAyK;IACzK,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACrC,yGAAyG;IACzG,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,8CAA8C;AAC9C,MAAM,WAAW,IAAI;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,wFAAwF;IACxF,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,wEAAwE;AACxE,MAAM,WAAW,QAAQ;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,IAAI,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AA0JtE;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,QAAQ,GAAG,IAAI,CAmBvD;AAwND,qFAAqF;AACrF,eAAO,MAAM,QAAQ;;;;;;;;;CAWnB,CAAC;AAEH,6EAA6E;AAC7E,wBAAgB,aAAa,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,IAAI,CAEvE"}