@owlmeans/viable-common 0.0.46 → 0.0.47

package/src/connect/errors.ts

@@ -93,6 +93,23 @@ export class ConnectOpUnknown extends ConnectError {
   }
 }
 
+/**
+ * A delegated write answered early (`{ pending }`) whose outcome was never recorded: the platform
+ * process holding it stopped and its heartbeat went stale (`CONNECT_CALL_LOST_MS`). Whether it took
+ * effect is unknown, so it is read from the domain's status before anything is repeated. The message
+ * carries the call id. Answered 410 — the outcome is gone, not merely late.
+ */
+export class ConnectCallLost extends ConnectError {
+  public static override typeName = `CallLost${ConnectError.typeName}`
+  /** The call's outcome is gone: answered 410. */
+  public static httpStatus = 410
+
+  constructor(message: string = 'error') {
+    super(`call-lost:${message}`)
+    this.type = ConnectCallLost.typeName
+  }
+}
+
 /**
  * The organization cannot pay for the action a connector just asked for.
  *
@@ -272,6 +289,7 @@ ResilientError.registerErrorClass(ConnectOpTimeout)
 ResilientError.registerErrorClass(ConnectOpRefused)
 ResilientError.registerErrorClass(LocalSlotUnsupported)
 ResilientError.registerErrorClass(ConnectOpUnknown)
+ResilientError.registerErrorClass(ConnectCallLost)
 ResilientError.registerErrorClass(ConnectOutOfCredits)
 ResilientError.registerErrorClass(ConnectConsentRequired)
 ResilientError.registerErrorClass(ConnectConfirmationRequired)

package/src/connect/feed/types.ts

@@ -0,0 +1,76 @@
+import type { ConnectFeedDetail, ConnectFeedKind } from '../consts.js'
+
+/**
+ * One feed entry before it has a position — what the platform appends. Small by construction: a
+ * projection of the event, never the record behind it (no namespace, no workload, no credential), and
+ * prose cut to a bounded excerpt.
+ */
+export interface ConnectFeedRecord {
+  kind: ConnectFeedKind
+  /** When it happened, ISO 8601. */
+  at: string
+  /** The model call or platform step it belongs to. */
+  run?: string
+  /** The project it belongs to — on an organization notice, the project it is about, if any. */
+  projectId?: string
+  /** The story it belongs to. */
+  storyId?: string
+  /** The workload it belongs to. */
+  slotId?: string
+  /** The platform's own name for the step, model call or notice. */
+  action?: string
+  /** The platform agent that did it. */
+  agent?: string
+  /** Prose: a model excerpt, a notice, a step's note — bounded. */
+  text?: string
+  /** A small structured detail of the kind: a step's index, a card's status, a file's path. */
+  data?: Record<string, unknown>
+}
+
+/** One feed entry as a read answers it: the record and its position. */
+export interface ConnectFeedEntry extends ConnectFeedRecord {
+  /** The entry's position — the cursor to read after it. */
+  id: string
+}
+
+/** What one feed read answers. */
+export interface ConnectFeedPage {
+  /**
+   * The cursor to pass as `after` on the next read: the last entry this read SCANNED (a filtered-out
+   * entry included), or the cursor it was given when nothing came. A feed that had nothing yet
+   * answers `CONNECT_FEED_START`.
+   */
+  cursor: string
+  entries: ConnectFeedEntry[]
+  /**
+   * Entries after the cursor it was given were dropped before this read — the feed keeps a bounded
+   * tail for a bounded time. The domain status reads (`project_status`, `story_status`, …) say where
+   * the work stands.
+   */
+  gap: boolean
+}
+
+/** The preview's file changes, and whether its watcher runs. */
+export interface ConnectFileChanges extends ConnectFeedPage {
+  /**
+   * The preview's file watcher is running. False while the preview is not ready: nothing records a
+   * change until it runs again.
+   */
+  watching: boolean
+}
+
+/** A feed read's query: after which entry, how many, and how long to hold for the next one. */
+export interface ConnectFeedQuery {
+  /** The cursor the previous read answered; absent, the latest entries. */
+  after?: string
+  /** At most `CONNECT_FEED_LIMIT_MAX`; `CONNECT_FEED_LIMIT_DEFAULT` when absent. */
+  limit?: number
+  /** Seconds to hold for the next entry when none is there yet — at most `CONNECT_FEED_WAIT_MAX_SEC`. */
+  wait?: number
+}
+
+/** The project activity read's query: a feed query and how much of the activity it answers. */
+export interface ConnectActivityQuery extends ConnectFeedQuery {
+  /** `progress` (absent) leaves the model's own words out; `thinking` includes them. */
+  detail?: ConnectFeedDetail
+}

