forked from FINAKON/HelpProject
Bhargava
6063bd1724
1. Initial Commit - a boiler plate code and POC to realize the concept of context
sensitive help
2. Frontend code written in ReactJS
3. Backend code written in Java, Spring Boot Framework
4. Frontend Start:
pre-requisites : node, npm
npm run dev ==> to start the frontend vite server
5. Backend Start:
pre-requisites : java, mvn
mvn spring-boot:run ==> to start the backend server
6. Visit http://localhost:5173/ for basic demo of help, press F1 in textboxes
7. Visit http://localhost:5173/editor and enter "admin123" to add/modify texts.
Happy Coding !!!
Thank you,
Bhargava.
70 lines
1.7 KiB
JavaScript
70 lines
1.7 KiB
JavaScript
/**
|
|
* @import {Info, Space} from 'property-information'
|
|
*/
|
|
|
|
/**
|
|
* @typedef Definition
|
|
* Definition of a schema.
|
|
* @property {Record<string, string> | undefined} [attributes]
|
|
* Normalzed names to special attribute case.
|
|
* @property {ReadonlyArray<string> | undefined} [mustUseProperty]
|
|
* Normalized names that must be set as properties.
|
|
* @property {Record<string, number | null>} properties
|
|
* Property names to their types.
|
|
* @property {Space | undefined} [space]
|
|
* Space.
|
|
* @property {Transform} transform
|
|
* Transform a property name.
|
|
*/
|
|
|
|
/**
|
|
* @callback Transform
|
|
* Transform.
|
|
* @param {Record<string, string>} attributes
|
|
* Attributes.
|
|
* @param {string} property
|
|
* Property.
|
|
* @returns {string}
|
|
* Attribute.
|
|
*/
|
|
|
|
import {normalize} from '../normalize.js'
|
|
import {DefinedInfo} from './defined-info.js'
|
|
import {Schema} from './schema.js'
|
|
|
|
/**
|
|
* @param {Definition} definition
|
|
* Definition.
|
|
* @returns {Schema}
|
|
* Schema.
|
|
*/
|
|
export function create(definition) {
|
|
/** @type {Record<string, Info>} */
|
|
const properties = {}
|
|
/** @type {Record<string, string>} */
|
|
const normals = {}
|
|
|
|
for (const [property, value] of Object.entries(definition.properties)) {
|
|
const info = new DefinedInfo(
|
|
property,
|
|
definition.transform(definition.attributes || {}, property),
|
|
value,
|
|
definition.space
|
|
)
|
|
|
|
if (
|
|
definition.mustUseProperty &&
|
|
definition.mustUseProperty.includes(property)
|
|
) {
|
|
info.mustUseProperty = true
|
|
}
|
|
|
|
properties[property] = info
|
|
|
|
normals[normalize(property)] = property
|
|
normals[normalize(info.attribute)] = property
|
|
}
|
|
|
|
return new Schema(properties, normals, definition.space)
|
|
}
|