@bunizao/contracts 0.21.0 → 0.23.0

package/dist/desk.d.ts

@@ -0,0 +1,78 @@
+/** Mac power state as the reporter sees it. */
+export declare const DESK_MAC_STATES: readonly ['on', 'locked', 'sleeping', 'paused'];
+export type DeskMacState = (typeof DESK_MAC_STATES)[number];
+/**
+ * An app on the desk. `label` is at most 24 letters, digits, spaces and dots;
+ * site-api turns anything else into "something else". `icon` is the
+ * lowercase hex sha256 of a PNG (at most 128 px a side) already uploaded to
+ * deskIconPath(icon), or null.
+ */
+export interface DeskApp {
+    label: string;
+    icon: string | null;
+}
+/** Report body version the reporter sends; site-api rejects any other. */
+export declare const DESK_REPORT_VERSION = 1;
+/**
+ * Body of the owner-only, HMAC-signed POST to DESK_REPORT_PATH. The server
+ * ignores a report whose sentAt is not newer than the stored one, and
+ * computes expiry from its own clock plus ttl.
+ */
+export interface DeskReport {
+    v: typeof DESK_REPORT_VERSION;
+    /** Reporter clock, epoch milliseconds. Only used for ordering. */
+    sentAt: number;
+    mac: DeskMacState;
+    /** Seconds since the last keyboard or pointer input. */
+    idleSeconds: number;
+    /** True while an app holds a display-sleep assertion (video, a call). */
+    screenHeld: boolean;
+    /** Apps in use, most active first; `other` for an unlisted one. Never window titles or bundle ids. */
+    apps: DeskApp[];
+    /** IANA zone of the Mac, e.g. Australia/Melbourne. */
+    timeZone: string;
+    /** Seconds this report stays valid without a successor. */
+    ttl: number;
+}
+export declare const DESK_PRESENCE_STATES: readonly ['awake', 'idle', 'asleep', 'offline'];
+export type DeskPresenceState = (typeof DESK_PRESENCE_STATES)[number];
+export declare const DESK_SKIES: readonly ['clear', 'cloudy', 'fog', 'drizzle', 'rain', 'snow', 'storm'];
+export type Sky = (typeof DESK_SKIES)[number];
+export interface DeskPresence {
+    state: DeskPresenceState;
+    /** Empty unless awake or idle; an unlisted app reads "something else" with no icon. */
+    apps: DeskApp[];
+    /** Seconds of lease left when computed; null when offline or asleep. */
+    validFor: number | null;
+}
+export interface DeskPlace {
+    /** IANA zone the clock shows; the last pushed zone, or the default. */
+    timeZone: string;
+    /** City named by the zone; null when the zone names none (e.g. UTC). */
+    city: string | null;
+}
+export interface DeskWeather {
+    /** Degrees Celsius, rounded. */
+    temperature: number;
+    sky: Sky;
+    /** Daylight at the place right now. */
+    day: boolean;
+}
+/** Response of GET DESK_PATH. Fields are only ever added. */
+export interface DeskNow {
+    presence: DeskPresence;
+    place: DeskPlace;
+    /** Null when the weather source is unavailable. */
+    weather: DeskWeather | null;
+}
+/** Close code the live socket uses when it is full; poll instead. */
+export declare const DESK_LIVE_FULL_CLOSE_CODE = 1013;
+/**
+ * Message the live socket at DESK_LIVE_PATH sends on connect and whenever
+ * presence or place changes. Weather is not pushed; read it from DESK_PATH.
+ * The socket answers the text `ping` with `pong`. Fields are only ever added.
+ */
+export interface DeskLive {
+    presence: DeskPresence;
+    place: DeskPlace;
+}

package/dist/desk.js

@@ -0,0 +1,13 @@
+// src/desk.ts
+var DESK_MAC_STATES = ["on", "locked", "sleeping", "paused"];
+var DESK_REPORT_VERSION = 1;
+var DESK_PRESENCE_STATES = ["awake", "idle", "asleep", "offline"];
+var DESK_SKIES = ["clear", "cloudy", "fog", "drizzle", "rain", "snow", "storm"];
+var DESK_LIVE_FULL_CLOSE_CODE = 1013;
+export {
+  DESK_LIVE_FULL_CLOSE_CODE,
+  DESK_MAC_STATES,
+  DESK_PRESENCE_STATES,
+  DESK_REPORT_VERSION,
+  DESK_SKIES
+};

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './analytics';
 export * from './admin';
 export * from './comments';
 export * from './content';
+export * from './desk';
 export * from './instagram';
 export * from './listening';
 export * from './messages';

