@universal-ember/table 3.5.0 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/declarations/-private/interfaces/table.d.ts +7 -2
  2. package/declarations/-private/interfaces/table.d.ts.map +1 -1
  3. package/declarations/-private/table.d.ts.map +1 -1
  4. package/dist/-private/table.js +8 -5
  5. package/dist/-private/table.js.map +1 -1
  6. package/package.json +1 -1
  7. package/src/-private/interfaces/table.ts +25 -21
  8. package/src/-private/table.ts +7 -2
package/declarations/-private/interfaces/table.d.ts CHANGED
@@ -96,7 +96,9 @@ export interface TableConfig<DataType> {
96
96
  * you have a table representing "blog posts", your table key may be "blog-posts".
97
97
  *
98
98
  * And most importantly, the `adapter` is how you load and save the preferences.
99
- * This may bo to local storage, or some API.
99
+ * This may be to local storage, or some API.
100
+ *
101
+ * Can be provided as a thunk for reactive multi-table sync.
100
102
  */
101
103
  preferences?: {
102
104
  /**
@@ -117,6 +119,9 @@ export interface TableConfig<DataType> {
117
119
  * So it's best to load up the table preferences before rendering a table.
118
120
  */
119
121
  adapter?: PreferencesAdapter;
120
- };
122
+ } | (() => {
123
+ key: string;
124
+ adapter?: PreferencesAdapter;
125
+ });
121
126
  }
122
127
  //# sourceMappingURL=table.d.ts.map
