@squiz/dxp-ai-client - npm Package Compare versions

Comparing version 0.9.0 to 0.10.0

CHANGELOG.md

 # @squiz/dxp-ai-client
 
+## 0.10.0
+
+### Minor Changes
+
+- Added list context items API endpoint.
+
 ## 0.9.0
@@ -4,0 +10,0 @@

dist/generated/DxpAiService.d.ts

@@ -63,3 +63,3 @@ export type AiAuthType = 'none' | 'dxp';
     pageSize?: PaginationPageLimit;
-    sortDirection?: SortDirectionEnum;
+    sortDirection?: SortDirectionEnum1;
 }
@@ -147,3 +147,11 @@ export type GetAllGenerativeThreadsParams1SortDirectionEnum = 'asc' | 'desc';
 }
-export interface ListParams2 {
+export interface ListParams3 {
+    aiId: string;
+    contextId: string;
+    cursor?: number;
+    pageSize?: PaginationPageLimit;
+    sortDirection?: SortDirectionEnum;
+}
+export type ListParams4SortDirectionEnum = 'asc' | 'desc';
+export interface ListParams5 {
     cursor?: string;
@@ -179,2 +187,9 @@ direction?: Direction;
 }
+export interface PageResultContextItem {
+    items: ContextItem[];
+    links?: {
+        nextPage?: string;
+        prevPage?: string;
+    };
+}
 export interface PageResultThread {
@@ -290,2 +305,3 @@ items: Thread[];
 export type SortDirectionEnum = 'asc' | 'desc';
+export type SortDirectionEnum1 = 'asc' | 'desc';
 export interface Thread {
@@ -374,3 +390,3 @@ aiId: string;
     }
-    namespace ListContexts {
+    namespace List {
         type RequestParams = {
@@ -418,2 +434,16 @@ aiId: string;
     }
+    namespace List {
+        type RequestParams = {
+            aiId: string;
+            contextId: string;
+        };
+        type RequestQuery = {
+            cursor?: number;
+            pageSize?: PaginationPageLimit;
+            sortDirection?: ListParams4SortDirectionEnum;
+        };
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = PageResultContextItem;
+    }
     namespace Update {
@@ -608,3 +638,3 @@ type RequestParams = {
         getSchema: (aiId: string, contextId: string, params?: RequestParams) => Promise<ExtendedJsonSchema>;
-        listContexts: (aiId: string, params?: RequestParams) => Promise<PageResultContext>;
+        list: (aiId: string, params?: RequestParams) => Promise<PageResultContext>;
     };
@@ -615,2 +645,3 @@ chatbotContextItem: {
         get: (aiId: string, contextId: string, contextItemId: string, params?: RequestParams) => Promise<ContextItem>;
+        list: ({ aiId, contextId, ...query }: ListParams3, params?: RequestParams) => Promise<PageResultContextItem>;
         update: (aiId: string, contextId: string, contextItemId: string, data: PersistedContextItem, params?: RequestParams) => Promise<PersistedContextItem>;
@@ -626,3 +657,3 @@ };
         getGenerativeThreadQueryAndResponse: (aiId: string, threadId: string, params?: RequestParams) => Promise<Message>;
-        list: (query: ListParams2, params?: RequestParams) => Promise<PageResultAiResponse>;
+        list: (query: ListParams5, params?: RequestParams) => Promise<PageResultAiResponse>;
         rate: (aiId: string, threadId: string, data: RatePayload, params?: RequestParams) => Promise<Thread>;
@@ -629,0 +660,0 @@ set: (id: string, data: GenerativeWrite, params?: RequestParams) => Promise<PickAiExcludeKeysTenantOrMetadata>;

package.json

@@ -5,3 +5,3 @@ {
   "private": false,
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Exposes the DXP AI service as a package for consumers",
@@ -21,5 +21,5 @@ "main": "dist/index.js",
     "jest": "^29.7.0",
-    "@squiz/ai-service": "1.5.0"
+    "@squiz/ai-service": "1.6.0"
   },
   "dependencies": {}
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

213046

increased by1.83%

Lines of code

1808

increased by2.2%

No dependency changes