@skillcdn/console 0.4.0 → 0.4.2

package/src/data.ts

@@ -39,12 +39,14 @@ import {
   type RestPerson,
   type RestPersonPatch,
   type RestPersonWork,
+  type RestPlugin,
   type RestProject,
   type RestProjectInput,
   type RestProjectPatch,
   type RestProjectRules,
   type RestRules,
   type RestRulesInput,
+  type RestRulesPlugin,
   type RestRun,
   type RestSkills,
   type RestTask,
@@ -66,12 +68,12 @@ import {
 
 // What the console shows, and how it stays current: the workspace (who is signed in, the
 // projects, the people, the tokens) is loaded once; the project the page is on is loaded whole,
-// its feed from the beginning, and from then on the project's stream says when something
+// its feed as it stands, the newest page, and from then on the project's stream says when something
 // changed: on every event the lists are loaded again, which is the boring way to be right.
 
 /** How many events the feed keeps on the page. */
 const FEED_KEEP = 200;
-/** How many pages of the feed are read at the start before the stream takes over. */
+/** How many pages of a task's own events are read for its thread, which is read from the beginning. */
 const FEED_MAX_PAGES = 20;
 /** How long changes that arrive together are gathered before the lists are loaded once. */
 const RELOAD_DELAY_MS = 150;
@@ -89,8 +91,10 @@ export interface ConsoleActions {
   removePackToken(): Promise<RestProject>;
   /** Asks the deployment to connect the project's pack with a code a person approves (ADR-0036); for an owner. */
   connectPackToken(): Promise<RestPackConnectStarted>;
-  /** How that connection stands; once connected, the project is the one answered. */
+  /** How that connection stands, read and changed nothing. */
   packTokenConnection(signal?: AbortSignal): Promise<RestPackConnect>;
+  /** Asks the console to claim the token at the deployment (ADR-0046); once connected, the project is the one answered. */
+  claimPackTokenConnection(signal?: AbortSignal): Promise<RestPackConnect>;
   cancelPackTokenConnection(): Promise<void>;
   addMember(input: RestMemberInput): Promise<RestMember>;
   updateMember(personId: string, patch: RestMemberPatch): Promise<RestMember>;
@@ -177,6 +181,7 @@ export interface ConsoleActions {
   removeWorkspacePackToken(): Promise<RestWorkspace>;
   connectWorkspacePackToken(): Promise<RestPackConnectStarted>;
   workspacePackTokenConnection(signal?: AbortSignal): Promise<RestWorkspacePackConnect>;
+  claimWorkspacePackTokenConnection(signal?: AbortSignal): Promise<RestWorkspacePackConnect>;
   cancelWorkspacePackTokenConnection(): Promise<void>;
   /** One person of the workspace by their exact login, or nobody: what an owner lists someone the People page does not show by. */
   findPerson(login: string, signal?: AbortSignal): Promise<RestPerson | undefined>;
@@ -195,6 +200,8 @@ export interface ConsoleActions {
   connectRequest(code: string, signal?: AbortSignal): Promise<RestConnectRequest>;
   approveConnection(code: string, input: RestTokenInput): Promise<RestConnectRequest>;
   denyConnection(code: string): Promise<void>;
+  /** Reads the plugins again: after one was enabled, configured or disabled on the settings. */
+  refreshPlugins(): Promise<void>;
   /** Another person's plate: for an administrator, or an owner of a project they are in. */
   personWork(personId: string, signal?: AbortSignal): Promise<RestPersonWork>;
   /** The tokens of another person, and the way to take one away: for an administrator. */
@@ -220,6 +227,8 @@ export interface ConsoleData {
   readonly organization: RestOrganization | null;
   /** The categories tasks are sorted into, by name. */
   readonly categories: readonly RestCategory[];
+  /** The plugins the person may know of (docs/specs/plugins.md), by key: the enabled ones, every one for an administrator. */
+  readonly plugins: readonly RestPlugin[];
   /** The tokens of whoever is signed in, newest first. */
   readonly tokens: readonly RestToken[];
   /** The project the page is on, once loaded; `undefined` while loading, or when the page is on none. */
@@ -242,28 +251,25 @@ export interface ConsoleData {
   readonly members: readonly RestMember[];
   /** The project's skills, as the console answered; `undefined` until it has. */
   readonly skills: RestSkills | undefined;
+  /** The plugins bound to the project that the person holds a role in, as the rules name them. */
+  readonly projectPlugins: readonly RestRulesPlugin[];
   readonly actions: ConsoleActions;
   /** Asks everything again, from who is signed in on. */
   reload(): void;
 }
 
-/** The whole feed of a project from the beginning, page by page, bounded. */
+/**
+ * The feed of a project as it stands: its newest page, oldest first, from which the stream
+ * goes on. Read in one request, where reading it from the beginning was a round trip per
+ * hundred events, each waited for before the board was shown.
+ */
 async function readFeed(
   client: ConsoleClient,
   key: string,
   signal: AbortSignal,
 ): Promise<RestEvent[]> {
-  const events: RestEvent[] = [];
-  let after = 0;
-  for (let page = 0; page < FEED_MAX_PAGES; page += 1) {
-    const result = await client.project(key).events(after, {}, signal);
-    events.push(...result.items);
-    after = result.items.at(-1)?.id ?? after;
-    if (!result.more) {
-      break;
-    }
-  }
-  return events.slice(-FEED_KEEP);
+  const result = await client.project(key).events(0, { latest: true }, signal);
+  return result.items.slice(-FEED_KEEP);
 }
 
 /** How many pages of the current tasks are read before the board is shown as it stands. */
@@ -356,6 +362,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
   const [listed, setListed] = useState<readonly RestListing[]>([]);
   const [organization, setOrganization] = useState<RestOrganization | null>(null);
   const [categories, setCategories] = useState<readonly RestCategory[]>([]);
+  const [plugins, setPlugins] = useState<readonly RestPlugin[]>([]);
   const [tokens, setTokens] = useState<readonly RestToken[]>([]);
   const [project, setProject] = useState<RestProject | undefined>(undefined);
   const [projectLoaded, setProjectLoaded] = useState(false);
@@ -368,6 +375,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
   const [events, setEvents] = useState<readonly RestEvent[]>([]);
   const [members, setMembers] = useState<readonly RestMember[]>([]);
   const [skills, setSkills] = useState<RestSkills | undefined>(undefined);
+  const [projectPlugins, setProjectPlugins] = useState<readonly RestRulesPlugin[]>([]);
   const [generation, setGeneration] = useState(0);
   const lastEvent = useRef(0);
   const signedIn = me?.person !== null && me !== undefined;
@@ -377,10 +385,12 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
   /** Loads the workspace's lists again. What fails stays as it was. */
   const refreshWorkspace = useCallback(
     async (signal?: AbortSignal) => {
-      const [nextProjects, nextPeople, nextCategories] = await Promise.all([
+      const [nextProjects, nextPeople, nextCategories, nextPlugins] = await Promise.all([
         client.projects(signal),
         client.people(signal),
         client.categories(signal),
+        // A console without plugins answers none; one older than them answers nothing, which is none too.
+        client.plugins(signal).catch(() => ({ items: [], sql: false })),
       ]);
       if (signal?.aborted === true) {
         return;
@@ -390,6 +400,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
       setListed(nextPeople.listed);
       setOrganization(nextPeople.organization);
       setCategories(nextCategories.items);
+      setPlugins(nextPlugins.items);
     },
     [client],
   );
@@ -401,7 +412,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
         return;
       }
       const scope = client.project(projectKey);
-      const [nextProject, nextTasks, nextDecisions, nextGoals, nextRuns, nextMembers] =
+      const [nextProject, nextTasks, nextDecisions, nextGoals, nextRuns, nextMembers, nextPlugins] =
         await Promise.all([
           scope.get(signal),
           readTasks(scope, signal),
@@ -409,6 +420,11 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
           readGoals(scope, signal),
           scope.runs(undefined, signal),
           scope.members(signal),
+          // The plugins bound to the project come with its rules; a console older than them names none.
+          scope
+            .rules(signal)
+            .then((rules) => rules.plugins ?? [])
+            .catch((): readonly RestRulesPlugin[] => []),
         ]);
       if (signal?.aborted === true) {
         return;
@@ -419,6 +435,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
       setGoals(nextGoals.items);
       setRuns(nextRuns.items);
       setMembers(nextMembers.items);
+      setProjectPlugins(nextPlugins);
     },
     [client, projectKey],
   );
@@ -468,7 +485,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
     return () => controller.abort();
   }, [client, generation, refreshWorkspace]);
 
-  // The project the page is on: its lists, its feed from the beginning, and its stream from
+  // The project the page is on: its lists, its feed as it stands, the newest page, and its stream from
   // where the feed ends. Another project, or none, starts over.
   // biome-ignore lint/correctness/useExhaustiveDependencies: `generation` is the trigger
   useEffect(() => {
@@ -482,6 +499,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
     setEvents([]);
     setMembers([]);
     setSkills(undefined);
+    setProjectPlugins([]);
     setLive(false);
     if (projectKey === undefined || !signedIn) {
       return;
@@ -612,8 +630,9 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
         return changed;
       },
       connectPackToken: () => scope().connectPackToken(),
-      async packTokenConnection(signal) {
-        const state = await scope().packTokenConnection(signal);
+      packTokenConnection: (signal) => scope().packTokenConnection(signal),
+      async claimPackTokenConnection(signal) {
+        const state = await scope().claimPackTokenConnection(signal);
         if (state.status === "connected") {
           setProject(state.project);
         }
@@ -756,8 +775,9 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
         return workspace;
       },
       connectWorkspacePackToken: () => client.connectWorkspacePackToken(),
-      async workspacePackTokenConnection(signal) {
-        const state = await client.workspacePackTokenConnection(signal);
+      workspacePackTokenConnection: (signal) => client.workspacePackTokenConnection(signal),
+      async claimWorkspacePackTokenConnection(signal) {
+        const state = await client.claimWorkspacePackTokenConnection(signal);
         if (state.status === "connected") {
           const { workspace } = state;
           setMe((current) => (current === undefined ? undefined : { ...current, workspace }));
@@ -766,6 +786,9 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
       },
       cancelWorkspacePackTokenConnection: () => client.cancelWorkspacePackTokenConnection(),
       findPerson: (login, signal) => client.findPerson(login, signal),
+      async refreshPlugins() {
+        setPlugins((await client.plugins()).items);
+      },
       async abandonRun(id) {
         const run = await scope().endRun(id, { status: "abandoned" });
         await refreshProject();
@@ -822,6 +845,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
     listed,
     organization,
     categories,
+    plugins,
     tokens,
     project,
     projectLoaded,
@@ -834,6 +858,7 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
     events,
     members,
     skills,
+    projectPlugins,
     actions,
     reload,
   };

package/src/i18n/en.ts

@@ -29,6 +29,15 @@ export const en = {
   label: "English",
 
   vocabulary: {
+    /** The states of a plugin (docs/specs/plugins.md, "Lifecycle"). */
+    pluginState: {
+      installed: "Installed",
+      enabled: "Enabled",
+      needs_consent: "Needs consent",
+      disabled: "Disabled",
+      failed: "Failed",
+      orphaned: "Orphaned",
+    } as Record<string, string>,
     state: {
       idea: "Idea",
       ready: "Ready",
@@ -143,6 +152,138 @@ export const en = {
     skills: "Skills",
     members: "Members",
     settings: "Settings",
+    plugins: "Plugins",
+    /** The groups of tabs the console knows (docs/specs/plugins.md, "Tabs, sub-tabs and addresses"). */
+    pluginGroups: {
+      people: "People",
+      customers: "Customers",
+      money: "Money",
+      operations: "Operations",
+      marketing: "Marketing",
+      engineering: "Engineering",
+      reports: "Reports",
+    } as Record<string, string>,
+  },
+
+  plugins: {
+    frame: (name: string) => `${name}, a plugin's page`,
+    noPage: {
+      title: "Nothing here",
+      body: "This plugin has no page you may see, or it is not on this project.",
+    },
+    settings: {
+      title: "Plugins",
+      empty: { title: "No plugins", body: "None is installed in this console's image." },
+      none: "The console has no plugins directory: none can be installed.",
+      about: "About",
+      problems: "Why it cannot run",
+      nothing: "None",
+      capabilities: "Capabilities",
+      board: "Board project",
+      boardHint: "Where its decisions, tasks and pages go.",
+      boardNone: "None",
+      boardCreate: "A new project",
+      boardChoose: "An existing project",
+      boardKey: "Key",
+      boardName: "Name",
+      boardDescription: "Description",
+      projects: "Projects",
+      projectsAll: "Every project",
+      projectsSome: "Some projects",
+      settingsForm: "Settings",
+      secretSet: (when: string) => `Set ${when}`,
+      secretUnset: "Not set",
+      secretNew: "New value",
+      enable: "Enable",
+      disable: "Disable",
+      roles: "Roles",
+      rolesNone: "No roles: every member may use it.",
+      roleDefault: "Default",
+      everyMember: "Every member",
+      grantEveryone: "Everyone",
+      grantMembersOf: (project: string) => `Members of ${project}`,
+      grantPeople: "People",
+      grantProjects: "Members of a project",
+      grantWhom: "Grant to…",
+      grant: "Grant",
+      revoke: "Revoke",
+      events: "What happened",
+      noEvents: "Nothing yet.",
+      data: "Data",
+      export: "Export",
+      exportHint: "Its records and their versions, as JSON Lines.",
+      exportLink: "Download",
+      purge: "Purge",
+      purgeHint:
+        "Removes its records, files, grants and secrets from the console. What it put on the board stays.",
+      purgeDisabledFirst: "Disable it first.",
+      purgeConfirm: (key: string) => `Type ${key}`,
+      purged: "Purged.",
+      agentNote: "For agents",
+      operations: "Commands and queries",
+    },
+    /** The capabilities (docs/specs/plugins.md, "Capabilities"), each by a name and the sentence of what it opens, as an administrator reads them before consenting. */
+    capability: {
+      files: {
+        name: "Files",
+        opens: "Keeps files on its records, within the bytes the deployment allows.",
+      },
+      "people:read": { name: "People", opens: "Reads the people the person may see." },
+      "people:read:all": {
+        name: "Everyone",
+        opens: "Reads everyone in the workspace, from its jobs and hooks too.",
+      },
+      "projects:read": {
+        name: "Projects",
+        opens: "Reads the projects and members the person may see.",
+      },
+      "projects:read:all": {
+        name: "Every project",
+        opens: "Reads every project and its members.",
+      },
+      "board:read": {
+        name: "Board",
+        opens:
+          "Reads the tasks, decisions, runs, pages and events of its board projects, and of the project a call is on.",
+      },
+      "board:tasks": {
+        name: "Tasks",
+        opens: "Creates tasks in its projects; changes, closes and comments on its own.",
+      },
+      "board:decisions": {
+        name: "Decisions",
+        opens: "Raises decisions in its projects and reads the answers to its own.",
+      },
+      "board:documents": {
+        name: "Pages",
+        opens: "Writes pages in a folder of its own in its projects.",
+      },
+      "events:console": {
+        name: "Console events",
+        opens: "Runs hooks on what happens in its board projects.",
+      },
+      "events:plugins": {
+        name: "Other plugins' events",
+        opens: "Runs hooks on the events other plugins emit.",
+      },
+      jobs: { name: "Schedule", opens: "Runs at the times it names." },
+      endpoints: {
+        name: "Inbound requests",
+        opens: "Takes requests under its own path, a person's or a webhook's.",
+      },
+      "storage:sql": {
+        name: "Own database schema",
+        opens: "Gets a schema and a login role of its own in the console's database.",
+      },
+      outbound: (host: string) => ({
+        name: `Requests to ${host}`,
+        opens: `Sends https requests to ${host}.`,
+      }),
+      plugins: (key: string) => ({
+        name: `Plugin ${key}`,
+        opens: `Calls the API of the plugin ${key}, as the person.`,
+      }),
+    },
   },
 
   shell: {
@@ -157,7 +298,15 @@ export const en = {
 
   signIn: {
     lead: "Join an organization made of AI agents.",
-    continueWith: (provider: string) => `Continue with ${provider}`,
+    signInWith: (provider: string) => `Sign in with ${provider}`,
+    /** The button while the browser is on its way to the provider. */
+    going: (provider: string) => `Going to ${provider}…`,
+    /** The line under a button: who gets in through that way. */
+    admits: {
+      organization: (name: string) => `For the members of ${name}, the organization at GitHub.`,
+      domains: (domains: string) => `For accounts at ${domains}.`,
+      listed: "For the people an administrator added.",
+    },
     nobody: {
       title: "Nobody can sign in here yet",
       body: "Signing in is not configured on this console. Whoever runs it sets it up as deploy/README.md describes.",
@@ -176,6 +325,8 @@ export const en = {
     empty: {
       title: "No projects yet",
       body: "Make the first one: what it is for, and who is in it. Or ask an owner to add you to theirs.",
+      bodyMember:
+        "An administrator makes the projects. Ask one for the first, or an owner to add you to theirs.",
     },
     list: "Projects",
     private: "Private",
@@ -585,6 +736,8 @@ export const en = {
     workspace: {
       title: "Workspace",
       aria: "Workspace settings",
+      consoleVersion: "Console version",
+      consoleTakes: (range: string) => `Takes the console command ${range}`,
       peopleVisibility: "Member visibility",
       peopleVisibilityHint:
         "Whom a member sees on the People page and in the pickers: everyone of the workspace, or only the people they share a project with. An administrator always sees everyone, and a project open to the workspace has everyone in it.",
@@ -630,6 +783,17 @@ export const en = {
     as: (agent: string) => `as ${agent}`,
     asTitle: "The agent the person acted through",
     aTask: "a task",
+    aPlugin: "a plugin",
+    /** After the sentence of a board's event a plugin caused (ADR-0052). */
+    throughPlugin: (plugin: string) => `through the plugin ${plugin}`,
+    everyone: "everyone",
+    membersOf: (project: string) => `the members of ${project}`,
+    outcome: {
+      ok: "done",
+      refused: "refused",
+      waiting: "waiting for a decision",
+      failed: "failed",
+    } as Readonly<Record<string, string>>,
     aProject: "a project",
     someone: "someone",
     something: "something",
@@ -715,6 +879,20 @@ export const en = {
       documentArchived: (page: string) => `archived ${page}`,
       documentRestored: (page: string) => `restored ${page}`,
       fileAttached: (label: string, page: string) => `attached ${label} to ${page}`,
+      pluginEnabled: (plugin: string) => `enabled the plugin ${plugin}`,
+      pluginDisabled: (plugin: string) => `disabled the plugin ${plugin}`,
+      pluginConfigured: (fields: string, plugin: string) =>
+        `changed ${fields} of the plugin ${plugin}`,
+      pluginGranted: (role: string, who: string, plugin: string) =>
+        `gave ${who} the role ${role} in the plugin ${plugin}`,
+      pluginRevoked: (role: string, who: string, plugin: string) =>
+        `took the role ${role} from ${who} in the plugin ${plugin}`,
+      pluginUpgraded: (plugin: string, version: string) =>
+        `brought the plugin ${plugin} to ${version}`,
+      pluginCommand: (command: string, plugin: string, outcome: string) =>
+        `ran ${command} of the plugin ${plugin}: ${outcome}`,
+      pluginPurged: (plugin: string) => `purged the plugin ${plugin}: everything it kept is gone`,
+      pluginFailed: (plugin: string, problem: string) => `the plugin ${plugin} failed: ${problem}`,
     },
   },
 
@@ -889,6 +1067,10 @@ export const en = {
       domain: "Of the domain",
       listed: "Added by an administrator",
     } satisfies Record<MembershipSource, string>,
+    /** A person the organization let in, by the organization's name: never read as their own. */
+    ofOrganization: (name: string) => `Member of ${name}`,
+    /** A person a Workspace domain let in, by the domain of their login. */
+    ofDomain: (domain: string) => `Account at ${domain}`,
     at: { gh: "at GitHub", google: "at Google" } satisfies Record<ProviderKey, string>,
     organization: (name: string) => `The organization ${name} at GitHub says who is in.`,
     organizationRead: "Last read",