@owlmeans/viable-common 0.0.46 → 0.0.48-rc.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@owlmeans/viable-common",
-  "version": "0.0.46",
+  "version": "0.0.48-rc.0",
   "license": "MIT",
-  "description": "Runtime-free contracts of the OwlMeans Viable platform — the analysis, design and metadata shapes of a generated project, its target-shape manifest, the slot command vocabulary, the connector protocol and the conversion vocabulary, and the intent-first hand-off from the public site to the platform.",
+  "description": "Runtime-free contracts of the OwlMeans Viable platform — the analysis, design and metadata shapes of a generated project, its target-shape manifest, the slot command vocabulary, the connector protocol, the owner console's IAM contract and the conversion vocabulary, and the intent-first hand-off from the public site to the platform.",
   "type": "module",
   "scripts": {
     "build": "tsc -b",
@@ -62,6 +62,13 @@
       "default": "./build/intent/index.js",
       "module": "./build/intent/index.js",
       "types": "./build/intent/index.d.ts"
+    },
+    "./iam-console": {
+      "import": "./build/iam-console/index.js",
+      "require": "./build/iam-console/index.js",
+      "default": "./build/iam-console/index.js",
+      "module": "./build/iam-console/index.js",
+      "types": "./build/iam-console/index.d.ts"
     }
   },
   "devDependencies": {
@@ -73,14 +80,16 @@
     "typescript": "^7.0.2"
   },
   "dependencies": {
-    "@owlmeans/agent-common": "^0.1.18-rc.48",
-    "@owlmeans/auth": "^0.1.18-rc.40",
+    "@owlmeans/agent-common": "^0.1.18-rc.49",
+    "@owlmeans/auth": "^0.1.18-rc.41",
+    "@owlmeans/auth-common": "^0.1.18-rc.49",
     "@owlmeans/context": "^0.1.18-rc.34",
     "@owlmeans/entrypoint": "^0.1.18-rc.41",
     "@owlmeans/error": "^0.1.18-rc.38",
     "@owlmeans/flow": "^0.1.18-rc.45",
+    "@owlmeans/iam": "^0.1.18-rc.52",
     "@owlmeans/llm-common": "^0.1.18-rc.39",
-    "@owlmeans/planning": "^0.1.18-rc.20",
+    "@owlmeans/planning": "^0.1.18-rc.21",
     "@owlmeans/resource": "^0.1.18-rc.40",
     "@owlmeans/route": "^0.1.18-rc.35"
   },

package/src/connect/account/types.ts

@@ -0,0 +1,91 @@
+/**
+ * The organization's branding defaults: the name and copyright line every new project starts with.
+ * A project keeps its own copy after creation; `copyDefaults` replaces a project's two values with
+ * these again.
+ */
+export interface ConnectOrganizationBranding {
+  organizationName: string
+  copyright: string
+}
+
+/** A PATCH of the organization's defaults; a field left out keeps its value. Neither may be empty. */
+export interface ConnectOrganizationBrandingSave extends Partial<ConnectOrganizationBranding> {}
+
+/** What a backfill did: how many projects had blank branding rows filled from the defaults. */
+export interface ConnectBrandingBackfill {
+  projects: number
+}
+
+/**
+ * One of the person's access tokens, as a connector sees it — never the secret, never its hash, and
+ * no record ids of the organization or the person: the token is the caller's own by construction.
+ */
+export interface ConnectAccessToken {
+  id: string
+  /** What the owner called it. */
+  name: string
+  /** The prefix and the first characters of the secret — useless as a credential. */
+  display: string
+  scopes: string[]
+  createdAt: string
+  lastUsedAt?: string
+  expiresAt?: string
+  /** Set once a token is revoked; a revoked token stays listed so its name still resolves. */
+  revokedAt?: string
+  /** Issued through a browser sign-in (an OAuth grant) for one resource, rather than minted by hand. */
+  oauth: boolean
+}
+
+export interface ConnectAccessTokenList {
+  items: ConnectAccessToken[]
+}
+
+/** The token a revoke names — one of the caller's own. */
+export interface ConnectAccessTokenParams {
+  id: string
+}
+
+/** What a revoke answers: the id it revoked. Revoking twice is what a retry looks like. */
+export interface ConnectAccessTokenRevoked {
+  id: string
+}
+
+/** Whether a consent was ever answered at its current wording. */
+export type ConnectPrivacyStatus = 'new' | 'revised' | 'current'
+
+/** One marketing consent of the person, as the "Privacy choices" settings show it. */
+export interface ConnectPrivacyChoice {
+  /** The consent's key — `marketing.email`, `data.profiling`, … */
+  key: string
+  group: string
+  mode: 'opt-in' | 'opt-out'
+  /**
+   * The person's SAVED, current answer — `false` for anything never answered at this wording,
+   * whatever the settings screen's opt-out display default says.
+   */
+  granted: boolean
+  status: ConnectPrivacyStatus
+  /** When the saved answer was given, if there is one. */
+  decidedAt?: string
+}
+
+export interface ConnectPrivacyChoices {
+  /** A consent still waits for the person's first or revised answer. */
+  pending: boolean
+  items: ConnectPrivacyChoice[]
+}
+
+/** The consents to withdraw — each written `granted: false`; nothing here can grant one. */
+export interface ConnectPrivacyWithdrawBody {
+  keys: string[]
+}
+
+/** The reference of a stashed prompt — the `ref` of the `/start?ref=…` address the public site opened. */
+export interface ConnectIntentPickupBody {
+  ref: string
+}
+
+/** The prompt a visitor typed on the public site. Collected once: the reference is spent. */
+export interface ConnectIntentPickup {
+  prompt: string
+}

