@ez4/database 0.35.0 → 0.37.0

package/dist/types/service.d.ts

@@ -3,7 +3,7 @@ import type { DatabaseScalability } from './scalability';
 import type { DatabaseEngine } from './engine';
 import type { DatabaseTable } from './table';
 export declare const ServiceType = "@ez4/database";
-export type DatabaseService = ServiceMetadata & {
+export type DatabaseService = Omit<ServiceMetadata, 'variables' | 'services'> & Required<Pick<ServiceMetadata, 'variables' | 'services'>> & {
     type: typeof ServiceType;
     scalability?: DatabaseScalability;
     engine: DatabaseEngine;
@@ -11,3 +11,13 @@ export type DatabaseService = ServiceMetadata & {
     name: string;
 };
 export declare const isDatabaseService: (service: ServiceMetadata) => service is DatabaseService;
+export declare const createDatabaseService: (name: string) => {
+    variables: {};
+    services: {};
+    type: "@ez4/database";
+    name: string;
+    context: Record<string, import("@ez4/project/library").LinkedContext>;
+    scalability?: DatabaseScalability | null | undefined;
+    engine?: DatabaseEngine | null | undefined;
+    tables?: DatabaseTable[] | null | undefined;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ez4/database",
   "description": "EZ4: Components to build database services",
-  "version": "0.35.0",
+  "version": "0.37.0",
   "author": "Silas B.",
   "license": "MIT",
   "type": "module",
@@ -46,10 +46,10 @@
     "live:publish": "npm run build && npm publish --access public"
   },
   "dependencies": {
-    "@ez4/common": "^0.35.0",
-    "@ez4/project": "^0.35.0",
-    "@ez4/reflection": "^0.35.0",
-    "@ez4/schema": "^0.35.0",
-    "@ez4/utils": "^0.35.0"
+    "@ez4/common": "^0.37.0",
+    "@ez4/project": "^0.37.0",
+    "@ez4/reflection": "^0.37.0",
+    "@ez4/schema": "^0.37.0",
+    "@ez4/utils": "^0.37.0"
   }
 }

package/dist/services/database.d.ts

@@ -1,142 +0,0 @@
-import type { Service as CommonService } from '@ez4/common';
-import type { LinkedVariables } from '@ez4/project/library';
-import type { StreamChange } from './streams';
-import type { DatabaseEngine } from './engine';
-import type { Client } from './client';
-/**
- * Given a database service `T`, it returns all its table.
- */
-export type DatabaseTables<T> = T extends {
-    tables: infer U;
-} ? U : [];
-/**
- * Provide all contracts for a self-managed database service.
- */
-export declare namespace Database {
-    /**
-     * Table schema.
-     */
-    interface Schema {
-    }
-    /**
-     * Table relations.
-     */
-    interface Relations {
-    }
-    /**
-     * Table indexes.
-     */
-    type Indexes = {};
-    /**
-     * Incoming stream event.
-     */
-    type Incoming<T extends Schema> = StreamChange<T> & Request;
-    /**
-     * Incoming request.
-     */
-    type Request = {
-        /**
-         * Request tracking Id.
-         */
-        requestId: string;
-    };
-    /**
-     * Stream listener.
-     */
-    type Listener<T extends Schema> = (event: CommonService.AnyEvent<Incoming<T>>, context: CommonService.Context<Database.Service>) => Promise<void> | void;
-    /**
-     * Stream handler.
-     */
-    type Handler<T extends Schema> = (request: Incoming<T>, context: CommonService.Context<Database.Service>) => Promise<void> | void;
-    /**
-     * Service event.
-     */
-    type ServiceEvent<T extends Schema = Schema> = CommonService.BeginEvent<Request> | CommonService.ReadyEvent<Incoming<T>> | CommonService.DoneEvent<Incoming<T>> | CommonService.ErrorEvent<Request | Incoming<T>> | CommonService.EndEvent<Request>;
-    /**
-     * Service engine.
-     */
-    type Engine = DatabaseEngine;
-    /**
-     * Service scalability configuration.
-     */
-    interface Scalability {
-        minCapacity: number;
-        maxCapacity: number;
-    }
-    /**
-     * Table stream.
-     */
-    interface Stream<T extends Schema = Schema> {
-        /**
-         * Stream listener.
-         */
-        listener?: Listener<T>;
-        /**
-         * Stream handler.
-         */
-        handler: Handler<T>;
-        /**
-         * Variables associated to the handler.
-         */
-        variables?: LinkedVariables;
-        /**
-         * Log retention (in days) for the handler.
-         */
-        logRetention?: number;
-        /**
-         * Max execution time (in seconds) for the handler.
-         */
-        timeout?: number;
-        /**
-         * Amount of memory available for the handler.
-         */
-        memory?: number;
-    }
-    /**
-     * Database table.
-     */
-    interface Table<T extends Schema = Schema> {
-        /**
-         * Table name.
-         */
-        name: string;
-        /**
-         * Table schema.
-         */
-        schema: T;
-        /**
-         * Table relations.
-         */
-        relations?: Relations;
-        /**
-         * Table indexes.
-         */
-        indexes: Indexes;
-        /**
-         * Table stream configuration.
-         */
-        stream?: Stream<T>;
-    }
-    /**
-     * Database service.
-     */
-    abstract class Service implements CommonService.Provider {
-        /**
-         * Determines which database engine to use.
-         * Check the provider package to know all the possible values.
-         */
-        abstract engine: Engine;
-        /**
-         * Describe all available tables for the service.
-         */
-        abstract tables: Table<any>[];
-        /**
-         * Scalability configuration.
-         */
-        scalability: Scalability;
-        /**
-         * Service client.
-         */
-        client: Client<Service>;
-    }
-}