@api-client/core 0.19.36 → 0.19.37

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.19.36",
+  "version": "0.19.37",
   "license": "UNLICENSED",
   "exports": {
     "./browser.js": {
@@ -86,7 +86,7 @@
     "@api-client/json": "^0.2.0",
     "@esm-bundle/chai": "^4.3.4-fix.0",
     "@faker-js/faker": "^10.1.0",
-    "@jarrodek/amw": "^0.1.1",
+    "@jarrodek/amw": "^0.2.2",
     "@jarrodek/pluralize": "^1.0.2",
     "@metrichor/jmespath": "^0.3.1",
     "@pawel-up/csv": "^0.2.0",

package/src/events/BaseEvents.ts

@@ -169,7 +169,7 @@ export interface IBulkOperationResult<T> {
    * The batch operation does not return specific errors. Use the direct delete operation
    * for the detailed error.
    */
-  items: (T | undefined | null)[]
+  data: (T | undefined | null)[]
 }
 
 /**
@@ -280,7 +280,7 @@ export interface ContextUpdateBulkEventDetail<T = unknown> {
   /**
    * The list of context store objects to be updated by the context provider.
    */
-  items: T[]
+  data: T[]
   /**
    * The key of the parent object, if applicable.
    */
@@ -347,7 +347,7 @@ export interface ContextListResult<T> {
    * The list of items in the response.
    * May be empty array when there was no more results.
    */
-  items: T[]
+  data: T[]
 }
 
 /**
@@ -402,6 +402,22 @@ export interface FilterGroup {
  */
 export type QueryFilter = AtomicFilter | FilterGroup
 
+/**
+ * Checks if the filter is an atomic filter.
+ * @param filter The filter to check.
+ */
+export function isAtomicFilter(filter?: QueryFilter): filter is AtomicFilter {
+  return !!filter && 'field' in filter && 'operator' in filter
+}
+
+/**
+ * Checks if the filter is a group filter.
+ * @param filter The filter to check.
+ */
+export function isFilterGroup(filter?: QueryFilter): filter is FilterGroup {
+  return !!filter && 'op' in filter && 'filters' in filter
+}
+
 /**
  * Base query options for the data store.
  */
@@ -488,7 +504,7 @@ export interface IQueryResponse<T = unknown> {
   /**
    * An ordered list of results.
    */
-  items: IQueryResult<T>[]
+  data: IQueryResult<T>[]
 }
 
 export interface IQueryResult<T = unknown> {

package/src/mocking/lib/Deployment.ts

@@ -2,6 +2,7 @@ import { faker } from '@faker-js/faker'
 import { nanoid } from '../../nanoid.js'
 import { DeploymentEnvironment, DeploymentKind, DeploymentStatus } from '../../models/store/Deployment.js'
 import type { DeploymentSchema } from '../../models/store/Deployment.js'
+import type { DeploymentApi } from '../../sdk/DeploymentsSdk.js'
 
 const deploymentEnvironments: DeploymentEnvironment[] = [
   DeploymentEnvironment.PROD,
@@ -85,4 +86,17 @@ export class Deployment {
     }
     return result
   }
+
+  deploymentApi(init: Partial<DeploymentApi> = {}): DeploymentApi {
+    const { fileId = nanoid(), apiSlug = faker.internet.domainWord() } = init
+    return { fileId, apiSlug }
+  }
+
+  deploymentApis(size = 25, init?: Partial<DeploymentApi>): DeploymentApi[] {
+    const result: DeploymentApi[] = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.deploymentApi(init))
+    }
+    return result
+  }
 }

package/src/models/store/Deployment.ts

