@piup/plugin-sdk 0.0.0-stage → 0.0.1-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 piup contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @piup/plugin-sdk
 
-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.
+<p>
+<a href="https://www.npmjs.com/package/@piup/plugin-sdk"><img alt="NPM version" src="https://img.shields.io/npm/v/@piup/plugin-sdk.svg?logo=npm"></a>
+<a href="https://www.npmjs.com/package/@piup/plugin-sdk"><img alt="NPM downloads" src="https://img.shields.io/npm/dm/@piup/plugin-sdk.svg?logo=npm&color=blue"></a>
+<a href="https://bundlephobia.com/package/@piup/plugin-sdk">
+  <img alt="bundle size" src="https://img.shields.io/bundlephobia/minzip/@piup/plugin-sdk.svg?style=flat-square&logo=typescript&label=size">
+</a>
+<a href="https://www.npmjs.com/package/@piup/plugin-sdk"><img alt="Node Versions" src="https://img.shields.io/node/v/@piup/plugin-sdk.svg"></a>
+</p>
+
+<p align="center">
+  <a href="https://docs-piup.keylenn.online">
+    <img src="https://docs-piup.keylenn.online/piup-logo.svg" alt="piup logo" width="128" height="128">
+  </a>
+</p>
+
+piup 的插件开发 SDK，提供受限的插件描述与注册 API。当前不包含独立 Plugin Host，也不是安全沙箱。
+
+## 快速开始
+
+⚠️ 当前插件功能尚未可用，敬请期待～
+
+💡 普通用户无需单独安装 SDK，使用 `@piup/cli` 即可。
+
+完整使用指南与支持范围请查看 **[piup 文档](https://docs-piup.keylenn.online)**。

package/dist/index.d.mts

@@ -0,0 +1,8 @@
+import { PluginDescriptor } from "@piup/contracts";
+//#region src/index.d.ts
+export interface PluginRegistration {
+  readonly descriptor: PluginDescriptor;
+}
+export declare function definePlugin<const TPlugin extends PluginRegistration>(plugin: TPlugin): TPlugin;
+//#endregion
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,8 @@
+//#region src/index.ts
+function definePlugin(plugin) {
+	return plugin;
+}
+//#endregion
+export { definePlugin };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { PluginDescriptor } from \"@piup/contracts\";\n\nexport interface PluginRegistration {\n  readonly descriptor: PluginDescriptor;\n}\n\nexport function definePlugin<const TPlugin extends PluginRegistration>(\n  plugin: TPlugin,\n): TPlugin {\n  return plugin;\n}\n"],"mappings":";AAMA,SAAgB,aACd,QACS;CACT,OAAO;AACT"}

package/package.json

@@ -1,6 +1,37 @@
 {
   "name": "@piup/plugin-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.1-beta.1",
+  "description": "Restricted plugin registration API for piup plugins.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Keylenn/piup.git",
+    "directory": "packages/plugin-sdk"
+  },
+  "homepage": "https://github.com/Keylenn/piup#readme",
+  "bugs": {
+    "url": "https://github.com/Keylenn/piup/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@piup/contracts": "0.0.1-beta.1"
+  }
 }