npm - pict-section-recordset - Versions diffs - 1.0.0 → 1.0.1 - Mend

pict-section-recordset 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (98) hide show

package/.vscode/launch.json ADDED Viewed

@@ -0,0 +1,46 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Debug Harness",
+            "type": "pwa-node",
+            "request": "launch",
+            "outputCapture": "std",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/debug/Harness.js",
+            "presentation": {
+                "hidden": false,
+                "group": "",
+                "order": 1
+            }
+        },
+        {
+            "name": "Mocha Tests",
+            "args": [
+                "-u",
+                "tdd",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceFolder}/test"
+            ],
+            "internalConsoleOptions": "openOnSessionStart",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "pwa-node",
+            "presentation": {
+                "hidden": false,
+                "group": "",
+                "order": 2
+            }
+        }
+    ]
+}

package/debug/Harness.js CHANGED Viewed

@@ -1,7 +0,0 @@
-const libParseCSV = require('../utility/csvparser/ParseCSV-Program.js');
-// This command takes the `TabularManifestCSV.csv` file and imports it into a JSON file
-//libParseCSV.run(['node', 'Harness.js', 'import']);
-// This command takes the `data/MathExampleForm.json` file and injects any sidecare files in the `input_data` folder into the JSON file
-//libParseCSV.run(['node', 'Harness.js', 'inject']);
-libParseCSV.run(['node', 'Harness.js', 'intersect']);

package/example_applications/list_view/index.html ADDED Viewed

@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title>Example Pict-Section-Form List View </title>
+</head>
+<body>
+	<!-- START Header template -->
+	<header id="RSP-Header-Container">
+		<!-- START Header-Title template -->
+		<h1>Title of Entity</h1>
+		<!-- END Header-Title template -->
+		<!-- START Header-Subtitle template -->
+		<h2>Subtitle of Entity</h2>
+		<!-- END Header-Subtitle template -->
+	</header>
+	<!-- END Header template -->
+	<!-- START Filter template-->
+	<section id="RSP-Filter-Container">
+		<form id="RSP-Filter-Form">
+			<!-- START Filter-Input-Container template -->
+			<fieldset>
+				<!-- START Filter-Input-Label template -->
+				<label for="filter">Filter:</label>
+				<!-- END Filter-Input-Label template -->
+				<!-- START Filter-Input template -->
+				<input type="text" id="filter" name="filter">
+				<!-- END Filter-Input template -->
+			</fieldset>
+			<!-- END Filter-Input-Container template -->
+			<!-- START Filter-Button-Container template -->
+			<fieldset id="RSP-Filter-Button-Container">
+				<!-- START Filter-Button-Reset template -->
+				<button type="button" id="RSP-Filter-Button-Reset">Reset</button>
+				<!-- END Filter-Button-Reset template -->
+				<!-- START Filter-Button-Apply template -->
+				<button type="submit" id="RSP-Filter-Button-Apply">Apply</button>
+				<!-- END Filter-Button-Apply template -->
+			</fieldset>
+			<!-- END Filter-Button-Container template -->
+		</form>
+	</section>
+	<!-- END Filter template-->
+	<!-- START Upper Pagination template -->
+	<nav id="RSP-Upper-Pagination-Container">
+		<!-- START Upper Pagination-Description template -->
+		<p>Showing 1-25 of 100</p>
+		<!-- END Upper Pagination-Description template -->
+		<!-- START Upper Pagination-Button-Container template -->
+		<ul>
+			<!-- START Upper Pagination Button Previous template -->
+			<li><a href="#">&laquo; Previous</a></li>
+			<!-- END Upper Pagination Button Previous template -->
+			<!-- START Upper Pagination Button Page template -->
+			<li><a href="#">1</a></li>
+			<!-- END Upper Pagination Button Page template -->
+			<!-- NOTE: more as needed (for examples)-->
+			<li><a href="#">2</a></li>
+			<li><a href="#">3</a></li>
+			<li><a href="#">4</a></li>
+			<!-- START Upper Pagination Button Next template -->
+			<li><a href="#">Next &raquo;</a></li>
+			<!-- END Upper Pagination Button Next template -->
+			<!-- START Upper Pagination Button Page template -->
+		</ul>
+		<!-- END Upper Pagination Button Page template -->
+	</nav>
+	<!-- END Upper Pagination template -->
+	<!-- START List template -->
+	<section id="RSP-List-Container">
+		<!-- START List-Table template -->
+		<table id="RSP-List-Table">
+			<!-- START List-Table-Header template -->
+			<thead>
+				<tr>
+					<!-- START List-Table-Header-Cell -->
+					<th>Column 1</th>
+					<!-- END List-Table-Header-Cell -->
+					<!-- NOTE: more cells as needed -->
+					<th>Column 2</th>
+					<th>Column 3</th>
+				</tr>
+			</thead>
+			<!-- END List-Table-Header template -->
+			<!-- START List-Table-Body template -->
+			<tbody>
+				<!-- START List-Table-Body-Row -->
+				<tr>
+					<!-- START List-Table-Body-Cell -->
+					<td>Row 1, Cell 1</td>
+					<!-- END List-Table-Body-Cell -->
+					<!-- NOTE: more cells as needed -->
+					<td>Row 1, Cell 2</td>
+					<td>Row 1, Cell 3</td>
+					<!-- START List-Table-Body-Extra-Cell -->
+					<td><!-- NOTE: slot for extra columns--></td>
+					<!-- END List-Table-Body-Extra-Cell -->
+				</tr>
+				<!-- END List-Table-Body-Row -->
+				<!-- Note: more rows as needed -->
+			</tbody>
+			<!-- END List-Table-Body template -->
+		</table>
+		<!-- END List-Table template -->
+	</section>
+	<!-- END List template -->
+	<!-- START Lower Pagination template -->
+	<nav id="RSP-Lower-Pagination-Container">
+		<!-- NOTE: Re-apply "RSP-Upper-Pagination-Container" content here to avoid duplication. -->
+	</nav>
+	<!-- END Lower Pagination template -->
+	<!-- Footer template -->
+	<footer id="RSP-Footer-Container">
+		<!-- NOTE: slot for additional set actions -->
+	</footer>
+	<!-- END Footer template -->
+</body>
+</html>

