@narrative.io/data-collaboration-sdk-ts 0.0.55 → 0.0.56

package/build/authentication/index.d.ts

@@ -0,0 +1,23 @@
+import { BaseApi } from '../base-api';
+import { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser } from './types';
+/**
+ * A class for accessing the Authentication API
+ * @extends BaseApi
+ */
+declare class AuthenticationApi extends BaseApi {
+    /**
+     * Logs in the user.
+     *
+     * @param {LoginRequest} loginRequest - The login request object.
+     * @returns {Promise<LoginResponse>} - A promise that resolves to the login response.
+     */
+    login(loginRequest: LoginRequest): Promise<LoginResponse>;
+    /**
+     * Registers a new user.
+     *
+     * @param {RegisterRequest} registerRequest - The register request object.
+     * @returns {Promise<RegisterResponse>} - A promise that resolves to the register response.
+     */
+    register(registerRequest: RegisterRequest): Promise<RegisterResponse>;
+}
+export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, AuthenticationApi };

package/build/authentication/index.js

@@ -0,0 +1,33 @@
+import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'authentication';
+/**
+ * A class for accessing the Authentication API
+ * @extends BaseApi
+ */
+class AuthenticationApi extends BaseApi {
+    /**
+     * Logs in the user.
+     *
+     * @param {LoginRequest} loginRequest - The login request object.
+     * @returns {Promise<LoginResponse>} - A promise that resolves to the login response.
+     */
+    async login(loginRequest) {
+        return await this.post(`${resourceName}/login`, loginRequest);
+    }
+    /**
+     * Registers a new user.
+     *
+     * @param {RegisterRequest} registerRequest - The register request object.
+     * @returns {Promise<RegisterResponse>} - A promise that resolves to the register response.
+     */
+    async register(registerRequest) {
+        return await this.post(`${resourceName}/register`, registerRequest);
+    }
+}
+export { AuthenticationApi };

package/build/authentication/types.d.ts

@@ -0,0 +1,24 @@
+export interface LoginRequest {
+    stytch_token: string;
+    session_duration_minutes?: number;
+}
+export interface LoginResponse {
+    user: LoggedInUser;
+    api_token: string;
+    stytch_session_token: string;
+    stytch_session_jwt: string;
+}
+export interface RegisterRequest {
+    stytch_token: string;
+    name?: string;
+    company_name: string;
+}
+export interface RegisterResponse {
+    user_id: number;
+}
+export interface LoggedInUser {
+    id: number;
+    name: string;
+    company_id: number;
+    company_name: string;
+}

package/build/authentication/types.js

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

package/build/index.d.ts

@@ -21,8 +21,9 @@ import { DataStreamsApi, type DataStream } from './data-streams';
 import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from './forecast';
 import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
+import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser } from './authentication';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, type Resource, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, getNqlObject, buildNql };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, type Resource, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, 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, getNqlObject, buildNql };

package/build/index.js

@@ -15,7 +15,8 @@ import { DataStreamsApi } from './data-streams';
 import { ForecastApi } from './forecast';
 import { ContractsApi } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
+import { AuthenticationApi } from './authentication';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, getNqlObject, buildNql };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, getNqlObject, buildNql };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.55",
+  "version": "0.0.56",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",