package/declarations/-private/interfaces/table.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../src/-private/interfaces/table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,SAAS;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,WAAW,CAAC,QAAQ;IACnC;;;;OAIG;IACH,OAAO,EAAE,MAAM,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,QAAQ,EAAE,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAKlB,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAI/B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,QAAQ,CAAC;IAC9B,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,GAAG,SAAS,KAAK,IAAI,CAAC;IAGjE,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE;QACZ;;;;;;;WAOG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;;;;;WAOG;QACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;KAC9B,CAAC;CACH"}
1
+ {"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../src/-private/interfaces/table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,SAAS;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,WAAW,CAAC,QAAQ;IACnC;;;;OAIG;IACH,OAAO,EAAE,MAAM,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,QAAQ,EAAE,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAKlB,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAI/B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,QAAQ,CAAC;IAC9B,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,GAAG,SAAS,KAAK,IAAI,CAAC;IAGjE,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;OASG;IACH,WAAW,CAAC,EACR;QACE;;;;;;;WAOG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;;;;;WAOG;QACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;KAC9B,GACD,CAAC,MAAM;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,kBAAkB,CAAA;KAAE,CAAC,CAAC;CAC3D"}
package/declarations/-private/table.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/-private/table.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAO7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAc,WAAW,EAAE,MAAM,cAAc,CAAC;AAW5D,UAAU,SAAS,CAAC,QAAQ;IAC1B,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,eAA0B,CAAC;AACjD,eAAO,MAAM,cAAc,eAA2B,CAAC;AACvD,eAAO,MAAM,eAAe,eAA4B,CAAC;AACzD,eAAO,MAAM,YAAY,eAAyB,CAAC;AAQnD,qBAAa,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAE,SAAQ,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC1E;;OAEG;IACH,CAAC,SAAS,CAAC,SAAiB;IAC5B;;OAEG;IACH,CAAC,cAAc,CAAC,2BAAkC;IAClD;;OAEG;IACH,CAAC,eAAe,CAAC,qDAAmD;IACpE;;OAEG;IACH,CAAC,YAAY,CAAC,kEAAgD;IAE9D;;;;;OAKG;IACM,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAExC;;;;;;OAMG;IACM,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAEvC;;;;OAIG;IACc,IAAI,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC;IAE/D;;OAEG;IACH,sBAAsB,CAAC,EAAE,WAAW,CAAC;IAErC;;;OAGG;IACK,WAAW,EAAE,gBAAgB,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;IAiB7D;;;;;;;;OAQG;IACH,SAAS;;;;;;;;;;;;;;;;;;;;;;MAuCP;IAEF;;;;;;OAMG;IACH,IACI,OAAO,IAAI,MAAM,EAAE,CA2BtB;IAED;;OAEG;IACH,QAAQ,CAAC,QAAQ,SAAS,UAAU,CAAC,GAAG,CAAC,EACvC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,GACrB,QAAQ,GAAG,SAAS;IAevB;;;;OAIG;IACH,IAAI,MAAM,0BAET;IAED,IAAI,mEASD;IAEH,OAAO,2GAqCJ;IAEH;;OAEG;IAEH,oBAAoB;IAOpB,eAAe;CAGhB"}
1
+ {"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/-private/table.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAO7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAc,WAAW,EAAE,MAAM,cAAc,CAAC;AAW5D,UAAU,SAAS,CAAC,QAAQ;IAC1B,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,eAA0B,CAAC;AACjD,eAAO,MAAM,cAAc,eAA2B,CAAC;AACvD,eAAO,MAAM,eAAe,eAA4B,CAAC;AACzD,eAAO,MAAM,YAAY,eAAyB,CAAC;AAQnD,qBAAa,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAE,SAAQ,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC1E;;OAEG;IACH,CAAC,SAAS,CAAC,SAAiB;IAC5B;;OAEG;IACH,CAAC,cAAc,CAAC,2BAAkC;IAClD;;OAEG;IACH,CAAC,eAAe,CAAC,qDAAmD;IACpE;;OAEG;IACH,CAAC,YAAY,CAAC,kEAAgD;IAE9D;;;;;OAKG;IACM,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAExC;;;;;;OAMG;IACM,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAEvC;;;;OAIG;IACc,IAAI,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC;IAE/D;;OAEG;IACH,sBAAsB,CAAC,EAAE,WAAW,CAAC;IAErC;;;OAGG;IACK,WAAW,EAAE,gBAAgB,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;IAsB7D;;;;;;;;OAQG;IACH,SAAS;;;;;;;;;;;;;;;;;;;;;;MAuCP;IAEF;;;;;;OAMG;IACH,IACI,OAAO,IAAI,MAAM,EAAE,CA2BtB;IAED;;OAEG;IACH,QAAQ,CAAC,QAAQ,SAAS,UAAU,CAAC,GAAG,CAAC,EACvC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,GACrB,QAAQ,GAAG,SAAS;IAevB;;;;OAIG;IACH,IAAI,MAAM,0BAET;IAED,IAAI,mEASD;IAEH,OAAO,2GAqCJ;IAEH;;OAEG;IAEH,oBAAoB;IAOpB,eAAe;CAGhB"}
package/dist/-private/table.js CHANGED
@@ -172,20 +172,23 @@ let Table = (_class = class Table extends Resource {
172
172
  this.args = {
173
173
  named
174
174
  };
175
+ const preferences = named?.preferences;
176
+ const {
177
+ key = guidFor(this),
178
+ adapter
179
+ } = (typeof preferences === 'function' ? preferences() : preferences) ?? {};
175
180
 
176
181
  // only set the preferences once
177
182
  if (!this.preferences) {
178
- const {
179
- key = guidFor(this),
180
- adapter
181
- } = named?.preferences ?? {};
182
-
183
183
  // TODO: when no key is present,
184
184
  // use "local-storage" preferences.
185
185
  // it does not make sense to use a guid in a user's preferences
186
186
  this.preferences = new TablePreferences(key, adapter);
187
187
  } else {
188
188
  // subsequent updates to args
189
+ if (typeof preferences === 'function' && adapter) {
190
+ this.preferences.restore(adapter);
191
+ }
189
192
  this.resetScrollContainer();
190
193
  }
191
194
  }
package/dist/-private/table.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"table.js","sources":["../../src/-private/table.ts"],"sourcesContent":["import { cached, tracked } from '@glimmer/tracking';\nimport { assert } from '@ember/debug';\nimport { action } from '@ember/object';\nimport { guidFor } from '@ember/object/internals';\n\nimport { isDevelopingApp, macroCondition } from '@embroider/macros';\nimport { modifier } from 'ember-modifier';\nimport { Resource } from 'ember-modify-based-class-resource';\nimport { map } from 'reactiveweb/map';\n\nimport {\n normalizePluginsConfig,\n verifyPlugins,\n} from '../plugins/-private/utils.ts';\nimport { Column } from './column.ts';\nimport { TablePreferences } from './preferences.ts';\nimport { Row } from './row.ts';\nimport { composeFunctionModifiers } from './utils.ts';\n\nimport type { BasePlugin, Plugin } from '../plugins/index.ts';\nimport type { Class } from './private-types.ts';\nimport type { Destructor, TableConfig } from './interfaces';\nimport { compatOwner } from './ember-compat.ts';\n\nconst getOwner = compatOwner.getOwner;\nconst setOwner = compatOwner.setOwner;\n\nconst DEFAULT_COLUMN_CONFIG = {\n isVisible: true,\n minWidth: 128,\n};\n\ninterface Signature<DataType> {\n Named: TableConfig<DataType>;\n}\n\n/**\n * Because the table is our entry-point object to all the table behaviors,\n * we need a stable way to know which table we have.\n * Normally, this could be done with referential integrity / identity.\n * However, due to how resources are implemented, if the consumer opts to\n * not use the `@use` decorator, then proxies get involved.\n * The proxies don't maintain instanceof checks, which may be a bug in\n * ember-resources.\n */\nexport const TABLE_KEY = Symbol('__TABLE_KEY__');\nexport const TABLE_META_KEY = Symbol('__TABLE_META__');\nexport const COLUMN_META_KEY = Symbol('__COLUMN_META__');\nexport const ROW_META_KEY = Symbol('__ROW_META__');\n\nconst attachContainer = (element: Element, table: Table) => {\n assert('Must be installed on an HTMLElement', element instanceof HTMLElement);\n\n table.scrollContainerElement = element;\n};\n\nexport class Table<DataType = unknown> extends Resource<Signature<DataType>> {\n /**\n * @private\n */\n [TABLE_KEY] = guidFor(this);\n /**\n * @private\n */\n [TABLE_META_KEY] = new Map<Class<unknown>, any>();\n /**\n * @private\n */\n [COLUMN_META_KEY] = new WeakMap<Column, Map<Class<unknown>, any>>();\n /**\n * @private\n */\n [ROW_META_KEY] = new WeakMap<Row, Map<Class<unknown>, any>>();\n\n /**\n * @private\n *\n * Unused for now, may be used in the future.\n * This data is collected along with the scrollContainerWidth, (which is currently in use)\n */\n @tracked scrollContainerHeight?: number;\n\n /**\n * @private\n *\n * Used to help determine how much space we can give to columns.\n * As we generate widths for columns, the columns' widths must\n * add up to about this number.\n */\n @tracked scrollContainerWidth?: number;\n\n /**\n * @private\n *\n * Lazy way to delay consuming arguments until they are needed.\n */\n @tracked declare args: { named: Signature<DataType>['Named'] };\n\n /**\n * @private\n */\n scrollContainerElement?: HTMLElement;\n\n /**\n * Interact with, save, modify, etc the preferences for the table,\n * plugins, columns, etc\n */\n declare preferences: TablePreferences;\n\n /**\n * @private\n */\n modify(_: [] | undefined, named: Signature<DataType>['Named']) {\n this.args = { named };\n\n // only set the preferences once\n if (!this.preferences) {\n const { key = guidFor(this), adapter } = named?.preferences ?? {};\n\n // TODO: when no key is present,\n // use \"local-storage\" preferences.\n // it does not make sense to use a guid in a user's preferences\n this.preferences = new TablePreferences(key, adapter);\n } else {\n // subsequent updates to args\n this.resetScrollContainer();\n }\n }\n\n /**\n * Collection of utility modifiers that are the result of composing modifiers\n * from plugins.\n *\n * Using this is optional, and you can \"just\" use modifiers from specific plugins\n * in specific places if you wish -- but these exists as a \"convenience\".\n *\n * These are all no-use, no-cost utilities\n */\n modifiers = {\n container: modifier((element: HTMLElement): Destructor => {\n const modifiers = this.plugins.map((plugin) => plugin.containerModifier);\n const composed = composeFunctionModifiers([\n attachContainer,\n ...modifiers,\n ]);\n\n return composed(element, this as Table<unknown>);\n }),\n\n // resize: ResizeModifier,\n // TODO: switch to composing real modifiers once \"curry\" and \"compose\"\n // RFCs are accepted and implemented\n //\n // Atm the moment, if _any_ header modifier's tracked data changes,\n // all the functions for all of the plugins run again.\n //\n // With curried+composed modifiers, only the plugin's headerModifier\n // that has tracked changes would run, leaving the other modifiers alone\n columnHeader: modifier(\n (element: HTMLElement, [column]: [Column<DataType>]): Destructor => {\n const modifiers = this.plugins.map(\n (plugin) => plugin.headerCellModifier,\n );\n const composed = composeFunctionModifiers(modifiers);\n\n return composed(element, { column, table: this });\n },\n ),\n\n row: modifier(\n (element: HTMLElement, [row]: [Row<DataType>]): Destructor => {\n const modifiers = this.plugins.map((plugin) => plugin.rowModifier);\n const composed = composeFunctionModifiers(modifiers);\n\n return composed(element, { row, table: this });\n },\n ),\n };\n\n /**\n * @private\n *\n * For all configured plugins, instantiates each one.\n * If the plugins argument changes to the Table (either directly or through\n * headlessTable, all state is lost and re-created)\n */\n @cached\n get plugins(): Plugin[] {\n const plugins = normalizePluginsConfig(this.args.named?.plugins);\n\n verifyPlugins(plugins);\n\n return plugins.map((tuple) => {\n // We don't need the options here\n const [PluginClass] = tuple;\n\n if (typeof PluginClass === 'function') {\n const plugin = new PluginClass(this);\n\n const owner = getOwner(this);\n\n assert(\n `The Table does not have an owner. cannot create a plugin without an owner`,\n owner,\n );\n setOwner(plugin, owner);\n\n return plugin;\n }\n\n // This is a plugin object, rather than a class\n // TODO: add test coverage around using classless plugins\n return PluginClass;\n });\n }\n\n /**\n * Get the active plugin instance for the given plugin class\n */\n pluginOf<Instance extends BasePlugin<any>>(\n klass: Class<Instance>,\n ): Instance | undefined {\n const result = this.plugins.find((plugin) => plugin instanceof klass);\n\n /**\n * This is an unsafe cast, because Instance could be unrelated to any of the types\n * that matches Plugin[]\n *\n * For example, `table.pluginOf(MyCustomPlugin)`, where MyCustomPlugin isn't in the\n * `plugins` list. This partially a problem with how Array.prototype.find doesn't\n * effectively narrow for what we want (combined with TS being clunky around\n * comparing Instance and Class types).\n */\n return result as unknown as Instance | undefined;\n }\n\n /**\n * @private\n *\n * used by other private APIs\n */\n get config() {\n return this.args.named;\n }\n\n rows = map(this, {\n data: () => {\n const dataFn = this.args.named?.data;\n\n if (!dataFn) return [];\n\n return dataFn() ?? [];\n },\n map: (datum) => new Row(this, datum),\n });\n\n columns = map(this, {\n data: () => {\n const configFn = this.args.named?.columns;\n\n if (!configFn) return [];\n\n const result = configFn() ?? [];\n\n if (macroCondition(isDevelopingApp())) {\n /**\n * Assertions for a column config to be valid:\n * - every key must be unique\n */\n const keys = new Set();\n const allKeys = result.map((columnConfig) => columnConfig.key);\n\n result.forEach((columnConfig) => {\n if (keys.has(columnConfig.key)) {\n throw new Error(\n `Every column key in the table's column config must be unique. ` +\n `Found duplicate entry: ${columnConfig.key}. ` +\n `All keys used: ${allKeys}`,\n );\n }\n\n keys.add(columnConfig.key);\n });\n }\n\n return result;\n },\n map: (config) => {\n return new Column<DataType>(this, {\n ...DEFAULT_COLUMN_CONFIG,\n ...config,\n });\n },\n });\n\n /**\n * @private\n */\n @action\n resetScrollContainer() {\n if (!this.scrollContainerElement) return;\n\n this.scrollContainerElement.scrollTop = 0;\n }\n\n @action\n resetToDefaults() {\n this.plugins.forEach((plugin) => plugin.reset?.());\n }\n}\n"],"names":["getOwner","compatOwner","setOwner","DEFAULT_COLUMN_CONFIG","isVisible","minWidth","TABLE_KEY","Symbol","TABLE_META_KEY","COLUMN_META_KEY","ROW_META_KEY","attachContainer","element","table","assert","HTMLElement","scrollContainerElement","Table","_class","Resource","constructor","args","_defineProperty","guidFor","Map","WeakMap","_initializerDefineProperty","_descriptor","_descriptor2","_descriptor3","container","modifier","modifiers","plugins","map","plugin","containerModifier","composed","composeFunctionModifiers","columnHeader","column","headerCellModifier","row","rowModifier","data","dataFn","named","datum","Row","configFn","columns","result","macroCondition","isDevelopingApp","keys","Set","allKeys","columnConfig","key","forEach","has","Error","add","config","Column","modify","_","preferences","adapter","TablePreferences","resetScrollContainer","normalizePluginsConfig","verifyPlugins","tuple","PluginClass","owner","pluginOf","klass","find","scrollTop","resetToDefaults","reset","_applyDecoratedDescriptor","prototype","tracked","configurable","enumerable","writable","initializer","cached","Object","getOwnPropertyDescriptor","action"],"mappings":";;;;;;;;;;;;;;;;;AAwBA,MAAMA,QAAQ,GAAGC,WAAW,CAACD,QAAQ;AACrC,MAAME,QAAQ,GAAGD,WAAW,CAACC,QAAQ;AAErC,MAAMC,qBAAqB,GAAG;AAC5BC,EAAAA,SAAS,EAAE,IAAI;AACfC,EAAAA,QAAQ,EAAE;AACZ,CAAC;AAMD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACaC,SAAS,GAAGC,MAAM,CAAC,eAAe;MAClCC,cAAc,GAAGD,MAAM,CAAC,gBAAgB;MACxCE,eAAe,GAAGF,MAAM,CAAC,iBAAiB;MAC1CG,YAAY,GAAGH,MAAM,CAAC,cAAc;AAEjD,MAAMI,eAAe,GAAGA,CAACC,OAAgB,EAAEC,KAAY,KAAK;AAC1DC,EAAAA,MAAM,CAAC,qCAAqC,EAAEF,OAAO,YAAYG,WAAW,CAAC;EAE7EF,KAAK,CAACG,sBAAsB,GAAGJ,OAAO;AACxC,CAAC;AAEYK,IAAAA,KAAK,IAAAC,MAAA,GAAX,MAAMD,KAAK,SAA6BE,QAAQ,CAAsB;AAAAC,EAAAA,WAAAA,CAAA,GAAAC,IAAA,EAAA;AAAA,IAAA,KAAA,CAAA,GAAAA,IAAA,CAAA;AAC3E;AACF;AACA;AAFEC,IAAAA,eAAA,OAGChB,SAAS,EAAIiB,OAAO,CAAC,IAAI,CAAC,CAAA;AAC3B;AACF;AACA;AAFED,IAAAA,eAAA,OAGCd,cAAc,EAAI,IAAIgB,GAAG,EAAuB,CAAA;AACjD;AACF;AACA;AAFEF,IAAAA,eAAA,OAGCb,eAAe,EAAI,IAAIgB,OAAO,EAAoC,CAAA;AACnE;AACF;AACA;AAFEH,IAAAA,eAAA,OAGCZ,YAAY,EAAI,IAAIe,OAAO,EAAiC,CAAA;AAE7D;AACF;AACA;AACA;AACA;AACA;AALEC,IAAAA,0BAAA,gCAAAC,WAAA,EAAA,IAAA,CAAA;AAQA;AACF;AACA;AACA;AACA;AACA;AACA;AANED,IAAAA,0BAAA,+BAAAE,YAAA,EAAA,IAAA,CAAA;AASA;AACF;AACA;AACA;AACA;AAJEF,IAAAA,0BAAA,eAAAG,YAAA,EAAA,IAAA,CAAA;AAOA;AACF;AACA;IAFEP,eAAA,CAAA,IAAA,EAAA,wBAAA,EAAA,MAAA,CAAA;AA+BA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAREA,IAAAA,eAAA,CASY,IAAA,EAAA,WAAA,EAAA;AACVQ,MAAAA,SAAS,EAAEC,QAAQ,CAAEnB,OAAoB,IAAiB;AACxD,QAAA,MAAMoB,SAAS,GAAG,IAAI,CAACC,OAAO,CAACC,GAAG,CAAEC,MAAM,IAAKA,MAAM,CAACC,iBAAiB,CAAC;QACxE,MAAMC,QAAQ,GAAGC,wBAAwB,CAAC,CACxC3B,eAAe,EACf,GAAGqB,SAAS,CACb,CAAC;AAEF,QAAA,OAAOK,QAAQ,CAACzB,OAAO,EAAE,IAAsB,CAAC;AAClD,OAAC,CAAC;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACA2B,YAAY,EAAER,QAAQ,CACpB,CAACnB,OAAoB,EAAE,CAAC4B,MAAM,CAAqB,KAAiB;AAClE,QAAA,MAAMR,SAAS,GAAG,IAAI,CAACC,OAAO,CAACC,GAAG,CAC/BC,MAAM,IAAKA,MAAM,CAACM,kBACrB,CAAC;AACD,QAAA,MAAMJ,QAAQ,GAAGC,wBAAwB,CAACN,SAAS,CAAC;QAEpD,OAAOK,QAAQ,CAACzB,OAAO,EAAE;UAAE4B,MAAM;AAAE3B,UAAAA,KAAK,EAAE;AAAK,SAAC,CAAC;AACnD,OACF,CAAC;MAED6B,GAAG,EAAEX,QAAQ,CACX,CAACnB,OAAoB,EAAE,CAAC8B,GAAG,CAAkB,KAAiB;AAC5D,QAAA,MAAMV,SAAS,GAAG,IAAI,CAACC,OAAO,CAACC,GAAG,CAAEC,MAAM,IAAKA,MAAM,CAACQ,WAAW,CAAC;AAClE,QAAA,MAAMN,QAAQ,GAAGC,wBAAwB,CAACN,SAAS,CAAC;QAEpD,OAAOK,QAAQ,CAACzB,OAAO,EAAE;UAAE8B,GAAG;AAAE7B,UAAAA,KAAK,EAAE;AAAK,SAAC,CAAC;OAElD;KACD,CAAA;AAAAS,IAAAA,eAAA,CAoEMY,IAAAA,EAAAA,MAAAA,EAAAA,GAAG,CAAC,IAAI,EAAE;MACfU,IAAI,EAAEA,MAAM;QACV,MAAMC,MAAM,GAAG,IAAI,CAACxB,IAAI,CAACyB,KAAK,EAAEF,IAAI;AAEpC,QAAA,IAAI,CAACC,MAAM,EAAE,OAAO,EAAE;AAEtB,QAAA,OAAOA,MAAM,EAAE,IAAI,EAAE;OACtB;MACDX,GAAG,EAAGa,KAAK,IAAK,IAAIC,GAAG,CAAC,IAAI,EAAED,KAAK;AACrC,KAAC,CAAC,CAAA;AAAAzB,IAAAA,eAAA,CAEQY,IAAAA,EAAAA,SAAAA,EAAAA,GAAG,CAAC,IAAI,EAAE;MAClBU,IAAI,EAAEA,MAAM;QACV,MAAMK,QAAQ,GAAG,IAAI,CAAC5B,IAAI,CAACyB,KAAK,EAAEI,OAAO;AAEzC,QAAA,IAAI,CAACD,QAAQ,EAAE,OAAO,EAAE;AAExB,QAAA,MAAME,MAAM,GAAGF,QAAQ,EAAE,IAAI,EAAE;AAE/B,QAAA,IAAIG,cAAc,CAACC,eAAe,EAAE,CAAC,EAAE;AACrC;AACR;AACA;AACA;AACQ,UAAA,MAAMC,IAAI,GAAG,IAAIC,GAAG,EAAE;UACtB,MAAMC,OAAO,GAAGL,MAAM,CAACjB,GAAG,CAAEuB,YAAY,IAAKA,YAAY,CAACC,GAAG,CAAC;AAE9DP,UAAAA,MAAM,CAACQ,OAAO,CAAEF,YAAY,IAAK;YAC/B,IAAIH,IAAI,CAACM,GAAG,CAACH,YAAY,CAACC,GAAG,CAAC,EAAE;AAC9B,cAAA,MAAM,IAAIG,KAAK,CACb,CAAA,8DAAA,CAAgE,GAC9D,CAA0BJ,uBAAAA,EAAAA,YAAY,CAACC,GAAG,CAAI,EAAA,CAAA,GAC9C,CAAkBF,eAAAA,EAAAA,OAAO,EAC7B,CAAC;AACH;AAEAF,YAAAA,IAAI,CAACQ,GAAG,CAACL,YAAY,CAACC,GAAG,CAAC;AAC5B,WAAC,CAAC;AACJ;AAEA,QAAA,OAAOP,MAAM;OACd;MACDjB,GAAG,EAAG6B,MAAM,IAAK;AACf,QAAA,OAAO,IAAIC,MAAM,CAAW,IAAI,EAAE;AAChC,UAAA,GAAG7D,qBAAqB;UACxB,GAAG4D;AACL,SAAC,CAAC;AACJ;AACF,KAAC,CAAC,CAAA;AAAA;AA9LF;AACF;AACA;AACA;;AAGE;AACF;AACA;AACEE,EAAAA,MAAMA,CAACC,CAAiB,EAAEpB,KAAmC,EAAE;IAC7D,IAAI,CAACzB,IAAI,GAAG;AAAEyB,MAAAA;KAAO;;AAErB;AACA,IAAA,IAAI,CAAC,IAAI,CAACqB,WAAW,EAAE;MACrB,MAAM;AAAET,QAAAA,GAAG,GAAGnC,OAAO,CAAC,IAAI,CAAC;AAAE6C,QAAAA;AAAQ,OAAC,GAAGtB,KAAK,EAAEqB,WAAW,IAAI,EAAE;;AAEjE;AACA;AACA;MACA,IAAI,CAACA,WAAW,GAAG,IAAIE,gBAAgB,CAACX,GAAG,EAAEU,OAAO,CAAC;AACvD,KAAC,MAAM;AACL;MACA,IAAI,CAACE,oBAAoB,EAAE;AAC7B;AACF;AAoDA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,IACIrC,OAAOA,GAAa;IACtB,MAAMA,OAAO,GAAGsC,sBAAsB,CAAC,IAAI,CAAClD,IAAI,CAACyB,KAAK,EAAEb,OAAO,CAAC;IAEhEuC,aAAa,CAACvC,OAAO,CAAC;AAEtB,IAAA,OAAOA,OAAO,CAACC,GAAG,CAAEuC,KAAK,IAAK;AAC5B;AACA,MAAA,MAAM,CAACC,WAAW,CAAC,GAAGD,KAAK;AAE3B,MAAA,IAAI,OAAOC,WAAW,KAAK,UAAU,EAAE;AACrC,QAAA,MAAMvC,MAAM,GAAG,IAAIuC,WAAW,CAAC,IAAI,CAAC;AAEpC,QAAA,MAAMC,KAAK,GAAG3E,QAAQ,CAAC,IAAI,CAAC;AAE5Bc,QAAAA,MAAM,CACJ,CAAA,yEAAA,CAA2E,EAC3E6D,KACF,CAAC;AACDzE,QAAAA,QAAQ,CAACiC,MAAM,EAAEwC,KAAK,CAAC;AAEvB,QAAA,OAAOxC,MAAM;AACf;;AAEA;AACA;AACA,MAAA,OAAOuC,WAAW;AACpB,KAAC,CAAC;AACJ;;AAEA;AACF;AACA;EACEE,QAAQA,CACNC,KAAsB,EACA;AACtB,IAAA,MAAM1B,MAAM,GAAG,IAAI,CAAClB,OAAO,CAAC6C,IAAI,CAAE3C,MAAM,IAAKA,MAAM,YAAY0C,KAAK,CAAC;;AAErE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACI,IAAA,OAAO1B,MAAM;AACf;;AAEA;AACF;AACA;AACA;AACA;EACE,IAAIY,MAAMA,GAAG;AACX,IAAA,OAAO,IAAI,CAAC1C,IAAI,CAACyB,KAAK;AACxB;AAoDA;AACF;AACA;AAEEwB,EAAAA,oBAAoBA,GAAG;AACrB,IAAA,IAAI,CAAC,IAAI,CAACtD,sBAAsB,EAAE;AAElC,IAAA,IAAI,CAACA,sBAAsB,CAAC+D,SAAS,GAAG,CAAC;AAC3C;AAGAC,EAAAA,eAAeA,GAAG;AAChB,IAAA,IAAI,CAAC/C,OAAO,CAAC0B,OAAO,CAAExB,MAAM,IAAKA,MAAM,CAAC8C,KAAK,IAAI,CAAC;AACpD;AACF,CAAC,EAAAtD,WAAA,GAAAuD,yBAAA,CAAAhE,MAAA,CAAAiE,SAAA,EAAA,uBAAA,EAAA,CArOEC,OAAO,CAAA,EAAA;EAAAC,YAAA,EAAA,IAAA;EAAAC,UAAA,EAAA,IAAA;EAAAC,QAAA,EAAA,IAAA;EAAAC,WAAA,EAAA;AAAA,CAAA5D,CAAAA,EAAAA,YAAA,GAAAsD,yBAAA,CAAAhE,MAAA,CAAAiE,SAAA,2BASPC,OAAO,CAAA,EAAA;EAAAC,YAAA,EAAA,IAAA;EAAAC,UAAA,EAAA,IAAA;EAAAC,QAAA,EAAA,IAAA;EAAAC,WAAA,EAAA;AAAA,CAAA3D,CAAAA,EAAAA,YAAA,GAAAqD,yBAAA,CAAAhE,MAAA,CAAAiE,SAAA,WAOPC,OAAO,CAAA,EAAA;EAAAC,YAAA,EAAA,IAAA;EAAAC,UAAA,EAAA,IAAA;EAAAC,QAAA,EAAA,IAAA;EAAAC,WAAA,EAAA;AAAA,CAAA,CAAA,EAAAN,yBAAA,CAAAhE,MAAA,CAAAiE,SAAA,EAAA,SAAA,EAAA,CA0FPM,MAAM,CAAA,EAAAC,MAAA,CAAAC,wBAAA,CAAAzE,MAAA,CAAAiE,SAAA,EAAA,SAAA,CAAA,EAAAjE,MAAA,CAAAiE,SAAA,CAAA,EAAAD,yBAAA,CAAAhE,MAAA,CAAAiE,SAAA,EAAA,sBAAA,EAAA,CAgHNS,MAAM,CAAA,EAAAF,MAAA,CAAAC,wBAAA,CAAAzE,MAAA,CAAAiE,SAAA,EAAA,sBAAA,CAAA,EAAAjE,MAAA,CAAAiE,SAAA,CAAA,EAAAD,yBAAA,CAAAhE,MAAA,CAAAiE,SAAA,EAAA,iBAAA,EAAA,CAONS,MAAM,CAAA,EAAAF,MAAA,CAAAC,wBAAA,CAAAzE,MAAA,CAAAiE,SAAA,EAAA,iBAAA,CAAA,EAAAjE,MAAA,CAAAiE,SAAA,CAAA,EAAAjE,MAAA;;;;"}
1
+ {"version":3,"file":"table.js","sources":["../../src/-private/table.ts"],"sourcesContent":["import { cached, tracked } from '@glimmer/tracking';\nimport { assert } from '@ember/debug';\nimport { action } from '@ember/object';\nimport { guidFor } from '@ember/object/internals';\n\nimport { isDevelopingApp, macroCondition } from '@embroider/macros';\nimport { modifier } from 'ember-modifier';\nimport { Resource } from 'ember-modify-based-class-resource';\nimport { map } from 'reactiveweb/map';\n\nimport {\n normalizePluginsConfig,\n verifyPlugins,\n} from '../plugins/-private/utils.ts';\nimport { Column } from './column.ts';\nimport { TablePreferences } from './preferences.ts';\nimport { Row } from './row.ts';\nimport { composeFunctionModifiers } from './utils.ts';\n\nimport type { BasePlugin, Plugin } from '../plugins/index.ts';\nimport type { Class } from './private-types.ts';\nimport type { Destructor, TableConfig } from './interfaces';\nimport { compatOwner } from './ember-compat.ts';\n\nconst getOwner = compatOwner.getOwner;\nconst setOwner = compatOwner.setOwner;\n\nconst DEFAULT_COLUMN_CONFIG = {\n isVisible: true,\n minWidth: 128,\n};\n\ninterface Signature<DataType> {\n Named: TableConfig<DataType>;\n}\n\n/**\n * Because the table is our entry-point object to all the table behaviors,\n * we need a stable way to know which table we have.\n * Normally, this could be done with referential integrity / identity.\n * However, due to how resources are implemented, if the consumer opts to\n * not use the `@use` decorator, then proxies get involved.\n * The proxies don't maintain instanceof checks, which may be a bug in\n * ember-resources.\n */\nexport const TABLE_KEY = Symbol('__TABLE_KEY__');\nexport const TABLE_META_KEY = Symbol('__TABLE_META__');\nexport const COLUMN_META_KEY = Symbol('__COLUMN_META__');\nexport const ROW_META_KEY = Symbol('__ROW_META__');\n\nconst attachContainer = (element: Element, table: Table) => {\n assert('Must be installed on an HTMLElement', element instanceof HTMLElement);\n\n table.scrollContainerElement = element;\n};\n\nexport class Table<DataType = unknown> extends Resource<Signature<DataType>> {\n /**\n * @private\n */\n [TABLE_KEY] = guidFor(this);\n /**\n * @private\n */\n [TABLE_META_KEY] = new Map<Class<unknown>, any>();\n /**\n * @private\n */\n [COLUMN_META_KEY] = new WeakMap<Column, Map<Class<unknown>, any>>();\n /**\n * @private\n */\n [ROW_META_KEY] = new WeakMap<Row, Map<Class<unknown>, any>>();\n\n /**\n * @private\n *\n * Unused for now, may be used in the future.\n * This data is collected along with the scrollContainerWidth, (which is currently in use)\n */\n @tracked scrollContainerHeight?: number;\n\n /**\n * @private\n *\n * Used to help determine how much space we can give to columns.\n * As we generate widths for columns, the columns' widths must\n * add up to about this number.\n */\n @tracked scrollContainerWidth?: number;\n\n /**\n * @private\n *\n * Lazy way to delay consuming arguments until they are needed.\n */\n @tracked declare args: { named: Signature<DataType>['Named'] };\n\n /**\n * @private\n */\n scrollContainerElement?: HTMLElement;\n\n /**\n * Interact with, save, modify, etc the preferences for the table,\n * plugins, columns, etc\n */\n declare preferences: TablePreferences;\n\n /**\n * @private\n */\n modify(_: [] | undefined, named: Signature<DataType>['Named']) {\n this.args = { named };\n\n const preferences = named?.preferences;\n const { key = guidFor(this), adapter } =\n (typeof preferences === 'function' ? preferences() : preferences) ?? {};\n\n // only set the preferences once\n if (!this.preferences) {\n // TODO: when no key is present,\n // use \"local-storage\" preferences.\n // it does not make sense to use a guid in a user's preferences\n this.preferences = new TablePreferences(key, adapter);\n } else {\n // subsequent updates to args\n if (typeof preferences === 'function' && adapter) {\n this.preferences.restore(adapter);\n }\n this.resetScrollContainer();\n }\n }\n\n /**\n * Collection of utility modifiers that are the result of composing modifiers\n * from plugins.\n *\n * Using this is optional, and you can \"just\" use modifiers from specific plugins\n * in specific places if you wish -- but these exists as a \"convenience\".\n *\n * These are all no-use, no-cost utilities\n */\n modifiers = {\n container: modifier((element: HTMLElement): Destructor => {\n const modifiers = this.plugins.map((plugin) => plugin.containerModifier);\n const composed = composeFunctionModifiers([\n attachContainer,\n ...modifiers,\n ]);\n\n return composed(element, this as Table<unknown>);\n }),\n\n // resize: ResizeModifier,\n // TODO: switch to composing real modifiers once \"curry\" and \"compose\"\n // RFCs are accepted and implemented\n //\n // Atm the moment, if _any_ header modifier's tracked data changes,\n // all the functions for all of the plugins run again.\n //\n // With curried+composed modifiers, only the plugin's headerModifier\n // that has tracked changes would run, leaving the other modifiers alone\n columnHeader: modifier(\n (element: HTMLElement, [column]: [Column<DataType>]): Destructor => {\n const modifiers = this.plugins.map(\n (plugin) => plugin.headerCellModifier,\n );\n const composed = composeFunctionModifiers(modifiers);\n\n return composed(element, { column, table: this });\n },\n ),\n\n row: modifier(\n (element: HTMLElement, [row]: [Row<DataType>]): Destructor => {\n const modifiers = this.plugins.map((plugin) => plugin.rowModifier);\n const composed = composeFunctionModifiers(modifiers);\n\n return composed(element, { row, table: this });\n },\n ),\n };\n\n /**\n * @private\n *\n * For all configured plugins, instantiates each one.\n * If the plugins argument changes to the Table (either directly or through\n * headlessTable, all state is lost and re-created)\n */\n @cached\n get plugins(): Plugin[] {\n const plugins = normalizePluginsConfig(this.args.named?.plugins);\n\n verifyPlugins(plugins);\n\n return plugins.map((tuple) => {\n // We don't need the options here\n const [PluginClass] = tuple;\n\n if (typeof PluginClass === 'function') {\n const plugin = new PluginClass(this);\n\n const owner = getOwner(this);\n\n assert(\n `The Table does not have an owner. cannot create a plugin without an owner`,\n owner,\n );\n setOwner(plugin, owner);\n\n return plugin;\n }\n\n // This is a plugin object, rather than a class\n // TODO: add test coverage around using classless plugins\n return PluginClass;\n });\n }\n\n /**\n * Get the active plugin instance for the given plugin class\n */\n pluginOf<Instance extends BasePlugin<any>>(\n klass: Class<Instance>,\n ): Instance | undefined {\n const result = this.plugins.find((plugin) => plugin instanceof klass);\n\n /**\n * This is an unsafe cast, because Instance could be unrelated to any of the types\n * that matches Plugin[]\n *\n * For example, `table.pluginOf(MyCustomPlugin)`, where MyCustomPlugin isn't in the\n * `plugins` list. This partially a problem with how Array.prototype.find doesn't\n * effectively narrow for what we want (combined with TS being clunky around\n * comparing Instance and Class types).\n */\n return result as unknown as Instance | undefined;\n }\n\n /**\n * @private\n *\n * used by other private APIs\n */\n get config() {\n return this.args.named;\n }\n\n rows = map(this, {\n data: () => {\n const dataFn = this.args.named?.data;\n\n if (!dataFn) return [];\n\n return dataFn() ?? [];\n },\n map: (datum) => new Row(this, datum),\n });\n\n columns = map(this, {\n data: () => {\n const configFn = this.args.named?.columns;\n\n if (!configFn) return [];\n\n const result = configFn() ?? [];\n\n if (macroCondition(isDevelopingApp())) {\n /**\n * Assertions for a column config to be valid:\n * - every key must be unique\n */\n const keys = new Set();\n const allKeys = result.map((columnConfig) => columnConfig.key);\n\n result.forEach((columnConfig) => {\n if (keys.has(columnConfig.key)) {\n throw new Error(\n `Every column key in the table's column config must be unique. ` +\n `Found duplicate entry: ${columnConfig.key}. ` +\n `All keys used: ${allKeys}`,\n );\n }\n\n keys.add(columnConfig.key);\n });\n }\n\n return result;\n },\n map: (config) => {\n return new Column<DataType>(this, {\n ...DEFAULT_COLUMN_CONFIG,\n ...config,\n });\n },\n });\n\n /**\n * @private\n */\n @action\n resetScrollContainer() {\n if (!this.scrollContainerElement) return;\n\n this.scrollContainerElement.scrollTop = 0;\n }\n\n @action\n resetToDefaults() {\n this.plugins.forEach((plugin) => plugin.reset?.());\n }\n}\n"],"names":["getOwner","compatOwner","setOwner","DEFAULT_COLUMN_CONFIG","isVisible","minWidth","TABLE_KEY","Symbol","TABLE_META_KEY","COLUMN_META_KEY","ROW_META_KEY","attachContainer","element","table","assert","HTMLElement","scrollContainerElement","Table","_class","Resource","constructor","args","_defineProperty","guidFor","Map","WeakMap","_initializerDefineProperty","_descriptor","_descriptor2","_descriptor3","container","modifier","modifiers","plugins","map","plugin","containerModifier","composed","composeFunctionModifiers","columnHeader","column","headerCellModifier","row","rowModifier","data","dataFn","named","datum","Row","configFn","columns","result","macroCondition","isDevelopingApp","keys","Set","allKeys","columnConfig","key","forEach","has","Error","add","config","Column","modify","_","preferences","adapter","TablePreferences","restore","resetScrollContainer","normalizePluginsConfig","verifyPlugins","tuple","PluginClass","owner","pluginOf","klass","find","scrollTop","resetToDefaults","reset","_applyDecoratedDescriptor","prototype","tracked","configurable","enumerable","writable","initializer","cached","Object","getOwnPropertyDescriptor","action"],"mappings":";;;;;;;;;;;;;;;;;AAwBA,MAAMA,QAAQ,GAAGC,WAAW,CAACD,QAAQ;AACrC,MAAME,QAAQ,GAAGD,WAAW,CAACC,QAAQ;AAErC,MAAMC,qBAAqB,GAAG;AAC5BC,EAAAA,SAAS,EAAE,IAAI;AACfC,EAAAA,QAAQ,EAAE;AACZ,CAAC;AAMD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACaC,SAAS,GAAGC,MAAM,CAAC,eAAe;MAClCC,cAAc,GAAGD,MAAM,CAAC,gBAAgB;MACxCE,eAAe,GAAGF,MAAM,CAAC,iBAAiB;MAC1CG,YAAY,GAAGH,MAAM,CAAC,cAAc;AAEjD,MAAMI,eAAe,GAAGA,CAACC,OAAgB,EAAEC,KAAY,KAAK;AAC1DC,EAAAA,MAAM,CAAC,qCAAqC,EAAEF,OAAO,YAAYG,WAAW,CAAC;EAE7EF,KAAK,CAACG,sBAAsB,GAAGJ,OAAO;AACxC,CAAC;AAEYK,IAAAA,KAAK,IAAAC,MAAA,GAAX,MAAMD,KAAK,SAA6BE,QAAQ,CAAsB;AAAAC,EAAAA,WAAAA,CAAA,GAAAC,IAAA,EAAA;AAAA,IAAA,KAAA,CAAA,GAAAA,IAAA,CAAA;AAC3E;AACF;AACA;AAFEC,IAAAA,eAAA,OAGChB,SAAS,EAAIiB,OAAO,CAAC,IAAI,CAAC,CAAA;AAC3B;AACF;AACA;AAFED,IAAAA,eAAA,OAGCd,cAAc,EAAI,IAAIgB,GAAG,EAAuB,CAAA;AACjD;AACF;AACA;AAFEF,IAAAA,eAAA,OAGCb,eAAe,EAAI,IAAIgB,OAAO,EAAoC,CAAA;AACnE;AACF;AACA;AAFEH,IAAAA,eAAA,OAGCZ,YAAY,EAAI,IAAIe,OAAO,EAAiC,CAAA;AAE7D;AACF;AACA;AACA;AACA;AACA;AALEC,IAAAA,0BAAA,gCAAAC,WAAA,EAAA,IAAA,CAAA;AAQA;AACF;AACA;AACA;AACA;AACA;AACA;AANED,IAAAA,0BAAA,+BAAAE,YAAA,EAAA,IAAA,CAAA;AASA;AACF;AACA;AACA;AACA;AAJEF,IAAAA,0BAAA,eAAAG,YAAA,EAAA,IAAA,CAAA;AAOA;AACF;AACA;IAFEP,eAAA,CAAA,IAAA,EAAA,wBAAA,EAAA,MAAA,CAAA;AAoCA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAREA,IAAAA,eAAA,CASY,IAAA,EAAA,WAAA,EAAA;AACVQ,MAAAA,SAAS,EAAEC,QAAQ,CAAEnB,OAAoB,IAAiB;AACxD,QAAA,MAAMoB,SAAS,GAAG,IAAI,CAACC,OAAO,CAACC,GAAG,CAAEC,MAAM,IAAKA,MAAM,CAACC,iBAAiB,CAAC;QACxE,MAAMC,QAAQ,GAAGC,wBAAwB,CAAC,CACxC3B,eAAe,EACf,GAAGqB,SAAS,CACb,CAAC;AAEF,QAAA,OAAOK,QAAQ,CAACzB,OAAO,EAAE,IAAsB,CAAC;AAClD,OAAC,CAAC;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACA2B,YAAY,EAAER,QAAQ,CACpB,CAACnB,OAAoB,EAAE,CAAC4B,MAAM,CAAqB,KAAiB;AAClE,QAAA,MAAMR,SAAS,GAAG,IAAI,CAACC,OAAO,CAACC,GAAG,CAC/BC,MAAM,IAAKA,MAAM,CAACM,kBACrB,CAAC;AACD,QAAA,MAAMJ,QAAQ,GAAGC,wBAAwB,CAACN,SAAS,CAAC;QAEpD,OAAOK,QAAQ,CAACzB,OAAO,EAAE;UAAE4B,MAAM;AAAE3B,UAAAA,KAAK,EAAE;AAAK,SAAC,CAAC;AACnD,OACF,CAAC;MAED6B,GAAG,EAAEX,QAAQ,CACX,CAACnB,OAAoB,EAAE,CAAC8B,GAAG,CAAkB,KAAiB;AAC5D,QAAA,MAAMV,SAAS,GAAG,IAAI,CAACC,OAAO,CAACC,GAAG,CAAEC,MAAM,IAAKA,MAAM,CAACQ,WAAW,CAAC;AAClE,QAAA,MAAMN,QAAQ,GAAGC,wBAAwB,CAACN,SAAS,CAAC;QAEpD,OAAOK,QAAQ,CAACzB,OAAO,EAAE;UAAE8B,GAAG;AAAE7B,UAAAA,KAAK,EAAE;AAAK,SAAC,CAAC;OAElD;KACD,CAAA;AAAAS,IAAAA,eAAA,CAoEMY,IAAAA,EAAAA,MAAAA,EAAAA,GAAG,CAAC,IAAI,EAAE;MACfU,IAAI,EAAEA,MAAM;QACV,MAAMC,MAAM,GAAG,IAAI,CAACxB,IAAI,CAACyB,KAAK,EAAEF,IAAI;AAEpC,QAAA,IAAI,CAACC,MAAM,EAAE,OAAO,EAAE;AAEtB,QAAA,OAAOA,MAAM,EAAE,IAAI,EAAE;OACtB;MACDX,GAAG,EAAGa,KAAK,IAAK,IAAIC,GAAG,CAAC,IAAI,EAAED,KAAK;AACrC,KAAC,CAAC,CAAA;AAAAzB,IAAAA,eAAA,CAEQY,IAAAA,EAAAA,SAAAA,EAAAA,GAAG,CAAC,IAAI,EAAE;MAClBU,IAAI,EAAEA,MAAM;QACV,MAAMK,QAAQ,GAAG,IAAI,CAAC5B,IAAI,CAACyB,KAAK,EAAEI,OAAO;AAEzC,QAAA,IAAI,CAACD,QAAQ,EAAE,OAAO,EAAE;AAExB,QAAA,MAAME,MAAM,GAAGF,QAAQ,EAAE,IAAI,EAAE;AAE/B,QAAA,IAAIG,cAAc,CAACC,eAAe,EAAE,CAAC,EAAE;AACrC;AACR;AACA;AACA;AACQ,UAAA,MAAMC,IAAI,GAAG,IAAIC,GAAG,EAAE;UACtB,MAAMC,OAAO,GAAGL,MAAM,CAACjB,GAAG,CAAEuB,YAAY,IAAKA,YAAY,CAACC,GAAG,CAAC;AAE9DP,UAAAA,MAAM,CAACQ,OAAO,CAAEF,YAAY,IAAK;YAC/B,IAAIH,IAAI,CAACM,GAAG,CAACH,YAAY,CAACC,GAAG,CAAC,EAAE;AAC9B,cAAA,MAAM,IAAIG,KAAK,CACb,CAAA,8DAAA,CAAgE,GAC9D,CAA0BJ,uBAAAA,EAAAA,YAAY,CAACC,GAAG,CAAI,EAAA,CAAA,GAC9C,CAAkBF,eAAAA,EAAAA,OAAO,EAC7B,CAAC;AACH;AAEAF,YAAAA,IAAI,CAACQ,GAAG,CAACL,YAAY,CAACC,GAAG,CAAC;AAC5B,WAAC,CAAC;AACJ;AAEA,QAAA,OAAOP,MAAM;OACd;MACDjB,GAAG,EAAG6B,MAAM,IAAK;AACf,QAAA,OAAO,IAAIC,MAAM,CAAW,IAAI,EAAE;AAChC,UAAA,GAAG7D,qBAAqB;UACxB,GAAG4D;AACL,SAAC,CAAC;AACJ;AACF,KAAC,CAAC,CAAA;AAAA;AAnMF;AACF;AACA;AACA;;AAGE;AACF;AACA;AACEE,EAAAA,MAAMA,CAACC,CAAiB,EAAEpB,KAAmC,EAAE;IAC7D,IAAI,CAACzB,IAAI,GAAG;AAAEyB,MAAAA;KAAO;AAErB,IAAA,MAAMqB,WAAW,GAAGrB,KAAK,EAAEqB,WAAW;IACtC,MAAM;AAAET,MAAAA,GAAG,GAAGnC,OAAO,CAAC,IAAI,CAAC;AAAE6C,MAAAA;AAAQ,KAAC,GACpC,CAAC,OAAOD,WAAW,KAAK,UAAU,GAAGA,WAAW,EAAE,GAAGA,WAAW,KAAK,EAAE;;AAEzE;AACA,IAAA,IAAI,CAAC,IAAI,CAACA,WAAW,EAAE;AACrB;AACA;AACA;MACA,IAAI,CAACA,WAAW,GAAG,IAAIE,gBAAgB,CAACX,GAAG,EAAEU,OAAO,CAAC;AACvD,KAAC,MAAM;AACL;AACA,MAAA,IAAI,OAAOD,WAAW,KAAK,UAAU,IAAIC,OAAO,EAAE;AAChD,QAAA,IAAI,CAACD,WAAW,CAACG,OAAO,CAACF,OAAO,CAAC;AACnC;MACA,IAAI,CAACG,oBAAoB,EAAE;AAC7B;AACF;AAoDA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,IACItC,OAAOA,GAAa;IACtB,MAAMA,OAAO,GAAGuC,sBAAsB,CAAC,IAAI,CAACnD,IAAI,CAACyB,KAAK,EAAEb,OAAO,CAAC;IAEhEwC,aAAa,CAACxC,OAAO,CAAC;AAEtB,IAAA,OAAOA,OAAO,CAACC,GAAG,CAAEwC,KAAK,IAAK;AAC5B;AACA,MAAA,MAAM,CAACC,WAAW,CAAC,GAAGD,KAAK;AAE3B,MAAA,IAAI,OAAOC,WAAW,KAAK,UAAU,EAAE;AACrC,QAAA,MAAMxC,MAAM,GAAG,IAAIwC,WAAW,CAAC,IAAI,CAAC;AAEpC,QAAA,MAAMC,KAAK,GAAG5E,QAAQ,CAAC,IAAI,CAAC;AAE5Bc,QAAAA,MAAM,CACJ,CAAA,yEAAA,CAA2E,EAC3E8D,KACF,CAAC;AACD1E,QAAAA,QAAQ,CAACiC,MAAM,EAAEyC,KAAK,CAAC;AAEvB,QAAA,OAAOzC,MAAM;AACf;;AAEA;AACA;AACA,MAAA,OAAOwC,WAAW;AACpB,KAAC,CAAC;AACJ;;AAEA;AACF;AACA;EACEE,QAAQA,CACNC,KAAsB,EACA;AACtB,IAAA,MAAM3B,MAAM,GAAG,IAAI,CAAClB,OAAO,CAAC8C,IAAI,CAAE5C,MAAM,IAAKA,MAAM,YAAY2C,KAAK,CAAC;;AAErE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACI,IAAA,OAAO3B,MAAM;AACf;;AAEA;AACF;AACA;AACA;AACA;EACE,IAAIY,MAAMA,GAAG;AACX,IAAA,OAAO,IAAI,CAAC1C,IAAI,CAACyB,KAAK;AACxB;AAoDA;AACF;AACA;AAEEyB,EAAAA,oBAAoBA,GAAG;AACrB,IAAA,IAAI,CAAC,IAAI,CAACvD,sBAAsB,EAAE;AAElC,IAAA,IAAI,CAACA,sBAAsB,CAACgE,SAAS,GAAG,CAAC;AAC3C;AAGAC,EAAAA,eAAeA,GAAG;AAChB,IAAA,IAAI,CAAChD,OAAO,CAAC0B,OAAO,CAAExB,MAAM,IAAKA,MAAM,CAAC+C,KAAK,IAAI,CAAC;AACpD;AACF,CAAC,EAAAvD,WAAA,GAAAwD,yBAAA,CAAAjE,MAAA,CAAAkE,SAAA,EAAA,uBAAA,EAAA,CA1OEC,OAAO,CAAA,EAAA;EAAAC,YAAA,EAAA,IAAA;EAAAC,UAAA,EAAA,IAAA;EAAAC,QAAA,EAAA,IAAA;EAAAC,WAAA,EAAA;AAAA,CAAA7D,CAAAA,EAAAA,YAAA,GAAAuD,yBAAA,CAAAjE,MAAA,CAAAkE,SAAA,2BASPC,OAAO,CAAA,EAAA;EAAAC,YAAA,EAAA,IAAA;EAAAC,UAAA,EAAA,IAAA;EAAAC,QAAA,EAAA,IAAA;EAAAC,WAAA,EAAA;AAAA,CAAA5D,CAAAA,EAAAA,YAAA,GAAAsD,yBAAA,CAAAjE,MAAA,CAAAkE,SAAA,WAOPC,OAAO,CAAA,EAAA;EAAAC,YAAA,EAAA,IAAA;EAAAC,UAAA,EAAA,IAAA;EAAAC,QAAA,EAAA,IAAA;EAAAC,WAAA,EAAA;AAAA,CAAA,CAAA,EAAAN,yBAAA,CAAAjE,MAAA,CAAAkE,SAAA,EAAA,SAAA,EAAA,CA+FPM,MAAM,CAAA,EAAAC,MAAA,CAAAC,wBAAA,CAAA1E,MAAA,CAAAkE,SAAA,EAAA,SAAA,CAAA,EAAAlE,MAAA,CAAAkE,SAAA,CAAA,EAAAD,yBAAA,CAAAjE,MAAA,CAAAkE,SAAA,EAAA,sBAAA,EAAA,CAgHNS,MAAM,CAAA,EAAAF,MAAA,CAAAC,wBAAA,CAAA1E,MAAA,CAAAkE,SAAA,EAAA,sBAAA,CAAA,EAAAlE,MAAA,CAAAkE,SAAA,CAAA,EAAAD,yBAAA,CAAAjE,MAAA,CAAAkE,SAAA,EAAA,iBAAA,EAAA,CAONS,MAAM,CAAA,EAAAF,MAAA,CAAAC,wBAAA,CAAA1E,MAAA,CAAAkE,SAAA,EAAA,iBAAA,CAAA,EAAAlE,MAAA,CAAAkE,SAAA,CAAA,EAAAlE,MAAA;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@universal-ember/table",
3
- "version": "3.5.0",
3
+ "version": "3.6.0",
4
4
  "description": "An implementation of table behaviors for driving any table or table-like UI -- all without a UI (headless)",
5
5
  "keywords": [
6
6
  "ember-addon",
package/src/-private/interfaces/table.ts CHANGED
@@ -110,26 +110,30 @@ export interface TableConfig<DataType> {
110
110
  * you have a table representing "blog posts", your table key may be "blog-posts".
111
111
  *
112
112
  * And most importantly, the `adapter` is how you load and save the preferences.
113
- * This may bo to local storage, or some API.
113
+ * This may be to local storage, or some API.
114
+ *
115
+ * Can be provided as a thunk for reactive multi-table sync.
114
116
  */
115
- preferences?: {
116
- /**
117
- * What to name the table in the preferences storage of your choice.
118
- * Any string is valid provided that the storage adapter of your choice supports
119
- * the format.
120
- *
121
- * For example, if you have a table of "blog posts", the preferences key might be
122
- * `"all-blog-posts"`
123
- */
124
- key: string;
125
- /**
126
- * Configuration for how you wish to `persist` and `restore` the configuration for your table.
127
- *
128
- * `persist` may be async as it is a fire-and-forget type of action.
129
- *
130
- * However, `restore` must be synchronous, as this is a blocking operation for rendering the table.
131
- * So it's best to load up the table preferences before rendering a table.
132
- */
133
- adapter?: PreferencesAdapter;
134
- };
117
+ preferences?:
118
+ | {
119
+ /**
120
+ * What to name the table in the preferences storage of your choice.
121
+ * Any string is valid provided that the storage adapter of your choice supports
122
+ * the format.
123
+ *
124
+ * For example, if you have a table of "blog posts", the preferences key might be
125
+ * `"all-blog-posts"`
126
+ */
127
+ key: string;
128
+ /**
129
+ * Configuration for how you wish to `persist` and `restore` the configuration for your table.
130
+ *
131
+ * `persist` may be async as it is a fire-and-forget type of action.
132
+ *
133
+ * However, `restore` must be synchronous, as this is a blocking operation for rendering the table.
134
+ * So it's best to load up the table preferences before rendering a table.
135
+ */
136
+ adapter?: PreferencesAdapter;
137
+ }
138
+ | (() => { key: string; adapter?: PreferencesAdapter });
135
139
  }
package/src/-private/table.ts CHANGED
@@ -113,16 +113,21 @@ export class Table<DataType = unknown> extends Resource<Signature<DataType>> {
113
113
  modify(_: [] | undefined, named: Signature<DataType>['Named']) {
114
114
  this.args = { named };
115
115
 
116
+ const preferences = named?.preferences;
117
+ const { key = guidFor(this), adapter } =
118
+ (typeof preferences === 'function' ? preferences() : preferences) ?? {};
119
+
116
120
  // only set the preferences once
117
121
  if (!this.preferences) {
118
- const { key = guidFor(this), adapter } = named?.preferences ?? {};
119
-
120
122
  // TODO: when no key is present,
121
123
  // use "local-storage" preferences.
122
124
  // it does not make sense to use a guid in a user's preferences
123
125
  this.preferences = new TablePreferences(key, adapter);
124
126
  } else {
125
127
  // subsequent updates to args
128
+ if (typeof preferences === 'function' && adapter) {
129
+ this.preferences.restore(adapter);
130
+ }
126
131
  this.resetScrollContainer();
127
132
  }
128
133
  }