@nocobase/app-plugin-projects 0.0.0-stage → 0.1.0-beta.2

package/dist/shared/access.js

@@ -0,0 +1,223 @@
+/**
+ * What this plugin offers to be granted: its pages, settings items and business actions with the levels each offers.
+ * The plugin registers them with the authorization plugin from here (`server/providers/authorization.ts`): its settings
+ * items, and its businesses as the `pm` resource type, each level of an action its own authorization action
+ * (`edit.related`, `edit.all`). The application that assembles it keeps the roles, stores the grants and tells
+ * the plugin each request's `Permissions` (`server/tokens.ts`, `projectsAccessToken`). The client reads a signed-in
+ * user's `Permissions` to show only what the server would allow.
+ */
+/** The namespace of every title below, in the plugin's locales (`shared/locales/access.*.ts`). */
+export const ACCESS_NAMESPACE = '@nocobase/app-plugin-projects';
+/** A title as the authorization plugin stores it: an i18n key in this plugin's namespace. */
+export function accessText(key) {
+    return { key: `access.${key}`, ns: ACCESS_NAMESPACE };
+}
+/**
+ * Business actions. Each reaches every record, none, or the records related to a set of users (`Scope`); the table
+ * says how a record relates to a user (`RELATIONS`). The application decides the set from the caller's roles: the
+ * caller alone, or more (say, their department); this plugin only filters by it.
+ *
+ * | Action                     | a record related to a user                                             |
+ * | -------------------------- | ---------------------------------------------------------------------- |
+ * | projects view              | public projects, and private ones the user leads or joined             |
+ * | projects create            | none: the action has no records, it is held or not                     |
+ * | projects manage            | projects the user leads                                                |
+ * | projects delete            | none: held or not                                                      |
+ * | issues view / edit         | issues without a project, or in a project related for `view`          |
+ * | issues create              | the same: without a project, or into such a project                    |
+ * | issues comment             | the same issues: comment, reply, resolve threads                       |
+ * | issues moderate-comments   | delete anyone's comment on issues the user owns or whose project they lead |
+ * | issues close / change-owner | issues the user owns, or in a project they lead                       |
+ * | issues delete              | none: held or not                                                      |
+ * | attachments upload         | files on the issues related for `view`: upload, attach, send with a comment |
+ */
+export const BUSINESS_ACTIONS = {
+    'pm.projects': ['view', 'create', 'manage', 'delete'],
+    'pm.issues': [
+        'view',
+        'create',
+        'edit',
+        'comment',
+        'moderate-comments',
+        'close',
+        'change-owner',
+        'delete',
+    ],
+    'pm.attachments': ['upload'],
+};
+/** Whether `scope` reaches a record related to any of `userIds` (null and undefined relate nothing). */
+export function reaches(scope, ...userIds) {
+    if (scope === 'all')
+        return true;
+    if (scope === 'none')
+        return false;
+    return userIds.some((id) => !!id && scope.users.includes(id));
+}
+/** The users a scope is limited to: null for `all`, none for `none`. */
+export function usersOf(scope) {
+    if (scope === 'all')
+        return null;
+    return scope === 'none' ? [] : scope.users;
+}
+/**
+ * Settings items, each checked on its own endpoints. `read` opens the page and `update` changes it; on members,
+ * `invite` invites without a project and manages every invitation, `assign` gives and takes roles, and `define-roles`
+ * creates, edits and deletes them.
+ */
+export const SETTINGS_ACTIONS = {
+    'pm.general': ['read', 'update'],
+    'pm.labels': ['read', 'update'],
+    'pm.workflows': ['read', 'update'],
+    'pm.members': ['read', 'invite', 'assign', 'define-roles'],
+};
+/** The app pages a role may open (`page` grants, action `access`); the client routes declare the same ids. */
+export const PAGES = ['pm-my-issues', 'pm-issues', 'pm-projects'];
+export function businessKey(business, action) {
+    return `${business}/${action}`;
+}
+export function settingsKey(item, action) {
+    return `${item}/${action}`;
+}
+/** Every business action, in declaration order. */
+export const BUSINESS_KEYS = Object.entries(BUSINESS_ACTIONS).flatMap(([business, actions]) => actions.map((action) => ({
+    business: business,
+    action: action,
+    key: `${business}/${action}`,
+})));
+/** Every settings capability, in declaration order. */
+export const SETTINGS_KEYS = Object.entries(SETTINGS_ACTIONS).flatMap(([item, actions]) => actions.map((action) => ({
+    item: item,
+    action: action,
+    key: `${item}/${action}`,
+})));
+/** Each business action's relation; null where the action has no records to relate, so it is held or not. */
+export const RELATIONS = {
+    'pm.projects/view': 'visible',
+    'pm.projects/create': null,
+    'pm.projects/manage': 'managed',
+    'pm.projects/delete': null,
+    'pm.issues/view': 'visible',
+    'pm.issues/create': 'visible',
+    'pm.issues/edit': 'visible',
+    'pm.issues/comment': 'visible',
+    'pm.issues/moderate-comments': 'managed',
+    'pm.issues/close': 'managed',
+    'pm.issues/change-owner': 'managed',
+    'pm.issues/delete': null,
+    'pm.attachments/upload': 'visible',
+};
+/** The authorization resource type the businesses are registered under; every business id starts with it. */
+export const RESOURCE_TYPE = 'pm';
+/** The permission workspace subsection (under business) that lists the businesses. */
+export const BUSINESS_SECTION = 'pm';
+/**
+ * The levels an action whose records relate to users (`RELATIONS`) is registered at, lowest first, each its own
+ * authorization action: `edit.related` reaches the related records, `edit.all` every one. An action without related
+ * records is registered as itself (`create`), held or not. Holding a level reaches at least what the lower ones do, so
+ * the application takes the highest one held.
+ */
+export const ACTION_LEVELS = ['related', 'all'];
+/** The authorization actions a business action is registered as, lowest level first. */
+export function levelActionsOf(key) {
+    const action = key.slice(key.indexOf('/') + 1);
+    return RELATIONS[key]
+        ? ACTION_LEVELS.map((level) => ({ level, name: `${action}.${level}` }))
+        : [{ level: 'all', name: action }];
+}
+const camel = (name) => name.replace(/-([a-z])/gu, (_, letter) => letter.toUpperCase());
+/** `pm.issues` → `issues`: a business's key in the locales. */
+const localName = (business) => business.slice(business.indexOf('.') + 1);
+/** A business's title or its one-line description (`access.businesses.issues.title`). */
+export function businessText(business, part) {
+    return accessText(`businesses.${localName(business)}.${part}`);
+}
+/**
+ * A business action's title, its one-line description, the title of one of its levels, or the wording of its `related`
+ * level: `relatedLabel`, its short name in a level choice ("in projects I can see"), and `relatedHint`, one line on what
+ * it reaches. An application reads the last two beside the `related` level's registered title.
+ */
+export function actionText(key, part) {
+    const [business = '', action = ''] = key.split('/');
+    return accessText(`businesses.${localName(business)}.actions.${camel(action)}.${part}`);
+}
+/** Every business action at `none`, the start of a new role. */
+export function noAbilities() {
+    return Object.fromEntries(BUSINESS_KEYS.map(({ key }) => [key, 'none']));
+}
+/** Every settings capability off. */
+export function noSettings() {
+    return Object.fromEntries(SETTINGS_KEYS.map(({ key }) => [key, false]));
+}
+const projectsAction = (action) => ({ kind: 'business', id: 'pm.projects', action });
+const issuesAction = (action) => ({
+    kind: 'business',
+    id: 'pm.issues',
+    action,
+});
+const setting = (item, action) => ({ kind: 'settings', id: item, action });
+/**
+ * What a scoped key may be given here. Levels include the ones below them. A key limited to some projects
+ * (`objects('pm.projects')`) sees only those projects and their issues; issues follow the projects group's selection
+ * and have none of their own. Members and roles are the application's group, not this plugin's.
+ */
+export const KEY_SCOPE_GROUPS = [
+    {
+        id: 'projects.projects',
+        category: 'business',
+        title: accessText('keyScopes.projects.title'),
+        description: accessText('keyScopes.projects.description'),
+        levels: {
+            read: [{ kind: 'page', id: 'pm-projects' }, projectsAction('view')],
+            write: [projectsAction('manage')],
+            admin: [projectsAction('create'), projectsAction('delete')],
+        },
+        objects: {
+            business: 'pm.projects',
+            title: accessText('keyScopes.projects.objects'),
+            allowsUnscoped: [projectsAction('create'), projectsAction('delete')],
+        },
+    },
+    {
+        id: 'projects.issues',
+        category: 'business',
+        title: accessText('keyScopes.issues.title'),
+        description: accessText('keyScopes.issues.description'),
+        levels: {
+            read: [
+                { kind: 'page', id: 'pm-issues' },
+                { kind: 'page', id: 'pm-my-issues' },
+                issuesAction('view'),
+            ],
+            write: [
+                issuesAction('create'),
+                issuesAction('edit'),
+                issuesAction('comment'),
+                issuesAction('close'),
+                issuesAction('change-owner'),
+                { kind: 'business', id: 'pm.attachments', action: 'upload' },
+            ],
+            admin: [issuesAction('moderate-comments'), issuesAction('delete')],
+        },
+    },
+    {
+        id: 'projects.settings',
+        category: 'administration',
+        title: accessText('keyScopes.settings.title'),
+        description: accessText('keyScopes.settings.description'),
+        levels: {
+            read: [
+                setting('pm.general', 'read'),
+                setting('pm.labels', 'read'),
+                setting('pm.workflows', 'read'),
+            ],
+            write: [
+                setting('pm.general', 'update'),
+                setting('pm.labels', 'update'),
+                setting('pm.workflows', 'update'),
+            ],
+        },
+    },
+];
+/** Presets this plugin suggests for a scoped key; none yet. */
+export const KEY_SCOPE_PRESETS = [];
+//# sourceMappingURL=access.js.map

