pict-section-recordset 1.1.0 → 1.3.0

package/docs/views/create/README.md

@@ -1,181 +0,0 @@
-# Create View
-
-The Create view provides a form interface for creating new records in a record set.
-
-## Overview
-
-The Create view automatically generates a form based on your record schema or a custom manifest. It handles form rendering, validation, and record submission through the configured record provider.
-
-## Routes
-
-| Route | Description |
-|-------|-------------|
-| `/PSRS/:RecordSet/Create` | Opens the create form for the specified record set |
-
-## Configuration
-
-Configure the Create view in your record set provider configuration:
-
-```javascript
-const recordSetConfig = {
-    RecordSet: 'User',
-
-    // Use manifest-based form (recommended for custom layouts)
-    RecordSetCreateManifestOnly: true,
-    RecordSetCreateDefaultManifest: 'UserCreateForm',
-    RecordSetCreateManifests: ['UserCreateForm', 'UserQuickCreate'],
-
-    // Or let the view auto-generate from schema
-    RecordSetCreateManifestOnly: false
-};
-```
-
-## Manifest Configuration
-
-When using `RecordSetCreateManifestOnly: true`, provide a manifest that defines the form structure:
-
-```javascript
-const createManifest = {
-    Form: 'UserCreateForm',
-    Scope: 'UserDetails',
-    Descriptors: {
-        'UserDetails.Name': {
-            Name: 'Full Name',
-            Hash: 'User-Name',
-            DataType: 'String',
-            PictForm: {
-                Row: '1',
-                Section: 'BasicInfo',
-                Group: 'NameGroup'
-            }
-        },
-        'UserDetails.Email': {
-            Name: 'Email Address',
-            Hash: 'User-Email',
-            DataType: 'String',
-            PictForm: {
-                Row: '2',
-                Section: 'BasicInfo',
-                Group: 'ContactGroup',
-                InputType: 'Email'
-            }
-        }
-    },
-    Sections: [
-        {
-            Name: 'Basic Information',
-            Hash: 'BasicInfo',
-            ShowTitle: true,
-            Groups: [
-                {
-                    Name: 'Name',
-                    Hash: 'NameGroup',
-                    Rows: [],
-                    ShowTitle: false
-                },
-                {
-                    Name: 'Contact',
-                    Hash: 'ContactGroup',
-                    Rows: [],
-                    ShowTitle: true
-                }
-            ]
-        }
-    ]
-};
-```
-
-## Auto-Generated Forms
-
-When `RecordSetCreateManifestOnly` is `false` (or not set), the Create view automatically generates a form from the record schema. The following fields are excluded by default:
-
-- ID field (e.g., `IDUser`)
-- GUID field (e.g., `GUIDUser`)
-- `CreatingIDUser`
-- `UpdatingIDUser`
-- `DeletingIDUser`
-- `Deleted`
-- `CreateDate`
-- `UpdateDate`
-- `DeleteDate`
-
-## Data Type Mapping
-
-Schema types are mapped to form input types:
-
-| Schema Type | Form DataType | Input Type |
-|-------------|---------------|------------|
-| `string`, `autoguid` | String | Text |
-| `datetime`, `date` | String | DateTime |
-| `boolean`, `deleted` | Boolean | Checkbox |
-| `integer`, `decimal` | Number | Number |
-
-## Lifecycle Hooks
-
-Override these methods in a custom view class to add behavior:
-
-```javascript
-class CustomCreateView extends viewRecordSetCreate {
-    async onBeforeRenderCreate(pRecordConfiguration, pProviderHash) {
-        // Called before rendering the form
-        // Use for pre-population or validation setup
-    }
-
-    async onBeforeClear() {
-        // Called before clearing the form
-        // Use for confirmation dialogs
-    }
-
-    async onBeforeSave() {
-        // Called before saving the record
-        // Use for validation or data transformation
-    }
-}
-```
-
-## Button Bar
-
-The default button bar includes:
-
-- **Clear** - Resets the form to empty state
-- **Save** - Creates the record via the provider's `createRecord` method
-
-After successful save, the view navigates to the Read view for the new record.
-
-## Templates
-
-The Create view uses these templates:
-
-| Template Hash | Purpose |
-|---------------|---------|
-| `PRSP-Create-Basic-Template` | Main container template |
-| `PRSP-Create-RecordButtonBar-Template` | Save/Clear button bar |
-| `PRSP-Create-Link-Name-Template` | Link text for navigation |
-| `PRSP-Create-Link-URL-Template` | Link URL pattern |
-
-## Customizing Templates
-
-Override templates by adding them before initialization:
-
-```javascript
-pict.TemplateProvider.addTemplate('PRSP-Create-RecordButtonBar-Template', /*html*/`
-    <div class="my-button-bar">
-        <button onclick="_Pict.views['RSP-RecordSet-Create'].clear()">Reset</button>
-        <button onclick="_Pict.views['RSP-RecordSet-Create'].save()">Create User</button>
-        <button onclick="window.history.back()">Cancel</button>
-    </div>
-`);
-```
-
-## Example Usage
-
-```javascript
-// Navigate to create form programmatically
-pict.providers.RecordSetRouter.pictRouter.navigate('/PSRS/User/Create');
-
-// Access the create view
-const createView = pict.views['RSP-RecordSet-Create'];
-
-// Manually trigger save
-await createView.save();
-```

