model-chain.js

  1. /**
  2. * @example
  3. * import { ModelChain } from "domodel"
  4. *
  5. * const MyModel = {
  6. * 	tagName: "div",
  7. * 	children: [{
  8. *		tagName: "div",
  9. *		identifier: "title"
  10. * 	}]
  11. *}
  12. *
  13. *const MyModelChain = new ModelChain(MyModel).after("title", {
  14. *	tagName: "div",
  15. *	textContent: "A description"
  16. *})
  17. *
  18. *Core.run(MyModelChain.definition, { target: document.body })
  19. * @class
  20. * Allows updating of models
  21. * @param {Model} definition
  22. */
  23. function ModelChain(definition) {
  24. 	/** @type {Model} */
  25. 	this.definition = structuredClone(definition)
  26. }
  28. /**
  29. * @param {string} [parentIdentifier]
  30. * @param {Model} definition
  31. * @returns {ModelChain}
  32. */
  33. ModelChain.prototype.prepend = function(parentIdentifier, definition) {
  34. 	if(parentIdentifier === null) {
  35. 		this.definition.children.unshift(definition)
  36. 	} else {
  37. 		const { object } = getObjectByIdentifier(parentIdentifier, this.definition)
  38. 		if(!object.children) {
  39. 			object.children = []
  40. 		}
  41. 		object.children.unshift(definition)
  42. 	}
  43. 	return this
  44. }
  46. /**
  47. * @param {string} [parentIdentifier]
  48. * @param {Model} definition
  49. * @returns {ModelChain}
  50. */
  51. ModelChain.prototype.append = function(parentIdentifier, definition) {
  52. 	if(parentIdentifier === null) {
  53. 		this.definition.children.push(definition)
  54. 	} else {
  55. 		const { object } = getObjectByIdentifier(parentIdentifier, this.definition)
  56. 		if(!object.children) {
  57. 			object.children = []
  58. 		}
  59. 		object.children.push(definition)
  60. 	}
  61. 	return this
  62. }
  64. /**
  65. * @param {string} identifier
  66. * @param {Model} definition
  67. * @returns {ModelChain}
  68. */
  69. ModelChain.prototype.replace = function(identifier, definition) {
  70. 	const { object } = getObjectByIdentifier(identifier, this.definition)
  71. 	for(const property in object) {
  72. 		delete object[property]
  73. 	}
  74. 	Object.assign(object, definition)
  75. 	return this
  76. }
  78. /**
  79. * @param {string} identifier
  80. * @param {Model} definition
  81. * @returns {ModelChain}
  82. */
  83. ModelChain.prototype.before = function(identifier, definition) {
  84. 	const { parent, object } = getObjectByIdentifier(identifier, this.definition)
  85. 	parent.children.splice(parent.children.indexOf(object), 0, definition)
  86. 	return this
  87. }
  89. /**
  90. * @param {string} identifier
  91. * @param {Model} definition
  92. * @returns {ModelChain}
  93. */
  94. ModelChain.prototype.after = function(identifier, definition) {
  95. 	const { parent, object } = getObjectByIdentifier(identifier, this.definition)
  96. 	parent.children.splice(parent.children.indexOf(object) + 1, 0, definition)
  97. 	return this
  98. }
  100. /**
  101. * @ignore
  102. * @param {string} identifier
  103. * @param {Model} definition
  104. * @returns {{object: object, parent: object}}
  105. */
  106. export function getObjectByIdentifier(identifier, definition) {
  107. 	/**
  108. 	*
  109. 	* @param {object} object
  110. 	* @param {object} parent
  111. 	* @returns {{object: object, parent: object}}
  112. 	*/
  113. 	function walk(object, parent) {
  114. 		if(object.identifier === identifier) {
  115. 			return { object, parent }
  116. 		}
  117. 		if(object.children) {
  118. 			for(const child of object.children) {
  119. 				const obj = walk(child, object)
  120. 				if(obj) {
  121. 					return obj
  122. 				}
  123. 			}
  124. 		}
  125. 	}
  126. 	return walk(definition, null)
  127. }
  129. export default ModelChain
  131. /**
  132.  * @typedef {import("./core.js").Model} Model
  133.  */