@dotcms/ai 1.5.5-next.2285 → 1.5.5-next.2290

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/package.json +1 -1
  2. package/spec.cjs.js +82 -129
  3. package/spec.esm.js +82 -129
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dotcms/ai",
3
- "version": "1.5.5-next.2285",
3
+ "version": "1.5.5-next.2290",
4
4
  "description": "The dotCMS agentic runtime — run model-written or human-written code safely against a dotCMS instance, with auth and policy owned in one place.",
5
5
  "repository": {
6
6
  "type": "git",
package/spec.cjs.js CHANGED
@@ -989,7 +989,7 @@ var paths = {
989
989
  requestBody: {
990
990
  description: "Updated container configuration data including identifier and modified properties",
991
991
  content: {
992
- "application/json": {
992
+ "*/*": {
993
993
  schema: {
994
994
  required: [
995
995
  "title"
@@ -1135,7 +1135,7 @@ var paths = {
1135
1135
  requestBody: {
1136
1136
  description: "Container configuration data including title, code, content type structures, and display settings",
1137
1137
  content: {
1138
- "application/json": {
1138
+ "*/*": {
1139
1139
  schema: {
1140
1140
  required: [
1141
1141
  "title"
@@ -3149,41 +3149,61 @@ var paths = {
3149
3149
  }
3150
3150
  }
3151
3151
  },
3152
- "/api/v1/folder/sitename/{siteName}/uri/{uri}": {
3153
- get: {
3152
+ "/api/v1/folder/byPath": {
3153
+ post: {
3154
3154
  tags: [
3155
3155
  "Folders"
3156
3156
  ],
3157
- summary: "Load a folder by site name and URI",
3158
- description: "Retrieves a folder by its URI path within the specified site.",
3159
- operationId: "loadFolderByURI",
3157
+ summary: "Find subfolders by path",
3158
+ description: "Retrieves subfolders of a given path, filtered by the path sent. The path format supports site-specific search (//siteName/path) or global search (/path). For example: '//default/folder1/' returns subfolder1, subfolder2 under folder1 in the 'default' site. '/folder1/s' returns all subfolders starting with 's' under folder1 across all sites.",
3159
+ operationId: "findSubFoldersByPath",
3160
3160
  parameters: [
3161
3161
  {
3162
- name: "siteName",
3163
- "in": "path",
3164
- required: true,
3162
+ name: "offset",
3163
+ "in": "query",
3164
+ description: "Number of results to skip for pagination. Must be >= 0.",
3165
3165
  schema: {
3166
- type: "string"
3166
+ type: "integer",
3167
+ format: "int32",
3168
+ "default": 0
3167
3169
  }
3168
3170
  },
3169
3171
  {
3170
- name: "uri",
3171
- "in": "path",
3172
- required: true,
3172
+ name: "limit",
3173
+ "in": "query",
3174
+ description: "Maximum number of results to return. Default 40. Use -1 for unlimited (capped at 10000 as a safety limit).",
3173
3175
  schema: {
3174
- pattern: ".+",
3175
- type: "string"
3176
+ type: "integer",
3177
+ format: "int32",
3178
+ "default": 40
3176
3179
  }
3177
3180
  }
3178
3181
  ],
3182
+ requestBody: {
3183
+ content: {
3184
+ "*/*": {
3185
+ schema: {
3186
+ type: "object",
3187
+ properties: {
3188
+ path: {
3189
+ type: "string"
3190
+ }
3191
+ }
3192
+ }
3193
+ }
3194
+ }
3195
+ },
3179
3196
  responses: {
3180
3197
  "200": {
3181
- description: "Folder retrieved successfully",
3198
+ description: "Subfolders retrieved successfully",
3182
3199
  content: {
3183
3200
  "application/json": {
3184
3201
  }
3185
3202
  }
3186
3203
  },
3204
+ "400": {
3205
+ description: "Path property must be sent"
3206
+ },
3187
3207
  "401": {
3188
3208
  description: "Authentication required"
3189
3209
  },
@@ -3191,117 +3211,54 @@ var paths = {
3191
3211
  description: "Insufficient permissions"
3192
3212
  },
3193
3213
  "404": {
3194
- description: "Folder not found"
3214
+ description: "Site not found"
3195
3215
  }
3196
3216
  }
3197
3217
  }
3198
3218
  },
3199
- "/api/v1/folder/search": {
3219
+ "/api/v1/folder/sitename/{siteName}/uri/{uri}": {
3200
3220
  get: {
3201
3221
  tags: [
3202
3222
  "Folders"
3203
3223
  ],
3204
- summary: "Search folders",
3205
- description: "Returns folders within a site matching an optional name filter and/or path scope. Supports recursive depth control, standard pagination, and sorting. With no 'name' and default path '/' + recursive=true, all site folders are returned.",
3206
- operationId: "searchFolders",
3224
+ summary: "Load a folder by site name and URI",
3225
+ description: "Retrieves a folder by its URI path within the specified site.",
3226
+ operationId: "loadFolderByURI",
3207
3227
  parameters: [
3208
3228
  {
3209
- name: "name",
3210
- "in": "query",
3211
- description: "Optional case-insensitive partial match on folder name (minimum 3 characters when provided)",
3229
+ name: "siteName",
3230
+ "in": "path",
3231
+ required: true,
3212
3232
  schema: {
3213
3233
  type: "string"
3214
3234
  }
3215
3235
  },
3216
3236
  {
3217
- name: "path",
3218
- "in": "query",
3219
- description: "Path scope for the search. Defaults to '/' (site root).",
3220
- schema: {
3221
- type: "string",
3222
- "default": "/"
3223
- }
3224
- },
3225
- {
3226
- name: "recursive",
3227
- "in": "query",
3228
- description: "false = direct children of 'path' only (default); true = search all descendants",
3229
- schema: {
3230
- type: "boolean",
3231
- "default": false
3232
- }
3233
- },
3234
- {
3235
- name: "siteId",
3236
- "in": "query",
3237
- description: "Site ID to scope the search (required)",
3237
+ name: "uri",
3238
+ "in": "path",
3239
+ required: true,
3238
3240
  schema: {
3241
+ pattern: ".+",
3239
3242
  type: "string"
3240
3243
  }
3241
- },
3242
- {
3243
- name: "orderby",
3244
- "in": "query",
3245
- description: "Column to sort by.",
3246
- schema: {
3247
- type: "string",
3248
- "enum": [
3249
- "name",
3250
- "mod_date"
3251
- ],
3252
- "default": "name"
3253
- }
3254
- },
3255
- {
3256
- name: "direction",
3257
- "in": "query",
3258
- description: "Sort direction",
3259
- schema: {
3260
- type: "string",
3261
- "enum": [
3262
- "ASC",
3263
- "DESC"
3264
- ],
3265
- "default": "ASC"
3266
- }
3267
- },
3268
- {
3269
- name: "page",
3270
- "in": "query",
3271
- description: "Page number (1-based, default 1)",
3272
- schema: {
3273
- type: "integer",
3274
- format: "int32",
3275
- "default": 1
3276
- }
3277
- },
3278
- {
3279
- name: "per_page",
3280
- "in": "query",
3281
- description: "Number of results per page (default 40)",
3282
- schema: {
3283
- type: "integer",
3284
- format: "int32",
3285
- "default": 40
3286
- }
3287
3244
  }
3288
3245
  ],
3289
3246
  responses: {
3290
3247
  "200": {
3291
- description: "Paginated list of matching folders",
3248
+ description: "Folder retrieved successfully",
3292
3249
  content: {
3293
3250
  "application/json": {
3294
3251
  }
3295
3252
  }
3296
3253
  },
3297
- "400": {
3298
- description: "'siteId' is required; 'name' must be at least 3 characters if provided"
3299
- },
3300
3254
  "401": {
3301
- description: "User is not authenticated"
3255
+ description: "Authentication required"
3302
3256
  },
3303
- "500": {
3304
- description: "Internal server error"
3257
+ "403": {
3258
+ description: "Insufficient permissions"
3259
+ },
3260
+ "404": {
3261
+ description: "Folder not found"
3305
3262
  }
3306
3263
  }
3307
3264
  }
@@ -5261,9 +5218,8 @@ var paths = {
5261
5218
  }
5262
5219
  ],
5263
5220
  requestBody: {
5264
- description: "Updated site properties. 'siteName' (the hostname) is required.",
5265
5221
  content: {
5266
- "application/json": {
5222
+ "*/*": {
5267
5223
  schema: {
5268
5224
  type: "object",
5269
5225
  properties: {
@@ -5342,8 +5298,7 @@ var paths = {
5342
5298
  }
5343
5299
  }
5344
5300
  }
5345
- },
5346
- required: true
5301
+ }
5347
5302
  },
5348
5303
  responses: {
5349
5304
  "200": {
@@ -5375,9 +5330,8 @@ var paths = {
5375
5330
  description: "Creates a new site with the provided properties including hostname, aliases, tag storage, SEO settings, and optional site variables.",
5376
5331
  operationId: "createSite",
5377
5332
  requestBody: {
5378
- description: "Site properties to create. 'siteName' (the hostname) is required.",
5379
5333
  content: {
5380
- "application/json": {
5334
+ "*/*": {
5381
5335
  schema: {
5382
5336
  type: "object",
5383
5337
  properties: {
@@ -5456,8 +5410,7 @@ var paths = {
5456
5410
  }
5457
5411
  }
5458
5412
  }
5459
- },
5460
- required: true
5413
+ }
5461
5414
  },
5462
5415
  responses: {
5463
5416
  "200": {
@@ -7686,7 +7639,7 @@ var paths = {
7686
7639
  requestBody: {
7687
7640
  description: "Template data to update. Must include the template identifier.",
7688
7641
  content: {
7689
- "application/json": {
7642
+ "*/*": {
7690
7643
  schema: {
7691
7644
  required: [
7692
7645
  "title"
@@ -7924,7 +7877,7 @@ var paths = {
7924
7877
  requestBody: {
7925
7878
  description: "Template data to create",
7926
7879
  content: {
7927
- "application/json": {
7880
+ "*/*": {
7928
7881
  schema: {
7929
7882
  required: [
7930
7883
  "title"
@@ -13644,6 +13597,15 @@ var paths = {
13644
13597
  hasOnlyBatchActionlet: {
13645
13598
  type: "boolean"
13646
13599
  },
13600
+ hasSaveActionlet: {
13601
+ type: "boolean"
13602
+ },
13603
+ hasDeleteActionlet: {
13604
+ type: "boolean"
13605
+ },
13606
+ hasResetActionlet: {
13607
+ type: "boolean"
13608
+ },
13647
13609
  hasPublishActionlet: {
13648
13610
  type: "boolean"
13649
13611
  },
@@ -13670,15 +13632,6 @@ var paths = {
13670
13632
  },
13671
13633
  hasMoveActionletActionlet: {
13672
13634
  type: "boolean"
13673
- },
13674
- hasSaveActionlet: {
13675
- type: "boolean"
13676
- },
13677
- hasDeleteActionlet: {
13678
- type: "boolean"
13679
- },
13680
- hasResetActionlet: {
13681
- type: "boolean"
13682
13635
  }
13683
13636
  }
13684
13637
  }
@@ -13918,6 +13871,15 @@ var paths = {
13918
13871
  hasOnlyBatchActionlet: {
13919
13872
  type: "boolean"
13920
13873
  },
13874
+ hasSaveActionlet: {
13875
+ type: "boolean"
13876
+ },
13877
+ hasDeleteActionlet: {
13878
+ type: "boolean"
13879
+ },
13880
+ hasResetActionlet: {
13881
+ type: "boolean"
13882
+ },
13921
13883
  hasPublishActionlet: {
13922
13884
  type: "boolean"
13923
13885
  },
@@ -13944,15 +13906,6 @@ var paths = {
13944
13906
  },
13945
13907
  hasMoveActionletActionlet: {
13946
13908
  type: "boolean"
13947
- },
13948
- hasSaveActionlet: {
13949
- type: "boolean"
13950
- },
13951
- hasDeleteActionlet: {
13952
- type: "boolean"
13953
- },
13954
- hasResetActionlet: {
13955
- type: "boolean"
13956
13909
  }
13957
13910
  }
13958
13911
  },
@@ -13989,10 +13942,10 @@ var paths = {
13989
13942
  type: {
13990
13943
  type: "string"
13991
13944
  },
13992
- individualPermission: {
13945
+ bitPermission: {
13993
13946
  type: "boolean"
13994
13947
  },
13995
- bitPermission: {
13948
+ individualPermission: {
13996
13949
  type: "boolean"
13997
13950
  },
13998
13951
  roleId: {
package/spec.esm.js CHANGED
@@ -987,7 +987,7 @@ var paths = {
987
987
  requestBody: {
988
988
  description: "Updated container configuration data including identifier and modified properties",
989
989
  content: {
990
- "application/json": {
990
+ "*/*": {
991
991
  schema: {
992
992
  required: [
993
993
  "title"
@@ -1133,7 +1133,7 @@ var paths = {
1133
1133
  requestBody: {
1134
1134
  description: "Container configuration data including title, code, content type structures, and display settings",
1135
1135
  content: {
1136
- "application/json": {
1136
+ "*/*": {
1137
1137
  schema: {
1138
1138
  required: [
1139
1139
  "title"
@@ -3147,41 +3147,61 @@ var paths = {
3147
3147
  }
3148
3148
  }
3149
3149
  },
3150
- "/api/v1/folder/sitename/{siteName}/uri/{uri}": {
3151
- get: {
3150
+ "/api/v1/folder/byPath": {
3151
+ post: {
3152
3152
  tags: [
3153
3153
  "Folders"
3154
3154
  ],
3155
- summary: "Load a folder by site name and URI",
3156
- description: "Retrieves a folder by its URI path within the specified site.",
3157
- operationId: "loadFolderByURI",
3155
+ summary: "Find subfolders by path",
3156
+ description: "Retrieves subfolders of a given path, filtered by the path sent. The path format supports site-specific search (//siteName/path) or global search (/path). For example: '//default/folder1/' returns subfolder1, subfolder2 under folder1 in the 'default' site. '/folder1/s' returns all subfolders starting with 's' under folder1 across all sites.",
3157
+ operationId: "findSubFoldersByPath",
3158
3158
  parameters: [
3159
3159
  {
3160
- name: "siteName",
3161
- "in": "path",
3162
- required: true,
3160
+ name: "offset",
3161
+ "in": "query",
3162
+ description: "Number of results to skip for pagination. Must be >= 0.",
3163
3163
  schema: {
3164
- type: "string"
3164
+ type: "integer",
3165
+ format: "int32",
3166
+ "default": 0
3165
3167
  }
3166
3168
  },
3167
3169
  {
3168
- name: "uri",
3169
- "in": "path",
3170
- required: true,
3170
+ name: "limit",
3171
+ "in": "query",
3172
+ description: "Maximum number of results to return. Default 40. Use -1 for unlimited (capped at 10000 as a safety limit).",
3171
3173
  schema: {
3172
- pattern: ".+",
3173
- type: "string"
3174
+ type: "integer",
3175
+ format: "int32",
3176
+ "default": 40
3174
3177
  }
3175
3178
  }
3176
3179
  ],
3180
+ requestBody: {
3181
+ content: {
3182
+ "*/*": {
3183
+ schema: {
3184
+ type: "object",
3185
+ properties: {
3186
+ path: {
3187
+ type: "string"
3188
+ }
3189
+ }
3190
+ }
3191
+ }
3192
+ }
3193
+ },
3177
3194
  responses: {
3178
3195
  "200": {
3179
- description: "Folder retrieved successfully",
3196
+ description: "Subfolders retrieved successfully",
3180
3197
  content: {
3181
3198
  "application/json": {
3182
3199
  }
3183
3200
  }
3184
3201
  },
3202
+ "400": {
3203
+ description: "Path property must be sent"
3204
+ },
3185
3205
  "401": {
3186
3206
  description: "Authentication required"
3187
3207
  },
@@ -3189,117 +3209,54 @@ var paths = {
3189
3209
  description: "Insufficient permissions"
3190
3210
  },
3191
3211
  "404": {
3192
- description: "Folder not found"
3212
+ description: "Site not found"
3193
3213
  }
3194
3214
  }
3195
3215
  }
3196
3216
  },
3197
- "/api/v1/folder/search": {
3217
+ "/api/v1/folder/sitename/{siteName}/uri/{uri}": {
3198
3218
  get: {
3199
3219
  tags: [
3200
3220
  "Folders"
3201
3221
  ],
3202
- summary: "Search folders",
3203
- description: "Returns folders within a site matching an optional name filter and/or path scope. Supports recursive depth control, standard pagination, and sorting. With no 'name' and default path '/' + recursive=true, all site folders are returned.",
3204
- operationId: "searchFolders",
3222
+ summary: "Load a folder by site name and URI",
3223
+ description: "Retrieves a folder by its URI path within the specified site.",
3224
+ operationId: "loadFolderByURI",
3205
3225
  parameters: [
3206
3226
  {
3207
- name: "name",
3208
- "in": "query",
3209
- description: "Optional case-insensitive partial match on folder name (minimum 3 characters when provided)",
3227
+ name: "siteName",
3228
+ "in": "path",
3229
+ required: true,
3210
3230
  schema: {
3211
3231
  type: "string"
3212
3232
  }
3213
3233
  },
3214
3234
  {
3215
- name: "path",
3216
- "in": "query",
3217
- description: "Path scope for the search. Defaults to '/' (site root).",
3218
- schema: {
3219
- type: "string",
3220
- "default": "/"
3221
- }
3222
- },
3223
- {
3224
- name: "recursive",
3225
- "in": "query",
3226
- description: "false = direct children of 'path' only (default); true = search all descendants",
3227
- schema: {
3228
- type: "boolean",
3229
- "default": false
3230
- }
3231
- },
3232
- {
3233
- name: "siteId",
3234
- "in": "query",
3235
- description: "Site ID to scope the search (required)",
3235
+ name: "uri",
3236
+ "in": "path",
3237
+ required: true,
3236
3238
  schema: {
3239
+ pattern: ".+",
3237
3240
  type: "string"
3238
3241
  }
3239
- },
3240
- {
3241
- name: "orderby",
3242
- "in": "query",
3243
- description: "Column to sort by.",
3244
- schema: {
3245
- type: "string",
3246
- "enum": [
3247
- "name",
3248
- "mod_date"
3249
- ],
3250
- "default": "name"
3251
- }
3252
- },
3253
- {
3254
- name: "direction",
3255
- "in": "query",
3256
- description: "Sort direction",
3257
- schema: {
3258
- type: "string",
3259
- "enum": [
3260
- "ASC",
3261
- "DESC"
3262
- ],
3263
- "default": "ASC"
3264
- }
3265
- },
3266
- {
3267
- name: "page",
3268
- "in": "query",
3269
- description: "Page number (1-based, default 1)",
3270
- schema: {
3271
- type: "integer",
3272
- format: "int32",
3273
- "default": 1
3274
- }
3275
- },
3276
- {
3277
- name: "per_page",
3278
- "in": "query",
3279
- description: "Number of results per page (default 40)",
3280
- schema: {
3281
- type: "integer",
3282
- format: "int32",
3283
- "default": 40
3284
- }
3285
3242
  }
3286
3243
  ],
3287
3244
  responses: {
3288
3245
  "200": {
3289
- description: "Paginated list of matching folders",
3246
+ description: "Folder retrieved successfully",
3290
3247
  content: {
3291
3248
  "application/json": {
3292
3249
  }
3293
3250
  }
3294
3251
  },
3295
- "400": {
3296
- description: "'siteId' is required; 'name' must be at least 3 characters if provided"
3297
- },
3298
3252
  "401": {
3299
- description: "User is not authenticated"
3253
+ description: "Authentication required"
3300
3254
  },
3301
- "500": {
3302
- description: "Internal server error"
3255
+ "403": {
3256
+ description: "Insufficient permissions"
3257
+ },
3258
+ "404": {
3259
+ description: "Folder not found"
3303
3260
  }
3304
3261
  }
3305
3262
  }
@@ -5259,9 +5216,8 @@ var paths = {
5259
5216
  }
5260
5217
  ],
5261
5218
  requestBody: {
5262
- description: "Updated site properties. 'siteName' (the hostname) is required.",
5263
5219
  content: {
5264
- "application/json": {
5220
+ "*/*": {
5265
5221
  schema: {
5266
5222
  type: "object",
5267
5223
  properties: {
@@ -5340,8 +5296,7 @@ var paths = {
5340
5296
  }
5341
5297
  }
5342
5298
  }
5343
- },
5344
- required: true
5299
+ }
5345
5300
  },
5346
5301
  responses: {
5347
5302
  "200": {
@@ -5373,9 +5328,8 @@ var paths = {
5373
5328
  description: "Creates a new site with the provided properties including hostname, aliases, tag storage, SEO settings, and optional site variables.",
5374
5329
  operationId: "createSite",
5375
5330
  requestBody: {
5376
- description: "Site properties to create. 'siteName' (the hostname) is required.",
5377
5331
  content: {
5378
- "application/json": {
5332
+ "*/*": {
5379
5333
  schema: {
5380
5334
  type: "object",
5381
5335
  properties: {
@@ -5454,8 +5408,7 @@ var paths = {
5454
5408
  }
5455
5409
  }
5456
5410
  }
5457
- },
5458
- required: true
5411
+ }
5459
5412
  },
5460
5413
  responses: {
5461
5414
  "200": {
@@ -7684,7 +7637,7 @@ var paths = {
7684
7637
  requestBody: {
7685
7638
  description: "Template data to update. Must include the template identifier.",
7686
7639
  content: {
7687
- "application/json": {
7640
+ "*/*": {
7688
7641
  schema: {
7689
7642
  required: [
7690
7643
  "title"
@@ -7922,7 +7875,7 @@ var paths = {
7922
7875
  requestBody: {
7923
7876
  description: "Template data to create",
7924
7877
  content: {
7925
- "application/json": {
7878
+ "*/*": {
7926
7879
  schema: {
7927
7880
  required: [
7928
7881
  "title"
@@ -13642,6 +13595,15 @@ var paths = {
13642
13595
  hasOnlyBatchActionlet: {
13643
13596
  type: "boolean"
13644
13597
  },
13598
+ hasSaveActionlet: {
13599
+ type: "boolean"
13600
+ },
13601
+ hasDeleteActionlet: {
13602
+ type: "boolean"
13603
+ },
13604
+ hasResetActionlet: {
13605
+ type: "boolean"
13606
+ },
13645
13607
  hasPublishActionlet: {
13646
13608
  type: "boolean"
13647
13609
  },
@@ -13668,15 +13630,6 @@ var paths = {
13668
13630
  },
13669
13631
  hasMoveActionletActionlet: {
13670
13632
  type: "boolean"
13671
- },
13672
- hasSaveActionlet: {
13673
- type: "boolean"
13674
- },
13675
- hasDeleteActionlet: {
13676
- type: "boolean"
13677
- },
13678
- hasResetActionlet: {
13679
- type: "boolean"
13680
13633
  }
13681
13634
  }
13682
13635
  }
@@ -13916,6 +13869,15 @@ var paths = {
13916
13869
  hasOnlyBatchActionlet: {
13917
13870
  type: "boolean"
13918
13871
  },
13872
+ hasSaveActionlet: {
13873
+ type: "boolean"
13874
+ },
13875
+ hasDeleteActionlet: {
13876
+ type: "boolean"
13877
+ },
13878
+ hasResetActionlet: {
13879
+ type: "boolean"
13880
+ },
13919
13881
  hasPublishActionlet: {
13920
13882
  type: "boolean"
13921
13883
  },
@@ -13942,15 +13904,6 @@ var paths = {
13942
13904
  },
13943
13905
  hasMoveActionletActionlet: {
13944
13906
  type: "boolean"
13945
- },
13946
- hasSaveActionlet: {
13947
- type: "boolean"
13948
- },
13949
- hasDeleteActionlet: {
13950
- type: "boolean"
13951
- },
13952
- hasResetActionlet: {
13953
- type: "boolean"
13954
13907
  }
13955
13908
  }
13956
13909
  },
@@ -13987,10 +13940,10 @@ var paths = {
13987
13940
  type: {
13988
13941
  type: "string"
13989
13942
  },
13990
- individualPermission: {
13943
+ bitPermission: {
13991
13944
  type: "boolean"
13992
13945
  },
13993
- bitPermission: {
13946
+ individualPermission: {
13994
13947
  type: "boolean"
13995
13948
  },
13996
13949
  roleId: {