package/docs/views/dashboard/README.md

@@ -1,308 +0,0 @@
-# Dashboard View
-
-The Dashboard view provides a configurable, manifest-driven interface for displaying record sets with enhanced visualization and computed columns.
-
-## Overview
-
-The Dashboard view extends the list functionality with support for manifests that define computed columns, custom cell rendering, and dynamic data transformation. It's ideal for analytics, reporting, and complex data displays.
-
-## Routes
-
-| Route | Description |
-|-------|-------------|
-| `/PSRS/:RecordSet/Dashboard` | Default dashboard |
-| `/PSRS/:RecordSet/Dashboard/:Offset` | Dashboard with offset |
-| `/PSRS/:RecordSet/Dashboard/:Offset/:PageSize` | Dashboard with pagination |
-| `/PSRS/:RecordSet/Dashboard/FilteredTo/:FilterString` | Dashboard with filter |
-| `/PSRS/:RecordSet/SpecificDashboard/:DashboardHash` | Named dashboard |
-| `/PSRS/:RecordSet/SpecificDashboard/:DashboardHash/:Offset/:PageSize` | Named dashboard with pagination |
-
-## Configuration
-
-```javascript
-const recordSetConfig = {
-    RecordSet: 'Sales',
-    Title: 'Sales Dashboard',
-
-    // Use manifest-based dashboard
-    RecordSetDashboardManifestOnly: true,
-    RecordSetDashboardDefaultManifest: 'SalesOverview',
-    RecordSetDashboardManifests: ['SalesOverview', 'SalesByRegion', 'TopSellers']
-};
-```
-
-## Dashboard Manifests
-
-Manifests define the dashboard structure, columns, and computed values:
-
-```javascript
-const dashboardManifest = {
-    Scope: 'SalesData',
-    TitleTemplate: 'Sales Dashboard - {~D:Record.RecordSet~}',
-
-    TableCells: [
-        {
-            Key: 'ProductName',
-            DisplayName: 'Product',
-            PictDashboard: {
-                ValueTemplate: '{~D:Record.Data.ProductName~}'
-            }
-        },
-        {
-            Key: 'Revenue',
-            DisplayName: 'Revenue',
-            ManifestHash: 'Currency',
-            PictDashboard: {
-                ValueTemplate: '${~D:Record.Data.Revenue~}'
-            }
-        },
-        {
-            Key: 'GrowthRate',
-            DisplayName: 'Growth',
-            PictDashboard: {
-                // Computed column using solver
-                Solver: 'ComputeGrowthRate',
-                ValueTemplate: '<span class="{~D:Record.Computed.GrowthClass~}">{~D:Record.Computed.GrowthRate~}%</span>'
-            }
-        }
-    ],
-
-    Descriptors: {
-        'GrowthRate': {
-            Hash: 'GrowthRate',
-            PictDashboard: {
-                Solver: 'ComputeGrowthRate'
-            }
-        }
-    }
-};
-```
-
-## Specific Dashboards
-
-Use the `SpecificDashboard` route to render a named dashboard:
-
-```javascript
-// Navigate to specific dashboard
-pict.providers.RecordSetRouter.pictRouter.navigate('/PSRS/Sales/SpecificDashboard/SalesByRegion');
-
-// With pagination
-pict.providers.RecordSetRouter.pictRouter.navigate('/PSRS/Sales/SpecificDashboard/TopSellers/0/50');
-```
-
-## Child Views
-
-The Dashboard view uses these child views:
-
-| View | Purpose |
-|------|---------|
-| `PRSP-Dashboard-HeaderDashboard` | Dashboard header actions |
-| `PRSP-Dashboard-Title` | Dashboard title |
-| `PRSP-Filters` | Filter controls |
-| `PRSP-Dashboard-PaginationTop` | Top pagination |
-| `PRSP-Dashboard-RecordList` | Record table |
-| `PRSP-Dashboard-RecordListHeader` | Table headers |
-| `PRSP-Dashboard-RecordListEntry` | Table rows |
-| `PRSP-Dashboard-PaginationBottom` | Bottom pagination |
-
-## Dynamic Solver
-
-The Dashboard view integrates with `DynamicRecordsetSolver` to compute values:
-
-```javascript
-// Solver is called automatically during render
-pict.providers.DynamicRecordsetSolver.solveDashboard(manifest, records);
-```
-
-This processes each record, running solvers defined in the manifest to populate computed fields.
-
-## Column Definition
-
-### Simple Columns
-
-```javascript
-TableCells: [
-    {
-        Key: 'Name',
-        DisplayName: 'Name',
-        PictDashboard: {
-            ValueTemplate: '{~D:Record.Data.Name~}'
-        }
-    }
-]
-```
-
-### Computed Columns
-
-```javascript
-TableCells: [
-    {
-        Key: 'Total',
-        DisplayName: 'Total',
-        PictDashboard: {
-            Solver: 'ComputeTotal',
-            ValueTemplate: '{~D:Record.Computed.Total~}'
-        }
-    }
-]
-```
-
-### Custom Rendering
-
-```javascript
-TableCells: [
-    {
-        Key: 'Status',
-        DisplayName: 'Status',
-        PictDashboard: {
-            ValueTemplate: /*html*/`
-                <span class="badge badge-{~D:Record.Data.Status~}">
-                    {~D:Record.Data.Status~}
-                </span>
-            `
-        }
-    }
-]
-```
-
-## Lifecycle Hooks
-
-```javascript
-class CustomDashboardView extends viewRecordSetDashboard {
-    onBeforeRenderList(pRecordListData) {
-        // Add custom data processing
-        // Compute totals, add summary rows, etc.
-        return pRecordListData;
-    }
-
-    dynamicallyGenerateColumns(pRecordListData) {
-        // Customize auto-generated columns
-        return super.dynamicallyGenerateColumns(pRecordListData);
-    }
-}
-```
-
-## Templates
-
-| Template Hash | Purpose |
-|---------------|---------|
-| `PRSP-Dashboard-Template` | Main dashboard container |
-| `PRSP-Dashboard-Template-Record` | Record template |
-
-## Filter Integration
-
-Dashboards support the same filtering as List views:
-
-```javascript
-// With filter
-'/PSRS/Sales/Dashboard/FilteredTo/FBV~Region~EQ~North'
-
-// With filter experience (serialized filter state)
-'/PSRS/Sales/Dashboard/FilterExperience/eyJmaWx0ZXJzIjpbXX0='
-```
-
-## Decorated Records
-
-The Dashboard uses `getDecoratedRecords` instead of `getRecords`, which allows providers to add computed or transformed data:
-
-```javascript
-// In provider
-async getDecoratedRecords(pFilter) {
-    const records = await this.getRecords(pFilter);
-
-    // Add decorations
-    records.Records = records.Records.map(record => ({
-        ...record,
-        DisplayStatus: this.getStatusLabel(record.Status),
-        FormattedDate: this.formatDate(record.CreatedDate)
-    }));
-
-    return records;
-}
-```
-
-## Example Usage
-
-```javascript
-// Navigate to default dashboard
-pict.providers.RecordSetRouter.pictRouter.navigate('/PSRS/Sales/Dashboard');
-
-// Navigate to specific dashboard
-pict.providers.RecordSetRouter.pictRouter.navigate('/PSRS/Sales/SpecificDashboard/TopSellers');
-
-// Access the dashboard view
-const dashboardView = pict.views['RSP-RecordSet-Dashboard'];
-
-// Render programmatically
-const config = pict.PictSectionRecordSet.recordSetProviderConfigurations['Sales'];
-await dashboardView.renderDashboard(config, 'RSP-Provider-Sales', '', '', 0, 100);
-
-// Render specific dashboard
-await dashboardView.renderSpecificDashboard(
-    'TopSellers',
-    config,
-    'RSP-Provider-Sales',
-    '',     // filterString
-    '',     // filterExperience
-    0,      // offset
-    50      // pageSize
-);
-```
-
-## Data Structure
-
-The dashboard provides this data structure to templates:
-
-```javascript
-{
-    Title: 'Sales Dashboard',
-    RecordSet: 'Sales',
-    RecordSetConfiguration: { ... },
-    RenderDestination: '#PRSP_Container',
-    DashboardHash: 'TopSellers',      // For specific dashboards
-    FilterString: '',
-    Records: { Records: [...] },
-    TotalRecordCount: { Count: 500 },
-    RecordSchema: { properties: { ... } },
-    GUIDAddress: 'GUIDSales',
-    TableCells: [
-        {
-            Key: 'ProductName',
-            DisplayName: 'Product',
-            ManifestHash: 'Default',
-            PictDashboard: { ValueTemplate: '...' }
-        }
-    ],
-    // Pagination data...
-}
-```
-
-## Multiple Dashboards
-
-Configure multiple dashboards for different views of the same data:
-
-```javascript
-const recordSetConfig = {
-    RecordSet: 'Sales',
-    RecordSetDashboardManifests: ['Overview', 'ByRegion', 'ByProduct', 'TimeSeries']
-};
-
-// Register manifests
-pict.PictSectionRecordSet.addManifest('Overview', overviewManifest);
-pict.PictSectionRecordSet.addManifest('ByRegion', regionManifest);
-pict.PictSectionRecordSet.addManifest('ByProduct', productManifest);
-pict.PictSectionRecordSet.addManifest('TimeSeries', timeSeriesManifest);
-```
-
-Then navigate between them:
-
-```javascript
-// Overview
-'/PSRS/Sales/SpecificDashboard/Overview'
-
-// By Region
-'/PSRS/Sales/SpecificDashboard/ByRegion'
-
-// By Product
-'/PSRS/Sales/SpecificDashboard/ByProduct'
-```