UNPKG

1.92 kBTypeScriptView Raw
1import { Flow as FlowDefinition, NodeDefinition, NodeDefinitions, NodeDependencies } from '@chix/common';
2export declare type Dependencies = NodeDependencies;
3export declare type DependencyTypes = 'npm';
4export interface BaseNodeDefinitionLocation {
5 providerLocation: string;
6}
7export declare type ProviderDef = {
8 ns: string;
9 name: string;
10 providerLocation: string;
11 url: string;
12};
13export declare type LoadDefinitionResult = {
14 nodeDefinition: NodeDefinition | FlowDefinition;
15 dependencies: Dependencies;
16};
17export declare type Location = string;
18export declare type WillLoad = Location[];
19export interface WorkloadBase {
20 ns: string;
21 name: string;
22 providerLocation: string;
23}
24export interface FSWorkload extends WorkloadBase {
25 path: string;
26}
27export interface RemoteWorkload extends WorkloadBase {
28 url: string;
29}
30export declare type Workload = Array<FSWorkload | RemoteWorkload>;
31export interface XCacheFile {
32 dependencies: NodeDependencies;
33 nodeDefinitions: NodeDefinitions;
34}
35export interface WriteCacheEvent {
36 file: string;
37}
38export interface PurgeCacheEvent {
39 file: string;
40}
41export interface LoadCacheEvent {
42 file: string;
43 cache: XCacheFile;
44}
45export declare type FSLoaderConfig = {
46 cache?: boolean;
47 purge?: boolean;
48};
49export interface NodeDefinitionLocationFS extends BaseNodeDefinitionLocation {
50 path: string;
51}
52export interface LoadFileEvent {
53 path: string;
54}
55export interface LoadUrlEvent {
56 url: string;
57}
58export declare type LoadNodeResult = {
59 providerLocation: string;
60 nodeDef: NodeDefinition | FlowDefinition;
61};
62export declare type PreloadResult = {
63 provider: string;
64 nodeDefinitions: NodeDefinitions;
65};
66export declare type PreloadConfig = {
67 provider: string;
68 collection: string;
69};
70export interface NodeDefinitionLocationRemote extends BaseNodeDefinitionLocation {
71 url: string;
72}