@narrative.io/data-collaboration-sdk-ts 0.0.148 → 0.0.150

package/build/index.d.ts

@@ -4,6 +4,7 @@ import { HealthCheckApi } from "./health";
 import { RosettaStoneApi } from "./rosetta-stone";
 import { type Environment, type Config, type ApiRecords, type MonetaryAmount } from "./types";
 import type { DatasetTableSummaryAPIResponse, Dataset, DatasetTableSummary, FilePerSnapshotResponse, RetentionPolicy, UpdateDatasetRequest, SchemaFileConfigType, SchemaPropertiesType, DatasetStatus, DatasetWriteMode, SchemaFileConfig, SchemaProperties, SchemaProperty, SchemaPrimitiveProperty, SchemaObjectProperty, SchemaArrayProperty, SchemaArrayItems, SchemaArrayItemsPrimitive, SchemaArrayItemsObject, SchemaArrayItemsArray, Schema, AdvancedStatisticsMetadata, SnapshotRange, Configuration, Columns, ColumnSummary, ColumnStatistics, BasicStatistics, AdvancedStatistics, Histogram, Value, CreateDatasetRequest, IngestDatasetFileRequest } from "./datasets/types";
+import { type User } from "./whoami/types";
 import { type HealthCheckResult } from "./health/types";
 import { type SampleRecords } from "./rosetta-stone/types";
 import { AttributeApi } from "./attributes";
@@ -30,8 +31,9 @@ import { MappingsApi } from "./mappings";
 import { type AccessRule, AccessRulesApi } from "./access-rules/";
 import { type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, SubscriptionsApi } from "./subscriptions";
 import { type Job, JobsApi } from "./jobs";
+import { WhoAmIApi } from "./whoami";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, 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 FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, 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 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 ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, 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, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, 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, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, 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 FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, 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 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 ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, 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 User, compileStatement, parseStatement, };

package/build/index.js

@@ -23,6 +23,7 @@ import { MappingsApi } from "./mappings";
 import { AccessRulesApi } from "./access-rules/";
 import { SubscriptionsApi, } from "./subscriptions";
 import { JobsApi } from "./jobs";
