@skillcdn/console 0.1.10 → 0.1.11

package/src/data.ts

@@ -58,10 +58,13 @@ const FEED_MAX_PAGES = 20;
 const RELOAD_DELAY_MS = 150;
 
 export interface ConsoleActions {
-  /** Makes a project, whose owner the person becomes. */
-  createProject(input: RestProjectInput): Promise<RestProject>;
+  /** Makes a project, whose owner the person becomes, with an image for its mark when one is given. */
+  createProject(input: RestProjectInput, icon?: FileUpload): Promise<RestProject>;
   /** Changes the settings of the project the page is on; for an owner. */
   updateProject(patch: RestProjectPatch): Promise<RestProject>;
+  /** Sets the image for the mark of the project the page is on, or takes it away; for an owner. */
+  setProjectIcon(input: FileUpload): Promise<RestProject>;
+  removeProjectIcon(): Promise<RestProject>;
   addMember(input: RestMemberInput): Promise<RestMember>;
   updateMember(personId: string, patch: RestMemberPatch): Promise<RestMember>;
   removeMember(personId: string): Promise<void>;
@@ -387,10 +390,11 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
       return client.project(projectKey);
     };
     return {
-      async createProject(input) {
+      async createProject(input, icon) {
         const made = await client.createProject(input);
+        const marked = icon === undefined ? made : await client.project(made.key).setIcon(icon);
         await refreshWorkspace();
-        return made;
+        return marked;
       },
       async updateProject(patch) {
         const changed = await scope().update(patch);
@@ -398,6 +402,18 @@ export function useConsoleData(client: ConsoleClient, projectKey: string | undef
         await refreshWorkspace();
         return changed;
       },
+      async setProjectIcon(input) {
+        const changed = await scope().setIcon(input);
+        setProject(changed);
+        await refreshWorkspace();
+        return changed;
+      },
+      async removeProjectIcon() {
+        const changed = await scope().removeIcon();
+        setProject(changed);
+        await refreshWorkspace();
+        return changed;
+      },
       async addMember(input) {
         const member = await scope().addMember(input);
         await refreshProject();

package/src/i18n/en.ts

@@ -43,7 +43,7 @@ export const en = {
       private: "Only those listed",
     } satisfies Record<ProjectVisibility, string>,
     runStatus: {
-      running: "At work",
+      running: "Open",
       waiting: "Waiting for a decision",
       finished: "Finished",
       failed: "Failed",
@@ -95,6 +95,7 @@ export const en = {
     nobody: "Nobody",
     nothing: "Nothing",
     language: "Language",
+    showMore: (n: number, of: number) => `Show ${n} more of ${of}`,
   },
 
   nav: {
@@ -150,7 +151,6 @@ export const en = {
     list: "Projects",
     private: "Private",
     decisionsWaiting: (n: number) => `${count(n, "decision", "decisions")} waiting`,
-    agentsAtWork: (n: number) => `${count(n, "agent", "agents")} at work`,
     form: {
       aria: "New project",
       name: "Name",
@@ -162,6 +162,11 @@ export const en = {
       whoIsMember: "Who is a member",
       skillsAddress: "Skills address",
       skillsAddressPlaceholder: "/gh/<owner>/<repo>, or empty for the organization's",
+      symbol: "Mark",
+      image: "Image",
+      imageRemove: "Remove the image",
+      color: "Colour",
+      colorAuto: "Chosen from the key",
       make: "Make the project",
     },
     members: {
@@ -207,9 +212,6 @@ export const en = {
     moveTo: "Move to",
     decisions: (n: number) => count(n, "decision", "decisions"),
     decisionsTitle: "Decisions waiting for a person",
-    agentAtWork: "agent at work",
-    agentAtWorkTitle: "An agent is at work on it",
-    agentSince: (agent: string, since: string) => `${agent}, at work since ${since}`,
     filters: {
       aria: "Narrow the board",
       everyone: "Everyone",
@@ -247,7 +249,6 @@ export const en = {
     raiseDecision: "Raise a decision",
     nothingMore: "Nothing more was written about it.",
     links: "Links",
-    agentsAtWork: "Agents at work",
     runs: "Runs",
     decisions: "Decisions",
     history: "What happened",
@@ -336,8 +337,10 @@ export const en = {
 
   calendar: {
     title: "Calendar",
-    lead: "The tasks by the day they are due. A task with a start is shown from it; one with no day waits at the bottom to be given one.",
+    lead: "The tasks on their days: planned from a start to a due day, a task lies across them; due on a day alone, it sits on it. One with no day waits at the bottom to be given one.",
     grid: "The month",
+    legend: { title: "Category colours" },
+    startsOnly: "Starts that day, with no due day yet",
     previous: "The month before",
     next: "The month after",
     thisMonth: "This month",
@@ -346,7 +349,6 @@ export const en = {
     nothingOverdue: "Nothing is overdue.",
     unscheduled: "No day set",
     allScheduled: "Every open task has a day.",
-    starts: "starts",
     workload: {
       title: "Who has what",
       lead: "The open tasks of each person, and what of them is late or due within the week.",
@@ -509,6 +511,7 @@ export const en = {
       runReported: (task: string, excerpt: string | undefined) =>
         `reported on ${task}${excerpt === undefined ? "" : `: ${excerpt}`}`,
       runHandedIn: (label: string, task: string) => `handed in ${label} on ${task}`,
+      runTakenOver: (task: string, agent: string) => `took over ${task} from ${agent}`,
       runFinished: (task: string) => `finished ${task}`,
       runFailed: (task: string) => `failed on ${task}`,
       runAbandoned: (task: string) => `gave up on ${task}`,
@@ -524,6 +527,7 @@ export const en = {
     for: "for",
     since: "since",
     until: "until",
+    lastHeard: "last heard",
     markAbandoned: "Mark abandoned",
     waitingForDecision: "Waiting for a decision",
     answerIt: "answer it",

package/src/i18n/ko.ts

@@ -21,7 +21,7 @@ export const ko: Messages = {
     projectRole: { owner: "소유자", member: "멤버" },
     visibility: { workspace: "워크스페이스의 모두", private: "목록에 있는 사람만" },
     runStatus: {
-      running: "작업 중",
+      running: "열림",
       waiting: "결정 대기 중",
       finished: "완료",
       failed: "실패",
@@ -68,6 +68,7 @@ export const ko: Messages = {
     nobody: "없음",
     nothing: "없음",
     language: "언어",
+    showMore: (n, of) => `${of}개 중 ${n}개 더 보기`,
   },
 
   nav: {
@@ -123,7 +124,6 @@ export const ko: Messages = {
     list: "프로젝트",
     private: "비공개",
     decisionsWaiting: (n) => `결정 ${n}건 대기 중`,
-    agentsAtWork: (n) => `에이전트 ${n}개 작업 중`,
     form: {
       aria: "새 프로젝트",
       name: "이름",
@@ -134,6 +134,11 @@ export const ko: Messages = {
       whoIsMember: "멤버 범위",
       skillsAddress: "스킬 주소",
       skillsAddressPlaceholder: "/gh/<owner>/<repo>, 비우면 조직의 스킬",
+      symbol: "마크",
+      image: "이미지",
+      imageRemove: "이미지 지우기",
+      color: "색",
+      colorAuto: "키에서 정해진 색",
       make: "프로젝트 만들기",
     },
     members: {
@@ -179,9 +184,6 @@ export const ko: Messages = {
     moveTo: "이동",
     decisions: (n) => `결정 ${n}건`,
     decisionsTitle: "사람을 기다리는 결정",
-    agentAtWork: "에이전트 작업 중",
-    agentAtWorkTitle: "에이전트가 이 작업을 하고 있습니다",
-    agentSince: (agent, since) => `${agent}, ${since}부터 작업 중`,
     filters: {
       aria: "보드 좁혀 보기",
       everyone: "모두",
@@ -219,7 +221,6 @@ export const ko: Messages = {
     raiseDecision: "결정 요청",
     nothingMore: "더 적힌 내용이 없습니다.",
     links: "링크",
-    agentsAtWork: "작업 중인 에이전트",
     runs: "실행",
     decisions: "결정",
     history: "일어난 일",
@@ -308,8 +309,10 @@ export const ko: Messages = {
 
   calendar: {
     title: "캘린더",
-    lead: "작업을 기한일에 놓고 봅니다. 시작일이 있는 작업은 그날부터 보이고, 날짜가 없는 작업은 아래에서 날짜를 기다립니다.",
+    lead: "작업을 날짜 위에 놓고 봅니다. 시작일과 기한이 있는 작업은 그 기간에 걸쳐 놓이고, 기한만 있는 작업은 그날에 놓입니다. 날짜가 없는 작업은 아래에서 날짜를 기다립니다.",
     grid: "이 달",
+    legend: { title: "카테고리 색" },
+    startsOnly: "그날 시작, 기한은 아직 없음",
     previous: "이전 달",
     next: "다음 달",
     thisMonth: "이번 달",
@@ -318,7 +321,6 @@ export const ko: Messages = {
     nothingOverdue: "기한이 지난 작업이 없습니다.",
     unscheduled: "날짜 없음",
     allScheduled: "열린 작업마다 날짜가 있습니다.",
-    starts: "시작",
     workload: {
       title: "누가 무엇을",
       lead: "사람마다 열린 작업과, 그중 늦은 것과 일주일 안에 마감인 것.",
@@ -477,6 +479,7 @@ export const ko: Messages = {
       runReported: (task, excerpt) =>
         `${task}에 보고했습니다${excerpt === undefined ? "" : `: ${excerpt}`}`,
       runHandedIn: (label, task) => `${task}에 ${label}을(를) 제출했습니다`,
+      runTakenOver: (task, agent) => `${agent}에게서 ${task}을(를) 넘겨받았습니다`,
       runFinished: (task) => `${task}을(를) 끝냈습니다`,
       runFailed: (task) => `${task}에 실패했습니다`,
       runAbandoned: (task) => `${task}을(를) 포기했습니다`,
@@ -492,6 +495,7 @@ export const ko: Messages = {
     for: "대신:",
     since: "시작",
     until: "종료",
+    lastHeard: "마지막 소식",
     markAbandoned: "중단됨으로 표시",
     waitingForDecision: "결정을 기다리는 중",
     answerIt: "답변하기",

package/src/index.ts

@@ -16,9 +16,11 @@ export {
 export {
   Calendar,
   type CalendarProps,
+  type WeekSegment,
   Workload,
   type WorkloadProps,
   type WorkloadRow,
+  weekSegments,
   workloadOf,
 } from "./components/calendar.js";
 export { CategoryList, type CategoryListProps } from "./components/categories.js";
@@ -64,6 +66,7 @@ export {
   type GoalViewProps,
 } from "./components/goals.js";
 export { Markdown, type MarkdownProps } from "./components/markdown.js";
+export { PAGE_SIZE, ShowMore, usePaged } from "./components/paged.js";
 export { PeopleList, type PeopleListProps } from "./components/people.js";
 export {
   keyOf,
@@ -74,6 +77,7 @@ export {
   type ProjectFormProps,
   ProjectList,
   type ProjectListProps,
+  ProjectMark,
   ProjectRoleBadge,
   VISIBILITY_LABELS,
 } from "./components/projects.js";

package/src/limits.ts

@@ -64,3 +64,9 @@ export const MAX_CATEGORY_KEY_LENGTH = 40;
 export const MAX_CATEGORY_NAME_LENGTH = 60;
 /** How many categories one workspace may have: a vocabulary, not a tag cloud. */
 export const MAX_CATEGORIES = 50;
+/** A project's mark: a letter or two, or a symbol, shown on its colour; counted in code units. */
+export const MAX_PROJECT_SYMBOL_LENGTH = 8;
+/** How large a project's own image for its mark may be, in bytes. */
+export const MAX_PROJECT_ICON_BYTES = 512 * 1024;
+/** How many items a listing answers with when none is asked for, and the most one may ask for. */
+export const DEFAULT_PAGE_LIMIT = 50;

package/src/marks.ts

@@ -0,0 +1,40 @@
+import { COLOR_NAMES, type ColorName } from "./vocabulary.js";
+
+// A project's mark: a symbol on a colour, so that projects tell apart at a glance. A project
+// that names neither gets a colour from its key, the same everywhere and every time, and the
+// first letter of its name.
+
+/** A small, well-spread hash of a string: enough to pick a colour, nothing more. */
+function hashOf(value: string): number {
+  let hash = 2166136261;
+  for (const char of value) {
+    hash ^= char.codePointAt(0) ?? 0;
+    hash = Math.imul(hash, 16777619) >>> 0;
+  }
+  return hash;
+}
+
+/** The colour of a project's mark: the one it names, else one chosen from its key. */
+export function projectColorOf(project: {
+  readonly key: string;
+  readonly color: ColorName | null;
+}): ColorName {
+  if (project.color !== null) {
+    return project.color;
+  }
+  // Gray is for what has no colour; a project chosen one gets one of the rest.
+  const choices = COLOR_NAMES.filter((name) => name !== "gray");
+  return choices[hashOf(project.key) % choices.length] ?? "gray";
+}
+
+/** The symbol of a project's mark: the one it names, else the first letter of its name. */
+export function projectSymbolOf(project: {
+  readonly name: string;
+  readonly symbol: string | null;
+}): string {
+  if (project.symbol !== null && project.symbol.length > 0) {
+    return project.symbol;
+  }
+  const first = [...project.name.trim()][0];
+  return first === undefined ? "?" : first.toUpperCase();
+}

package/src/router.ts

@@ -52,8 +52,13 @@ export type Route =
   | { readonly name: "decisions"; readonly project: string }
   | { readonly name: "new-decision"; readonly project: string }
   | { readonly name: "decision"; readonly project: string; readonly id: string }
-  /** The calendar of a project: the month shown, or this one when the address names none. */
-  | { readonly name: "calendar"; readonly project: string; readonly month: string | undefined }
+  /** The calendar of a project: the month shown, or this one when the address names none, narrowed as the board is. */
+  | {
+      readonly name: "calendar";
+      readonly project: string;
+      readonly month: string | undefined;
+      readonly filter: BoardFilter;
+    }
   | { readonly name: "roadmap"; readonly project: string }
   | { readonly name: "new-goal"; readonly project: string }
   | {
@@ -280,7 +285,7 @@ export function matchRoute(pathname: string, search = ""): Route {
     if (month !== null && !isMonth(month)) {
       return NOT_FOUND;
     }
-    return { name: "calendar", project, month: month ?? undefined };
+    return { name: "calendar", project, month: month ?? undefined, filter: boardFilterOf(params) };
   }
   if (page === "roadmap") {
     return { name: "roadmap", project };
@@ -307,6 +312,12 @@ export function projectHref(key: string, page?: ProjectPage): string {
 
 /** Where a project's board is, narrowed as the filter says; the plain board for an empty one. */
 export function boardHref(key: string, filter: BoardFilter = {}): string {
+  const parts = filterParts(filter);
+  return parts.length === 0 ? projectHref(key) : `${projectHref(key)}?${parts.join("&")}`;
+}
+
+/** The filter as the query carries it, a part per narrowing; nothing for the plain board. */
+function filterParts(filter: BoardFilter): string[] {
   const parts: string[] = [];
   // An empty value means "none": it keeps its sign; "mine" is a flag and has no value.
   if (filter.category !== undefined) {
@@ -321,7 +332,7 @@ export function boardHref(key: string, filter: BoardFilter = {}): string {
   if (filter.mine === true) {
     parts.push("mine");
   }
-  return parts.length === 0 ? projectHref(key) : `${projectHref(key)}?${parts.join("&")}`;
+  return parts;
 }
 
 /** Where a task is written: the form. */
@@ -345,10 +356,11 @@ export function decisionHref(key: string, id: string): string {
   return `${PATHS.project}/${key}/decisions/${id}`;
 }
 
-/** Where a project's calendar is, on a month, or on this one when none is named. */
-export function calendarHref(key: string, month?: string): string {
+/** Where a project's calendar is, on a month, or on this one when none is named, narrowed as the filter says. */
+export function calendarHref(key: string, month?: string, filter: BoardFilter = {}): string {
   const base = projectHref(key, "calendar");
-  return month === undefined ? base : `${base}?month=${month}`;
+  const parts = [...(month === undefined ? [] : [`month=${month}`]), ...filterParts(filter)];
+  return parts.length === 0 ? base : `${base}?${parts.join("&")}`;
 }
 
 /** Where a goal is set: the form. */

package/src/routes.ts

@@ -114,3 +114,12 @@ export function projectPath(key: string, collection?: ProjectCollection, id?: st
     ? `${base}/${collection}`
     : `${base}/${collection}/${encodeURIComponent(id)}`;
 }
+
+/**
+ * Where a project's own image for its mark is read, with the hash as a version where the image
+ * is known, so that a browser's copy is asked for again only when the image changes.
+ */
+export function projectIconPath(key: string, icon?: { readonly sha256: string } | null): string {
+  const base = `${projectPath(key)}/icon`;
+  return icon === undefined || icon === null ? base : `${base}?v=${icon.sha256.slice(0, 16)}`;
+}

package/src/schemas.ts

@@ -21,6 +21,7 @@ import {
   MAX_PROJECT_DESCRIPTION_LENGTH,
   MAX_PROJECT_KEY_LENGTH,
   MAX_PROJECT_NAME_LENGTH,
+  MAX_PROJECT_SYMBOL_LENGTH,
   MAX_QUESTION_LENGTH,
   MAX_SECRET_LENGTH,
   MAX_SKILLS_ADDRESS_LENGTH,
@@ -35,10 +36,12 @@ import { hasForbiddenCodePoint } from "./text.js";
 import {
   ARTIFACT_KINDS,
   CATEGORY_COLORS,
+  COLOR_NAMES,
   EVENT_KINDS,
   GOAL_STATES,
   LINK_SOURCES,
   PERSON_ROLES,
+  PROJECT_ICON_TYPES,
   PROJECT_ROLES,
   PROJECT_VISIBILITIES,
   PROVIDER_KEYS,
@@ -160,7 +163,19 @@ const projectKey = z.string().check(
 /** The address of a project's skills, as the standard spells one; the console checks it as one. */
 const skillsAddress = line(MAX_SKILLS_ADDRESS_LENGTH);
 
+/** A project's mark: a letter or two, or a symbol, with no space in it; shown on the project's colour. */
+const projectSymbol = line(MAX_PROJECT_SYMBOL_LENGTH).check(
+  z.refine((value) => !/\s/.test(value), "must have no space in it"),
+);
+
 /** A project of the workspace, as the asker sees it: with what they are in it. */
+/** A project's own image for its mark: the hash it is kept by, which `projectIconPath` reads it with, and its kind. */
+export const restProjectIconSchema = z.object({
+  sha256: z.string().check(z.regex(/^[0-9a-f]{64}$/)),
+  contentType: z.enum(PROJECT_ICON_TYPES),
+});
+export type RestProjectIcon = z.infer<typeof restProjectIconSchema>;
+
 export const restProjectSchema = z.object({
   id: uuid,
   key: projectKey,
@@ -170,6 +185,12 @@ export const restProjectSchema = z.object({
   visibility: z.enum(PROJECT_VISIBILITIES),
   /** The address of the project's skills at the SkillCDN deployment, canonical, or `null` for the organization's. */
   skillsAddress: z.nullable(z.string()),
+  /** The colour of the project's mark, one of the names, or `null` for one chosen from its key. */
+  color: z.nullable(z.enum(COLOR_NAMES)),
+  /** The project's mark, a letter or two or a symbol, or `null` for the first letter of its name. */
+  symbol: z.nullable(z.string()),
+  /** The project's own image for its mark, shown in place of the symbol, or `null` for none. */
+  icon: z.nullable(restProjectIconSchema),
   /** What the asker is in it: an owner configures the project, a member works on it. */
   role: z.enum(PROJECT_ROLES),
   /** How many decisions in it wait for a person. */
@@ -194,6 +215,9 @@ export const restProjectInputSchema = z.object({
   visibility: z.optional(z.enum(PROJECT_VISIBILITIES)),
   /** Left out or `null`: the organization's skills. */
   skillsAddress: z.optional(z.nullable(skillsAddress)),
+  /** Left out or `null`: a colour chosen from the key, and the first letter of the name. */
+  color: z.optional(z.nullable(z.enum(COLOR_NAMES))),
+  symbol: z.optional(z.nullable(projectSymbol)),
 });
 export type RestProjectInput = z.infer<typeof restProjectInputSchema>;
 
@@ -203,6 +227,8 @@ export const restProjectPatchSchema = z.object({
   description: z.optional(paragraphs(MAX_PROJECT_DESCRIPTION_LENGTH)),
   visibility: z.optional(z.enum(PROJECT_VISIBILITIES)),
   skillsAddress: z.optional(z.nullable(skillsAddress)),
+  color: z.optional(z.nullable(z.enum(COLOR_NAMES))),
+  symbol: z.optional(z.nullable(projectSymbol)),
 });
 export type RestProjectPatch = z.infer<typeof restProjectPatchSchema>;
 
@@ -313,8 +339,8 @@ export const restTaskSchema = z.object({
 });
 export type RestTask = z.infer<typeof restTaskSchema>;
 
-/** `GET /api/v1/projects/<key>/tasks`: the board, newest first. */
-export const restTasksSchema = z.object({ items: z.array(restTaskSchema) });
+/** `GET /api/v1/projects/<key>/tasks`: a page of the board, newest first, and whether there is more after it. */
+export const restTasksSchema = z.object({ items: z.array(restTaskSchema), more: z.boolean() });
 export type RestTasks = z.infer<typeof restTasksSchema>;
 
 const taskLinkInput = z.object({
@@ -449,12 +475,21 @@ export const restDecisionSchema = z.object({
 });
 export type RestDecision = z.infer<typeof restDecisionSchema>;
 
-/** `GET /api/v1/projects/<key>/decisions`: the ones that wait first, newest first within each. */
-export const restDecisionsSchema = z.object({ items: z.array(restDecisionSchema) });
+/** `GET /api/v1/projects/<key>/decisions`: a page, the ones that wait first, newest first within each, and whether there is more. */
+export const restDecisionsSchema = z.object({
+  items: z.array(restDecisionSchema),
+  more: z.boolean(),
+});
 export type RestDecisions = z.infer<typeof restDecisionsSchema>;
 
-/** The project a thing on a person's plate belongs to, named for the page to say and link it. */
-const projectRef = z.object({ key: projectKey, name: z.string() });
+/** The project a thing on a person's plate belongs to, named and marked for the page to say, link and show it. */
+const projectRef = z.object({
+  key: projectKey,
+  name: z.string(),
+  color: z.nullable(z.enum(COLOR_NAMES)),
+  symbol: z.nullable(z.string()),
+  icon: z.nullable(restProjectIconSchema),
+});
 
 /**
  * `GET /api/v1/work`: what is on the asker's plate across the projects they may see (ADR-0019):
@@ -598,6 +633,11 @@ export const restRunSchema = z.object({
   status: z.enum(RUN_STATUSES),
   startedAt: instant,
   endedAt: z.nullable(instant),
+  /**
+   * When the agent was last heard from on this run: when it began, reported, handed in or
+   * asked. The board cannot know whether an agent still runs; this is what it knows.
+   */
+  lastHeardAt: instant,
   /** What the agent said when the run ended, in Markdown, or `null`. */
   summary: z.nullable(z.string()),
   /** Oldest first. */
@@ -608,8 +648,8 @@ export const restRunSchema = z.object({
 });
 export type RestRun = z.infer<typeof restRunSchema>;
 
-/** `GET /api/v1/projects/<key>/runs`: the runs, newest first. */
-export const restRunsSchema = z.object({ items: z.array(restRunSchema) });
+/** `GET /api/v1/projects/<key>/runs`: a page of the runs, newest first, and whether there is more. */
+export const restRunsSchema = z.object({ items: z.array(restRunSchema), more: z.boolean() });
 export type RestRuns = z.infer<typeof restRunsSchema>;
 
 /** `GET .../events?after=`: what happened after that number, oldest first. */