@weavix/sdk-core 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -1,518 +1,24 @@
-import { ApiV3DeleteMethods } from '@weavix/tracker-api-types';
-import { ApiV3GetMethods } from '@weavix/tracker-api-types';
-import { ApiV3PatchMethods } from '@weavix/tracker-api-types';
-import { ApiV3PostMethods } from '@weavix/tracker-api-types';
-import { ApiV3PutMethods } from '@weavix/tracker-api-types';
-import { Attachment } from '@weavix/tracker-api-types';
-import { Issue } from '@weavix/tracker-api-types';
-import { LocalizedString } from '@weavix/tracker-api-types';
-import { MetaEntityV2 } from '@weavix/tracker-api-types';
-import { WebhookTriggerActionInput } from '@weavix/tracker-api-types';
-
-export declare type ApiCallPayload = {
-    version: string;
-    method: string;
-    url: string;
-    pathParams: Record<string, string>;
-    queryParams: Record<string, unknown>;
-    bodyParams: Record<string, unknown>;
-    file?: File;
-};
-
-export declare type ApiCallResult = {
-    data: unknown;
-    headers: Record<string, string>;
-};
-
-declare type ApiResult<M> = {
-    [K in keyof M]: M[K] extends (...args: infer A) => Promise<infer R> ? (...args: A) => Promise<{
-        data: R;
-        headers: Record<string, string>;
-    }> : never;
-};
-
-declare type AttachmentViewerActionClosePayload = {
-    attachments: Attachment[];
-};
-
-declare type AttachmentViewerActionSlotContext = {
-    attachmentBlob: Blob;
-    meta: {
-        id: string;
-        url: string;
-        date: string;
-        size: number;
-        mimetype: string;
-    };
-};
-
-export declare type ConfirmOptions = {
-    title?: string;
-    message: string;
-    textButtonApply?: string;
-    textButtonCancel?: string;
-    theme?: 'normal' | 'danger';
-};
-
-export declare type ConfirmResult = { confirmed: boolean };
-
-export declare type ContentSizeUpdateRequest = {
-    height?: number;
-    width?: number;
-    unit?: ContentSizeUpdateRequestUnit;
-};
-
-declare type ContentSizeUpdateRequestUnit = 'pixel' | 'percent';
-
-/**
- * Dispatch an incoming event message to all registered subscribers.
- * Caches the value so late subscribers receive it on subscription.
- */
-export declare function dispatchHostEvent(message: EventMessage): void {
-    const method = message.method as HostEventMethod;
-    lastValues.set(method, message.result);
-
-    const set = subscribers.get(method);
-    if (!set) {
-        return;
-    }
-    for (const cb of set) {
-        try {
-            cb(message.result);
-        } catch (err) {
-            console.error(`[EventBus] Error in subscriber for "${message.method}":`, err);
-        }
-    }
-}
-
-/**
- * Shape of an incoming event message from the host (postMessage).
- * Distinct from 'response' and 'request' message types.
- */
-export declare type EventMessage = {
-    messageId: string;
-    type: 'event';
-    method: HostEventMethod;
-    result: unknown;
-};
-
-/**
- * Маппинг trigger-слотов на тип возвращаемого значения getData.
- */
-export declare type GetDataResultMap = {
-    'trigger.create.action': TriggerActionData;
-    'trigger.edit.action': TriggerActionData;
-};
-
-/**
- * Извлекает значение из объекта по точечному пути (dot notation).
- * Предназначена для работы с полями типа Record<string, unknown>, например со значениями полей задачи (Issue).
- *
- * Поддерживает вложенные пути: `'priority.display'`, `'assignee.display.ru'` и т.д.
- * Если любой сегмент пути отсутствует или не является объектом — возвращается defaultValue или undefined.
- * @param obj - Объект с произвольной структурой (например, issue или issue.values)
- * @param path - Путь к полю через точку, например `'priority.display'` или `'summary'`
- * @param defaultValue - Значение по умолчанию, если путь не найден
- * @returns Значение по пути, defaultValue или undefined
- * @example
- * ```ts
- * // Поле верхнего уровня
- * getField(issue, 'key'); // 'QUEUE-123'
- *
- * // Вложенное поле (например, приоритет с display)
- * getField(issue, 'priority.display'); // 'много' | undefined
- *
- * // С типизацией и значением по умолчанию
- * const name = getField<string>(issue, 'summary', 'Без названия');
- *
- * // Элемент массива по индексу (массивы — объекты с числовыми ключами)
- * getField(tags, '0'); // первый элемент
- * ```
- */
-export declare function getField<T = unknown>(
-obj: Record<string, unknown>,
-path: string,
-defaultValue?: T,
-): T | undefined {
-    if (path === '') {
-        return defaultValue;
-    }
-
-    const keys = path.split('.');
-    let result: unknown = obj;
-
-    for (const key of keys) {
-        if (
-        result !== null &&
-        typeof result === 'object' &&
-        Object.prototype.hasOwnProperty.call(result, key)
-        ) {
-            result = (result as Record<string, unknown>)[key];
-        } else {
-            return defaultValue;
-        }
-    }
-
-    return (result as T | undefined) ?? defaultValue;
-}
-
-/**
- * Возвращает обработчик getData. При указании TSlot — () => GetDataResultMap[TSlot].
- */
-export declare function getHandler<TSlot extends keyof GetDataResultMap>(name: 'getData'): (() => GetDataResultMap[TSlot]) | undefined;
-
-export declare function getHandler<TKey extends keyof Handlers>(name: TKey): HandlerFunction<TKey> | undefined;
-
-/**
- * Получить локализованную строку на основе языка.
- * Принимает api-types `LocalizedString` (Yandex flavor).
- */
-export declare function getLocalizedString(value: LocalizedString, language: string | undefined, fallbackLanguage?: string): string;
-
-declare type GoalActionsSlotContext = {
-    data: MetaEntityV2 & {
-        progress: {
-            closed: number;
-            total: number;
-        };
-    };
-};
-
-export declare type HandlerFunction<TKey extends keyof Handlers> = Handlers[TKey];
-
-/**
- * Обработчики, которые плагин регистрирует для ответов на запросы хоста.
- * - getData — общий метод получения данных; тип зависит от слота (GetDataResultMap).
- */
-export declare type Handlers = {
-    getData: () => GetDataResultMap[keyof GetDataResultMap];
-};
-
-/**
- * Типизированный интерфейс HostApi для публичного API публикуемого core'а.
- */
-declare interface HostApi<TSlot extends keyof SlotContextMap = keyof SlotContextMap> {
-    /**
-     * Текущая тема хоста
-     */
-    getTheme(): Promise<Theme>;
-    /**
-     * Текущий язык хоста
-     */
-    getLanguage(): Promise<string>;
-    /**
-     * Id пользователя
-     */
-    getUserId(): Promise<string>;
-    /**
-     * Сборка для ятима
-     */
-    getIsYateam(): Promise<boolean>;
-    /**
-     * Получить текущий контекст, в котором запущен плагин.
-     * Тип возвращаемого значения зависит от слота.
-     */
-    getContext(): Promise<SlotContextMap[TSlot]>;
-    /**
-     * Изменить размер окна, в котором запущен плагин
-     */
-    updateContentSize(payload: ContentSizeUpdateRequest): Promise<void>;
-    /**
-     * Сообщить, что плагин готов к работе
-     */
-    notifyReady(): Promise<void>;
-    /**
-     * Сообщить, что плагин закрыт
-     */
-    close(payload: PluginClosePayloadMap[TSlot]): Promise<void>;
-    /**
-     * Выполнить навигацию в хосте
-     */
-    navigate(payload: NavigateRequest): Promise<void>;
-    /**
-     * Инициализация плагина
-     */
-    init(options: HostInitOptions): void;
-    /**
-     * Текущий слот, в котором открыт плагин.
-     * Вызов до init() приведёт к ошибке.
-     */
-    getSlot(): TSlot;
-    /**
-     * Сервис, в котором открылся плагин.
-     * Вызов до init() приведёт к ошибке.
-     */
-    getService(): string;
-    /**
-     * Origin родительского окна (хоста).
-     * Вызов до init() приведёт к ошибке.
-     */
-    getOrigin(): string;
-    /**
-     * Внутренний урл плагина.
-     * Вызов до init() приведёт к ошибке.
-     */
-    getInnerUrl(): string;
-    /**
-     * Query-параметры плагина.
-     * Вызов до init() приведёт к ошибке.
-     */
-    getQueryParams(): Record<string, string>;
-    /**
-     * Выключить автоматическое изменение размера контейнера
-     */
-    disableAutoResize(): void;
-}
-
-export declare const hostApi: HostApi;
-
-/** Callback type for a specific host event */
-export declare type HostEventCallback<M extends HostEventMethod> = (
-result: HostEventContract[M]['result'],
-) => void;
-
-/**
- * Contract describing host-pushed events.
- * Each key is a `method` string from the incoming postMessage,
- * and the value describes the `result` payload type.
- */
-export declare type HostEventContract = {
-    'theme.changed': { result: Theme };
-    'language.changed': { result: string };
-    'userId.changed': { result: string };
-    'isYateam.changed': { result: boolean };
-    'context.changed': { result: Record<string, unknown> };
-    'toast.action.clicked': { result: { name: string; actionId: string } };
-};
-
-/** Union of all supported host event method names */
-export declare type HostEventMethod = keyof HostEventContract;
-
-declare interface HostInitOptions {
-    /**
-     * Автоматически изменять размер контейнера плагина
-     * при изменении содержимого
-     * @default true
-     */
-    autoResize?: boolean;
-}
-
-export declare type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'LINK' | 'UNLINK';
-
-declare type IssueCommentActionSlotContext = {
-    id: string;
-    createdAt: string;
-    updatedAt: string | null;
-    text: string;
-    type: string;
-    transport: string;
-    attachments: Attachment[];
-    issueVersion: number;
-};
-
-export { LocalizedString }
-
-/** Код ошибки: запрошенный метод API не поддерживается в данной конфигурации или версии. */
-export declare const METHOD_NOT_SUPPORTED = 1003;
-
-/** Код ошибки: у плагина нет необходимого scope (разрешения) для выполнения операции. */
-export declare const MISSING_REQUIRED_SCOPE = 1004;
-
-declare type NavigateRequest = {
-    path: string;
-    params?: QueryParams;
-    options?: {
-        newTab?: boolean;
-    };
-};
-
-/**
- * Subscribe to a host-pushed event.
- * If a value was already dispatched for this method, the callback is called
- * synchronously with the cached value before returning.
- * @param method - Event method name (e.g. `'theme.changed'`)
- * @param callback - Function called with the typed event payload
- * @returns An `Unsubscribe` function that removes this subscription
- */
-export declare function on<M extends HostEventMethod>(
-method: M,
-callback: HostEventCallback<M>,
-): Unsubscribe {
-    let set = subscribers.get(method);
-    if (!set) {
-        set = new Set();
-        subscribers.set(method, set);
-    }
-
-    const cb = callback as (result: unknown) => void;
-    set.add(cb);
-
-    // Replay last known value to the new subscriber immediately
-    if (lastValues.has(method)) {
-        try {
-            cb(lastValues.get(method));
-        } catch (err) {
-            console.error(`[EventBus] Error replaying cached value for "${method}":`, err);
-        }
-    }
-
-    return () => {
-        set.delete(cb);
-        if (set.size === 0) {
-            subscribers.delete(method);
-        }
-    };
-}
-
-/** Код ошибки: переданный pluginId не совпадает с зарегистрированным плагином или неверного формата. */
-export declare const PLUGIN_ID_IS_NOT_CORRECT = 1001;
-
-/** Код ошибки: не переданы обязательные параметры инициализации плагина (pluginId или slot). */
-export declare const PLUGIN_ID_OR_SLOT_NOT_PROVIDED = 1000;
-
-export declare class PluginActionError extends Error {
-    readonly code: number;
-
-    readonly errorData?: unknown;
-
-    constructor(code: number, message: string, errorData?: unknown) {
-        super(message);
-        this.name = 'PluginActionError';
-        this.code = code;
-        this.errorData = errorData;
-    }
-}
-
-declare type PluginClosePayloadMap = WithUndefinedDefaults<PluginClosePayloadOverrides, keyof SlotContextMap>;
-
-declare type PluginClosePayloadOverrides = {
-    'attachment.viewer.action': AttachmentViewerActionClosePayload;
-};
-
-declare type PortfolioActionsSlotContext = {
-    data: MetaEntityV2 & {
-        progress: {
-            closed: number;
-            total: number;
-        };
-    };
-};
-
-declare type ProjectActionsSlotContext = {
-    data: MetaEntityV2 & {
-        progress: {
-            closed: number;
-            total: number;
-        };
-        boardId: number;
-    };
-};
-
-declare type QueryParams = Record<string, QueryParamValue | QueryParamValue[]>;
-
-declare type QueryParamValue = string | number | boolean | null | undefined;
-
-/**
- * Clears all cached last values and subscribers from the event bus.
- * Intended for use in tests to prevent state leaking between test cases.
- */
-export declare function resetEventBus(): void {
-    lastValues.clear();
-    subscribers.clear();
-}
-
-/**
- * Регистрирует обработчик. Тип возвращаемого значения задаётся слотом (GetDataResultMap).
- */
-export declare function setHandler<TSlot extends keyof GetDataResultMap>(name: 'getData', handler: () => GetDataResultMap[TSlot]): void;
-
-export declare function setHandler<TKey extends keyof Handlers>(name: TKey, handler: HandlerFunction<TKey>): void;
-
-export declare type SlotContextMap = {
-    'issue.action': Issue;
-    'issue.block': Issue;
-    'issue.tab': Issue;
-    navigation: Record<string, never>;
-    'issue.floatingbottom.action': Record<string, never>;
-    'trigger.create.action': TriggerCreateActionsSlotContext;
-    'trigger.edit.action': TriggerEditActionsSlotContext;
-    'portfolio.action': PortfolioActionsSlotContext;
-    'project.action': ProjectActionsSlotContext;
-    'goal.action': GoalActionsSlotContext;
-    'attachment.viewer.action': AttachmentViewerActionSlotContext;
-    'issue.comment.action': IssueCommentActionSlotContext;
-};
-
-export declare type Theme = 'light' | 'light-hc' | 'dark' | 'dark-hc' | 'system';
-
-export declare type ToastAction = {
-    label: string;
-    onClick: () => void;
-};
-
-export declare type ToastOptions = {
-    name?: string;
-    title: string;
-    content?: string;
-    theme?: 'success' | 'danger' | 'warning' | 'info';
-    autoHiding?: number;
-    isClosable?: boolean;
-    actions?: ToastAction[];
-};
-
-export declare interface TrackerApi {
-    v3: TrackerApiV3;
-}
-
-export declare const trackerApi: TrackerApi;
-
-export declare type TrackerApiCallOptions = TrackerApiCallOptions_2;
-
-declare interface TrackerApiCallOptions_2 {
-    pathParams?: Record<string, string>;
-    queryParams?: Record<string, unknown>;
-    bodyParams?: Record<string, unknown>;
-    file?: File;
-}
-
-export declare type TrackerApiInitOptions = TrackerApiInitOptions_2;
-
-declare interface TrackerApiInitOptions_2 {
-    apiVersion?: string;
-}
-
-export declare interface TrackerApiV3 {
-    get: ApiResult<ApiV3GetMethods>;
-    post: ApiResult<ApiV3PostMethods>;
-    put: ApiResult<ApiV3PutMethods>;
-    patch: ApiResult<ApiV3PatchMethods>;
-    delete: ApiResult<ApiV3DeleteMethods>;
-}
-
-export declare type TriggerActionData = Omit<WebhookTriggerActionInput, 'id' | 'type' | 'typeKey'>;
-
-declare type TriggerCreateActionsSlotContext = {
-    queue: string;
-};
-
-declare type TriggerEditActionsSlotContext = {
-    queue: string;
-    data: TriggerActionData;
-};
-
-export declare const uiApi = new UiApi();
-
-/** Код ошибки: непредвиденная или неклассифицированная ошибка. */
-export declare const UNKNOWN_ERROR = 6666;
-
-/** Function returned by `on()` to remove the subscription */
-export declare type Unsubscribe = () => void;
-
-/** Код ошибки: данные запроса не прошли валидацию (неверный формат, обязательные поля отсутствуют и т.п.). */
-export declare const VALIDATION_ERROR = 1002;
-
-declare type WithUndefinedDefaults<TMap, TKeys extends PropertyKey> = {
-    [K in TKeys]: K extends keyof TMap ? TMap[K] : undefined;
-};
-
-export { }
+export { initBridge, sendRequest } from './bridge/bridge';
+export type { BaseMessage } from './bridge/types/BaseMessage';
+export { BAD_KEY, DATA_TOO_LARGE, METHOD_NOT_SUPPORTED, MISSING_REQUIRED_SCOPE, PLUGIN_ID_IS_NOT_CORRECT, PLUGIN_ID_OR_SLOT_NOT_PROVIDED, UNKNOWN_ERROR, VALIDATION_ERROR, VERSION_CONFLICT, } from './bridge/types/ErrorCodes';
+export { PluginActionError } from './bridge/types/PluginActionError';
+export type { PluginConfirmPayload, PluginToastAction, PluginToastPayload, UiContract, } from './bridge/types/UiContract';
+export { getHandler, setHandler } from './handlers/handlers';
+export { dispatchHostEvent, eventBus, on, resetEventBus } from './events/eventBus';
+export type { EventMessage, HostEventCallback, HostEventContract, HostEventMethod, Unsubscribe, } from './events/types';
+export { Confirm } from './ui/Confirm';
+export type { ConfirmOptions, ConfirmResult } from './ui/Confirm';
+export { Toaster } from './ui/Toaster';
+export type { ToastAction, ToastOptions } from './ui/Toaster';
+export { uiApi } from './ui/uiApi';
+export { getField } from './utils/getField';
+export { getLocalizedString } from './utils/localization';
+export type { LocalizedString } from './utils/localization';
+export { AutoResizeManager } from './host/utils/autoResize';
+export type { ResizeCallback } from './host/utils/autoResize';
+export type { ContentSizeUpdateRequest, ContentSizeUpdateRequestUnit, } from './host/types/ContentSizeUpdateRequest';
+export type { NavigateRequest } from './host/types/NavigateRequest';
+export type { Theme } from './common/types/Theme';
+export { HostApi, hostApi } from './host/hostApi';
+export type { BasicContext, ContextLevel, HostInitOptions } from './host/hostApi';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG1D,YAAY,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EACH,OAAO,EACP,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,8BAA8B,EAC9B,aAAa,EACb,gBAAgB,EAChB,gBAAgB,GACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,YAAY,EACR,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,UAAU,GACb,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAG7D,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnF,YAAY,EACR,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAG5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EACR,wBAAwB,EACxB,4BAA4B,GAC/B,MAAM,uCAAuC,CAAC;AAC/C,YAAY,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAGpE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAGlD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAClD,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}