@narrative.io/data-collaboration-sdk-ts 2.17.0 → 2.19.0

package/build/attributes/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from "../base-api";
-import type { ApiRecords } from "../types";
+import type { ApiRecords, ApiRecordsV2, PaginationOptions, SearchParams } from "../types";
 import type { ArrayAttribute, Attribute, ObjectAttribute, PrimitiveAttribute, RefAttribute, ShallowAttribute, SubAttribute } from "./types";
 /**
  * A class for accessing the Attribute API.
@@ -12,6 +12,20 @@ declare class AttributeApi extends BaseApi {
      * @returns {Promise<ApiRecords<Attribute>>} A promise that resolves with the list of attributes.
      */
     getAttributes(): Promise<ApiRecords<Attribute>>;
+}
+/**
+ * A class for accessing the Attribute API.
+ * @extends BaseApi
+ */
+declare class AttributeApiV2 extends BaseApi {
+    /**
+     * Gets a list of attributes from the API.
+     *
+     * @param {PaginationOptions} [paginationOptions] - Optional pagination parameters.
+     * @param {SearchParams} [searchParams] - Optional search parameters.
+     * @returns {Promise<ApiRecordsV2<Attribute>>} A promise that resolves with the list of attributes.
+     */
+    getAttributesV2(paginationOptions?: PaginationOptions, searchParams?: SearchParams): Promise<ApiRecordsV2<Attribute>>;
     /**
      * Gets a single attribute from the API by its ID.
      *
@@ -34,4 +48,4 @@ declare class AttributeApi extends BaseApi {
      */
     createAttribute(data: Attribute): Promise<Attribute>;
 }
-export { AttributeApi, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, };
+export { AttributeApi, AttributeApiV2, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, };

package/build/attributes/index.js

