@speclynx/apidom-datamodel 1.12.2

package/src/serialisers/JSONSerialiser.cjs

@@ -0,0 +1,144 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+/**
+ * Serialized representation of an Element in JSON Refract format.
+ * @public
+ */
+
+/**
+ * Serialized representation of a KeyValuePair in JSON Refract format.
+ * @public
+ */
+
+/**
+ * Possible content types in a serialized element.
+ * @public
+ */
+
+/**
+ * Input document format for deserialization.
+ * @public
+ */
+
+/**
+ * JSONSerialiser handles serialization and deserialization of ApiDOM elements
+ * to and from JSON Refract format.
+ * @public
+ */
+class JSONSerialiser {
+  namespace;
+
+  // This will be set via prototype assignment to avoid circular dependency
+
+  constructor(namespace) {
+    this.namespace = namespace || new this.Namespace();
+  }
+
+  /**
+   * Serializes an Element to JSON Refract format.
+   */
+  serialise(element) {
+    if (!(element instanceof this.namespace.elements.Element)) {
+      throw new TypeError(`Given element \`${element}\` is not an Element instance`);
+    }
+    const payload = {
+      element: element.element
+    };
+    if (element._meta && element._meta.length > 0) {
+      payload.meta = this.serialiseObject(element.meta);
+    }
+    if (element._attributes && element._attributes.length > 0) {
+      payload.attributes = this.serialiseObject(element.attributes);
+    }
+    const content = this.serialiseContent(element.content);
+    if (content !== undefined) {
+      payload.content = content;
+    }
+    return payload;
+  }
+
+  /**
+   * Deserializes a JSON Refract document to an Element.
+   */
+  deserialise(value) {
+    if (!value.element) {
+      throw new Error('Given value is not an object containing an element name');
+    }
+    const ElementClass = this.namespace.getElementClass(value.element);
+    const element = new ElementClass();
+    if (element.element !== value.element) {
+      element.element = value.element;
+    }
+    if (value.meta) {
+      this.deserialiseObject(value.meta, element.meta);
+    }
+    if (value.attributes) {
+      this.deserialiseObject(value.attributes, element.attributes);
+    }
+    const content = this.deserialiseContent(value.content);
+    if (content !== undefined || element.content === null) {
+      element.content = content;
+    }
+    return element;
+  }
+  serialiseContent(content) {
+    if (content instanceof this.namespace.elements.Element) {
+      return this.serialise(content);
+    }
+    if (content instanceof this.namespace.KeyValuePair) {
+      const kvp = content;
+      const pair = {
+        key: this.serialise(kvp.key)
+      };
+      if (kvp.value) {
+        pair.value = this.serialise(kvp.value);
+      }
+      return pair;
+    }
+    if (content && Array.isArray(content)) {
+      if (content.length === 0) {
+        return undefined;
+      }
+      return content.map(item => this.serialise(item));
+    }
+    return content;
+  }
+  deserialiseContent(content) {
+    if (content) {
+      if (content.element) {
+        return this.deserialise(content);
+      }
+      if (content.key) {
+        const pair = new this.namespace.KeyValuePair(this.deserialise(content.key));
+        if (content.value) {
+          pair.value = this.deserialise(content.value);
+        }
+        return pair;
+      }
+      if (Array.isArray(content)) {
+        return content.map(item => this.deserialise(item));
+      }
+    }
+    return content;
+  }
+  serialiseObject(obj) {
+    const result = {};
+    obj.forEach((value, key) => {
+      if (value) {
+        result[key.toValue()] = this.serialise(value);
+      }
+    });
+    if (Object.keys(result).length === 0) {
+      return undefined;
+    }
+    return result;
+  }
+  deserialiseObject(from, to) {
+    Object.keys(from).forEach(key => {
+      to.set(key, this.deserialise(from[key]));
+    });
+  }
+}
+var _default = exports.default = JSONSerialiser;

