@narrative.io/data-collaboration-sdk-ts 0.0.106 → 0.0.108

package/build/nql/index.d.ts

@@ -1,6 +1,6 @@
-import { BaseApi } from '../base-api';
-import type { Plan } from './SubstraitParser';
-import type { Nql, NqlField, NqlResult, NqlCompileResult, NqlQueryInput, NqlExpression, NqlWhere, NqlFilterBinaryExpression, NqlBooleanExpression, NqlFilterExpression, NqlFilterUnaryExpression } from './types';
+import { BaseApi } from "../base-api";
+import type { Plan } from "./SubstraitParser";
+import type { Nql, NqlField, NqlResult, NqlCompileResult, NqlQueryInput, NqlExpression, NqlWhere, NqlFilterBinaryExpression, NqlBooleanExpression, NqlFilterExpression, NqlFilterUnaryExpression } from "./types";
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -35,4 +35,4 @@ declare class NqlApi extends BaseApi {
      */
     getNqlByJobId(id: string): Promise<NqlResult>;
 }
-export { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression };
+export { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, };

package/build/nql/index.js

@@ -1,12 +1,12 @@
 // src/api/NqlApi.ts
-import { BaseApi } from '../base-api';
+import { BaseApi } from "../base-api";
 /**
  * The name of the resource to be used in API requests.
  * @constant
  * @private
  * @type {string}
  */
-const resourceName = 'nql';
+const resourceName = "nql";
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -52,4 +52,4 @@ class NqlApi extends BaseApi {
         return await this.get(`${resourceName}/${id}`);
     }
 }
-export { NqlApi };
+export { NqlApi, };

package/build/nql/types.d.ts

