Skip to content

Commit 9a5639f

Browse files
committed
add more stuff to docs exports
1 parent dca95d0 commit 9a5639f

File tree

3 files changed

+41
-1
lines changed

3 files changed

+41
-1
lines changed

packages/core/src/config/FieldConfigs.ts

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ import type { SimpleButtonGroupDeclaration } from 'packages/core/src/parsers/But
99
import { type BindTargetDeclaration } from 'packages/core/src/parsers/bindTargetParser/BindTargetDeclaration';
1010
import { type MetaBindColumnDeclaration } from 'packages/core/src/fields/metaBindTable/TableMountable';
1111

12+
/**
13+
* @internal
14+
*/
1215
export interface FieldArgumentValueConfig {
1316
name: string;
1417
// empty is any
1518
allowed: string[];
1619
description: string;
1720
}
1821

22+
/**
23+
* @internal
24+
*/
1925
export interface FieldArgumentConfig<ArgumentType extends string, FieldType extends string> {
2026
type: ArgumentType;
2127
allowedFieldTypes: FieldType[];
@@ -73,12 +79,18 @@ export enum InputFieldArgumentType {
7379
INVALID = 'invalid',
7480
}
7581

82+
/**
83+
* @internal
84+
*/
7685
export interface InputFieldConfig {
7786
type: InputFieldType;
7887
allowInBlock: boolean;
7988
allowInline: boolean;
8089
}
8190

91+
/**
92+
* @internal
93+
*/
8294
export const InputFieldConfigs: Record<InputFieldType, InputFieldConfig> = {
8395
[InputFieldType.TOGGLE]: {
8496
type: InputFieldType.TOGGLE,
@@ -192,14 +204,23 @@ export const InputFieldConfigs: Record<InputFieldType, InputFieldConfig> = {
192204
},
193205
} as const;
194206

207+
/**
208+
* @internal
209+
*/
195210
export enum UseLinksInputFieldArgumentValue {
196211
TRUE = 'true',
197212
PARTIAL = 'partial',
198213
FALSE = 'false',
199214
}
200215

216+
/**
217+
* @internal
218+
*/
201219
export type InputFieldArgumentConfig = FieldArgumentConfig<InputFieldArgumentType, InputFieldType>;
202220

221+
/**
222+
* @internal
223+
*/
203224
export const InputFieldArgumentConfigs: Record<InputFieldArgumentType, InputFieldArgumentConfig> = {
204225
[InputFieldArgumentType.ADD_LABELS]: {
205226
type: InputFieldArgumentType.ADD_LABELS,
@@ -522,8 +543,14 @@ export enum ViewFieldArgumentType {
522543
INVALID = 'invalid',
523544
}
524545

546+
/**
547+
* @internal
548+
*/
525549
export type ViewFieldArgumentConfig = FieldArgumentConfig<ViewFieldArgumentType, ViewFieldType>;
526550

551+
/**
552+
* @internal
553+
*/
527554
export const ViewFieldArgumentConfigs: Record<ViewFieldArgumentType, ViewFieldArgumentConfig> = {
528555
[ViewFieldArgumentType.RENDER_MARKDOWN]: {
529556
type: ViewFieldArgumentType.RENDER_MARKDOWN,

packages/obsidian/src/ObsidianAPI.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Component } from 'obsidian';
1+
import { Component, type MarkdownPostProcessorContext } from 'obsidian';
22
import type MetaBindPlugin from 'packages/obsidian/src/main';
33
import { API, type LifecycleHook } from 'packages/core/src/api/API.js';
44
import { type BindTargetDeclaration } from 'packages/core/src/parsers/bindTargetParser/BindTargetDeclaration';
@@ -15,10 +15,16 @@ import { getJsEnginePluginAPI } from 'packages/obsidian/src/ObsUtils';
1515
import { type ReactiveComponent } from 'jsEngine/api/reactive/ReactiveComponent';
1616
import { type Mountable } from 'packages/core/src/utils/Mountable';
1717

18+
/**
19+
* Either {@link MarkdownPostProcessorContext} or {@link Component}.
20+
*/
1821
export interface ComponentLike {
1922
addChild(child: Component): void;
2023
}
2124

25+
/**
26+
* @internal
27+
*/
2228
export const V_ComponentLike = z.object({
2329
addChild: z.function().args(z.instanceof(Component)).returns(z.void()),
2430
});
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
11
export * from 'packages/obsidian/src/ObsidianAPI';
2+
3+
export * from 'packages/core/src/config/ButtonConfig';
4+
export * from 'packages/core/src/config/FieldConfigs';
5+
6+
export * from 'packages/core/src/parsers/bindTargetParser/BindTargetDeclaration';
7+
export * from 'packages/core/src/parsers/viewFieldParser/ViewFieldDeclaration';
8+
export * from 'packages/core/src/parsers/inputFieldParser/InputFieldDeclaration';

0 commit comments

Comments
 (0)