package/src/connect/branding/types.ts

@@ -4,9 +4,9 @@
  * A project's branding as a connector reads it — what the generated application says about who
  * made it, and the Google tag it loads.
  *
- * Every field is a string, `''` when unset, in the platform's own branding vocabulary. The
- * platform credit is absent on purpose: hiding it is a paid capability behind its own gated route,
- * and neither reading nor saving this record may reach it.
+ * Every text field is a string, `''` when unset, in the platform's own branding vocabulary. The
+ * platform credit is READ-ONLY here: hiding it is a paid capability behind its own gated route
+ * (`branding.credit`), and saving this record never reaches it.
  */
 export interface ConnectProjectBranding {
   /** The copyright line in the application's footer. Never empty once saved. */
@@ -19,11 +19,35 @@ export interface ConnectProjectBranding {
   privacyUrl: string
   /** `''`, or a Google tag id: `GTM-…`, `G-…`, `GT-…`, `AW-…`, `DC-…`. */
   googleTag: string
+  /** The platform credit as it stands — absent from a platform that predates it on this view. */
+  credit?: ConnectBrandingCredit
 }
 
+/**
+ * The platform credit ("Built with OwlMeans"): what the owner asked for and what is delivered, which
+ * differ while the plan does not include hiding it — the request survives a lapsed plan and takes
+ * effect again on its own once the plan includes it.
+ */
+export interface ConnectBrandingCredit {
+  /** The delivered value: the credit is hidden in the application. */
+  hidden: boolean
+  /** The owner asked to hide it. */
+  requested: boolean
+  /** The organization's plan includes hiding it (white label). */
+  entitled: boolean
+}
+
+/** The editable text settings — every field of the view but the read-only credit. */
+export interface ConnectProjectBrandingFields extends Omit<ConnectProjectBranding, 'credit'> {}
+
 /**
  * A PATCH of a project's branding: every field optional, and an absent field keeps its current
  * value. The platform merges it over what is stored, validates the result as a whole with the
  * rules the web form uses, and answers the merged record.
  */
-export interface ConnectProjectBrandingSave extends Partial<ConnectProjectBranding> {}
+export interface ConnectProjectBrandingSave extends Partial<ConnectProjectBrandingFields> {}
+
+/** Hide (`true`) or show (`false`) the platform credit. */
+export interface ConnectBrandingCreditBody {
+  hideCredit: boolean
+}

package/src/connect/call/types.ts

@@ -0,0 +1,31 @@
+import type { ConnectCallState } from '../consts.js'
+
+/**
+ * The body of a delegated write answered EARLY (HTTP 202, `EntrypointOutcome.Accepted`): the call
+ * named by the `x-viable-call` header is still running, and its outcome is collected by that id.
+ */
+export interface ConnectCallPending {
+  /** The call id the request carried in `x-viable-call`. */
+  pending: string
+}
+
+/** What one collect of a named call answers. */
+export interface ConnectCallResult {
+  state: ConnectCallState
+  /** The entrypoint outcome the call would have answered with (`ok`, `created`, …); settled only. */
+  outcome?: string
+  /** The value the call would have answered with — any JSON; settled without `error` only. */
+  value?: unknown
+  /** The call's failure, marshalled (`ResilientError.marshal(error).message`); settled only. */
+  error?: string
+}
+
+/** The collect route's path parameters. */
+export interface ConnectCallCollectParams {
+  callId: string
+}
+
+/** The collect route's query: how long to hold, in seconds — at most `CONNECT_CALL_COLLECT_WAIT_SEC`. */
+export interface ConnectCallCollectQuery {
+  wait?: number
+}

package/src/connect/config/types.ts

@@ -0,0 +1,51 @@
+import type { WorkloadKind } from '../../slot/consts.js'
+
+/**
+ * Which workload's set a configuration read or write addresses: the project's preview (the
+ * default) or its production workload, whose rows are its own and reach it only at a Publish.
+ */
+export type ConnectConfigScope = WorkloadKind.Ephemeral | WorkloadKind.Production
+
+/** `?scope=` — absent is the preview's set. */
+export interface ConnectScopeQuery {
+  scope?: ConnectConfigScope
+}
+
+/** One backend variable as a connector reads it: its name and whether it holds a value — never the value. */
+export interface ConnectConfigVariable {
+  name: string
+  /** A non-empty value is stored. The value itself is a secret and is never returned. */
+  set: boolean
+}
+
+/** One frontend variable: public by nature — it is baked into the bundle every visitor downloads. */
+export interface ConnectFrontendVariable extends ConnectConfigVariable {
+  /** `''` when unset. */
+  value: string
+}
+
+/**
+ * A project's configuration requirements: the variables its generated application declares, per
+ * side, for one scope. A backend variable's value is never part of it.
+ */
+export interface ConnectProjectConfig {
+  scope: ConnectConfigScope
+  backend: ConnectConfigVariable[]
+  frontend: ConnectFrontendVariable[]
+}
+
+/** One variable a save sets. A new name is declared on its side; an existing one keeps its side. */
+export interface ConnectConfigValue {
+  name: string
+  value: string
+}
+
+/**
+ * A PATCH of a project's configuration: the variables named are set, every other one keeps its
+ * value. A name already declared on the OTHER side is refused — a backend secret written as a
+ * frontend variable would be published in the bundle.
+ */
+export interface ConnectConfigSaveBody {
+  backend?: ConnectConfigValue[]
+  frontend?: ConnectConfigValue[]
+}