@universal-ember/table 3.0.2 → 3.0.3

package/declarations/plugins/-private/base.d.ts

@@ -0,0 +1,281 @@
+import type { Table } from '../../-private/table.ts';
+import type { ColumnReordering } from '../column-reordering';
+import type { ColumnVisibility } from '../column-visibility';
+import type { Class, Constructor } from '../../-private/private-types.ts';
+import type { Column, Row } from '../../index.ts';
+import type { ColumnMetaFor, ColumnOptionsFor, OptionsFor, Plugin, RowMetaFor, TableMetaFor } from '../../-private/interfaces';
+type InstanceOf<T> = T extends Class<infer Instance> ? Instance : T;
+/**
+ * @public
+ *
+ * list of interfaces by feature name that consumers may provide alternative
+ * implementation for
+ */
+export interface TableFeatures extends Record<string, unknown | undefined> {
+    /**
+     * @public
+     *
+     * interface for the table meta of a "column visibility plugin"
+     */
+    columnVisibility: InstanceOf<ColumnVisibility['meta']['table']>;
+    /**
+     * @public
+     *
+     * interface for the table meta of a "column order plugin"
+     */
+    columnOrder: InstanceOf<ColumnReordering['meta']['table']>;
+}
+/**
+ * @public
+ *
+ * list of interfaces by feature name that consumers may provide alternative
+ * implementation for
+ */
+export interface ColumnFeatures extends Record<string, unknown | undefined> {
+    /**
+     * @public
+     *
+     * interface for the column meta of a "column visibility plugin"
+     */
+    columnVisibility: InstanceOf<ColumnVisibility['meta']['column']>;
+    /**
+     * @public
+     *
+     * interface for the column meta of a "column order plugin"
+     */
+    columnOrder: InstanceOf<ColumnReordering['meta']['column']>;
+}
+/**
+ * @private utility type
+ *
+ */
+export type SignatureFrom<Klass extends BasePlugin<any>> = Klass extends BasePlugin<infer Signature> ? Signature : never;
+declare const __Signature__: unique symbol;
+/**
+ * @public
+ *
+ * If your table plugin is a class, you may extend from BasePlugin, which provides
+ * small utility methods and properties for getting the metadata for your plugin
+ * for the table and each column
+ *
+ * One instance of a plugin exists per table
+ */
+export declare abstract class BasePlugin<Signature = unknown> implements Plugin<Signature> {
+    protected table: Table;
+    constructor(table: Table);
+    /**
+     * @private (secret)
+     *
+     * Because classes are kind of like interfaces,
+     * we need "something" to help TS know what a Resource is.
+     *
+     * This isn't a real API, but does help with type inference
+     * with the SignatureFrom utility above
+     */
+    [__Signature__]: Signature;
+    /**
+     * Helper for specifying plugins on `headlessTable` with the plugin-level options
+     */
+    static with<T extends BasePlugin<any>>(this: Constructor<T>, configFn: () => OptionsFor<SignatureFrom<T>>): [Constructor<T>, () => OptionsFor<SignatureFrom<T>>];
+    /**
+     * Helper for specifying column-level configurations for a plugin on `headlessTable`'s
+     * columns option
+     */
+    static forColumn<T extends BasePlugin<any>>(this: Constructor<T>, configFn: () => ColumnOptionsFor<SignatureFrom<T>>): [Constructor<T>, () => ColumnOptionsFor<SignatureFrom<T>>];
+    meta?: {
+        column?: Constructor<ColumnMetaFor<Signature>>;
+        table?: Constructor<TableMetaFor<Signature>>;
+        row?: Constructor<RowMetaFor<Signature>>;
+    };
+    abstract name: string;
+    static features?: string[];
+    static requires?: string[];
+}
+/**
+ * @public
+ *
+ * returns boolean if the passed table has an instance of the configured passed plugin class.
+ * This can be used to help guard against accessing public-specific APIs if those plugins
+ * are not configured for a particular table instance
+ */
+export declare function hasPlugin<P extends BasePlugin<any>, Data = unknown>(table: Table<Data>, klass: Class<P>): boolean;
+export declare const preferences: {
+    /**
+     * @public
+     *
+     * returns an object for getting and setting preferences data
+     * based on the column (scoped to key)
+     *
+     * Only the provided plugin will have access to these preferences
+     * (though, if other plugins can guess how the underlying plugin access
+     * works, they can access this data, too. No security guaranteed)
+     */
+    forColumn<P extends BasePlugin<any>, Data = unknown>(column: Column<Data>, klass: Class<P>): {
+        /**
+         * delete an entry on the underlying `Map` used for this column-plugin pair
+         */
+        delete(key: string): void | undefined;
+        /**
+         * get an entry on the underlying `Map` used for this column-plugin pair
+         */
+        get(key: string): unknown;
+        /**
+         * set an entry on the underlying `Map` used for this column-plugin pair
+         */
+        set(key: string, value: unknown): void;
+    };
+    /**
+     * @public
+     *
+     * returns an object for bulk updating preferences data
+     * for all columns (scoped to key and table)
+     */
+    forAllColumns<P extends BasePlugin<any>, Data = unknown>(table: Table<Data>, klass: Class<P>): {
+        /**
+         * delete an entry on every column in the underlying column `Map` for this table-plugin pair
+         */
+        delete(key: string): void | undefined;
+    };
+    /**
+     * @public
+     *
+     * returns an object for getting and setting preferences data
+     * based on the table (scoped to the key: "table")
+     *
+     * Only the provided plugin will have access to these preferences
+     * (though, if other plugins can guess how the underlying plugin access
+     * works, they can access this data, too. No security guaranteed)
+     */
+    forTable<P extends BasePlugin<any>, Data = unknown>(table: Table<Data>, klass: Class<P>): {
+        /**
+         * delete an entry on the underlying `Map` used for this table-plugin pair
+         */
+        delete(key: string): void | undefined;
+        /**
+         * get an entry on the underlying `Map` used for this table-plugin pair
+         */
+        get(key: string): unknown;
+        /**
+         * set an entry on the underlying `Map` used for this table-plugin pair
+         */
+        set(key: string, value: unknown): void | undefined;
+    };
+};
+/**
+ * if a `requester` is not provided,
+ * Get the columns for the table, considering any and all plugins that could modify columns.
+ *
+ * If you are an end-consumer of @universal-ember/table, this is the function to use.
+ * If you are a plugin-author, you'll want to pass your plugin class as the second parameter.
+ *
+ * For a given plugin, `requester`, determine what columns should be returned.
+ * Since multiple plugins could be used in a table, there is an implicit hierarchy of
+ * column modifications that can occur from each of those plugins.
+ *
+ * If a plugin defines other plugins as either *requirements* or *optional requirements*,
+ * and that upstream plugin defines a `columns` property, then those columns will be returned here.
+ *
+ * This works recursively up the plugin tree up until a plugin has no requirements, and then
+ * all columns from the table are returned.
+ */
+declare function columnsFor<DataType = any>(table: Table<DataType>, requester?: Plugin<any>): Column<DataType>[];
+export declare const columns: {
+    for: typeof columnsFor;
+    /**
+     * for a given current or reference column, return the column that
+     * is immediately next, or to the right of that column.
+     *
+     * If a plugin class is provided, the hierarchy of column list modifications
+     * will be respected.
+     */
+    next: <Data = unknown>(current: Column<Data>, requester?: Plugin<any>) => Column<Data> | undefined;
+    /**
+     * for a given current or reference column, return the column that
+     * is immediately previous, or to the left of that column.
+     *
+     * If a plugin class is provided, the hierarchy of column list modifications
+     * will be respected.
+     */
+    previous: <Data = unknown>(current: Column<Data>, requester?: Plugin<any>) => Column<Data> | undefined;
+    /**
+     * for a given current or reference column, return the columns that
+     * should appear before, or to the left of that column.
+     *
+     * if a plugin class is provided, the hierarchy of column list modifications
+     * will be respected.
+     */
+    before: <Data = unknown>(current: Column<Data>, requester?: Plugin<any>) => Column<Data>[];
+    /**
+     * for a given current or reference column, return the columns that
+     * should appear after, or to the right of that column.
+     *
+     * if a plugin class is provided, the hierarchy of column list modifications
+     * will be respected.
+     */
+    after: <Data = unknown>(current: Column<Data>, requester?: Plugin<any>) => Column<Data>[];
+};
+export declare const meta: {
+    /**
+     * @public
+     *
+     * For a given column and plugin, return the meta / state bucket for the
+     * plugin<->column instance pair.
+     *
+     * Note that this requires the column instance to exist on the table.
+     */
+    forColumn<P extends BasePlugin<any>, Data = unknown>(column: Column<Data>, klass: Class<P>): ColumnMetaFor<SignatureFrom<P>>;
+    /**
+     * @public
+     *
+     * For a given row and plugin, return the meta / state bucket for the
+     * plugin<->row instance pair.
+     *
+     * Note that this requires the row instance to exist on the table.
+     */
+    forRow<P extends BasePlugin<any>, Data = unknown>(row: Row<Data>, klass: Class<P>): RowMetaFor<SignatureFrom<P>>;
+    /**
+     * @public
+     *
+     * For a given table and plugin, return the meta / state bucket for the
+     * plugin<->table instance pair.
+     */
+    forTable<P extends BasePlugin<any>, Data = unknown>(table: Table<Data>, klass: Class<P>): TableMetaFor<SignatureFrom<P>>;
+    /**
+     * Instead of finding meta based on column or table instances,
+     * you can search for meta based on feature strings, such as `columnWidth`
+     */
+    withFeature: {
+        /**
+         * @public
+         *
+         * for a given column and feature name, return the "ColumnMeta" for that feature.
+         * This is useful when plugins may depend on one another but may not necessarily care which
+         * plugin is providing what behavior.
+         *
+         * For example, multiple column-focused plugins may care about width or visibility
+         */
+        forColumn<FeatureName extends string, Data = unknown>(column: Column<Data>, featureName: FeatureName): ColumnFeatures[FeatureName];
+        /**
+         * @public
+         *
+         * for a given table and feature name, return the "TableMeta" for that feature.
+         * This is useful when plugins may depend on one another but may not necessarily care
+         * which plugin is providing that behavior.
+         *
+         * For example, multiple column-focused plugins may care about width or visibility.
+         */
+        forTable<FeatureName extends string, Data = unknown>(table: Table<Data>, featureName: FeatureName): TableFeatures[FeatureName];
+    };
+};
+export declare const options: {
+    /**
+     * @public
+     *
+     * For a given table and plugin, return the options, if any were given from the user
+     * during construction of the table.
+     */
+    forTable<P extends BasePlugin<any>, Data = unknown>(table: Table<Data>, klass: Class<P>): Partial<OptionsFor<SignatureFrom<P>>>;
+    forColumn<P extends BasePlugin<any>, Data = unknown>(column: Column<Data>, klass: Class<P>): Partial<ColumnOptionsFor<SignatureFrom<P>>>;
+};
+export {};
+//# sourceMappingURL=base.d.ts.map

