@alpic-ai/api 0.0.0-dev.ge14aad6 → 0.0.0-dev.ge14fb76

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 +1362 -881
  2. package/dist/index.mjs +1636 -35
  3. package/package.json +6 -6
package/dist/index.d.mts CHANGED
@@ -23,12 +23,17 @@ declare const platformSchema: z.ZodEnum<{
23
23
  type Platform = z.infer<typeof platformSchema>;
24
24
  export declare const PLATFORM_LABELS: Record<Platform, string>;
25
25
  //#endregion
26
+ //#region ../domains/src/projects/python-runtime.d.ts
27
+ export declare function detectPythonRuntimeFromRequirement(requiresPython: string): "python3.13" | "python3.14" | "python3.15" | "node22" | "node24" | "node26" | null | undefined;
28
+ //#endregion
26
29
  //#region ../domains/src/projects/schemas.d.ts
27
30
  export declare const runtimeSchema: z.ZodEnum<{
28
31
  "python3.13": "python3.13";
29
32
  "python3.14": "python3.14";
33
+ "python3.15": "python3.15";
30
34
  node22: "node22";
31
35
  node24: "node24";
36
+ node26: "node26";
32
37
  }>;
33
38
  export declare const transportSchema: z.ZodEnum<{
34
39
  stdio: "stdio";
@@ -291,6 +296,9 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
291
296
  openWorldJustification: z.ZodString;
292
297
  destructiveJustification: z.ZodString;
293
298
  }, z.core.$strip>>>;
299
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
300
+ name: z.ZodString;
301
+ }, z.core.$strip>>>>;
294
302
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
295
303
  mode: z.ZodLiteral<"all">;
296
304
  }, z.core.$strip>, z.ZodObject<{
@@ -731,10 +739,10 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
731
739
  url: z.ZodString;
732
740
  }, z.core.$strip>>>;
733
741
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
734
- scenario: z.ZodOptional<z.ZodString>;
735
- userPrompt: z.ZodOptional<z.ZodString>;
736
742
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
737
743
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
744
+ scenario: z.ZodOptional<z.ZodString>;
745
+ userPrompt: z.ZodOptional<z.ZodString>;
738
746
  }, z.core.$strip>>>;
739
747
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
740
748
  scenario: z.ZodOptional<z.ZodString>;
@@ -853,6 +861,9 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
853
861
  openWorldJustification: z.ZodString;
854
862
  destructiveJustification: z.ZodString;
855
863
  }, z.core.$strip>>>;
864
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
865
+ name: z.ZodString;
866
+ }, z.core.$strip>>>>;
856
867
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
857
868
  mode: z.ZodLiteral<"all">;
858
869
  }, z.core.$strip>, z.ZodObject<{
@@ -1293,10 +1304,10 @@ declare const chatgptSubmissionSchemaInternal: z.ZodObject<{
1293
1304
  url: z.ZodString;
1294
1305
  }, z.core.$strip>>>;
1295
1306
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1296
- scenario: z.ZodOptional<z.ZodString>;
1297
- userPrompt: z.ZodOptional<z.ZodString>;
1298
1307
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1299
1308
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1309
+ scenario: z.ZodOptional<z.ZodString>;
1310
+ userPrompt: z.ZodOptional<z.ZodString>;
1300
1311
  }, z.core.$strip>>>;
1301
1312
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1302
1313
  scenario: z.ZodOptional<z.ZodString>;
@@ -1377,6 +1388,19 @@ type ClaudeSubmission = z.infer<typeof claudeSubmissionSchemaInternal>;
1377
1388
  type ChatgptSubmission = z.infer<typeof chatgptSubmissionSchemaInternal>;
1378
1389
  type Submission = ClaudeSubmission | ChatgptSubmission;
1379
1390
  //#endregion
1391
+ //#region ../domains/src/telemetry/schemas.d.ts
1392
+ export declare const TELEMETRY_SIGNALS: readonly ["logs", "metrics", "traces"];
1393
+ export declare const telemetrySignalSchema: z.ZodEnum<{
1394
+ logs: "logs";
1395
+ metrics: "metrics";
1396
+ traces: "traces";
1397
+ }>;
1398
+ export declare const OTLP_PROTOCOLS: readonly ["http/protobuf", "http/json"];
1399
+ export declare const otlpProtocolSchema: z.ZodEnum<{
1400
+ "http/protobuf": "http/protobuf";
1401
+ "http/json": "http/json";
1402
+ }>;
1403
+ //#endregion
1380
1404
  //#region src/api.contract.d.ts
1381
1405
  export type ApiContext = {
1382
1406
  request: Request & {
@@ -1531,6 +1555,9 @@ export declare const chatgptSubmissionUpdateSchema: z.ZodObject<{
1531
1555
  openWorldJustification: z.ZodString;
1532
1556
  destructiveJustification: z.ZodString;
1533
1557
  }, z.core.$strip>>>;
1558
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
1559
+ name: z.ZodString;
1560
+ }, z.core.$strip>>>>;
1534
1561
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
1535
1562
  mode: z.ZodLiteral<"all">;
1536
1563
  }, z.core.$strip>, z.ZodObject<{
@@ -1971,10 +1998,10 @@ export declare const chatgptSubmissionUpdateSchema: z.ZodObject<{
1971
1998
  url: z.ZodString;
1972
1999
  }, z.core.$strip>>>;
1973
2000
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1974
- scenario: z.ZodOptional<z.ZodString>;
1975
- userPrompt: z.ZodOptional<z.ZodString>;
1976
2001
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1977
2002
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
2003
+ scenario: z.ZodOptional<z.ZodString>;
2004
+ userPrompt: z.ZodOptional<z.ZodString>;
1978
2005
  }, z.core.$strip>>>;
1979
2006
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
1980
2007
  scenario: z.ZodOptional<z.ZodString>;
@@ -2666,6 +2693,206 @@ export declare const contract: {
2666
2693
  }>, Record<never, never>>;
2667
2694
  };
2668
2695
  };
