@wix/bex-core 2.336.0 → 2.338.0

package/dist/types/types/SchemaSource.d.ts

@@ -1,6 +1,7 @@
 import type { Field, PatternsFieldType } from './Field';
+import type { FieldTypeDefinition } from './FieldTypeDefinition';
 import type { Schema, LoadedSchema } from './Schema';
-import type { FieldPermissions } from './FieldsSource';
+import type { FieldModalText, FieldPermissions, FieldPiiWarning } from './FieldsSource';
 import type { OffsetQuery, OffsetQueryResult } from '../hooks/paginationModeConfig';
 /** A field type a source allows creating. Declare one entry per
  *  `patternsType` — the type is the entry's identity. */
@@ -10,6 +11,15 @@ export interface CreatableFieldType {
     label?: string;
     /** Custom name-input placeholder. Absent ⇒ the UI's standard placeholder. */
     namePlaceholder?: string;
+    /** A one-line description shown under the type in the add-field menu. */
+    subtitle?: string;
+    /** The group heading this type is listed under in the add-field menu, in
+     *  first-seen order. Types sharing a heading form one group. Absent ⇒
+     *  ungrouped. */
+    group?: string;
+    /** Whether a field of this type can be marked PII. Absent ⇒ follows the
+     *  source's `supportsPii`. */
+    supportsPii?: boolean;
 }
 /** What a caller passes. Only `collectionId` and `loadSchema` are required. */
 export interface SchemaSourceInput<T> {
@@ -29,6 +39,9 @@ export interface SchemaSourceInput<T> {
     searchableFieldIds?: (schema: Schema) => string[];
     /** Field types the add-field modal offers. Default: none. */
     creatableFieldTypes?: CreatableFieldType[];
+    /** Consumer-defined field types. A field with `type: 'CUSTOM'` resolves its
+     *  definition here by `customType`. Default: none. */
+    fieldTypes?: FieldTypeDefinition[];
     /** Default: `schemaPermissions.createField`. */
     canAddFields?: (schema: Schema) => boolean;
     /** Default: `schemaPermissions.updateField && !field.isSystem`. */
@@ -39,6 +52,11 @@ export interface SchemaSourceInput<T> {
     fieldPermissions?: FieldPermissions;
     /** Default: `false`. */
     supportsPii?: boolean;
+    /** Warning shown while the PII toggle is on. Read on every render, so it can
+     *  use data that only exists once the schema has loaded. Default: none. */
+    piiWarning?: () => FieldPiiWarning | undefined;
+    /** Title and subtitle for the add/edit field modal. Absent ⇒ generic default. */
+    fieldModalText?: FieldModalText;
     /** The value of a field on an item. Default: `item[field.id]`. */
     getFieldValue?: (item: T, field: Field) => unknown;
     /** Writes a field's value on an item, returning the updated item.
@@ -57,19 +75,27 @@ export interface SchemaSource<T> {
     /** Sources for referenced collections, keyed by referenced collection id. */
     readonly references: Record<string, SchemaSource<any>>;
     readonly creatableFieldTypes: CreatableFieldType[];
+    readonly fieldTypes: FieldTypeDefinition[];
     searchableFieldIds: (schema: Schema) => string[];
     canAddFields: (schema: Schema) => boolean;
     canEditField: (field: Field, schema: Schema) => boolean;
     canDeleteField: (field: Field, schema: Schema) => boolean;
     readonly fieldPermissions?: FieldPermissions;
     readonly supportsPii: boolean;
+    readonly piiWarning?: () => FieldPiiWarning | undefined;
+    readonly fieldModalText?: FieldModalText;
     /** The value of a field on an item. */
     getFieldValue: (item: T, field: Field) => unknown;
     /** Writes a field's value on an item, returning the updated item. */
     setFieldValue: (item: T, field: Field, value: unknown) => T;
 }
 /** The collection fetch derived from a source: loads once, then queries the
- *  backend's `find` scoped to the source's searchable fields. */
+ *  backend's `find`.
+ *
+ *  Free-text search covers the columns the page is showing: the table keeps
+ *  `query.columns` in sync with them, so the scope comes off the query rather
+ *  than being threaded in. Falls back to the source's own `searchableFieldIds`
+ *  before any columns are known (or with no table attached). */
 export declare function sourceFetchData<T>(source: SchemaSource<T>): (query: OffsetQuery) => Promise<OffsetQueryResult<T>>;
 /** Fills source-neutral defaults over `input` and memoizes the load so the collection
  *  query and the table columns share a single fetch. */

package/dist/types/types/SchemaSource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaSource.d.ts","sourceRoot":"","sources":["../../../src/types/SchemaSource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAe,MAAM,UAAU,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EACV,WAAW,EACX,iBAAiB,EAClB,MAAM,+BAA+B,CAAC;AAEvC;yDACyD;AACzD,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,iBAAiB,CAAC;IAChC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6EAA6E;IAC7E,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,+EAA+E;AAC/E,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C;;;uDAGmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC9B,uDAAuD;IACvD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC/B,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;IAClD,6DAA6D;IAC7D,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C,gDAAgD;IAChD,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC3C,mEAAmE;IACnE,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,mEAAmE;IACnE,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC3D,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,wBAAwB;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kEAAkE;IAClE,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC;IACnD;qDACiD;IACjD,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;CAC9D;AAED,mEAAmE;AACnE,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,UAAU,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAClC,2BAA2B;IAC3B,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC7B,yBAAyB;IACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC9B,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IACnD,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;IACjD,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC1C,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IACxD,cAAc,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC1D,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAC7C,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,uCAAuC;IACvC,aAAa,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC;IAClD,qEAAqE;IACrE,aAAa,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;CAC7D;AAOD;iEACiE;AACjE,wBAAgB,eAAe,CAAC,CAAC,EAC/B,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,CAAC,KAAK,EAAE,WAAW,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAOvD;AAED;wDACwD;AACxD,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC1B,YAAY,CAAC,CAAC,CAAC,CA0EjB"}
+{"version":3,"file":"SchemaSource.d.ts","sourceRoot":"","sources":["../../../src/types/SchemaSource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAe,MAAM,UAAU,CAAC;AAClE,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,WAAW,EACX,iBAAiB,EAClB,MAAM,+BAA+B,CAAC;AAEvC;yDACyD;AACzD,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,iBAAiB,CAAC;IAChC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6EAA6E;IAC7E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;qBAEiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;kCAC8B;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C;;;uDAGmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC9B,uDAAuD;IACvD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC/B,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;IAClD,6DAA6D;IAC7D,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C;0DACsD;IACtD,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,gDAAgD;IAChD,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC3C,mEAAmE;IACnE,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,mEAAmE;IACnE,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC3D,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,wBAAwB;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;+EAC2E;IAC3E,UAAU,CAAC,EAAE,MAAM,eAAe,GAAG,SAAS,CAAC;IAC/C,iFAAiF;IACjF,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,kEAAkE;IAClE,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC;IACnD;qDACiD;IACjD,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;CAC9D;AAED,mEAAmE;AACnE,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,UAAU,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAClC,2BAA2B;IAC3B,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC7B,yBAAyB;IACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC9B,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IACnD,QAAQ,CAAC,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAC3C,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;IACjD,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC1C,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IACxD,cAAc,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC1D,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAC7C,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,eAAe,GAAG,SAAS,CAAC;IACxD,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;IACzC,uCAAuC;IACvC,aAAa,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC;IAClD,qEAAqE;IACrE,aAAa,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;CAC7D;AAOD;;;;;;gEAMgE;AAChE,wBAAgB,eAAe,CAAC,CAAC,EAC/B,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,CAAC,KAAK,EAAE,WAAW,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAYvD;AAED;wDACwD;AACxD,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC1B,YAAY,CAAC,CAAC,CAAC,CAgFjB"}

package/dist/types/types/__tests__/defineSchemaSource.fieldTypes.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=defineSchemaSource.fieldTypes.spec.d.ts.map

package/dist/types/types/__tests__/defineSchemaSource.fieldTypes.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineSchemaSource.fieldTypes.spec.d.ts","sourceRoot":"","sources":["../../../../src/types/__tests__/defineSchemaSource.fieldTypes.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/bex-core",
-  "version": "2.336.0",
+  "version": "2.338.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Kobi",
@@ -41,7 +41,7 @@
     "exports"
   ],
   "dependencies": {
-    "@wix/bex-utils": "2.123.0",
+    "@wix/bex-utils": "2.125.0",
     "chance": "^1.0.0",
     "events": "^3.0.0",
     "formstate": "^2.1.0",
@@ -63,7 +63,7 @@
     "@types/react": "^16.0.0",
     "@wix/auto-crud": "^1.0.108",
     "@wix/babel-cli": "^1.11.0",
-    "@wix/cairo-integration-utils": "1.98.0",
+    "@wix/cairo-integration-utils": "1.100.0",
     "@wix/eslint-config-yoshi": "^6.74.0",
     "@wix/fe-essentials": "^1.233.0",
     "@wix/fe-essentials-standalone": "^1.374.0",
@@ -169,5 +169,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "1d72baf424077e1255396c300f21e970688f7bb4de64a5da40017f9e"
+  "falconPackageHash": "2467211b8c5cd94a97397f1ffab97d9f31236d8c3915175bd980918e"
 }