@alpic-ai/api 0.0.0-staging.gf15a40a → 0.0.0-staging.gf168f3b

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