@promptbook/cli 0.113.0-1 → 0.113.0-11

package/apps/agents-server/src/utils/vpsSelfUpdate/vpsSelfUpdateTypes.ts

@@ -0,0 +1,452 @@
+import type { VpsSelfUpdateEnvironmentOption } from './vpsSelfUpdateEnvironment';
+
+/**
+ * Persisted self-update job status.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateJobStatus = 'idle' | 'running' | 'succeeded' | 'failed';
+
+/**
+ * Source that started one standalone VPS self-update run.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateJobTrigger = 'manual' | 'automatic';
+
+/**
+ * Browser-safe automatic self-update configuration.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateAutomaticConfiguration = {
+    /**
+     * Whether scheduled branch updates are enabled.
+     */
+    readonly isEnabled: boolean;
+    /**
+     * Branch environment tracked by the automatic scheduler.
+     */
+    readonly environment: VpsSelfUpdateEnvironmentOption;
+    /**
+     * Cron expression controlling how often the scheduler checks the tracked branch.
+     */
+    readonly cronExpression: string;
+};
+
+/**
+ * Persisted database migration status inside one standalone VPS self-update run.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateDatabaseMigrationStatus =
+    | 'pending'
+    | 'running'
+    | 'succeeded'
+    | 'failed'
+    | 'skipped'
+    | 'unknown';
+
+/**
+ * Browser-safe database migration summary for one table prefix.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateDatabaseMigrationPrefixSummary = {
+    /**
+     * Prefix that was processed.
+     */
+    readonly prefix: string;
+    /**
+     * Number of newly applied migration files.
+     */
+    readonly appliedCount: number;
+    /**
+     * Migration filenames newly applied for this prefix.
+     */
+    readonly appliedMigrationFiles: ReadonlyArray<string>;
+};
+
+/**
+ * Browser-safe database migration snapshot recorded during one standalone VPS self-update run.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateDatabaseMigrationSnapshot = {
+    /**
+     * Last known migration status inside the update job.
+     */
+    readonly status: VpsSelfUpdateDatabaseMigrationStatus;
+    /**
+     * Prefixes that were processed by the migration runner.
+     */
+    readonly processedPrefixes: ReadonlyArray<string>;
+    /**
+     * Number of SQL migration files discovered on disk, or `null` when not recorded yet.
+     */
+    readonly totalMigrationFiles: number | null;
+    /**
+     * Per-prefix summary from the migration runner.
+     */
+    readonly perPrefix: ReadonlyArray<VpsSelfUpdateDatabaseMigrationPrefixSummary>;
+    /**
+     * Whether migration execution was skipped because another process already held the advisory lock.
+     */
+    readonly isSkippedDueToActiveMigrationLock: boolean | null;
+    /**
+     * Error message when the migration step failed.
+     */
+    readonly errorMessage: string | null;
+    /**
+     * Absolute migration-summary file path when known.
+     */
+    readonly summaryFilePath: string | null;
+};
+
+/**
+ * Snapshot of the latest standalone VPS self-update job.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateJobSnapshot = {
+    /**
+     * Stable identifier of one self-update run.
+     */
+    readonly jobId: string | null;
+    /**
+     * Last known job status.
+     */
+    readonly status: VpsSelfUpdateJobStatus;
+    /**
+     * Whether the job was started manually from the Update page or by the automatic scheduler.
+     */
+    readonly trigger: VpsSelfUpdateJobTrigger;
+    /**
+     * Background process id when available.
+     */
+    readonly pid: number | null;
+    /**
+     * Selected target branch for the running or last completed job.
+     */
+    readonly targetBranch: string | null;
+    /**
+     * Resolved target environment metadata.
+     */
+    readonly targetEnvironment: VpsSelfUpdateEnvironmentOption;
+    /**
+     * Human-readable current step.
+     */
+    readonly currentStep: string | null;
+    /**
+     * Current deployed commit recorded by the installer script.
+     */
+    readonly currentCommitSha: string | null;
+    /**
+     * Target remote commit recorded by the installer script.
+     */
+    readonly targetCommitSha: string | null;
+    /**
+     * Error message when the job failed.
+     */
+    readonly errorMessage: string | null;
+    /**
+     * Start time of the job in ISO format.
+     */
+    readonly startedAt: string | null;
+    /**
+     * Finish time of the job in ISO format.
+     */
+    readonly finishedAt: string | null;
+    /**
+     * Whether the job claims to be running even though its process is gone.
+     */
+    readonly isStale: boolean;
+    /**
+     * Tail of the persisted installer log.
+     */
+    readonly logTail: string | null;
+    /**
+     * Absolute log-file path when known.
+     */
+    readonly logFilePath: string | null;
+    /**
+     * Database migration status and summary recorded during this update job.
+     */
+    readonly databaseMigrations: VpsSelfUpdateDatabaseMigrationSnapshot;
+};
+
+/**
+ * Browser-safe summary of one Agents Server version installed in the releases directory.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateInstalledVersion = {
+    /**
+     * Release directory name (short commit hash or release tag, e.g. `10dbbe7` or `0.101.0`).
+     */
+    readonly name: string;
+    /**
+     * Absolute path of the installed version directory.
+     */
+    readonly directoryPath: string;
+    /**
+     * Last modification time of the version directory in ISO format, or `null` when unknown.
+     */
+    readonly modifiedAt: string | null;
+    /**
+     * Whether this version is the currently deployed one.
+     */
+    readonly isCurrent: boolean;
+};
+
+/**
+ * Browser-safe self-update overview shown on the Update page.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateOverview = {
+    /**
+     * Whether self-update can run on the current host.
+     */
+    readonly isAvailable: boolean;
+    /**
+     * Human-readable reason when self-update is unavailable.
+     */
+    readonly unavailableReason: string | null;
+    /**
+     * Available deployment environments.
+     */
+    readonly environments: ReadonlyArray<VpsSelfUpdateEnvironmentOption>;
+    /**
+     * Currently configured deployment environment.
+     */
+    readonly currentEnvironment: VpsSelfUpdateEnvironmentOption;
+    /**
+     * Absolute path to the managed Promptbook repository.
+     */
+    readonly repositoryDirectory: string | null;
+    /**
+     * Current local repository commit.
+     */
+    readonly currentCommitSha: string | null;
+    /**
+     * Short local repository commit.
+     */
+    readonly currentCommitShortSha: string | null;
+    /**
+     * Current local repository commit subject.
+     */
+    readonly currentCommitMessage: string | null;
+    /**
+     * Author timestamp of the currently deployed commit in ISO format.
+     */
+    readonly currentCommitDate: string | null;
+    /**
+     * Latest remote commit on the selected branch.
+     */
+    readonly latestRemoteCommitSha: string | null;
+    /**
+     * Short latest remote commit.
+     */
+    readonly latestRemoteCommitShortSha: string | null;
+    /**
+     * Author timestamp of the latest remote commit in ISO format.
+     */
+    readonly latestRemoteCommitDate: string | null;
+    /**
+     * Latest remote commit subject.
+     */
+    readonly latestRemoteCommitMessage: string | null;
+    /**
+     * Number of commits the deployed checkout is behind the latest remote commit, or `null` when unknown.
+     */
+    readonly commitsBehindCount: number | null;
+    /**
+     * Commits that the deployed checkout is behind the latest remote commit (newest first).
+     */
+    readonly pendingCommits: ReadonlyArray<VpsSelfUpdatePendingCommit>;
+    /**
+     * Whether the remote branch contains a newer commit than the deployed checkout.
+     */
+    readonly isUpdateAvailable: boolean;
+    /**
+     * Configured upstream repository URL (defaults to `webgptorg/promptbook`).
+     */
+    readonly originRepositoryUrl: string;
+    /**
+     * Whether the configured origin matches the default upstream repository.
+     */
+    readonly isOriginRepositoryDefault: boolean;
+    /**
+     * Default upstream repository URL.
+     */
+    readonly defaultOriginRepositoryUrl: string;
+    /**
+     * Automatic self-update configuration persisted in the standalone VPS `.env` file.
+     */
+    readonly automaticConfiguration: VpsSelfUpdateAutomaticConfiguration;
+    /**
+     * Agents Server versions installed in the releases directory (newest first, current version included).
+     */
+    readonly installedVersions: ReadonlyArray<VpsSelfUpdateInstalledVersion>;
+    /**
+     * Total number of installed versions kept by automatic garbage collection (`AGENTS_SERVER_GC_KEEP_VERSIONS`).
+     */
+    readonly garbageCollectionKeepVersionsCount: number;
+    /**
+     * Latest persisted update-job state.
+     */
+    readonly job: VpsSelfUpdateJobSnapshot;
+};
+
+/**
+ * Repository state used to resolve a persisted self-update job for the browser overview.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateJobOverviewContext = {
+    /**
+     * Environment currently configured in the running Agents Server.
+     */
+    readonly currentEnvironment: VpsSelfUpdateEnvironmentOption;
+    /**
+     * Current local repository commit observed by the running server.
+     */
+    readonly currentCommitSha: string | null;
+};
+
+/**
+ * Request payload accepted by `startVpsSelfUpdate`.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateStartRequest = {
+    /**
+     * Predefined environment id (e.g. `production`) or `custom` to target an arbitrary ref.
+     */
+    readonly environmentId: string;
+    /**
+     * Optional arbitrary commit hash, tag, or branch used when `environmentId === 'custom'`.
+     */
+    readonly customRef?: string | null;
+    /**
+     * Optional override of the upstream repository URL (must be a `https://` git URL).
+     */
+    readonly originRepositoryUrl?: string | null;
+    /**
+     * Source that started the update. Defaults to `manual`.
+     */
+    readonly trigger?: VpsSelfUpdateJobTrigger;
+};
+
+/**
+ * Browser-safe summary of one commit that the deployed checkout is behind the latest remote commit.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdatePendingCommit = {
+    /**
+     * Full commit hash.
+     */
+    readonly commitSha: string;
+    /**
+     * Short commit hash (first 7 chars).
+     */
+    readonly shortCommitSha: string;
+    /**
+     * Single-line commit subject.
+     */
+    readonly subject: string;
+    /**
+     * Author timestamp in ISO format or `null` when unknown.
+     */
+    readonly authoredAt: string | null;
+};
+
+/**
+ * Browser-safe metadata read from one git commit object.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateCommitMetadata = {
+    /**
+     * Full commit hash.
+     */
+    readonly commitSha: string;
+    /**
+     * Single-line commit subject.
+     */
+    readonly subject: string;
+    /**
+     * Author timestamp in ISO format or `null` when unknown.
+     */
+    readonly authoredAt: string | null;
+};
+
+/**
+ * Browser-safe summary of one commit that the super admin can pick from the custom-target picker.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateCandidateCommit = {
+    /**
+     * Full commit hash.
+     */
+    readonly commitSha: string;
+    /**
+     * Short commit hash (first 7 chars).
+     */
+    readonly shortCommitSha: string;
+    /**
+     * Single-line commit subject.
+     */
+    readonly subject: string;
+    /**
+     * Author name.
+     */
+    readonly authorName: string;
+    /**
+     * Author email.
+     */
+    readonly authorEmail: string;
+    /**
+     * Author timestamp in ISO format.
+     */
+    readonly authoredAt: string;
+    /**
+     * Branches that point at this commit (origin-prefixed names stripped).
+     */
+    readonly branches: ReadonlyArray<string>;
+    /**
+     * Tags that point at this commit.
+     */
+    readonly tags: ReadonlyArray<string>;
+    /**
+     * Whether at least one tag points at the commit (used to flag stable releases).
+     */
+    readonly isReleaseTag: boolean;
+};
+
+/**
+ * Filter applied to the candidate-commit listing.
+ *
+ * @private type of `vpsSelfUpdate`
+ */
+export type VpsSelfUpdateCandidateCommitsFilter = {
+    /**
+     * Free-text search across subject, author name, hash, branch and tag names.
+     */
+    readonly searchText?: string | null;
+    /**
+     * Restrict to commits authored on or after this ISO date.
+     */
+    readonly authoredAfter?: string | null;
+    /**
+     * Restrict to commits authored on or before this ISO date.
+     */
+    readonly authoredBefore?: string | null;
+    /**
+     * Hard limit on returned commits (default 200).
+     */
+    readonly limit?: number | null;
+};