package/src/connect/files/types.ts

@@ -0,0 +1,38 @@
+import type { SpecCategory } from '../../ba/consts.js'
+import type { MetadataListKind } from '../../metadata/consts.js'
+
+/** One file of a cloud target's tree, addressed by its path relative to the project root. */
+export interface ConnectFileQuery {
+  path: string
+}
+
+/** A file read from a cloud target. */
+export interface ConnectFileContent {
+  path: string
+  content: string
+}
+
+/** A whole-file write: the content replaces whatever the file held. */
+export interface ConnectFileSaveBody {
+  path: string
+  content: string
+}
+
+/**
+ * What a write or a delete did. The platform rebuilds the preview after either; a build that failed
+ * leaves the last good preview serving and says why on `buildWarning` — the file change itself stands.
+ */
+export interface ConnectFileWritten {
+  path: string
+  buildWarning?: string
+}
+
+/**
+ * Which of the project's metadata documents to list: `stories` (the story documents), `meta` (the
+ * specifications beside the sources, narrowed by `category`) or `all` (everything under `docs/` and
+ * `.agents/` plus the specifications beside the sources).
+ */
+export interface ConnectFileMetaQuery {
+  kind: MetadataListKind
+  category?: SpecCategory
+}

package/src/connect/git/types.ts

@@ -0,0 +1,187 @@
+/**
+ * A cloud target's git repository and its GitHub connection, as a connector reads them.
+ *
+ * Self-contained mirrors of the platform's own git vocabulary (`@owlmeans/git/model` and the
+ * platform's `GithubConnection`): the connector contract depends on no git package, so these name the
+ * same fields and nothing more. A status is a plain string for the same reason a slot's is — this
+ * view crosses a version skew, and a newer platform may answer with a value an older connector has
+ * never heard of.
+ *
+ * NOTHING here carries the GitHub token. The platform stores it locked and relays it only to the
+ * project's own slot; no connector answer, and no field of any shape below, can hold it.
+ */
+
+/** One commit of the project's repository. */
+export interface ConnectGitCommit {
+  hash: string
+  shortHash: string
+  subject: string
+  authorName: string
+  authorEmail: string
+  committedAt: string
+}
+
+/** One changed path of the working tree, with git's porcelain status letters. */
+export interface ConnectGitFileChange {
+  path: string
+  status: string
+}
+
+/** The working tree: its branch and head, what changed, and where it stands against its remote. */
+export interface ConnectGitStatus {
+  initialized: boolean
+  head: ConnectGitCommit | null
+  branch: string
+  dirty: boolean
+  changedFiles: number
+  /** The changed paths — capped by the platform; `changedFiles` is the whole count. */
+  files: ConnectGitFileChange[]
+  /** The credential-free remote the project publishes to, once it has been published. */
+  remoteUrl: string | null
+  ahead: number | null
+  behind: number | null
+}
+
+/**
+ * The project's GitHub connection — who connected it and where it publishes. `status` is `connected`
+ * (authorized, not published yet), `published` (push and pull work) or `invalid` (GitHub refused the
+ * stored access: it has to be connected again).
+ */
+export interface ConnectGithubConnection {
+  projectId: string
+  githubLogin: string
+  repoFullName?: string
+  repoUrl?: string
+  status: string
+  connectedAt: string
+}
+
+/**
+ * The project's git state: its GitHub connection (`null` when none) and its working tree (`null`
+ * while the preview is not ready — git lives in the preview's pod, and reading it there would start
+ * a stopped preview).
+ */
+export interface ConnectGitState {
+  connection: ConnectGithubConnection | null
+  git: ConnectGitStatus | null
+}
+
+/** A commit of every change in the working tree. */
+export interface ConnectGitCommitBody {
+  message: string
+}
+
+/** What a commit made — `null` when there was nothing to commit. */
+export interface ConnectGitCommitResult {
+  commit: ConnectGitCommit | null
+}
+
+/** Go back to the tree of one earlier commit, as a NEW commit (history is never rewritten). */
+export interface ConnectGitRevertBody {
+  hash: string
+}
+
+/**
+ * What a revert made. `dbWarning` is what the project's database migration said after the tree went
+ * back — a schema the older code no longer matches is reported, never silently left.
+ */
+export interface ConnectGitRevertResult {
+  commit: ConnectGitCommit | null
+  dbWarning?: string | null
+}
+
+/**
+ * A push or a pull: `ok`, `up-to-date`, `conflict` (a pull that could not merge — aborted, nothing
+ * changed), `rejected` (the remote moved: pull first), `no-remote` or `auth-failed` (GitHub refused
+ * the stored access; the connection is then `invalid`).
+ */
+export interface ConnectGitSyncResult {
+  status: string
+  ahead: number | null
+  behind: number | null
+  message?: string
+}
+
+/**
+ * The address the PERSON opens to connect GitHub. The authorization finishes in their browser — GitHub
+ * returns to the platform's web application, which completes it; nothing a connector can call does.
+ */
+export interface ConnectGithubAuthorize {
+  authorizeUrl: string
+}
+
+/**
+ * Publish the project to GitHub: a new repository (`repoName`, private unless `private` is false) or
+ * one that exists (`existing`). The repository a converted project came FROM is refused while its
+ * original sources are still on the volume.
+ */
+export interface ConnectGithubPublishBody {
+  repoName?: string
+  private?: boolean
+  existing?: { owner: string, repo: string }
+}
+
+/** The connection after a disconnect — there is none. */
+export interface ConnectGithubDisconnected {
+  connection: null
+}
+
+/** One page of the person's repositories; `search` narrows the page that came back. */
+export interface ConnectGithubRepoQuery {
+  page?: number
+  search?: string
+}
+
+/** One repository as the picker lists it. */
+export interface ConnectGithubRepo {
+  fullName: string
+  name: string
+  owner: string
+  url: string
+  private: boolean
+  defaultBranch: string
+  updatedAt: string
+  archived: boolean
+  fork: boolean
+  sizeKb: number
+  description?: string
+  language?: string
+}
+
+export interface ConnectGithubRepoList {
+  repos: ConnectGithubRepo[]
+  page: number
+  hasMore: boolean
+}
+
+/** One page of one repository's branches. */
+export interface ConnectGithubBranchQuery {
+  owner: string
+  repo: string
+  page?: number
+}
+
+export interface ConnectGithubBranch {
+  name: string
+  protected: boolean
+}
+
+export interface ConnectGithubBranchList {
+  branches: ConnectGithubBranch[]
+  page: number
+  hasMore: boolean
+}
+
+/**
+ * Record which repository an imported project came FROM — it pushes nothing and publishes nothing.
+ * Absent `branch` is the repository's own default branch, read back from GitHub.
+ */
+export interface ConnectGithubLinkBody {
+  owner: string
+  repo: string
+  branch?: string
+}
+
+export interface ConnectGithubLinked {
+  connection: ConnectGithubConnection
+}

