django-spire 0.25.1__py3-none-any.whl → 0.26.0__py3-none-any.whl

django_spire/core/templates/django_spire/form/field/multi_select_field.html

@@ -0,0 +1,155 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    {# This can be removed and need to insert input fields to have getlist and get effect #}
+    <div
+            class="position-relative"
+            x-data="{
+            show_dropdown: false,
+            search: '',
+            init () {
+                this.parse_value()
+
+                this.$watch('glue_field.value', value => {
+                    this.parse_value()
+                })
+            },
+            add_choice(choice) {
+                this.glue_field.value.push(choice[0])
+            },
+            get get_selected_choices() {
+                if (!Array.isArray(this.glue_field.value)) {
+                    return []
+                }
+                return this.glue_field.choices.filter(choice => this.glue_field.value.includes(choice[0]))
+            },
+            get filtered_choices() {
+                if (!Array.isArray(this.glue_field.value)) {
+                    return []
+                }
+
+                const filtered_array = this.glue_field.choices.filter(choice => !this.glue_field.value.includes(choice[0]) && choice[1] !== '----------')
+
+                const search = this.search.toLowerCase()
+                return filtered_array.filter(filtered_choice => filtered_choice[1].toLowerCase().includes(search))
+            },
+            focus_input() {
+                setTimeout(() => this.$refs.search_input.focus(), 100)
+            },
+            parse_value(){
+                // It is already an array!
+                if (Array.isArray(this.glue_field.value)) {
+                    return
+                }
+
+                // Parse the initial value into an array.
+                if (typeof(this.glue_field.value) == 'string' && this.glue_field.value.startsWith('[')){
+                    value = JSON.parse(this.glue_field.value)
+                    return
+                }
+
+                // Must be an array.
+                this.glue_field.value = []
+            },
+            remove_choice(choice) {
+                this.glue_field.value = this.glue_field.value.filter(val => val !== choice[0])
+            },
+        }"
+    >
+        <template x-for="choice in get_selected_choices" :key="choice[0]">
+            <input hidden type="text" :name="glue_field.name" :value="choice[0]">
+
+        </template>
+        <div x-ref="inputs"></div>
+
+        {% block selected_choices %}
+            <button
+                    class="form-control text-start d-flex justify-content-between"
+                    type="button"
+                    @click="show_dropdown = !show_dropdown; focus_input();"
+            >
+                <span class="d-flex flex-wrap align-items-center">
+                    <template x-for="choice in get_selected_choices" :key="choice[0]">
+                        <div class="d-inline-block my-1">
+                            <span class="badge rounded-pill glue-fs--1 text-app-glue-primary fw-normal border me-1">
+                                <span x-text="choice[1]"></span>
+                            </span>
+                        </div>
+                    </template>
+
+                    <template x-if="get_selected_choices.length === 0">
+                        <span>----------</span>
+                    </template>
+                </span>
+
+                <span class="d-flex align-items-center">
+                    {% include 'django_spire/form/field/element/select_down_arrow_element.html' %}
+                </span>
+            </button>
+        {% endblock %}
+
+        <div
+                x-cloak
+                x-show="show_dropdown"
+                @click.outside="show_dropdown = false"
+                class="shadow border rounded-2 mt-2 position-absolute z-3 bg-app-glue-layer-one w-100 p-0 list-group"
+                style="max-height: 350px; overflow-y: auto; z-index: 3;"
+                @keydown.escape="show_dropdown = false"
+                x-trap.inert="show_dropdown"
+        >
+            <div class="glue-fs--2 fw-bold ms-2 my-1">
+                Select Many <span>"<span x-text="glue_field.label"></span>"</span>
+            </div>
+
+            <div class="m-1">
+                <input
+                        x-model="search"
+                        class="form-control py-1 glue-fs--2"
+                        placeholder="Search..."
+                        type="text"
+                        x-ref="search_input"
+                        @keydown.enter.prevent="add_choice(filtered_choices[0])"
+                >
+            </div>
+
+            <template x-for="(choice, index) in get_selected_choices" :key="index">
+                <div
+                        class="glue-cursor-pointer glue-user-select py-1 d-flex align-items-center list-group-item px-0 bg-app-glue-layer-one-hover"
+                        tabindex="0"
+                        @click="remove_choice(choice)"
+                        @keydown.enter.prevent="remove_choice(choice)"
+                >
+                    {% block selected_choice_item %}
+                        {% include 'django_spire/form/field/item/selected_choice_item.html' %}
+                    {% endblock %}
+                </div>
+            </template>
+
+            <template x-if="get_selected_choices.length > 0 && filtered_choices.length !== 0">
+                <div>
+                    <span class="d-block glue-fs--2 ms-3">Choices</span>
+                </div>
+            </template>
+
+            <template x-for="(choice, index) in filtered_choices" :key="choice[0]">
+                <div
+                        class="glue-user-select py-1 d-flex align-items-center list-group-item px-0"
+                        tabindex="0"
+                        @click="glue_field.disabled_choices.includes(choice[0]) ? '' : add_choice(choice)"
+                        :class="glue_field.disabled_choices.includes(choice[0]) ? 'opacity-50 glue-user-select glue-cursor-not-allowed' : 'glue-cursor-pointer bg-app-glue-layer-one-hover'"
+                        @keydown.enter.prevent="add_choice(choice)"
+                >
+                    {% block choice_item %}
+                        {% include 'django_spire/form/field/item/select_choice_item.html' %}
+                    {% endblock %}
+                </div>
+            </template>
+
+            <template x-if="filtered_choices.length === 0">
+                <div class="py-1">
+                    <span class="d-block glue-fs--2 ms-3">No available choices</span>
+                </div>
+            </template>
+        </div>
+    </div>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/number_field.html