package/declarations/plugins/-private/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/plugins/-private/base.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,MAAM,EACN,UAAU,EACV,YAAY,EACb,MAAM,2BAA2B,CAAC;AAEnC,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,QAAQ,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IACxE;;;;OAIG;IACH,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE;;;;OAIG;IACH,WAAW,EAAE,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IACzE;;;;OAIG;IACH,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjE;;;;OAIG;IACH,WAAW,EAAE,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,UAAU,CAAC,GAAG,CAAC,IACrD,KAAK,SAAS,UAAU,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;AAEhE,OAAO,CAAC,MAAM,aAAa,EAAE,OAAO,MAAM,CAAC;AAE3C;;;;;;;;GAQG;AACH,8BAAsB,UAAU,CAAC,SAAS,GAAG,OAAO,CAClD,YAAW,MAAM,CAAC,SAAS,CAAC;IAEhB,SAAS,CAAC,KAAK,EAAE,KAAK;gBAAZ,KAAK,EAAE,KAAK;IAElC;;;;;;;;OAQG;IACK,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EACnC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,QAAQ,EAAE,MAAM,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAC3C,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAIvD;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EACxC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,QAAQ,EAAE,MAAM,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GACjD,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAIrD,IAAI,CAAC,EAAE;QACb,MAAM,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7C,GAAG,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;KAC1C,CAAC;IAEF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,OAAO,EACjE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAClB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,WAGhB;AAED,eAAO,MAAM,WAAW;IACtB;;;;;;;;;OASG;cACO,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,oBAC/B,MAAM,CAAC,IAAI,CAAC,SACb,KAAK,CAAC,CAAC,CAAC;QAGb;;WAEG;oBACS,MAAM;QASlB;;WAEG;iBACM,MAAM;QAOf;;WAEG;iBACM,MAAM,SAAS,OAAO;;IAYnC;;;;;OAKG;kBACW,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,mBACpC,KAAK,CAAC,IAAI,CAAC,SACX,KAAK,CAAC,CAAC,CAAC;QAGb;;WAEG;oBACS,MAAM;;IAgBtB;;;;;;;;;OASG;aACM,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,mBAC/B,KAAK,CAAC,IAAI,CAAC,SACX,KAAK,CAAC,CAAC,CAAC;QAGb;;WAEG;oBACS,MAAM;QAQlB;;WAEG;iBACM,MAAM;QAMf;;WAEG;iBACM,MAAM,SAAS,OAAO;;CAUpC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAS,UAAU,CAAC,QAAQ,GAAG,GAAG,EAChC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,EACtB,SAAS,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GACtB,MAAM,CAAC,QAAQ,CAAC,EAAE,CA0GpB;AAED,eAAO,MAAM,OAAO;;IAGlB;;;;;;OAMG;WACI,IAAI,qBACA,MAAM,CAAC,IAAI,CAAC,cACT,MAAM,CAAC,GAAG,CAAC,KACtB,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS;IAsB3B;;;;;;OAMG;eACQ,IAAI,qBACJ,MAAM,CAAC,IAAI,CAAC,cACT,MAAM,CAAC,GAAG,CAAC,KACtB,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS;IAoB3B;;;;;;OAMG;aACM,IAAI,qBACF,MAAM,CAAC,IAAI,CAAC,cACT,MAAM,CAAC,GAAG,CAAC,KACtB,MAAM,CAAC,IAAI,CAAC,EAAE;IASjB;;;;;;OAMG;YACK,IAAI,qBACD,MAAM,CAAC,IAAI,CAAC,cACT,MAAM,CAAC,GAAG,CAAC,KACtB,MAAM,CAAC,IAAI,CAAC,EAAE;CASlB,CAAC;AAEF,eAAO,MAAM,IAAI;IACf;;;;;;;OAOG;cACO,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,oBAC/B,MAAM,CAAC,IAAI,CAAC,SACb,KAAK,CAAC,CAAC,CAAC,GACd,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAuBlC;;;;;;;OAOG;WACI,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,iBAC/B,GAAG,CAAC,IAAI,CAAC,SACP,KAAK,CAAC,CAAC,CAAC,GACd,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAuB/B;;;;;OAKG;aACM,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,mBAC/B,KAAK,CAAC,IAAI,CAAC,SACX,KAAK,CAAC,CAAC,CAAC,GACd,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA4BjC;;;OAGG;;QAED;;;;;;;;WAQG;kBACO,WAAW,SAAS,MAAM,EAAE,IAAI,oBAChC,MAAM,CAAC,IAAI,CAAC,eACP,WAAW,GACvB,cAAc,CAAC,WAAW,CAAC;QAe9B;;;;;;;;WAQG;iBACM,WAAW,SAAS,MAAM,EAAE,IAAI,mBAChC,KAAK,CAAC,IAAI,CAAC,eACL,WAAW,GACvB,aAAa,CAAC,WAAW,CAAC;;CAehC,CAAC;AAuCF,eAAO,MAAM,OAAO;IAClB;;;;;OAKG;aACM,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,mBAC/B,KAAK,CAAC,IAAI,CAAC,SACX,KAAK,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;cAa9B,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,oBAC/B,MAAM,CAAC,IAAI,CAAC,SACb,KAAK,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAY/C,CAAC"}

