@tomradex/build-page 0.0.0-stage → 0.26.0

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Haoyuan Tang
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { BuildPage, BuildPage as default, MIGRATIONS, TABLES, type BuildPagePreview, type BuildPagePublished, type BuildPageState } from "./service.js";
+export { candidates, content, feedbackUrl, renderPage, GENERATOR, type Candidate, type PageConfig, type PageContent, type Section } from "./page.js";
+export { publishPages, BRANCH, type Api, type PublishOutcome } from "./publish.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/page.d.ts

@@ -0,0 +1,57 @@
+import type { Item } from "@tomradex/domain";
+import type { BuildPageWords } from "./words.js";
+/** What a person chose for a project's page. Nothing is ticked until they tick it. */
+export interface PageConfig {
+    /** "owner/repo" the page is published to and feedback is filed in. */
+    repo: string | null;
+    title: string;
+    /** "Built with Tomrade" at the foot of the page. */
+    footer: boolean;
+    /** Ticked item ids: open ones go on the roadmap, merged ones in the changelog. */
+    picks: string[];
+}
+export type Section = "roadmap" | "changelog";
+/** A ticket that may go on the page, and where it would. */
+export interface Candidate {
+    id: string;
+    key: string;
+    title: string;
+    status: Item["status"];
+    section: Section;
+    /** When its code was merged, for the changelog. */
+    mergedAt: number | null;
+}
+/** Marks a page this package wrote, so a site someone else put on gh-pages is never overwritten. */
+export declare const GENERATOR = "Tomrade build page";
+/**
+ * The tickets a person may tick: open tickets for the roadmap, done tickets
+ * whose code was merged for the changelog. Epics and cancelled work are not offered.
+ */
+export declare function candidates(items: Item[], mergedAt: ReadonlyMap<string, number>): Candidate[];
+export interface PageContent {
+    title: string;
+    repo: string;
+    /** BCP 47 tag of the page's language. */
+    lang: string;
+    now: {
+        title: string;
+    }[];
+    next: {
+        title: string;
+    }[];
+    changelog: {
+        date: string;
+        titles: string[];
+    }[];
+    feedbackUrl: string;
+    footer: boolean;
+    updated: string;
+}
+/** Only ticked candidates reach the page; only their titles leave the machine. */
+export declare function content(config: PageConfig & {
+    repo: string;
+}, offered: Candidate[], lang: string, at: number, w: BuildPageWords): PageContent;
+export declare function feedbackUrl(repo: string, w: BuildPageWords): string;
+/** One self-contained page: no script, no request beyond the feedback link. */
+export declare function renderPage(page: PageContent, w: BuildPageWords): string;
+//# sourceMappingURL=page.d.ts.map

package/dist/publish.d.ts

@@ -0,0 +1,33 @@
+/** The REST calls publishing needs, as `ctx.github.api` makes them. */
+export interface Api {
+    request<T>(method: string, route: string, body?: unknown): Promise<T>;
+}
+export declare const BRANCH = "gh-pages";
+export type PublishOutcome = {
+    ok: true;
+    url: string | null;
+    commit: string;
+    pages: "served" | "enabled";
+} | {
+    ok: true;
+    url: string | null;
+    commit: string;
+    pages: "elsewhere";
+    source: string;
+} | {
+    ok: true;
+    url: null;
+    commit: string;
+    pages: "failed";
+    why: string;
+} | {
+    ok: false;
+    reason: "foreign";
+};
+/**
+ * Writes `files` onto the repository's gh-pages branch through the Git Data
+ * API, keeping whatever else the branch holds, then makes sure GitHub Pages
+ * serves that branch. A gh-pages index that Tomrade did not write is left alone.
+ */
+export declare function publishPages(api: Api, repo: string, files: Record<string, string>, message: string): Promise<PublishOutcome>;
+//# sourceMappingURL=publish.d.ts.map

package/dist/runtime.js

@@ -0,0 +1 @@
+throw new Error("@tomradex/build-page is Tomrade's own code: a full-mode plugin gets the running app's copy, so load the plugin in Tomrade");

package/dist/service.d.ts

