@universal-ember/table 3.0.2 → 3.0.3

package/declarations/plugins/row-selection/plugin.d.ts

@@ -0,0 +1,80 @@
+import { BasePlugin } from '../-private/base.ts';
+import type { Row, Table } from '../../index.ts';
+import type { PluginSignature, RowApi } from '../../-private/interfaces';
+export interface Signature<DataType = any, Key = DataType> extends PluginSignature {
+    Meta: {
+        Table: TableMeta;
+        Row: RowMeta;
+    };
+    Options: {
+        Plugin: {
+            /**
+             * A set of selected things using the same type of Identifier
+             * returned from `key`
+             */
+            selection: Set<Key> | Array<Key>;
+        } & ({
+            /**
+             * For a given row's data, how should the key be determined?
+             * this could be a remote id from a database, or some other attribute
+             *
+             * This could be useful for indicating in UI if a particular item is selected.
+             *
+             * If not provided, the row's data will be used as the key
+             */
+            key: (data: DataType) => Key;
+            /**
+             * When a row is clicked, this will be invoked,
+             * allowing you to update your selection object
+             */
+            onSelect: (item: Key, row: Row<DataType>) => void;
+            /**
+             * When a row is clicked (and the row is selected), this will be invoked,
+             * allowing you to update your selection object
+             */
+            onDeselect: (item: Key, row: Row<DataType>) => void;
+        } | {
+            /**
+             * When a row is clicked (and the row is not selected), this will be invoked,
+             * allowing you to update your selection object
+             */
+            onSelect: (item: DataType | any, row: Row<DataType>) => void;
+            /**
+             * When a row is clicked (and the row is selected), this will be invoked,
+             * allowing you to update your selection object
+             */
+            onDeselect: (item: DataType | any, row: Row<DataType>) => void;
+        });
+    };
+}
+/**
+ * This plugin provides a means of managing selection of a single row in a table.
+ *
+ * The state of what is actually selected is managed by you, but this plugin
+ * will wire up the click listeners as well as let you know which *data* is clicked.
+ */
+export declare class RowSelection<DataType = any, Key = DataType> extends BasePlugin<Signature<DataType, Key>> {
+    #private;
+    name: string;
+    meta: {
+        row: typeof RowMeta;
+        table: typeof TableMeta;
+    };
+    constructor(table: Table);
+    rowModifier: (element: HTMLElement, { row }: RowApi<Table<any>>) => () => void;
+}
+declare class TableMeta {
+    #private;
+    constructor(table: Table);
+    get selection(): Set<unknown>;
+}
+declare class RowMeta {
+    #private;
+    constructor(row: Row<any>);
+    get isSelected(): boolean;
+    toggle: () => void;
+    select: () => void;
+    deselect: () => void;
+}
+export {};
+//# sourceMappingURL=plugin.d.ts.map

package/declarations/plugins/row-selection/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/row-selection/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAiB,MAAM,qBAAqB,CAAC;AAEhE,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAEzE,MAAM,WAAW,SAAS,CAAC,QAAQ,GAAG,GAAG,EAAE,GAAG,GAAG,QAAQ,CACvD,SAAQ,eAAe;IACvB,IAAI,EAAE;QACJ,KAAK,EAAE,SAAS,CAAC;QACjB,GAAG,EAAE,OAAO,CAAC;KACd,CAAC;IACF,OAAO,EAAE;QACP,MAAM,EAAE;YACN;;;eAGG;YACH,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;SAClC,GAAG,CACA;YACE;;;;;;;eAOG;YACH,GAAG,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAC;YAC7B;;;eAGG;YACH,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;YAClD;;;eAGG;YACH,UAAU,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;SACrD,GACD;YACE;;;eAGG;YACH,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;YAC7D;;;eAGG;YACH,UAAU,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;SAChE,CACJ,CAAC;KACH,CAAC;CACH;AAED;;;;;GAKG;AACH,qBAAa,YAAY,CAAC,QAAQ,GAAG,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAE,SAAQ,UAAU,CAC1E,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CACzB;;IACC,IAAI,SAAmB;IAEvB,IAAI;;;MAGF;gBAEU,KAAK,EAAE,KAAK;IAcxB,WAAW,GAAI,SAAS,WAAW,EAAE,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,gBAU9D;CAiCH;AAED,cAAM,SAAS;;gBAGD,KAAK,EAAE,KAAK;IAIxB,IACI,SAAS,IAAI,GAAG,CAAC,OAAO,CAAC,CAa5B;CACF;AAED,cAAM,OAAO;;gBAGC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC;IAIzB,IAAI,UAAU,IAAI,OAAO,CAaxB;IAED,MAAM,aAQJ;IAEF,MAAM,aAYJ;IAEF,QAAQ,aAYN;CACH"}