package/declarations/plugins/-private/utils.d.ts

@@ -0,0 +1,22 @@
+import type { Constructor } from '../../-private/private-types';
+import type { Plugin } from '../../plugins';
+type PluginOption = Constructor<Plugin<any>> | [Constructor<Plugin<any>>, () => any];
+type ExpandedPluginOption = [Constructor<Plugin<any>>, () => any];
+export type Plugins = PluginOption[];
+export declare function normalizePluginsConfig(plugins?: Plugins): ExpandedPluginOption[];
+export declare function verifyPlugins(plugins: ExpandedPluginOption[]): void;
+type AssignableStyles = Omit<CSSStyleDeclaration, 'length' | 'parentRule'>;
+/**
+ * @public
+ *
+ * Utility that helps safely apply styles to an element
+ */
+export declare function applyStyles(element: HTMLElement | SVGElement, styles: Partial<AssignableStyles>): void;
+/**
+ * @public
+ *
+ * Utility that helps safely remove styles from an element
+ */
+export declare function removeStyles(element: HTMLElement | SVGElement, styles: Array<keyof AssignableStyles>): void;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/declarations/plugins/-private/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/plugins/-private/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C,KAAK,YAAY,GACb,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GACxB,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;AAE1C,KAAK,oBAAoB,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;AAElE,MAAM,MAAM,OAAO,GAAG,YAAY,EAAE,CAAC;AAErC,wBAAgB,sBAAsB,CACpC,OAAO,CAAC,EAAE,OAAO,GAChB,oBAAoB,EAAE,CA8BxB;AAsCD,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,EAAE,QA6B5D;AAED,KAAK,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAE3E;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,WAAW,GAAG,UAAU,EACjC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,QAWlC;AAiBD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,WAAW,GAAG,UAAU,EACjC,MAAM,EAAE,KAAK,CAAC,MAAM,gBAAgB,CAAC,QAMtC"}

