@alpic-ai/api 0.0.0-dev.ge9cac3a → 0.0.0-dev.ge9d2c4f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +1337 -881
  2. package/dist/index.mjs +180 -33
  3. package/package.json +6 -6
package/dist/index.d.mts CHANGED
@@ -291,6 +291,9 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
291
291
  openWorldJustification: z.ZodString;
292
292
  destructiveJustification: z.ZodString;
293
293
  }, z.core.$strip>>>;
294
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
295
+ name: z.ZodString;
296
+ }, z.core.$strip>>>>;
294
297
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
295
298
  mode: z.ZodLiteral<"all">;
296
299
  }, z.core.$strip>, z.ZodObject<{
@@ -731,10 +734,10 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
731
734
  url: z.ZodString;
732
735
  }, z.core.$strip>>>;
733
736
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
734
- scenario: z.ZodOptional<z.ZodString>;
735
- userPrompt: z.ZodOptional<z.ZodString>;
736
737
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
737
738
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
739
+ scenario: z.ZodOptional<z.ZodString>;
740
+ userPrompt: z.ZodOptional<z.ZodString>;
738
741
  }, z.core.$strip>>>;
739
742
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
740
743
  scenario: z.ZodOptional<z.ZodString>;
@@ -853,6 +856,9 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
853
856
  openWorldJustification: z.ZodString;
854
857
  destructiveJustification: z.ZodString;
855
858
  }, z.core.$strip>>>;
859
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
860
+ name: z.ZodString;
861
+ }, z.core.$strip>>>>;
856
862
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
857
863
  mode: z.ZodLiteral<"all">;
858
864
  }, z.core.$strip>, z.ZodObject<{
@@ -1293,10 +1299,10 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
1293
1299
  url: z.ZodString;
1294
1300
  }, z.core.$strip>>>;
1295
1301
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1296
- scenario: z.ZodOptional<z.ZodString>;
1297
- userPrompt: z.ZodOptional<z.ZodString>;
1298
1302
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1299
1303
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1304
+ scenario: z.ZodOptional<z.ZodString>;
1305
+ userPrompt: z.ZodOptional<z.ZodString>;
1300
1306
  }, z.core.$strip>>>;
1301
1307
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1302
1308
  scenario: z.ZodOptional<z.ZodString>;
@@ -1377,6 +1383,19 @@ type ClaudeSubmission = z.infer<typeof claudeSubmissionSchemaInternal>;
1377
1383
  type ChatgptSubmission = z.infer<typeof chatgptSubmissionSchemaInternal>;
1378
1384
  type Submission = ClaudeSubmission | ChatgptSubmission;
1379
1385
  //#endregion
1386
+ //#region ../domains/src/telemetry/schemas.d.ts
1387
+ export declare const TELEMETRY_SIGNALS: readonly ["logs", "metrics", "traces"];
1388
+ export declare const telemetrySignalSchema: z.ZodEnum<{
1389
+ logs: "logs";
1390
+ metrics: "metrics";
1391
+ traces: "traces";
1392
+ }>;
1393
+ export declare const OTLP_PROTOCOLS: readonly ["http/protobuf", "http/json"];
1394
+ export declare const otlpProtocolSchema: z.ZodEnum<{
1395
+ "http/protobuf": "http/protobuf";
1396
+ "http/json": "http/json";
1397
+ }>;
1398
+ //#endregion
1380
1399
  //#region src/api.contract.d.ts
1381
1400
  export type ApiContext = {
1382
1401
  request: Request & {
@@ -1531,6 +1550,9 @@ export declare const chatgptSubmissionUpdateSchema: z.ZodObject<{
1531
1550
  openWorldJustification: z.ZodString;
1532
1551
  destructiveJustification: z.ZodString;
1533
1552
  }, z.core.$strip>>>;
1553
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
1554
+ name: z.ZodString;
1555
+ }, z.core.$strip>>>>;
1534
1556
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
1535
1557
  mode: z.ZodLiteral<"all">;
1536
1558
  }, z.core.$strip>, z.ZodObject<{
@@ -1971,10 +1993,10 @@ export declare const chatgptSubmissionUpdateSchema: z.ZodObject<{
1971
1993
  url: z.ZodString;
1972
1994
  }, z.core.$strip>>>;
1973
1995
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1974
- scenario: z.ZodOptional<z.ZodString>;
1975
- userPrompt: z.ZodOptional<z.ZodString>;
1976
1996
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1977
1997
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1998
+ scenario: z.ZodOptional<z.ZodString>;
1999
+ userPrompt: z.ZodOptional<z.ZodString>;
1978
2000
  }, z.core.$strip>>>;
1979
2001
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1980
2002
  scenario: z.ZodOptional<z.ZodString>;
@@ -2666,6 +2688,206 @@ export declare const contract: {
2666
2688
  }>, Record<never, never>>;
2667
2689
  };
2668
2690
  };
2691
+ telemetryDestinations: {
2692
+ list: {
2693
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2694
+ environmentId: z.ZodString;
2695
+ }, z.core.$strip>, z.ZodArray<z.ZodObject<{
2696
+ id: z.ZodString;
2697
+ signal: z.ZodEnum<{
2698
+ logs: "logs";
2699
+ metrics: "metrics";
2700
+ traces: "traces";
2701
+ }>;
2702
+ endpoint: z.ZodString;
2703
+ protocol: z.ZodEnum<{
2704
+ "http/protobuf": "http/protobuf";
2705
+ "http/json": "http/json";
2706
+ }>;
2707
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
2708
+ id: z.ZodString;
2709
+ name: z.ZodString;
2710
+ value: z.ZodNull;
2711
+ isSecret: z.ZodLiteral<true>;
2712
+ }, z.core.$strip>, z.ZodObject<{
2713
+ id: z.ZodString;
2714
+ name: z.ZodString;
2715
+ value: z.ZodString;
2716
+ isSecret: z.ZodLiteral<false>;
2717
+ }, z.core.$strip>], "isSecret">>;
2718
+ status: z.ZodEnum<{
2719
+ active: "active";
2720
+ suspended: "suspended";
2721
+ }>;
2722
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
2723
+ credentials: "credentials";
2724
+ "wrong-path": "wrong-path";
2725
+ "wrong-protocol": "wrong-protocol";
2726
+ "invalid-payload": "invalid-payload";
2727
+ "partial-rejection": "partial-rejection";
2728
+ "blocked-target": "blocked-target";
2729
+ timeout: "timeout";
2730
+ unreachable: "unreachable";
2731
+ "receiver-error": "receiver-error";
2732
+ "unexpected-status": "unexpected-status";
2733
+ }>>;
2734
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
2735
+ }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2736
+ BAD_REQUEST: {};
2737
+ }>, {
2738
+ NOT_FOUND: {};
2739
+ }>, Record<never, never>>;
2740
+ };
2741
+ create: {
2742
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2743
+ environmentId: z.ZodString;
2744
+ signal: z.ZodEnum<{
2745
+ logs: "logs";
2746
+ metrics: "metrics";
2747
+ traces: "traces";
2748
+ }>;
2749
+ endpoint: z.ZodString;
2750
+ protocol: z.ZodDefault<z.ZodEnum<{
2751
+ "http/protobuf": "http/protobuf";
2752
+ "http/json": "http/json";
2753
+ }>>;
2754
+ isScopedToIntentionalRequestsOnly: z.ZodDefault<z.ZodBoolean>;
2755
+ headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
2756
+ name: z.ZodString;
2757
+ value: z.ZodString;
2758
+ isSecret: z.ZodBoolean;
2759
+ }, z.core.$strip>>>;
2760
+ }, z.core.$strip>, z.ZodObject<{
2761
+ id: z.ZodString;
2762
+ signal: z.ZodEnum<{
2763
+ logs: "logs";
2764
+ metrics: "metrics";
2765
+ traces: "traces";
2766
+ }>;
2767
+ endpoint: z.ZodString;
2768
+ protocol: z.ZodEnum<{
2769
+ "http/protobuf": "http/protobuf";
2770
+ "http/json": "http/json";
2771
+ }>;
2772
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
2773
+ id: z.ZodString;
2774
+ name: z.ZodString;
2775
+ value: z.ZodNull;
2776
+ isSecret: z.ZodLiteral<true>;
2777
+ }, z.core.$strip>, z.ZodObject<{
2778
+ id: z.ZodString;
2779
+ name: z.ZodString;
2780
+ value: z.ZodString;
2781
+ isSecret: z.ZodLiteral<false>;
2782
+ }, z.core.$strip>], "isSecret">>;
2783
+ status: z.ZodEnum<{
2784
+ active: "active";
2785
+ suspended: "suspended";
2786
+ }>;
2787
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
2788
+ credentials: "credentials";
2789
+ "wrong-path": "wrong-path";
2790
+ "wrong-protocol": "wrong-protocol";
2791
+ "invalid-payload": "invalid-payload";
2792
+ "partial-rejection": "partial-rejection";
2793
+ "blocked-target": "blocked-target";
2794
+ timeout: "timeout";
2795
+ unreachable: "unreachable";
2796
+ "receiver-error": "receiver-error";
2797
+ "unexpected-status": "unexpected-status";
2798
+ }>>;
2799
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
2800
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2801
+ BAD_REQUEST: {};
2802
+ }>, {
2803
+ NOT_FOUND: {};
2804
+ FORBIDDEN: {};
2805
+ OTLP_DESTINATION_UNVERIFIED: {
2806
+ status: number;
2807
+ };
2808
+ INTERNAL_SERVER_ERROR: {};
2809
+ }>, Record<never, never>>;
2810
+ };
2811
+ update: {
2812
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2813
+ environmentId: z.ZodString;
2814
+ destinationId: z.ZodString;
2815
+ endpoint: z.ZodOptional<z.ZodString>;
2816
+ protocol: z.ZodOptional<z.ZodEnum<{
2817
+ "http/protobuf": "http/protobuf";
2818
+ "http/json": "http/json";
2819
+ }>>;
2820
+ isScopedToIntentionalRequestsOnly: z.ZodOptional<z.ZodBoolean>;
2821
+ headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
2822
+ id: z.ZodOptional<z.ZodString>;
2823
+ name: z.ZodString;
2824
+ value: z.ZodOptional<z.ZodString>;
2825
+ isSecret: z.ZodBoolean;
2826
+ }, z.core.$strip>>>;
2827
+ }, z.core.$strip>, z.ZodObject<{
2828
+ id: z.ZodString;
2829
+ signal: z.ZodEnum<{
2830
+ logs: "logs";
2831
+ metrics: "metrics";
2832
+ traces: "traces";
2833
+ }>;
2834
+ endpoint: z.ZodString;
2835
+ protocol: z.ZodEnum<{
2836
+ "http/protobuf": "http/protobuf";
2837
+ "http/json": "http/json";
2838
+ }>;
2839
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
2840
+ id: z.ZodString;
2841
+ name: z.ZodString;
2842
+ value: z.ZodNull;
2843
+ isSecret: z.ZodLiteral<true>;
2844
+ }, z.core.$strip>, z.ZodObject<{
2845
+ id: z.ZodString;
2846
+ name: z.ZodString;
2847
+ value: z.ZodString;
2848
+ isSecret: z.ZodLiteral<false>;
2849
+ }, z.core.$strip>], "isSecret">>;
2850
+ status: z.ZodEnum<{
2851
+ active: "active";
2852
+ suspended: "suspended";
2853
+ }>;
2854
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
2855
+ credentials: "credentials";
2856
+ "wrong-path": "wrong-path";
2857
+ "wrong-protocol": "wrong-protocol";
2858
+ "invalid-payload": "invalid-payload";
2859
+ "partial-rejection": "partial-rejection";
2860
+ "blocked-target": "blocked-target";
2861
+ timeout: "timeout";
2862
+ unreachable: "unreachable";
2863
+ "receiver-error": "receiver-error";
2864
+ "unexpected-status": "unexpected-status";
2865
+ }>>;
2866
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
2867
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2868
+ BAD_REQUEST: {};
2869
+ }>, {
2870
+ NOT_FOUND: {};
2871
+ FORBIDDEN: {};
2872
+ OTLP_DESTINATION_UNVERIFIED: {
2873
+ status: number;
2874
+ };
2875
+ }>, Record<never, never>>;
2876
+ };
2877
+ delete: {
2878
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2879
+ environmentId: z.ZodString;
2880
+ destinationId: z.ZodString;
2881
+ }, z.core.$strip>, z.ZodObject<{
2882
+ success: z.ZodLiteral<true>;
2883
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2884
+ BAD_REQUEST: {};
2885
+ }>, {
2886
+ NOT_FOUND: {};
2887
+ INTERNAL_SERVER_ERROR: {};
2888
+ }>, Record<never, never>>;
2889
+ };
2890
+ };
2669
2891
  projects: {
2670
2892
  update: {
2671
2893
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -3262,6 +3484,20 @@ export declare const contract: {
3262
3484
  NOT_FOUND: {};
3263
3485
  }>, Record<never, never>>;
3264
3486
  };
3487
+ list: {
3488
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
3489
+ projectId: z.ZodString;
3490
+ environmentId: z.ZodOptional<z.ZodString>;
3491
+ platform: z.ZodOptional<z.ZodEnum<{
3492
+ chatgpt: "chatgpt";
3493
+ claudeai: "claudeai";
3494
+ }>>;
3495
+ }, z.core.$strip>, z.ZodArray<z.ZodType<Submission, unknown, z.core.$ZodTypeInternals<Submission, unknown>>>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
3496
+ BAD_REQUEST: {};
3497
+ }>, {
3498
+ NOT_FOUND: {};
3499
+ }>, Record<never, never>>;
3500
+ };
3265
3501
  get: {
3266
3502
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
3267
3503
  submissionId: z.ZodString;
@@ -3397,6 +3633,9 @@ export declare const contract: {
3397
3633
  openWorldJustification: z.ZodString;
3398
3634
  destructiveJustification: z.ZodString;
3399
3635
  }, z.core.$strip>>>;
3636
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
3637
+ name: z.ZodString;
3638
+ }, z.core.$strip>>>>;
3400
3639
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
3401
3640
  mode: z.ZodLiteral<"all">;
3402
3641
  }, z.core.$strip>, z.ZodObject<{
@@ -3837,10 +4076,10 @@ export declare const contract: {
3837
4076
  url: z.ZodString;
3838
4077
  }, z.core.$strip>>>;
3839
4078
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
3840
- scenario: z.ZodOptional<z.ZodString>;
3841
- userPrompt: z.ZodOptional<z.ZodString>;
3842
4079
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
3843
4080
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
4081
+ scenario: z.ZodOptional<z.ZodString>;
4082
+ userPrompt: z.ZodOptional<z.ZodString>;
3844
4083
  }, z.core.$strip>>>;
3845
4084
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
3846
4085
  scenario: z.ZodOptional<z.ZodString>;