@@ -19,6 +19,33 @@ class AttributeApi extends BaseApi {
     async getAttributes() {
         return await this.get(resourceName);
     }
+}
+/**
+ * A class for accessing the Attribute API.
+ * @extends BaseApi
+ */
+class AttributeApiV2 extends BaseApi {
+    /**
+     * Gets a list of attributes from the API.
+     *
+     * @param {PaginationOptions} [paginationOptions] - Optional pagination parameters.
+     * @param {SearchParams} [searchParams] - Optional search parameters.
+     * @returns {Promise<ApiRecordsV2<Attribute>>} A promise that resolves with the list of attributes.
+     */
+    async getAttributesV2(paginationOptions, searchParams) {
+        const queryParams = new URLSearchParams();
+        if (paginationOptions?.page) {
+            queryParams.append("page", paginationOptions.page.toString());
+        }
+        if (paginationOptions?.per_page) {
+            queryParams.append("per_page", paginationOptions.per_page.toString());
+        }
+        if (searchParams?.q) {
+            queryParams.append("q", searchParams.q);
+        }
+        const url = `${resourceName}?${queryParams.toString()}`;
+        return await this.get(url);
+    }
     /**
      * Gets a single attribute from the API by its ID.
      *
@@ -47,4 +74,4 @@ class AttributeApi extends BaseApi {
         return await this.post(`${resourceName}`, data);
     }
 }
-export { AttributeApi, };
+export { AttributeApi, AttributeApiV2, };

package/build/base-api.js

@@ -21,6 +21,7 @@ export class BaseApi {
         this.headers = config.headers ?? {};
         this.base_api = mande(`${this.getBaseUrl()}`, {
             headers: this.constructHeaders(),
+            responseAs: config.responseAs ?? "json",
         });
         this.drawLogo();
         if (this.verbose) {

package/build/index.d.ts

@@ -3,7 +3,7 @@ import type { AccessRuleSchema } from "./access-rules/types";
 import { type AccessTokenMetadata, AccessTokensApi, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest } from "./access-tokens";
 import { type Permission, resources } from "./access-tokens/types";
 import { type App, AppsApi } from "./apps";
-import { AttributeApi } from "./attributes";
+import { AttributeApi, AttributeApiV2 } from "./attributes";
 import type { ArrayAttribute, Attribute, ObjectAttribute, PrimitiveAttribute, RefAttribute, ShallowAttribute, SubAttribute } from "./attributes/types";
 import { type ApiToken, AuthenticationApi, type LoggedInUser, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type StytchToken, type UserRole } from "./authentication";
 import { BaseApi } from "./base-api";
@@ -20,6 +20,7 @@ import { HealthCheckApi } from "./health";
 import type { HealthCheckResult } from "./health/types";
 import { type Installation, InstallationsApi, type Profile } from "./installations";
 import { type ExplainInput, type ExplainOutput, type GetJobsParameters, type Job, JobsApi, type MaterializedViewInput, type MaterializedViewOutput } from "./jobs";
+import JsonBigNumber from "./json-big-number";
 import { type Mapping, type MappingTestResult, MappingsApi } from "./mappings";
 import type { CreateMapping, ObjectMapping, ValueMapping } from "./mappings/types";
 import { type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Nql, NqlApi, type NqlAst, type NqlBooleanExpression, type NqlCompileResult, type NqlExpression, type NqlField, type NqlFilterBinaryExpression, type NqlFilterExpression, type NqlFilterUnaryExpression, type NqlQueryInput, type NqlResult, type NqlWhere, type Raw, type Select, type Statement, type Table, compileStatement, parseStatement } from "./nql";
@@ -42,6 +43,6 @@ import { WhoAmIApi } from "./whoami";
 import type { User } from "./whoami/types";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, type DataPlane, type AccessTokenMetadata, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest, 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 Permission, 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 ForecastResult, type CostForecastResult, type ForecastResultFailure, 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 AstNodeType, type AstNodeMetadata, type SharedAccessRule, type OwnedAccessRule, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type AccessRuleSchema, 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 ExplainInput, type MaterializedViewInput, type ExplainOutput, type MaterializedViewOutput, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, type DataPlane, type AccessTokenMetadata, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest, 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 Permission, 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 ForecastResult, type CostForecastResult, type ForecastResultFailure, 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 AstNodeType, type AstNodeMetadata, type SharedAccessRule, type OwnedAccessRule, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type AccessRuleSchema, 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 ExplainInput, type MaterializedViewInput, type ExplainOutput, type MaterializedViewOutput, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, compileStatement, parseStatement, JsonBigNumber, };

package/build/index.js

@@ -2,7 +2,7 @@ import { AccessRulesApi, } from "./access-rules/";
 import { AccessTokensApi, } from "./access-tokens";
 import { resources } from "./access-tokens/types";
 import { AppsApi } from "./apps";
-import { AttributeApi } from "./attributes";
+import { AttributeApi, AttributeApiV2 } from "./attributes";
 import { AuthenticationApi, } from "./authentication";
 import { BaseApi } from "./base-api";
 import { CompanyInfoApi } from "./company-info";
@@ -15,6 +15,7 @@ import { ForecastApi, } from "./forecast";
 import { HealthCheckApi } from "./health";
 import { InstallationsApi, } from "./installations";
 import { JobsApi, } from "./jobs";
+import JsonBigNumber from "./json-big-number";
 import { MappingsApi } from "./mappings";
 import { NqlApi, compileStatement, parseStatement, } from "./nql";
 import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
@@ -39,6 +40,7 @@ applyMixins(NarrativeApi, [
     DataPlaneApi,
     RosettaStoneApi,
     AttributeApi,
+    AttributeApiV2,
     PingApi,
     CompanyInfoApi,
     InstallationsApi,
@@ -60,4 +62,4 @@ applyMixins(NarrativeApi, [
 ]);
 export { 
 // biome-ignore lint/style/useExportType: We need to export the class
-NarrativeApi, AttributeApi, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, };
+NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };

package/build/json-big-number/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Parses a JSON string and converts it into a JavaScript object or array.
+ * This function uses the `json-big-number` library, which supports parsing large numbers
+ * (BigNumbers) that may exceed JavaScript's safe integer range.
+ *
+ * @param {string} source - The JSON string to parse.
+ * @param {(key: string, value: unknown) => unknown} [reviver] - An optional function that transforms the results.
+ * Each key/value pair is passed to this function, and its return value is used instead of the original value.
+ * @returns {unknown} - The JavaScript object or array resulting from parsing the JSON string.
+ */
+declare function parse(source: string, reviver?: (key: string, value: unknown) => unknown): unknown;
+/**
+ * Converts a JavaScript object or array into a JSON string.
+ * This function uses the `json-big-number` library, which supports serializing large numbers (BigNumbers)
+ * without losing precision, making it useful for cases where large numerical values need to be preserved.
+ *
+ * @param {unknown} value - The value to convert into a JSON string. This can be an object, array, or any other data type.
+ * @param {(key: string, value: unknown) => unknown} [replacer] - An optional function that can modify the behavior of the stringification process.
+ * If provided, it is called for each key/value pair.
+ * @param {string | number} [space] - An optional argument that controls indentation in the output JSON string.
+ * If a number, it specifies the number of spaces to indent. If a string, it specifies the characters to use for indentation.
+ * @returns {string} - The JSON string representation of the provided value.
+ */
+declare function stringify(value: unknown, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string;
+declare const JsonBigNumber: {
+    parse: typeof parse;
+    stringify: typeof stringify;
+};
+export default JsonBigNumber;

package/build/json-big-number/index.js

@@ -0,0 +1,34 @@
+import { parse as parseBigNumber, stringify as stringifyBigNumber, } from "./lib/json-big-number";
+/**
+ * Parses a JSON string and converts it into a JavaScript object or array.
+ * This function uses the `json-big-number` library, which supports parsing large numbers
+ * (BigNumbers) that may exceed JavaScript's safe integer range.
+ *
+ * @param {string} source - The JSON string to parse.
+ * @param {(key: string, value: unknown) => unknown} [reviver] - An optional function that transforms the results.
+ * Each key/value pair is passed to this function, and its return value is used instead of the original value.
+ * @returns {unknown} - The JavaScript object or array resulting from parsing the JSON string.
+ */
+function parse(source, reviver) {
+    return parseBigNumber(source, reviver);
+}
+/**
+ * Converts a JavaScript object or array into a JSON string.
+ * This function uses the `json-big-number` library, which supports serializing large numbers (BigNumbers)
+ * without losing precision, making it useful for cases where large numerical values need to be preserved.
+ *
+ * @param {unknown} value - The value to convert into a JSON string. This can be an object, array, or any other data type.
+ * @param {(key: string, value: unknown) => unknown} [replacer] - An optional function that can modify the behavior of the stringification process.
+ * If provided, it is called for each key/value pair.
+ * @param {string | number} [space] - An optional argument that controls indentation in the output JSON string.
+ * If a number, it specifies the number of spaces to indent. If a string, it specifies the characters to use for indentation.
+ * @returns {string} - The JSON string representation of the provided value.
+ */
+function stringify(value, replacer, space) {
+    return stringifyBigNumber(value, replacer, space);
+}
+const JsonBigNumber = {
+    parse,
+    stringify,
+};
+export default JsonBigNumber;

package/build/json-big-number/lib/json-big-number.d.ts

@@ -0,0 +1,7 @@
+export declare function stringify(value: any, replacer: any, space: any): any;
+export declare function parse(source: any, reviver: any): any;
+declare const _default: {
+    parse: typeof parse;
+    stringify: typeof stringify;
+};
+export default _default;

package/build/json-big-number/lib/json-big-number.js

@@ -0,0 +1,484 @@
+// @ts-nocheck
+// The MIT License (MIT)
+// Copyright (c) 2017 William Buss
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+import BigNumber from "bignumber.js";
+var rx_escapable = /[\\"\u0000-\u001f\u007f-\u009f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;
+function f(n) {
+    // Format integers to have at least two digits.
+    return n < 10 ? "0" + n : n;
+}
+function this_value() {
+    return this.valueOf();
+}
+if (typeof Date.prototype.toJSON !== "function") {
+    Date.prototype.toJSON = function () {
+        return isFinite(this.valueOf())
+            ? this.getUTCFullYear() +
+                "-" +
+                f(this.getUTCMonth() + 1) +
+                "-" +
+                f(this.getUTCDate()) +
+                "T" +
+                f(this.getUTCHours()) +
+                ":" +
+                f(this.getUTCMinutes()) +
+                ":" +
+                f(this.getUTCSeconds()) +
+                "Z"
+            : null;
+    };
+    Boolean.prototype.toJSON = this_value;
+    Number.prototype.toJSON = this_value;
+    String.prototype.toJSON = this_value;
+}
+var gap;
+var indent;
+var meta;
+var rep;
+function quote(string) {
+    // If the string contains no control characters, no quote characters, and no
+    // backslash characters, then we can safely slap some quotes around it.
+    // Otherwise we must also replace the offending characters with safe escape
+    // sequences.
+    rx_escapable.lastIndex = 0;
+    return rx_escapable.test(string)
+        ? '"' +
+            string.replace(rx_escapable, (a) => {
+                var c = meta[a];
+                return typeof c === "string"
+                    ? c
+                    : "\\u" + ("0000" + a.charCodeAt(0).toString(16)).slice(-4);
+            }) +
+            '"'
+        : '"' + string + '"';
+}
+function str(key, holder) {
+    // Produce a string from holder[key].
+    var i; // The loop counter.
+    var k; // The member key.
+    var v; // The member value.
+    var length;
+    var mind = gap;
+    var partial;
+    var value = holder[key];
+    var isBigNumber = value != null &&
+        (value instanceof BigNumber || BigNumber.isBigNumber(value));
+    // Check for NaN and Infinity
+    if (isBigNumber && !value.isFinite()) {
+        value = null;
+    }
+    // If the value has a toJSON method, call it to obtain a replacement value.
+    if (value &&
+        typeof value === "object" &&
+        typeof value.toJSON === "function") {
+        value = value.toJSON(key);
+    }
+    // If we were called with a replacer function, then call the replacer to
+    // obtain a replacement value.
+    if (typeof rep === "function") {
+        value = rep.call(holder, key, value);
+    }
+    // What happens next depends on the value's type.
+    switch (typeof value) {
+        case "string":
+            if (isBigNumber) {
+                return value;
+            }
+            else {
+                return quote(value);
+            }
+        case "number":
+            // JSON numbers must be finite. Encode non-finite numbers as null.
+            return isFinite(value) ? String(value) : "null";
+        case "boolean":
+        case "null":
+            // If the value is a boolean or null, convert it to a string. Note:
+            // typeof null does not produce "null". The case is included here in
+            // the remote chance that this gets fixed someday.
+            return String(value);
+        // If the type is "object", we might be dealing with an object or an array or
+        // null.
+        case "object":
+            // Due to a specification blunder in ECMAScript, typeof null is "object",
+            // so watch out for that case.
+            if (!value) {
+                return "null";
+            }
+            // Make an array to hold the partial results of stringifying this object value.
+            gap += indent;
+            partial = [];
+            // Is the value an array?
+            if (Object.prototype.toString.apply(value) === "[object Array]") {
+                // The value is an array. Stringify every element. Use null as a placeholder
+                // for non-JSON values.
+                length = value.length;
+                for (i = 0; i < length; i += 1) {
+                    partial[i] = str(i, value) || "null";
+                }
+                // Join all of the elements together, separated with commas, and wrap them in
+                // brackets.
+                v =
+                    partial.length === 0
+                        ? "[]"
+                        : gap
+                            ? "[\n" + gap + partial.join(",\n" + gap) + "\n" + mind + "]"
+                            : "[" + partial.join(",") + "]";
+                gap = mind;
+                return v;
+            }
+            // If the replacer is an array, use it to select the members to be stringified.
+            if (rep && typeof rep === "object") {
+                length = rep.length;
+                for (i = 0; i < length; i += 1) {
+                    if (typeof rep[i] === "string") {
+                        k = rep[i];
+                        v = str(k, value);
+                        if (v) {
+                            partial.push(quote(k) + (gap ? ": " : ":") + v);
+                        }
+                    }
+                }
+            }
+            else {
+                // Otherwise, iterate through all of the keys in the object.
+                for (k in value) {
+                    if (Object.prototype.hasOwnProperty.call(value, k)) {
+                        v = str(k, value);
+                        if (v) {
+                            partial.push(quote(k) + (gap ? ": " : ":") + v);
+                        }
+                    }
+                }
+            }
+            // Join all of the member texts together, separated with commas,
+            // and wrap them in braces.
+            v =
+                partial.length === 0
+                    ? "{}"
+                    : gap
+                        ? "{\n" + gap + partial.join(",\n" + gap) + "\n" + mind + "}"
+                        : "{" + partial.join(",") + "}";
+            gap = mind;
+            return v;
+    }
+}
+// If the JSON object does not yet have a stringify method, give it one.
+meta = {
+    // table of character substitutions
+    "\b": "\\b",
+    "\t": "\\t",
+    "\n": "\\n",
+    "\f": "\\f",
+    "\r": "\\r",
+    '"': '\\"',
+    "\\": "\\\\",
+};
+export function stringify(value, replacer, space) {
+    // The stringify method takes a value and an optional replacer, and an optional
+    // space parameter, and returns a JSON text. The replacer can be a function
+    // that can replace values, or an array of strings that will select the keys.
+    // A default replacer method can be provided. Use of the space parameter can
+    // produce text that is more easily readable.
+    var i;
+    gap = "";
+    indent = "";
+    // If the space parameter is a number, make an indent string containing that
+    // many spaces.
+    if (typeof space === "number") {
+        for (i = 0; i < space; i += 1) {
+            indent += " ";
+        }
+        // If the space parameter is a string, it will be used as the indent string.
+    }
+    else if (typeof space === "string") {
+        indent = space;
+    }
+    // If there is a replacer, it must be a function or an array.
+    // Otherwise, throw an error.
+    rep = replacer;
+    if (replacer &&
+        typeof replacer !== "function" &&
+        (typeof replacer !== "object" || typeof replacer.length !== "number")) {
+        throw new Error("JSON.stringify");
+    }
+    // Make a fake root object containing our value under the key of "".
+    // Return the result of stringifying the value.
+    return str("", {
+        "": value,
+    });
+}
+// We are defining the function inside of another function to avoid creating
+// global variables.
+var at; // The index of the current character
+var ch; // The current character
+var escapee = {
+    '"': '"',
+    "\\": "\\",
+    "/": "/",
+    b: "\b",
+    f: "\f",
+    n: "\n",
+    r: "\r",
+    t: "\t",
+};
+var text;
+var error = (m) => {
+    // Call error when something is wrong.
+    throw {
+        name: "SyntaxError",
+        message: m,
+        at: at,
+        text: text,
+    };
+};
+var next = (c) => {
+    // If a c parameter is provided, verify that it matches the current character.
+    if (c && c !== ch) {
+        error("Expected '" + c + "' instead of '" + ch + "'");
+    }
+    // Get the next character. When there are no more characters,
+    // return the empty string.
+    ch = text.charAt(at);
+    at += 1;
+    return ch;
+};
+var number = () => {
+    // Parse a number value to a BigNumber.
+    var number;
+    var string = "";
+    if (ch === "-") {
+        string = "-";
+        next("-");
+    }
+    while (ch >= "0" && ch <= "9") {
+        string += ch;
+        next();
+    }
+    if (ch === ".") {
+        string += ".";
+        while (next() && ch >= "0" && ch <= "9") {
+            string += ch;
+        }
+    }
+    if (ch === "e" || ch === "E") {
+        string += ch;
+        next();
+        if (ch === "-" || ch === "+") {
+            string += ch;
+            next();
+        }
+        while (ch >= "0" && ch <= "9") {
+            string += ch;
+            next();
+        }
+    }
+    number = new BigNumber(string);
+    if (!number.isFinite()) {
+        error("Bad number");
+    }
+    else {
+        return number;
+    }
+};
+var string = () => {
+    // Parse a string value.
+    var hex;
+    var i;
+    var value = "";
+    var uffff;
+    // When parsing for string values, we must look for " and \ characters.
+    if (ch === '"') {
+        while (next()) {
+            if (ch === '"') {
+                next();
+                return value;
+            }
+            if (ch === "\\") {
+                next();
+                if (ch === "u") {
+                    uffff = 0;
+                    for (i = 0; i < 4; i += 1) {
+                        hex = Number.parseInt(next(), 16);
+                        if (!isFinite(hex)) {
+                            break;
+                        }
+                        uffff = uffff * 16 + hex;
+                    }
+                    value += String.fromCharCode(uffff);
+                }
+                else if (typeof escapee[ch] === "string") {
+                    value += escapee[ch];
+                }
+                else {
+                    break;
+                }
+            }
+            else {
+                value += ch;
+            }
+        }
+    }
+    error("Bad string");
+};
+var white = () => {
+    // Skip whitespace.
+    while (ch && ch <= " ") {
+        next();
+    }
+};
+var word = () => {
+    // true, false, or null.
+    switch (ch) {
+        case "t":
+            next("t");
+            next("r");
+            next("u");
+            next("e");
+            return true;
+        case "f":
+            next("f");
+            next("a");
+            next("l");
+            next("s");
+            next("e");
+            return false;
+        case "n":
+            next("n");
+            next("u");
+            next("l");
+            next("l");
+            return null;
+    }
+    error("Unexpected '" + ch + "'");
+};
+var value; // Place holder for the value function.
+var array = () => {
+    // Parse an array value.
+    var arr = [];
+    if (ch === "[") {
+        next("[");
+        white();
+        if (ch === "]") {
+            next("]");
+            return arr; // empty array
+        }
+        while (ch) {
+            arr.push(value());
+            white();
+            if (ch === "]") {
+                next("]");
+                return arr;
+            }
+            next(",");
+            white();
+        }
+    }
+    error("Bad array");
+};
+var object = () => {
+    // Parse an object value.
+    var key;
+    var obj = {};
+    if (ch === "{") {
+        next("{");
+        white();
+        if (ch === "}") {
+            next("}");
+            return obj; // empty object
+        }
+        while (ch) {
+            key = string();
+            white();
+            next(":");
+            if (Object.hasOwnProperty.call(obj, key)) {
+                error("Duplicate key '" + key + "'");
+            }
+            obj[key] = value();
+            white();
+            if (ch === "}") {
+                next("}");
+                return obj;
+            }
+            next(",");
+            white();
+        }
+    }
+    error("Bad object");
+};
+value = () => {
+    // Parse a JSON value. It could be an object, an array, a string, a number,
+    // or a word.
+    white();
+    switch (ch) {
+        case "{":
+            return object();
+        case "[":
+            return array();
+        case '"':
+            return string();
+        case "-":
+            return number();
+        default:
+            return ch >= "0" && ch <= "9" ? number() : word();
+    }
+};
+// Set the New JSONBigNumber.parse function It will have access to all of the above
+// functions and variables.
+export function parse(source, reviver) {
+    var result;
+    text = source;
+    at = 0;
+    ch = " ";
+    result = value();
+    white();
+    if (ch) {
+        error("Syntax error");
+    }
+    // If there is a reviver function, we recursively walk the new structure,
+    // passing each name/value pair to the reviver function for possible
+    // transformation, starting with a temporary root object that holds the result
+    // in an empty key. If there is not a reviver function, we simply return the
+    // result.
+    return typeof reviver === "function"
+        ? (function walk(holder, key) {
+            var k;
+            var v;
+            var val = holder[key];
+            if (val && typeof val === "object") {
+                for (k in val) {
+                    if (Object.prototype.hasOwnProperty.call(val, k)) {
+                        v = walk(val, k);
+                        if (v !== undefined) {
+                            val[k] = v;
+                        }
+                        else {
+                            delete val[k];
+                        }
+                    }
+                }
+            }
+            return reviver.call(holder, key, val);
+        })({
+            "": result,
+        }, "")
+        : result;
+}
+export default {
+    parse: parse,
+    stringify: stringify,
+};

package/build/types.d.ts

@@ -1,3 +1,4 @@
+import type { ResponseAsTypes } from "mande";
 /**
  * Environment for the API.
  *
@@ -16,6 +17,7 @@ export interface Config {
     environment?: Environment;
     headers?: Record<string, string>;
     verbose?: boolean;
+    responseAs?: ResponseAsTypes;
 }
 export interface ApiRecordsV2<T> extends PaginationMetadata {
     records: T[];
@@ -44,4 +46,10 @@ export interface PaginationOptions {
     page?: number | null;
     per_page?: number | null;
 }
+/**
+ * Interface for search parameters
+ */
+export interface SearchParams {
+    q?: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "2.17.0",
+	"version": "2.19.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -8,8 +8,8 @@
 	"description": "",
 	"scripts": {
 		"build": "tsc",
-		"lint": "npx @biomejs/biome check --apply ./src",
-		"prepare": "npx @biomejs/biome check --apply ./src && npm run build",
+		"lint": "npx @biomejs/biome check --write ./src",
+		"prepare": "npx @biomejs/biome check --write ./src && npm run build",
 		"prepublishOnly": "npm test && npm run lint",
 		"preversion": "npm run lint",
 		"version": "npm run && git add -A src",
@@ -20,21 +20,22 @@
 	"author": "",
 	"license": "ISC",
 	"devDependencies": {
-		"@babel/core": "7.25.2",
-		"@babel/preset-env": "7.25.4",
-		"@babel/preset-typescript": "7.24.7",
-		"@biomejs/biome": "1.9.1",
+		"@babel/core": "7.25.8",
+		"@babel/preset-env": "7.25.8",
+		"@babel/preset-typescript": "7.25.7",
+		"@biomejs/biome": "1.9.3",
 		"@commitlint/cli": "19.5.0",
 		"@commitlint/config-conventional": "19.5.0",
 		"@types/jest": "29.5.13",
 		"babel-jest": "29.7.0",
 		"jest": "29.7.0",
-		"lefthook": "1.7.15",
+		"lefthook": "1.7.18",
 		"ts-jest": "29.2.5"
 	},
 	"dependencies": {
 		"mande": "2.0.9",
-		"zod": "3.23.8"
+		"zod": "3.23.8",
+		"bignumber.js": "^9.0.0"
 	},
 	"overrides": {
 		"semver@<7.5.2": "7.5.2"
@@ -42,4 +43,4 @@
 	"files": [
 		"build"
 	]
-}
+}