@samebase/alchemy-convex 0.15.0 → 0.16.0

package/README.md

@@ -167,7 +167,8 @@ values explicitly: `Convex.providers(Convex.fromValues({ accessToken, deployKey
 ## State in Convex
 
 `state: Convex.state({ team })` keeps the Alchemy state of every stack and stage of a Convex team in
-one project of that team, `samebase`, so a repository holds one secret and a stack can create
+one project of that team, `alchemy-state-store`, the same name as the Cloudflare state store of
+Alchemy, so a repository holds one secret and a stack can create
 and destroy its own project. [docs/design/convex-state.md](docs/design/convex-state.md) records the
 decisions and the measurements.
 
@@ -185,26 +186,16 @@ Every run needs the team token in `CONVEX_ACCESS_TOKEN`, or the Convex CLI login
 team access token names its team, so `Convex.state()` needs no `team` with one; a `team` slug that
 is set must be the slug of that team, checked against its projects, and a token of another team
 fails the run. The Convex CLI login needs the slug or the id. The first run of a team creates
-the project `samebase` and pushes the store app of this package to its
+the project `alchemy-state-store` and pushes the store functions to its
 production deployment with the Convex CLI of the app; a later version of this package pushes a
-newer store app when it finds an older one. A store that is newer than the package fails the run
-with both versions, so the repositories of a team upgrade the package together. Each run makes a
+newer store when it finds an older one. A store that is newer than the package fails the run with
+both versions, so the repositories of a team upgrade the package together. Each run makes a
 deploy key of that deployment that can only run the store's internal functions, and deletes it at
 the end. Rows are in the tables `resources` and `outputs` of the component `alchemyState` in the
 dashboard, under the stack name.
 The store has no lock: run one deploy of a stage at a time, such as with a CI concurrency group.
 The store and its readers (Samebase) are released and upgraded together.
 
-The base app of a team can serve the store in the `samebase` project, next to its own components.
-It mounts the component from `@samebase/alchemy-convex/state/convex.config`. It exports the
-store functions of `@samebase/alchemy-convex/state/functions`:
-`stateFunctions(components.alchemyState, "base")` and `readerFunctions(components.alchemyState)`.
-It exports its auth config from `@samebase/alchemy-convex/state/auth.config`. Then
-`state:host` answers `"base"`, and `Convex.state()` never pushes over that app: a base
-that is older than the package fails the run with `OutdatedBase`, and the base app upgrades its
-`@samebase/alchemy-convex`. See
-[the design note](docs/design/convex-state.md#the-stores-functions-are-exported-and-a-base-is-never-pushed-over-0140).
-
 Store version 3 supports native subscriptions. A trusted server checks repository access, then
 calls internal `reader:authorize({ repository, subject })` with a deployment credential. It gives
 the returned token to a separate `ConvexClient` connected to the state deployment. The client
@@ -284,8 +275,8 @@ call.
     has every action, because the command can do more than a push.
 
 - `Convex.HubClient`: `{ team, app, redirectUri, deploymentType, clientName, softwareVersion? }`
-  registers one deployment as a client of the identity hub of the team. The hub is in the base of the
-  team, the production deployment of the project `samebase`. The resource finds it by name and runs
+  registers one deployment as a client of the identity hub of the team. The hub is the production
+  deployment of the project `samebase`. The resource finds it by name and runs
   its internal function `identityBroker:registerClient` with a short-lived key, so the stack needs no
   other credential and no hub address. The first client of an `app` creates the app. Outputs
   `issuer`, `clientId`, `clientSecret`, `redirectUri`, `deploymentType`, and `clientName`, which the

package/lib/{HubClient-C_nvjlvW.js → HubClient-BYBV7cF5.js}

@@ -1510,7 +1510,7 @@ const withRunRecord = (output, record) => isPlainObject(output) ? "samebase.run"
 //#endregion
 //#region src/State.ts
 /** The name of the state project in each team. */
-const STORE_PROJECT_NAME = "samebase";
+const STORE_PROJECT_NAME = "alchemy-state-store";
 /**
 * The actions of the key of one run: the internal queries and mutations of
 * the store, nothing else. Measured: `deployment:data:view` and
@@ -1625,26 +1625,6 @@ const remoteOf = (api, record) => {
 /** The version that the store answers, or undefined when the deployment has no `state:version`. */
 const storeVersion = (api) => api.call("state:version", {}).pipe(Effect.flatMap((reply) => reply.status === "error" && MISSING_FUNCTION.test(reply.errorMessage) ? Effect.succeed(void 0) : valueOf(reply).pipe(Effect.flatMap(decode(Schema.Number, "store version")))));
 /**
-* The app that serves the store. A store without `state:host` is a seed: it
-* was pushed before 0.14.0, and only the store app of this package served
-* those stores.
-*/
-const storeHost = (api) => api.call("state:host", {}).pipe(Effect.flatMap((reply) => reply.status === "error" && MISSING_FUNCTION.test(reply.errorMessage) ? Effect.succeed("seed") : valueOf(reply).pipe(Effect.flatMap(decode(Schema.Literals(["seed", "base"]), "store host")))));
-/**
-* The base app of the team serves an older store. Convex.state() never
-* pushes its store app over a base, because the push replaces every function
-* of the deployment and so erases the base app.
-*/
-var OutdatedBase = class extends Schema.TaggedError()("OutdatedBase", {
-	team: Schema.Union([Schema.String, Schema.Number]),
-	deployment: Schema.String,
-	version: Schema.Number
-}) {
-	get message() {
-		return `The base of team ${this.team} (${this.deployment}) answers store version ${this.version}, and this package needs store version 4. Convex.state does not push over a base. Upgrade the dependency @samebase/alchemy-convex of the base app to the version of this package, and push the base app.`;
-	}
-};
-/**
 * The functions directory of the store app, `src/store/convex` of this
 * package. This file is `src/State.ts` in a checkout and a chunk in `lib/`
 * in the installed package, which ships `src` too, so the directory is
@@ -1700,15 +1680,15 @@ const createStoreProject = (api, teamId, team) => Effect.gen(function* () {
 	return oldest;
 });
 /**
-* The StateService over the `samebase` project of the team: found or
-* created, its store app pushed when the store is missing or an older seed,
-* and read and written with the keys of this run.
+* The StateService over the `alchemy-state-store` project of the team: found or
+* created, its store pushed when it is missing or older, and read and
+* written with the keys of this run.
 */
 const makeConvexState = (options) => Effect.gen(function* () {
 	const { api } = options;
 	const teamId = yield* api.resolveTeamId(options.team);
 	const team = options.team ?? teamId;
-	const project = (yield* findProjectByName(api, teamId, "samebase")) ?? (yield* createStoreProject(api, teamId, team));
+	const project = (yield* findProjectByName(api, teamId, "alchemy-state-store")) ?? (yield* createStoreProject(api, teamId, team));
 	const deployment = yield* prodDeploymentOf(api, project.id);
 	if (deployment === void 0) return yield* new ProductionDeploymentNotFound({ projectId: project.id });
 	const keys = [];
@@ -1722,21 +1702,15 @@ const makeConvexState = (options) => Effect.gen(function* () {
 		current = next;
 		return next.call(path, args);
 	})))) };
-	const needsPush = (found) => found === void 0 ? Effect.succeed(true) : found < 4 ? storeHost(functions).pipe(Effect.map((host) => host === "seed")) : Effect.succeed(false);
 	let version = yield* storeVersion(functions);
-	if (yield* needsPush(version)) {
+	if (version === void 0 || version < 4) {
 		if (version === void 0 && deployment.lastDeployTime) return yield* failure(`project ${STORE_PROJECT_NAME} (${project.id}) of team ${team} has code that is not the state store, and Convex.state does not push over it. Rename that project in the Convex dashboard.`);
 		version = yield* storeVersion(functions);
-		if (yield* needsPush(version)) {
+		if (version === void 0 || version < 4) {
 			yield* pushStore(options, deployment);
 			version = yield* storeVersion(functions);
 		}
 	}
-	if (version !== void 0 && version < 4 && (yield* storeHost(functions)) === "base") return yield* new OutdatedBase({
-		team,
-		deployment: deployment.name,
-		version
-	});
 	if (version !== 4) return yield* failure(`${deployment.name} answers store version ${version ?? "none"}, and this package needs store version 4.`);
 	const remote = remoteOf(functions, options.run);
 	/** The stack's output plus the record, when the run has one and the output has a place for it. */
@@ -1778,12 +1752,11 @@ const makeConvexState = (options) => Effect.gen(function* () {
 	};
 });
 /**
-* Alchemy state in the `samebase` project of `team`, with the team token
+* Alchemy state in the `alchemy-state-store` project of `team`, with the team token
 * in CONVEX_ACCESS_TOKEN or the Convex CLI login. A team access token names
 * its team, so `team` is optional with one; the Convex CLI login needs the
 * slug or the id. The first use of the run finds or creates the project and
-* pushes the store app when the store is missing or an older seed. An older
-* base fails the run with {@link OutdatedBase}. `alchemy plan` on another
+* pushes the store when it is missing or older. `alchemy plan` on another
 * stack never touches Convex.
 */
 const state = (options = {}) => Layer.effect(State, Effect.gen(function* () {
@@ -1808,14 +1781,16 @@ const state = (options = {}) => Layer.effect(State, Effect.gen(function* () {
 }));
 //#endregion
 //#region src/HubClient.ts
+/** The name of the project of the hub in each team. */
+const HUB_PROJECT_NAME = "samebase";
 const HubClient = Resource("IdentityHub.Client");
-/** The base of the team could not do the call. The reason is the Convex message: it holds no secret. */
+/** The hub of the team could not do the call. The reason is the Convex message: it holds no secret. */
 var HubClientFailed = class extends Schema.TaggedError()("HubClientFailed", {
 	team: Schema.Union([Schema.String, Schema.Number]),
 	reason: Schema.String
 }) {
 	get message() {
-		return `Convex.HubClient: the base of team ${this.team}: ${this.reason}.`;
+		return `Convex.HubClient: the hub of team ${this.team}: ${this.reason}.`;
 	}
 };
 /** The reply of `identityBroker:registerClient`. */
@@ -1824,18 +1799,18 @@ const Registered = Schema.Struct({
 	clientId: Schema.NonEmptyString,
 	clientSecret: Schema.NonEmptyString
 });
-/** Runs `use` with the function API of the base of `team`, with a key of this call only. */
-const withBase = (api, team, use) => Effect.gen(function* () {
+/** Runs `use` with the function API of the hub of `team`, with a key of this call only. */
+const withHub = (api, team, use) => Effect.gen(function* () {
 	const teamId = yield* api.resolveTeamId(team);
-	const project = yield* findProjectByName(api, teamId, STORE_PROJECT_NAME);
+	const project = yield* findProjectByName(api, teamId, HUB_PROJECT_NAME);
 	if (project === void 0) return yield* new HubClientFailed({
 		team,
-		reason: `no project ${STORE_PROJECT_NAME}, which holds the hub`
+		reason: `no project ${HUB_PROJECT_NAME}, which holds the hub`
 	});
 	const deployment = yield* prodDeploymentOf(api, project.id);
 	if (deployment === void 0) return yield* new HubClientFailed({
 		team,
-		reason: `project ${STORE_PROJECT_NAME} has no production deployment`
+		reason: `project ${HUB_PROJECT_NAME} has no production deployment`
 	});
 	return yield* withPushKey(api, deployment.name, RUN_KEY_ACTIONS, (key) => use(makeFunctionApi(deployment.deploymentUrl, key)));
 });
@@ -1851,7 +1826,7 @@ const runHub = (functions, team, name, args) => functions.call(`identityBroker:$
 * Registers one client. An attempt that a lost reply repeats leaves one spare
 * client on the hub, which signs nobody in.
 */