package/declarations/plugins/column-reordering/helpers.d.ts

@@ -0,0 +1,33 @@
+import type { ColumnOrder } from './plugin.ts';
+import type { Column, Table } from '../../index.ts';
+/**
+ * Move the column one position to the left.
+ * If the column is first, nothing will happen.
+ */
+export declare const moveLeft: (column: Column) => void;
+/**
+ * Move the column one position to the right.
+ * If the column is last, nothing will happen.
+ */
+export declare const moveRight: (column: Column) => void;
+/**
+ * Override all column positions at once.
+ */
+export declare const setColumnOrder: (table: Table, order: ColumnOrder) => void;
+/**
+ * Ask if the column cannot move to the left
+ */
+export declare const cannotMoveLeft: (column: Column) => boolean;
+/**
+ * Ask if the column cannot move to the right
+ */
+export declare const cannotMoveRight: (column: Column) => boolean;
+/**
+ * Ask if the column can move to the left
+ */
+export declare const canMoveLeft: (column: Column) => boolean;
+/**
+ * Ask if the column can move to the right
+ */
+export declare const canMoveRight: (column: Column) => boolean;
+//# sourceMappingURL=helpers.d.ts.map

package/declarations/plugins/column-reordering/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/plugins/column-reordering/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,MAAM,SACc,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,MAAM,SACc,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,KAAK,EAAE,OAAO,WAAW,SAE9D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,YACY,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,YACY,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,YACe,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,YACe,CAAC"}

