@narrative.io/data-collaboration-sdk-ts 0.0.74 → 0.0.76

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 } from './types';
+import { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole } from './types';
 /**
  * A class for accessing the Authentication API
  * @extends BaseApi
@@ -20,4 +20,4 @@ declare class AuthenticationApi extends BaseApi {
      */
     register(registerRequest: RegisterRequest): Promise<RegisterResponse>;
 }
-export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, AuthenticationApi };
+export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, AuthenticationApi };

package/build/authentication/types.d.ts

@@ -3,11 +3,25 @@ export interface LoginRequest {
     session_duration_minutes?: number;
 }
 export interface LoginResponse {
-    user: LoggedInUser;
-    api_token: string;
+    user: {
+        id: number;
+        email: string;
+        name: string;
+        company_id: number;
+        company_name: string;
+        role: number;
+    };
+    api_token: ApiToken;
+    legacy_token: string;
     stytch_session_token: string;
     stytch_session_jwt: string;
 }
+export interface ApiToken {
+    access_token: string;
+    access_token_expires_in: number;
+    refresh_token: string;
+    refresh_token_expires_in: number;
+}
 export interface RegisterRequest {
     stytch_token: StytchToken;
     name?: string;
@@ -18,11 +32,14 @@ export interface RegisterResponse {
 }
 export interface LoggedInUser {
     id: number;
+    email?: string;
     name: string;
     company_id: number;
     company_name: string;
+    role: UserRole;
 }
 export interface StytchToken {
     token: string;
     token_type: 'magiclinks' | 'oauth';
 }
+export type UserRole = 'global_admin' | 'partner_admin' | 'partner_user';

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 } from './authentication';
+import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole } 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, 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, getNqlObject, buildNql, convertNqlObjectToForecastBody, type ForecastBody };

package/build/nql/DataRulesConverter.d.ts

@@ -1,4 +1,6 @@
-import type { ForecastBody, Nql } from './types';
+import { type ObjectAttribute } from 'src/attributes/types';
+import { type Attribute } from '../attributes';
+import type { DataRulesAttributesField, ForecastBody, Nql } from './types';
 /**
  * Convert an NQL object to a Forecast body.
  * @param {Nql} nqlObject - The NQL object to convert.
@@ -6,3 +8,43 @@ import type { ForecastBody, Nql } from './types';
  * @throws {Error} - Throws an error if price filter conditions are not met.
  */
 export declare function convertNqlObjectToForecastBody(nqlObject: Nql): Promise<ForecastBody>;
+/**
+ * Looks for an attribute with the given name and checks if it is of type 'object'.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {ObjectAttribute | undefined} Returns the attribute if found and is of type 'object', otherwise returns undefined.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns { name: 'person', type: 'object', properties: { name: 'John Doe' } }
+ * isObject(attributes, 'person');
+ */
+export declare function isObject(attributes: Attribute[], name: string): ObjectAttribute | undefined;
+/**
+ * Finds an attribute with the given name, and if it is of type 'object', returns the names of its properties.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {string[]} An array containing the names of the properties if the attribute is of type 'object', otherwise an empty array.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns ['name']
+ * findAttributeProperties(attributes, 'person');
+ */
+export declare function findAttributeProperties(attributes: Attribute[], name: string): string[];
+/**
+ * Builds an array of field objects with names based on the given attribute and properties.
+ *
+ * @param {string} attribute - The primary attribute to be prefixed to each field.
+ * @param {string[]} properties - An array of properties that will be appended to the attribute to form the field names.
+ * @returns {DataRulesAttributesField[]} An array of field objects, where each object has a 'field' property which is a combination of the attribute and property, and an 'exported' property set to true.
+ *
+ * @example
+ * // Returns [{ field: 'person.name', exported: true }, { field: 'person.age', exported: true }]
+ * buildField('person', ['name', 'age']);
+ */
+export declare function buildField(attribute: string, properties: string[]): DataRulesAttributesField[];

package/build/nql/DataRulesConverter.js

@@ -34,13 +34,15 @@ async function getAttributesFromFields(fields) {
     const attributes = await attributesApi.getAttributes();
     const uniqueAttributes = [...new Set(fields.map((field) => field.field.split('.')[0]))].filter((att) => !att.startsWith('_'));
     uniqueAttributes.forEach((att) => {
+        const isObjectProperty = isObject(attributes.records, att);
+        const relevantFields = (isObjectProperty != null) ? fields.filter((field) => field.field.split('.')[0] === att && field.field !== att) : fields.filter((field) => field.field.split('.')[0] === att);
         const attributeId = attributes.records.find((attribute) => attribute.name === att)?.id;
         if (attributeId === undefined) {
             throw new Error(`Attribute ${att} not found`);
         }
         attributesArray.push({
             attribute_id: attributeId,
-            fields: fields.filter((field) => field.field.split('.')[0] === att),
+            fields: relevantFields.length > 0 ? relevantFields : buildField(att, findAttributeProperties(attributes.records, att)),
             optional: fields.some(field => field.field.startsWith(att + '.') && field.filter === undefined)
         });
     });
@@ -212,3 +214,65 @@ function addParentheses(input) {
     // Replace matched string with itself followed by ()
     return input.replace(regex, '$1()');
 }
+/**
+ * Looks for an attribute with the given name and checks if it is of type 'object'.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {ObjectAttribute | undefined} Returns the attribute if found and is of type 'object', otherwise returns undefined.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns { name: 'person', type: 'object', properties: { name: 'John Doe' } }
+ * isObject(attributes, 'person');
+ */
+export function isObject(attributes, name) {
+    // Look for the attribute with the given name.
+    const attribute = attributes.find(attr => attr.name === name);
+    // If no such attribute is found, return an empty array.
+    if (attribute == null) {
+        return undefined;
+    }
+    return attribute.type === 'object' && 'properties' in attribute ? attribute : undefined;
+}
+/**
+ * Finds an attribute with the given name, and if it is of type 'object', returns the names of its properties.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {string[]} An array containing the names of the properties if the attribute is of type 'object', otherwise an empty array.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns ['name']
+ * findAttributeProperties(attributes, 'person');
+ */
+export function findAttributeProperties(attributes, name) {
+    const attribute = isObject(attributes, name);
+    // If the attribute is of type 'object', return the names of its properties.
+    if (attribute != null) {
+        return Object.keys(attribute.properties);
+    }
+    return [];
+}
+/**
+ * Builds an array of field objects with names based on the given attribute and properties.
+ *
+ * @param {string} attribute - The primary attribute to be prefixed to each field.
+ * @param {string[]} properties - An array of properties that will be appended to the attribute to form the field names.
+ * @returns {DataRulesAttributesField[]} An array of field objects, where each object has a 'field' property which is a combination of the attribute and property, and an 'exported' property set to true.
+ *
+ * @example
+ * // Returns [{ field: 'person.name', exported: true }, { field: 'person.age', exported: true }]
+ * buildField('person', ['name', 'age']);
+ */
+export function buildField(attribute, properties) {
+    return properties.map((property) => {
+        return {
+            field: `${attribute}.${property}`,
+            exported: true
+        };
+    });
+}

package/package.json

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