harperdb 4.7.18 → 4.7.20

package/components/EntryHandler.d.ts

@@ -2,6 +2,7 @@ import type { Stats } from 'node:fs';
 import { EventEmitter } from 'node:events';
 import { FileAndURLPathConfig } from './Component.js';
 import { FilesOption } from './deriveGlobOptions.js';
+import type { Logger } from './Logger.ts';
 export interface BaseEntry {
     stats?: Stats;
     urlPath: string;
@@ -52,7 +53,7 @@ export type EntryHandlerEventMap = {
 export declare class EntryHandler extends EventEmitter<EntryHandlerEventMap> {
     #private;
     ready: Promise<any[]>;
-    constructor(name: string, directory: string, config: FilesOption | FileAndURLPathConfig, logger?: any);
+    constructor(name: string, directory: string, config: FilesOption | FileAndURLPathConfig, logger?: Logger);
     get name(): string;
     get directory(): string;
     close(): this;

package/components/Logger.d.ts

@@ -0,0 +1,12 @@
+export interface Logger {
+    logLevel: string;
+    notify?: (...args: any[]) => void;
+    fatal?: (...args: any[]) => void;
+    error?: (...args: any[]) => void;
+    warn?: (...args: any[]) => void;
+    info?: (...args: any[]) => void;
+    debug?: (...args: any[]) => void;
+    trace?: (...args: any[]) => void;
+    withTag: (tag: string) => Logger;
+    loggerWithTag: (tag: string) => Logger;
+}

package/components/OptionsWatcher.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+import type { Logger } from './Logger.ts';
 export interface Config {
     [key: string]: ConfigValue;
 }
@@ -40,7 +41,7 @@ export declare class CannotSetPropertyError extends Error {
 export declare class OptionsWatcher extends EventEmitter<OptionsWatcherEventMap> {
     #private;
     ready: Promise<any[]>;
-    constructor(name: string, filePath: string, logger?: any);
+    constructor(name: string, filePath: string, logger?: Logger);
     /**
      * Closes the underlying file watcher, emits the `close` event, and removes any listeners on the OptionsWatcher instance
      */

package/components/Scope.d.ts

@@ -1,6 +1,8 @@
 import { EventEmitter } from 'node:events';
+import { databaseEventsEmitter } from '../resources/databases.ts';
 import { type Server } from '../server/Server.ts';
 import { EntryHandler, type onEntryEventHandler } from './EntryHandler.ts';
+import type { Logger } from './Logger.ts';
 import { OptionsWatcher } from './OptionsWatcher.ts';
 import type { Resources } from '../resources/Resources.ts';
 import type { FileAndURLPathConfig } from './Component.ts';
@@ -8,22 +10,31 @@ import { FilesOption } from './deriveGlobOptions.ts';
 export declare class MissingDefaultFilesOptionError extends Error {
     constructor();
 }
+export type ScopeEventsMap = {
+    all: [...args: unknown[]];
+    close: [];
+    error: [error: unknown];
+    ready: [];
+    [record: string]: [...args: unknown[]];
+};
 /**
  * This class is what is passed to the `handleApplication` function of an extension.
  *
- * It is imperative that the instance is "ready" before its passed to the `handleApplication` function
+ * It is imperative that the instance is "ready" before it's passed to the `handleApplication` function
  * so that the developer can immediately start using `scope.options`, etc.
  *
  */
-export declare class Scope extends EventEmitter {
+export declare class Scope extends EventEmitter<ScopeEventsMap> {
     #private;
     options: OptionsWatcher;
     resources: Resources;
     server: Server;
     ready: Promise<any[]>;
-    constructor(name: string, directory: string, configFilePath: string, resources: Resources, server: Server);
-    get logger(): any;
-    get name(): string;
+    databaseEvents: typeof databaseEventsEmitter;
+    constructor(appName: string, pluginName: string, directory: string, configFilePath: string, resources: Resources, server: Server, logger?: Logger);
+    get logger(): Logger;
+    get appName(): string;
+    get pluginName(): string;
     get directory(): string;
     get configFilePath(): string;
     close(): this;

package/index.d.ts

@@ -1,11 +1,17 @@
-export { Resource } from './resources/Resource.ts';
+import type { Logger } from './components/Logger.ts';
+import { BlobCreationOptions } from './resources/blob.ts';
+import { databases as dbDatabases, tables as dbTables } from './resources/databases.ts';
 import { Resource as ResourceImport } from './resources/Resource.ts';
+import { server as serverImport } from './server/Server.ts';
+
+export { Resource } from './resources/Resource.ts';
 export type {
-	Query,
 	Context,
+	Query,
+	RequestTargetOrId,
+	Session,
 	SourceContext,
 	SubscriptionRequest,
-	RequestTargetOrId,
 } from './resources/ResourceInterface.ts';
 export { ResourceInterface } from './resources/ResourceInterface.ts';
 export type { User } from './security/user.ts';
@@ -13,14 +19,17 @@ export type { RecordObject } from './resources/RecordEncoder.ts';
 export type { IterableEventQueue } from './resources/IterableEventQueue.ts';
 export { RequestTarget } from './resources/RequestTarget.ts';
 export { server } from './server/Server';
-import { server as serverImport } from './server/Server.ts';
-export { tables, databases } from './resources/databases.ts';
-import { tables as dbTables, databases as dbDatabases } from './resources/databases.ts';
-import { BlobCreationOptions } from './resources/blob.ts';
-export { Scope } from './components/Scope.ts';
+export { tables, databases, type Table } from './resources/databases.ts';
+export type { Attribute } from './resources/Table.ts';
+
+declare const logger: Logger;
+export { type Logger, logger };
+
+export type { Scope } from './components/Scope.ts';
 export type { FilesOption, FilesOptionObject } from './components/deriveGlobOptions.ts';
 export type { FileAndURLPathConfig } from './components/Component.ts';
 export { OptionsWatcher, type Config, type ConfigValue } from './components/OptionsWatcher.ts';
+
 export {
 	EntryHandler,
 	type BaseEntry,
@@ -32,9 +41,11 @@ export {
 	type FileEntryEvent,
 	type AddDirectoryEvent,
 	type UnlinkDirectoryEvent,
-	type DirectoryEntryEvent } from './components/EntryHandler.ts';
+	type DirectoryEntryEvent,
+} from './components/EntryHandler.ts';
 declare global {
 	const tables: typeof dbTables;
+	const logger: Logger;
 	const databases: typeof dbDatabases;
 	const server: typeof serverImport;
 	const Resource: typeof ResourceImport;

package/index.js

@@ -7,6 +7,7 @@ if (!workerThreads.isMainThread) {
 const { globals } = require('./server/threads/threadServer.js');
 
 // exported types are needed for parsing as well
+exports.Attribute = undefined;
 exports.Config = undefined;
 exports.ConfigValue = undefined;
 exports.Context = undefined;
@@ -14,6 +15,7 @@ exports.FileAndURLPathConfig = undefined;
 exports.FilesOption = undefined;
 exports.FilesOptionObject = undefined;
 exports.IterableEventQueue = undefined;
+exports.Logger = undefined;
 exports.Query = undefined;
 exports.RecordObject = undefined;
 exports.RequestTarget = undefined;
@@ -24,6 +26,7 @@ exports.Scope = undefined;
 exports.Session = undefined;
 exports.SourceContext = undefined;
 exports.SubscriptionRequest = undefined;
+exports.Table = undefined;
 exports.User = undefined;
 
 // these are all overwritten by the globals, but need to be here so that Node's static