@finos/legend-extension-dsl-data-space
Version:
Legend extension for Data Space DSL
161 lines • 6.17 kB
TypeScript
/**
* Copyright (c) 2020-present, Goldman Sachs
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { Multiplicity, Mapping, PackageableRuntime, PureModel, DatasetSpecification, MappingModelCoverageAnalysisResult, FunctionAnalysisInfo } from '@finos/legend-graph';
import type { DataSpaceSupportInfo } from '../../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
import type { Diagram } from '@finos/legend-extension-dsl-diagram/graph';
export declare class DataSpaceExecutionContextAnalysisResult {
name: string;
title?: string | undefined;
description?: string | undefined;
mapping: Mapping;
defaultRuntime: PackageableRuntime;
compatibleRuntimes: PackageableRuntime[];
datasets: DatasetSpecification[];
runtimeMetadata?: DataSpaceExecutionContextRuntimeMetadata;
}
export declare class DataSpaceExecutionContextRuntimeMetadata {
storePath?: string;
connectionPath?: string;
connectionType?: string;
}
export declare class DataSpaceTaggedValueInfo {
readonly _UUID: string;
profile: string;
tag: string;
value: string;
}
export declare class DataSpaceStereotypeInfo {
readonly _UUID: string;
profile: string;
value: string;
}
export declare class NormalizedDataSpaceDocumentationEntry {
readonly uuid: string;
readonly text: string;
readonly documentation: string;
readonly elementEntry: DataSpaceModelDocumentationEntry;
readonly entry: DataSpaceBasicDocumentationEntry;
constructor(text: string, documentation: string, elementEntry: DataSpaceModelDocumentationEntry, entry: DataSpaceBasicDocumentationEntry);
get humanizedText(): string;
}
export declare class DataSpaceBasicDocumentationEntry {
name: string;
docs: string[];
get humanizedName(): string;
}
export declare class DataSpacePropertyDocumentationEntry extends DataSpaceBasicDocumentationEntry {
milestoning?: string | undefined;
/**
* Make this optional for backward compatibility
*
* @backwardCompatibility
*/
type?: string | undefined;
/**
* Make this optional for backward compatibility
*
* @backwardCompatibility
*/
multiplicity?: Multiplicity | undefined;
}
export declare class DataSpaceModelDocumentationEntry extends DataSpaceBasicDocumentationEntry {
path: string;
}
export declare class DataSpaceClassDocumentationEntry extends DataSpaceModelDocumentationEntry {
properties: DataSpacePropertyDocumentationEntry[];
milestoning?: string | undefined;
}
export declare class DataSpaceEnumerationDocumentationEntry extends DataSpaceModelDocumentationEntry {
enumValues: DataSpaceBasicDocumentationEntry[];
}
export declare class DataSpaceAssociationDocumentationEntry extends DataSpaceModelDocumentationEntry {
properties: DataSpacePropertyDocumentationEntry[];
}
export declare class DataSpaceDiagramAnalysisResult {
readonly uuid: string;
title: string;
description?: string | undefined;
diagram: Diagram;
}
export declare abstract class DataSpaceExecutableInfo {
id: string;
executionContextKey: string;
query: string;
}
export declare class DataSpaceTemplateExecutableInfo extends DataSpaceExecutableInfo {
}
export declare class DataSpaceFunctionPointerExecutableInfo extends DataSpaceExecutableInfo {
function: string;
}
export declare class DataSpaceServiceExecutableInfo extends DataSpaceExecutableInfo {
pattern: string;
mapping?: string | undefined;
runtime?: string | undefined;
datasets: DatasetSpecification[];
}
export declare class DataSpaceMultiExecutionServiceExecutableInfo extends DataSpaceExecutableInfo {
pattern: string;
keyedExecutableInfos: DataSpaceMultiExecutionServiceKeyedExecutableInfo[];
}
export declare class DataSpaceMultiExecutionServiceKeyedExecutableInfo {
key: string;
mapping?: string | undefined;
runtime?: string | undefined;
datasets: DatasetSpecification[];
}
export declare abstract class DataSpaceExecutableResult {
}
export declare class DataSpaceExecutableTDSResultColumn {
readonly uuid: string;
name: string;
type?: string | undefined;
relationalType?: string | undefined;
documentation?: string | undefined;
sampleValues?: string | undefined;
}
export declare class DataSpaceExecutableTDSResult extends DataSpaceExecutableResult {
columns: DataSpaceExecutableTDSResultColumn[];
}
export declare class DataSpaceExecutableAnalysisResult {
readonly uuid: string;
title: string;
description?: string | undefined;
executable?: string;
info?: DataSpaceExecutableInfo | undefined;
result: DataSpaceExecutableResult;
}
export declare class DataSpaceAnalysisResult {
name: string;
package: string;
path: string;
taggedValues: DataSpaceTaggedValueInfo[];
stereotypes: DataSpaceStereotypeInfo[];
title?: string | undefined;
description?: string | undefined;
graph: PureModel;
executionContextsIndex: Map<string, DataSpaceExecutionContextAnalysisResult>;
defaultExecutionContext: DataSpaceExecutionContextAnalysisResult;
elementDocs: NormalizedDataSpaceDocumentationEntry[];
elements: string[];
diagrams: DataSpaceDiagramAnalysisResult[];
executables: DataSpaceExecutableAnalysisResult[];
supportInfo?: DataSpaceSupportInfo | undefined;
mappingToMappingCoverageResult?: Map<string, MappingModelCoverageAnalysisResult>;
functionInfos?: Map<string, FunctionAnalysisInfo>;
dependencyFunctionInfos?: Map<string, FunctionAnalysisInfo>;
get displayName(): string;
}
//# sourceMappingURL=DataSpaceAnalysis.d.ts.map