@hey-api/openapi-ts 0.80.4 → 0.80.6

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.
@@ -9016,6 +9016,28 @@ type UserConfig$7 = Plugin.Name<'@tanstack/angular-query-experimental'> & {
9016
9016
  * @default true
9017
9017
  */
9018
9018
  enabled?: boolean;
9019
+ /**
9020
+ * Custom function to generate metadata for the operation.
9021
+ * Can return any valid meta object that will be included in the generated infinite query options.
9022
+ * @param operation - The operation object containing all available metadata
9023
+ * @returns A meta object with any properties you want to include
9024
+ *
9025
+ * @example
9026
+ * ```typescript
9027
+ * meta: (operation) => ({
9028
+ * customField: operation.id,
9029
+ * isDeprecated: operation.deprecated,
9030
+ * tags: operation.tags,
9031
+ * customObject: {
9032
+ * method: operation.method,
9033
+ * path: operation.path
9034
+ * }
9035
+ * })
9036
+ * ```
9037
+ *
9038
+ * @default false
9039
+ */
9040
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9019
9041
  /**
9020
9042
  * Custom naming pattern for generated infinite query options names. The name variable is
9021
9043
  * obtained from the SDK function name.
@@ -9053,6 +9075,28 @@ type UserConfig$7 = Plugin.Name<'@tanstack/angular-query-experimental'> & {
9053
9075
  * @default true
9054
9076
  */
9055
9077
  enabled?: boolean;
9078
+ /**
9079
+ * Custom function to generate metadata for the operation.
9080
+ * Can return any valid meta object that will be included in the generated mutation options.
9081
+ * @param operation - The operation object containing all available metadata
9082
+ * @returns A meta object with any properties you want to include
9083
+ *
9084
+ * @example
9085
+ * ```typescript
9086
+ * meta: (operation) => ({
9087
+ * customField: operation.id,
9088
+ * isDeprecated: operation.deprecated,
9089
+ * tags: operation.tags,
9090
+ * customObject: {
9091
+ * method: operation.method,
9092
+ * path: operation.path
9093
+ * }
9094
+ * })
9095
+ * ```
9096
+ *
9097
+ * @default false
9098
+ */
9099
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9056
9100
  /**
9057
9101
  * Custom naming pattern for generated mutation options names. The name variable is
9058
9102
  * obtained from the SDK function name.
@@ -9140,6 +9184,28 @@ type UserConfig$7 = Plugin.Name<'@tanstack/angular-query-experimental'> & {
9140
9184
  * @default true
9141
9185
  */
9142
9186
  enabled?: boolean;
9187
+ /**
9188
+ * Custom function to generate metadata for the operation.
9189
+ * Can return any valid meta object that will be included in the generated query options.
9190
+ * @param operation - The operation object containing all available metadata
9191
+ * @returns A meta object with any properties you want to include
9192
+ *
9193
+ * @example
9194
+ * ```typescript
9195
+ * meta: (operation) => ({
9196
+ * customField: operation.id,
9197
+ * isDeprecated: operation.deprecated,
9198
+ * tags: operation.tags,
9199
+ * customObject: {
9200
+ * method: operation.method,
9201
+ * path: operation.path
9202
+ * }
9203
+ * })
9204
+ * ```
9205
+ *
9206
+ * @default false
9207
+ */
9208
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9143
9209
  /**
9144
9210
  * Custom naming pattern for generated query options names. The name variable is
9145
9211
  * obtained from the SDK function name.
@@ -9222,6 +9288,28 @@ type Config$6 = Plugin.Name<'@tanstack/angular-query-experimental'> & {
9222
9288
  * @default true
9223
9289
  */
9224
9290
  enabled: boolean;
9291
+ /**
9292
+ * Custom function to generate metadata for the operation.
9293
+ * Can return any valid meta object that will be included in the generated infinite query options.
9294
+ * @param operation - The operation object containing all available metadata
9295
+ * @returns A meta object with any properties you want to include
9296
+ *
9297
+ * @example
9298
+ * ```typescript
9299
+ * meta: (operation) => ({
9300
+ * customField: operation.id,
9301
+ * isDeprecated: operation.deprecated,
9302
+ * tags: operation.tags,
9303
+ * customObject: {
9304
+ * method: operation.method,
9305
+ * path: operation.path
9306
+ * }
9307
+ * })
9308
+ * ```
9309
+ *
9310
+ * @default false
9311
+ */
9312
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9225
9313
  /**
9226
9314
  * Custom naming pattern for generated infinite query options names. The name variable is
9227
9315
  * obtained from the SDK function name.
@@ -9249,6 +9337,28 @@ type Config$6 = Plugin.Name<'@tanstack/angular-query-experimental'> & {
9249
9337
  * @default true
9250
9338
  */
9251
9339
  enabled: boolean;
9340
+ /**
9341
+ * Custom function to generate metadata for the operation.
9342
+ * Can return any valid meta object that will be included in the generated mutation options.
9343
+ * @param operation - The operation object containing all available metadata
9344
+ * @returns A meta object with any properties you want to include
9345
+ *
9346
+ * @example
9347
+ * ```typescript
9348
+ * meta: (operation) => ({
9349
+ * customField: operation.id,
9350
+ * isDeprecated: operation.deprecated,
9351
+ * tags: operation.tags,
9352
+ * customObject: {
9353
+ * method: operation.method,
9354
+ * path: operation.path
9355
+ * }
9356
+ * })
9357
+ * ```
9358
+ *
9359
+ * @default false
9360
+ */
9361
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9252
9362
  /**
9253
9363
  * Custom naming pattern for generated mutation options names. The name variable is
9254
9364
  * obtained from the SDK function name.
@@ -9316,6 +9426,28 @@ type Config$6 = Plugin.Name<'@tanstack/angular-query-experimental'> & {
9316
9426
  * @default true
9317
9427
  */
9318
9428
  enabled: boolean;
9429
+ /**
9430
+ * Custom function to generate metadata for the operation.
9431
+ * Can return any valid meta object that will be included in the generated query options.
9432
+ * @param operation - The operation object containing all available metadata
9433
+ * @returns A meta object with any properties you want to include
9434
+ *
9435
+ * @example
9436
+ * ```typescript
9437
+ * meta: (operation) => ({
9438
+ * customField: operation.id,
9439
+ * isDeprecated: operation.deprecated,
9440
+ * tags: operation.tags,
9441
+ * customObject: {
9442
+ * method: operation.method,
9443
+ * path: operation.path
9444
+ * }
9445
+ * })
9446
+ * ```
9447
+ *
9448
+ * @default false
9449
+ */
9450
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9319
9451
  /**
9320
9452
  * Custom naming pattern for generated query options names. The name variable is
9321
9453
  * obtained from the SDK function name.
@@ -9425,6 +9557,27 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> & {
9425
9557
  * @default true
9426
9558
  */
9427
9559
  enabled?: boolean;
9560
+ /**
9561
+ * Custom function to generate metadata for the operation.
9562
+ * Can return any valid meta object that will be included in the generated infinite query options.
9563
+ *
9564
+ * @param operation - The operation object containing all available metadata
9565
+ * @returns A meta object with any properties you want to include
9566
+ *
9567
+ * @example
9568
+ * ```typescript
9569
+ * meta: (operation) => ({
9570
+ * customField: operation.id,
9571
+ * isDeprecated: operation.deprecated,
9572
+ * tags: operation.tags,
9573
+ * customObject: {
9574
+ * method: operation.method,
9575
+ * path: operation.path
9576
+ * }
9577
+ * })
9578
+ * ```
9579
+ */
9580
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9428
9581
  /**
9429
9582
  * Custom naming pattern for generated infinite query options names. The name variable is
9430
9583
  * obtained from the SDK function name.
@@ -9462,6 +9615,27 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> & {
9462
9615
  * @default true
9463
9616
  */
9464
9617
  enabled?: boolean;
9618
+ /**
9619
+ * Custom function to generate metadata for the operation.
9620
+ * Can return any valid meta object that will be included in the generated mutation options.
9621
+ *
9622
+ * @param operation - The operation object containing all available metadata
9623
+ * @returns A meta object with any properties you want to include
9624
+ *
9625
+ * @example
9626
+ * ```typescript
9627
+ * meta: (operation) => ({
9628
+ * customField: operation.id,
9629
+ * isDeprecated: operation.deprecated,
9630
+ * tags: operation.tags,
9631
+ * customObject: {
9632
+ * method: operation.method,
9633
+ * path: operation.path
9634
+ * }
9635
+ * })
9636
+ * ```
9637
+ */
9638
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9465
9639
  /**
9466
9640
  * Custom naming pattern for generated mutation options names. The name variable is
9467
9641
  * obtained from the SDK function name.
@@ -9549,6 +9723,28 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> & {
9549
9723
  * @default true
9550
9724
  */
9551
9725
  enabled?: boolean;
9726
+ /**
9727
+ * Custom function to generate metadata for the operation.
9728
+ * Can return any valid meta object that will be included in the generated query options.
9729
+ *
9730
+ * @param operation - The operation object containing all available metadata
9731
+ * @returns A meta object with any properties you want to include
9732
+ *
9733
+ * @example
9734
+ * ```typescript
9735
+ * meta: (operation) => ({
9736
+ * customField: operation.id,
9737
+ * isDeprecated: operation.deprecated,
9738
+ * tags: operation.tags,
9739
+ * customObject: {
9740
+ * method: operation.method,
9741
+ * path: operation.path
9742
+ * }
9743
+ * })
9744
+ * ```
9745
+ */
9746
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9747
+
9552
9748
  /**
9553
9749
  * Custom naming pattern for generated query options names. The name variable is
9554
9750
  * obtained from the SDK function name.
@@ -9630,6 +9826,27 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> & {
9630
9826
  * @default true
9631
9827
  */
9632
9828
  enabled: boolean;
9829
+ /**
9830
+ * Custom function to generate metadata for the operation.
9831
+ * Can return any valid meta object that will be included in the generated infinite query options.
9832
+ *
9833
+ * @param operation - The operation object containing all available metadata
9834
+ * @returns A meta object with any properties you want to include
9835
+ *
9836
+ * @example
9837
+ * ```typescript
9838
+ * meta: (operation) => ({
9839
+ * customField: operation.id,
9840
+ * isDeprecated: operation.deprecated,
9841
+ * tags: operation.tags,
9842
+ * customObject: {
9843
+ * method: operation.method,
9844
+ * path: operation.path
9845
+ * }
9846
+ * })
9847
+ * ```
9848
+ */
9849
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9633
9850
  /**
9634
9851
  * Custom naming pattern for generated infinite query options names. The name variable is obtained from the SDK function name.
9635
9852
  *
@@ -9656,6 +9873,27 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> & {
9656
9873
  * @default true
9657
9874
  */
9658
9875
  enabled: boolean;
9876
+ /**
9877
+ * Custom function to generate metadata for the operation.
9878
+ * Can return any valid meta object that will be included in the generated mutation options.
9879
+ *
9880
+ * @param operation - The operation object containing all available metadata
9881
+ * @returns A meta object with any properties you want to include
9882
+ *
9883
+ * @example
9884
+ * ```typescript
9885
+ * meta: (operation) => ({
9886
+ * customField: operation.id,
9887
+ * isDeprecated: operation.deprecated,
9888
+ * tags: operation.tags,
9889
+ * customObject: {
9890
+ * method: operation.method,
9891
+ * path: operation.path
9892
+ * }
9893
+ * })
9894
+ * ```
9895
+ */
9896
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9659
9897
  /**
9660
9898
  * Custom naming pattern for generated mutation options names. The name variable is obtained from the SDK function name.
9661
9899
  *
@@ -9721,6 +9959,27 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> & {
9721
9959
  * @default true
9722
9960
  */
9723
9961
  enabled: boolean;
9962
+ /**
9963
+ * Custom function to generate metadata for the operation.
9964
+ * Can return any valid meta object that will be included in the generated query options.
9965
+ *
9966
+ * @param operation - The operation object containing all available metadata
9967
+ * @returns A meta object with any properties you want to include
9968
+ *
9969
+ * @example
9970
+ * ```typescript
9971
+ * meta: (operation) => ({
9972
+ * customField: operation.id,
9973
+ * isDeprecated: operation.deprecated,
9974
+ * tags: operation.tags,
9975
+ * customObject: {
9976
+ * method: operation.method,
9977
+ * path: operation.path
9978
+ * }
9979
+ * })
9980
+ * ```
9981
+ */
9982
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9724
9983
  /**
9725
9984
  * Custom naming pattern for generated query options names. The name variable is obtained from the SDK function name.
9726
9985
  *
@@ -9824,6 +10083,27 @@ type UserConfig$5 = Plugin.Name<'@tanstack/solid-query'> & {
9824
10083
  * @default true
9825
10084
  */
9826
10085
  enabled?: boolean;
10086
+ /**
10087
+ * Custom function to generate metadata for the operation.
10088
+ * Can return any valid meta object that will be included in the generated infinite query options.
10089
+ *
10090
+ * @param operation - The operation object containing all available metadata
10091
+ * @returns A meta object with any properties you want to include
10092
+ *
10093
+ * @example
10094
+ * ```typescript
10095
+ * meta: (operation) => ({
10096
+ * customField: operation.id,
10097
+ * isDeprecated: operation.deprecated,
10098
+ * tags: operation.tags,
10099
+ * customObject: {
10100
+ * method: operation.method,
10101
+ * path: operation.path
10102
+ * }
10103
+ * })
10104
+ * ```
10105
+ */
10106
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9827
10107
  /**
9828
10108
  * Custom naming pattern for generated infinite query options names. The name variable is
9829
10109
  * obtained from the SDK function name.
@@ -9861,6 +10141,28 @@ type UserConfig$5 = Plugin.Name<'@tanstack/solid-query'> & {
9861
10141
  * @default true
9862
10142
  */
9863
10143
  enabled?: boolean;
10144
+ /**
10145
+ * Custom function to generate metadata for the operation.
10146
+ * Can return any valid meta object that will be included in the generated mutation options.
10147
+ * @param operation - The operation object containing all available metadata
10148
+ * @returns A meta object with any properties you want to include
10149
+ *
10150
+ * @example
10151
+ * ```typescript
10152
+ * meta: (operation) => ({
10153
+ * customField: operation.id,
10154
+ * isDeprecated: operation.deprecated,
10155
+ * tags: operation.tags,
10156
+ * customObject: {
10157
+ * method: operation.method,
10158
+ * path: operation.path
10159
+ * }
10160
+ * })
10161
+ * ```
10162
+ *
10163
+ * @default false
10164
+ */
10165
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9864
10166
  /**
9865
10167
  * Custom naming pattern for generated mutation options names. The name variable is
9866
10168
  * obtained from the SDK function name.
@@ -9948,6 +10250,28 @@ type UserConfig$5 = Plugin.Name<'@tanstack/solid-query'> & {
9948
10250
  * @default true
9949
10251
  */
9950
10252
  enabled?: boolean;
10253
+ /**
10254
+ * Custom function to generate metadata for the operation.
10255
+ * Can return any valid meta object that will be included in the generated query options.
10256
+ * @param operation - The operation object containing all available metadata
10257
+ * @returns A meta object with any properties you want to include
10258
+ *
10259
+ * @example
10260
+ * ```typescript
10261
+ * meta: (operation) => ({
10262
+ * customField: operation.id,
10263
+ * isDeprecated: operation.deprecated,
10264
+ * tags: operation.tags,
10265
+ * customObject: {
10266
+ * method: operation.method,
10267
+ * path: operation.path
10268
+ * }
10269
+ * })
10270
+ * ```
10271
+ *
10272
+ * @default false
10273
+ */
10274
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
9951
10275
  /**
9952
10276
  * Custom naming pattern for generated query options names. The name variable is
9953
10277
  * obtained from the SDK function name.
@@ -10030,6 +10354,28 @@ type Config$4 = Plugin.Name<'@tanstack/solid-query'> & {
10030
10354
  * @default true
10031
10355
  */
10032
10356
  enabled: boolean;
10357
+ /**
10358
+ * Custom function to generate metadata for the operation.
10359
+ * Can return any valid meta object that will be included in the generated infinite query options.
10360
+ * @param operation - The operation object containing all available metadata
10361
+ * @returns A meta object with any properties you want to include
10362
+ *
10363
+ * @example
10364
+ * ```typescript
10365
+ * meta: (operation) => ({
10366
+ * customField: operation.id,
10367
+ * isDeprecated: operation.deprecated,
10368
+ * tags: operation.tags,
10369
+ * customObject: {
10370
+ * method: operation.method,
10371
+ * path: operation.path
10372
+ * }
10373
+ * })
10374
+ * ```
10375
+ *
10376
+ * @default false
10377
+ */
10378
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10033
10379
  /**
10034
10380
  * Custom naming pattern for generated infinite query options names. The name variable is
10035
10381
  * obtained from the SDK function name.
@@ -10057,6 +10403,28 @@ type Config$4 = Plugin.Name<'@tanstack/solid-query'> & {
10057
10403
  * @default true
10058
10404
  */
10059
10405
  enabled: boolean;
10406
+ /**
10407
+ * Custom function to generate metadata for the operation.
10408
+ * Can return any valid meta object that will be included in the generated mutation options.
10409
+ * @param operation - The operation object containing all available metadata
10410
+ * @returns A meta object with any properties you want to include
10411
+ *
10412
+ * @example
10413
+ * ```typescript
10414
+ * meta: (operation) => ({
10415
+ * customField: operation.id,
10416
+ * isDeprecated: operation.deprecated,
10417
+ * tags: operation.tags,
10418
+ * customObject: {
10419
+ * method: operation.method,
10420
+ * path: operation.path
10421
+ * }
10422
+ * })
10423
+ * ```
10424
+ *
10425
+ * @default false
10426
+ */
10427
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10060
10428
  /**
10061
10429
  * Custom naming pattern for generated mutation options names. The name variable is
10062
10430
  * obtained from the SDK function name.
@@ -10124,6 +10492,28 @@ type Config$4 = Plugin.Name<'@tanstack/solid-query'> & {
10124
10492
  * @default true
10125
10493
  */
10126
10494
  enabled: boolean;
10495
+ /**
10496
+ * Custom function to generate metadata for the operation.
10497
+ * Can return any valid meta object that will be included in the generated query options.
10498
+ * @param operation - The operation object containing all available metadata
10499
+ * @returns A meta object with any properties you want to include
10500
+ *
10501
+ * @example
10502
+ * ```typescript
10503
+ * meta: (operation) => ({
10504
+ * customField: operation.id,
10505
+ * isDeprecated: operation.deprecated,
10506
+ * tags: operation.tags,
10507
+ * customObject: {
10508
+ * method: operation.method,
10509
+ * path: operation.path
10510
+ * }
10511
+ * })
10512
+ * ```
10513
+ *
10514
+ * @default false
10515
+ */
10516
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10127
10517
  /**
10128
10518
  * Custom naming pattern for generated query options names. The name variable is
10129
10519
  * obtained from the SDK function name.
@@ -10159,7 +10549,7 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10159
10549
  /**
10160
10550
  * Configuration for generated infinite query key helpers.
10161
10551
  *
10162
- * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery}
10552
+ * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery}
10163
10553
  *
10164
10554
  * Can be:
10165
10555
  * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10189,7 +10579,7 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10189
10579
  * obtained from the SDK function name.
10190
10580
  *
10191
10581
  * @default '{{name}}InfiniteQueryKey'
10192
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery
10582
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
10193
10583
  */
10194
10584
  name?: StringName;
10195
10585
  /**
@@ -10203,7 +10593,7 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10203
10593
  /**
10204
10594
  * Configuration for generated infinite query options helpers.
10205
10595
  *
10206
- * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery}
10596
+ * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery}
10207
10597
  *
10208
10598
  * Can be:
10209
10599
  * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10228,19 +10618,41 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10228
10618
  * @default true
10229
10619
  */
10230
10620
  enabled?: boolean;
10621
+ /**
10622
+ * Custom function to generate metadata for the operation.
10623
+ * Can return any valid meta object that will be included in the generated infinite query options.
10624
+ * @param operation - The operation object containing all available metadata
10625
+ * @returns A meta object with any properties you want to include
10626
+ *
10627
+ * @example
10628
+ * ```typescript
10629
+ * meta: (operation) => ({
10630
+ * customField: operation.id,
10631
+ * isDeprecated: operation.deprecated,
10632
+ * tags: operation.tags,
10633
+ * customObject: {
10634
+ * method: operation.method,
10635
+ * path: operation.path
10636
+ * }
10637
+ * })
10638
+ * ```
10639
+ *
10640
+ * @default false
10641
+ */
10642
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10231
10643
  /**
10232
10644
  * Custom naming pattern for generated infinite query options names. The name variable is
10233
10645
  * obtained from the SDK function name.
10234
10646
  *
10235
10647
  * @default '{{name}}InfiniteOptions'
10236
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery
10648
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
10237
10649
  */
10238
10650
  name?: StringName;
10239
10651
  };
