@sayrio/public 0.0.5

package/dist/index.d.cts

@@ -0,0 +1,258 @@
+interface ApiSuccess<T> {
+    success: true;
+    data: T;
+}
+interface ApiError {
+    success: false;
+    error: string;
+    message?: string;
+    status?: number;
+}
+interface Pagination {
+    limit: number;
+    page: number;
+    totalPages: number;
+    totalItems: number;
+    hasMore: boolean;
+}
+interface Organization {
+    id: string;
+    name: string;
+    slug: string;
+    logo: string | null;
+    bannerImg: string | null;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+    wsUrl: string;
+}
+interface Label {
+    id: string;
+    organizationId: string;
+    name: string;
+    color: string | null;
+    createdAt: string;
+}
+interface Category {
+    id: string;
+    organizationId: string;
+    name: string;
+    color: string | null;
+    icon: string | null;
+    createdAt: string;
+}
+type TaskStatus = "backlog" | "todo" | "in-progress" | "done" | "canceled";
+type TaskPriority = "none" | "low" | "medium" | "high" | "urgent";
+interface Task {
+    id: string;
+    organizationId: string;
+    shortId: number | null;
+    visible: "public" | "private";
+    createdAt: string;
+    updatedAt: string;
+    title: string | null;
+    description: unknown | null;
+    status: TaskStatus;
+    priority: TaskPriority;
+    createdBy: string | null;
+    category: string | null;
+    voteCount: number;
+    descriptionHtml: string;
+    descriptionMarkdown: string;
+}
+interface CommentUser {
+    name: string | null;
+    image: string | null;
+}
+interface CommentReaction {
+    count: number;
+    users: string[];
+}
+interface Comment {
+    id: string;
+    organizationId: string;
+    taskId: string | null;
+    createdAt: string;
+    updatedAt: string;
+    content: unknown | null;
+    visibility: "public" | "internal";
+    contentHtml: string;
+    contentMarkdown: string;
+    createdBy: CommentUser | null;
+    reactions?: {
+        total: number;
+        reactions: Record<string, CommentReaction>;
+    };
+}
+
+type RequestOptions = {
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: Record<string, string>;
+    body?: Record<string, string>;
+    signal?: AbortSignal;
+};
+type Hooks = {
+    onRequest?: (url: string, opts: RequestOptions) => void;
+    onResponse?: (res: Response) => void;
+    onError?: (error: ApiError | unknown) => void;
+};
+declare function setToken(token?: string): void;
+declare function setHeaders(headers?: Record<string, string>): void;
+declare function setFetch(fn: typeof fetch): void;
+declare function setBaseUrl(url: string): void;
+declare function setHooks(h: Hooks): void;
+declare function resetClient(): void;
+
+interface Me {
+    id: string;
+    name: string | null;
+    email: string | null;
+    image: string | null;
+    createdAt: string;
+}
+
+type Order = "asc" | "desc";
+interface PaginationParams {
+    page?: number;
+    limit?: number;
+}
+interface OrderedPaginationParams extends PaginationParams {
+    order?: Order;
+}
+declare function buildPaginationParams(params?: OrderedPaginationParams): URLSearchParams;
+
+declare const v1: {
+    org: {
+        tasks: {
+            list(slug: string, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Task[];
+                pagination: Pagination;
+            }>;
+            get(slug: string, shortId: number, opts?: RequestOptions): Promise<Task>;
+        };
+        comments: {
+            list(slug: string, shortId: number, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Comment[];
+                pagination: Pagination;
+            }>;
+        };
+        labels: {
+            list(slug: string, opts?: RequestOptions): Promise<Label[]>;
+        };
+        categories: {
+            list(slug: string, order?: Order, opts?: RequestOptions): Promise<Category[]>;
+        };
+        get(slug: string, opts?: RequestOptions): Promise<Organization>;
+    };
+    me: {
+        get(opts?: RequestOptions): Promise<Me>;
+        organizations(opts?: RequestOptions): Promise<Organization[]>;
+    };
+};
+
+type WSMessageType = "CONNECTION_STATUS" | "SUBSCRIBED" | "ERROR" | "PING" | "PONG" | "UPDATE_ORG" | "CREATE_TASK" | "UPDATE_TASK" | "UPDATE_TASK_COMMENTS" | "UPDATE_TASK_VOTE" | "UPDATE_LABELS" | "UPDATE_VIEWS" | "UPDATE_CATEGORIES" | "UPDATE_ISSUE_TEMPLATES" | "DISCONNECTED";
+/**
+ * String enum replacement for WS event names.
+ * Use this instead of raw strings.
+ */
+declare const WS_EVENTS: Record<WSMessageType, WSMessageType>;
+interface WSMessage<T = unknown> {
+    type: WSMessageType;
+    scope: "PUBLIC";
+    data: T;
+    meta?: {
+        ts: number;
+    };
+}
+
+type Handlers = Partial<Record<WSMessageType, (data: any, msg: WSMessage) => void>>;
+declare function ws(url: string, handlers?: Handlers): {
+    close(): void;
+};
+
+/**
+ * Sayr Public API — Version 1.
+ *
+ * @since v1.0.0
+ */
+declare const SayrV1: {
+    org: {
+        tasks: {
+            list(slug: string, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Task[];
+                pagination: Pagination;
+            }>;
+            get(slug: string, shortId: number, opts?: RequestOptions): Promise<Task>;
+        };
+        comments: {
+            list(slug: string, shortId: number, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Comment[];
+                pagination: Pagination;
+            }>;
+        };
+        labels: {
+            list(slug: string, opts?: RequestOptions): Promise<Label[]>;
+        };
+        categories: {
+            list(slug: string, order?: Order, opts?: RequestOptions): Promise<Category[]>;
+        };
+        get(slug: string, opts?: RequestOptions): Promise<Organization>;
+    };
+    me: {
+        get(opts?: RequestOptions): Promise<Me>;
+        organizations(opts?: RequestOptions): Promise<Organization[]>;
+    };
+};
+/**
+ * Create a WebSocket connection for public real‑time updates.
+ */
+declare const SayrWS: typeof ws;
+/**
+ * Typed WebSocket event constants.
+ */
+declare const SayrWSEvents: Record<WSMessageType, WSMessageType>;
+/**
+ * Global client configuration helpers.
+ */
+declare const SayrClient: {
+    setToken: typeof setToken;
+    setHeaders: typeof setHeaders;
+    setBaseUrl: typeof setBaseUrl;
+    resetClient: typeof resetClient;
+    setHooks: typeof setHooks;
+    setFetch: typeof setFetch;
+};
+/**
+ * Sayr Public SDK.
+ *
+ * Read‑only access to public Sayr data via REST and WebSockets.
+ *
+ * @since v1.0.0
+ */
+declare const Sayr: {
+    /**
+     * Client configuration helpers.
+     */
+    client: typeof SayrClient;
+    /**
+     * Versioned API namespaces.
+     */
+    v1: typeof v1;
+    /**
+     * Alias for the current API version (`v1`).
+     *
+     * @since v1.0.0
+     */
+    org: typeof v1.org;
+    me: typeof v1.me;
+    /**
+     * WebSocket helper for real‑time updates.
+     */
+    ws: typeof ws;
+    /**
+     * WebSocket event constants.
+     */
+    WS_EVENTS: typeof WS_EVENTS;
+};
+
+export { type ApiError, type ApiSuccess, type Category, type Comment, type CommentReaction, type CommentUser, type Label, type Order, type OrderedPaginationParams, type Organization, type Pagination, type PaginationParams, SayrClient, SayrV1, SayrWS, SayrWSEvents, type Task, type TaskPriority, type TaskStatus, type WSMessage, type WSMessageType, WS_EVENTS, buildPaginationParams, Sayr as default };

