@youasked/react 0.4.1 → 0.6.0

package/dist/YouAsked.d.ts

@@ -1,7 +1,8 @@
 import { type ReactNode } from "react";
 import { type YouAskedUser } from "./client";
+import { type NudgeSettings } from "./nudge";
 import { type Appearance } from "./theme";
-export declare const DEFAULT_API_URL = "https://youasked-api.adenteo.workers.dev";
+export declare const DEFAULT_API_URL = "https://api.youasked.dev";
 export type YouAskedProps = {
     /** Publishable key (ya_pub_…). Safe to ship in client code. Not needed with `demo`. */
     appKey?: string;
@@ -34,7 +35,13 @@ export type YouAskedProps = {
     offset?: number;
     /** Show the corner card for replies, shipped requests and what's new. Turn off for previews embedded in a page. */
     cards?: boolean;
+    /**
+     * The occasional "Got an idea for <App>?" prompt. Set it up in the dashboard; this overrides it:
+     * false turns it off, true turns it on with the dashboard's (or default) settings, an object
+     * changes individual settings, e.g. `{ everyDays: 14, activeSeconds: 60 }`.
+     */
+    nudge?: boolean | Partial<NudgeSettings>;
     apiUrl?: string;
     children?: ReactNode;
 };
-export declare function YouAsked({ appKey, demo, cards, user, signature, ready, appearance, trigger, position, label, appName, appIcon, greeting, title, offset, apiUrl, children, }: YouAskedProps): import("react").JSX.Element;
+export declare function YouAsked({ appKey, demo, cards, nudge: nudgeProp, user, signature, ready, appearance, trigger, position, label, appName, appIcon, greeting, title, offset, apiUrl, children, }: YouAskedProps): import("react").JSX.Element;

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-export type Status = "open" | "planned" | "in_progress" | "shipped" | "declined";
+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. */
@@ -15,6 +15,9 @@ export type FeatureRequest = {
         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;
@@ -65,6 +68,9 @@ export type Config = {
     canCredit: boolean;
     unseen: Notice[];
     whatsNew: WhatsNew | null;
+    mode?: "test" | "live";
+    /** The occasional in-app prompt, as set in the dashboard. null when it's off. */
+    nudge?: import("./nudge").NudgeSettings | null;
 };
 export type NewRequest = {
     title: string;
@@ -83,6 +89,8 @@ export type RequestDetail = {
     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 = {
@@ -92,7 +100,11 @@ export type YouAskedUser = {
 };
 export declare class YouAskedError extends Error {
     code: string;
-    constructor(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;
@@ -122,6 +134,9 @@ export declare function createClient({ appKey, apiUrl, user, signature }: Client
             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;
@@ -129,6 +144,9 @@ export declare function createClient({ appKey, apiUrl, user, signature }: Client
         mine: boolean;
     }>;
     upload: (image: Blob) => Promise<Attachment>;
+    remove: (id: string) => Promise<{
+        ok: true;
+    }>;
     earlyAccess: (id: string) => Promise<{
         earlyAccess: boolean;
     }>;

package/dist/context.d.ts

@@ -23,9 +23,12 @@ export type Route = {
 } | {
     view: "board";
     tab?: "top" | "new" | "shipped";
-} | {
+}
+/** `from` is where Back goes: the list they opened it from. */
+ | {
     view: "detail";
     id: string;
+    from?: "home" | "board" | "mine";
 } | {
     view: "mine";
 };

package/dist/icons.d.ts

@@ -11,4 +11,7 @@ export declare const IconBulb: () => import("react").JSX.Element;
 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;
+/** The ask mark: a speech bubble holding the vote arrow. `ink` colours the arrow; by default the background. */
+export declare const IconIdea: ({ ink }: {
+    ink?: string;
+}) => import("react").JSX.Element;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { YouAsked, DEFAULT_API_URL } from "./YouAsked";
+export type { NudgeSettings } from "./nudge";
 export type { YouAskedProps } from "./YouAsked";
 export { useYouAsked, openYouAsked } from "./context";
 export type { OpenOptions } from "./context";