package/dist/shared/access.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.js","sourceRoot":"","sources":["../../shared/access.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,kGAAkG;AAClG,MAAM,CAAC,MAAM,gBAAgB,GAAG,+BAA+B,CAAC;AAEhE,6FAA6F;AAC7F,MAAM,UAAU,UAAU,CAAC,GAAW;IAIpC,OAAO,EAAE,GAAG,EAAE,UAAU,GAAG,EAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE,CAAC;AACxD,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,aAAa,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;IACrD,WAAW,EAAE;QACX,MAAM;QACN,QAAQ;QACR,MAAM;QACN,SAAS;QACT,mBAAmB;QACnB,OAAO;QACP,cAAc;QACd,QAAQ;KACT;IACD,gBAAgB,EAAE,CAAC,QAAQ,CAAC;CACpB,CAAC;AAkBX,wGAAwG;AACxG,MAAM,UAAU,OAAO,CACrB,KAAY,EACZ,GAAG,OAA+C;IAElD,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,OAAO,CAAC,KAAY;IAClC,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IACjC,OAAO,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;AAC7C,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,YAAY,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAChC,WAAW,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC/B,cAAc,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClC,YAAY,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,CAAC;CAClD,CAAC;AAWX,8GAA8G;AAC9G,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE,aAAa,CAAU,CAAC;AAU3E,MAAM,UAAU,WAAW,CACzB,QAAW,EACX,MAAyB;IAEzB,OAAO,GAAG,QAAQ,IAAI,MAAM,EAAiB,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,IAAO,EACP,MAAyB;IAEzB,OAAO,GAAG,IAAI,IAAI,MAAM,EAAiB,CAAC;AAC5C,CAAC;AAED,mDAAmD;AACnD,MAAM,CAAC,MAAM,aAAa,GAIpB,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE,CACrE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAC/B,QAAQ,EAAE,QAAoB;IAC9B,MAAM,EAAE,MAAwB;IAChC,GAAG,EAAE,GAAG,QAAQ,IAAI,MAAM,EAAiB;CAC5C,CAAC,CAAC,CACJ,CAAC;AAEF,uDAAuD;AACvD,MAAM,CAAC,MAAM,aAAa,GAIpB,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CACjE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAoB;IAC1B,MAAM,EAAE,MAAwB;IAChC,GAAG,EAAE,GAAG,IAAI,IAAI,MAAM,EAAiB;CACxC,CAAC,CAAC,CACJ,CAAC;AAQF,6GAA6G;AAC7G,MAAM,CAAC,MAAM,SAAS,GAAmD;IACvE,kBAAkB,EAAE,SAAS;IAC7B,oBAAoB,EAAE,IAAI;IAC1B,oBAAoB,EAAE,SAAS;IAC/B,oBAAoB,EAAE,IAAI;IAC1B,gBAAgB,EAAE,SAAS;IAC3B,kBAAkB,EAAE,SAAS;IAC7B,gBAAgB,EAAE,SAAS;IAC3B,mBAAmB,EAAE,SAAS;IAC9B,6BAA6B,EAAE,SAAS;IACxC,iBAAiB,EAAE,SAAS;IAC5B,wBAAwB,EAAE,SAAS;IACnC,kBAAkB,EAAE,IAAI;IACxB,uBAAuB,EAAE,SAAS;CACnC,CAAC;AAEF,6GAA6G;AAC7G,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC;AAElC,sFAAsF;AACtF,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,KAAK,CAAU,CAAC;AAIzD,wFAAwF;AACxF,MAAM,UAAU,cAAc,CAC5B,GAAgB;IAEhB,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,OAAO,SAAS,CAAC,GAAG,CAAC;QACnB,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,KAAK,EAAE,EAAE,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,IAAY,EAAU,EAAE,CACrC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;AAE1E,+DAA+D;AAC/D,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC7C,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAE5C,yFAAyF;AACzF,MAAM,UAAU,YAAY,CAC1B,QAAkB,EAClB,IAA6B;IAE7B,OAAO,UAAU,CAAC,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;AACjE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,GAAgB,EAChB,IAA4E;IAE5E,MAAM,CAAC,QAAQ,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpD,OAAO,UAAU,CACf,cAAc,SAAS,CAAC,QAAQ,CAAC,YAAY,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CACrE,CAAC;AACJ,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,WAAW;IACzB,OAAO,MAAM,CAAC,WAAW,CACvB,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAChB,CAAC;AAClC,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,UAAU;IACxB,OAAO,MAAM,CAAC,WAAW,CACvB,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CACb,CAAC;AACpC,CAAC;AAyCD,MAAM,cAAc,GAAG,CACrB,MAAqC,EACrB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;AACvE,MAAM,YAAY,GAAG,CAAC,MAAmC,EAAkB,EAAE,CAAC,CAAC;IAC7E,IAAI,EAAE,UAAU;IAChB,EAAE,EAAE,WAAW;IACf,MAAM;CACP,CAAC,CAAC;AACH,MAAM,OAAO,GAAG,CACd,IAAiD,EACjD,MAAyB,EACT,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA6B;IACxD;QACE,EAAE,EAAE,mBAAmB;QACvB,QAAQ,EAAE,UAAU;QACpB,KAAK,EAAE,UAAU,CAAC,0BAA0B,CAAC;QAC7C,WAAW,EAAE,UAAU,CAAC,gCAAgC,CAAC;QACzD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;YACnE,KAAK,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACjC,KAAK,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;SAC5D;QACD,OAAO,EAAE;YACP,QAAQ,EAAE,aAAa;YACvB,KAAK,EAAE,UAAU,CAAC,4BAA4B,CAAC;YAC/C,cAAc,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;SACrE;KACF;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,QAAQ,EAAE,UAAU;QACpB,KAAK,EAAE,UAAU,CAAC,wBAAwB,CAAC;QAC3C,WAAW,EAAE,UAAU,CAAC,8BAA8B,CAAC;QACvD,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE;gBACjC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE;gBACpC,YAAY,CAAC,MAAM,CAAC;aACrB;YACD,KAAK,EAAE;gBACL,YAAY,CAAC,QAAQ,CAAC;gBACtB,YAAY,CAAC,MAAM,CAAC;gBACpB,YAAY,CAAC,SAAS,CAAC;gBACvB,YAAY,CAAC,OAAO,CAAC;gBACrB,YAAY,CAAC,cAAc,CAAC;gBAC5B,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE;aAC7D;YACD,KAAK,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;SACnE;KACF;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,QAAQ,EAAE,gBAAgB;QAC1B,KAAK,EAAE,UAAU,CAAC,0BAA0B,CAAC;QAC7C,WAAW,EAAE,UAAU,CAAC,gCAAgC,CAAC;QACzD,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC;gBAC7B,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC;gBAC5B,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC;aAChC;YACD,KAAK,EAAE;gBACL,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC;gBAC/B,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC;gBAC9B,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC;aAClC;SACF;KACF;CACF,CAAC;AAEF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,iBAAiB,GAAqB,EAAE,CAAC"}