@@ -11,19 +11,19 @@ export enum DeploymentStatus {
   /**
    * Deployment is pending
    */
-  Pending = 0,
+  Pending = 'pending',
   /**
    * Deployment is active
    */
-  Active = 1,
+  Active = 'active',
   /**
    * Deployment is inactive
    */
-  Inactive = 2,
+  Inactive = 'inactive',
   /**
    * Deployment has failed
    */
-  Failed = 3,
+  Failed = 'failed',
 }
 
 /**

package/src/sdk/AiSdk.ts

@@ -156,7 +156,7 @@ export class AiSdk extends SdkBase {
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
-      if (!Array.isArray(data.items)) {
+      if (!Array.isArray(data.data)) {
         throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
       }
       return data
@@ -328,7 +328,7 @@ export class AiSdk extends SdkBase {
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
-      if (!Array.isArray(data.items)) {
+      if (!Array.isArray(data.data)) {
         throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
       }
       return data

package/src/sdk/DeploymentsSdk.ts

@@ -1,4 +1,4 @@
-import { SdkBase, type SdkOptions, E_RESPONSE_STATUS } from './SdkBase.js'
+import { SdkBase, type SdkOptions, E_RESPONSE_STATUS, E_RESPONSE_UNKNOWN } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { DeploymentEnvironment, DeploymentKind, DeploymentSchema } from '../models/store/Deployment.js'
 import { Exception } from '../exceptions/exception.js'
@@ -24,7 +24,49 @@ export interface CreateDeploymentPayload {
   env: DeploymentEnvironment
 }
 
+/**
+ * Used when querying for all APIs deployed in the organization.
+ */
+export interface DeploymentApi {
+  /**
+   * ID of the API file.
+   */
+  fileId: string
+  /**
+   * Slug of the API.
+   */
+  apiSlug: string
+}
+
+export interface DeploymentLatestEnvironments {
+  /**
+   * Latest production deployment (if any).
+   */
+  prod?: DeploymentSchema
+  /**
+   * Latest staging environment deployment (if any).
+   */
+  stage?: DeploymentSchema
+  /**
+   * Latest development environment deployment (if any).
+   */
+  dev?: DeploymentSchema
+}
+
+export interface DeploymentLatestEnvironmentsResponse {
+  data: DeploymentLatestEnvironments
+}
+
 export class DeploymentsSdk extends SdkBase {
+  /**
+   * Lists deployments for a given organization.
+   *
+   * This endpoint supports pagination and filtering.
+   * The client should use it to compose its own paginated list of deployments.
+   *
+   * @param oid The organization ID
+   * @param options Optional SDK options
+   */
   async list(
     oid: string,
     options: ContextListOptions = {},
@@ -123,36 +165,41 @@ export class DeploymentsSdk extends SdkBase {
 
   apis = {
     /**
-     * Lists deployments for a given API, with one entry per environment.
-     * This is used to display the list of environments for a given API.
+     * Lists all APIs in an organization with their active or latest (if no active) deployments.
+     * If an environment is missing then there's no deployment for it.
      *
      * @param oid The organization ID
-     * @param apiId The API ID
+     * @param fileId The API model file ID
      * @param request Optional SDK options
+     * @returns Object containing latest deployments for each environment
      */
-    listAllForApi: async (
+    getLatestPerEnvironment: async (
       oid: string,
-      apiId: string,
+      fileId: string,
       request: SdkOptions = {}
-    ): Promise<ContextListResult<DeploymentSchema>> => {
-      const url = this.sdk.getUrl(RouteBuilder.deploymentsApisByEnv(oid, apiId))
+    ): Promise<DeploymentLatestEnvironmentsResponse> => {
+      const url = this.sdk.getUrl(RouteBuilder.deploymentsApisByEnvLatest(oid, fileId))
       const { token = this.sdk.token } = request
       const result = await this.sdk.http.get(url.toString(), { token })
-      return this.processListResponse<DeploymentSchema>(result, 'Unable to list environment deployments for an API. ')
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to list latest deployments for an API. '
+      const data = this.readResponseJSON<DeploymentLatestEnvironmentsResponse>(result, E_PREFIX)
+      if (!data.data) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
     },
 
-    listForEnvironment: async (
-      oid: string,
-      apiId: string,
-      env: DeploymentEnvironment,
-      options: ContextListOptions = {},
-      request: SdkOptions = {}
-    ): Promise<ContextListResult<DeploymentSchema>> => {
-      const url = this.sdk.getUrl(RouteBuilder.deploymentsApisForEnv(oid, apiId, env))
-      this.sdk.appendListOptions(url, options)
+    /**
+     * List all APIs in an organization (API slugs + API model file ID).
+     * @param oid The organization ID
+     * @param request Optional SDK options
+     */
+    list: async (oid: string, request: SdkOptions = {}): Promise<ContextListResult<DeploymentApi>> => {
+      const url = this.sdk.getUrl(RouteBuilder.deploymentsApis(oid))
       const { token = this.sdk.token } = request
       const result = await this.sdk.http.get(url.toString(), { token })
-      return this.processListResponse<DeploymentSchema>(result, 'Unable to list environment deployments for an API. ')
+      return this.processListResponse<DeploymentApi>(result, 'Unable to list APIs. ')
     },
   }
 }

package/src/sdk/FilesSdk.ts

@@ -78,7 +78,7 @@ export class FilesSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -338,7 +338,7 @@ export class FilesSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -553,7 +553,7 @@ export class FilesSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -586,7 +586,7 @@ export class FilesSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data

package/src/sdk/HistorySdk.ts

@@ -87,7 +87,7 @@ export class HistorySdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!data.items) {
+    if (!data.data) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -119,7 +119,7 @@ export class HistorySdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -192,7 +192,7 @@ export class HistorySdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data

package/src/sdk/OrganizationsSdk.ts

@@ -41,7 +41,7 @@ export class OrganizationsSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -115,7 +115,7 @@ export class OrganizationsSdk extends SdkBase {
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
-      if (!Array.isArray(data.items)) {
+      if (!Array.isArray(data.data)) {
         throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
       }
       return data
@@ -371,7 +371,7 @@ export class OrganizationsSdk extends SdkBase {
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
-      if (!Array.isArray(data.items)) {
+      if (!Array.isArray(data.data)) {
         throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
       }
       return data
@@ -445,7 +445,7 @@ export class OrganizationsSdk extends SdkBase {
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
-      if (!Array.isArray(data.items)) {
+      if (!Array.isArray(data.data)) {
         throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
       }
       return data

package/src/sdk/RevisionsSdk.ts

@@ -43,7 +43,7 @@ export class RevisionsSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data

package/src/sdk/RouteBuilder.ts

@@ -1,7 +1,6 @@
 /* eslint-disable @typescript-eslint/no-extraneous-class */
 
 import type { AiSessionApp } from '../models/AiSession.js'
-import type { DeploymentEnvironment } from '../models/store/Deployment.js'
 
 /**
  * A helper class to make sure routes user and reported by this service are consistent.
@@ -340,19 +339,15 @@ export class RouteBuilder {
     return `/v1/orgs/${oid}/deployments`
   }
 
-  static deploymentsApis(oid: string, apiId: string): string {
-    return `${RouteBuilder.deployments(oid)}/apis/${apiId}`
-  }
-
-  static deploymentsApisByEnv(oid: string, apiId: string): string {
-    return `${RouteBuilder.deploymentsApis(oid, apiId)}/envs`
-  }
-
-  static deploymentsApisForEnv(oid: string, apiId: string, env: DeploymentEnvironment): string {
-    return `${RouteBuilder.deploymentsApis(oid, apiId)}/envs/${env}`
+  static deploymentsApis(oid: string): string {
+    return `${RouteBuilder.deployments(oid)}/apis`
   }
 
   static deployment(oid: string, deploymentId: string): string {
     return `${RouteBuilder.deployments(oid)}/${deploymentId}`
   }
+
+  static deploymentsApisByEnvLatest(oid: string, fileId: string): string {
+    return `${RouteBuilder.deploymentsApis(oid)}/${fileId}/environments/latest`
+  }
 }

package/src/sdk/SdkBase.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import { Headers } from '../lib/headers/Headers.js'
 import { Sdk } from './Sdk.js'
 import {
@@ -54,6 +53,7 @@ export class SdkBase {
       try {
         const data = JSON.parse(response.body)
         if (data.message) {
+          // eslint-disable-next-line no-console
           console.warn(`[Store message]: ${data.message}`)
         }
       } catch {
@@ -155,7 +155,7 @@ export class SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -201,7 +201,7 @@ export class SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data
@@ -240,9 +240,9 @@ export class SdkBase {
 
   /**
    * A helper function to process List response.
-   * The list response is standardised response containing the `items` and `cursor` properties.
+   * The list response is standardised response containing the `data` and `cursor` properties.
    * The list response also returns 200 status code. The logic validates the JSON response,
-   * 200 status code, and whether the response the `items` array (can be empty).
+   * 200 status code, and whether the response the `data` array (can be empty).
    *
    * @param result The read results of a standard List request
    * @param prefix The error prefix to use with the error codes.
@@ -252,7 +252,7 @@ export class SdkBase {
     this.inspectCommonStatusCodes(result)
     // Status check happens in the readResponseBody method.
     const data = this.readResponseJSON<ContextListResult<T>>(result, prefix)
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${prefix}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data