@ez4/database 0.36.0 → 0.38.0

package/dist/metadata/types.d.ts

@@ -0,0 +1,70 @@
+import type { FunctionSignature, ServiceListener } from '@ez4/common/library';
+import type { LinkedVariables, ServiceMetadata } from '@ez4/project/library';
+import type { ArchitectureType, RuntimeType } from '@ez4/project';
+import type { ObjectSchema } from '@ez4/schema';
+import type { ParametersMode, TransactionMode, InsensitiveMode, PaginationMode, OrderMode, LockMode } from '../types/mode';
+import type { Index } from '../types/index';
+export declare const ServiceType = "@ez4/database";
+export type DatabaseService = Omit<ServiceMetadata, 'variables' | 'services'> & Required<Pick<ServiceMetadata, 'variables' | 'services'>> & {
+    type: typeof ServiceType;
+    scalability?: DatabaseScalability;
+    engine: DatabaseEngine;
+    tables: DatabaseTable[];
+    name: string;
+};
+export type TableSchema = ObjectSchema;
+export type StreamHandler = FunctionSignature;
+export type DatabaseEngine = {
+    parametersMode: ParametersMode;
+    transactionMode: TransactionMode;
+    insensitiveMode: InsensitiveMode;
+    paginationMode: PaginationMode;
+    orderMode: OrderMode;
+    lockMode: LockMode;
+    name: string;
+};
+export type DatabaseScalability = {
+    minCapacity: number;
+    maxCapacity: number;
+};
+export type TableIndex = {
+    name: string;
+    columns: string[];
+    type: Index;
+};
+export type TableRelation = {
+    sourceTable: string;
+    sourceColumn: string;
+    sourceIndex?: Index;
+    targetColumn: string;
+    targetAlias: string;
+    targetIndex?: Index;
+};
+export type DatabaseTable = {
+    name: string;
+    schema: TableSchema;
+    relations?: TableRelation[];
+    indexes: TableIndex[];
+    stream?: TableStream;
+};
+export type TableStream = {
+    listener?: ServiceListener;
+    handler: StreamHandler;
+    variables?: LinkedVariables;
+    architecture?: ArchitectureType;
+    runtime?: RuntimeType;
+    logRetention?: number;
+    timeout?: number;
+    memory?: number;
+};
+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/dist/services/contract.d.ts

@@ -1,6 +1,9 @@
 import type { Service as CommonService } from '@ez4/common';
-import type { TableStreamHandler, TableStreamIncoming, TableStreamListener, TableStreamRequest } from './common';
 import type { DatabaseScalability } from './scalability';
+import type { TableStreamIncoming } from './incoming';
+import type { TableStreamListener } from './listener';
+import type { TableStreamHandler } from './handler';
+import type { TableStreamRequest } from './request';
 import type { TableRelations } from './relations';
 import type { DatabaseEngine } from './engine';
 import type { TableIndexes } from './indexes';

package/dist/services/engine.d.ts

@@ -1,10 +1,5 @@
-import type { ParametersMode } from './parameters';
-import type { TransactionMode } from './transaction';
-import type { InsensitiveMode } from './insensitive';
-import type { PaginationMode } from './pagination';
+import type { ParametersMode, TransactionMode, InsensitiveMode, PaginationMode, OrderMode, LockMode } from '../types/mode';
 import type { Database } from './contract';
-import type { OrderMode } from './order';
-import type { LockMode } from './lock';
 /**
  * Database engine.
  */

package/dist/services/handler.d.ts

@@ -0,0 +1,8 @@
+import type { Service as CommonService } from '@ez4/common';
+import type { TableStreamIncoming } from './incoming';
+import type { TableSchema } from './schemas';
+import type { Database } from './contract';
+/**
+ * Table stream handler.
+ */
+export type TableStreamHandler<T extends TableSchema> = (request: TableStreamIncoming<T>, context: CommonService.Context<Database.Service>) => Promise<void> | void;

package/dist/services/incoming.d.ts

@@ -0,0 +1,7 @@
+import type { TableStreamRequest } from './request';
+import type { StreamAnyChange } from './streams';
+import type { TableSchema } from './schemas';
+/**
+ * Incoming table stream event.
+ */
+export type TableStreamIncoming<T extends TableSchema> = StreamAnyChange<T> & TableStreamRequest;

