@flowcore/data-pump 0.9.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.11.0](https://github.com/flowcore-io/data-pump/compare/v0.10.0...v0.11.0) (2025-04-14)
+
+
+### Features
+
+* **data-pump:** :sparkles: enhance FlowcoreDataSource with detailed JSDoc comments ([1e3308d](https://github.com/flowcore-io/data-pump/commit/1e3308d6c1aca7da47c96650f0b1e9ef9c8b7c8a))
+
+## [0.10.0](https://github.com/flowcore-io/data-pump/compare/v0.9.0...v0.10.0) (2025-04-14)
+
+
+### Features
+
+* **data-pump:** :sparkles: export data source module ([6208e42](https://github.com/flowcore-io/data-pump/commit/6208e42bbf59e67d70235833a08d6e116b29dc60))
+
 ## [0.9.0](https://github.com/flowcore-io/data-pump/compare/v0.8.3...v0.9.0) (2025-04-14)
 
 

package/esm/data-pump/data-source.d.ts

@@ -1,32 +1,116 @@
-import { type FlowcoreEvent } from "../deps/jsr.io/@flowcore/sdk/1.26.3/src/mod.js";
+/**
+ * @module data-source
+ * @description Provides functionality to interact with Flowcore data sources
+ */
+import { type FlowcoreClient, type FlowcoreEvent } from "../deps/jsr.io/@flowcore/sdk/1.26.3/src/mod.js";
 import type { FlowcoreDataPumpAuth, FlowcoreDataPumpDataSource, FlowcoreDataPumpState } from "./types.js";
+/**
+ * Options for configuring a Flowcore data source
+ * @interface FlowcoreDataSourceOptions
+ */
 export interface FlowcoreDataSourceOptions {
+    /** Authentication information for Flowcore */
     auth: FlowcoreDataPumpAuth;
+    /** Data source configuration */
     dataSource: FlowcoreDataPumpDataSource;
+    /** Optional base URL override for the Flowcore API */
     baseUrlOverride?: string;
+    /** When true, disables name-to-ID translation for tenant, dataCore, flowType, and eventTypes */
     noTranslation?: boolean;
+    /** When true, executes commands in direct mode */
     directMode?: boolean;
 }
+/**
+ * Provides methods to interact with a Flowcore data source
+ * @class FlowcoreDataSource
+ */
 export declare class FlowcoreDataSource {
-    private readonly options;
-    private flowcoreClient;
-    private tenantId?;
-    private dataCoreId?;
-    private flowTypeId?;
-    private eventTypeIds?;
-    private timeBuckets?;
+    protected readonly options: FlowcoreDataSourceOptions;
+    /** Flowcore client instance */
+    protected flowcoreClient: FlowcoreClient;
+    /** Cached tenant ID */
+    protected tenantId?: string;
+    /** Cached data core ID */
+    protected dataCoreId?: string;
+    /** Cached flow type ID */
+    protected flowTypeId?: string;
+    /** Cached event type IDs */
+    protected eventTypeIds?: string[];
+    /** Cached time buckets */
+    protected timeBuckets?: string[];
+    /**
+     * Creates a new FlowcoreDataSource instance
+     * @param options - Configuration options for the data source
+     */
     constructor(options: FlowcoreDataSourceOptions);
+    /**
+     * Gets the tenant name from the data source configuration
+     * @returns Tenant name
+     */
     get tenant(): string;
+    /**
+     * Gets the data core name from the data source configuration
+     * @returns Data core name
+     */
     get dataCore(): string;
+    /**
+     * Gets the flow type name from the data source configuration
+     * @returns Flow type name
+     */
     get flowType(): string;
+    /**
+     * Gets the event type names from the data source configuration
+     * @returns Array of event type names
+     */
     get eventTypes(): string[];
+    /**
+     * Gets the tenant ID, translating from name if necessary
+     * @returns Promise that resolves to the tenant ID
+     */
     getTenantId(): Promise<string>;
+    /**
+     * Gets the data core ID, translating from name if necessary
+     * @returns Promise that resolves to the data core ID
+     */
     getDataCoreId(): Promise<string>;
+    /**
+     * Gets the flow type ID, translating from name if necessary
+     * @returns Promise that resolves to the flow type ID
+     */
     getFlowTypeId(): Promise<string>;
+    /**
+     * Gets the event type IDs, translating from names if necessary
+     * @returns Promise that resolves to an array of event type IDs
+     * @throws Error if an event type is not found
+     */
     getEventTypeIds(): Promise<string[]>;
+    /**
+     * Gets all time buckets for the configured event types
+     * @param force - When true, forces a refresh of cached time buckets
+     * @returns Promise that resolves to an array of time bucket strings
+     */
     getTimeBuckets(force?: boolean): Promise<string[]>;
+    /**
+     * Gets the next time bucket after the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @returns Promise that resolves to the next time bucket, or null if none exists
+     */
     getNextTimeBucket(timeBucket: string): Promise<string | null>;
+    /**
+     * Gets the closest time bucket to the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @param getBefore - When true, gets the closest time bucket before the reference
+     * @returns Promise that resolves to the closest time bucket, or null if none exists
+     * @throws Error if the time bucket format is invalid
+     */
     getClosestTimeBucket(timeBucket: string, getBefore?: boolean): Promise<string | null>;
+    /**
+     * Gets events from the data source starting from a specific state
+     * @param from - The state to start from (includes timeBucket and eventId)
+     * @param amount - Maximum number of events to retrieve
+     * @param toEventId - Optional ID to stop at when retrieving events
+     * @returns Promise that resolves to an array of Flowcore events
+     */
     getEvents(from: FlowcoreDataPumpState, amount: number, toEventId?: string): Promise<FlowcoreEvent[]>;
 }
 //# sourceMappingURL=data-source.d.ts.map

package/esm/data-pump/data-source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../src/data-pump/data-source.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,aAAa,EAInB,MAAM,gDAAgD,CAAA;AAEvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AACzG,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,oBAAoB,CAAA;IAC1B,UAAU,EAAE,0BAA0B,CAAA;IACtC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,qBAAa,kBAAkB;IAQjB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAPpC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAQ;IACzB,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAU;IAC/B,OAAO,CAAC,WAAW,CAAC,CAAU;gBAED,OAAO,EAAE,yBAAyB;IAI/D,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,UAAU,IAAI,MAAM,EAAE,CAEhC;IAEY,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAiB9B,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkBhC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkBhC,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAyBpC,cAAc,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwBhD,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAa7D,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAiBnF,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAelH"}
+{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../src/data-pump/data-source.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,aAAa,EAInB,MAAM,gDAAgD,CAAA;AAEvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEzG;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,8CAA8C;IAC9C,IAAI,EAAE,oBAAoB,CAAA;IAC1B,gCAAgC;IAChC,UAAU,EAAE,0BAA0B,CAAA;IACtC,sDAAsD;IACtD,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,gGAAgG;IAChG,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAkBjB,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,yBAAyB;IAjBjE,+BAA+B;IAC/B,SAAS,CAAC,cAAc,EAAE,cAAc,CAAA;IACxC,uBAAuB;IACvB,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC3B,0BAA0B;IAC1B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC7B,0BAA0B;IAC1B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC7B,4BAA4B;IAC5B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACjC,0BAA0B;IAC1B,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEhC;;;OAGG;gBAC4B,OAAO,EAAE,yBAAyB;IAIjE;;;OAGG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,MAAM,EAAE,CAEhC;IAED;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAiB3C;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkB7C;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkB7C;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAyBjD;;;;OAIG;IACU,cAAc,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwB7D;;;;OAIG;IACU,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAa1E;;;;;;OAMG;IACU,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAiBhG;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAelH"}

package/esm/data-pump/data-source.js

@@ -1,6 +1,18 @@
+/**
+ * @module data-source
+ * @description Provides functionality to interact with Flowcore data sources
+ */
 import { DataCoreFetchCommand, EventListCommand, EventTypeListCommand, FlowTypeFetchCommand, TenantTranslateNameToIdCommand, TimeBucketListCommand, } from "../deps/jsr.io/@flowcore/sdk/1.26.3/src/mod.js";
 import { getFlowcoreClient } from "./flowcore-client.js";
+/**
+ * Provides methods to interact with a Flowcore data source
+ * @class FlowcoreDataSource
+ */
 export class FlowcoreDataSource {
+    /**
+     * Creates a new FlowcoreDataSource instance
+     * @param options - Configuration options for the data source
+     */
     constructor(options) {
         Object.defineProperty(this, "options", {
             enumerable: true,
@@ -8,36 +20,42 @@ export class FlowcoreDataSource {
             writable: true,
             value: options
         });
+        /** Flowcore client instance */
         Object.defineProperty(this, "flowcoreClient", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached tenant ID */
         Object.defineProperty(this, "tenantId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached data core ID */
         Object.defineProperty(this, "dataCoreId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached flow type ID */
         Object.defineProperty(this, "flowTypeId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached event type IDs */
         Object.defineProperty(this, "eventTypeIds", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached time buckets */
         Object.defineProperty(this, "timeBuckets", {
             enumerable: true,
             configurable: true,
@@ -46,18 +64,38 @@ export class FlowcoreDataSource {
         });
         this.flowcoreClient = getFlowcoreClient(this.options.auth, this.options.baseUrlOverride);
     }
+    /**
+     * Gets the tenant name from the data source configuration
+     * @returns Tenant name
+     */
     get tenant() {
         return this.options.dataSource.tenant;
     }
+    /**
+     * Gets the data core name from the data source configuration
+     * @returns Data core name
+     */
     get dataCore() {
         return this.options.dataSource.dataCore;
     }
+    /**
+     * Gets the flow type name from the data source configuration
+     * @returns Flow type name
+     */
     get flowType() {
         return this.options.dataSource.flowType;
     }
+    /**
+     * Gets the event type names from the data source configuration
+     * @returns Array of event type names
+     */
     get eventTypes() {
         return this.options.dataSource.eventTypes;
     }
+    /**
+     * Gets the tenant ID, translating from name if necessary
+     * @returns Promise that resolves to the tenant ID
+     */
     async getTenantId() {
         if (this.tenantId) {
             return this.tenantId;
@@ -74,6 +112,10 @@ export class FlowcoreDataSource {
         }
         return this.tenantId;
     }
+    /**
+     * Gets the data core ID, translating from name if necessary
+     * @returns Promise that resolves to the data core ID
+     */
     async getDataCoreId() {
         if (this.dataCoreId) {
             return this.dataCoreId;
@@ -91,6 +133,10 @@ export class FlowcoreDataSource {
         }
         return this.dataCoreId;
     }
+    /**
+     * Gets the flow type ID, translating from name if necessary
+     * @returns Promise that resolves to the flow type ID
+     */
     async getFlowTypeId() {
         if (this.flowTypeId) {
             return this.flowTypeId;
@@ -108,6 +154,11 @@ export class FlowcoreDataSource {
         }
         return this.flowTypeId;
     }
+    /**
+     * Gets the event type IDs, translating from names if necessary
+     * @returns Promise that resolves to an array of event type IDs
+     * @throws Error if an event type is not found
+     */
     async getEventTypeIds() {
         if (this.eventTypeIds) {
             return this.eventTypeIds;
@@ -132,6 +183,11 @@ export class FlowcoreDataSource {
         }
         return this.eventTypeIds;
     }
+    /**
+     * Gets all time buckets for the configured event types
+     * @param force - When true, forces a refresh of cached time buckets
+     * @returns Promise that resolves to an array of time bucket strings
+     */
     async getTimeBuckets(force = false) {
         if (this.timeBuckets && !force) {
             return this.timeBuckets;
@@ -151,6 +207,11 @@ export class FlowcoreDataSource {
         this.timeBuckets = timeBuckets;
         return this.timeBuckets;
     }
+    /**
+     * Gets the next time bucket after the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @returns Promise that resolves to the next time bucket, or null if none exists
+     */
     async getNextTimeBucket(timeBucket) {
         const closestTimeBucket = await this.getClosestTimeBucket(timeBucket);
         if (!closestTimeBucket) {
@@ -163,6 +224,13 @@ export class FlowcoreDataSource {
         }
         return timeBuckets[index + 1] ?? null;
     }
+    /**
+     * Gets the closest time bucket to the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @param getBefore - When true, gets the closest time bucket before the reference
+     * @returns Promise that resolves to the closest time bucket, or null if none exists
+     * @throws Error if the time bucket format is invalid
+     */
     async getClosestTimeBucket(timeBucket, getBefore = false) {
         const timeBuckets = await this.getTimeBuckets();
         if (!timeBucket.match(/^\d{14}$/)) {
@@ -175,6 +243,13 @@ export class FlowcoreDataSource {
         return (timeBuckets.find((t) => Number.parseFloat(t) >= Number.parseFloat(timeBucket)) ??
             timeBuckets[timeBuckets.length - 1]);
     }
+    /**
+     * Gets events from the data source starting from a specific state
+     * @param from - The state to start from (includes timeBucket and eventId)
+     * @param amount - Maximum number of events to retrieve
+     * @param toEventId - Optional ID to stop at when retrieving events
+     * @returns Promise that resolves to an array of Flowcore events
+     */
     async getEvents(from, amount, toEventId) {
         const eventTypeIds = await this.getEventTypeIds();
         const result = await this.flowcoreClient.execute(new EventListCommand({

package/esm/mod.d.ts

@@ -2,6 +2,7 @@ import "./_dnt.polyfills.js";
 export * from "./lib/data-pump.js";
 export * from "./lib/data-pump-create.js";
 export * from "./data-pump/data-pump.js";
+export * from "./data-pump/data-source.js";
 export * from "./data-pump/metrics.js";
 export * from "./data-pump/types.js";
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AAEzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AAEzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA"}

package/esm/mod.js

@@ -2,5 +2,6 @@ import "./_dnt.polyfills.js";
 export * from "./lib/data-pump.js";
 export * from "./lib/data-pump-create.js";
 export * from "./data-pump/data-pump.js";
+export * from "./data-pump/data-source.js";
 export * from "./data-pump/metrics.js";
 export * from "./data-pump/types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowcore/data-pump",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Flowcore Data Pump",
   "homepage": "https://github.com/flowcore-io/flowcore-data-pump#readme",
   "repository": {

package/script/data-pump/data-source.d.ts

@@ -1,32 +1,116 @@
-import { type FlowcoreEvent } from "../deps/jsr.io/@flowcore/sdk/1.26.3/src/mod.js";
+/**
+ * @module data-source
+ * @description Provides functionality to interact with Flowcore data sources
+ */
+import { type FlowcoreClient, type FlowcoreEvent } from "../deps/jsr.io/@flowcore/sdk/1.26.3/src/mod.js";
 import type { FlowcoreDataPumpAuth, FlowcoreDataPumpDataSource, FlowcoreDataPumpState } from "./types.js";
+/**
+ * Options for configuring a Flowcore data source
+ * @interface FlowcoreDataSourceOptions
+ */
 export interface FlowcoreDataSourceOptions {
+    /** Authentication information for Flowcore */
     auth: FlowcoreDataPumpAuth;
+    /** Data source configuration */
     dataSource: FlowcoreDataPumpDataSource;
+    /** Optional base URL override for the Flowcore API */
     baseUrlOverride?: string;
+    /** When true, disables name-to-ID translation for tenant, dataCore, flowType, and eventTypes */
     noTranslation?: boolean;
+    /** When true, executes commands in direct mode */
     directMode?: boolean;
 }
+/**
+ * Provides methods to interact with a Flowcore data source
+ * @class FlowcoreDataSource
+ */
 export declare class FlowcoreDataSource {
-    private readonly options;
-    private flowcoreClient;
-    private tenantId?;
-    private dataCoreId?;
-    private flowTypeId?;
-    private eventTypeIds?;
-    private timeBuckets?;
+    protected readonly options: FlowcoreDataSourceOptions;
+    /** Flowcore client instance */
+    protected flowcoreClient: FlowcoreClient;
+    /** Cached tenant ID */
+    protected tenantId?: string;
+    /** Cached data core ID */
+    protected dataCoreId?: string;
+    /** Cached flow type ID */
+    protected flowTypeId?: string;
+    /** Cached event type IDs */
+    protected eventTypeIds?: string[];
+    /** Cached time buckets */
+    protected timeBuckets?: string[];
+    /**
+     * Creates a new FlowcoreDataSource instance
+     * @param options - Configuration options for the data source
+     */
     constructor(options: FlowcoreDataSourceOptions);
+    /**
+     * Gets the tenant name from the data source configuration
+     * @returns Tenant name
+     */
     get tenant(): string;
+    /**
+     * Gets the data core name from the data source configuration
+     * @returns Data core name
+     */
     get dataCore(): string;
+    /**
+     * Gets the flow type name from the data source configuration
+     * @returns Flow type name
+     */
     get flowType(): string;
+    /**
+     * Gets the event type names from the data source configuration
+     * @returns Array of event type names
+     */
     get eventTypes(): string[];
+    /**
+     * Gets the tenant ID, translating from name if necessary
+     * @returns Promise that resolves to the tenant ID
+     */
     getTenantId(): Promise<string>;
+    /**
+     * Gets the data core ID, translating from name if necessary
+     * @returns Promise that resolves to the data core ID
+     */
     getDataCoreId(): Promise<string>;
+    /**
+     * Gets the flow type ID, translating from name if necessary
+     * @returns Promise that resolves to the flow type ID
+     */
     getFlowTypeId(): Promise<string>;
+    /**
+     * Gets the event type IDs, translating from names if necessary
+     * @returns Promise that resolves to an array of event type IDs
+     * @throws Error if an event type is not found
+     */
     getEventTypeIds(): Promise<string[]>;
+    /**
+     * Gets all time buckets for the configured event types
+     * @param force - When true, forces a refresh of cached time buckets
+     * @returns Promise that resolves to an array of time bucket strings
+     */
     getTimeBuckets(force?: boolean): Promise<string[]>;
+    /**
+     * Gets the next time bucket after the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @returns Promise that resolves to the next time bucket, or null if none exists
+     */
     getNextTimeBucket(timeBucket: string): Promise<string | null>;
+    /**
+     * Gets the closest time bucket to the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @param getBefore - When true, gets the closest time bucket before the reference
+     * @returns Promise that resolves to the closest time bucket, or null if none exists
+     * @throws Error if the time bucket format is invalid
+     */
     getClosestTimeBucket(timeBucket: string, getBefore?: boolean): Promise<string | null>;
+    /**
+     * Gets events from the data source starting from a specific state
+     * @param from - The state to start from (includes timeBucket and eventId)
+     * @param amount - Maximum number of events to retrieve
+     * @param toEventId - Optional ID to stop at when retrieving events
+     * @returns Promise that resolves to an array of Flowcore events
+     */
     getEvents(from: FlowcoreDataPumpState, amount: number, toEventId?: string): Promise<FlowcoreEvent[]>;
 }
 //# sourceMappingURL=data-source.d.ts.map

package/script/data-pump/data-source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../src/data-pump/data-source.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,aAAa,EAInB,MAAM,gDAAgD,CAAA;AAEvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AACzG,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,oBAAoB,CAAA;IAC1B,UAAU,EAAE,0BAA0B,CAAA;IACtC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,qBAAa,kBAAkB;IAQjB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAPpC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAQ;IACzB,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAU;IAC/B,OAAO,CAAC,WAAW,CAAC,CAAU;gBAED,OAAO,EAAE,yBAAyB;IAI/D,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,UAAU,IAAI,MAAM,EAAE,CAEhC;IAEY,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAiB9B,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkBhC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkBhC,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAyBpC,cAAc,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwBhD,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAa7D,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAiBnF,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAelH"}
+{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../src/data-pump/data-source.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,aAAa,EAInB,MAAM,gDAAgD,CAAA;AAEvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEzG;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,8CAA8C;IAC9C,IAAI,EAAE,oBAAoB,CAAA;IAC1B,gCAAgC;IAChC,UAAU,EAAE,0BAA0B,CAAA;IACtC,sDAAsD;IACtD,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,gGAAgG;IAChG,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAkBjB,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,yBAAyB;IAjBjE,+BAA+B;IAC/B,SAAS,CAAC,cAAc,EAAE,cAAc,CAAA;IACxC,uBAAuB;IACvB,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC3B,0BAA0B;IAC1B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC7B,0BAA0B;IAC1B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC7B,4BAA4B;IAC5B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACjC,0BAA0B;IAC1B,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEhC;;;OAGG;gBAC4B,OAAO,EAAE,yBAAyB;IAIjE;;;OAGG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,MAAM,EAAE,CAEhC;IAED;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAiB3C;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkB7C;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAkB7C;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAyBjD;;;;OAIG;IACU,cAAc,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwB7D;;;;OAIG;IACU,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAa1E;;;;;;OAMG;IACU,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAiBhG;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAelH"}

package/script/data-pump/data-source.js

@@ -1,9 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowcoreDataSource = void 0;
+/**
+ * @module data-source
+ * @description Provides functionality to interact with Flowcore data sources
+ */
 const mod_js_1 = require("../deps/jsr.io/@flowcore/sdk/1.26.3/src/mod.js");
 const flowcore_client_js_1 = require("./flowcore-client.js");
+/**
+ * Provides methods to interact with a Flowcore data source
+ * @class FlowcoreDataSource
+ */
 class FlowcoreDataSource {
+    /**
+     * Creates a new FlowcoreDataSource instance
+     * @param options - Configuration options for the data source
+     */
     constructor(options) {
         Object.defineProperty(this, "options", {
             enumerable: true,
@@ -11,36 +23,42 @@ class FlowcoreDataSource {
             writable: true,
             value: options
         });
+        /** Flowcore client instance */
         Object.defineProperty(this, "flowcoreClient", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached tenant ID */
         Object.defineProperty(this, "tenantId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached data core ID */
         Object.defineProperty(this, "dataCoreId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached flow type ID */
         Object.defineProperty(this, "flowTypeId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached event type IDs */
         Object.defineProperty(this, "eventTypeIds", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Cached time buckets */
         Object.defineProperty(this, "timeBuckets", {
             enumerable: true,
             configurable: true,
@@ -49,18 +67,38 @@ class FlowcoreDataSource {
         });
         this.flowcoreClient = (0, flowcore_client_js_1.getFlowcoreClient)(this.options.auth, this.options.baseUrlOverride);
     }
+    /**
+     * Gets the tenant name from the data source configuration
+     * @returns Tenant name
+     */
     get tenant() {
         return this.options.dataSource.tenant;
     }
+    /**
+     * Gets the data core name from the data source configuration
+     * @returns Data core name
+     */
     get dataCore() {
         return this.options.dataSource.dataCore;
     }
+    /**
+     * Gets the flow type name from the data source configuration
+     * @returns Flow type name
+     */
     get flowType() {
         return this.options.dataSource.flowType;
     }
+    /**
+     * Gets the event type names from the data source configuration
+     * @returns Array of event type names
+     */
     get eventTypes() {
         return this.options.dataSource.eventTypes;
     }
+    /**
+     * Gets the tenant ID, translating from name if necessary
+     * @returns Promise that resolves to the tenant ID
+     */
     async getTenantId() {
         if (this.tenantId) {
             return this.tenantId;
@@ -77,6 +115,10 @@ class FlowcoreDataSource {
         }
         return this.tenantId;
     }
+    /**
+     * Gets the data core ID, translating from name if necessary
+     * @returns Promise that resolves to the data core ID
+     */
     async getDataCoreId() {
         if (this.dataCoreId) {
             return this.dataCoreId;
@@ -94,6 +136,10 @@ class FlowcoreDataSource {
         }
         return this.dataCoreId;
     }
+    /**
+     * Gets the flow type ID, translating from name if necessary
+     * @returns Promise that resolves to the flow type ID
+     */
     async getFlowTypeId() {
         if (this.flowTypeId) {
             return this.flowTypeId;
@@ -111,6 +157,11 @@ class FlowcoreDataSource {
         }
         return this.flowTypeId;
     }
+    /**
+     * Gets the event type IDs, translating from names if necessary
+     * @returns Promise that resolves to an array of event type IDs
+     * @throws Error if an event type is not found
+     */
     async getEventTypeIds() {
         if (this.eventTypeIds) {
             return this.eventTypeIds;
@@ -135,6 +186,11 @@ class FlowcoreDataSource {
         }
         return this.eventTypeIds;
     }
+    /**
+     * Gets all time buckets for the configured event types
+     * @param force - When true, forces a refresh of cached time buckets
+     * @returns Promise that resolves to an array of time bucket strings
+     */
     async getTimeBuckets(force = false) {
         if (this.timeBuckets && !force) {
             return this.timeBuckets;
@@ -154,6 +210,11 @@ class FlowcoreDataSource {
         this.timeBuckets = timeBuckets;
         return this.timeBuckets;
     }
+    /**
+     * Gets the next time bucket after the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @returns Promise that resolves to the next time bucket, or null if none exists
+     */
     async getNextTimeBucket(timeBucket) {
         const closestTimeBucket = await this.getClosestTimeBucket(timeBucket);
         if (!closestTimeBucket) {
@@ -166,6 +227,13 @@ class FlowcoreDataSource {
         }
         return timeBuckets[index + 1] ?? null;
     }
+    /**
+     * Gets the closest time bucket to the specified time bucket
+     * @param timeBucket - The reference time bucket
+     * @param getBefore - When true, gets the closest time bucket before the reference
+     * @returns Promise that resolves to the closest time bucket, or null if none exists
+     * @throws Error if the time bucket format is invalid
+     */
     async getClosestTimeBucket(timeBucket, getBefore = false) {
         const timeBuckets = await this.getTimeBuckets();
         if (!timeBucket.match(/^\d{14}$/)) {
@@ -178,6 +246,13 @@ class FlowcoreDataSource {
         return (timeBuckets.find((t) => Number.parseFloat(t) >= Number.parseFloat(timeBucket)) ??
             timeBuckets[timeBuckets.length - 1]);
     }
+    /**
+     * Gets events from the data source starting from a specific state
+     * @param from - The state to start from (includes timeBucket and eventId)
+     * @param amount - Maximum number of events to retrieve
+     * @param toEventId - Optional ID to stop at when retrieving events
+     * @returns Promise that resolves to an array of Flowcore events
+     */
     async getEvents(from, amount, toEventId) {
         const eventTypeIds = await this.getEventTypeIds();
         const result = await this.flowcoreClient.execute(new mod_js_1.EventListCommand({

package/script/mod.d.ts

@@ -2,6 +2,7 @@ import "./_dnt.polyfills.js";
 export * from "./lib/data-pump.js";
 export * from "./lib/data-pump-create.js";
 export * from "./data-pump/data-pump.js";
+export * from "./data-pump/data-source.js";
 export * from "./data-pump/metrics.js";
 export * from "./data-pump/types.js";
 //# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AAEzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AAEzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA"}

package/script/mod.js

@@ -18,5 +18,6 @@ require("./_dnt.polyfills.js");
 __exportStar(require("./lib/data-pump.js"), exports);
 __exportStar(require("./lib/data-pump-create.js"), exports);
 __exportStar(require("./data-pump/data-pump.js"), exports);
+__exportStar(require("./data-pump/data-source.js"), exports);
 __exportStar(require("./data-pump/metrics.js"), exports);
 __exportStar(require("./data-pump/types.js"), exports);