profoundai 0.31.2 → 0.32.0

package/src/internal/qs/types.ts

@@ -0,0 +1,71 @@
+export type Format = 'RFC1738' | 'RFC3986';
+
+export type DefaultEncoder = (str: any, defaultEncoder?: any, charset?: string) => string;
+export type DefaultDecoder = (str: string, decoder?: any, charset?: string) => string;
+
+export type BooleanOptional = boolean | undefined;
+
+export type StringifyBaseOptions = {
+  delimiter?: string;
+  allowDots?: boolean;
+  encodeDotInKeys?: boolean;
+  strictNullHandling?: boolean;
+  skipNulls?: boolean;
+  encode?: boolean;
+  encoder?: (
+    str: any,
+    defaultEncoder: DefaultEncoder,
+    charset: string,
+    type: 'key' | 'value',
+    format?: Format,
+  ) => string;
+  filter?: Array<PropertyKey> | ((prefix: PropertyKey, value: any) => any);
+  arrayFormat?: 'indices' | 'brackets' | 'repeat' | 'comma';
+  indices?: boolean;
+  sort?: ((a: PropertyKey, b: PropertyKey) => number) | null;
+  serializeDate?: (d: Date) => string;
+  format?: 'RFC1738' | 'RFC3986';
+  formatter?: (str: PropertyKey) => string;
+  encodeValuesOnly?: boolean;
+  addQueryPrefix?: boolean;
+  charset?: 'utf-8' | 'iso-8859-1';
+  charsetSentinel?: boolean;
+  allowEmptyArrays?: boolean;
+  commaRoundTrip?: boolean;
+};
+
+export type StringifyOptions = StringifyBaseOptions;
+
+export type ParseBaseOptions = {
+  comma?: boolean;
+  delimiter?: string | RegExp;
+  depth?: number | false;
+  decoder?: (str: string, defaultDecoder: DefaultDecoder, charset: string, type: 'key' | 'value') => any;
+  arrayLimit?: number;
+  parseArrays?: boolean;
+  plainObjects?: boolean;
+  allowPrototypes?: boolean;
+  allowSparse?: boolean;
+  parameterLimit?: number;
+  strictDepth?: boolean;
+  strictNullHandling?: boolean;
+  ignoreQueryPrefix?: boolean;
+  charset?: 'utf-8' | 'iso-8859-1';
+  charsetSentinel?: boolean;
+  interpretNumericEntities?: boolean;
+  allowEmptyArrays?: boolean;
+  duplicates?: 'combine' | 'first' | 'last';
+  allowDots?: boolean;
+  decodeDotInKeys?: boolean;
+};
+
+export type ParseOptions = ParseBaseOptions;
+
+export type ParsedQs = {
+  [key: string]: undefined | string | string[] | ParsedQs | ParsedQs[];
+};
+
+// Type to remove null or undefined union from each property
+export type NonNullableProperties<T> = {
+  [K in keyof T]-?: Exclude<T[K], undefined | null>;
+};

package/src/internal/qs/utils.ts