@@ -0,0 +1,11 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <input
+            {% if input_type %}type="{{ input_type }}"{% else %}type="number"{% endif %}
+            class="form-control"
+            x-ref="glue_field"
+            x-model="value"
+            :id="glue_field.id"
+    >
+{% endblock %}

django_spire/core/templates/django_spire/form/field/password_field.html

@@ -0,0 +1 @@
+{% include 'django_spire/form/field/input_field.html' with input_type='password' %}

django_spire/core/templates/django_spire/form/field/radio_field.html

@@ -0,0 +1,24 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <div class="form-group">
+        <template x-for="choice in glue_field.choices" :key="choice[0]">
+            <div class="form-check">
+                <input
+                        type="radio"
+                        class="form-check-input"
+                        :id="glue_field.id + '_' + choice[0]"
+                        :name="glue_field.name"
+                        :value="choice[0]"
+                        :checked="value === choice[0]"
+                        @change="this.value =choice[0]"
+                >
+                <label
+                        class="form-check-label"
+                        :for="glue_field.id + '_' + choice[0]"
+                        x-text="choice[1]"
+                ></label>
+            </div>
+        </template>
+    </div>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/range_field.html

@@ -0,0 +1 @@
+{% include 'django_spire/form/field/input_field.html' with input_type='range' %}

django_spire/core/templates/django_spire/form/field/search_and_select_field.html

