@tiagojct/subsub 0.5.0 → 0.6.1

package/web/glauca.css

@@ -0,0 +1,106 @@
+/* Generated from glauca.json. Edit the json, then `make generate`. */
+:root {
+  --gl-font-serif: "IBM Plex Serif", "IBM Plex Serif fallback", Georgia, serif;
+  --gl-font-sans: "IBM Plex Sans", "IBM Plex Sans fallback", system-ui, sans-serif;
+  --gl-font-mono: "IBM Plex Mono", "IBM Plex Mono fallback", ui-monospace, monospace;
+  --gl-font-reading: "IBM Plex Sans", "IBM Plex Sans fallback", system-ui, sans-serif;
+  --gl-text-xs: 0.64rem;
+  --gl-text-sm: 0.8rem;
+  --gl-text-base: 1rem;
+  --gl-text-lg: 1.25rem;
+  --gl-text-xl: 1.563rem;
+  --gl-text-2xl: 1.953rem;
+  --gl-text-3xl: 2.441rem;
+  --gl-text-4xl: 3.052rem;
+  --gl-text-display: clamp(2.5rem, 6vw, 4rem);
+  --gl-text-poster: clamp(3rem, 10vw, 6.5rem);
+  --gl-leading-tight: 1.08;
+  --gl-leading-snug: 1.3;
+  --gl-leading-normal: 1.55;
+  --gl-leading-relaxed: 1.7;
+  --gl-weight-regular: 400;
+  --gl-weight-medium: 500;
+  --gl-weight-semibold: 600;
+  --gl-weight-bold: 700;
+  --gl-space-0: 0;
+  --gl-space-1: 0.25rem;
+  --gl-space-2: 0.5rem;
+  --gl-space-3: 0.75rem;
+  --gl-space-4: 1rem;
+  --gl-space-5: 1.25rem;
+  --gl-space-6: 1.5rem;
+  --gl-space-8: 2rem;
+  --gl-space-10: 2.5rem;
+  --gl-space-12: 3rem;
+  --gl-space-16: 4rem;
+  --gl-space-20: 5rem;
+  --gl-space-24: 6rem;
+  --gl-radius-none: 0;
+  --gl-radius-sm: 2px;
+  --gl-radius-md: 4px;
+  --gl-radius-lg: 6px;
+  --gl-radius-pill: 999px;
+  --gl-border-width: 1px;
+}
+
+/* Pruina is the light default; Profundum is dark. */
+:root,
+[data-mode="light"],
+[data-theme="light"],
+html[data-theme="light"] {
+  --gl-bg: #f0f4f6;
+  --gl-surface: #f7fafb;
+  --gl-surface-raised: #ffffff;
+  --gl-text: #16222a;
+  --gl-text-muted: #55646d;
+  --gl-border: #cdd7dc;
+  --gl-accent: #0b62cf;
+  --gl-accent-bright: #007aff;
+  --gl-accent-deep: #084b96;
+  --gl-on-accent: #f2f7fb;
+  --gl-tint-deep: #16303f;
+  --gl-tint: #35576b;
+  --gl-tint-bright: #3e6d84;
+  --gl-tint-pale: #b7cdd6;
+  --gl-on-tint: #f2f7fb;
+}
+
+[data-mode="dark"],
+[data-theme="dark"],
+html[data-theme="dark"] {
+  --gl-bg: #10161c;
+  --gl-surface: #171f26;
+  --gl-surface-raised: #1f2932;
+  --gl-text: #e8eef2;
+  --gl-text-muted: #8c8c8c;
+  --gl-border: #2a3540;
+  --gl-accent: #3d97ff;
+  --gl-accent-bright: #6cb2ff;
+  --gl-accent-deep: #007aff;
+  --gl-on-accent: #0b1218;
+  --gl-tint-deep: #142430;
+  --gl-tint: #2b4356;
+  --gl-tint-bright: #4d7391;
+  --gl-tint-pale: #93b7c9;
+  --gl-on-tint: #0d1720;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root:not([data-theme="light"]) {
+    --gl-bg: #10161c;
+    --gl-surface: #171f26;
+    --gl-surface-raised: #1f2932;
+    --gl-text: #e8eef2;
+    --gl-text-muted: #8c8c8c;
+    --gl-border: #2a3540;
+    --gl-accent: #3d97ff;
+    --gl-accent-bright: #6cb2ff;
+    --gl-accent-deep: #007aff;
+    --gl-on-accent: #0b1218;
+    --gl-tint-deep: #142430;
+    --gl-tint: #2b4356;
+    --gl-tint-bright: #4d7391;
+    --gl-tint-pale: #93b7c9;
+    --gl-on-tint: #0d1720;
+  }
+}

