effect-zero 0.5.0 → 0.6.0-beta.0

package/src/types/mutation.ts

@@ -0,0 +1,155 @@
+import * as Schema from "effect/Schema";
+import { JsonSchema } from "./common.js";
+import { MutationId } from "./mutation-id.js";
+
+// The code below was converted to Effect Schema from:
+// https://github.com/rocicorp/mono/blob/74273167af5d15ed07045e04165cb04d3983d44f/packages/zero-protocol/src/mutation.ts
+
+const PrimaryKey = Schema.NonEmptyArray(Schema.String);
+
+const PrimaryKeyValue = Schema.Union([Schema.String, Schema.Number, Schema.Boolean]);
+
+const PrimaryKeyValueRecord = Schema.Record(Schema.String, PrimaryKeyValue);
+
+const Value = Schema.Union([JsonSchema, Schema.Undefined]);
+const Row = Schema.Record(Schema.String, Value);
+
+const CRUD_MUTATION_NAME = "_zero_crud";
+
+// biome-ignore lint/correctness/noUnusedVariables: borrowed code
+const CLEANUP_RESULTS_MUTATION_NAME = "_zero_cleanupResults";
+
+// biome-ignore lint/correctness/noUnusedVariables: borrowed code
+const CleanupResultsArg = Schema.Union([
+  // Legacy format (no type field) - treat as single
+  Schema.Struct({
+    clientGroupID: Schema.String,
+    clientID: Schema.String,
+    upToMutationID: Schema.Number,
+  }),
+  // Explicit single: delete up to a specific mutation ID for one client
+  Schema.Struct({
+    type: Schema.Literal("single"),
+    clientGroupID: Schema.String,
+    clientID: Schema.String,
+    upToMutationID: Schema.Number,
+  }),
+  // Bulk: delete all mutations for multiple clients
+  Schema.Struct({
+    type: Schema.Literal("bulk"),
+    clientGroupID: Schema.String,
+    clientIDs: Schema.NonEmptyArray(Schema.String),
+  }),
+]);
+
+/**
+ * Inserts if entity with id does not already exist.
+ */
+const InsertOp = Schema.Struct({
+  op: Schema.Literal("insert"),
+  tableName: Schema.String,
+  primaryKey: PrimaryKey,
+  value: Row,
+});
+
+/**
+ * Upsert semantics. Inserts if entity with id does not already exist,
+ * otherwise updates existing entity with id.
+ */
+const UpsertOp = Schema.Struct({
+  op: Schema.Literal("upsert"),
+  tableName: Schema.String,
+  primaryKey: PrimaryKey,
+  value: Row,
+});
+
+/**
+ * Updates if entity with id exists, otherwise does nothing.
+ */
+const UpdateOp = Schema.Struct({
+  op: Schema.Literal("update"),
+  tableName: Schema.String,
+  primaryKey: PrimaryKey,
+  // Partial value with at least the primary key fields
+  value: Row,
+});
+
+/**
+ * Deletes entity with id if it exists, otherwise does nothing.
+ */
+const DeleteOp = Schema.Struct({
+  op: Schema.Literal("delete"),
+  tableName: Schema.String,
+  primaryKey: PrimaryKey,
+  // Partial value representing the primary key
+  value: PrimaryKeyValueRecord,
+});
+
+const CrudOp = Schema.Union([InsertOp, UpsertOp, UpdateOp, DeleteOp]);
+
+const CrudArg = Schema.Struct({
+  ops: Schema.Array(CrudOp),
+});
+
+const CrudArgs = Schema.Tuple([CrudArg]);
+
+const CrudMutation = Schema.Struct({
+  type: Schema.Literal("crud"),
+  id: Schema.Number,
+  clientID: Schema.String,
+  name: Schema.Literal(CRUD_MUTATION_NAME),
+  args: CrudArgs,
+  timestamp: Schema.Number,
+});
+
+const CustomMutation = Schema.Struct({
+  type: Schema.Literal("custom"),
+  id: Schema.Number,
+  clientID: Schema.String,
+  name: Schema.String,
+  args: Schema.Array(JsonSchema),
+  timestamp: Schema.Number,
+});
+
+export const Mutation = Schema.Union([CrudMutation, CustomMutation]);
+export type Mutation = typeof Mutation.Type;
+
+export const AppError = Schema.Struct({
+  error: Schema.Literal("app"),
+  // The user can return any additional data here
+  message: Schema.optional(Schema.String),
+  details: Schema.optional(JsonSchema),
+});
+
+export type AppError = typeof AppError.Type;
+
+export const ZeroError = Schema.Struct({
+  error: Schema.Literals([
+    /** @deprecated push oooMutation errors are now represented as ['error', { ... }] messages */
+    "oooMutation",
+    "alreadyProcessed",
+  ]),
+  details: Schema.optional(JsonSchema),
+});
+
+export type ZeroError = typeof ZeroError.Type;
+
+const MutationOk = Schema.Struct({
+  // The user can return any additional data here
+  data: Schema.optional(JsonSchema),
+});
+
+const MutationError = Schema.Union([AppError, ZeroError]);
+
+export const MutationResult = Schema.Union([
+  // We flip the original order here as otherwise values of type MutationError would get parsed as MutationOk with empty `data`
+  MutationError,
+  MutationOk,
+]);
+export type MutationResult = typeof MutationResult.Type;
+
+export const MutationResponse = Schema.Struct({
+  id: MutationId,
+  result: MutationResult,
+});
+export type MutationResponse = typeof MutationResponse.Type;