-const registerHubClient = (api, props) => withBase(api, props.team, (functions) => runHub(functions, props.team, "registerClient", {
+const registerHubClient = (api, props) => withHub(api, props.team, (functions) => runHub(functions, props.team, "registerClient", {
 	appId: props.app,
 	redirectUri: props.redirectUri,
 	deploymentType: props.deploymentType,
@@ -1866,7 +1841,7 @@ const registerHubClient = (api, props) => withBase(api, props.team, (functions)
 	clientId,
 	clientSecret: Redacted.make(clientSecret)
 })));
-const unregister = (api, team, clientId) => withBase(api, team, (functions) => runHub(functions, team, "deleteClient", { clientId }));
+const unregister = (api, team, clientId) => withHub(api, team, (functions) => runHub(functions, team, "deleteClient", { clientId }));
 /** True when the client in state serves the redirect URI and deployment type of `props`. */
 const registeredFor = (output, props) => output.redirectUri === props.redirectUri && output.deploymentType === props.deploymentType;
 const HubClientProvider = () => Provider.effect(HubClient, Effect.gen(function* () {
@@ -1933,6 +1908,6 @@ const registerDevelopmentClient = (options) => Effect.gen(function* () {
 	return callbackUrl;
 });
 //#endregion
-export { PushTargetMismatch as A, DEPLOY_KEY_ENV as B, DeploymentProvider as C, ConvexAppNotFound as D, CodePushFailed as E, ManagementApi as F, fromValues as H, ManagementApiLive as I, ACCESS_TOKEN_ENV as L, installedCli as M, parseDeployOutput as N, ConvexCliNotFound as O, ConvexApiError as P, Credentials as R, DeploymentIdentityChange as S, ProductionDeploymentNotFound as T, fromConfig as V, ProjectProvider as _, OutdatedBase as a, AmbiguousDeployment as b, RUN_RECORD_KEY as c, withRunRecord as d, AmbiguousProject as f, ProjectNotFound as g, ProjectDeploymentChange as h, registerDevelopmentClient as i, VariablesOwnedBySomeoneElse as j, EnvironmentNeedsDeployKey as k, RunRecordError as l, Project as m, HubClientFailed as n, STORE_PROJECT_NAME as o, CreatedProjectNotFound as p, HubClientProvider as r, state as s, HubClient as t, runRecord as u, ProjectTeamChange as v, DeploymentResource as w, Deployment as x, AbsoluteRootDir as y, CredentialsError as z };
+export { PushTargetMismatch as A, DEPLOY_KEY_ENV as B, DeploymentProvider as C, ConvexAppNotFound as D, CodePushFailed as E, ManagementApi as F, fromValues as H, ManagementApiLive as I, ACCESS_TOKEN_ENV as L, installedCli as M, parseDeployOutput as N, ConvexCliNotFound as O, ConvexApiError as P, Credentials as R, DeploymentIdentityChange as S, ProductionDeploymentNotFound as T, fromConfig as V, ProjectProvider as _, registerDevelopmentClient as a, AmbiguousDeployment as b, RUN_RECORD_KEY as c, withRunRecord as d, AmbiguousProject as f, ProjectNotFound as g, ProjectDeploymentChange as h, HubClientProvider as i, VariablesOwnedBySomeoneElse as j, EnvironmentNeedsDeployKey as k, RunRecordError as l, Project as m, HubClient as n, STORE_PROJECT_NAME as o, CreatedProjectNotFound as p, HubClientFailed as r, state as s, HUB_PROJECT_NAME as t, runRecord as u, ProjectTeamChange as v, DeploymentResource as w, Deployment as x, AbsoluteRootDir as y, CredentialsError as z };
 
-//# sourceMappingURL=HubClient-C_nvjlvW.js.map
+//# sourceMappingURL=HubClient-BYBV7cF5.js.map