package/example_applications/simple_entity/Simple-RecordSet-Application.js CHANGED Viewed

@@ -4,30 +4,36 @@ const libPictRecordSet = require('../../source/Pict-Section-RecordSet.js');
 module.exports = libPictRecordSet.PictRecordSetApplication;
 module.exports.default_configuration.pict_configuration = (
-		{
-			"Product": "Simple Record Set",
-			"DefaultRecordSetConfigurations":
-				[
-					{
-						"RecordSet": "Book",
-						"RecordSetType": "MeadowEndpoint", // Could be "Custom" which would require a provider to already be created for the record set.
-						"RecordSetMeadowEntity": "Book",   // This leverages the /Schema endpoint to get the record set columns.
-						"RecordSetURLPrefix": "http://datadebase.com:8086/1.0/"
-					},
-					{
-						"RecordSet": "Author",
-						"RecordSetType": "MeadowEndpoint",
-						"RecordSetMeadowEntity": "Author",
-						"RecordSetURLPrefix": "http://datadebase.com:8086/1.0/"
-					},
-					{
-						"RecordSet": "RandomizedValues",
-						"RecordSetType": "Custom" // This means the `PS-RSP-RandomizedValues` provider will be checked for to get records.
-					}
-				]
+	{
+		"Product": "Simple Record Set",
+		"PictApplicationConfiguration":
+			{
+				"AutoRenderMainViewportViewAfterInitialize": false
+			},
+		"DefaultRecordSetConfigurations":
+			[
+				{
+					"RecordSet": "Book",
+					"RecordSetType": "MeadowEndpoint", // Could be "Custom" which would require a provider to already be created for the record set.
+					"RecordSetMeadowEntity": "Book",   // This leverages the /Schema endpoint to get the record set columns.
+					"RecordSetURLPrefix": "http://www.datadebase.com:8086/1.0/"
+				},
+				{
+					"RecordSet": "Author",
+					"RecordSetType": "MeadowEndpoint",
+					"RecordSetMeadowEntity": "Author",
+					"RecordSetURLPrefix": "http://www.datadebase.com:8086/1.0/"
+				},
+				{
+					"RecordSet": "RandomizedValues",
+					"RecordSetType": "Custom" // This means the `PS-RSP-RandomizedValues` provider will be checked for to get records.
+				}
+			]
 		});

package/example_applications/simple_entity/html/index.html CHANGED Viewed

@@ -3,11 +3,11 @@
 	<head>
 		<title>Simple.</title>
 		<style id="PICT-CSS"></style>
-		<script src="./pict.min.js" type="text/javascript"></script>
+		<script src="./pict.js" type="text/javascript"></script>
 		<script type="text/javascript">Pict.safeOnDocumentReady(() => { Pict.safeLoadPictApplication(SimpleApplication, 1)});</script>
 	</head>
 	<body>
-		<div id="Pict-Form-Container"></div>
-		<script src="./simple_application.min.js" type="text/javascript"></script>
+		<div id="PRSP_List_Container"></div>
+		<script src="./simple_application.js" type="text/javascript"></script>
 	</body>
 </html>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "pict-section-recordset",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Pict dynamic record set management views",
   "main": "source/Pict-Section-RecordSet.js",
   "directories": {
@@ -21,27 +21,30 @@
     "build": "npx quack build",
     "test": "npx mocha -u tdd -R spec",
     "lint": "eslint source/**",
-    "types": "tsc -p ."
+    "types": "tsc -p tsconfig.build.json"
   },
   "types": "types/source/Pict-Section-RecordSet.d.ts",
   "author": "steven velozo <steven@velozo.com>",
   "license": "MIT",
   "devDependencies": {
     "@eslint/js": "^9.21.0",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^16.18.126",
     "browser-env": "^3.3.0",
     "eslint": "^9.21.0",
     "jquery": "^3.7.1",
-    "pict": "^1.0.237",
-    "pict-application": "^1.0.24",
+    "pict": "^1.0.239",
+    "pict-application": "^1.0.25",
     "pict-service-commandlineutility": "^1.0.15",
-    "quackage": "^1.0.40",
+    "quackage": "^1.0.41",
     "typescript": "^5.7.3"
   },
   "dependencies": {
     "fable-serviceproviderbase": "^3.0.15",
     "pict-provider": "^1.0.3",
+    "pict-router": "^1.0.3",
     "pict-template": "^1.0.10",
-    "pict-view": "^1.0.59"
+    "pict-view": "^1.0.60"
   },
   "mocha": {
     "diff": true,

package/source/Pict-Section-RecordSet.js CHANGED Viewed

@@ -1,8 +1,12 @@
 // The container for all the Pict-Section-Form related code.
 // The main dynamic view class
-module.exports = require('./Pict-Section-RecordSet.js');
+module.exports = require('./services/RecordsSet-MetaController.js');
 //module.exports.default_configuration = require('./views/Pict-View-DynamicForm-DefaultConfiguration.json');
 // The application container
-module.exports.PictRecordSetApplication = require('./application/Pict-Application-RecordSet.js');
+module.exports.PictRecordSetApplication = require('./application/Pict-Application-RecordSet.js');
+// Export the providers
+module.exports.RecordSetProviderBase = require('./providers/RecordSet-RecordProvider-Base.js');
+module.exports.RecordSetProviderMeadowEndpoints = require('./providers/RecordSet-RecordProvider-MeadowEndpoints.js');

package/source/application/Pict-Application-RecordSet.js CHANGED Viewed

@@ -21,6 +21,17 @@ class PictSectionFormApplication extends libPictApplication
 		// Add the pict recordset meta controller service
 		this.pict.addServiceType('PictSectionRecordSet', libPictSectionRecordSet);
 	}
+	onInitialize()
+	{
+		// Add the PictSectionRecordSet service
+		this.pict.instantiateServiceProvider('PictSectionRecordSet', this.options);
+		// Initialize the views for the foundation metacontroller service
+		this.pict.PictSectionRecordSet.initialize();
+		// Initialize the parent class
+		return super.onInitialize();
+	}
 };
 module.exports = PictSectionFormApplication

