@youasked/react 0.0.0-stage → 0.5.0

package/dist/capture.d.ts

@@ -0,0 +1,4 @@
+export default function Capture({ onDone, onCancel }: {
+    onDone: (image: Blob) => void;
+    onCancel: () => void;
+}): import("react").JSX.Element;

package/dist/client.d.ts

@@ -0,0 +1,164 @@
+export type Status = "open" | "planned" | "in_progress" | "shipped" | "declined" | "pending";
+export type FeatureRequest = {
+    id: string;
+    /** Shown as YA-12; commits and PRs that say "closes YA-12" ship it. */
+    number: number;
+    title: string;
+    body: string;
+    status: Status;
+    votes: number;
+    comments: number;
+    shipNote: string | null;
+    shippedAt: number | null;
+    /** Where it was asked from: the page path and/or a topic like "charts". */
+    context: {
+        path?: string;
+        topic?: string;
+    } | null;
+    /** Set when the team found this ask elsewhere ("reddit" or "appstore") and added it. */
+    source?: string;
+    sourceUrl?: string | null;
+    /** First name of the person who asked, when they opted in to being thanked and it has shipped. */
+    creditName: string | null;
+    createdAt: number;
+    voted: boolean;
+    mine: boolean;
+};
+export type Attachment = {
+    id: string;
+    url: string;
+};
+/** What shipped since this person was last shown the list. */
+export type WhatsNew = {
+    /** Items shown, newest first with the ones they asked for or voted on at the top. */
+    items: {
+        id: string;
+        title: string;
+        shipNote: string | null;
+        shippedAt: number;
+        mine: boolean;
+    }[];
+    /** How many shipped in all; more than items.length when the list was cut short. */
+    total: number;
+};
+export type RequestComment = {
+    id: string;
+    body: string;
+    team: boolean;
+    author: string | null;
+    mine: boolean;
+    createdAt: number;
+};
+export type Notice = {
+    id: string;
+    /** "shipped", or "reply" when the team answered */
+    kind: string;
+    requestId: string;
+    title: string;
+    shipNote: string | null;
+    reply: string | null;
+};
+export type Config = {
+    app: {
+        name: string;
+    };
+    watermark: boolean;
+    identified: boolean;
+    /** Identified with a name, so "Credit me when it ships" makes sense. */
+    canCredit: boolean;
+    unseen: Notice[];
+    whatsNew: WhatsNew | null;
+    mode?: "test" | "live";
+};
+export type NewRequest = {
+    title: string;
+    body: string;
+    /** Ids from `upload()`. */
+    attachments?: string[];
+    context?: {
+        path?: string;
+        topic?: string;
+    };
+    credit?: boolean;
+};
+export type RequestDetail = {
+    request?: FeatureRequest;
+    comments?: RequestComment[];
+    attachments?: Attachment[];
+    /** Whether this person asked to try it before it ships. */
+    earlyAccess?: boolean;
+    /** The person wrote it and nobody else has joined in yet, so they can take it back. */
+    canDelete?: boolean;
+    redirect?: string;
+};
+export type YouAskedUser = {
+    id: string | number;
+    email?: string | null;
+    name?: string | null;
+};
+export declare class YouAskedError extends Error {
+    code: string;
+    /** A ready-to-show sentence from the server, when it sent one (spam and rate-limit answers do). */
+    detail?: string | undefined;
+    constructor(code: string, 
+    /** A ready-to-show sentence from the server, when it sent one (spam and rate-limit answers do). */
+    detail?: string | undefined);
+}
+export type ClientOptions = {
+    appKey: string;
+    apiUrl: string;
+    user?: YouAskedUser | null;
+    signature?: string | null;
+};
+export declare function createClient({ appKey, apiUrl, user, signature }: ClientOptions): {
+    config: () => Promise<Config>;
+    list: (sort: "top" | "new", status: "active" | "shipped" | "all") => Promise<FeatureRequest[]>;
+    similar: (q: string) => Promise<FeatureRequest[]>;
+    get: (id: string) => Promise<RequestDetail>;
+    create: (input: NewRequest) => Promise<{
+        attachments: Attachment[];
+        id: string;
+        /** Shown as YA-12; commits and PRs that say "closes YA-12" ship it. */
+        number: number;
+        title: string;
+        body: string;
+        status: Status;
+        votes: number;
+        comments: number;
+        shipNote: string | null;
+        shippedAt: number | null;
+        /** Where it was asked from: the page path and/or a topic like "charts". */
+        context: {
+            path?: string;
+            topic?: string;
+        } | null;
+        /** Set when the team found this ask elsewhere ("reddit" or "appstore") and added it. */
+        source?: string;
+        sourceUrl?: string | null;
+        /** First name of the person who asked, when they opted in to being thanked and it has shipped. */
+        creditName: string | null;
+        createdAt: number;
+        voted: boolean;
+        mine: boolean;
+    }>;
+    upload: (image: Blob) => Promise<Attachment>;
+    remove: (id: string) => Promise<{
+        ok: true;
+    }>;
+    earlyAccess: (id: string) => Promise<{
+        earlyAccess: boolean;
+    }>;
+    whatsNewSeen: () => Promise<{
+        ok: true;
+    }>;
+    vote: (id: string) => Promise<{
+        voted: boolean;
+        votes: number;
+    }>;
+    comment: (id: string, body: string) => Promise<RequestComment>;
+    mine: () => Promise<FeatureRequest[]>;
+    seen: (ids: string[]) => Promise<{
+        ok: true;
+    }>;
+};
+export type Client = ReturnType<typeof createClient>;

