Zef Hemel
0773df31e2
- Introduced a new `validate` callback for `tag.define` - Added `index.validateObjects` API to validate and transform objects before indexing. - Updated relevant documentation and examples to reflect these changes.
78 lines
2.2 KiB
TypeScript
78 lines
2.2 KiB
TypeScript
import type { LuaCollectionQuery } from "../../client/space_lua/query_collection.ts";
|
|
import { syscall } from "@silverbulletmd/silverbullet/syscall";
|
|
import type { ObjectValue } from "../../plug-api/types/index.ts";
|
|
|
|
/**
|
|
* Exposes the SilverBullet object indexing system
|
|
* @module
|
|
*/
|
|
|
|
/**
|
|
* Indexes objects for a specific page
|
|
* @param page - The page identifier where objects will be indexed
|
|
* @param objects - Array of objects to be indexed
|
|
* @returns Promise that resolves when indexing is complete
|
|
*/
|
|
export function indexObjects<T>(
|
|
page: string,
|
|
objects: ObjectValue<T>[],
|
|
): Promise<void> {
|
|
return syscall("index.indexObjects", page, objects);
|
|
}
|
|
|
|
export function validateObjects<T>(
|
|
page: string,
|
|
objects: ObjectValue<T>[],
|
|
): Promise<{ error: string; object: ObjectValue } | null> {
|
|
return syscall("index.validateObjects", page, objects);
|
|
}
|
|
|
|
/**
|
|
* Queries objects using a Lua-based collection query
|
|
* @param tag - The tag to filter objects by
|
|
* @param query - Lua query parameters to filter objects
|
|
* @param scopedVariables - Optional variables to be used in the Lua query
|
|
* @returns Promise that resolves with an array of matching objects
|
|
*/
|
|
export function queryLuaObjects<T>(
|
|
tag: string,
|
|
query: LuaCollectionQuery,
|
|
scopedVariables?: Record<string, any>,
|
|
): Promise<ObjectValue<T>[]> {
|
|
return syscall("index.queryLuaObjects", tag, query, scopedVariables);
|
|
}
|
|
|
|
/**
|
|
* Retrieves a specific object by its reference
|
|
* @param page - The page identifier where the object is located
|
|
* @param tag - The tag of the object
|
|
* @param ref - The reference identifier of the object
|
|
* @returns Promise that resolves with the matching object or undefined if not found
|
|
*/
|
|
export function getObjectByRef<T>(
|
|
page: string,
|
|
tag: string,
|
|
ref: string,
|
|
): Promise<ObjectValue<T> | undefined> {
|
|
return syscall("index.getObjectByRef", page, tag, ref);
|
|
}
|
|
|
|
/**
|
|
* Ensures that the full index is built and up-to-date
|
|
*/
|
|
export function ensureFullIndex(): Promise<void> {
|
|
return syscall("index.ensureFullIndex");
|
|
}
|
|
|
|
export function reindexSpace(): Promise<void> {
|
|
return syscall("index.reindexSpace");
|
|
}
|
|
|
|
export function deleteObject(
|
|
page: string,
|
|
tag: string,
|
|
ref: string,
|
|
): Promise<void> {
|
|
return syscall("index.deleteObject", page, tag, ref);
|
|
}
|