package/declarations/plugins/column-reordering/index.d.ts

@@ -0,0 +1,5 @@
+export * from './helpers.ts';
+export { ColumnOrder, ColumnReordering, orderOf } from './plugin.ts';
+export { ColumnReordering as Plugin } from './plugin.ts';
+export type { Signature } from './plugin.ts';
+//# sourceMappingURL=index.d.ts.map

package/declarations/plugins/column-reordering/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/column-reordering/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,gBAAgB,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAGzD,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/declarations/plugins/column-reordering/plugin.d.ts

@@ -0,0 +1,148 @@
+import { TrackedMap } from 'tracked-built-ins';
+import { BasePlugin } from '../-private/base.ts';
+import type { PluginPreferences } from '../../plugins/index.ts';
+import type { Column, Table } from '../../index.ts';
+interface ColumnReorderingPreferences extends PluginPreferences {
+    table: {
+        order?: Record<string, number>;
+    };
+}
+declare module '@universal-ember/table/plugins' {
+    interface Registry {
+        ColumnReordering?: ColumnReorderingPreferences;
+        'column-reordering'?: ColumnReorderingPreferences;
+    }
+}
+export interface Signature {
+    Meta: {
+        Column: ColumnMeta;
+        Table: TableMeta;
+    };
+}
+export declare class ColumnReordering extends BasePlugin<Signature> {
+    name: string;
+    static features: string[];
+    meta: {
+        readonly column: typeof ColumnMeta;
+        readonly table: typeof TableMeta;
+    };
+    reset(): void;
+    get columns(): Column<unknown>[];
+}
+export declare class ColumnMeta {
+    #private;
+    private column;
+    constructor(column: Column);
+    get position(): number;
+    set position(value: number);
+    get canMoveLeft(): boolean;
+    get canMoveRight(): boolean;
+    get cannotMoveLeft(): boolean;
+    get cannotMoveRight(): boolean;
+    /**
+     * Move the column one spot to the left
+     */
+    moveLeft: () => void;
+    /**
+     * Move the column one spot to the right
+     */
+    moveRight: () => void;
+}
+export declare class TableMeta {
+    private table;
+    constructor(table: Table);
+    /**
+     * @private
+     *
+     * We want to maintain the instance of this ColumnOrder class because
+     * we allow the consumer of the table to swap out columns at any time.
+     * When they do this, we want to maintain the order of the table, best we can.
+     * This is also why the order of the columns is maintained via column key
+     */
+    columnOrder: ColumnOrder;
+    /**
+     * Get the curret order/position of a column
+     */
+    getPosition(column: Column): number;
+    /**
+     * Swap the column with the column at `newPosition`
+     */
+    setPosition(column: Column, newPosition: number): false | undefined;
+    /**
+     * Using a `ColumnOrder` instance, set the order of all columns
+     */
+    setOrder: (order: ColumnOrder) => void;
+    /**
+     * Revert to default config, delete preferences,
+     * and clear the columnOrder
+     */
+    reset(): void;
+    /**
+     * @private
+     */
+    save(map: Map<string, number>): void;
+    /**
+     * @private
+     */
+    private read;
+    get columns(): Column<unknown>[];
+    /**
+     * @private
+     * This isn't our data to expose, but it is useful to alias
+     */
+    private get availableColumns();
+}
+/**
+ * @private
+ * Used for keeping track of and updating column order
+ */
+export declare class ColumnOrder {
+    private args;
+    /**
+     * This map will be empty until we re-order something.
+     */
+    map: TrackedMap<string, number>;
+    constructor(args: {
+        columns: () => Column[];
+        save?: (order: Map<string, number>) => void;
+        existingOrder?: Map<string, number>;
+    });
+    /**
+     * To account for columnVisibilty, we need to:
+     * - get the list of visible columns
+     * - get the column order (which preserves the order of hidden columns)
+     * - skip over non-visible columns when determining the previous "index"
+     * - set the position to whatever that is.
+     */
+    moveLeft(key: string): void;
+    setAll: (map: Map<string, number>) => void;
+    /**
+     * To account for columnVisibilty, we need to:
+     * - get the list of visible columns
+     * - get the column order (which preserves the order of hidden columns)
+     * - skip over non-visible columns when determining the next "index"
+     * - set the position to whatever that is.
+     */
+    moveRight(key: string): void;
+    /**
+     * Performs a swap of the column's position with the column at position
+     */
+    swapWith(key: string, position: number): false | undefined;
+    get(key: string): number;
+    /**
+     * The same as this.map, but with all the columns' information
+     */
+    get orderedMap(): ReadonlyMap<string, number>;
+    get orderedColumns(): Column[];
+}
+/**
+ * @private
+ *
+ * Utility for helping determine the percieved order of a set of columns
+ * given the original (default) ordering, and then user-configurations
+ */
+export declare function orderOf(columns: {
+    key: string;
+}[], currentOrder: Map<string, number>): Map<string, number>;
+export {};
+//# sourceMappingURL=plugin.d.ts.map