@@ -0,0 +1,265 @@
+import { RFC1738 } from './formats';
+import type { DefaultEncoder, Format } from './types';
+import { isArray } from '../utils/values';
+
+export let has = (obj: object, key: PropertyKey): boolean => (
+  (has = (Object as any).hasOwn ?? Function.prototype.call.bind(Object.prototype.hasOwnProperty)),
+  has(obj, key)
+);
+
+const hex_table = /* @__PURE__ */ (() => {
+  const array = [];
+  for (let i = 0; i < 256; ++i) {
+    array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
+  }
+
+  return array;
+})();
+
+function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; prop: string }>) {
+  while (queue.length > 1) {
+    const item = queue.pop();
+    if (!item) continue;
+
+    const obj = item.obj[item.prop];
+
+    if (isArray(obj)) {
+      const compacted: unknown[] = [];
+
+      for (let j = 0; j < obj.length; ++j) {
+        if (typeof obj[j] !== 'undefined') {
+          compacted.push(obj[j]);
+        }
+      }
+
+      // @ts-ignore
+      item.obj[item.prop] = compacted;
+    }
+  }
+}
+
+function array_to_object(source: any[], options: { plainObjects: boolean }) {
+  const obj = options && options.plainObjects ? Object.create(null) : {};
+  for (let i = 0; i < source.length; ++i) {
+    if (typeof source[i] !== 'undefined') {
+      obj[i] = source[i];
+    }
+  }
+
+  return obj;
+}
+
+export function merge(
+  target: any,
+  source: any,
+  options: { plainObjects?: boolean; allowPrototypes?: boolean } = {},
+) {
+  if (!source) {
+    return target;
+  }
+
+  if (typeof source !== 'object') {
+    if (isArray(target)) {
+      target.push(source);
+    } else if (target && typeof target === 'object') {
+      if ((options && (options.plainObjects || options.allowPrototypes)) || !has(Object.prototype, source)) {
+        target[source] = true;
+      }
+    } else {
+      return [target, source];
+    }
+
+    return target;
+  }
+
+  if (!target || typeof target !== 'object') {
+    return [target].concat(source);
+  }
+
+  let mergeTarget = target;
+  if (isArray(target) && !isArray(source)) {
+    // @ts-ignore
+    mergeTarget = array_to_object(target, options);
+  }
+
+  if (isArray(target) && isArray(source)) {
+    source.forEach(function (item, i) {
+      if (has(target, i)) {
+        const targetItem = target[i];
+        if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
+          target[i] = merge(targetItem, item, options);
+        } else {
+          target.push(item);
+        }
+      } else {
+        target[i] = item;
+      }
+    });
+    return target;
+  }
+
+  return Object.keys(source).reduce(function (acc, key) {
+    const value = source[key];
+
+    if (has(acc, key)) {
+      acc[key] = merge(acc[key], value, options);
+    } else {
+      acc[key] = value;
+    }
+    return acc;
+  }, mergeTarget);
+}
+
+export function assign_single_source(target: any, source: any) {
+  return Object.keys(source).reduce(function (acc, key) {
+    acc[key] = source[key];
+    return acc;
+  }, target);
+}
+
+export function decode(str: string, _: any, charset: string) {
+  const strWithoutPlus = str.replace(/\+/g, ' ');
+  if (charset === 'iso-8859-1') {
+    // unescape never throws, no try...catch needed:
+    return strWithoutPlus.replace(/%[0-9a-f]{2}/gi, unescape);
+  }
+  // utf-8
+  try {
+    return decodeURIComponent(strWithoutPlus);
+  } catch (e) {
+    return strWithoutPlus;
+  }
+}
+
+const limit = 1024;
+
+export const encode: (
+  str: any,
+  defaultEncoder: DefaultEncoder,
+  charset: string,
+  type: 'key' | 'value',
+  format: Format,
+) => string = (str, _defaultEncoder, charset, _kind, format: Format) => {
+  // This code was originally written by Brian White for the io.js core querystring library.
+  // It has been adapted here for stricter adherence to RFC 3986
+  if (str.length === 0) {
+    return str;
+  }
+
+  let string = str;
+  if (typeof str === 'symbol') {
+    string = Symbol.prototype.toString.call(str);
+  } else if (typeof str !== 'string') {
+    string = String(str);
+  }
+
+  if (charset === 'iso-8859-1') {
+    return escape(string).replace(/%u[0-9a-f]{4}/gi, function ($0) {
+      return '%26%23' + parseInt($0.slice(2), 16) + '%3B';
+    });
+  }
+
+  let out = '';
+  for (let j = 0; j < string.length; j += limit) {
+    const segment = string.length >= limit ? string.slice(j, j + limit) : string;
+    const arr = [];
+
+    for (let i = 0; i < segment.length; ++i) {
+      let c = segment.charCodeAt(i);
+      if (
+        c === 0x2d || // -
+        c === 0x2e || // .
+        c === 0x5f || // _
+        c === 0x7e || // ~
+        (c >= 0x30 && c <= 0x39) || // 0-9
+        (c >= 0x41 && c <= 0x5a) || // a-z
+        (c >= 0x61 && c <= 0x7a) || // A-Z
+        (format === RFC1738 && (c === 0x28 || c === 0x29)) // ( )
+      ) {
+        arr[arr.length] = segment.charAt(i);
+        continue;
+      }
+
+      if (c < 0x80) {
+        arr[arr.length] = hex_table[c];
+        continue;
+      }
+
+      if (c < 0x800) {
+        arr[arr.length] = hex_table[0xc0 | (c >> 6)]! + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      if (c < 0xd800 || c >= 0xe000) {
+        arr[arr.length] =
+          hex_table[0xe0 | (c >> 12)]! + hex_table[0x80 | ((c >> 6) & 0x3f)] + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      i += 1;
+      c = 0x10000 + (((c & 0x3ff) << 10) | (segment.charCodeAt(i) & 0x3ff));
+
+      arr[arr.length] =
+        hex_table[0xf0 | (c >> 18)]! +
+        hex_table[0x80 | ((c >> 12) & 0x3f)] +
+        hex_table[0x80 | ((c >> 6) & 0x3f)] +
+        hex_table[0x80 | (c & 0x3f)];
+    }
+
+    out += arr.join('');
+  }
+
+  return out;
+};
+
+export function compact(value: any) {
+  const queue = [{ obj: { o: value }, prop: 'o' }];
+  const refs = [];
+
+  for (let i = 0; i < queue.length; ++i) {
+    const item = queue[i];
+    // @ts-ignore
+    const obj = item.obj[item.prop];
+
+    const keys = Object.keys(obj);
+    for (let j = 0; j < keys.length; ++j) {
+      const key = keys[j]!;
+      const val = obj[key];
+      if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+        queue.push({ obj: obj, prop: key });
+        refs.push(val);
+      }
+    }
+  }
+
+  compact_queue(queue);
+
+  return value;
+}
+
+export function is_regexp(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}
+
+export function is_buffer(obj: any) {
+  if (!obj || typeof obj !== 'object') {
+    return false;
+  }
+
+  return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
+}
+
+export function combine(a: any, b: any) {
+  return [].concat(a, b);
+}
+
+export function maybe_map<T>(val: T[], fn: (v: T) => T) {
+  if (isArray(val)) {
+    const mapped = [];
+    for (let i = 0; i < val.length; i += 1) {
+      mapped.push(fn(val[i]!));
+    }
+    return mapped;
+  }
+  return fn(val);
+}

package/src/internal/utils/query.ts

@@ -1,23 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { ProfoundError } from '../../core/error';
+import * as qs from '../qs/stringify';
 
-/**
- * Basic re-implementation of `qs.stringify` for primitive types.
- */
 export function stringifyQuery(query: object | Record<string, unknown>) {
-  return Object.entries(query)
-    .filter(([_, value]) => typeof value !== 'undefined')
-    .map(([key, value]) => {
-      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-      }
-      if (value === null) {
-        return `${encodeURIComponent(key)}=`;
-      }
-      throw new ProfoundError(
-        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-      );
-    })
-    .join('&');
+  return qs.stringify(query, { arrayFormat: 'comma' });
 }

