fix: update api context format (#38)

Author: vadyvas

lib/2019.ts

@@ -68,6 +68,7 @@ export {
   AsyncValidateFunction,
   ErrorObject,
   ErrorNoParams,
+  Context,
 } from "./types"
 
 export {Plugin, Options, CodeOptions, InstanceOptions, Logger, ErrorsTextOptions} from "./core"

lib/2020.ts

@@ -62,6 +62,7 @@ export {
   AsyncValidateFunction,
   ErrorObject,
   ErrorNoParams,
+  Context,
 } from "./types"
 
 export {Plugin, Options, CodeOptions, InstanceOptions, Logger, ErrorsTextOptions} from "./core"

lib/ajv.ts

@@ -57,6 +57,7 @@ export {
   SchemaValidateFunction,
   ErrorObject,
   ErrorNoParams,
+  Context,
 } from "./types"
 
 export {Plugin, Options, CodeOptions, InstanceOptions, Logger, ErrorsTextOptions} from "./core"

lib/types/index.ts

@@ -242,3 +242,7 @@ export interface UriResolver {
   resolve(base: string, path: string): string
   serialize(component: URIComponent): string
 }
+
+export interface Context {
+  apiContext?: "request" | "response"
+}

lib/vocabularies/oasContext.ts

@@ -13,15 +13,15 @@ export function getSkipCondition(schema: AnySchemaObject, prop: string): Code |
   if (!hasReadOnly && !hasWriteOnly) return undefined
 
   const conditions: Code[] = []
-  const oasContext = _`typeof ${N.this} == "object" && ${N.this} && ${N.this}.oas`
+  const apiContext = _`typeof ${N.this} == "object" && ${N.this} && ${N.this}.apiContext`
 
   if (hasReadOnly) {
-    conditions.push(_`${oasContext} && ${N.this}.oas.mode === "request"`)
+    conditions.push(_`${apiContext} === "request"`)
   }
 
   if (hasWriteOnly) {
-    conditions.push(_`${oasContext} && ${N.this}.oas.mode === "response"`)
+    conditions.push(_`${apiContext} === "response"`)
   }
 
-  return conditions.length === 1 ? conditions[0] : or(...conditions)
+  return or(...conditions)
 }

lib/vocabularies/validation/readOnly.ts

