@narrative.io/data-collaboration-sdk-ts 0.0.107 → 0.0.109

package/build/index.d.ts

@@ -1,34 +1,35 @@
-import { BaseApi } from './base-api';
-import { DatasetApi } from './datasets';
-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 } from './datasets/types';
-import { type HealthCheckResult } from './health/types';
-import { type SampleRecords } from './rosetta-stone/types';
-import { AttributeApi } from './attributes';
-import { type Resource, ResourceApi, type BucketCreationRequest, type UpdateAccessTypeRequest } from './resources';
-import { type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute } from './attributes/types';
-import { PingApi } from './ping';
-import { UploadsApi } from './uploads';
-import { type UploadsResponse } from './uploads/types';
-import { type PingStatus } from './ping/types';
-import { type Product, ProductsApi } from './products';
-import { CompanyInfoApi, type CompanyInfo } from './company-info';
-import { InstallationsApi, type Installation } from './installations';
-import { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression } from './nql';
-import { DataStreamsApi, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } 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 { convertNqlObjectToForecastBody } from './nql/DataRulesConverter';
-import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse } from './authentication';
-import { AppsApi, type App } from './apps';
-import type { ForecastBody } from './nql/types';
-import { type ConversationMessageRole, isConversationMessageRole, type ConversationMessageName, isConversationMessageName, type ConversationUserMessage, isConversationUserMessage, type ConversationAssistantMessage, isConversationAssistantMessage, type ConversationSystemMessage, isConversationSystemMessage, type ConversationFunctionMessage, isConversationFunctionMessage, type ConversationMessage, isConversationMessage, type ConversationIOMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaRequestMessage, isRosettaRequestMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall } from './rosetta/types';
-import { MappingsApi } from './mappings';
+import { BaseApi } from "./base-api";
+import { DatasetApi } from "./datasets";
+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 } from "./datasets/types";
+import { type HealthCheckResult } from "./health/types";
+import { type SampleRecords } from "./rosetta-stone/types";
+import { AttributeApi } from "./attributes";
+import { type Resource, ResourceApi, type BucketCreationRequest, type UpdateAccessTypeRequest } from "./resources";
+import { type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute } from "./attributes/types";
+import { PingApi } from "./ping";
+import { UploadsApi } from "./uploads";
+import { type UploadsResponse } from "./uploads/types";
+import { type PingStatus } from "./ping/types";
+import { type Product, ProductsApi } from "./products";
+import { CompanyInfoApi, type CompanyInfo } from "./company-info";
+import { InstallationsApi, type Installation } from "./installations";
+import { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression } from "./nql";
+import { DataStreamsApi, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } 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 { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
+import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse } from "./authentication";
+import { AppsApi, type App } from "./apps";
+import type { ForecastBody } from "./nql/types";
+import { type ConversationMessageRole, isConversationMessageRole, type ConversationMessageName, isConversationMessageName, type ConversationUserMessage, isConversationUserMessage, type ConversationAssistantMessage, isConversationAssistantMessage, type ConversationSystemMessage, isConversationSystemMessage, type ConversationFunctionMessage, isConversationFunctionMessage, type ConversationMessage, isConversationMessage, type ConversationIOMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaRequestMessage, isRosettaRequestMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall } from "./rosetta/types";
+import { MappingsApi } from "./mappings";
+import { type AccessRule, AccessRulesApi } from "./access-rules/";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AppsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, 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 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 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 };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, 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 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 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, };

package/build/index.js

