fedipod-server 0.4.0

package/dist/handler.jsonld

@@ -0,0 +1,519 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/fedipod-server/^0.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^7.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:fedipod-server",
+  "components": [
+    {
+      "@id": "fps:dist/handler.jsonld#FediPodServerHandler",
+      "@type": "Class",
+      "requireElement": "FediPodServerHandler",
+      "extends": [
+        "css:dist/server/HttpHandler.jsonld#HttpHandler",
+        "css:dist/init/Initializable.jsonld#Initializable",
+        "css:dist/init/final/Finalizable.jsonld#Finalizable"
+      ],
+      "parameters": [
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_resourceStore",
+          "range": "css:dist/storage/ResourceStore.jsonld#ResourceStore",
+          "comment": "The server's ResourceStore: the handler reads pods and writes inbox items and directory rows directly through it — no HTTP, no credential."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_frontHost",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "The apex host the front answers on, e.g. fedipod.net. Defaults to the host of frontOrigin, so a server that sets nothing answers on its own address. Pod subdomains are never claimed."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_frontOrigin",
+          "range": "xsd:string",
+          "comment": "The front's origin, e.g. https://fedipod.net."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_directoryContainer",
+          "range": "xsd:string",
+          "comment": "An internal container URL where the handle→pod directory rows live."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_gatewayWebId",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "The WebID stamped on verification receipts."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_offersPods",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Whether this host also offers pods (the signup page shows the take-one option). The front never hosts pods itself."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_signupPage",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "The new-account page HTML served at the root."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_runPage",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "The run-your-identity page HTML served at /run."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentDataDir",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Directory holding each agent identity's signing key and log. Required when runtime opt-in is on."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentWebIdSuffix",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Path from a pod's base to the owner's WebID."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentPollSeconds",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:number",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Seconds between inbox sweeps. Deliveries also wake the sweep as they land."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentAutoAcceptFollows",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Whether a newly provisioned identity accepts follows without review."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_clusterManager",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "css:dist/init/cluster/ClusterManager.jsonld#ClusterManager",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "The server's cluster manager, so the agent can say when it is running blind to other workers' writes."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentUiPath",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Path on a pod's origin where its owner's pages live. Empty serves no pages at all."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentRuntimeOptIn",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Whether a pod owner may opt in at runtime by proving control of their pod. Off unless the host chooses it."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentAutoFront",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "When this server also runs the door, give each identity a @handle@frontHost address as it starts — an inbox-only directory row, written once. The actor keeps its own ids on the pod. Off by default."
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentRegistryContainer",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "An internal container URL where the runtime opt-in rows live."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_args",
+          "memberFieldName": "args"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_io",
+          "memberFieldName": "io"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_dir",
+          "memberFieldName": "dir",
+          "range": "fps:dist/directory.jsonld#Directory"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_podPut",
+          "memberFieldName": "podPut"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_logger",
+          "memberFieldName": "logger"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_agentHosts",
+          "memberFieldName": "agentHosts"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_agentHandles",
+          "memberFieldName": "agentHandles"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_frontHost",
+          "memberFieldName": "frontHost"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_uiPath",
+          "memberFieldName": "uiPath"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_identities",
+          "memberFieldName": "identities"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_surfaces",
+          "memberFieldName": "surfaces"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_registry",
+          "memberFieldName": "registry"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_doorSecrets",
+          "memberFieldName": "doorSecrets"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_starting",
+          "memberFieldName": "starting"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_startCancelled",
+          "memberFieldName": "startCancelled"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_stopping",
+          "memberFieldName": "stopping"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_onSignal",
+          "memberFieldName": "onSignal"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_validateAgentHost",
+          "memberFieldName": "validateAgentHost"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_initialize",
+          "memberFieldName": "initialize"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_finalize",
+          "memberFieldName": "finalize"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_startIdentity",
+          "memberFieldName": "startIdentity"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_frontIdentity",
+          "memberFieldName": "frontIdentity"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_canHandle",
+          "memberFieldName": "canHandle"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_surfaceFor",
+          "memberFieldName": "surfaceFor"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_optInPod",
+          "memberFieldName": "optInPod"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_optOutPod",
+          "memberFieldName": "optOutPod"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler__member_handle",
+          "memberFieldName": "handle"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "resourceStore",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_resourceStore"
+              }
+            },
+            {
+              "keyRaw": "frontHost",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_frontHost"
+              }
+            },
+            {
+              "keyRaw": "frontOrigin",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_frontOrigin"
+              }
+            },
+            {
+              "keyRaw": "directoryContainer",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_directoryContainer"
+              }
+            },
+            {
+              "keyRaw": "gatewayWebId",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_gatewayWebId"
+              }
+            },
+            {
+              "keyRaw": "offersPods",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_offersPods"
+              }
+            },
+            {
+              "keyRaw": "signupPage",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_signupPage"
+              }
+            },
+            {
+              "keyRaw": "runPage",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_runPage"
+              }
+            },
+            {
+              "keyRaw": "agentDataDir",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentDataDir"
+              }
+            },
+            {
+              "keyRaw": "agentWebIdSuffix",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentWebIdSuffix"
+              }
+            },
+            {
+              "keyRaw": "agentPollSeconds",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentPollSeconds"
+              }
+            },
+            {
+              "keyRaw": "agentAutoAcceptFollows",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentAutoAcceptFollows"
+              }
+            },
+            {
+              "keyRaw": "clusterManager",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_clusterManager"
+              }
+            },
+            {
+              "keyRaw": "agentUiPath",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentUiPath"
+              }
+            },
+            {
+              "keyRaw": "agentRuntimeOptIn",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentRuntimeOptIn"
+              }
+            },
+            {
+              "keyRaw": "agentAutoFront",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentAutoFront"
+              }
+            },
+            {
+              "keyRaw": "agentRegistryContainer",
+              "value": {
+                "@id": "fps:dist/handler.jsonld#FediPodServerHandler_args_agentRegistryContainer"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "fps:dist/handler.jsonld#FediPodServerArgs",
+      "@type": "AbstractClass",
+      "requireElement": "FediPodServerArgs",
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_resourceStore",
+          "memberFieldName": "resourceStore"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_frontHost",
+          "memberFieldName": "frontHost"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_frontOrigin",
+          "memberFieldName": "frontOrigin"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_directoryContainer",
+          "memberFieldName": "directoryContainer"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_gatewayWebId",
+          "memberFieldName": "gatewayWebId"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_offersPods",
+          "memberFieldName": "offersPods"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_signupPage",
+          "memberFieldName": "signupPage"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_runPage",
+          "memberFieldName": "runPage"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentDataDir",
+          "memberFieldName": "agentDataDir"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentWebIdSuffix",
+          "memberFieldName": "agentWebIdSuffix"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentPollSeconds",
+          "memberFieldName": "agentPollSeconds"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentAutoAcceptFollows",
+          "memberFieldName": "agentAutoAcceptFollows"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_clusterManager",
+          "memberFieldName": "clusterManager"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentUiPath",
+          "memberFieldName": "agentUiPath"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentRuntimeOptIn",
+          "memberFieldName": "agentRuntimeOptIn"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentAutoFront",
+          "memberFieldName": "agentAutoFront"
+        },
+        {
+          "@id": "fps:dist/handler.jsonld#FediPodServerArgs__member_agentRegistryContainer",
+          "memberFieldName": "agentRegistryContainer"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { FediPodServerHandler } from './handler';
+export type { FediPodServerArgs } from './handler';
+export { FediPodStreamingHandler } from './streaming-handler';
+export type { FediPodStreamingArgs } from './streaming-handler';

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FediPodStreamingHandler = exports.FediPodServerHandler = void 0;
+// Public entry: the class Components.js instantiates. The pure helpers are
+// imported by the package's own tests directly from their built modules, so
+// they are deliberately NOT re-exported here — the generator would otherwise
+// try to treat the helper functions as components.
+var handler_1 = require("./handler");
+Object.defineProperty(exports, "FediPodServerHandler", { enumerable: true, get: function () { return handler_1.FediPodServerHandler; } });
+var streaming_handler_1 = require("./streaming-handler");
+Object.defineProperty(exports, "FediPodStreamingHandler", { enumerable: true, get: function () { return streaming_handler_1.FediPodStreamingHandler; } });

package/dist/store-css.d.ts

@@ -0,0 +1,3 @@
+import type { ResourceStore } from '@solid/community-server';
+import type { IO } from './directory';
+export declare function makeStoreIO(resourceStore: ResourceStore): IO;

package/dist/store-css.js

@@ -0,0 +1,41 @@
+"use strict";
+// store-css.ts — the real IO over CSS's ResourceStore: the only file that
+// imports CSS. Turns the store's Representation-based API into the tiny
+// { read, write } shape the directory and podPut are written against.
+//
+// Writing here bypasses WAC by design: the lowest store assumes the necessary
+// Solid checks were already made, and the gateway handler is the thing that
+// made them — it only ever writes verified mail into an inbox, or a directory
+// row into the gateway's own internal container.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeStoreIO = makeStoreIO;
+const community_server_1 = require("@solid/community-server");
+function makeStoreIO(resourceStore) {
+    return {
+        async read(url) {
+            try {
+                const rep = await resourceStore.getRepresentation({ path: url }, {});
+                return await (0, community_server_1.readableToString)(rep.data);
+            }
+            catch (e) {
+                if (community_server_1.NotFoundHttpError.isInstance?.(e) || e?.statusCode === 404)
+                    return null;
+                throw e;
+            }
+        },
+        async write(url, body, contentType) {
+            const rep = new community_server_1.BasicRepresentation(body, { path: url }, contentType);
+            await resourceStore.setRepresentation({ path: url }, rep);
+        },
+        async remove(url) {
+            try {
+                await resourceStore.deleteResource({ path: url });
+            }
+            catch (e) {
+                if (community_server_1.NotFoundHttpError.isInstance?.(e) || e?.statusCode === 404)
+                    return;
+                throw e;
+            }
+        },
+    };
+}

package/dist/store-pod.d.ts

@@ -0,0 +1,20 @@
+import type { ResourceStore } from '@solid/community-server';
+export interface StoreFetchStats {
+    reads: number;
+    writes: number;
+    deletes: number;
+}
+export interface StoreFetch {
+    (url: string, init?: RequestInit): Promise<Response>;
+    stats: () => StoreFetchStats;
+}
+export declare function makeStoreFetch(resourceStore: ResourceStore, podBase?: string): StoreFetch;
+/**
+ * The session shape RemotePod consumes — the same three members its
+ * credential-backed session has, so the class itself needs no other change.
+ */
+export declare function makeStoreSession(resourceStore: ResourceStore, podBase?: string): {
+    fetch: StoreFetch;
+    warmup: () => Promise<void>;
+    stats: () => StoreFetchStats;
+};