@@ -0,0 +1,119 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <input
+            type="text"
+            x-model="value"
+            x-ref="glue_field"
+            hidden
+    >
+
+    <div
+            class="position-relative"
+            x-data="{
+            placeholder: '------------',
+            show_dropdown: false,
+            search: '',
+            is_search_focused: false,
+            choice_verbose: this.placeholder,
+
+            init() {
+                this.update_choice();
+
+                $watch('value', (value) => {
+                    this.update_choice();
+                });
+
+                $watch('glue_field.choices', () => {
+                    this.update_choice();
+                });
+            },
+
+            get filtered_choices() {
+                return glue_field.choices.filter(choice => {
+                    let label = choice[1].toLowerCase();
+                    let search = this.search.toLowerCase();
+                    return label.includes(search);
+                });
+            },
+
+            focus_input() {
+                if (!is_touch_device()) {
+                    this.$nextTick(() => {
+                        if (this.show_dropdown) {
+                            this.$refs.search_input.focus();
+                        }
+                    });
+                }
+            },
+
+            handle_click(event) {
+                if (!this.$refs.search_input.contains(event.target) && !this.is_search_focused || !this.is_search_focused && this.show_dropdown) {
+                    this.show_dropdown = false;
+                }
+            },
+
+            select_choice(choice) {
+                this.value = choice[0];
+                this.search = '';
+                this.show_dropdown = false;
+            },
+
+            update_choice() {
+                let match = this.glue_field.choices.find(choice => String(choice[0]) === String(this.value));
+                this.choice_verbose = match ? match[1] : this.placeholder;
+            }
+        }"
+            @click.outside="handle_click"
+    >
+        <button
+                class="form-control text-start d-flex justify-content-between"
+                type="button"
+                style="outline: none; box-shadow: none;"
+                @click="$event.target.blur(); focus_input(); show_dropdown = !show_dropdown;"
+        >
+            <span x-text="choice_verbose"></span>
+
+            <span class="d-flex align-items-center">
+                {% include 'django_spire/form/field/element/select_down_arrow_element.html' %}
+            </span>
+        </button>
+
+        <div
+                x-show="show_dropdown"
+                class="shadow border rounded-2 mt-2 position-absolute z-3 bg-app-glue-layer-one w-100 p-0 list-group"
+                style="max-height: 300px; overflow-y: auto; z-index: 3;"
+                @keydown.escape="show_dropdown = false"
+        >
+            <div class="glue-fs--2 fw-bold ms-2 mt-1">
+                Select <span x-text="glue_field.label"></span>
+            </div>
+
+            <div class="m-2">
+                <input
+                        x-model="search"
+                        class="form-control glue-fs--2"
+                        placeholder="Search..."
+                        type="text"
+                        x-ref="search_input"
+                        @blur="setTimeout(() => is_search_focused = false, 150)"
+                        @keydown.enter.prevent="select_choice(filtered_choices[0])"
+                >
+            </div>
+
+            <template x-for="(choice, index) in filtered_choices" :key="choice[0]">
+                <div
+                        class="py-1 d-flex align-items-center list-group-item px-0"
+                        tabindex="0"
+                        @click="glue_field.disabled_choices.includes(choice[0]) ? '' : select_choice(choice)"
+                        :class="glue_field.disabled_choices.includes(choice[0]) ? 'opacity-50 glue-user-select glue-cursor-not-allowed' : 'glue-cursor-pointer bg-app-glue-layer-one-hover'"
+                        @keydown.enter.prevent="select_choice(choice)"
+                >
+                    {% block choice_item %}
+                        {% include 'django_spire/form/field/item/select_choice_item.html' %}
+                    {% endblock %}
+                </div>
+            </template>
+        </div>
+    </div>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/search_field.html

@@ -0,0 +1,5 @@
+{% extends 'django_spire/form/field/input_field.html' %}
+
+{% block input_type %}search{% endblock %}
+
+{% block input_field_attrs %}placeholder="{% if search_field_placeholder %}{{ search_field_placeholder }}{% else %}Search...{% endif %}"{% endblock %}

django_spire/core/templates/django_spire/form/field/select_field.html

@@ -0,0 +1,78 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <input
+            type="text"
+            x-model="value"
+            x-ref="glue_field"
+            hidden
+    >
+
+    <div
+            class="position-relative"
+            x-data="{
+            placeholder: '------------',
+            show_dropdown: false,
+            choice_verbose: this.placeholder,
+
+            init() {
+                this.update_choice();
+
+                $watch('value', (value) => {
+                    this.update_choice();
+                });
+
+                $watch('glue_field.choices', () => {
+                    this.update_choice();
+                });
+            },
+
+            update_choice() {
+                let match = this.glue_field.choices.find(choice => String(choice[0]) === String(this.value));
+                this.choice_verbose = match ? match[1] : this.placeholder;
+            }
+        }"
+            x-effect="update_choice();"
+    >
+        <button
+                class="form-control text-start d-flex justify-content-between {{ select_padding }}"
+                type="button"
+                @click="show_dropdown = !show_dropdown"
+        >
+            <span x-text="choice_verbose"></span>
+
+            <span class="d-flex align-items-center pt-1">
+                {% include 'django_spire/form/field/element/select_down_arrow_element.html' %}
+            </span>
+        </button>
+        <div
+                x-cloak
+                x-show="show_dropdown"
+                @click.outside="show_dropdown = false"
+                class="shadow border rounded-2 mt-2 position-absolute z-3 bg-app-glue-layer-one w-100 p-0 list-group"
+                style="max-height: 300px; overflow-y: auto; z-index: 3;"
+                @keydown.escape="show_dropdown = false"
+                x-trap.inert="show_dropdown"
+        >
+            {% block select_dropdown_header %}
+            {% endblock %}
+
+            <template x-for="(choice, index) in glue_field.choices" :key="choice[0]">
+                <div
+                        class="py-1 d-flex align-items-center list-group-item px-0"
+                        tabindex="0"
+                        @click="glue_field.disabled_choices.includes(choice[0]) ? '' : value = choice[0]; show_dropdown = false"
+                        :class="glue_field.disabled_choices.includes(choice[0]) ? 'opacity-50 glue-user-select glue-cursor-not-allowed' : 'glue-cursor-pointer bg-app-glue-layer-one-hover'"
+                        @keydown.enter.prevent="value = choice[0]; show_dropdown = false"
+                >
+                    {% block choice_item %}
+                        {% include 'django_spire/form/field/item/select_choice_item.html' %}
+                    {% endblock %}
+                </div>
+            </template>
+
+            {% block select_dropdown_footer %}
+            {% endblock %}
+        </div>
+    </div>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/single_checkbox_field.html