@@ -0,0 +1,72 @@
+import { Context, Service } from "cordis";
+import { type Candidate, type PageConfig } from "./page.js";
+declare module "cordis" {
+    interface Context {
+        buildPage: BuildPage;
+    }
+}
+declare module "@tomradex/ipc" {
+    interface Channels {
+        "buildPage.state": (projectId: string) => BuildPageState;
+        "buildPage.preview": (projectId: string, config: PageConfig) => BuildPagePreview;
+        "buildPage.publish": (projectId: string, previewId: string) => BuildPagePublished;
+    }
+}
+export interface BuildPageState {
+    config: PageConfig;
+    candidates: Candidate[];
+    /** The project's GitHub repositories, "owner/repo". */
+    repos: string[];
+    connected: boolean;
+    published: {
+        url: string | null;
+        at: number;
+    } | null;
+}
+export interface BuildPagePreview {
+    id: string;
+    /** Exactly what publishing writes as index.html. */
+    html: string;
+    roadmap: number;
+    changelog: number;
+}
+export interface BuildPagePublished {
+    url: string | null;
+    /** What still needs the person, in their language; null when the page is live. */
+    warning: string | null;
+}
+export declare const MIGRATIONS: {
+    version: number;
+    up: string;
+}[];
+/** What was ticked travels with the project, so every machine publishes the same page. */
+export declare const TABLES: {
+    readonly plugin_buildpage_projects: {
+        readonly project: "project_id";
+        readonly export: {
+            readonly order: "project_id";
+        };
+    };
+};
+/**
+ * The public build page: the roadmap and changelog a person ticked, and a way
+ * to send feedback, rendered to one static page and published to their own
+ * repository's GitHub Pages. Feedback opens an issue there, which the GitHub
+ * inbox source brings into the Inbox. A page is published only as it was previewed.
+ */
+export declare class BuildPage extends Service {
+    static inject: string[];
+    private readonly home;
+    private readonly previews;
+    constructor(ctx: Context);
+    [Service.init](): void;
+    private words;
+    private row;
+    private repos;
+    private offered;
+    state(projectId: string): Promise<BuildPageState>;
+    /** Saves what was ticked and renders the page; publishing takes this preview's id and writes exactly its html. */
+    preview(projectId: string, config: PageConfig): Promise<BuildPagePreview>;
+    publish(projectId: string, previewId: string): Promise<BuildPagePublished>;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/words.d.ts

@@ -0,0 +1,23 @@
+export declare const BUILD_PAGE_WORDS: import("@tomradex/domain").WordBook<{
+    readonly roadmap: "Roadmap";
+    readonly inProgress: "In progress";
+    readonly planned: "Planned";
+    readonly changelog: "Changelog";
+    readonly nothingYet: "Nothing here yet.";
+    readonly feedback: "Feedback";
+    readonly feedbackLede: "Found a bug or have an idea? Tell us in a GitHub issue — you'll hear back there when it ships.";
+    readonly feedbackButton: "Send feedback";
+    readonly feedbackFooter: "Sent from the public build page.";
+    readonly builtWith: "Built with";
+    readonly updated: "Updated {{date}}";
+    readonly noRepo: "This project has no GitHub repository to publish to. Add one to the project first.";
+    readonly notConnected: "Connect a GitHub account in Settings first.";
+    readonly stale: "The preview is out of date. Preview again, then publish.";
+    readonly noPreview: "Preview the page before publishing it.";
+    readonly foreignSite: "The gh-pages branch of {{repo}} already holds a site Tomrade did not make, so nothing was published.";
+    readonly pagesElsewhere: "Published to the gh-pages branch, but GitHub Pages for {{repo}} serves {{source}}. Switch it to gh-pages in the repository's Pages settings.";
+    readonly pagesFailed: "Published to the gh-pages branch, but GitHub Pages could not be turned on: {{why}}";
+    readonly commit: "Update the public build page";
+}>;
+export type BuildPageWords = ReturnType<typeof BUILD_PAGE_WORDS>;
+//# sourceMappingURL=words.d.ts.map

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@tomradex/build-page",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.26.0",
+  "type": "module",
+  "author": "Haoyuan Tang",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "description": "The public build page: the roadmap, changelog and feedback link a person ticked, rendered to one static page and published to their own repository's GitHub Pages — declarations for full-mode plugins; Tomrade provides the code at run time",
+  "keywords": [
+    "tomrade",
+    "tomrade-plugin",
+    "types"
+  ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/runtime.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tomradex/contracts": "0.26.0",
+    "@tomradex/db": "0.26.0",
+    "@tomradex/domain": "0.2.33",
+    "@tomradex/github": "0.26.0",
+    "@tomradex/inbox-github": "0.26.0",
+    "@tomradex/ipc": "0.26.0",
+    "@tomradex/items": "0.26.0",
+    "@tomradex/projects": "0.26.0",
+    "@tomradex/repos": "0.26.0",
+    "@tomradex/settings": "0.26.0",
+    "cordis": "4.0.0-rc.8"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.