pict-section-recordset 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Steven Velozo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# PICT RecordSet Section
+
+A PICT section that provides basic CRUD views (Create, Read, Update and Delete)
+based on stable providers and configurations.
+
+## The Noble Provider
+
+The only thing that's really required for this to operate is a Record/Record
+Set provider... and given a Meadow Endpoint, the `/1.0/Entity/Schema` endpoint
+can be used to programmatically create a functional provider.
+
+

package/debug/Harness.js

@@ -0,0 +1,7 @@
+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/README.md

@@ -0,0 +1,15 @@
+# Example Applications
+
+These applications exercise the library from very basic to complex.
+
+## The Basics
+
+These forms are meant to provide simple configuration-based test
+suites for the framework.
+
+### Simple RecordSet
+
+The most basic example.  Some lists, etc. for Book and Author
+records.
+
+http://localhost:9090/simple_entity/dist/index.html

package/example_applications/ServeExamples.js

@@ -0,0 +1,82 @@
+const libFable = require('fable');
+
+const defaultFableSettings = (
+	{
+		Product:'PictSectionFormExampleServer',
+		ProductVersion: '1.0.0',
+		APIServerPort: 9090,
+
+		OratorHTTPProxyDestinationURL: 'http://127.0.0.1:8086/'
+	});
+
+// Initialize Fable
+let _Fable = new libFable(defaultFableSettings);
+
+// Now initialize the Restify ServiceServer Fable Service
+_Fable.serviceManager.addServiceType('OratorServiceServer', require('orator-serviceserver-restify'));
+_Fable.serviceManager.instantiateServiceProvider('OratorServiceServer', 
+	{
+		RestifyConfiguration: { strictNext: true }
+	});
+
+// Now add the orator service to Fable
+_Fable.serviceManager.addServiceType('Orator', require('orator'));
+let _Orator = _Fable.serviceManager.instantiateServiceProvider('Orator', {});
+
+let tmpAnticipate = _Fable.newAnticipate();
+
+// Initialize the Orator server
+tmpAnticipate.anticipate(_Orator.initialize.bind(_Orator));
+
+// Create a simple custom endpoint on the server.
+tmpAnticipate.anticipate(
+	(fStageComplete)=>
+	{
+		// Create an endpoint.  This can also be done after the service is started.
+		_Orator.serviceServer.get
+		(
+			'/1.0/test/:hash',
+			(pRequest, pResponse, fNext) =>
+			{
+				// Send back the request parameters
+				pResponse.send(pRequest.params);
+				_Orator.fable.log.info(`Endpoint sent parameters object:`, pRequest.params);
+				return fNext();
+			}
+		);
+		return fStageComplete();
+	});
+
+tmpAnticipate.anticipate(
+	(fStageComplete) =>
+	{
+		_Orator.addStaticRoute(`${__dirname}/`);
+		return fStageComplete();
+	}
+)
+
+// Add the http proxy service
+const libOratorHTTPProxy = require(`orator-http-proxy`);
+_Fable.serviceManager.addServiceType('OratorHTTPProxy', libOratorHTTPProxy);
+_Fable.serviceManager.instantiateServiceProvider('OratorHTTPProxy', {LogLevel: 2});
+// Proxy all /1.0/ requests to the locally-running bookstore service (you need to run this from https://github.com/stevenvelozo/retold-harness ... it's a one-liner to start the service)
+tmpAnticipate.anticipate(
+	(fNext)=>
+	{
+		_Fable.OratorHTTPProxy.connectProxyRoutes();
+		return fNext();
+	});
+
+
+// Now start the service server.
+tmpAnticipate.anticipate(_Orator.startService.bind(_Orator));
+
+tmpAnticipate.wait(
+	(pError)=>
+	{
+		if (pError)
+		{
+			_Fable.log.error('Error initializing Orator Service Server: '+pError.message, pError);
+		}
+		_Fable.log.info('Orator Service Server Initialized.');
+	});

package/example_applications/index.html

