Documents

LicenseStableVueJavaScriptIssuesMerge Requests

Description

Documents is the Enso UI frontend package for the laravel-enso/documents backend package. It provides Vue Router route groups, Bulma pages, table screens, backend-driven forms, template editing, type PDF upload UI, signature request monitoring, document browsing, and a reusable requirements component.

The package stays generic. Application-owned links, filters, local business actions, and document generation endpoints belong in the consuming application.

Installation

Install the package from the GitLab repository:

yarn add git+ssh://git@git.xtelecom.ro/enso-ui/documents.git#1.0.3

Register the route groups in the consuming application router:

import { administration, documents } from '@enso-ui/documents';

routes.push(administration, documents);

The backend companion package must be installed and migrated separately:

composer require laravel-enso/documents
php artisan migrate

Features

  • Administration pages for document categories, types, fields, partials, and templates.
  • Type edit page support for static PDF model upload and deletion.
  • Global fields page for reusable field definitions.
  • Type edit page field assignment panel with add, edit, delete, and move up/down actions.
  • Template editor powered by backend forms and @enso-ui/wysiwyg.
  • Placeholder catalogue panel for template editing.
  • Partials management for headers, footers, and body snippets.
  • Root document archive table.
  • Signature request monitoring table.
  • Requirements component for rendering backend-calculated requirements.
  • Pinia store for backend-provided document types and categories.
  • FontAwesome icon registration for package routes and actions.

Usage

Route Groups

The package exports two route groups:

import { administration, documents } from '@enso-ui/documents';

administration registers the administration/documents parent route and these children:

  • administration.documents.categories.index
  • administration.documents.categories.create
  • administration.documents.categories.edit
  • administration.documents.types.index
  • administration.documents.types.create
  • administration.documents.types.edit
  • administration.documents.types.fields.create
  • administration.documents.types.fields.edit
  • administration.documents.fields.index
  • administration.documents.fields.create
  • administration.documents.fields.edit
  • administration.documents.partials.index
  • administration.documents.partials.create
  • administration.documents.partials.edit
  • administration.documents.templates.index
  • administration.documents.templates.create
  • administration.documents.templates.edit

documents registers the root documents parent route and these children:

  • documents.index
  • documents.signatureRequests.index

The default export returns both groups:

import documentRoutes from '@enso-ui/documents';

Pages

The package ships page modules under src/bulma/pages:

  • administration/documents/categories: index, create, edit.
  • administration/documents/types: index, create, edit, type file upload component, and type field assignment pages.
  • administration/documents/fields: index, create, edit.
  • administration/documents/partials: index, create, edit.
  • administration/documents/templates: index, create, edit, base form, placeholders panel.
  • documents: document archive index.
  • documents/signatureRequests: signature request index.

Requirements Component

Applications can import and render the requirements component directly:

<template>
    <requirements :requirements="requirements"/>
</template>

<script setup>
import { Requirements } from '@enso-ui/documents';
</script>

The component accepts the normalized requirements array returned by local application endpoints that use LaravelEnso\Documents\Services\Requirements. It also accepts legacy object-shaped input where keys map to boolean validity.

Field Tables

The Fields page uses the backend table id document_fields. It displays reusable field definitions once.

The Type edit page embeds the document_type_fields table for the selected document type. That table manages the assignment between a type and reusable fields, including per-type validations and ordering. Values for concrete documents are backend records in document_field_values and are intentionally not managed through this administration page.

API

Exports

  • default export: [administration, documents]
  • named export administration
  • named export documents
  • named export Requirements

Backend Companion

The backend companion provides routes, permissions, menus, form builders, table builders, state, models, PDF generation, placeholder resolution, requirements checking, and signature request lifecycle handling.

Depends On

License

MIT

Edit this page on GitHub
Last Updated: 7/6/2026, 11:10:39 AM