@napacitor/dialog 0.0.0-stage → 0.1.2-beta.3

package/README.md

@@ -1,3 +1,41 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @napacitor/dialog
+
+原生对话框插件(与 [@capacitor/dialog](https://github.com/ionic-team/capacitor-plugins/tree/main/dialog) 对应)。
+
+## 用法
+
+```ts
+import { Dialog } from '@napacitor/dialog';
+
+await Dialog.alert({ title: '提示', message: 'Hello Napacitor', buttonTitle: '知道了' });
+
+const { value } = await Dialog.confirm({ title: '确认', message: '继续吗?' });
+console.log(value); // true / false
+
+const { value: text, cancelled } = await Dialog.prompt({
+  title: '输入',
+  message: '你的名字?',
+  okButtonTitle: '确定',
+  cancelButtonTitle: '取消',
+});
+```
+
+## 结构
+
+- `src/` —— TypeScript 源码(index / definitions / web)
+- `dist/` —— 构建产物(CJS + d.ts,已提交)
+- `maui/` —— .NET MAUI C# 实现(程序集 `Napacitor.Dialog`,运行时反射自动发现)
+
+原生实现映射:`Page.DisplayAlert`(alert / confirm)、`Page.DisplayPromptAsync`(prompt);
+Windows 上由 MAUI 落到 `ContentDialog`。对话框必须在 UI 线程弹出,插件内部经
+`MainThread.InvokeOnMainThreadAsync` 切换。
+
+## 与 Capacitor 的差异
+
+- **alert**:映射 DisplayAlert 的单按钮形态,`buttonTitle` 即按钮文案;
+- **prompt**:`inputPlaceholder` 映射 DisplayPromptAsync 的 placeholder,MAUI 无
+  maxLength / keyboard 定制参数故未暴露;取消时 `value` 为空字符串;
+- **web**:Capacitor 依赖 pwa-elements 渲染样式化弹层,此处用 `window.alert / confirm /
+  prompt` 兜底;
+- 该插件是少数需要 `Microsoft.Maui.Controls` 包引用的插件(Page API 属于 Controls 层,
+  运行时 Napacitor 程序集本身仍保持零 MAUI 依赖)。

package/dist/definitions.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @napacitor/dialog 类型定义。
+ * 原生对话框:alert / prompt / confirm
+ * (映射 MAUI Page.DisplayAlert / DisplayPromptAsync;Windows 上由 MAUI 落到 ContentDialog)。
+ */
+/** alert() 参数。 */
+export interface AlertOptions {
+    /** 对话框标题。 */
+    title: string;
+    /** 对话框消息。 */
+    message: string;
+    /** 按钮文案(默认 'OK')。 */
+    buttonTitle?: string;
+}
+/** prompt() 参数。 */
+export interface PromptOptions {
+    /** 对话框标题。 */
+    title: string;
+    /** 对话框消息。 */
+    message: string;
+    /** 确认按钮文案(默认 'OK')。 */
+    okButtonTitle?: string;
+    /** 取消按钮文案(默认 'Cancel')。 */
+    cancelButtonTitle?: string;
+    /** 输入框占位提示。 */
+    inputPlaceholder?: string;
+    /** 输入框预填文本。 */
+    inputText?: string;
+}
+/** prompt() 返回值。 */
+export interface PromptResult {
+    /** 输入的文本(取消时为空字符串)。 */
+    value: string;
+    /** 是否被取消。 */
+    cancelled: boolean;
+}
+/** confirm() 参数。 */
+export interface ConfirmOptions {
+    /** 对话框标题。 */
+    title: string;
+    /** 对话框消息。 */
+    message: string;
+    /** 确认按钮文案(默认 'OK')。 */
+    okButtonTitle?: string;
+    /** 取消按钮文案(默认 'Cancel')。 */
+    cancelButtonTitle?: string;
+}
+/** confirm() 返回值。 */
+export interface ConfirmResult {
+    /** 点击确认按钮时为 true。 */
+    value: boolean;
+}
+export interface DialogPlugin {
+    /** 显示警告对话框。 */
+    alert(options: AlertOptions): Promise<void>;
+    /** 显示输入对话框。 */
+    prompt(options: PromptOptions): Promise<PromptResult>;
+    /** 显示确认对话框。 */
+    confirm(options: ConfirmOptions): Promise<ConfirmResult>;
+}

package/dist/definitions.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @napacitor/dialog 类型定义。
+ * 原生对话框:alert / prompt / confirm
+ * (映射 MAUI Page.DisplayAlert / DisplayPromptAsync;Windows 上由 MAUI 落到 ContentDialog)。
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { DialogPlugin } from './definitions';
+declare const Dialog: DialogPlugin;
+export * from './definitions';
+export { Dialog };

package/dist/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dialog = void 0;
+/**
+ * @napacitor/dialog 入口。
+ */
+const core_1 = require("@napacitor/core");
+const Dialog = (0, core_1.registerPlugin)('Dialog', {
+    web: () => Promise.resolve().then(() => __importStar(require('./web'))).then((m) => new m.DialogWeb()),
+});
+exports.Dialog = Dialog;
+__exportStar(require("./definitions"), exports);

package/dist/web.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @napacitor/dialog 浏览器实现(基于 window.alert / confirm / prompt,
+ * 与 @capacitor/dialog 的 web 实现对应;Capacitor 依赖 pwa-elements,
+ * 此处用原生对话框兜底)。
+ */
+import type { AlertOptions, ConfirmOptions, ConfirmResult, PromptOptions, PromptResult } from './definitions';
+export declare class DialogWeb {
+    alert(options: AlertOptions): Promise<void>;
+    confirm(options: ConfirmOptions): Promise<ConfirmResult>;
+    prompt(options: PromptOptions): Promise<PromptResult>;
+}

package/dist/web.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogWeb = void 0;
+class DialogWeb {
+    async alert(options) {
+        var _a, _b;
+        window.alert(`${(_a = options.title) !== null && _a !== void 0 ? _a : ''}\n${(_b = options.message) !== null && _b !== void 0 ? _b : ''}`.trim());
+    }
+    async confirm(options) {
+        var _a, _b;
+        const value = window.confirm(`${(_a = options.title) !== null && _a !== void 0 ? _a : ''}\n${(_b = options.message) !== null && _b !== void 0 ? _b : ''}`.trim());
+        return { value };
+    }
+    async prompt(options) {
+        var _a, _b, _c;
+        const value = window.prompt(`${(_a = options.title) !== null && _a !== void 0 ? _a : ''}\n${(_b = options.message) !== null && _b !== void 0 ? _b : ''}`.trim(), (_c = options.inputText) !== null && _c !== void 0 ? _c : '');
+        return { value: value !== null && value !== void 0 ? value : '', cancelled: value === null };
+    }
+}
+exports.DialogWeb = DialogWeb;

package/maui/DialogPlugin.cs

@@ -0,0 +1,118 @@
+using Microsoft.Maui.ApplicationModel;
+using Microsoft.Maui.Controls;
+
+namespace Napacitor.Plugins.Dialog;
+
+/* ─── 参数 / 返回 DTO ─────────────────────────────────────── */
+
+/// <summary>alert() 参数。</summary>
+public class DialogAlertOptions
+{
+    /// <summary>对话框标题。</summary>
+    public string? Title { get; set; }
+
+    /// <summary>对话框消息。</summary>
+    public string? Message { get; set; }
+
+    /// <summary>按钮文案(默认 'OK')。</summary>
+    public string? ButtonTitle { get; set; }
+}
+
+/// <summary>prompt() 参数。</summary>
+public class DialogPromptOptions
+{
+    public string? Title { get; set; }
+    public string? Message { get; set; }
+    public string? OkButtonTitle { get; set; }
+    public string? CancelButtonTitle { get; set; }
+    public string? InputPlaceholder { get; set; }
+    public string? InputText { get; set; }
+}
+
+/// <summary>prompt() 返回值。</summary>
+public class DialogPromptResult
+{
+    public string Value { get; set; } = string.Empty;
+    public bool Cancelled { get; set; }
+}
+
+/// <summary>confirm() 参数。</summary>
+public class DialogConfirmOptions
+{
+    public string? Title { get; set; }
+    public string? Message { get; set; }
+    public string? OkButtonTitle { get; set; }
+    public string? CancelButtonTitle { get; set; }
+}
+
+/// <summary>confirm() 返回值。</summary>
+public class DialogConfirmResult
+{
+    public bool Value { get; set; }
+}
+
+/* ─── 插件主体 ─────────────────────────────────────────────── */
+
+/// <summary>
+/// Dialog 插件:原生对话框(映射 MAUI Page.DisplayAlert / DisplayPromptAsync;
+/// Windows 上由 MAUI 落到 ContentDialog)。
+/// </summary>
+[NapacitorPlugin("Dialog")]
+public class DialogPlugin : NapacitorPluginBase
+{
+    /// <summary>显示警告对话框(单按钮)。</summary>
+    [NapacitorMethod]
+    public Task Alert(DialogAlertOptions options)
+    {
+        var page = CurrentPage();
+        return MainThread.InvokeOnMainThreadAsync(() => page.DisplayAlert(
+            options.Title ?? string.Empty,
+            options.Message ?? string.Empty,
+            OrDefault(options.ButtonTitle, "OK")));
+    }
+
+    /// <summary>显示输入对话框(取消时 value 为空串、cancelled 为 true)。</summary>
+    [NapacitorMethod]
+    public async Task<DialogPromptResult> Prompt(DialogPromptOptions options)
+    {
+        var page = CurrentPage();
+        var result = await MainThread.InvokeOnMainThreadAsync(() => page.DisplayPromptAsync(
+            options.Title ?? string.Empty,
+            options.Message ?? string.Empty,
+            OrDefault(options.OkButtonTitle, "OK"),
+            OrDefault(options.CancelButtonTitle, "Cancel"),
+            options.InputPlaceholder,
+            initialValue: options.InputText ?? string.Empty));
+        return new DialogPromptResult
+        {
+            Value = result ?? string.Empty,
+            Cancelled = result is null,
+        };
+    }
+
+    /// <summary>显示确认对话框。</summary>
+    [NapacitorMethod]
+    public async Task<DialogConfirmResult> Confirm(DialogConfirmOptions options)
+    {
+        var page = CurrentPage();
+        var ok = await MainThread.InvokeOnMainThreadAsync(() => page.DisplayAlert(
+            options.Title ?? string.Empty,
+            options.Message ?? string.Empty,
+            OrDefault(options.OkButtonTitle, "OK"),
+            OrDefault(options.CancelButtonTitle, "Cancel")));
+        return new DialogConfirmResult { Value = ok };
+    }
+
+    /* ── 页面定位(宿主窗口未创建 / 无页面时抛 UNAVAILABLE)── */
+
+    private static Page CurrentPage()
+    {
+        var app = Application.Current;
+        return (app?.Windows?.FirstOrDefault()?.Page ?? app?.MainPage)
+            ?? throw new NapacitorException(
+                NapacitorException.Unavailable, "Dialog:当前无可用页面(宿主窗口尚未创建)");
+    }
+
+    private static string OrDefault(string? value, string fallback) =>
+        string.IsNullOrEmpty(value) ? fallback : value;
+}

package/maui/Napacitor.Dialog.csproj

@@ -0,0 +1,25 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <RootNamespace>Napacitor.Plugins.Dialog</RootNamespace>
+    <AssemblyName>Napacitor.Dialog</AssemblyName>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <LangVersion>latest</LangVersion>
+    <Description>Napacitor Dialog 插件(.NET MAUI 实现)</Description>
+    <Version>0.1.0</Version>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <!-- Page.DisplayAlert / DisplayPromptAsync 需要 Controls 层 -->
+    <PackageReference Include="Microsoft.Maui.Essentials" Version="10.0.20" />
+    <PackageReference Include="Microsoft.Maui.Controls" Version="10.0.20" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\maui\src\Napacitor.csproj" Condition="Exists('..\..\maui\src\Napacitor.csproj')" />
+    <ProjectReference Include="..\..\..\maui\src\Napacitor.csproj" Condition="!Exists('..\..\maui\src\Napacitor.csproj')" />
+  </ItemGroup>
+
+</Project>

package/package.json

@@ -1,6 +1,13 @@
-{
-  "name": "@napacitor/dialog",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@napacitor/dialog",
+  "version": "0.1.2-beta.3",
+  "description": "Napacitor Dialog 插件(原生对话框,映射 MAUI Page.DisplayAlert/DisplayPromptAsync)",
+  "homepage": "https://github.com/jevonsflash/napacitor",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist/", "maui/", "!maui/bin/", "!maui/obj/"],
+  "scripts": { "build": "tsc", "type-check": "tsc --noEmit" },
+  "peerDependencies": { "@napacitor/core": "^0.1.0" },
+  "devDependencies": { "@napacitor/core": "^0.1.0", "typescript": "~5.4.5" }
+}