@narrative.io/data-collaboration-sdk-ts 0.8.0 → 0.10.0

package/build/access-rules/index.d.ts

@@ -1,12 +1,13 @@
-import type { ApiRecords } from "../types";
+import type { ApiRecords, ApiRecordsV2, PaginationOptions } from "../types";
 import { BaseApi } from "../base-api";
 import type { AccessRule, AccessRuleV2 } from "./types";
 /**
  * Represents the parameters used to retrieve access rules.
- * This interface extends a generic record allowing for string, number, boolean, or undefined values.
+ * This interface extends a generic record allowing for a range of value types including arrays.
+ * It's primarily used to filter access rules.
  *
  * @interface GetAccessRulesParameters
- * @extends {Record<string, string | number | boolean | undefined>}
+ * @extends {Record<string, string | number | boolean | undefined | string[] | number[]>}
  *
  * @property {boolean} [owned_only] - Optional filter to retrieve only the access rules owned by the user.
  *                                    Setting this to true will fetch only the access rules that are owned.
@@ -14,25 +15,21 @@ import type { AccessRule, AccessRuleV2 } from "./types";
  * @property {boolean} [shared_only] - Optional filter to retrieve only the access rules shared with the user.
  *                                     Setting this to true will fetch only the access rules that are shared.
  *
- * @property {string} [tag] - Optional filter to retrieve access rules that are tagged with a specific tag.
- *                           Provide the tag string to fetch access rules associated with it.
+ * @property {string | string[]} [tag] - Optional filter to retrieve access rules tagged with a specific tag or tags.
+ *                                       Provide a single tag or an array of tags to fetch access rules associated with them.
  *
- * @property {number} [company_id] - Optional filter to retrieve access rules associated with a specific company.
- *                                   Provide the company ID to fetch access rules related to that company.
+ * @property {number | number[]} [company_id] - Optional filter to retrieve access rules associated with a specific company or companies.
+ *                                              Provide a company ID or an array of IDs to fetch access rules related to those companies.
  *
- * @property {number} [offset] - Optional pagination parameter that specifies the starting point for the list of results.
- *                               Provide an offset number to skip a specific number of records in the result set.
- *
- * @property {number} [per_page] - Optional pagination parameter that specifies the number of records to return per page.
- *                                 Provide a number to set the maximum number of records returned in one page of results.
+ * @property {number | number[]} [dataset_id] - Optional filter to retrieve access rules associated with a specific dataset or datasets.
+ *                                              Provide a dataset ID or an array of IDs to fetch access rules related to those datasets.
  */
-interface GetAccessRulesParameters extends Record<string, string | number | boolean | undefined> {
+interface GetAccessRulesParameters extends Record<string, string | number | boolean | undefined | string[] | number[]> {
     owned_only?: boolean;
     shared_only?: boolean;
-    tag?: string;
-    company_id?: number;
-    offset?: number;
-    per_page?: number;
+    tag?: string | string[];
+    company_id?: number | number[];
+    dataset_id?: number | number[];
 }
 /**
  * @module AccessRulesApi
@@ -107,6 +104,6 @@ declare class AccessRulesApi extends BaseApi {
      * @description This method fetches access rules based on the specified filters and pagination options provided in the parameters.
      *              It returns a promise that resolves to a list of access rules that match the criteria.
      */
-    getAccessableAccessRules(parameters: GetAccessRulesParameters): Promise<ApiRecords<AccessRuleV2>>;
+    getAccessableAccessRules(parameters: GetAccessRulesParameters & PaginationOptions): Promise<ApiRecordsV2<AccessRuleV2>>;
 }
 export { AccessRulesApi, type AccessRule, type AccessRuleV2, type GetAccessRulesParameters, };

package/build/access-rules/index.js

@@ -89,8 +89,7 @@ class AccessRulesApi extends BaseApi {
      *              It returns a promise that resolves to a list of access rules that match the criteria.
      */
     async getAccessableAccessRules(parameters) {
-        const queryString = this.constructQueryString(parameters);
-        return await this.get(`v2/${resourceName}${queryString}`);
+        return await this.get(`v2/${resourceName}`, parameters);
     }
 }
 export { AccessRulesApi, };

package/build/base-api.d.ts

@@ -1,5 +1,5 @@
 import { type MandeInstance } from "mande";