10240
10652
  /**
10241
10653
  * Configuration for generated mutation options helpers.
10242
10654
  *
10243
- * See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/createMutation}
10655
+ * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation}
10244
10656
  *
10245
10657
  * Can be:
10246
10658
  * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10265,12 +10677,34 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10265
10677
  * @default true
10266
10678
  */
10267
10679
  enabled?: boolean;
10680
+ /**
10681
+ * Custom function to generate metadata for the operation.
10682
+ * Can return any valid meta object that will be included in the generated mutation options.
10683
+ * @param operation - The operation object containing all available metadata
10684
+ * @returns A meta object with any properties you want to include
10685
+ *
10686
+ * @example
10687
+ * ```typescript
10688
+ * meta: (operation) => ({
10689
+ * customField: operation.id,
10690
+ * isDeprecated: operation.deprecated,
10691
+ * tags: operation.tags,
10692
+ * customObject: {
10693
+ * method: operation.method,
10694
+ * path: operation.path
10695
+ * }
10696
+ * })
10697
+ * ```
10698
+ *
10699
+ * @default false
10700
+ */
10701
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10268
10702
  /**
10269
10703
  * Custom naming pattern for generated mutation options names. The name variable is
10270
10704
  * obtained from the SDK function name.
10271
10705
  *
10272
10706
  * @default '{{name}}Mutation'
10273
- * @see https://tanstack.com/query/v5/docs/framework/solid/reference/createMutation
10707
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation
10274
10708
  */
