npm - @empathyco/x-components - Versions diffs - 6.2.3 → 6.3.1 - Mend

@empathyco/x-components 6.2.3 → 6.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/report/x-types.api.json CHANGED Viewed

@@ -7111,11 +7111,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "originalValue: "
+                  "text": "originalValue?: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number"
+                  "text": "number | undefined"
                 },
                 {
                   "kind": "Content",
@@ -7123,7 +7123,7 @@
                 }
               ],
               "isReadonly": false,
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "originalValue",
               "propertyTypeTokenRange": {
@@ -7138,11 +7138,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "value: "
+                  "text": "value?: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number"
+                  "text": "number | undefined"
                 },
                 {
                   "kind": "Content",
@@ -7150,7 +7150,7 @@
                 }
               ],
               "isReadonly": false,
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "value",
               "propertyTypeTokenRange": {
@@ -9047,56 +9047,6 @@
           "name": "XComponentsAdapter",
           "preserveMemberOrder": false,
           "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiQuestions:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "aiQuestions: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "EndpointAdapter",
-                  "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "AiQuestionsRequest",
-                  "canonicalReference": "@empathyco/x-types!AiQuestionsRequest:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "AiQuestionsResponse",
-                  "canonicalReference": "@empathyco/x-types!AiQuestionsResponse:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "aiQuestions",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 7
-              }
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiSuggestions:member",
@@ -9197,106 +9147,6 @@
                 "endIndex": 7
               }
             },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiSummarize:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "aiSummarize: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "EndpointAdapter",
-                  "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "AiSuggestionsRequest",
-                  "canonicalReference": "@empathyco/x-types!AiSuggestionsRequest:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Response",
-                  "canonicalReference": "!Response:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "aiSummarize",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 7
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiTasks:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "aiTasks: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "EndpointAdapter",
-                  "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "AiTasksRequest",
-                  "canonicalReference": "@empathyco/x-types!AiTasksRequest:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "AiTasksResponse",
-                  "canonicalReference": "@empathyco/x-types!AiTasksResponse:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "aiTasks",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 7
-              }
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-types!XComponentsAdapter#experienceControls:member",

package/docs/API-reference/api/x-adapter-platform.aiquestionsendpointadapter.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiQuestionsEndpointAdapter](./x-adapter-platform.aiquestionsendpointadapter.md)
-## aiQuestionsEndpointAdapter variable
-Default adapter for the questions v1 endpoint.
-**Signature:**
-```typescript
-aiQuestionsEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<AiQuestionsRequest, AiQuestionsResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aiquestionsrequestmapper.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiQuestionsRequestMapper](./x-adapter-platform.aiquestionsrequestmapper.md)
-## aiQuestionsRequestMapper variable
-Default implementation for the AIQuestionsRequestMapper.
-**Signature:**
-```typescript
-aiQuestionsRequestMapper: import("@empathyco/x-adapter").Mapper<AiQuestionsRequest, PlatformAiQuestionsRequest>
-```

package/docs/API-reference/api/x-adapter-platform.aiquestionsrequestschema.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiQuestionsRequestSchema](./x-adapter-platform.aiquestionsrequestschema.md)
-## aiQuestionsRequestSchema variable
-Default implementation for the AiQuestionsRequestSchema.
-**Signature:**
-```typescript
-aiQuestionsRequestSchema: import("@empathyco/x-adapter").MutableSchema<AiQuestionsRequest, PlatformAiQuestionsRequest>
-```

package/docs/API-reference/api/x-adapter-platform.aiquestionsresponsemapper.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiQuestionsResponseMapper](./x-adapter-platform.aiquestionsresponsemapper.md)
-## aiQuestionsResponseMapper variable
-Default implementation for the AiQuestionsResponseMapper.
-**Signature:**
-```typescript
-aiQuestionsResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformAiQuestionsResponse, AiQuestionsResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aiquestionsresponseschema.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiQuestionsResponseSchema](./x-adapter-platform.aiquestionsresponseschema.md)
-## aiQuestionsResponseSchema variable
-Default implementation for the AIQuestionsResponseSchema.
-**Signature:**
-```typescript
-aiQuestionsResponseSchema: import("@empathyco/x-adapter").MutableSchema<PlatformAiQuestionsResponse, AiQuestionsResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aiquestionsschema.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiQuestionsSchema](./x-adapter-platform.aiquestionsschema.md)
-## aiQuestionsSchema variable
-Default implementation for the AIQuestionsSchema.
-**Signature:**
-```typescript
-aiQuestionsSchema: import("@empathyco/x-adapter").MutableSchema<PlatformAiQuestionsResponse, AiQuestionsResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aisummarizeendpointadapter.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiSummarizeEndpointAdapter](./x-adapter-platform.aisummarizeendpointadapter.md)
-## aiSummarizeEndpointAdapter variable
-Default adapter for the Overview summarize streaming endpoint.
-Mirrors the aiSuggestions endpoint adapter.
-**Signature:**
-```typescript
-aiSummarizeEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<AiSuggestionsRequest, Response>
-```