package/src/connect/iam/types.ts

@@ -0,0 +1,28 @@
+/**
+ * The connector's twins of the owner console's IAM (`connect.iam`): the same bodies, answers and
+ * refusals as the browser's `back.iam` routes (`../../iam-console/types.ts`), addressed under the
+ * connector's project path (`/project/:id/iam/…`) — so the project travels as `id`, like every other
+ * connector route. A read takes `scope` in its query, a write in its body.
+ */
+
+/** One subject of the project's client, by its pairwise `profileId`. */
+export interface ConnectIamUserParams {
+  id: string
+  profileId: string
+}
+
+/** One organization the project's client has members in, by its slug. */
+export interface ConnectIamOrganizationParams {
+  id: string
+  entitySlug: string
+}
+
+/** One member of an organization, as the project's client sees them. */
+export interface ConnectIamMemberParams extends ConnectIamOrganizationParams {
+  profileId: string
+}
+
+/** One group of (organization, the project's client), by its key. */
+export interface ConnectIamGroupParams extends ConnectIamOrganizationParams {
+  group: string
+}

package/src/connect/index.ts

@@ -9,9 +9,18 @@ export type * from './ops/types.js'
 export type * from './project/types.js'
 export type * from './settings/types.js'
 export type * from './branding/types.js'
+export type * from './account/types.js'
+export type * from './config/types.js'
 export type * from './pipeline/types.js'
 export type * from './conversion/types.js'
 export type * from './kit/types.js'
+export type * from './files/types.js'
+export type * from './slot/types.js'
+export type * from './git/types.js'
+export type * from './production/types.js'
+export type * from './iam/types.js'
+export type * from './call/types.js'
+export type * from './feed/types.js'
 export type * from './entrypoints/types.js'
 export type * from './errors/types.js'
 export type * from './references/types.js'

package/src/connect/production/types.ts

