@kollors/deep-json-server 0.5.0 → 0.7.0

package/types/src/server.d.ts

@@ -1,30 +1,14 @@
+export type OpenapiDocument = Record<string, unknown>;
+export type ServerFacade = {
+    fastify: () => import('fastify').FastifyInstance;
+    openapi: () => Promise<OpenapiDocument>;
+};
 /**
- * Creates a Fastify server without opening a network port.
- * @param {{ databasePath: string, filesDirectoryPath?: string, filesMetadataPath?: string, logger?: boolean | Record<string, unknown>, maxFileSize?: number, maxPageSize?: number, schemaPath?: string }} options Server options.
- * @returns {Promise<import('fastify').FastifyInstance>} Fastify server.
+ * Creates lazy Fastify and OpenAPI accessors from one configuration.
+ * @param {import('./config.js').DeepJsonServerConfig} config Server configuration.
+ * @param {{ files?: boolean }} [features] Optional feature switches.
+ * @returns {Promise<ServerFacade>} Server facade.
  */
-export declare function createServer(options: {
-    databasePath: string;
-    filesDirectoryPath?: string;
-    filesMetadataPath?: string;
-    logger?: boolean | Record<string, unknown>;
-    maxFileSize?: number;
-    maxPageSize?: number;
-    schemaPath?: string;
-}): Promise<import('fastify').FastifyInstance>;
-/**
- * Creates and starts a Fastify server.
- * @param {{ databasePath: string, filesDirectoryPath?: string, filesMetadataPath?: string, host?: string, logger?: boolean | Record<string, unknown>, maxFileSize?: number, maxPageSize?: number, port?: number, schemaPath?: string }} options Server options.
- * @returns {Promise<import('fastify').FastifyInstance>} Listening Fastify server.
- */
-export declare function startServer(options: {
-    databasePath: string;
-    filesDirectoryPath?: string;
-    filesMetadataPath?: string;
-    host?: string;
-    logger?: boolean | Record<string, unknown>;
-    maxFileSize?: number;
-    maxPageSize?: number;
-    port?: number;
-    schemaPath?: string;
-}): Promise<import('fastify').FastifyInstance>;
+export declare function createServer(config: import('./config.js').DeepJsonServerConfig, features?: {
+    files?: boolean;
+}): Promise<ServerFacade>;

package/types/src/utils.d.ts

@@ -1,4 +1,12 @@
 export declare const createHttpError: (statusCode: any, message: any) => Error;
+/** @returns {<T>(operation: () => T | Promise<T>) => Promise<T>} Serialized operation scheduler. */
+export declare const createSerialQueue: () => <T>(operation: () => T | Promise<T>) => Promise<T>;
+/**
+ * Creates a random ID that is not currently in use.
+ * @param {(id: string) => boolean} isUsed Checks whether an ID already exists.
+ * @returns {string} Unique ID.
+ */
+export declare const createUniqueId: (isUsed: (id: string) => boolean) => string;
 export declare const getResourceNames: (data: any) => string[];
 export declare const isObject: (value: any) => boolean;
 export declare const isSafeKey: (key: any) => boolean;