@jitsu/types
Advanced tools
Comparing version 0.7.1 to 0.9.0-alpha.164
import { DefaultJitsuEvent } from "./event"; | ||
import { ConfigurationParameter } from "./parameters"; | ||
import { Config } from "prettier"; | ||
import { SourceCatalog, StreamReader } from "./sources"; | ||
@@ -36,2 +37,15 @@ /** | ||
/** | ||
* For source extension: returns all available streams with configuration parameters | ||
*/ | ||
sourceCatalog?: SourceCatalog<Config>; | ||
/** | ||
* The main logic of source extension. Pulls data from underlying API and push it to provided StreamSink object | ||
* @param sourceConfig | ||
* @param streamConfig | ||
* @param streamSink | ||
* @param services | ||
*/ | ||
streamReader?: StreamReader<Config, Record<string, any>>; | ||
/** | ||
* Extension can export transformation logic. The transformation logic | ||
@@ -119,3 +133,2 @@ * is applied before event is sent to destination | ||
* | ||
* Avoid using `fetch` if possible. Just return | ||
* @param event incoming event | ||
@@ -122,0 +135,0 @@ * @param context context of the processing |
{ | ||
"name": "@jitsu/types", | ||
"version": "0.7.1", | ||
"version": "0.9.0-alpha.164", | ||
"author": "Jitsu Dev Team <dev@jitsu.com>", | ||
@@ -12,14 +12,13 @@ "description": "Types for Jitsu (👉 https://jitsu.com)", | ||
], | ||
"scripts": { | ||
"test": "exit 0" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/jitsucom/jitsu-sdk", | ||
"directory": "packages/jitsu-types" | ||
"directory": "core/jitsu-types" | ||
}, | ||
"devDependencies": { | ||
"@segment/analytics-next": "~1.17.4" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/jitsucom/jitsu/issues" | ||
}, | ||
"gitHead": "5ae340da9c4d3ff3c2377f52e7ef9abd51262208" | ||
} | ||
} | ||
} |
@@ -1,3 +0,1 @@ | ||
type ConfigParameterType = "string" | "int" | "json" | "boolean" | "password"; | ||
export type ConfigurationParameter<T = string> = { | ||
@@ -33,2 +31,22 @@ /** | ||
documentation?: string; | ||
/** | ||
* Defines if the field can be accepted depending on the parent field value | ||
*/ | ||
relevantIf?: { | ||
/** Parent field id */ | ||
field: string; | ||
/** Parent field value for which this field is relevant */ | ||
value: unknown; | ||
}; | ||
}; | ||
export type ConfigParameterType = | ||
| "string" | ||
| "int" | ||
| "json" | ||
| "boolean" | ||
| "password" | ||
| "oauthSecret" | ||
| "isoUtcDate" | ||
| { oneOf: Readonly<string[]> } | ||
| { severalOf: Readonly<string[]>; max?: number }; |
@@ -9,4 +9,2 @@ /** | ||
* | ||
* see flattenToTable() from pipeline-helpers module | ||
* | ||
*/ | ||
@@ -25,6 +23,6 @@ export declare type TableObject = { | ||
*/ | ||
import { throws } from "assert"; | ||
export type SqlTypeHintKey = `__sql_type_${string}`; | ||
export declare type JitsuDestinationHints<T extends TableObject> = { | ||
[key in `__sql_type_${string}`]: SqlTypeHint; | ||
[key in SqlTypeHintKey]: SqlTypeHint; | ||
} & { | ||
@@ -39,3 +37,3 @@ JITSU_TABLE_NAME?: string; | ||
* being converted to CanonicalSqlTypeHint by `canonicalSqlTypeHint` from | ||
* pipeline-helpers package | ||
* @jitsu/jlib package | ||
* | ||
@@ -42,0 +40,0 @@ * Supported shortcuts: string (just an SQL type), [string, string] (ddl type, cast type) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
23266
10
596
1