@api-client/core 0.12.17 → 0.13.0

package/data/models/example-generator-api.json

@@ -41722,10 +41722,10 @@
 "@id": "#209"
 },
 {
-"@id": "#191"
+"@id": "#194"
 },
 {
-"@id": "#194"
+"@id": "#191"
 },
 {
 "@id": "#197"
@@ -42470,16 +42470,16 @@
 "@id": "#219"
 },
 {
-"@id": "#210"
+"@id": "#219"
 },
 {
 "@id": "#213"
 },
 {
-"@id": "#216"
+"@id": "#210"
 },
 {
-"@id": "#219"
+"@id": "#216"
 }
 ],
 "doc:root": false,
@@ -43096,7 +43096,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43117,7 +43117,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43892,7 +43892,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43934,7 +43934,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43955,7 +43955,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44416,12 +44416,12 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
@@ -44776,7 +44776,7 @@
 {
 "@id": "#212/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#212",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#215/source-map/lexical/element_0",
@@ -44786,12 +44786,12 @@
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#338/source-map/synthesized-field/element_1",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.12.17",
+  "version": "0.13.0",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/events/BaseEvents.ts

@@ -350,6 +350,58 @@ export interface ContextListResult<T> {
   items: T[]
 }
 
+/**
+ * Defines the type of comparison or operation to be performed on a field.
+ * - eq: Equal
+ * - neq: Not Equal
+ * - gt: Greater Than
+ * - lt: Less Than
+ * - gte: Greater Than or Equal
+ * - lte: Less Than or Equal
+ * - con: String contains substring / Array contains element
+ * - start: String starts with
+ * - end: String ends with
+ * - in: Value is one of the elements in the provided array
+ * - nin: Value is not one of the elements in the provided array
+ */
+export type FilterOperator =
+  | 'eq' // Equal
+  | 'neq' // Not Equal
+  | 'gt' // Greater Than
+  | 'lt' // Less Than
+  | 'gte' // Greater Than or Equal
+  | 'lte' // Less Than or Equal
+  | 'con' // String contains substring / Array contains element
+  | 'start' // String starts with
+  | 'end' // String ends with
+  | 'in' // Value is one of the elements in the provided array
+  | 'nin' // Value is not one of the elements in the provided array
+
+/**
+ * Represents a single filter condition applied to a field.
+ */
+export interface AtomicFilter {
+  field: string
+  operator: FilterOperator
+  value?: unknown // The value to compare against the field.
+  // For 'in'/'nin', value should be an array.
+}
+
+/**
+ * Represents a group of filters combined with a logical operator.
+ * This allows for nesting and complex query construction.
+ */
+export interface FilterGroup {
+  op: 'AND' | 'OR'
+  filters: (AtomicFilter | FilterGroup)[]
+}
+
+/**
+ * Represents a filter that can be either a single atomic condition
+ * or a group of conditions. This is the type to be used in ContextListOptions.
+ */
+export type QueryFilter = AtomicFilter | FilterGroup
+
 /**
  * Base query options for the data store.
  */
@@ -359,25 +411,9 @@ export interface ContextListOptions {
    */
   limit?: number
   /**
-   * Page cursor to use with the query. This is returned by the
+   * Page cursor to use with the query. This is returned by the API.
    */
   cursor?: string
-  /**
-   * Optional general purpose parent for the query.
-   */
-  parent?: string
-  /**
-   * Supported by some endpoints. When set it performs a query on the data store.
-   */
-  query?: string
-  /**
-   * Only with the `query` property. Tells the system in which fields to search for the query term.
-   */
-  queryField?: string[]
-  /**
-   * Whether to use the `descending` order.
-   */
-  descending?: boolean
   /**
    * The name of the field to order then results.
    */
@@ -387,11 +423,6 @@ export interface ContextListOptions {
    * It can be `asc` or `desc`.
    */
   order?: 'asc' | 'desc'
-  /**
-   * General purpose type property to filer the results.
-   * This is used, for example, by the history store to list history for a specific type of requests,
-   */
-  type?: string
   /**
    * Used when synchronizing data in the local store with the data stored in the net-store.
    * The timestamp when the last synchronization was performed. The resulting array will contain only items that
@@ -399,14 +430,19 @@ export interface ContextListOptions {
    */
   since?: number
   /**
-   * The list of kinds to list. This is used when querying for files.
+   * Optional parent identifier for hierarchical queries.
+   * Some specific list operations might use this directly.
    */
-  kinds?: unknown[]
+  parent?: string
   /**
-   * Some endpoints require the `oid` property to be set as a query parameter
-   * and not as a part of the URL. It is used when the org id is optional.
+   * Optional organization identifier.
+   * Some specific list operations might use this directly if not part of the main path.
    */
   oid?: string
+  /**
+   * A structured filter object for advanced querying.
+   */
+  filter?: QueryFilter
 }
 
 export class ContextListEvent<T> extends ContextEvent<ContextListOptions, ContextListResult<T>> {

package/src/sdk/FilesSdk.ts

@@ -60,16 +60,12 @@ export class FilesSdk extends SdkBase {
    */
   async list(
     organization: string,
-    kinds?: ListFileKind[],
     options: ContextListOptions = {},
     request: SdkOptions = {}
   ): Promise<ContextListResult<IFile>> {
     const { token } = request
     const opts = { ...options }
     const url = this.sdk.getUrl(RouteBuilder.files(organization))
-    if (kinds && kinds.length) {
-      opts.kinds = kinds
-    }
     this.sdk.appendListOptions(url, opts)
     const result = await this.sdk.http.get(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
@@ -326,7 +322,7 @@ export class FilesSdk extends SdkBase {
   async readBulk(organization: string, keys: string[], request: SdkOptions = {}): Promise<IBulkOperationResult<IFile>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.filesBatch(organization))
-    const body = JSON.stringify(keys)
+    const body = JSON.stringify({ ids: keys })
     const result = await this.sdk.http.post(url.toString(), { token, body })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to read files in bulk. '

package/src/sdk/Sdk.ts

@@ -144,26 +144,12 @@ export abstract class Sdk {
     if (options.cursor) {
       searchParams.set('cursor', options.cursor)
     }
-    if (Array.isArray(options.kinds)) {
-      options.kinds.forEach((k) => url.searchParams.append('kinds', String(k)))
-    }
     if (typeof options.limit === 'number') {
       searchParams.set('limit', String(options.limit))
     }
-    if (options.query) {
-      searchParams.set('query', options.query)
-    }
-    if (Array.isArray(options.queryField)) {
-      options.queryField.forEach((field) => {
-        searchParams.append('queryField', field)
-      })
-    }
     if (options.parent) {
       searchParams.set('parent', options.parent)
     }
-    if (options.type) {
-      searchParams.set('type', options.type)
-    }
     if (options.since) {
       searchParams.set('since', String(options.since))
     }
@@ -176,8 +162,12 @@ export abstract class Sdk {
     if (options.oid) {
       searchParams.set('oid', String(options.oid))
     }
-    if (typeof options.descending === 'boolean') {
-      searchParams.set('descending', String(options.descending))
+    if (options.filter) {
+      const bytes = new TextEncoder().encode(JSON.stringify(options.filter))
+      // To be used when Uint8Array.prototype.toBase64() is available.
+      // const encoded = bytes.toBase64({ alphabet: 'base64url' })
+      const binString = Array.from(bytes, (byte) => String.fromCodePoint(byte)).join('')
+      searchParams.set('filter', btoa(binString))
     }
   }
 }