nn-widgets 0.1.0

package/plugin/build/types.d.ts

@@ -0,0 +1,353 @@
+/**
+ * Widget family types for iOS WidgetKit
+ */
+export type WidgetFamily = "systemSmall" | "systemMedium" | "systemLarge" | "systemExtraLarge" | "accessoryCircular" | "accessoryRectangular" | "accessoryInline";
+/**
+ * Widget display type.
+ *
+ * - `"single"` – Icon + Title + Subtitle centered layout (default for backward compat)
+ * - `"list"`   – Vertical list of items, each with icon + title + description
+ * - `"grid"`   – Grid of items, each column with icon on top + title at bottom
+ * - `"image"`  – Full-bleed background image (legacy `image` prop is auto-detected)
+ */
+export type WidgetType = "single" | "list" | "grid" | "image";
+/**
+ * System font size keys (maps to SwiftUI Font / Android sp values).
+ *
+ * | Key          | iOS (SwiftUI)   | Android (sp) |
+ * |--------------|-----------------|-------------|
+ * | caption2     | .caption2 (11)  | 11          |
+ * | caption      | .caption (12)   | 12          |
+ * | footnote     | .footnote (13)  | 13          |
+ * | subheadline  | .subheadline (15)| 15         |
+ * | body         | .body (17)      | 17          |
+ * | headline     | .headline (17b) | 17 bold     |
+ * | title3       | .title3 (20)    | 20          |
+ * | title2       | .title2 (22)    | 22          |
+ * | title        | .title (28)     | 28          |
+ */
+export type WidgetFontSize = "caption2" | "caption" | "footnote" | "subheadline" | "body" | "headline" | "title3" | "title2" | "title";
+/**
+ * Font weight keys (maps to SwiftUI Font.Weight / Android Typeface).
+ */
+export type WidgetFontWeight = "regular" | "medium" | "semibold" | "bold";
+/**
+ * Icon configuration for a list/single item.
+ * Can be a simple string (system icon name) or an object with extra styling.
+ */
+export type WidgetItemIcon = string | {
+    /** Icon name: SF Symbol (iOS) or bundled image name */
+    url: string;
+    /** Icon size in points/dp @default 32 */
+    size?: number;
+    /** Border radius (0 = square, size/2 = circle) @default 0 */
+    radius?: number;
+    /** Background color behind the icon (hex) */
+    backgroundColor?: string;
+};
+/**
+ * Text configuration for a list/single item.
+ * Can be a simple string or an object with styling.
+ */
+export type WidgetItemText = string | {
+    /** The text content */
+    text: string;
+    /** Text color (hex). Falls back to widget-level style colors. */
+    color?: string;
+    /** Font size key @default "body" for title, "caption" for description */
+    fontSize?: WidgetFontSize;
+    /** Font weight @default "semibold" for title, "regular" for description */
+    fontWeight?: WidgetFontWeight;
+};
+/**
+ * A single item in a list-type widget.
+ */
+export interface WidgetListItem {
+    /** Left icon (SF Symbol name, bundled image, or object with styling) */
+    icon?: WidgetItemIcon;
+    /** Right icon (SF Symbol name, bundled image, or object with styling) */
+    rightIcon?: WidgetItemIcon;
+    /** Title text (string or styled object) */
+    title: WidgetItemText;
+    /** Description text (string or styled object) */
+    description?: WidgetItemText;
+    /** Per-item deep link URL (overrides widget-level deepLink when tapped) */
+    deepLink?: string;
+}
+/**
+ * Data payload for `setWidgetData()`. Shape depends on widget type.
+ */
+export interface WidgetDataPayload {
+    /** For type: "single" */
+    icon?: WidgetItemIcon;
+    title?: WidgetItemText;
+    subtitle?: WidgetItemText;
+    /** For type: "list" */
+    items?: WidgetListItem[];
+}
+/**
+ * Per-widget configuration (used in the widgets[] array)
+ */
+export interface WidgetConfig {
+    /**
+     * Unique name for this widget (used as Swift/Kotlin identifier)
+     * Must be a valid identifier (no spaces, starts with letter)
+     */
+    name: string;
+    /**
+     * Display name shown in widget gallery
+     */
+    displayName: string;
+    /**
+     * Widget description shown in widget gallery
+     * @default "A widget for your app"
+     */
+    description?: string;
+    /**
+     * Widget display type.
+     * - `"single"` – Icon + Title + Subtitle (default)
+     * - `"list"`   – Vertical list of items
+     * - `"image"`  – Full-bleed background image
+     *
+     * If `image` prop is set and `type` is omitted, type is auto-detected as "image".
+     * @default "single"
+     */
+    type?: WidgetType;
+    /**
+     * Deep link URL opened when widget is tapped
+     * Example: "myapp://widget/play" or "myapp://widget/brainstorm"
+     */
+    deepLinkUrl?: string;
+    /**
+     * Show app icon in widget UI
+     * @default true
+     */
+    showAppIcon?: boolean;
+    /**
+     * Supported widget families (iOS only)
+     * @default ["systemSmall", "systemMedium", "systemLarge"]
+     */
+    widgetFamilies?: WidgetFamily[];
+    /**
+     * Background images for the widget, per size.
+     * Path relative to project root (e.g. "./assets/widgets/main-small.png").
+     * If provided and type is not set, widget type auto-detects to "image".
+     */
+    image?: {
+        small?: string;
+        medium?: string;
+        large?: string;
+    } | string;
+    /**
+     * Grid layout configuration for type: "grid".
+     * Format: "COLUMNSxROWS" (e.g. "2x2", "3x2", "4x2").
+     * - Columns: number of columns in the grid
+     * - Rows: max number of rows (items beyond columns*rows are hidden)
+     *
+     * If not set, columns are auto-detected based on widget family:
+     * - systemSmall: 2 columns
+     * - systemMedium: 4 columns
+     * - systemLarge: 4 columns
+     *
+     * @example "3x2" → 3 columns, 2 rows → max 6 items
+     * @example "2x2" → 2 columns, 2 rows → max 4 items
+     */
+    gridLayout?: string;
+    /**
+     * Bundled icon images for use in list/single items at runtime.
+     * Keys are icon names, values are paths to .png files.
+     * These are copied to Assets.xcassets (iOS) / res/drawable (Android) at prebuild.
+     *
+     * @example
+     * ```json
+     * { "brainstorm": "./assets/widgets/icons/brainstorm.png" }
+     * ```
+     */
+    icons?: Record<string, string>;
+    /**
+     * Widget-level style (colors). Items inherit from these unless overridden.
+     * Colors are hex strings (e.g. "#1E1E2E").
+     */
+    style?: {
+        /** Background color of the widget */
+        backgroundColor?: string;
+        /** Title text color */
+        titleColor?: string;
+        /** Subtitle / description text color */
+        subtitleColor?: string;
+        /** Accent color (used for icons, values) */
+        accentColor?: string;
+    };
+    /**
+     * Fallback title shown when no data has been set via setWidgetData().
+     * @default displayName
+     */
+    fallbackTitle?: string;
+    /**
+     * Fallback subtitle shown when no data has been set via setWidgetData().
+     * @default "Open app to start"
+     */
+    fallbackSubtitle?: string;
+    /**
+     * Android-specific overrides for this widget
+     */
+    android?: {
+        minWidth?: number;
+        minHeight?: number;
+        resizeMode?: "none" | "horizontal" | "vertical" | "horizontal|vertical";
+    };
+}
+/**
+ * Configuration options for nn-widgets plugin
+ *
+ * Supports two formats:
+ * 1. Legacy single widget: { widgetName, displayName, ios, android }
+ * 2. Multi-widget: { widgets: [...], ios, android }
+ */
+export interface NNWidgetsPluginProps {
+    /**
+     * Array of widget configurations.
+     * When provided, widgetName/displayName/description are ignored.
+     */
+    widgets?: WidgetConfig[];
+    /**
+     * @deprecated Use widgets[] instead
+     */
+    widgetName?: string;
+    /**
+     * @deprecated Use widgets[] instead
+     */
+    displayName?: string;
+    /**
+     * @deprecated Use widgets[] instead
+     */
+    description?: string;
+    /**
+     * iOS shared configuration
+     */
+    ios?: {
+        /**
+         * Deployment target for widget extension
+         * @default "17.0"
+         */
+        deploymentTarget?: string;
+        /**
+         * Enable App Groups for data sharing between app and widget
+         * Set to false for local development without provisioning profile setup
+         * @default true
+         */
+        useAppGroups?: boolean;
+        /**
+         * App group identifier for data sharing
+         * If not provided, will be auto-generated as group.{bundleIdentifier}
+         * Only used when useAppGroups is true
+         */
+        appGroupIdentifier?: string;
+        /**
+         * Development team ID for signing
+         */
+        devTeam?: string;
+        /**
+         * Supported widget families (applies to legacy single-widget format)
+         * For multi-widget, set widgetFamilies per widget in widgets[]
+         * @default ["systemSmall", "systemMedium", "systemLarge"]
+         */
+        widgetFamilies?: WidgetFamily[];
+        /**
+         * Deep link URL (applies to legacy single-widget format)
+         * For multi-widget, set deepLinkUrl per widget in widgets[]
+         */
+        deepLinkUrl?: string;
+        /**
+         * Show app icon (applies to legacy single-widget format)
+         * For multi-widget, set showAppIcon per widget in widgets[]
+         * @default true
+         */
+        showAppIcon?: boolean;
+    };
+    /**
+     * Android shared configuration
+     */
+    android?: {
+        /**
+         * Minimum SDK for widget
+         * @default 26
+         */
+        minSdkVersion?: number;
+        /**
+         * Widget update interval in milliseconds (minimum 30 minutes)
+         * @default 1800000 (30 minutes)
+         */
+        updatePeriodMillis?: number;
+        /**
+         * Widget minimum width in dp (applies to legacy single-widget format)
+         * @default 110
+         */
+        minWidth?: number;
+        /**
+         * Widget minimum height in dp (applies to legacy single-widget format)
+         * @default 40
+         */
+        minHeight?: number;
+        /**
+         * Widget resize mode (applies to legacy single-widget format)
+         * @default "horizontal|vertical"
+         */
+        resizeMode?: "none" | "horizontal" | "vertical" | "horizontal|vertical";
+    };
+}
+/**
+ * Resolved per-widget config with all defaults applied
+ */
+export interface ResolvedWidgetConfig {
+    name: string;
+    displayName: string;
+    description: string;
+    type: WidgetType;
+    deepLinkUrl?: string;
+    showAppIcon: boolean;
+    widgetFamilies: string[];
+    fallbackTitle: string;
+    fallbackSubtitle: string;
+    /** Resolved image paths per size (absolute paths, or undefined if not set) */
+    image?: {
+        small?: string;
+        medium?: string;
+        large?: string;
+    };
+    /** Grid layout "COLUMNSxROWS" (e.g. "3x2") for grid-type widgets */
+    gridLayout?: string;
+    /** Bundled icon images (name → path) */
+    icons?: Record<string, string>;
+    /** Resolved style options */
+    style?: {
+        backgroundColor?: string;
+        titleColor?: string;
+        subtitleColor?: string;
+        accentColor?: string;
+    };
+    android: {
+        minWidth: number;
+        minHeight: number;
+        resizeMode: string;
+    };
+}
+/**
+ * Resolved configuration with all defaults applied
+ */
+export interface ResolvedPluginProps {
+    /** The shared extension name (iOS) */
+    extensionName: string;
+    widgets: ResolvedWidgetConfig[];
+    ios: {
+        deploymentTarget: string;
+        useAppGroups: boolean;
+        appGroupIdentifier?: string;
+        devTeam?: string;
+    };
+    android: {
+        minSdkVersion: number;
+        updatePeriodMillis: number;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/plugin/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,aAAa,GACb,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,mBAAmB,GACnB,sBAAsB,GACtB,iBAAiB,CAAC;AAEtB;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9D;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,GACtB,UAAU,GACV,SAAS,GACT,UAAU,GACV,aAAa,GACb,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN;IACE,uDAAuD;IACvD,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN;IACE,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,2EAA2E;IAC3E,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wEAAwE;IACxE,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,yEAAyE;IACzE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,2CAA2C;IAC3C,KAAK,EAAE,cAAc,CAAC;IACtB,iDAAiD;IACjD,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAE1B,uBAAuB;IACvB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;IAEhC;;;;OAIG;IACH,KAAK,CAAC,EACF;QACE,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACD,MAAM,CAAC;IAEX;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,KAAK,CAAC,EAAE;QACN,qCAAqC;QACrC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,uBAAuB;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,wCAAwC;QACxC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,4CAA4C;QAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,qBAAqB,CAAC;KACzE,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IAGnC;;;OAGG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IAIzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE;QACJ;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;;;WAIG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;QAEhC;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;IAEF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,qBAAqB,CAAC;KACzE,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,KAAK,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,6BAA6B;IAC7B,KAAK,CAAC,EAAE;QACN,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,sCAAsC;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,GAAG,EAAE;QACH,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE;QACP,aAAa,EAAE,MAAM,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH"}

package/plugin/build/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/plugin/build/withAndroidWidget.d.ts

@@ -0,0 +1,5 @@
+import { ConfigPlugin } from "@expo/config-plugins";
+import type { NNWidgetsPluginProps } from "./types";
+export declare const withAndroidWidget: ConfigPlugin<NNWidgetsPluginProps>;
+export default withAndroidWidget;
+//# sourceMappingURL=withAndroidWidget.d.ts.map

package/plugin/build/withAndroidWidget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withAndroidWidget.d.ts","sourceRoot":"","sources":["../src/withAndroidWidget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,sBAAsB,CAAC;AAGzE,OAAO,KAAK,EACV,oBAAoB,EAGrB,MAAM,SAAS,CAAC;AA+hBjB,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,oBAAoB,CAuNhE,CAAC;AAEF,eAAe,iBAAiB,CAAC"}