2696
+ telemetryDestinations: {
2697
+ list: {
2698
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2699
+ environmentId: z.ZodString;
2700
+ }, z.core.$strip>, z.ZodArray<z.ZodObject<{
2701
+ id: z.ZodString;
2702
+ signal: z.ZodEnum<{
2703
+ logs: "logs";
2704
+ metrics: "metrics";
2705
+ traces: "traces";
2706
+ }>;
2707
+ endpoint: z.ZodString;
2708
+ protocol: z.ZodEnum<{
2709
+ "http/protobuf": "http/protobuf";
2710
+ "http/json": "http/json";
2711
+ }>;
2712
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
2713
+ id: z.ZodString;
2714
+ name: z.ZodString;
2715
+ value: z.ZodNull;
2716
+ isSecret: z.ZodLiteral<true>;
2717
+ }, z.core.$strip>, z.ZodObject<{
2718
+ id: z.ZodString;
2719
+ name: z.ZodString;
2720
+ value: z.ZodString;
2721
+ isSecret: z.ZodLiteral<false>;
2722
+ }, z.core.$strip>], "isSecret">>;
2723
+ status: z.ZodEnum<{
2724
+ active: "active";
2725
+ suspended: "suspended";
2726
+ }>;
2727
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
2728
+ credentials: "credentials";
2729
+ "wrong-path": "wrong-path";
2730
+ "wrong-protocol": "wrong-protocol";
2731
+ "invalid-payload": "invalid-payload";
2732
+ "partial-rejection": "partial-rejection";
2733
+ "blocked-target": "blocked-target";
2734
+ timeout: "timeout";
2735
+ unreachable: "unreachable";
2736
+ "receiver-error": "receiver-error";
2737
+ "unexpected-status": "unexpected-status";
2738
+ }>>;
2739
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
2740
+ }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2741
+ BAD_REQUEST: {};
2742
+ }>, {
2743
+ NOT_FOUND: {};
2744
+ }>, Record<never, never>>;
2745
+ };
2746
+ create: {
2747
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2748
+ environmentId: z.ZodString;
2749
+ signal: z.ZodEnum<{
2750
+ logs: "logs";
2751
+ metrics: "metrics";
2752
+ traces: "traces";
2753
+ }>;
2754
+ endpoint: z.ZodString;
2755
+ protocol: z.ZodDefault<z.ZodEnum<{
2756
+ "http/protobuf": "http/protobuf";
2757
+ "http/json": "http/json";
2758
+ }>>;
2759
+ isScopedToIntentionalRequestsOnly: z.ZodDefault<z.ZodBoolean>;
2760
+ headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
2761
+ name: z.ZodString;
2762
+ value: z.ZodString;
2763
+ isSecret: z.ZodBoolean;
2764
+ }, z.core.$strip>>>;
2765
+ }, z.core.$strip>, z.ZodObject<{
2766
+ id: z.ZodString;
2767
+ signal: z.ZodEnum<{
2768
+ logs: "logs";
2769
+ metrics: "metrics";
2770
+ traces: "traces";
2771
+ }>;
2772
+ endpoint: z.ZodString;
2773
+ protocol: z.ZodEnum<{
2774
+ "http/protobuf": "http/protobuf";
2775
+ "http/json": "http/json";
2776
+ }>;
2777
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
2778
+ id: z.ZodString;
2779
+ name: z.ZodString;
2780
+ value: z.ZodNull;
2781
+ isSecret: z.ZodLiteral<true>;
2782
+ }, z.core.$strip>, z.ZodObject<{
2783
+ id: z.ZodString;
2784
+ name: z.ZodString;
2785
+ value: z.ZodString;
2786
+ isSecret: z.ZodLiteral<false>;
2787
+ }, z.core.$strip>], "isSecret">>;
2788
+ status: z.ZodEnum<{
2789
+ active: "active";
2790
+ suspended: "suspended";
2791
+ }>;
2792
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
2793
+ credentials: "credentials";
2794
+ "wrong-path": "wrong-path";
2795
+ "wrong-protocol": "wrong-protocol";
2796
+ "invalid-payload": "invalid-payload";
2797
+ "partial-rejection": "partial-rejection";
2798
+ "blocked-target": "blocked-target";
2799
+ timeout: "timeout";
2800
+ unreachable: "unreachable";
2801
+ "receiver-error": "receiver-error";
2802
+ "unexpected-status": "unexpected-status";
2803
+ }>>;
2804
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
2805
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2806
+ BAD_REQUEST: {};
2807
+ }>, {
2808
+ NOT_FOUND: {};
2809
+ FORBIDDEN: {};
2810
+ OTLP_DESTINATION_UNVERIFIED: {
2811
+ status: number;
2812
+ };
2813
+ INTERNAL_SERVER_ERROR: {};
2814
+ }>, Record<never, never>>;
2815
+ };
2816
+ update: {
2817
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2818
+ environmentId: z.ZodString;
2819
+ destinationId: z.ZodString;
2820
+ endpoint: z.ZodOptional<z.ZodString>;
2821
+ protocol: z.ZodOptional<z.ZodEnum<{
2822
+ "http/protobuf": "http/protobuf";
2823
+ "http/json": "http/json";
2824
+ }>>;
2825
+ isScopedToIntentionalRequestsOnly: z.ZodOptional<z.ZodBoolean>;
2826
+ headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
2827
+ id: z.ZodOptional<z.ZodString>;
2828
+ name: z.ZodString;
2829
+ value: z.ZodOptional<z.ZodString>;
2830
+ isSecret: z.ZodBoolean;
2831
+ }, z.core.$strip>>>;
2832
+ }, z.core.$strip>, z.ZodObject<{
2833
+ id: z.ZodString;
2834
+ signal: z.ZodEnum<{
2835
+ logs: "logs";
2836
+ metrics: "metrics";
2837
+ traces: "traces";
2838
+ }>;
2839
+ endpoint: z.ZodString;
2840
+ protocol: z.ZodEnum<{
2841
+ "http/protobuf": "http/protobuf";
2842
+ "http/json": "http/json";
2843
+ }>;
2844
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
2845
+ id: z.ZodString;
2846
+ name: z.ZodString;
2847
+ value: z.ZodNull;
2848
+ isSecret: z.ZodLiteral<true>;
2849
+ }, z.core.$strip>, z.ZodObject<{
2850
+ id: z.ZodString;
2851
+ name: z.ZodString;
2852
+ value: z.ZodString;
2853
+ isSecret: z.ZodLiteral<false>;
2854
+ }, z.core.$strip>], "isSecret">>;
2855
+ status: z.ZodEnum<{
2856
+ active: "active";
2857
+ suspended: "suspended";
2858
+ }>;
2859
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
2860
+ credentials: "credentials";
2861
+ "wrong-path": "wrong-path";
2862
+ "wrong-protocol": "wrong-protocol";
2863
+ "invalid-payload": "invalid-payload";
2864
+ "partial-rejection": "partial-rejection";
2865
+ "blocked-target": "blocked-target";
2866
+ timeout: "timeout";
2867
+ unreachable: "unreachable";
2868
+ "receiver-error": "receiver-error";
2869
+ "unexpected-status": "unexpected-status";
2870
+ }>>;
2871
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
2872
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2873
+ BAD_REQUEST: {};
2874
+ }>, {
2875
+ NOT_FOUND: {};
2876
+ FORBIDDEN: {};
2877
+ OTLP_DESTINATION_UNVERIFIED: {
2878
+ status: number;
2879
+ };
2880
+ }>, Record<never, never>>;
2881
+ };
2882
+ delete: {
2883
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
2884
+ environmentId: z.ZodString;
2885
+ destinationId: z.ZodString;
2886
+ }, z.core.$strip>, z.ZodObject<{
2887
+ success: z.ZodLiteral<true>;
2888
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
2889
+ BAD_REQUEST: {};
2890
+ }>, {
2891
+ NOT_FOUND: {};
2892
+ INTERNAL_SERVER_ERROR: {};
2893
+ }>, Record<never, never>>;
2894
+ };
2895
+ };
2669
2896
  projects: {
2670
2897
  update: {
2671
2898
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -2680,8 +2907,10 @@ export declare const contract: {
2680
2907
  runtime: z.ZodEnum<{
2681
2908
  "python3.13": "python3.13";
2682
2909
  "python3.14": "python3.14";
2910
+ "python3.15": "python3.15";
2683
2911
  node22: "node22";
2684
2912
  node24: "node24";
2913
+ node26: "node26";
2685
2914
  }>;
2686
2915
  transport: z.ZodNullable<z.ZodEnum<{
2687
2916
  stdio: "stdio";
@@ -2758,8 +2987,10 @@ export declare const contract: {
2758
2987
  runtime: z.ZodEnum<{
2759
2988
  "python3.13": "python3.13";
2760
2989
  "python3.14": "python3.14";
2990
+ "python3.15": "python3.15";
2761
2991
  node22: "node22";
2762
2992
  node24: "node24";
2993
+ node26: "node26";
2763
2994
  }>;
2764
2995
  transport: z.ZodNullable<z.ZodEnum<{
2765
2996
  stdio: "stdio";
@@ -2835,8 +3066,10 @@ export declare const contract: {
2835
3066
  runtime: z.ZodEnum<{
2836
3067
  "python3.13": "python3.13";
2837
3068
  "python3.14": "python3.14";
3069
+ "python3.15": "python3.15";
2838
3070
  node22: "node22";
2839
3071
  node24: "node24";
3072
+ node26: "node26";
2840
3073
  }>;
2841
3074
  transport: z.ZodNullable<z.ZodEnum<{
2842
3075
  stdio: "stdio";
@@ -2910,8 +3143,10 @@ export declare const contract: {
2910
3143
  runtime: z.ZodEnum<{
2911
3144
  "python3.13": "python3.13";
2912
3145
  "python3.14": "python3.14";
3146
+ "python3.15": "python3.15";
2913
3147
  node22: "node22";
2914
3148
  node24: "node24";
3149
+ node26: "node26";
2915
3150
  }>;
2916
3151
  transport: z.ZodOptional<z.ZodEnum<{
2917
3152
  stdio: "stdio";
@@ -2946,8 +3181,10 @@ export declare const contract: {
2946
3181
  runtime: z.ZodEnum<{
2947
3182
  "python3.13": "python3.13";
2948
3183
  "python3.14": "python3.14";
3184
+ "python3.15": "python3.15";
2949
3185
  node22: "node22";
2950
3186
  node24: "node24";
3187
+ node26: "node26";
2951
3188
  }>;
2952
3189
  transport: z.ZodNullable<z.ZodEnum<{
2953
3190
  stdio: "stdio";
@@ -3262,6 +3499,20 @@ export declare const contract: {
3262
3499
  NOT_FOUND: {};
3263
3500
  }>, Record<never, never>>;
3264
3501
  };
3502
+ list: {
3503
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
3504
+ projectId: z.ZodString;
3505
+ environmentId: z.ZodOptional<z.ZodString>;
3506
+ platform: z.ZodOptional<z.ZodEnum<{
3507
+ chatgpt: "chatgpt";
3508
+ claudeai: "claudeai";
3509
+ }>>;
3510
+ }, 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>, {
3511
+ BAD_REQUEST: {};
3512
+ }>, {
3513
+ NOT_FOUND: {};
3514
+ }>, Record<never, never>>;
3515
+ };
3265
3516
  get: {
3266
3517
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
3267
3518
  submissionId: z.ZodString;
@@ -3397,6 +3648,9 @@ export declare const contract: {
3397
3648
  openWorldJustification: z.ZodString;
3398
3649
  destructiveJustification: z.ZodString;
3399
3650
  }, z.core.$strip>>>;
3651
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
3652
+ name: z.ZodString;
3653
+ }, z.core.$strip>>>>;
3400
3654
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
3401
3655
  mode: z.ZodLiteral<"all">;
3402
3656
  }, z.core.$strip>, z.ZodObject<{
@@ -3837,10 +4091,10 @@ export declare const contract: {
3837
4091
  url: z.ZodString;
3838
4092
  }, z.core.$strip>>>;
3839
4093
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
3840
- scenario: z.ZodOptional<z.ZodString>;
3841
- userPrompt: z.ZodOptional<z.ZodString>;
3842
4094
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
3843
4095
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
4096
+ scenario: z.ZodOptional<z.ZodString>;
4097
+ userPrompt: z.ZodOptional<z.ZodString>;
3844
4098
  }, z.core.$strip>>>;
3845
4099
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
3846
4100
  scenario: z.ZodOptional<z.ZodString>;
@@ -4527,6 +4781,206 @@ export declare const contractForDocs: {
4527
4781
  }>, Record<never, never>>;
4528
4782
  };
4529
4783
  };
4784
+ telemetryDestinations: {
4785
+ list: {
4786
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4787
+ environmentId: z.ZodString;
4788
+ }, z.core.$strip>, z.ZodArray<z.ZodObject<{
4789
+ id: z.ZodString;
4790
+ signal: z.ZodEnum<{
4791
+ logs: "logs";
4792
+ metrics: "metrics";
4793
+ traces: "traces";
4794
+ }>;
4795
+ endpoint: z.ZodString;
4796
+ protocol: z.ZodEnum<{
4797
+ "http/protobuf": "http/protobuf";
4798
+ "http/json": "http/json";
4799
+ }>;
4800
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
4801
+ id: z.ZodString;
4802
+ name: z.ZodString;
4803
+ value: z.ZodNull;
4804
+ isSecret: z.ZodLiteral<true>;
4805
+ }, z.core.$strip>, z.ZodObject<{
4806
+ id: z.ZodString;
4807
+ name: z.ZodString;
4808
+ value: z.ZodString;
4809
+ isSecret: z.ZodLiteral<false>;
4810
+ }, z.core.$strip>], "isSecret">>;
4811
+ status: z.ZodEnum<{
4812
+ active: "active";
4813
+ suspended: "suspended";
4814
+ }>;
4815
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
4816
+ credentials: "credentials";
4817
+ "wrong-path": "wrong-path";
4818
+ "wrong-protocol": "wrong-protocol";
4819
+ "invalid-payload": "invalid-payload";
4820
+ "partial-rejection": "partial-rejection";
4821
+ "blocked-target": "blocked-target";
4822
+ timeout: "timeout";
4823
+ unreachable: "unreachable";
4824
+ "receiver-error": "receiver-error";
4825
+ "unexpected-status": "unexpected-status";
4826
+ }>>;
4827
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
4828
+ }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4829
+ BAD_REQUEST: {};
4830
+ }>, {
4831
+ NOT_FOUND: {};
4832
+ }>, Record<never, never>>;
4833
+ };
4834
+ create: {
4835
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4836
+ environmentId: z.ZodString;
4837
+ signal: z.ZodEnum<{
4838
+ logs: "logs";
4839
+ metrics: "metrics";
4840
+ traces: "traces";
4841
+ }>;
4842
+ endpoint: z.ZodString;
4843
+ protocol: z.ZodDefault<z.ZodEnum<{
4844
+ "http/protobuf": "http/protobuf";
4845
+ "http/json": "http/json";
4846
+ }>>;
4847
+ isScopedToIntentionalRequestsOnly: z.ZodDefault<z.ZodBoolean>;
4848
+ headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
4849
+ name: z.ZodString;
4850
+ value: z.ZodString;
4851
+ isSecret: z.ZodBoolean;
4852
+ }, z.core.$strip>>>;
4853
+ }, z.core.$strip>, z.ZodObject<{
4854
+ id: z.ZodString;
4855
+ signal: z.ZodEnum<{
4856
+ logs: "logs";
4857
+ metrics: "metrics";
4858
+ traces: "traces";
4859
+ }>;
4860
+ endpoint: z.ZodString;
4861
+ protocol: z.ZodEnum<{
4862
+ "http/protobuf": "http/protobuf";
4863
+ "http/json": "http/json";
4864
+ }>;
4865
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
4866
+ id: z.ZodString;
4867
+ name: z.ZodString;
4868
+ value: z.ZodNull;
4869
+ isSecret: z.ZodLiteral<true>;
4870
+ }, z.core.$strip>, z.ZodObject<{
4871
+ id: z.ZodString;
4872
+ name: z.ZodString;
4873
+ value: z.ZodString;
4874
+ isSecret: z.ZodLiteral<false>;
4875
+ }, z.core.$strip>], "isSecret">>;
4876
+ status: z.ZodEnum<{
4877
+ active: "active";
4878
+ suspended: "suspended";
4879
+ }>;
4880
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
4881
+ credentials: "credentials";
4882
+ "wrong-path": "wrong-path";
4883
+ "wrong-protocol": "wrong-protocol";
4884
+ "invalid-payload": "invalid-payload";
4885
+ "partial-rejection": "partial-rejection";
4886
+ "blocked-target": "blocked-target";
4887
+ timeout: "timeout";
4888
+ unreachable: "unreachable";
4889
+ "receiver-error": "receiver-error";
4890
+ "unexpected-status": "unexpected-status";
4891
+ }>>;
4892
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
4893
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4894
+ BAD_REQUEST: {};
4895
+ }>, {
4896
+ NOT_FOUND: {};
4897
+ FORBIDDEN: {};
4898
+ OTLP_DESTINATION_UNVERIFIED: {
4899
+ status: number;
4900
+ };
4901
+ INTERNAL_SERVER_ERROR: {};
4902
+ }>, Record<never, never>>;
4903
+ };
4904
+ update: {
4905
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4906
+ environmentId: z.ZodString;
4907
+ destinationId: z.ZodString;
4908
+ endpoint: z.ZodOptional<z.ZodString>;
4909
+ protocol: z.ZodOptional<z.ZodEnum<{
4910
+ "http/protobuf": "http/protobuf";
4911
+ "http/json": "http/json";
4912
+ }>>;
4913
+ isScopedToIntentionalRequestsOnly: z.ZodOptional<z.ZodBoolean>;
4914
+ headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
4915
+ id: z.ZodOptional<z.ZodString>;
4916
+ name: z.ZodString;
4917
+ value: z.ZodOptional<z.ZodString>;
4918
+ isSecret: z.ZodBoolean;
4919
+ }, z.core.$strip>>>;
4920
+ }, z.core.$strip>, z.ZodObject<{
4921
+ id: z.ZodString;
4922
+ signal: z.ZodEnum<{
4923
+ logs: "logs";
4924
+ metrics: "metrics";
4925
+ traces: "traces";
4926
+ }>;
4927
+ endpoint: z.ZodString;
4928
+ protocol: z.ZodEnum<{
4929
+ "http/protobuf": "http/protobuf";
4930
+ "http/json": "http/json";
4931
+ }>;
4932
+ headers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
4933
+ id: z.ZodString;
4934
+ name: z.ZodString;
4935
+ value: z.ZodNull;
4936
+ isSecret: z.ZodLiteral<true>;
4937
+ }, z.core.$strip>, z.ZodObject<{
4938
+ id: z.ZodString;
4939
+ name: z.ZodString;
4940
+ value: z.ZodString;
4941
+ isSecret: z.ZodLiteral<false>;
4942
+ }, z.core.$strip>], "isSecret">>;
4943
+ status: z.ZodEnum<{
4944
+ active: "active";
4945
+ suspended: "suspended";
4946
+ }>;
4947
+ lastFailureReason: z.ZodNullable<z.ZodEnum<{
4948
+ credentials: "credentials";
4949
+ "wrong-path": "wrong-path";
4950
+ "wrong-protocol": "wrong-protocol";
4951
+ "invalid-payload": "invalid-payload";
4952
+ "partial-rejection": "partial-rejection";
4953
+ "blocked-target": "blocked-target";
4954
+ timeout: "timeout";
4955
+ unreachable: "unreachable";
4956
+ "receiver-error": "receiver-error";
4957
+ "unexpected-status": "unexpected-status";
4958
+ }>>;
4959
+ isScopedToIntentionalRequestsOnly: z.ZodBoolean;
4960
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4961
+ BAD_REQUEST: {};
4962
+ }>, {
4963
+ NOT_FOUND: {};
4964
+ FORBIDDEN: {};
4965
+ OTLP_DESTINATION_UNVERIFIED: {
4966
+ status: number;
4967
+ };
4968
+ }>, Record<never, never>>;
4969
+ };
4970
+ delete: {
4971
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
4972
+ environmentId: z.ZodString;
4973
+ destinationId: z.ZodString;
4974
+ }, z.core.$strip>, z.ZodObject<{
4975
+ success: z.ZodLiteral<true>;
4976
+ }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
4977
+ BAD_REQUEST: {};
4978
+ }>, {
4979
+ NOT_FOUND: {};
4980
+ INTERNAL_SERVER_ERROR: {};
4981
+ }>, Record<never, never>>;
4982
+ };
4983
+ };
4530
4984
  projects: {
4531
4985
  update: {
4532
4986
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -4541,8 +4995,10 @@ export declare const contractForDocs: {
4541
4995
  runtime: z.ZodEnum<{
4542
4996
  "python3.13": "python3.13";
4543
4997
  "python3.14": "python3.14";
4998
+ "python3.15": "python3.15";
4544
4999
  node22: "node22";
4545
5000
  node24: "node24";
5001
+ node26: "node26";
4546
5002
  }>;
4547
5003
  transport: z.ZodNullable<z.ZodEnum<{
4548
5004
  stdio: "stdio";
@@ -4619,8 +5075,10 @@ export declare const contractForDocs: {
4619
5075
  runtime: z.ZodEnum<{
4620
5076
  "python3.13": "python3.13";
4621
5077
  "python3.14": "python3.14";
5078
+ "python3.15": "python3.15";
4622
5079
  node22: "node22";
4623
5080
  node24: "node24";
5081
+ node26: "node26";
4624
5082
  }>;
4625
5083
  transport: z.ZodNullable<z.ZodEnum<{
4626
5084
  stdio: "stdio";
@@ -4696,8 +5154,10 @@ export declare const contractForDocs: {
4696
5154
  runtime: z.ZodEnum<{
4697
5155
  "python3.13": "python3.13";
4698
5156
  "python3.14": "python3.14";
5157
+ "python3.15": "python3.15";
4699
5158
  node22: "node22";
4700
5159
  node24: "node24";
5160
+ node26: "node26";
4701
5161
  }>;
4702
5162
  transport: z.ZodNullable<z.ZodEnum<{
4703
5163
  stdio: "stdio";
@@ -4771,8 +5231,10 @@ export declare const contractForDocs: {
4771
5231
  runtime: z.ZodEnum<{
4772
5232
  "python3.13": "python3.13";
4773
5233
  "python3.14": "python3.14";
5234
+ "python3.15": "python3.15";
4774
5235
  node22: "node22";
4775
5236
  node24: "node24";
5237
+ node26: "node26";
4776
5238
  }>;
4777
5239
  transport: z.ZodOptional<z.ZodEnum<{
4778
5240
  stdio: "stdio";
@@ -4807,8 +5269,10 @@ export declare const contractForDocs: {
4807
5269
  runtime: z.ZodEnum<{
4808
5270
  "python3.13": "python3.13";
4809
5271
  "python3.14": "python3.14";
5272
+ "python3.15": "python3.15";
4810
5273
  node22: "node22";
4811
5274
  node24: "node24";
5275
+ node26: "node26";
4812
5276
  }>;
4813
5277
  transport: z.ZodNullable<z.ZodEnum<{
4814
5278
  stdio: "stdio";
@@ -5123,6 +5587,20 @@ export declare const contractForDocs: {
5123
5587
  NOT_FOUND: {};
5124
5588
  }>, Record<never, never>>;
5125
5589
  };
5590
+ list: {
5591
+ v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
5592
+ projectId: z.ZodString;
5593
+ environmentId: z.ZodOptional<z.ZodString>;
5594
+ platform: z.ZodOptional<z.ZodEnum<{
5595
+ chatgpt: "chatgpt";
5596
+ claudeai: "claudeai";
5597
+ }>>;
5598
+ }, 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>, {
5599
+ BAD_REQUEST: {};
5600
+ }>, {
5601
+ NOT_FOUND: {};
5602
+ }>, Record<never, never>>;
5603
+ };
5126
5604
  get: {
5127
5605
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
5128
5606
  submissionId: z.ZodString;
@@ -5258,6 +5736,9 @@ export declare const contractForDocs: {
5258
5736
  openWorldJustification: z.ZodString;
5259
5737
  destructiveJustification: z.ZodString;
5260
5738
  }, z.core.$strip>>>;
5739
+ skills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
5740
+ name: z.ZodString;
5741
+ }, z.core.$strip>>>>;
5261
5742
  allowedCountries: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
5262
5743
  mode: z.ZodLiteral<"all">;
5263
5744
  }, z.core.$strip>, z.ZodObject<{
@@ -5698,10 +6179,10 @@ export declare const contractForDocs: {
5698
6179
  url: z.ZodString;
5699
6180
  }, z.core.$strip>>>;
5700
6181
  testCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
5701
- scenario: z.ZodOptional<z.ZodString>;
5702
- userPrompt: z.ZodOptional<z.ZodString>;
5703
6182
  toolTriggered: z.ZodOptional<z.ZodOptional<z.ZodString>>;
5704
6183
  expectedOutput: z.ZodOptional<z.ZodOptional<z.ZodString>>;
6184
+ scenario: z.ZodOptional<z.ZodString>;
6185
+ userPrompt: z.ZodOptional<z.ZodString>;
5705
6186
  }, z.core.$strip>>>;
5706
6187
  negativeTestCases: z.ZodOptional<z.ZodArray<z.ZodObject<{
5707
6188
  scenario: z.ZodOptional<z.ZodString>;
@@ -5799,7 +6280,7 @@ export type RouteAuthMeta = {
5799
6280
  authScope?: AuthScope;
5800
6281
  };
5801
6282
  //#endregion
5802
- //#region ../../node_modules/.pnpm/type-fest@5.6.0/node_modules/type-fest/source/promisable.d.ts
6283
+ //#region ../../node_modules/.pnpm/type-fest@5.10.0/node_modules/type-fest/source/promisable.d.ts
5803
6284
  /**
5804
6285
  Create a type that represents either the value or the value wrapped in `PromiseLike`.
5805
6286
 
@@ -5826,11 +6307,11 @@ await logger(() => Promise.resolve('bar'));
5826
6307
  */
5827
6308
  type Promisable<T> = T | PromiseLike<T>;
5828
6309
  //#endregion
5829
- //#region ../../node_modules/.pnpm/@orpc+shared@1.15.0_@opentelemetry+api@1.9.1/node_modules/@orpc/shared/dist/index.d.mts
6310
+ //#region ../../node_modules/.pnpm/@orpc+shared@1.15.7_@opentelemetry+api@1.9.1/node_modules/@orpc/shared/dist/index.d.mts
5830
6311
  type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
5831
6312
  type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
5832
6313
  //#endregion
5833
- //#region ../../node_modules/.pnpm/@orpc+client@1.15.0_@opentelemetry+api@1.9.1/node_modules/@orpc/client/dist/index.d.mts
6314
+ //#region ../../node_modules/.pnpm/@orpc+client@1.15.7_@opentelemetry+api@1.9.1/node_modules/@orpc/client/dist/index.d.mts
5834
6315
  declare const COMMON_ORPC_ERROR_DEFS: {
5835
6316
  readonly BAD_REQUEST: {
5836
6317
  readonly status: 400;
@@ -5943,7 +6424,7 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
5943
6424
  }
5944
6425
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
5945
6426
  //#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
6427
+ //#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
6428
  type Context = Record<PropertyKey, any>;
5948
6429
  type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<TData>, 'defined' | 'status'>;
5949
6430
  type ORPCErrorConstructorMapItem<TCode extends ORPCErrorCode, TInData> = (...rest: MaybeOptionalOptions<ORPCErrorConstructorMapItemOptions<TInData>>) => ORPCError<TCode, TInData>;
@@ -6014,7 +6495,7 @@ interface Middleware<TInContext extends Context, TOutContext extends Context, TI
6014
6495
  }
6015
6496
  type AnyMiddleware = Middleware<any, any, any, any, any, any>;
6016
6497
  //#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
6498
+ //#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
6499
  interface TraverseContractProcedureCallbackOptions {
6019
6500
  contract: AnyContractProcedure | AnyProcedure;
6020
6501
  path: readonly string[];
@@ -6023,976 +6504,976 @@ interface TraverseContractProcedureCallbackOptions {
6023
6504
  //#region ../../node_modules/.pnpm/json-schema-typed@8.0.2/node_modules/json-schema-typed/draft_2020_12.d.ts
6024
6505
  type MaybeReadonlyArray<T> = Array<T> | ReadonlyArray<T>;
6025
6506
  type ValueOf<T> = T[keyof T];
6026
- /**
6027
- * JSON Schema [Draft 2020-12](https://json-schema.org/draft/2020-12/json-schema-validation.html)
6507
+ /**
6508
+ * JSON Schema [Draft 2020-12](https://json-schema.org/draft/2020-12/json-schema-validation.html)
6028
6509
  */
6029
6510
  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.
6511
+ /**
6512
+ * Using JSON Pointer fragments requires knowledge of the structure of the
6513
+ * schema. When writing schema documents with the intention to provide
6514
+ * re-usable schemas, it may be preferable to use a plain name fragment
6515
+ * that is not tied to any particular structural location. This allows a
6516
+ * subschema to be relocated without requiring JSON Pointer references to
6517
+ * be updated.
6518
+ *
6519
+ * The `$anchor` keyword is used to specify such a fragment. It is an
6520
+ * identifier keyword that can only be used to create plain name fragments.
6521
+ *
6522
+ * If present, the value of this keyword MUST be a string, which MUST start
6523
+ * with a letter `[A-Za-z]`, followed by any number of letters, digits
6524
+ * `[0-9]`, hyphens `-`, underscores `_`, colons `:`,
6525
+ * or periods `.`.
6526
+ *
6527
+ * Note that the anchor string does not include the `#` character,
6528
+ * as it is not a URI-reference. An `{"$anchor": "foo"}` becomes the
6529
+ * fragment `#foo` when used in a URI.
6530
+ *
6531
+ * The base URI to which the resulting fragment is appended is determined
6532
+ * by the `$id` keyword as explained in the previous section.
6533
+ * Two `$anchor` keywords in the same schema document MAY have the same
6534
+ * value if they apply to different base URIs, as the resulting full URIs
6535
+ * will be distinct. However, the effect of two `$anchor` keywords
6536
+ * with the same value and the same base URI is undefined. Implementations
6537
+ * MAY raise an error if such usage is detected.
6057
6538
  */
6058
6539
  $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.
6540
+ /**
6541
+ * This keyword reserves a location for comments from schema authors to
6542
+ * readers or maintainers of the schema.
6543
+ *
6544
+ * The value of this keyword MUST be a string. Implementations MUST NOT
6545
+ * present this string to end users. Tools for editing schemas SHOULD
6546
+ * support displaying and editing this keyword. The value of this keyword
6547
+ * MAY be used in debug or error output which is intended for developers
6548
+ * making use of schemas.
6549
+ *
6550
+ * Schema vocabularies SHOULD allow `$comment` within any object
6551
+ * containing vocabulary keywords. Implementations MAY assume `$comment`
6552
+ * is allowed unless the vocabulary specifically forbids it. Vocabularies
6553
+ * MUST NOT specify any effect of `$comment` beyond what is described in
6554
+ * this specification.
6555
+ *
6556
+ * Tools that translate other media types or programming languages
6557
+ * to and from `application/schema+json` MAY choose to convert that media
6558
+ * type or programming language's native comments to or from `$comment`
6559
+ * values. The behavior of such translation when both native comments and
6560
+ * `$comment` properties are present is implementation-dependent.
6561
+ *
6562
+ * Implementations MAY strip `$comment` values at any point during
6563
+ * processing. In particular, this allows for shortening schemas when the
6564
+ * size of deployed schemas is a concern.
6565
+ *
6566
+ * Implementations MUST NOT take any other action based on the presence,
6567
+ * absence, or contents of `$comment` properties. In particular, the
6568
+ * value of `$comment` MUST NOT be collected as an annotation result.
6088
6569
  */
6089
6570
  $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.
6571
+ /**
6572
+ * The `$defs` keyword reserves a location for schema authors to inline
6573
+ * re-usable JSON Schemas into a more general schema. The keyword does not
6574
+ * directly affect the validation result.
6575
+ *
6576
+ * This keyword's value MUST be an object. Each member value of this object
6577
+ * MUST be a valid JSON Schema.
6097
6578
  */
6098
6579
  $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.
6580
+ /**
6581
+ * "The `$dynamicAnchor` indicates that the fragment is an extension
6582
+ * point when used with the `$dynamicRef` keyword. This low-level,
6583
+ * advanced feature makes it easier to extend recursive schemas such as the
6584
+ * meta-schemas, without imposing any particular semantics on that
6585
+ * extension. See `$dynamicRef` for more details.
6105
6586
  */
6106
6587
  $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"
6588
+ /**
6589
+ * The `$dynamicRef` keyword is an applicator that allows for deferring
6590
+ * the full resolution until runtime, at which point it is resolved each
6591
+ * time it is encountered while evaluating an instance.
6592
+ *
6593
+ * Together with `$dynamicAnchor`, `$dynamicRef` implements a
6594
+ * cooperative extension mechanism that is primarily useful with recursive
6595
+ * schemas (schemas that reference themselves). Both the extension point
6596
+ * and the runtime-determined extension target are defined with
6597
+ * `$dynamicAnchor`, and only exhibit runtime dynamic behavior when
6598
+ * referenced with `$dynamicRef`.
6599
+ *
6600
+ * The value of the `$dynamicRef` property MUST be a string which is
6601
+ * a URI-Reference. Resolved against the current URI base, it produces
6602
+ * the URI used as the starting point for runtime resolution. This initial
6603
+ * resolution is safe to perform on schema load.
6604
+ *
6605
+ * If the initially resolved starting point URI includes a fragment that
6606
+ * was created by the `$dynamicAnchor` keyword, the initial URI MUST be
6607
+ * replaced by the URI (including the fragment) for the outermost schema
6608
+ * resource in the [dynamic scope][scopes] that defines
6609
+ * an identically named fragment with `$dynamicAnchor`.
6610
+ *
6611
+ * Otherwise, its behavior is identical to `$ref`, and no runtime
6612
+ * resolution is needed.
6613
+ *
6614
+ * [scopes]: https://json-schema.org/draft/2020-12/json-schema-core.html#scopes
6615
+ *
6616
+ * @format "uri-reference"
6136
6617
  */
6137
6618
  $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"
6619
+ /**
6620
+ * The `$id` keyword identifies a schema resource with its
6621
+ * [canonical][[RFC6596]] URI.
6622
+ *
6623
+ * Note that this URI is an identifier and not necessarily a network
6624
+ * locator. In the case of a network-addressable URL, a schema need not be
6625
+ * downloadable from its canonical URI.
6626
+ *
6627
+ * If present, the value for this keyword MUST be a string, and MUST
6628
+ * represent a valid [URI-reference][RFC3986]. This URI-reference SHOULD
6629
+ * be normalized, and MUST resolve to an [absolute-URI][RFC3986] (without a
6630
+ * fragment). Therefore, `$id` MUST NOT contain a non-empty fragment,
6631
+ * and SHOULD NOT contain an empty fragment.
6632
+ *
6633
+ * Since an empty fragment in the context of the
6634
+ * `application/schema+json` media type refers to the same resource as
6635
+ * the base URI without a fragment, an implementation MAY normalize a URI
6636
+ * ending with an empty fragment by removing the fragment. However, schema
6637
+ * authors SHOULD NOT rely on this behavior across implementations.
6638
+ *
6639
+ * This URI also serves as the base URI for relative URI-references in
6640
+ * keywords within the schema resource, in accordance with
6641
+ * [RFC 3986][RFC3986] section 5.1.1 regarding base URIs embedded in
6642
+ * content.
6643
+ *
6644
+ * The presence of `$id` in a subschema indicates that the subschema
6645
+ * constitutes a distinct schema resource within a single schema document.
6646
+ * Furthermore, in accordance with [RFC 3986][RFC3986] section 5.1.2
6647
+ * regarding encapsulating entities, if an `$id` in a subschema is a
6648
+ * relative URI-reference, the base URI for resolving that reference is the
6649
+ * URI of the parent schema resource.
6650
+ *
6651
+ * If no parent schema object explicitly identifies itself as a resource
6652
+ * with `$id`, the base URI is that of the entire document.
6653
+ *
6654
+ * The root schema of a JSON Schema document SHOULD contain an `$id`
6655
+ * keyword with an [absolute-URI][RFC3986] (containing a scheme, but no
6656
+ * fragment).
6657
+ *
6658
+ * [RFC6596]: https://datatracker.ietf.org/doc/html/rfc6596
6659
+ * [RFC3986]: https://datatracker.ietf.org/doc/html/rfc3986
6660
+ *
6661
+ * @format "uri-reference"
6181
6662
  */
6182
6663
  $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"
6664
+ /**
6665
+ * The `$ref` keyword is an applicator that is used to reference a
6666
+ * statically identified schema. Its results are the results of the
6667
+ * referenced schema. Other keywords can appear alongside of `$ref` in
6668
+ * the same schema object.
6669
+ *
6670
+ * The value of the `$ref` property MUST be a string which is a
6671
+ * URI-Reference. Resolved against the current URI base, it produces the
6672
+ * URI of the schema to apply.
6673
+ *
6674
+ * @format "uri-reference"
6194
6675
  */
6195
6676
  $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"
6677
+ /**
6678
+ * The `$schema` keyword is both used as a JSON Schema dialect identifier
6679
+ * and as the identifier of a resource which is itself a JSON Schema, which
6680
+ * describes the set of valid schemas written for this particular dialect.
6681
+ *
6682
+ * The value of this keyword MUST be a [URI][RFC3986] (containing a scheme)
6683
+ * and this URI MUST be normalized. The current schema MUST be valid
6684
+ * against the meta-schema identified by this URI.
6685
+ *
6686
+ * If this URI identifies a retrievable resource, that resource SHOULD be
6687
+ * of media type `application/schema+json`.
6688
+ *
6689
+ * The `$schema` keyword SHOULD be used in the document root schema
6690
+ * object, and MAY be used in the root schema objects of embedded schema
6691
+ * resources. It MUST NOT appear in non-resource root schema objects. If
6692
+ * absent from the document root schema, the resulting behavior is
6693
+ * implementation-defined.
6694
+ *
6695
+ * Values for this property are defined elsewhere in this and other
6696
+ * documents, and by other parties.
6697
+ *
6698
+ * [RFC3986]: https://datatracker.ietf.org/doc/html/rfc3986
6699
+ *
6700
+ * @format "uri"
6220
6701
  */
6221
6702
  $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.
6703
+ /**
6704
+ * The `$vocabulary` keyword is used in meta-schemas to identify the
6705
+ * vocabularies available for use in schemas described by that meta-schema.
6706
+ * It is also used to indicate whether each vocabulary is required or
6707
+ * optional, in the sense that an implementation MUST understand the
6708
+ * required vocabularies in order to successfully process the schema.
6709
+ * Together, this information forms a dialect. Any vocabulary that is
6710
+ * understood by the implementation MUST be processed in a manner
6711
+ * consistent with the semantic definitions contained within the
6712
+ * vocabulary.
6713
+ *
6714
+ * The value of this keyword MUST be an object. The property names in the
6715
+ * object MUST be URIs (containing a scheme) and this URI MUST be
6716
+ * normalized. Each URI that appears as a property name identifies a
6717
+ * specific set of keywords and their semantics.
6718
+ *
6719
+ * The URI MAY be a URL, but the nature of the retrievable resource is
6720
+ * currently undefined, and reserved for future use. Vocabulary authors
6721
+ * MAY use the URL of the vocabulary specification, in a human-readable
6722
+ * media type such as `text/html` or `text/plain`, as the vocabulary
6723
+ * URI.
6724
+ *
6725
+ * The values of the object properties MUST be booleans. If the value is
6726
+ * `true`, then implementations that do not recognize the vocabulary MUST
6727
+ * refuse to process any schemas that declare this meta-schema with
6728
+ * `$schema`. If the value is `false`, implementations that do not
6729
+ * recognize the vocabulary SHOULD proceed with processing such schemas.
6730
+ * The value has no impact if the implementation understands the
6731
+ * vocabulary.
6732
+ *
6733
+ * Unrecognized keywords SHOULD be ignored. This remains the case for
6734
+ * keywords defined by unrecognized vocabularies. It is not currently
6735
+ * possible to distinguish between unrecognized keywords that are defined
6736
+ * in vocabularies from those that are not part of any vocabulary.
6737
+ *
6738
+ * The `$vocabulary` keyword SHOULD be used in the root schema of any
6739
+ * schema document intended for use as a meta-schema. It MUST NOT appear
6740
+ * in subschemas.
6741
+ *
6742
+ * The `$vocabulary` keyword MUST be ignored in schema documents that are
6743
+ * not being processed as a meta-schema.
6263
6744
  */
6264
6745
  $vocabulary?: Record<string, string>;
6265
- /**
6266
- * @deprecated `additionalItems` has been deprecated in favor of `prefixItems`
6267
- * paired with `items`.
6746
+ /**
6747
+ * @deprecated `additionalItems` has been deprecated in favor of `prefixItems`
6748
+ * paired with `items`.
6268
6749
  */
6269
6750
  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.
6751
+ /**
6752
+ * The value of `additionalProperties` MUST be a valid JSON Schema.
6753
+ *
6754
+ * The behavior of this keyword depends on the presence and annotation
6755
+ * results of `properties` and `patternProperties` within the same
6756
+ * schema object. Validation with `additionalProperties` applies only to
6757
+ * the child values of instance names that do not appear in the annotation
6758
+ * results of either `properties` or `patternProperties`.
6759
+ *
6760
+ * For all such properties, validation succeeds if the child instance
6761
+ * validates against the `additionalProperties` schema.
6762
+ *
6763
+ * The annotation result of this keyword is the set of instance property
6764
+ * names validated by this keyword's subschema. Annotation results for
6765
+ * `additionalProperties` keywords from multiple schemas applied to the
6766
+ * same instance location are combined by taking the union of the sets.
6767
+ *
6768
+ * Omitting this keyword has the same assertion behavior as an empty
6769
+ * schema.
6770
+ *
6771
+ * Implementations MAY choose to implement or optimize this keyword in
6772
+ * another way that produces the same effect, such as by directly checking
6773
+ * the names in `properties` and the patterns in `patternProperties`
6774
+ * against the instance property set.
6294
6775
  */
6295
6776
  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.
6777
+ /**
6778
+ * This keyword's value MUST be a non-empty array. Each item of the array
6779
+ * MUST be a valid JSON Schema.
6780
+ *
6781
+ * An instance validates successfully against this keyword if it validates
6782
+ * successfully against all schemas defined by this keyword's value.
6302
6783
  */
6303
6784
  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.
6785
+ /**
6786
+ * This keyword's value MUST be a non-empty array. Each item of the array
6787
+ * MUST be a valid JSON Schema.
6788
+ *
6789
+ * An instance validates successfully against this keyword if it validates
6790
+ * successfully against at least one schema defined by this keyword's
6791
+ * value.
6311
6792
  */
6312
6793
  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.
6794
+ /**
6795
+ * An instance validates successfully against this keyword if its value is
6796
+ * equal to the value of the keyword.
6797
+ *
6798
+ * Use of this keyword is functionally equivalent to the `enum` keyword
6799
+ * with a single value.
6319
6800
  */
6320
6801
  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.
6802
+ /**
6803
+ * The value of this keyword MUST be a valid JSON Schema.
6804
+ *
6805
+ * An array instance is valid against `contains` if at least one of its
6806
+ * elements is valid against the given schema. The subschema MUST be
6807
+ * applied to every array element even after the first match has been
6808
+ * found, in order to collect annotations for use by other keywords.
6809
+ * This is to ensure that all possible annotations are collected.
6810
+ *
6811
+ * Logically, the validation result of applying the value subschema to each
6812
+ * item in the array MUST be OR'ed with `false`, resulting in an overall
6813
+ * validation result.
6814
+ *
6815
+ * This keyword produces an annotation value which is an array of the
6816
+ * indexes to which this keyword validates successfully when applying its
6817
+ * subschema, in ascending order. The value MAY be a boolean `true` if
6818
+ * the subschema validates successfully when applied to every index of the
6819
+ * instance. The annotation MUST be present if the instance array to which
6820
+ * this keyword's schema applies is empty.
6340
6821
  */
6341
6822
  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
6823
+ /**
6824
+ * If the instance value is a string, this property defines that the
6825
+ * string SHOULD be interpreted as binary data and decoded using the
6826
+ * encoding named by this property. [RFC 2045, Sec 6.1][RFC2045] lists the
6827
+ * possible values for this property.
6828
+ *
6829
+ * The value of this property SHOULD be ignored if the instance described
6830
+ * is not a string.
6831
+ *
6832
+ * If this keyword is absent, but `contentMediaType` is present, this
6833
+ * indicates that the media type could be encoded into `UTF-8` like any
6834
+ * other JSON string value, and does not require additional decoding.
6835
+ *
6836
+ * The value of this property MUST be a string.
6837
+ *
6838
+ * [RFC2045]: https://datatracker.ietf.org/doc/html/rfc2045#section-6.1
6358
6839
  */
6359
6840
  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
6841
+ /**
6842
+ * If the instance is a string, this property indicates the media type
6843
+ * of the contents of the string. If `contentEncoding` is present,
6844
+ * this property describes the decoded string.
6845
+ *
6846
+ * The value of this property must be a media type, as defined by
6847
+ * [RFC 2046][RFC2046]. This property defines the media type of instances
6848
+ * which this schema defines.
6849
+ *
6850
+ * The value of this property SHOULD be ignored if the instance described
6851
+ * is not a string.
6852
+ *
6853
+ * If the `contentEncoding` property is not present, but the instance
6854
+ * value is a string, then the value of this property SHOULD specify a text
6855
+ * document type, and the character set SHOULD be the character set into
6856
+ * which the JSON string value was decoded (for which the default is
6857
+ * Unicode).
6858
+ *
6859
+ * [RFC2046]: https://datatracker.ietf.org/doc/html/rfc2046
6379
6860
  */
6380
6861
  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.
6862
+ /**
6863
+ * If the instance is a string, and if `contentMediaType` is present,
6864
+ * this property contains a schema which describes the structure of the
6865
+ * string.
6866
+ *
6867
+ * This keyword MAY be used with any media type that can be mapped into
6868
+ * JSON Schema's data model.
6869
+ *
6870
+ * The value of this property MUST be a valid JSON schema. It SHOULD be
6871
+ * ignored if `contentMediaType` is not present.
6391
6872
  */
6392
6873
  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.
6874
+ /**
6875
+ * This keyword can be used to supply a default JSON value associated with
6876
+ * a particular schema. It is RECOMMENDED that a `default` value be valid
6877
+ * against the associated schema.
6397
6878
  */
6398
6879
  default?: Value;
6399
- /**
6400
- * @deprecated `definitions` has been renamed to `$defs`.
6880
+ /**
6881
+ * @deprecated `definitions` has been renamed to `$defs`.
6401
6882
  */
6402
6883
  definitions?: Record<string, JSONSchema>;
6403
- /**
6404
- * @deprecated `dependencies` has been split into two keywords:
6405
- * `dependentSchemas` and `dependentRequired`.
6884
+ /**
6885
+ * @deprecated `dependencies` has been split into two keywords:
6886
+ * `dependentSchemas` and `dependentRequired`.
6406
6887
  */
6407
6888
  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.
6889
+ /**
6890
+ * The value of this keyword MUST be an object. Properties in
6891
+ * this object, if any, MUST be arrays. Elements in each array,
6892
+ * if any, MUST be strings, and MUST be unique.
6893
+ *
6894
+ * This keyword specifies properties that are required if a specific
6895
+ * other property is present. Their requirement is dependent on the
6896
+ * presence of the other property.
6897
+ *
6898
+ * Validation succeeds if, for each name that appears in both
6899
+ * the instance and as a name within this keyword's value, every
6900
+ * item in the corresponding array is also the name of a property
6901
+ * in the instance.
6902
+ *
6903
+ * Omitting this keyword has the same behavior as an empty object.
6423
6904
  */
6424
6905
  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.
6906
+ /**
6907
+ * This keyword specifies subschemas that are evaluated if the instance is
6908
+ * an object and contains a certain property.
6909
+ *
6910
+ * This keyword's value MUST be an object. Each value in the object MUST be
6911
+ * a valid JSON Schema.
6912
+ *
6913
+ * If the object key is a property in the instance, the entire instance
6914
+ * must validate against the subschema. Its use is dependent on the
6915
+ * presence of the property.
6916
+ *
6917
+ * Omitting this keyword has the same behavior as an empty object.
6437
6918
  */
6438
6919
  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`.
6920
+ /**
6921
+ * The value of this keyword MUST be a boolean. When multiple occurrences
6922
+ * of this keyword are applicable to a single sub-instance, applications
6923
+ * SHOULD consider the instance location to be deprecated if any occurrence
6924
+ * specifies a `true` value.
6925
+ *
6926
+ * If `deprecated` has a value of boolean `true`, it indicates that
6927
+ * applications SHOULD refrain from usage of the declared property. It MAY
6928
+ * mean the property is going to be removed in the future.
6929
+ *
6930
+ * A root schema containing `deprecated` with a value of `true`
6931
+ * indicates that the entire resource being described MAY be removed in the
6932
+ * future.
6933
+ *
6934
+ * The `deprecated` keyword applies to each instance location to which
6935
+ * the schema object containing the keyword successfully applies. This can
6936
+ * result in scenarios where every array item or object property is
6937
+ * deprecated even though the containing array or object is not.
6938
+ *
6939
+ * Omitting this keyword has the same behavior as a value of `false`.
6459
6940
  */
6460
6941
  deprecated?: boolean;
6461
- /**
6462
- * Can be used to decorate a user interface with explanation or information
6463
- * about the data produced.
6942
+ /**
6943
+ * Can be used to decorate a user interface with explanation or information
6944
+ * about the data produced.
6464
6945
  */
6465
6946
  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.
6947
+ /**
6948
+ * This keyword's value MUST be a valid JSON Schema.
6949
+ *
6950
+ * When `if` is present, and the instance fails to validate against its
6951
+ * subschema, then validation succeeds against this keyword if the instance
6952
+ * successfully validates against this keyword's subschema.
6953
+ *
6954
+ * This keyword has no effect when `if` is absent, or when the instance
6955
+ * successfully validates against its subschema. Implementations MUST NOT
6956
+ * evaluate the instance against this keyword, for either validation or
6957
+ * annotation collection purposes, in such cases.
6477
6958
  */
6478
6959
  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`.
6960
+ /**
6961
+ * The value of this keyword MUST be an array. This array SHOULD have at
6962
+ * least one element. Elements in the array SHOULD be unique.
6963
+ *
6964
+ * An instance validates successfully against this keyword if its value is
6965
+ * equal to one of the elements in this keyword's array value.
6966
+ *
6967
+ * Elements in the array might be of any type, including `null`.
6487
6968
  */
6488
6969
  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.
6970
+ /**
6971
+ * The value of this keyword MUST be an array. When multiple occurrences of
6972
+ * this keyword are applicable to a single sub-instance, implementations
6973
+ * MUST provide a flat array of all values rather than an array of arrays.
6974
+ *
6975
+ * This keyword can be used to provide sample JSON values associated with a
6976
+ * particular schema, for the purpose of illustrating usage. It is
6977
+ * RECOMMENDED that these values be valid against the associated schema.
6978
+ *
6979
+ * Implementations MAY use the value(s) of `default`, if present, as an
6980
+ * additional example. If `examples` is absent, `default` MAY still be
6981
+ * used in this manner.
6501
6982
  */
6502
6983
  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`.
6984
+ /**
6985
+ * The value of `exclusiveMaximum` MUST be a number, representing an
6986
+ * exclusive upper limit for a numeric instance.
6987
+ *
6988
+ * If the instance is a number, then the instance is valid only if it has a
6989
+ * value strictly less than (not equal to) `exclusiveMaximum`.
6509
6990
  */
6510
6991
  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`.
6992
+ /**
6993
+ * The value of `exclusiveMinimum` MUST be a number, representing an
6994
+ * exclusive lower limit for a numeric instance.
6995
+ *
6996
+ * If the instance is a number, then the instance is valid only if it has a
6997
+ * value strictly greater than (not equal to) `exclusiveMinimum`.
6517
6998
  */
6518
6999
  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.
7000
+ /**
7001
+ * Implementations MAY treat `format` as an assertion in addition to an
7002
+ * annotation, and attempt to validate the value's conformance to the
7003
+ * specified semantics.
7004
+ *
7005
+ * The value of this keyword is called a format attribute. It MUST be a
7006
+ * string. A format attribute can generally only validate a given set
7007
+ * of instance types. If the type of the instance to validate is not in
7008
+ * this set, validation for this format attribute and instance SHOULD
7009
+ * succeed. Format attributes are most often applied to strings, but can
7010
+ * be specified to apply to any type.
7011
+ *
7012
+ * Implementations MAY support custom format attributes. Save for agreement
7013
+ * between parties, schema authors SHALL NOT expect a peer implementation
7014
+ * to support such custom format attributes. An implementation MUST NOT
7015
+ * fail validation or cease processing due to an unknown format attribute.
7016
+ * When treating `format` as an annotation, implementations SHOULD
7017
+ * collect both known and unknown format attribute values.
6537
7018
  */
6538
7019
  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`.
7020
+ /**
7021
+ * This keyword's value MUST be a valid JSON Schema.
7022
+ *
7023
+ * This validation outcome of this keyword's subschema has no direct effect
7024
+ * on the overall validation result. Rather, it controls which of the
7025
+ * `then` or `else` keywords are evaluated.
7026
+ *
7027
+ * Instances that successfully validate against this keyword's subschema
7028
+ * MUST also be valid against the subschema value of the `then` keyword,
7029
+ * if present.
7030
+ *
7031
+ * Instances that fail to validate against this keyword's subschema MUST
7032
+ * also be valid against the subschema value of the `else` keyword, if
7033
+ * present.
7034
+ *
7035
+ * If annotations are being collected, they are collected
7036
+ * from this keyword's subschema in the usual way, including when the
7037
+ * keyword is present without either `then` or `else`.
6557
7038
  */
6558
7039
  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.
7040
+ /**
7041
+ * The value of `items` MUST be a valid JSON Schema.
7042
+ *
7043
+ * This keyword applies its subschema to all instance elements at indexes
7044
+ * greater than the length of the `prefixItems` array in the same schema
7045
+ * object, as reported by the annotation result of that `prefixItems`
7046
+ * keyword. If no such annotation result exists, `items` applies its
7047
+ * subschema to all instance array elements.
7048
+ *
7049
+ * Note that the behavior of `items` without `prefixItems` is identical
7050
+ * to that of the schema form of `items` in prior drafts.
7051
+ *
7052
+ * When `prefixItems` is present, the behavior of `items` is identical
7053
+ * to the former `additionalItems` keyword.
7054
+ *
7055
+ * If the `items` subschema is applied to any positions within the
7056
+ * instance array, it produces an annotation result of boolean `true`,
7057
+ * indicating that all remaining array elements have been evaluated against
7058
+ * this keyword's subschema.
7059
+ *
7060
+ * Omitting this keyword has the same assertion behavior as an empty
7061
+ * schema.
7062
+ *
7063
+ * Implementations MAY choose to implement or optimize this keyword
7064
+ * in another way that produces the same effect, such as by directly
7065
+ * checking for the presence and size of a `prefixItems` array.
6585
7066
  */
6586
7067
  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.
7068
+ /**
7069
+ * The value of this keyword MUST be a non-negative integer.
7070
+ *
7071
+ * If `contains` is not present within the same schema object, then this
7072
+ * keyword has no effect.
7073
+ *
7074
+ * An instance array is valid against `maxContains` in two ways,
7075
+ * depending on the form of the annotation result of an adjacent
7076
+ * `contains` keyword. The first way is if the annotation result is an
7077
+ * array and the length of that array is less than or equal to the
7078
+ * `maxContains` value. The second way is if the annotation result is a
7079
+ * boolean `true` and the instance array length is less than or equal to
7080
+ * the `maxContains` value.
6600
7081
  */
6601
7082
  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`.
7083
+ /**
7084
+ * The value of `maximum` MUST be a number, representing an inclusive
7085
+ * upper limit for a numeric instance.
7086
+ *
7087
+ * If the instance is a number, then this keyword validates only if the
7088
+ * instance is less than or exactly equal to `maximum`.
6608
7089
  */
6609
7090
  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
7091
+ /**
7092
+ * The value of this keyword MUST be a non-negative integer.
7093
+ *
7094
+ * An array instance is valid against `maxItems` if its size is less
7095
+ * than, or equal to, the value of this keyword.
7096
+ *
7097
+ * @minimum 0
6617
7098
  */
6618
7099
  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
7100
+ /**
7101
+ * The value of this keyword MUST be a non-negative integer.
7102
+ *
7103
+ * A string instance is valid against this keyword if its length is less
7104
+ * than, or equal to, the value of this keyword.
7105
+ *
7106
+ * The length of a string instance is defined as the number of its
7107
+ * characters as defined by [RFC 8259][RFC8259].
7108
+ *
7109
+ * [RFC8259]: https://datatracker.ietf.org/doc/html/rfc8259
7110
+ *
7111
+ * @minimum 0
6631
7112
  */
6632
7113
  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
7114
+ /**
7115
+ * The value of this keyword MUST be a non-negative integer.
7116
+ *
7117
+ * An object instance is valid against `maxProperties` if its number of
7118
+ * `properties` is less than, or equal to, the value of this keyword.
7119
+ *
7120
+ * @minimum 0
6640
7121
  */
6641
7122
  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
7123
+ /**
7124
+ * The value of this keyword MUST be a non-negative integer.
7125
+ *
7126
+ * If `contains` is not present within the same schema object, then this
7127
+ * keyword has no effect.
7128
+ *
7129
+ * An instance array is valid against `minContains` in two ways,
7130
+ * depending on the form of the annotation result of an adjacent
7131
+ * `contains` keyword. The first way is if the annotation result is an
7132
+ * array and the length of that array is greater than or equal to the
7133
+ * `minContains` value. The second way is if the annotation result is a
7134
+ * boolean `true` and the instance array length is greater than or equal
7135
+ * to the `minContains` value.
7136
+ *
7137
+ * A value of `0` is allowed, but is only useful for setting a range
7138
+ * of occurrences from `0` to the value of `maxContains`. A value of
7139
+ * `0` with no `maxContains` causes `contains` to always pass
7140
+ * validation.
7141
+ *
7142
+ * Omitting this keyword has the same behavior as a value of `1`.
7143
+ *
7144
+ * @default 1
6664
7145
  */
6665
7146
  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`.
7147
+ /**
7148
+ * The value of `minimum` MUST be a number, representing an inclusive
7149
+ * lower limit for a numeric instance.
7150
+ *
7151
+ * If the instance is a number, then this keyword validates only if the
7152
+ * instance is greater than or exactly equal to `minimum`.
6672
7153
  */
6673
7154
  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
7155
+ /**
7156
+ * The value of this keyword MUST be a non-negative integer.
7157
+ *
7158
+ * An array instance is valid against `minItems` if its size is greater
7159
+ * than, or equal to, the value of this keyword.
7160
+ *
7161
+ * Omitting this keyword has the same behavior as a value of `0`.
7162
+ *
7163
+ * @default 0
7164
+ * @minimum 0
6684
7165
  */
6685
7166
  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
7167
+ /**
7168
+ * The value of this keyword MUST be a non-negative integer.
7169
+ *
7170
+ * A string instance is valid against this keyword if its length is greater
7171
+ * than, or equal to, the value of this keyword.
7172
+ *
7173
+ * The length of a string instance is defined as the number of its
7174
+ * characters as defined by [RFC 8259][RFC8259].
7175
+ *
7176
+ * Omitting this keyword has the same behavior as a value of `0`.
7177
+ *
7178
+ * [RFC8259]: https://datatracker.ietf.org/doc/html/rfc8259
7179
+ *
7180
+ * @default 0
7181
+ * @minimum 0
6701
7182
  */
6702
7183
  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
7184
+ /**
7185
+ * The value of this keyword MUST be a non-negative integer.
7186
+ *
7187
+ * An object instance is valid against `minProperties` if its number of
7188
+ * `properties` is greater than, or equal to, the value of this keyword.
7189
+ *
7190
+ * Omitting this keyword has the same behavior as a value of `0`.
7191
+ *
7192
+ * @default 0
7193
+ * @minimum 0
6713
7194
  */
6714
7195
  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
7196
+ /**
7197
+ * The value of `multipleOf` MUST be a number, strictly greater than
7198
+ * `0`.
7199
+ *
7200
+ * A numeric instance is valid only if division by this keyword's value
7201
+ * results in an integer.
7202
+ *
7203
+ * @exclusiveMinimum 0
6723
7204
  */
6724
7205
  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.
7206
+ /**
7207
+ * This keyword's value MUST be a valid JSON Schema.
7208
+ *
7209
+ * An instance is valid against this keyword if it fails to validate
7210
+ * successfully against the schema defined by this keyword.
6730
7211
  */
6731
7212
  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.
7213
+ /**
7214
+ * This keyword's value MUST be a non-empty array. Each item of the array
7215
+ * MUST be a valid JSON Schema.
7216
+ *
7217
+ * An instance validates successfully against this keyword if it validates
7218
+ * successfully against exactly one schema defined by this keyword's value.
6738
7219
  */
6739
7220
  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"
7221
+ /**
7222
+ * The value of this keyword MUST be a string. This string SHOULD be a
7223
+ * valid regular expression, according to the [ECMA-262][ecma262] regular
7224
+ * expression dialect.
7225
+ *
7226
+ * A string instance is considered valid if the regular expression matches
7227
+ * the instance successfully. Recall: regular expressions are not
7228
+ * implicitly anchored.
7229
+ *
7230
+ * [ecma262]: https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
7231
+ *
7232
+ * @format "regex"
6752
7233
  */
6753
7234
  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/
7235
+ /**
7236
+ * The value of `patternProperties` MUST be an object. Each property name
7237
+ * of this object SHOULD be a valid regular expression, according to the
7238
+ * [ECMA-262][ecma262] regular expression dialect. Each property value of
7239
+ * this object MUST be a valid JSON Schema.
7240
+ *
7241
+ * Validation succeeds if, for each instance name that matches any regular
7242
+ * expressions that appear as a property name in this keyword's value,
7243
+ * the child instance for that name successfully validates against each
7244
+ * schema that corresponds to a matching regular expression.
7245
+ *
7246
+ * The annotation result of this keyword is the set of instance property
7247
+ * names matched by this keyword. Omitting this keyword has the same
7248
+ * assertion behavior as an empty object.
7249
+ *
7250
+ * [ecma262]: https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
6770
7251
  */
6771
7252
  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.
7253
+ /**
7254
+ * The value of `prefixItems` MUST be a non-empty array of valid JSON
7255
+ * Schemas.
7256
+ *
7257
+ * Validation succeeds if each element of the instance validates against
7258
+ * the schema at the same position, if any. This keyword does not
7259
+ * constrain the length of the array. If the array is longer than this
7260
+ * keyword's value, this keyword validates only the prefix of matching
7261
+ * length.
7262
+ *
7263
+ * This keyword produces an annotation value which is the largest index to
7264
+ * which this keyword applied a subschema. The value MAY be a boolean
7265
+ * `true` if a subschema was applied to every index of the instance, such
7266
+ * as is produced by the `items` keyword.
7267
+ * This annotation affects the behavior of `items` and
7268
+ * `unevaluatedItems`.
7269
+ *
7270
+ * Omitting this keyword has the same assertion behavior as an empty array.
6790
7271
  */
6791
7272
  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.
7273
+ /**
7274
+ * The value of `properties` MUST be an object. Each value of this object
7275
+ * MUST be a valid JSON Schema.
7276
+ *
7277
+ * Validation succeeds if, for each name that appears in both the instance
7278
+ * and as a name within this keyword's value, the child instance for that
7279
+ * name successfully validates against the corresponding schema.
7280
+ *
7281
+ * The annotation result of this keyword is the set of instance property
7282
+ * names matched by this keyword.
7283
+ *
7284
+ * Omitting this keyword has the same assertion behavior as an empty
7285
+ * object.
6805
7286
  */
6806
7287
  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.
7288
+ /**
7289
+ * The value of `propertyNames` MUST be a valid JSON Schema.
7290
+ *
7291
+ * If the instance is an object, this keyword validates if every property
7292
+ * name in the instance validates against the provided schema.
7293
+ * Note the property name that the schema is testing will always be a
7294
+ * string.
7295
+ *
7296
+ * Omitting this keyword has the same behavior as an empty schema.
6816
7297
  */
6817
7298
  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
7299
+ /**
7300
+ * The value of this keyword MUST be a boolean. When multiple occurrences
7301
+ * of this keyword are applicable to a single sub-instance, the resulting
7302
+ * value MUST be `true` if any occurrence specifies a `true` value, and
7303
+ * MUST be `false` otherwise.
7304
+ *
7305
+ * If `readOnly` has a value of boolean `true`, it indicates that the
7306
+ * value of the instance is managed exclusively by the owning authority,
7307
+ * and attempts by an application to modify the value of this property are
7308
+ * expected to be ignored or rejected by that owning authority.
7309
+ *
7310
+ * An instance document that is marked as `readOnly` for the entire
7311
+ * document MAY be ignored if sent to the owning authority, or MAY result
7312
+ * in an error, at the authority's discretion.
7313
+ *
7314
+ * For example, `readOnly` would be used to mark a database-generated
7315
+ * serial number as read-only.
7316
+ *
7317
+ * This keyword can be used to assist in user interface instance
7318
+ * generation.
7319
+ *
7320
+ * @default false
6840
7321
  */
6841
7322
  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.
7323
+ /**
7324
+ * The value of this keyword MUST be an array. Elements of this array, if
7325
+ * any, MUST be strings, and MUST be unique.
7326
+ *
7327
+ * An object instance is valid against this keyword if every item in the
7328
+ * array is the name of a property in the instance.
7329
+ *
7330
+ * Omitting this keyword has the same behavior as an empty array.
6850
7331
  */
6851
7332
  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.
7333
+ /**
7334
+ * This keyword's value MUST be a valid JSON Schema.
7335
+ *
7336
+ * When `if` is present, and the instance successfully validates against
7337
+ * its subschema, then validation succeeds against this keyword if the
7338
+ * instance also successfully validates against this keyword's subschema.
7339
+ *
7340
+ * This keyword has no effect when `if` is absent, or when the instance
7341
+ * fails to validate against its subschema. Implementations MUST NOT
7342
+ * evaluate the instance against this keyword, for either validation or
7343
+ * annotation collection purposes, in such cases.
6863
7344
  */
6864
7345
  then?: JSONSchema<Value, SchemaType>;
6865
- /**
6866
- * Can be used to decorate a user interface with a short label about the
6867
- * data produced.
7346
+ /**
7347
+ * Can be used to decorate a user interface with a short label about the
7348
+ * data produced.
6868
7349
  */
6869
7350
  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.
7351
+ /**
7352
+ * The value of this keyword MUST be either a string or an array. If it is
7353
+ * an array, elements of the array MUST be strings and MUST be unique.
7354
+ *
7355
+ * String values MUST be one of the six primitive types (`"null"`,
7356
+ * `"boolean"`, `"object"`, `"array"`, `"number"`, or
7357
+ * `"string"`), or `"integer"` which matches any number with a zero
7358
+ * fractional part.
7359
+ *
7360
+ * An instance validates if and only if the instance is in any of the sets
7361
+ * listed for this keyword.
6881
7362
  */
6882
7363
  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
7364
+ /**
7365
+ * The value of `unevaluatedItems` MUST be a valid JSON Schema.
7366
+ *
7367
+ * The behavior of this keyword depends on the annotation results of
7368
+ * adjacent keywords that apply to the instance location being validated.
7369
+ * Specifically, the annotations from `prefixItems`, `items`, and
7370
+ * `contains`, which can come from those keywords when they are adjacent
7371
+ * to the `unevaluatedItems` keyword. Those three annotations, as well as
7372
+ * `unevaluatedItems`, can also result from any and all adjacent
7373
+ * [in-place applicator][in-place-applicator] keywords.
7374
+ *
7375
+ * If no relevant annotations are present, the `unevaluatedItems`
7376
+ * subschema MUST be applied to all locations in the array.
7377
+ * If a boolean `true` value is present from any of the relevant
7378
+ * annotations, `unevaluatedItems` MUST be ignored. Otherwise, the
7379
+ * subschema MUST be applied to any index greater than the largest
7380
+ * annotation value for `prefixItems`, which does not appear in any
7381
+ * annotation value for `contains`.
7382
+ *
7383
+ * This means that `prefixItems`, `items`, `contains`, and all
7384
+ * in-place applicators MUST be evaluated before this keyword can be
7385
+ * evaluated. Authors of extension keywords MUST NOT define an in-place
7386
+ * applicator that would need to be evaluated after this keyword.
7387
+ *
7388
+ * If the `unevaluatedItems` subschema is applied to any positions within
7389
+ * the instance array, it produces an annotation result of boolean
7390
+ * `true`, analogous to the behavior of `items`.
7391
+ *
7392
+ * Omitting this keyword has the same assertion behavior as an empty
7393
+ * schema.
7394
+ *
7395
+ * [in-place-applicator]: https://json-schema.org/draft/2020-12/json-schema-core.html#in-place
6915
7396
  */
6916
7397
  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
7398
+ /**
7399
+ * The value of `unevaluatedProperties` MUST be a valid JSON Schema.
7400
+ *
7401
+ * The behavior of this keyword depends on the annotation results of
7402
+ * adjacent keywords that apply to the instance location being validated.
7403
+ * Specifically, the annotations from `properties`,
7404
+ * `patternProperties`, and `additionalProperties`, which can come from
7405
+ * those keywords when they are adjacent to the `unevaluatedProperties`
7406
+ * keyword. Those three annotations, as well as `unevaluatedProperties`,
7407
+ * can also result from any and all adjacent
7408
+ * [in-place applicator][in-place-applicator] keywords.
7409
+ *
7410
+ * Validation with `unevaluatedProperties` applies only to the child
7411
+ * values of instance names that do not appear in the `properties`,
7412
+ * `patternProperties`, `additionalProperties`, or
7413
+ * `unevaluatedProperties` annotation results that apply to the
7414
+ * instance location being validated.
7415
+ *
7416
+ * For all such properties, validation succeeds if the child instance
7417
+ * validates against the "unevaluatedProperties" schema.
7418
+ *
7419
+ * This means that `properties`, `patternProperties`,
7420
+ * `additionalProperties`, and all in-place applicators MUST be evaluated
7421
+ * before this keyword can be evaluated. Authors of extension keywords
7422
+ * MUST NOT define an in-place applicator that would need to be evaluated
7423
+ * after this keyword.
7424
+ *
7425
+ * The annotation result of this keyword is the set of instance property
7426
+ * names validated by this keyword's subschema.
7427
+ *
7428
+ * Omitting this keyword has the same assertion behavior as an empty
7429
+ * schema.
7430
+ *
7431
+ * [in-place-applicator]: https://json-schema.org/draft/2020-12/json-schema-core.html#in-place
6951
7432
  */
6952
7433
  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
7434
+ /**
7435
+ * The value of this keyword MUST be a boolean.
7436
+ *
7437
+ * If this keyword has boolean value `false`, the instance validates
7438
+ * successfully. If it has boolean value `true`, the instance validates
7439
+ * successfully if all of its elements are unique.
7440
+ *
7441
+ * Omitting this keyword has the same behavior as a value of `false`.
7442
+ *
7443
+ * @default false
6963
7444
  */
6964
7445
  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
7446
+ /**
7447
+ * The value of this keyword MUST be a boolean. When multiple occurrences
7448
+ * of this keyword is applicable to a single sub-instance, the resulting
7449
+ * value MUST be `true` if any occurrence specifies a `true` value, and
7450
+ * MUST be `false` otherwise.
7451
+ *
7452
+ * If `writeOnly` has a value of boolean `true`, it indicates that the
7453
+ * value is never present when the instance is retrieved from the owning
7454
+ * authority. It can be present when sent to the owning authority to update
7455
+ * or create the document (or the resource it represents), but it will not
7456
+ * be included in any updated or newly created version of the instance.
7457
+ *
7458
+ * An instance document that is marked as `writeOnly` for the entire
7459
+ * document MAY be returned as a blank document of some sort, or MAY
7460
+ * produce an error upon retrieval, or have the retrieval request ignored,
7461
+ * at the authority's discretion.
7462
+ *
7463
+ * For example, `writeOnly` would be used to mark a password input field.
7464
+ *
7465
+ * These keywords can be used to assist in user interface instance
7466
+ * generation. In particular, an application MAY choose to use a widget
7467
+ * that hides input values as they are typed for write-only fields.
7468
+ *
7469
+ * @default false
6989
7470
  */
6990
7471
  writeOnly?: boolean;
6991
7472
  };
6992
7473
  declare namespace JSONSchema {
6993
7474
  type TypeValue = ValueOf<TypeName> | TypeName | Array<ValueOf<TypeName> | TypeName> | ReadonlyArray<ValueOf<TypeName> | TypeName>;
6994
- /**
6995
- * JSON Schema interface
7475
+ /**
7476
+ * JSON Schema interface
6996
7477
  */
6997
7478
  type Interface<Value = any, SchemaType extends TypeValue = TypeValue> = Exclude<JSONSchema<Value, SchemaType>, boolean>;
6998
7479
  type Array<T = any> = Pick<Interface<T, "array">, KeywordByType.Any | KeywordByType.Array>;
@@ -7010,45 +7491,45 @@ declare namespace KeywordByType {
7010
7491
  type Object = "additionalProperties" | "dependencies" | "dependentRequired" | "dependentSchemas" | "maxProperties" | "minProperties" | "patternProperties" | "properties" | "propertyNames" | "required" | "unevaluatedProperties";
7011
7492
  type String = "contentEncoding" | "contentMediaType" | "contentSchema" | "maxLength" | "minLength" | "pattern";
7012
7493
  }
7013
- /**
7014
- * Enum consisting of simple type names for the `type` keyword
7494
+ /**
7495
+ * Enum consisting of simple type names for the `type` keyword
7015
7496
  */
7016
7497
  declare enum TypeName {
7017
- /**
7018
- * Value MUST be an array.
7498
+ /**
7499
+ * Value MUST be an array.
7019
7500
  */
7020
7501
  Array = "array",
7021
- /**
7022
- * Value MUST be a boolean.
7502
+ /**
7503
+ * Value MUST be a boolean.
7023
7504
  */
7024
7505
  Boolean = "boolean",
7025
- /**
7026
- * Value MUST be an integer, no floating point numbers are allowed. This is a
7027
- * subset of the number type.
7506
+ /**
7507
+ * Value MUST be an integer, no floating point numbers are allowed. This is a
7508
+ * subset of the number type.
7028
7509
  */
7029
7510
  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).
7511
+ /**
7512
+ * Value MUST be null. Note this is mainly for purpose of being able use union
7513
+ * types to define nullability. If this type is not included in a union, null
7514
+ * values are not allowed (the primitives listed above do not allow nulls on
7515
+ * their own).
7035
7516
  */
7036
7517
  Null = "null",
7037
- /**
7038
- * Value MUST be a number, floating point numbers are allowed.
7518
+ /**
7519
+ * Value MUST be a number, floating point numbers are allowed.
7039
7520
  */
7040
7521
  Number = "number",
7041
- /**
7042
- * Value MUST be an object.
7522
+ /**
7523
+ * Value MUST be an object.
7043
7524
  */
7044
7525
  Object = "object",
7045
- /**
7046
- * Value MUST be a string.
7526
+ /**
7527
+ * Value MUST be a string.
7047
7528
  */
7048
7529
  String = "string"
7049
7530
  }
7050
7531
  //#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
7532
+ //#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
7533
  interface SchemaConverterComponent {
7053
7534
  allowedStrategies: readonly SchemaConvertOptions['strategy'][];
7054
7535
  schema: AnySchema;