@cube-drone/marquee-turbolink 0.1.0

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.
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,134 @@
1
+ # marquee-turbolink
2
+
3
+ Link expanders as plugins. The Marquee renderer owns the floor (a plain link, always) and the
4
+ socket (`Profile.turbolink`); this library is what embedders plug into it — an image link
5
+ unfurls into a picture, an mp3 into play controls, YouTube into a playable embed, and whatever
6
+ link kinds 2035 brings into whatever they deserve.
7
+
8
+ ## The plugin contract
9
+
10
+ ```ts
11
+ interface TurbolinkPlugin {
12
+ name: string;
13
+ match(target: string): boolean; // cheap recognition
14
+ resolve?(target: string): Promise<unknown>; // async; the ONLY place network is allowed
15
+ render(target, { level, data }): string | null; // sync, pure; null = decline
16
+ }
17
+ ```
18
+
19
+ Two phases on purpose: `resolve()` gathers (OpenGraph fetches live here — run
20
+ `resolveTargets()` as a fetch-ahead pass for static builds, or on mount in interactive
21
+ renderers); `render()` is synchronous and deterministic, which is all the Marquee renderer
22
+ ever calls. Nothing can fetch mid-render.
23
+
24
+ Wiring it up:
25
+
26
+ ```ts
27
+ import { composeTurbolinks, defaultPlugins } from "marquee-turbolink";
28
+
29
+ const profile = {
30
+ ...bareWebProfile,
31
+ turbolink: composeTurbolinks([myPlatformPlugin, ...defaultPlugins]),
32
+ };
33
+ ```
34
+
35
+ First plugin that matches *and* renders wins; a declined or unmatched target falls to the
36
+ renderer's plain-link floor. And whatever a plugin renders, the renderer's wrapper appends
37
+ the original link beside it — enrichment augments, never replaces, and that guarantee is
38
+ structural: plugins don't need to remember it, and can't forget it. `defaultPlugins` is entirely fetchless (YouTube and Spotify embed
39
+ URLs are derivable; media kinds are extensions); `opengraphPlugin` fetches and is exported
40
+ separately — opting into network is a deliberate act.
41
+
42
+ ## Your markup, your styles — declared, not distributed
43
+
44
+ Plugins own their presentation, so they own its skin — as a `css` string field on the plugin
45
+ itself. `turbolinkStyles(plugins)` collects the skins of exactly the chain you composed
46
+ (deduplicating shared chunks, always including the standard card's baseline) into one
47
+ artifact: emit it in a `<style>` block, or write it to a bundle file at build time. Importing
48
+ a plugin imports its style; there is no per-plugin file scavenger hunt to get wrong.
49
+
50
+ ```ts
51
+ const plugins = [myPlatformPlugin, ...defaultPlugins];
52
+ const profile = { ...bareWebProfile, turbolink: composeTurbolinks(plugins) };
53
+ const styles = turbolinkStyles(plugins); // one string, same list, nothing forgotten
54
+ ```
55
+
56
+ (Why not inline `style=` attributes on the markup instead? Inline styles can't express
57
+ `@media (prefers-reduced-motion)`, hover, or breakpoints — and they defeat embedder theming,
58
+ since inline beats every stylesheet rule. Classes + collected CSS keep plugins themeable and
59
+ motion-respectful.)
60
+
61
+ ## Safety
62
+
63
+ Plugins are embedder-trusted code, exactly like `Profile.directive`. Author bytes only ever
64
+ enter as the `target` string: escape everything you interpolate (`escapeText` / `escapeAttr`
65
+ are exported for exactly that), and `renderCard` handles it for you on the common path.
66
+
67
+ Tests are this package's own (`npm test`) — renderer goldens never depend on plugin behavior.
68
+
69
+ ## Writing a plugin
70
+
71
+ The complete worked example lives in
72
+ [`ts/marquee-turbolink-example-plugin`](../turbolink-example-plugin/): a plugin that recognizes
73
+ `https://marquee.click/...` links, performs a ritual HTTP request in its resolve phase and
74
+ throws the answer away, then renders the link's path in `<strong>`. It does almost nothing —
75
+ correctly — so every part of the contract is legible. The walkthrough:
76
+
77
+ **1. `match()` is cheap recognition.** It runs against every turbolink target in a document,
78
+ so keep it to a prefix or regex test — no parsing, no allocation drama, definitely no I/O:
79
+
80
+ ```ts
81
+ match: (target) => target.startsWith("https://marquee.click/"),
82
+ ```
83
+
84
+ **2. `css` is your skin, declared on the plugin.** The example mints one class, so it
85
+ declares one rule — collected by `turbolinkStyles()` along with every other composed plugin's,
86
+ so it travels wherever the plugin goes. Namespace classes to your plugin (`marquee-click-*`);
87
+ the `mq-*` prefix belongs to Marquee's own vocabulary.
88
+
89
+ ```ts
90
+ css: `.marquee-click-path { color: rebeccapurple; font-size: 1.5em; }`,
91
+ ```
92
+
93
+ **3. `resolve()` is where network lives — and nowhere else.** It's async, it may fetch, and
94
+ it runs *ahead of rendering* (a fetch-ahead pass over `turbolinkTargets(doc)` for static
95
+ builds; on mount for interactive renderers). Whatever it returns arrives in `render()` as
96
+ `ctx.data`. Return `null` to say "nothing gathered." If your plugin needs no network — most
97
+ don't — omit `resolve` entirely.
98
+
99
+ ```ts
100
+ async resolve(target) {
101
+ await fetch("https://example.org/"); // the example discards this, honestly
102
+ return { ritualComplete: true };
103
+ },
104
+ ```
105
+
106
+ **4. `render()` is sync, pure, and deterministic.** Given the same target, level, and data,
107
+ it returns the same string forever — no clocks, no randomness, no fetching. Two pieces of
108
+ etiquette:
109
+
110
+ - **Decline with `null`** when you have nothing appropriate — the chain continues and the
111
+ renderer's plain-link floor catches everything. The default plugins all decline below
112
+ `level=full`; a player is not a "title."
113
+ - **Escape everything you interpolate.** The target (and anything derived from it) is author
114
+ bytes. Use the exported `escapeText`/`escapeAttr`, or hand your facts to `renderCard` and
115
+ let the standard card do it.
116
+
117
+ ```ts
118
+ render(target, { level }) {
119
+ if (level !== "full") return null;
120
+ const path = target.slice("https://marquee.click".length).split(/[?#]/, 1)[0]!;
121
+ return `<strong class="marquee-click-path">${escapeText(path)}</strong>`;
122
+ },
123
+ ```
124
+
125
+ **5. Test the pure parts.** `match()` and `render()` need no network by construction, so a
126
+ plugin's test suite is fetchless: recognition, escaping (feed it a `<b>` in the path),
127
+ decline behavior, and a `composeTurbolinks([yours, ...defaultPlugins])` integration check.
128
+ See the example's `test/plugin.test.ts`.
129
+
130
+ Then hand it to the chain, ahead of anything it should outrank:
131
+
132
+ ```ts
133
+ turbolink: composeTurbolinks([marqueeClickPlugin, ...defaultPlugins]);
134
+ ```
package/dist/card.d.ts ADDED
@@ -0,0 +1,11 @@
1
+ import type { TurbolinkLevel } from "./index.ts";
2
+ export interface TurbolinkSummary {
3
+ title?: string;
4
+ description?: string;
5
+ image?: string;
6
+ site?: string;
7
+ }
8
+ /** The card's skin. Always included by turbolinkStyles() - the keyhole's
9
+ * look is the library baseline, whichever plugins use it. */
10
+ export declare const cardCss = ".mq-turbolink-card {\n display: grid;\n grid-template-columns: 1fr auto;\n gap: 0.15rem 0.75rem;\n border: 1px solid rgba(136, 136, 136, 0.33);\n border-left-width: 4px;\n border-radius: 0.375rem;\n padding: 0.5rem 0.75rem;\n}\n.mq-turbolink-site { font-size: 0.8em; opacity: 0.6; }\n.mq-turbolink-title { font-weight: 600; text-decoration: none; }\n.mq-turbolink-desc { font-size: 0.9em; opacity: 0.85; }\n.mq-turbolink-thumb {\n grid-column: 2;\n grid-row: 1 / span 3;\n width: 6rem;\n height: 6rem;\n object-fit: cover;\n border-radius: 0.25rem;\n}\n.mq-turbolink-rich .mq-turbolink-card {\n border: none;\n padding: 0;\n}";
11
+ export declare function renderCard(target: string, summary: TurbolinkSummary, level: TurbolinkLevel): string;
package/dist/card.js ADDED
@@ -0,0 +1,51 @@
1
+ // The standard summary card - the safe keyhole. Plugins that just have
2
+ // facts (title, description, image, site) call this and inherit the shared
3
+ // mq-turbolink-* look and its escaping; plugins with richer ideas write
4
+ // their own markup and own their own escaping.
5
+ import { escapeAttr, escapeText } from "./escape.js";
6
+ function siteOf(target) {
7
+ const m = /^[A-Za-z][A-Za-z0-9+.-]*:\/\/([^/]+)/.exec(target);
8
+ return m?.[1];
9
+ }
10
+ /** The card's skin. Always included by turbolinkStyles() - the keyhole's
11
+ * look is the library baseline, whichever plugins use it. */
12
+ export const cardCss = `.mq-turbolink-card {
13
+ display: grid;
14
+ grid-template-columns: 1fr auto;
15
+ gap: 0.15rem 0.75rem;
16
+ border: 1px solid rgba(136, 136, 136, 0.33);
17
+ border-left-width: 4px;
18
+ border-radius: 0.375rem;
19
+ padding: 0.5rem 0.75rem;
20
+ }
21
+ .mq-turbolink-site { font-size: 0.8em; opacity: 0.6; }
22
+ .mq-turbolink-title { font-weight: 600; text-decoration: none; }
23
+ .mq-turbolink-desc { font-size: 0.9em; opacity: 0.85; }
24
+ .mq-turbolink-thumb {
25
+ grid-column: 2;
26
+ grid-row: 1 / span 3;
27
+ width: 6rem;
28
+ height: 6rem;
29
+ object-fit: cover;
30
+ border-radius: 0.25rem;
31
+ }
32
+ .mq-turbolink-rich .mq-turbolink-card {
33
+ border: none;
34
+ padding: 0;
35
+ }`;
36
+ export function renderCard(target, summary, level) {
37
+ const href = escapeAttr(target);
38
+ const site = summary.site ?? siteOf(target);
39
+ let card = "";
40
+ if (site !== undefined) {
41
+ card += `<span class="mq-turbolink-site">${escapeText(site)}</span>`;
42
+ }
43
+ card += `<a class="mq-turbolink-title" href="${href}">${escapeText(summary.title ?? target)}</a>`;
44
+ if (level === "full" && summary.description !== undefined) {
45
+ card += `<span class="mq-turbolink-desc">${escapeText(summary.description)}</span>`;
46
+ }
47
+ if (level === "full" && summary.image !== undefined) {
48
+ card += `<img class="mq-turbolink-thumb" src="${escapeAttr(summary.image)}" alt="" loading="lazy">`;
49
+ }
50
+ return `<span class="mq-turbolink-card">${card}</span>`;
51
+ }
@@ -0,0 +1,2 @@
1
+ export declare function escapeText(s: string): string;
2
+ export declare function escapeAttr(s: string): string;
package/dist/escape.js ADDED
@@ -0,0 +1,9 @@
1
+ // Local escaping (duplicated from the html renderer on purpose: this
2
+ // library stands alone - plugins for other renderers shouldn't drag the
3
+ // HTML renderer in as a dependency).
4
+ export function escapeText(s) {
5
+ return s.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
6
+ }
7
+ export function escapeAttr(s) {
8
+ return escapeText(s).replaceAll('"', "&quot;");
9
+ }
@@ -0,0 +1,44 @@
1
+ import type { Node } from "@cube-drone/marquee-parser";
2
+ export type TurbolinkLevel = "full" | "title" | "bare";
3
+ export interface TurbolinkContext {
4
+ level: TurbolinkLevel;
5
+ /** Whatever this plugin's resolve() produced for this target, if it ran. */
6
+ data: unknown;
7
+ }
8
+ export interface TurbolinkPlugin {
9
+ name: string;
10
+ /** Cheap recognition; render()/resolve() run only when this is true. */
11
+ match(target: string): boolean;
12
+ /** Optional async gathering - the ONLY place network is allowed. */
13
+ resolve?(target: string): Promise<unknown>;
14
+ /** Sync and pure. Return HTML, or null to decline (the chain continues;
15
+ * the renderer's plain-link floor catches everything). */
16
+ render(target: string, ctx: TurbolinkContext): string | null;
17
+ /** The stylesheet for the markup render() emits, as a string - collected
18
+ * by turbolinkStyles(), so importing a plugin imports its skin and no
19
+ * per-plugin file scavenger hunt exists. Plugins sharing rules assign the
20
+ * same string constant (aggregation dedupes by content). */
21
+ css?: string;
22
+ }
23
+ /** Everything the composed chain needs styled, once: the standard card's
24
+ * skin (renderCard is the library's keyhole, so its skin is baseline) plus
25
+ * each plugin's declared css, deduplicated. Emit it in a <style> block or
26
+ * write it to a bundle file at build time - either way it's one artifact
27
+ * derived from the same list you composed. */
28
+ export declare function turbolinkStyles(plugins: TurbolinkPlugin[]): string;
29
+ /** Compose a plugin chain into the shape Profile.turbolink wants. First
30
+ * plugin that matches AND renders wins. */
31
+ export declare function composeTurbolinks(plugins: TurbolinkPlugin[], resolved?: Map<string, unknown>): (target: string, level: TurbolinkLevel) => string | null;
32
+ /** The fetch-ahead pass: run every matching plugin's resolve() over a
33
+ * target list, yielding the map composeTurbolinks() consumes. Targets
34
+ * resolve concurrently (wall-clock is the slowest fetch, not the sum);
35
+ * within one target, plugins still run in order - first resolver wins,
36
+ * like first renderer. */
37
+ export declare function resolveTargets(targets: string[], plugins: TurbolinkPlugin[]): Promise<Map<string, unknown>>;
38
+ /** Every turbolink target in a parsed document (bare-paragraph nodes and
39
+ * explicit :::turbolink directives) - the fetch-ahead pass's shopping list. */
40
+ export declare function turbolinkTargets(node: Node): string[];
41
+ export { escapeAttr, escapeText } from "./escape.ts";
42
+ export { cardCss, renderCard, type TurbolinkSummary } from "./card.ts";
43
+ export { audioPlugin, defaultPlugins, imagePlugin, mapsPlugin, spotifyPlugin, videoPlugin, youtubePlugin, } from "./plugins.ts";
44
+ export { opengraphPlugin, parseOpenGraph } from "./opengraph.ts";