@narrative.io/data-collaboration-sdk-ts 0.0.77 → 0.0.80

package/README.md

@@ -0,0 +1,18 @@
+# SDK
+
+## Make a release
+
+To make a new release of the SDK, create a branch, make your changes, create a commit with a message following this
+format: `chore(main): release x.y.z` where x.y.z is the release number that you want. You can calculate it like this:
+
+```bash
+VERSION=$(cat package.json | jq -r .version); \
+PATCH=$(expr $(echo $VERSION|cut -f3 -d.) + 1); \
+NEW_VERSION=$(printf "$(echo $VERSION | cut -f1,2 -d.).$PATCH\n"); \
+echo $NEW_VERSION | pbcopy; \
+echo "The new VERSION=${NEW_VERSION} is in your clipboard."
+```
+
+Push your changes to the branch, merge it to the `main` branch. Once the merge is completed (i.e., github actions
+completed) a new release pull request will be available on the github project. Merge the new pull request and the
+github actions will publish the new version of the SKD for you.

package/build/authentication/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from '../base-api';
-import { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole } from './types';
+import { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest } from './types';
 /**
  * A class for accessing the Authentication API
  * @extends BaseApi
@@ -19,5 +19,12 @@ declare class AuthenticationApi extends BaseApi {
      * @returns {Promise<RegisterResponse>} - A promise that resolves to the register response.
      */
     register(registerRequest: RegisterRequest): Promise<RegisterResponse>;
+    /**
+     * Checks the resgistration status of a user.
+     *
+     * @param {RegistrationStatusRequest} statusRewquest - request payload of user login for whom to check status.
+     * @returns {Promise<RegistrationStatus>} - A promise that resolves to the response.
+     */
+    checkRegistrationStatus(statusRequest: RegistrationStatusRequest): Promise<RegistrationStatus>;
 }
-export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, AuthenticationApi };
+export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, AuthenticationApi };

package/build/authentication/index.js

@@ -29,5 +29,14 @@ class AuthenticationApi extends BaseApi {
     async register(registerRequest) {
         return await this.post(`${resourceName}/register`, registerRequest);
     }
+    /**
+     * Checks the resgistration status of a user.
+     *
+     * @param {RegistrationStatusRequest} statusRewquest - request payload of user login for whom to check status.
+     * @returns {Promise<RegistrationStatus>} - A promise that resolves to the response.
+     */
+    async checkRegistrationStatus(statusRequest) {
+        return await this.post(`${resourceName}/registration-status`, statusRequest);
+    }
 }
 export { AuthenticationApi };

package/build/authentication/types.d.ts

@@ -43,3 +43,7 @@ export interface StytchToken {
     token_type: 'magiclinks' | 'oauth';
 }
 export type UserRole = 'global_admin' | 'partner_admin' | 'partner_user';
+export interface RegistrationStatusRequest {
+    stytch_token: StytchToken;
+}
+export type RegistrationStatus = 'complete' | 'pending';

package/build/company-info/index.d.ts

@@ -1,16 +1,21 @@
 import { BaseApi } from '../base-api';
 import { type ApiRecords } from '../types';
-import { type CompanyInfo } from './types';
+import { type CompanyInfo, type WhoAmI } from './types';
 /**
  * A class for accessing the Company Info API
  * @extends BaseApi
  */
 declare class CompanyInfoApi extends BaseApi {
     companyId: () => Promise<number>;
+    /**
+     * Get the logged in company id
+     * @returns {Promise<WhoAmI>}
+     */
+    whoami(): Promise<WhoAmI>;
     /**
      * Get a list of all providers in the Data Streams Market
      * @returns {Promise<ApiRecords<CompanyInfo[]>>} - Promise resolving to an array of CompanyInfo records
      */
     getAllProvidersCompanyInfo(): Promise<ApiRecords<CompanyInfo>>;
 }
-export { type CompanyInfo, CompanyInfoApi };
+export { type CompanyInfo, type WhoAmI, CompanyInfoApi };

package/build/company-info/index.js

@@ -14,6 +14,13 @@ class CompanyInfoApi extends BaseApi {
     companyId = async () => {
         return (await this.get(`${resourceName}/whoami`)).id;
     };
+    /**
+     * Get the logged in company id
+     * @returns {Promise<WhoAmI>}
+     */
+    async whoami() {
+        return await this.get(`${resourceName}/whoami?with_user_id=true`);
+    }
     /**
      * Get a list of all providers in the Data Streams Market
      * @returns {Promise<ApiRecords<CompanyInfo[]>>} - Promise resolving to an array of CompanyInfo records

package/build/company-info/types.d.ts

@@ -11,3 +11,7 @@ export interface CompanyInfo {
     contact: string;
     created_at: string;
 }
+export interface WhoAmI {
+    id: number;
+    userId?: number;
+}

package/build/index.d.ts

@@ -22,11 +22,11 @@ import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostFore
 import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
 import { convertNqlObjectToForecastBody } from './nql/DataRulesConverter';
-import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole } from './authentication';
+import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest } from './authentication';
 import { AppsApi, type App } from './apps';
 import type { ForecastBody } from './nql/types';
 declare class NarrativeApi extends BaseApi {
 }
 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, AuthenticationApi, AppsApi, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type RefAttribute, type SubAttribute, 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, type StytchToken, type ApiToken, type UserRole, getNqlObject, buildNql, convertNqlObjectToForecastBody, type ForecastBody };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type RefAttribute, type SubAttribute, 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, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, getNqlObject, buildNql, convertNqlObjectToForecastBody, type ForecastBody };

package/package.json

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