10275
10709
  name?: StringName;
10276
10710
  };
@@ -10283,7 +10717,7 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10283
10717
  /**
10284
10718
  * Configuration for generated query keys.
10285
10719
  *
10286
- * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/queryKey}
10720
+ * See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys}
10287
10721
  *
10288
10722
  * Can be:
10289
10723
  * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10313,7 +10747,7 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10313
10747
  * obtained from the SDK function name.
10314
10748
  *
10315
10749
  * @default '{{name}}QueryKey'
10316
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/queryKey
10750
+ * @see https://tanstack.com/query/v5/docs/framework/react/guides/query-keys
10317
10751
  */
10318
10752
  name?: StringName;
10319
10753
  /**
@@ -10327,7 +10761,7 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10327
10761
  /**
10328
10762
  * Configuration for generated query options helpers.
10329
10763
  *
10330
- * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/createQuery}
10764
+ * See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery}
10331
10765
  *
10332
10766
  * Can be:
10333
10767
  * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10352,12 +10786,34 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> & {
10352
10786
  * @default true
10353
10787
  */
10354
10788
  enabled?: boolean;
10789
+ /**
10790
+ * Custom function to generate metadata for the operation.
10791
+ * Can return any valid meta object that will be included in the generated query options.
10792
+ * @param operation - The operation object containing all available metadata
10793
+ * @returns A meta object with any properties you want to include
10794
+ *
10795
+ * @example
10796
+ * ```typescript
10797
+ * meta: (operation) => ({
10798
+ * customField: operation.id,
10799
+ * isDeprecated: operation.deprecated,
10800
+ * tags: operation.tags,
10801
+ * customObject: {
10802
+ * method: operation.method,
10803
+ * path: operation.path
10804
+ * }
10805
+ * })
10806
+ * ```
10807
+ *
10808
+ * @default false
10809
+ */
10810
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10355
10811
  /**
10356
10812
  * Custom naming pattern for generated query options names. The name variable is
10357
10813
  * obtained from the SDK function name.
10358
10814
  *
10359
10815
  * @default '{{name}}Options'
10360
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createQuery
10816
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery
10361
10817
  */
