logseq / logseq/plugins

[Feature Request] Extend Plugin API for full ontology import/export parity in DB graphs

Ouverte
#32 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
HTML
Étoiles
26
Forks
8
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Problem Statement

The Plugin API for DB graphs does not support all fields that Logseq exports in its native EDN format. This prevents plugins from implementing complete ontology import/export functionality.

When users export ontology from a DB graph and attempt to re-import it via a plugin, some data is lost:

Data Type Fields in EDN Export Fields Settable via API Lost on Import
Properties 14 10 4 fields (29%)
Classes/Tags 7 6 1 field (14%)
What Works (Discovered Feb 2025)

Through extensive console testing, we discovered workarounds for several fields:

System Description Field

Using the full namespaced key with upsertBlockProperty sets the system description:

// ❌ WRONG - creates a user property named "description"
await logseq.Editor.upsertBlockProperty(uuid, 'description', 'My description')

// ✅ CORRECT - sets the system logseq.property/description field
await logseq.Editor.upsertBlockProperty(uuid, ':logseq.property/description', 'My description')

The value is stored as an entity reference (Logseq creates a new entity containing the text).

Tabler Icons on Properties and Tags

setBlockIcon() works for Tabler icons on properties and tags:

// ✅ Works - Tabler icon on property
const prop = await logseq.Editor.getProperty('my-property')
await logseq.Editor.setBlockIcon(prop.uuid, 'tabler-icon', 'star')

// ✅ Works - Tabler icon on tag
const tag = await logseq.Editor.getTag('MyTag')
await logseq.Editor.setBlockIcon(tag.uuid, 'tabler-icon', 'folder')
What Doesn't Work
Emoji Icons - Lookup Table Inaccessible

setBlockIcon() fails for all emoji formats:

await logseq.Editor.setBlockIcon(uuid, 'emoji', 'rocket')     // ❌ "Can't find emoji for rocket"
await logseq.Editor.setBlockIcon(uuid, 'emoji', '🚀')         // ❌ "Can't find emoji for 🚀"
await logseq.Editor.setBlockIcon(uuid, 'emoji', ':rocket:')   // ❌ "Can't find emoji for :rocket:"

Root cause: Logseq's emoji lookup table is internal and not accessible to plugins. The EDN export shows emojis stored with numeric IDs (e.g., {:type :emoji, :id "100"}) but there's no way for plugins to discover or use these IDs.

Class/Tag Title - Ownership Restriction

Attempting to set :logseq.class/title fails:

await logseq.Editor.upsertBlockProperty(tagUuid, ':logseq.class/title', 'My Display Title')
// ❌ Error: "Plugins can only upsert its own properties"

Unlike :logseq.property/description which works, the title field is blocked.

Remaining Fields Not Settable via Plugin API
Properties
Missing Field Impact
icon (emoji only) Cannot set emoji icons (Tabler icons work)
closedValues Cannot create enum/choice/select properties
datetime type Must downgrade to date (loses time component)
position Cannot control UI ordering
default Cannot set default values
Classes/Tags
Missing Field Impact
icon (emoji only) Cannot set emoji icons (Tabler icons work)
title Cannot set display name (blocked by ownership restriction)
position Cannot control UI ordering
Use Case

I'm building an ontology import plugin that allows users to:

  1. Export ontology definitions from one DB graph
  2. Share them via a marketplace/repository
  3. Import them into another DB graph

Currently, imported ontologies lose emoji icons, enum configurations (closedValues), and display titles. Tabler icons and descriptions now import successfully.

Proposed Solutions
1. Expose emoji lookup or accept emoji characters directly

Either:

  • Option A: Accept emoji characters directly in setBlockIcon: setBlockIcon(uuid, 'emoji', '🚀')
  • Option B: Accept standard emoji names: setBlockIcon(uuid, 'emoji', 'rocket')
  • Option C: Document the emoji ID format so plugins can use it
2. Add closedValues support to upsertProperty
upsertProperty(key: string, schema?: {
  // Existing fields...

  // Requested addition
  closedValues?: Array<{
    value: string;
    icon?: { type: "emoji" | "tabler-icon"; id: string };
    description?: string;
  }>;
}): Promise<IEntityID>
3. Allow setting class/tag title

Either remove the ownership restriction for :logseq.class/title or add it to the createTag options:

createTag(name: string, opts?: {
  uuid?: string;  // Existing
  title?: string; // Requested
}): Promise<PageEntity>
4. Add datetime property type

Currently datetime must be downgraded to date, losing the time component.

Priority Ranking
  1. 🔴 Critical: Fix emoji icon setting (expose lookup or accept characters) - Icons are the primary visual identity of ontology elements; losing them during import significantly degrades the user experience
  2. 🔴 Critical: Add closedValues support to upsertProperty - Required for enum/select properties
  3. 🟡 Medium: Allow setting class/tag title
  4. 🟡 Medium: Add datetime property type
  5. 🟢 Low: Add position to schema APIs
Environment
  • Logseq version: 2.0.0 (DB graph mode)
  • Platform: Windows
  • Plugin API version: @logseq/libs latest
What We Learned (Testing Details)

For reference, here's what we discovered through console testing:

Feature Method Status
System Description upsertBlockProperty(uuid, ':logseq.property/description', text) ✅ Works
Tabler Icons setBlockIcon(uuid, 'tabler-icon', 'iconName') ✅ Works
Emoji Icons setBlockIcon(uuid, 'emoji', ...) ❌ All formats fail
Class Title upsertBlockProperty(uuid, ':logseq.class/title', text) ❌ Ownership blocked
Icon via upsertBlockProperty upsertBlockProperty(uuid, ':logseq.property/icon', {...}) ❌ Renders "Invalid icon"

Key insight: setBlockIcon stores icons as {type: 'tablerIcon', id: 'name'} (camelCase), but setting this format directly via upsertBlockProperty still renders as "Invalid icon" - there's internal processing in setBlockIcon that can't be replicated.

Additional Context

Full field-by-field reconciliation available here: API Field Reconciliation Document

This enhancement would enable a richer ecosystem of ontology sharing and template plugins for DB graphs.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les points d’entrée de @logseq/libs nommés dans l’issue : setBlockIcon, upsertProperty, upsertBlockProperty et createTag. Lisez docs/api-field-reconciliation.md et reproduisez les lacunes documentées de l’importation/exportation du graphe DB ; le travail est terminé lorsque les champs d’ontologie demandés, notamment les icônes emoji, closedValues, les titres, datetime et position, peuvent effectuer un aller-retour via l’API du plugin.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.