@emuanalytics/flow-engine-client 2.1.0 → 2.2.0

package/dist/index.d.mts

@@ -0,0 +1,668 @@
+import Debug from 'debug';
+import { Socket, ManagerOptions, SocketOptions } from 'socket.io-client';
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+interface IQuery {
+    filter?: {
+        [key: string]: any;
+    };
+    attributes?: string | string[];
+    join?: string | string[];
+    limit?: number;
+    offset?: number;
+    sort?: string | string[];
+}
+interface IBaseResource {
+    id: string;
+}
+interface IMetadata {
+    [key: string]: any;
+}
+interface IPermissions {
+    [key: string]: {
+        [key: string]: string;
+    };
+}
+interface IApiKey extends IBaseResource {
+    applicationId: string;
+    application?: IApplication;
+    id: string;
+    description: string;
+    type: 'app' | 'master';
+    permissions: IPermissions;
+    metadata: IMetadata;
+    userId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface IApplication extends IBaseResource {
+    id: string;
+    name: string;
+    databases?: IDatabase[];
+    description: string;
+    contact: string;
+    metadata: IMetadata;
+    createdAt: string;
+    updatedAt: string;
+}
+interface IAppConfig extends IBaseResource {
+    applicationId: string;
+    config: object;
+}
+interface IDatabase extends IBaseResource {
+    applicationId: string;
+    application?: IApplication;
+    id: string;
+    type: string;
+    name: string;
+    default: boolean;
+    description: string;
+    host: string;
+    port: number;
+    user: string;
+    password: string;
+    db: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface IDatasetAttribute {
+    attribute: string;
+    type: string;
+    dbType: string;
+    isGeometry?: boolean;
+    srid?: number;
+    extent?: number[];
+    extentLngLat?: number[];
+    primaryKey?: boolean;
+    default?: string;
+    nullable?: boolean;
+    description?: string;
+}
+interface IDataset extends IBaseResource {
+    applicationId: string;
+    application?: IApplication;
+    id: string;
+    type: 'table' | 'sql';
+    source: string;
+    name: string;
+    databaseId: string;
+    database?: IDatabase;
+    description: string;
+    bytes: number;
+    metadata: IMetadata;
+    ownerId: string;
+    createdAt: string;
+    updatedAt: string;
+    attributes: IDatasetAttribute[];
+    options?: {
+        [key: string]: any;
+    };
+}
+interface IMapLayer extends IBaseResource {
+    applicationId: string;
+    application?: IApplication;
+    ownerId: string;
+    createdAt: string;
+    updatedAt: string;
+    id: string;
+    name: string;
+    description: string;
+    layerSpec: any;
+    type: string;
+    group: string;
+    metadata: IMetadata;
+}
+type FileExportFormat = 'geojson' | 'gpkg' | 'shapefile';
+interface ITileSource extends IBaseResource {
+    applicationId: string;
+    application?: IApplication;
+    metadata: IMetadata;
+    id: string;
+    type: string;
+    source: string;
+    attribution: string;
+    minZoom: number;
+    maxZoom: number;
+    headers: {
+        [key: string]: string;
+    };
+    extentLngLat: number[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface IUpload extends IBaseResource {
+    id: string;
+    fileName: string;
+    path: string;
+    options: {
+        name: string;
+        description?: string;
+        datasetId: string;
+        attribution?: string;
+        schema?: string;
+    };
+    size: number;
+    status: string;
+    error: {
+        message: string;
+        stdout: string;
+        stderr: string;
+    };
+    applicationId: string;
+    application?: IApplication;
+    ownerId: string;
+    updatedAt: string;
+    createdAt: string;
+}
+interface IUser extends IBaseResource {
+    [key: string]: any;
+}
+interface IStyle extends IBaseResource {
+    [key: string]: any;
+}
+interface ITileSpec {
+    [key: string]: any;
+}
+interface IConfig {
+    version: {
+        tag: string;
+        hash: string;
+        timestamp: number;
+    };
+}
+interface ILoginResponse {
+    accessToken: string;
+    refreshToken: string;
+}
+interface ITokenRefreshResponse {
+    accessToken: string;
+}
+interface UsersMeResponse {
+    applicationId: string;
+    email: string;
+    firstName: string;
+    id: string;
+    lastName: string;
+    metadata: object;
+    roles: string[];
+}
+type JobStatus = 'pending' | 'processing' | 'done' | 'cancelled' | 'error';
+interface IJob {
+    id: string;
+    applicationId: string;
+    ownerId?: string;
+    metadata: IMetadata;
+    type: string;
+    name?: string;
+    description?: string;
+    params: any;
+    status: JobStatus;
+    error?: object;
+    progress?: number;
+    progressText?: string;
+    datasetId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface IJobStatus {
+    status?: JobStatus;
+    error?: object;
+    progress?: number;
+    progressText?: string;
+}
+interface IJobSubmission {
+    type: string;
+    name?: string;
+    description?: string;
+    params: any;
+}
+interface IJobRequest {
+    type: string;
+}
+type IngestAction = 'insert' | 'upsert' | 'delete';
+interface IIngestMessage {
+    datasetId: string;
+    action: IngestAction;
+    data: any;
+}
+interface IPipeline extends IBaseResource {
+    applicationId: string;
+    application?: IApplication;
+    id: string;
+    environment: string;
+    description: string;
+    config: Record<string, any>;
+    metadata: IMetadata;
+    startedAt: string;
+    heartbeatAt: string;
+    createdAt: string;
+    updatedAt: string;
+    components?: IPipelineComponent[];
+}
+interface IPipelineComponent extends IBaseResource {
+    id: string;
+    description: string;
+    config: Record<string, any>;
+    class: string;
+    type: string;
+    metadata: IMetadata;
+    index: number;
+    createdAt: string;
+    updatedAt: string;
+    metrics?: IPipelineMetric[];
+}
+interface IPipelineMetric extends IBaseResource {
+    id: string;
+    applicationId: string;
+    pipelineId: string;
+    componentId: string;
+    name: string;
+    type: string;
+    timestamp: string;
+    value: number;
+    labels: Record<string, string>;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Contact point resource.
+ */
+interface IContactPoint extends IBaseResource {
+    id: string;
+    applicationId: string;
+    type: string;
+    description: string;
+    templates: string[];
+    recipients: string[];
+    /** Driver-specific host configuration for the contact point */
+    host: string;
+    /** Driver-specific port configuration for the contact point */
+    port: number;
+    /** Driver-specific user configuration for the contact point */
+    user: string;
+    /** Driver-specific password configuration for the contact point */
+    password: string;
+    metadata: IMetadata;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Request body for sending a notification to a contact point.
+ */
+interface IContactPointSendRequest {
+    /** ID of the template to use for the notification */
+    template?: string;
+    /** Subject of the notification */
+    subject?: string;
+    /** Recipients of the notification */
+    recipients?: string[];
+    /** Template key/value data for expanding the notification template */
+    data?: any;
+}
+/**
+ * Media resource.
+ */
+interface IMedia extends IBaseResource {
+    id: string;
+    applicationId: string;
+    type: string;
+    mimeType: string;
+    fileName: string;
+    metadata: IMetadata;
+    createdAt: string;
+    updatedAt: string;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class BaseEndpoints<T extends IBaseResource> {
+    protected readonly client: Client;
+    private readonly resourcePath;
+    constructor(client: Client, resourcePath: string);
+    protected get resourceEndpoint(): string;
+    list(params?: IQuery): Promise<T[]>;
+    get(id: string, params?: Record<string, any>): Promise<T>;
+    create(data: Partial<T>, params?: Record<string, any>): Promise<T>;
+    update(id: string, data: Partial<T>, params?: Record<string, any>): Promise<T>;
+    delete(id: string, params?: Record<string, any>): Promise<any>;
+    getMetadata(id: string, key?: string, params?: Record<string, any>): Promise<any>;
+    setMetadata(id: string, key: string, value: any, params?: Record<string, any>): Promise<any>;
+    deleteMetadata(id: string, key: string, params?: Record<string, any>): Promise<any>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class ApiKeyEndpoints extends BaseEndpoints<IApiKey> {
+    constructor(client: Client);
+}
+
+declare enum WebSocketChannel {
+    System = "system",
+    AppConfig = "appconfig",
+    Dataset = "dataset/"
+}
+interface WebSocketPublishMessage {
+    channel: string;
+    messageType?: string;
+    payload: unknown;
+}
+interface WebSocketSubscribeMessage {
+    channel: string;
+}
+interface WebSocketErrorResponse {
+    status: 'error';
+    code: string;
+    message: string;
+}
+interface WebSocketOkResponse {
+    status: 'ok';
+}
+type WebSocketResponse = WebSocketOkResponse | WebSocketErrorResponse;
+type WebSocketManagerOptions = Partial<ManagerOptions & SocketOptions>;
+type WebSocketSubscribeCallback = (err: Error | null, msg?: WebSocketPublishMessage) => void;
+type WebSocketUnsubscribeCallback = (err: Error | null) => void;
+type WebSocketUnsubscriber = (cb?: WebSocketUnsubscribeCallback) => void;
+declare class WebSocketGateway {
+    readonly client: Client;
+    private readonly options?;
+    private connected;
+    private subscribedChannels;
+    socket: Socket;
+    get isConnected(): boolean;
+    constructor(client: Client, options?: WebSocketManagerOptions | undefined);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    subscribe(channel: string, cb: WebSocketSubscribeCallback): WebSocketUnsubscriber;
+    unsubscribe(channel: string, cb?: WebSocketUnsubscribeCallback): void;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class AppConfigEndpoints {
+    private readonly client;
+    constructor(client: Client);
+    private get resourceEndpoint();
+    get(path?: string, params?: Record<string, any>): Promise<any>;
+    set(path: string | null, value: any, params?: Record<string, any>): Promise<any>;
+    delete(path: string, params?: Record<string, any>): Promise<any>;
+    subscribe(cb: WebSocketSubscribeCallback): WebSocketUnsubscriber;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class ApplicationEndpoints extends BaseEndpoints<IApplication> {
+    constructor(client: Client);
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class UserEndpoint extends BaseEndpoints<IUser> {
+    constructor(client: Client);
+    me(token: string): Promise<UsersMeResponse>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class AuthEndpoints {
+    private readonly client;
+    users: UserEndpoint;
+    constructor(client: Client);
+    login(email: string, password: string, applicationId?: string): Promise<ILoginResponse>;
+    logout(accessToken: string, refreshToken: string): Promise<void>;
+    refresh(refreshToken: string, applicationId: string): Promise<ITokenRefreshResponse>;
+    changePassword(password: string, newPassword: string, token: string): Promise<void>;
+    signUp(firstName: string, lastName: string, email: string, password: string, applicationId: string, confirmUrl: string, redirectUrl?: string): Promise<void>;
+    confirmSignUp(email: string, token: string, redirect?: string): Promise<void>;
+    requestPasswordReset(email: string, applicationId: string, redirectUrl: string): Promise<void>;
+    resetPassword(email: string, password: string, applicationId: string, token: string): Promise<void>;
+}
+
+/**
+ * Copyright © 2018-present Emu Analytics
+ */
+
+declare class ContactPointEndpoints extends BaseEndpoints<IContactPoint> {
+    constructor(client: Client);
+    /**
+     * Send a notification to a contact point.
+     */
+    send(contactPointId: string, params?: IContactPointSendRequest): Promise<void>;
+    /**
+     * Get a list of available contact point drivers. Supported types include 'email', 'slack', 'teams', 'sns'.
+     *
+     * Drivers have different required parameters - refer to documentation for details.
+     */
+    drivers(): Promise<string[]>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class DatabaseEndpoints extends BaseEndpoints<IDatabase> {
+    constructor(client: Client);
+    drivers(): Promise<string[]>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+interface DatasetQuery {
+    [key: string]: any;
+}
+type QueryOutputFormat = 'plain' | 'json' | 'csv' | 'geojson';
+interface DatasetQueryOptions {
+    [param: string]: any;
+    format?: QueryOutputFormat;
+    explain?: boolean | string;
+    abortController?: AbortController;
+}
+declare class DatasetEndpoints extends BaseEndpoints<IDataset> {
+    constructor(client: Client);
+    query(datasetId: string | DatasetQuery, query?: DatasetQuery, params?: DatasetQueryOptions | QueryOutputFormat): Promise<any>;
+    ingest(ingestMessage: IIngestMessage, params?: Record<string, any>): Promise<any>;
+    getExportUrl(datasetId: string, format: FileExportFormat): string;
+    subscribe(datasetId: string, cb: WebSocketSubscribeCallback): WebSocketUnsubscriber;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class JobEndpoints extends BaseEndpoints<IJob> {
+    constructor(client: Client);
+    submit(submission: IJobSubmission): Promise<IJob>;
+    getStatus(jobId: string): Promise<IJobStatus>;
+    setStatus(jobId: string, status: IJobStatus): Promise<IJob>;
+    cancel(jobId: string): Promise<IJob>;
+    request(jobType: string): Promise<IJob>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class MapEndpoints {
+    private readonly client;
+    constructor(client: Client);
+    get(id: string, params?: Record<string, any>): Promise<IStyle>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class MapLayerEndpoints extends BaseEndpoints<IMapLayer> {
+    constructor(client: Client);
+    subscribe(cb: WebSocketSubscribeCallback): WebSocketUnsubscriber;
+}
+
+/**
+ * Copyright © 2018-present Emu Analytics
+ */
+
+interface IMediaUploadRequest {
+    type: string;
+    mimeType?: string;
+    metadata?: IMetadata;
+    fileName: string;
+    data: any;
+}
+declare class MediaEndpoints extends BaseEndpoints<IMedia> {
+    constructor(client: Client);
+    upload(mediaId: string, request: IMediaUploadRequest, params?: Record<string, any>): Promise<IMedia>;
+    content(mediaId: string): Promise<any>;
+}
+
+/**
+ * Copyright © 2018-present Emu Analytics
+ */
+
+declare class PipelineMetricEndpoints extends BaseEndpoints<IPipelineMetric> {
+    constructor(client: Client, pipelineId: string, componentId: string);
+}
+
+/**
+ * Copyright © 2018-present Emu Analytics
+ */
+
+declare class PipelineComponentEndpoints extends BaseEndpoints<IPipelineComponent> {
+    private pipelineId;
+    constructor(client: Client, pipelineId: string);
+    metrics(componentId: string): PipelineMetricEndpoints;
+}
+
+/**
+ * Copyright © 2018-present Emu Analytics
+ */
+
+declare class PipelineEndpoints extends BaseEndpoints<IPipeline> {
+    constructor(client: Client);
+    components(pipelineId: string): PipelineComponentEndpoints;
+    heartbeat(id: string, params?: Record<string, any>): Promise<void>;
+    publishMetrics(metrics: object, params?: Record<string, any>): Promise<void>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class StyleEndpoints extends BaseEndpoints<IStyle> {
+    constructor(client: Client);
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class TileSourceEndpoints extends BaseEndpoints<ITileSource> {
+    constructor(client: Client);
+    drivers(): Promise<string[]>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+declare class TileEndpoints {
+    private readonly client;
+    constructor(client: Client);
+    getTileSpec(tilesourceId: string, params?: Record<string, any>): Promise<ITileSpec>;
+    getPreviewStyle(tilesourceId: string, params?: Record<string, any>): Promise<ITileSpec>;
+}
+
+interface UploadOptions {
+    data: any;
+    filename: string;
+    datasetId?: string;
+    datasetName?: string;
+    datasetDescription?: string;
+    attribution?: string;
+    sourceSrid?: number;
+    targetSrid?: number;
+    schema?: string;
+    metadata?: any;
+    abortController?: AbortController;
+    progress?: (event: any) => void;
+}
+declare class UploadEndpoints extends BaseEndpoints<IUpload> {
+    constructor(client: Client);
+    upload(options: UploadOptions, params?: Record<string, any>): Promise<IUpload>;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+
+type ClientOptions = WebSocketManagerOptions;
+declare class Client {
+    baseUrl: string;
+    readonly apiKey: string | null;
+    private readonly axios;
+    readonly debug: Debug.Debugger;
+    webSocketGateway: WebSocketGateway;
+    accessToken: string | null;
+    auth: AuthEndpoints;
+    tiles: TileEndpoints;
+    maps: MapEndpoints;
+    apiKeys: ApiKeyEndpoints;
+    applications: ApplicationEndpoints;
+    appconfig: AppConfigEndpoints;
+    contactpoints: ContactPointEndpoints;
+    databases: DatabaseEndpoints;
+    datasets: DatasetEndpoints;
+    styles: StyleEndpoints;
+    tileSources: TileSourceEndpoints;
+    uploads: UploadEndpoints;
+    jobs: JobEndpoints;
+    maplayers: MapLayerEndpoints;
+    media: MediaEndpoints;
+    pipelines: PipelineEndpoints;
+    useRequestInterceptor(interceptor: (config: any) => any): number;
+    ejectRequestInterceptor(id: number): void;
+    constructor(baseUrl: string, apiKey?: string | null, options?: ClientOptions);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    config(): Promise<IConfig>;
+    _get(path: string, options?: any): Promise<any>;
+    _post(path: string, data: object, options?: any): Promise<any>;
+    _put(path: string, data: object, options?: any): Promise<any>;
+    _delete(path: string, options?: any): Promise<any>;
+    _subscribe(channel: string, cb: WebSocketSubscribeCallback): WebSocketUnsubscriber;
+    _unsubscribe(channel: string, cb?: WebSocketUnsubscribeCallback): void;
+    /**
+     * Normalize errors
+     * Throws a new error based on type of input error
+     *
+     * @param {AxiosError} e
+     */
+    private handleError;
+    private headers;
+}
+
+/**
+ * Copyright © 2018 Emu Analytics
+ */
+declare class FlowEngineError extends Error {
+    error: object | null;
+    statusCode: number;
+    constructor(message: string, underlyingError?: Error | null, statusCode?: number);
+}
+
+export { BaseEndpoints, Client, FlowEngineError, WebSocketChannel, WebSocketGateway };
+export type { ClientOptions, FileExportFormat, IApiKey, IAppConfig, IApplication, IBaseResource, IConfig, IContactPoint, IContactPointSendRequest, IDatabase, IDataset, IDatasetAttribute, IIngestMessage, IJob, IJobRequest, IJobStatus, IJobSubmission, ILoginResponse, IMapLayer, IMedia, IMetadata, IPermissions, IPipeline, IPipelineComponent, IPipelineMetric, IQuery, IStyle, ITileSource, ITileSpec, ITokenRefreshResponse, IUpload, IUser, IngestAction, JobStatus, UsersMeResponse, WebSocketErrorResponse, WebSocketManagerOptions, WebSocketOkResponse, WebSocketPublishMessage, WebSocketResponse, WebSocketSubscribeCallback, WebSocketSubscribeMessage, WebSocketUnsubscribeCallback, WebSocketUnsubscriber };