@typedb/driver-http 3.11.5 → 3.12.0

package/dist/index.cjs

@@ -136,11 +136,11 @@ var TypeDBHttpDriver = class {
   analyze(transactionId, query, analyzeOptions) {
     return this.apiPost(`/v1/transactions/${encodeURIComponent(transactionId)}/analyze`, { query, analyzeOptions });
   }
-  query(transactionId, query, queryOptions) {
-    return this.apiPost(`/v1/transactions/${encodeURIComponent(transactionId)}/query`, { query, queryOptions });
+  query(transactionId, query, queryOptions, givenRows) {
+    return this.apiPost(`/v1/transactions/${encodeURIComponent(transactionId)}/query`, { query, queryOptions, givenRows });
   }
-  oneShotQuery(query, commit, databaseName, transactionType, transactionOptions, queryOptions) {
-    return this.apiPost(`/v1/query`, { query, commit, databaseName, transactionType, transactionOptions, queryOptions });
+  oneShotQuery(query, commit, databaseName, transactionType, transactionOptions, queryOptions, givenRows) {
+    return this.apiPost(`/v1/query`, { query, commit, databaseName, transactionType, transactionOptions, queryOptions, givenRows });
   }
   health() {
     return this.apiGet(`/v1/health`);

package/dist/index.d.ts

@@ -352,6 +352,12 @@ interface ConjunctionAnnotations {
         [name: VariableId]: VariableAnnotations;
     };
 }
+interface Given {
+    variables: VariableId[];
+    variable_annotations: {
+        [name: VariableId]: VariableAnnotations;
+    };
+}
 type AnalyzedFetch = {
     tag: "list";
     elements: AnalyzedFetch;
@@ -428,6 +434,7 @@ type QueryResponse = OkQueryResponse | ConceptRowsQueryResponse | ConceptDocumen
 interface AnalyzeResponse {
     source: string;
     preamble: AnalyzedFunction[];
+    given: Given | null;
     query: AnalyzedPipeline;
     fetch: AnalyzedFetch | null;
 }
@@ -477,8 +484,8 @@ declare class TypeDBHttpDriver {
     closeTransaction(transactionId: string): Promise<ApiResponse>;
     rollbackTransaction(transactionId: string): Promise<ApiResponse>;
     analyze(transactionId: string, query: string, analyzeOptions?: AnalyzeOptions): Promise<ApiResponse<AnalyzeResponse>>;
-    query(transactionId: string, query: string, queryOptions?: QueryOptions): Promise<ApiResponse<QueryResponse>>;
-    oneShotQuery(query: string, commit: boolean, databaseName: string, transactionType: TransactionType, transactionOptions?: TransactionOptions, queryOptions?: QueryOptions): Promise<ApiResponse<QueryResponse>>;
+    query(transactionId: string, query: string, queryOptions?: QueryOptions, givenRows?: GivenRows): Promise<ApiResponse<QueryResponse>>;
+    oneShotQuery(query: string, commit: boolean, databaseName: string, transactionType: TransactionType, transactionOptions?: TransactionOptions, queryOptions?: QueryOptions, givenRows?: GivenRows): Promise<ApiResponse<QueryResponse>>;
     health(): Promise<ApiResponse>;
     version(): Promise<ApiResponse<VersionResponse>>;
     getServers(): Promise<ApiResponse<ServersListResponse>>;
@@ -522,5 +529,9 @@ interface AnalyzeOptions {
 interface User {
     username: string;
 }
+type GivenRowEntry = Value | Entity | Relation | Attribute | boolean | number | string;
+type GivenRows = {
+    [varName: string]: GivenRowEntry;
+}[];
 
-export { type AnalyzeOptions, type AnalyzeResponse, type AnalyzedConjunction, type AnalyzedFetch, type AnalyzedFunction, type AnalyzedPipeline, type Answer, type AnswerType, type ApiError, type ApiErrorResponse, type ApiOkResponse, type ApiResponse, type Attribute, type AttributeType, type Concept, type ConceptDocument, type ConceptDocumentsQueryResponse, type ConceptRow, type ConceptRowAnswer, type ConceptRowsQueryResponse, type ConceptRowsQueryResponseLegacy, type ConjunctionAnnotations, type ConstraintAny, type ConstraintComparison, type ConstraintExpression, type ConstraintExpressionLegacy, type ConstraintFunction, type ConstraintHas, type ConstraintIid, type ConstraintIs, type ConstraintIsa, type ConstraintIsaExact, type ConstraintKind, type ConstraintLabel, type ConstraintLinks, type ConstraintLinksLegacy, type ConstraintNot, type ConstraintOr, type ConstraintOwns, type ConstraintPlays, type ConstraintRelates, type ConstraintSpan, type ConstraintSub, type ConstraintSubExact, type ConstraintTry, type ConstraintValue, type ConstraintVertexAny, type ConstraintVertexLabel, type ConstraintVertexNamedRole, type ConstraintVertexValue, type ConstraintVertexVariable, type Database, type DatabasesListResponse, type Distribution, type DriverParams, type DriverParamsBasic, type DriverParamsTranslated, type EdgeKind, type Entity, type EntityType, type FetchAnnotationFieldEntry, type FunctionReturnStructure, type FunctionSingleReturnSelector, type InstantiableType, type MisdirectedError, type OkQueryResponse, type PipelineStage, type QueryConjunctionLegacy, type QueryOptions, type QueryResponse, type QueryResponseBase, type QueryStructureLegacy, type QueryType, type Reducer, type Relation, type RelationType, type ReplicationRole, type ReplicationStatus, type RoleType, type Server, type ServersListResponse, type SignInResponse, type ThingKind, type TransactionOpenResponse, type TransactionOptions, type TransactionType, type TranslatedAddress, type Type, TypeDBHttpDriver, type TypeKind, type User, type UsersListResponse, type Value, type ValueKind, type ValueType, type VariableAnnotations, type VariableId, type VariableInfo, type VersionResponse, allOrigins, driverError, getVariableName, hostPortFromOrigin, isApiError, isApiErrorResponse, isBasicParams, isMisdirectedError, isOkResponse, isQueryResponseLegacy, isTranslatedParams, remoteOrigin, resolveOrigin };
+export { type AnalyzeOptions, type AnalyzeResponse, type AnalyzedConjunction, type AnalyzedFetch, type AnalyzedFunction, type AnalyzedPipeline, type Answer, type AnswerType, type ApiError, type ApiErrorResponse, type ApiOkResponse, type ApiResponse, type Attribute, type AttributeType, type Concept, type ConceptDocument, type ConceptDocumentsQueryResponse, type ConceptRow, type ConceptRowAnswer, type ConceptRowsQueryResponse, type ConceptRowsQueryResponseLegacy, type ConjunctionAnnotations, type ConstraintAny, type ConstraintComparison, type ConstraintExpression, type ConstraintExpressionLegacy, type ConstraintFunction, type ConstraintHas, type ConstraintIid, type ConstraintIs, type ConstraintIsa, type ConstraintIsaExact, type ConstraintKind, type ConstraintLabel, type ConstraintLinks, type ConstraintLinksLegacy, type ConstraintNot, type ConstraintOr, type ConstraintOwns, type ConstraintPlays, type ConstraintRelates, type ConstraintSpan, type ConstraintSub, type ConstraintSubExact, type ConstraintTry, type ConstraintValue, type ConstraintVertexAny, type ConstraintVertexLabel, type ConstraintVertexNamedRole, type ConstraintVertexValue, type ConstraintVertexVariable, type Database, type DatabasesListResponse, type Distribution, type DriverParams, type DriverParamsBasic, type DriverParamsTranslated, type EdgeKind, type Entity, type EntityType, type FetchAnnotationFieldEntry, type FunctionReturnStructure, type FunctionSingleReturnSelector, type Given, type GivenRowEntry, type GivenRows, type InstantiableType, type MisdirectedError, type OkQueryResponse, type PipelineStage, type QueryConjunctionLegacy, type QueryOptions, type QueryResponse, type QueryResponseBase, type QueryStructureLegacy, type QueryType, type Reducer, type Relation, type RelationType, type ReplicationRole, type ReplicationStatus, type RoleType, type Server, type ServersListResponse, type SignInResponse, type ThingKind, type TransactionOpenResponse, type TransactionOptions, type TransactionType, type TranslatedAddress, type Type, TypeDBHttpDriver, type TypeKind, type User, type UsersListResponse, type Value, type ValueKind, type ValueType, type VariableAnnotations, type VariableId, type VariableInfo, type VersionResponse, allOrigins, driverError, getVariableName, hostPortFromOrigin, isApiError, isApiErrorResponse, isBasicParams, isMisdirectedError, isOkResponse, isQueryResponseLegacy, isTranslatedParams, remoteOrigin, resolveOrigin };

package/dist/index.mjs

@@ -136,11 +136,11 @@ var TypeDBHttpDriver = class {
   analyze(transactionId, query, analyzeOptions) {
     return this.apiPost(`/v1/transactions/${encodeURIComponent(transactionId)}/analyze`, { query, analyzeOptions });
   }
-  query(transactionId, query, queryOptions) {
-    return this.apiPost(`/v1/transactions/${encodeURIComponent(transactionId)}/query`, { query, queryOptions });
+  query(transactionId, query, queryOptions, givenRows) {
+    return this.apiPost(`/v1/transactions/${encodeURIComponent(transactionId)}/query`, { query, queryOptions, givenRows });
   }
-  oneShotQuery(query, commit, databaseName, transactionType, transactionOptions, queryOptions) {
-    return this.apiPost(`/v1/query`, { query, commit, databaseName, transactionType, transactionOptions, queryOptions });
+  oneShotQuery(query, commit, databaseName, transactionType, transactionOptions, queryOptions, givenRows) {
+    return this.apiPost(`/v1/query`, { query, commit, databaseName, transactionType, transactionOptions, queryOptions, givenRows });
   }
   health() {
     return this.apiGet(`/v1/health`);

package/package.json

@@ -1 +1 @@
-{"name": "@typedb/driver-http", "version": "3.11.5", "description": "TypeDB HTTP Driver", "author": "TypeDB Community <community@typedb.com>", "license": "Apache-2.0", "homepage": "https://typedb.com", "repository": {"type": "git", "url": "https://github.com/typedb/typedb-driver"}, "bugs": {"url": "https://github.com/typedb/typedb-driver/issues"}, "keywords": ["database", "typedb"], "main": "dist/index.cjs", "module": "dist/index.mjs", "types": "dist/index.d.ts", "type": "module", "exports": {".": {"types": "./dist/index.d.ts", "import": "./dist/index.mjs", "require": "./dist/index.cjs"}}, "scripts": {"build:dev": "tsc", "build": "tsup", "test": "cucumber-js", "docs": "typedoc"}, "packageManager": "pnpm@8.15.9", "packageConfig": {"access": "public"}, "devDependencies": {"@cucumber/cucumber": "9.0.0", "@types/node": "24.0.12", "tsup": "8.5.0", "typedoc": "^0.28.7", "typescript": "5.8.3"}}
+{"name": "@typedb/driver-http", "version": "3.12.0", "description": "TypeDB HTTP Driver", "author": "TypeDB Community <community@typedb.com>", "license": "Apache-2.0", "homepage": "https://typedb.com", "repository": {"type": "git", "url": "https://github.com/typedb/typedb-driver"}, "bugs": {"url": "https://github.com/typedb/typedb-driver/issues"}, "keywords": ["database", "typedb"], "main": "dist/index.cjs", "module": "dist/index.mjs", "types": "dist/index.d.ts", "type": "module", "exports": {".": {"types": "./dist/index.d.ts", "import": "./dist/index.mjs", "require": "./dist/index.cjs"}}, "scripts": {"build:dev": "tsc", "build": "tsup", "test": "cucumber-js", "docs": "typedoc"}, "packageManager": "pnpm@8.15.9", "packageConfig": {"access": "public"}, "devDependencies": {"@cucumber/cucumber": "9.0.0", "@types/node": "24.0.12", "tsup": "8.5.0", "typedoc": "^0.28.7", "typescript": "5.8.3"}}