django-spire 0.23.4__py3-none-any.whl

django_spire/knowledge/migrations/0001_initial.py

@@ -0,0 +1,95 @@
+# Generated by Django 5.2.3 on 2025-08-04 15:39
+
+import django.db.models.deletion
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('django_spire_auth_user', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Collection',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('order', models.PositiveIntegerField(default=0, editable=False)),
+                ('name', models.CharField(max_length=255)),
+                ('description', models.TextField()),
+                ('parent', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='children', related_query_name='child', to='django_spire_knowledge.collection')),
+            ],
+            options={
+                'verbose_name': 'Collection',
+                'verbose_name_plural': 'Collections',
+                'db_table': 'django_spire_knowledge_collection',
+            },
+        ),
+        migrations.CreateModel(
+            name='Entry',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('order', models.PositiveIntegerField(default=0, editable=False)),
+                ('name', models.CharField(max_length=255)),
+                ('collection', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='entries', related_query_name='entry', to='django_spire_knowledge.collection')),
+            ],
+            options={
+                'verbose_name': 'Entry',
+                'verbose_name_plural': 'Entries',
+                'db_table': 'django_spire_knowledge_entry',
+            },
+        ),
+        migrations.CreateModel(
+            name='EntryVersion',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('published_datetime', models.DateTimeField(blank=True, null=True)),
+                ('last_edit_datetime', models.DateTimeField(default=django.utils.timezone.now)),
+                ('status', models.CharField(choices=[('draft', 'Draft'), ('published', 'Published'), ('archived', 'Archived')], default='draft', max_length=32)),
+                ('author', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='entry_versions', related_query_name='entry_version', to='django_spire_auth_user.authuser')),
+                ('entry', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='versions', related_query_name='version', to='django_spire_knowledge.entry')),
+            ],
+            options={
+                'verbose_name': 'Entry Version',
+                'verbose_name_plural': 'Entry Versions',
+                'db_table': 'django_spire_knowledge_entry_version',
+            },
+        ),
+        migrations.AddField(
+            model_name='entry',
+            name='current_version',
+            field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='current_version', related_query_name='current_version', to='django_spire_knowledge.entryversion'),
+        ),
+        migrations.CreateModel(
+            name='EntryVersionBlock',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('order', models.PositiveIntegerField(default=0, editable=False)),
+                ('type', models.CharField(choices=[('text', 'Text'), ('heading', 'Heading'), ('sub_heading', 'Sub Heading')], default='text', max_length=32)),
+                ('_block_data', models.JSONField()),
+                ('_text_data', models.TextField()),
+                ('version', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='blocks', related_query_name='block', to='django_spire_knowledge.entryversion')),
+            ],
+            options={
+                'verbose_name': 'Block',
+                'verbose_name_plural': 'Blocks',
+                'db_table': 'django_spire_knowledge_entry_version_block',
+            },
+        ),
+    ]

django_spire/knowledge/migrations/0002_alter_entryversionblock_type.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.5 on 2025-09-04 02:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_knowledge', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='entryversionblock',
+            name='type',
+            field=models.CharField(choices=[('text', 'Text'), ('heading', 'Heading'), ('sub_heading', 'Sub Heading'), ('list_item', 'List Item')], default='text', max_length=32),
+        ),
+    ]

django_spire/knowledge/migrations/0003_alter_collection_order_alter_entry_order_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.5 on 2025-09-06 00:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_knowledge', '0002_alter_entryversionblock_type'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='collection',
+            name='order',
+            field=models.PositiveIntegerField(default=0),
+        ),
+        migrations.AlterField(
+            model_name='entry',
+            name='order',
+            field=models.PositiveIntegerField(default=0),
+        ),
+        migrations.AlterField(
+            model_name='entryversionblock',
+            name='order',
+            field=models.PositiveIntegerField(default=0),
+        ),
+    ]

django_spire/knowledge/migrations/0004_alter_collection_options_collectiongroup.py

@@ -0,0 +1,27 @@
+# Generated by Django 5.2.6 on 2025-09-23 14:11
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_auth_group', '0001_initial'),
+        ('django_spire_knowledge', '0003_alter_collection_order_alter_entry_order_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='collection',
+            options={'permissions': [('can_access_all_collections', 'Can Access All Collections'), ('can_change_collection_groups', 'Can Change Collection Groups')], 'verbose_name': 'Collection', 'verbose_name_plural': 'Collections'},
+        ),
+        migrations.CreateModel(
+            name='CollectionGroup',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('auth_group', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='collection_groups', related_query_name='collection_group', to='django_spire_auth_group.authgroup')),
+                ('collection', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='groups', related_query_name='group', to='django_spire_knowledge.collection')),
+            ],
+        ),
+    ]