package/declarations/plugins/column-reordering/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/column-reordering/plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAI/C,OAAO,EAAE,UAAU,EAAiB,MAAM,qBAAqB,CAAC;AAEhE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEpD,UAAU,2BAA4B,SAAQ,iBAAiB;IAC7D,KAAK,EAAE;QACL,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAChC,CAAC;CACH;AAED,OAAO,QAAQ,gCAAgC,CAAC;IAC9C,UAAU,QAAQ;QAChB,gBAAgB,CAAC,EAAE,2BAA2B,CAAC;QAC/C,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;KACnD;CACF;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE;QACJ,MAAM,EAAE,UAAU,CAAC;QACnB,KAAK,EAAE,SAAS,CAAC;KAClB,CAAC;CACH;AAED,qBAAa,gBAAiB,SAAQ,UAAU,CAAC,SAAS,CAAC;IACzD,IAAI,SAAuB;IAC3B,MAAM,CAAC,QAAQ,WAAmB;IAElC,IAAI;;;MAGO;IAEX,KAAK;IAML,IAAI,OAAO,sBAEV;CACF;AAED,qBAAa,UAAU;;IACT,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAMlC,IAAI,QAAQ,IAIQ,MAAM,CAFzB;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED,IAAI,WAAW,YAEd;IAED,IAAI,YAAY,YAKf;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,eAAe,YAElB;IAED;;OAEG;IACH,QAAQ,aAEN;IAEF;;OAEG;IACH,SAAS,aAEP;CACH;AAED,qBAAa,SAAS;IACR,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,KAAK;IAEhC;;;;;;;OAOG;IAEH,WAAW,cAIR;IAEH;;OAEG;IAEH,WAAW,CAAC,MAAM,EAAE,MAAM;IAI1B;;OAEG;IAEH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAI/C;;OAEG;IACH,QAAQ,GAAI,OAAO,WAAW,UAE5B;IAEF;;;OAGG;IAEH,KAAK;IAQL;;OAEG;IAEH,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAU7B;;OAEG;IAEH,OAAO,CAAC,IAAI;IAUZ,IAAI,OAAO,sBAEV;IAED;;;OAGG;IACH,OAAO,KAAK,gBAAgB,GAE3B;CACF;AAED;;;GAGG;AACH,qBAAa,WAAW;IAOpB,OAAO,CAAC,IAAI;IANd;;OAEG;IACH,GAAG,6BAAoC;gBAG7B,IAAI,EAAE;QACZ,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;QACxB,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;QAC5C,aAAa,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACrC;IAOH;;;;;;OAMG;IAEH,QAAQ,CAAC,GAAG,EAAE,MAAM;IAyBpB,MAAM,GAAI,KAAK,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,UAQhC;IAEF;;;;;;OAMG;IAEH,SAAS,CAAC,GAAG,EAAE,MAAM;IAyBrB;;OAEG;IAEH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IA6EtC,GAAG,CAAC,GAAG,EAAE,MAAM;IAYf;;OAEG;IACH,IACI,UAAU,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAE5C;IAED,IACI,cAAc,IAAI,MAAM,EAAE,CAiC7B;CACF;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CACrB,OAAO,EAAE;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE,EAC1B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAChC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CA8CrB"}