-import { type Config } from "./types";
+import { type PaginationOptions, type Config } from "./types";
 /**
  * BaseApi class provides basic functionality for making API requests.
  */
@@ -46,7 +46,7 @@ export declare abstract class BaseApi {
      * @returns {Promise<T>} - Promise that resolves with the response data.
      * @template T - Type of the response data.
      */
-    protected get<T>(endpoint: string): Promise<T>;
+    protected get<T>(endpoint: string, params?: Record<string, any> & PaginationOptions): Promise<T>;
     /**
      * Makes a POST request to the given endpoint with the given data.
      *
@@ -87,5 +87,5 @@ export declare abstract class BaseApi {
      * @private
      */
     private constructHeaders;
-    constructQueryString<T extends Record<string, number | string | boolean | undefined>>(parameters?: T): string;
+    protected constructQueryString<T extends Record<string, any>>(parameters?: T): string;
 }

package/build/base-api.js

@@ -70,13 +70,15 @@ export class BaseApi {
      * @returns {Promise<T>} - Promise that resolves with the response data.
      * @template T - Type of the response data.
      */
-    async get(endpoint) {
+    async get(endpoint, params) {
+        const queryString = this.constructQueryString(params);
+        const url = `${endpoint}${queryString}`;
         if (this.verbose) {
-            console.log(`Making GET request to ${endpoint}...`);
-            const resp = await this.base_api.get(endpoint);
+            console.log(`Making GET request to ${url}...`);
+            const resp = await this.base_api.get(url);
             console.log(`Response: ${JSON.stringify(resp)}`);
         }
-        return await this.base_api.get(endpoint);
+        return await this.base_api.get(url);
     }
     /**
      * Makes a POST request to the given endpoint with the given data.
@@ -153,16 +155,18 @@ export class BaseApi {
     }
     constructQueryString(parameters) {
         const queryParameters = [];
-        if (parameters !== undefined) {
-            Object.keys(parameters)
-                .filter((key) => key in parameters)
-                .forEach((key) => queryParameters.push({ [key]: String(parameters[key]) }));
+        if (parameters != null) {
+            for (const [key, value] of Object.entries(parameters)) {
+                if (value !== undefined && value !== null && !Array.isArray(value)) {
+                    queryParameters.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`);
+                }
+                if (Array.isArray(value)) {
+                    for (const val of value) {
+                        queryParameters.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(val))}`);
+                    }
+                }
+            }
         }
-        const queryString = queryParameters.length > 0
-            ? queryParameters
-                .map((param) => Object.entries(param).map(([key, value]) => `${key}=${value}`))
-                .join("&")
-            : "";
-        return queryString.length > 0 ? `?${queryString}` : "";
+        return queryParameters.length > 0 ? `?${queryParameters.join("&")}` : "";
     }
 }

package/build/datasets/types.d.ts

@@ -9,7 +9,7 @@ export interface Dataset {
     retention_policy: RetentionPolicy;
     schema: Schema;
     status: DatasetStatus;
-    tags: string[];
+    tags?: string[];
     updated_at: string;
     write_mode: DatasetWriteMode;
     last_snapshot_created_at?: string;

package/build/index.d.ts

@@ -2,7 +2,7 @@ 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 Environment, type Config, type ApiRecords, type ApiRecordsV2, 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";
@@ -38,4 +38,4 @@ declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, 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 AccessRuleV2, type GetAccessRulesParameters, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type Connection, 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 Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type GetJobsParameters, 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, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, 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 AccessRuleV2, type GetAccessRulesParameters, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type Connection, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type ApiRecordsV2, 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 Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type GetJobsParameters, 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, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, compileStatement, parseStatement, };

package/build/types.d.ts

@@ -17,6 +17,9 @@ export interface Config {
     headers?: Record<string, string>;
     verbose?: boolean;
 }
+export interface ApiRecordsV2<T> extends PaginationMetadata {
+    records: T[];
+}
 export interface ApiRecords<T> {
     records: T[];
 }
@@ -30,4 +33,15 @@ export interface MonetaryAmount {
     microCentsUsd: number;
 }
 type CurrencyCode = "USD";
+export interface PaginationMetadata {
+    prev_page: number | null;
+    current_page: number;
+    next_page: number | null;
+    total_records: number;
+    total_pages: number;
+}
+export interface PaginationOptions {
+    page?: number | null;
+    per_page?: number | null;
+}
 export {};

package/package.json

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