Housekeeping

.eslintignore

@@ -0,0 +1 @@
+dist

.eslintrc

@@ -1,3 +1,3 @@
 {
-  "extends": "plugin:bpmn-io/es5"
+  "extends": "plugin:bpmn-io/recommended"
 }

.github/workflows/CI.yml

@@ -0,0 +1,18 @@
+name: CI
+on: [ push, pull_request ]
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Use Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: 20
+        cache: 'npm'
+    - name: Install dependencies
+      run: npm ci
+    - name: Build
+      run: npm run all

.gitignore

@@ -1,3 +1,3 @@
 node_modules/
 tmp/
-package-lock.json
+dist/

CHANGELOG.md

@@ -8,6 +8,16 @@ ___Note:__ Yet to be released changes appear here._
 
 ## 0.4.0
 
+* `FEAT`: add type definitions
+* `FEAT`: add `module` export
+* `CHORE`: export `Refs` and `Collection` as a named exports
+
+### Breaking Changes
+
+* `Refs` and `Collection` are now exposed via a named export.
+
+## 0.3.0
+
 * `FEAT`: transitively bind inverse one-to-many relationships ([#1](https://github.com/bpmn-io/object-refs/issues/1))
 * `FEAT`: be able to define configurable properties ([#3](https://github.com/bpmn-io/object-refs/issues/3))
 

README.md

@@ -1,6 +1,6 @@
 # object-refs
 
-[![Build Status](https://travis-ci.com/bpmn-io/object-refs.svg?branch=master)](https://travis-ci.com/bpmn-io/object-refs)
+[![CI](https://github.com/bpmn-io/object-refs/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/object-refs/actions/workflows/CI.yml)
 
 A minimal implementation of bi-directional object references for JavaScript.
 

dist/index.d.ts

@@ -0,0 +1,42 @@
+export type AttributeDescriptor = {
+  name: string;
+  collection?: boolean | undefined;
+  enumerable?: boolean | undefined;
+}
+
+export class Refs {
+
+  /**
+   * Creates a new references object defining two inversly related
+   * attribute descriptors a and b.
+   * @param {AttributeDescriptor} a property descriptor
+   * @param {AttributeDescriptor} b property descriptor
+   */
+  constructor(a: AttributeDescriptor, b: AttributeDescriptor);
+
+  /**
+   * Binds one side of a bi-directional reference to a target object.
+   * @param {*} target
+   * @param {string|AttributeDescriptor} property
+   */
+  bind(target: any, property: string | AttributeDescriptor): void;
+
+  ensureBound(target: any, property: string | AttributeDescriptor): void;
+
+  ensureRefsCollection(target: any, property: AttributeDescriptor): any;
+
+  set(target: any, property: string | AttributeDescriptor, value: any): void;
+
+  unset(target: any, property: string | AttributeDescriptor, value: any): void;
+}
+
+export namespace Collection {
+
+  /**
+   * Extends a collection with Refs aware methods
+   */
+  function extend(collection: any[], refs: Refs, property: string | AttributeDescriptor, target: any): any;
+
+  function isExtended(collection: any[]): boolean;
+
+}