package/dist/context.d.ts

@@ -0,0 +1,71 @@
+import { type CSSProperties } from "react";
+import type { Client, Config, WhatsNew } from "./client";
+export type OpenOptions = {
+    /** "home" is the chat-style start screen; "new" opens it with the composer focused. */
+    view?: "home" | "new" | "board" | "shipped" | "mine";
+    requestId?: string;
+    /** Pre-fills the composer, e.g. "Export to Excel" from a locked feature. */
+    draft?: string;
+    /**
+     * What the request is about, e.g. "charts". It's saved with the request, and the composer asks
+     * "What would make charts better?". "search" and "locked" are used by AskForIt and keep the default wording.
+     */
+    topic?: string;
+    /** Replaces the composer's placeholder. */
+    placeholder?: string;
+};
+export type Route = {
+    view: "home";
+    draft?: string;
+    focus?: boolean;
+    topic?: string;
+    placeholder?: string;
+} | {
+    view: "board";
+    tab?: "top" | "new" | "shipped";
+} | {
+    view: "detail";
+    id: string;
+} | {
+    view: "mine";
+};
+export declare function toRoute(o?: OpenOptions): Route;
+export type InternalContext = {
+    open: (options?: OpenOptions) => void;
+    close: () => void;
+    isOpen: boolean;
+    unseenCount: number;
+    client: Client;
+    config: Config | null;
+    markSeen: (ids: string[]) => void;
+    /** What shipped since this person's last visit, until they've been shown it. */
+    whatsNew: WhatsNew | null;
+    dismissWhatsNew: () => void;
+    /**
+     * Hides the sheet, lets the person draw on the page, and resolves with a screenshot of it
+     * (null if they cancel or the page can't be captured).
+     */
+    pointAtIt: () => Promise<Blob | null>;
+    /** Spread onto any element that renders widget UI inside the host page. */
+    scope: {
+        className: string;
+        style?: CSSProperties;
+        "data-ya-mode"?: string;
+    };
+    appName: string;
+    /** The app's icon: from the appIcon prop, else the page's apple-touch-icon or a large favicon, else null. */
+    appIcon: string | null;
+    title: string;
+    greeting?: string;
+};
+export declare const YouAskedContext: import("react").Context<InternalContext | null>;
+export declare function useInternal(): InternalContext;
+/** Open, close and the unseen badge count, for wiring YouAsked to your own buttons. */
+export declare function useYouAsked(): {
+    open: (options?: OpenOptions) => void;
+    close: () => void;
+    isOpen: boolean;
+    unseenCount: number;
+};
+/** Opens the panel from anywhere, even outside React. */
+export declare function openYouAsked(options?: OpenOptions): void;