package/declarations/plugins/sticky-columns/helpers.d.ts

@@ -0,0 +1,17 @@
+import { htmlSafe } from '@ember/template';
+import type { Column } from '../../index.ts';
+export declare const isSticky: <DataType = unknown>(column: Column<DataType>) => boolean;
+export declare const styleFor: <DataType = unknown>(column: Column<DataType>) => Partial<CSSStyleDeclaration>;
+/**
+ * In this plugin, both header and cells have the same styles,
+ * if applicable.
+ *
+ * Until this RFC https://github.com/emberjs/rfcs/pull/883
+ * is merged and implemented, we can't performantly
+ * use modifiers for apply styles.
+ *
+ * In the mean time, we'll need to append style strings, which is more work
+ * for consumers, but is a reasonable trade-off for now.
+ */
+export declare const styleStringFor: <DataType = unknown>(column: Column<DataType>) => ReturnType<typeof htmlSafe>;
+//# sourceMappingURL=helpers.d.ts.map

package/declarations/plugins/sticky-columns/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/plugins/sticky-columns/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAK3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,eAAO,MAAM,QAAQ,GAAI,QAAQ,GAAG,OAAO,EAAE,QAAQ,MAAM,CAAC,QAAQ,CAAC,YACrB,CAAC;AAEjD,eAAO,MAAM,QAAQ,GAAI,QAAQ,GAAG,OAAO,EACzC,QAAQ,MAAM,CAAC,QAAQ,CAAC,KACvB,OAAO,CAAC,mBAAmB,CAAgD,CAAC;AAE/E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,GAAG,OAAO,EAC/C,QAAQ,MAAM,CAAC,QAAQ,CAAC,KACvB,UAAU,CAAC,OAAO,QAAQ,CAc5B,CAAC"}

package/declarations/plugins/sticky-columns/index.d.ts

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

package/declarations/plugins/sticky-columns/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/sticky-columns/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAGtD,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/declarations/plugins/sticky-columns/plugin.d.ts

@@ -0,0 +1,70 @@
+import { BasePlugin } from '../-private/base.ts';
+import type { ColumnApi } from '../../plugins/index.ts';
+import type { Column } from '../../index.ts';
+interface ColumnOptions {
+    /**
+     * Whether or not to enable stickiness on the column
+     * (default is false)
+     *
+     * valid values: 'left', 'right', false
+     */
+    sticky?: boolean | string;
+}
+export interface Signature {
+    Options: {
+        Column: ColumnOptions;
+        Plugin: {
+            /**
+             * Opts this plugin out of engaging in the modifier system
+             * and instead requires setting a `style` attribute on
+             * th / td tags for getting the "position: sticky" behovior
+             * on columns.
+             */
+            workaroundForModifierTimingUpdateRFC883?: boolean;
+        };
+    };
+    Meta: {
+        Table: TableMeta;
+        Column: ColumnMeta;
+    };
+}
+export declare class StickyColumns extends BasePlugin<Signature> {
+    name: string;
+    /**
+     * This plugin requires that the resizing plugin be present, because the resizing plugin is
+     * what manages the base width of the columns.
+     *
+     * Other width-management plugins can be used instead of ColumnResizing, but they must declare
+     * that they manage the width of the columns.
+     */
+    static requires: string[];
+    meta: {
+        table: typeof TableMeta;
+        column: typeof ColumnMeta;
+    };
+    conditionallyRemoveStyles: (element: HTMLElement) => void;
+    headerCellModifier: (element: HTMLElement, { column, table }: ColumnApi) => void;
+    /**
+     * Not yet supported. Pending Ember RFC #883
+     *
+     * TODO: switch ColumnApi to "RowApi", add the row's data
+     */
+    cellModifier: (element: HTMLElement, { column, table }: ColumnApi) => void;
+}
+/**
+ * @private
+ *
+ * Contains state and behaviors for the sticiness
+ */
+export declare class ColumnMeta {
+    private column;
+    constructor(column: Column);
+    get isSticky(): boolean;
+    get position(): 'left' | 'right' | 'none';
+    get offset(): string | undefined;
+    get style(): Partial<Pick<CSSStyleDeclaration, 'position' | 'left' | 'right' | 'zIndex'>>;
+}
+export declare class TableMeta {
+}
+export {};
+//# sourceMappingURL=plugin.d.ts.map

