@uniformdev/canvas 19.112.1-alpha.2 → 19.114.0

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 (6) hide show
  1. package/dist/index.d.mts +54 -401
  2. package/dist/index.d.ts +54 -401
  3. package/dist/index.esm.js +9 -2
  4. package/dist/index.js +9 -2
  5. package/dist/index.mjs +9 -2
  6. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -3031,11 +3031,9 @@ interface paths$b {
3031
3031
  */
3032
3032
  orderBy?: components$4["parameters"]["orderBy"];
3033
3033
  /**
3034
- * Matches compositions based on whether they are a pattern composition or a regular composition.
3035
- * If true, only pattern compositions will be returned.
3036
- * If false, only regular compositions will be returned.
3037
- * If omitted, both pattern and regular compositions will be returned.
3038
- * This is a list query parameter, and cannot be used with any primary query parameters.
3034
+ * Matches entries based on whether they are pattern entries or a regular entries.
3035
+ * If true, only pattern entries will be returned.
3036
+ * If false (default), only regular entries will be returned.
3039
3037
  */
3040
3038
  pattern?: components$4["parameters"]["pattern"];
3041
3039
  /** The project the entry/entries are on. */
@@ -3096,97 +3094,11 @@ interface paths$b {
3096
3094
  */
3097
3095
  locale?: components$4["parameters"]["locale"];
3098
3096
  /**
3099
- * @deprecated Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
3100
- * It works with textual and rich text fields.
3101
- * Example: ?filterMatch=fields.title:hello
3102
- *
3103
- * Multiple filters can be provided by repeating the parameter.
3104
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
3105
- */
3106
- filterMatch?: components$4["parameters"]["filterMatch"];
3107
- /**
3108
- * @deprecated Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
3109
- * It works with textual, numerical, boolean and date fields.
3110
- * Example: ?filterEq=fields.count:123
3111
- *
3112
- * Multiple filters can be provided by repeating the parameter.
3113
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
3114
- */
3115
- filterEq?: components$4["parameters"]["filterEq"];
3116
- /**
3117
- * @deprecated Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
3118
- * It works with textual, numerical, boolean and date fields.
3119
- * Example: ?filterNeq=fields.count:0
3120
- *
3121
- * Multiple filters can be provided by repeating the parameter.
3122
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
3123
- */
3124
- filterNeq?: components$4["parameters"]["filterNeq"];
3125
- /**
3126
- * @deprecated Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
3127
- * for a specified field. It works with numerical and date fields.
3128
- * Example: ?filterLt=fields.releaseDate:2024-01-01
3129
- *
3130
- * Multiple filters can be provided by repeating the parameter.
3131
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
3132
- */
3133
- filterLt?: components$4["parameters"]["filterLt"];
3134
- /**
3135
- * @deprecated Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
3136
- * for a specified field. It works with numerical and date fields.
3137
- * Example: ?filterLte=fields.releaseDate:2024-01-01
3138
- *
3139
- * Multiple filters can be provided by repeating the parameter.
3140
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
3097
+ * @deprecated Search on textual fields of an entry.
3098
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
3099
+ * Example: ?search=hello
3141
3100
  */
3142
- filterLte?: components$4["parameters"]["filterLte"];
3143
- /**
3144
- * @deprecated Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
3145
- * for a specified field. It works with numerical and date fields.
3146
- * Example: ?filterGt=fields.releaseDate:2024-01-01
3147
- *
3148
- * Multiple filters can be provided by repeating the parameter.
3149
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
3150
- */
3151
- filterGt?: components$4["parameters"]["filterGt"];
3152
- /**
3153
- * @deprecated Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
3154
- * for a specified field. It works with numerical and date fields.
3155
- * Example: ?filterGte=fields.releaseDate:2024-01-01
3156
- *
3157
- * Multiple filters can be provided by repeating the parameter.
3158
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
3159
- */
3160
- filterGte?: components$4["parameters"]["filterGte"];
3161
- /**
3162
- * @deprecated Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
3163
- * for a specified field. It works with textual, numerical, boolean and date fields.
3164
- * Array values are provided by repeating the parameter with the same field name.
3165
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
3166
- */
3167
- filterIn?: components$4["parameters"]["filterIn"];
3168
- /**
3169
- * @deprecated Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
3170
- * for a specified field. It works with textual, numerical, boolean and date fields.
3171
- * Array values are provided by repeating the parameter with the same field name.
3172
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
3173
- */
3174
- filterNin?: components$4["parameters"]["filterNin"];
3175
- /**
3176
- * @deprecated Filters list of entries so it only includes entries with a specified field defined
3177
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
3178
- * It works with all field types
3179
- * Example: ?filterDef=fields.title:true
3180
- *
3181
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
3182
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
3183
- */
3184
- filterDef?: components$4["parameters"]["filterDef"];
3185
- /**
3186
- * @deprecated Performs full text search on the entries.
3187
- * Example: ?ftsQuery=hello
3188
- */
3189
- ftsQuery?: components$4["parameters"]["ftsQuery"];
3101
+ search?: components$4["parameters"]["search"];
3190
3102
  };
3191
3103
  };