package/web/i18n.js

@@ -0,0 +1,287 @@
+// Labels for the web view, in English and European Portuguese. The language
+// follows Sub-Sub's language setting; replies follow it already.
+
+export const STRINGS = {
+	en: {
+		researcher: "Researcher",
+		librarian: "Librarian",
+		profile: "Profile",
+		model: "Model",
+		noModel: "No model",
+		newConversation: "New conversation",
+		actions: "Actions",
+		conversations: "Conversations",
+		noConversations: "No earlier conversations.",
+		send: "Send",
+		stop: "Stop",
+		placeholderResearcher: "Ask about your library, or type / for commands",
+		placeholderLibrarian: "Ask for a change to your library, or type / for commands",
+		yes: "Yes",
+		no: "No",
+		ok: "OK",
+		cancel: "Cancel",
+		close: "Close",
+		apply: "Apply {x}?",
+		run: "Run {x}?",
+		undo: "Undo this change?",
+		write: "Allow writing to {x}?",
+		approveHint: "Nothing changes until you select Yes.",
+		zoteroChecking: "Zotero: checking",
+		zoteroDown: "Zotero is not running",
+		items: "{n} items",
+		toReview: "{n} to review",
+		serversDown: "Not running: {x}",
+		working: "Working",
+		using: "Using: {x}",
+		failed: "failed",
+		result: "Result",
+		open: "Open",
+		stopped: "Stopped.",
+		agentExit: "Sub-Sub stopped.",
+		startAgain: "Start again",
+		disconnected: "Connection lost. Trying again.",
+		connectModel: "Connect a model to start.",
+		connect: "Connect",
+		modelTitle: "Model",
+		chooseModel: "Choose a model",
+		forBoth: "Use it in both modes",
+		noModels: "No models yet. Connect a provider below.",
+		connectProvider: "Connect a provider",
+		provider: "Provider",
+		apiKey: "API key",
+		save: "Save",
+		getKey: "Get a key",
+		keyNote: "The key is saved on this computer, in Sub-Sub's settings folder, and is sent only to that provider.",
+		oauthNote: "To sign in through a provider's website (for example with a subscription), open a terminal, type subsub, then /login.",
+		saving: "Saving",
+		saved: "Saved.",
+		busy: "Wait until Sub-Sub finishes.",
+		emptyTitle: "What would you like to do?",
+		quit: "Close Sub-Sub",
+		quitDone: "Sub-Sub is closed. You can close this tab.",
+		earlier: "Earlier messages were summarised.",
+		menu: "Menu",
+		commands: "Commands",
+		error: "Error",
+		theme: "Theme",
+		themeAuto: "System",
+		themeLight: "Light",
+		themeDark: "Dark",
+		themeToggle: "Toggle theme",
+		copy: "Copy",
+		copied: "Copied!",
+		copyNote: "Copy text",
+		searchConversations: "Search conversations...",
+		export: "Export",
+		exportTitle: "Export conversation",
+		confirmShortcutHint: "Y to approve, N to decline",
+	},
+	pt: {
+		researcher: "Investigador",
+		librarian: "Bibliotecário",
+		profile: "Perfil",
+		model: "Modelo",
+		noModel: "Sem modelo",
+		newConversation: "Nova conversa",
+		actions: "Ações",
+		conversations: "Conversas",
+		noConversations: "Ainda não há conversas anteriores.",
+		send: "Enviar",
+		stop: "Parar",
+		placeholderResearcher: "Pergunte sobre a sua biblioteca, ou escreva / para ver os comandos",
+		placeholderLibrarian: "Peça uma alteração à biblioteca, ou escreva / para ver os comandos",
+		yes: "Sim",
+		no: "Não",
+		ok: "OK",
+		cancel: "Cancelar",
+		close: "Fechar",
+		apply: "Aplicar {x}?",
+		run: "Executar {x}?",
+		undo: "Desfazer esta alteração?",
+		write: "Permitir escrever em {x}?",
+		approveHint: "Nada muda até selecionar Sim.",
+		zoteroChecking: "Zotero: a verificar",
+		zoteroDown: "O Zotero não está aberto",
+		items: "{n} itens",
+		toReview: "{n} por rever",
+		serversDown: "Parados: {x}",
+		working: "A trabalhar",
+		using: "A usar: {x}",
+		failed: "falhou",
+		result: "Resultado",
+		open: "Abrir",
+		stopped: "Parado.",
+		agentExit: "O Sub-Sub parou.",
+		startAgain: "Recomeçar",
+		disconnected: "Ligação perdida. A tentar de novo.",
+		connectModel: "Ligue um modelo para começar.",
+		connect: "Ligar",
+		modelTitle: "Modelo",
+		chooseModel: "Escolha um modelo",
+		forBoth: "Usar nos dois modos",
+		noModels: "Ainda não há modelos. Ligue um fornecedor abaixo.",
+		connectProvider: "Ligar um fornecedor",
+		provider: "Fornecedor",
+		apiKey: "Chave de API",
+		save: "Guardar",
+		getKey: "Obter uma chave",
+		keyNote: "A chave fica guardada neste computador, na pasta de definições do Sub-Sub, e só é enviada a esse fornecedor.",
+		oauthNote: "Para entrar através do site de um fornecedor (por exemplo, com uma subscrição), abra um terminal, escreva subsub e depois /login.",
+		saving: "A guardar",
+		saved: "Guardado.",
+		busy: "Espere que o Sub-Sub termine.",
+		emptyTitle: "O que quer fazer?",
+		quit: "Fechar o Sub-Sub",
+		quitDone: "O Sub-Sub está fechado. Pode fechar este separador.",
+		earlier: "As mensagens anteriores foram resumidas.",
+		menu: "Menu",
+		commands: "Comandos",
+		error: "Erro",
+		theme: "Tema",
+		themeAuto: "Sistema",
+		themeLight: "Claro",
+		themeDark: "Escuro",
+		themeToggle: "Mudar tema",
+		copy: "Copiar",
+		copied: "Copiado!",
+		copyNote: "Copiar texto",
+		searchConversations: "Procurar conversas...",
+		export: "Exportar",
+		exportTitle: "Exportar conversa",
+		confirmShortcutHint: "Y para aprovar, N para recusar",
+	},
+};
+
+/** Buttons in the side panel. `fill` puts the command in the message box; `send` runs it at once. */
+export const ACTIONS = {
+	researcher: [
+		{ cmd: "subsub", send: true, en: "Library overview", pt: "Resumo da biblioteca" },
+		{ cmd: "lit-note", fill: true, en: "Literature note", pt: "Nota de leitura" },
+		{ cmd: "synthesis", fill: true, en: "Synthesis", pt: "Síntese" },
+		{ cmd: "gaps", fill: true, en: "What is missing", pt: "O que falta" },
+		{ cmd: "manuscript", fill: true, en: "Check a manuscript", pt: "Verificar um manuscrito" },
+		{ cmd: "alert", send: true, en: "New publications", pt: "Novas publicações" },
+	],
+	librarian: [
+		{ cmd: "subsub", send: true, en: "Library overview", pt: "Resumo da biblioteca" },
+		{ cmd: "tag-batch 10", send: true, en: "Tag 10 items", pt: "Etiquetar 10 itens" },
+		{ cmd: "clean-tags", send: true, en: "Clean up tags", pt: "Limpar etiquetas" },
+		{ cmd: "import-queue", send: true, en: "Import the queue", pt: "Importar a fila" },
+	],
+	both: [
+		{ cmd: "history", send: true, en: "Recent changes", pt: "Alterações recentes" },
+		{ cmd: "undo", send: true, en: "Undo the last change", pt: "Desfazer a última alteração" },
+	],
+};
+
+/** Suggestions on an empty conversation. */
+export const SUGGESTIONS = {
+	researcher: {
+		en: ["What do I have on ", "Find recent systematic reviews on ", "Which items have no PDF?"],
+		pt: ["O que tenho sobre ", "Procure revisões sistemáticas recentes sobre ", "Que itens não têm PDF?"],
+	},
+	librarian: {
+		en: ["Tag the next 10 items without a topic", "Import 10.1136/bmj.n71", "Find duplicates"],
+		pt: ["Etiquete os próximos 10 itens sem tópico", "Importe 10.1136/bmj.n71", "Procure duplicados"],
+	},
+};
+
+/** Plain names for the tools, shown while they run. Unknown tools keep their name. */
+export const TOOLS = {
+	en: {
+		find_items: "search the library",
+		get_item: "read an item",
+		get_fulltext: "read the full text",
+		library_overview: "library overview",
+		list_tags: "list tags",
+		list_collections: "list collections",
+		get_vocabulary: "read the tag list",
+		tag_items: "tag items",
+		remove_tags: "remove tags",
+		rename_tags: "rename tags",
+		remove_automatic_tags: "remove automatic tags",
+		trash_items: "move items to the trash",
+		update_fields: "update fields",
+		repair_metadata: "repair metadata",
+		import_identifiers: "import",
+		import_queue: "import the queue",
+		find_duplicates: "find duplicates",
+		check_retractions: "check retractions",
+		attach_oa_pdfs: "attach open-access PDFs",
+		missing_pdfs: "find items without a PDF",
+		create_note: "add a note",
+		create_collection: "create a collection",
+		file_items: "file items in a collection",
+		set_citekeys: "set citekeys",
+		tag_audit: "check tags",
+		audit_metadata: "check metadata",
+		write_tag_review: "write a tag review note",
+		apply_tag_review: "apply a tag review note",
+		history: "recent changes",
+		undo: "undo",
+		status: "Zotero status",
+		search_pubmed: "search PubMed",
+		search_openalex: "search OpenAlex",
+		get_work: "read a publication record",
+		citation_graph: "citations",
+		library_lookup: "check the library",
+		queue_imports: "queue imports",
+		attach_note: "add a linked note",
+		check_manuscript: "check a manuscript",
+		export_bibliography: "export a bibliography",
+		read: "read a file",
+		write: "write a file",
+		edit: "edit a file",
+		grep: "search files",
+		find: "find files",
+		ls: "list a folder",
+	},
+	pt: {
+		find_items: "pesquisar na biblioteca",
+		get_item: "ler um item",
+		get_fulltext: "ler o texto completo",
+		library_overview: "resumo da biblioteca",
+		list_tags: "listar etiquetas",
+		list_collections: "listar coleções",
+		get_vocabulary: "ler a lista de etiquetas",
+		tag_items: "etiquetar itens",
+		remove_tags: "retirar etiquetas",
+		rename_tags: "mudar o nome de etiquetas",
+		remove_automatic_tags: "retirar etiquetas automáticas",
+		trash_items: "mover itens para o lixo",
+		update_fields: "atualizar campos",
+		repair_metadata: "corrigir metadados",
+		import_identifiers: "importar",
+		import_queue: "importar a fila",
+		find_duplicates: "procurar duplicados",
+		check_retractions: "verificar retratações",
+		attach_oa_pdfs: "anexar PDF em acesso aberto",
+		missing_pdfs: "procurar itens sem PDF",
+		create_note: "acrescentar uma nota",
+		create_collection: "criar uma coleção",
+		file_items: "arquivar itens numa coleção",
+		set_citekeys: "definir citekeys",
+		tag_audit: "verificar etiquetas",
+		audit_metadata: "verificar metadados",
+		write_tag_review: "escrever uma nota de revisão de etiquetas",
+		apply_tag_review: "aplicar uma nota de revisão de etiquetas",
+		history: "alterações recentes",
+		undo: "desfazer",
+		status: "estado do Zotero",
+		search_pubmed: "pesquisar na PubMed",
+		search_openalex: "pesquisar na OpenAlex",
+		get_work: "ler o registo de uma publicação",
+		citation_graph: "citações",
+		library_lookup: "verificar a biblioteca",
+		queue_imports: "pôr importações na fila",
+		attach_note: "acrescentar uma nota ligada",
+		check_manuscript: "verificar um manuscrito",
+		export_bibliography: "exportar uma bibliografia",
+		read: "ler um ficheiro",
+		write: "escrever um ficheiro",
+		edit: "editar um ficheiro",
+		grep: "pesquisar em ficheiros",
+		find: "procurar ficheiros",
+		ls: "listar uma pasta",
+	},
+};

