@iterate-com/cloud 0.0.0 → 0.1.0-main.20261106T154720Z-ce800a3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/README.md

@@ -0,0 +1,93 @@
+# @iterate-com/cloud
+
+Iterate Cloud as a package a project installs: a person signs in through the OS, connects a
+Cloudflare account, and gets a deployment of iterate's platform (`core/os`) in that account, which
+the Cloud deploys and updates. The project that installs it is the Cloud's origin and its backend;
+its pages are [packages/cloud-app](../cloud-app/README.md), a Worker with no state.
+
+Everything the Cloud knows is a context with a processor ([src/contract.ts](src/contract.ts)):
+
+- **`/people/<sub>`** ([src/person.ts](src/person.ts)): a person's sign-ins, their Cloudflare
+  connections and their deployments.
+- **`/deployments/<id>`** ([src/deployment.ts](src/deployment.ts)): the record and the config, the
+  creation (the deployment's own sandbox, then its first deploy), and each run as a saga: its named
+  steps with each one's newest text lines, and Alchemy's resources as its typed events report them
+  ([src/alchemy.ts](src/alchemy.ts)).
+- **`/toolchain`** ([src/toolchain.ts](src/toolchain.ts)): iterate/core installed and built once,
+  saved as the snapshot every deployment's sandbox starts from.
+
+The sandbox work is [src/runs.ts](src/runs.ts) and [src/image.ts](src/image.ts): the same deploy
+program a laptop runs, as two steps (`pnpm build`, then `pnpm alchemy deploy --yes --log-format
+json`, whose JSON records the run reads), with the Cloudflare grant as an egress placeholder that no
+code reads. A deployment's three inputs are its config ([src/config.ts](src/config.ts)), its account,
+and the grant.
+
+The project's config worker serves the Cloud ([src/worker.ts](src/worker.ts)): its own sign-in
+through the OS ([src/sign-in.ts](src/sign-in.ts)), a capnweb API at `/rpc` for the signed-in
+person ([src/api.ts](src/api.ts)), the return of a Cloudflare connect, and the pages, fetched
+through to the Cloud app. The page's wizard is a state machine here ([src/wizard.ts](src/wizard.ts)),
+and what it shows of a deployment is [src/views.ts](src/views.ts).
+
+```ts
+// the installing project's config: cloud.ts re-exports the facets, worker.ts serves the Cloud
+export { CloudDeploymentFacet, CloudPersonFacet, CloudToolchainFacet } from "@iterate-com/cloud";
+```
+
+## What the installing project needs
+
+- **`/secrets/cloud-cloudflare-client`**, `{ clientSecret }` pinned to `https://dash.cloudflare.com`:
+  the secret of the Cloud's Cloudflare OAuth client, whose id the config passes in. Only the
+  platform reads it, at a connect's code exchange and at each refresh. The client lists the
+  platform's callback, `<platform origin>/.secrets/oauth/callback`, as a redirect URI.
+- **`/secrets/cloud-image-source`**, `{ username, password }` pinned to
+  `https://registry.cloudflare.com`, `username` public: a pull credential of the registry that holds
+  `iterate-dev-image`, which that account's API mints
+  (`POST /accounts/<account>/containers/registries/registry.cloudflare.com/credentials`,
+  `{"permissions":["pull"],"expiration_minutes":…}`). It expires; a run that must copy the image
+  then fails and names it. A Cloud whose toolchain names no image needs none.
+- **The toolchain**, prepared once and again for each new core, with one event:
+  `itx.cd("/toolchain").append({ type: "cloud/toolchain-requested", payload: {} })`.
+  Its deployments get no sandbox image: a run's image step says it is skipped, and their sandboxes
+  start Cloudflare's managed image.
+- **The sandbox image, optional**: the same event with
+  `payload: { image: { account, secret, digest } }` makes each plan and deploy put
+  `iterate-dev-image` into the customer's account first ([src/image.ts](src/image.ts)). The digest
+  is `iterate-dev-image`'s under the source account in iterate's `scripts/os/images.lock.json`, at
+  the commit core's main was copied from (its `GitOrigin-RevId`). The project needs no GitHub
+  connection: the image step reads no repository. **The copy does not work yet for an account that
+  lacks the image**: crane uploads each layer through the project's egress, which gives a request
+  50 seconds, and the image's large layers take longer (`504 … sent no answer within 50 s`).
+- Nothing by hand for the sandboxes: each preparation writes two rules on its own context,
+  `itx.fetch` and `itx.sandboxes` to the root's ([src/runs.ts](src/runs.ts) `withProjectRoots`). A
+  sandbox's requests are answered by its context's `itx.fetch`, and its start from the toolchain
+  finds that sandbox through its context's `itx.sandboxes`; a context beneath the root has neither.
+
+The Cloud runs at the root of a host (prd: `cloud.iterate.app`) or under a base path, as a
+project is served under paths ingress (`<platform>/projects/cloud`): the config worker reads the
+path from `x-iterate-base-path` and every address it names carries it, and the pages follow
+`@iterate-com/ui/apps/base-path`.
+
+## The playground
+
+`cloud-dev` (`osEnvs["cloud-dev"]` in iterate/private's `envs.ts`) is a standing core/os on the dev
+account, at https://cloud-dev-os.iterate-dev-preview.workers.dev, whose `cloud` project serves the
+Cloud at `/projects/cloud`, with the dev account's pages Worker (`cloudAppEnvs.preview`). A core
+change goes there with one command, and the same deployment keeps its data:
+`doppler run --project os --config preview -- pnpm os deploy --env cloud-dev`.
+
+## The spec
+
+`test/playwright/cloud/install.spec.ts` walks a new person through the whole Cloud, from the first
+page to an agent's answer in a project of the iterate it deployed into the dev account, and always
+destroys that deployment again, checking that the Worker and the Artifacts namespace are gone. Cloudflare's consent is the one step a robot cannot take: it stores what the
+consent would have stored. Against the playground:
+
+```sh
+caffeinate -dimu doppler run --project os --config preview -- env WORKER_BASE_URL=https://cloud-dev-os.iterate-dev-preview.workers.dev CLOUD_BASE_URL=https://cloud-dev-os.iterate-dev-preview.workers.dev/projects/cloud pnpm spec --project cloud
+caffeinate -dimu doppler run --project os --config preview -- env VIDEO_MODE=1 WORKER_BASE_URL=https://cloud-dev-os.iterate-dev-preview.workers.dev CLOUD_BASE_URL=https://cloud-dev-os.iterate-dev-preview.workers.dev/projects/cloud pnpm spec --project cloud
+```
+
+Without `CLOUD_BASE_URL` it skips.
+
+Published per commit on pkg.pr.new (`.github/workflows/pkg-pr-new.yml`). `pnpm test` runs the
+processors over an in-memory stream and the wizard over fakes.

package/dist/api-B9RGHZ6w.d.mts

@@ -0,0 +1,149 @@
+import { c as DeploymentRecord, f as PersonState, l as DeploymentState, x as RunStep } from "./records-BQhLMgQ8.mjs";
+import { i as WatchTarget } from "./durable-object-BM27_ak3.mjs";
+import { RpcTarget } from "cloudflare:workers";
+import { IterateContextApi } from "iterate/api";
+//#region src/sign-in.d.ts
+/** The person, as the issuer's userinfo names them: `sub` is their OS user id. */
+type Person = {
+  sub: string;
+  email: string;
+};
+//#endregion
+//#region src/api.d.ts
+/** What a Cloud API serves from: the person the session names, the config worker's scope, its
+ *  `waitUntil`, and the Cloud's Cloudflare OAuth client. */
+type ApiDeps = {
+  person: Person;
+  /** The path the Cloud is served under on its origin, "" at a host's root (worker.ts). */
+  basePath: string;
+  getItx: () => IterateContextApi & Disposable;
+  waitUntil: (work: Promise<unknown>) => void;
+  cloudflare: CloudflareClient;
+};
+/** The Cloud's own Cloudflare OAuth client: its id, public, and the project secret that holds its
+ *  secret, `{ clientSecret }`, which only the platform reads, at the code exchange and each refresh. */
+type CloudflareClient = {
+  clientId: string;
+  secret: string;
+};
+declare class CloudApi extends RpcTarget {
+  #private;
+  constructor(deps: ApiDeps);
+  whoami(): {
+    sub: string;
+    email: string;
+  };
+  /** The person's own context, live: their connections and deployments. */
+  get person(): LiveContext;
+  get deployments(): Deployments;
+  /** Begin a Cloudflare connect: the platform's start link, which the browser opens to reach
+   *  Cloudflare's consent. Cloudflare returns to the platform's callback, which stores the tokens in
+   *  the connection's secret and sends the browser to `/connected` here (worker.ts). The attempt is
+   *  this person's alone (`completedByUserId`): the callback completes it only in a browser signed
+   *  in at the OS as them, whether or not they are a member of this project. */
+  connectCloudflare(): Promise<{
+    url: string;
+  }>;
+}
+/** A context the person owns, live: the seed (`liveSnapshot`) and the deltas (`subscribe`) of its
+ *  processor, as iterate/client `connectLiveState` reads them. */
+declare class LiveContext extends RpcTarget {
+  #private;
+  protected readonly deps: ApiDeps;
+  protected readonly path: string;
+  constructor(deps: ApiDeps, path: string, slug: string);
+  liveSnapshot(): Promise<{
+    rev: number;
+    state: PersonState | DeploymentState;
+  }>;
+  /** Follow the processor's live state: `target` gets every batch of its deltas until the handle
+   *  is disposed or the socket closes. Only the live-state type: `name` and `consumes` are ignored
+   *  (the facet names its watch). */
+  subscribe(input: {
+    target: WatchTarget;
+    name?: string;
+    consumes?: string[];
+  }): Promise<Subscription>;
+}
+/** What `subscribe` answers: disposing it, or the socket closing, ends the facet's watch. */
+declare class Subscription extends RpcTarget {
+  #private;
+  constructor(end: () => void);
+  [Symbol.dispose](): void;
+}
+declare class Deployments extends RpcTarget {
+  #private;
+  constructor(deps: ApiDeps);
+  /** Request a deployment into one of the accounts a connected connection reaches. `request` is
+   *  the page's own random id for this creation: the deployment's id is derived from it, so a
+   *  retried request (a reload, a lost answer) is the same deployment. The person's listing is
+   *  appended first, then the deployment's own request, both keyed by the id: a creation that
+   *  stops between the two is listed, its context empty, and `requestCreation` finishes it. Of
+   *  two that overlap with one name, only the first the person's log lists goes on. */
+  create(input: {
+    request: string;
+    connection: string;
+    accountId: string;
+    name: string;
+  }): Promise<{
+    id: string;
+  }>;
+  /** Whether `name` is free for a new deployment in the account, as `create` checks it: no
+   *  deployment of the person's has it there, and the account has no Worker of that name. A name in
+   *  use is never taken over: a deploy of an existing stack would replace that deployment's
+   *  encryption key and orphan every secret it sealed. */
+  checkName(input: {
+    connection: string;
+    accountId: string;
+    name: string;
+  }): Promise<{
+    status: "taken";
+    message: string;
+  } | {
+    status: "free";
+    message: string;
+  } | {
+    status: "unknown";
+    message: string;
+  }>;
+  /** One of the person's deployments; any other id is refused. */
+  get(id: string): Promise<Deployment>;
+}
+declare class Deployment extends LiveContext {
+  #private;
+  constructor(deps: ApiDeps, record: DeploymentRecord);
+  /** Finish a creation that stopped before the deployment's own request (`create` says when). */
+  requestCreation(): Promise<void>;
+  /** Prepare the sandbox again after a preparation failed. */
+  prepareAgain(): Promise<void>;
+  /** Ask for a run. Its answer is on the deployment's state: open, or refused while another runs. */
+  requestRun(kind: string): Promise<{
+    requestOffset: number;
+  }>;
+  /** The text lines one step of a run printed, at most its first 1,000, from the run's
+   *  `cloud/output-printed` events; the state keeps only each step's newest. */
+  readOutput(requestOffset: number, step: RunStep): Promise<{
+    lines: string[];
+  }>;
+  /** The password minted for the owner's sign-in to the deployed Worker (config.ts), from the
+   *  deployment's full state: the one secret the Cloud shows, to the owner alone. */
+  signInPassword(): Promise<string | null>;
+}
+/** The Cloudflare accounts a connection's token reaches, as Cloudflare's API lists them. The
+ *  placeholder rides in the header; egress swaps the token in. */
+declare function accountsOf(connection: string): Promise<{
+  id: string;
+  name: string;
+}[]>;
+/** The facet spec of one of the package's processors, loaded from the project's published config,
+ *  whose top-level `cloud.ts` re-exports the package (a processor row names a top-level module).
+ *  `consumes` is its contract's: the platform delivers the processor no other type. */
+declare const facetSpecOf: (className: string, consumes: readonly string[]) => {
+  className: string;
+  mainModule: string;
+  source: ["itx", ["cd", string], "config"];
+  consumes: string[];
+};
+declare const personPathOf: (sub: string) => string;
+//#endregion
+export { facetSpecOf as a, accountsOf as i, CloudApi as n, personPathOf as o, CloudflareClient as r, ApiDeps as t };

package/dist/api.d.mts

@@ -0,0 +1,2 @@
+import { a as facetSpecOf, i as accountsOf, n as CloudApi, o as personPathOf, r as CloudflareClient, t as ApiDeps } from "./api-B9RGHZ6w.mjs";
+export { ApiDeps, CloudApi, CloudflareClient, accountsOf, facetSpecOf, personPathOf };