package/dist/index.js

@@ -145,6 +145,12 @@ function parsePostLocaleTag(tagName) {
   }
   return canonicalSlug ? { locale, canonicalSlug } : { locale };
 }
+// src/desk.ts
+var DESK_MAC_STATES = ["on", "locked", "sleeping", "paused"];
+var DESK_REPORT_VERSION = 1;
+var DESK_PRESENCE_STATES = ["awake", "idle", "asleep", "offline"];
+var DESK_SKIES = ["clear", "cloudy", "fog", "drizzle", "rain", "snow", "storm"];
+var DESK_LIVE_FULL_CLOSE_CODE = 1013;
 // src/messages.ts
 var MESSAGE_LOCALES = ["zh", "en"];
 var MESSAGE_MIN_BODY_LENGTH = 2;
@@ -174,6 +180,18 @@ var MOOD_TOPICS = [
   { id: "travel", zh: "出行旅行", en: "Travel & Transport" },
   { id: "daily-life", zh: "日常生活", en: "Daily Life" }
 ];
+var MOOD_TOPIC_GROUPS = [
+  { id: "ai", zh: "AI", en: "AI", topics: ["ai"] },
+  { id: "tech", zh: "数码与折腾", en: "Tech & Tinkering", topics: ["devices", "apps-services", "coding"] },
+  { id: "study", zh: "学习", en: "Study", topics: ["study-school"] },
+  { id: "food", zh: "吃喝", en: "Food & Drink", topics: ["food-drink"] },
+  { id: "money", zh: "钱与消费", en: "Money & Shopping", topics: ["money-finance", "shopping-style"] },
+  { id: "people", zh: "朋友与感情", en: "Friends & Love", topics: ["friends", "romance"] },
+  { id: "feelings", zh: "心情与想法", en: "Feelings & Thoughts", topics: ["self-feelings", "reflections"] },
+  { id: "health", zh: "身体与睡眠", en: "Health & Sleep", topics: ["health-sleep"] },
+  { id: "media", zh: "音乐与娱乐", en: "Music & Media", topics: ["music", "media-entertainment", "internet-culture"] },
+  { id: "life", zh: "生活与出行", en: "Daily Life & Travel", topics: ["daily-life", "travel"] }
+];
 var MOOD_COMMENT_ORIGINS = ["telegram", "web"];
 // src/notify.ts
 var NOTIFY_CHANNELS = ["mood", "blog", "privacy", "announcement"];
@@ -193,6 +211,13 @@ var MOOD_SEARCH_PATH = "/v2/mood/search";
 var MOOD_IMAGE_PROXY_BASE_PATH = "/v2/images";
 var MOOD_MEDIA_PROXY_BASE_PATH = "/v2/media";
 var LISTENING_PATH = "/v2/listening";
+var DESK_PATH = "/v2/desk";
+var DESK_LIVE_PATH = "/v2/desk/live";
+var DESK_REPORT_PATH = "/v2/desk/report";
+var DESK_ICONS_PATH = "/v2/desk/icons";
+function deskIconPath(hash) {
+  return `${DESK_ICONS_PATH}/${hash}`;
+}
 var INSTAGRAM_PROFILE_PATH = "/v2/instagram";
 var INSTAGRAM_AVATAR_PATH = "/v2/instagram/avatar";
 var COMMENTS_PATH = "/v2/comments";
