/** * 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 { AbstractServerClient, type PlainObject, type ServerClientConfig, type TraceData } from '@finos/legend-shared'; import type { V1_PureModelContextData } from '../model/context/V1_PureModelContextData.js'; import type { V1_LambdaReturnTypeInput, V1_LambdaReturnTypeResult } from './compilation/V1_LambdaReturnType.js'; import type { V1_ServiceRegistrationResult } from './service/V1_ServiceRegistrationResult.js'; import type { V1_ServiceConfigurationInfo } from './service/V1_ServiceConfiguration.js'; import { ServiceDetail } from '../../../../action/service/ServiceDetail.js'; import type { V1_CompileResult } from './compilation/V1_CompileResult.js'; import type { V1_RawLambda } from '../model/rawValueSpecification/V1_RawLambda.js'; import type { V1_GenerateFileInput } from './generation/V1_FileGenerationInput.js'; import type { V1_ExecutionResult } from './execution/V1_ExecutionResult.js'; import type { V1_ImportConfigurationDescription } from './import/V1_ImportConfigurationDescription.js'; import type { V1_GenerationConfigurationDescription } from './generation/V1_GenerationConfigurationDescription.js'; import type { V1_GenerationOutput } from './generation/V1_GenerationOutput.js'; import type { V1_ExecuteInput } from './execution/V1_ExecuteInput.js'; import type { V1_PureModelContext } from '../model/context/V1_PureModelContext.js'; import type { V1_ExecutionPlan } from '../model/executionPlan/V1_ExecutionPlan.js'; import type { V1_LightQuery, V1_Query } from './query/V1_Query.js'; import type { V1_ServiceStorage } from './service/V1_ServiceStorage.js'; import type { GenerationMode } from '../../../../../graph-manager/action/generation/GenerationConfigurationDescription.js'; import type { V1_QuerySearchSpecification } from './query/V1_QuerySearchSpecification.js'; import { type TDSExecutionResult, EXECUTION_SERIALIZATION_FORMAT } from '../../../../../graph-manager/action/execution/ExecutionResult.js'; import type { V1_ExternalFormatDescription } from './externalFormat/V1_ExternalFormatDescription.js'; import type { V1_ExternalFormatModelGenerationInput } from './externalFormat/V1_ExternalFormatModelGeneration.js'; import type { V1_GenerateSchemaInput } from './externalFormat/V1_GenerateSchemaInput.js'; import type { V1_RunTestsInput } from './test/V1_RunTestsInput.js'; import type { V1_RawRelationalOperationElement } from '../model/packageableElements/store/relational/model/V1_RawRelationalOperationElement.js'; import type { V1_RenderStyle } from './grammar/V1_RenderStyle.js'; import type { V1_ParserError } from './grammar/V1_ParserError.js'; import type { V1_MappingModelCoverageAnalysisInput, V1_MappingModelCoverageAnalysisResult } from './analytics/V1_MappingModelCoverageAnalysis.js'; import { ServiceExecutionMode } from '../../../../action/service/ServiceExecutionMode.js'; import type { V1_CheckEntitlementsResult, V1_EntitlementReportAnalyticsInput, V1_StoreEntitlementAnalysisInput, V1_SurveyDatasetsResult } from './analytics/V1_StoreEntitlementAnalysis.js'; import type { V1_RunTestsResult } from './test/V1_RunTestsResult.js'; import type { ClassifierPathMapping, SubtypeInfo } from '../../../../action/protocol/ProtocolInfo.js'; import type { V1_FunctionActivatorInfo } from './functionActivator/V1_FunctionActivatorInfo.js'; import type { V1_FunctionActivatorError } from './functionActivator/V1_FunctionActivatorError.js'; import type { V1_FunctionActivatorInput } from './functionActivator/V1_FunctionActivatorInput.js'; import type { V1_DatabaseBuilderInput } from './generation/V1_DatabaseBuilderInput.js'; import type { V1_RawSQLExecuteInput } from './execution/V1_RawSQLExecuteInput.js'; import type { V1_ValueSpecification } from '../model/valueSpecification/V1_ValueSpecification.js'; import type { V1_ArtifactGenerationExtensionInput, V1_ArtifactGenerationExtensionOutput } from './generation/V1_ArtifactGenerationExtensionApi.js'; import type { V1_DatabaseToModelGenerationInput } from './relational/V1_DatabaseToModelGenerationInput.js'; import type { V1_TestDataGenerationInput } from './service/V1_TestDataGenerationInput.js'; import type { V1_TestDataGenerationResult } from './service/V1_TestDataGenerationResult.js'; import type { V1_RelationalConnectionBuilder } from './relational/V1_RelationalConnectionBuilder.js'; import type { V1_LambdaPrefix } from './lambda/V1_LambdaPrefix.js'; import type { V1_DebugTestsResult } from './test/V1_DebugTestsResult.js'; import type { V1_RelationType } from '../model/packageableElements/type/V1_RelationType.js'; import type { CodeCompletionResult } from '../../../../action/compilation/Completion.js'; import type { V1_CompleteCodeInput } from './compilation/V1_CompleteCodeInput.js'; import type { DeploymentResult } from '../../../../action/DeploymentResult.js'; import type { PersistentDataCube } from '../../../../action/query/PersistentDataCube.js'; import { type V1_LambdaTdsToRelationInput } from './pureProtocol/V1_LambdaTdsToRelationInput.js'; import type { V1_RawLineageModel } from '../model/lineage/V1_Lineage.js'; import type { V1_DevMetadataPushRequest } from './dev-metadata/V1_DevMetadataPushRequest.js'; export type V1_GrammarParserBatchInputEntry = { value: string; returnSourceInformation?: boolean | undefined; sourceInformationOffset?: { sourceId?: string | undefined; lineOffset?: number | undefined; columnOffset?: number | undefined; } | undefined; }; declare enum ENGINE_EXECUTION_SERIALIZATION_FORMAT { CSV_TRANSFORMED = "csv_transformed" } export declare const V1_getEngineSerializationFormat: (val: EXECUTION_SERIALIZATION_FORMAT) => ENGINE_EXECUTION_SERIALIZATION_FORMAT | string; export declare function getCurrentUserIDFromEngineServer(engineServerUrl: string): Promise; export declare class V1_EngineServerClient extends AbstractServerClient { currentUserId?: string | undefined; private env?; private queryBaseUrl?; private baseUrlForServiceRegistration?; constructor(config: ServerClientConfig); setBaseUrlForServiceRegistration(val: string | undefined): void; setEnv: (value: string | undefined) => void; setCurrentUserId: (value: string | undefined) => void; getTraceData: (name: string, tracingTags?: PlainObject) => TraceData; _pure: () => string; _sdlc: () => string; _server: () => string; getCurrentUserId: () => Promise; _marketplace: () => string; getTerminals: () => Promise; getTerminalById: (id: string) => Promise; _lambda: () => string; getLambdaPrefixes: () => Promise[]>; getClassifierPathMap: () => Promise; getSubtypeInfo: () => Promise; transformTdsToRelation_lambda: (input: PlainObject) => Promise>; createPrototypeProject: () => Promise<{ projectId: string; webUrl: string | undefined; owner: string; }>; validUserAccessRole: (userId: string) => Promise; _grammarToJSON: () => string; grammarToJSON_model: (input: string, sourceId?: string | undefined, lineOffset?: number | undefined, returnSourceInformation?: boolean | undefined) => Promise>; grammarToJSON_lambda: (input: string, sourceId?: string | undefined, lineOffset?: number | undefined, columnOffset?: number | undefined, returnSourceInformation?: boolean | undefined) => Promise>; grammarToJSON_lambda_batch: (input: Record) => Promise<{ errors?: Record> | undefined; result?: Record> | undefined; }>; grammarToJSON_valueSpecification_batch: (input: Record) => Promise<{ errors?: Record> | undefined; result?: Record> | undefined; }>; grammarToJSON_valueSpecification: (input: string, sourceId?: string | undefined, lineOffset?: number | undefined, columnOffset?: number | undefined, returnSourceInformation?: boolean | undefined) => Promise>; grammarToJSON_relationalOperationElement: (input: string, sourceId?: string | undefined, lineOffset?: number | undefined, columnOffset?: number | undefined, returnSourceInformation?: boolean | undefined) => Promise>; grammarToJSON_relationalOperationElement_batch: (input: Record) => Promise<{ errors?: Record> | undefined; result?: Record> | undefined; }>; _JSONToGrammar: () => string; JSONToGrammar_model: (input: PlainObject, renderStyle?: V1_RenderStyle | undefined) => Promise; JSONToGrammar_lambda: (input: PlainObject, renderStyle?: V1_RenderStyle | undefined) => Promise; JSONToGrammar_lambda_batch: (input: Record>, renderStyle?: V1_RenderStyle | undefined) => Promise>; JSONToGrammar_valueSpecification_batch: (input: Record>, renderStyle?: V1_RenderStyle | undefined) => Promise>; JSONToGrammar_valueSpecification: (input: PlainObject, renderStyle?: V1_RenderStyle | undefined) => Promise; JSONToGrammar_relationalOperationElement: (input: PlainObject, renderStyle?: V1_RenderStyle | undefined) => Promise; JSONToGrammar_relationalOperationElement_batch: (input: Record>, renderStyle?: V1_RenderStyle | undefined) => Promise>; runTests: (input: PlainObject) => Promise>; debugTests: (input: PlainObject) => Promise>; _externalFormats: () => string; getAvailableExternalFormatsDescriptions: () => Promise[]>; generateModel: (input: PlainObject) => Promise[]>; generateSchema: (input: PlainObject) => Promise[]>; getAvailableCodeImportDescriptions: () => Promise[]>; getAvailableSchemaImportDescriptions: () => Promise[]>; getAvailableCodeGenerationDescriptions: () => Promise[]>; generateFile: (mode: GenerationMode, type: string, input: PlainObject) => Promise[]>; generateAritfacts: (input: PlainObject) => Promise>; getAvailableSchemaGenerationDescriptions: () => Promise[]>; _testDataGeneration: () => string; generateTestData(input: PlainObject): Promise>; compile: (input: PlainObject) => Promise>; lambdaReturnType: (input: PlainObject) => Promise>; lambdaRelationType: (input: PlainObject, options?: { abortController?: AbortController | undefined; }) => Promise>; completeCode: (input: PlainObject) => Promise>; _execution: () => string; _executionManager: () => string; runQuery: (input: PlainObject, options?: { returnAsResponse?: boolean; serializationFormat?: EXECUTION_SERIALIZATION_FORMAT | undefined; abortController?: AbortController | undefined; tracingTags?: PlainObject | undefined; }) => Promise | Response>; generateLineage: (input: PlainObject) => Promise>; generatePlan: (input: PlainObject) => Promise>; debugPlanGeneration: (input: PlainObject) => Promise<{ plan: PlainObject; debug: string[]; }>; generateTestDataWithDefaultSeed: (input: PlainObject) => Promise; generateTestDataWithSeed: (input: PlainObject) => Promise; /** * TODO: this is an internal API that should me refactored out using extension mechanism */ INTERNAL__cancelUserExecutions: (userID: string, broadcastToCluster: boolean) => Promise; _query: (queryId?: string) => string; searchQueries: (searchSpecification: PlainObject) => Promise[]>; getQueries: (queryIds: string[]) => Promise[]>; getQuery: (queryId: string) => Promise>; createQuery: (query: PlainObject) => Promise>; updateQuery: (queryId: string, query: PlainObject) => Promise>; patchQuery: (queryId: string, query: PlainObject>) => Promise>; deleteQuery: (queryId: string) => Promise>; _dataCube: (id?: string) => string; searchDataCubes: (searchSpecification: PlainObject) => Promise[]>; getDataCubes: (ids: string[]) => Promise[]>; getDataCube: (id: string) => Promise>; createDataCube: (dataCube: PlainObject) => Promise>; updateDataCube: (id: string, dataCube: PlainObject) => Promise>; deleteDataCube: (id: string) => Promise>; analyzeMappingModelCoverage: (input: PlainObject) => Promise>; surveyDatasets: (input: PlainObject) => Promise>; checkDatasetEntitlements: (input: PlainObject) => Promise>; _databaseUtilities: () => string; buildDatabase: (input: PlainObject) => Promise>; executeRawSQL: (input: PlainObject) => Promise; _functionActivator: () => string; getAvailableFunctionActivators(): Promise[]>; validateFunctionActivator(input: PlainObject): Promise>; renderFunctionActivatorArtifact(input: PlainObject): Promise; publishFunctionActivatorToSandbox(input: PlainObject): Promise>; _relationalElement: () => string; generateModelsFromDatabaseSpecification(input: PlainObject): Promise>; getAvailableRelationalDatabaseTypeConfigurations: () => Promise[]>; _service: (serviceServerUrl?: string) => string; /** * TODO: this is an internal API that should me refactored out using extension mechanism */ TEMPORARY__getServerServiceInfo: () => Promise>; /** * TODO: this is an internal API that should me refactored out using extension mechanism */ TEMPORARY__getServiceVersionInfo: (serviceServerUrl: string, serviceId: string) => Promise>; /** * TODO: this is an internal API that should me refactored out using extension mechanism */ TEMPORARY__activateGenerationId: (serviceServerUrl: string, generationId: string) => Promise; runServicePostVal: (servicePath: string, input: PlainObject, assertionId: string) => Promise; private getRegisterServiceUrlFromExecMode; /** * TODO: this is an internal API that should me refactored out using extension mechanism */ INTERNAL__registerService: (input: PlainObject, serviceServerUrl: string, serviceExecutionMode: ServiceExecutionMode, TEMPORARY__useStoreModel: boolean, TEMPORARY__useGenerateLineage: boolean, TEMPORARY__useGenerateOpenApi: boolean) => Promise>; _devMetadata: () => string; pushToDevMetadata: (request: PlainObject) => Promise; getServiceMetadataByPattern: (serviceServerUrl: string, servicePattern: string) => Promise; private readonly getServicesDetailsFromCache; getServicesInfo: () => Promise; } export {}; //# sourceMappingURL=V1_EngineServerClient.d.ts.map