@@ -0,0 +1,27 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <div
+            class="glue-form-group"
+            x-init="glue_field.hide_label()"
+    >
+        <div>
+            <div class="d-flex align-items-center">
+                <input
+                        type="checkbox"
+                        class="glue-form-check-input me-2"
+                        :id="glue_field.id"
+                        :name="glue_field.name"
+                        x-model="value"
+                        x-ref="glue_field"
+                        style="accent-color: var(--glue-primary);"
+                >
+                <label
+                        class="glue-form-check-label glue-text-primary glue-cursor-pointer"
+                        :for="glue_field.id"
+                        x-text="glue_field.label"
+                ></label>
+            </div>
+        </div>
+    </div>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/single_file_field.html

@@ -0,0 +1,90 @@
+{% extends 'django_spire/form/field/_base_file_field.html' %}
+
+{% block x-data %}
+    async handle_files_change(event) {
+    let files = Array.from(event.target.files || []);
+    if (files.length === 0) return;
+
+    this.files = [];
+
+    Object.keys(this.objects).forEach(id => {
+    URL.revokeObjectURL(this.files.find(file => file.id === id)?.data);
+    URL.revokeObjectURL(this.files.find(file => file.id === id)?.preview);
+    });
+
+    this.objects = {};
+
+    let file = files[0];
+
+    if (file.size > this.maximum_filesize) {
+    alert(`The file is too large (${this.format_file_size(file.size)}). Maximum size is
+    ${this.format_file_size(this.maximum_filesize)}.`);
+    return;
+    }
+
+    let file_id = Date.now() + '-' + Math.random().toString(36).substr(2, 9);
+    let processed = file;
+
+    if (file.type.startsWith('image/') && file.type !== 'image/svg+xml' && this.compression) {
+    processed = await this.compress(file);
+    }
+
+    this.objects[file_id] = processed;
+
+    let data = URL.createObjectURL(processed);
+
+    this.files.push({
+    id: file_id,
+    name: processed.name,
+    size: processed.size,
+    type: processed.type,
+    data: data,
+    preview: processed.type.startsWith('image/') ? data : null
+    });
+
+    this.update_value();
+    this.show_dropdown = true;
+    this.update_form_files();
+
+    this.$refs.file_input.value = '';
+    this.$refs.camera_input.value = '';
+    },
+
+    remove_file(file_id) {
+    let file = this.files.find(file => file.id === file_id);
+
+    if (file) {
+    URL.revokeObjectURL(file.data);
+    if (file.preview) URL.revokeObjectURL(file.preview);
+    }
+
+    delete this.objects[file_id];
+
+    this.files = [];
+
+    this.update_value();
+    this.update_form_files();
+
+    if (this.files.length === 0) {
+    this.show_dropdown = false;
+    }
+    }
+{% endblock %}
+
+{% block upload_attributes %}{% endblock %}
+{% block file_input_attributes %}{% endblock %}
+{% block camera_input_attributes %}{% endblock %}
+
+{% block selection_display %}
+    <template x-if="files.length === 0">
+        <span>No file selected</span>
+    </template>
+
+    <template x-if="files.length > 0">
+        <span x-text="truncate_name(files[0].name)"></span>
+    </template>
+{% endblock %}
+
+{% block drop_area_text %}
+    <span>Click to select or drag and drop a file here</span>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/telephone_field.html

@@ -0,0 +1 @@
+{% include 'django_spire/form/field/input_field.html' with input_type='tel' %}

django_spire/core/templates/django_spire/form/field/text_field.html

@@ -0,0 +1,11 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <textarea
+            x-ref="glue_field"
+            type="text"
+            class="form-control"
+            x-model.debounce.500ms="value"
+            rows="{% if rows %}{{ rows }}{% else %}3{% endif %}"
+    ></textarea>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/time_field.html

@@ -0,0 +1 @@
+{% include 'django_spire/form/field/input_field.html' with input_type='time' %}

django_spire/core/templates/django_spire/infinite_scroll/base.html