@@ -4,11 +4,7 @@ import {_, str} from "../../compile/codegen"
 import N from "../../compile/names"
 
 const error: KeywordErrorDefinition = {
-  message: ({params}) =>
-    str`must NOT be present in ${params.mode || "this context"}${
-      params.location ? str` (${params.location})` : ""
-    }`,
-  params: ({params}) => _`{mode: ${params.mode}, location: ${params.location}}`,
+  message: () => str`must NOT be present in request context`,
 }
 
 const def: CodeKeywordDefinition = {
@@ -18,13 +14,9 @@ const def: CodeKeywordDefinition = {
   code(cxt: KeywordCxt) {
     if (cxt.schema !== true) return
 
-    const mode = _`(${N.this} && ${N.this}.oas ? ${N.this}.oas.mode : undefined)`
-    const location = _`(${N.this} && ${N.this}.oas ? ${N.this}.oas.location : undefined)`
-    cxt.setParams({mode, location})
+    const apiContext = _`(${N.this} && ${N.this}.apiContext)`
 
-    cxt.fail(
-      _`typeof ${N.this} == "object" && ${N.this} && ${N.this}.oas && ${N.this}.oas.mode === "request"`
-    )
+    cxt.fail(_`${apiContext} === "request"`)
   },
 }
 

lib/vocabularies/validation/writeOnly.ts

@@ -4,11 +4,7 @@ import {_, str} from "../../compile/codegen"
 import N from "../../compile/names"
 
 const error: KeywordErrorDefinition = {
-  message: ({params}) =>
-    str`must NOT be present in ${params.mode || "this context"}${
-      params.location ? str` (${params.location})` : ""
-    }`,
-  params: ({params}) => _`{mode: ${params.mode}, location: ${params.location}}`,
+  message: () => str`must NOT be present in response context`,
 }
 
 const def: CodeKeywordDefinition = {
@@ -17,12 +13,9 @@ const def: CodeKeywordDefinition = {
   error,
   code(cxt: KeywordCxt) {
     if (cxt.schema !== true) return
-    const mode = _`(${N.this} && ${N.this}.oas ? ${N.this}.oas.mode : undefined)`
-    const location = _`(${N.this} && ${N.this}.oas ? ${N.this}.oas.location : undefined)`
-    cxt.setParams({mode, location})
-    cxt.fail(
-      _`typeof ${N.this} == "object" && ${N.this} && ${N.this}.oas && ${N.this}.oas.mode === "response"`
-    )
+    const apiContext = _`(${N.this} && ${N.this}.apiContext)`
+
+    cxt.fail(_`${apiContext} === "response"`)
   },
 }
 

spec/validation/read-write.spec.ts

@@ -1,11 +1,9 @@
-import type {DataValidationCxt} from "../../lib/types"
+import type {DataValidationCxt, Context} from "../../lib/types"
 import Ajv from "../ajv"
 import chai from "../chai"
 
 chai.should()
 
-type OasMode = "request" | "response"
-
 function buildContext(data: unknown): DataValidationCxt {
   const dynamicAnchors: DataValidationCxt["dynamicAnchors"] = {}
   return {
@@ -21,17 +19,9 @@ function getAjv() {
   return new Ajv({passContext: true})
 }
 
-function getOasContext(mode: OasMode, location?: "requestBody" | "responseBody") {
-  return {oas: {mode, location}}
-}
-
 type Validate = ReturnType<InstanceType<typeof Ajv>["compile"]>
 
-function expectValid(
-  validate: Validate,
-  data: unknown,
-  ctx?: {oas: {mode: OasMode; location?: "requestBody" | "responseBody"}}
-) {
+function expectValid(validate: Validate, data: unknown, ctx?: Context) {
   const valid = ctx ? validate.call(ctx, data, buildContext(data)) : validate(data)
   valid.should.equal(true)
 }
@@ -40,7 +30,7 @@ function expectInvalid(
   validate: Validate,
   data: unknown,
   keyword: "readOnly" | "writeOnly" | "required",
-  ctx?: {oas: {mode: OasMode; location?: "requestBody" | "responseBody"}}
+  ctx?: Context
 ) {
   const valid = ctx ? validate.call(ctx, data, buildContext(data)) : validate(data)
   valid.should.equal(false)
@@ -78,7 +68,7 @@ describe("readOnly/writeOnly", () => {
 
     it("should skip readOnly in request context and still require writeOnly", () => {
       const validate = getAjv().compile(schemaWithRequired)
-      const requestCtx = getOasContext("request", "requestBody")
+      const requestCtx: Context = {apiContext: "request"}
 
       expectValid(validate, {password: "secret"}, requestCtx)
       expectInvalid(validate, {id: "1", password: "secret"}, "readOnly", requestCtx)
@@ -87,7 +77,7 @@ describe("readOnly/writeOnly", () => {
 
     it("should skip writeOnly in response context and still require readOnly", () => {
       const validate = getAjv().compile(schemaWithRequired)
-      const responseCtx = getOasContext("response", "responseBody")
+      const responseCtx: Context = {apiContext: "response"}
 
       expectValid(validate, {id: "1"}, responseCtx)
       expectInvalid(validate, {id: "1", password: "secret"}, "writeOnly", responseCtx)
@@ -98,14 +88,14 @@ describe("readOnly/writeOnly", () => {
   describe("presence validation with context", () => {
     it("should reject readOnly in request context", () => {
       const validate = getAjv().compile(baseSchema)
-      const requestCtx = getOasContext("request", "requestBody")
+      const requestCtx: Context = {apiContext: "request"}
 
       expectInvalid(validate, {id: "1"}, "readOnly", requestCtx)
     })
 
     it("should reject writeOnly in response context", () => {
       const validate = getAjv().compile(baseSchema)
-      const responseCtx = getOasContext("response", "responseBody")
+      const responseCtx: Context = {apiContext: "response"}
 
       expectInvalid(validate, {password: "secret"}, "writeOnly", responseCtx)
     })