@narrative.io/data-collaboration-sdk-ts 2.24.0 → 2.25.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.
Files changed (5) hide show
  1. package/build/index.d.ts +3 -2
  2. package/build/index.js +3 -1
  3. package/build/views/index.d.ts +45 -0
  4. package/build/views/index.js +60 -0
  5. package/package.json +2 -2
package/build/index.d.ts CHANGED
@@ -39,10 +39,11 @@ import { type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails
39
39
  import type { ApiRecords, ApiRecordsV2, Config, Environment, MonetaryAmount } from "./types";
40
40
  import { UploadsApi } from "./uploads";
41
41
  import type { UploadsResponse } from "./uploads/types";
42
+ import { type CreateViewRequest, type OwnedView, type SharedView, type UpdateViewRequest, type View, type ViewOwner, ViewsApi } from "./views";
42
43
  import { WhoAmIApi } from "./whoami";
43
44
  import type { User } from "./whoami/types";
44
45
  declare class NarrativeApi extends BaseApi {
45
46
  }
46
- interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi {
47
+ interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, WhoAmIApi {
47
48
  }
48
- export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, 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 CreateAccessRuleV2Request, type UpdateAccessRuleV2Request, type AccessRuleCollaborators, type AccessRuleCollaboratorsType, 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 AstNodeType, type AstNodeMetadata, 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, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, compileStatement, parseStatement, JsonBigNumber, };
49
+ export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, 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 CreateAccessRuleV2Request, type UpdateAccessRuleV2Request, type AccessRuleCollaborators, type AccessRuleCollaboratorsType, 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 AstNodeType, type AstNodeMetadata, 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, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, type View, type OwnedView, type SharedView, type ViewOwner, type CreateViewRequest, type UpdateViewRequest, compileStatement, parseStatement, JsonBigNumber, };
package/build/index.js CHANGED
@@ -29,6 +29,7 @@ import { isConversationAssistantMessage, isConversationAssistantMessageWithFunct
29
29
  import { SubscriptionsApi, } from "./subscriptions";
30
30
  import { UploadsApi } from "./uploads";
31
31
  import { applyMixins } from "./utils";
32
+ import { ViewsApi, } from "./views";
32
33
  import { WhoAmIApi } from "./whoami";
33
34
  class NarrativeApi extends BaseApi {
34
35
  }
@@ -58,8 +59,9 @@ applyMixins(NarrativeApi, [
58
59
  SubscriptionsApi,
59
60
  JobsApi,
60
61
  QueriesApi,
62
+ ViewsApi,
61
63
  WhoAmIApi,
62
64
  ]);
63
65
  export {
64
66
  // biome-ignore lint/style/useExportType: We need to export the class
65
- NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };
67
+ NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };
package/build/views/index.d.ts ADDED
@@ -0,0 +1,45 @@
1
+ import { BaseApi } from "../base-api";
2
+ import type { ApiRecords } from "../types";
3
+ import type { CreateViewRequest, OwnedView, SharedView, UpdateViewRequest, View, ViewOwner } from "./types";
4
+ /**
5
+ * A class for accessing the Views API.
6
+ * @extends BaseApi
7
+ */
8
+ declare class ViewsApi extends BaseApi {
9
+ /**
10
+ * Gets a list of accessable viees from the API.
11
+ *
12
+ * @returns {Promise<ApiRecords<View>>} A promise that resolves with the list of views.
13
+ */
14
+ getViews(): Promise<ApiRecords<View>>;
15
+ /**
16
+ * Gets a single view from the API by its ID.
17
+ *
18
+ * @param {number} viewId - The ID of the view to retrieve.
19
+ * @returns {Promise<View>} A promise that resolves with the view.
20
+ */
21
+ getView(viewId: number): Promise<View>;
22
+ /**
23
+ * Deletes a single view from the API by its ID.
24
+ *
25
+ * @param {number} viewId - The ID of the view to delete.
26
+ * @returns {Promise<void>} A promise that resolves when the delete operation is complete.
27
+ */
28
+ deleteView(viewId: string): Promise<void>;
29
+ /**
30
+ * Creates a new view on the API.
31
+ *
32
+ * @param {CreateViewRequest} data - The data for the new view.
33
+ * @returns {Promise<View>} A promise that resolves with the newly created view.
34
+ */
35
+ createView(data: CreateViewRequest): Promise<View>;
36
+ /**
37
+ * Updates an existing view on the API.
38
+ *
39
+ * @param {string} viewId - The ID of the view to update.
40
+ * @param {UpdateViewRequest} data - The updated data for the view.
41
+ * @returns {Promise<View>} A promise that resolves with the updated view.
42
+ */
43
+ updateView(viewId: string, data: UpdateViewRequest): Promise<View>;
44
+ }
45
+ export { ViewsApi, type View, type OwnedView, type SharedView, type ViewOwner, type CreateViewRequest, type UpdateViewRequest, };
package/build/views/index.js ADDED
@@ -0,0 +1,60 @@
1
+ import { BaseApi } from "../base-api";
2
+ /**
3
+ * The name of the resource to be used in API requests.
4
+ * @constant
5
+ * @private
6
+ * @type {string}
7
+ */
8
+ const resourceName = "v2/views";
9
+ /**
10
+ * A class for accessing the Views API.
11
+ * @extends BaseApi
12
+ */
13
+ class ViewsApi extends BaseApi {
14
+ /**
15
+ * Gets a list of accessable viees from the API.
16
+ *
17
+ * @returns {Promise<ApiRecords<View>>} A promise that resolves with the list of views.
18
+ */
19
+ async getViews() {
20
+ return await this.get(resourceName);
21
+ }
22
+ /**
23
+ * Gets a single view from the API by its ID.
24
+ *
25
+ * @param {number} viewId - The ID of the view to retrieve.
26
+ * @returns {Promise<View>} A promise that resolves with the view.
27
+ */
28
+ async getView(viewId) {
29
+ return await this.get(`${resourceName}/${viewId}`);
30
+ }
31
+ /**
32
+ * Deletes a single view from the API by its ID.
33
+ *
34
+ * @param {number} viewId - The ID of the view to delete.
35
+ * @returns {Promise<void>} A promise that resolves when the delete operation is complete.
36
+ */
37
+ async deleteView(viewId) {
38
+ await this.delete(`${resourceName}/${viewId}`);
39
+ }
40
+ /**
41
+ * Creates a new view on the API.
42
+ *
43
+ * @param {CreateViewRequest} data - The data for the new view.
44
+ * @returns {Promise<View>} A promise that resolves with the newly created view.
45
+ */
46
+ async createView(data) {
47
+ return await this.post(`${resourceName}`, data);
48
+ }
49
+ /**
50
+ * Updates an existing view on the API.
51
+ *
52
+ * @param {string} viewId - The ID of the view to update.
53
+ * @param {UpdateViewRequest} data - The updated data for the view.
54
+ * @returns {Promise<View>} A promise that resolves with the updated view.
55
+ */
56
+ async updateView(viewId, data) {
57
+ return await this.put(`${resourceName}/${viewId}`, data);
58
+ }
59
+ }
60
+ export { ViewsApi, };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@narrative.io/data-collaboration-sdk-ts",
3
- "version": "2.24.0",
3
+ "version": "2.25.0",
4
4
  "main": "build/index.js",
5
5
  "repository": "github:narrative-io/data-collaboration-sdk-ts",
6
6
  "source": "src/index.ts",
@@ -29,7 +29,7 @@
29
29
  "@types/jest": "29.5.14",
30
30
  "babel-jest": "29.7.0",
31
31
  "jest": "29.7.0",
32
- "lefthook": "1.8.2",
32
+ "lefthook": "1.8.4",
33
33
  "ts-jest": "29.2.5"
34
34
  },
35
35
  "dependencies": {