Merge pull request #62 from retejs/docs/typedoc

Docs/typedoc

.github/workflows/update-docs.yml

@@ -3,12 +3,12 @@ name: Update docs
 on:
   workflow_dispatch:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   pull:
     uses: retejs/.github/.github/workflows/update-docs.yml@main
     secrets: inherit
     with:
-      filename: '1.rete'
-      package: rete
+      filename: "7.rete-angular-plugin"
+      package: rete-angular-plugin

.gitignore

@@ -46,3 +46,4 @@ testem.log
 Thumbs.db
 
 .src
+docs

package.json

@@ -10,7 +10,8 @@
     "build:14": "npm --prefix ng14 run build",
     "build:15": "npm --prefix ng15 run build",
     "build:16": "npm --prefix ng16 run build",
-    "postinstall": "npm i --prefix ng12 && npm i --prefix ng13 && npm i --prefix ng14 && npm i --prefix ng15 && npm i --prefix ng16"
+    "postinstall": "npm i --prefix ng12 && npm i --prefix ng13 && npm i --prefix ng14 && npm i --prefix ng15 && npm i --prefix ng16",
+    "doc": "rete doc"
   },
   "author": "Vitaliy Stoliarov",
   "license": "MIT",

src/core.ts

@@ -54,19 +54,35 @@ function getRenderer(): Renderer {
   }
 }
 
-type Produces<Schemes extends BaseSchemes> =
+/**
+ * Signals that can be emitted by the plugin
+ * @priority 10
+ */
+export type Produces<Schemes extends BaseSchemes> =
   | { type: 'connectionpath', data: { payload: Schemes['Connection'], path?: string, points: Position[] } }
 
 type Requires<Schemes extends BaseSchemes> =
   | RenderSignal<'node', { payload: Schemes['Node'] }>
   | RenderSignal<'connection', { payload: Schemes['Connection'], start?: Position, end?: Position }>
   | { type: 'unmount', data: { element: HTMLElement } }
 
+/**
+ * Angular plugin. Renders nodes, connections and other elements using React.
+ * @priority 9
+ * @emits connectionpath
+ * @listens render
+ * @listens unmount
+ */
 export class AngularPlugin<Schemes extends BaseSchemes, T = Requires<Schemes>> extends Scope<Produces<Schemes>, [Requires<Schemes> | T]> {
   presets: RenderPreset<Schemes, T>[] = []
   renderer: Renderer
   owners = new WeakMap<HTMLElement, RenderPreset<Schemes, T>>()
 
+  /**
+   * @constructor
+   * @param params Plugin properties
+   * @param params.injector Angular's Injector instance
+   */
   constructor(private params: { injector: Injector }) {
     super('angular-render')
     this.renderer = getRenderer()
@@ -137,6 +153,10 @@ export class AngularPlugin<Schemes extends BaseSchemes, T = Requires<Schemes>> e
     return
   }
 
+  /**
+   * Adds a preset to the plugin.
+   * @param preset Preset that can render nodes, connections and other elements.
+   */
   public addPreset<K>(preset: RenderPreset<Schemes, CanAssignSignal<T, K> extends true ? K : 'Cannot apply preset. Provided signals are not compatible'>) {
     const local = preset as unknown as RenderPreset<Schemes, T>
 

src/presets/classic/index.ts

@@ -23,6 +23,9 @@ type ClassicProps<Schemes extends ClassicScheme, K> = {
   customize?: CustomizationProps<Schemes>
 }
 
+/**
+ * Classic preset for rendering nodes, connections, controls and sockets.
+ */
 export function setup<Schemes extends ClassicScheme, K extends AngularArea2D<Schemes>>(
   props?: ClassicProps<Schemes, K>
 ): RenderPreset<Schemes, K> {

src/presets/context-menu/index.ts

@@ -4,6 +4,9 @@ import { ContextMenuRender } from './types';
 import { ContextMenuComponent } from './components/menu/menu.component';
 import { RenderPreset } from '../types';
 
+/**
+ * Preset for rendering context menu.
+ */
 export function setup<Schemes extends BaseSchemes, K extends ContextMenuRender>(props?: { delay?: number }): RenderPreset<Schemes, K> {
   const delay = typeof props?.delay === 'undefined' ? 1000 : props.delay
 

src/presets/index.ts

@@ -1,3 +1,7 @@
+/**
+ * Built-in presets, responsible for rendering different parts of the editor.
+ * @module
+ */
 export * as classic from './classic'
 export * as contextMenu from './context-menu'
 export * as minimap from './minimap'

src/presets/minimap/index.ts

@@ -4,6 +4,9 @@ import { RenderPreset } from '../types';
 import { MinimapRender } from './types';
 import { MinimapComponent } from './components/minimap/minimap.component';
 
+/**
+ * Preset for rendering minimap.
+ */
 export function setup<Schemes extends BaseSchemes, K extends MinimapRender>(props?: { size?: number }): RenderPreset<Schemes, K> {
   return {
     update(context) {

src/presets/reroute/index.ts

@@ -11,6 +11,9 @@ type Props = {
   pointerdown?: (id: string) => void
 }
 
+/**
+ * Preset for rendering pins.
+ */
 export function setup<Schemes extends BaseSchemes, K extends PinsRender>(props?: Props): RenderPreset<Schemes, K> {
   const getProps = () => ({
     menu: props?.contextMenu || (() => null),

tsconfig.json

@@ -20,5 +20,8 @@
       "es2018",
       "dom"
     ]
-  }
+  },
+  "include": [
+    "src"
+  ]
 }