package/src/resources/organizations/categories.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as CategoriesAPI from './categories';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -34,8 +33,12 @@ export class Categories extends APIResource {
   /**
    * Get Category Prompts
    */
-  prompts(categoryID: string, options?: RequestOptions): APIPromise<CategoryPromptsResponse> {
-    return this._client.get(path`/v1/org/categories/${categoryID}/prompts`, options);
+  prompts(
+    categoryID: string,
+    query: CategoryPromptsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CategoryPromptsResponse> {
+    return this._client.get(path`/v1/org/categories/${categoryID}/prompts`, { query, ...options });
   }
 
   /**
@@ -53,13 +56,18 @@ export class Categories extends APIResource {
   }
 }
 
-export interface OrgItem {
-  id: string;
+export type CategoryListResponse = Array<CategoryListResponse.CategoryListResponseItem>;
 
-  name: string;
-}
+export namespace CategoryListResponse {
+  /**
+   * Generic id+name reference used across domain boundaries.
+   */
+  export interface CategoryListResponseItem {
+    id: string;
 
-export type CategoryListResponse = Array<OrgItem>;
+    name: string;
+  }
+}
 
 export type CategoryAssetsResponse = Array<CategoryAssetsResponse.CategoryAssetsResponseItem>;
 
@@ -129,6 +137,8 @@ export namespace CategoryGetCategoryPersonasResponse {
 
 export interface CategoryPromptsResponse {
   data: Array<CategoryPromptsResponse.Data>;
+
+  info: CategoryPromptsResponse.Info;
 }
 
 export namespace CategoryPromptsResponse {
@@ -137,21 +147,81 @@ export namespace CategoryPromptsResponse {
 
     created_at: string;
 
-    platforms: Array<CategoriesAPI.OrgItem>;
+    platforms: Array<Data.Platform>;
 
     prompt: string;
 
     prompt_type: string;
 
-    regions: Array<CategoriesAPI.OrgItem>;
+    regions: Array<Data.Region>;
 
-    topic: CategoriesAPI.OrgItem;
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    topic: Data.Topic;
 
-    tags?: Array<CategoriesAPI.OrgItem>;
+    tags?: Array<Data.Tag>;
+  }
+
+  export namespace Data {
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    export interface Platform {
+      id: string;
+
+      name: string;
+    }
+
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    export interface Region {
+      id: string;
+
+      name: string;
+    }
+
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    export interface Topic {
+      id: string;
+
+      name: string;
+    }
+
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    export interface Tag {
+      id: string;
+
+      name: string;
+    }
+  }
+
+  export interface Info {
+    limit: number;
+
+    next_cursor: string | null;
+
+    total_rows: number;
   }
 }
 
-export type CategoryTagsResponse = Array<OrgItem>;
+export type CategoryTagsResponse = Array<CategoryTagsResponse.CategoryTagsResponseItem>;
+
+export namespace CategoryTagsResponse {
+  /**
+   * Generic id+name reference used across domain boundaries.
+   */
+  export interface CategoryTagsResponseItem {
+    id: string;
+
+    name: string;
+  }
+}
 
 export type CategoryTopicsResponse = Array<CategoryTopicsResponse.CategoryTopicsResponseItem>;
 
@@ -163,14 +233,32 @@ export namespace CategoryTopicsResponse {
   }
 }
 
+export interface CategoryPromptsParams {
+  cursor?: string | null;
+
+  limit?: number;
+
+  order_dir?: 'asc' | 'desc';
+
+  platform_id?: Array<string>;
+
+  prompt_type?: Array<'visibility' | 'sentiment'>;
+
+  region_id?: Array<string>;
+
+  tag_id?: Array<string>;
+
+  topic_id?: Array<string>;
+}
+
 export declare namespace Categories {
   export {
-    type OrgItem as OrgItem,
     type CategoryListResponse as CategoryListResponse,
     type CategoryAssetsResponse as CategoryAssetsResponse,
     type CategoryGetCategoryPersonasResponse as CategoryGetCategoryPersonasResponse,
     type CategoryPromptsResponse as CategoryPromptsResponse,
     type CategoryTagsResponse as CategoryTagsResponse,
     type CategoryTopicsResponse as CategoryTopicsResponse,
+    type CategoryPromptsParams as CategoryPromptsParams,
   };
 }

package/src/resources/organizations/index.ts

@@ -2,13 +2,13 @@
 
 export {
   Categories,
-  type OrgItem,
   type CategoryListResponse,
   type CategoryAssetsResponse,
   type CategoryGetCategoryPersonasResponse,
   type CategoryPromptsResponse,
   type CategoryTagsResponse,
   type CategoryTopicsResponse,
+  type CategoryPromptsParams,
 } from './categories';
 export {
   Organizations,

package/src/resources/organizations/organizations.ts

@@ -7,10 +7,10 @@ import {
   CategoryAssetsResponse,
   CategoryGetCategoryPersonasResponse,
   CategoryListResponse,
+  CategoryPromptsParams,
   CategoryPromptsResponse,
   CategoryTagsResponse,
   CategoryTopicsResponse,
-  OrgItem,
 } from './categories';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
@@ -74,7 +74,10 @@ export namespace OrganizationGetPersonasResponse {
   export interface Data {
     id: string;
 
-    category: CategoriesAPI.OrgItem;
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    category: Data.Category;
 
     name: string;
 
@@ -82,6 +85,15 @@ export namespace OrganizationGetPersonasResponse {
   }
 
   export namespace Data {
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    export interface Category {
+      id: string;
+
+      name: string;
+    }
+
     export interface Persona {
       behavior: Persona.Behavior;
 
@@ -122,7 +134,10 @@ export namespace OrganizationListAssetsResponse {
   export interface Data {
     id: string;
 
-    category: CategoriesAPI.OrgItem;
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    category: Data.Category;
 
     created_at: string;
 
@@ -136,11 +151,44 @@ export namespace OrganizationListAssetsResponse {
 
     alternate_domains?: Array<string> | null;
   }
+
+  export namespace Data {
+    /**
+     * Generic id+name reference used across domain boundaries.
+     */
+    export interface Category {
+      id: string;
+
+      name: string;
+    }
+  }
+}
+
+export type OrganizationModelsResponse = Array<OrganizationModelsResponse.OrganizationModelsResponseItem>;
+
+export namespace OrganizationModelsResponse {
+  /**
+   * Generic id+name reference used across domain boundaries.
+   */
+  export interface OrganizationModelsResponseItem {
+    id: string;
+
+    name: string;
+  }
 }
 
-export type OrganizationModelsResponse = Array<CategoriesAPI.OrgItem>;
+export type OrganizationRegionsResponse = Array<OrganizationRegionsResponse.OrganizationRegionsResponseItem>;
+
+export namespace OrganizationRegionsResponse {
+  /**
+   * Generic id+name reference used across domain boundaries.
+   */
+  export interface OrganizationRegionsResponseItem {
+    id: string;
 
-export type OrganizationRegionsResponse = Array<CategoriesAPI.OrgItem>;
+    name: string;
+  }
+}
 
 Organizations.Categories = Categories;
 
@@ -155,12 +203,12 @@ export declare namespace Organizations {
 
   export {
     Categories as Categories,
-    type OrgItem as OrgItem,
     type CategoryListResponse as CategoryListResponse,
     type CategoryAssetsResponse as CategoryAssetsResponse,
     type CategoryGetCategoryPersonasResponse as CategoryGetCategoryPersonasResponse,
     type CategoryPromptsResponse as CategoryPromptsResponse,
     type CategoryTagsResponse as CategoryTagsResponse,
     type CategoryTopicsResponse as CategoryTopicsResponse,
+    type CategoryPromptsParams as CategoryPromptsParams,
   };
 }

package/src/resources/prompts.ts

@@ -96,7 +96,7 @@ export interface PromptAnswersParams {
     | Shared.RegionIDFilter
     | Shared.ModelIDFilter
     | Shared.TagIDFilter
-    | PromptAnswersParams.PromptTypeFilter
+    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersPromptTypeFilter
     | Shared.PromptFilter
     | Shared.PersonaIDFilter
     | Shared.TopicIDFilter
@@ -116,7 +116,7 @@ export namespace PromptAnswersParams {
   /**
    * Filter by prompt type (visibility or sentiment)
    */
-  export interface PromptTypeFilter {
+  export interface ProfoundAnswerEngineInsightsFiltersPromptTypeFilter {
     field: 'prompt_type';
 
     operator:

package/src/resources/reports.ts

@@ -224,7 +224,7 @@ export interface ReportCitationsParams {
     | Shared.TagIDFilter
     | ReportCitationsParams.URLFilter
     | ReportCitationsParams.RootDomainFilter
-    | ReportCitationsParams.PromptTypeFilter
+    | ReportCitationsParams.ProfoundAnswerEngineInsightsFiltersPromptTypeFilter
     | Shared.PersonaIDFilter
     | ReportCitationsParams.CitationCategoryFilter
     | Shared.PromptFilter
@@ -312,7 +312,7 @@ export namespace ReportCitationsParams {
   /**
    * Filter by prompt type (visibility or sentiment)
    */
-  export interface PromptTypeFilter {
+  export interface ProfoundAnswerEngineInsightsFiltersPromptTypeFilter {
     field: 'prompt_type';
 
     operator:

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.31.2'; // x-release-please-version
+export const VERSION = '0.32.0'; // x-release-please-version