package/dist/services/indexes.d.ts

@@ -2,19 +2,11 @@ import type { ArrayRest, IsArrayEmpty } from '@ez4/utils';
 import type { DatabaseTable, DatabaseTables } from './table';
 import type { TableSchema } from './schemas';
 import type { Database } from './contract';
+import type { Index } from '../types';
 /**
  * Database table indexes.
  */
 export type TableIndexes = {};
-/**
- * All supported index types.
- */
-export declare const enum Index {
-    Primary = "primary",
-    Secondary = "secondary",
-    Unique = "unique",
-    TTL = "ttl"
-}
 /**
  * Given an index name `T`, it produces the decomposed index names.
  */

package/dist/services/insensitive.d.ts

@@ -1,11 +1,5 @@
+import type { InsensitiveMode } from '../types/mode';
 import type { DatabaseEngine, EngineUtils } from './engine';
-/**
- * Insensitive mode.
- */
-export declare const enum InsensitiveMode {
-    Unsupported = "unsupported",
-    Enabled = "enabled"
-}
 /**
  * Insensitive mode utils.
  */

package/dist/services/listener.d.ts

@@ -0,0 +1,8 @@
+import type { Service as CommonService } from '@ez4/common';
+import type { TableStreamIncoming } from './incoming';
+import type { TableSchema } from './schemas';
+import type { Database } from './contract';
+/**
+ * Table stream listener.
+ */
+export type TableStreamListener<T extends TableSchema> = (event: CommonService.AnyEvent<TableStreamIncoming<T>>, context: CommonService.Context<Database.Service>) => Promise<void> | void;

package/dist/services/lock.d.ts

@@ -1,11 +1,5 @@
+import type { LockMode } from '../types/mode';
 import type { TableMetadata } from './table';
-/**
- * Lock mode.
- */
-export declare const enum LockMode {
-    Unsupported = "unsupported",
-    Supported = "supported"
-}
 /**
  * Lock mode utils.
  */

package/dist/services/order.d.ts

@@ -1,20 +1,8 @@
+import type { OrderMode } from '../types/mode';
+import type { Order } from '../types/order';
 import type { DecomposeIndexName } from './indexes';
 import type { TableMetadata } from './table';
 import type { Database } from './contract';
-/**
- * Query order types.
- */
-export declare const enum Order {
-    Asc = "asc",
-    Desc = "desc"
-}
-/**
- * Order mode.
- */
-export declare const enum OrderMode {
-    IndexColumns = "index",
-    AnyColumns = "any"
-}
 /**
  * Order mode utils.
  */

package/dist/services/pagination.d.ts

@@ -1,11 +1,5 @@
+import type { PaginationMode } from '../types/mode';
 import type { DatabaseEngine, EngineUtils } from './engine';
-/**
- * Pagination mode.
- */
-export declare const enum PaginationMode {
-    Cursor = "cursor",
-    Offset = "offset"
-}
 /**
  * Pagination mode utils.
  */

package/dist/services/parameters.d.ts

@@ -1,12 +1,6 @@
+import type { ParametersMode } from '../types/mode';
 import type { EngineUtils } from './engine';
 import type { Database } from './contract';
-/**
- * Parameters mode.
- */
-export declare const enum ParametersMode {
-    NameAndIndex = "both",
-    OnlyIndex = "index"
-}
 /**
  * Parameters mode utils.
  */

package/dist/services/request.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Table stream request.
+ */
+export type TableStreamRequest = {
+    /**
+     *  Unique identifier for the request.
+     */
+    readonly requestId: string;
+    /**
+     * Unique identifier across multiple services.
+     */
+    readonly traceId?: string;
+};

package/dist/services/scalability.d.ts

@@ -2,6 +2,12 @@
  * Database scalability configuration.
  */
 export interface DatabaseScalability {
+    /**
+     * Minimum scalability threshold.
+     */
     minCapacity: number;
+    /**
+     * Maximum scalability threshold.
+     */
     maxCapacity: number;
 }

package/dist/services/streams.d.ts