package/src/serialisers/JSONSerialiser.mjs

@@ -0,0 +1,140 @@
+/**
+ * Serialized representation of an Element in JSON Refract format.
+ * @public
+ */
+
+/**
+ * Serialized representation of a KeyValuePair in JSON Refract format.
+ * @public
+ */
+
+/**
+ * Possible content types in a serialized element.
+ * @public
+ */
+
+/**
+ * Input document format for deserialization.
+ * @public
+ */
+
+/**
+ * JSONSerialiser handles serialization and deserialization of ApiDOM elements
+ * to and from JSON Refract format.
+ * @public
+ */
+class JSONSerialiser {
+  namespace;
+
+  // This will be set via prototype assignment to avoid circular dependency
+
+  constructor(namespace) {
+    this.namespace = namespace || new this.Namespace();
+  }
+
+  /**
+   * Serializes an Element to JSON Refract format.
+   */
+  serialise(element) {
+    if (!(element instanceof this.namespace.elements.Element)) {
+      throw new TypeError(`Given element \`${element}\` is not an Element instance`);
+    }
+    const payload = {
+      element: element.element
+    };
+    if (element._meta && element._meta.length > 0) {
+      payload.meta = this.serialiseObject(element.meta);
+    }
+    if (element._attributes && element._attributes.length > 0) {
+      payload.attributes = this.serialiseObject(element.attributes);
+    }
+    const content = this.serialiseContent(element.content);
+    if (content !== undefined) {
+      payload.content = content;
+    }
+    return payload;
+  }
+
+  /**
+   * Deserializes a JSON Refract document to an Element.
+   */
+  deserialise(value) {
+    if (!value.element) {
+      throw new Error('Given value is not an object containing an element name');
+    }
+    const ElementClass = this.namespace.getElementClass(value.element);
+    const element = new ElementClass();
+    if (element.element !== value.element) {
+      element.element = value.element;
+    }
+    if (value.meta) {
+      this.deserialiseObject(value.meta, element.meta);
+    }
+    if (value.attributes) {
+      this.deserialiseObject(value.attributes, element.attributes);
+    }
+    const content = this.deserialiseContent(value.content);
+    if (content !== undefined || element.content === null) {
+      element.content = content;
+    }
+    return element;
+  }
+  serialiseContent(content) {
+    if (content instanceof this.namespace.elements.Element) {
+      return this.serialise(content);
+    }
+    if (content instanceof this.namespace.KeyValuePair) {
+      const kvp = content;
+      const pair = {
+        key: this.serialise(kvp.key)
+      };
+      if (kvp.value) {
+        pair.value = this.serialise(kvp.value);
+      }
+      return pair;
+    }
+    if (content && Array.isArray(content)) {
+      if (content.length === 0) {
+        return undefined;
+      }
+      return content.map(item => this.serialise(item));
+    }
+    return content;
+  }
+  deserialiseContent(content) {
+    if (content) {
+      if (content.element) {
+        return this.deserialise(content);
+      }
+      if (content.key) {
+        const pair = new this.namespace.KeyValuePair(this.deserialise(content.key));
+        if (content.value) {
+          pair.value = this.deserialise(content.value);
+        }
+        return pair;
+      }
+      if (Array.isArray(content)) {
+        return content.map(item => this.deserialise(item));
+      }
+    }
+    return content;
+  }
+  serialiseObject(obj) {
+    const result = {};
+    obj.forEach((value, key) => {
+      if (value) {
+        result[key.toValue()] = this.serialise(value);
+      }
+    });
+    if (Object.keys(result).length === 0) {
+      return undefined;
+    }
+    return result;
+  }
+  deserialiseObject(from, to) {
+    Object.keys(from).forEach(key => {
+      to.set(key, this.deserialise(from[key]));
+    });
+  }
+}
+export default JSONSerialiser;

package/src/types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/src/types.mjs

@@ -0,0 +1 @@
+export {};