@transai/connector-runtime-sdk 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs +2 -0
- package/index.cjs.map +7 -0
- package/index.js +2 -0
- package/index.js.map +7 -0
- package/meta.cjs.json +250 -0
- package/meta.esm.json +252 -0
- package/package.json +1 -1
- package/src/lib/connector-runtime.d.ts +16 -0
- package/src/lib/connector-runtime.interface.d.ts +5 -0
- package/src/lib/sdk/files.sdk.interface.d.ts +18 -0
- package/src/lib/sdk/http-client.interface.d.ts +38 -0
- package/src/lib/sdk/logger.sdk.interface.d.ts +7 -0
- package/src/lib/sdk/offset-store.sdk.interface.d.ts +12 -0
- package/src/lib/sdk/processing.sdk.interface.d.ts +13 -0
- package/src/lib/sdk/receiver.sdk.interface.d.ts +14 -0
- package/src/lib/sdk/sdk.interface.d.ts +31 -0
- package/src/lib/sdk/sender.sdk.interface.d.ts +22 -0
- package/src/lib/sdk/telemetry.sdk.interface.d.ts +15 -0
- package/src/lib/sdk/templating.sdk.interface.d.ts +12 -0
- package/.eslintrc.json +0 -30
- package/CHANGELOG.md +0 -25
- package/README.md +0 -11
- package/jest.config.ts +0 -10
- package/project.json +0 -37
- package/src/lib/connector-runtime.interface.ts +0 -7
- package/src/lib/connector-runtime.spec.ts +0 -115
- package/src/lib/connector-runtime.ts +0 -119
- package/src/lib/sdk/files.sdk.interface.ts +0 -29
- package/src/lib/sdk/http-client.interface.ts +0 -110
- package/src/lib/sdk/logger.sdk.interface.ts +0 -11
- package/src/lib/sdk/offset-store.sdk.interface.ts +0 -14
- package/src/lib/sdk/processing.sdk.interface.ts +0 -20
- package/src/lib/sdk/receiver.sdk.interface.ts +0 -29
- package/src/lib/sdk/sdk.interface.ts +0 -42
- package/src/lib/sdk/sender.sdk.interface.ts +0 -34
- package/src/lib/sdk/telemetry.sdk.interface.ts +0 -12
- package/src/lib/sdk/templating.sdk.interface.ts +0 -16
- package/tsconfig.json +0 -16
- package/tsconfig.lib.json +0 -11
- package/tsconfig.spec.json +0 -14
- /package/src/{index.ts → index.d.ts} +0 -0
- /package/src/lib/sdk/{index.ts → index.d.ts} +0 -0
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
ActionInterface,
|
|
3
|
-
KafkaCallbackResponse,
|
|
4
|
-
KafkaCallbackResponseType,
|
|
5
|
-
XodJobType,
|
|
6
|
-
} from '@xip-online-data/types';
|
|
7
|
-
|
|
8
|
-
export interface ReceiverSDKInterface {
|
|
9
|
-
readonly responses: {
|
|
10
|
-
readonly ok: KafkaCallbackResponseType;
|
|
11
|
-
readonly created: KafkaCallbackResponseType;
|
|
12
|
-
readonly badRequest: KafkaCallbackResponseType;
|
|
13
|
-
readonly unprocessableEntity: KafkaCallbackResponseType;
|
|
14
|
-
readonly notFound: KafkaCallbackResponseType;
|
|
15
|
-
readonly internalServerError: KafkaCallbackResponseType;
|
|
16
|
-
};
|
|
17
|
-
|
|
18
|
-
registerCallback<T extends XodJobType = XodJobType>(
|
|
19
|
-
callbackFunction: (message: T) => Promise<KafkaCallbackResponse>,
|
|
20
|
-
eventType?: string,
|
|
21
|
-
identifier?: string,
|
|
22
|
-
): void;
|
|
23
|
-
|
|
24
|
-
getActionConfig(message: XodJobType): ActionInterface | null;
|
|
25
|
-
|
|
26
|
-
emitEventType<T extends XodJobType = XodJobType>(
|
|
27
|
-
callbackFunction: (message: T) => Promise<KafkaCallbackResponse>,
|
|
28
|
-
): (message: T) => Promise<KafkaCallbackResponse>;
|
|
29
|
-
}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import { BaseConnectorConfig } from '@xip-online-data/types';
|
|
2
|
-
|
|
3
|
-
import { FilesSDKInterface } from './files.sdk.interface';
|
|
4
|
-
import { HttpClientSDKInterface, HttpConfig } from './http-client.interface';
|
|
5
|
-
import { LoggerSDKInterface } from './logger.sdk.interface';
|
|
6
|
-
import { OffsetStoreSDKInterface } from './offset-store.sdk.interface';
|
|
7
|
-
import { ProcessingSDKInterface } from './processing.sdk.interface';
|
|
8
|
-
import { ReceiverSDKInterface } from './receiver.sdk.interface';
|
|
9
|
-
import { SenderSDKInterface } from './sender.sdk.interface';
|
|
10
|
-
import { TelemetrySDKInterface } from './telemetry.sdk.interface';
|
|
11
|
-
import { TemplatingSDKInterface } from './templating.sdk.interface';
|
|
12
|
-
|
|
13
|
-
export interface ConnectorSDKInterface<T = BaseConnectorConfig> {
|
|
14
|
-
get config(): T;
|
|
15
|
-
|
|
16
|
-
get logger(): LoggerSDKInterface;
|
|
17
|
-
|
|
18
|
-
get sender(): SenderSDKInterface;
|
|
19
|
-
|
|
20
|
-
get receiver(): ReceiverSDKInterface;
|
|
21
|
-
|
|
22
|
-
get templating(): TemplatingSDKInterface;
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* Service to schedule and manage processing tasks that need monitoring and retries.
|
|
26
|
-
*/
|
|
27
|
-
get processing(): ProcessingSDKInterface;
|
|
28
|
-
|
|
29
|
-
get offsetStore(): OffsetStoreSDKInterface;
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Ability to send telemetry data such as gauges and increments on how the connector is performing.
|
|
33
|
-
*/
|
|
34
|
-
get telemetry(): TelemetrySDKInterface;
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Get file service instance to access files using a specified DSN. If no DSN is provided, defaults to local file system tmp dir.
|
|
38
|
-
*/
|
|
39
|
-
files(dsn?: string): FilesSDKInterface;
|
|
40
|
-
|
|
41
|
-
httpClient(httpConfig?: HttpConfig): HttpClientSDKInterface;
|
|
42
|
-
}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
export interface Metric {
|
|
2
|
-
key: string;
|
|
3
|
-
value: number;
|
|
4
|
-
}
|
|
5
|
-
|
|
6
|
-
export type Metadata = { [key: string]: string };
|
|
7
|
-
|
|
8
|
-
export interface Context {
|
|
9
|
-
timestamp?: Date;
|
|
10
|
-
ttl?: number;
|
|
11
|
-
extraPayload?: { [key: string]: string };
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export type Result = boolean | { [index: number]: boolean };
|
|
15
|
-
|
|
16
|
-
export interface SenderSDKInterface {
|
|
17
|
-
metrics(
|
|
18
|
-
metrics: Array<Metric>,
|
|
19
|
-
metadata?: Metadata,
|
|
20
|
-
context?: Context,
|
|
21
|
-
): Promise<Result>;
|
|
22
|
-
|
|
23
|
-
metricsLegacy(
|
|
24
|
-
metrics: Array<never>,
|
|
25
|
-
metadata?: Metadata,
|
|
26
|
-
context?: Context,
|
|
27
|
-
): Promise<Result>;
|
|
28
|
-
|
|
29
|
-
documents(
|
|
30
|
-
metrics: Array<object>,
|
|
31
|
-
metadata?: Metadata,
|
|
32
|
-
context?: Context,
|
|
33
|
-
): Promise<Result>;
|
|
34
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
export interface TelemetrySDKInterface {
|
|
2
|
-
/**
|
|
3
|
-
* Increment a telemetry counter by 1.
|
|
4
|
-
*/
|
|
5
|
-
increment(key: string): void;
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Increment a telemetry counter by a specified value. 0 doesn't send any telemetry.
|
|
9
|
-
* A negative value will decrement the counter.
|
|
10
|
-
*/
|
|
11
|
-
increment(key: string, value: number): void;
|
|
12
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
export type RuntimeOptions = {
|
|
2
|
-
partial?: boolean;
|
|
3
|
-
};
|
|
4
|
-
|
|
5
|
-
export type CompileDelegate<T = unknown> = {
|
|
6
|
-
(context: T, options?: RuntimeOptions): string;
|
|
7
|
-
};
|
|
8
|
-
|
|
9
|
-
export type CompileOptions = { strict?: boolean };
|
|
10
|
-
|
|
11
|
-
export interface TemplatingSDKInterface {
|
|
12
|
-
compile<T = unknown>(
|
|
13
|
-
input: string,
|
|
14
|
-
options?: CompileOptions,
|
|
15
|
-
): CompileDelegate<T>;
|
|
16
|
-
}
|
package/tsconfig.json
DELETED
package/tsconfig.lib.json
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"extends": "./tsconfig.json",
|
|
3
|
-
"compilerOptions": {
|
|
4
|
-
"module": "commonjs",
|
|
5
|
-
"outDir": "../../dist/out-tsc",
|
|
6
|
-
"declaration": true,
|
|
7
|
-
"types": ["node"]
|
|
8
|
-
},
|
|
9
|
-
"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
|
|
10
|
-
"include": ["src/**/*.ts"]
|
|
11
|
-
}
|
package/tsconfig.spec.json
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"extends": "./tsconfig.json",
|
|
3
|
-
"compilerOptions": {
|
|
4
|
-
"outDir": "../../dist/out-tsc",
|
|
5
|
-
"module": "commonjs",
|
|
6
|
-
"types": ["jest", "node"]
|
|
7
|
-
},
|
|
8
|
-
"include": [
|
|
9
|
-
"jest.config.ts",
|
|
10
|
-
"src/**/*.test.ts",
|
|
11
|
-
"src/**/*.spec.ts",
|
|
12
|
-
"src/**/*.d.ts"
|
|
13
|
-
]
|
|
14
|
-
}
|
|
File without changes
|
|
File without changes
|