@@ -4527,6 +4766,206 @@ export declare const contractForDocs: {
4527
4766
  }>, Record<never, never>>;
4528
4767
  };
4529
4768
  };
4769
+ telemetryDestinations: {
4770
+ list: {
4771
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4772
+ environmentId: z.ZodString;
4773
+ }, z.core.$strip>, z.ZodArray<z.ZodObject<{
4774
+ id: z.ZodString;
4775
+ signal: z.ZodEnum<{
4776
+ logs: "logs";
4777
+ metrics: "metrics";
4778
+ traces: "traces";
4779
+ }>;
4780
+ endpoint: z.ZodString;
4781
+ protocol: z.ZodEnum<{
4782
+ "http/protobuf": "http/protobuf";
4783
+ "http/json": "http/json";
4784
+ }>;
4785
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
4786
+ id: z.ZodString;
4787
+ name: z.ZodString;
4788
+ value: z.ZodNull;
4789
+ isSecret: z.ZodLiteral<true>;
4790
+ }, z.core.$strip>, z.ZodObject<{
4791
+ id: z.ZodString;
4792
+ name: z.ZodString;
4793
+ value: z.ZodString;
4794
+ isSecret: z.ZodLiteral<false>;
4795
+ }, z.core.$strip>], "isSecret">>;
4796
+ status: z.ZodEnum<{
4797
+ active: "active";
4798
+ suspended: "suspended";
4799
+ }>;
4800
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
4801
+ credentials: "credentials";
4802
+ "wrong-path": "wrong-path";
4803
+ "wrong-protocol": "wrong-protocol";
4804
+ "invalid-payload": "invalid-payload";
4805
+ "partial-rejection": "partial-rejection";
4806
+ "blocked-target": "blocked-target";
4807
+ timeout: "timeout";
4808
+ unreachable: "unreachable";
4809
+ "receiver-error": "receiver-error";
4810
+ "unexpected-status": "unexpected-status";
4811
+ }>>;
4812
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
4813
+ }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4814
+ BAD_REQUEST: {};
4815
+ }>, {
4816
+ NOT_FOUND: {};
4817
+ }>, Record<never, never>>;
4818
+ };
4819
+ create: {
4820
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4821
+ environmentId: z.ZodString;
4822
+ signal: z.ZodEnum<{
4823
+ logs: "logs";
4824
+ metrics: "metrics";
4825
+ traces: "traces";
4826
+ }>;
4827
+ endpoint: z.ZodString;
4828
+ protocol: z.ZodDefault<z.ZodEnum<{
4829
+ "http/protobuf": "http/protobuf";
4830
+ "http/json": "http/json";
4831
+ }>>;
4832
+ isScopedToIntentionalRequestsOnly: z.ZodDefault<z.ZodBoolean>;
4833
+ headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
4834
+ name: z.ZodString;
4835
+ value: z.ZodString;
4836
+ isSecret: z.ZodBoolean;
4837
+ }, z.core.$strip>>>;
4838
+ }, z.core.$strip>, z.ZodObject<{
4839
+ id: z.ZodString;
4840
+ signal: z.ZodEnum<{
4841
+ logs: "logs";
4842
+ metrics: "metrics";
4843
+ traces: "traces";
4844
+ }>;
4845
+ endpoint: z.ZodString;
4846
+ protocol: z.ZodEnum<{
4847
+ "http/protobuf": "http/protobuf";
4848
+ "http/json": "http/json";
4849
+ }>;
4850
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
4851
+ id: z.ZodString;
4852
+ name: z.ZodString;
4853
+ value: z.ZodNull;
4854
+ isSecret: z.ZodLiteral<true>;
4855
+ }, z.core.$strip>, z.ZodObject<{
4856
+ id: z.ZodString;
4857
+ name: z.ZodString;
4858
+ value: z.ZodString;
4859
+ isSecret: z.ZodLiteral<false>;
4860
+ }, z.core.$strip>], "isSecret">>;
4861
+ status: z.ZodEnum<{
4862
+ active: "active";
4863
+ suspended: "suspended";
4864
+ }>;
4865
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
4866
+ credentials: "credentials";
4867
+ "wrong-path": "wrong-path";
4868
+ "wrong-protocol": "wrong-protocol";
4869
+ "invalid-payload": "invalid-payload";
4870
+ "partial-rejection": "partial-rejection";
4871
+ "blocked-target": "blocked-target";
4872
+ timeout: "timeout";
4873
+ unreachable: "unreachable";
4874
+ "receiver-error": "receiver-error";
4875
+ "unexpected-status": "unexpected-status";
4876
+ }>>;
4877
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
4878
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4879
+ BAD_REQUEST: {};
4880
+ }>, {
4881
+ NOT_FOUND: {};
4882
+ FORBIDDEN: {};
4883
+ OTLP_DESTINATION_UNVERIFIED: {
4884
+ status: number;
4885
+ };
4886
+ INTERNAL_SERVER_ERROR: {};
4887
+ }>, Record<never, never>>;
4888
+ };
4889
+ update: {
4890
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4891
+ environmentId: z.ZodString;
4892
+ destinationId: z.ZodString;
4893
+ endpoint: z.ZodOptional<z.ZodString>;
4894
+ protocol: z.ZodOptional<z.ZodEnum<{
4895
+ "http/protobuf": "http/protobuf";
4896
+ "http/json": "http/json";
4897
+ }>>;
4898
+ isScopedToIntentionalRequestsOnly: z.ZodOptional<z.ZodBoolean>;
4899
+ headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
4900
+ id: z.ZodOptional<z.ZodString>;
4901
+ name: z.ZodString;
4902
+ value: z.ZodOptional<z.ZodString>;
4903
+ isSecret: z.ZodBoolean;
4904
+ }, z.core.$strip>>>;
4905
+ }, z.core.$strip>, z.ZodObject<{
4906
+ id: z.ZodString;
4907
+ signal: z.ZodEnum<{
4908
+ logs: "logs";
4909
+ metrics: "metrics";
4910
+ traces: "traces";
4911
+ }>;
4912
+ endpoint: z.ZodString;
4913
+ protocol: z.ZodEnum<{
4914
+ "http/protobuf": "http/protobuf";
4915
+ "http/json": "http/json";
4916
+ }>;
4917
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
4918
+ id: z.ZodString;
4919
+ name: z.ZodString;
4920
+ value: z.ZodNull;
4921
+ isSecret: z.ZodLiteral<true>;
4922
+ }, z.core.$strip>, z.ZodObject<{
4923
+ id: z.ZodString;
4924
+ name: z.ZodString;
4925
+ value: z.ZodString;
4926
+ isSecret: z.ZodLiteral<false>;
4927
+ }, z.core.$strip>], "isSecret">>;
4928
+ status: z.ZodEnum<{
4929
+ active: "active";
4930
+ suspended: "suspended";
4931
+ }>;
4932
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
4933
+ credentials: "credentials";
4934
+ "wrong-path": "wrong-path";
4935
+ "wrong-protocol": "wrong-protocol";
4936
+ "invalid-payload": "invalid-payload";
4937
+ "partial-rejection": "partial-rejection";
4938
+ "blocked-target": "blocked-target";
4939
+ timeout: "timeout";
4940
+ unreachable: "unreachable";
4941
+ "receiver-error": "receiver-error";
4942
+ "unexpected-status": "unexpected-status";
4943
+ }>>;
4944
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
4945
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4946
+ BAD_REQUEST: {};
4947
+ }>, {
4948
+ NOT_FOUND: {};
4949
+ FORBIDDEN: {};
4950
+ OTLP_DESTINATION_UNVERIFIED: {
4951
+ status: number;
4952
+ };
4953
+ }>, Record<never, never>>;
4954
+ };
4955
+ delete: {
4956
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4957
+ environmentId: z.ZodString;
4958
+ destinationId: z.ZodString;
4959
+ }, z.core.$strip>, z.ZodObject<{
4960
+ success: z.ZodLiteral<true>;
4961
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4962
+ BAD_REQUEST: {};
4963
+ }>, {
4964
+ NOT_FOUND: {};
4965
+ INTERNAL_SERVER_ERROR: {};
4966
+ }>, Record<never, never>>;
4967
+ };
4968
+ };
4530
4969
  projects: {
4531
4970
  update: {
4532
4971
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -5123,6 +5562,20 @@ export declare const contractForDocs: {
5123
5562
  NOT_FOUND: {};
5124
5563
  }>, Record<never, never>>;
5125
5564
  };
5565
+ list: {
5566
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
5567
+ projectId: z.ZodString;
5568
+ environmentId: z.ZodOptional<z.ZodString>;
5569
+ platform: z.ZodOptional<z.ZodEnum<{
5570
+ chatgpt: "chatgpt";
5571
+ claudeai: "claudeai";
5572
+ }>>;
5573
+ }, z.core.$strip>, z.ZodArray<z.ZodType<Submission, unknown, z.core.$ZodTypeInternals<Submission, unknown>>>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
5574
+ BAD_REQUEST: {};
5575
+ }>, {
5576
+ NOT_FOUND: {};
5577
+ }>, Record<never, never>>;
5578
+ };
5126
5579
  get: {
5127
5580
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
5128
5581
  submissionId: z.ZodString;
@@ -5258,6 +5711,9 @@ export declare const contractForDocs: {
5258
5711
  openWorldJustification: z.ZodString;
5259
5712
  destructiveJustification: z.ZodString;
5260
5713
  }, z.core.$strip>>>;
5714
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
5715
+ name: z.ZodString;
5716
+ }, z.core.$strip>>>>;
5261
5717
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
5262
5718
  mode: z.ZodLiteral<"all">;
5263
5719
  }, z.core.$strip>, z.ZodObject<{
@@ -5698,10 +6154,10 @@ export declare const contractForDocs: {
5698
6154
  url: z.ZodString;
5699
6155
  }, z.core.$strip>>>;
5700
6156
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
5701
- scenario: z.ZodOptional<z.ZodString>;
5702
- userPrompt: z.ZodOptional<z.ZodString>;
5703
6157
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
5704
6158
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
6159
+ scenario: z.ZodOptional<z.ZodString>;
6160
+ userPrompt: z.ZodOptional<z.ZodString>;
5705
6161
  }, z.core.$strip>>>;
5706
6162
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
5707
6163
  scenario: z.ZodOptional<z.ZodString>;
@@ -5799,7 +6255,7 @@ export type RouteAuthMeta = {
5799
6255
  authScope?: AuthScope;
5800
6256
  };
5801
6257
  //#endregion
5802
- //#region ../../node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/promisable.d.ts
6258
+ //#region ../../node_modules/.pnpm/type-fest@5.10.0/node_modules/type-fest/source/promisable.d.ts
5803
6259
  /**
5804
6260
  Create a type that represents either the value or the value wrapped in `PromiseLike`.
5805
6261
 
@@ -5826,11 +6282,11 @@ await logger(() => Promise.resolve('bar'));
5826
6282
  */
5827
6283
  type Promisable<T> = T | PromiseLike<T>;
5828
6284
  //#endregion
5829
- //#region ../../node_modules/.pnpm/@orpc+shared@1.15.0_@opentelemetry+api@1.9.1/node_modules/@orpc/shared/dist/index.d.mts
6285
+ //#region ../../node_modules/.pnpm/@orpc+shared@1.15.7_@opentelemetry+api@1.9.1/node_modules/@orpc/shared/dist/index.d.mts
5830
6286
  type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
5831
6287
  type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
5832
6288
  //#endregion
5833
- //#region ../../node_modules/.pnpm/@orpc+client@1.15.0_@opentelemetry+api@1.9.1/node_modules/@orpc/client/dist/index.d.mts
6289
+ //#region ../../node_modules/.pnpm/@orpc+client@1.15.7_@opentelemetry+api@1.9.1/node_modules/@orpc/client/dist/index.d.mts
5834
6290
  declare const COMMON_ORPC_ERROR_DEFS: {
5835
6291
  readonly BAD_REQUEST: {
5836
6292
  readonly status: 400;
@@ -5943,7 +6399,7 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
5943
6399
  }
5944
6400
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
5945
6401
  //#endregion
5946
- //#region ../../node_modules/.pnpm/@orpc+server@1.15.0_@opentelemetry+api@1.9.1_ws@8.21.3/node_modules/@orpc/server/dist/shared/server.qKsRrdxW.d.mts
6402
+ //#region ../../node_modules/.pnpm/@orpc+server@1.15.7_@opentelemetry+api@1.9.1_ws@8.22.0/node_modules/@orpc/server/dist/shared/server.qKsRrdxW.d.mts
5947
6403
  type Context = Record<PropertyKey, any>;
5948
6404
  type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<TData>, 'defined' | 'status'>;
5949
6405
  type ORPCErrorConstructorMapItem<TCode extends ORPCErrorCode, TInData> = (...rest: MaybeOptionalOptions<ORPCErrorConstructorMapItemOptions<TInData>>) => ORPCError<TCode, TInData>;
@@ -6014,7 +6470,7 @@ interface Middleware<TInContext extends Context, TOutContext extends Context, TI
6014
6470
  }
6015
6471
  type AnyMiddleware = Middleware<any, any, any, any, any, any>;
6016
6472
  //#endregion