package/dist/index.d.ts

@@ -0,0 +1,258 @@
+interface ApiSuccess<T> {
+    success: true;
+    data: T;
+}
+interface ApiError {
+    success: false;
+    error: string;
+    message?: string;
+    status?: number;
+}
+interface Pagination {
+    limit: number;
+    page: number;
+    totalPages: number;
+    totalItems: number;
+    hasMore: boolean;
+}
+interface Organization {
+    id: string;
+    name: string;
+    slug: string;
+    logo: string | null;
+    bannerImg: string | null;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+    wsUrl: string;
+}
+interface Label {
+    id: string;
+    organizationId: string;
+    name: string;
+    color: string | null;
+    createdAt: string;
+}
+interface Category {
+    id: string;
+    organizationId: string;
+    name: string;
+    color: string | null;
+    icon: string | null;
+    createdAt: string;
+}
+type TaskStatus = "backlog" | "todo" | "in-progress" | "done" | "canceled";
+type TaskPriority = "none" | "low" | "medium" | "high" | "urgent";
+interface Task {
+    id: string;
+    organizationId: string;
+    shortId: number | null;
+    visible: "public" | "private";
+    createdAt: string;
+    updatedAt: string;
+    title: string | null;
+    description: unknown | null;
+    status: TaskStatus;
+    priority: TaskPriority;
+    createdBy: string | null;
+    category: string | null;
+    voteCount: number;
+    descriptionHtml: string;
+    descriptionMarkdown: string;
+}
+interface CommentUser {
+    name: string | null;
+    image: string | null;
+}
+interface CommentReaction {
+    count: number;
+    users: string[];
+}
+interface Comment {
+    id: string;
+    organizationId: string;
+    taskId: string | null;
+    createdAt: string;
+    updatedAt: string;
+    content: unknown | null;
+    visibility: "public" | "internal";
+    contentHtml: string;
+    contentMarkdown: string;
+    createdBy: CommentUser | null;
+    reactions?: {
+        total: number;
+        reactions: Record<string, CommentReaction>;
+    };
+}
+
+type RequestOptions = {
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: Record<string, string>;
+    body?: Record<string, string>;
+    signal?: AbortSignal;
+};
+type Hooks = {
+    onRequest?: (url: string, opts: RequestOptions) => void;
+    onResponse?: (res: Response) => void;
+    onError?: (error: ApiError | unknown) => void;
+};
+declare function setToken(token?: string): void;
+declare function setHeaders(headers?: Record<string, string>): void;
+declare function setFetch(fn: typeof fetch): void;
+declare function setBaseUrl(url: string): void;
+declare function setHooks(h: Hooks): void;
+declare function resetClient(): void;
+
+interface Me {
+    id: string;
+    name: string | null;
+    email: string | null;
+    image: string | null;
+    createdAt: string;
+}
+
+type Order = "asc" | "desc";
+interface PaginationParams {
+    page?: number;
+    limit?: number;
+}
+interface OrderedPaginationParams extends PaginationParams {
+    order?: Order;
+}
+declare function buildPaginationParams(params?: OrderedPaginationParams): URLSearchParams;
+
+declare const v1: {
+    org: {
+        tasks: {
+            list(slug: string, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Task[];
+                pagination: Pagination;
+            }>;
+            get(slug: string, shortId: number, opts?: RequestOptions): Promise<Task>;
+        };
+        comments: {
+            list(slug: string, shortId: number, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Comment[];
+                pagination: Pagination;
+            }>;
+        };
+        labels: {
+            list(slug: string, opts?: RequestOptions): Promise<Label[]>;
+        };
+        categories: {
+            list(slug: string, order?: Order, opts?: RequestOptions): Promise<Category[]>;
+        };
+        get(slug: string, opts?: RequestOptions): Promise<Organization>;
+    };
+    me: {
+        get(opts?: RequestOptions): Promise<Me>;
+        organizations(opts?: RequestOptions): Promise<Organization[]>;
+    };
+};
+
+type WSMessageType = "CONNECTION_STATUS" | "SUBSCRIBED" | "ERROR" | "PING" | "PONG" | "UPDATE_ORG" | "CREATE_TASK" | "UPDATE_TASK" | "UPDATE_TASK_COMMENTS" | "UPDATE_TASK_VOTE" | "UPDATE_LABELS" | "UPDATE_VIEWS" | "UPDATE_CATEGORIES" | "UPDATE_ISSUE_TEMPLATES" | "DISCONNECTED";
+/**
+ * String enum replacement for WS event names.
+ * Use this instead of raw strings.
+ */
+declare const WS_EVENTS: Record<WSMessageType, WSMessageType>;
+interface WSMessage<T = unknown> {
+    type: WSMessageType;
+    scope: "PUBLIC";
+    data: T;
+    meta?: {
+        ts: number;
+    };
+}
+
+type Handlers = Partial<Record<WSMessageType, (data: any, msg: WSMessage) => void>>;
+declare function ws(url: string, handlers?: Handlers): {
+    close(): void;
+};
+
+/**
+ * Sayr Public API — Version 1.
+ *
+ * @since v1.0.0
+ */
+declare const SayrV1: {
+    org: {
+        tasks: {
+            list(slug: string, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Task[];
+                pagination: Pagination;
+            }>;
+            get(slug: string, shortId: number, opts?: RequestOptions): Promise<Task>;
+        };
+        comments: {
+            list(slug: string, shortId: number, params?: OrderedPaginationParams, opts?: RequestOptions): Promise<{
+                data: Comment[];
+                pagination: Pagination;
+            }>;
+        };
+        labels: {
+            list(slug: string, opts?: RequestOptions): Promise<Label[]>;
+        };
+        categories: {
+            list(slug: string, order?: Order, opts?: RequestOptions): Promise<Category[]>;
+        };
+        get(slug: string, opts?: RequestOptions): Promise<Organization>;
+    };
+    me: {
+        get(opts?: RequestOptions): Promise<Me>;
+        organizations(opts?: RequestOptions): Promise<Organization[]>;
+    };
+};
+/**
+ * Create a WebSocket connection for public real‑time updates.
+ */
+declare const SayrWS: typeof ws;
+/**
+ * Typed WebSocket event constants.
+ */
+declare const SayrWSEvents: Record<WSMessageType, WSMessageType>;
+/**
+ * Global client configuration helpers.
+ */
+declare const SayrClient: {
+    setToken: typeof setToken;
+    setHeaders: typeof setHeaders;
+    setBaseUrl: typeof setBaseUrl;
+    resetClient: typeof resetClient;
+    setHooks: typeof setHooks;
+    setFetch: typeof setFetch;
+};
+/**
+ * Sayr Public SDK.
+ *
+ * Read‑only access to public Sayr data via REST and WebSockets.
+ *
+ * @since v1.0.0
+ */
+declare const Sayr: {
+    /**
+     * Client configuration helpers.
+     */
+    client: typeof SayrClient;
+    /**
+     * Versioned API namespaces.
+     */
+    v1: typeof v1;
+    /**
+     * Alias for the current API version (`v1`).
+     *
+     * @since v1.0.0
+     */
+    org: typeof v1.org;
+    me: typeof v1.me;
+    /**
+     * WebSocket helper for real‑time updates.
+     */
+    ws: typeof ws;
+    /**
+     * WebSocket event constants.
+     */
+    WS_EVENTS: typeof WS_EVENTS;
+};
+
+export { type ApiError, type ApiSuccess, type Category, type Comment, type CommentReaction, type CommentUser, type Label, type Order, type OrderedPaginationParams, type Organization, type Pagination, type PaginationParams, SayrClient, SayrV1, SayrWS, SayrWSEvents, type Task, type TaskPriority, type TaskStatus, type WSMessage, type WSMessageType, WS_EVENTS, buildPaginationParams, Sayr as default };