@kubun/plugin-p2p-api 0.16.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/lib/index.d.ts

@@ -0,0 +1,55 @@
+import type { CommandRefusalReason, EnqueueOptions, InstanceStatus } from '@kubun/plugin-workflow-api';
+export type WorkflowCommandRefusalReason = CommandRefusalReason;
+export type WorkflowCommandResult = {
+    ok: true;
+    status: InstanceStatus;
+} | {
+    ok: false;
+    reason: WorkflowCommandRefusalReason;
+};
+export type WorkflowDiscoverReply = {
+    senderDID: string;
+    instances: Array<InstanceStatus>;
+};
+/**
+ * The narrow typed P2P control-plane API. Each method takes `groupID` as the
+ * PEER-SELECTION argument; the transport (multi-hub fan-out for discover, a
+ * directed `.to(targetDID)` request for the rest) and reply dedup (by
+ * authenticated `senderDID`) are the implementation's concern — no
+ * group-peer-manager internal is exposed here.
+ *
+ * The three OBSERVE methods return `InstanceStatus` shapes and REJECT on refusal:
+ * a non-observable instance is refused identically to a missing one, so a
+ * rejection is indistinguishable — the caller cannot confirm a hidden instance
+ * exists. The three COMMAND methods return the discriminated
+ * {@link WorkflowCommandResult} verbatim; a caller helper reconstitutes a
+ * refusal into a local throw.
+ */
+/**
+ * Bounds a discover fan-out, mirroring `peer/query`: `quorum` resolves a gather
+ * as soon as that many distinct responders answer (set it to the known
+ * live-member count to return promptly rather than waiting out the window),
+ * `timeoutMs` caps the wait. Both optional; absent, the gather runs its default
+ * window. `quorum` is applied per hub-peer gather, not across the deduplicated
+ * multi-hub result, so with members split across hubs a hub may wait out its
+ * window even once the combined result already holds `quorum` distinct
+ * responders; the single-hub case (the common one) resolves exactly at quorum.
+ */
+export type WorkflowDiscoverOptions = {
+    quorum?: number;
+    timeoutMs?: number;
+};
+export type WorkflowControlPlaneAPI = {
+    /** Fan out `workflow/discover` across the group's hubs; one entry per distinct responder. */
+    discoverWorkflows(groupID: string, options?: WorkflowDiscoverOptions): Promise<Array<WorkflowDiscoverReply>>;
+    /** Directed `workflow/list` to one peer: its remotely-observable instances. */
+    listWorkflows(groupID: string, targetDID: string): Promise<Array<InstanceStatus>>;
+    /** Directed `workflow/status` to one peer; rejects when not observable or missing. */
+    workflowStatus(groupID: string, targetDID: string, instanceID: string): Promise<InstanceStatus>;
+    /** Directed `workflow/enqueue` to one peer; refusal returned as data. */
+    enqueueWorkflow(groupID: string, targetDID: string, name: string, params?: unknown, opts?: EnqueueOptions): Promise<WorkflowCommandResult>;
+    /** Directed `workflow/cancel` to one peer; refusal returned as data. */
+    cancelWorkflow(groupID: string, targetDID: string, instanceID: string): Promise<WorkflowCommandResult>;
+    /** Directed `workflow/retry` to one peer; refusal returned as data. */
+    retryWorkflow(groupID: string, targetDID: string, instanceID: string): Promise<WorkflowCommandResult>;
+};

package/lib/index.js

@@ -0,0 +1,8 @@
+// Caller-facing contract for the p2p group workflow control plane: the typed
+// methods a consumer reaches through `engine.getAPI('p2p')` to drive the six
+// remote workflow ops (discover/list/status/enqueue/cancel/retry) by `groupID`.
+// Types only — importing this creates no runtime edge on plugin-p2p, so a
+// consumer (e.g. plugin-workflow's caller helpers) stays independently loadable.
+// This is the `@kubun/plugin-workflow-api` pattern in reverse: plugin-p2p
+// implements these, plugin-workflow imports them type-only.
+export { };

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@kubun/plugin-p2p-api",
+  "version": "0.16.0",
+  "keywords": [],
+  "license": "see LICENSE.md",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "dependencies": {
+    "@kubun/plugin-workflow-api": "^0.16.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../node_modules/@kigu/dev/swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
+    "test": "pnpm run test:types",
+    "test:types": "tsc --noEmit --skipLibCheck"
+  }
+}