@torrow/sdk-client 0.10.0 → 0.11.1

package/README.md

@@ -60,6 +60,12 @@ Network failures use `TorrowSdkError`: `category` is independent of the outcome
 
 Selected composite methods provide optional `detail`, `operation`, `failureAt` and immutable `effects`. Missing `effects` means no description is supplied. Local builder/ID/constructor errors retain their existing exception types. Errors do not authorize automatic retry.
 
+`publicMessage?: string` is an optional explanation for people or AI clients. The eight item `patch` methods supply short Russian messages from SDK templates; other methods may omit it. Use `error.publicMessage ?? "Не удалось выполнить операцию."` for display and `category`/`effects` for decisions. Wording is not a stable machine code and does not prove whether a write happened. Applications can replace it with their own localized text. The standard `Error.message` stays generic.
+
+The constructor accepts nonblank strings of at most 512 UTF-16 code units and preserves them unchanged. Invalid values become `undefined` without throwing, coercing or truncating. This checks shape, not confidentiality: callers creating errors or using `withContext` must supply safe text. SDK patch never forwards server/callback messages or item data into this field.
+
+`toJSON()` includes the explanation. `withContext({})` preserves it, `withContext({ publicMessage: undefined })` clears it, and a supplied string replaces it under the same validation. The original error and sensitive diagnostics remain intact. Unknown server codes, status and correlation metadata remain available through `http`; raw data stays behind `getSensitiveDetails()`.
+
 
 ## Частичное обновление item
 

package/dist/index.d.ts