3192
3104
  responses: {
@@ -3518,11 +3430,9 @@ interface components$4 {
3518
3430
  */
3519
3431
  skipParameterResolution: boolean;
3520
3432
  /**
3521
- * @description Matches compositions based on whether they are a pattern composition or a regular composition.
3522
- * If true, only pattern compositions will be returned.
3523
- * If false, only regular compositions will be returned.
3524
- * If omitted, both pattern and regular compositions will be returned.
3525
- * This is a list query parameter, and cannot be used with any primary query parameters.
3433
+ * @description Matches entries based on whether they are pattern entries or a regular entries.
3434
+ * If true, only pattern entries will be returned.
3435
+ * If false (default), only regular entries will be returned.
3526
3436
  */
3527
3437
  pattern: boolean;
3528
3438
  /**
@@ -3540,107 +3450,11 @@ interface components$4 {
3540
3450
  locale: string;
3541
3451
  /**
3542
3452
  * @deprecated
3543
- * @description Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
3544
- * It works with textual and rich text fields.
3545
- * Example: ?filterMatch=fields.title:hello
3546
- *
3547
- * Multiple filters can be provided by repeating the parameter.
3548
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
3453
+ * @description Search on textual fields of an entry.
3454
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
3455
+ * Example: ?search=hello
3549
3456
  */
3550
- filterMatch: string[];
3551
- /**
3552
- * @deprecated
3553
- * @description Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
3554
- * It works with textual, numerical, boolean and date fields.
3555
- * Example: ?filterEq=fields.count:123
3556
- *
3557
- * Multiple filters can be provided by repeating the parameter.
3558
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
3559
- */
3560
- filterEq: string[];
3561
- /**
3562
- * @deprecated
3563
- * @description Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
3564
- * It works with textual, numerical, boolean and date fields.
3565
- * Example: ?filterNeq=fields.count:0
3566
- *
3567
- * Multiple filters can be provided by repeating the parameter.
3568
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
3569
- */
3570
- filterNeq: string[];
3571
- /**
3572
- * @deprecated
3573
- * @description Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
3574
- * for a specified field. It works with numerical and date fields.
3575
- * Example: ?filterLt=fields.releaseDate:2024-01-01
3576
- *
3577
- * Multiple filters can be provided by repeating the parameter.
3578
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
3579
- */
3580
- filterLt: string[];
3581
- /**
3582
- * @deprecated
3583
- * @description Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
3584
- * for a specified field. It works with numerical and date fields.
3585
- * Example: ?filterLte=fields.releaseDate:2024-01-01
3586
- *
3587
- * Multiple filters can be provided by repeating the parameter.
3588
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
3589
- */
3590
- filterLte: string[];
3591
- /**
3592
- * @deprecated
3593
- * @description Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
3594
- * for a specified field. It works with numerical and date fields.
3595
- * Example: ?filterGt=fields.releaseDate:2024-01-01
3596
- *
3597
- * Multiple filters can be provided by repeating the parameter.
3598
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
3599
- */
3600
- filterGt: string[];
3601
- /**
3602
- * @deprecated
3603
- * @description Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
3604
- * for a specified field. It works with numerical and date fields.
3605
- * Example: ?filterGte=fields.releaseDate:2024-01-01
3606
- *
3607
- * Multiple filters can be provided by repeating the parameter.
3608
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
3609
- */
3610
- filterGte: string[];
3611
- /**
3612
- * @deprecated
3613
- * @description Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
3614
- * for a specified field. It works with textual, numerical, boolean and date fields.
3615
- * Array values are provided by repeating the parameter with the same field name.
3616
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
3617
- */
3618
- filterIn: string[];
3619
- /**
3620
- * @deprecated
3621
- * @description Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
3622
- * for a specified field. It works with textual, numerical, boolean and date fields.
3623
- * Array values are provided by repeating the parameter with the same field name.
3624
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
3625
- */
3626
- filterNin: string[];
3627
- /**
3628
- * @deprecated
3629
- * @description Filters list of entries so it only includes entries with a specified field defined
3630
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
3631
- * It works with all field types
3632
- * Example: ?filterDef=fields.title:true
3633
- *
3634
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
3635
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
3636
- */
3637
- filterDef: string[];
3638
- /**
3639
- * @deprecated
3640
- * @description Performs full text search on the entries.
3641
- * Example: ?ftsQuery=hello
3642
- */
3643
- ftsQuery: string;
3457
+ search: string;
3644
3458
  };
3645
3459
  }
