@uniformdev/canvas 19.103.0 → 19.106.1-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +425 -10
  2. package/dist/index.d.ts +425 -10
  3. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -3025,7 +3025,10 @@ interface paths$b {
3025
3025
  limit?: components$4["parameters"]["limit"];
3026
3026
  /** Number of records to skip */
3027
3027
  offset?: components$4["parameters"]["offset"];
3028
- /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
3028
+ /**
3029
+ * Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
3030
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
3031
+ */
3029
3032
  orderBy?: components$4["parameters"]["orderBy"];
3030
3033
  /**
3031
3034
  * Matches compositions based on whether they are a pattern composition or a regular composition.
@@ -3092,6 +3095,98 @@ interface paths$b {
3092
3095
  * When this parameter is not passed, all locales' data will be returned.
3093
3096
  */
3094
3097
  locale?: components$4["parameters"]["locale"];
3098
+ /**
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
3141
+ */
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"];
3095
3190
  };
3096
3191
  };
3097
3192
  responses: {
@@ -3372,8 +3467,11 @@ interface components$4 {
3372
3467
  offset: number;
3373
3468
  /** @description Max number of records to return */
3374
3469
  limit: number;
3375
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
3376
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
3470
+ /**
3471
+ * @description Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
3472
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
3473
+ */
3474
+ orderBy: string[];
3377
3475
  /**
3378
3476
  * @deprecated
3379
3477
  * @description Returns the UI status string of the entry.
@@ -3440,6 +3538,109 @@ interface components$4 {
3440
3538
  * When this parameter is not passed, all locales' data will be returned.
3441
3539
  */
3442
3540
  locale: string;
3541
+ /**
3542
+ * @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
3549
+ */
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;
3443
3644
  };
3444
3645
  }
