Merge pull request #497 from cocopon/update-api-reference

Update API reference
cocopon · Feb 24, 2023 · 0ef60af · 0ef60af
2 parents 54710b3 + 00b00d0
commit 0ef60af
Show file tree

Hide file tree

Showing 84 changed files with 311 additions and 193 deletions.
diff --git a/packages/core/src/blade/binding/api/binding.ts b/packages/core/src/blade/binding/api/binding.ts
@@ -6,7 +6,7 @@ import {TpChangeEvent} from '../../common/api/tp-event';
 import {BindingController} from '../controller/binding';
 
 export interface BindingApiEvents<Ex> {
-	change: TpChangeEvent<Ex, BindingApi>;
+	change: TpChangeEvent<Ex, BindingApi<unknown, Ex>>;
 }
 
 /**

diff --git a/packages/core/src/blade/binding/controller/binding.ts b/packages/core/src/blade/binding/controller/binding.ts
@@ -23,6 +23,9 @@ function excludeValue(state: BladeState): Omit<BladeState, 'value'> {
 	return result;
 }
 
+/**
+ * @hidden
+ */
 interface Config<
 	In,
 	Vc extends ValueController<In>,
@@ -31,6 +34,9 @@ interface Config<
 	tag?: string | undefined;
 }
 
+/**
+ * @hidden
+ */
 export class BindingController<
 	In = unknown,
 	Vc extends ValueController<In> = ValueController<In>,

diff --git a/packages/core/src/blade/binding/controller/input-binding.ts b/packages/core/src/blade/binding/controller/input-binding.ts
@@ -11,6 +11,9 @@ import {
 import {isValueBladeController} from '../../common/controller/value-blade';
 import {BindingController} from './binding';
 
+/**
+ * @hidden
+ */
 export class InputBindingController<
 	In = unknown,
 	Vc extends ValueController<In> = ValueController<In>,

diff --git a/packages/core/src/blade/binding/controller/monitor-binding.ts b/packages/core/src/blade/binding/controller/monitor-binding.ts
@@ -14,6 +14,9 @@ export type BufferedValueController<
 	Vw extends View = View,
 > = ValueController<TpBuffer<T>, Vw>;
 
+/**
+ * @hidden
+ */
 export type MonitorBindingController<
 	T = unknown,
 	Vc extends BufferedValueController<T> = BufferedValueController<T>,

diff --git a/packages/core/src/blade/button/controller/button.ts b/packages/core/src/blade/button/controller/button.ts
@@ -12,6 +12,9 @@ export interface ButtonEvents {
 	};
 }
 