package/src/types/push.ts

@@ -1,118 +1,10 @@
 import * as Schema from "effect/Schema";
-import { JsonSchema } from "./common.js";
 import { PushFailedBody } from "./error.js";
+import { Mutation, MutationResponse } from "./mutation.js";
+import { MutationId } from "./mutation-id.js";
 
 // The code below was converted to Effect Schema from:
-// https://github.com/rocicorp/mono/blob/8e0f600fb3a9185facf60cfd4971d260b266690e/packages/zero-protocol/src/push.ts
-
-const PrimaryKey = Schema.Array(Schema.String);
-
-const PrimaryKeyValue = Schema.Union([Schema.String, Schema.Number, Schema.Boolean]);
-
-const PrimaryKeyValueRecord = Schema.Record(Schema.String, PrimaryKeyValue);
-
-const Value = Schema.Union([JsonSchema, Schema.Undefined]);
-const Row = Schema.Record(Schema.String, Value);
-
-const CRUD_MUTATION_NAME = "_zero_crud";
-
-// biome-ignore lint/correctness/noUnusedVariables: borrowed code
-const CLEANUP_RESULTS_MUTATION_NAME = "_zero_cleanupResults";
-
-// biome-ignore lint/correctness/noUnusedVariables: borrowed code
-const CleanupResultsArg = Schema.Union([
-  // Legacy format (no type field) - treat as single
-  Schema.Struct({
-    clientGroupID: Schema.String,
-    clientID: Schema.String,
-    upToMutationID: Schema.Number,
-  }),
-  // Explicit single: delete up to a specific mutation ID for one client
-  Schema.Struct({
-    type: Schema.Literal("single"),
-    clientGroupID: Schema.String,
-    clientID: Schema.String,
-    upToMutationID: Schema.Number,
-  }),
-  // Bulk: delete all mutations for multiple clients
-  Schema.Struct({
-    type: Schema.Literal("bulk"),
-    clientGroupID: Schema.String,
-    clientIDs: Schema.NonEmptyArray(Schema.String),
-  }),
-]);
-
-/**
- * Inserts if entity with id does not already exist.
- */
-const InsertOp = Schema.Struct({
-  op: Schema.Literal("insert"),
-  tableName: Schema.String,
-  primaryKey: PrimaryKey,
-  value: Row,
-});
-
-/**
- * Upsert semantics. Inserts if entity with id does not already exist,
- * otherwise updates existing entity with id.
- */
-const UpsertOp = Schema.Struct({
-  op: Schema.Literal("upsert"),
-  tableName: Schema.String,
-  primaryKey: PrimaryKey,
-  value: Row,
-});
-
-/**
- * Updates if entity with id exists, otherwise does nothing.
- */
-const UpdateOp = Schema.Struct({
-  op: Schema.Literal("update"),
-  tableName: Schema.String,
-  primaryKey: PrimaryKey,
-  // Partial value with at least the primary key fields
-  value: Row,
-});
-
-/**
- * Deletes entity with id if it exists, otherwise does nothing.
- */
-const DeleteOp = Schema.Struct({
-  op: Schema.Literal("delete"),
-  tableName: Schema.String,
-  primaryKey: PrimaryKey,
-  // Partial value representing the primary key
-  value: PrimaryKeyValueRecord,
-});
-
-const CrudOp = Schema.Union([InsertOp, UpsertOp, UpdateOp, DeleteOp]);
-
-const CrudArg = Schema.Struct({
-  ops: Schema.Array(CrudOp),
-});
-
-const CrudArgs = Schema.Tuple([CrudArg]);
-
-const CrudMutation = Schema.Struct({
-  type: Schema.Literal("crud"),
-  id: Schema.Number,
-  clientID: Schema.String,
-  name: Schema.Literal(CRUD_MUTATION_NAME),
-  args: CrudArgs,
-  timestamp: Schema.Number,
-});
-
-const CustomMutation = Schema.Struct({
-  type: Schema.Literal("custom"),
-  id: Schema.Number,
-  clientID: Schema.String,
-  name: Schema.String,
-  args: Schema.Array(JsonSchema),
-  timestamp: Schema.Number,
-});
-
-export const Mutation = Schema.Union([CrudMutation, CustomMutation]);
-export type Mutation = typeof Mutation.Type;
+// https://github.com/rocicorp/mono/blob/74273167af5d15ed07045e04165cb04d3983d44f/packages/zero-protocol/src/push.ts
 
 export const PushBody = Schema.Struct({
   clientGroupID: Schema.String,
@@ -129,57 +21,14 @@ export const PushBody = Schema.Struct({
    * and should not be included in push messages.
    */
   auth: Schema.optional(Schema.String),
+  /** W3C traceparent header for distributed tracing. */
+  traceparent: Schema.optional(Schema.String),
 });
 export type PushBody = typeof PushBody.Type;
 
 // biome-ignore lint/correctness/noUnusedVariables: borrowed code
 const PushMessage = Schema.Tuple([Schema.Literal("push"), PushBody]);
 
-const MutationId = Schema.Struct({
-  id: Schema.Number,
-  clientID: Schema.String,
-});
-
-export const AppError = Schema.Struct({
-  error: Schema.Literal("app"),
-  // The user can return any additional data here
-  message: Schema.optional(Schema.String),
-  details: Schema.optional(JsonSchema),
-});
-
-export type AppError = typeof AppError.Type;
-
-export const ZeroError = Schema.Struct({
-  error: Schema.Literals([
-    /** @deprecated push oooMutation errors are now represented as ['error', { ... }] messages */
-    "oooMutation",
-    "alreadyProcessed",
-  ]),
-  details: Schema.optional(JsonSchema),
-});
-
-export type ZeroError = typeof ZeroError.Type;
-
-const MutationOk = Schema.Struct({
-  // The user can return any additional data here
-  data: Schema.optional(JsonSchema),
-});
-
-const MutationError = Schema.Union([AppError, ZeroError]);
-
-export const MutationResult = Schema.Union([
-  // We flip the original order here as otherwise values of type MutationError would get parsed as MutationOk with empty `data`
-  MutationError,
-  MutationOk,
-]);
-export type MutationResult = typeof MutationResult.Type;
-
-export const MutationResponse = Schema.Struct({
-  id: MutationId,
-  result: MutationResult,
-});
-export type MutationResponse = typeof MutationResponse.Type;
-
 const PushOk = Schema.Struct({
   mutations: Schema.Array(MutationResponse),
 });
@@ -233,9 +82,9 @@ const ZeroPusherError = Schema.Struct({
 /**
  * @deprecated push errors are now represented as ['error', { ... }] messages
  */
-const PushError = Schema.Union([UnsupportedPushVersion, UnsupportedSchemaVersion, HttpError, ZeroPusherError]);
+export const PushError = Schema.Union([UnsupportedPushVersion, UnsupportedSchemaVersion, HttpError, ZeroPusherError]);
 
-const PushResponseBody = Schema.Union([PushOk, PushError]);
+export const PushResponseBody = Schema.Union([PushOk, PushError]);
 
 export const PushResponse = Schema.Union([PushResponseBody, PushFailedBody]);
 export type PushResponse = typeof PushResponse.Type;
@@ -245,12 +94,3 @@ const PushResponseMessage = Schema.Tuple([Schema.Literal("pushResponse"), PushRe
 
 // biome-ignore lint/correctness/noUnusedVariables: borrowed code
 const AckMutationResponsesMessage = Schema.Tuple([Schema.Literal("ackMutationResponses"), MutationId]);
-
-/**
- * The schema for the querystring parameters of the custom push endpoint.
- */
-export const PushParams = Schema.Struct({
-  schema: Schema.String,
-  appID: Schema.String,
-});
-export type PushParams = typeof PushParams.Type;

package/src/types/query-server.ts

@@ -0,0 +1,27 @@
+import * as Schema from "effect/Schema";
+import { ErroredQuery, TransformedQuery, TransformResponseMessage } from "./custom-queries.js";
+import { TransformFailedBody } from "./error.js";
+
+// The code below was converted to Effect Schema from:
+// https://github.com/rocicorp/mono/blob/74273167af5d15ed07045e04165cb04d3983d44f/packages/zero-protocol/src/query-server.ts
+
+export const QueryResult = Schema.Union([TransformedQuery, ErroredQuery]);
+export type QueryResult = typeof QueryResult.Type;
+
+export const QueryResponseBody = Schema.Array(QueryResult);
+export type QueryResponseBody = typeof QueryResponseBody.Type;
+
+export const QuerySuccess = Schema.Struct({
+  kind: Schema.Literal("QueryResponse"),
+  userID: Schema.optional(Schema.NullOr(Schema.String)),
+  queries: QueryResponseBody,
+});
+export type QuerySuccess = typeof QuerySuccess.Type;
+
+export const QueryResponse = Schema.Union([
+  QuerySuccess,
+  TransformFailedBody,
+  // for backwards compatibility
+  TransformResponseMessage,
+]);
+export type QueryResponse = typeof QueryResponse.Type;

package/dist/types/queries.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/types/queries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AA6CxC,eAAO,MAAM,uBAAuB;;;;KAAoE,CAAC;AACzG,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,IAAI,CAAC;AAS1E,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAA6D,CAAC"}

package/dist/types/queries.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"queries.js","sourceRoot":"","sources":["../../src/types/queries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,sDAAsD;AACtD,8HAA8H;AAE9H,uCAAuC;AACvC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC;AAE3B,MAAM,oBAAoB,GAAG,MAAM,CAAC,KAAK,CACvC,MAAM,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;CAC/B,CAAC,CACH,CAAC;AAEF,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,GAAG,EAAE,GAAG;CACT,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAExE,MAAM,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC;AAGzG,iEAAiE;AACjE,MAAM,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AAE3G,MAAM,sBAAsB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;AAEtG,MAAM,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC;AAEhG,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,sBAAsB,CAAC,CAAC,CAAC"}