@@ -0,0 +1,20 @@
+<!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 Applications</title>
+</head>
+<body>
+	<h1>Examples</h1>
+	<ul>
+		<li><a href="debug/index.html">Debug Harness (must build from debug folder)</a></li>
+		<li><a href="simple_form/dist/index.html">Simple Form</a></li>
+		<li><a href="simple_table/dist/index.html">Simple Table</a></li>
+		<li><a href="complex_table/dist/index.html">Complex Grid</a></li>
+		<li><a href="complex_tuigrid/dist/index.html">Complex Grid (using Toast UI Grid)</a></li>
+		<li><a href="gradebook/dist/index.html">Gradebook Linked Set Exercises</a></li>
+		<li><a href="postcard_example/dist/index.html">PostKard Custom App</a></li>
+	</ul>
+</body>
+</html>

package/example_applications/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "example_applications",
+  "version": "1.0.0",
+  "description": "Simple static server and API pass-through to Bookstore API.",
+  "main": "ServeExamples.js",
+  "scripts": {
+    "start": "node ServeExamples.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "orator": "^5.0.1",
+    "orator-http-proxy": "^1.0.1",
+    "orator-serviceserver-restify": "^2.0.3"
+  }
+}

package/example_applications/simple_entity/.quackage.json

@@ -0,0 +1,9 @@
+{
+	"GulpExecutions": [
+	{
+		"Hash": "default",
+		"Name": "Default standard build.",
+		"BuildFileLabel": "",
+		"BrowsersListRC": "since 2022"
+	}]
+}

package/example_applications/simple_entity/README-Simple-RecordSet.md

@@ -0,0 +1,8 @@
+# Minimum Viable Record Set Forms Edit Application
+
+To run this, install dependencies in the root of this repository with a `npm install`
+and then navigate to this folder and run `npm run build` to build the dist files
+(which are not checked in).  Then, you should be able to open dist/index.html from
+your favorite browser.
+
+This form exercises a configuration-only form that has CRUD for the Book entity.

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

@@ -0,0 +1,33 @@
+const libPictRecordSet = require('../../source/Pict-Section-RecordSet.js');
+//const libPictSectionForm = require('pict-section-recordset');
+
+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.
+					}
+				]
+		});

package/example_applications/simple_entity/html/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<title>Simple.</title>
+		<style id="PICT-CSS"></style>
+		<script src="./pict.min.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>
+	</body>
+</html>

package/example_applications/simple_entity/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "simple_application",
+    "version": "1.0.0",
+    "description": "The most basic forms application ever!",
+    "main": "Simple-RecordSet-Application.js",
+    "scripts": {
+        "start": "node Simple-RecordSet-Application.js",
+        "build": "npx quack build && npx quack copy"
+    },
+    "author": "steven",
+    "license": "MIT",
+    "devDependencies": {
+    },
+    "copyFilesSettings": {
+        "whenFileExists": "overwrite"
+    },
+    "copyFiles": [
+        {
+            "from": "./html/*",
+            "to": "./dist/"
+        },
+        {
+            "from": "../../node_modules/pict/dist/*",
+            "to": "./dist/"
+        }
+    ]
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "pict-section-recordset",
+  "version": "1.0.0",
+  "description": "Pict dynamic record set management views",
+  "main": "source/Pict-Section-RecordSet.js",
+  "directories": {
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stevenvelozo/pict-section-recordset.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stevenvelozo/pict-section-recordset/issues"
+  },
+  "homepage": "https://github.com/stevenvelozo/pict-section-recordset#readme",
+  "scripts": {
+    "start": "node source/Pict-Section-RecordSet.js",
+    "tests": "npx mocha -u tdd --exit -R spec --grep",
+    "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec",
+    "build": "npx quack build",
+    "test": "npx mocha -u tdd -R spec",
+    "lint": "eslint source/**",
+    "types": "tsc -p ."
+  },
+  "types": "types/source/Pict-Section-RecordSet.d.ts",
+  "author": "steven velozo <steven@velozo.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "browser-env": "^3.3.0",
+    "eslint": "^9.21.0",
+    "jquery": "^3.7.1",
+    "pict": "^1.0.237",
+    "pict-application": "^1.0.24",
+    "pict-service-commandlineutility": "^1.0.15",
+    "quackage": "^1.0.40",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "fable-serviceproviderbase": "^3.0.15",
+    "pict-provider": "^1.0.3",
+    "pict-template": "^1.0.10",
+    "pict-view": "^1.0.59"
+  },
+  "mocha": {
+    "diff": true,
+    "extension": [
+      "js"
+    ],
+    "package": "./package.json",
+    "reporter": "spec",
+    "slow": "75",
+    "timeout": "5000",
+    "ui": "tdd",
+    "watch-files": [
+      "source/**/*.js",
+      "test/**/*.js"
+    ],
+    "watch-ignore": [
+      "lib/vendor"
+    ]
+  }
+}