package/docs/API-reference/api/x-adapter-platform.aitasksendpointadapter.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksEndpointAdapter](./x-adapter-platform.aitasksendpointadapter.md)
-## aiTasksEndpointAdapter variable
-Default adapter for the questions v1 endpoint.
-**Signature:**
-```typescript
-aiTasksEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<AiTasksRequest, AiTasksResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aitasksrequestmapper.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksRequestMapper](./x-adapter-platform.aitasksrequestmapper.md)
-## aiTasksRequestMapper variable
-Default implementation for the AiTasksRequestMapper.
-**Signature:**
-```typescript
-aiTasksRequestMapper: import("@empathyco/x-adapter").Mapper<AiTasksRequest, PlatformAiTasksRequest>
-```

package/docs/API-reference/api/x-adapter-platform.aitasksrequestschema.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksRequestSchema](./x-adapter-platform.aitasksrequestschema.md)
-## aiTasksRequestSchema variable
-Default implementation for the AiTasksRequestSchema.
-**Signature:**
-```typescript
-aiTasksRequestSchema: import("@empathyco/x-adapter").MutableSchema<AiTasksRequest, PlatformAiTasksRequest>
-```

package/docs/API-reference/api/x-adapter-platform.aitasksresponsemapper.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksResponseMapper](./x-adapter-platform.aitasksresponsemapper.md)
-## aiTasksResponseMapper variable
-Default implementation for the AiTasksResponseMapper.
-**Signature:**
-```typescript
-aiTasksResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformAiTasksResponse, AiTasksResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aitasksresponseschema.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksResponseSchema](./x-adapter-platform.aitasksresponseschema.md)
-## aiTasksResponseSchema variable
-Default implementation for the AITasksResponseSchema.
-**Signature:**
-```typescript
-aiTasksResponseSchema: import("@empathyco/x-adapter").MutableSchema<PlatformAiTasksResponse, AiTasksResponse>
-```

package/docs/API-reference/api/x-adapter-platform.aitasksschema.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksSchema](./x-adapter-platform.aitasksschema.md)
-## aiTasksSchema variable
-Default implementation for the AITasksSchema.
-**Signature:**
-```typescript
-aiTasksSchema: import("@empathyco/x-adapter").MutableSchema<PlatformAiTasksResponse, AiTasksResponse>
-```

package/docs/API-reference/api/x-adapter-platform.platformadapter.aiquestions.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [aiQuestions](./x-adapter-platform.platformadapter.aiquestions.md)
-## PlatformAdapter.aiQuestions property
-**Signature:**
-```typescript
-aiQuestions: ExtendableEndpointAdapter<AiQuestionsRequest, AiQuestionsResponse>;
-```

package/docs/API-reference/api/x-adapter-platform.platformadapter.aisummarize.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [aiSummarize](./x-adapter-platform.platformadapter.aisummarize.md)
-## PlatformAdapter.aiSummarize property
-**Signature:**
-```typescript
-aiSummarize: ExtendableEndpointAdapter<AiSuggestionsRequest, Response>;
-```