package/dist/demo.d.ts

@@ -0,0 +1,6 @@
+import { type Client, type Notice } from "./client";
+export type DemoClient = Client & {
+    /** Calls back when the pretend team writes in. Returns an unsubscribe. */
+    onNotice: (fn: (n: Notice) => void) => () => void;
+};
+export declare function createDemoClient(appName?: string): DemoClient;

package/dist/entries.d.ts

@@ -0,0 +1,47 @@
+import { type CSSProperties } from "react";
+type Common = {
+    className?: string;
+    style?: CSSProperties;
+};
+/** A chat-style input bar. Tapping it opens the composer. Good at the top of a home screen or under an empty state. */
+export declare function AskBar({ placeholder, className, style }: Common & {
+    placeholder?: string;
+}): import("react").JSX.Element;
+/** A card with the top requests and vote buttons, for a dashboard or home tab. */
+export declare function FeatureCard({ heading, description, limit, className, style, }: Common & {
+    heading?: string;
+    description?: string;
+    limit?: number;
+}): import("react").JSX.Element;
+/**
+ * A button for your own toolbar or menu.
+ * - "pill": tinted pill with an icon and label
+ * - "icon": round icon button, e.g. in a header
+ * - "row": a settings-style row with a chevron
+ */
+export declare function RequestButton({ variant, label, sublabel, className, style, }: Common & {
+    variant?: "pill" | "icon" | "row";
+    label?: string;
+    sublabel?: string;
+}): import("react").JSX.Element;
+/**
+ * A quiet line next to a feature: "Want more from charts?". Opens the composer already about that
+ * topic, and the request is saved with it so you can see which feature people are asking about.
+ */
+export declare function AskAbout({ topic, prompt, className, style, }: Common & {
+    topic: string;
+    prompt?: string;
+}): import("react").JSX.Element;
+/**
+ * For an empty search: "Can't find “export”? Ask for it". Opens the composer with the search as the
+ * draft, tagged as a search so you can tell what people looked for and didn't find.
+ */
+export declare function AskForIt({ query, className, style }: Common & {
+    query: string;
+}): import("react").JSX.Element;
+/** The whole experience inline, for a /feedback page or a tab. */
+export declare function FeatureBoard({ start, height, className, style, }: Common & {
+    start?: "home" | "board";
+    height?: number | string;
+}): import("react").JSX.Element;
+export {};

package/dist/icons.d.ts

@@ -0,0 +1,14 @@
+export declare const IconUp: () => import("react").JSX.Element;
+export declare const IconClose: () => import("react").JSX.Element;
+export declare const IconBack: () => import("react").JSX.Element;
+export declare const IconChevron: () => import("react").JSX.Element;
+export declare const IconPlus: () => import("react").JSX.Element;
+export declare const IconCheck: () => import("react").JSX.Element;
+export declare const IconChat: () => import("react").JSX.Element;
+export declare const IconSend: () => import("react").JSX.Element;
+export declare const IconBulb: () => import("react").JSX.Element;
+/** Viewfinder corners: "show us" a spot on the page. */
+export declare const IconFrame: () => import("react").JSX.Element;
+export declare const IconSpark: () => import("react").JSX.Element;
+/** YouAsked's own mark for asking: a speech bubble with an up arrow (ask, and vote it up). */
+export declare const IconIdea: () => import("react").JSX.Element;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { YouAsked, DEFAULT_API_URL } from "./YouAsked";
+export type { YouAskedProps } from "./YouAsked";
+export { useYouAsked, openYouAsked } from "./context";
+export type { OpenOptions } from "./context";
+export { AskBar, AskAbout, AskForIt, FeatureCard, RequestButton, FeatureBoard } from "./entries";
+export type { Appearance } from "./theme";
+export type { Attachment, FeatureRequest, RequestComment, Status, WhatsNew, YouAskedUser } from "./client";