Revise the ordering of type parameters within the SchemaStore inter… (

#2792) Co-authored-by: Tim <hello@timsmart.co>
Effect-TS · May 22, 2024 · 78f6d4a · 78f6d4a
1 parent e376641
commit 78f6d4a
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 32 deletions.
diff --git a/.changeset/light-foxes-buy.md b/.changeset/light-foxes-buy.md
@@ -0,0 +1,5 @@
+---
+"@effect/platform": minor
+---
+
+Revise the ordering of type parameters within the `SchemaStore` interface to enhance consistency
diff --git a/packages/platform/src/Http/Client.ts b/packages/platform/src/Http/Client.ts
@@ -133,7 +133,7 @@ export const catchTag: {
     tag: K,
     f: (e: Extract<E, { _tag: K }>) => Effect.Effect<A1, E1, R1>
   ): <A, R>(self: Client<A, E, R>) => Client<A1 | A, E1 | Exclude<E, { _tag: K }>, R1 | R>
-  <R, E extends { _tag: string }, A, K extends E["_tag"] & string, A1, E1, R1>(
+  <A, E extends { _tag: string }, R, K extends E["_tag"] & string, A1, E1, R1>(
     self: Client<A, E, R>,
     tag: K,
     f: (e: Extract<E, { _tag: K }>) => Effect.Effect<A1, E1, R1>

diff --git a/packages/platform/src/Http/IncomingMessage.ts b/packages/platform/src/Http/IncomingMessage.ts
@@ -69,7 +69,7 @@ export const schemaBodyJsonScoped = <A, I, R>(schema: Schema.Schema<A, I, R>, op
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyUrlParams = <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -82,7 +82,7 @@ export const schemaBodyUrlParams = <R, I extends Readonly<Record<string, string>
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyUrlParamsScoped = <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaBodyUrlParamsScoped = <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -97,7 +97,7 @@ export const schemaBodyUrlParamsScoped = <R, I extends Readonly<Record<string, s
  * @since 1.0.0
  * @category schema
  */
-export const schemaHeaders = <R, I extends Readonly<Record<string, string | undefined>>, A>(
+export const schemaHeaders = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -109,7 +109,7 @@ export const schemaHeaders = <R, I extends Readonly<Record<string, string | unde
  * @since 1.0.0
  * @category schema
  */
-export const schemaHeadersScoped = <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaHeadersScoped = <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {

diff --git a/packages/platform/src/Http/Multipart.ts b/packages/platform/src/Http/Multipart.ts
@@ -248,7 +248,7 @@ export const schemaJson: <A, I, R>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaPersisted: <R, I extends Partial<Persisted>, A>(
+export const schemaPersisted: <A, I extends Partial<Persisted>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => (persisted: Persisted) => Effect.Effect<A, ParseResult.ParseError, R> = internal.schemaPersisted

diff --git a/packages/platform/src/Http/Router.ts b/packages/platform/src/Http/Router.ts
@@ -194,7 +194,7 @@ export const schemaNoBody: <
  * @since 1.0.0
  * @category route context
  */
-export const schemaParams: <R, I extends Readonly<Record<string, string | Array<string> | undefined>>, A>(
+export const schemaParams: <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, R | RouteContext | ServerRequest.ParsedSearchParams> =
@@ -204,7 +204,7 @@ export const schemaParams: <R, I extends Readonly<Record<string, string | Array<
  * @since 1.0.0
  * @category route context
  */
-export const schemaPathParams: <R, I extends Readonly<Record<string, string | undefined>>, A>(
+export const schemaPathParams: <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, R | RouteContext> = internal.schemaPathParams

diff --git a/packages/platform/src/Http/ServerRequest.ts b/packages/platform/src/Http/ServerRequest.ts
@@ -133,7 +133,7 @@ export const upgradeChannel: <IE = never>() => Channel<
  * @since 1.0.0
  * @category schema
  */
-export const schemaCookies: <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaCookies: <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, ServerRequest | R> = internal.schemaCookies
@@ -142,7 +142,7 @@ export const schemaCookies: <R, I extends Readonly<Record<string, string>>, A>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaHeaders: <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaHeaders: <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, ServerRequest | R> = internal.schemaHeaders
@@ -151,7 +151,7 @@ export const schemaHeaders: <R, I extends Readonly<Record<string, string>>, A>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaSearchParams: <R, I extends Readonly<Record<string, string | Array<string> | undefined>>, A>(
+export const schemaSearchParams: <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, ParsedSearchParams | R> = internal.schemaSearchParams
@@ -169,7 +169,7 @@ export const schemaBodyJson: <A, I, R>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyForm: <R, I extends Partial<Multipart.Persisted>, A>(
+export const schemaBodyForm: <A, I extends Partial<Multipart.Persisted>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<
@@ -182,7 +182,7 @@ export const schemaBodyForm: <R, I extends Partial<Multipart.Persisted>, A>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyUrlParams: <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaBodyUrlParams: <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError | Error.RequestError, R | ServerRequest> = internal.schemaBodyUrlParams
@@ -191,7 +191,7 @@ export const schemaBodyUrlParams: <R, I extends Readonly<Record<string, string>>
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyMultipart: <R, I extends Partial<Multipart.Persisted>, A>(
+export const schemaBodyMultipart: <A, I extends Partial<Multipart.Persisted>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<

diff --git a/packages/platform/src/KeyValueStore.ts b/packages/platform/src/KeyValueStore.ts
@@ -76,7 +76,7 @@ export interface KeyValueStore {
   /**
    * Create a SchemaStore for the specified schema.
    */
-  readonly forSchema: <A, I, R>(schema: Schema.Schema<A, I, R>) => SchemaStore<R, A>
+  readonly forSchema: <A, I, R>(schema: Schema.Schema<A, I, R>) => SchemaStore<A, R>
 }
 
 /**
@@ -143,7 +143,7 @@ export type SchemaStoreTypeId = typeof SchemaStoreTypeId
  * @since 1.0.0
  * @category models
  */
-export interface SchemaStore<R, A> {
+export interface SchemaStore<A, R> {
   readonly [SchemaStoreTypeId]: SchemaStoreTypeId
   /**
    * Returns the value of the specified key if it exists.
@@ -202,6 +202,6 @@ export const layerSchema: <A, I, R>(
   schema: Schema.Schema<A, I, R>,
   tagIdentifier: string
 ) => {
-  readonly tag: Context.Tag<SchemaStore<R, A>, SchemaStore<R, A>>
-  readonly layer: Layer.Layer<SchemaStore<R, A>, never, KeyValueStore>
+  readonly tag: Context.Tag<SchemaStore<A, R>, SchemaStore<A, R>>
+  readonly layer: Layer.Layer<SchemaStore<A, R>, never, KeyValueStore>
 } = internal.layerSchema
diff --git a/packages/platform/src/Transferable.ts b/packages/platform/src/Transferable.ts
@@ -82,11 +82,11 @@ export const schema: {
   <I>(
     f: (_: I) => Iterable<globalThis.Transferable>
   ): <A, R>(self: Schema.Schema<A, I, R>) => Schema.Schema<A, I, R>
-  <R, I, A>(
+  <A, I, R>(
     self: Schema.Schema<A, I, R>,
     f: (_: I) => Iterable<globalThis.Transferable>
   ): Schema.Schema<A, I, R>
-} = dual(2, <R, I, A>(
+} = dual(2, <A, I, R>(
   self: Schema.Schema<A, I, R>,
   f: (_: I) => Iterable<globalThis.Transferable>
 ) =>

diff --git a/packages/platform/src/internal/http/multipart.ts b/packages/platform/src/internal/http/multipart.ts
@@ -118,7 +118,7 @@ export const SingleFileSchema: Schema.transform<
 })
 
 /** @internal */
-export const schemaPersisted = <R, I extends Partial<Multipart.Persisted>, A>(
+export const schemaPersisted = <A, I extends Partial<Multipart.Persisted>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {

diff --git a/packages/platform/src/internal/http/router.ts b/packages/platform/src/internal/http/router.ts
@@ -112,7 +112,7 @@ export const schemaNoBody = <
 }
 
 /** @internal */
-export const schemaParams = <R, I extends Readonly<Record<string, string | Array<string> | undefined>>, A>(
+export const schemaParams = <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -128,7 +128,7 @@ export const schemaParams = <R, I extends Readonly<Record<string, string | Array
 }
 
 /** @internal */
-export const schemaPathParams = <R, I extends Readonly<Record<string, string | undefined>>, A>(
+export const schemaPathParams = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {

diff --git a/packages/platform/src/internal/http/serverRequest.ts b/packages/platform/src/internal/http/serverRequest.ts
@@ -61,7 +61,7 @@ export const searchParamsFromURL = (url: URL): ReadonlyRecord<string, string | A
 }
 
 /** @internal */
-export const schemaCookies = <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaCookies = <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -70,7 +70,7 @@ export const schemaCookies = <R, I extends Readonly<Record<string, string>>, A>(
 }
 
 /** @internal */
-export const schemaHeaders = <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaHeaders = <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -79,7 +79,7 @@ export const schemaHeaders = <R, I extends Readonly<Record<string, string>>, A>(
 }
 
 /** @internal */
-export const schemaSearchParams = <R, I extends Readonly<Record<string, string | Array<string> | undefined>>, A>(
+export const schemaSearchParams = <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -97,7 +97,7 @@ const isMultipart = (request: ServerRequest.ServerRequest) =>
   request.headers["content-type"]?.toLowerCase().includes("multipart/form-data")
 
 /** @internal */
-export const schemaBodyForm = <R, I extends Partial<Multipart.Persisted>, A>(
+export const schemaBodyForm = <A, I extends Partial<Multipart.Persisted>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -116,7 +116,7 @@ export const schemaBodyForm = <R, I extends Partial<Multipart.Persisted>, A>(
 }
 
 /** @internal */
-export const schemaBodyUrlParams = <R, I extends Readonly<Record<string, string>>, A>(
+export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -125,7 +125,7 @@ export const schemaBodyUrlParams = <R, I extends Readonly<Record<string, string>
 }
 
 /** @internal */
-export const schemaBodyMultipart = <R, I extends Partial<Multipart.Persisted>, A>(
+export const schemaBodyMultipart = <A, I extends Partial<Multipart.Persisted>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {

diff --git a/packages/platform/src/internal/keyValueStore.ts b/packages/platform/src/internal/keyValueStore.ts
@@ -71,7 +71,7 @@ export const SchemaStoreTypeId: KeyValueStore.SchemaStoreTypeId = Symbol.for(
 const makeSchemaStore = <A, I, R>(
   store: KeyValueStore.KeyValueStore,
   schema: Schema.Schema<A, I, R>
-): KeyValueStore.SchemaStore<R, A> => {
+): KeyValueStore.SchemaStore<A, R> => {
   const jsonSchema = Schema.parseJson(schema)
   const parse = Schema.decodeUnknown(jsonSchema)
   const encode = Schema.encode(jsonSchema)
@@ -170,7 +170,7 @@ export const layerSchema = <A, I, R>(
   schema: Schema.Schema<A, I, R>,
   tagIdentifier: string
 ) => {
-  const tag = Context.GenericTag<KeyValueStore.SchemaStore<R, A>>(tagIdentifier)
+  const tag = Context.GenericTag<KeyValueStore.SchemaStore<A, R>>(tagIdentifier)
   const layer = Layer.effect(tag, Effect.map(keyValueStoreTag, (store) => store.forSchema(schema)))
   return { tag, layer } as const
 }
diff --git a/packages/platform/test/KeyValueStore.test.ts b/packages/platform/test/KeyValueStore.test.ts
@@ -115,7 +115,7 @@ class User extends Schema.Class<User>("User")({
   age: Schema.Number
 }) {}
 const UserStore = KeyValueStore.layerSchema(User, "UserStore")
-const runUserStore = <E, A>(effect: Effect.Effect<A, E, KeyValueStore.SchemaStore<never, User>>) =>
+const runUserStore = <E, A>(effect: Effect.Effect<A, E, KeyValueStore.SchemaStore<User, never>>) =>
   Effect.runPromise(Effect.provide(effect, UserStore.layer.pipe(Layer.provide(KeyValueStore.layerMemory))))
 
 describe("KeyValueStore / SchemaStore", () => {