django_spire/knowledge/migrations/0005_entryversionblock__tunes_data_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.2.7 on 2025-10-22 01:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_knowledge', '0004_alter_collection_options_collectiongroup'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='entryversionblock',
+            name='_tunes_data',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='entryversionblock',
+            name='type',
+            field=models.CharField(choices=[('text', 'Text'), ('heading', 'Heading'), ('sub_heading', 'Sub Heading'), ('list_item', 'List Item'), ('list', 'List'), ('code', 'Code')], default='text', max_length=32),
+        ),
+    ]

django_spire/knowledge/migrations/0006_alter_entryversionblock_type.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.7 on 2025-10-25 15:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_knowledge', '0005_entryversionblock__tunes_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='entryversionblock',
+            name='type',
+            field=models.CharField(choices=[('text', 'Text'), ('heading', 'Heading'), ('list', 'List')], default='text', max_length=32),
+        ),
+    ]

django_spire/knowledge/migrations/0007_alter_collection_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.2.7 on 2025-11-07 23:13
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_knowledge', '0006_alter_entryversionblock_type'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='collection',
+            options={'ordering': ['name'], 'permissions': [('can_access_all_collections', 'Can Access All Collections'), ('can_change_collection_groups', 'Can Change Collection Groups')], 'verbose_name': 'Collection', 'verbose_name_plural': 'Collections'},
+        ),
+    ]

django_spire/knowledge/migrations/0008_collection_tags_entry_tags.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.2.7 on 2025-11-12 16:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_core', '0001_initial'),
+        ('django_spire_knowledge', '0007_alter_collection_options'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='collection',
+            name='tags',
+            field=models.ManyToManyField(blank=True, editable=False, null=True, related_name='+', to='django_spire_core.tag'),
+        ),
+        migrations.AddField(
+            model_name='entry',
+            name='tags',
+            field=models.ManyToManyField(blank=True, editable=False, null=True, related_name='+', to='django_spire_core.tag'),
+        ),
+    ]

django_spire/knowledge/models.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+# These imports are for the migrations to work as a single app "django_spire_knowledge"
+
+from django_spire.knowledge.entry import models as entry_models
+from django_spire.knowledge.entry.version import models as entry_version_models
+from django_spire.knowledge.entry.version.block import models as \
+    entry_version_block_models
+from django_spire.knowledge.collection import models as collection_models
+
+# Must assert to stop unused import removals.
+
+assert entry_models
+assert entry_version_models
+assert entry_version_block_models
+assert collection_models

django_spire/knowledge/seeding/seed.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+from django_spire.knowledge.collection.seeding.seed import *

django_spire/knowledge/static/django_spire/knowledge/collection/js/managers.js

@@ -0,0 +1,148 @@
+class Entry {
+    constructor({
+        entry_id,
+        name,
+        version_id,
+        author,
+        status,
+        last_edit_datetime,
+        publish_datetime,
+        view_url,
+        edit_url,
+        edit_version_url,
+        delete_url,
+    }) {
+        this.entry_id = entry_id
+        this.name = name
+        this.version_id = version_id
+        this.author = author
+        this.status = status
+        this.last_edit_datetime = last_edit_datetime
+        this.publish_datetime = publish_datetime
+        this.view_url = view_url
+        this.edit_url = edit_url
+        this.delete_url = delete_url
+        this.edit_version_url = edit_version_url
+    }
+}
+
+class Collection {
+    constructor({
+        id = -1,
+        name = 'None',
+        description = '',
+        order = 0,
+        parent = null,
+        children = [],
+        entries = [],
+        delete_url = '',
+        edit_url = '',
+        create_entry_url = '',
+        import_entry_url = '',
+    }) {
+        this.id = id
+        this.name = name
+        this.description = description
+        this.order = order
+        this.parent = parent
+        this.children = children
+        this.entries = entries
+        this.delete_url = delete_url
+        this.edit_url = edit_url
+        this.create_entry_url = create_entry_url
+        this.import_entry_url = import_entry_url
+        this.show_details = false
+    }
+
+    has_child_collections() {
+        return this.children.length > 0
+    }
+
+    has_entries() {
+        return this.entries.length > 0
+    }
+
+    toggle_show_details({value = false}) {
+        this.show_details = value
+
+        this.children.forEach(child => {
+            child.toggle_show_details({value: false})
+        });
+    }
+}
+
+class CollectionManager {
+    constructor(collection_tree){
+        this.collection_lookup_map = new Map()
+        this.collection_map = this._create_tree_structure({collections: collection_tree})
+    }
+
+    _create_entries({entries_json}) {
+        let entries = []
+
+        entries_json.forEach(entry => {
+            entries.push(new Entry({
+                entry_id: entry.entry_id,
+                name: entry.name,
+                version_id: entry.version_id,
+                author: entry.author,
+                status: entry.status,
+                last_edit_datetime: entry.last_edit_datetime,
+                publish_datetime: entry.publish_datetime,
+                view_url: entry.view_url,
+                edit_url: entry.edit_url,
+                edit_version_url: entry.edit_version_url,
+                delete_url: entry.delete_url,
+            }))
+        })
+
+        return entries
+    }
+
+    _create_tree_structure({collections}) {
+        return collections.map((collection, index) => {
+            const collection_object = new Collection({
+                id: collection.id,
+                name: collection.name,
+                description: collection.description,
+                order: collection.order,
+                parent: new Collection({}),
+                children: this._create_tree_structure({collections: collection.children}),
+                entries: this._create_entries({entries_json: collection.entries}),
+                delete_url: collection.delete_url,
+                edit_url: collection.edit_url,
+                create_entry_url: collection.create_entry_url,
+                import_entry_url: collection.import_entry_url
+            })
+
+            this.collection_lookup_map.set(collection_object.id, collection_object)
+
+            collection_object.children.forEach(child => {
+                child.parent = collection_object;
+            });
+
+            return collection_object
+        })
+    }
+
+    _show_details_to_root({collection}) {
+        collection.show_details = true
+
+        if (collection.parent) {
+            this._show_details_to_root({collection: collection.parent})
+        }
+    }
+
+    open_path_to({collection_id}) {
+        const target_collection = this.collection_lookup_map.get(collection_id)
+
+        this._show_details_to_root({collection: target_collection})
+    }
+
+    set_parent({collection, parent_id}) {
+        collection.parent = this.collection_lookup_map.get(parent_id)
+        if (collection.parent) {
+            this.open_path_to({collection_id: collection.parent.id})
+        }
+    }
+}