@@ -1,5 +1,7 @@
+import type { ArchitectureType, RuntimeType } from '@ez4/project';
 import type { LinkedVariables } from '@ez4/project/library';
-import type { TableStreamHandler, TableStreamListener } from './common';
+import type { TableStreamListener } from './listener';
+import type { TableStreamHandler } from './handler';
 import type { TableSchema } from './schemas';
 /**
  * Database table stream.
@@ -17,6 +19,14 @@ export interface TableStream<T extends TableSchema> {
      * Variables associated to the handler.
      */
     readonly variables?: LinkedVariables;
+    /**
+     * Architecture for the stream function.
+     */
+    readonly architecture?: ArchitectureType;
+    /**
+     * Runtime for the stream function.
+     */
+    readonly runtime?: RuntimeType;
     /**
      * Log retention (in days) for the handler.
      */

package/dist/services/transaction.d.ts

@@ -1,3 +1,4 @@
+import type { TransactionMode } from '../types/mode';
 import type { TableIndex, TableMetadata, TableRelation } from './table';
 import type { RelationTables } from './relations';
 import type { IndexedTables } from './indexes';
@@ -6,13 +7,6 @@ import type { TableSchemas } from './schemas';
 import type { Database } from './contract';
 import type { Client } from './client';
 import type { Query } from './query';
-/**
- * Transaction mode.
- */
-export declare const enum TransactionMode {
-    Interactive = "interactive",
-    Static = "static"
-}
 /**
  * Transaction mode utils.
  */

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * All supported index types.
+ */
+export declare const enum Index {
+    Primary = "primary",
+    Secondary = "secondary",
+    Unique = "unique",
+    TTL = "ttl"
+}

package/dist/types/mode.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Parameters mode.
+ */
+export declare const enum ParametersMode {
+    NameAndIndex = "both",
+    OnlyIndex = "index"
+}
+/**
+ * Transaction mode.
+ */
+export declare const enum TransactionMode {
+    Interactive = "interactive",
+    Static = "static"
+}
+/**
+ * Insensitive mode.
+ */
+export declare const enum InsensitiveMode {
+    Unsupported = "unsupported",
+    Enabled = "enabled"
+}
+/**
+ * Pagination mode.
+ */
+export declare const enum PaginationMode {
+    Cursor = "cursor",
+    Offset = "offset"
+}
+/**
+ * Order mode.
+ */
+export declare const enum OrderMode {
+    IndexColumns = "index",
+    AnyColumns = "any"
+}
+/**
+ * Lock mode.
+ */
+export declare const enum LockMode {
+    Unsupported = "unsupported",
+    Supported = "supported"
+}

package/dist/types/order.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Query order types.
+ */
+export declare const enum Order {
+    Asc = "asc",
+    Desc = "desc"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ez4/database",
   "description": "EZ4: Components to build database services",
-  "version": "0.36.0",
+  "version": "0.38.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.36.0",
-    "@ez4/project": "^0.36.0",
-    "@ez4/reflection": "^0.36.0",
-    "@ez4/schema": "^0.36.0",
-    "@ez4/utils": "^0.36.0"
+    "@ez4/common": "^0.38.0",
+    "@ez4/project": "^0.38.0",
+    "@ez4/reflection": "^0.38.0",
+    "@ez4/schema": "^0.38.0",
+    "@ez4/utils": "^0.38.0"
   }
 }

package/dist/metadata/utils.d.ts

@@ -1,9 +0,0 @@
-import type { AllType, TypeCallback, TypeClass, TypeFunction, TypeModel } from '@ez4/reflection';
-export declare const isDatabaseService: (type: AllType) => type is TypeClass;
-export declare const isDatabaseEngine: (type: AllType) => type is TypeModel;
-export declare const isDatabaseTable: (type: AllType) => type is TypeModel;
-export declare const isStreamHandler: (type: AllType) => type is TypeCallback | TypeFunction;
-export declare const isTableRelations: (type: TypeModel) => boolean;
-export declare const isTableIndexes: (type: TypeModel) => boolean;
-export declare const isTableSchema: (type: TypeModel) => boolean;
-export declare const isTableStream: (type: TypeModel) => boolean;

