canopycms 0.5.0 → 0.7.0

package/dist/api/request-deadline.d.ts

@@ -4,18 +4,26 @@
  * past it, rejects with {@link ApiTimeoutError}: a thrown error, as a network failure is, but
  * distinguishable from one. HTTP error statuses stay `ok: false` responses.
  */
+/**
+ * The longest a gateway in front of the API holds a request before answering 504: CloudFront's
+ * default origin response timeout quota, which canopycms-cdk's `MAX_CLOUDFRONT_ORIGIN_READ_TIMEOUT`
+ * caps its origin at. The two are pinned equal by canopycms-cdk's `request-deadline-pin.test.ts`.
+ * @internal Exported for tests and `create-branch-request.ts`.
+ */
+export declare const GATEWAY_MAX_TIMEOUT_MS = 120000;
+/** @internal Exported for tests. What the browser allows past the gateway's limit before giving up. */
+export declare const GATEWAY_MARGIN_MS = 15000;
 /**
  * @internal Exported for tests.
  *
- * How long each class of request may take. `standard` is past the 60 s an API behind CloudFront
- * gets (canopycms-cdk's `assertOriginReadTimeout`), so a server still working answers, or its
- * proxy's 504 does, before the editor gives up; reads get it too, since any request may first
- * provision the base branch's workspace (`http/handler.ts`). `long` is
- * for the operations that legitimately run longer: branch create, submit, admin scans and
- * repairs, and an upload without progress.
+ * How long each class of request may take. `standard` is past {@link GATEWAY_MAX_TIMEOUT_MS}, so
+ * a server still working answers, or its proxy's 504 does, before the editor gives up; reads get
+ * it too, since any request may first provision the base branch's workspace (`http/handler.ts`).
+ * `long` is for the operations that legitimately run longer: branch create, submit, admin scans
+ * and repairs, and an upload without progress.
  */
 export declare const REQUEST_TIMEOUT_MS: {
-    readonly standard: 75000;
+    readonly standard: number;
     readonly long: 180000;
 };
 /** An endpoint's timeout class; `none` waits as long as the browser does. */

package/dist/api/request-deadline.js

@@ -4,18 +4,26 @@
  * past it, rejects with {@link ApiTimeoutError}: a thrown error, as a network failure is, but
  * distinguishable from one. HTTP error statuses stay `ok: false` responses.
  */
+/**
+ * The longest a gateway in front of the API holds a request before answering 504: CloudFront's
+ * default origin response timeout quota, which canopycms-cdk's `MAX_CLOUDFRONT_ORIGIN_READ_TIMEOUT`
+ * caps its origin at. The two are pinned equal by canopycms-cdk's `request-deadline-pin.test.ts`.
+ * @internal Exported for tests and `create-branch-request.ts`.
+ */
+export const GATEWAY_MAX_TIMEOUT_MS = 120_000;
+/** @internal Exported for tests. What the browser allows past the gateway's limit before giving up. */
+export const GATEWAY_MARGIN_MS = 15_000;
 /**
  * @internal Exported for tests.
  *
- * How long each class of request may take. `standard` is past the 60 s an API behind CloudFront
- * gets (canopycms-cdk's `assertOriginReadTimeout`), so a server still working answers, or its
- * proxy's 504 does, before the editor gives up; reads get it too, since any request may first
- * provision the base branch's workspace (`http/handler.ts`). `long` is
- * for the operations that legitimately run longer: branch create, submit, admin scans and
- * repairs, and an upload without progress.
+ * How long each class of request may take. `standard` is past {@link GATEWAY_MAX_TIMEOUT_MS}, so
+ * a server still working answers, or its proxy's 504 does, before the editor gives up; reads get
+ * it too, since any request may first provision the base branch's workspace (`http/handler.ts`).
+ * `long` is for the operations that legitimately run longer: branch create, submit, admin scans
+ * and repairs, and an upload without progress.
  */
 export const REQUEST_TIMEOUT_MS = {
-    standard: 75_000,
+    standard: GATEWAY_MAX_TIMEOUT_MS + GATEWAY_MARGIN_MS,
     long: 180_000,
 };
 /** @internal Exported for tests. A timed-out read's message: retrying it is safe. */

package/dist/api/schema.d.ts

@@ -185,14 +185,14 @@ export declare const createCollection: import("./route-builder.js").RouteDefinit
         maxItems: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         name: string;