@@ -305,6 +330,15 @@ export {
   CONTENT_DOCUMENT_SOURCES,
   DEFAULT_COMMENT_POLICY,
   DEFAULT_REACTION_EMOJI,
+  DESK_ICONS_PATH,
+  DESK_LIVE_FULL_CLOSE_CODE,
+  DESK_LIVE_PATH,
+  DESK_MAC_STATES,
+  DESK_PATH,
+  DESK_PRESENCE_STATES,
+  DESK_REPORT_PATH,
+  DESK_REPORT_VERSION,
+  DESK_SKIES,
   EVENT_STATUSES,
   GHOST_WEBHOOK_PATH,
   HEALTH_PATH,
@@ -339,6 +373,7 @@ export {
   MOOD_SEARCH_PATH,
   MOOD_SENTIMENT_LABELS,
   MOOD_TOPICS,
+  MOOD_TOPIC_GROUPS,
   MUSICKIT_TOKEN_PATH,
   NEWSLETTER_ANALYTICS_CLICK_ENDPOINT,
   NEWSLETTER_ANALYTICS_OPEN_ENDPOINT,
@@ -394,6 +429,7 @@ export {
   avatarClass,
   commentAnchorToken,
   commentPolicyFromTags,
+  deskIconPath,
   isAvatarSeed,
   parsePostLocaleTag,
   seedInClass,

package/dist/mood.d.ts

@@ -88,6 +88,61 @@ export declare const MOOD_TOPICS: readonly [{
     readonly en: 'Daily Life';
 }];
 export type MoodTopicId = (typeof MOOD_TOPICS)[number]['id'];
+/** How the yearly view counts topics: eighteen bars are too fine to read a
+    year by, so it shows these ten. Posts keep their MOOD_TOPICS ids; every id
+    sits in exactly one group. */
+export declare const MOOD_TOPIC_GROUPS: readonly [{
+    readonly id: 'ai';
+    readonly zh: 'AI';
+    readonly en: 'AI';
+    readonly topics: readonly ["ai"];
+}, {
+    readonly id: 'tech';
+    readonly zh: '数码与折腾';
+    readonly en: 'Tech & Tinkering';
+    readonly topics: readonly ["devices", "apps-services", "coding"];
+}, {
+    readonly id: 'study';
+    readonly zh: '学习';
+    readonly en: 'Study';
+    readonly topics: readonly ["study-school"];
+}, {
+    readonly id: 'food';
+    readonly zh: '吃喝';
+    readonly en: 'Food & Drink';
+    readonly topics: readonly ["food-drink"];
+}, {
+    readonly id: 'money';
+    readonly zh: '钱与消费';
+    readonly en: 'Money & Shopping';
+    readonly topics: readonly ["money-finance", "shopping-style"];
+}, {
+    readonly id: 'people';
+    readonly zh: '朋友与感情';
+    readonly en: 'Friends & Love';
+    readonly topics: readonly ["friends", "romance"];
+}, {
+    readonly id: 'feelings';
+    readonly zh: '心情与想法';
+    readonly en: 'Feelings & Thoughts';
+    readonly topics: readonly ["self-feelings", "reflections"];
+}, {
+    readonly id: 'health';
+    readonly zh: '身体与睡眠';
+    readonly en: 'Health & Sleep';
+    readonly topics: readonly ["health-sleep"];
+}, {
+    readonly id: 'media';
+    readonly zh: '音乐与娱乐';
+    readonly en: 'Music & Media';
+    readonly topics: readonly ["music", "media-entertainment", "internet-culture"];
+}, {
+    readonly id: 'life';
+    readonly zh: '生活与出行';
+    readonly en: 'Daily Life & Travel';
+    readonly topics: readonly ["daily-life", "travel"];
+}];
+export type MoodTopicGroupId = (typeof MOOD_TOPIC_GROUPS)[number]['id'];
 export interface MoodSentiment {
     label: MoodSentimentLabel;
     score: number;
@@ -128,13 +183,19 @@ export interface MoodYearDay {
     temperature: number | null;
 }
 export interface MoodYearTopic {
-    /** A MoodTopicId, kept as string: a snapshot can outlive a vocabulary change. */
-    topic: string;
+    /** A MoodTopicGroupId, kept as string: a snapshot can outlive a vocabulary change. */
+    group: string;
+    /** Analysed posts with at least one topic in the group. */
     count: number;
 }
 export interface MoodYearWord {
+    /** The spelling the year used most. */
     word: string;
+    /** Posts that name it. */
     count: number;
+    /** Message ids of the newest posts that name it, newest first, at most
+        five: where the word came from. */
+    posts: number[];
 }
 /** One calendar year of the owner's own words. Forwards are left out: they
     are someone else's mood. Built once a day into KV, never per request. */
@@ -148,9 +209,10 @@ export interface MoodYear {
     /** Days with at least one post, ascending; empty days are absent. */
     days: MoodYearDay[];
     sentiment: Record<MoodSentimentLabel, number>;
-    /** Most frequent first. */
+    /** Topic groups, most frequent first. */
     topics: MoodYearTopic[];
-    /** Word-cloud keywords, most frequent first, at most 120. */
+    /** Word-cloud keywords used on at least two days, most distinctive first,
+        at most 120. */
     words: MoodYearWord[];
     generatedAt: string;
 }

package/dist/mood.js

@@ -21,10 +21,23 @@ var MOOD_TOPICS = [
   { id: "travel", zh: "出行旅行", en: "Travel & Transport" },
   { id: "daily-life", zh: "日常生活", en: "Daily Life" }
 ];
+var MOOD_TOPIC_GROUPS = [
+  { id: "ai", zh: "AI", en: "AI", topics: ["ai"] },
+  { id: "tech", zh: "数码与折腾", en: "Tech & Tinkering", topics: ["devices", "apps-services", "coding"] },
+  { id: "study", zh: "学习", en: "Study", topics: ["study-school"] },
+  { id: "food", zh: "吃喝", en: "Food & Drink", topics: ["food-drink"] },
+  { id: "money", zh: "钱与消费", en: "Money & Shopping", topics: ["money-finance", "shopping-style"] },
+  { id: "people", zh: "朋友与感情", en: "Friends & Love", topics: ["friends", "romance"] },
+  { id: "feelings", zh: "心情与想法", en: "Feelings & Thoughts", topics: ["self-feelings", "reflections"] },
+  { id: "health", zh: "身体与睡眠", en: "Health & Sleep", topics: ["health-sleep"] },
+  { id: "media", zh: "音乐与娱乐", en: "Music & Media", topics: ["music", "media-entertainment", "internet-culture"] },
+  { id: "life", zh: "生活与出行", en: "Daily Life & Travel", topics: ["daily-life", "travel"] }
+];
 var MOOD_COMMENT_ORIGINS = ["telegram", "web"];
 export {
   MOOD_AI_MODELS,
   MOOD_COMMENT_ORIGINS,
   MOOD_SENTIMENT_LABELS,
-  MOOD_TOPICS
+  MOOD_TOPICS,
+  MOOD_TOPIC_GROUPS
 };

package/dist/routes.d.ts

@@ -12,6 +12,13 @@ export declare const MOOD_SEARCH_PATH: '/v2/mood/search';
 export declare const MOOD_IMAGE_PROXY_BASE_PATH: '/v2/images';
 export declare const MOOD_MEDIA_PROXY_BASE_PATH: '/v2/media';
 export declare const LISTENING_PATH: '/v2/listening';
+export declare const DESK_PATH: '/v2/desk';
+/** WebSocket upgrade; the server pushes DeskLive messages. */
+export declare const DESK_LIVE_PATH: '/v2/desk/live';
+export declare const DESK_REPORT_PATH: '/v2/desk/report';
+/** PUT (owner-signed) and GET an app icon PNG by its sha256: `${DESK_ICONS_PATH}/<hash>`. */
+export declare const DESK_ICONS_PATH: '/v2/desk/icons';
+export declare function deskIconPath(hash: string): string;
 export declare const INSTAGRAM_PROFILE_PATH: '/v2/instagram';
 export declare const INSTAGRAM_AVATAR_PATH: '/v2/instagram/avatar';
 export declare const COMMENTS_PATH: '/v2/comments';

package/dist/routes.js

@@ -13,6 +13,13 @@ var MOOD_SEARCH_PATH = "/v2/mood/search";
 var MOOD_IMAGE_PROXY_BASE_PATH = "/v2/images";
 var MOOD_MEDIA_PROXY_BASE_PATH = "/v2/media";
 var LISTENING_PATH = "/v2/listening";
+var DESK_PATH = "/v2/desk";
+var DESK_LIVE_PATH = "/v2/desk/live";
+var DESK_REPORT_PATH = "/v2/desk/report";
+var DESK_ICONS_PATH = "/v2/desk/icons";
+function deskIconPath(hash) {
+  return `${DESK_ICONS_PATH}/${hash}`;
+}
 var INSTAGRAM_PROFILE_PATH = "/v2/instagram";
 var INSTAGRAM_AVATAR_PATH = "/v2/instagram/avatar";
 var COMMENTS_PATH = "/v2/comments";
@@ -45,6 +52,10 @@ export {
   API_PREFIX,
   COMMENTS_PATH,
   COMMENT_PATH_PREFIX,
+  DESK_ICONS_PATH,
+  DESK_LIVE_PATH,
+  DESK_PATH,
+  DESK_REPORT_PATH,
   GHOST_WEBHOOK_PATH,
   HEALTH_PATH,
   INSTAGRAM_AVATAR_PATH,
@@ -81,5 +92,6 @@ export {
   READER_PREFERENCES_PATH,
   READER_RESEND_PATH,
   READER_VERIFY_PATH,
-  TELEGRAM_WEBHOOK_PATH
+  TELEGRAM_WEBHOOK_PATH,
+  deskIconPath
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bunizao/contracts",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "Shared TypeScript contracts for buxx.me services and clients.",
   "type": "module",
   "sideEffects": false,
@@ -48,6 +48,11 @@
       "import": "./dist/content.js",
       "default": "./dist/content.js"
     },
+    "./desk": {
+      "types": "./dist/desk.d.ts",
+      "import": "./dist/desk.js",
+      "default": "./dist/desk.js"
+    },
     "./instagram": {
       "types": "./dist/instagram.d.ts",
       "import": "./dist/instagram.js",