@samebase/alchemy-convex 0.12.0 → 0.14.0

package/README.md

@@ -167,7 +167,7 @@ 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, `alchemy-state`, so a repository holds one secret and a stack can create
+one project of that team, `samebase`, 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,16 +185,26 @@ 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 `alchemy-state` and pushes the store functions to its
+the project `samebase` and pushes the store app of this package to its
 production deployment with the Convex CLI of the app; a later version of this package pushes 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
+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
 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

package/lib/index.d.ts

@@ -457,13 +457,27 @@ export declare const withRunRecord: (output: unknown, record: RunRecord) => obje
 //#endregion
 //#region src/State.d.ts
 /** The name of the state project in each team. */
-export declare const STORE_PROJECT_NAME = "alchemy-state";
+export declare const STORE_PROJECT_NAME = "samebase";
+declare const OutdatedBase_base: Schema.Class<OutdatedBase, Schema.TaggedStruct<"OutdatedBase", {
+  readonly team: Schema.Union<readonly [Schema.String, Schema.Number]>;
+  readonly deployment: Schema.String;
+  readonly version: Schema.Number;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * 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.
+ */
+export declare class OutdatedBase extends OutdatedBase_base {
+  get message(): string;
+}
 /**
- * Alchemy state in the `alchemy-state` project of `team`, with the team token
+ * Alchemy state in the `samebase` 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 when it is missing or older. `alchemy plan` on another
+ * 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
  * stack never touches Convex.
  */
 export declare const state: (options?: {

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/Credentials.ts","../src/ManagementApi.ts","../src/Providers.ts","../src/Push.ts","../src/Deployment.ts","../src/Component.ts","../src/Project.ts","../src/RunRecord.ts","../src/State.ts"],"mappings":";;;;;;;;;;;;;;;;UA6BiB;;WAEN,aAAa,SAAS;;WAEtB;;UAGM;;WAEN,aAAa,OAAO,OAAO;;WAE3B,gBAAgB,OAAO;;WAEvB,WAAW,OAAO,OAAO,SAAS;;;qBAGhC,oBAAoB;;qBAKpB;;qBAGA;;;;qBAOA,yBAAyB;;;;;;;;;qBAiCzB,kBAAiB,MAAM,MAAM;;qBA0B7B,aAAc;WAChB,cAAc,SAAS;WACvB,YAAY,SAAS;MAC5B,MAAM,MAAM;;;KC3GJ,mBAAmB,kBAAkB;KACrC,mBAAmB,kBAAkB;;UAGhC,YAAY;WAClB,OAAO;WACP;WACA,UAAU;;;;;;;;;;;;;qBAQR,uBAAuB;UAuBnB;;WAEN,UAAU,GACjB,mBACA,MAAM,QAAQ,qBAAqB,QAAQ,YAAY,QACpD,OAAO,OAAO,GAAG;;WAEb,cACP,mBACA,MAAM,QAAQ,qBAAqB,QAAQ,0BACxC,OAAO,aAAa;;WAEhB,oBAAoB,GAC3B,mBACA,6BACA,WAAW,SAAS,kBACpB,MAAM,QAAQ,qBAAqB,QAAQ,YAAY,QACpD,OAAO,OAAO,GAAG;;;;;;;;WAQb,gBACP,sCACG,OAAO,eAAe;;;;;;;;WAQlB,oBAAoB,mBAAmB,OAAO;;;;;WAK9C,YAAY,OAAO,SAAS,qBAAqB;;;qBAM/C,sBAAsB;;;;qBC1FtB,kBAAkB;;;;;;qBAOlB,YAAa,cAAa,MAAM,MAAM,iBAA2B,MAAA,MAAA,8CAAA,mCAAA,oDAAA;;;;KC+BlE,oBAAoB,SAAS;;;;;;KAO7B;;WAIG;;;;;;;;WAQA;;;;;;;WAOA;;;;;;qBAkCF,0BAA0B;MAIxB;;;;;;;qBAMF,0BAA0B;MAOxB;;;;;;;;;qBAMF,uBAAuB;MAMrB;;;;;;;qBAQF,2BAA2B;MAIzB;;;;;;;qBAMF,oCAAoC;MAIlC;;;;;;qBAMF,kCAAkC;MAIhC;;;qBAuCF,oBACX;EACG;EAAa;;;;UC3HR;;WAEC;aAAoB;;;;;;;;WAOpB;;;;;;WAMA,SAAS;;WAET,MAAM,SAAS,eAAe;;KAG7B,mBACP;;WAEU;MAEV;;WAEU;;;;;WAKA;;;UAIL;WACC;WACA,MAAM;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA;;UAGM,6BAA6B;;WAEnC;;WAEA;;YAGC,aAAa,8BAEvB,iBACA,sBACA,kBACA;;KAQU,kBAAkB,+BAA8B,KACxD,UAAU,kBACR,WAAW;;;;;qBAWJ,wBAAwB;MAGtB;;;;;;;;;;;;qBAeF,cAAU,YACV,OAAS,oBAAe,OAAA,OAAA,mBAAA;;;;;;EAYvB,MAAA,YAAM;IAAc;IAAgB;QAAgB,OAAA,OAAA;;;;;;;;;;qBAMrD,iCAAiC;MAU/B;;;;;;qBAMF,qCAAqC;MAInC;;;;;;;;;qBAMF,4BAA4B;MAS1B;;;;;UC1OE;WACN;WACA;WACA;;;;;;;;;qBAUE,gBAAiB;EAC5B,YAAY;EACZ;EACA,WAAW;MACZ,OAAA,yBAAA;;;;KCWW,mBAAmB;KAEnB;;WAGG;;WAEA;;WAEA,mBAAmB;;WAEnB;;;WAIA;;WAEA;;UAGE;WACN;WACA;WACA;WACA;WACA;WACA;;YAGC,UAAU,2BAA2B,cAAc,0BAA0B;qBAC5E,2BAAO,cAAA;;;;;;;qBAGP,0BAA0B;MAIxB;;;;;;;;;;;;qBASF,gCAAgC;MAS9B;;;;;;;;qBAOF,yBAAyB;MAKvB;;;;;;qBAMF,+BAA+B;MAI7B;;;;;;;qBAMF,wBAAwB;MAItB;;;;;qBC5GF;;UAMI;WACN;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;WACA;;WAEA;;;;;qBAGE,uBAAuB;MAGrB;;;UAME;WACN;WACA,KAAK,SAAS;;;;;;;;qBAuIZ,YAAa,OAAO,mBAAiB,OAAO,OAAO,WAAW;;;;;;;qBAgB9D,gBAAiB,iBAAiB,QAAQ;;;;qBCxH1C;;;;;;;;;qBAgXA,QACX;WAAoB;MACnB,MAAM,MAAM,cAAc,oBAAoB"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/Credentials.ts","../src/ManagementApi.ts","../src/Providers.ts","../src/Push.ts","../src/Deployment.ts","../src/Component.ts","../src/Project.ts","../src/RunRecord.ts","../src/State.ts"],"mappings":";;;;;;;;;;;;;;;;UA6BiB;;WAEN,aAAa,SAAS;;WAEtB;;UAGM;;WAEN,aAAa,OAAO,OAAO;;WAE3B,gBAAgB,OAAO;;WAEvB,WAAW,OAAO,OAAO,SAAS;;;qBAGhC,oBAAoB;;qBAKpB;;qBAGA;;;;qBAOA,yBAAyB;;;;;;;;;qBAiCzB,kBAAiB,MAAM,MAAM;;qBA0B7B,aAAc;WAChB,cAAc,SAAS;WACvB,YAAY,SAAS;MAC5B,MAAM,MAAM;;;KC3GJ,mBAAmB,kBAAkB;KACrC,mBAAmB,kBAAkB;;UAGhC,YAAY;WAClB,OAAO;WACP;WACA,UAAU;;;;;;;;;;;;;qBAQR,uBAAuB;UAuBnB;;WAEN,UAAU,GACjB,mBACA,MAAM,QAAQ,qBAAqB,QAAQ,YAAY,QACpD,OAAO,OAAO,GAAG;;WAEb,cACP,mBACA,MAAM,QAAQ,qBAAqB,QAAQ,0BACxC,OAAO,aAAa;;WAEhB,oBAAoB,GAC3B,mBACA,6BACA,WAAW,SAAS,kBACpB,MAAM,QAAQ,qBAAqB,QAAQ,YAAY,QACpD,OAAO,OAAO,GAAG;;;;;;;;WAQb,gBACP,sCACG,OAAO,eAAe;;;;;;;;WAQlB,oBAAoB,mBAAmB,OAAO;;;;;WAK9C,YAAY,OAAO,SAAS,qBAAqB;;;qBAM/C,sBAAsB;;;;qBC1FtB,kBAAkB;;;;;;qBAOlB,YAAa,cAAa,MAAM,MAAM,iBAA2B,MAAA,MAAA,8CAAA,mCAAA,oDAAA;;;;KC+BlE,oBAAoB,SAAS;;;;;;KAO7B;;WAIG;;;;;;;;WAQA;;;;;;;WAOA;;;;;;qBAkCF,0BAA0B;MAIxB;;;;;;;qBAMF,0BAA0B;MAOxB;;;;;;;;;qBAMF,uBAAuB;MAMrB;;;;;;;qBAQF,2BAA2B;MAIzB;;;;;;;qBAMF,oCAAoC;MAIlC;;;;;;qBAMF,kCAAkC;MAIhC;;;qBAuCF,oBACX;EACG;EAAa;;;;UC3HR;;WAEC;aAAoB;;;;;;;;WAOpB;;;;;;WAMA,SAAS;;WAET,MAAM,SAAS,eAAe;;KAG7B,mBACP;;WAEU;MAEV;;WAEU;;;;;WAKA;;;UAIL;WACC;WACA,MAAM;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA;;UAGM,6BAA6B;;WAEnC;;WAEA;;YAGC,aAAa,8BAEvB,iBACA,sBACA,kBACA;;KAQU,kBAAkB,+BAA8B,KACxD,UAAU,kBACR,WAAW;;;;;qBAWJ,wBAAwB;MAGtB;;;;;;;;;;;;qBAeF,cAAU,YACV,OAAS,oBAAe,OAAA,OAAA,mBAAA;;;;;;EAYvB,MAAA,YAAM;IAAc;IAAgB;QAAgB,OAAA,OAAA;;;;;;;;;;qBAMrD,iCAAiC;MAU/B;;;;;;qBAMF,qCAAqC;MAInC;;;;;;;;;qBAMF,4BAA4B;MAS1B;;;;;UC1OE;WACN;WACA;WACA;;;;;;;;;qBAUE,gBAAiB;EAC5B,YAAY;EACZ;EACA,WAAW;MACZ,OAAA,yBAAA;;;;KCWW,mBAAmB;KAEnB;;WAGG;;WAEA;;WAEA,mBAAmB;;WAEnB;;;WAIA;;WAEA;;UAGE;WACN;WACA;WACA;WACA;WACA;WACA;;YAGC,UAAU,2BAA2B,cAAc,0BAA0B;qBAC5E,2BAAO,cAAA;;;;;;;qBAGP,0BAA0B;MAIxB;;;;;;;;;;;;qBASF,gCAAgC;MAS9B;;;;;;;;qBAOF,yBAAyB;MAKvB;;;;;;qBAMF,+BAA+B;MAI7B;;;;;;;qBAMF,wBAAwB;MAItB;;;;;qBC5GF;;UAMI;WACN;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;WACA;;WAEA;;;;;qBAGE,uBAAuB;MAGrB;;;UAME;WACN;WACA,KAAK,SAAS;;;;;;;;qBAuIZ,YAAa,OAAO,mBAAiB,OAAO,OAAO,WAAW;;;;;;;qBAgB9D,gBAAiB,iBAAiB,QAAQ;;;;qBCrH1C;;;;;;;;;;;qBAwLA,qBAAqB;MAKnB;;;;;;;;;;;qBAqOF,QACX;WAAoB;MACnB,MAAM,MAAM,cAAc,oBAAoB"}

package/lib/index.js

@@ -1545,7 +1545,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 = "alchemy-state";
+const STORE_PROJECT_NAME = "samebase";
 /**
 * The actions of the key of one run: the internal queries and mutations of
 * the store, nothing else. Measured: `deployment:data:view` and
@@ -1660,6 +1660,26 @@ 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
@@ -1715,20 +1735,20 @@ const createStoreProject = (api, teamId, team) => Effect.gen(function* () {
 	return oldest;
 });
 /**
-* The StateService over the `alchemy-state` 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.
+* 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.
 */
 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, "alchemy-state")) ?? (yield* createStoreProject(api, teamId, team));