django_spire/knowledge/static/django_spire/knowledge/collection/js/x_component.js

@@ -0,0 +1,26 @@
+document.querySelectorAll('template[x-component]').forEach(template => {
+
+    const name = `x-${template.getAttribute('x-component')}`;
+
+    class Component extends HTMLElement {
+        connectedCallback() {
+            if (!this._initialized) {
+                this._initialized = true;
+                const clone = template.content.cloneNode(true);
+                const dataBinding = this.getAttribute(':data');
+                if (dataBinding) {
+                    const wrapper = document.createElement('div');
+                    wrapper.setAttribute('x-data', `{ data: ${dataBinding} }`);
+                    wrapper.appendChild(clone);
+                    this.append(wrapper);
+                } else {
+                    this.append(clone);
+                }
+            }
+        }
+    }
+
+    if (!customElements.get(name)) {
+        customElements.define(name, Component);
+    }
+});

django_spire/knowledge/static/django_spire/knowledge/css/editor.css

@@ -0,0 +1,93 @@
+.ce-popover__container {
+    background-color: var(--app-layer-one);
+    border: 1px solid var(--bs-border-color) !important;
+}
+
+.ce-toolbar__plus,
+.ce-toolbar__settings-btn,
+.ce-popover-item__title,
+.ce-popover-item__icon,
+.cdx-search-field__input {
+    color: var(--app-default-text-color);
+}
+
+.cdx-search-field.ce-popover__search {
+    background-color: var(--app-layer-two);
+    border-color: var(--bs-border-color);
+}
+
+.ce-popover-item--active  {
+    background-color: var(--app-bg-accent-soft) !important;
+}
+
+.ce-popover-item--active .ce-popover-item__title,
+.ce-popover-item--active .ce-popover-item__icon {
+    color: var(--app-accent-dark) !important;
+}
+
+.cdx-block,
+.ce-block {
+    color: var(--app-default-text-color);
+}
+
+.ce-inline-toolbar,
+.ce-conversion-tool__icon,
+.ce-popover-item__icon {
+    color: var(--app-default-text-color);
+    background-color: inherit;
+    border-color: var(--bs-border-color);
+}
+
+.ce-popover,
+.ce-conversion-toolbar,
+.ce-inline-toolbar {
+    background-color: var(--app-layer-one);
+    border-color: var(--bs-border-color);
+    box-shadow: 0 3px 15px -3px var(--bs-border-color);
+}
+
+.ce-inline-tool:hover,
+.ce-inline-toolbar__dropdown:hover,
+.ce-toolbar__plus:hover,
+.ce-toolbar__settings-btn:hover,
+.ce-conversion-tool:hover,
+.ce-popover-item:hover {
+    background-color: var(--app-layer-three) !important;
+}
+
+*::selection,
+.ce-block.ce-block--selected .ce-block__content {
+    background-color: var(--app-bg-accent-soft) !important;
+}
+
+.ce-popover__items {
+    scrollbar-color: var(--bs-border-color) var(--app-layer-one);
+
+    /* Safari and Chrome */
+    &::-webkit-scrollbar {
+        width: 8px;
+    }
+
+    &::-webkit-scrollbar-track {
+        background: var(--app-layer-one);
+    }
+
+    &::-webkit-scrollbar-thumb {
+        background-color: var(--bs-border-color);
+        border-radius: 4px;
+    }
+
+}
+
+.ce-popover-item-separator__line {
+    background: var(--bs-border-color) !important;
+}
+
+@media (max-width: 650px) {
+    .ce-toolbar__settings-btn,
+    .ce-toolbar__plus {
+        background-color: var(--app-layer-one);
+        border-color: var(--bs-border-color);
+        box-shadow: 0 3px 15px -3px var(--bs-border-color);
+    }
+}