package/declarations/plugins/column-reordering/utils.d.ts

@@ -0,0 +1,8 @@
+import type { Column } from '../../index.ts';
+type ColumnOrder = {
+    key: string;
+    position: number | undefined;
+}[];
+export declare function reorderColumns(columns: Column[], orderedColumns: ColumnOrder | undefined): Column<unknown>[];
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/declarations/plugins/column-reordering/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/plugins/column-reordering/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,KAAK,WAAW,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,EAAE,CAAC;AAEnE,wBAAgB,cAAc,CAC5B,OAAO,EAAE,MAAM,EAAE,EACjB,cAAc,EAAE,WAAW,GAAG,SAAS,qBAsCxC"}

package/declarations/plugins/column-resizing/handle.d.ts

@@ -0,0 +1,128 @@
+import Modifier from 'ember-modifier';
+import type { ColumnMeta } from './plugin.ts';
+import type { Column } from '../../-private/column.ts';
+/**
+ * - why are mouse events used instead of drag events?
+ * - why not use the "draggable" attribute?
+ *
+ * It seems drag events are more for files and/or moving images around on a page
+ * dragging an image, for example, has a ghost of that image until it is dropped.
+ * The same thing happens with text.
+ * This prevents us from having total control of the styling of how dragging works.
+ *
+ *
+ *
+ */
+declare class ResizeHandle extends Modifier<{
+    Args: {
+        Positional: [Column];
+    };
+}> {
+    dragHandle: HTMLElement;
+    column: Column;
+    meta: ColumnMeta;
+    pointerStartX: number;
+    pointerStartY: number;
+    pointerX: number;
+    pointerY: number;
+    dragFrame: number;
+    keyDistance: number;
+    keyFrame: number;
+    lastKey: number;
+    token?: unknown;
+    isSetup: boolean;
+    modify(element: Element, [column]: [Column]): void;
+    setup: () => void;
+    setPosition: (event: Event) => void;
+    setStartPosition: (event: Event) => void;
+    /**
+     * queueUpdate takes an optional function argument that is called
+     * in the requestAnimationFrame callback _after_ the resize function.
+     *
+     * We can use this to ensure that preferences are only ever saved after
+     * we have completed column resizing.
+     *
+     * Because the requestAnimationFrame 'hides' these function calls from the
+     * the ember test waiter, we also ensure that we track them by also cancelling
+     * the waiter in the requestAnimationFrame callback.
+     */
+    queueUpdate: (callback?: () => void) => void;
+    dragEndHandler: () => void;
+    dragMove: (event: Event) => void;
+    dragStartHandler: (event: Event) => void;
+    keyHandler: (event: KeyboardEvent) => void;
+}
+/**
+ * Modifier to attach to the column resize handles.
+ * This provides both keyboard and mouse support for resizing columns.
+ * (provided the resize handle element is focusable -- so consider using
+ * a button for the resize element)
+ *
+ * @example
+ * ```js
+ * import Component from '@glimmer/component';
+ * import { meta } from '@universal-ember/table/plugins';
+ * import { resizeHandle, ColumnResizing } from '@universal-ember/table/plugins/column-resizing';
+ *
+ * export default class TableHead extends Component {
+ *   /* ✂️  *\/
+ *
+ *   <template>
+ *     <thead>
+ *       <tr>
+ *         {{#each this.columns as |column|}}
+ *           <th>
+ *             <span>{{column.name}}</span>
+ *             <button {{resizeHandle column}}></button>
+ *           </th>
+ *         {{/each}}
+ *       </tr>
+ *     </thead>
+ *   </template>
+ * }
+ * ```
+ *
+ * Width and isResizing state is maintained on the "meta"
+ * class so that the users may choose per-column stylings for
+ * isResizing and dragging behaviors.
+ *
+ * For example, while dragging, the user may add a class based on the
+ * isDragging property.
+ *
+ * @example
+ * ```js
+ * import Component from '@glimmer/component';
+ * import { meta } from '@universal-ember/table/plugins';
+ * import { resizeHandle, ColumnResizing } from '@universal-ember/table/plugins/column-resizing';
+ *
+ * export default class TableHead extends Component {
+ *   /* ✂️  *\/
+ *
+ *   isDragging = (column) => {
+ *     return meta.forColumn(column, ColumnResizing).isDragging;
+ *   }
+ *
+ *   <template>
+ *     <thead>
+ *       <tr>
+ *         {{#each this.columns as |column|}}
+ *           <th class="header {{if (this.isDragging column) 'blue'}}">
+ *             <span>{{column.name}}</span>
+ *             <button {{resizeHandle column}}></button>
+ *           </th>
+ *         {{/each}}
+ *       </tr>
+ *     </thead>
+ *   </template>
+ * }
+ * ```
+ *
+ *
+ * @note
+ * The logic here is copied from the drag slider in
+ * https://limber.glimdown.com/
+ * See: "resize-handle" on Limber's GitHub
+ */
+export declare const resizeHandle: typeof ResizeHandle;
+export {};
+//# sourceMappingURL=handle.d.ts.map

