tsondb 0.21.11 → 0.23.0

package/dist/src/node/config.d.ts

@@ -15,9 +15,6 @@ export type Config<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> = {
      */
     locales?: string[];
     dataRootPath?: string;
-    homeLayoutSections?: HomeLayoutSection[];
-    customStylesheetPath?: string;
-    customAssetsPath?: string;
     validationOptions?: Partial<ValidationOptions>;
     formattingOptions?: Partial<FormatterOptions>;
 };
@@ -29,6 +26,9 @@ export type FormatterOptions = {
 };
 export type ServerOptions = {
     port: number;
+    homeLayoutSections?: HomeLayoutSection[];
+    customStylesheetPath?: string;
+    customAssetsPath?: string;
 };
 export type HomeLayoutSection = {
     title: string;
@@ -58,10 +58,7 @@ export declare const validateConfigForData: (config: Config) => asserts config i
 export type ServerConfig<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> = DataConfig<T> & {
     serverOptions?: ServerOptions;
     locales: string[];
-    homeLayoutSections?: HomeLayoutSection[];
     validationOptions?: Partial<ValidationOptions>;
-    customStylesheetPath?: string;
-    customAssetsPath?: string;
     formattingOptions?: Partial<FormatterOptions>;
 };
 /**

package/dist/src/node/index.d.ts

@@ -1,9 +1,9 @@
-import type { InstanceContainer, InstanceContainerOverview, InstanceContent, SingletonInstanceContainer } from "../shared/utils/instances.ts";
-import type { FormatterOptions } from "./config.ts";
+import type { InstanceContainer, InstanceContent, SingletonInstanceContainer } from "../shared/utils/instances.ts";
+import type { FormatterOptions, ServerOptions } from "./config.ts";
 import { Git } from "./git.js";
-import type { Output } from "./output.ts";
+import { ReadonlyTSONDB } from "./readonly.ts";
 import type { EntityDecl } from "./schema/dsl/index.ts";
-import type { AnyChildEntityMap, AnyEntityMap, AnyEnumMap, AnySingletonEntityMap, AnyTypeAliasMap, IdArgsVariant } from "./schema/generatedTypeHelpers.ts";
+import type { AnyChildEntityMap, AnyEntityMap, AnyEnumMap, AnySingletonEntityMap, AnyTypeAliasMap } from "./schema/generatedTypeHelpers.ts";
 import type { Schema } from "./schema/index.ts";
 import { Transaction } from "./transaction.ts";
 export interface DefaultTSONDBTypes {
@@ -116,7 +116,7 @@ export type HookTrigger = "transaction:before" | "transaction:after";
 /**
  * The main class for managing a typed JSON database.
  */
-export declare class TSONDB<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> {
+export declare class TSONDB<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> extends ReadonlyTSONDB<T> {
     #private;
     private constructor();
     /**
@@ -126,35 +126,10 @@ export declare class TSONDB<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> {
      * @param skipReferenceCache If set to `true`, the reference cache will not be created during initialization. This can speed up the initialization process, but referential integrity checks will not work correctly until the cache is created. This should only be set to `true` if you plan to call `sync()` immediately after initialization.
      */
     static create<Types extends DefaultTSONDBTypes = DefaultTSONDBTypes>(options: TSONDBOptions<Types>, skipReferenceCache?: boolean): Promise<TSONDB<Types>>;
-    /**
-     * Generates outputs based on the provided schema and output configurations.
-     */
-    static generateOutputs(options: {
-        schema: Schema;
-        outputs: Output[];
-    }): Promise<void>;
-    /**
-     * Generates outputs based on the current schema and the provided output configurations.
-     */
-    generateOutputs(outputs: Output[]): Promise<void>;
-    /**
-     * Validates the data in the database.
-     *
-     * Returns `true` if the data is valid, `false` otherwise.
-     */
-    validate(): boolean;
     /**
      * Formats the data on disk according to the current in-memory representation.
      */
     format(): Promise<void>;
-    /**
-     * Checks if the data on disk is formatted according to the current in-memory representation.
-     */
-    checkFormat(): Promise<boolean>;
-    /**
-     * Reloads the data from disk into memory.
-     */
-    sync(): Promise<void>;
     /**
      * Runs a transaction on the database.
      *
@@ -216,82 +191,6 @@ export declare class TSONDB<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> {
      * @throws {Error}
      */
     reorderInstanceOfEntity(entityName: EntityName<T> | EntityDecl<EntityName<T>>, instanceId: string, newIndex: number): Promise<[id: string, oldContent: InstanceContent, newContent: InstanceContent][]>;
-    /**
-     * Retrieves an instance of the specified entity by its identifier.
-     */
-    getInstanceOfEntityById<E extends EntityName<T>>(...args: IdArgsVariant<T["entityMap"], E>): T["entityMap"][E] | undefined;
-    /**
-     * Retrieves the instance container of the specified entity by its identifier.
-     */
-    getInstanceContainerOfEntityById<E extends EntityName<T>>(...args: IdArgsVariant<T["entityMap"], E>): InstanceContainer<T["entityMap"][E]> | undefined;
-    /**
-     * Retrieves the overview of an instance of the specified entity by its identifier.
-     */
-    getInstanceOverviewOfEntityById(...args: IdArgsVariant<T["entityMap"]>): InstanceContainerOverview | undefined;
-    /**
-     * Retrieves all instances of the specified entity.
-     */
-    getAllInstancesOfEntity<E extends EntityName<T>>(entityName: E): Entity<T, E>[];
-    /**
-     * Retrieves all instance containers of the specified entity.
-     */
-    getAllInstanceContainersOfEntity<E extends EntityName<T>>(entityName: E): InstanceContainer<Entity<T, E>>[];
-    /**
-     * Retrieves all instance overviews of the specified entity.
-     */
-    getAllInstanceOverviewsOfEntity(entity: EntityDecl<EntityName<T>> | EntityName<T>): InstanceContainerOverview[];
-    /**
-     * Retrieves an instance of the specified entity by its identifier.
-     */
-    getSingletonInstanceOfEntity<E extends SingletonEntityName<T>>(entityName: E): T["singletonEntityMap"][E] | undefined;
-    /**
-     * Retrieves the instance container of the specified entity by its identifier.
-     */
-    getSingletonInstanceContainerOfEntity<E extends SingletonEntityName<T>>(entityName: E): SingletonInstanceContainer<T["singletonEntityMap"][E]> | undefined;
-    /**
-     * Counts the number of instances registered for the specified entity.
-     */
-    countInstancesOfEntity(entityName: EntityName<T>): number;
-    /**
-     * Returns whether the singleton entity has an instance.
-     */
-    hasInstanceOfSingletonEntity(entityName: SingletonEntityName<T>): boolean;
-    /**
-     * Retrieves overviews for all instances in the database, grouped by entity name.
-     */
-    getAllInstanceOverviews(): Record<EntityName<T>, InstanceContainerOverview[]>;
-    /**
-     * Retrieves all instance containers of the specified child entity for a given parent instance.
-     */
-    getAllChildInstanceContainersForParent<U extends ChildEntityName<T>>(childEntityName: U, parentId: ChildEntityConfig<T, U>[2]): InstanceContainer<ChildEntity<T, U>>[];
-    /**
-     * Displays the name of an entity instance including its ID. If no display name is found, `undefined` is returned.
-     */
-    getDisplayName(...args: IdArgsVariant<T["entityMap"]>): string | undefined;
-    /**
-     * Displays the name of an entity instance including its ID. If no display name is found, only the ID is returned.
-     */
-    getDisplayNameWithId(...args: IdArgsVariant<T["entityMap"]>): string;
-    /**
-     * Checks if a given instance is referenced by other instances in the database.
-     *
-     * If `otherInstancesToDelete` is provided, those instances will be excluded from the check. This can be useful when planning to delete multiple instances at once and wanting to ignore references from those instances.
-     */
-    isReferencedByOtherInstances(instance: string, otherInstancesToDelete?: string[]): boolean;
-    /**
-     * The configured locales for this TSONDB instance.
-     */
-    get locales(): string[];
-    /**
-     * Sets the locales for this TSONDB instance.
-     *
-     * The provided locales must exist in the database if a locale entity is defined in the schema.
-     */
-    setLocales(locales: string[]): void;
-    /**
-     * The loaded schema for this TSONDB instance.
-     */
-    get schema(): Schema<T>;
     /**
      * The Git wrapper for this TSONDB instance, if a git repository is connected.
      */
@@ -301,43 +200,24 @@ export declare class TSONDB<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> {
      */
     isGitRepo(): this is TSONDBWithGit<T>;
     /**
-     * Searches for instances matching the provided query in their ID or display name.
-     *
-     * The results are sorted by relevance. A custom relevance score function can be provided.
+     * Registers a new hook for the specified trigger. The callback will be invoked whenever the trigger is activated.
      */
-    search(query: string, options?: Partial<{
-        getRelevanceScore: <E extends EntityName<T>>(args: {
-            entityName: E;
-            id: string;
-            content: Entity<T, E>;
-            displayName: string;
-            displayNameLocaleId: string | undefined;
-            query: string;
-            queryLowerCase: string;
-        }) => number;
-    }>): [string, InstanceContainerOverview][];
+    registerHook(trigger: HookTrigger, callback: (db: TSONDB<T>) => void): void;
     /**
-     * Retrieves the name of the entity for a given instance ID. If no instance with the provided ID is found, `undefined` is returned.
+     * Unregisters a hook for the specified trigger.
      */
-    getEntityNameOfInstanceId(id: string): string | undefined;
+    unregisterHook(trigger: HookTrigger, callback: (db: TSONDB<T>) => void): void;
     /**
      * Compresses the entire database into a single JSON file at the specified path.
      *
      * Instead of storing each instance in its own file, this method serializes the entire database into a single JSON file. This can be useful for backup, transfer or archiving purposes. The resulting file contains all instances organized by entity names. No spaces or indentation are used in the JSON output to minimize file size.
      * @param path The file path where the compressed database will be saved.
+     * @param indentation Optional. If provided, the JSON output will be formatted with the specified number of spaces for indentation. If not provided, the output will be minified without any extra spaces.
      */
-    compressToSingleFile(path: string): Promise<void>;
-    /**
-     * Registers a new hook for the specified trigger. The callback will be invoked whenever the trigger is activated.
-     */
-    registerHook(trigger: HookTrigger, callback: (db: TSONDB<T>) => void): void;
-    /**
-     * Unregisters a hook for the specified trigger.
-     */
-    unregisterHook(trigger: HookTrigger, callback: (db: TSONDB<T>) => void): void;
+    compressToSingleFile(path: string, indentation?: number): Promise<void>;
+    serve(config: ServerOptions, callback?: (error?: NodeJS.ErrnoException) => void): void;
 }
 export type TSONDBWithGit<T extends DefaultTSONDBTypes = DefaultTSONDBTypes> = TSONDB<T> & {
     git: Git<T>;
 };
 export type { Config } from "./config.ts";
-export { createServer } from "./server/index.ts";