package/dist/services/common.d.ts

@@ -1,25 +0,0 @@
-import type { Service as CommonService } from '@ez4/common';
-import type { StreamAnyChange } from './streams';
-import type { TableSchema } from './schemas';
-import type { Database } from './contract';
-/**
- * Incoming table stream event.
- */
-export type TableStreamIncoming<T extends TableSchema> = StreamAnyChange<T> & TableStreamRequest;
-/**
- * Table stream request.
- */
-export type TableStreamRequest = {
-    /**
-     * Request tracking Id.
-     */
-    readonly requestId: string;
-};
-/**
- * Table stream listener.
- */
-export type TableStreamListener<T extends TableSchema> = (event: CommonService.AnyEvent<TableStreamIncoming<T>>, context: CommonService.Context<Database.Service>) => Promise<void> | void;
-/**
- * Table stream handler.
- */
-export type TableStreamHandler<T extends TableSchema> = (request: TableStreamIncoming<T>, context: CommonService.Context<Database.Service>) => Promise<void> | void;

package/dist/types/engine.d.ts

@@ -1,15 +0,0 @@
-import type { ParametersMode } from '../services/parameters';
-import type { TransactionMode } from '../services/transaction';
-import type { InsensitiveMode } from '../services/insensitive';
-import type { PaginationMode } from '../services/pagination';
-import type { OrderMode } from '../services/order';
-import type { LockMode } from '../services/lock';
-export type DatabaseEngine = {
-    parametersMode: ParametersMode;
-    transactionMode: TransactionMode;
-    insensitiveMode: InsensitiveMode;
-    paginationMode: PaginationMode;
-    orderMode: OrderMode;
-    lockMode: LockMode;
-    name: string;
-};

package/dist/types/handler.d.ts

@@ -1,6 +0,0 @@
-export type StreamHandler = {
-    name: string;
-    module?: string;
-    file: string;
-    description?: string;
-};

package/dist/types/indexes.d.ts

@@ -1,6 +0,0 @@
-import type { Index } from '../services/indexes';
-export type TableIndex = {
-    name: string;
-    columns: string[];
-    type: Index;
-};

package/dist/types/relations.d.ts

@@ -1,9 +0,0 @@
-import type { Index } from '../services/indexes';
-export type TableRelation = {
-    sourceTable: string;
-    sourceColumn: string;
-    sourceIndex?: Index;
-    targetColumn: string;
-    targetAlias: string;
-    targetIndex?: Index;
-};

package/dist/types/scalability.d.ts

@@ -1,4 +0,0 @@
-export type DatabaseScalability = {
-    minCapacity: number;
-    maxCapacity: number;
-};

package/dist/types/schema.d.ts

@@ -1,2 +0,0 @@
-import type { ObjectSchema } from '@ez4/schema';
-export type TableSchema = ObjectSchema;

package/dist/types/service.d.ts

@@ -1,13 +0,0 @@
-import type { ServiceMetadata } from '@ez4/project/library';
-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 & {
-    type: typeof ServiceType;
-    scalability?: DatabaseScalability;
-    engine: DatabaseEngine;
-    tables: DatabaseTable[];
-    name: string;
-};
-export declare const isDatabaseService: (service: ServiceMetadata) => service is DatabaseService;

package/dist/types/stream.d.ts

@@ -1,11 +0,0 @@
-import type { LinkedVariables } from '@ez4/project/library';
-import type { ServiceListener } from '@ez4/common/library';
-import type { StreamHandler } from './handler';
-export type TableStream = {
-    listener?: ServiceListener;
-    handler: StreamHandler;
-    variables?: LinkedVariables;
-    logRetention?: number;
-    timeout?: number;
-    memory?: number;
-};

package/dist/types/table.d.ts

@@ -1,11 +0,0 @@
-import type { TableRelation } from './relations';
-import type { TableIndex } from './indexes';
-import type { TableSchema } from './schema';
-import type { TableStream } from './stream';
-export type DatabaseTable = {
-    name: string;
-    schema: TableSchema;
-    relations?: TableRelation[];
-    indexes: TableIndex[];
-    stream?: TableStream;
-};