+/**
+ * @hidden
+ */
 interface Config {
 	props: ButtonProps;
 	viewProps: ViewProps;
@@ -26,6 +29,9 @@ export class ButtonController implements Controller<ButtonView> {
 	public readonly view: ButtonView;
 	public readonly viewProps: ViewProps;
 
+	/**
+	 * @hidden
+	 */
 	constructor(doc: Document, config: Config) {
 		this.onClick_ = this.onClick_.bind(this);
 

diff --git a/packages/core/src/blade/button/view/button.ts b/packages/core/src/blade/button/view/button.ts
@@ -4,12 +4,21 @@ import {ClassName} from '../../../common/view/class-name';
 import {bindValueToTextContent} from '../../../common/view/reactive';
 import {View} from '../../../common/view/view';
 
+/**
+ * @hidden
+ */
 export type ButtonPropsObject = {
 	title: string | undefined;
 };
 
+/**
+ * @hidden
+ */
 export type ButtonProps = ValueMap<ButtonPropsObject>;
 
+/**
+ * @hidden
+ */
 interface Config {
 	props: ButtonProps;
 	viewProps: ViewProps;

diff --git a/packages/core/src/blade/common/api/container-blade.ts b/packages/core/src/blade/common/api/container-blade.ts
@@ -3,9 +3,6 @@ import {ContainerBladeController} from '../controller/container-blade';
 import {BladeApi} from './blade';
 import {RackApi} from './rack';
 
-/**
- * @hidden
- */
 export class ContainerBladeApi<
 	C extends ContainerBladeController,
 > extends BladeApi<C> {
@@ -14,6 +11,9 @@ export class ContainerBladeApi<
 	 */
 	protected readonly rackApi_: RackApi;
 
+	/**
+	 * @hidden
+	 */
 	constructor(controller: C, pool: PluginPool) {
 		super(controller);
 

diff --git a/packages/core/src/blade/common/api/rack.ts b/packages/core/src/blade/common/api/rack.ts
@@ -31,7 +31,10 @@ import {
 } from './params';
 import {TpChangeEvent} from './tp-event';
 
-export interface RackApiEvents {
+/**
+ * @hidden
+ */
+interface RackApiEvents {
 	change: TpChangeEvent<unknown, BladeApi>;
 }
 
@@ -61,15 +64,15 @@ function createBindingTarget<O extends Bindable, Key extends keyof O>(
 	return new BindingTarget(obj, key as string);
 }
 
+/**
+ * @hidden
+ */
 export class RackApi implements ContainerApi {
 	private readonly controller_: RackController;
 	private readonly emitter_: Emitter<RackApiEvents>;
 	private readonly apiSet_: NestedOrderedSet<BladeApi>;
 	private readonly pool_: PluginPool;
 
-	/**
-	 * @hidden
-	 */
 	constructor(controller: RackController, pool: PluginPool) {
 		this.onRackAdd_ = this.onRackAdd_.bind(this);
 		this.onRackRemove_ = this.onRackRemove_.bind(this);

diff --git a/packages/core/src/blade/common/controller/blade.ts b/packages/core/src/blade/common/controller/blade.ts
@@ -8,6 +8,9 @@ import {BladePosition, getAllBladePositions} from '../model/blade-positions';
 import {Rack} from '../model/rack';
 import {BladeState, exportBladeState, importBladeState} from './blade-state';
 
+/**
+ * @hidden
+ */
 interface Config<V extends View> {
 	blade: Blade;
 	view: V;
@@ -22,6 +25,9 @@ const POS_TO_CLASS_NAME_MAP: {[pos in BladePosition]: string} = {
 	verylast: 'vlst',
 };
 
+/**
+ * @hidden
+ */
 export class BladeController<V extends View = View> implements Controller<V> {
 	public readonly blade: Blade;
 	public readonly view: V;

diff --git a/packages/core/src/blade/common/controller/container-blade.ts b/packages/core/src/blade/common/controller/container-blade.ts
@@ -4,12 +4,18 @@ import {BladeController} from './blade';
 import {BladeState, exportBladeState, importBladeState} from './blade-state';
 import {RackController} from './rack';
 
+/**
+ * @hidden
+ */
 interface Config<V extends View> {
 	blade: Blade;
 	rackController: RackController;
 	view: V;
 }
 
+/**
+ * @hidden
+ */
 export class ContainerBladeController<
 	V extends View = View,
 > extends BladeController<V> {

diff --git a/packages/core/src/blade/common/controller/rack.ts b/packages/core/src/blade/common/controller/rack.ts
@@ -3,6 +3,9 @@ import {ViewProps} from '../../../common/model/view-props';
 import {Blade} from '../model/blade';
 import {Rack, RackEvents} from '../model/rack';
 
+/**
+ * @hidden
+ */
 interface Config {
 	blade: Blade;
 	element: HTMLElement;
@@ -11,6 +14,9 @@ interface Config {
 	root?: boolean;
 }
 
+/**
+ * @hidden
+ */
 export class RackController {
 	public readonly element: HTMLElement;
 	public readonly rack: Rack;

diff --git a/packages/core/src/blade/common/controller/value-blade.ts b/packages/core/src/blade/common/controller/value-blade.ts
@@ -4,13 +4,19 @@ import {View} from '../../../common/view/view';
 import {Blade} from '../model/blade';
 import {BladeController} from './blade';
 
+/**
+ * @hidden
+ */
 interface Config<T, Vw extends View, Va extends Value<T>> {
 	blade: Blade;
 	value: Va;
 	view: Vw;
 	viewProps: ViewProps;
 }
 
+/**
+ * @hidden
+ */
 export class ValueBladeController<
 	T,
 	Vw extends View = View,

diff --git a/packages/core/src/blade/common/model/foldable.ts b/packages/core/src/blade/common/model/foldable.ts
@@ -7,6 +7,9 @@ import {Value} from '../../../common/model/value';
 import {ValueMap} from '../../../common/model/value-map';
 import {isEmpty} from '../../../misc/type-util';
 
+/**
+ * @hidden
+ */
 type FoldableObject = {
 	completed: boolean;
 	expanded: boolean;

diff --git a/packages/core/src/blade/common/model/nested-ordered-set.ts b/packages/core/src/blade/common/model/nested-ordered-set.ts
@@ -1,6 +1,9 @@
 import {Emitter} from '../../../common/model/emitter';
 import {TpError} from '../../../common/tp-error';
 
+/**
+ * @hidden
+ */
 export interface NestedOrderedSetEvents<T> {
 	add: {
 		index: number;
@@ -16,8 +19,14 @@ export interface NestedOrderedSetEvents<T> {
 	};
 }
 
+/**
+ * @hidden
+ */
 type Extractor<T> = (item: T) => NestedOrderedSet<T> | null;
 
+/**
+ * @hidden
+ */
 export class NestedOrderedSet<T> {
 	public readonly emitter: Emitter<NestedOrderedSetEvents<T>> = new Emitter();
 	private readonly items_: T[] = [];

diff --git a/packages/core/src/blade/common/model/rack.ts b/packages/core/src/blade/common/model/rack.ts
@@ -63,13 +63,17 @@ function findSubBladeControllerSet(
 		: null;
 }
 
+/**
+ * @hidden
+ */
 interface Config {
 	blade?: Blade;
 	viewProps: ViewProps;
 }
 
 /**
  * A collection of blade controllers that manages positions and event propagation.
+ * @hidden
  */
 export class Rack {
 	public readonly emitter: Emitter<RackEvents> = new Emitter();

diff --git a/packages/core/src/blade/folder/controller/folder.ts b/packages/core/src/blade/folder/controller/folder.ts
@@ -10,6 +10,9 @@ import {Blade} from '../../common/model/blade';
 import {bindFoldable, Foldable} from '../../common/model/foldable';
 import {FolderProps, FolderView} from '../view/folder';
 
+/**
+ * @hidden
+ */
 interface Config {
 	expanded?: boolean;
 	blade: Blade;
@@ -26,6 +29,9 @@ export class FolderController extends ContainerBladeController<FolderView> {
 	public readonly foldable: Foldable;
 	public readonly props: FolderProps;
 
+	/**
+	 * @hidden
+	 */
 	constructor(doc: Document, config: Config) {
 		const foldable = Foldable.create(config.expanded ?? true);
 		const view = new FolderView(doc, {

diff --git a/packages/core/src/blade/folder/view/folder.ts b/packages/core/src/blade/folder/view/folder.ts
@@ -11,12 +11,21 @@ import {isEmpty} from '../../../misc/type-util';
 import {Foldable} from '../../common/model/foldable';
 import {bladeContainerClassName} from '../../common/view/blade-container';
 
+/**
+ * @hidden
+ */
 export type FolderPropsObject = {
 	title: string | undefined;
 };
 
+/**
+ * @hidden
+ */
 export type FolderProps = ValueMap<FolderPropsObject>;
 
+/**
+ * @hidden
+ */
 interface Config {
 	foldable: Foldable;
 	props: FolderProps;

diff --git a/packages/core/src/blade/label/controller/label.ts b/packages/core/src/blade/label/controller/label.ts
@@ -8,12 +8,18 @@ import {
 import {Blade} from '../../common/model/blade';
 import {LabelProps, LabelView} from '../view/label';
 
+/**
+ * @hidden
+ */
 interface Config<C extends Controller> {
 	blade: Blade;
 	props: LabelProps;
 	valueController: C;
 }
 
+/**
+ * @hidden
+ */
 export class LabelBladeController<
 	C extends Controller,
 > extends BladeController<LabelView> {

diff --git a/packages/core/src/blade/label/controller/value-label.ts b/packages/core/src/blade/label/controller/value-label.ts
@@ -10,18 +10,27 @@ import {ValueBladeController} from '../../common/controller/value-blade';
 import {Blade} from '../../common/model/blade';
 import {LabelProps, LabelView} from '../view/label';
 
+/**
+ * @hidden
+ */
 interface Config<T, C extends ValueController<T>, Va extends Value<T>> {
 	blade: Blade;
 	props: LabelProps;
 	value: Va;
 	valueController: C;
 }
+/**
+ * @hidden
+ */
 export type LabeledValueConfig<
 	T,
 	C extends ValueController<T>,
 	Va extends Value<T>,
 > = Config<T, C, Va>;
 
+/**
+ * @hidden
+ */
 export class LabeledValueController<
 	T,
 	C extends ValueController<T> = ValueController<T>,

diff --git a/packages/core/src/blade/label/view/label.ts b/packages/core/src/blade/label/view/label.ts
@@ -6,12 +6,21 @@ import {ClassName} from '../../../common/view/class-name';
 import {View} from '../../../common/view/view';
 import {isEmpty} from '../../../misc/type-util';
 
+/**
+ * @hidden
+ */
 export type LabelPropsObject = {
 	label: string | undefined;
 };
 
+/**
+ * @hidden
+ */
 export type LabelProps = ValueMap<LabelPropsObject>;
 
+/**
+ * @hidden
+ */
 interface Config {
 	props: LabelProps;
 	viewProps: ViewProps;