3646
3460
  interface external$c {
@@ -11388,11 +11202,9 @@ interface external$3 {
11388
11202
  */
11389
11203
  orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
11390
11204
  /**
11391
- * Matches compositions based on whether they are a pattern composition or a regular composition.
11392
- * If true, only pattern compositions will be returned.
11393
- * If false, only regular compositions will be returned.
11394
- * If omitted, both pattern and regular compositions will be returned.
11395
- * This is a list query parameter, and cannot be used with any primary query parameters.
11205
+ * Matches entries based on whether they are pattern entries or a regular entries.
11206
+ * If true, only pattern entries will be returned.
11207
+ * If false (default), only regular entries will be returned.
11396
11208
  */
11397
11209
  pattern?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["pattern"];
11398
11210
  /** The project the entry/entries are on. */
@@ -11453,97 +11265,11 @@ interface external$3 {
11453
11265
  */
11454
11266
  locale?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["locale"];
11455
11267
  /**
11456
- * @deprecated Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11457
- * It works with textual and rich text fields.
11458
- * Example: ?filterMatch=fields.title:hello
11459
- *
11460
- * Multiple filters can be provided by repeating the parameter.
11461
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11462
- */
11463
- filterMatch?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterMatch"];
11464
- /**
11465
- * @deprecated Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11466
- * It works with textual, numerical, boolean and date fields.
11467
- * Example: ?filterEq=fields.count:123
11468
- *
11469
- * Multiple filters can be provided by repeating the parameter.
11470
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11471
- */
11472
- filterEq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterEq"];
11473
- /**
11474
- * @deprecated Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
11475
- * It works with textual, numerical, boolean and date fields.
11476
- * Example: ?filterNeq=fields.count:0
11477
- *
11478
- * Multiple filters can be provided by repeating the parameter.
11479
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11480
- */
11481
- filterNeq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNeq"];
11482
- /**
11483
- * @deprecated Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
11484
- * for a specified field. It works with numerical and date fields.
11485
- * Example: ?filterLt=fields.releaseDate:2024-01-01
11486
- *
11487
- * Multiple filters can be provided by repeating the parameter.
11488
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11489
- */
11490
- filterLt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLt"];
11491
- /**
11492
- * @deprecated Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
11493
- * for a specified field. It works with numerical and date fields.
11494
- * Example: ?filterLte=fields.releaseDate:2024-01-01
11495
- *
11496
- * Multiple filters can be provided by repeating the parameter.
11497
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11498
- */
11499
- filterLte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLte"];
11500
- /**
11501
- * @deprecated Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
11502
- * for a specified field. It works with numerical and date fields.
11503
- * Example: ?filterGt=fields.releaseDate:2024-01-01
11504
- *
11505
- * Multiple filters can be provided by repeating the parameter.
11506
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11507
- */
11508
- filterGt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGt"];
11509
- /**
11510
- * @deprecated Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
11511
- * for a specified field. It works with numerical and date fields.
11512
- * Example: ?filterGte=fields.releaseDate:2024-01-01
11513
- *
11514
- * Multiple filters can be provided by repeating the parameter.
11515
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11516
- */
11517
- filterGte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGte"];
11518
- /**
11519
- * @deprecated Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
11520
- * for a specified field. It works with textual, numerical, boolean and date fields.
11521
- * Array values are provided by repeating the parameter with the same field name.
11522
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11523
- */
11524
- filterIn?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterIn"];
11525
- /**
11526
- * @deprecated Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
11527
- * for a specified field. It works with textual, numerical, boolean and date fields.
11528
- * Array values are provided by repeating the parameter with the same field name.
11529
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
11268
+ * @deprecated Search on textual fields of an entry.
11269
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
11270
+ * Example: ?search=hello
11530
11271
  */
11531
- filterNin?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNin"];
11532
- /**
11533
- * @deprecated Filters list of entries so it only includes entries with a specified field defined
11534
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11535
- * It works with all field types
11536
- * Example: ?filterDef=fields.title:true
11537
- *
11538
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11539
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11540
- */
11541
- filterDef?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterDef"];
11542
- /**
11543
- * @deprecated Performs full text search on the entries.
11544
- * Example: ?ftsQuery=hello
11545
- */
11546
- ftsQuery?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["ftsQuery"];
11272
+ search?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["search"];
11547
11273
  };
11548
11274
  };
11549
11275
  responses: {
@@ -11875,11 +11601,9 @@ interface external$3 {
11875
11601
  */
11876
11602
  skipParameterResolution: boolean;
11877
11603
  /**
11878
- * @description Matches compositions based on whether they are a pattern composition or a regular composition.
11879
- * If true, only pattern compositions will be returned.
11880
- * If false, only regular compositions will be returned.
11881
- * If omitted, both pattern and regular compositions will be returned.
11882
- * This is a list query parameter, and cannot be used with any primary query parameters.
11604
+ * @description Matches entries based on whether they are pattern entries or a regular entries.
11605
+ * If true, only pattern entries will be returned.
11606
+ * If false (default), only regular entries will be returned.
11883
11607
  */
11884
11608
  pattern: boolean;
11885
11609
  /**
@@ -11897,107 +11621,11 @@ interface external$3 {
11897
11621
  locale: string;
11898
11622
  /**
11899
11623
  * @deprecated
11900
- * @description Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11901
- * It works with textual and rich text fields.
11902
- * Example: ?filterMatch=fields.title:hello
11903
- *
11904
- * Multiple filters can be provided by repeating the parameter.
11905
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11906
- */
11907
- filterMatch: string[];
11908
- /**
11909
- * @deprecated
11910
- * @description Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11911
- * It works with textual, numerical, boolean and date fields.
11912
- * Example: ?filterEq=fields.count:123
11913
- *
11914
- * Multiple filters can be provided by repeating the parameter.
11915
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11916
- */
11917
- filterEq: string[];
11918
- /**
11919
- * @deprecated
11920
- * @description Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
11921
- * It works with textual, numerical, boolean and date fields.
11922
- * Example: ?filterNeq=fields.count:0
11923
- *
11924
- * Multiple filters can be provided by repeating the parameter.
11925
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11926
- */
11927
- filterNeq: string[];
11928
- /**
11929
- * @deprecated
11930
- * @description Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
11931
- * for a specified field. It works with numerical and date fields.
11932
- * Example: ?filterLt=fields.releaseDate:2024-01-01
11933
- *
11934
- * Multiple filters can be provided by repeating the parameter.
11935
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11936
- */
11937
- filterLt: string[];
11938
- /**
11939
- * @deprecated
11940
- * @description Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
11941
- * for a specified field. It works with numerical and date fields.
11942
- * Example: ?filterLte=fields.releaseDate:2024-01-01
11943
- *
11944
- * Multiple filters can be provided by repeating the parameter.
11945
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11946
- */
11947
- filterLte: string[];
11948
- /**
11949
- * @deprecated
11950
- * @description Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
11951
- * for a specified field. It works with numerical and date fields.
11952
- * Example: ?filterGt=fields.releaseDate:2024-01-01
11953
- *
11954
- * Multiple filters can be provided by repeating the parameter.
11955
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11956
- */
11957
- filterGt: string[];
11958
- /**
11959
- * @deprecated
11960
- * @description Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
11961
- * for a specified field. It works with numerical and date fields.
11962
- * Example: ?filterGte=fields.releaseDate:2024-01-01
11963
- *
11964
- * Multiple filters can be provided by repeating the parameter.
11965
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11624
+ * @description Search on textual fields of an entry.
11625
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
11626
+ * Example: ?search=hello
11966
11627
  */
11967
- filterGte: string[];
11968
- /**
11969
- * @deprecated
11970
- * @description Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
11971
- * for a specified field. It works with textual, numerical, boolean and date fields.
11972
- * Array values are provided by repeating the parameter with the same field name.
11973
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11974
- */
11975
- filterIn: string[];
11976
- /**
11977
- * @deprecated
11978
- * @description Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
11979
- * for a specified field. It works with textual, numerical, boolean and date fields.
11980
- * Array values are provided by repeating the parameter with the same field name.
11981
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
11982
- */
11983
- filterNin: string[];
11984
- /**
11985
- * @deprecated
11986
- * @description Filters list of entries so it only includes entries with a specified field defined
11987
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11988
- * It works with all field types
11989
- * Example: ?filterDef=fields.title:true
11990
- *
11991
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11992
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11993
- */
11994
- filterDef: string[];
11995
- /**
11996
- * @deprecated
11997
- * @description Performs full text search on the entries.
11998
- * Example: ?ftsQuery=hello
11999
- */
12000
- ftsQuery: string;
11628
+ search: string;
12001
11629
  };
12002
11630
  };
12003
11631
  operations: {};
@@ -14566,12 +14194,37 @@ type ContentClientOptions = ClientOptions & {
14566
14194
  edgeApiHost?: string;
14567
14195
  disableSWR?: boolean;
14568
14196
  };
14197
+ type FilterLhs = 'type' | 'locale' | 'uiStatus' | 'name' | 'slug' | 'creator' | 'author' | 'created' | 'modified' | `fields.${string}`;
14198
+ type FilterRhs = string | number | boolean | {
14199
+ match: string;
14200
+ } | {
14201
+ eq: string | number | boolean;
14202
+ } | {
14203
+ neq: string | number | boolean;
14204
+ } | {
14205
+ in: (string | number | boolean)[];
14206
+ } | {
14207
+ nin: (string | number | boolean)[];
14208
+ } | {
14209
+ gt: string | number;
14210
+ } | {
14211
+ gte: string | number;
14212
+ } | {
14213
+ lt: string | number;
14214
+ } | {
14215
+ lte: string | number;
14216
+ } | {
14217
+ def: boolean;
14218
+ };
14569
14219
  declare class ContentClient extends ApiClient<ContentClientOptions> {
14570
14220
  #private;
14571
14221
  private edgeApiHost;
14572
14222
  constructor(options: ContentClientOptions);
14573
14223
  getContentTypes(options?: ExceptProject<GetContentTypesOptions>): Promise<GetContentTypesResponse>;
14574
- getEntries(options: ExceptProject<GetEntriesOptions> & DataResolutionParameters & DataResolutionOption): Promise<GetEntriesResponse>;
14224
+ getEntries(options: ExceptProject<GetEntriesOptions> & DataResolutionParameters & DataResolutionOption & {
14225
+ /** @deprecated do not use */
14226
+ filters?: Partial<Record<FilterLhs, FilterRhs>>;
14227
+ }): Promise<GetEntriesResponse>;
14575
14228
  /** Fetches historical versions of an entry */
14576
14229
  getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
14577
14230
  cursor?: string | undefined;
package/dist/index.d.ts CHANGED
@@ -3031,11 +3031,9 @@ interface paths$b {
3031
3031
  */
3032
3032
  orderBy?: components$4["parameters"]["orderBy"];
3033
3033
  /**
3034
- * Matches compositions based on whether they are a pattern composition or a regular composition.
3035
- * If true, only pattern compositions will be returned.
3036
- * If false, only regular compositions will be returned.
3037
- * If omitted, both pattern and regular compositions will be returned.
3038
- * This is a list query parameter, and cannot be used with any primary query parameters.
3034
+ * Matches entries based on whether they are pattern entries or a regular entries.
3035
+ * If true, only pattern entries will be returned.
3036
+ * If false (default), only regular entries will be returned.
3039
3037
  */
3040
3038
  pattern?: components$4["parameters"]["pattern"];
3041
3039
  /** The project the entry/entries are on. */
@@ -3096,97 +3094,11 @@ interface paths$b {
3096
3094
  */
3097
3095
  locale?: components$4["parameters"]["locale"];
3098
3096
  /**
3099
- * @deprecated Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
3100
- * It works with textual and rich text fields.
3101
- * Example: ?filterMatch=fields.title:hello
3102
- *
3103
- * Multiple filters can be provided by repeating the parameter.
3104
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
3105
- */
3106
- filterMatch?: components$4["parameters"]["filterMatch"];
3107
- /**
3108
- * @deprecated Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
3109
- * It works with textual, numerical, boolean and date fields.
3110
- * Example: ?filterEq=fields.count:123
3111
- *
3112
- * Multiple filters can be provided by repeating the parameter.
3113
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
3114
- */
3115
- filterEq?: components$4["parameters"]["filterEq"];
3116
- /**
3117
- * @deprecated Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
3118
- * It works with textual, numerical, boolean and date fields.
3119
- * Example: ?filterNeq=fields.count:0
3120
- *
3121
- * Multiple filters can be provided by repeating the parameter.
3122
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
3123
- */
3124
- filterNeq?: components$4["parameters"]["filterNeq"];
3125
- /**
3126
- * @deprecated Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
3127
- * for a specified field. It works with numerical and date fields.
3128
- * Example: ?filterLt=fields.releaseDate:2024-01-01
3129
- *
3130
- * Multiple filters can be provided by repeating the parameter.
3131
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
3132
- */
3133
- filterLt?: components$4["parameters"]["filterLt"];
3134
- /**
3135
- * @deprecated Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
3136
- * for a specified field. It works with numerical and date fields.
3137
- * Example: ?filterLte=fields.releaseDate:2024-01-01
3138
- *
3139
- * Multiple filters can be provided by repeating the parameter.
3140
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
3097
+ * @deprecated Search on textual fields of an entry.
3098
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
3099
+ * Example: ?search=hello
3141
3100
  */
3142
- filterLte?: components$4["parameters"]["filterLte"];
3143
- /**
3144
- * @deprecated Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
3145
- * for a specified field. It works with numerical and date fields.
3146
- * Example: ?filterGt=fields.releaseDate:2024-01-01
3147
- *
3148
- * Multiple filters can be provided by repeating the parameter.
3149
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
3150
- */
3151
- filterGt?: components$4["parameters"]["filterGt"];
3152
- /**
3153
- * @deprecated Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
3154
- * for a specified field. It works with numerical and date fields.
3155
- * Example: ?filterGte=fields.releaseDate:2024-01-01
3156
- *
3157
- * Multiple filters can be provided by repeating the parameter.
3158
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
3159
- */
3160
- filterGte?: components$4["parameters"]["filterGte"];
3161
- /**
3162
- * @deprecated Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
3163
- * for a specified field. It works with textual, numerical, boolean and date fields.
3164
- * Array values are provided by repeating the parameter with the same field name.
3165
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
3166
- */
3167
- filterIn?: components$4["parameters"]["filterIn"];
3168
- /**
3169
- * @deprecated Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
3170
- * for a specified field. It works with textual, numerical, boolean and date fields.
3171
- * Array values are provided by repeating the parameter with the same field name.
3172
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
3173
- */
3174
- filterNin?: components$4["parameters"]["filterNin"];
3175
- /**
3176
- * @deprecated Filters list of entries so it only includes entries with a specified field defined
3177
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
3178
- * It works with all field types
3179
- * Example: ?filterDef=fields.title:true
3180
- *
3181
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
3182
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
3183
- */
3184
- filterDef?: components$4["parameters"]["filterDef"];
3185
- /**
3186
- * @deprecated Performs full text search on the entries.
3187
- * Example: ?ftsQuery=hello
3188
- */
3189
- ftsQuery?: components$4["parameters"]["ftsQuery"];
3101
+ search?: components$4["parameters"]["search"];
3190
3102
  };
3191
3103
  };
3192
3104
  responses: {
@@ -3518,11 +3430,9 @@ interface components$4 {
3518
3430
  */
3519
3431
  skipParameterResolution: boolean;
3520
3432
  /**
3521
- * @description Matches compositions based on whether they are a pattern composition or a regular composition.
3522
- * If true, only pattern compositions will be returned.
3523
- * If false, only regular compositions will be returned.
3524
- * If omitted, both pattern and regular compositions will be returned.
3525
- * This is a list query parameter, and cannot be used with any primary query parameters.
3433
+ * @description Matches entries based on whether they are pattern entries or a regular entries.
3434
+ * If true, only pattern entries will be returned.
3435
+ * If false (default), only regular entries will be returned.
3526
3436
  */
3527
3437
  pattern: boolean;
3528
3438
  /**
@@ -3540,107 +3450,11 @@ interface components$4 {
3540
3450
  locale: string;
3541
3451
  /**
3542
3452
  * @deprecated
3543
- * @description Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
3544
- * It works with textual and rich text fields.
3545
- * Example: ?filterMatch=fields.title:hello
3546
- *
3547
- * Multiple filters can be provided by repeating the parameter.
3548
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
3453
+ * @description Search on textual fields of an entry.
3454
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
3455
+ * Example: ?search=hello
3549
3456
  */
3550
- filterMatch: string[];
3551
- /**
3552
- * @deprecated
3553
- * @description Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
3554
- * It works with textual, numerical, boolean and date fields.
3555
- * Example: ?filterEq=fields.count:123
3556
- *
3557
- * Multiple filters can be provided by repeating the parameter.
3558
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
3559
- */
3560
- filterEq: string[];
3561
- /**
3562
- * @deprecated
3563
- * @description Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
3564
- * It works with textual, numerical, boolean and date fields.
3565
- * Example: ?filterNeq=fields.count:0
3566
- *
3567
- * Multiple filters can be provided by repeating the parameter.
3568
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
3569
- */
3570
- filterNeq: string[];
3571
- /**
3572
- * @deprecated
3573
- * @description Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
3574
- * for a specified field. It works with numerical and date fields.
3575
- * Example: ?filterLt=fields.releaseDate:2024-01-01
3576
- *
3577
- * Multiple filters can be provided by repeating the parameter.
3578
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
3579
- */
3580
- filterLt: string[];
3581
- /**
3582
- * @deprecated
3583
- * @description Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
3584
- * for a specified field. It works with numerical and date fields.
3585
- * Example: ?filterLte=fields.releaseDate:2024-01-01
3586
- *
3587
- * Multiple filters can be provided by repeating the parameter.
3588
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
3589
- */
3590
- filterLte: string[];
3591
- /**
3592
- * @deprecated
3593
- * @description Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
3594
- * for a specified field. It works with numerical and date fields.
3595
- * Example: ?filterGt=fields.releaseDate:2024-01-01
3596
- *
3597
- * Multiple filters can be provided by repeating the parameter.
3598
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
3599
- */
3600
- filterGt: string[];
3601
- /**
3602
- * @deprecated
3603
- * @description Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
3604
- * for a specified field. It works with numerical and date fields.
3605
- * Example: ?filterGte=fields.releaseDate:2024-01-01
3606
- *
3607
- * Multiple filters can be provided by repeating the parameter.
3608
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
3609
- */
3610
- filterGte: string[];
3611
- /**
3612
- * @deprecated
3613
- * @description Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
3614
- * for a specified field. It works with textual, numerical, boolean and date fields.
3615
- * Array values are provided by repeating the parameter with the same field name.
3616
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
3617
- */
3618
- filterIn: string[];
3619
- /**
3620
- * @deprecated
3621
- * @description Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
3622
- * for a specified field. It works with textual, numerical, boolean and date fields.
3623
- * Array values are provided by repeating the parameter with the same field name.
3624
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
3625
- */
3626
- filterNin: string[];
3627
- /**
3628
- * @deprecated
3629
- * @description Filters list of entries so it only includes entries with a specified field defined
3630
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
3631
- * It works with all field types
3632
- * Example: ?filterDef=fields.title:true
3633
- *
3634
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
3635
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
3636
- */
3637
- filterDef: string[];
3638
- /**
3639
- * @deprecated
3640
- * @description Performs full text search on the entries.
3641
- * Example: ?ftsQuery=hello
3642
- */
3643
- ftsQuery: string;
3457
+ search: string;
3644
3458
  };
3645
3459
  }
3646
3460
  interface external$c {
@@ -11388,11 +11202,9 @@ interface external$3 {
11388
11202
  */
11389
11203
  orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
11390
11204
  /**
11391
- * Matches compositions based on whether they are a pattern composition or a regular composition.
11392
- * If true, only pattern compositions will be returned.
11393
- * If false, only regular compositions will be returned.
11394
- * If omitted, both pattern and regular compositions will be returned.
11395
- * This is a list query parameter, and cannot be used with any primary query parameters.
11205
+ * Matches entries based on whether they are pattern entries or a regular entries.
11206
+ * If true, only pattern entries will be returned.
11207
+ * If false (default), only regular entries will be returned.
11396
11208
  */
11397
11209
  pattern?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["pattern"];
11398
11210
  /** The project the entry/entries are on. */
@@ -11453,97 +11265,11 @@ interface external$3 {
11453
11265
  */
11454
11266
  locale?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["locale"];
11455
11267
  /**
11456
- * @deprecated Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11457
- * It works with textual and rich text fields.
11458
- * Example: ?filterMatch=fields.title:hello
11459
- *
11460
- * Multiple filters can be provided by repeating the parameter.
11461
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11462
- */
11463
- filterMatch?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterMatch"];
11464
- /**
11465
- * @deprecated Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11466
- * It works with textual, numerical, boolean and date fields.
11467
- * Example: ?filterEq=fields.count:123
11468
- *
11469
- * Multiple filters can be provided by repeating the parameter.
11470
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11471
- */
11472
- filterEq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterEq"];
11473
- /**
11474
- * @deprecated Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
11475
- * It works with textual, numerical, boolean and date fields.
11476
- * Example: ?filterNeq=fields.count:0
11477
- *
11478
- * Multiple filters can be provided by repeating the parameter.
11479
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11480
- */
11481
- filterNeq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNeq"];
11482
- /**
11483
- * @deprecated Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
11484
- * for a specified field. It works with numerical and date fields.
11485
- * Example: ?filterLt=fields.releaseDate:2024-01-01
11486
- *
11487
- * Multiple filters can be provided by repeating the parameter.
11488
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11489
- */
11490
- filterLt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLt"];
11491
- /**
11492
- * @deprecated Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
11493
- * for a specified field. It works with numerical and date fields.
11494
- * Example: ?filterLte=fields.releaseDate:2024-01-01
11495
- *
11496
- * Multiple filters can be provided by repeating the parameter.
11497
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11498
- */
11499
- filterLte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLte"];
11500
- /**
11501
- * @deprecated Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
11502
- * for a specified field. It works with numerical and date fields.
11503
- * Example: ?filterGt=fields.releaseDate:2024-01-01
11504
- *
11505
- * Multiple filters can be provided by repeating the parameter.
11506
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11507
- */
11508
- filterGt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGt"];
11509
- /**
11510
- * @deprecated Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
11511
- * for a specified field. It works with numerical and date fields.
11512
- * Example: ?filterGte=fields.releaseDate:2024-01-01
11513
- *
11514
- * Multiple filters can be provided by repeating the parameter.
11515
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11516
- */
11517
- filterGte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGte"];
11518
- /**
11519
- * @deprecated Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
11520
- * for a specified field. It works with textual, numerical, boolean and date fields.
11521
- * Array values are provided by repeating the parameter with the same field name.
11522
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11523
- */
11524
- filterIn?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterIn"];
11525
- /**
11526
- * @deprecated Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
11527
- * for a specified field. It works with textual, numerical, boolean and date fields.
11528
- * Array values are provided by repeating the parameter with the same field name.
11529
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
11268
+ * @deprecated Search on textual fields of an entry.
11269
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
11270
+ * Example: ?search=hello
11530
11271
  */
11531
- filterNin?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNin"];
11532
- /**
11533
- * @deprecated Filters list of entries so it only includes entries with a specified field defined
11534
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11535
- * It works with all field types
11536
- * Example: ?filterDef=fields.title:true
11537
- *
11538
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11539
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11540
- */
11541
- filterDef?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterDef"];
11542
- /**
11543
- * @deprecated Performs full text search on the entries.
11544
- * Example: ?ftsQuery=hello
11545
- */
11546
- ftsQuery?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["ftsQuery"];
11272
+ search?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["search"];
11547
11273
  };
11548
11274
  };
11549
11275
  responses: {
@@ -11875,11 +11601,9 @@ interface external$3 {
11875
11601
  */
11876
11602
  skipParameterResolution: boolean;
11877
11603
  /**
11878
- * @description Matches compositions based on whether they are a pattern composition or a regular composition.
11879
- * If true, only pattern compositions will be returned.
11880
- * If false, only regular compositions will be returned.
11881
- * If omitted, both pattern and regular compositions will be returned.
11882
- * This is a list query parameter, and cannot be used with any primary query parameters.
11604
+ * @description Matches entries based on whether they are pattern entries or a regular entries.
11605
+ * If true, only pattern entries will be returned.
11606
+ * If false (default), only regular entries will be returned.
11883
11607
  */
11884
11608
  pattern: boolean;
11885
11609
  /**
@@ -11897,107 +11621,11 @@ interface external$3 {
11897
11621
  locale: string;
11898
11622
  /**
11899
11623
  * @deprecated
11900
- * @description Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11901
- * It works with textual and rich text fields.
11902
- * Example: ?filterMatch=fields.title:hello
11903
- *
11904
- * Multiple filters can be provided by repeating the parameter.
11905
- * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11906
- */
11907
- filterMatch: string[];
11908
- /**
11909
- * @deprecated
11910
- * @description Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11911
- * It works with textual, numerical, boolean and date fields.
11912
- * Example: ?filterEq=fields.count:123
11913
- *
11914
- * Multiple filters can be provided by repeating the parameter.
11915
- * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11916
- */
11917
- filterEq: string[];
11918
- /**
11919
- * @deprecated
11920
- * @description Filters list of entries by negation of strict equality (e.g. 1, 2, 3 and so on are not equal to 0) of a specified field.
11921
- * It works with textual, numerical, boolean and date fields.
11922
- * Example: ?filterNeq=fields.count:0
11923
- *
11924
- * Multiple filters can be provided by repeating the parameter.
11925
- * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11926
- */
11927
- filterNeq: string[];
11928
- /**
11929
- * @deprecated
11930
- * @description Filters list of entries so it includes only entries with values that are lower than (e.g. 1, 2, 3 are less than 4)
11931
- * for a specified field. It works with numerical and date fields.
11932
- * Example: ?filterLt=fields.releaseDate:2024-01-01
11933
- *
11934
- * Multiple filters can be provided by repeating the parameter.
11935
- * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11936
- */
11937
- filterLt: string[];
11938
- /**
11939
- * @deprecated
11940
- * @description Filters list of entries so it includes only entries with values that are lower than or equal to (e.g. 1, 2, 3 and 4 are less than or equal to 4)
11941
- * for a specified field. It works with numerical and date fields.
11942
- * Example: ?filterLte=fields.releaseDate:2024-01-01
11943
- *
11944
- * Multiple filters can be provided by repeating the parameter.
11945
- * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11946
- */
11947
- filterLte: string[];
11948
- /**
11949
- * @deprecated
11950
- * @description Filters list of entries so it includes only entries with values that are greater than (e.g. 4 is greater than 1, 2, 3)
11951
- * for a specified field. It works with numerical and date fields.
11952
- * Example: ?filterGt=fields.releaseDate:2024-01-01
11953
- *
11954
- * Multiple filters can be provided by repeating the parameter.
11955
- * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11956
- */
11957
- filterGt: string[];
11958
- /**
11959
- * @deprecated
11960
- * @description Filters list of entries so it includes only entries with values that are greater than or equal to (e.g. 4 and 5 are greater than or equal to 4)
11961
- * for a specified field. It works with numerical and date fields.
11962
- * Example: ?filterGte=fields.releaseDate:2024-01-01
11963
- *
11964
- * Multiple filters can be provided by repeating the parameter.
11965
- * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11624
+ * @description Search on textual fields of an entry.
11625
+ * Note: for long text fields the tail of the text is not guaranteed to be searchable.
11626
+ * Example: ?search=hello
11966
11627
  */
11967
- filterGte: string[];
11968
- /**
11969
- * @deprecated
11970
- * @description Filters list of entries so it includes only values that are in a specified array (e.g. 1 is in [1, 2, 3, 4])
11971
- * for a specified field. It works with textual, numerical, boolean and date fields.
11972
- * Array values are provided by repeating the parameter with the same field name.
11973
- * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11974
- */
11975
- filterIn: string[];
11976
- /**
11977
- * @deprecated
11978
- * @description Filters list of entries so it includes only values that are not in a specified array (e.g. 5 is not in [1, 2, 3, 4])
11979
- * for a specified field. It works with textual, numerical, boolean and date fields.
11980
- * Array values are provided by repeating the parameter with the same field name.
11981
- * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
11982
- */
11983
- filterNin: string[];
11984
- /**
11985
- * @deprecated
11986
- * @description Filters list of entries so it only includes entries with a specified field defined
11987
- * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11988
- * It works with all field types
11989
- * Example: ?filterDef=fields.title:true
11990
- *
11991
- * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11992
- * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11993
- */
11994
- filterDef: string[];
11995
- /**
11996
- * @deprecated
11997
- * @description Performs full text search on the entries.
11998
- * Example: ?ftsQuery=hello
11999
- */
12000
- ftsQuery: string;
11628
+ search: string;
12001
11629
  };
12002
11630
  };
12003
11631
  operations: {};
@@ -14566,12 +14194,37 @@ type ContentClientOptions = ClientOptions & {
14566
14194
  edgeApiHost?: string;
14567
14195
  disableSWR?: boolean;
14568
14196
  };
14197
+ type FilterLhs = 'type' | 'locale' | 'uiStatus' | 'name' | 'slug' | 'creator' | 'author' | 'created' | 'modified' | `fields.${string}`;
14198
+ type FilterRhs = string | number | boolean | {
14199
+ match: string;
14200
+ } | {
14201
+ eq: string | number | boolean;
14202
+ } | {
14203
+ neq: string | number | boolean;
14204
+ } | {
14205
+ in: (string | number | boolean)[];
14206
+ } | {
14207
+ nin: (string | number | boolean)[];
14208
+ } | {
14209
+ gt: string | number;
14210
+ } | {
14211
+ gte: string | number;
14212
+ } | {
14213
+ lt: string | number;
14214
+ } | {
14215
+ lte: string | number;
14216
+ } | {
14217
+ def: boolean;
14218
+ };
14569
14219
  declare class ContentClient extends ApiClient<ContentClientOptions> {
14570
14220
  #private;
14571
14221
  private edgeApiHost;
14572
14222
  constructor(options: ContentClientOptions);
14573
14223
  getContentTypes(options?: ExceptProject<GetContentTypesOptions>): Promise<GetContentTypesResponse>;
14574
- getEntries(options: ExceptProject<GetEntriesOptions> & DataResolutionParameters & DataResolutionOption): Promise<GetEntriesResponse>;
14224
+ getEntries(options: ExceptProject<GetEntriesOptions> & DataResolutionParameters & DataResolutionOption & {
14225
+ /** @deprecated do not use */
14226
+ filters?: Partial<Record<FilterLhs, FilterRhs>>;
14227
+ }): Promise<GetEntriesResponse>;
14575
14228
  /** Fetches historical versions of an entry */
14576
14229
  getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
14577
14230
  cursor?: string | undefined;
package/dist/index.esm.js CHANGED
@@ -643,9 +643,15 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
643
643
  }
644
644
  getEntries(options) {
645
645
  const { projectId } = this.options;
646
- const { skipDataResolution, ...params } = options;
646
+ const { skipDataResolution, filters, ...params } = options;
647
+ const rewrittenFilters = Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
648
+ const lhs = `filters.${key}` + (typeof value === "object" ? `[${Object.keys(value)[0]}]` : "");
649
+ let rhs = typeof value === "object" ? Object.values(value)[0] : value;
650
+ rhs = Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim();
651
+ return { ...acc, [lhs]: rhs };
652
+ }, {});
647
653
  if (skipDataResolution) {
648
- const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
654
+ const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, ...rewrittenFilters, projectId });
649
655
  return this.apiClient(url);
650
656
  }