package/declarations/plugins/sticky-columns/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/sticky-columns/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAA0B,MAAM,qBAAqB,CAAC;AAGzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAI7C,UAAU,aAAa;IACrB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE;QACP,MAAM,EAAE,aAAa,CAAC;QACtB,MAAM,EAAE;YACN;;;;;eAKG;YACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;SACnD,CAAC;KACH,CAAC;IACF,IAAI,EAAE;QACJ,KAAK,EAAE,SAAS,CAAC;QACjB,MAAM,EAAE,UAAU,CAAC;KACpB,CAAC;CACH;AAED,qBAAa,aAAc,SAAQ,UAAU,CAAC,SAAS,CAAC;IACtD,IAAI,SAAoB;IAExB;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,WAAmB;IAElC,IAAI;;;MAGF;IAEF,yBAAyB,GAAI,SAAS,WAAW,UAgB/C;IAEF,kBAAkB,GAAI,SAAS,WAAW,EAAE,mBAAmB,SAAS,UAetE;IAEF;;;;OAIG;IACH,YAAY,GAAI,SAAS,WAAW,EAAE,mBAAmB,SAAS,UAehE;CACH;AAED;;;;GAIG;AACH,qBAAa,UAAU;IACT,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAElC,IAAI,QAAQ,YAEX;IAED,IAAI,QAAQ,IAAI,MAAM,GAAG,OAAO,GAAG,MAAM,CAYxC;IAED,IACI,MAAM,uBAoCT;IAED,IAAI,KAAK,IAAI,OAAO,CAClB,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC,CACpE,CAUA;CACF;AAOD,qBAAa,SAAS;CAAG"}

package/declarations/test-support/index.d.ts

@@ -0,0 +1,15 @@
+interface Selectors {
+    resizeHandle?: string;
+    scrollContainer?: string;
+}
+export declare function createHelpers(selectors: Selectors): {
+    dragLeft: (column: Element, amount: number) => Promise<void>;
+    dragRight: (column: Element, amount: number) => Promise<void>;
+    scrollLeft: (distance: number) => Promise<void>;
+    scrollRight: (distance: number) => Promise<void>;
+    swipeLeft: (distance: number) => Promise<void>;
+    swipeRight: (distance: number) => Promise<void>;
+};
+export declare function requestAnimationFrameSettled(): Promise<void>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/declarations/test-support/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test-support/index.ts"],"names":[],"mappings":"AAGA,UAAU,SAAS;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS;uBAuD3B,OAAO,UAAU,MAAM;wBACtB,OAAO,UAAU,MAAM;2BATT,MAAM;4BAPL,MAAM;0BAAN,MAAM;2BAOP,MAAM;EAe3C;AAED,wBAAsB,4BAA4B,kBAGjD"}

package/declarations/utils.d.ts

@@ -0,0 +1,26 @@
+import type { Sort, SortsOptions } from './plugins/data-sorting/types.ts';
+/**
+ * @example
+ *
+ * ```ts
+ * deserializeSorts('first_name.asc', { separator: '.', transform: 'camelize' });
+ * // => [{ property: 'firstName', direction: 'ascending' }]
+ *
+ * deserializeSorts('last_name.desc', { separator: '.', transform: 'camelize' });
+ * // => [{ property: 'lastName', direction: 'descending' }]
+ * ```
+ */
+export declare const deserializeSorts: (sortString: string, options?: SortsOptions) => Sort[];
+/**
+ * @example
+ *
+ * ```ts
+ * serializeSorts([{ property: 'firstName', direction: 'ascending' }],{ separator: '.', transform: 'camelize' });
+ * // => 'first_name.asc'
+ *
+ * serializeSorts([{ property: 'lastName', direction: 'descending' }],{ separator: '.', transform: 'camelize' });
+ * // => 'last_name.desc'
+ * ```
+ */
+export declare function serializeSorts(sorts: Sort[], options?: SortsOptions): string;
+//# sourceMappingURL=utils.d.ts.map

package/declarations/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE1E;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,gBAAgB,GAC3B,YAAY,MAAM,EAClB,UAAS,YAAwD,KAChE,IAAI,EA4BN,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,GAAE,YAA0D,GAClE,MAAM,CAkBR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@universal-ember/table",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "An implementation of table behaviors for driving any table or table-like UI -- all without a UI (headless)",
   "keywords": [
     "ember-addon",
@@ -13,6 +13,7 @@
   "author": "NullVoxPopuli",
   "files": [
     "addon-main.js",
+    "declarations",
     "dist",
     "src"
   ],