django_spire/knowledge/static/django_spire/knowledge/css/navigation_items.css

@@ -0,0 +1,9 @@
+.knowledge-nav-item {
+    transition: all 0.10s ease;
+    border-radius: 8px;
+    padding: 3px 3px;
+}
+
+.knowledge-nav-item:hover {
+    background-color: var(--app-layer-three);
+}

django_spire/knowledge/static/django_spire/knowledge/entry/version/js/editor.js

@@ -0,0 +1,105 @@
+function create_editorjs_instance({holder_id, update_url, initial_editor_blocks}) {
+    return new EditorJS({
+        holder: holder_id,
+        readOnly: !should_init_editor_in_edit_mode(),
+        tools: {
+            text: {
+                class: Paragraph,
+                inlineToolbar: true,
+                config: {
+                    placeholder: 'Write something awesome!',
+                }
+            },
+            heading: {
+                class: Header,
+                inlineToolbar: true,
+                config: {
+                    placeholder: 'Enter heading text...',
+                    levels: [1, 2, 3, 4, 5, 6],
+                    defaultLevel: 1
+                }
+            },
+            list: {
+                class: EditorjsList,
+                inlineToolbar: true,
+                config: {
+                    defaultStyle: 'unordered'
+                },
+            },
+            paragraph: NullParagraph
+        },
+        defaultBlock: 'text',
+        onChange: async (api, _) => {
+            const raw_editor_blocks = await api.saver.save()
+
+            const parsed_editor_blocks = raw_editor_blocks.blocks.map((block, i) => ({
+                id: block.id,
+                order: i,
+                data: block.data,
+                type: block.type,
+                tunes: block?.tunes ?? {},
+            }))
+
+           try {
+                await django_glue_fetch(
+                    update_url,
+                    {
+                        payload: parsed_editor_blocks,
+                    }
+                )
+            }
+            catch (e) {
+                console.error('Error saving editor blocks', e)
+                const event_detail = {
+                    'id': Date.now(),
+                    'type': 'error',
+                    'message': 'Something went wrong when saving your changes. Please reload the page and try again.'
+                }
+
+                const editor_error_event = new CustomEvent('notify', { detail: event_detail })
+                window.dispatchEvent(editor_error_event)
+            }
+        },
+        onReady: () => {
+            try {
+                if (initial_editor_blocks.length > 0) {
+                    KNOWLEDGE_ENTRY_VERSION_EDITOR.blocks.render({
+                        blocks: initial_editor_blocks,
+                    })
+                    if (should_init_editor_in_edit_mode()) {
+                        focus_editor()
+                    }
+
+                    const block_id = new URLSearchParams(window.location.search).get('block_id')
+
+                    if (block_id) {
+                        setTimeout(() => {
+                            const element = document.querySelector(`[data-id="${block_id}"]`)?.firstElementChild
+                            if (element) {
+                                element.scrollIntoView({behavior: 'smooth', block: 'center'})
+                                element.style.transition = 'background-color 1s ease, padding 1s ease'
+                                element.classList.add('bg-app-accent-soft', 'ps-2', 'rounded-3')
+                                setTimeout(() => {
+                                    element.classList.remove('bg-app-accent-soft', 'ps-2')
+                                }, 4000)
+                            }
+                        }, 100)
+                    }
+
+                }
+            }
+            catch (e) {
+                console.error('Invalid JSON found in included initial block data', e)
+            }
+        }
+    })
+}
+
+function focus_editor() {
+    // editor seems to have trouble focusing without this slight setTimeout applied
+    setTimeout(() => KNOWLEDGE_ENTRY_VERSION_EDITOR.focus(), 10)
+}
+
+function should_init_editor_in_edit_mode() {
+    return new URLSearchParams(window.location.search).get('view_mode') === 'edit'
+}