@sortedyuan/plugin-permissions 0.0.0-stage → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yuan
+
+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,17 @@
-# Temporary Holding Version
+# @sortedyuan/plugin-permissions
 
-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.
+`createPermissionPlugin({ id?, create, dispose? })` provides
+`services.permissionPolicy`. `create(context)` returns the actual permission policy
+for one Application. Optional `dispose(policy)` and `context.defer()` own cleanup.
+An existing policy with no disposer remains caller-owned.
+Typed `config`, `configSchema`, dependencies, `requiresHooks`, `state`, and `version`
+are supported through [`PluginFactoryMetadata`](../../plugin-services/README.md).
+Configuration is validated before resources are acquired; `create(context)` can
+read declared services and persistent state.
+
+Application keeps approval requests, durable permission events and its
+`PermissionToolExecutor`; policy evaluation resolves the currently enabled service.
+One plugin supplies the policy. Duplicate providers fail before setup.
+
+Tests evaluate policies against real file resources and verify independent scope
+cleanup: `pnpm --filter @sortedyuan/plugin-permissions test`.

package/README.zh-CN.md

@@ -0,0 +1,15 @@
+# @sortedyuan/plugin-permissions
+
+`createPermissionPlugin({ id?, create, dispose? })` 提供 `services.permissionPolicy`。
+`create(context)` 为一个 Application 返回实际 permission policy。
+通过 `dispose(policy)` 和 `context.defer()` 管理资源清理。
+传入已有 policy 并省略 disposer 时，该实例由调用方管理。
+支持 [`PluginFactoryMetadata`](../../plugin-services/README.zh-CN.md) 中带类型的
+`config`、`configSchema`、依赖、`requiresHooks`、`state` 和 `version`。
+取得资源之前验证配置，`create(context)` 可以读取声明的服务和持久状态。
+
+Application 管理审批请求、权限事件保存和 `PermissionToolExecutor`，
+每次判定权限时取得当前服务。每种 policy 服务具有一个提供方，重复提供方在 setup 之前报错。
+
+测试使用实际文件资源判定权限，并验证不同作用域分别关闭资源。
+执行 `pnpm --filter @sortedyuan/plugin-permissions test`。

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import type { PermissionPolicy } from "@sortedyuan/permissions";
+import { type PluginContext, type PluginDefinition } from "@sortedyuan/plugin";
+import { type PluginFactoryMetadata } from "@sortedyuan/plugin-services";
+export interface PermissionPluginOptions<C = unknown> extends PluginFactoryMetadata<C> {
+    readonly id?: string;
+    readonly create: (context: PluginContext<C>) => PermissionPolicy | Promise<PermissionPolicy>;
+    readonly dispose?: (policy: PermissionPolicy) => void | Promise<void>;
+}
+export declare function createPermissionPlugin<C = unknown>(options: PermissionPluginOptions<C>): PluginDefinition<C>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAgB,KAAK,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC7F,OAAO,EAA6B,KAAK,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpG,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,qBAAqB,CAAC,CAAC,CAAC;IACpF,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE;AACD,wBAAgB,sBAAsB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAO5G"}

package/dist/index.js

@@ -0,0 +1,13 @@
+import { definePlugin } from "@sortedyuan/plugin";
+import { services, factoryMetadata } from "@sortedyuan/plugin-services";
+export function createPermissionPlugin(options) {
+    return definePlugin({ ...factoryMetadata(options), id: options.id ?? "may.permissions", provides: [services.permissionPolicy], async setup(context) {
+            const policy = await options.create(context);
+            if (options.dispose)
+                context.defer(() => options.dispose(policy));
+            if (typeof policy !== "function")
+                throw new TypeError("Permission plugin must create a policy");
+            context.provide(services.permissionPolicy, policy);
+        } });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAA6C,MAAM,oBAAoB,CAAC;AAC7F,OAAO,EAAE,QAAQ,EAAE,eAAe,EAA8B,MAAM,6BAA6B,CAAC;AAOpG,MAAM,UAAU,sBAAsB,CAAc,OAAmC;IACrF,OAAO,YAAY,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,iBAAiB,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO;YAChJ,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,OAAO,CAAC,OAAO;gBAAE,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YACnE,IAAI,OAAO,MAAM,KAAK,UAAU;gBAAE,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;YAChG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC,EAAE,CAAC,CAAC;AACP,CAAC"}

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@sortedyuan/plugin-permissions",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.3",
+  "description": "Permission policy plugin factory.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@sortedyuan/permissions": "0.2.1",
+    "@sortedyuan/plugin": "0.2.0",
+    "@sortedyuan/plugin-services": "0.2.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "tsc -b --clean",
+    "test": "pnpm run build && node --test test/*.test.mjs",
+    "test:coverage": "pnpm run build && node --test --experimental-test-coverage test/*.test.mjs"
+  }
 }