@effect/platform 0.71.1 → 0.71.3

package/src/HttpApiSchema.ts

@@ -48,6 +48,30 @@ export const AnnotationParam: unique symbol = Symbol.for(
   "@effect/platform/HttpApiSchema/AnnotationParam"
 )
 
+/**
+ * @since 1.0.0
+ * @category annotations
+ */
+export const extractAnnotations = (ast: AST.Annotations): AST.Annotations => {
+  const result: Record<symbol, unknown> = {}
+  if (AnnotationStatus in ast) {
+    result[AnnotationStatus] = ast[AnnotationStatus]
+  }
+  if (AnnotationEmptyDecodeable in ast) {
+    result[AnnotationEmptyDecodeable] = ast[AnnotationEmptyDecodeable]
+  }
+  if (AnnotationEncoding in ast) {
+    result[AnnotationEncoding] = ast[AnnotationEncoding]
+  }
+  if (AnnotationParam in ast) {
+    result[AnnotationParam] = ast[AnnotationParam]
+  }
+  if (AnnotationMultipart in ast) {
+    result[AnnotationMultipart] = ast[AnnotationMultipart]
+  }
+  return result
+}
+
 const mergedAnnotations = (ast: AST.AST): Record<symbol, unknown> =>
   ast._tag === "Transformation" ?
     {

package/src/OpenApiJsonSchema.ts

@@ -4,7 +4,6 @@
 import * as JSONSchema from "effect/JSONSchema"
 import * as Record from "effect/Record"
 import type * as Schema from "effect/Schema"
-import type * as AST from "effect/SchemaAST"
 
 /**
  * @category model
@@ -24,6 +23,7 @@ export interface Annotations {
 export interface Never extends Annotations {
   $id: "/schemas/never"
   not: {}
+  nullable?: boolean
 }
 
 /**
@@ -60,6 +60,7 @@ export interface AnyObject extends Annotations {
     { type: "object" },
     { type: "array" }
   ]
+  nullable?: boolean
 }
 
 /**
@@ -72,6 +73,7 @@ export interface Empty extends Annotations {
     { type: "object" },
     { type: "array" }
   ]
+  nullable?: boolean
 }
 
 /**
@@ -80,6 +82,7 @@ export interface Empty extends Annotations {
  */
 export interface Ref extends Annotations {
   $ref: string
+  nullable?: boolean
 }
 
 /**
@@ -99,6 +102,7 @@ export interface String extends Annotations {
     maxLength?: number
     pattern?: string
   }>
+  nullable?: boolean
 }
 
 /**
@@ -119,6 +123,7 @@ export interface Numeric extends Annotations {
     exclusiveMaximum?: number
     multipleOf?: number
   }>
+  nullable?: boolean
 }
 
 /**
@@ -143,6 +148,7 @@ export interface Integer extends Numeric {
  */
 export interface Boolean extends Annotations {
   type: "boolean"
+  nullable?: boolean
 }
 
 /**
@@ -155,6 +161,7 @@ export interface Array extends Annotations {
   minItems?: number
   maxItems?: number
   additionalItems?: JsonSchema | boolean
+  nullable?: boolean
 }
 
 /**
@@ -162,7 +169,9 @@ export interface Array extends Annotations {
  * @since 1.0.0
  */
 export interface Enum extends Annotations {
-  enum: globalThis.Array<AST.LiteralValue>
+  type?: "string" | "number" | "boolean"
+  enum: globalThis.Array<string | number | boolean | null>
+  nullable?: boolean
 }
 
 /**
@@ -172,9 +181,11 @@ export interface Enum extends Annotations {
 export interface Enums extends Annotations {
   $comment: "/schemas/enums"
   anyOf: globalThis.Array<{
+    type: "string" | "number"
     title: string
     enum: [string | number]
   }>
+  nullable?: boolean
 }
 
 /**
@@ -183,6 +194,7 @@ export interface Enums extends Annotations {
  */
 export interface AnyOf extends Annotations {
   anyOf: globalThis.Array<JsonSchema>
+  nullable?: boolean
 }
 
 /**
@@ -196,6 +208,7 @@ export interface Object extends Annotations {
   additionalProperties?: boolean | JsonSchema
   patternProperties?: Record<string, JsonSchema>
   propertyNames?: JsonSchema
+  nullable?: boolean
 }
 
 /**
@@ -254,14 +267,15 @@ export const make = <A, I, R>(schema: Schema.Schema<A, I, R>): Root => {
  * @since 1.0.0
  */
 export const makeWithDefs = <A, I, R>(schema: Schema.Schema<A, I, R>, options: {
-  readonly defs: Record<string, JsonSchema>
+  readonly defs: Record<string, any>
   readonly defsPath?: string
   readonly topLevelReferenceStrategy?: "skip" | "keep"
 }): JsonSchema => {
-  return JSONSchema.fromAST(schema.ast, {
+  const jsonSchema = JSONSchema.fromAST(schema.ast, {
     definitions: options.defs,
     definitionPath: options.defsPath ?? "#/components/schemas/",
     target: "openApi3.1",
     topLevelReferenceStrategy: options.topLevelReferenceStrategy ?? "keep"
   })
+  return jsonSchema as JsonSchema
 }