package/declarations/plugins/column-resizing/handle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../../../src/plugins/column-resizing/handle.ts"],"names":[],"mappings":"AAGA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAKtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;;;;;;;;;;GAWG;AAEH,cAAM,YAAa,SAAQ,QAAQ,CAAC;IAAE,IAAI,EAAE;QAAE,UAAU,EAAE,CAAC,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,CAAC;IAC7D,UAAU,EAAE,WAAW,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IAGzB,aAAa,SAAK;IAClB,aAAa,SAAK;IAClB,QAAQ,SAAK;IACb,QAAQ,SAAK;IACL,SAAS,EAAE,MAAM,CAAC;IAG1B,WAAW,SAAK;IACR,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAGxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,OAAO,UAAS;IAChB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC;IAW3C,KAAK,aAqBH;IAEF,WAAW,GAAI,OAAO,KAAK,UAczB;IAEF,gBAAgB,GAAI,OAAO,KAAK,UAc9B;IAEF;;;;;;;;;;OAUG;IACH,WAAW,GAAI,WAAW,MAAM,IAAI,UAkBlC;IAEF,cAAc,aAYZ;IAEF,QAAQ,GAAI,OAAO,KAAK,UAItB;IAEF,gBAAgB,GAAI,OAAO,KAAK,UAmB9B;IAEF,UAAU,GAAI,OAAO,aAAa,UAoBhC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,eAAO,MAAM,YAAY,qBAAe,CAAC"}