@@ -1,26 +1,46 @@
-import { BaseApi } from './base-api';
-import { DatasetApi } from './datasets';
-import { HealthCheckApi } from './health';
-import { RosettaStoneApi } from './rosetta-stone';
-import { applyMixins } from './utils';
-import { AttributeApi } from './attributes';
-import { ResourceApi } from './resources';
-import { PingApi } from './ping';
-import { UploadsApi } from './uploads';
-import { ProductsApi } from './products';
-import { CompanyInfoApi } from './company-info';
-import { InstallationsApi } from './installations';
-import { NqlApi } from './nql';
-import { DataStreamsApi } from './data-streams';
-import { ForecastApi } from './forecast';
-import { ContractsApi } from './contracts';
-import { getNqlObject, buildNql } from './nql/NQLParser';
-import { convertNqlObjectToForecastBody } from './nql/DataRulesConverter';
-import { AuthenticationApi } from './authentication';
-import { AppsApi } from './apps';
-import { isConversationMessageRole, isConversationMessageName, isConversationUserMessage, isConversationAssistantMessage, isConversationSystemMessage, isConversationFunctionMessage, isConversationMessage, isConversationInputMessage, isConversationMessages, isType, isRosettaRequestMessage, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall } from './rosetta/types';
-import { MappingsApi } from './mappings';
+import { BaseApi } from "./base-api";
+import { DatasetApi } from "./datasets";
+import { HealthCheckApi } from "./health";
+import { RosettaStoneApi } from "./rosetta-stone";
+import { applyMixins } from "./utils";
+import { AttributeApi } from "./attributes";
+import { ResourceApi, } from "./resources";
+import { PingApi } from "./ping";
+import { UploadsApi } from "./uploads";
+import { ProductsApi } from "./products";
+import { CompanyInfoApi } from "./company-info";
+import { InstallationsApi } from "./installations";
+import { NqlApi, } from "./nql";
+import { DataStreamsApi, } from "./data-streams";
+import { ForecastApi, } from "./forecast";
+import { ContractsApi, } from "./contracts";
+import { getNqlObject, buildNql } from "./nql/NQLParser";
+import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
+import { AuthenticationApi, } from "./authentication";
+import { AppsApi } from "./apps";
+import { isConversationMessageRole, isConversationMessageName, isConversationUserMessage, isConversationAssistantMessage, isConversationSystemMessage, isConversationFunctionMessage, isConversationMessage, isConversationInputMessage, isConversationMessages, isType, isRosettaRequestMessage, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, } from "./rosetta/types";
+import { MappingsApi } from "./mappings";
+import { AccessRulesApi } from "./access-rules/";
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AppsApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall };
+applyMixins(NarrativeApi, [
+    BaseApi,
+    HealthCheckApi,
+    DatasetApi,
+    RosettaStoneApi,
+    AttributeApi,
+    PingApi,
+    CompanyInfoApi,
+    InstallationsApi,
+    UploadsApi,
+    ResourceApi,
+    NqlApi,
+    DataStreamsApi,
+    ForecastApi,
+    ContractsApi,
+    AuthenticationApi,
+    MappingsApi,
+    AppsApi,
+    AccessRulesApi,
+]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, };

package/build/installations/index.d.ts

@@ -1,6 +1,6 @@
-import { type ApiRecords } from '../types';
-import { BaseApi } from '../base-api';
-import { type Installation } from './types';
+import { type ApiRecords } from "../types";
+import { BaseApi } from "../base-api";
+import { type Installation } from "./types";
 /**
  * @module InstallationsApi
  * @description This module provides methods for fetching installation records.

package/build/installations/index.js

@@ -1,5 +1,5 @@
-import { BaseApi } from '../base-api';
-const resourceName = 'installations';
+import { BaseApi } from "../base-api";
+const resourceName = "installations";
 /**
  * @module InstallationsApi
  * @description This module provides methods for fetching installation records.
@@ -12,7 +12,7 @@ class InstallationsApi extends BaseApi {
      * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
      */
     async getInstallations(appCategory) {
-        const appCategoryQuery = appCategory !== undefined ? `?app_category=${appCategory}` : '';
+        const appCategoryQuery = appCategory !== undefined ? `?app_category=${appCategory}` : "";
         const url = `${resourceName}${appCategoryQuery}`;
         return await this.get(url);
     }

package/build/installations/types.d.ts

@@ -10,5 +10,5 @@ export interface Permission {
     acess: Access;
     resource: string;
 }
-type Access = 'read' | 'write' | 'admin' | 'create' | 'revise';
+type Access = "read" | "write" | "admin" | "create" | "revise";
 export {};

package/build/mappings/index.d.ts

@@ -1,7 +1,7 @@
-import type { Config, ApiRecords } from 'src/types';
-import { BaseApi } from '../base-api';
-import type { CreateMapping, Mapping } from './types';
-import { CompanyInfoApi } from '../company-info';
+import type { Config, ApiRecords } from "src/types";
+import { BaseApi } from "../base-api";
+import type { CreateMapping, Mapping } from "./types";
+import { CompanyInfoApi } from "../company-info";
 /**
  * A class for accessing the Mappings API.
  * @extends BaseApi
@@ -10,20 +10,20 @@ declare class MappingsApi extends BaseApi {
     private readonly companyInfoApi?;
     constructor(config: Config, companyInfoApi?: CompanyInfoApi | undefined);
     /**
-   * Fetches all mappings.
-   * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
-   */
+     * Fetches all mappings.
+     * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
+     */
     getMappings(): Promise<ApiRecords<Mapping>>;
     /**
-   * Creates a private (specific to a company) mapping between a dataset and an attribute.
-   *
-   * @param {CreateMapping} mapping - The mapping to be created.
-   * @param {number} [companyId] - The ID of the company. If not provided, will be fetched from the API.
-   * @returns {Promise<Mapping>} - A promise that resolves to the created mapping.
-   * @public
-   * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
-   * @async
-   */
+     * Creates a private (specific to a company) mapping between a dataset and an attribute.
+     *
+     * @param {CreateMapping} mapping - The mapping to be created.
+     * @param {number} [companyId] - The ID of the company. If not provided, will be fetched from the API.
+     * @returns {Promise<Mapping>} - A promise that resolves to the created mapping.
+     * @public
+     * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
+     * @async
+     */
     createPrivateMapping(mapping: CreateMapping, companyId?: number): Promise<Mapping>;
     /**
      * Retrieves the company ID from the API.

package/build/mappings/index.js

@@ -1,12 +1,12 @@
-import { BaseApi } from '../base-api';
-import { CompanyInfoApi } from '../company-info';
+import { BaseApi } from "../base-api";
+import { CompanyInfoApi } from "../company-info";
 /**
  * The name of the resource to be used in API requests.
  * @constant
  * @private
  * @type {string}
  */
