@speclynx/apidom-datamodel 1.12.2 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [2.0.0](https://github.com/speclynx/apidom/compare/v1.12.2...v2.0.0) (2026-01-14)
+
+### Bug Fixes
+
+- limit source maps memory consuption ([#20](https://github.com/speclynx/apidom/issues/20)) ([4a0574f](https://github.com/speclynx/apidom/commit/4a0574fd6d466be7c33c8a5871baacd384918d22))
+
+### Features
+
+- apply innovations learned during last 3 years ([#11](https://github.com/speclynx/apidom/issues/11)) ([cfdbbfc](https://github.com/speclynx/apidom/commit/cfdbbfc2721b0dadc77eeba31dd4e8768c078d22))
+- introduce datamodel package ([#10](https://github.com/speclynx/apidom/issues/10)) ([273af6b](https://github.com/speclynx/apidom/commit/273af6b1151cefb92e8ec51d99b35fb24cec3807))
+
+### BREAKING CHANGES
+
+- source maps have been completely rewritten
+- breaking changes introduced to every package public API

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -13,8 +13,8 @@ Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 
 graphql-js
 Copyright (c) GraphQL Contributors
-File packages/apidom-ast/src/traversal/visitor.ts (the file) was originally created under MIT license in https://github.com/graphql/graphql-js repository.
-The file has been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+File packages/apidom-traverse/src/traversal.ts (the file) was originally inspired by https://github.com/graphql/graphql-js repository.
+All modifications are licensed under Apache 2.0 License.
 Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 
 babel-plugin-add-import-extension

package/README.md

@@ -42,8 +42,6 @@ Additionally, convenience attributes are exposed on every element as shortcuts f
 
 - `id` (StringElement) - Shortcut for `.meta.get('id')`
 - `classes` (ArrayElement) - Shortcut for `.meta.get('classes')`
-- `title` (StringElement) - Shortcut for `.meta.get('title')`
-- `description` (StringElement) - Shortcut for `.meta.get('description')`
 - `links` (ArrayElement) - Shortcut for `.meta.get('links')`
 
 ```js
@@ -51,11 +49,9 @@ import { StringElement } from '@speclynx/apidom-datamodel';
 
 const element = new StringElement('hello');
 element.id = 'greeting';
-element.title = 'A greeting';
 element.classes = ['important', 'message'];
 
 element.id.toValue(); // => 'greeting'
-element.title.toValue(); // => 'A greeting'
 element.classes.toValue(); // => ['important', 'message']
 ```
 
@@ -186,6 +182,125 @@ link.href = 'https://example.com';
 
 ---
 
+## Source Maps
+
+Source maps track the original source position of each element in the parsed document.
+Position properties are stored directly on elements (not nested in a separate object):
+
+- `startLine` - Zero-based line number where the element begins
+- `startCharacter` - Zero-based column number where the element begins
+- `startOffset` - Zero-based character offset from the start of the document
+- `endLine` - Zero-based line number where the element ends
+- `endCharacter` - Zero-based column number where the element ends
+- `endOffset` - Zero-based character offset where the element ends
+
+All position values use **UTF-16 code units**, making them compatible with:
+- [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/)
+- JavaScript string indexing
+- TextDocument APIs
+
+### Accessing Source Positions
+
+```js
+import { StringElement } from '@speclynx/apidom-datamodel';
+
+const element = new StringElement('hello');
+element.startLine = 0;
+element.startCharacter = 5;
+element.startOffset = 5;
+element.endLine = 0;
+element.endCharacter = 12;
+element.endOffset = 12;
+
+console.log(element.startLine); // => 0
+console.log(element.startOffset); // => 5
+```
+
+### SourceMapElement
+
+`SourceMapElement` is a transitive element that stores source positions as a compact
+VLQ-encoded string. It provides utilities for transferring and serializing source positions.
+
+#### Transferring Source Positions
+
+Use `SourceMapElement.transfer()` to copy position properties between any compatible shapes
+(elements, AST nodes, or plain objects with position properties):
+
+```js
+import { SourceMapElement, StringElement } from '@speclynx/apidom-datamodel';
+
+const source = new StringElement('source');
+source.startLine = 1;
+source.startCharacter = 2;
+source.startOffset = 10;
+source.endLine = 1;
+source.endCharacter = 8;
+source.endOffset = 16;
+
+const target = new StringElement('target');
+SourceMapElement.transfer(source, target);
+
+console.log(target.startLine); // => 1
+console.log(target.startOffset); // => 10
+```
+
+#### Creating from Source
+
+Use `SourceMapElement.from()` to create a source map from any object with position properties.
+Returns `undefined` if any position property is not a number:
+
+```js
+import { SourceMapElement, StringElement } from '@speclynx/apidom-datamodel';
+
+const element = new StringElement('hello');
+element.startLine = 0;
+element.startCharacter = 0;
+element.startOffset = 0;
+element.endLine = 0;
+element.endCharacter = 5;
+element.endOffset = 5;
+
+const sourceMap = SourceMapElement.from(element);
+// sourceMap.content => 'sm1:AAAAKA' (VLQ-encoded positions)
+```
+
+#### Applying to Target
+
+Use `sourceMap.applyTo()` to decode VLQ content and apply position properties to any target object:
+
+```js
+import { SourceMapElement, StringElement } from '@speclynx/apidom-datamodel';
+
+const sourceMap = new SourceMapElement('sm1:AAAAKA');
+const target = new StringElement('target');
+
+sourceMap.applyTo(target);
+
+console.log(target.startLine); // => 0
+console.log(target.endOffset); // => 5
+```
+
+### SourceMapShape Interface
+
+The `SourceMapShape` interface defines the shape for objects with source position properties:
+
+```ts
+import type { SourceMapShape } from '@speclynx/apidom-datamodel';
+
+interface SourceMapShape {
+  startLine?: number;
+  startCharacter?: number;
+  startOffset?: number;
+  endLine?: number;
+  endCharacter?: number;
+  endOffset?: number;
+}
+```
+
+This enables `SourceMapElement.transfer()` to work with any compatible object, not just elements.
+
+---
+
 ## Extending Elements
 
 You can create custom element types by extending the primitive elements.
@@ -390,20 +505,6 @@ const element = serialiser.deserialise(json);
 
 ## Element Operations
 
-### Cloning
-
-Elements can be deeply cloned:
-
-```js
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-
-const original = new ObjectElement({ nested: { value: 1 } });
-const cloned = original.clone();
-
-cloned.get('nested').set('value', 2);
-original.get('nested').get('value').toValue(); // => 1 (unchanged)
-```
-
 ### Freezing
 
 Elements can be frozen for immutability. Freezing also sets up parent references:
@@ -475,5 +576,36 @@ const pair = new KeyValuePair();
 pair.key = new StringElement('name');
 pair.value = new NumberElement(42);
 
-pair.clone(); // creates a deep copy
+pair.toValue(); // { key: 'name', value: 42 }
+```
+
+---
+
+## Cloning
+
+Functions for creating shallow and deep copies of ApiDOM elements.
+
+### Shallow cloning
+
+Creates a shallow clone of an ApiDOM element. The element itself is cloned,
+but content references are shared (except for meta and attributes which are deep cloned
+to preserve semantic information).
+
+```js
+import { ObjectElement, cloneShallow } from '@speclynx/apidom-datamodel';
+
+const objectElement = new ObjectElement({ a: 'b' });
+const objectElementShallowClone = cloneShallow(objectElement);
+```
+
+### Deep cloning
+
+Creates a deep clone of an ApiDOM element. All nested elements are recursively cloned.
+Handles cycles by memoizing visited objects.
+
+```js
+import { ObjectElement, cloneDeep } from '@speclynx/apidom-datamodel';
+
+const objectElement = new ObjectElement({ a: 'b' });
+const objectElementDeepClone = cloneDeep(objectElement);
 ```