+	const project = (yield* findProjectByName(api, teamId, "samebase")) ?? (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 = [];
 	yield* Scope.addFinalizer(options.scope, Effect.suspend(() => Effect.forEach(keys, (key) => deleteDeployKey(api, deployment.name, key), { discard: true })));
-	const mint = createDeployKey(api, deployment.name, "alchemy-state", RUN_KEY_ACTIONS).pipe(Effect.map((key) => {
+	const mint = createDeployKey(api, deployment.name, STORE_PROJECT_NAME, RUN_KEY_ACTIONS).pipe(Effect.map((key) => {
 		keys.push(key);
 		return makeFunctionApi(deployment.deploymentUrl, key);
 	}), Effect.mapError((error) => failure(`no key for ${deployment.name}: ${error.message}`)));
@@ -1737,15 +1757,21 @@ 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 (version === void 0 || version < 4) {
+	if (yield* needsPush(version)) {
 		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 (version === void 0 || version < 4) {
+		if (yield* needsPush(version)) {
 			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. */
@@ -1787,11 +1813,12 @@ const makeConvexState = (options) => Effect.gen(function* () {
 	};
 });
 /**
-* Alchemy state in the `alchemy-state` project of `team`, with the team token
+* Alchemy state in the `samebase` 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 when it is missing or older. `alchemy plan` on another
+* 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
 * stack never touches Convex.
 */
 const state = (options = {}) => Layer.effect(State, Effect.gen(function* () {
@@ -1815,6 +1842,6 @@ const state = (options = {}) => Layer.effect(State, Effect.gen(function* () {
 	}).pipe(Effect.provideContext(context), Effect.orDie));
 }));
 //#endregion
-export { ACCESS_TOKEN_ENV, AbsoluteRootDir, AmbiguousDeployment, AmbiguousProject, CodePushFailed, ConvexApiError, ConvexAppNotFound, ConvexCliNotFound, CreatedProjectNotFound, Credentials, CredentialsError, DEPLOY_KEY_ENV, Deployment, DeploymentIdentityChange, EnvironmentNeedsDeployKey, ManagementApi, ProductionDeploymentNotFound, Project, ProjectDeploymentChange, ProjectNotFound, ProjectTeamChange, Providers, PushTargetMismatch, RUN_RECORD_KEY, RunRecordError, STORE_PROJECT_NAME, VariablesOwnedBySomeoneElse, bindComponent, fromConfig, fromValues, parseDeployOutput, providers, runRecord, state, withRunRecord };
+export { ACCESS_TOKEN_ENV, AbsoluteRootDir, AmbiguousDeployment, AmbiguousProject, CodePushFailed, ConvexApiError, ConvexAppNotFound, ConvexCliNotFound, CreatedProjectNotFound, Credentials, CredentialsError, DEPLOY_KEY_ENV, Deployment, DeploymentIdentityChange, EnvironmentNeedsDeployKey, ManagementApi, OutdatedBase, ProductionDeploymentNotFound, Project, ProjectDeploymentChange, ProjectNotFound, ProjectTeamChange, Providers, PushTargetMismatch, RUN_RECORD_KEY, RunRecordError, STORE_PROJECT_NAME, VariablesOwnedBySomeoneElse, bindComponent, fromConfig, fromValues, parseDeployOutput, providers, runRecord, state, withRunRecord };
 
 //# sourceMappingURL=index.js.map