@narrative.io/data-collaboration-sdk-ts 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/index.d.ts +2 -2
- package/build/index.js +4 -2
- package/build/jobs/index.d.ts +2 -2
- package/build/jobs/index.js +1 -1
- package/build/jobs/types.d.ts +29 -2
- package/build/nql/types.d.ts +298 -298
- package/package.json +5 -5
- package/build/nql/SubstraitParser.d.ts +0 -770
- package/build/nql/SubstraitParser.js +0 -785
package/build/index.d.ts
CHANGED
|
@@ -19,7 +19,7 @@ import { type CostForecastRequest, type CostForecastResponse, type CostForecastR
|
|
|
19
19
|
import { HealthCheckApi } from "./health";
|
|
20
20
|
import type { HealthCheckResult } from "./health/types";
|
|
21
21
|
import { type Installation, InstallationsApi, type Profile } from "./installations";
|
|
22
|
-
import { type GetJobsParameters, type Job, JobsApi } from "./jobs";
|
|
22
|
+
import { type ExplainInput, type ExplainOutput, type GetJobsParameters, type Job, JobsApi, type MaterializedViewInput, type MaterializedViewOutput } from "./jobs";
|
|
23
23
|
import { type Mapping, type MappingTestResult, MappingsApi } from "./mappings";
|
|
24
24
|
import type { CreateMapping, ObjectMapping, ValueMapping } from "./mappings/types";
|
|
25
25
|
import { type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Nql, NqlApi, type NqlAst, type NqlBooleanExpression, type NqlCompileResult, type NqlExpression, type NqlField, type NqlFilterBinaryExpression, type NqlFilterExpression, type NqlFilterUnaryExpression, type NqlQueryInput, type NqlResult, type NqlWhere, type Raw, type Select, type Statement, type Table, compileStatement, parseStatement } from "./nql";
|
|
@@ -43,4 +43,4 @@ declare class NarrativeApi extends BaseApi {
|
|
|
43
43
|
}
|
|
44
44
|
interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, WhoAmIApi {
|
|
45
45
|
}
|
|
46
|
-
export {
|
|
46
|
+
export { NarrativeApi, AttributeApi, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, type DataPlane, type AccessTokenMetadata, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest, type App, type Resource, type AccessRuleV2, type GetAccessRulesParameters, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type Connection, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type ApiRecordsV2, type Dataset, type HealthCheckResult, type SampleRecords, type Permission, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type GetJobsParameters, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type ForecastResult, type CostForecastResult, type ForecastResultFailure, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type SharedAccessRule, type OwnedAccessRule, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type AccessRuleSchema, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, type Job, type ExplainInput, type MaterializedViewInput, type ExplainOutput, type MaterializedViewOutput, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, compileStatement, parseStatement, };
|
package/build/index.js
CHANGED
|
@@ -14,7 +14,7 @@ import { DatasetApi } from "./datasets";
|
|
|
14
14
|
import { ForecastApi, } from "./forecast";
|
|
15
15
|
import { HealthCheckApi } from "./health";
|
|
16
16
|
import { InstallationsApi, } from "./installations";
|
|
17
|
-
import { JobsApi } from "./jobs";
|
|
17
|
+
import { JobsApi, } from "./jobs";
|
|
18
18
|
import { MappingsApi } from "./mappings";
|
|
19
19
|
import { NqlApi, compileStatement, parseStatement, } from "./nql";
|
|
20
20
|
import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
|
|
@@ -56,4 +56,6 @@ applyMixins(NarrativeApi, [
|
|
|
56
56
|
JobsApi,
|
|
57
57
|
WhoAmIApi,
|
|
58
58
|
]);
|
|
59
|
-
export {
|
|
59
|
+
export {
|
|
60
|
+
// biome-ignore lint/style/useExportType: We need to export the class
|
|
61
|
+
NarrativeApi, AttributeApi, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, };
|
package/build/jobs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseApi } from "../base-api";
|
|
2
2
|
import type { ApiRecords } from "../types";
|
|
3
|
-
import type { Job } from "./types";
|
|
3
|
+
import type { ExplainInput, ExplainOutput, Job, MaterializedViewInput, MaterializedViewOutput } from "./types";
|
|
4
4
|
interface GetJobsParameters extends Record<string, string | number | boolean | undefined> {
|
|
5
5
|
dataset_id?: number;
|
|
6
6
|
per_page?: number;
|
|
@@ -23,4 +23,4 @@ declare class JobsApi extends BaseApi {
|
|
|
23
23
|
*/
|
|
24
24
|
getJob(jobId: string): Promise<Job>;
|
|
25
25
|
}
|
|
26
|
-
export { type Job, JobsApi, type GetJobsParameters };
|
|
26
|
+
export { type Job, type ExplainInput, type MaterializedViewInput, type ExplainOutput, type MaterializedViewOutput, JobsApi, type GetJobsParameters, };
|
package/build/jobs/index.js
CHANGED
package/build/jobs/types.d.ts
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
import type { JobState } from "src/forecast";
|
|
2
|
+
import type { NqlBudget } from "src/nql/types";
|
|
2
3
|
export interface Job {
|
|
3
4
|
job_id: string;
|
|
4
5
|
request_source: JobRequestSource;
|
|
5
6
|
state: JobState;
|
|
6
7
|
type: string;
|
|
7
|
-
input:
|
|
8
|
+
input: ExplainInput | MaterializedViewInput;
|
|
8
9
|
executor?: string;
|
|
9
10
|
idempotency_key: string;
|
|
10
|
-
result?:
|
|
11
|
+
result?: ExplainOutput | MaterializedViewOutput;
|
|
11
12
|
created_at: string;
|
|
12
13
|
updated_at: string;
|
|
13
14
|
ended_at?: string;
|
|
@@ -23,3 +24,29 @@ export interface JobRequestSourceApiUser {
|
|
|
23
24
|
export interface JobRequestSourceProcess {
|
|
24
25
|
name: string;
|
|
25
26
|
}
|
|
27
|
+
export interface ExplainInput {
|
|
28
|
+
nql: string;
|
|
29
|
+
compiled_nql: string;
|
|
30
|
+
}
|
|
31
|
+
export interface MaterializedViewInput {
|
|
32
|
+
nql: string;
|
|
33
|
+
compiled_nql: string;
|
|
34
|
+
budget: NqlBudget;
|
|
35
|
+
dataset_id: number;
|
|
36
|
+
stats_enabled: boolean;
|
|
37
|
+
}
|
|
38
|
+
export interface ExplainOutput {
|
|
39
|
+
dataset_id: number;
|
|
40
|
+
snapshop_id: number;
|
|
41
|
+
recalculation_id: string;
|
|
42
|
+
}
|
|
43
|
+
export interface MaterializedViewOutput {
|
|
44
|
+
success: {
|
|
45
|
+
result: {
|
|
46
|
+
Forecast: {
|
|
47
|
+
cost: number;
|
|
48
|
+
rows: number;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
}
|