-        format: "mdx" | "md" | "json" | "yaml";
+        format: "md" | "mdx" | "json" | "yaml";
         schema: string;
         default?: boolean | undefined;
         label?: string | undefined;
         maxItems?: number | undefined;
     }, {
         name: string;
-        format: "mdx" | "md" | "json" | "yaml";
+        format: "md" | "mdx" | "json" | "yaml";
         schema: string;
         default?: boolean | undefined;
         label?: string | undefined;
@@ -202,7 +202,7 @@ export declare const createCollection: import("./route-builder.js").RouteDefinit
     name: string;
     entries: {
         name: string;
-        format: "mdx" | "md" | "json" | "yaml";
+        format: "md" | "mdx" | "json" | "yaml";
         schema: string;
         default?: boolean | undefined;
         label?: string | undefined;
@@ -214,7 +214,7 @@ export declare const createCollection: import("./route-builder.js").RouteDefinit
     name: string;
     entries: {
         name: string;
-        format: "mdx" | "md" | "json" | "yaml";
+        format: "md" | "mdx" | "json" | "yaml";
         schema: string;
         default?: boolean | undefined;
         label?: string | undefined;
@@ -315,14 +315,14 @@ export declare const addEntryType: import("./route-builder.js").RouteDefinition<
     maxItems: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    format: "mdx" | "md" | "json" | "yaml";
+    format: "md" | "mdx" | "json" | "yaml";
     schema: string;
     default?: boolean | undefined;
     label?: string | undefined;
     maxItems?: number | undefined;
 }, {
     name: string;
-    format: "mdx" | "md" | "json" | "yaml";
+    format: "md" | "mdx" | "json" | "yaml";
     schema: string;
     default?: boolean | undefined;
     label?: string | undefined;
@@ -361,13 +361,13 @@ export declare const updateEntryType: import("./route-builder.js").RouteDefiniti
     maxItems: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     default?: boolean | undefined;
-    format?: "mdx" | "md" | "json" | "yaml" | undefined;
+    format?: "md" | "mdx" | "json" | "yaml" | undefined;
     label?: string | undefined;
     maxItems?: number | undefined;
     schema?: string | undefined;
 }, {
     default?: boolean | undefined;
-    format?: "mdx" | "md" | "json" | "yaml" | undefined;
+    format?: "md" | "mdx" | "json" | "yaml" | undefined;
     label?: string | undefined;
     maxItems?: number | undefined;
     schema?: string | undefined;
@@ -482,14 +482,14 @@ export declare const SCHEMA_ROUTES: {
             maxItems: z.ZodOptional<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
             name: string;
-            format: "mdx" | "md" | "json" | "yaml";
+            format: "md" | "mdx" | "json" | "yaml";
             schema: string;
             default?: boolean | undefined;
             label?: string | undefined;
             maxItems?: number | undefined;
         }, {
             name: string;
-            format: "mdx" | "md" | "json" | "yaml";
+            format: "md" | "mdx" | "json" | "yaml";
             schema: string;
             default?: boolean | undefined;
             label?: string | undefined;
@@ -499,7 +499,7 @@ export declare const SCHEMA_ROUTES: {
         name: string;
         entries: {
             name: string;
-            format: "mdx" | "md" | "json" | "yaml";
+            format: "md" | "mdx" | "json" | "yaml";
             schema: string;
             default?: boolean | undefined;
             label?: string | undefined;
@@ -511,7 +511,7 @@ export declare const SCHEMA_ROUTES: {
         name: string;
         entries: {
             name: string;
-            format: "mdx" | "md" | "json" | "yaml";
+            format: "md" | "mdx" | "json" | "yaml";
             schema: string;
             default?: boolean | undefined;
             label?: string | undefined;
@@ -597,14 +597,14 @@ export declare const SCHEMA_ROUTES: {
         maxItems: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         name: string;
-        format: "mdx" | "md" | "json" | "yaml";
+        format: "md" | "mdx" | "json" | "yaml";
         schema: string;
         default?: boolean | undefined;
         label?: string | undefined;
         maxItems?: number | undefined;
     }, {
         name: string;
-        format: "mdx" | "md" | "json" | "yaml";
+        format: "md" | "mdx" | "json" | "yaml";
         schema: string;
         default?: boolean | undefined;
         label?: string | undefined;
@@ -638,13 +638,13 @@ export declare const SCHEMA_ROUTES: {
         maxItems: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         default?: boolean | undefined;
-        format?: "mdx" | "md" | "json" | "yaml" | undefined;
+        format?: "md" | "mdx" | "json" | "yaml" | undefined;
         label?: string | undefined;
         maxItems?: number | undefined;
         schema?: string | undefined;
     }, {
         default?: boolean | undefined;
-        format?: "mdx" | "md" | "json" | "yaml" | undefined;
+        format?: "md" | "mdx" | "json" | "yaml" | undefined;
         label?: string | undefined;
         maxItems?: number | undefined;
         schema?: string | undefined;

package/dist/authorization/review-role.d.ts

@@ -0,0 +1,33 @@
+import type { PullRequestState } from '../types.js';
+/** What the review role depends on in a branch, whichever component holds it. */
+export interface ReviewedBranch {
+    status: string | undefined;
+    createdBy: string | undefined;
+    /** Users on the branch's access list. */
+    users?: readonly string[];
+    /** Groups on the branch's access list. */
+    groups?: readonly string[];
+    /** The protected base branch, which is never approved: Withdraw recovers one stuck in review. */
+    isProtected?: boolean;
+    /** A closed pull request cannot be approved or sent back; the way forward is Withdraw. */
+    pullRequestState?: PullRequestState;
+}
+/**
+ * How `user` relates to `branch`'s review. A reviewer or admin who neither made the branch nor was
+ * given access to it by name or by group, on a submitted or approved branch that is not the
+ * protected base branch, is `reviewing`: Approve (on a submitted branch) and Request changes
+ * lead instead of Withdraw, which stays in the card's "…" menu. With a closed pull request the same user is `reviewing-closed`, since there is
+ * nothing to approve and Withdraw is the way forward. Anyone else is `none`.
+ */
+export type ReviewRole = 'reviewing' | 'reviewing-closed' | 'none';
+export declare function reviewRoleOf(branch: ReviewedBranch, user: {
+    userId: string;
+    groups?: readonly string[];
+} | undefined): ReviewRole;
+/** Whether `user` reviews `branch`, so its review actions lead; see {@link reviewRoleOf}. */
+export declare const isReviewerOfOthersReview: (branch: ReviewedBranch, user: {
+    userId: string;
+    groups?: readonly string[];
+} | undefined) => boolean;
+/** Longest note a reviewer can attach to a request for changes; the editor's field and the API share it. */
+export declare const REQUEST_CHANGES_NOTE_MAX_LENGTH = 2000;

package/dist/authorization/review-role.js

@@ -0,0 +1,17 @@
+import { isReviewer } from './helpers.js';
+export function reviewRoleOf(branch, user) {
+    const reviews = !!user &&
+        isReviewer(user.groups) &&
+        !branch.isProtected &&
+        (branch.status === 'submitted' || branch.status === 'approved') &&
+        branch.createdBy !== user.userId &&
+        !branch.users?.includes(user.userId) &&
+        !user.groups?.some((g) => branch.groups?.includes(g));
+    if (!reviews)
+        return 'none';
+    return branch.pullRequestState === 'closed' ? 'reviewing-closed' : 'reviewing';
+}
+/** Whether `user` reviews `branch`, so its review actions lead; see {@link reviewRoleOf}. */
+export const isReviewerOfOthersReview = (branch, user) => reviewRoleOf(branch, user) === 'reviewing';
+/** Longest note a reviewer can attach to a request for changes; the editor's field and the API share it. */
+export const REQUEST_CHANGES_NOTE_MAX_LENGTH = 2000;

package/dist/branch-metadata-file.d.ts

@@ -51,6 +51,7 @@ export declare const branchMetadataSchema: z.ZodObject<{
     pullRequestNumber: z.ZodOptional<z.ZodNumber>;
     submittedAt: z.ZodOptional<z.ZodString>;
     pushedToGitHubAt: z.ZodOptional<z.ZodString>;
+    editorUrl: z.ZodOptional<z.ZodString>;
     syncStatus: z.ZodOptional<z.ZodNativeEnum<{
         synced: "synced";
         "pending-sync": "pending-sync";
@@ -115,6 +116,7 @@ export declare const branchMetadataSchema: z.ZodObject<{
     pullRequestNumber: z.ZodOptional<z.ZodNumber>;
     submittedAt: z.ZodOptional<z.ZodString>;
     pushedToGitHubAt: z.ZodOptional<z.ZodString>;
+    editorUrl: z.ZodOptional<z.ZodString>;
     syncStatus: z.ZodOptional<z.ZodNativeEnum<{
         synced: "synced";
         "pending-sync": "pending-sync";
@@ -179,6 +181,7 @@ export declare const branchMetadataSchema: z.ZodObject<{
     pullRequestNumber: z.ZodOptional<z.ZodNumber>;
     submittedAt: z.ZodOptional<z.ZodString>;
     pushedToGitHubAt: z.ZodOptional<z.ZodString>;
+    editorUrl: z.ZodOptional<z.ZodString>;
     syncStatus: z.ZodOptional<z.ZodNativeEnum<{
         synced: "synced";
         "pending-sync": "pending-sync";

package/dist/branch-metadata-file.js

@@ -60,6 +60,7 @@ const branchMetadataShape = {
     pullRequestNumber: z.number().int().optional(),
     submittedAt: z.string().optional(),
     pushedToGitHubAt: z.string().optional(),
+    editorUrl: z.string().optional(),
     syncStatus: enumOf({
         synced: 'synced',
         'pending-sync': 'pending-sync',