package/docs/API-reference/api/x-adapter-platform.platformadapter.aitasks.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [aiTasks](./x-adapter-platform.platformadapter.aitasks.md)
-## PlatformAdapter.aiTasks property
-**Signature:**
-```typescript
-aiTasks: ExtendableEndpointAdapter<AiTasksRequest, AiTasksResponse>;
-```

package/docs/API-reference/api/x-adapter-platform.platformaiquestionsrequest.context.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAiQuestionsRequest](./x-adapter-platform.platformaiquestionsrequest.md) &gt; [context](./x-adapter-platform.platformaiquestionsrequest.context.md)
-## PlatformAiQuestionsRequest.context property
-**Signature:**
-```typescript
-context: {
-        lang: string;
-        instance?: string;
-        filters?: Record<string, unknown>;
-        query?: string;
-    };
-```

package/docs/API-reference/api/x-adapter-platform.platformaiquestionsrequest.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAiQuestionsRequest](./x-adapter-platform.platformaiquestionsrequest.md)
-## PlatformAiQuestionsRequest interface
-Request for the `Questions v1` endpoint.
-**Signature:**
-```typescript
-export interface PlatformAiQuestionsRequest
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[context](./x-adapter-platform.platformaiquestionsrequest.context.md)
-</td><td>
-</td><td>
-{ lang: string; instance?: string; filters?: Record&lt;string, unknown&gt;; query?: string; }
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/API-reference/api/x-adapter-platform.platformaiquestionsresponse.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAiQuestionsResponse](./x-adapter-platform.platformaiquestionsresponse.md)
-## PlatformAiQuestionsResponse interface
-Response for the `questions` endpoint.
-**Signature:**
-```typescript
-export interface PlatformAiQuestionsResponse extends AiQuestionsResponse
-```
-**Extends:** AiQuestionsResponse

package/docs/API-reference/api/x-adapter-platform.platformaitasksrequest.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAiTasksRequest](./x-adapter-platform.platformaitasksrequest.md)
-## PlatformAiTasksRequest interface
-Request for the `Tasks v1` endpoint.
-**Signature:**
-```typescript
-export interface PlatformAiTasksRequest
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[taskId](./x-adapter-platform.platformaitasksrequest.taskid.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/API-reference/api/x-adapter-platform.platformaitasksrequest.taskid.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAiTasksRequest](./x-adapter-platform.platformaitasksrequest.md) &gt; [taskId](./x-adapter-platform.platformaitasksrequest.taskid.md)
-## PlatformAiTasksRequest.taskId property
-**Signature:**
-```typescript
-taskId: string;
-```

package/docs/API-reference/api/x-adapter-platform.platformaitasksresponse.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAiTasksResponse](./x-adapter-platform.platformaitasksresponse.md)
-## PlatformAiTasksResponse interface
-Response for the `tasks` endpoint.
-**Signature:**
-```typescript
-export interface PlatformAiTasksResponse extends AiTasksResponse
-```
-**Extends:** AiTasksResponse

package/docs/API-reference/api/x-types.xcomponentsadapter.aiquestions.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [aiQuestions](./x-types.xcomponentsadapter.aiquestions.md)
-## XComponentsAdapter.aiQuestions property
-**Signature:**
-```typescript
-aiQuestions: EndpointAdapter<AiQuestionsRequest, AiQuestionsResponse>;
-```

package/docs/API-reference/api/x-types.xcomponentsadapter.aisummarize.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [aiSummarize](./x-types.xcomponentsadapter.aisummarize.md)
-## XComponentsAdapter.aiSummarize property
-**Signature:**
-```typescript
-aiSummarize: EndpointAdapter<AiSuggestionsRequest, Response>;
-```

package/docs/API-reference/api/x-types.xcomponentsadapter.aitasks.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [aiTasks](./x-types.xcomponentsadapter.aitasks.md)
-## XComponentsAdapter.aiTasks property
-**Signature:**
-```typescript
-aiTasks: EndpointAdapter<AiTasksRequest, AiTasksResponse>;
-```