+import { WhoAmIApi } from "./whoami";
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [
@@ -46,5 +47,6 @@ applyMixins(NarrativeApi, [
     AccessRulesApi,
     SubscriptionsApi,
     JobsApi,
+    WhoAmIApi,
 ]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, 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, compileStatement, parseStatement, };

package/build/nql/AstParser.d.ts

@@ -1,15 +1,15 @@
 import * as ast from "./Ast";
-type Statement = CreateMaterializedView | Explain;
-interface CreateMaterializedView {
+export type Statement = CreateMaterializedView | Explain;
+export interface CreateMaterializedView {
     type: "create_materialized_view";
     name: string;
     select: Select;
 }
-interface Explain {
+export interface Explain {
     type: "explain";
     query: Select;
 }
-interface Select {
+export interface Select {
     type: "select";
     budget: ast.NqlBudget | null;
     columns: Expression[];
@@ -17,184 +17,183 @@ interface Select {
     from: Table[] | Raw;
     where: BooleanExpression | Raw | null;
 }
-type Expression = ArithmeticExpression | BooleanExpression | ColumnRef | Lit | FunctionCall | StringExpression | UnaryMinus | Raw;
-interface Raw {
+export type Expression = ArithmeticExpression | BooleanExpression | ColumnRef | Lit | FunctionCall | StringExpression | UnaryMinus | Raw;
+export interface Raw {
     type: "nql";
     as?: string;
     nql: string;
 }
-interface Deduplication {
+export interface Deduplication {
     type: "deduplication";
     expressions: Expression[];
 }
-type ColumnRef = AttributeRef | DatasetColumnRef | RawRef;
-type ArithmeticExpression = BinaryArithmeticExpression | UnaryMinus;
-type BinaryArithmeticExpression = Add | Divide | Multiply | Subtract;
-type BooleanExpression = And | Between | Equals | NotEquals | Gt | Gte | In | IsNull | Like | Lt | Lte | Not | Or;
-type StringExpression = Concat;
-type Table = RosettaTable | DatasetTable | RawTable;
-interface RosettaTable {
+export type ColumnRef = AttributeRef | DatasetColumnRef | RawRef;
+export type ArithmeticExpression = BinaryArithmeticExpression | UnaryMinus;
+export type BinaryArithmeticExpression = Add | Divide | Multiply | Subtract;
+export type BooleanExpression = And | Between | Equals | NotEquals | Gt | Gte | In | IsNull | Like | Lt | Lte | Not | Or;
+export type StringExpression = Concat;
+export type Table = RosettaTable | DatasetTable | RawTable;
+export interface RosettaTable {
     type: "rosetta_stone";
     as?: string;
     join?: Join;
 }
-interface DatasetTable {
+export interface DatasetTable {
     type: "dataset";
     as?: string;
     datasetId: number;
     join?: Join;
 }
-interface RawTable {
+export interface RawTable {
     type: "raw_table";
     as?: string;
     nql: string;
     join?: Join;
 }
-interface Join {
+export interface Join {
     type: "join";
     condition: BooleanExpression | Raw | null;
     conditionType: ast.NqlJoinConditionType;
     joinType: ast.NqlJoinType;
 }
-interface AttributeRef {
+export interface AttributeRef {
     type: "attribute_ref";
     as?: string;
     name: string;
     column: string;
 }
-interface DatasetColumnRef {
+export interface DatasetColumnRef {
     type: "dataset_column_ref";
     as?: string;
     column: string;
     datasetId: number;
 }
-interface RawRef {
+export interface RawRef {
     type: "raw_ref";
     as?: string;
     nql: string;
 }
-interface Lit {
+export interface Lit {
     type: "lit";
     as?: string;
     value_type: ast.NqlSimpleType;
     value: string | null;
 }
-interface FunctionCall {
+export interface FunctionCall {
     type: "function";
     as?: string;
     args: Expression[];
     name: string;
 }
-interface Add {
+export interface Add {
     type: "+";
     as?: string;
     operands: Expression[];
 }
-interface Divide {
+export interface Divide {
     type: "/";
     as?: string;
     operands: Expression[];
 }
-interface Multiply {
+export interface Multiply {
     type: "*";
     as?: string;
     operands: Expression[];
 }
-interface Subtract {
+export interface Subtract {
     type: "-";
     as?: string;
     operands: Expression[];
 }
-interface UnaryMinus {
+export interface UnaryMinus {
     type: "unary_-";
     as?: string;
     operand: Expression;
 }
-interface And {
+export interface And {
     type: "and";
     as?: string;
     operands: Expression[];
 }
-interface Or {
+export interface Or {
     type: "or";
     as?: string;
     operands: Expression[];
 }
-interface Not {
+export interface Not {
     type: "not";
     as?: string;
     operand: BooleanExpression | Raw;
 }
 /** Implicitly we only support asymmetric betweens. */
-interface Between {
+export interface Between {
     type: "between";
     as?: string;
     operand: Expression;
     lower: Expression;
     upper: Expression;
 }
-interface Equals {
+export interface Equals {
     type: "=";
     as?: string;
     left: Expression;
     right: Expression;
 }
-interface NotEquals {
+export interface NotEquals {
     type: "<>";
     as?: string;
     left: Expression;
     right: Expression;
 }
-interface Lt {
+export interface Lt {
     type: "<";
     as?: string;
     left: Expression;
     right: Expression;
 }
-interface Lte {
+export interface Lte {
     type: "<=";
     as?: string;
     left: Expression;
     right: Expression;
 }
-interface Gt {
+export interface Gt {
     type: ">";
     as?: string;
     left: Expression;
     right: Expression;
 }
-interface Gte {
+export interface Gte {
     type: ">=";
     as?: string;
     left: Expression;
     right: Expression;
 }
-interface In {
+export interface In {
     type: "in";
     as?: string;
     negated: boolean;
     expression: Expression;
     values: Expression[] | Raw;
 }
-interface IsNull {
+export interface IsNull {
     type: "is_null";
     as?: string;
     negated: boolean;
     operand: Expression;
 }
-interface Like {
+export interface Like {
     type: "like";
     as?: string;
     negated: boolean;
     value: Expression;
     pattern: string;
 }
-interface Concat {
+export interface Concat {
     type: "||";
     as?: string;
     operands: Expression[];
 }
-export type { CreateMaterializedView, Deduplication, Explain, Expression, Raw, Select, Statement, Table, };
 export declare function parseStatement(n: ast.NqlAst): Statement | Raw;
 export declare function parseCreateMaterializedView(n: ast.NqlCreateMaterializedView): CreateMaterializedView;
 export declare function parseExplain(n: ast.NqlExplain): Explain | Raw;

package/build/whoami/index.d.ts

@@ -0,0 +1,14 @@
+import { BaseApi } from "../base-api";
+import { type User } from "../whoami/types";
+/**
+ * A class for accessing the Ping API.
+ * @extends BaseApi
+ */
+export declare class WhoAmIApi extends BaseApi {
+    /**
+     * The the current users information from the API.
+     *
+     * @returns {Promise<User>} A promise that resolves with the result of the WhoAmI call.
+     */
+    getWhoAmI(): Promise<User>;
+}

package/build/whoami/index.js

@@ -0,0 +1,22 @@
+import { BaseApi } from "../base-api";
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = "whoami";
+/**
+ * A class for accessing the Ping API.
+ * @extends BaseApi
+ */
+export class WhoAmIApi extends BaseApi {
+    /**
+     * The the current users information from the API.
+     *
+     * @returns {Promise<User>} A promise that resolves with the result of the WhoAmI call.
+     */
+    async getWhoAmI() {
+        return await this.get(resourceName);
+    }
+}

package/build/whoami/types.d.ts

@@ -0,0 +1,30 @@
+export interface User {
+    user_id: number;
+    name: string;
+    company_access_list: number[];
+    current_company_scope: CompanyScope;
+    permissions: Permission[];
+    created_at: string;
+    created_by: null | string;
+    last_updated_at: string;
+    last_updated_by: null | string;
+}
+export interface CompanyScope {
+    company_id: number;
+    slug: null | string;
+    name: string;
+    short_description: null | string;
+    long_description: null | string;
+    contact_email: null | string;
+    website: null | string;
+    data_shop_url: null | string;
+    twitter_link: null | string;
+    linkedin_link: null | string;
+    image_url: string;
+    status: string;
+    visibility: string;
+}
+export interface Permission {
+    resource: string;
+    access: string[];
+}

package/build/whoami/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.148",
+  "version": "0.0.150",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -23,8 +23,8 @@
     "@babel/core": "^7.22.5",
     "@babel/preset-env": "^7.22.5",
     "@babel/preset-typescript": "^7.18.6",
-    "@commitlint/cli": "^17.4.2",
-    "@commitlint/config-conventional": "^17.4.2",
+    "@commitlint/cli": "^18.2.0",
+    "@commitlint/config-conventional": "^18.1.0",
     "@types/jest": "^29.5.0",
     "babel-jest": "^29.4.3",
     "eslint-config-prettier": "^9.0.0",