10362
10818
  name?: StringName;
10363
10819
  };
@@ -10385,7 +10841,7 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10385
10841
  /**
10386
10842
  * Resolved configuration for generated infinite query key helpers.
10387
10843
  *
10388
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery
10844
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
10389
10845
  */
10390
10846
  infiniteQueryKeys: {
10391
10847
  /**
@@ -10405,7 +10861,7 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10405
10861
  * obtained from the SDK function name.
10406
10862
  *
10407
10863
  * @default '{{name}}InfiniteQueryKey'
10408
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery
10864
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
10409
10865
  */
10410
10866
  name: StringName;
10411
10867
  /**
@@ -10419,7 +10875,7 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10419
10875
  /**
10420
10876
  * Resolved configuration for generated infinite query options helpers.
10421
10877
  *
10422
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery
10878
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
10423
10879
  */
10424
10880
  infiniteQueryOptions: {
10425
10881
  /**
@@ -10434,19 +10890,41 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10434
10890
  * @default true
10435
10891
  */
10436
10892
  enabled: boolean;
10893
+ /**
10894
+ * Custom function to generate metadata for the operation.
10895
+ * Can return any valid meta object that will be included in the generated infinite query options.
10896
+ * @param operation - The operation object containing all available metadata
10897
+ * @returns A meta object with any properties you want to include
10898
+ *
10899
+ * @example
10900
+ * ```typescript
10901
+ * meta: (operation) => ({
10902
+ * customField: operation.id,
10903
+ * isDeprecated: operation.deprecated,
10904
+ * tags: operation.tags,
10905
+ * customObject: {
10906
+ * method: operation.method,
10907
+ * path: operation.path
10908
+ * }
10909
+ * })
10910
+ * ```
10911
+ *
10912
+ * @default false
10913
+ */
10914
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10437
10915
  /**
10438
10916
  * Custom naming pattern for generated infinite query options names. The name variable is
10439
10917
  * obtained from the SDK function name.
10440
10918
  *
10441
10919
  * @default '{{name}}InfiniteOptions'
10442
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createInfiniteQuery
10920
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
10443
10921
  */
10444
10922
  name: StringName;
10445
10923
  };
10446
10924
  /**
10447
10925
  * Resolved configuration for generated mutation options helpers.
10448
10926
  *
10449
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createMutation
10927
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation
10450
10928
  */
10451
10929
  mutationOptions: {
10452
10930
  /**
@@ -10461,12 +10939,34 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10461
10939
  * @default true
10462
10940
  */
10463
10941
  enabled: boolean;
10942
+ /**
10943
+ * Custom function to generate metadata for the operation.
10944
+ * Can return any valid meta object that will be included in the generated mutation options.
10945
+ * @param operation - The operation object containing all available metadata
10946
+ * @returns A meta object with any properties you want to include
10947
+ *
10948
+ * @example
10949
+ * ```typescript
10950
+ * meta: (operation) => ({
10951
+ * customField: operation.id,
10952
+ * isDeprecated: operation.deprecated,
10953
+ * tags: operation.tags,
10954
+ * customObject: {
10955
+ * method: operation.method,
10956
+ * path: operation.path
10957
+ * }
10958
+ * })
10959
+ * ```
10960
+ *
10961
+ * @default false
10962
+ */
10963
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10464
10964
  /**
10465
10965
  * Custom naming pattern for generated mutation options names. The name variable is
10466
10966
  * obtained from the SDK function name.
10467
10967
  *
10468
10968
  * @default '{{name}}Mutation'
10469
- * @see https://tanstack.com/query/v5/docs/framework/solid/reference/createMutation
10969
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation
10470
10970
  */
10471
10971
  name: StringName;
10472
10972
  };
@@ -10479,7 +10979,7 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10479
10979
  /**
10480
10980
  * Resolved configuration for generated query keys.
10481
10981
  *
10482
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/queryKey
10982
+ * @see https://tanstack.com/query/v5/docs/framework/react/guides/query-keys
10483
10983
  */
10484
10984
  queryKeys: {
10485
10985
  /**
@@ -10499,7 +10999,7 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10499
10999
  * obtained from the SDK function name.
10500
11000
  *
10501
11001
  * @default '{{name}}QueryKey'
10502
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/queryKey
11002
+ * @see https://tanstack.com/query/v5/docs/framework/react/guides/query-keys
10503
11003
  */
10504
11004
  name: StringName;
10505
11005
  /**
@@ -10513,7 +11013,7 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10513
11013
  /**
10514
11014
  * Resolved configuration for generated query options helpers.
10515
11015
  *
10516
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createQuery
11016
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery
10517
11017
  */
10518
11018
  queryOptions: {
10519
11019
  /**
@@ -10528,12 +11028,34 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> & {
10528
11028
  * @default true
10529
11029
  */
10530
11030
  enabled: boolean;
11031
+ /**
11032
+ * Custom function to generate metadata for the operation.
11033
+ * Can return any valid meta object that will be included in the generated query options.
11034
+ * @param operation - The operation object containing all available metadata
11035
+ * @returns A meta object with any properties you want to include
11036
+ *
11037
+ * @example
11038
+ * ```typescript
11039
+ * meta: (operation) => ({
11040
+ * customField: operation.id,
11041
+ * isDeprecated: operation.deprecated,
11042
+ * tags: operation.tags,
11043
+ * customObject: {
11044
+ * method: operation.method,
11045
+ * path: operation.path
11046
+ * }
11047
+ * })
11048
+ * ```
11049
+ *
11050
+ * @default false
11051
+ */
11052
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10531
11053
  /**
10532
11054
  * Custom naming pattern for generated query options names. The name variable is
10533
11055
  * obtained from the SDK function name.
10534
11056
  *
10535
11057
  * @default '{{name}}Options'
10536
- * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/createQuery
11058
+ * @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery
10537
11059
  */
10538
11060
  name: StringName;
10539
11061
  };
@@ -10632,6 +11154,27 @@ type UserConfig$3 = Plugin.Name<'@tanstack/vue-query'> & {
10632
11154
  * @default true
10633
11155
  */
10634
11156
  enabled?: boolean;
11157
+ /**
11158
+ * Custom function to generate metadata for the operation.
11159
+ * Can return any valid meta object that will be included in the generated infinite query options.
11160
+ *
11161
+ * @param operation - The operation object containing all available metadata
11162
+ * @returns A meta object with any properties you want to include
11163
+ *
11164
+ * @example
11165
+ * ```typescript
11166
+ * meta: (operation) => ({
11167
+ * customField: operation.id,
11168
+ * isDeprecated: operation.deprecated,
11169
+ * tags: operation.tags,
11170
+ * customObject: {
11171
+ * method: operation.method,
11172
+ * path: operation.path
11173
+ * }
11174
+ * })
11175
+ * ```
11176
+ */
11177
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10635
11178
  /**
10636
11179
  * Custom naming pattern for generated infinite query options names. The name variable is
10637
11180
  * obtained from the SDK function name.
@@ -10669,6 +11212,27 @@ type UserConfig$3 = Plugin.Name<'@tanstack/vue-query'> & {
10669
11212
  * @default true
10670
11213
  */
10671
11214
  enabled?: boolean;
11215
+ /**
11216
+ * Custom function to generate metadata for the operation.
11217
+ * Can return any valid meta object that will be included in the generated mutation options.
11218
+ *
11219
+ * @param operation - The operation object containing all available metadata
11220
+ * @returns A meta object with any properties you want to include
11221
+ *
11222
+ * @example
11223
+ * ```typescript
11224
+ * meta: (operation) => ({
11225
+ * customField: operation.id,
11226
+ * isDeprecated: operation.deprecated,
11227
+ * tags: operation.tags,
11228
+ * customObject: {
11229
+ * method: operation.method,
11230
+ * path: operation.path
11231
+ * }
11232
+ * })
11233
+ * ```
11234
+ */
11235
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10672
11236
  /**
10673
11237
  * Custom naming pattern for generated mutation options names. The name variable is
10674
11238
  * obtained from the SDK function name.
@@ -10756,6 +11320,27 @@ type UserConfig$3 = Plugin.Name<'@tanstack/vue-query'> & {
10756
11320
  * @default true
10757
11321
  */
10758
11322
  enabled?: boolean;
11323
+ /**
11324
+ * Custom function to generate metadata for the operation.
11325
+ * Can return any valid meta object that will be included in the generated query options.
11326
+ *
11327
+ * @param operation - The operation object containing all available metadata
11328
+ * @returns A meta object with any properties you want to include
11329
+ *
11330
+ * @example
11331
+ * ```typescript
11332
+ * meta: (operation) => ({
11333
+ * customField: operation.id,
11334
+ * isDeprecated: operation.deprecated,
11335
+ * tags: operation.tags,
11336
+ * customObject: {
11337
+ * method: operation.method,
11338
+ * path: operation.path
11339
+ * }
11340
+ * })
11341
+ * ```
11342
+ */
11343
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10759
11344
  /**
10760
11345
  * Custom naming pattern for generated query options names. The name variable is
10761
11346
  * obtained from the SDK function name.
@@ -10838,6 +11423,27 @@ type Config$2 = Plugin.Name<'@tanstack/vue-query'> & {
10838
11423
  * @default true
10839
11424
  */
10840
11425
  enabled: boolean;
11426
+ /**
11427
+ * Custom function to generate metadata for the operation.
11428
+ * Can return any valid meta object that will be included in the generated infinite query options.
11429
+ *
11430
+ * @param operation - The operation object containing all available metadata
11431
+ * @returns A meta object with any properties you want to include
11432
+ *
11433
+ * @example
11434
+ * ```typescript
11435
+ * meta: (operation) => ({
11436
+ * customField: operation.id,
11437
+ * isDeprecated: operation.deprecated,
11438
+ * tags: operation.tags,
11439
+ * customObject: {
11440
+ * method: operation.method,
11441
+ * path: operation.path
11442
+ * }
11443
+ * })
11444
+ * ```
11445
+ */
11446
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10841
11447
  /**
10842
11448
  * Custom naming pattern for generated infinite query options names. The name variable is
10843
11449
  * obtained from the SDK function name.
@@ -10865,6 +11471,27 @@ type Config$2 = Plugin.Name<'@tanstack/vue-query'> & {
10865
11471
  * @default true
10866
11472
  */
10867
11473
  enabled: boolean;
11474
+ /**
11475
+ * Custom function to generate metadata for the operation.
11476
+ * Can return any valid meta object that will be included in the generated mutation options.
11477
+ *
11478
+ * @param operation - The operation object containing all available metadata
11479
+ * @returns A meta object with any properties you want to include
11480
+ *
11481
+ * @example
11482
+ * ```typescript
11483
+ * meta: (operation) => ({
11484
+ * customField: operation.id,
11485
+ * isDeprecated: operation.deprecated,
11486
+ * tags: operation.tags,
11487
+ * customObject: {
11488
+ * method: operation.method,
11489
+ * path: operation.path
11490
+ * }
11491
+ * })
11492
+ * ```
11493
+ */
11494
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10868
11495
  /**
10869
11496
  * Custom naming pattern for generated mutation options names. The name variable is
10870
11497
  * obtained from the SDK function name.
@@ -10932,6 +11559,27 @@ type Config$2 = Plugin.Name<'@tanstack/vue-query'> & {
10932
11559
  * @default true
10933
11560
  */
10934
11561
  enabled: boolean;
11562
+ /**
11563
+ * Custom function to generate metadata for the operation.
11564
+ * Can return any valid meta object that will be included in the generated query options.
11565
+ *
11566
+ * @param operation - The operation object containing all available metadata
11567
+ * @returns A meta object with any properties you want to include
11568
+ *
11569
+ * @example
11570
+ * ```typescript
11571
+ * meta: (operation) => ({
11572
+ * customField: operation.id,
11573
+ * isDeprecated: operation.deprecated,
11574
+ * tags: operation.tags,
11575
+ * customObject: {
11576
+ * method: operation.method,
11577
+ * path: operation.path
11578
+ * }
11579
+ * })
11580
+ * ```
11581
+ */
11582
+ meta?: false | ((operation: IR.OperationObject) => Record<string, any>);
10935
11583
  /**
10936
11584
  * Custom naming pattern for generated query options names. The name variable is
10937
11585
  * obtained from the SDK function name.