@wix/auto_sdk_data_collections 1.0.110 → 1.0.112
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.
- package/build/cjs/index.d.ts +29 -29
- package/build/cjs/index.js +16 -16
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +83 -33
- package/build/cjs/index.typings.js +16 -16
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +54 -4
- package/build/cjs/meta.js +16 -16
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +29 -29
- package/build/es/index.mjs +16 -16
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +83 -33
- package/build/es/index.typings.mjs +16 -16
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +54 -4
- package/build/es/meta.mjs +16 -16
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +29 -29
- package/build/internal/cjs/index.typings.d.ts +42 -86
- package/build/internal/cjs/meta.d.ts +13 -57
- package/build/internal/es/index.d.mts +29 -29
- package/build/internal/es/index.typings.d.mts +42 -86
- package/build/internal/es/meta.d.mts +13 -57
- package/package.json +3 -3
|
@@ -1112,27 +1112,15 @@ declare enum FieldPluginType {
|
|
|
1112
1112
|
UNKNOWN = "UNKNOWN",
|
|
1113
1113
|
/** CMS-related field attributes. */
|
|
1114
1114
|
CMS = "CMS",
|
|
1115
|
-
/**
|
|
1116
|
-
* Marks a multi-reference field as a category field linking to a Category Group.
|
|
1117
|
-
* @documentationMaturity preview
|
|
1118
|
-
* @internal
|
|
1119
|
-
*/
|
|
1115
|
+
/** Marks a multi-reference field as a category field linking to a Category Group. */
|
|
1120
1116
|
CATEGORY_FIELD = "CATEGORY_FIELD",
|
|
1121
|
-
/**
|
|
1122
|
-
* Marks a back-reference field on Category Groups indicating a consumer relationship.
|
|
1123
|
-
* @documentationMaturity preview
|
|
1124
|
-
* @internal
|
|
1125
|
-
*/
|
|
1117
|
+
/** Marks a back-reference field on Category Groups indicating a consumer relationship. */
|
|
1126
1118
|
CATEGORY_CONSUMER = "CATEGORY_CONSUMER",
|
|
1127
|
-
/**
|
|
1128
|
-
* Marks the auto-managed primary category single-reference field on a consumer collection.
|
|
1129
|
-
* @documentationMaturity preview
|
|
1130
|
-
* @internal
|
|
1131
|
-
*/
|
|
1119
|
+
/** Marks the auto-managed primary category single-reference field on a consumer collection. */
|
|
1132
1120
|
PRIMARY_CATEGORY_FIELD = "PRIMARY_CATEGORY_FIELD"
|
|
1133
1121
|
}
|
|
1134
1122
|
/** @enumType */
|
|
1135
|
-
type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
|
|
1123
|
+
type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS' | 'CATEGORY_FIELD' | 'CATEGORY_CONSUMER' | 'PRIMARY_CATEGORY_FIELD';
|
|
1136
1124
|
/** Options for the CMS plugin. */
|
|
1137
1125
|
interface CmsOptions {
|
|
1138
1126
|
/**
|
|
@@ -1226,15 +1214,9 @@ interface Plugin extends PluginOptionsOneOf {
|
|
|
1226
1214
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
1227
1215
|
/** Options for the CMS plugin. */
|
|
1228
1216
|
cmsOptions?: PluginCmsOptions;
|
|
1229
|
-
/**
|
|
1230
|
-
* Options for the Catalog plugin.
|
|
1231
|
-
* @internal
|
|
1232
|
-
*/
|
|
1217
|
+
/** Options for the Catalog plugin. */
|
|
1233
1218
|
catalogOptions?: CatalogOptions;
|
|
1234
|
-
/**
|
|
1235
|
-
* Options for the Draft Items plugin.
|
|
1236
|
-
* @internal
|
|
1237
|
-
*/
|
|
1219
|
+
/** Options for the Draft Items plugin. */
|
|
1238
1220
|
draftItemsOptions?: DraftItemsPluginOptions;
|
|
1239
1221
|
/** Plugin type. */
|
|
1240
1222
|
type?: PluginTypeWithLiterals;
|
|
@@ -1256,15 +1238,9 @@ interface PluginOptionsOneOf {
|
|
|
1256
1238
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
1257
1239
|
/** Options for the CMS plugin. */
|
|
1258
1240
|
cmsOptions?: PluginCmsOptions;
|
|
1259
|
-
/**
|
|
1260
|
-
* Options for the Catalog plugin.
|
|
1261
|
-
* @internal
|
|
1262
|
-
*/
|
|
1241
|
+
/** Options for the Catalog plugin. */
|
|
1263
1242
|
catalogOptions?: CatalogOptions;
|
|
1264
|
-
/**
|
|
1265
|
-
* Options for the Draft Items plugin.
|
|
1266
|
-
* @internal
|
|
1267
|
-
*/
|
|
1243
|
+
/** Options for the Draft Items plugin. */
|
|
1268
1244
|
draftItemsOptions?: DraftItemsPluginOptions;
|
|
1269
1245
|
}
|
|
1270
1246
|
declare enum Status {
|
|
@@ -1320,20 +1296,17 @@ interface DraftPermissions {
|
|
|
1320
1296
|
* Access level required to view/edit/remove items from the drafts collection.
|
|
1321
1297
|
* Can be set to one of CMS_EDITOR, PRIVILEGED
|
|
1322
1298
|
* Default: `CMS_EDITOR`
|
|
1323
|
-
* @internal
|
|
1324
1299
|
*/
|
|
1325
1300
|
manageDrafts?: AccessLevelWithLiterals;
|
|
1326
1301
|
/**
|
|
1327
1302
|
* Access level required to publish draft items and unpublish published items.
|
|
1328
1303
|
* Can be set to one of CMS_EDITOR, PRIVILEGED
|
|
1329
1304
|
* Default: `CMS_EDITOR`
|
|
1330
|
-
* @internal
|
|
1331
1305
|
*/
|
|
1332
1306
|
managePublishStatus?: AccessLevelWithLiterals;
|
|
1333
1307
|
/**
|
|
1334
1308
|
* Access level required to view draft items. Managing drafts also grants viewing.
|
|
1335
1309
|
* If omitted, inherits manage_drafts for compatibility.
|
|
1336
|
-
* @internal
|
|
1337
1310
|
*/
|
|
1338
1311
|
viewDrafts?: AccessLevelWithLiterals;
|
|
1339
1312
|
}
|
|
@@ -1362,27 +1335,15 @@ declare enum PluginType {
|
|
|
1362
1335
|
EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
|
|
1363
1336
|
/** CMS-specific collection properties. */
|
|
1364
1337
|
CMS = "CMS",
|
|
1365
|
-
/**
|
|
1366
|
-
* Indicates that the collection is used as a [Wix Catalog](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalogs/catalog-service-plugin/introduction) app. This plugin is used to manage product data and is required for collections that are part of a catalog.
|
|
1367
|
-
* @documentationMaturity preview
|
|
1368
|
-
* @internal
|
|
1369
|
-
*/
|
|
1338
|
+
/** Indicates that the collection is used as a [Wix Catalog](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalogs/catalog-service-plugin/introduction) app. This plugin is used to manage product data and is required for collections that are part of a catalog. */
|
|
1370
1339
|
CATALOG = "CATALOG",
|
|
1371
|
-
/**
|
|
1372
|
-
* Marks the collection as a Category Group for categorization features.
|
|
1373
|
-
* @documentationMaturity preview
|
|
1374
|
-
* @internal
|
|
1375
|
-
*/
|
|
1340
|
+
/** Marks the collection as a Category Group for categorization features. */
|
|
1376
1341
|
CATEGORIES = "CATEGORIES",
|
|
1377
|
-
/**
|
|
1378
|
-
* Enables the draft items collection: safe draft editing with explicit publish step.
|
|
1379
|
-
* @documentationMaturity preview
|
|
1380
|
-
* @internal
|
|
1381
|
-
*/
|
|
1342
|
+
/** Enables the draft items collection: safe draft editing with explicit publish step. */
|
|
1382
1343
|
DRAFT_ITEMS = "DRAFT_ITEMS"
|
|
1383
1344
|
}
|
|
1384
1345
|
/** @enumType */
|
|
1385
|
-
type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
|
|
1346
|
+
type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS' | 'CATALOG' | 'CATEGORIES' | 'DRAFT_ITEMS';
|
|
1386
1347
|
interface PublishPluginOptions {
|
|
1387
1348
|
/**
|
|
1388
1349
|
* Publication status assigned to items that don't specify one.
|
|
@@ -1607,14 +1568,10 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
|
|
|
1607
1568
|
* @readonly
|
|
1608
1569
|
*/
|
|
1609
1570
|
publishedCollectionId?: string;
|
|
1610
|
-
/**
|
|
1611
|
-
* Access levels required to view and manage drafts and change publication status.
|
|
1612
|
-
* @internal
|
|
1613
|
-
*/
|
|
1571
|
+
/** Access levels required to view and manage drafts and change publication status. */
|
|
1614
1572
|
draftPermissions?: DraftPermissions;
|
|
1615
1573
|
/**
|
|
1616
1574
|
* Actual draft management operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`.
|
|
1617
|
-
* @internal
|
|
1618
1575
|
* @readonly
|
|
1619
1576
|
*/
|
|
1620
1577
|
allowedPermissions?: AllowedDraftPermissions;
|
|
@@ -1622,7 +1579,6 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
|
|
|
1622
1579
|
* Whether writes to the published collection are allowed while the Draft Items plugin is enabled.
|
|
1623
1580
|
* Defaults to `false` for newly created collections and newly added plugins.
|
|
1624
1581
|
* Existing schemas that predate this field return `true` for backwards compatibility.
|
|
1625
|
-
* @internal
|
|
1626
1582
|
*/
|
|
1627
1583
|
allowWritesToPublishedCollection?: boolean;
|
|
1628
1584
|
}
|