package/dist/shared/approvals.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Approval requests: a status change a workflow holds until one of its approvers approves it. A request is pending
+ * until it is approved (the issue moves), rejected (it stays), withdrawn by who asked, or stale: the issue left the
+ * status meanwhile, or the move's conditions no longer hold when it is approved.
+ */
+import type { ApproverRole } from './workflows.js';
+export type ApprovalStatus = 'pending' | 'approved' | 'rejected' | 'withdrawn' | 'stale';
+export interface ApprovalRequest {
+    readonly id: string;
+    readonly issueId: string;
+    readonly issueIdentifier: string | null;
+    readonly issueTitle: string | null;
+    readonly fromStatus: string;
+    readonly toStatus: string;
+    readonly requestedByType: string;
+    readonly requestedById: string;
+    readonly requestedByName: string | null;
+    /** The roles the workflow named. */
+    readonly approvers: readonly ApproverRole[];
+    /** Who they resolved to when the request was made; any one of them decides. */
+    readonly approverUserIds: readonly string[];
+    readonly approverNames: readonly string[];
+    readonly status: ApprovalStatus;
+    readonly decidedById: string | null;
+    readonly decidedByName: string | null;
+    readonly decidedAt: string | null;
+    readonly comment: string | null;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+export interface DecideApprovalRequest {
+    readonly comment?: string;
+}
+export declare const APPROVAL_COMMENT_MAX = 2000;
+/** How many decided requests the issue page lists (`IssueDetail.recentApprovals`). */
+export declare const RECENT_DECIDED_APPROVALS = 5;
+//# sourceMappingURL=approvals.d.ts.map

package/dist/shared/approvals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"approvals.d.ts","sourceRoot":"","sources":["../../shared/approvals.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,cAAc,GACxB,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;AAE9D,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,YAAY,EAAE,CAAC;IAC5C,+EAA+E;IAC/E,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,oBAAoB,OAAO,CAAC;AAEzC,sFAAsF;AACtF,eAAO,MAAM,wBAAwB,IAAI,CAAC"}

package/dist/shared/approvals.js

@@ -0,0 +1,4 @@
+export const APPROVAL_COMMENT_MAX = 2000;
+/** How many decided requests the issue page lists (`IssueDetail.recentApprovals`). */
+export const RECENT_DECIDED_APPROVALS = 5;
+//# sourceMappingURL=approvals.js.map

package/dist/shared/approvals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"approvals.js","sourceRoot":"","sources":["../../shared/approvals.ts"],"names":[],"mappings":"AAsCA,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAEzC,sFAAsF;AACtF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC"}