@@ -322,7 +322,8 @@
     {% block scroll_container %}
         <div
             class="position-relative {% block scroll_container_class %}{% endblock %}"
-            style="height: {{ container_height|default:'600px' }}; overflow-y: auto; overscroll-behavior: contain; -webkit-overflow-scrolling: touch;"
+            style="height:
+                    {% block container_height %}{{ container_height|default:'600px' }}{% endblock %}; overflow-y: auto; overscroll-behavior: contain; -webkit-overflow-scrolling: touch;"
             x-ref="scroll_container"
         >
             {% block scroll_content_wrapper %}

django_spire/core/templatetags/model_tags.py

@@ -0,0 +1,34 @@
+from django import template
+from django.db.models import Model
+
+register = template.Library()
+
+
+@register.filter
+def model_app_label(model_obj: Model) -> str:
+    """
+    Return the Django app label for the given model instance.
+
+    Args:
+        model_obj: A Django model instance.
+
+    Returns:
+        The app label defined by the model's app configuration.
+    """
+
+    return model_obj._meta.app_label
+
+
+@register.filter
+def model_name(model_obj: Model) -> str:
+    """
+    Return the Django model name for the given model instance.
+
+    Args:
+        model_obj: A Django model instance.
+
+    Returns:
+        The model name (lowercased) as defined by Django's model metadata.
+    """
+
+    return model_obj._meta.model_name

django_spire/knowledge/entry/forms.py

@@ -8,7 +8,7 @@ from django_spire.knowledge.entry.models import Entry
 class EntryForm(forms.ModelForm):
     class Meta:
         model = Entry
-        exclude = ['current_version', 'collection', 'order']
+        fields = ['name']
 
 
 class EntryFilesForm(forms.Form):

django_spire/knowledge/entry/models.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from django.contrib.postgres.indexes import GinIndex
+from django.contrib.postgres.search import SearchVectorField
 from django.db import models
 from django.urls import reverse
 
@@ -36,6 +38,9 @@ class Entry(
 
     name = models.CharField(max_length=255)
 
+    _search_text = models.TextField(blank=True, default='')
+    _search_vector = SearchVectorField(null=True)
+
     objects = EntryQuerySet.as_manager()
     services = EntryService()
 
@@ -75,3 +80,16 @@ class Entry(
         verbose_name = 'Entry'
         verbose_name_plural = 'Entries'
         db_table = 'django_spire_knowledge_entry'
+        indexes = [
+            GinIndex(fields=['_search_vector'], name='entry_search_vector_idx'),
+            GinIndex(
+                name='entry_name_trgm_idx',
+                fields=['name'],
+                opclasses=['gin_trgm_ops'],
+            ),
+            GinIndex(
+                name='entry_search_text_trgm_idx',
+                fields=['_search_text'],
+                opclasses=['gin_trgm_ops'],
+            ),
+        ]

django_spire/knowledge/entry/querysets.py

@@ -3,17 +3,24 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 from django.db.models import Q
+
 from django_spire.contrib.ordering.querysets import OrderingQuerySetMixin
 from django_spire.history.querysets import HistoryQuerySet
 from django_spire.knowledge.entry.version.choices import EntryVersionStatusChoices
 
 if TYPE_CHECKING:
-    from django_spire.auth.user.models import AuthUser
     from django.db.models import QuerySet
+
+    from django_spire.auth.user.models import AuthUser
     from django_spire.knowledge.entry.models import Entry
 
 
 class EntryQuerySet(HistoryQuerySet, OrderingQuerySetMixin):
+    def get_by_version_block_id(self, version_block_id: int) -> Entry:
+        return self.get(
+            current_version__block__id=version_block_id
+        )
+
     def has_current_version(self) -> QuerySet[Entry]:
         return self.filter(current_version__isnull=False)
 
@@ -30,8 +37,3 @@ class EntryQuerySet(HistoryQuerySet, OrderingQuerySetMixin):
                 current_version__status=EntryVersionStatusChoices.DRAFT
             )
         )
-
-    def get_by_version_block_id(self, version_block_id: int) -> Entry:
-        return self.get(
-            current_version__block__id=version_block_id
-        )

django_spire/knowledge/entry/services/processor_service.py

@@ -15,4 +15,5 @@ class EntryProcessorService(BaseDjangoModelService['Entry']):
         self.obj.ordering_services.processor.remove_from_objects(
             destination_objects=self.obj.collection.entries.active()
         )
+
         self.obj.set_deleted()