pict-section-recordset 1.1.0 → 1.3.0

package/docs/record-providers.md

@@ -1,155 +0,0 @@
-# Record Providers
-
-Record providers handle all data operations for your record sets.
-
-## Provider Types
-
-### RecordSetProviderBase
-
-The base class for creating custom record providers:
-
-```javascript
-const libRecordSetProviderBase = require('pict-section-recordset').RecordSetProviderBase;
-
-class MyRecordProvider extends libRecordSetProviderBase
-{
-    constructor(pFable, pOptions, pServiceHash)
-    {
-        super(pFable, pOptions, pServiceHash);
-    }
-
-    // Get a single record by ID
-    getRecord(pIDOrGuid, fCallback)
-    {
-        // Fetch record from your data source
-        const record = this.fetchFromDatabase(pIDOrGuid);
-        fCallback(null, record);
-    }
-
-    // Get multiple records with filtering
-    getRecords(pFilter, fCallback)
-    {
-        // Fetch records with filter applied
-        const records = this.queryDatabase(pFilter);
-        fCallback(null, { Records: records });
-    }
-
-    // Create a new record
-    createRecord(pRecord, fCallback)
-    {
-        const newRecord = this.insertIntoDatabase(pRecord);
-        fCallback(null, newRecord);
-    }
-
-    // Update an existing record
-    updateRecord(pRecord, fCallback)
-    {
-        const updated = this.updateInDatabase(pRecord);
-        fCallback(null, updated);
-    }
-
-    // Delete a record
-    deleteRecord(pIDOrGuid, fCallback)
-    {
-        this.deleteFromDatabase(pIDOrGuid);
-        fCallback(null, true);
-    }
-}
-
-module.exports = MyRecordProvider;
-```
-
-### RecordSetProviderMeadowEndpoints
-
-Provider for Meadow REST API endpoints:
-
-```javascript
-const libMeadowProvider = require('pict-section-recordset').RecordSetProviderMeadowEndpoints;
-
-// The provider automatically handles:
-// - GET /Entity/{id} - Get single record
-// - GET /Entities/FilteredTo/{filter}/0/100 - Get filtered records
-// - POST /Entity - Create record
-// - PUT /Entity - Update record
-// - DELETE /Entity/{id} - Delete record
-```
-
-## Filter Object
-
-When fetching records, you can pass a filter object:
-
-```javascript
-const filter = {
-    // Entity name (can override for LiteExtended, etc.)
-    Entity: 'User',
-
-    // Meadow-style filter string
-    FilterString: 'FBV~Name~EQ~John',
-
-    // Pagination
-    Offset: 0,
-    PageSize: 25,
-
-    // Faceting for search
-    Facets: {
-        ReturnRecords: true,
-        Fields: ['Status', 'Department'],
-        Ranges: [
-            {
-                Field: 'CreatedDate',
-                Start: '2020-01-01',
-                End: '2025-12-31',
-                Gap: 'YEAR'
-            }
-        ]
-    }
-};
-
-provider.getRecords(filter, (err, result) => {
-    console.log(result.Records);  // Array of records
-    console.log(result.Facets);   // Facet counts
-});
-```
-
-## Provider Configuration
-
-```javascript
-const providerConfig = {
-    ProviderIdentifier: 'MyRecordProvider',
-
-    // Auto-initialize with application
-    AutoInitialize: true,
-    AutoInitializeOrdinal: 1,
-
-    // Don't solve with app (records loaded on demand)
-    AutoSolveWithApp: false
-};
-```
-
-## Registering Providers
-
-Register your provider with the Pict instance:
-
-```javascript
-// Add the provider type
-pict.addProviderSingleton('MyRecordProvider', providerConfig, MyRecordProvider);
-
-// Or instantiate directly
-const provider = pict.instantiateServiceProvider('RecordSetProviderBase', {
-    ProviderIdentifier: 'UserProvider'
-});
-```
-
-## Using with Meadow Endpoints
-
-The Meadow provider can auto-generate configuration from schema:
-
-```javascript
-// Fetch schema from Meadow endpoint
-fetch('/1.0/User/Schema')
-    .then(response => response.json())
-    .then(schema => {
-        // Use schema to configure the record set
-        app.configureFromSchema(schema);
-    });
-```

package/docs/retold-catalog.json

@@ -1,87 +0,0 @@
-{
-	"Generated": "2026-06-01T03:49:18.603Z",
-	"Mode": "module",
-	"GitHubOrg": "fable-retold",
-	"DefaultBranch": "master",
-	"Module": {
-		"Name": "pict-section-recordset",
-		"Repo": "pict-section-recordset",
-		"Group": "",
-		"Branch": "master",
-		"HasDocs": true,
-		"HasCover": true,
-		"Sidebar": [
-			{
-				"Title": "Getting Started",
-				"Children": [
-					{
-						"Title": "Introduction",
-						"Path": "README.md"
-					},
-					{
-						"Title": "Record Providers",
-						"Path": "record-providers.md"
-					}
-				]
-			},
-			{
-				"Title": "Views",
-				"Children": [
-					{
-						"Title": "Create View",
-						"Path": "views/create/README.md"
-					},
-					{
-						"Title": "Read View",
-						"Path": "views/read/README.md"
-					},
-					{
-						"Title": "List View",
-						"Path": "views/list/README.md"
-					},
-					{
-						"Title": "Dashboard View",
-						"Path": "views/dashboard/README.md"
-					}
-				]
-			},
-			{
-				"Title": "Configuration",
-				"Children": [
-					{
-						"Title": "Filters",
-						"Path": "filters.md"
-					}
-				]
-			},
-			{
-				"Title": "Reference",
-				"Children": [
-					{
-						"Title": "API Reference",
-						"Path": "api-reference.md"
-					}
-				]
-			}
-		],
-		"DocFiles": [
-			".nojekyll",
-			"README.md",
-			"_brand.json",
-			"_cover.md",
-			"_sidebar.md",
-			"_version.json",
-			"api-reference.md",
-			"filters.md",
-			"index.html",
-			"record-providers.md",
-			"retold-catalog.json",
-			"retold-keyword-index.json",
-			"views/create/README.md",
-			"views/dashboard/README.md",
-			"views/list/README.md",
-			"views/read/README.md"
-		]
-	},
-	"Groups": []
-}