resolve-eventstore-base - npm Package Compare versions

Comparing version 0.27.6-alpha to 0.27.7-alpha

package.json

 {
   "name": "resolve-eventstore-base",
-  "version": "0.27.6-alpha",
+  "version": "0.27.7-alpha",
   "description": "A base for reSolve eventstore adapters",
@@ -27,4 +27,4 @@ "keywords": [
     "@babel/runtime": "7.9.6",
-    "resolve-debug-levels": "0.27.6-alpha",
-    "resolve-core": "0.27.6-alpha"
+    "resolve-debug-levels": "0.27.7-alpha",
+    "resolve-core": "0.27.7-alpha"
   },
@@ -31,0 +31,0 @@ "devDependencies": {

types/constants.d.ts

 export declare const MAINTENANCE_MODE_AUTO: unique symbol;
 export declare const MAINTENANCE_MODE_MANUAL: unique symbol;
 export declare const PARTIAL_EVENT_FLAG: unique symbol;
+export declare const PARTIAL_SECRET_FLAG: unique symbol;
 export declare const BUFFER_SIZE: number;
 export declare const BATCH_SIZE = 200;

types/create-adapter.d.ts

 import { AdapterPoolConnected, AdapterPoolConnectedProps, Adapter, AdapterFunctions, CommonAdapterFunctions, AdapterConfig } from './types';
-declare const createAdapter: <ConnectedProps extends AdapterPoolConnectedProps, ConnectionDependencies extends unknown, Config extends AdapterConfig>({ maybeThrowResourceError, wrapMethod, wrapEventFilter, wrapDispose, validateEventFilter, loadEvents, importStream, exportStream, incrementalImport, getNextCursor, }: CommonAdapterFunctions<ConnectedProps>, { connect, loadEventsByCursor, loadEventsByTimestamp, getLatestEvent, saveEvent, init, drop, dispose, injectEvent, freeze, unfreeze, shapeEvent, loadSnapshot, saveSnapshot, dropSnapshot, beginIncrementalImport, commitIncrementalImport, rollbackIncrementalImport, pushIncrementalImport, getSecret, setSecret, deleteSecret, }: AdapterFunctions<ConnectedProps, ConnectionDependencies, Config, AdapterPoolConnected<ConnectedProps>>, connectionDependencies: ConnectionDependencies, options: Config) => Adapter;
+declare const createAdapter: <ConnectedProps extends AdapterPoolConnectedProps, ConnectionDependencies extends unknown, Config extends AdapterConfig>({ maybeThrowResourceError, wrapMethod, wrapEventFilter, wrapDispose, validateEventFilter, loadEvents, importEventsStream, exportEventsStream, incrementalImport, getNextCursor, importSecretsStream, exportSecretsStream, init, drop, }: CommonAdapterFunctions<ConnectedProps>, { connect, loadEventsByCursor, loadEventsByTimestamp, getLatestEvent, saveEvent, initEvents, initSecrets, initFinal, dropEvents, dropSecrets, dropFinal, dispose, injectEvent, freeze, unfreeze, shapeEvent, loadSnapshot, saveSnapshot, dropSnapshot, beginIncrementalImport, commitIncrementalImport, rollbackIncrementalImport, pushIncrementalImport, getSecret, setSecret, deleteSecret, loadSecrets, injectSecret, }: AdapterFunctions<ConnectedProps, ConnectionDependencies, Config, AdapterPoolConnected<ConnectedProps>>, connectionDependencies: ConnectionDependencies, options: Config) => Adapter;
 export default createAdapter;

types/index.d.ts

@@ -7,5 +7,5 @@ import { MAINTENANCE_MODE_AUTO, MAINTENANCE_MODE_MANUAL } from './constants';
 import snapshotTrigger from './snapshot-trigger';
-import { CursorFilter, TimestampFilter, isTimestampFilter, isCursorFilter, EventsWithCursor, EventFilter, Adapter, AdapterFunctions, AdapterPoolConnectedProps, AdapterPoolPossiblyUnconnected, AdapterPoolConnected, AdapterConfig } from './types';
+import { CursorFilter, TimestampFilter, isTimestampFilter, isCursorFilter, EventsWithCursor, EventFilter, Adapter, AdapterFunctions, AdapterPoolConnectedProps, AdapterPoolPossiblyUnconnected, AdapterPoolConnected, AdapterConfig, ImportOptions, ExportOptions, SecretFilter, SecretsWithIdx, SecretRecord } from './types';
 declare const wrappedCreateAdapter: <ConnectedProps extends AdapterPoolConnectedProps, ConnectionDependencies extends unknown, Config extends AdapterConfig>(adapterFunctions: AdapterFunctions<ConnectedProps, ConnectionDependencies, Config, AdapterPoolConnected<ConnectedProps>>, connectionDependencies: ConnectionDependencies, options: Config) => Adapter;
 export default wrappedCreateAdapter;
-export { ResourceAlreadyExistError as EventstoreResourceAlreadyExistError, ResourceNotExistError as EventstoreResourceNotExistError, ConcurrentError, MAINTENANCE_MODE_AUTO, MAINTENANCE_MODE_MANUAL, throwBadCursor, getNextCursor, snapshotTrigger, CursorFilter, TimestampFilter, isTimestampFilter, isCursorFilter, EventsWithCursor, EventFilter, Adapter, AdapterPoolConnectedProps, AdapterPoolConnected, AdapterPoolPossiblyUnconnected, AdapterConfig, };
+export { ResourceAlreadyExistError as EventstoreResourceAlreadyExistError, ResourceNotExistError as EventstoreResourceNotExistError, ConcurrentError, MAINTENANCE_MODE_AUTO, MAINTENANCE_MODE_MANUAL, throwBadCursor, getNextCursor, snapshotTrigger, CursorFilter, TimestampFilter, isTimestampFilter, isCursorFilter, EventsWithCursor, EventFilter, Adapter, AdapterPoolConnectedProps, AdapterPoolConnected, AdapterPoolPossiblyUnconnected, AdapterConfig, ImportOptions, ExportOptions, SecretFilter, SecretsWithIdx, SecretRecord, };

types/types.d.ts

@@ -0,2 +1,5 @@
+/// <reference types="node" />
 import { SecretsManager } from 'resolve-core';
+import stream from 'stream';
+import { MAINTENANCE_MODE_AUTO, MAINTENANCE_MODE_MANUAL } from './constants';
 export declare type CheckForResourceError = (errors: Error[]) => void;
@@ -28,2 +31,15 @@ declare type PropType<TObj, TProp extends keyof TObj> = TObj[TProp];
 export declare type EventFilter = TimestampFilter | CursorFilter;
+export declare type SecretFilter = {
+    idx?: number | null;
+    limit: number;
+};
+export declare type SecretsWithIdx = {
+    idx: number | null;
+    secrets: SecretRecord[];
+};
+export declare type SecretRecord = {
+    idx: number;
+    id: string;
+    secret: string;
+};
 export declare function isTimestampFilter(filter: EventFilter): filter is TimestampFilter;
@@ -56,2 +72,8 @@ export declare function isCursorFilter(filter: EventFilter): filter is CursorFilter;
     shapeEvent: ShapeEvent;
+    initEvents: () => Promise<any[]>;
+    initSecrets: () => Promise<any[]>;
+    initFinal: () => Promise<any[]>;
+    dropEvents: () => Promise<any[]>;
+    dropSecrets: () => Promise<any[]>;
+    dropFinal: () => Promise<any[]>;
 };
@@ -69,2 +91,17 @@ export declare type AdapterPoolPossiblyUnconnected<ConnectedProps> = AdapterPoolPrimalProps & Partial<ConnectedProps>;
 export declare type Dispose<ConnectedProps extends AdapterPoolConnectedProps> = (pool: AdapterPoolConnected<ConnectedProps>) => Promise<void>;
+declare type MAINTENANCE_MODE = typeof MAINTENANCE_MODE_AUTO | typeof MAINTENANCE_MODE_MANUAL;
+export declare type ImportOptions = {
+    byteOffset: number;
+    maintenanceMode: MAINTENANCE_MODE;
+};
+export declare type ExportOptions = {
+    cursor: string | null;
+    maintenanceMode: MAINTENANCE_MODE;
+    bufferSize: number;
+};
+export declare type ExportSecretsOptions = {
+    idx: number | null;
+};
+export declare type GetImportStream<ConnectedProps extends AdapterPoolConnectedProps> = (pool: AdapterPoolPossiblyUnconnected<ConnectedProps>, options?: Partial<ImportOptions>) => stream.Writable;
+export declare type GetExportStream<ConnectedProps extends AdapterPoolConnectedProps> = (pool: AdapterPoolPossiblyUnconnected<ConnectedProps>, options?: Partial<ExportOptions>) => stream.Readable;
 export interface CommonAdapterFunctions<ConnectedProps extends AdapterPoolConnectedProps> {
@@ -77,6 +114,10 @@ maybeThrowResourceError: CheckForResourceError;
     loadEvents: LoadEvents<ConnectedProps>;
-    importStream: any;
-    exportStream: any;
+    importEventsStream: GetImportStream<ConnectedProps>;
+    exportEventsStream: GetExportStream<ConnectedProps>;
     incrementalImport: IncrementImport<ConnectedProps>;
     getNextCursor: GetNextCursor;
+    importSecretsStream: (pool: AdapterPoolPossiblyUnconnected<ConnectedProps>) => stream.Writable;
+    exportSecretsStream: (pool: AdapterPoolPossiblyUnconnected<ConnectedProps>, options?: Partial<ExportSecretsOptions>) => stream.Readable;
+    init: (pool: AdapterPoolConnected<ConnectedProps>) => Promise<void>;
+    drop: (pool: AdapterPoolConnected<ConnectedProps>) => Promise<void>;
 }
@@ -89,6 +130,4 @@ export interface AdapterFunctions<ConnectedProps extends AdapterPoolConnectedProps, ConnectionDependencies extends any, Config extends AdapterConfig, AdapterPool = AdapterPoolConnected<ConnectedProps>> {
     dropSnapshot: (pool: AdapterPool, snapshotKey: string) => Promise<any>;
-    drop: (pool: AdapterPool) => Promise<any>;
     freeze: (pool: AdapterPool) => Promise<void>;
     getLatestEvent: (pool: AdapterPool, filter: EventFilter) => Promise<any>;
-    init: (pool: AdapterPool) => Promise<any>;
     injectEvent: (pool: AdapterPool, event: any) => Promise<any>;
@@ -108,11 +147,19 @@ loadEventsByCursor: (pool: AdapterPool, filter: CursorFilter) => Promise<EventsWithCursor>;
     deleteSecret: (pool: AdapterPool, selector: string) => Promise<void>;
+    loadSecrets?: (pool: AdapterPool, filter: SecretFilter) => Promise<SecretsWithIdx>;
+    injectSecret?: (pool: AdapterPool, secretRecord: SecretRecord) => Promise<void>;
+    initEvents: (pool: AdapterPool) => Promise<any[]>;
+    initSecrets: (pool: AdapterPool) => Promise<any[]>;
+    initFinal: (pool: AdapterPool) => Promise<any[]>;
+    dropEvents: (pool: AdapterPool) => Promise<any[]>;
+    dropSecrets: (pool: AdapterPool) => Promise<any[]>;
+    dropFinal: (pool: AdapterPool) => Promise<any[]>;
 }
 export interface Adapter {
     loadEvents: (filter: EventFilter) => Promise<EventsWithCursor>;
-    import: (options: any) => any;
-    export: (options: any) => any;
+    importEvents: (options?: Partial<ImportOptions>) => stream.Writable;
+    exportEvents: (options?: Partial<ExportOptions>) => stream.Readable;
     getLatestEvent: (filter: EventFilter) => Promise<any>;
     saveEvent: (event: any) => Promise<any>;
-    init: () => Promise<any>;
-    drop: () => Promise<any>;
+    init: () => Promise<void>;
+    drop: () => Promise<void>;
     dispose: () => Promise<any>;
@@ -131,3 +178,7 @@ freeze: () => Promise<void>;
     incrementalImport: (events: any[]) => Promise<void>;
+    loadSecrets?: (filter: SecretFilter) => Promise<SecretsWithIdx>;
+    injectSecret?: (secretRecord: SecretRecord) => Promise<void>;
+    importSecrets: () => stream.Writable;
+    exportSecrets: (options?: Partial<ExportSecretsOptions>) => stream.Readable;
 }
 export {};

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses eval() which is a dangerous function. This prevents the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

296267

increased by1754.91%

Number of package files

121

increased by426.09%

Lines of code

2558

increased by1012.17%

Worsened metrics

Number of medium supply chain risk alerts

3

increased by200%

Dependency changes

• + Addedresolve-core@0.27.7-alpha(transitive)

• + Addedresolve-debug-levels@0.27.7-alpha(transitive)

• - Removedresolve-core@0.27.6-alpha(transitive)

• - Removedresolve-debug-levels@0.27.6-alpha(transitive)

• Updatedresolve-core@0.27.7-alpha

• Updatedresolve-debug-levels@0.27.7-alpha