package/source/Pict-Section-RecordSet.js

@@ -0,0 +1,8 @@
+// The container for all the Pict-Section-Form related code.
+
+// The main dynamic view class
+module.exports = require('./Pict-Section-RecordSet.js');
+//module.exports.default_configuration = require('./views/Pict-View-DynamicForm-DefaultConfiguration.json');
+
+// The application container
+module.exports.PictRecordSetApplication = require('./application/Pict-Application-RecordSet.js');

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

@@ -0,0 +1,39 @@
+const libPictApplication = require('pict-application');
+
+const libPictSectionRecordSet = require('../Pict-Section-RecordSet.js');
+
+/**
+ * Represents a PictSectionFormApplication.
+ *
+ * This is the automagic controller for a dyncamic form application.
+ *
+ * @class
+ * @extends libPictApplication
+ */
+class PictSectionFormApplication extends libPictApplication
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+
+		/** @type {import('pict') & import('fable')} */
+		this.pict;
+		// Add the pict recordset meta controller service
+		this.pict.addServiceType('PictSectionRecordSet', libPictSectionRecordSet);
+	}
+};
+
+module.exports = PictSectionFormApplication
+
+module.exports.default_configuration = (
+{
+	"Name": "A Simple Pict RecordSet Application",
+	"Hash": "PictRecordSetApplication",
+
+	//"MainViewportViewIdentifier": "PictRecordSetPrimaryView",
+
+	"pict_configuration":
+		{
+			"Product": "DefaultPictRecordSetApplication",
+		}
+});

package/test/PictSectionRecordSet-Basic_tests.js