651
657
  const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
@@ -2344,6 +2350,7 @@ function convertEntryToPutEntry(entry) {
2344
2350
  fields: entry.entry.fields,
2345
2351
  _locales: entry.entry._locales
2346
2352
  },
2353
+ pattern: entry.pattern,
2347
2354
  state: entry.state,
2348
2355
  projectId: entry.projectId
2349
2356
  };
package/dist/index.js CHANGED
@@ -771,9 +771,15 @@ var _ContentClient = class _ContentClient extends import_api4.ApiClient {
771
771
  }
772
772
  getEntries(options) {
773
773
  const { projectId } = this.options;
774
- const { skipDataResolution, ...params } = options;
774
+ const { skipDataResolution, filters, ...params } = options;
775
+ const rewrittenFilters = Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
776
+ const lhs = `filters.${key}` + (typeof value === "object" ? `[${Object.keys(value)[0]}]` : "");
777
+ let rhs = typeof value === "object" ? Object.values(value)[0] : value;
778
+ rhs = Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim();
779
+ return { ...acc, [lhs]: rhs };
780
+ }, {});
775
781
  if (skipDataResolution) {
776
- const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
782
+ const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, ...rewrittenFilters, projectId });
777
783
  return this.apiClient(url);
778
784
  }
779
785
  const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