3445
3646
  interface external$c {
@@ -7996,6 +8197,8 @@ interface paths$4 {
7996
8197
  offset?: components$2["parameters"]["offset"];
7997
8198
  /**
7998
8199
  * Sets the sorting of the results. If unspecified, results are sorted by name ascending.
8200
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
8201
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
7999
8202
  * When using primary query parameters, this parameter is ignored.
8000
8203
  */
8001
8204
  orderBy?: components$2["parameters"]["orderBy"];
@@ -8384,9 +8587,11 @@ interface components$2 {
8384
8587
  pattern: boolean;
8385
8588
  /**
8386
8589
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
8590
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
8591
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
8387
8592
  * When using primary query parameters, this parameter is ignored.
8388
8593
  */
8389
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
8594
+ orderBy: string[];
8390
8595
  /**
8391
8596
  * @deprecated
8392
8597
  * @description Returns the UI status string of the composition.
@@ -10695,6 +10900,8 @@ interface external$3 {
10695
10900
  offset?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
10696
10901
  /**
10697
10902
  * Sets the sorting of the results. If unspecified, results are sorted by name ascending.
10903
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
10904
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
10698
10905
  * When using primary query parameters, this parameter is ignored.
10699
10906
  */
10700
10907
  orderBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
@@ -11083,9 +11290,11 @@ interface external$3 {
11083
11290
  pattern: boolean;
11084
11291
  /**
11085
11292
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
11293
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
11294
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
11086
11295
  * When using primary query parameters, this parameter is ignored.
11087
11296
  */
11088
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
11297
+ orderBy: string[];
11089
11298
  /**
11090
11299
  * @deprecated
11091
11300
  * @description Returns the UI status string of the composition.
@@ -11166,7 +11375,10 @@ interface external$3 {
11166
11375
  limit?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["limit"];
11167
11376
  /** Number of records to skip */
11168
11377
  offset?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["offset"];
11169
- /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
11378
+ /**
11379
+ * Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
11380
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
11381
+ */
11170
11382
  orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
11171
11383
  /**
11172
11384
  * Matches compositions based on whether they are a pattern composition or a regular composition.
@@ -11233,6 +11445,98 @@ interface external$3 {
11233
11445
  * When this parameter is not passed, all locales' data will be returned.
11234
11446
  */
11235
11447
  locale?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["locale"];
11448
+ /**
11449
+ * @deprecated Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11450
+ * It works with textual and rich text fields.
11451
+ * Example: ?filterMatch=fields.title:hello
11452
+ *
11453
+ * Multiple filters can be provided by repeating the parameter.
11454
+ * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11455
+ */
11456
+ filterMatch?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterMatch"];
11457
+ /**
11458
+ * @deprecated Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11459
+ * It works with textual, numerical, boolean and date fields.
11460
+ * Example: ?filterEq=fields.count:123
11461
+ *
11462
+ * Multiple filters can be provided by repeating the parameter.
11463
+ * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11464
+ */
11465
+ filterEq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterEq"];
11466
+ /**
11467
+ * @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.
11468
+ * It works with textual, numerical, boolean and date fields.
11469
+ * Example: ?filterNeq=fields.count:0
11470
+ *
11471
+ * Multiple filters can be provided by repeating the parameter.
11472
+ * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11473
+ */
11474
+ filterNeq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNeq"];
11475
+ /**
11476
+ * @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)
11477
+ * for a specified field. It works with numerical and date fields.
11478
+ * Example: ?filterLt=fields.releaseDate:2024-01-01
11479
+ *
11480
+ * Multiple filters can be provided by repeating the parameter.
11481
+ * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11482
+ */
11483
+ filterLt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLt"];
11484
+ /**
11485
+ * @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)
11486
+ * for a specified field. It works with numerical and date fields.
11487
+ * Example: ?filterLte=fields.releaseDate:2024-01-01
11488
+ *
11489
+ * Multiple filters can be provided by repeating the parameter.
11490
+ * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11491
+ */
11492
+ filterLte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLte"];
11493
+ /**
11494
+ * @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)
11495
+ * for a specified field. It works with numerical and date fields.
11496
+ * Example: ?filterGt=fields.releaseDate:2024-01-01
11497
+ *
11498
+ * Multiple filters can be provided by repeating the parameter.
11499
+ * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11500
+ */
11501
+ filterGt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGt"];
11502
+ /**
11503
+ * @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)
11504
+ * for a specified field. It works with numerical and date fields.
11505
+ * Example: ?filterGte=fields.releaseDate:2024-01-01
11506
+ *
11507
+ * Multiple filters can be provided by repeating the parameter.
11508
+ * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11509
+ */
11510
+ filterGte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGte"];
11511
+ /**
11512
+ * @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])
11513
+ * for a specified field. It works with textual, numerical, boolean and date fields.
11514
+ * Array values are provided by repeating the parameter with the same field name.
11515
+ * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11516
+ */
11517
+ filterIn?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterIn"];
11518
+ /**
11519
+ * @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])
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: ?filterNin=fields.title:hello&filterNin=fields.title:world
11523
+ */
11524
+ filterNin?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNin"];
11525
+ /**
11526
+ * @deprecated Filters list of entries so it only includes entries with a specified field defined
11527
+ * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11528
+ * It works with all field types
11529
+ * Example: ?filterDef=fields.title:true
11530
+ *
11531
+ * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11532
+ * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11533
+ */
11534
+ filterDef?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterDef"];
11535
+ /**
11536
+ * @deprecated Performs full text search on the entries.
11537
+ * Example: ?ftsQuery=hello
11538
+ */
11539
+ ftsQuery?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["ftsQuery"];
11236
11540
  };
11237
11541
  };
11238
11542
  responses: {
@@ -11513,8 +11817,11 @@ interface external$3 {
11513
11817
  offset: number;
11514
11818
  /** @description Max number of records to return */
11515
11819
  limit: number;
11516
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
11517
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
11820
+ /**
11821
+ * @description Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
11822
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
11823
+ */
11824
+ orderBy: string[];
11518
11825
  /**
11519
11826
  * @deprecated
11520
11827
  * @description Returns the UI status string of the entry.
@@ -11581,6 +11888,109 @@ interface external$3 {
11581
11888
  * When this parameter is not passed, all locales' data will be returned.
11582
11889
  */
11583
11890
  locale: string;
11891
+ /**
11892
+ * @deprecated
11893
+ * @description Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11894
+ * It works with textual and rich text fields.
11895
+ * Example: ?filterMatch=fields.title:hello
11896
+ *
11897
+ * Multiple filters can be provided by repeating the parameter.
11898
+ * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11899
+ */
11900
+ filterMatch: string[];
11901
+ /**
11902
+ * @deprecated
11903
+ * @description Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11904
+ * It works with textual, numerical, boolean and date fields.
11905
+ * Example: ?filterEq=fields.count:123
11906
+ *
11907
+ * Multiple filters can be provided by repeating the parameter.
11908
+ * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11909
+ */
11910
+ filterEq: string[];
11911
+ /**
11912
+ * @deprecated
11913
+ * @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.
11914
+ * It works with textual, numerical, boolean and date fields.
11915
+ * Example: ?filterNeq=fields.count:0
11916
+ *
11917
+ * Multiple filters can be provided by repeating the parameter.
11918
+ * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11919
+ */
11920
+ filterNeq: string[];
11921
+ /**
11922
+ * @deprecated
11923
+ * @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)
11924
+ * for a specified field. It works with numerical and date fields.
11925
+ * Example: ?filterLt=fields.releaseDate:2024-01-01
11926
+ *
11927
+ * Multiple filters can be provided by repeating the parameter.
11928
+ * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11929
+ */
11930
+ filterLt: string[];
11931
+ /**
11932
+ * @deprecated
11933
+ * @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)
11934
+ * for a specified field. It works with numerical and date fields.
11935
+ * Example: ?filterLte=fields.releaseDate:2024-01-01
11936
+ *
11937
+ * Multiple filters can be provided by repeating the parameter.
11938
+ * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11939
+ */
11940
+ filterLte: string[];
11941
+ /**
11942
+ * @deprecated
11943
+ * @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)
11944
+ * for a specified field. It works with numerical and date fields.
11945
+ * Example: ?filterGt=fields.releaseDate:2024-01-01
11946
+ *
11947
+ * Multiple filters can be provided by repeating the parameter.
11948
+ * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11949
+ */
11950
+ filterGt: string[];
11951
+ /**
11952
+ * @deprecated
11953
+ * @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)
11954
+ * for a specified field. It works with numerical and date fields.
11955
+ * Example: ?filterGte=fields.releaseDate:2024-01-01
11956
+ *
11957
+ * Multiple filters can be provided by repeating the parameter.
11958
+ * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11959
+ */
11960
+ filterGte: string[];
11961
+ /**
11962
+ * @deprecated
11963
+ * @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])
11964
+ * for a specified field. It works with textual, numerical, boolean and date fields.
11965
+ * Array values are provided by repeating the parameter with the same field name.
11966
+ * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11967
+ */
11968
+ filterIn: string[];
11969
+ /**
11970
+ * @deprecated
11971
+ * @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])
11972
+ * for a specified field. It works with textual, numerical, boolean and date fields.
11973
+ * Array values are provided by repeating the parameter with the same field name.
11974
+ * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
11975
+ */
11976
+ filterNin: string[];
11977
+ /**
11978
+ * @deprecated
11979
+ * @description Filters list of entries so it only includes entries with a specified field defined
11980
+ * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11981
+ * It works with all field types
11982
+ * Example: ?filterDef=fields.title:true
11983
+ *
11984
+ * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11985
+ * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11986
+ */
11987
+ filterDef: string[];
11988
+ /**
11989
+ * @deprecated
11990
+ * @description Performs full text search on the entries.
11991
+ * Example: ?ftsQuery=hello
11992
+ */
11993
+ ftsQuery: string;
11584
11994
  };
11585
11995
  };
11586
11996
  operations: {};
@@ -12853,6 +13263,8 @@ interface external$2 {
12853
13263
  offset?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
12854
13264
  /**
12855
13265
  * Sets the sorting of the results. If unspecified, results are sorted by name ascending.
13266
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
13267
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
12856
13268
  * When using primary query parameters, this parameter is ignored.
12857
13269
  */
12858
13270
  orderBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
@@ -13241,9 +13653,11 @@ interface external$2 {
13241
13653
  pattern: boolean;
13242
13654
  /**
13243
13655
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
13656
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
13657
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
13244
13658
  * When using primary query parameters, this parameter is ignored.
13245
13659
  */
13246
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
13660
+ orderBy: string[];
13247
13661
  /**
13248
13662
  * @deprecated
13249
13663
  * @description Returns the UI status string of the composition.
@@ -13511,7 +13925,8 @@ type HistoryApi = paths$3['/api/v1/canvas-history'];
13511
13925
  type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
13512
13926
  type?: string | string[];
13513
13927
  };
13514
- type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
13928
+ /** @deprecated - ordering now possible with any arbitrary string locator */
13929
+ type CompositionGetOrderBy = 'updated_at_DESC' | 'updated_at_ASC' | 'created_at_DESC' | 'created_at_ASC' | 'name_DESC' | 'name_ASC' | 'slug_DESC' | 'slug_ASC';
13515
13930
  /** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
13516
13931
  type CompositionGetResponse = Components['CompositionApiResponse'];
13517
13932
  /** The GET response from /api/v1/canvas-history (history for one composition) */
package/dist/index.d.ts CHANGED
@@ -3025,7 +3025,10 @@ interface paths$b {
3025
3025
  limit?: components$4["parameters"]["limit"];
3026
3026
  /** Number of records to skip */
3027
3027
  offset?: components$4["parameters"]["offset"];
3028
- /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
3028
+ /**
3029
+ * Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
3030
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
3031
+ */
3029
3032
  orderBy?: components$4["parameters"]["orderBy"];
3030
3033
  /**
3031
3034
  * Matches compositions based on whether they are a pattern composition or a regular composition.
@@ -3092,6 +3095,98 @@ interface paths$b {
3092
3095
  * When this parameter is not passed, all locales' data will be returned.
3093
3096
  */
3094
3097
  locale?: components$4["parameters"]["locale"];
3098
+ /**
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
3141
+ */
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"];
3095
3190
  };
3096
3191
  };
3097
3192
  responses: {
@@ -3372,8 +3467,11 @@ interface components$4 {
3372
3467
  offset: number;
3373
3468
  /** @description Max number of records to return */
3374
3469
  limit: number;
3375
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
3376
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
3470
+ /**
3471
+ * @description Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
3472
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
3473
+ */
3474
+ orderBy: string[];
3377
3475
  /**
3378
3476
  * @deprecated
3379
3477
  * @description Returns the UI status string of the entry.
@@ -3440,6 +3538,109 @@ interface components$4 {
3440
3538
  * When this parameter is not passed, all locales' data will be returned.
3441
3539
  */
3442
3540
  locale: string;
3541
+ /**
3542
+ * @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
3549
+ */
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;
3443
3644
  };
3444
3645
  }
3445
3646
  interface external$c {
@@ -7996,6 +8197,8 @@ interface paths$4 {
7996
8197
  offset?: components$2["parameters"]["offset"];
7997
8198
  /**
7998
8199
  * Sets the sorting of the results. If unspecified, results are sorted by name ascending.
8200
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
8201
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
7999
8202
  * When using primary query parameters, this parameter is ignored.
8000
8203
  */
8001
8204
  orderBy?: components$2["parameters"]["orderBy"];
@@ -8384,9 +8587,11 @@ interface components$2 {
8384
8587
  pattern: boolean;
8385
8588
  /**
8386
8589
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
8590
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
8591
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
8387
8592
  * When using primary query parameters, this parameter is ignored.
8388
8593
  */
8389
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
8594
+ orderBy: string[];
8390
8595
  /**
8391
8596
  * @deprecated
8392
8597
  * @description Returns the UI status string of the composition.
@@ -10695,6 +10900,8 @@ interface external$3 {
10695
10900
  offset?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
10696
10901
  /**
10697
10902
  * Sets the sorting of the results. If unspecified, results are sorted by name ascending.
10903
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
10904
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
10698
10905
  * When using primary query parameters, this parameter is ignored.
10699
10906
  */
10700
10907
  orderBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
@@ -11083,9 +11290,11 @@ interface external$3 {
11083
11290
  pattern: boolean;
11084
11291
  /**
11085
11292
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
11293
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
11294
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
11086
11295
  * When using primary query parameters, this parameter is ignored.
11087
11296
  */
11088
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
11297
+ orderBy: string[];
11089
11298
  /**
11090
11299
  * @deprecated
11091
11300
  * @description Returns the UI status string of the composition.
@@ -11166,7 +11375,10 @@ interface external$3 {
11166
11375
  limit?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["limit"];
11167
11376
  /** Number of records to skip */
11168
11377
  offset?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["offset"];
11169
- /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
11378
+ /**
11379
+ * Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
11380
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
11381
+ */
11170
11382
  orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
11171
11383
  /**
11172
11384
  * Matches compositions based on whether they are a pattern composition or a regular composition.
@@ -11233,6 +11445,98 @@ interface external$3 {
11233
11445
  * When this parameter is not passed, all locales' data will be returned.
11234
11446
  */
11235
11447
  locale?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["locale"];
11448
+ /**
11449
+ * @deprecated Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11450
+ * It works with textual and rich text fields.
11451
+ * Example: ?filterMatch=fields.title:hello
11452
+ *
11453
+ * Multiple filters can be provided by repeating the parameter.
11454
+ * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11455
+ */
11456
+ filterMatch?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterMatch"];
11457
+ /**
11458
+ * @deprecated Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11459
+ * It works with textual, numerical, boolean and date fields.
11460
+ * Example: ?filterEq=fields.count:123
11461
+ *
11462
+ * Multiple filters can be provided by repeating the parameter.
11463
+ * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11464
+ */
11465
+ filterEq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterEq"];
11466
+ /**
11467
+ * @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.
11468
+ * It works with textual, numerical, boolean and date fields.
11469
+ * Example: ?filterNeq=fields.count:0
11470
+ *
11471
+ * Multiple filters can be provided by repeating the parameter.
11472
+ * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11473
+ */
11474
+ filterNeq?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNeq"];
11475
+ /**
11476
+ * @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)
11477
+ * for a specified field. It works with numerical and date fields.
11478
+ * Example: ?filterLt=fields.releaseDate:2024-01-01
11479
+ *
11480
+ * Multiple filters can be provided by repeating the parameter.
11481
+ * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11482
+ */
11483
+ filterLt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLt"];
11484
+ /**
11485
+ * @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)
11486
+ * for a specified field. It works with numerical and date fields.
11487
+ * Example: ?filterLte=fields.releaseDate:2024-01-01
11488
+ *
11489
+ * Multiple filters can be provided by repeating the parameter.
11490
+ * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11491
+ */
11492
+ filterLte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterLte"];
11493
+ /**
11494
+ * @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)
11495
+ * for a specified field. It works with numerical and date fields.
11496
+ * Example: ?filterGt=fields.releaseDate:2024-01-01
11497
+ *
11498
+ * Multiple filters can be provided by repeating the parameter.
11499
+ * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11500
+ */
11501
+ filterGt?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGt"];
11502
+ /**
11503
+ * @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)
11504
+ * for a specified field. It works with numerical and date fields.
11505
+ * Example: ?filterGte=fields.releaseDate:2024-01-01
11506
+ *
11507
+ * Multiple filters can be provided by repeating the parameter.
11508
+ * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11509
+ */
11510
+ filterGte?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterGte"];
11511
+ /**
11512
+ * @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])
11513
+ * for a specified field. It works with textual, numerical, boolean and date fields.
11514
+ * Array values are provided by repeating the parameter with the same field name.
11515
+ * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11516
+ */
11517
+ filterIn?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterIn"];
11518
+ /**
11519
+ * @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])
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: ?filterNin=fields.title:hello&filterNin=fields.title:world
11523
+ */
11524
+ filterNin?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterNin"];
11525
+ /**
11526
+ * @deprecated Filters list of entries so it only includes entries with a specified field defined
11527
+ * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11528
+ * It works with all field types
11529
+ * Example: ?filterDef=fields.title:true
11530
+ *
11531
+ * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11532
+ * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11533
+ */
11534
+ filterDef?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["filterDef"];
11535
+ /**
11536
+ * @deprecated Performs full text search on the entries.
11537
+ * Example: ?ftsQuery=hello
11538
+ */
11539
+ ftsQuery?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["ftsQuery"];
11236
11540
  };
11237
11541
  };
11238
11542
  responses: {
@@ -11513,8 +11817,11 @@ interface external$3 {
11513
11817
  offset: number;
11514
11818
  /** @description Max number of records to return */
11515
11819
  limit: number;
11516
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
11517
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
11820
+ /**
11821
+ * @description Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
11822
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC.
11823
+ */
11824
+ orderBy: string[];
11518
11825
  /**
11519
11826
  * @deprecated
11520
11827
  * @description Returns the UI status string of the entry.
@@ -11581,6 +11888,109 @@ interface external$3 {
11581
11888
  * When this parameter is not passed, all locales' data will be returned.
11582
11889
  */
11583
11890
  locale: string;
11891
+ /**
11892
+ * @deprecated
11893
+ * @description Filters list of entries by matching (e.g. "hello" matches "hello world") string value of a specified field.
11894
+ * It works with textual and rich text fields.
11895
+ * Example: ?filterMatch=fields.title:hello
11896
+ *
11897
+ * Multiple filters can be provided by repeating the parameter.
11898
+ * Example: ?filterMatch=fields.title:hello&filterMatch=fields.description:world
11899
+ */
11900
+ filterMatch: string[];
11901
+ /**
11902
+ * @deprecated
11903
+ * @description Filters list of entries by strict equality (e.g. 123 is equal to 123 and 123 only) of a specified field.
11904
+ * It works with textual, numerical, boolean and date fields.
11905
+ * Example: ?filterEq=fields.count:123
11906
+ *
11907
+ * Multiple filters can be provided by repeating the parameter.
11908
+ * Example: ?filterEq=fields.count:123&filterEq=fields.isPublished:true
11909
+ */
11910
+ filterEq: string[];
11911
+ /**
11912
+ * @deprecated
11913
+ * @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.
11914
+ * It works with textual, numerical, boolean and date fields.
11915
+ * Example: ?filterNeq=fields.count:0
11916
+ *
11917
+ * Multiple filters can be provided by repeating the parameter.
11918
+ * Example: ?filterNeq=fields.count:0&filterNeq=fields.isPublished:true
11919
+ */
11920
+ filterNeq: string[];
11921
+ /**
11922
+ * @deprecated
11923
+ * @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)
11924
+ * for a specified field. It works with numerical and date fields.
11925
+ * Example: ?filterLt=fields.releaseDate:2024-01-01
11926
+ *
11927
+ * Multiple filters can be provided by repeating the parameter.
11928
+ * Example: ?filterLt=fields.count:123&filterLt=fields.releaseDate:2020-01-01
11929
+ */
11930
+ filterLt: string[];
11931
+ /**
11932
+ * @deprecated
11933
+ * @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)
11934
+ * for a specified field. It works with numerical and date fields.
11935
+ * Example: ?filterLte=fields.releaseDate:2024-01-01
11936
+ *
11937
+ * Multiple filters can be provided by repeating the parameter.
11938
+ * Example: ?filterLte=fields.count:123&filterLte=fields.releaseDate:2020-01-01
11939
+ */
11940
+ filterLte: string[];
11941
+ /**
11942
+ * @deprecated
11943
+ * @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)
11944
+ * for a specified field. It works with numerical and date fields.
11945
+ * Example: ?filterGt=fields.releaseDate:2024-01-01
11946
+ *
11947
+ * Multiple filters can be provided by repeating the parameter.
11948
+ * Example: ?filterGt=fields.count:123&filterGt=fields.releaseDate:2020-01-01
11949
+ */
11950
+ filterGt: string[];
11951
+ /**
11952
+ * @deprecated
11953
+ * @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)
11954
+ * for a specified field. It works with numerical and date fields.
11955
+ * Example: ?filterGte=fields.releaseDate:2024-01-01
11956
+ *
11957
+ * Multiple filters can be provided by repeating the parameter.
11958
+ * Example: ?filterGte=fields.count:123&filterGte=fields.releaseDate:2020-01-01
11959
+ */
11960
+ filterGte: string[];
11961
+ /**
11962
+ * @deprecated
11963
+ * @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])
11964
+ * for a specified field. It works with textual, numerical, boolean and date fields.
11965
+ * Array values are provided by repeating the parameter with the same field name.
11966
+ * Example: ?filterIn=fields.title:hello&filterIn=fields.title:world
11967
+ */
11968
+ filterIn: string[];
11969
+ /**
11970
+ * @deprecated
11971
+ * @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])
11972
+ * for a specified field. It works with textual, numerical, boolean and date fields.
11973
+ * Array values are provided by repeating the parameter with the same field name.
11974
+ * Example: ?filterNin=fields.title:hello&filterNin=fields.title:world
11975
+ */
11976
+ filterNin: string[];
11977
+ /**
11978
+ * @deprecated
11979
+ * @description Filters list of entries so it only includes entries with a specified field defined
11980
+ * (e.g. 0, 1, "hello", true, false are all defined, but null, undefined and empty string are considered not defined)
11981
+ * It works with all field types
11982
+ * Example: ?filterDef=fields.title:true
11983
+ *
11984
+ * Multiple filters can be provided by repeating the parameter. It can be negated by providing false as the value.
11985
+ * Example: ?filterDef=fields.title:true&filterDef=fields.description:false
11986
+ */
11987
+ filterDef: string[];
11988
+ /**
11989
+ * @deprecated
11990
+ * @description Performs full text search on the entries.
11991
+ * Example: ?ftsQuery=hello
11992
+ */
11993
+ ftsQuery: string;
11584
11994
  };
11585
11995
  };
11586
11996
  operations: {};
@@ -12853,6 +13263,8 @@ interface external$2 {
12853
13263
  offset?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
12854
13264
  /**
12855
13265
  * Sets the sorting of the results. If unspecified, results are sorted by name ascending.
13266
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
13267
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
12856
13268
  * When using primary query parameters, this parameter is ignored.
12857
13269
  */
12858
13270
  orderBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
@@ -13241,9 +13653,11 @@ interface external$2 {
13241
13653
  pattern: boolean;
13242
13654
  /**
13243
13655
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
13656
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
13657
+ * name_DESC, name_ASC, slug_DESC, slug_ASC.
13244
13658
  * When using primary query parameters, this parameter is ignored.
13245
13659
  */
13246
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
13660
+ orderBy: string[];
13247
13661
  /**
13248
13662
  * @deprecated
13249
13663
  * @description Returns the UI status string of the composition.
@@ -13511,7 +13925,8 @@ type HistoryApi = paths$3['/api/v1/canvas-history'];
13511
13925
  type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
13512
13926
  type?: string | string[];
13513
13927
  };
13514
- type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
13928
+ /** @deprecated - ordering now possible with any arbitrary string locator */
13929
+ type CompositionGetOrderBy = 'updated_at_DESC' | 'updated_at_ASC' | 'created_at_DESC' | 'created_at_ASC' | 'name_DESC' | 'name_ASC' | 'slug_DESC' | 'slug_ASC';
13515
13930
  /** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
13516
13931
  type CompositionGetResponse = Components['CompositionApiResponse'];
13517
13932
  /** The GET response from /api/v1/canvas-history (history for one composition) */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "19.103.0",
3
+ "version": "19.106.1-alpha.3+47677ea6f",
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.103.0",
42
- "@uniformdev/context": "19.103.0",
41
+ "@uniformdev/assets": "19.106.1-alpha.3+47677ea6f",
42
+ "@uniformdev/context": "19.106.1-alpha.3+47677ea6f",
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": "ebdcac3a77d293bff272925f62f8c1c10be855bc"
51
+ "gitHead": "47677ea6fd6eb707bb30eb20dc67e42573e0516d"
52
52
  }