-const resourceName = 'mappings';
+const resourceName = "mappings";
 /**
  * A class for accessing the Mappings API.
  * @extends BaseApi
@@ -21,31 +21,31 @@ class MappingsApi extends BaseApi {
                 apiKey: this.apiKey,
                 environment: this.environment,
                 verbose: this.verbose,
-                headers: this.headers
+                headers: this.headers,
             });
         }
     }
     /**
-   * Fetches all mappings.
-   * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
-   */
+     * Fetches all mappings.
+     * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
+     */
     async getMappings() {
         return await this.get(resourceName);
     }
     /**
-   * Creates a private (specific to a company) mapping between a dataset and an attribute.
-   *
-   * @param {CreateMapping} mapping - The mapping to be created.
-   * @param {number} [companyId] - The ID of the company. If not provided, will be fetched from the API.
-   * @returns {Promise<Mapping>} - A promise that resolves to the created mapping.
-   * @public
-   * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
-   * @async
-   */
+     * Creates a private (specific to a company) mapping between a dataset and an attribute.
+     *
+     * @param {CreateMapping} mapping - The mapping to be created.
+     * @param {number} [companyId] - The ID of the company. If not provided, will be fetched from the API.
+     * @returns {Promise<Mapping>} - A promise that resolves to the created mapping.
+     * @public
+     * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
+     * @async
+     */
     async createPrivateMapping(mapping, companyId) {
-        companyId = companyId ?? await this.getCompanyId();
+        companyId = companyId ?? (await this.getCompanyId());
         if (companyId === undefined)
-            throw new Error('Company ID is undefined');
+            throw new Error("Company ID is undefined");
         const resource = `${resourceName}/companies/${companyId}`;
         return await this.post(resource, mapping);
     }

package/build/mappings/types.d.ts

@@ -13,20 +13,20 @@ export interface Mapping {
     source: MappingSource;
     derived_from: string;
 }
-type MappingStatus = 'active' | 'archived' | 'pending';
-type MappingScope = 'global' | 'private';
-type MappingSource = 'system' | 'admin' | 'company';
+type MappingStatus = "active" | "archived" | "pending";
+type MappingScope = "global" | "private";
+type MappingSource = "system" | "admin" | "company";
 interface PropertyMapping {
     path: string;
     expression: string;
 }
 interface ObjectMapping {
-    type: 'object_mapping';
+    type: "object_mapping";
     property_mappings: PropertyMapping[];
 }
 interface ValueMapping {
-    type: 'value_mapping';
+    type: "value_mapping";
     expression: string;
 }
-export type CreateMapping = Pick<Mapping, 'attribute_id' | 'dataset_id' | 'mapping'>;
+export type CreateMapping = Pick<Mapping, "attribute_id" | "dataset_id" | "mapping">;
 export {};

package/build/nql/DataRulesConverter.d.ts