@@ -37576,6 +37576,20 @@ type VerifyCommunicationCodeRespDto = components["schemas"]["VerifyCommunication
 type ViewInfoDto = components["schemas"]["ViewInfo"];
 type WorkloadPeriodDto = components["schemas"]["WorkloadPeriod"];
 
+/**
+ * Поддерживаемая публичность SDK. Private временно исключён из-за серверного дефекта;
+ * Undefined исключён по решению контракта. Ответы с обоими значениями читаются как Personal.
+ * Возврат Private требует подтверждённого исправления сервера, Undefined — отдельного решения.
+ */
+type PublicityType = Exclude<PublicityTypeDto, "Private" | "Undefined">;
+/**
+ * Публичная проекция серверной модели: сужает объявленное publicityType, включая вложенные DTO.
+ * Сохраняет optional/null, даты, массивы и непрозрачные пользовательские данные unknown.
+ */
+type NormalizedPublicity<T> = T extends Date ? T : T extends object ? {
+    [K in keyof T]: K extends "publicityType" ? Exclude<T[K], "Private" | "Undefined"> : NormalizedPublicity<T[K]>;
+} : T;
+
 type SolutionData = OpenApiSchemas["SolutionData"];
 type PersonalSolutionData = OpenApiSchemas["PersonalSolutionData"];
 type Metrics = OpenApiSchemas["Metrics"];
@@ -37648,12 +37662,12 @@ type TorrowObject = TorrowObjectDto;
 /**
  * Общие поля item: схема `TorrowItem` + явное пересечение с `TorrowObject`, чтобы тип оставался подтипом `TorrowObject`.
  */
-type TorrowItem = TorrowItemDto & TorrowObject;
+type TorrowItem = NormalizedPublicity<TorrowItemDto> & TorrowObject;
 /**
  * Публичный item-тип из доменного OpenAPI-DTO: пересечение с **`TorrowItem`**, чтобы в типах явно
  * участвовали общие поля item и связь с **`TorrowObject`** (после codegen даты уже **`Date`** в DTO).
  */
-type TorrowItemFromDto<D extends object> = D & TorrowItem;
+type TorrowItemFromDto<D extends object> = NormalizedPublicity<D> & TorrowItem;
 /**
  * Ключи, которые не должны попадать в тело create/update: профиль и дискриминатор,
  * поля социального слоя с отдельными эндпоинтами (`TorrowItemCoreFacade` / `TorrowItemFacade`),
@@ -37674,9 +37688,9 @@ type TorrowItemForCreateOrUpdate<T extends TorrowItem> = Omit<T, TorrowItemKeysE
  * Сгенерировано: `node scripts/build-sdk-shared-public-types.mjs`
  */
 
-type AccountingTransaction = AccountingTransactionDto;
+type AccountingTransaction = NormalizedPublicity<AccountingTransactionDto>;
 type AccountingTransactionState = AccountingTransactionStateDto;
-type AddProfileResp = AddProfileRespDto;
+type AddProfileResp = NormalizedPublicity<AddProfileRespDto>;
 type BalanceValue = BalanceValueDto;
 type DeleteResponse = DeleteResponseDto;
 type DictionarySortCondition = DictionarySortConditionDto;
@@ -37693,17 +37707,17 @@ type ObjectInfo = ObjectInfoDto;
 type ObjectSortCondition = ObjectSortConditionDto;
 type ParticipantState = ParticipantStateDto;
 type ParticipantType = ParticipantTypeDto;
-type ParticipantView = ParticipantViewDto;
+type ParticipantView = NormalizedPublicity<ParticipantViewDto>;
 type Participation = ParticipationDto;
 type ParticipationResp = ParticipationRespDto;
 type PutUrlResp = PutUrlRespDto;
-type ResourceView = ResourceViewDto;
+type ResourceView = NormalizedPublicity<ResourceViewDto>;
 type SaveItemToMindMapReq = SaveItemToMindMapReqDto;
 type SendLinkOfItemReq = SendLinkOfItemReqDto;
 type SendLinkOfItemResp = SendLinkOfItemRespDto;
 type SetGroupItemReq = SetGroupItemReqDto;
 type ShareItemReq = ShareItemReqDto;
-type TimetableCase = TimetableCaseDto;
+type TimetableCase = NormalizedPublicity<TimetableCaseDto>;
 type TimetableDetailsVisibility = TimetableDetailsVisibilityDto;
 type TimetableFilter = TimetableFilterDto;
 type TorrowObjectType = TorrowObjectTypeDto;
@@ -37807,8 +37821,8 @@ type UpdateContactPropertiesResp = UpdateContactPropertiesRespDto;
 type UpdateMasterInfoReq = UpdateMasterInfoReqDto;
 type FeedbackOptions = FeedbackOptionsDto;
 type PersonalReminder = PersonalReminderDto;
-type PublicityType = PublicityTypeDto;
-type GroupStatus = GroupStatusDto;
+
+type GroupStatus = NormalizedPublicity<GroupStatusDto>;
 type UpdateItemAccountsReq = UpdateItemAccountsReqDto;
 type UpdateItemGroupsReq = UpdateItemGroupsReqDto;
 type UpdatePersonalListOrderReq = UpdatePersonalListOrderReqDto;
@@ -37963,7 +37977,7 @@ declare const ImagePreviewSizeValues: {
     readonly MediumSlider: "MediumSlider";
     readonly LargeSlider: "LargeSlider";
 };
-/** Explicit publicity on create; meta.version on update preserves optimistic concurrency. */
+/** Публичность create/update: Personal, PublicWithRequest, PublicAvailable или Link; без значения при create — Personal. Поле meta.version сохраняет optimistic concurrency при update. Серверные Private/Undefined читаются как Personal. */
 type NoteItemForCreateOrUpdate = TorrowItemForCreateOrUpdate<NoteItem> & Pick<NoteItem, "publicityType" | "meta">;
 /** Частичное изменение заметки; общие name/image описаны в TorrowItemPatchFields. */
 interface NoteItemPatch extends TorrowItemPatchFields {
@@ -38073,7 +38087,7 @@ declare abstract class TorrowItemCoreFacade<TItem, TParticipantsQuery = ContactC
     generateFileId(ownerTorrowId: string): string;
     /** Id item этого домена до `create` / upload (клиентская генерация, без запроса к API). */
     protected generateItemId(ownerTorrowId: string): string;
-    /** `PUT /api/v1/{domain}/{torrowId}/publicity` */
+    /** `PUT /api/v1/{domain}/{torrowId}/publicity`: только Personal, PublicWithRequest, PublicAvailable или Link. */
     updatePublicity(torrowId: string, body: PublicityType, options?: TorrowOptions): Promise<TorrowObject>;
     /** `PUT /api/v1/{domain}/{torrowId}/image/id` — тело: JSON-string **`fileId`**. */
     updateImageId(torrowId: string, fileId: string, options?: TorrowOptions): Promise<UpdateFileIdResp>;
@@ -38513,17 +38527,17 @@ interface ServiceBehaviorSettingsUpdateOptions {
     signal?: AbortSignal;
 }
 
-type ServiceItemApi = ServiceItemApiDto;
+type ServiceItemApi = NormalizedPublicity<ServiceItemApiDto>;
 type ResourceGroup = NonNullable<ServiceItemApi["resourceGroupList"]>[number];
 type BookingProperties = NonNullable<ResourceGroup["bookingProperties"]>;
 type CreateOrderReq = CreateOrderReqDto;
-type OrderResp = OrderRespDto;
+type OrderResp = NormalizedPublicity<OrderRespDto>;
 type SearchServiceResourcesReq = SearchServiceResourcesReqDto;
-type SearchServiceResourcesResp = SearchServiceResourcesRespDto;
+type SearchServiceResourcesResp = NormalizedPublicity<SearchServiceResourcesRespDto>;
 type StepDescription = StepDescriptionDto;
 type SessionDurationProperties = SessionDurationPropertiesDto;
 type GetServiceWorkloadInfoRequest = GetServiceWorkloadInfoRequestDto;
-type GetServiceWorkloadInfoResp = GetServiceWorkloadInfoRespDto;
+type GetServiceWorkloadInfoResp = NormalizedPublicity<GetServiceWorkloadInfoRespDto>;
 type GetTimetableStatisticsRequest = GetTimetableStatisticsRequestDto;
 type TimetableStatisticsResp = TimetableStatisticsRespDto;
 type GetCheckInScheduleReq = GetCheckInScheduleReqDto;
@@ -38835,7 +38849,7 @@ type CaseItemPatch = TorrowItemPatchFields & ItemPricePatchFields & {
     /** Правила начислений лояльности целиком; []/null очищают список. */
     loyaltyTransactionPropertiesList?: CaseItem["loyaltyTransactionPropertiesList"];
 };
-type CreateCaseReq = CreateCaseReqDto;
+type CreateCaseReq = NormalizedPublicity<CreateCaseReqDto>;
 type AvailabilityTime = AvailabilityTimeDto;
 type CaseParticipantType = CaseParticipantTypeDto;
 /**
@@ -38846,7 +38860,7 @@ type CaseParticipantType = CaseParticipantTypeDto;
  * Проверка против живого API — отдельно (integration / ручные тесты).
  */
 type CaseParticipant = CaseParticipantDto;
-type CaseParticipantView = CaseParticipantViewDto;
+type CaseParticipantView = NormalizedPublicity<CaseParticipantViewDto>;
 type CaseParticipantFields = CaseParticipantFieldsDto;
 type GetCaseParticipationCountResp = GetCaseParticipationCountRespDto;
 type CheckInReq = CheckInReqDto;
@@ -39479,16 +39493,16 @@ type ResourcePaymentPatchProperties = PaymentPatchConfiguration<PaymentProviderT
 /** Предметные параметры всех ветвей payment patch; paymentProviderType выбирает класс, text/beforePayMessage/afterPayMessage — общие сообщения, остальные атрибуты относятся к выбранному провайдеру в ResourcePaymentPatchProperties. */
 type ResourcePaymentPatchParameters = NonNullable<ResourcePaymentPatchProperties["parameters"]>;
 
-type ResourceItemApi = ResourceItemApiDto;
+type ResourceItemApi = NormalizedPublicity<ResourceItemApiDto>;
 type ServiceDescription = NonNullable<ResourceItemApi["serviceDescriptions"]>[number];
 type UsageCondition = NonNullable<ResourceItemApi["usageCondition"]>;
 /** Дополнительные и исключающие условия; отсутствие условия и неизвестный sentinel сюда не входят. */
 type ResourceUsageConditionType = Exclude<UsageConditionType, `${UsageConditionTypeWireValues.Unknown | UsageConditionTypeWireValues.None}`>;
 type WorkloadPeriod = WorkloadPeriodDto;
 type PickOrderReq = PickOrderReqDto;
-type PickOrderResp = PickOrderRespDto;
+type PickOrderResp = NormalizedPublicity<PickOrderRespDto>;
 type ReturnOrderReq = ReturnOrderReqDto;
-type ReturnOrderResp = ReturnOrderRespDto;
+type ReturnOrderResp = NormalizedPublicity<ReturnOrderRespDto>;
 type ResourceItem = TorrowItemFromDto<ResourceItemApi> & {
     behaviorSettings?: ResourceBehaviorSettings;
 };
@@ -39977,9 +39991,9 @@ declare class AuthFacade {
 }
 
 /** @see components.schemas.ProfileListResp */
-type ProfileListResp = ProfileListRespDto;
+type ProfileListResp = NormalizedPublicity<ProfileListRespDto>;
 /** @see components.schemas.RemoveProfileResp */
-type RemoveProfileResp = RemoveProfileRespDto;
+type RemoveProfileResp = NormalizedPublicity<RemoveProfileRespDto>;
 /** @see components.schemas.UpdateProfilePropertiesResp */
 type UpdateProfilePropertiesResp = UpdateProfilePropertiesRespDto;
 /** @see components.schemas.ProfileProperties */
@@ -40094,15 +40108,15 @@ declare function isTorrowItemType(value: string): value is TorrowItemType;
 
 /** Представление узла в mind map / персональном списке под родителем — тип зависит от `TorrowItemType`. */
 type TorrowItemViewByTypeMap = {
-    Contact: OpenApiSchemas["ContactView"];
-    Note: OpenApiSchemas["NoteView"];
-    Context: OpenApiSchemas["ContextView"];
-    Resource: OpenApiSchemas["ResourceView"];
-    Service: OpenApiSchemas["ServiceView"];
-    Case: OpenApiSchemas["CaseView"];
-    Calendar: OpenApiSchemas["CalendarView"];
-    LoyaltyCard: OpenApiSchemas["LoyaltyCardView"];
-    LoyaltySystem: OpenApiSchemas["LoyaltySystemView"];
+    Contact: NormalizedPublicity<OpenApiSchemas["ContactView"]>;
+    Note: NormalizedPublicity<OpenApiSchemas["NoteView"]>;
+    Context: NormalizedPublicity<OpenApiSchemas["ContextView"]>;
+    Resource: NormalizedPublicity<OpenApiSchemas["ResourceView"]>;
+    Service: NormalizedPublicity<OpenApiSchemas["ServiceView"]>;
+    Case: NormalizedPublicity<OpenApiSchemas["CaseView"]>;
+    Calendar: NormalizedPublicity<OpenApiSchemas["CalendarView"]>;
+    LoyaltyCard: NormalizedPublicity<OpenApiSchemas["LoyaltyCardView"]>;
+    LoyaltySystem: NormalizedPublicity<OpenApiSchemas["LoyaltySystemView"]>;
 };
 type TorrowItemView = TorrowItemViewByTypeMap[TorrowItemType];
 type ViewListQuery = {
@@ -40129,16 +40143,16 @@ type ViewOrderInput = {
     order: number;
 };
 type ViewInfo = ViewInfoDto;
-type ContactView = ContactViewDto;
-type NoteView = NoteViewDto;
-type ContextView = ContextViewDto;
+type ContactView = NormalizedPublicity<ContactViewDto>;
+type NoteView = NormalizedPublicity<NoteViewDto>;
+type ContextView = NormalizedPublicity<ContextViewDto>;
 /** Представление ресурса в mind map (та же схема `ResourceView`, что в поиске ресурсов услуги). */
-type ResourceMindMapView = ResourceMindMapViewDto;
-type ServiceView = ServiceViewDto;
-type CaseView = CaseViewDto;
-type CalendarView = CalendarViewDto;
-type LoyaltyCardView = LoyaltyCardViewDto;
-type LoyaltySystemView = LoyaltySystemViewDto;
+type ResourceMindMapView = NormalizedPublicity<ResourceMindMapViewDto>;
+type ServiceView = NormalizedPublicity<ServiceViewDto>;
+type CaseView = NormalizedPublicity<CaseViewDto>;
+type CalendarView = NormalizedPublicity<CalendarViewDto>;
+type LoyaltyCardView = NormalizedPublicity<LoyaltyCardViewDto>;
+type LoyaltySystemView = NormalizedPublicity<LoyaltySystemViewDto>;
 
 /** Закреплённые представления (`views/pinned`). */
 declare class PinnedViewsFacade {
@@ -40323,7 +40337,7 @@ declare class SearchFacade {
     /** `GET /api/v1/search/adviseditems` — `NearLocation` (гео) / `Recommendation`. */
     advisedItems(query?: AdvisedItemsSearchQuery, options?: {
         signal?: AbortSignal;
-    }): Promise<TorrowItemDto[]>;
+    }): Promise<TorrowItem[]>;
     /**
      * `PUT /api/v1/search/{torrowId}/orders` — заказы (события-заказы) под элементом с фильтром.
      * Тело **`OrderFilter`**; см. также **`examples/node/raw/search-orders-raw.ts`** (сырой `raw.put`).
@@ -40395,7 +40409,7 @@ declare class SearchFacade {
     }): Promise<ServiceView[]>;
 }
 
-type ActionHistoryInfo = ActionHistoryInfoDto;
+type ActionHistoryInfo = NormalizedPublicity<ActionHistoryInfoDto>;
 type ActionHistoryType = ActionHistoryTypeDto;
 type ActionHistoryState = ActionHistoryStateDto;
 /**
@@ -40493,7 +40507,7 @@ declare class AccountingTransactionsFacade {
     }): Promise<AccountingTransaction[]>;
 }
 
-type AnnouncementInfo = AnnouncementInfoDto;
+type AnnouncementInfo = NormalizedPublicity<AnnouncementInfoDto>;
 type AnnouncementState = AnnouncementStateDto;
 type UpdateAnnouncementStateReq = UpdateAnnouncementStateReqDto;
 /**
@@ -40534,8 +40548,8 @@ declare class AnnouncementsFacade {
 }
 
 type ExportRequest = ExportRequestDto;
-type ExportGraph = ExportGraphDto;
-type ImportByFileRequest = ImportByFileRequestDto;
+type ExportGraph = NormalizedPublicity<ExportGraphDto>;
+type ImportByFileRequest = NormalizedPublicity<ImportByFileRequestDto>;
 type ImportByUniqueNameRequest = ImportByUniqueNameRequestDto;
 
 /**
@@ -41019,7 +41033,7 @@ type DeviceSettingsInfo = {
 };
 type UserDeliveryWay = UserDeliveryWayDto;
 type DeliveryChannel = DeliveryChannelDto;
-type RegistrationUserInfo = RegistrationUserInfoDto;
+type RegistrationUserInfo = NormalizedPublicity<RegistrationUserInfoDto>;
 type RegisterUserForAccountResp = RegisterUserForAccountRespDto;
 type UserCalendar = UserCalendarDto;
 type InitDeletingUserResp = InitDeletingUserRespDto;
@@ -41052,7 +41066,7 @@ declare class UserFacade {
     /** `GET /api/v1/user/loyaltycard` */
     getLoyaltyCard(options?: {
         signal?: AbortSignal;
-    }): Promise<LoyaltyCardItemDto>;
+    }): Promise<LoyaltyCardItem>;
     /** `GET /api/v1/user/accounts` */
     listAccounts(query?: UserAccountsQuery, options?: {
         signal?: AbortSignal;
@@ -41277,9 +41291,9 @@ declare class IntegrationsFacade {
     delete(integrationId: string, options?: TorrowOptions): Promise<number>;
 }
 
-type Feedback = FeedbackDto;
-type ItemFeedback = ItemFeedbackDto;
-type UserFeedback = UserFeedbackDto;
+type Feedback = NormalizedPublicity<FeedbackDto>;
+type ItemFeedback = NormalizedPublicity<ItemFeedbackDto>;
+type UserFeedback = NormalizedPublicity<UserFeedbackDto>;
 
 /**
  * Кросс-доменные операции **Item** (отзывы, шаринг-сессия, uniquename).
@@ -41638,6 +41652,7 @@ interface TorrowSdkSensitiveDetails {
 /** Безопасный снимок ошибки. Отсутствие effects не доказывает отсутствие изменений. */
 interface TorrowSdkErrorInfo {
     /** Общая причина отказа. */ readonly category: TorrowSdkErrorCategory;
+    /** Необязательное пояснение для человека, не для ветвления. Передающий текст отвечает за его безопасность. */ readonly publicMessage?: string;
     /** Метаданные HTTP, если они известны. */ readonly http?: TorrowSdkHttpDetails;
     /** Предметное уточнение выбранного домена. */ readonly detail?: TorrowSdkErrorDetail;
     /** Начало fetch соответствующего запроса. */ readonly request?: TorrowSdkRequestState;
@@ -41653,6 +41668,7 @@ interface TorrowSdkErrorInit extends TorrowSdkErrorInfo {
 declare class TorrowSdkError extends Error implements TorrowSdkErrorInfo {
     #private;
     /** Общая причина отказа. */ readonly category: TorrowSdkErrorCategory;
+    /** Пояснение без изменения исходной строки: до 512 UTF-16 единиц, не пустое после trim; иначе undefined. */ readonly publicMessage?: string;
     /** Безопасные метаданные ответа. */ readonly http?: TorrowSdkHttpDetails;
     /** Неизменяемое предметное уточнение. */ readonly detail?: TorrowSdkErrorDetail;
     /** Начало fetch; не доставка. */ readonly request?: TorrowSdkRequestState;