@webitel/api-services 0.0.29 → 0.0.30

package/Readme.md

@@ -1,13 +1,107 @@
-# @webitel/api-services
+# `@webitel/api-services`
 
-## Includes:
+## Contents:
 
-* API services, **generated (!)** from webitel swagger file
-* Utils for these generated services
+### Generated API services. 
+
+_Source: webitel [swagger file](https://swagger.webitel.com/)._
+
+### API clients.
+
+API clients – self-written api wrappers on top of gen services.
+
+### Utils, tools and helpers, related to API communication.
 
 ## Exports:
 
-* `@webitel/api-services/gen` – generated services
-* `@webitel/api-services/utils` – utils for generated services
+### `@webitel/api-services/gen`
+
+```ts
+// zod, services, msw
+import {
+    createSourceBody, // zod
+    getSources, // api service
+    getListSourcesResponseMock, // mock
+} from '@webitel/api-services/gen';
+```
+
+### `@webitel/api-services/gen/models`
+
+```ts
+import {
+    // enums, types and interfaces
+} from '@webitel/api-services/gen/models';
+```
+
+### `@webitel/api-services/gen/utils`
+
+```ts
+import {
+    // get list of top-level field keys. useful to sanitize fieldsToSend
+    getShallowFieldsToSendFromZodSchema,
+    // DONT USE. same, but for nested fields
+    getFieldsToSendFromZodSchema,
+    // pass zod schema, pass empty object, get object with default values
+    getDefaultsFromZodSchema,
+} from '@webitel/api-services/gen/utils';
+```
+
+### `@webitel/api-services/api`
+
+See ["contents" section](#api-clients).
+
+```ts
+import { ContactsAPI } from '@webitel/api-services/api';
+```
+
+### `@webitel/api-services/api/transformers`
+
+API transformers, used to transform data before sending it to the server or after receiving it from the server.
+
+```ts
+import { applyTransform } from '@webitel/api-services/api';
+```
+
+### `@webitel/api-services/api/defaults`
+
+API defaults: default axios instance, default getList response, etc
+
+```ts
+import { getDefaultInstance } from '@webitel/api-services/api/defaults';
+```
+
+## Usage
+
+### API Mocks
+
+Useful for parallel development, testing, and debugging.
+Calling a mock returns fake generated data, without sending a request to the server.
+
+```ts
+import { getSources } from '@webitel/api-services/gen';
+
+const searchSources = getSources().listSources();
+```
+->
+
+```ts
+import { getListSourcesResponseMock } from '@webitel/api-services/gen';
+```
+
+## FAQ
+
+### Q: How to generate API?
+
+A: Run [this](https://github.com/webitel/webitel-ui-sdk/actions/workflows/api-services.publish.yml)
+**manual** workflow.
+
+### Q: generating source?
+A: `https://raw.githubusercontent.com/webitel/protos/main/swagger/api.json`
+
+### Q: Versioning?
+A: Automated version patching on each action run.
+minor/major version bump is manual, if needed.
 
+## Related links:
 
+* backend proto annotations [guideline](https://github.com/webitel/protos/blob/docs(proto-annotation-guidelines)/docs/proto_annotation_guidelines.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webitel/api-services",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "private": false,
   "scripts": {
     "make-all": "npm run gen:api && npm version patch && (npm run build:types || true) && (npm run format:all || true) && npm run publish-lib",
@@ -20,6 +20,7 @@
   "files": [
     "src/*",
     "types/*",
+    "Readme.md",
     "CHANGELOG.md"
   ],
   "peerDependencies": {

package/src/api/clients/caseSources/caseSources.ts

@@ -75,8 +75,8 @@ const addSource = async ({ itemInstance }) => {
 
 const updateSource = async ({ itemInstance, itemId: id }) => {
 	const item = applyTransform(itemInstance, [
-		camelToSnake(),
 		sanitize(getShallowFieldsToSendFromZodSchema(updateSourceBody)),
+		camelToSnake(),
 	]);
 
 	try {

package/src/api/clients/quickReplies/quickReplies.ts

@@ -8,6 +8,7 @@ import {
 	notify,
 	sanitize,
 	snakeToCamel,
+	starToSearch,
 } from '../../transformers';
 
 const fieldsToSend = ['name', 'queues', 'article', 'teams', 'text'];
@@ -19,6 +20,7 @@ const getQuickRepliesList = async (params) => {
 		merge(getDefaultGetParams()),
 		(params) => ({ ...params, q: params.search }),
 		sanitize(fieldsToSend),
+		starToSearch('q'),
 		camelToSnake(),
 	]);