package/web/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32"><rect width="32" height="32" rx="6" fill="#12161b"/><text x="16" y="21.5" text-anchor="middle" font-family="IBM Plex Mono, ui-monospace, monospace" font-size="14" font-weight="600" fill="#e0832a">SS</text></svg>

package/web/index.html

@@ -0,0 +1,122 @@
+<!doctype html>
+<html lang="en">
+<head>
+	<meta charset="utf-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<meta name="color-scheme" content="light dark">
+	<title>Sub-Sub</title>
+	<link rel="icon" href="/icon.svg" type="image/svg+xml">
+	<link rel="stylesheet" href="/glauca.css">
+	<link rel="stylesheet" href="/app.css">
+	<script type="module" src="/app.js"></script>
+</head>
+<body data-mode="researcher">
+	<div class="app">
+		<header class="top">
+			<button type="button" class="ghost menu-btn" id="menu-btn" aria-controls="side" aria-expanded="false" data-i18n="menu">Menu</button>
+			<div class="brand"><span class="mark" aria-hidden="true">SS</span> Sub-Sub</div>
+			<div class="modes" role="group" aria-label="Mode">
+				<button type="button" data-mode="researcher" aria-pressed="true" data-i18n="researcher">Researcher</button>
+				<button type="button" data-mode="librarian" aria-pressed="false" data-i18n="librarian">Librarian</button>
+			</div>
+			<div class="status">
+				<span class="library" id="library"><span class="library-dot" aria-hidden="true"></span><span class="library-text"></span></span>
+				<label class="profile"><span class="visually-hidden" data-i18n="profile">Profile</span>
+					<select id="profile">
+						<option value="reader">Reader</option>
+						<option value="scholar">Scholar</option>
+						<option value="author">Author</option>
+						<option value="editor">Editor</option>
+					</select>
+				</label>
+				<button type="button" class="ghost model-btn" id="model-btn"></button>
+				<button type="button" class="ghost theme-btn" id="theme-btn" aria-label="Toggle theme" title="Toggle theme"></button>
+			</div>
+		</header>
+
+		<aside class="side" id="side">
+			<button type="button" class="primary block" id="new-btn" data-i18n="newConversation">New conversation</button>
+			<section class="phone-only settings">
+				<label><span data-i18n="profile">Profile</span>
+					<select id="profile-side">
+						<option value="reader">Reader</option>
+						<option value="scholar">Scholar</option>
+						<option value="author">Author</option>
+						<option value="editor">Editor</option>
+					</select>
+				</label>
+				<label><span data-i18n="model">Model</span>
+					<button type="button" class="secondary model-btn" id="model-btn-side"></button>
+				</label>
+				<label><span data-i18n="theme">Theme</span>
+					<button type="button" class="secondary theme-btn" id="theme-btn-side"></button>
+				</label>
+			</section>
+			<section>
+				<h2 data-i18n="actions">Actions</h2>
+				<div class="actions" id="actions"></div>
+			</section>
+			<section class="grow">
+				<div class="side-subhead">
+					<h2 data-i18n="conversations">Conversations</h2>
+					<button type="button" class="ghost small" id="export-btn" title="Export conversation as Markdown" data-i18n="export">Export</button>
+				</div>
+				<div class="search-wrap">
+					<input type="search" id="session-search" placeholder="Search conversations..." autocomplete="off">
+				</div>
+				<ul class="sessions" id="sessions"></ul>
+			</section>
+			<footer class="side-foot">
+				<button type="button" class="ghost small" id="quit-btn" data-i18n="quit">Close Sub-Sub</button>
+				<span class="version" id="version"></span>
+			</footer>
+		</aside>
+
+		<main class="chat" id="main">
+			<div class="banner" id="banner" hidden></div>
+			<div class="log" id="log" aria-live="polite"></div>
+			<form class="composer" id="composer">
+				<div class="suggest" id="suggest" role="listbox" hidden></div>
+				<textarea id="input" rows="2" autocomplete="off" spellcheck="true"></textarea>
+				<div class="composer-buttons">
+					<button type="button" class="secondary" id="stop" hidden data-i18n="stop">Stop</button>
+					<button type="submit" class="primary" id="send" data-i18n="send">Send</button>
+				</div>
+			</form>
+		</main>
+	</div>
+
+	<dialog id="dialog" class="modal">
+		<form method="dialog" id="dialog-form">
+			<h2 id="dialog-title"></h2>
+			<p class="hint" id="dialog-hint"></p>
+			<pre class="preview" id="dialog-message"></pre>
+			<div id="dialog-body"></div>
+			<div class="modal-buttons" id="dialog-buttons"></div>
+		</form>
+	</dialog>
+
+	<dialog id="model-dialog" class="modal wide">
+		<div class="modal-head">
+			<h2 data-i18n="modelTitle">Model</h2>
+			<button type="button" class="ghost small" id="model-close" data-i18n="close">Close</button>
+		</div>
+		<h3 data-i18n="chooseModel">Choose a model</h3>
+		<label class="check"><input type="checkbox" id="model-both" checked> <span data-i18n="forBoth">Use it in both modes</span></label>
+		<ul class="models" id="models"></ul>
+		<h3 data-i18n="connectProvider">Connect a provider</h3>
+		<form id="login-form" class="login">
+			<label><span data-i18n="provider">Provider</span>
+				<select id="login-provider"></select>
+			</label>
+			<label><span data-i18n="apiKey">API key</span>
+				<input type="password" id="login-key" autocomplete="off" spellcheck="false" required>
+			</label>
+			<p class="small"><a id="login-link" href="#" target="_blank" rel="noopener noreferrer" data-i18n="getKey">Get a key</a></p>
+			<p class="small muted" data-i18n="keyNote"></p>
+			<div class="modal-buttons"><button type="submit" class="primary" id="login-save" data-i18n="save">Save</button></div>
+			<p class="small muted" data-i18n="oauthNote"></p>
+		</form>
+	</dialog>
+</body>
+</html>