@@ -1,6 +1,6 @@
-import { type ObjectAttribute } from 'src/attributes/types';
-import { type Attribute } from '../attributes';
-import type { DataRulesAttributesField, 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.

package/build/nql/DataRulesConverter.js

@@ -1,4 +1,4 @@
-import { AttributeApi } from '../attributes';
+import { AttributeApi } from "../attributes";
 /**
  * Convert an NQL object to a Forecast body.
  * @param {Nql} nqlObject - The NQL object to convert.
@@ -11,12 +11,12 @@ export async function convertNqlObjectToForecastBody(nqlObject) {
     const forecastBody = {
         as_of: new Date().toISOString(),
         details: {
-            type: 'marketplace',
+            type: "marketplace",
             pricing: price,
             data_rules: {
-                attributes: await getAttributesFromFields(fields)
-            }
-        }
+                attributes: await getAttributesFromFields(fields),
+            },
+        },
     };
     return forecastBody;
 }
@@ -29,21 +29,27 @@ export async function convertNqlObjectToForecastBody(nqlObject) {
 async function getAttributesFromFields(fields) {
     const attributesArray = [];
     const attributesApi = new AttributeApi({
-        environment: 'prod'
+        environment: "prod",
     });
     const attributes = await attributesApi.getAttributes();
-    const uniqueAttributes = [...new Set(fields.map((field) => field.field.split('.')[0]))].filter((att) => !att.startsWith('_'));
+    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 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: relevantFields.length > 0 ? relevantFields : buildField(att, findAttributeProperties(attributes.records, att)),
-            optional: fields.some(field => field.field.startsWith(att + '.') && field.filter === undefined)
+            fields: relevantFields.length > 0
+                ? relevantFields
+                : buildField(att, findAttributeProperties(attributes.records, att)),
+            optional: fields.some((field) => field.field.startsWith(att + ".") && field.filter === undefined),
         });
     });
     ensureAtLeastOneRequired(attributesArray);
@@ -67,8 +73,8 @@ async function getAttributesFromFields(fields) {
  * // The array is now guaranteed to have at least one object with `optional` set to `false`.
  */
 function ensureAtLeastOneRequired(dataRulesAttributes) {
-    const exportedAttributes = dataRulesAttributes.filter(item => item.fields.filter(field => field.exported).length > 0);
-    const hasMandatory = exportedAttributes.some(item => !item.optional);
+    const exportedAttributes = dataRulesAttributes.filter((item) => item.fields.filter((field) => field.exported).length > 0);
+    const hasMandatory = exportedAttributes.some((item) => !item.optional);
     if (!hasMandatory) {
         const randomIndex = Math.floor(Math.random() * exportedAttributes.length);
         exportedAttributes[randomIndex].optional = false;
@@ -81,22 +87,27 @@ function ensureAtLeastOneRequired(dataRulesAttributes) {
  * @throws {Error} - Throws an error if price filter conditions are not met.
  */
 function getPriceFromNql(nqlObject) {
-    const priceFilter = nqlObject.where.filterExpressions.filter((expr) => ('left' in expr && typeof expr.left === 'object' && expr.left.field === '_price_cpm_usd') || ('right' in expr && typeof expr.right === 'object' && expr.right.field === '_price_cpm_usd'));
+    const priceFilter = nqlObject.where.filterExpressions.filter((expr) => ("left" in expr &&
+        typeof expr.left === "object" &&
+        expr.left.field === "_price_cpm_usd") ||
+        ("right" in expr &&
+            typeof expr.right === "object" &&
+            expr.right.field === "_price_cpm_usd"));
     if (priceFilter.length !== 1) {
-        throw new Error('Expected exactly one price filter');
+        throw new Error("Expected exactly one price filter");
     }
-    if (typeof priceFilter[0].right === 'number') {
+    if (typeof priceFilter[0].right === "number") {
         return {
-            micro_cents_usd: priceFilter[0].right * 100000000
+            micro_cents_usd: priceFilter[0].right * 100000000,
         };
     }
-    else if (typeof priceFilter[0].left === 'number') {
+    else if (typeof priceFilter[0].left === "number") {
         return {
-            micro_cents_usd: priceFilter[0].left * 100000000
+            micro_cents_usd: priceFilter[0].left * 100000000,
         };
     }
     else {
-        throw new Error('Expected one side of price filter to be a number');
+        throw new Error("Expected one side of price filter to be a number");
     }
 }
 /**
@@ -108,7 +119,10 @@ function getFieldsFromNql(nqlObject) {
     const fieldsArray = [];
     // Extract all fields from the 'select' section and mark them as exported.
     nqlObject.select.forEach((field) => {
-        fieldsArray.push({ field: field.field.replace('"value"', 'value').replace('"type"', 'type'), exported: true });
+        fieldsArray.push({
+            field: field.field.replace('"value"', "value").replace('"type"', "type"),
+            exported: true,
+        });
     });
     // Process all filter expressions from the 'where' section.
     nqlObject.where.filterExpressions.forEach((expression) => {
@@ -122,11 +136,13 @@ function getFieldsFromNql(nqlObject) {
  * @param {DataRulesAttributesField[]} fieldsArray - The array to populate with fields.
  */
 function handleFilterExpression(expression, fieldsArray) {
-    if ('field' in expression) {
+    if ("field" in expression) {
         updateFieldsArray(expression.field, fieldsArray, constructUnaryFilterExpression(expression));
     }
     else {
-        if (typeof expression.right === 'object' && expression.right !== null && 'field' in expression.right) {
+        if (typeof expression.right === "object" &&
+            expression.right !== null &&
+            "field" in expression.right) {
             updateFieldsArray(expression.right, fieldsArray, constructBinaryFilterExpression(expression));
         }
         else {
@@ -143,7 +159,9 @@ function handleFilterExpression(expression, fieldsArray) {
 function updateFieldsArray(field, fieldsArray, filterExpression) {
     const existingEntry = fieldsArray.find((entry) => entry.field === field.field);
     if (existingEntry !== undefined) {
-        if (existingEntry.filter !== undefined && typeof existingEntry.filter === 'object' && 'expressions' in existingEntry.filter) {
+        if (existingEntry.filter !== undefined &&
+            typeof existingEntry.filter === "object" &&
+            "expressions" in existingEntry.filter) {
             // If there are already filter expressions for this field, push the new one to the array.
             existingEntry.filter.expressions.push(filterExpression);
         }
@@ -154,7 +172,11 @@ function updateFieldsArray(field, fieldsArray, filterExpression) {
     }
     else {
         // If this field does not exist in the fieldsArray, add it with the new filter expression.
-        fieldsArray.push({ field: field.field, exported: false, filter: { expressions: [filterExpression] } });
+        fieldsArray.push({
+            field: field.field,
+            exported: false,
+            filter: { expressions: [filterExpression] },
+        });
     }
 }
 /**
@@ -179,13 +201,13 @@ function constructBinaryFilterExpression(filter) {
  * @returns {string} - Returns the string representation of the expression.
  */
 function expressionToString(expr) {
-    if (typeof expr === 'string') {
+    if (typeof expr === "string") {
         return `${addParentheses(expr)}`;
     }
-    else if (typeof expr === 'number') {
+    else if (typeof expr === "number") {
         return expr.toString();
     }
-    else if (typeof expr === 'boolean') {
+    else if (typeof expr === "boolean") {
         return expr.toString();
     }
     else {
@@ -211,7 +233,7 @@ function addParentheses(input) {
     // Regular expression that matches 'CURRENT_TIMESTAMP' or 'CURRENT_DATE' that is not followed by ()
     const regex = /(CURRENT_TIMESTAMP|CURRENT_DATE)(?!\(\))/g;
     // Replace matched string with itself followed by ()
-    return input.replace(regex, '$1()');
+    return input.replace(regex, "$1()");
 }
 /**
  * Looks for an attribute with the given name and checks if it is of type 'object'.
@@ -228,12 +250,14 @@ function addParentheses(input) {
  */
 export function isObject(attributes, name) {
     // Look for the attribute with the given name.
-    const attribute = attributes.find(attr => attr.name === 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;
+    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.
@@ -271,7 +295,7 @@ export function buildField(attribute, properties) {
     return properties.map((property) => {
         return {
             field: `${attribute}.${property}`,
-            exported: true
+            exported: true,
         };
     });
 }

package/build/nql/NQLParser.d.ts

@@ -1,4 +1,4 @@
-import { type Nql, type NqlBudget, type NqlField, type NqlFilterExpression, type NqlPreSelectExpression, type NqlTable, type NqlWhere } from './types';
+import { type Nql, type NqlBudget, type NqlField, type NqlFilterExpression, type NqlPreSelectExpression, type NqlTable, type NqlWhere } from "./types";
 /**
  * Retrieves the WHERE clause from the given NQL (Nested Query Language) string and returns a parsed NqlWhereClause object.
  *
@@ -80,8 +80,8 @@ export declare function buildNql(nql: Nql | SemanticNql, strict?: NotStrict): st
 export declare function buildFrom(from: NqlTable): string;
 export declare function buildWhere(where: NqlWhere): string;
 export declare function buildField(field: NqlField | string | number | boolean): string;
-type ParseType = 'full' | 'semantic';
-type SemanticNql = Omit<Nql, 'explain' | 'limit'>;
-export declare function getNqlObject<T extends ParseType = 'full'>(nql: string, type?: T): T extends 'full' ? Nql : SemanticNql;
+type ParseType = "full" | "semantic";
+type SemanticNql = Omit<Nql, "explain" | "limit">;
+export declare function getNqlObject<T extends ParseType = "full">(nql: string, type?: T): T extends "full" ? Nql : SemanticNql;
 export declare function createSemanticWhere(expressionContainer: NqlWhere): NqlWhere;
 export {};