@atproto/lex-schema 0.0.3 → 0.0.5

package/src/schema/params.ts

@@ -18,13 +18,6 @@ export type ParamsSchemaOutput<Shape extends ParamsSchemaShape> =
     [K in keyof Shape]: Infer<Shape[K]>
   }>
 
-export type InferParamsSchema<T> =
-  T extends ParamsSchema<infer P>
-    ? NonNullable<unknown> extends ParamsSchemaOutput<P>
-      ? ParamsSchemaOutput<P> | undefined // Allow undefined if all params are optional
-      : ParamsSchemaOutput<P>
-    : never
-
 export class ParamsSchema<
   const Shape extends ParamsSchemaShape = ParamsSchemaShape,
 > extends Schema<ParamsSchemaOutput<Shape>> {

package/src/schema/payload.ts

@@ -1,53 +1,86 @@
 import { LexValue } from '@atproto/lex-data'
-import { Infer, Validator } from '../validation.js'
+import { Infer, Schema } from '../validation.js'
 
-export type LexBody<E extends string = any> = E extends `text/${string}`
-  ? string // Text encodings always yield string bodies
-  : E extends 'application/json'
-    ? LexValue
-    : Uint8Array
+export type InferPayload<
+  P extends Payload,
+  B,
+> = P['encoding'] extends infer E extends string
+  ? {
+      encoding: SchemaEncodingToDataEncoding<E>
+      body: InferPayloadBody<P, B>
+    }
+  : void | undefined
+
+export type SchemaEncodingToDataEncoding<E extends string> = E extends '*/*'
+  ? `${string}/${string}`
+  : E extends `${infer T extends string}/*`
+    ? `${T}/${string}`
+    : E
 
 export type InferPayloadEncoding<P extends Payload> =
-  P extends Payload<infer E, any> ? E : undefined
-
-export type InferPayloadBody<P extends Payload> =
-  P extends Payload<any, infer S>
-    ? S extends Validator
-      ? Infer<S>
-      : P extends Payload<infer E extends string>
-        ? LexBody<E>
-        : undefined
+  P['encoding'] extends string
+    ? SchemaEncodingToDataEncoding<P['encoding']>
     : undefined
 
-export type PayloadOutput<
-  E extends string | undefined = any,
-  S extends Validator | undefined = any,
-> = E extends string
-  ? S extends Validator
-    ? {
-        encoding: E
-        body: Infer<S>
-      }
-    : {
-        encoding: E
-        body: LexBody<E>
-      }
-  : void
-
-export type PayloadBody<E extends string | undefined> = E extends undefined
+export type InferPayloadBody<
+  P extends Payload,
+  B,
+> = P['encoding'] extends undefined
+  ? undefined // No encoding, no payload
+  : P['schema'] extends Schema
+    ? Infer<P['schema']>
+    : P['encoding'] extends `application/json`
+      ? LexValue
+      : B
+
+export type PayloadSchema<E extends string | undefined> = E extends undefined
   ? undefined
-  : Validator | undefined
+  : Schema | undefined
 
 export class Payload<
   const Encoding extends string | undefined = string | undefined,
-  const Body extends PayloadBody<Encoding> = PayloadBody<Encoding>,
+  const Schema extends PayloadSchema<Encoding> = PayloadSchema<Encoding>,
 > {
   constructor(
     readonly encoding: Encoding,
-    readonly schema: Body,
+    readonly schema: Schema,
   ) {
     if (encoding === undefined && schema !== undefined) {
       throw new TypeError('schema cannot be defined when encoding is undefined')
     }
   }
+
+  /**
+   * Checks whether the given content-type matches the expected payload schema's
+   * encoding.
+   */
+  matchesEncoding(contentType: string | undefined): boolean {
+    const mime = contentType?.split(';', 1)[0].trim()
+
+    const { encoding } = this
+
+    // Handle undefined cases
+    if (encoding === undefined) {
+      // Expecting no body
+      return mime === undefined
+    } else if (mime === undefined) {
+      // Expecting a body, but got no content-type
+      return false
+    }
+
+    if (encoding === '*/*') {
+      return true
+    }
+
+    if (encoding.endsWith('/*')) {
+      return mime.startsWith(encoding.slice(0, -1))
+    }
+
+    // Invalid: Lexicon can only specify "*/*" or "type/*" wildcards
+    if (encoding.includes('*')) {
+      return false
+    }
+
+    return encoding === mime
+  }
 }

package/src/schema/permission-set.test.ts

@@ -1,11 +1,11 @@
-import { asNsid } from '../core.js'
+import { asNsidString } from '../core.js'
 import { PermissionSet } from './permission-set.js'
 import { Permission } from './permission.js'
 
 describe('PermissionSet', () => {
   describe('constructor', () => {
     it('creates a PermissionSet instance with all parameters', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.post:write', {}),
@@ -24,7 +24,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with minimal options', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -39,7 +39,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with empty permissions array', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [] as const
       const options = {}
 
@@ -50,7 +50,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with title only', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.like:read', {}),
       ] as const
@@ -65,7 +65,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with detail only', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.like:read', {}),
       ] as const
@@ -80,7 +80,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with localized titles', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -102,7 +102,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with localized details', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -124,7 +124,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet instance with all options including localization', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.post:write', {}),
@@ -165,7 +165,7 @@ describe('PermissionSet', () => {
 
   describe('property immutability', () => {
     it('options object itself is mutable', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -181,7 +181,7 @@ describe('PermissionSet', () => {
 
   describe('with multiple permissions', () => {
     it('creates a PermissionSet with multiple read permissions', () => {
-      const nsid = asNsid('app.bsky.oauth.read')
+      const nsid = asNsidString('app.bsky.oauth.read')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.like:read', {}),
@@ -211,7 +211,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet with mixed read/write permissions', () => {
-      const nsid = asNsid('app.bsky.oauth.full')
+      const nsid = asNsidString('app.bsky.oauth.full')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.post:write', {}),
@@ -229,7 +229,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a PermissionSet with a single permission', () => {
-      const nsid = asNsid('app.bsky.oauth.limited')
+      const nsid = asNsidString('app.bsky.oauth.limited')
       const permissions = [
         new Permission('app.bsky.actor.profile:read', {}),
       ] as const
@@ -249,7 +249,7 @@ describe('PermissionSet', () => {
 
   describe('edge cases', () => {
     it('handles very long NSID', () => {
-      const nsid = asNsid(
+      const nsid = asNsidString(
         'com.example.very.long.namespace.identifier.oauth.permissions',
       )
       const permissions = [new Permission('resource:action', {})] as const
@@ -261,7 +261,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles long title strings', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -277,7 +277,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles long detail strings', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -293,7 +293,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles multiple language codes in title:lang', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -319,7 +319,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles undefined values in title:lang', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -342,7 +342,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles undefined values in detail:lang', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -363,7 +363,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles special characters in title', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -379,7 +379,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles special characters in detail', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -396,7 +396,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles unicode characters in title', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -410,7 +410,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles empty strings in title', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -424,7 +424,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles empty strings in detail', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -438,7 +438,7 @@ describe('PermissionSet', () => {
     })
 
     it('handles large number of permissions', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = Array.from(
         { length: 100 },
         (_, i) => new Permission(`resource${i}:action`, {}),
@@ -453,7 +453,7 @@ describe('PermissionSet', () => {
 
   describe('real-world permission set examples', () => {
     it('creates a feed management permission set', () => {
-      const nsid = asNsid('app.bsky.oauth.feed')
+      const nsid = asNsidString('app.bsky.oauth.feed')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.post:write', {}),
@@ -483,7 +483,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a read-only permission set', () => {
-      const nsid = asNsid('app.bsky.oauth.readonly')
+      const nsid = asNsidString('app.bsky.oauth.readonly')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.like:read', {}),
@@ -504,7 +504,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a profile management permission set', () => {
-      const nsid = asNsid('app.bsky.oauth.profile')
+      const nsid = asNsidString('app.bsky.oauth.profile')
       const permissions = [
         new Permission('app.bsky.actor.profile:read', {}),
         new Permission('app.bsky.actor.profile:write', {}),
@@ -531,7 +531,7 @@ describe('PermissionSet', () => {
     })
 
     it('creates a minimal permission set', () => {
-      const nsid = asNsid('app.bsky.oauth.minimal')
+      const nsid = asNsidString('app.bsky.oauth.minimal')
       const permissions = [
         new Permission('app.bsky.actor.profile:read', {}),
       ] as const
@@ -549,7 +549,7 @@ describe('PermissionSet', () => {
 
   describe('permission validation', () => {
     it('validates that permissions are Permission instances', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permission1 = new Permission('app.bsky.feed.post:read', {})
       const permission2 = new Permission('app.bsky.feed.post:write', {})
       const permissions = [permission1, permission2] as const
@@ -562,7 +562,7 @@ describe('PermissionSet', () => {
     })
 
     it('preserves permission resource strings', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
         new Permission('app.bsky.feed.like:write', {}),
@@ -584,7 +584,7 @@ describe('PermissionSet', () => {
     })
 
     it('preserves permission options', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissionOptions = { custom: 'value' }
       const permissions = [
         new Permission('app.bsky.feed.post:read', permissionOptions),
@@ -599,7 +599,7 @@ describe('PermissionSet', () => {
 
   describe('option variations', () => {
     it('accepts title without detail', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -616,7 +616,7 @@ describe('PermissionSet', () => {
     })
 
     it('accepts detail without title', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -635,7 +635,7 @@ describe('PermissionSet', () => {
     })
 
     it('accepts title:lang without title', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const
@@ -656,7 +656,7 @@ describe('PermissionSet', () => {
     })
 
     it('accepts detail:lang without detail', () => {
-      const nsid = asNsid('app.bsky.oauth.permissions')
+      const nsid = asNsidString('app.bsky.oauth.permissions')
       const permissions = [
         new Permission('app.bsky.feed.post:read', {}),
       ] as const

package/src/schema/procedure.test.ts

@@ -1,12 +1,7 @@
 import { ObjectSchema } from './object.js'
 import { ParamsSchema } from './params.js'
 import { Payload } from './payload.js'
-import {
-  InferProcedureInputBody,
-  InferProcedureOutputBody,
-  InferProcedureParameters,
-  Procedure,
-} from './procedure.js'
+import { Procedure } from './procedure.js'
 import { StringSchema } from './string.js'
 
 describe('Procedure', () => {
@@ -288,62 +283,6 @@ describe('Procedure', () => {
     })
   })
 
-  describe('type inference helpers', () => {
-    it('infers procedure parameters type', () => {
-      const parameters = new ParamsSchema({
-        limit: new StringSchema({}),
-      })
-      const procedure = new Procedure(
-        'com.example.list',
-        parameters,
-        new Payload(undefined, undefined),
-        new Payload(undefined, undefined),
-        undefined,
-      )
-
-      type Params = InferProcedureParameters<typeof procedure>
-      // Type test - this will fail at compile time if inference is wrong
-      const params: Params = { limit: 'test' }
-      expect(params).toBeDefined()
-    })
-
-    it('infers procedure input body type', () => {
-      const inputSchema = new ObjectSchema({
-        text: new StringSchema({}),
-      })
-      const procedure = new Procedure(
-        'com.example.create',
-        new ParamsSchema({}),
-        new Payload('application/json', inputSchema),
-        new Payload(undefined, undefined),
-        undefined,
-      )
-
-      type InputBody = InferProcedureInputBody<typeof procedure>
-      // Type test - this will fail at compile time if inference is wrong
-      const input: InputBody = { text: 'hello' }
-      expect(input).toBeDefined()
-    })
-
-    it('infers procedure output body type', () => {
-      const outputSchema = new ObjectSchema({
-        uri: new StringSchema({}),
-      })
-      const procedure = new Procedure(
-        'com.example.get',
-        new ParamsSchema({}),
-        new Payload(undefined, undefined),
-        new Payload('application/json', outputSchema),
-        undefined,
-      )
-
-      type OutputBody = InferProcedureOutputBody<typeof procedure>
-      // Type test - this will fail at compile time if inference is wrong
-      const output: OutputBody = { uri: 'at://did:plc:abc/post/123' }
-      expect(output).toBeDefined()
-    })
-  })
-
   describe('property access', () => {
     it('provides access to all properties', () => {
       const nsid = 'com.example.test'

package/src/schema/procedure.ts

@@ -1,28 +1,16 @@
 import { NsidString } from '../core.js'
-import { Infer } from '../validation.js'
 import { ParamsSchema } from './params.js'
-import { InferPayloadBody, Payload } from './payload.js'
-
-export type InferProcedureParameters<Q extends Procedure> =
-  Q extends Procedure<any, infer P extends ParamsSchema, any> ? Infer<P> : never
-
-export type InferProcedureInputBody<Q extends Procedure> =
-  Q extends Procedure<any, any, infer I extends Payload, any>
-    ? InferPayloadBody<I>
-    : never
-
-export type InferProcedureOutputBody<Q extends Procedure> =
-  Q extends Procedure<any, any, any, infer O extends Payload>
-    ? InferPayloadBody<O>
-    : never
+import { Payload } from './payload.js'
 
 export class Procedure<
-  TNsid extends NsidString = any,
-  TParameters extends ParamsSchema = any,
-  TInputPayload extends Payload = any,
-  TOutputPayload extends Payload = any,
-  TErrors extends undefined | readonly string[] = any,
+  TNsid extends NsidString = NsidString,
+  TParameters extends ParamsSchema = ParamsSchema,
+  TInputPayload extends Payload = Payload,
+  TOutputPayload extends Payload = Payload,
+  TErrors extends undefined | readonly string[] = undefined | readonly string[],
 > {
+  readonly type = 'procedure' as const
+
   constructor(
     readonly nsid: TNsid,
     readonly parameters: TParameters,