package/source/providers/RecordSet-RecordProvider-Base.js CHANGED Viewed

@@ -0,0 +1,217 @@
+const libPictProvider = require('pict-provider');
+/**
+ * Default configuration for the RecordSetProvider provider.
+ * @type {Record<string, any>}
+ */
+const _DefaultProviderConfiguration = {
+	ProviderIdentifier: 'Pict-RecordSetProvider',
+	AutoInitialize: true,
+	AutoInitializeOrdinal: 0,
+	AutoSolveWithApp: false,
+};
+/**
+ * @typedef {Object} RecordSetSearchRangeFacet
+ * @property {string} Field - The field to facet on. Only indexed fields can be faceted.
+ * @property {any} Start - The start of the range. (ex. 1900)
+ * @property {any} End - The end of the range. (ex. 2025)
+ * @property {any} Gap - The gap between range values. (ex. 25)
+ * TODO: Support auto-generating ranges based on the data at rest?
+ */
+/**
+ * @typedef {Object} RecordSetSearchFacetPayload
+ * @property {boolean} [ReturnRecords] - If false, search will return facets only, not records.
+ * @property {Array<string>} Fields - Requests to facet on all unique values of the given fields.
+ * @property {Array<RecordSetSearchRangeFacet>} Ranges - Requests to facet on given ranges of field values.
+ * TODO: support facet on custom query?
+ */
+/**
+ * @typedef {Object} RecordSetResult
+ * @property {Array<Record<string, any>>} Records - The records returned from the provider.
+ * @property {Record<string, Record<string, number>> & { ByRange?: Record<string, number> }} Facets - The facets returned from the provider.
+ */
+/**
+ * @typedef {Object} RecordSetFilter
+ * @property {string} [Entity] - The entity name. Can be used as an override to achieve LiteExtended, etc.
+ * @property {string} [FilterString] - A meadow endpoint style filter to apply.
+ * @property {number} [Offset] - The starting record number for pagination.
+ * @property {number} [PageSize] - The starting record number for pagination.
+ * @property {RecordSetSearchFacetPayload} [Facets] - The faceting config for the search.
+ */
+/**
+ * Base record set provider.
+ * @extends libPictProvider
+ */
+class RecordSetProviderBase extends libPictProvider
+{
+	/**
+	 * Creates an instance of RecordSetProvider.
+	 * @param {import('fable')} pFable - The Fable object.
+	 * @param {Record<string, any>} [pOptions] - Custom options for the provider.
+	 * @param {string} [pServiceHash] - The service hash.
+	 */
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		const tmpOptions = Object.assign({}, JSON.parse(JSON.stringify(_DefaultProviderConfiguration)), pOptions);
+		super(pFable, tmpOptions, pServiceHash);
+		/** @type {Record<string, any>} */
+		this.options;
+		/** @type {import('fable')} */
+		this.fable;
+		/** @type {import('pict')} */
+		this.pict;
+	}
+	/**
+	 * Get a record by its ID or GUID.
+	 *
+	 * @param {string|number} pIDOrGuid - The ID or GUID of the record.
+	 */
+	async getRecord(pIDOrGuid)
+	{
+		this.pict.log.info(`RecordSetProviderBase.getRecord(${pIDOrGuid})`);
+		return { };
+	}
+	/**
+	 * Get a record by its ID or GUID.
+	 *
+	 * @param {string|number} pGuid - The ID or GUID of the record.
+	 */
+	async getRecordByGUID(pGuid)
+	{
+		this.pict.log.info(`RecordSetProviderBase.getRecordByGUID(${pGuid})`);
+		return { };
+	}
+	/**
+	 * Read records from the provider.
+	 *
+	 * @param {RecordSetFilter} pOptions - Options for the read operation.
+	 * @return {Promise<RecordSetResult>} - The result of the read operation.
+	 */
+	async getRecords(pOptions)
+	{
+		this.pict.log.info(`RecordSetProviderBase.getRecords(${JSON.stringify(pOptions)})`);
+		return { Records: [], Facets: { } };
+	}
+	/**
+	 * Read records from the provider.
+	 *
+	 * @param {string} [pFilterString] - The filter string to apply.
+	 * @param {number} [pOffset] - The starting record number for pagination.
+	 * @param {number} [pPageSize] - The number of records to return.
+	 * @return {Promise<RecordSetResult>} - The result of the read operation.
+	 */
+	async getRecordsInline(pFilterString = '', pOffset = 0, pPageSize = 250)
+	{
+		this.pict.log.info(`RecordSetProviderBase.getRecordsInline(${pFilterString}, ${pOffset}, ${pPageSize})`);
+		return { Records: [], Facets: { } };
+	}
+	/**
+	 * Read records from the provider.
+	 *
+	 * @param {RecordSetFilter} pOptions - Options for the read operation.
+	 */
+	async getRecordSetCount(pOptions)
+	{
+		this.pict.log.info(`RecordSetProviderBase.getRecordSetCount(${JSON.stringify(pOptions)})`);
+		return { Count: 0 };
+	}
+	/**
+	 * Create a new record.
+	 *
+	 * @param {Record<string, any>} pRecord - The record to create.
+	 */
+	async createRecord(pRecord)
+	{
+		this.pict.log.info(`RecordSetProviderBase.createRecord(${JSON.stringify(pRecord)})`);
+		return pRecord;
+	}
+	/**
+	 * Update a record.
+	 *
+	 * @param {Record<string, any>} pRecord - The record to update.
+	 */
+	async updateRecord(pRecord)
+	{
+		this.pict.log.info(`RecordSetProviderBase.updateRecord(${JSON.stringify(pRecord)})`);
+		return pRecord;
+	}
+	/**
+	 * Delete a record.
+	 *
+	 * @param {Record<string, any>} pRecord - The record to delete.
+	 */
+	async deleteRecord(pRecord)
+	{
+		this.pict.log.info(`RecordSetProviderBase.deleteRecord(${JSON.stringify(pRecord)})`);
+	}
+	/**
+	 * Read a record.
+	 *
+	 * @param {string|number} pIDOrGuid - The ID or GUID of the record.
+	 */
+	async readRecord(pIDOrGuid)
+	{
+		this.pict.log.info(`RecordSetProviderBase.readRecord(${pIDOrGuid})`);
+		return { };
+	}
+	/**
+	 * Read records from the provider.
+	 *
+	 * @param {RecordSetFilter} pOptions - Options for the read operation.
+	 * @return {Promise<RecordSetResult>} - The result of the read operation.
+	 */
+	async readRecords(pOptions)
+	{
+		this.pict.log.info(`RecordSetProviderBase.readRecords(${JSON.stringify(pOptions)})`);
+		return { Records: [], Facets: { } };
+	}
+	/**
+	 * Clone a record.
+	 *
+	 * @param {Record<string, any>} pRecord - The record to clone.
+	 */
+	async cloneRecord(pRecord)
+	{
+		return this.createRecord(this.cleanRecord(pRecord));
+	}
+	/**
+	 * Remove any intrinsic identifiers from a record.
+	 *
+	 * @param {Record<string, any>} pRecord - The record to clean.
+	 */
+	cleanRecord(pRecord)
+	{
+		return pRecord;
+	}
+	/**
+	 * @return {Record<string, any>} The schema of the record.
+	 */
+	get recordSchema()
+	{
+		return { };
+	}
+}
+module.exports = RecordSetProviderBase;
+module.exports.default_configuration = _DefaultProviderConfiguration;