6017
- //#region ../../node_modules/.pnpm/@orpc+server@1.15.0_@opentelemetry+api@1.9.1_ws@8.21.3/node_modules/@orpc/server/dist/shared/server.C8_sRzQB.d.mts
6473
+ //#region ../../node_modules/.pnpm/@orpc+server@1.15.7_@opentelemetry+api@1.9.1_ws@8.22.0/node_modules/@orpc/server/dist/shared/server.C8_sRzQB.d.mts
6018
6474
  interface TraverseContractProcedureCallbackOptions {
6019
6475
  contract: AnyContractProcedure | AnyProcedure;
6020
6476
  path: readonly string[];
@@ -6023,976 +6479,976 @@ interface TraverseContractProcedureCallbackOptions {
6023
6479
  //#region ../../node_modules/.pnpm/json-schema-typed@8.0.2/node_modules/json-schema-typed/draft_2020_12.d.ts
6024
6480
  type MaybeReadonlyArray<T> = Array<T> | ReadonlyArray<T>;
6025
6481
  type ValueOf<T> = T[keyof T];
6026
- /**
6027
- * JSON Schema [Draft 2020-12](https://json-schema.org/draft/2020-12/json-schema-validation.html)
6482
+ /**
6483
+ * JSON Schema [Draft 2020-12](https://json-schema.org/draft/2020-12/json-schema-validation.html)
6028
6484
  */
6029
6485
  type JSONSchema<Value = any, SchemaType = Value extends boolean ? "boolean" : Value extends null ? "null" : Value extends number ? "number" | "integer" : Value extends string ? "string" : Value extends unknown[] ? "array" : Value extends Record<string | number, unknown> ? "object" : JSONSchema.TypeValue> = boolean | {
6030
- /**
6031
- * Using JSON Pointer fragments requires knowledge of the structure of the
6032
- * schema. When writing schema documents with the intention to provide
6033
- * re-usable schemas, it may be preferable to use a plain name fragment
6034
- * that is not tied to any particular structural location. This allows a
6035
- * subschema to be relocated without requiring JSON Pointer references to
6036
- * be updated.
6037
- *
6038
- * The `$anchor` keyword is used to specify such a fragment. It is an
6039
- * identifier keyword that can only be used to create plain name fragments.
6040
- *
6041
- * If present, the value of this keyword MUST be a string, which MUST start
6042
- * with a letter `[A-Za-z]`, followed by any number of letters, digits
6043
- * `[0-9]`, hyphens `-`, underscores `_`, colons `:`,
6044
- * or periods `.`.
6045
- *
6046
- * Note that the anchor string does not include the `#` character,
6047
- * as it is not a URI-reference. An `{"$anchor": "foo"}` becomes the
6048
- * fragment `#foo` when used in a URI.
6049
- *
6050
- * The base URI to which the resulting fragment is appended is determined
6051
- * by the `$id` keyword as explained in the previous section.
6052
- * Two `$anchor` keywords in the same schema document MAY have the same
6053
- * value if they apply to different base URIs, as the resulting full URIs
6054
- * will be distinct. However, the effect of two `$anchor` keywords
6055
- * with the same value and the same base URI is undefined. Implementations
6056
- * MAY raise an error if such usage is detected.
6486
+ /**
6487
+ * Using JSON Pointer fragments requires knowledge of the structure of the
6488
+ * schema. When writing schema documents with the intention to provide
6489
+ * re-usable schemas, it may be preferable to use a plain name fragment
6490
+ * that is not tied to any particular structural location. This allows a
6491
+ * subschema to be relocated without requiring JSON Pointer references to
6492
+ * be updated.
6493
+ *
6494
+ * The `$anchor` keyword is used to specify such a fragment. It is an
6495
+ * identifier keyword that can only be used to create plain name fragments.
6496
+ *
6497
+ * If present, the value of this keyword MUST be a string, which MUST start
6498
+ * with a letter `[A-Za-z]`, followed by any number of letters, digits
6499
+ * `[0-9]`, hyphens `-`, underscores `_`, colons `:`,
6500
+ * or periods `.`.
6501
+ *
6502
+ * Note that the anchor string does not include the `#` character,
6503
+ * as it is not a URI-reference. An `{"$anchor": "foo"}` becomes the
6504
+ * fragment `#foo` when used in a URI.
6505
+ *
6506
+ * The base URI to which the resulting fragment is appended is determined
6507
+ * by the `$id` keyword as explained in the previous section.
6508
+ * Two `$anchor` keywords in the same schema document MAY have the same
6509
+ * value if they apply to different base URIs, as the resulting full URIs
6510
+ * will be distinct. However, the effect of two `$anchor` keywords
6511
+ * with the same value and the same base URI is undefined. Implementations
6512
+ * MAY raise an error if such usage is detected.
6057
6513
  */
6058
6514
  $anchor?: string;
6059
- /**
6060
- * This keyword reserves a location for comments from schema authors to
6061
- * readers or maintainers of the schema.
6062
- *
6063
- * The value of this keyword MUST be a string. Implementations MUST NOT
6064
- * present this string to end users. Tools for editing schemas SHOULD
6065
- * support displaying and editing this keyword. The value of this keyword
6066
- * MAY be used in debug or error output which is intended for developers
6067
- * making use of schemas.
6068
- *
6069
- * Schema vocabularies SHOULD allow `$comment` within any object
6070
- * containing vocabulary keywords. Implementations MAY assume `$comment`
6071
- * is allowed unless the vocabulary specifically forbids it. Vocabularies
6072
- * MUST NOT specify any effect of `$comment` beyond what is described in
6073
- * this specification.
6074
- *
6075
- * Tools that translate other media types or programming languages
6076
- * to and from `application/schema+json` MAY choose to convert that media
6077
- * type or programming language's native comments to or from `$comment`
6078
- * values. The behavior of such translation when both native comments and
6079
- * `$comment` properties are present is implementation-dependent.
6080
- *
6081
- * Implementations MAY strip `$comment` values at any point during
6082
- * processing. In particular, this allows for shortening schemas when the
6083
- * size of deployed schemas is a concern.
6084
- *
6085
- * Implementations MUST NOT take any other action based on the presence,
6086
- * absence, or contents of `$comment` properties. In particular, the
6087
- * value of `$comment` MUST NOT be collected as an annotation result.
6515
+ /**
6516
+ * This keyword reserves a location for comments from schema authors to
6517
+ * readers or maintainers of the schema.
6518
+ *
6519
+ * The value of this keyword MUST be a string. Implementations MUST NOT
6520
+ * present this string to end users. Tools for editing schemas SHOULD
6521
+ * support displaying and editing this keyword. The value of this keyword
6522
+ * MAY be used in debug or error output which is intended for developers
6523
+ * making use of schemas.
6524
+ *
6525
+ * Schema vocabularies SHOULD allow `$comment` within any object
6526
+ * containing vocabulary keywords. Implementations MAY assume `$comment`
6527
+ * is allowed unless the vocabulary specifically forbids it. Vocabularies
6528
+ * MUST NOT specify any effect of `$comment` beyond what is described in
6529
+ * this specification.
6530
+ *
6531
+ * Tools that translate other media types or programming languages
6532
+ * to and from `application/schema+json` MAY choose to convert that media
6533
+ * type or programming language's native comments to or from `$comment`
6534
+ * values. The behavior of such translation when both native comments and
6535
+ * `$comment` properties are present is implementation-dependent.
6536
+ *
6537
+ * Implementations MAY strip `$comment` values at any point during
6538
+ * processing. In particular, this allows for shortening schemas when the
6539
+ * size of deployed schemas is a concern.
6540
+ *
6541
+ * Implementations MUST NOT take any other action based on the presence,
6542
+ * absence, or contents of `$comment` properties. In particular, the
6543
+ * value of `$comment` MUST NOT be collected as an annotation result.
6088
6544
  */
6089
6545
  $comment?: string;
6090
- /**
6091
- * The `$defs` keyword reserves a location for schema authors to inline
6092
- * re-usable JSON Schemas into a more general schema. The keyword does not
6093
- * directly affect the validation result.
6094
- *
6095
- * This keyword's value MUST be an object. Each member value of this object
6096
- * MUST be a valid JSON Schema.
6546
+ /**
6547
+ * The `$defs` keyword reserves a location for schema authors to inline
6548
+ * re-usable JSON Schemas into a more general schema. The keyword does not
6549
+ * directly affect the validation result.
6550
+ *
6551
+ * This keyword's value MUST be an object. Each member value of this object
6552
+ * MUST be a valid JSON Schema.
6097
6553
  */
6098
6554
  $defs?: Record<string, JSONSchema>;
6099
- /**
6100
- * "The `$dynamicAnchor` indicates that the fragment is an extension
6101
- * point when used with the `$dynamicRef` keyword. This low-level,
6102
- * advanced feature makes it easier to extend recursive schemas such as the
6103
- * meta-schemas, without imposing any particular semantics on that
6104
- * extension. See `$dynamicRef` for more details.
6555
+ /**
6556
+ * "The `$dynamicAnchor` indicates that the fragment is an extension
6557
+ * point when used with the `$dynamicRef` keyword. This low-level,
6558
+ * advanced feature makes it easier to extend recursive schemas such as the
6559
+ * meta-schemas, without imposing any particular semantics on that
6560
+ * extension. See `$dynamicRef` for more details.
6105
6561
  */
6106
6562
  $dynamicAnchor?: string;
6107
- /**
6108
- * The `$dynamicRef` keyword is an applicator that allows for deferring
6109
- * the full resolution until runtime, at which point it is resolved each
6110
- * time it is encountered while evaluating an instance.
6111
- *
6112
- * Together with `$dynamicAnchor`, `$dynamicRef` implements a
6113
- * cooperative extension mechanism that is primarily useful with recursive
6114
- * schemas (schemas that reference themselves). Both the extension point
6115
- * and the runtime-determined extension target are defined with
6116
- * `$dynamicAnchor`, and only exhibit runtime dynamic behavior when
6117
- * referenced with `$dynamicRef`.
6118
- *
6119
- * The value of the `$dynamicRef` property MUST be a string which is
6120
- * a URI-Reference. Resolved against the current URI base, it produces
6121
- * the URI used as the starting point for runtime resolution. This initial
6122
- * resolution is safe to perform on schema load.
6123
- *
6124
- * If the initially resolved starting point URI includes a fragment that
6125
- * was created by the `$dynamicAnchor` keyword, the initial URI MUST be
6126
- * replaced by the URI (including the fragment) for the outermost schema
6127
- * resource in the [dynamic scope][scopes] that defines
6128
- * an identically named fragment with `$dynamicAnchor`.
6129
- *
6130
- * Otherwise, its behavior is identical to `$ref`, and no runtime
6131
- * resolution is needed.
6132
- *
6133
- * [scopes]: https://json-schema.org/draft/2020-12/json-schema-core.html#scopes
6134
- *
6135
- * @format "uri-reference"
6563
+ /**
6564
+ * The `$dynamicRef` keyword is an applicator that allows for deferring
6565
+ * the full resolution until runtime, at which point it is resolved each
6566
+ * time it is encountered while evaluating an instance.
6567
+ *
6568
+ * Together with `$dynamicAnchor`, `$dynamicRef` implements a
6569
+ * cooperative extension mechanism that is primarily useful with recursive
6570
+ * schemas (schemas that reference themselves). Both the extension point
6571
+ * and the runtime-determined extension target are defined with
6572
+ * `$dynamicAnchor`, and only exhibit runtime dynamic behavior when
6573
+ * referenced with `$dynamicRef`.
6574
+ *
6575
+ * The value of the `$dynamicRef` property MUST be a string which is
6576
+ * a URI-Reference. Resolved against the current URI base, it produces
6577
+ * the URI used as the starting point for runtime resolution. This initial
6578
+ * resolution is safe to perform on schema load.
6579
+ *
6580
+ * If the initially resolved starting point URI includes a fragment that
6581
+ * was created by the `$dynamicAnchor` keyword, the initial URI MUST be
6582
+ * replaced by the URI (including the fragment) for the outermost schema
6583
+ * resource in the [dynamic scope][scopes] that defines
6584
+ * an identically named fragment with `$dynamicAnchor`.
6585
+ *
6586
+ * Otherwise, its behavior is identical to `$ref`, and no runtime
6587
+ * resolution is needed.
6588
+ *
6589
+ * [scopes]: https://json-schema.org/draft/2020-12/json-schema-core.html#scopes
6590
+ *
6591
+ * @format "uri-reference"
6136
6592
  */
6137
6593
  $dynamicRef?: string;
6138
- /**
6139
- * The `$id` keyword identifies a schema resource with its
6140
- * [canonical][[RFC6596]] URI.
6141
- *
6142
- * Note that this URI is an identifier and not necessarily a network
6143
- * locator. In the case of a network-addressable URL, a schema need not be
6144
- * downloadable from its canonical URI.
6145
- *
6146
- * If present, the value for this keyword MUST be a string, and MUST
6147
- * represent a valid [URI-reference][RFC3986]. This URI-reference SHOULD
6148
- * be normalized, and MUST resolve to an [absolute-URI][RFC3986] (without a
6149
- * fragment). Therefore, `$id` MUST NOT contain a non-empty fragment,
6150
- * and SHOULD NOT contain an empty fragment.
6151
- *
6152
- * Since an empty fragment in the context of the
6153
- * `application/schema+json` media type refers to the same resource as
6154
- * the base URI without a fragment, an implementation MAY normalize a URI
6155
- * ending with an empty fragment by removing the fragment. However, schema
6156
- * authors SHOULD NOT rely on this behavior across implementations.
6157
- *
6158
- * This URI also serves as the base URI for relative URI-references in
6159
- * keywords within the schema resource, in accordance with
6160
- * [RFC 3986][RFC3986] section 5.1.1 regarding base URIs embedded in
6161
- * content.
6162
- *
6163
- * The presence of `$id` in a subschema indicates that the subschema
6164
- * constitutes a distinct schema resource within a single schema document.
6165
- * Furthermore, in accordance with [RFC 3986][RFC3986] section 5.1.2
6166
- * regarding encapsulating entities, if an `$id` in a subschema is a
6167
- * relative URI-reference, the base URI for resolving that reference is the
6168
- * URI of the parent schema resource.
6169
- *
6170
- * If no parent schema object explicitly identifies itself as a resource
6171
- * with `$id`, the base URI is that of the entire document.
6172
- *
6173
- * The root schema of a JSON Schema document SHOULD contain an `$id`
6174
- * keyword with an [absolute-URI][RFC3986] (containing a scheme, but no
6175
- * fragment).
6176
- *
6177
- * [RFC6596]: https://datatracker.ietf.org/doc/html/rfc6596
6178
- * [RFC3986]: https://datatracker.ietf.org/doc/html/rfc3986
6179
- *
6180
- * @format "uri-reference"
6594
+ /**
6595
+ * The `$id` keyword identifies a schema resource with its
6596
+ * [canonical][[RFC6596]] URI.
6597
+ *
6598
+ * Note that this URI is an identifier and not necessarily a network
6599
+ * locator. In the case of a network-addressable URL, a schema need not be
6600
+ * downloadable from its canonical URI.
6601
+ *
6602
+ * If present, the value for this keyword MUST be a string, and MUST
6603
+ * represent a valid [URI-reference][RFC3986]. This URI-reference SHOULD
6604
+ * be normalized, and MUST resolve to an [absolute-URI][RFC3986] (without a
6605
+ * fragment). Therefore, `$id` MUST NOT contain a non-empty fragment,
6606
+ * and SHOULD NOT contain an empty fragment.
6607
+ *
6608
+ * Since an empty fragment in the context of the
6609
+ * `application/schema+json` media type refers to the same resource as
6610
+ * the base URI without a fragment, an implementation MAY normalize a URI
6611
+ * ending with an empty fragment by removing the fragment. However, schema
6612
+ * authors SHOULD NOT rely on this behavior across implementations.
6613
+ *
6614
+ * This URI also serves as the base URI for relative URI-references in
6615
+ * keywords within the schema resource, in accordance with
6616
+ * [RFC 3986][RFC3986] section 5.1.1 regarding base URIs embedded in
6617
+ * content.
6618
+ *
6619
+ * The presence of `$id` in a subschema indicates that the subschema
6620
+ * constitutes a distinct schema resource within a single schema document.
6621
+ * Furthermore, in accordance with [RFC 3986][RFC3986] section 5.1.2
6622
+ * regarding encapsulating entities, if an `$id` in a subschema is a
6623
+ * relative URI-reference, the base URI for resolving that reference is the
6624
+ * URI of the parent schema resource.
6625
+ *
6626
+ * If no parent schema object explicitly identifies itself as a resource
6627
+ * with `$id`, the base URI is that of the entire document.
6628
+ *
6629
+ * The root schema of a JSON Schema document SHOULD contain an `$id`
6630
+ * keyword with an [absolute-URI][RFC3986] (containing a scheme, but no
6631
+ * fragment).
6632
+ *
6633
+ * [RFC6596]: https://datatracker.ietf.org/doc/html/rfc6596
6634
+ * [RFC3986]: https://datatracker.ietf.org/doc/html/rfc3986
6635
+ *
6636
+ * @format "uri-reference"
6181
6637
  */
6182
6638
  $id?: string;
6183
- /**
6184
- * The `$ref` keyword is an applicator that is used to reference a
6185
- * statically identified schema. Its results are the results of the
6186
- * referenced schema. Other keywords can appear alongside of `$ref` in
6187
- * the same schema object.
6188
- *
6189
- * The value of the `$ref` property MUST be a string which is a
6190
- * URI-Reference. Resolved against the current URI base, it produces the
6191
- * URI of the schema to apply.
6192
- *
6193
- * @format "uri-reference"
6639
+ /**
6640
+ * The `$ref` keyword is an applicator that is used to reference a
6641
+ * statically identified schema. Its results are the results of the
6642
+ * referenced schema. Other keywords can appear alongside of `$ref` in
6643
+ * the same schema object.
6644
+ *
6645
+ * The value of the `$ref` property MUST be a string which is a
6646
+ * URI-Reference. Resolved against the current URI base, it produces the
6647
+ * URI of the schema to apply.
6648
+ *
6649
+ * @format "uri-reference"
6194
6650
  */
6195
6651
  $ref?: string;
6196
- /**
6197
- * The `$schema` keyword is both used as a JSON Schema dialect identifier
6198
- * and as the identifier of a resource which is itself a JSON Schema, which
6199
- * describes the set of valid schemas written for this particular dialect.
6200
- *
6201
- * The value of this keyword MUST be a [URI][RFC3986] (containing a scheme)
6202
- * and this URI MUST be normalized. The current schema MUST be valid
6203
- * against the meta-schema identified by this URI.
6204
- *
6205
- * If this URI identifies a retrievable resource, that resource SHOULD be
6206
- * of media type `application/schema+json`.
6207
- *
6208
- * The `$schema` keyword SHOULD be used in the document root schema
6209
- * object, and MAY be used in the root schema objects of embedded schema
6210
- * resources. It MUST NOT appear in non-resource root schema objects. If
6211
- * absent from the document root schema, the resulting behavior is
6212
- * implementation-defined.
6213
- *
6214
- * Values for this property are defined elsewhere in this and other
6215
- * documents, and by other parties.
6216
- *
6217
- * [RFC3986]: https://datatracker.ietf.org/doc/html/rfc3986
6218
- *
6219
- * @format "uri"
6652
+ /**
6653
+ * The `$schema` keyword is both used as a JSON Schema dialect identifier
6654
+ * and as the identifier of a resource which is itself a JSON Schema, which
6655
+ * describes the set of valid schemas written for this particular dialect.
6656
+ *
6657
+ * The value of this keyword MUST be a [URI][RFC3986] (containing a scheme)
6658
+ * and this URI MUST be normalized. The current schema MUST be valid
6659
+ * against the meta-schema identified by this URI.
6660
+ *
6661
+ * If this URI identifies a retrievable resource, that resource SHOULD be
6662
+ * of media type `application/schema+json`.
6663
+ *
6664
+ * The `$schema` keyword SHOULD be used in the document root schema
6665
+ * object, and MAY be used in the root schema objects of embedded schema
6666
+ * resources. It MUST NOT appear in non-resource root schema objects. If
6667
+ * absent from the document root schema, the resulting behavior is
6668
+ * implementation-defined.
6669
+ *
6670
+ * Values for this property are defined elsewhere in this and other
6671
+ * documents, and by other parties.
6672
+ *
6673
+ * [RFC3986]: https://datatracker.ietf.org/doc/html/rfc3986
6674
+ *
6675
+ * @format "uri"
6220
6676
  */
6221
6677
  $schema?: string;
6222
- /**
6223
- * The `$vocabulary` keyword is used in meta-schemas to identify the
6224
- * vocabularies available for use in schemas described by that meta-schema.
6225
- * It is also used to indicate whether each vocabulary is required or
6226
- * optional, in the sense that an implementation MUST understand the
6227
- * required vocabularies in order to successfully process the schema.
6228
- * Together, this information forms a dialect. Any vocabulary that is
6229
- * understood by the implementation MUST be processed in a manner
6230
- * consistent with the semantic definitions contained within the
6231
- * vocabulary.
6232
- *
6233
- * The value of this keyword MUST be an object. The property names in the
6234
- * object MUST be URIs (containing a scheme) and this URI MUST be
6235
- * normalized. Each URI that appears as a property name identifies a
6236
- * specific set of keywords and their semantics.
6237
- *
6238
- * The URI MAY be a URL, but the nature of the retrievable resource is
6239
- * currently undefined, and reserved for future use. Vocabulary authors
6240
- * MAY use the URL of the vocabulary specification, in a human-readable
6241
- * media type such as `text/html` or `text/plain`, as the vocabulary
6242
- * URI.
6243
- *
6244
- * The values of the object properties MUST be booleans. If the value is
6245
- * `true`, then implementations that do not recognize the vocabulary MUST
6246
- * refuse to process any schemas that declare this meta-schema with
6247
- * `$schema`. If the value is `false`, implementations that do not
6248
- * recognize the vocabulary SHOULD proceed with processing such schemas.
6249
- * The value has no impact if the implementation understands the
6250
- * vocabulary.
6251
- *
6252
- * Unrecognized keywords SHOULD be ignored. This remains the case for
6253
- * keywords defined by unrecognized vocabularies. It is not currently
6254
- * possible to distinguish between unrecognized keywords that are defined
6255
- * in vocabularies from those that are not part of any vocabulary.
6256
- *
6257
- * The `$vocabulary` keyword SHOULD be used in the root schema of any
6258
- * schema document intended for use as a meta-schema. It MUST NOT appear
6259
- * in subschemas.
6260
- *
6261
- * The `$vocabulary` keyword MUST be ignored in schema documents that are
6262
- * not being processed as a meta-schema.
6678
+ /**
6679
+ * The `$vocabulary` keyword is used in meta-schemas to identify the
6680
+ * vocabularies available for use in schemas described by that meta-schema.
6681
+ * It is also used to indicate whether each vocabulary is required or
6682
+ * optional, in the sense that an implementation MUST understand the
6683
+ * required vocabularies in order to successfully process the schema.
6684
+ * Together, this information forms a dialect. Any vocabulary that is
6685
+ * understood by the implementation MUST be processed in a manner
6686
+ * consistent with the semantic definitions contained within the
6687
+ * vocabulary.
6688
+ *
6689
+ * The value of this keyword MUST be an object. The property names in the
6690
+ * object MUST be URIs (containing a scheme) and this URI MUST be
6691
+ * normalized. Each URI that appears as a property name identifies a
6692
+ * specific set of keywords and their semantics.
6693
+ *
6694
+ * The URI MAY be a URL, but the nature of the retrievable resource is
6695
+ * currently undefined, and reserved for future use. Vocabulary authors
6696
+ * MAY use the URL of the vocabulary specification, in a human-readable
6697
+ * media type such as `text/html` or `text/plain`, as the vocabulary
6698
+ * URI.
6699
+ *
6700
+ * The values of the object properties MUST be booleans. If the value is
6701
+ * `true`, then implementations that do not recognize the vocabulary MUST
6702
+ * refuse to process any schemas that declare this meta-schema with
6703
+ * `$schema`. If the value is `false`, implementations that do not
6704
+ * recognize the vocabulary SHOULD proceed with processing such schemas.
6705
+ * The value has no impact if the implementation understands the
6706
+ * vocabulary.
6707
+ *
6708
+ * Unrecognized keywords SHOULD be ignored. This remains the case for
6709
+ * keywords defined by unrecognized vocabularies. It is not currently
6710
+ * possible to distinguish between unrecognized keywords that are defined
6711
+ * in vocabularies from those that are not part of any vocabulary.
6712
+ *
6713
+ * The `$vocabulary` keyword SHOULD be used in the root schema of any
6714
+ * schema document intended for use as a meta-schema. It MUST NOT appear
6715
+ * in subschemas.
6716
+ *
6717
+ * The `$vocabulary` keyword MUST be ignored in schema documents that are
6718
+ * not being processed as a meta-schema.
6263
6719
  */
6264
6720
  $vocabulary?: Record<string, string>;
6265
- /**
6266
- * @deprecated `additionalItems` has been deprecated in favor of `prefixItems`
6267
- * paired with `items`.
6721
+ /**
6722
+ * @deprecated `additionalItems` has been deprecated in favor of `prefixItems`
6723
+ * paired with `items`.
6268
6724
  */
6269
6725
  additionalItems?: JSONSchema;
6270
- /**
6271
- * The value of `additionalProperties` MUST be a valid JSON Schema.
6272
- *
6273
- * The behavior of this keyword depends on the presence and annotation
6274
- * results of `properties` and `patternProperties` within the same
6275
- * schema object. Validation with `additionalProperties` applies only to
6276
- * the child values of instance names that do not appear in the annotation
6277
- * results of either `properties` or `patternProperties`.
6278
- *
6279
- * For all such properties, validation succeeds if the child instance
6280
- * validates against the `additionalProperties` schema.
6281
- *
6282
- * The annotation result of this keyword is the set of instance property
6283
- * names validated by this keyword's subschema. Annotation results for
6284
- * `additionalProperties` keywords from multiple schemas applied to the
6285
- * same instance location are combined by taking the union of the sets.
6286
- *
6287
- * Omitting this keyword has the same assertion behavior as an empty
6288
- * schema.
6289
- *
6290
- * Implementations MAY choose to implement or optimize this keyword in
6291
- * another way that produces the same effect, such as by directly checking
6292
- * the names in `properties` and the patterns in `patternProperties`
6293
- * against the instance property set.
6726
+ /**
6727
+ * The value of `additionalProperties` MUST be a valid JSON Schema.
6728
+ *
6729
+ * The behavior of this keyword depends on the presence and annotation
6730
+ * results of `properties` and `patternProperties` within the same
6731
+ * schema object. Validation with `additionalProperties` applies only to
6732
+ * the child values of instance names that do not appear in the annotation
6733
+ * results of either `properties` or `patternProperties`.
6734
+ *
6735
+ * For all such properties, validation succeeds if the child instance
6736
+ * validates against the `additionalProperties` schema.
6737
+ *
6738
+ * The annotation result of this keyword is the set of instance property
6739
+ * names validated by this keyword's subschema. Annotation results for
6740
+ * `additionalProperties` keywords from multiple schemas applied to the
6741
+ * same instance location are combined by taking the union of the sets.
6742
+ *
6743
+ * Omitting this keyword has the same assertion behavior as an empty
6744
+ * schema.
6745
+ *
6746
+ * Implementations MAY choose to implement or optimize this keyword in
6747
+ * another way that produces the same effect, such as by directly checking
6748
+ * the names in `properties` and the patterns in `patternProperties`
6749
+ * against the instance property set.
6294
6750
  */
6295
6751
  additionalProperties?: JSONSchema;
6296
- /**
6297
- * This keyword's value MUST be a non-empty array. Each item of the array
6298
- * MUST be a valid JSON Schema.
6299
- *
6300
- * An instance validates successfully against this keyword if it validates
6301
- * successfully against all schemas defined by this keyword's value.
6752
+ /**
6753
+ * This keyword's value MUST be a non-empty array. Each item of the array
6754
+ * MUST be a valid JSON Schema.
6755
+ *
6756
+ * An instance validates successfully against this keyword if it validates
6757
+ * successfully against all schemas defined by this keyword's value.
6302
6758
  */
6303
6759
  allOf?: MaybeReadonlyArray<JSONSchema<Value, SchemaType>>;
6304
- /**
6305
- * This keyword's value MUST be a non-empty array. Each item of the array
6306
- * MUST be a valid JSON Schema.
6307
- *
6308
- * An instance validates successfully against this keyword if it validates
6309
- * successfully against at least one schema defined by this keyword's
6310
- * value.
6760
+ /**
6761
+ * This keyword's value MUST be a non-empty array. Each item of the array
6762
+ * MUST be a valid JSON Schema.
6763
+ *
6764
+ * An instance validates successfully against this keyword if it validates
6765
+ * successfully against at least one schema defined by this keyword's
6766
+ * value.
6311
6767
  */
6312
6768
  anyOf?: MaybeReadonlyArray<JSONSchema<Value, SchemaType>>;
6313
- /**
6314
- * An instance validates successfully against this keyword if its value is
6315
- * equal to the value of the keyword.
6316
- *
6317
- * Use of this keyword is functionally equivalent to the `enum` keyword
6318
- * with a single value.
6769
+ /**
6770
+ * An instance validates successfully against this keyword if its value is
6771
+ * equal to the value of the keyword.
6772
+ *
6773
+ * Use of this keyword is functionally equivalent to the `enum` keyword
6774
+ * with a single value.
6319
6775
  */
6320
6776
  const?: Value;
6321
- /**
6322
- * The value of this keyword MUST be a valid JSON Schema.
6323
- *
6324
- * An array instance is valid against `contains` if at least one of its
6325
- * elements is valid against the given schema. The subschema MUST be
6326
- * applied to every array element even after the first match has been
6327
- * found, in order to collect annotations for use by other keywords.
6328
- * This is to ensure that all possible annotations are collected.
6329
- *
6330
- * Logically, the validation result of applying the value subschema to each
6331
- * item in the array MUST be OR'ed with `false`, resulting in an overall
6332
- * validation result.
6333
- *
6334
- * This keyword produces an annotation value which is an array of the
6335
- * indexes to which this keyword validates successfully when applying its
6336
- * subschema, in ascending order. The value MAY be a boolean `true` if
6337
- * the subschema validates successfully when applied to every index of the
6338
- * instance. The annotation MUST be present if the instance array to which
6339
- * this keyword's schema applies is empty.
6777
+ /**
6778
+ * The value of this keyword MUST be a valid JSON Schema.
6779
+ *
6780
+ * An array instance is valid against `contains` if at least one of its
6781
+ * elements is valid against the given schema. The subschema MUST be
6782
+ * applied to every array element even after the first match has been
6783
+ * found, in order to collect annotations for use by other keywords.
6784
+ * This is to ensure that all possible annotations are collected.
6785
+ *
6786
+ * Logically, the validation result of applying the value subschema to each
6787
+ * item in the array MUST be OR'ed with `false`, resulting in an overall
6788
+ * validation result.
6789
+ *
6790
+ * This keyword produces an annotation value which is an array of the
6791
+ * indexes to which this keyword validates successfully when applying its
6792
+ * subschema, in ascending order. The value MAY be a boolean `true` if
6793
+ * the subschema validates successfully when applied to every index of the
6794
+ * instance. The annotation MUST be present if the instance array to which
6795
+ * this keyword's schema applies is empty.
6340
6796
  */
6341
6797
  contains?: JSONSchema<Value, SchemaType>;
6342
- /**
6343
- * If the instance value is a string, this property defines that the
6344
- * string SHOULD be interpreted as binary data and decoded using the
6345
- * encoding named by this property. [RFC 2045, Sec 6.1][RFC2045] lists the
6346
- * possible values for this property.
6347
- *
6348
- * The value of this property SHOULD be ignored if the instance described
6349
- * is not a string.
6350
- *
6351
- * If this keyword is absent, but `contentMediaType` is present, this
6352
- * indicates that the media type could be encoded into `UTF-8` like any
6353
- * other JSON string value, and does not require additional decoding.
6354
- *
6355
- * The value of this property MUST be a string.
6356
- *
6357
- * [RFC2045]: https://datatracker.ietf.org/doc/html/rfc2045#section-6.1
6798
+ /**
6799
+ * If the instance value is a string, this property defines that the
6800
+ * string SHOULD be interpreted as binary data and decoded using the
6801
+ * encoding named by this property. [RFC 2045, Sec 6.1][RFC2045] lists the
6802
+ * possible values for this property.
6803
+ *
6804
+ * The value of this property SHOULD be ignored if the instance described
6805
+ * is not a string.
6806
+ *
6807
+ * If this keyword is absent, but `contentMediaType` is present, this
6808
+ * indicates that the media type could be encoded into `UTF-8` like any
6809
+ * other JSON string value, and does not require additional decoding.
6810
+ *
6811
+ * The value of this property MUST be a string.
6812
+ *
6813
+ * [RFC2045]: https://datatracker.ietf.org/doc/html/rfc2045#section-6.1
6358
6814
  */
6359
6815
  contentEncoding?: "7bit" | "8bit" | "base64" | "binary" | "ietf-token" | "quoted-printable" | "x-token";
6360
- /**
6361
- * If the instance is a string, this property indicates the media type
6362
- * of the contents of the string. If `contentEncoding` is present,
6363
- * this property describes the decoded string.
6364
- *
6365
- * The value of this property must be a media type, as defined by
6366
- * [RFC 2046][RFC2046]. This property defines the media type of instances
6367
- * which this schema defines.
6368
- *
6369
- * The value of this property SHOULD be ignored if the instance described
6370
- * is not a string.
6371
- *
6372
- * If the `contentEncoding` property is not present, but the instance
6373
- * value is a string, then the value of this property SHOULD specify a text
6374
- * document type, and the character set SHOULD be the character set into
6375
- * which the JSON string value was decoded (for which the default is
6376
- * Unicode).
6377
- *
6378
- * [RFC2046]: https://datatracker.ietf.org/doc/html/rfc2046
6816
+ /**
6817
+ * If the instance is a string, this property indicates the media type
6818
+ * of the contents of the string. If `contentEncoding` is present,
6819
+ * this property describes the decoded string.
6820
+ *
6821
+ * The value of this property must be a media type, as defined by
6822
+ * [RFC 2046][RFC2046]. This property defines the media type of instances
6823
+ * which this schema defines.
6824
+ *
6825
+ * The value of this property SHOULD be ignored if the instance described
6826
+ * is not a string.
6827
+ *
6828
+ * If the `contentEncoding` property is not present, but the instance
6829
+ * value is a string, then the value of this property SHOULD specify a text
6830
+ * document type, and the character set SHOULD be the character set into
6831
+ * which the JSON string value was decoded (for which the default is
6832
+ * Unicode).
6833
+ *
6834
+ * [RFC2046]: https://datatracker.ietf.org/doc/html/rfc2046
6379
6835
  */
6380
6836
  contentMediaType?: string;
6381
- /**
6382
- * If the instance is a string, and if `contentMediaType` is present,
6383
- * this property contains a schema which describes the structure of the
6384
- * string.
6385
- *
6386
- * This keyword MAY be used with any media type that can be mapped into
6387
- * JSON Schema's data model.
6388
- *
6389
- * The value of this property MUST be a valid JSON schema. It SHOULD be
6390
- * ignored if `contentMediaType` is not present.
6837
+ /**
6838
+ * If the instance is a string, and if `contentMediaType` is present,
6839
+ * this property contains a schema which describes the structure of the
6840
+ * string.
6841
+ *
6842
+ * This keyword MAY be used with any media type that can be mapped into
6843
+ * JSON Schema's data model.
6844
+ *
6845
+ * The value of this property MUST be a valid JSON schema. It SHOULD be
6846
+ * ignored if `contentMediaType` is not present.
6391
6847
  */
6392
6848
  contentSchema?: JSONSchema<Value, SchemaType>;
6393
- /**
6394
- * This keyword can be used to supply a default JSON value associated with
6395
- * a particular schema. It is RECOMMENDED that a `default` value be valid
6396
- * against the associated schema.
6849
+ /**
6850
+ * This keyword can be used to supply a default JSON value associated with
6851
+ * a particular schema. It is RECOMMENDED that a `default` value be valid
6852
+ * against the associated schema.
6397
6853
  */
6398
6854
  default?: Value;
6399
- /**
6400
- * @deprecated `definitions` has been renamed to `$defs`.
6855
+ /**
6856
+ * @deprecated `definitions` has been renamed to `$defs`.
6401
6857
  */
6402
6858
  definitions?: Record<string, JSONSchema>;
6403
- /**
6404
- * @deprecated `dependencies` has been split into two keywords:
6405
- * `dependentSchemas` and `dependentRequired`.
6859
+ /**
6860
+ * @deprecated `dependencies` has been split into two keywords:
6861
+ * `dependentSchemas` and `dependentRequired`.
6406
6862
  */
6407
6863
  dependencies?: Record<string, MaybeReadonlyArray<string> | JSONSchema>;
6408
- /**
6409
- * The value of this keyword MUST be an object. Properties in
6410
- * this object, if any, MUST be arrays. Elements in each array,
6411
- * if any, MUST be strings, and MUST be unique.
6412
- *
6413
- * This keyword specifies properties that are required if a specific
6414
- * other property is present. Their requirement is dependent on the
6415
- * presence of the other property.
6416
- *
6417
- * Validation succeeds if, for each name that appears in both
6418
- * the instance and as a name within this keyword's value, every
6419
- * item in the corresponding array is also the name of a property
6420
- * in the instance.
6421
- *
6422
- * Omitting this keyword has the same behavior as an empty object.
6864
+ /**
6865
+ * The value of this keyword MUST be an object. Properties in
6866
+ * this object, if any, MUST be arrays. Elements in each array,
6867
+ * if any, MUST be strings, and MUST be unique.
6868
+ *
6869
+ * This keyword specifies properties that are required if a specific
6870
+ * other property is present. Their requirement is dependent on the
6871
+ * presence of the other property.
6872
+ *
6873
+ * Validation succeeds if, for each name that appears in both
6874
+ * the instance and as a name within this keyword's value, every
6875
+ * item in the corresponding array is also the name of a property
6876
+ * in the instance.
6877
+ *
6878
+ * Omitting this keyword has the same behavior as an empty object.
6423
6879
  */
6424
6880
  dependentRequired?: Record<string, MaybeReadonlyArray<string>>;
6425
- /**
6426
- * This keyword specifies subschemas that are evaluated if the instance is
6427
- * an object and contains a certain property.
6428
- *
6429
- * This keyword's value MUST be an object. Each value in the object MUST be
6430
- * a valid JSON Schema.
6431
- *
6432
- * If the object key is a property in the instance, the entire instance
6433
- * must validate against the subschema. Its use is dependent on the
6434
- * presence of the property.
6435
- *
6436
- * Omitting this keyword has the same behavior as an empty object.
6881
+ /**
6882
+ * This keyword specifies subschemas that are evaluated if the instance is
6883
+ * an object and contains a certain property.
6884
+ *
6885
+ * This keyword's value MUST be an object. Each value in the object MUST be
6886
+ * a valid JSON Schema.
6887
+ *
6888
+ * If the object key is a property in the instance, the entire instance
6889
+ * must validate against the subschema. Its use is dependent on the
6890
+ * presence of the property.
6891
+ *
6892
+ * Omitting this keyword has the same behavior as an empty object.
6437
6893
  */
6438
6894
  dependentSchemas?: Record<string, JSONSchema>;
6439
- /**
6440
- * The value of this keyword MUST be a boolean. When multiple occurrences
6441
- * of this keyword are applicable to a single sub-instance, applications
6442
- * SHOULD consider the instance location to be deprecated if any occurrence
6443
- * specifies a `true` value.
6444
- *
6445
- * If `deprecated` has a value of boolean `true`, it indicates that
6446
- * applications SHOULD refrain from usage of the declared property. It MAY
6447
- * mean the property is going to be removed in the future.
6448
- *
6449
- * A root schema containing `deprecated` with a value of `true`
6450
- * indicates that the entire resource being described MAY be removed in the
6451
- * future.
6452
- *
6453
- * The `deprecated` keyword applies to each instance location to which
6454
- * the schema object containing the keyword successfully applies. This can
6455
- * result in scenarios where every array item or object property is
6456
- * deprecated even though the containing array or object is not.
6457
- *
6458
- * Omitting this keyword has the same behavior as a value of `false`.
6895
+ /**
6896
+ * The value of this keyword MUST be a boolean. When multiple occurrences
6897
+ * of this keyword are applicable to a single sub-instance, applications
6898
+ * SHOULD consider the instance location to be deprecated if any occurrence
6899
+ * specifies a `true` value.
6900
+ *
6901
+ * If `deprecated` has a value of boolean `true`, it indicates that
6902
+ * applications SHOULD refrain from usage of the declared property. It MAY
6903
+ * mean the property is going to be removed in the future.
6904
+ *
6905
+ * A root schema containing `deprecated` with a value of `true`
6906
+ * indicates that the entire resource being described MAY be removed in the
6907
+ * future.
6908
+ *
6909
+ * The `deprecated` keyword applies to each instance location to which
6910
+ * the schema object containing the keyword successfully applies. This can
6911
+ * result in scenarios where every array item or object property is
6912
+ * deprecated even though the containing array or object is not.
6913
+ *
6914
+ * Omitting this keyword has the same behavior as a value of `false`.
6459
6915
  */
6460
6916
  deprecated?: boolean;
6461
- /**
6462
- * Can be used to decorate a user interface with explanation or information
6463
- * about the data produced.
6917
+ /**
6918
+ * Can be used to decorate a user interface with explanation or information
6919
+ * about the data produced.
6464
6920
  */
6465
6921
  description?: string;
6466
- /**
6467
- * This keyword's value MUST be a valid JSON Schema.
6468
- *
6469
- * When `if` is present, and the instance fails to validate against its
6470
- * subschema, then validation succeeds against this keyword if the instance
6471
- * successfully validates against this keyword's subschema.
6472
- *
6473
- * This keyword has no effect when `if` is absent, or when the instance
6474
- * successfully validates against its subschema. Implementations MUST NOT
6475
- * evaluate the instance against this keyword, for either validation or
6476
- * annotation collection purposes, in such cases.
6922
+ /**
6923
+ * This keyword's value MUST be a valid JSON Schema.
6924
+ *
6925
+ * When `if` is present, and the instance fails to validate against its
6926
+ * subschema, then validation succeeds against this keyword if the instance
6927
+ * successfully validates against this keyword's subschema.
6928
+ *
6929
+ * This keyword has no effect when `if` is absent, or when the instance
6930
+ * successfully validates against its subschema. Implementations MUST NOT
6931
+ * evaluate the instance against this keyword, for either validation or
6932
+ * annotation collection purposes, in such cases.
6477
6933
  */
6478
6934
  else?: JSONSchema<Value, SchemaType>;
6479
- /**
6480
- * The value of this keyword MUST be an array. This array SHOULD have at
6481
- * least one element. Elements in the array SHOULD be unique.
6482
- *
6483
- * An instance validates successfully against this keyword if its value is
6484
- * equal to one of the elements in this keyword's array value.
6485
- *
6486
- * Elements in the array might be of any type, including `null`.
6935
+ /**
6936
+ * The value of this keyword MUST be an array. This array SHOULD have at
6937
+ * least one element. Elements in the array SHOULD be unique.
6938
+ *
6939
+ * An instance validates successfully against this keyword if its value is
6940
+ * equal to one of the elements in this keyword's array value.
6941
+ *
6942
+ * Elements in the array might be of any type, including `null`.
6487
6943
  */
6488
6944
  enum?: MaybeReadonlyArray<Value>;
6489
- /**
6490
- * The value of this keyword MUST be an array. When multiple occurrences of
6491
- * this keyword are applicable to a single sub-instance, implementations
6492
- * MUST provide a flat array of all values rather than an array of arrays.
6493
- *
6494
- * This keyword can be used to provide sample JSON values associated with a
6495
- * particular schema, for the purpose of illustrating usage. It is
6496
- * RECOMMENDED that these values be valid against the associated schema.
6497
- *
6498
- * Implementations MAY use the value(s) of `default`, if present, as an
6499
- * additional example. If `examples` is absent, `default` MAY still be
6500
- * used in this manner.
6945
+ /**
6946
+ * The value of this keyword MUST be an array. When multiple occurrences of
6947
+ * this keyword are applicable to a single sub-instance, implementations
6948
+ * MUST provide a flat array of all values rather than an array of arrays.
6949
+ *
6950
+ * This keyword can be used to provide sample JSON values associated with a
6951
+ * particular schema, for the purpose of illustrating usage. It is
6952
+ * RECOMMENDED that these values be valid against the associated schema.
6953
+ *
6954
+ * Implementations MAY use the value(s) of `default`, if present, as an
6955
+ * additional example. If `examples` is absent, `default` MAY still be
6956
+ * used in this manner.
6501
6957
  */
6502
6958
  examples?: MaybeReadonlyArray<Value>;
6503
- /**
6504
- * The value of `exclusiveMaximum` MUST be a number, representing an
6505
- * exclusive upper limit for a numeric instance.
6506
- *
6507
- * If the instance is a number, then the instance is valid only if it has a
6508
- * value strictly less than (not equal to) `exclusiveMaximum`.
6959
+ /**
6960
+ * The value of `exclusiveMaximum` MUST be a number, representing an
6961
+ * exclusive upper limit for a numeric instance.
6962
+ *
6963
+ * If the instance is a number, then the instance is valid only if it has a
6964
+ * value strictly less than (not equal to) `exclusiveMaximum`.
6509
6965
  */
6510
6966
  exclusiveMaximum?: number;
6511
- /**
6512
- * The value of `exclusiveMinimum` MUST be a number, representing an
6513
- * exclusive lower limit for a numeric instance.
6514
- *
6515
- * If the instance is a number, then the instance is valid only if it has a
6516
- * value strictly greater than (not equal to) `exclusiveMinimum`.
6967
+ /**
6968
+ * The value of `exclusiveMinimum` MUST be a number, representing an
6969
+ * exclusive lower limit for a numeric instance.
6970
+ *
6971
+ * If the instance is a number, then the instance is valid only if it has a
6972
+ * value strictly greater than (not equal to) `exclusiveMinimum`.
6517
6973
  */
6518
6974
  exclusiveMinimum?: number;
6519
- /**
6520
- * Implementations MAY treat `format` as an assertion in addition to an
6521
- * annotation, and attempt to validate the value's conformance to the
6522
- * specified semantics.
6523
- *
6524
- * The value of this keyword is called a format attribute. It MUST be a
6525
- * string. A format attribute can generally only validate a given set
6526
- * of instance types. If the type of the instance to validate is not in
6527
- * this set, validation for this format attribute and instance SHOULD
6528
- * succeed. Format attributes are most often applied to strings, but can
6529
- * be specified to apply to any type.
6530
- *
6531
- * Implementations MAY support custom format attributes. Save for agreement
6532
- * between parties, schema authors SHALL NOT expect a peer implementation
6533
- * to support such custom format attributes. An implementation MUST NOT
6534
- * fail validation or cease processing due to an unknown format attribute.
6535
- * When treating `format` as an annotation, implementations SHOULD
6536
- * collect both known and unknown format attribute values.
6975
+ /**
6976
+ * Implementations MAY treat `format` as an assertion in addition to an
6977
+ * annotation, and attempt to validate the value's conformance to the
6978
+ * specified semantics.
6979
+ *
6980
+ * The value of this keyword is called a format attribute. It MUST be a
6981
+ * string. A format attribute can generally only validate a given set
6982
+ * of instance types. If the type of the instance to validate is not in
6983
+ * this set, validation for this format attribute and instance SHOULD
6984
+ * succeed. Format attributes are most often applied to strings, but can
6985
+ * be specified to apply to any type.
6986
+ *
6987
+ * Implementations MAY support custom format attributes. Save for agreement
6988
+ * between parties, schema authors SHALL NOT expect a peer implementation
6989
+ * to support such custom format attributes. An implementation MUST NOT
6990
+ * fail validation or cease processing due to an unknown format attribute.
6991
+ * When treating `format` as an annotation, implementations SHOULD
6992
+ * collect both known and unknown format attribute values.
6537
6993
  */
6538
6994
  format?: string;
6539
- /**
6540
- * This keyword's value MUST be a valid JSON Schema.
6541
- *
6542
- * This validation outcome of this keyword's subschema has no direct effect
6543
- * on the overall validation result. Rather, it controls which of the
6544
- * `then` or `else` keywords are evaluated.
6545
- *
6546
- * Instances that successfully validate against this keyword's subschema
6547
- * MUST also be valid against the subschema value of the `then` keyword,
6548
- * if present.
6549
- *
6550
- * Instances that fail to validate against this keyword's subschema MUST
6551
- * also be valid against the subschema value of the `else` keyword, if
6552
- * present.
6553
- *
6554
- * If annotations are being collected, they are collected
6555
- * from this keyword's subschema in the usual way, including when the
6556
- * keyword is present without either `then` or `else`.
6995
+ /**
6996
+ * This keyword's value MUST be a valid JSON Schema.
6997
+ *
6998
+ * This validation outcome of this keyword's subschema has no direct effect
6999
+ * on the overall validation result. Rather, it controls which of the
7000
+ * `then` or `else` keywords are evaluated.
7001
+ *
7002
+ * Instances that successfully validate against this keyword's subschema
7003
+ * MUST also be valid against the subschema value of the `then` keyword,
7004
+ * if present.
7005
+ *
7006
+ * Instances that fail to validate against this keyword's subschema MUST
7007
+ * also be valid against the subschema value of the `else` keyword, if
7008
+ * present.
7009
+ *
7010
+ * If annotations are being collected, they are collected
7011
+ * from this keyword's subschema in the usual way, including when the
7012
+ * keyword is present without either `then` or `else`.
6557
7013
  */
6558
7014
  if?: JSONSchema<Value, SchemaType>;
6559
- /**
6560
- * The value of `items` MUST be a valid JSON Schema.
6561
- *
6562
- * This keyword applies its subschema to all instance elements at indexes
6563
- * greater than the length of the `prefixItems` array in the same schema
6564
- * object, as reported by the annotation result of that `prefixItems`
6565
- * keyword. If no such annotation result exists, `items` applies its
6566
- * subschema to all instance array elements.
6567
- *
6568
- * Note that the behavior of `items` without `prefixItems` is identical
6569
- * to that of the schema form of `items` in prior drafts.
6570
- *
6571
- * When `prefixItems` is present, the behavior of `items` is identical
6572
- * to the former `additionalItems` keyword.
6573
- *
6574
- * If the `items` subschema is applied to any positions within the
6575
- * instance array, it produces an annotation result of boolean `true`,
6576
- * indicating that all remaining array elements have been evaluated against
6577
- * this keyword's subschema.
6578
- *
6579
- * Omitting this keyword has the same assertion behavior as an empty
6580
- * schema.
6581
- *
6582
- * Implementations MAY choose to implement or optimize this keyword
6583
- * in another way that produces the same effect, such as by directly
6584
- * checking for the presence and size of a `prefixItems` array.
7015
+ /**
7016
+ * The value of `items` MUST be a valid JSON Schema.
7017
+ *
7018
+ * This keyword applies its subschema to all instance elements at indexes
7019
+ * greater than the length of the `prefixItems` array in the same schema
7020
+ * object, as reported by the annotation result of that `prefixItems`
7021
+ * keyword. If no such annotation result exists, `items` applies its
7022
+ * subschema to all instance array elements.
7023
+ *
7024
+ * Note that the behavior of `items` without `prefixItems` is identical
7025
+ * to that of the schema form of `items` in prior drafts.
7026
+ *
7027
+ * When `prefixItems` is present, the behavior of `items` is identical
7028
+ * to the former `additionalItems` keyword.
7029
+ *
7030
+ * If the `items` subschema is applied to any positions within the
7031
+ * instance array, it produces an annotation result of boolean `true`,
7032
+ * indicating that all remaining array elements have been evaluated against
7033
+ * this keyword's subschema.
7034
+ *
7035
+ * Omitting this keyword has the same assertion behavior as an empty
7036
+ * schema.
7037
+ *
7038
+ * Implementations MAY choose to implement or optimize this keyword
7039
+ * in another way that produces the same effect, such as by directly
7040
+ * checking for the presence and size of a `prefixItems` array.
6585
7041
  */
6586
7042
  items?: JSONSchema;
6587
- /**
6588
- * The value of this keyword MUST be a non-negative integer.
6589
- *
6590
- * If `contains` is not present within the same schema object, then this
6591
- * keyword has no effect.
6592
- *
6593
- * An instance array is valid against `maxContains` in two ways,
6594
- * depending on the form of the annotation result of an adjacent
6595
- * `contains` keyword. The first way is if the annotation result is an
6596
- * array and the length of that array is less than or equal to the
6597
- * `maxContains` value. The second way is if the annotation result is a
6598
- * boolean `true` and the instance array length is less than or equal to
6599
- * the `maxContains` value.
7043
+ /**
7044
+ * The value of this keyword MUST be a non-negative integer.
7045
+ *
7046
+ * If `contains` is not present within the same schema object, then this
7047
+ * keyword has no effect.
7048
+ *
7049
+ * An instance array is valid against `maxContains` in two ways,
7050
+ * depending on the form of the annotation result of an adjacent
7051
+ * `contains` keyword. The first way is if the annotation result is an
7052
+ * array and the length of that array is less than or equal to the
7053
+ * `maxContains` value. The second way is if the annotation result is a
7054
+ * boolean `true` and the instance array length is less than or equal to
7055
+ * the `maxContains` value.
6600
7056
  */
6601
7057
  maxContains?: number;
6602
- /**
6603
- * The value of `maximum` MUST be a number, representing an inclusive
6604
- * upper limit for a numeric instance.
6605
- *
6606
- * If the instance is a number, then this keyword validates only if the
6607
- * instance is less than or exactly equal to `maximum`.
7058
+ /**
7059
+ * The value of `maximum` MUST be a number, representing an inclusive
7060
+ * upper limit for a numeric instance.
7061
+ *
7062
+ * If the instance is a number, then this keyword validates only if the
7063
+ * instance is less than or exactly equal to `maximum`.
6608
7064
  */
6609
7065
  maximum?: number;
6610
- /**
6611
- * The value of this keyword MUST be a non-negative integer.
6612
- *
6613
- * An array instance is valid against `maxItems` if its size is less
6614
- * than, or equal to, the value of this keyword.
6615
- *
6616
- * @minimum 0
7066
+ /**
7067
+ * The value of this keyword MUST be a non-negative integer.
7068
+ *
7069
+ * An array instance is valid against `maxItems` if its size is less
7070
+ * than, or equal to, the value of this keyword.
7071
+ *
7072
+ * @minimum 0
6617
7073
  */
6618
7074
  maxItems?: number;
6619
- /**
6620
- * The value of this keyword MUST be a non-negative integer.
6621
- *
6622
- * A string instance is valid against this keyword if its length is less
6623
- * than, or equal to, the value of this keyword.
6624
- *
6625
- * The length of a string instance is defined as the number of its
6626
- * characters as defined by [RFC 8259][RFC8259].
6627
- *
6628
- * [RFC8259]: https://datatracker.ietf.org/doc/html/rfc8259
6629
- *
6630
- * @minimum 0
7075
+ /**
7076
+ * The value of this keyword MUST be a non-negative integer.
7077
+ *
7078
+ * A string instance is valid against this keyword if its length is less
7079
+ * than, or equal to, the value of this keyword.
7080
+ *
7081
+ * The length of a string instance is defined as the number of its
7082
+ * characters as defined by [RFC 8259][RFC8259].
7083
+ *
7084
+ * [RFC8259]: https://datatracker.ietf.org/doc/html/rfc8259
7085
+ *
7086
+ * @minimum 0
6631
7087
  */
6632
7088
  maxLength?: number;
6633
- /**
6634
- * The value of this keyword MUST be a non-negative integer.
6635
- *
6636
- * An object instance is valid against `maxProperties` if its number of
6637
- * `properties` is less than, or equal to, the value of this keyword.
6638
- *
6639
- * @minimum 0
7089
+ /**
7090
+ * The value of this keyword MUST be a non-negative integer.
7091
+ *
7092
+ * An object instance is valid against `maxProperties` if its number of
7093
+ * `properties` is less than, or equal to, the value of this keyword.
7094
+ *
7095
+ * @minimum 0
6640
7096
  */
6641
7097
  maxProperties?: number;
6642
- /**
6643
- * The value of this keyword MUST be a non-negative integer.
6644
- *
6645
- * If `contains` is not present within the same schema object, then this
6646
- * keyword has no effect.
6647
- *
6648
- * An instance array is valid against `minContains` in two ways,
6649
- * depending on the form of the annotation result of an adjacent
6650
- * `contains` keyword. The first way is if the annotation result is an
6651
- * array and the length of that array is greater than or equal to the
6652
- * `minContains` value. The second way is if the annotation result is a
6653
- * boolean `true` and the instance array length is greater than or equal
6654
- * to the `minContains` value.
6655
- *
6656
- * A value of `0` is allowed, but is only useful for setting a range
6657
- * of occurrences from `0` to the value of `maxContains`. A value of
6658
- * `0` with no `maxContains` causes `contains` to always pass
6659
- * validation.
6660
- *
6661
- * Omitting this keyword has the same behavior as a value of `1`.
6662
- *
6663
- * @default 1
7098
+ /**
7099
+ * The value of this keyword MUST be a non-negative integer.
7100
+ *
7101
+ * If `contains` is not present within the same schema object, then this
7102
+ * keyword has no effect.
7103
+ *
7104
+ * An instance array is valid against `minContains` in two ways,
7105
+ * depending on the form of the annotation result of an adjacent
7106
+ * `contains` keyword. The first way is if the annotation result is an
7107
+ * array and the length of that array is greater than or equal to the
7108
+ * `minContains` value. The second way is if the annotation result is a
7109
+ * boolean `true` and the instance array length is greater than or equal
7110
+ * to the `minContains` value.
7111
+ *
7112
+ * A value of `0` is allowed, but is only useful for setting a range
7113
+ * of occurrences from `0` to the value of `maxContains`. A value of
7114
+ * `0` with no `maxContains` causes `contains` to always pass
7115
+ * validation.
7116
+ *
7117
+ * Omitting this keyword has the same behavior as a value of `1`.
7118
+ *
7119
+ * @default 1
6664
7120
  */
6665
7121
  minContains?: number;
6666
- /**
6667
- * The value of `minimum` MUST be a number, representing an inclusive
6668
- * lower limit for a numeric instance.
6669
- *
6670
- * If the instance is a number, then this keyword validates only if the
6671
- * instance is greater than or exactly equal to `minimum`.
7122
+ /**
7123
+ * The value of `minimum` MUST be a number, representing an inclusive
7124
+ * lower limit for a numeric instance.
7125
+ *
7126
+ * If the instance is a number, then this keyword validates only if the
7127
+ * instance is greater than or exactly equal to `minimum`.
6672
7128
  */
6673
7129
  minimum?: number;
6674
- /**
6675
- * The value of this keyword MUST be a non-negative integer.
6676
- *
6677
- * An array instance is valid against `minItems` if its size is greater
6678
- * than, or equal to, the value of this keyword.
6679
- *
6680
- * Omitting this keyword has the same behavior as a value of `0`.
6681
- *
6682
- * @default 0
6683
- * @minimum 0
7130
+ /**
7131
+ * The value of this keyword MUST be a non-negative integer.
7132
+ *
7133
+ * An array instance is valid against `minItems` if its size is greater
7134
+ * than, or equal to, the value of this keyword.
7135
+ *
7136
+ * Omitting this keyword has the same behavior as a value of `0`.
7137
+ *
7138
+ * @default 0
7139
+ * @minimum 0
6684
7140
  */
6685
7141
  minItems?: number;
6686
- /**
6687
- * The value of this keyword MUST be a non-negative integer.
6688
- *
6689
- * A string instance is valid against this keyword if its length is greater
6690
- * than, or equal to, the value of this keyword.
6691
- *
6692
- * The length of a string instance is defined as the number of its
6693
- * characters as defined by [RFC 8259][RFC8259].
6694
- *
6695
- * Omitting this keyword has the same behavior as a value of `0`.
6696
- *
6697
- * [RFC8259]: https://datatracker.ietf.org/doc/html/rfc8259
6698
- *
6699
- * @default 0
6700
- * @minimum 0
7142
+ /**
7143
+ * The value of this keyword MUST be a non-negative integer.
7144
+ *
7145
+ * A string instance is valid against this keyword if its length is greater
7146
+ * than, or equal to, the value of this keyword.
7147
+ *
7148
+ * The length of a string instance is defined as the number of its
7149
+ * characters as defined by [RFC 8259][RFC8259].
7150
+ *
7151
+ * Omitting this keyword has the same behavior as a value of `0`.
7152
+ *
7153
+ * [RFC8259]: https://datatracker.ietf.org/doc/html/rfc8259
7154
+ *
7155
+ * @default 0
7156
+ * @minimum 0
6701
7157
  */
6702
7158
  minLength?: number;
6703
- /**
6704
- * The value of this keyword MUST be a non-negative integer.
6705
- *
6706
- * An object instance is valid against `minProperties` if its number of
6707
- * `properties` is greater than, or equal to, the value of this keyword.
6708
- *
6709
- * Omitting this keyword has the same behavior as a value of `0`.
6710
- *
6711
- * @default 0
6712
- * @minimum 0
7159
+ /**
7160
+ * The value of this keyword MUST be a non-negative integer.
7161
+ *
7162
+ * An object instance is valid against `minProperties` if its number of
7163
+ * `properties` is greater than, or equal to, the value of this keyword.
7164
+ *
7165
+ * Omitting this keyword has the same behavior as a value of `0`.
7166
+ *
7167
+ * @default 0
7168
+ * @minimum 0
6713
7169
  */
6714
7170
  minProperties?: number;
6715
- /**
6716
- * The value of `multipleOf` MUST be a number, strictly greater than
6717
- * `0`.
6718
- *
6719
- * A numeric instance is valid only if division by this keyword's value
6720
- * results in an integer.
6721
- *
6722
- * @exclusiveMinimum 0
7171
+ /**
7172
+ * The value of `multipleOf` MUST be a number, strictly greater than
7173
+ * `0`.
7174
+ *
7175
+ * A numeric instance is valid only if division by this keyword's value
7176
+ * results in an integer.
7177
+ *
7178
+ * @exclusiveMinimum 0
6723
7179
  */
6724
7180
  multipleOf?: number;
6725
- /**
6726
- * This keyword's value MUST be a valid JSON Schema.
6727
- *
6728
- * An instance is valid against this keyword if it fails to validate
6729
- * successfully against the schema defined by this keyword.
7181
+ /**
7182
+ * This keyword's value MUST be a valid JSON Schema.
7183
+ *
7184
+ * An instance is valid against this keyword if it fails to validate
7185
+ * successfully against the schema defined by this keyword.
6730
7186
  */
6731
7187
  not?: JSONSchema<Value, SchemaType>;
6732
- /**
6733
- * This keyword's value MUST be a non-empty array. Each item of the array
6734
- * MUST be a valid JSON Schema.
6735
- *
6736
- * An instance validates successfully against this keyword if it validates
6737
- * successfully against exactly one schema defined by this keyword's value.
7188
+ /**
7189
+ * This keyword's value MUST be a non-empty array. Each item of the array
7190
+ * MUST be a valid JSON Schema.
7191
+ *
7192
+ * An instance validates successfully against this keyword if it validates
7193
+ * successfully against exactly one schema defined by this keyword's value.
6738
7194
  */
6739
7195
  oneOf?: MaybeReadonlyArray<JSONSchema<Value, SchemaType>>;
6740
- /**
6741
- * The value of this keyword MUST be a string. This string SHOULD be a
6742
- * valid regular expression, according to the [ECMA-262][ecma262] regular
6743
- * expression dialect.
6744
- *
6745
- * A string instance is considered valid if the regular expression matches
6746
- * the instance successfully. Recall: regular expressions are not
6747
- * implicitly anchored.
6748
- *
6749
- * [ecma262]: https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
6750
- *
6751
- * @format "regex"
7196
+ /**
7197
+ * The value of this keyword MUST be a string. This string SHOULD be a
7198
+ * valid regular expression, according to the [ECMA-262][ecma262] regular
7199
+ * expression dialect.
7200
+ *
7201
+ * A string instance is considered valid if the regular expression matches
7202
+ * the instance successfully. Recall: regular expressions are not
7203
+ * implicitly anchored.
7204
+ *
7205
+ * [ecma262]: https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
7206
+ *
7207
+ * @format "regex"
6752
7208
  */
6753
7209
  pattern?: string;
6754
- /**
6755
- * The value of `patternProperties` MUST be an object. Each property name
6756
- * of this object SHOULD be a valid regular expression, according to the
6757
- * [ECMA-262][ecma262] regular expression dialect. Each property value of
6758
- * this object MUST be a valid JSON Schema.
6759
- *
6760
- * Validation succeeds if, for each instance name that matches any regular
6761
- * expressions that appear as a property name in this keyword's value,
6762
- * the child instance for that name successfully validates against each
6763
- * schema that corresponds to a matching regular expression.
6764
- *
6765
- * The annotation result of this keyword is the set of instance property
6766
- * names matched by this keyword. Omitting this keyword has the same
6767
- * assertion behavior as an empty object.
6768
- *
6769
- * [ecma262]: https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
7210
+ /**
7211
+ * The value of `patternProperties` MUST be an object. Each property name
7212
+ * of this object SHOULD be a valid regular expression, according to the
7213
+ * [ECMA-262][ecma262] regular expression dialect. Each property value of
7214
+ * this object MUST be a valid JSON Schema.
7215
+ *
7216
+ * Validation succeeds if, for each instance name that matches any regular
7217
+ * expressions that appear as a property name in this keyword's value,
7218
+ * the child instance for that name successfully validates against each
7219
+ * schema that corresponds to a matching regular expression.
7220
+ *
7221
+ * The annotation result of this keyword is the set of instance property
7222
+ * names matched by this keyword. Omitting this keyword has the same
7223
+ * assertion behavior as an empty object.
7224
+ *
7225
+ * [ecma262]: https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
6770
7226
  */
6771
7227
  patternProperties?: Record<string, JSONSchema>;
6772
- /**
6773
- * The value of `prefixItems` MUST be a non-empty array of valid JSON
6774
- * Schemas.
6775
- *
6776
- * Validation succeeds if each element of the instance validates against
6777
- * the schema at the same position, if any. This keyword does not
6778
- * constrain the length of the array. If the array is longer than this
6779
- * keyword's value, this keyword validates only the prefix of matching
6780
- * length.
6781
- *
6782
- * This keyword produces an annotation value which is the largest index to
6783
- * which this keyword applied a subschema. The value MAY be a boolean
6784
- * `true` if a subschema was applied to every index of the instance, such
6785
- * as is produced by the `items` keyword.
6786
- * This annotation affects the behavior of `items` and
6787
- * `unevaluatedItems`.
6788
- *
6789
- * Omitting this keyword has the same assertion behavior as an empty array.
7228
+ /**
7229
+ * The value of `prefixItems` MUST be a non-empty array of valid JSON
7230
+ * Schemas.
7231
+ *
7232
+ * Validation succeeds if each element of the instance validates against
7233
+ * the schema at the same position, if any. This keyword does not
7234
+ * constrain the length of the array. If the array is longer than this
7235
+ * keyword's value, this keyword validates only the prefix of matching
7236
+ * length.
7237
+ *
7238
+ * This keyword produces an annotation value which is the largest index to
7239
+ * which this keyword applied a subschema. The value MAY be a boolean
7240
+ * `true` if a subschema was applied to every index of the instance, such
7241
+ * as is produced by the `items` keyword.
7242
+ * This annotation affects the behavior of `items` and
7243
+ * `unevaluatedItems`.
7244
+ *
7245
+ * Omitting this keyword has the same assertion behavior as an empty array.
6790
7246
  */
6791
7247
  prefixItems?: MaybeReadonlyArray<JSONSchema> | JSONSchema;
6792
- /**
6793
- * The value of `properties` MUST be an object. Each value of this object
6794
- * MUST be a valid JSON Schema.
6795
- *
6796
- * Validation succeeds if, for each name that appears in both the instance
6797
- * and as a name within this keyword's value, the child instance for that
6798
- * name successfully validates against the corresponding schema.
6799
- *
6800
- * The annotation result of this keyword is the set of instance property
6801
- * names matched by this keyword.
6802
- *
6803
- * Omitting this keyword has the same assertion behavior as an empty
6804
- * object.
7248
+ /**
7249
+ * The value of `properties` MUST be an object. Each value of this object
7250
+ * MUST be a valid JSON Schema.
7251
+ *
7252
+ * Validation succeeds if, for each name that appears in both the instance
7253
+ * and as a name within this keyword's value, the child instance for that
7254
+ * name successfully validates against the corresponding schema.
7255
+ *
7256
+ * The annotation result of this keyword is the set of instance property
7257
+ * names matched by this keyword.
7258
+ *
7259
+ * Omitting this keyword has the same assertion behavior as an empty
7260
+ * object.
6805
7261
  */
6806
7262
  properties?: Record<string, JSONSchema>;
6807
- /**
6808
- * The value of `propertyNames` MUST be a valid JSON Schema.
6809
- *
6810
- * If the instance is an object, this keyword validates if every property
6811
- * name in the instance validates against the provided schema.
6812
- * Note the property name that the schema is testing will always be a
6813
- * string.
6814
- *
6815
- * Omitting this keyword has the same behavior as an empty schema.
7263
+ /**
7264
+ * The value of `propertyNames` MUST be a valid JSON Schema.
7265
+ *
7266
+ * If the instance is an object, this keyword validates if every property
7267
+ * name in the instance validates against the provided schema.
7268
+ * Note the property name that the schema is testing will always be a
7269
+ * string.
7270
+ *
7271
+ * Omitting this keyword has the same behavior as an empty schema.
6816
7272
  */
6817
7273
  propertyNames?: JSONSchema;
6818
- /**
6819
- * The value of this keyword MUST be a boolean. When multiple occurrences
6820
- * of this keyword are applicable to a single sub-instance, the resulting
6821
- * value MUST be `true` if any occurrence specifies a `true` value, and
6822
- * MUST be `false` otherwise.
6823
- *
6824
- * If `readOnly` has a value of boolean `true`, it indicates that the
6825
- * value of the instance is managed exclusively by the owning authority,
6826
- * and attempts by an application to modify the value of this property are
6827
- * expected to be ignored or rejected by that owning authority.
6828
- *
6829
- * An instance document that is marked as `readOnly` for the entire
6830
- * document MAY be ignored if sent to the owning authority, or MAY result
6831
- * in an error, at the authority's discretion.
6832
- *
6833
- * For example, `readOnly` would be used to mark a database-generated
6834
- * serial number as read-only.
6835
- *
6836
- * This keyword can be used to assist in user interface instance
6837
- * generation.
6838
- *
6839
- * @default false
7274
+ /**
7275
+ * The value of this keyword MUST be a boolean. When multiple occurrences
7276
+ * of this keyword are applicable to a single sub-instance, the resulting
7277
+ * value MUST be `true` if any occurrence specifies a `true` value, and
7278
+ * MUST be `false` otherwise.
7279
+ *
7280
+ * If `readOnly` has a value of boolean `true`, it indicates that the
7281
+ * value of the instance is managed exclusively by the owning authority,
7282
+ * and attempts by an application to modify the value of this property are
7283
+ * expected to be ignored or rejected by that owning authority.
7284
+ *
7285
+ * An instance document that is marked as `readOnly` for the entire
7286
+ * document MAY be ignored if sent to the owning authority, or MAY result
7287
+ * in an error, at the authority's discretion.
7288
+ *
7289
+ * For example, `readOnly` would be used to mark a database-generated
7290
+ * serial number as read-only.
7291
+ *
7292
+ * This keyword can be used to assist in user interface instance
7293
+ * generation.
7294
+ *
7295
+ * @default false
6840
7296
  */
6841
7297
  readOnly?: boolean;
6842
- /**
6843
- * The value of this keyword MUST be an array. Elements of this array, if
6844
- * any, MUST be strings, and MUST be unique.
6845
- *
6846
- * An object instance is valid against this keyword if every item in the
6847
- * array is the name of a property in the instance.
6848
- *
6849
- * Omitting this keyword has the same behavior as an empty array.
7298
+ /**
7299
+ * The value of this keyword MUST be an array. Elements of this array, if
7300
+ * any, MUST be strings, and MUST be unique.
7301
+ *
7302
+ * An object instance is valid against this keyword if every item in the
7303
+ * array is the name of a property in the instance.
7304
+ *
7305
+ * Omitting this keyword has the same behavior as an empty array.
6850
7306
  */
6851
7307
  required?: MaybeReadonlyArray<string>;
6852
- /**
6853
- * This keyword's value MUST be a valid JSON Schema.
6854
- *
6855
- * When `if` is present, and the instance successfully validates against
6856
- * its subschema, then validation succeeds against this keyword if the
6857
- * instance also successfully validates against this keyword's subschema.
6858
- *
6859
- * This keyword has no effect when `if` is absent, or when the instance
6860
- * fails to validate against its subschema. Implementations MUST NOT
6861
- * evaluate the instance against this keyword, for either validation or
6862
- * annotation collection purposes, in such cases.
7308
+ /**
7309
+ * This keyword's value MUST be a valid JSON Schema.
7310
+ *
7311
+ * When `if` is present, and the instance successfully validates against
7312
+ * its subschema, then validation succeeds against this keyword if the
7313
+ * instance also successfully validates against this keyword's subschema.
7314
+ *
7315
+ * This keyword has no effect when `if` is absent, or when the instance
7316
+ * fails to validate against its subschema. Implementations MUST NOT
7317
+ * evaluate the instance against this keyword, for either validation or
7318
+ * annotation collection purposes, in such cases.
6863
7319
  */
6864
7320
  then?: JSONSchema<Value, SchemaType>;
6865
- /**
6866
- * Can be used to decorate a user interface with a short label about the
6867
- * data produced.
7321
+ /**
7322
+ * Can be used to decorate a user interface with a short label about the
7323
+ * data produced.
6868
7324
  */
6869
7325
  title?: string;
6870
- /**
6871
- * The value of this keyword MUST be either a string or an array. If it is
6872
- * an array, elements of the array MUST be strings and MUST be unique.
6873
- *
6874
- * String values MUST be one of the six primitive types (`"null"`,
6875
- * `"boolean"`, `"object"`, `"array"`, `"number"`, or
6876
- * `"string"`), or `"integer"` which matches any number with a zero
6877
- * fractional part.
6878
- *
6879
- * An instance validates if and only if the instance is in any of the sets
6880
- * listed for this keyword.
7326
+ /**
7327
+ * The value of this keyword MUST be either a string or an array. If it is
7328
+ * an array, elements of the array MUST be strings and MUST be unique.
7329
+ *
7330
+ * String values MUST be one of the six primitive types (`"null"`,
7331
+ * `"boolean"`, `"object"`, `"array"`, `"number"`, or
7332
+ * `"string"`), or `"integer"` which matches any number with a zero
7333
+ * fractional part.
7334
+ *
7335
+ * An instance validates if and only if the instance is in any of the sets
7336
+ * listed for this keyword.
6881
7337
  */
6882
7338
  type?: SchemaType;
6883
- /**
6884
- * The value of `unevaluatedItems` MUST be a valid JSON Schema.
6885
- *
6886
- * The behavior of this keyword depends on the annotation results of
6887
- * adjacent keywords that apply to the instance location being validated.
6888
- * Specifically, the annotations from `prefixItems`, `items`, and
6889
- * `contains`, which can come from those keywords when they are adjacent
6890
- * to the `unevaluatedItems` keyword. Those three annotations, as well as
6891
- * `unevaluatedItems`, can also result from any and all adjacent
6892
- * [in-place applicator][in-place-applicator] keywords.
6893
- *
6894
- * If no relevant annotations are present, the `unevaluatedItems`
6895
- * subschema MUST be applied to all locations in the array.
6896
- * If a boolean `true` value is present from any of the relevant
6897
- * annotations, `unevaluatedItems` MUST be ignored. Otherwise, the
6898
- * subschema MUST be applied to any index greater than the largest
6899
- * annotation value for `prefixItems`, which does not appear in any
6900
- * annotation value for `contains`.
6901
- *
6902
- * This means that `prefixItems`, `items`, `contains`, and all
6903
- * in-place applicators MUST be evaluated before this keyword can be
6904
- * evaluated. Authors of extension keywords MUST NOT define an in-place
6905
- * applicator that would need to be evaluated after this keyword.
6906
- *
6907
- * If the `unevaluatedItems` subschema is applied to any positions within
6908
- * the instance array, it produces an annotation result of boolean
6909
- * `true`, analogous to the behavior of `items`.
6910
- *
6911
- * Omitting this keyword has the same assertion behavior as an empty
6912
- * schema.
6913
- *
6914
- * [in-place-applicator]: https://json-schema.org/draft/2020-12/json-schema-core.html#in-place
7339
+ /**
7340
+ * The value of `unevaluatedItems` MUST be a valid JSON Schema.
7341
+ *
7342
+ * The behavior of this keyword depends on the annotation results of
7343
+ * adjacent keywords that apply to the instance location being validated.
7344
+ * Specifically, the annotations from `prefixItems`, `items`, and
7345
+ * `contains`, which can come from those keywords when they are adjacent
7346
+ * to the `unevaluatedItems` keyword. Those three annotations, as well as
7347
+ * `unevaluatedItems`, can also result from any and all adjacent
7348
+ * [in-place applicator][in-place-applicator] keywords.
7349
+ *
7350
+ * If no relevant annotations are present, the `unevaluatedItems`
7351
+ * subschema MUST be applied to all locations in the array.
7352
+ * If a boolean `true` value is present from any of the relevant
7353
+ * annotations, `unevaluatedItems` MUST be ignored. Otherwise, the
7354
+ * subschema MUST be applied to any index greater than the largest
7355
+ * annotation value for `prefixItems`, which does not appear in any
7356
+ * annotation value for `contains`.
7357
+ *
7358
+ * This means that `prefixItems`, `items`, `contains`, and all
7359
+ * in-place applicators MUST be evaluated before this keyword can be
7360
+ * evaluated. Authors of extension keywords MUST NOT define an in-place
7361
+ * applicator that would need to be evaluated after this keyword.
7362
+ *
7363
+ * If the `unevaluatedItems` subschema is applied to any positions within
7364
+ * the instance array, it produces an annotation result of boolean
7365
+ * `true`, analogous to the behavior of `items`.
7366
+ *
7367
+ * Omitting this keyword has the same assertion behavior as an empty
7368
+ * schema.
7369
+ *
7370
+ * [in-place-applicator]: https://json-schema.org/draft/2020-12/json-schema-core.html#in-place
6915
7371
  */
6916
7372
  unevaluatedItems?: JSONSchema;
6917
- /**
6918
- * The value of `unevaluatedProperties` MUST be a valid JSON Schema.
6919
- *
6920
- * The behavior of this keyword depends on the annotation results of
6921
- * adjacent keywords that apply to the instance location being validated.
6922
- * Specifically, the annotations from `properties`,
6923
- * `patternProperties`, and `additionalProperties`, which can come from
6924
- * those keywords when they are adjacent to the `unevaluatedProperties`
6925
- * keyword. Those three annotations, as well as `unevaluatedProperties`,
6926
- * can also result from any and all adjacent
6927
- * [in-place applicator][in-place-applicator] keywords.
6928
- *
6929
- * Validation with `unevaluatedProperties` applies only to the child
6930
- * values of instance names that do not appear in the `properties`,
6931
- * `patternProperties`, `additionalProperties`, or
6932
- * `unevaluatedProperties` annotation results that apply to the
6933
- * instance location being validated.
6934
- *
6935
- * For all such properties, validation succeeds if the child instance
6936
- * validates against the "unevaluatedProperties" schema.
6937
- *
6938
- * This means that `properties`, `patternProperties`,
6939
- * `additionalProperties`, and all in-place applicators MUST be evaluated
6940
- * before this keyword can be evaluated. Authors of extension keywords
6941
- * MUST NOT define an in-place applicator that would need to be evaluated
6942
- * after this keyword.
6943
- *
6944
- * The annotation result of this keyword is the set of instance property
6945
- * names validated by this keyword's subschema.
6946
- *
6947
- * Omitting this keyword has the same assertion behavior as an empty
6948
- * schema.
6949
- *
6950
- * [in-place-applicator]: https://json-schema.org/draft/2020-12/json-schema-core.html#in-place
7373
+ /**
7374
+ * The value of `unevaluatedProperties` MUST be a valid JSON Schema.
7375
+ *
7376
+ * The behavior of this keyword depends on the annotation results of
7377
+ * adjacent keywords that apply to the instance location being validated.
7378
+ * Specifically, the annotations from `properties`,
7379
+ * `patternProperties`, and `additionalProperties`, which can come from
7380
+ * those keywords when they are adjacent to the `unevaluatedProperties`
7381
+ * keyword. Those three annotations, as well as `unevaluatedProperties`,
7382
+ * can also result from any and all adjacent
7383
+ * [in-place applicator][in-place-applicator] keywords.
7384
+ *
7385
+ * Validation with `unevaluatedProperties` applies only to the child
7386
+ * values of instance names that do not appear in the `properties`,
7387
+ * `patternProperties`, `additionalProperties`, or
7388
+ * `unevaluatedProperties` annotation results that apply to the
7389
+ * instance location being validated.
7390
+ *
7391
+ * For all such properties, validation succeeds if the child instance
7392
+ * validates against the "unevaluatedProperties" schema.
7393
+ *
7394
+ * This means that `properties`, `patternProperties`,
7395
+ * `additionalProperties`, and all in-place applicators MUST be evaluated
7396
+ * before this keyword can be evaluated. Authors of extension keywords
7397
+ * MUST NOT define an in-place applicator that would need to be evaluated
7398
+ * after this keyword.
7399
+ *
7400
+ * The annotation result of this keyword is the set of instance property
7401
+ * names validated by this keyword's subschema.
7402
+ *
7403
+ * Omitting this keyword has the same assertion behavior as an empty
7404
+ * schema.
7405
+ *
7406
+ * [in-place-applicator]: https://json-schema.org/draft/2020-12/json-schema-core.html#in-place
6951
7407
  */
6952
7408
  unevaluatedProperties?: JSONSchema;
6953
- /**
6954
- * The value of this keyword MUST be a boolean.
6955
- *
6956
- * If this keyword has boolean value `false`, the instance validates
6957
- * successfully. If it has boolean value `true`, the instance validates
6958
- * successfully if all of its elements are unique.
6959
- *
6960
- * Omitting this keyword has the same behavior as a value of `false`.
6961
- *
6962
- * @default false
7409
+ /**
7410
+ * The value of this keyword MUST be a boolean.
7411
+ *
7412
+ * If this keyword has boolean value `false`, the instance validates
7413
+ * successfully. If it has boolean value `true`, the instance validates
7414
+ * successfully if all of its elements are unique.
7415
+ *
7416
+ * Omitting this keyword has the same behavior as a value of `false`.
7417
+ *
7418
+ * @default false
6963
7419
  */
6964
7420
  uniqueItems?: boolean;
6965
- /**
6966
- * The value of this keyword MUST be a boolean. When multiple occurrences
6967
- * of this keyword is applicable to a single sub-instance, the resulting
6968
- * value MUST be `true` if any occurrence specifies a `true` value, and
6969
- * MUST be `false` otherwise.
6970
- *
6971
- * If `writeOnly` has a value of boolean `true`, it indicates that the
6972
- * value is never present when the instance is retrieved from the owning
6973
- * authority. It can be present when sent to the owning authority to update
6974
- * or create the document (or the resource it represents), but it will not
6975
- * be included in any updated or newly created version of the instance.
6976
- *
6977
- * An instance document that is marked as `writeOnly` for the entire
6978
- * document MAY be returned as a blank document of some sort, or MAY
6979
- * produce an error upon retrieval, or have the retrieval request ignored,
6980
- * at the authority's discretion.
6981
- *
6982
- * For example, `writeOnly` would be used to mark a password input field.
6983
- *
6984
- * These keywords can be used to assist in user interface instance
6985
- * generation. In particular, an application MAY choose to use a widget
6986
- * that hides input values as they are typed for write-only fields.
6987
- *
6988
- * @default false
7421
+ /**
7422
+ * The value of this keyword MUST be a boolean. When multiple occurrences
7423
+ * of this keyword is applicable to a single sub-instance, the resulting
7424
+ * value MUST be `true` if any occurrence specifies a `true` value, and
7425
+ * MUST be `false` otherwise.
7426
+ *
7427
+ * If `writeOnly` has a value of boolean `true`, it indicates that the
7428
+ * value is never present when the instance is retrieved from the owning
7429
+ * authority. It can be present when sent to the owning authority to update
7430
+ * or create the document (or the resource it represents), but it will not
7431
+ * be included in any updated or newly created version of the instance.
7432
+ *
7433
+ * An instance document that is marked as `writeOnly` for the entire
7434
+ * document MAY be returned as a blank document of some sort, or MAY
7435
+ * produce an error upon retrieval, or have the retrieval request ignored,
7436
+ * at the authority's discretion.
7437
+ *
7438
+ * For example, `writeOnly` would be used to mark a password input field.
7439
+ *
7440
+ * These keywords can be used to assist in user interface instance
7441
+ * generation. In particular, an application MAY choose to use a widget
7442
+ * that hides input values as they are typed for write-only fields.
7443
+ *
7444
+ * @default false
6989
7445
  */
6990
7446
  writeOnly?: boolean;
6991
7447
  };
6992
7448
  declare namespace JSONSchema {
6993
7449
  type TypeValue = ValueOf<TypeName> | TypeName | Array<ValueOf<TypeName> | TypeName> | ReadonlyArray<ValueOf<TypeName> | TypeName>;
6994
- /**
6995
- * JSON Schema interface
7450
+ /**
7451
+ * JSON Schema interface
6996
7452
  */
6997
7453
  type Interface<Value = any, SchemaType extends TypeValue = TypeValue> = Exclude<JSONSchema<Value, SchemaType>, boolean>;
6998
7454
  type Array<T = any> = Pick<Interface<T, "array">, KeywordByType.Any | KeywordByType.Array>;
@@ -7010,45 +7466,45 @@ declare namespace KeywordByType {
7010
7466
  type Object = "additionalProperties" | "dependencies" | "dependentRequired" | "dependentSchemas" | "maxProperties" | "minProperties" | "patternProperties" | "properties" | "propertyNames" | "required" | "unevaluatedProperties";
7011
7467
  type String = "contentEncoding" | "contentMediaType" | "contentSchema" | "maxLength" | "minLength" | "pattern";
7012
7468
  }
7013
- /**
7014
- * Enum consisting of simple type names for the `type` keyword
7469
+ /**
7470
+ * Enum consisting of simple type names for the `type` keyword
7015
7471
  */
7016
7472
  declare enum TypeName {
7017
- /**
7018
- * Value MUST be an array.
7473
+ /**
7474
+ * Value MUST be an array.
7019
7475
  */
7020
7476
  Array = "array",
7021
- /**
7022
- * Value MUST be a boolean.
7477
+ /**
7478
+ * Value MUST be a boolean.
7023
7479
  */
7024
7480
  Boolean = "boolean",
7025
- /**
7026
- * Value MUST be an integer, no floating point numbers are allowed. This is a
7027
- * subset of the number type.
7481
+ /**
7482
+ * Value MUST be an integer, no floating point numbers are allowed. This is a
7483
+ * subset of the number type.
7028
7484
  */
7029
7485
  Integer = "integer",
7030
- /**
7031
- * Value MUST be null. Note this is mainly for purpose of being able use union
7032
- * types to define nullability. If this type is not included in a union, null
7033
- * values are not allowed (the primitives listed above do not allow nulls on
7034
- * their own).
7486
+ /**
7487
+ * Value MUST be null. Note this is mainly for purpose of being able use union
7488
+ * types to define nullability. If this type is not included in a union, null
7489
+ * values are not allowed (the primitives listed above do not allow nulls on
7490
+ * their own).
7035
7491
  */
7036
7492
  Null = "null",
7037
- /**
7038
- * Value MUST be a number, floating point numbers are allowed.
7493
+ /**
7494
+ * Value MUST be a number, floating point numbers are allowed.
7039
7495
  */
7040
7496
  Number = "number",
7041
- /**
7042
- * Value MUST be an object.
7497
+ /**
7498
+ * Value MUST be an object.
7043
7499
  */
7044
7500
  Object = "object",
7045
- /**
7046
- * Value MUST be a string.
7501
+ /**
7502
+ * Value MUST be a string.
7047
7503
  */
7048
7504
  String = "string"
7049
7505
  }
7050
7506
  //#endregion
7051
- //#region ../../node_modules/.pnpm/@orpc+openapi@1.15.0_@opentelemetry+api@1.9.1_ws@8.21.3/node_modules/@orpc/openapi/dist/shared/openapi.BGy4N6eR.d.mts
7507
+ //#region ../../node_modules/.pnpm/@orpc+openapi@1.15.7_@opentelemetry+api@1.9.1_ws@8.22.0/node_modules/@orpc/openapi/dist/shared/openapi.BGy4N6eR.d.mts
7052
7508
  interface SchemaConverterComponent {
7053
7509
  allowedStrategies: readonly SchemaConvertOptions['strategy'][];
7054
7510
  schema: AnySchema;