mirror of
https://github.com/dotwee/obsidian-raindropio-plugin.git
synced 2026-07-22 06:50:29 +00:00
c12cf641b1
Add comma-separated show and hide keys to fenced raindrop blocks, layered on top of the result display settings. Unknown field names produce a warning above the rendered results. Collection titles are fetched lazily and cached, only when a block or the explorer shows the collection field. Co-authored-by: Cursor <cursoragent@cursor.com>
101 lines
3 KiB
TypeScript
101 lines
3 KiB
TypeScript
import { isRaindropFieldName, RAINDROP_FIELD_NAMES, type RaindropDisplayFields } from "./renderer";
|
|
|
|
export interface RaindropBlockOptions {
|
|
collectionId?: number;
|
|
search?: string;
|
|
tag?: string;
|
|
sort?: string;
|
|
limit?: number;
|
|
showFields?: (keyof RaindropDisplayFields)[];
|
|
hideFields?: (keyof RaindropDisplayFields)[];
|
|
}
|
|
|
|
export interface ParsedRaindropBlock {
|
|
options: RaindropBlockOptions;
|
|
warnings: string[];
|
|
}
|
|
|
|
function parseKeyValueLines(source: string): Record<string, string> {
|
|
const out: Record<string, string> = {};
|
|
for (const rawLine of source.split("\n")) {
|
|
const line = rawLine.trim();
|
|
if (!line || line.startsWith("#")) continue;
|
|
|
|
const idx = line.indexOf(":");
|
|
if (idx === -1) continue;
|
|
|
|
const key = line.slice(0, idx).trim();
|
|
const value = line.slice(idx + 1).trim();
|
|
if (key) out[key] = value;
|
|
}
|
|
return out;
|
|
}
|
|
|
|
function clampLimit(limit: number, { min, max }: { min: number; max: number }): number {
|
|
if (!Number.isFinite(limit)) return min;
|
|
return Math.max(min, Math.min(max, Math.floor(limit)));
|
|
}
|
|
|
|
function parseFieldList(
|
|
raw: string | undefined,
|
|
key: "show" | "hide",
|
|
warnings: string[],
|
|
): (keyof RaindropDisplayFields)[] | undefined {
|
|
if (raw === undefined) return undefined;
|
|
|
|
const fields: (keyof RaindropDisplayFields)[] = [];
|
|
for (const entry of raw.split(",")) {
|
|
const name = entry.trim().toLowerCase();
|
|
if (!name) continue;
|
|
|
|
if (isRaindropFieldName(name)) {
|
|
if (!fields.includes(name)) fields.push(name);
|
|
} else {
|
|
warnings.push(`Unknown field \`${name}\` in \`${key}\`; expected one of ${RAINDROP_FIELD_NAMES.join(", ")}.`);
|
|
}
|
|
}
|
|
|
|
return fields.length > 0 ? fields : undefined;
|
|
}
|
|
|
|
export function parseRaindropBlock(source: string): ParsedRaindropBlock {
|
|
const warnings: string[] = [];
|
|
const kv = parseKeyValueLines(source);
|
|
|
|
const collectionRaw = kv.collection ?? kv.collectionId;
|
|
const collectionId = collectionRaw === undefined ? undefined : Number(collectionRaw);
|
|
if (collectionId !== undefined && (!Number.isFinite(collectionId) || collectionId < 0)) {
|
|
warnings.push("Invalid `collection`; using the default collection.");
|
|
}
|
|
|
|
const limitRaw = kv.limit;
|
|
const limit = limitRaw ? clampLimit(Number(limitRaw), { min: 1, max: 100 }) : undefined;
|
|
if (limitRaw && !Number.isFinite(Number(limitRaw))) {
|
|
warnings.push("Invalid `limit`; using the plugin default.");
|
|
}
|
|
|
|
const tag = kv.tag?.trim() || undefined;
|
|
const search = kv.search?.trim() || undefined;
|
|
const sort = kv.sort?.trim() || undefined;
|
|
const showFields = parseFieldList(kv.show, "show", warnings);
|
|
const hideFields = parseFieldList(kv.hide, "hide", warnings);
|
|
|
|
return {
|
|
options: {
|
|
collectionId: collectionId !== undefined && Number.isFinite(collectionId) && collectionId >= 0 ? collectionId : undefined,
|
|
tag,
|
|
search,
|
|
sort,
|
|
limit,
|
|
showFields,
|
|
hideFields,
|
|
},
|
|
warnings,
|
|
};
|
|
}
|
|
|
|
export function extractFirstRaindropBlock(source: string): string | null {
|
|
const match = source.match(/```raindrop\s*\n([\s\S]*?)```/i);
|
|
const block = match?.[1];
|
|
return typeof block === "string" ? block : null;
|
|
}
|