@@ -4,7 +4,7 @@
  *
  * @see {@link https://github.com/colinhacks/zod} for more information about Zod.
  */
-import { z } from 'zod';
+import { z } from "zod";
 /**
  * Defines the structure for a budget object.
  *
@@ -1287,7 +1287,7 @@ export interface ForecastBody {
     details: QueryDetails;
 }
 export interface QueryDetails {
-    type: 'marketplace';
+    type: "marketplace";
     pricing: QueryPricing;
     data_rules: DataRules;
 }
@@ -1310,7 +1310,7 @@ export interface DataRulesAttributesField {
 export interface DataRulesAttributesFieldFilter {
     expression: string[];
 }
-export type FilterDefinition = 'include_all_values_including_nulls_filter' | 'include_only_if_not_null_filter' | EnumFilter | IntervalFilter | TimestampFilter | SparkSqlConstraintFilter;
+export type FilterDefinition = "include_all_values_including_nulls_filter" | "include_only_if_not_null_filter" | EnumFilter | IntervalFilter | TimestampFilter | SparkSqlConstraintFilter;
 export interface EnumFilter {
     type: InclusionType;
     list: string[];
@@ -1327,11 +1327,11 @@ export interface TimestampFilter {
 export interface SparkSqlConstraintFilter {
     expressions: string[];
 }
-export type IntervalEndType = 'inclusive' | 'exclusive';
+export type IntervalEndType = "inclusive" | "exclusive";
 export interface IntervalEnd {
     type: IntervalEndType;
     value: string;
 }
-export type SpatialPredicate = 'contains' | 'intersects';
-export type InclusionType = 'include' | 'exclude';
+export type SpatialPredicate = "contains" | "intersects";
+export type InclusionType = "include" | "exclude";
 export {};

package/build/nql/types.js

@@ -4,16 +4,20 @@
  *
  * @see {@link https://github.com/colinhacks/zod} for more information about Zod.
  */
-import { z } from 'zod';
+import { z } from "zod";
 /**
  * Defines the structure for a budget object.
  *
  * @type {z.ZodObject}
  */
 export const NqlBudgetObj = z.object({
-    value: z.number().describe('The value of the budget.'),
-    currency: z.enum(['USD']).describe('The currency the budget is described in.'),
-    period: z.enum(['CALENDAR_MONTH']).describe('The period over which the budget will be applied.')
+    value: z.number().describe("The value of the budget."),
+    currency: z
+        .enum(["USD"])
+        .describe("The currency the budget is described in."),
+    period: z
+        .enum(["CALENDAR_MONTH"])
+        .describe("The period over which the budget will be applied."),
 });
 /**
  * A schema object used to validate and infer the structure of NqlQuery.
@@ -21,51 +25,77 @@ export const NqlBudgetObj = z.object({
  * @constant {z.ZodObject} NqlQueryObj
  */
 export const NqlQueryInputObj = z.object({
-    nql: z.string().trim().includes('SELECT', {
-        message: 'NQL query must contain a SELECT statement.'
+    nql: z
+        .string()
+        .trim()
+        .includes("SELECT", {
+        message: "NQL query must contain a SELECT statement.",
     })
         .regex(/^.*\bLIMIT\b.*/is, {
-        message: 'NQL query must contain a LIMIT statement.'
+        message: "NQL query must contain a LIMIT statement.",
     })
         .regex(/^(?!.*\bJOIN\b).*/is, {
-        message: 'NQL query cannot contain a JOIN statement.'
+        message: "NQL query cannot contain a JOIN statement.",
     })
-        .describe('A NQL query')
+        .describe("A NQL query"),
 });
 /**
  * A schema object used to validate and infer the structure of NqlPreSelectExpression.
  *
  * @constant {z.ZodEnum} NqlPreSelectExpressionObj
  */
-export const NqlPreSelectExpressionObj = z.enum(['EXPLAIN']).describe('Expression that occurs before the SELECT statement.').optional();
-export const NqlDatabaseObject = z.string().refine(x => x.toLowerCase() === 'narrative');
+export const NqlPreSelectExpressionObj = z
+    .enum(["EXPLAIN"])
+    .describe("Expression that occurs before the SELECT statement.")
+    .optional();
+export const NqlDatabaseObject = z
+    .string()
+    .refine((x) => x.toLowerCase() === "narrative");
 export const NqlTableObject = z.object({
     database: NqlDatabaseObject,
-    table: z.string().refine(x => x.toLowerCase() === 'rosetta_stone')
+    table: z.string().refine((x) => x.toLowerCase() === "rosetta_stone"),
 });
 export const NqlFieldObj = z.object({
     field: z.string().trim(),
-    table: NqlTableObject
+    table: NqlTableObject,
 });
 export const NqlFilterUnaryExpressionObj = z.object({
     field: NqlFieldObj,
-    operator: z.enum(['IS NULL', 'IS NOT NULL']).describe('The operator to use for the filter.  As a standalone operator it only expects the field to be defined.')
+    operator: z
+        .enum(["IS NULL", "IS NOT NULL"])
+        .describe("The operator to use for the filter.  As a standalone operator it only expects the field to be defined."),
 });
-const NqlExpressionObj = z.union([NqlFieldObj, z.string(), z.number(), z.boolean()]);
+const NqlExpressionObj = z.union([
+    NqlFieldObj,
+    z.string(),
+    z.number(),
+    z.boolean(),
+]);
 export const NqlFilterBinaryExpressionObj = z.object({
     left: NqlExpressionObj,
-    operator: z.enum(['=', '!=', '>', '<', '>=', '<=', 'IN', 'NOT IN', 'LIKE', 'NOT LIKE']).describe('The operator to use for the filter.  As a binary operator it expects both a left and right expression'),
-    right: NqlExpressionObj
+    operator: z
+        .enum(["=", "!=", ">", "<", ">=", "<=", "IN", "NOT IN", "LIKE", "NOT LIKE"])
+        .describe("The operator to use for the filter.  As a binary operator it expects both a left and right expression"),
+    right: NqlExpressionObj,
 });
-export const NqlFilterExpressionObj = z.union([NqlFilterUnaryExpressionObj, NqlFilterBinaryExpressionObj]);
-export const NqlBooleanExpressionObj = z.enum(['AND', 'OR']).describe('The operator to use for the filter.  As a standalone operator it only expects the field to be defined.');
-export const NqlWhereObj = z.object({
+export const NqlFilterExpressionObj = z.union([
+    NqlFilterUnaryExpressionObj,
+    NqlFilterBinaryExpressionObj,
+]);
+export const NqlBooleanExpressionObj = z
+    .enum(["AND", "OR"])
+    .describe("The operator to use for the filter.  As a standalone operator it only expects the field to be defined.");
+export const NqlWhereObj = z
+    .object({
     booleanExpressions: NqlBooleanExpressionObj.array(),
-    filterExpressions: NqlFilterExpressionObj.array()
-}).refine((clause) => {
-    return clause.booleanExpressions.length === clause.filterExpressions.length - 1 || clause.filterExpressions.length === 0;
+    filterExpressions: NqlFilterExpressionObj.array(),
+})
+    .refine((clause) => {
+    return (clause.booleanExpressions.length ===
+        clause.filterExpressions.length - 1 ||
+        clause.filterExpressions.length === 0);
 }, {
-    message: 'Boolean expression must have one less element than filter expression.'
+    message: "Boolean expression must have one less element than filter expression.",
 });
 export const NqlObj = z.object({
     explain: NqlPreSelectExpressionObj,
@@ -73,9 +103,9 @@ export const NqlObj = z.object({
     from: NqlTableObject.array(),
     where: NqlWhereObj,
     limit: NqlBudgetObj,
-    sort: z.undefined().describe('Sort is not currently supported in NQL'),
-    group: z.undefined().describe('Group is not currently supported in NQL'),
-    having: z.undefined().describe('Having is not currently supported in NQL'),
-    offset: z.undefined().describe('Offset is not currently supported in NQL'),
-    join: z.undefined().describe('Join is not currently supported in NQL')
+    sort: z.undefined().describe("Sort is not currently supported in NQL"),
+    group: z.undefined().describe("Group is not currently supported in NQL"),
+    having: z.undefined().describe("Having is not currently supported in NQL"),
+    offset: z.undefined().describe("Offset is not currently supported in NQL"),
+    join: z.undefined().describe("Join is not currently supported in NQL"),
 });

package/build/ping/index.d.ts

@@ -1,5 +1,5 @@
-import { BaseApi } from '../base-api';
-import { type PingStatus } from './types';
+import { BaseApi } from "../base-api";
+import { type PingStatus } from "./types";
 /**
  * A class for accessing the Ping API.
  * @extends BaseApi

package/build/ping/index.js

@@ -1,11 +1,11 @@
-import { BaseApi } from '../base-api';
+import { BaseApi } from "../base-api";
 /**
  * The name of the resource to be used in API requests.
  * @constant
  * @private
  * @type {string}
  */
-const resourceName = 'ping';
+const resourceName = "ping";
 /**
  * A class for accessing the Ping API.
  * @extends BaseApi

package/build/ping/types.d.ts

@@ -1 +1 @@
-export type PingStatus = 'healthy' | unknown;
+export type PingStatus = "healthy" | unknown;

package/build/products/index.d.ts

@@ -1,15 +1,15 @@
-import { BaseApi } from '../base-api';
-import { type Product } from './types';
+import { BaseApi } from "../base-api";
+import { type Product } from "./types";
 /**
  * A class for accessing the Products API.
  * @extends BaseApi
  */
 declare class ProductsApi extends BaseApi {
     /**
-       * Gets the result of a product from the API.
-       *
-       * @returns {Promise<Product[]>} A promise that resolves with the products.
-       */
+     * Gets the result of a product from the API.
+     *
+     * @returns {Promise<Product[]>} A promise that resolves with the products.
+     */
     getHealthCheck(): Promise<Product[]>;
 }
 export { ProductsApi, type Product };

package/build/products/index.js

@@ -1,21 +1,21 @@
-import { BaseApi } from '../base-api';
+import { BaseApi } from "../base-api";
 /**
  * The name of the resource to be used in API requests.
  * @constant
  * @private
  * @type {string}
  */
-const resourceName = 'admin/products';
+const resourceName = "admin/products";
 /**
  * A class for accessing the Products API.
  * @extends BaseApi
  */
 class ProductsApi extends BaseApi {
     /**
-       * Gets the result of a product from the API.
-       *
-       * @returns {Promise<Product[]>} A promise that resolves with the products.
-       */
+     * Gets the result of a product from the API.
+     *
+     * @returns {Promise<Product[]>} A promise that resolves with the products.
+     */
     async getHealthCheck() {
         return await this.get(resourceName);
     }

package/build/products/types.d.ts

@@ -1,8 +1,8 @@
 type ProductId = string;
-type ProductSkuType = 'processing' | 'storage' | 'transfer';
-type ProductCloudType = 'aws' | 'gcp' | 'azure';
-type ProductUnitType = 'bytes' | 'average-bytes-per-month';
-type ProductStatus = 'active' | 'archived';
+type ProductSkuType = "processing" | "storage" | "transfer";
+type ProductCloudType = "aws" | "gcp" | "azure";
+type ProductUnitType = "bytes" | "average-bytes-per-month";
+type ProductStatus = "active" | "archived";
 interface ProductRate {
     type: string;
     unitPrice: {

package/build/resources/index.d.ts

@@ -2,10 +2,10 @@
  * @fileoverview This module provides methods for fetching resources.
  * @author Your Name
  */
-import { type ApiRecords } from '../types';
-import { BaseApi } from '../base-api';
-import { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest } from './types';
-export { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest };
+import { type ApiRecords } from "../types";
+import { BaseApi } from "../base-api";
+import { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest } from "./types";
+export { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest, };
 /**
  * @class ResourceApi
  * @extends {BaseApi}

package/build/resources/index.js

@@ -2,8 +2,8 @@
  * @fileoverview This module provides methods for fetching resources.
  * @author Your Name
  */
-import { BaseApi } from '../base-api';
-const resourceName = 'resources';
+import { BaseApi } from "../base-api";
+const resourceName = "resources";
 /**
  * @class ResourceApi
  * @extends {BaseApi}

package/build/resources/types.d.ts

@@ -2,7 +2,7 @@ export interface Resource {
     id: string;
     company_id: number;
     auth: {
-        type: 'bucket_policy' | 'role';
+        type: "bucket_policy" | "role";
         account_id: string;
         external_id?: string;
         role?: string;
@@ -13,11 +13,11 @@ export interface Resource {
     is_access_mutable: boolean;
 }
 export interface RoleBasedBucketAccess {
-    type: 'role';
+    type: "role";
     external_id: string;
 }
 export interface PolicyBasedBucketAccess {
-    type: 'bucket_policy';
+    type: "bucket_policy";
 }
 export interface UpdateAccessTypeRequest {
     bucket_name: string;

package/build/rosetta/types.d.ts

@@ -1,4 +1,4 @@
-import z from 'zod';
+import z from "zod";
 declare const ChatCompletionRequestMessageRoleEnum: z.ZodEnum<["system", "user", "assistant", "function"]>;
 type ConversationMessageRole = z.infer<typeof ChatCompletionRequestMessageRoleEnum>;
 declare const isConversationMessageRole: (input: unknown) => input is "function" | "system" | "user" | "assistant";
@@ -880,24 +880,24 @@ declare const isRosettaRequestMessage: (input: unknown) => input is {
 } | {
     type: "history";
 };
-type InfoMessageType = 'info';
+type InfoMessageType = "info";
 interface InfoMessageData {
     message: string;
     code?: string;
 }
 interface ConverationHistoryObj {
-    type: 'human' | 'ai';
+    type: "human" | "ai";
     text: string;
     timestamp: number;
     reference?: string;
     reference_type?: string;
 }
-type ConversationHistoryType = 'history';
+type ConversationHistoryType = "history";
 interface ConversationHistoryData {
     history: ConverationHistoryObj[];
 }
-type ConversationUpdatedType = 'conversationUpdated';
-type ConversationDeletedType = 'conversationDeleted';
+type ConversationUpdatedType = "conversationUpdated";
+type ConversationDeletedType = "conversationDeleted";
 interface ConversationUpdatedData {
     change: ConversationDeletedType;
     message?: string;
@@ -920,7 +920,7 @@ interface ConversationSummary {
     description?: string;
     timestamp?: string;
 }
-type ConversationsType = 'userConversations';
+type ConversationsType = "userConversations";
 interface ConversationsData {
     userConversations: ConversationSummary[];
 }
@@ -928,11 +928,11 @@ interface ConversationListMessage {
     type: ConversationsType;
     data: ConversationsData;
 }
-type PongType = 'pong';
+type PongType = "pong";
 interface PongMessage {
     type: PongType;
 }
-type ErrorType = 'error';
+type ErrorType = "error";
 interface ErrorData {
     message: string;
     code?: string;
@@ -941,7 +941,7 @@ interface ErrorMessage {
     type: ErrorType;
     data: ErrorData;
 }
-type ThoughtType = 'thought-start';
+type ThoughtType = "thought-start";
 interface ThoughtData {
     text: string;
     timestamp?: string;
@@ -950,7 +950,7 @@ interface ThoughtMessage {
     type: ThoughtType;
     data: ThoughtData;
 }
-type ResponseType = 'response';
+type ResponseType = "response";
 interface ResponseData {
     response: string;
     reference_type?: string;
@@ -963,4 +963,4 @@ interface RespomseMessage {
 }
 type RosettaResponseMessage = InfoMessage | HistoryMessage | ConversationUpdatedMessage | PongMessage | ErrorMessage | ThoughtMessage | RespomseMessage | ConversationListMessage;
 declare function isType<T>(input: unknown, schema: z.ZodType<T>): input is T;
-export { 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 RosettaResponseMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall };
+export { 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 RosettaResponseMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall, };