package/dist/shared/attachments.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Files attached to issues and comments. A file is stored through the file plugin (its bytes on a Drive disk) and
+ * starts out as an upload of its uploader's, attached to nothing; attaching it to an issue (the issue's own files) or
+ * to a comment (sent with the comment) makes it readable by whoever sees the issue. An upload attached to nothing for
+ * `ORPHAN_HOURS` is purged, and so are the files of a deleted comment. Any type of file is accepted, up to
+ * `ATTACHMENT_SIZE_MAX` bytes each.
+ *
+ * ## Who may do what
+ *
+ * | Operation                                   | Needs                                                            |
+ * | ------------------------------------------- | ---------------------------------------------------------------- |
+ * | read, download, list                        | seeing the issue (an upload attached to nothing: its uploader)   |
+ * | upload                                      | `pm.attachments` `upload`                                        |
+ * | attach to an issue                          | `upload`, and `pm.issues` `edit` on the issue                    |
+ * | send with a comment                         | `upload`, and `pm.issues` `comment` on the issue                 |
+ * | remove an issue's file                      | its uploader (with `edit`), or `moderate-comments` on the issue  |
+ * | remove a comment's file                     | deleting the comment                                             |
+ *
+ * ## HTTP API (`/api/projects`, signed in)
+ *
+ * | Method and path                          | Body                     | Answer                                           |
+ * | ---------------------------------------- | ------------------------ | ------------------------------------------------ |
+ * | `POST /attachments`                      | multipart, one `file`    | 201 `{ data: Attachment }`, attached to nothing  |
+ * | `GET /attachments/{attachmentId}`        |                          | 200 `{ data: Attachment }`                       |
+ * | `GET /attachments/{attachmentId}/content`| `?download=true` to save | the bytes; safe images inline, others saved      |
+ * | `DELETE /attachments/{attachmentId}`     |                          | 204                                              |
+ * | `GET /issues/{issueId}/attachments`      |                          | `{ data: Attachment[], meta: { total } }`        |
+ * | `POST /issues/{issueId}/attachments`     | multipart, one `file`    | 201 `{ data: Attachment }`, attached to it       |
+ *
+ * `POST /issues/{issueId}/comments` takes `attachmentIds` (`CreateCommentRequest`): the caller's own uploads attached
+ * to nothing, at most `ATTACHMENTS_PER_REQUEST_MAX`, attached in the comment's transaction. Errors: 400
+ * `INVALID_ATTACHMENT` (not an upload of the caller's attached to nothing), 400 `FAILED_PRECONDITION`
+ * `FILES_UNAVAILABLE` (the application stores no files), 413 `FILE_TOO_LARGE`.
+ *
+ * ## Content
+ *
+ * The content route always answers `X-Content-Type-Options: nosniff`, `Content-Security-Policy: sandbox` and
+ * `Cache-Control: private, no-store`. Only raster images whose declared type and extension agree
+ * (`isInlinePreviewable`) are served inline; everything else, SVG and HTML included, is a download.
+ */
+/** Per file, in bytes. */
+export declare const ATTACHMENT_SIZE_MAX: number;
+/** Files sent with one comment, or attached in one request. */
+export declare const ATTACHMENTS_PER_REQUEST_MAX = 10;
+/** How long an upload attached to nothing is kept. */
+export declare const ORPHAN_HOURS = 24;
+/** The raster images shown inline, by extension: the declared type must be the one listed. */
+export declare const INLINE_PREVIEW_TYPES: Readonly<Record<string, string>>;
+/** A safe raster image, whose declared type matches its extension; anything else is only downloaded. */
+export declare function isInlinePreviewable(mimeType: string, ext: string): boolean;
+/** Who uploaded a file: a person, or a principal of another kind (an agent at work). */
+export interface AttachmentUploader {
+    /** A kind's key (`shared/kinds.ts`). */
+    readonly type: string;
+    readonly id: string;
+    readonly name: string | null;
+}
+export interface Attachment {
+    readonly id: string;
+    readonly filename: string;
+    /** Lower case, without the dot; empty when the name has none. */
+    readonly ext: string;
+    /** As the uploader declared it. */
+    readonly mimeType: string;
+    readonly size: number;
+    readonly issueId: string | null;
+    /** Set when it was sent with a comment. */
+    readonly commentId: string | null;
+    readonly uploader: AttachmentUploader;
+    readonly createdAt: string;
+    /** The content route, with the application's base path: shows a safe image inline, downloads anything else. */
+    readonly contentUrl: string;
+    /** The content route, always as a download. */
+    readonly downloadUrl: string;
+    /** A safe raster image the browser may show (`isInlinePreviewable`). */
+    readonly previewable: boolean;
+    /** The reader may remove it now (an issue's own file; a comment's files go with the comment). */
+    readonly canDelete: boolean;
+}
+//# sourceMappingURL=attachments.d.ts.map

package/dist/shared/attachments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.d.ts","sourceRoot":"","sources":["../../shared/attachments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,0BAA0B;AAC1B,eAAO,MAAM,mBAAmB,EAAE,MAAyB,CAAC;AAC5D,+DAA+D;AAC/D,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAC9C,sDAAsD;AACtD,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,8FAA8F;AAC9F,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAOjE,CAAC;AAEF,wGAAwG;AACxG,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAG1E;AAED,wFAAwF;AACxF,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,+GAA+G;IAC/G,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,wEAAwE;IACxE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,iGAAiG;IACjG,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B"}

package/dist/shared/attachments.js

@@ -0,0 +1,61 @@
+/**
+ * Files attached to issues and comments. A file is stored through the file plugin (its bytes on a Drive disk) and
+ * starts out as an upload of its uploader's, attached to nothing; attaching it to an issue (the issue's own files) or
+ * to a comment (sent with the comment) makes it readable by whoever sees the issue. An upload attached to nothing for
+ * `ORPHAN_HOURS` is purged, and so are the files of a deleted comment. Any type of file is accepted, up to
+ * `ATTACHMENT_SIZE_MAX` bytes each.
+ *
+ * ## Who may do what
+ *
+ * | Operation                                   | Needs                                                            |
+ * | ------------------------------------------- | ---------------------------------------------------------------- |
+ * | read, download, list                        | seeing the issue (an upload attached to nothing: its uploader)   |
+ * | upload                                      | `pm.attachments` `upload`                                        |
+ * | attach to an issue                          | `upload`, and `pm.issues` `edit` on the issue                    |
+ * | send with a comment                         | `upload`, and `pm.issues` `comment` on the issue                 |
+ * | remove an issue's file                      | its uploader (with `edit`), or `moderate-comments` on the issue  |
+ * | remove a comment's file                     | deleting the comment                                             |
+ *
+ * ## HTTP API (`/api/projects`, signed in)
+ *
+ * | Method and path                          | Body                     | Answer                                           |
+ * | ---------------------------------------- | ------------------------ | ------------------------------------------------ |
+ * | `POST /attachments`                      | multipart, one `file`    | 201 `{ data: Attachment }`, attached to nothing  |
+ * | `GET /attachments/{attachmentId}`        |                          | 200 `{ data: Attachment }`                       |
+ * | `GET /attachments/{attachmentId}/content`| `?download=true` to save | the bytes; safe images inline, others saved      |
+ * | `DELETE /attachments/{attachmentId}`     |                          | 204                                              |
+ * | `GET /issues/{issueId}/attachments`      |                          | `{ data: Attachment[], meta: { total } }`        |
+ * | `POST /issues/{issueId}/attachments`     | multipart, one `file`    | 201 `{ data: Attachment }`, attached to it       |
+ *
+ * `POST /issues/{issueId}/comments` takes `attachmentIds` (`CreateCommentRequest`): the caller's own uploads attached
+ * to nothing, at most `ATTACHMENTS_PER_REQUEST_MAX`, attached in the comment's transaction. Errors: 400
+ * `INVALID_ATTACHMENT` (not an upload of the caller's attached to nothing), 400 `FAILED_PRECONDITION`
+ * `FILES_UNAVAILABLE` (the application stores no files), 413 `FILE_TOO_LARGE`.
+ *
+ * ## Content
+ *
+ * The content route always answers `X-Content-Type-Options: nosniff`, `Content-Security-Policy: sandbox` and
+ * `Cache-Control: private, no-store`. Only raster images whose declared type and extension agree
+ * (`isInlinePreviewable`) are served inline; everything else, SVG and HTML included, is a download.
+ */
+/** Per file, in bytes. */
+export const ATTACHMENT_SIZE_MAX = 20 * 1024 * 1024;
+/** Files sent with one comment, or attached in one request. */
+export const ATTACHMENTS_PER_REQUEST_MAX = 10;
+/** How long an upload attached to nothing is kept. */
+export const ORPHAN_HOURS = 24;
+/** The raster images shown inline, by extension: the declared type must be the one listed. */
+export const INLINE_PREVIEW_TYPES = {
+    png: 'image/png',
+    jpg: 'image/jpeg',
+    jpeg: 'image/jpeg',
+    gif: 'image/gif',
+    webp: 'image/webp',
+    avif: 'image/avif',
+};
+/** A safe raster image, whose declared type matches its extension; anything else is only downloaded. */
+export function isInlinePreviewable(mimeType, ext) {
+    const type = mimeType.split(';')[0]?.trim().toLowerCase() ?? '';
+    return INLINE_PREVIEW_TYPES[ext.toLowerCase()] === type;
+}
+//# sourceMappingURL=attachments.js.map

package/dist/shared/attachments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.js","sourceRoot":"","sources":["../../shared/attachments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,mBAAmB,GAAW,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAC5D,+DAA+D;AAC/D,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAC9C,sDAAsD;AACtD,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,CAAC;AAE/B,8FAA8F;AAC9F,MAAM,CAAC,MAAM,oBAAoB,GAAqC;IACpE,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,YAAY;IACjB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,YAAY;CACnB,CAAC;AAEF,wGAAwG;AACxG,MAAM,UAAU,mBAAmB,CAAC,QAAgB,EAAE,GAAW;IAC/D,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;IAChE,OAAO,oBAAoB,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,IAAI,CAAC;AAC1D,CAAC"}

package/dist/shared/checklists.d.ts

@@ -0,0 +1,27 @@
+/**
+ * An issue's checklists: when an issue enters a status with a checklist, it gets a copy of the items, kept per status.
+ * Anyone who may edit the issue checks and unchecks them; the issue leaves the status (except to a closed one) only
+ * once the required items are checked.
+ */
+export interface ChecklistItem {
+    readonly itemKey: string;
+    readonly label: string;
+    readonly required: boolean;
+    readonly checked: boolean;
+    readonly checkedByType: string | null;
+    readonly checkedById: string | null;
+    readonly checkedByName: string | null;
+    readonly checkedAt: string | null;
+}
+export interface IssueChecklist {
+    readonly statusKey: string;
+    /** Whether the issue is in this status now. */
+    readonly current: boolean;
+    /** Every required item is checked. */
+    readonly complete: boolean;
+    readonly items: readonly ChecklistItem[];
+}
+export interface UpdateChecklistItemRequest {
+    readonly checked: boolean;
+}
+//# sourceMappingURL=checklists.d.ts.map

package/dist/shared/checklists.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checklists.d.ts","sourceRoot":"","sources":["../../shared/checklists.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IAC/C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,sCAAsC;IACtC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B"}

package/dist/shared/checklists.js

@@ -0,0 +1,7 @@
+/**
+ * An issue's checklists: when an issue enters a status with a checklist, it gets a copy of the items, kept per status.
+ * Anyone who may edit the issue checks and unchecks them; the issue leaves the status (except to a closed one) only
+ * once the required items are checked.
+ */
+export {};
+//# sourceMappingURL=checklists.js.map

package/dist/shared/checklists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checklists.js","sourceRoot":"","sources":["../../shared/checklists.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/shared/comments.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Comments on issues: threads (a root and its replies, flat), Markdown with mentions (`mention://<kind>/<id>`),
+ * reactions and resolved threads. The browser writes plain comments; other plugins write their own kinds through the
+ * server's `CommentWriter`.
+ */
+import type { Attachment } from './attachments.js';
+import type { Page } from './common.js';
+import type { NameText } from './kinds.js';
+export declare const REACTION_EMOJIS: readonly ["👍", "👀", "🎉", "❤️", "🚀", "😄", "🤔", "👎"];
+export type ReactionEmoji = (typeof REACTION_EMOJIS)[number];
+export declare const COMMENT_CONTENT_MAX = 200000;
+/** Threads per page: a page is a number of roots, each with all its replies. */
+export declare const THREAD_PAGE_LIMIT: {
+    readonly default: 30;
+    readonly max: 100;
+};
+/** `GET /api/projects/mentionCandidates`: candidates per request (`pageSize`). */
+export declare const MENTION_CANDIDATE_LIMIT: {
+    readonly default: 8;
+    readonly max: 20;
+};
+/** How much of a comment a notice quotes. */
+export declare const EXCERPT_LENGTH = 200;
+/** The kind the browser writes. */
+export declare const PLAIN_COMMENT = "comment";
+export interface CommentReaction {
+    readonly emoji: ReactionEmoji;
+    readonly count: number;
+    readonly userIds: readonly string[];
+}
+/** Someone or something named in a comment: a kind's key and an id. */
+export interface MentionRef {
+    readonly kind: string;
+    readonly id: string;
+}
+/** One entry of the `@` list. */
+export interface MentionCandidate extends MentionRef {
+    readonly name: string;
+    /** Its name in the viewer's language, when its kind ships one (a built-in agent). */
+    readonly nameText?: NameText;
+    /** A second line, such as an email address. */
+    readonly hint?: string;
+}
+export interface IssueComment {
+    readonly id: string;
+    readonly issueId: string;
+    /** A kind's key (`shared/kinds.ts`). */
+    readonly authorType: string;
+    readonly authorId: string | null;
+    readonly authorName: string | null;
+    /** `comment`, or a kind another plugin writes. */
+    readonly kind: string;
+    /** Markdown; empty once deleted. */
+    readonly content: string;
+    /** The content starts with `/note`: it starts no work. */
+    readonly note: boolean;
+    readonly parentId: string | null;
+    readonly rootId: string;
+    /** How a person wrote it when not by hand in the browser (`agent`: an agent wrote it for them, or their plan did). */
+    readonly via: 'cli' | 'api_key' | 'agent' | null;
+    readonly createdAt: string;
+    readonly editedAt: string | null;
+    readonly deleted: boolean;
+    readonly reactions: readonly CommentReaction[];
+    /** Roots only. */
+    readonly resolvedAt: string | null;
+    readonly resolvedById: string | null;
+    readonly resolvedByName: string | null;
+    /** The files sent with it, oldest first; none once it is deleted. */
+    readonly attachments: readonly Attachment[];
+}
+/** A root comment and its replies, oldest first. */
+export interface CommentThread {
+    readonly root: IssueComment;
+    readonly replies: readonly IssueComment[];
+}
+/**
+ * `GET /api/projects/issues/{issueId}/comments`: the newer threads first page by page, each page oldest first. The
+ * service's page; the API answers `{ data, meta: { nextPageToken? } }`.
+ */
+export type ThreadPage = Page<CommentThread>;
+export interface CreateCommentRequest {
+    readonly content: string;
+    readonly parentId?: string | null;
+    /**
+     * Uploads of the caller's attached to nothing (`POST /api/projects/attachments`), at most
+     * `ATTACHMENTS_PER_REQUEST_MAX`: they are sent with the comment (`shared/attachments.ts`).
+     */
+    readonly attachmentIds?: readonly string[];
+}
+export interface UpdateCommentRequest {
+    readonly content: string;
+}
+/**
+ * `POST /api/projects/issues/{issueId}/comments` answers `{ data: CreateCommentResult }`: the comment and whom it
+ * started work for (empty without a plugin that does).
+ */
+export interface CreateCommentResult {
+    readonly comment: IssueComment;
+    readonly triggered: readonly MentionRef[];
+}
+/** `POST /api/projects/comments/{commentId}/react` and `/unreact`: the comment's reactions after the change. */
+export interface CommentReactions {
+    readonly reactions: readonly CommentReaction[];
+}
+export interface ThreadResolution {
+    readonly commentId: string;
+    readonly resolvedAt: string | null;
+    readonly resolvedById: string | null;
+}
+//# sourceMappingURL=comments.d.ts.map

package/dist/shared/comments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.d.ts","sourceRoot":"","sources":["../../shared/comments.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,eAAO,MAAM,eAAe,2DASlB,CAAC;AACX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,eAAO,MAAM,mBAAmB,SAAU,CAAC;AAC3C,gFAAgF;AAChF,eAAO,MAAM,iBAAiB;;;CAAqC,CAAC;AACpE,kFAAkF;AAClF,eAAO,MAAM,uBAAuB;;;CAAmC,CAAC;AACxE,6CAA6C;AAC7C,eAAO,MAAM,cAAc,MAAM,CAAC;AAClC,mCAAmC;AACnC,eAAO,MAAM,aAAa,YAAY,CAAC;AAEvC,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,uEAAuE;AACvE,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,iCAAiC;AACjC,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,kDAAkD;IAClD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,sHAAsH;IACtH,QAAQ,CAAC,GAAG,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,eAAe,EAAE,CAAC;IAC/C,kBAAkB;IAClB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,qEAAqE;IACrE,QAAQ,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,CAAC;CAC7C;AAED,oDAAoD;AACpD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,UAAU,EAAE,CAAC;CAC3C;AAED,gHAAgH;AAChH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,eAAe,EAAE,CAAC;CAChD;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC"}

package/dist/shared/comments.js

@@ -0,0 +1,20 @@
+export const REACTION_EMOJIS = [
+    '👍',
+    '👀',
+    '🎉',
+    '❤️',
+    '🚀',
+    '😄',
+    '🤔',
+    '👎',
+];
+export const COMMENT_CONTENT_MAX = 200_000;
+/** Threads per page: a page is a number of roots, each with all its replies. */
+export const THREAD_PAGE_LIMIT = { default: 30, max: 100 };
+/** `GET /api/projects/mentionCandidates`: candidates per request (`pageSize`). */
+export const MENTION_CANDIDATE_LIMIT = { default: 8, max: 20 };
+/** How much of a comment a notice quotes. */
+export const EXCERPT_LENGTH = 200;
+/** The kind the browser writes. */
+export const PLAIN_COMMENT = 'comment';
+//# sourceMappingURL=comments.js.map

package/dist/shared/comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.js","sourceRoot":"","sources":["../../shared/comments.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACI,CAAC;AAGX,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAC3C,gFAAgF;AAChF,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAW,CAAC;AACpE,kFAAkF;AAClF,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAW,CAAC;AACxE,6CAA6C;AAC7C,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAC;AAClC,mCAAmC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC"}