@@ -0,0 +1,95 @@
+/*
+	Unit tests for PictSectionRecordSet Basic
+	
+*/
+
+// This is temporary, but enables unit tests
+const libBrowserEnv = require('browser-env')
+libBrowserEnv();
+
+const libPictView = require('pict-view');
+
+const Chai = require('chai');
+const Expect = Chai.expect;
+
+const libPict = require('pict');
+
+const libPictSectionRecordSet = require('../source/Pict-Section-RecordSet.js');
+
+class DoNothingApplication extends libPictSectionRecordSet.PictRecordSetApplication
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+
+		this.pict.addView('DoNothingView', {}, DoNothingView);
+	}
+
+	/**
+	 * @param {function} fDone - Callback that finishes the test
+	 */
+	set testDone(fDone)
+	{
+		this._testDone = fDone;
+	}
+
+	onAfterInitialize()
+	{
+		this.solve();
+		this._testDone();
+		return super.onAfterInitialize();
+	}
+}
+
+class DoNothingView extends libPictView
+{
+	constructor(pPict, pOptions)
+	{
+		super(pPict, pOptions);
+	}
+}
+
+suite
+(
+	'PictSectionRecordSet Basic',
+	() =>
+	{
+		setup(() => { });
+
+		suite
+			(
+				'Basic Basic Tests',
+				() =>
+				{
+					test(
+							'Basic Initialization',
+							(fDone) =>
+							{
+								let _Pict = new libPict();
+								_Pict.LogNoisiness = 1;
+								let _PictEnvironment = new libPict.EnvironmentObject(_Pict);
+
+								let _Application = new DoNothingApplication(_Pict, {});
+
+								Expect(_Application).to.be.an('object', 'Application should be an object.');
+								Expect(_Application).to.be.an.instanceof(libPictSectionRecordSet.PictRecordSetApplication, 'Application should be an instance of PictRecordSetApplication.');
+
+
+								// let _PictSectionRecordSet = _Pict.addView(tmpViewHash, tmpViewConfiguration, libPictSectionRecordSet);
+
+								// Expect(_PictSectionRecordSet).to.be.an('object');
+
+								// // Test package anthropology
+								// Expect(_PictSectionRecordSet._PackageFableServiceProvider).to.be.an('object', 'Fable should have a _PackageFableServiceProvider object.');
+								// Expect(_PictSectionRecordSet._PackageFableServiceProvider.name).equal('fable-serviceproviderbase', 'Fable _PackageFableServiceProvider.package.name should be set.');
+								// Expect(_PictSectionRecordSet._PackagePictView).to.be.an('object', 'Should have a _PackagePictView object.');
+								// Expect(_PictSectionRecordSet._PackagePictView.name).to.equal('pict-view', '_PackagePictView.package.name should be set.');
+								// Expect(_PictSectionRecordSet._Package).to.be.an('object', 'Should have a _Package object.');
+								// Expect(_PictSectionRecordSet._Package.name).to.equal('pict-section-recordset', '_Package.package.name should be set.');
+
+								return fDone();
+							}
+						);
+					});
+	}
+);

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+	"include": ["source"],
+	"compilerOptions":
+	{
+		"target": "es2019",
+		"esModuleInterop": true,
+		"allowJs": true,
+		"checkJs": true,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"outDir": "types",
+		"declarationMap": true,
+		"module": "commonjs",
+		"resolveJsonModule": true
+	}
+}

package/types/Pict-Section-RecordSet.d.ts

@@ -0,0 +1,3 @@
+declare const _exports: any;
+export = _exports;
+//# sourceMappingURL=Pict-Section-RecordSet.d.ts.map

package/types/Pict-Section-RecordSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pict-Section-RecordSet.d.ts","sourceRoot":"","sources":["../source/Pict-Section-RecordSet.js"],"names":[],"mappings":""}

package/types/application/Pict-Application-RecordSet.d.ts

@@ -0,0 +1,24 @@
+export = PictSectionFormApplication;
+/**
+ * Represents a PictSectionFormApplication.
+ *
+ * This is the automagic controller for a dyncamic form application.
+ *
+ * @class
+ * @extends libPictApplication
+ */
+declare class PictSectionFormApplication extends libPictApplication {
+    constructor(pFable: any, pOptions: any, pServiceHash: any);
+}
+declare namespace PictSectionFormApplication {
+    export { default_configuration };
+}
+import libPictApplication = require("pict-application");
+declare namespace default_configuration {
+    let Name: string;
+    let Hash: string;
+    namespace pict_configuration {
+        let Product: string;
+    }
+}
+//# sourceMappingURL=Pict-Application-RecordSet.d.ts.map

package/types/application/Pict-Application-RecordSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pict-Application-RecordSet.d.ts","sourceRoot":"","sources":["../../source/application/Pict-Application-RecordSet.js"],"names":[],"mappings":";AAIA;;;;;;;GAOG;AACH;IAEC,2DAQC;CACD"}

package/types/providers/RecordSet-RecordProvider-Base.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=RecordSet-RecordProvider-Base.d.ts.map

package/types/providers/RecordSet-RecordProvider-Base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordSet-RecordProvider-Base.d.ts","sourceRoot":"","sources":["../../source/providers/RecordSet-RecordProvider-Base.js"],"names":[],"mappings":""}