@@ -2472,6 +2478,7 @@ function convertEntryToPutEntry(entry) {
2472
2478
  fields: entry.entry.fields,
2473
2479
  _locales: entry.entry._locales
2474
2480
  },
2481
+ pattern: entry.pattern,
2475
2482
  state: entry.state,
2476
2483
  projectId: entry.projectId
2477
2484
  };
package/dist/index.mjs CHANGED
@@ -643,9 +643,15 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
643
643
  }
644
644
  getEntries(options) {
645
645
  const { projectId } = this.options;
646
- const { skipDataResolution, ...params } = options;
646
+ const { skipDataResolution, filters, ...params } = options;
647
+ const rewrittenFilters = Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
648
+ const lhs = `filters.${key}` + (typeof value === "object" ? `[${Object.keys(value)[0]}]` : "");
649
+ let rhs = typeof value === "object" ? Object.values(value)[0] : value;
650
+ rhs = Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim();
651
+ return { ...acc, [lhs]: rhs };
652
+ }, {});
647
653
  if (skipDataResolution) {
648
- const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
654
+ const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, ...rewrittenFilters, projectId });
649
655
  return this.apiClient(url);
650
656
  }
651
657
  const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
@@ -2344,6 +2350,7 @@ function convertEntryToPutEntry(entry) {
2344
2350
  fields: entry.entry.fields,
2345
2351
  _locales: entry.entry._locales
2346
2352
  },
2353
+ pattern: entry.pattern,
2347
2354
  state: entry.state,
2348
2355
  projectId: entry.projectId
2349
2356
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "19.112.1-alpha.2+c0012954cc",
3
+ "version": "19.114.0",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -38,8 +38,8 @@
38
38
  "pusher-js": "8.2.0"
39
39
  },
40
40
  "dependencies": {
41
- "@uniformdev/assets": "19.112.1-alpha.2+c0012954cc",
42
- "@uniformdev/context": "19.112.1-alpha.2+c0012954cc",
41
+ "@uniformdev/assets": "19.114.0",
42
+ "@uniformdev/context": "19.114.0",
43
43
  "immer": "10.0.3"
44
44
  },
45
45
  "files": [
@@ -48,5 +48,5 @@
48
48
  "publishConfig": {
49
49
  "access": "public"
50
50
  },
51
- "gitHead": "c0012954ccbba15dfa086a7186ac325e22bf3f0d"
51
+ "gitHead": "c9d4260a191785215cdca52c78f869be809f6e06"
52
52
  }