@@ -0,0 +1,71 @@
+import type { ConnectSlotState } from '../slot/types.js'
+
+/**
+ * A project's production workload as a connector reads it: the published site, its address and the
+ * custom domain attached to it, and the standalone sign-in configuration a self-hosted copy uses.
+ *
+ * Every status is a plain string, like a slot's: this view crosses a version skew, and a newer
+ * platform may answer with a value an older connector has never heard of. No shape here can carry the
+ * production sign-in's client secret — it is reported only as set or not.
+ */
+
+/**
+ * The custom domain of a production site, with the two DNS records the owner creates at their DNS
+ * provider: the traffic record (`customDomain` CNAME → `cnameTarget`) and the certificate's
+ * domain-control delegation (`dcvName` CNAME → `dcvValue`). `status` is the collapsed view
+ * (`none`, `pending`, `pending_validation`, `verified`, `linked`, `error`); `hostnameStatus` and
+ * `sslStatus` are the provider's own states of the two records, each answered as it reported them.
+ */
+export interface ConnectProductionDomain {
+  /** The site's own address, minted by the platform — it serves whether or not a domain is attached. */
+  generatedHost: string
+  customDomain?: string
+  status: string
+  verifiedAt?: string
+  cnameTarget?: string
+  dcvName?: string
+  dcvValue?: string
+  hostnameStatus?: string
+  sslStatus?: string
+  /** The provider's validation errors, verbatim, while the domain is in error. */
+  message?: string
+}
+
+/**
+ * The project's production workload — `null` before its first publish — and its domain (`null`
+ * while it has none).
+ */
+export interface ConnectProductionStatus {
+  workload: ConnectSlotState | null
+  domain: ConnectProductionDomain | null
+}
+
+/** The custom domain to attach — a DNS host name the owner controls. */
+export interface ConnectProductionDomainBody {
+  domain: string
+}
+
+/**
+ * The production sign-in configuration a self-hosted copy of the project is configured with: the
+ * OIDC client, its issuer and the addresses it may return to. The client SECRET is never answered —
+ * `secretSet` says whether one exists; the owner reads it in the web application.
+ */
+export interface ConnectProductionAuth {
+  clientId: string
+  issuerUrl: string
+  secretSet: boolean
+  /** The owner's own standalone redirect addresses — applied to the client on the next publish. */
+  redirectUris: string[]
+  generatedHost: string
+  customDomain?: string
+}
+
+/** Replace the owner's standalone redirect addresses — the whole list. */
+export interface ConnectProductionRedirectsBody {
+  redirects: string[]
+}
+
+/** The list as stored: trimmed, without blanks, each address once. */
+export interface ConnectProductionRedirects {
+  redirectUris: string[]
+}

package/src/connect/project/types.ts

@@ -1,6 +1,7 @@
 import type { ConnectTarget, ConnectWaitReason } from '../consts.js'
 import type { InquiryPayload } from '../ops/types.js'
 import type { ConnectSessionView } from '../session/types.js'
+import type { ConnectSlotState } from '../slot/types.js'
 
 export interface ConnectRunStatus {
   runId: string
@@ -37,19 +38,9 @@ export interface ConnectProjectStatus {
     vision?: string
     designSystem?: string
   }
-  slot?: {
-    id: string
-    kind: string
-    status: string
-    slug: string
-    host?: string
-    initialized?: boolean
-    lastError?: string
-    buildWarning?: string
-    backendWarning?: string
-  }
+  slot?: ConnectSlotState
   production?: { id: string, status: string, host?: string }
-  agent: { locked: boolean, task?: string, lockedAt?: string }
+  agent: ConnectAgentLock
   run?: ConnectRunStatus
   waitingFor?: ConnectWaitReason
   pendingInquiry?: InquiryPayload
@@ -59,6 +50,16 @@ export interface ConnectProjectStatus {
   updatedAt: string
 }
 
+/**
+ * The project's agent lock as a connector reads it — held while a run, a conversion stage or a
+ * kit apply works on the project. `task` and `lockedAt` are set only while it is held.
+ */
+export interface ConnectAgentLock {
+  locked: boolean
+  task?: string
+  lockedAt?: string
+}
+
 /** A story card composed with its deterministic development run. */
 export interface ConnectStoryStatus {
   projectId: string
@@ -104,6 +105,11 @@ export interface ConnectAttachBody {
 export interface ConnectCreateBody {
   prompt: string
   target?: ConnectTarget
+  /**
+   * The caller's unattached delegated session; its pre-card checks are performed by that session's
+   * parent. Absent, the platform performs them.
+   */
+  sessionId?: string
 }
 
 /**
@@ -125,3 +131,10 @@ export interface ConnectConfirmBody {
 export interface ConnectModifyBody {
   prompt: string
 }
+
+export interface ConnectRenameBody {
+  /** The new product name. */
+  name: string
+  /** A new one-line description, when the person gave one. */
+  description?: string
+}