npm - @hortonstudio/main - Versions diffs - 1.2.11 → 1.2.13 - Mend

@hortonstudio/main 1.2.11 → 1.2.13

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 (489) hide show

package/attributes-master/packages/list/CHANGELOG.md DELETED Viewed

@@ -1,185 +0,0 @@
-# @finsweet/attributes-list
-## 1.5.0
-### Minor Changes
-- bc17316: feat: `fs-list-showtag`
-## 1.4.7
-### Patch Changes
-- 978384a: fix: support `fs-list-element="facet-count"` for elements that are rendered after initializing filters
-## 1.4.6
-### Patch Changes
-- 3b9fe56: fix: don't set empty arrays in query params
-## 1.4.5
-### Patch Changes
-- 81e9e3e: fix: only JSON.stringify array values for query params
-- 124839b: fix: query params filters reactivity
-## 1.4.4
-### Patch Changes
-- 2f45dd5: fix: hide next buttons correclty when items are filtered
-## 1.4.3
-### Patch Changes
-- 621ed61: fix: hide pagination next when itemsPerPage > items.length
-## 1.4.2
-### Patch Changes
-- 6246fbb: fix: combine + pagination
-- 2eac30b: fix: prevent race conditions in facet counts
-- d2af879: fix: filtering items with nested properties
-## 1.4.1
-### Patch Changes
-- Updated dependencies [2af0bad]
-  - @finsweet/attributes-utils@0.1.0
-## 1.4.0
-### Minor Changes
-- 4805858: feat: beautify query params
-### Patch Changes
-- 4805858: fix: respect `fs-list-allowsubmit` for sorting forms
-## 1.3.1
-### Patch Changes
-- Updated dependencies [378d74d]
-  - @finsweet/attributes-utils@0.0.6
-## 1.3.0
-### Minor Changes
-- 8c7ab62: feat: support debouncing in dynamic mode
-### Patch Changes
-- 102879c: chore: trim field attributes
-- f5b70e5: chore: remove console logs in the wild
-## 1.2.9
-### Patch Changes
-- c685c7b: fix: active class removal
-- Updated dependencies [01973d8]
-  - @finsweet/attributes-utils@0.0.5
-## 1.2.8
-### Patch Changes
-- Updated dependencies [deef758]
-  - @finsweet/attributes-utils@0.0.4
-## 1.2.7
-### Patch Changes
-- 1c2900f: fix: support 2 way binding for dynamic filter values
-- d21cbca: refactor: unify form field value getters and setters
-- Updated dependencies [d21cbca]
-  - @finsweet/attributes-utils@0.0.3
-## 1.2.6
-### Patch Changes
-- 58529b7: fix: make infinite loading more responsive
-- ed6876f: fix: update page count in more/infinite modes
-## 1.2.5
-### Patch Changes
-- 216237e: fix: fall back fs-list-loadcount source to the list element
-- b84f8cd: fix: support `fs-list-element="clear"` in dynamic mode
-## 1.2.4
-### Patch Changes
-- 87fef70: fix: resetix
-## 1.2.3
-### Patch Changes
-- 76a962f: fix: only highlight text nodes
-## 1.2.2
-### Patch Changes
-- c7b544d: chore: updated dependencies
-- Updated dependencies [c7b544d]
-  - @finsweet/attributes-utils@0.0.2
-## 1.2.1
-### Patch Changes
-- 43ffe73: fix: removal of items
-## 1.2.0
-### Minor Changes
-- 205c30b: feat: list animations
-### Patch Changes
-- f349526: chore: finalize animations
-## 1.1.0
-### Minor Changes
-- 3f92ebb: feat: remove tags in dynamic mode
-## 1.0.0
-### Major Changes
-- 99ec3f2: feat: fs-list
-## 0.1.1
-### Patch Changes
-- b56e5e5: rename fsAttribute in places of usage to finsweetAttribute
-- Updated dependencies [b56e5e5]
-  - @finsweet/attributes-utils@0.0.1
-## 0.1.0
-### Minor Changes
-- e2ca8e3: fs-list: added automatic & manual nesting
-### Patch Changes
-- 7081cb7: fs-list: renamed "load" options

package/attributes-master/packages/list/README.md DELETED Viewed

@@ -1,331 +0,0 @@
-# `list` Attribute
-Supercharge your Webflow CMS and static lists.
-## Getting Started
-Please follow the documentation at [finsweet.com/attributes](https://www.finsweet.com/attributes) to learn how to use Attributes in your Webflow projects.
-## Accessing the API
-To learn how to access the API, please check the general [API Reference](../attributes/README.md#api-reference) documentation:
-```javascript
-window.FinsweetAttributes ||= [];
-window.FinsweetAttributes.push([
-  'list',
-  (listInstances) => {
-    // Your code goes here.
-  },
-]);
-```
-The `result` object contains the [List](#the-list-object) instances that are currently active on the page.
-## The `List` object
-### Reactivity
-List instances have a set of [reactive properties](#reactive-properties) powered by [@vue/reactivity](https://vuejs.org/api/reactivity-core.html). These properties allow us to track them and run logic when they change.
-### Lifecycle of the items
-The items in the list instances follow a lifecycle that is divided into the following phases:
-1. `start`: The items are in their initial state.
-2. `filter`: The items are being filtered.
-3. `sort`: The items are being sorted.
-4. `pagination`: The items are being paginated.
-5. `beforeRender`: The items are about to be rendered.
-6. `render`: The items are being rendered.
-7. `afterRender`: The items have been rendered.
-Not all phases are always executed, as the lifecycle may start at any point depending on the actions taken by the user. For example, if the user interacts with the sorting controls, the lifecycle will start at the `sort` phase. If the user interacts with the pagination controls, the lifecycle will start at the `pagination` phase.
-You can hook into any of these phases by using the [List.addHook()](#listaddhookkey-callback) method, allowing you to run custom logic and interact with the items at any point in the lifecycle.
-### Adding and removing items from the list
-The [List.items](#reactive-properties) property is a [shallowRef](https://vuejs.org/api/reactivity-advanced#shallowref) array that contains the items in the list. You can add and remove items from the list by simply mutating the array:
-```javascript
-listInstance.items.value = listInstance.items.value.filter((item) => {
-  return item.fields.target.value === 'adults';
-});
-```
-To create new item instances, you can use the [List.createItem()](#listcreateitemelement) method, which takes a DOM element as an argument and returns a new [ListItem](#the-listitem-object) instance:
-```javascript
-const newItem = listInstance.createItem(element);
-listInstance.items.value = [...listInstance.items.value, newItem];
-```
-### Updating the filters
-The [List.filters](#reactive-properties) property is a [ref](https://vuejs.org/api/reactivity-core.html#ref) object that contains the filters applied to the list. You can update the filters by simply mutating the object:
-```javascript
-listInstance.filters.value.groups[0].conditions.push({
-  id: 'new-condition',
-  type: 'checkbox',
-  fieldKey: 'premium',
-  op: 'equal',
-  value: 'true',
-});
-```
-### Updating the sorting
-The [List.sorting](#reactive-properties) property is a [ref](https://vuejs.org/api/reactivity-core.html#ref) object that contains the sorting applied to the list. You can update the sorting by simply mutating the object:
-```javascript
-listInstance.sorting.value.fieldKey = 'name';
-listInstance.sorting.value.direction = 'asc';
-```
-### Updating the pagination
-You can update the pagination by simply mutating the [List.currentPage](#reactive-properties) and/or [List.itemsPerPage](#reactive-properties) properties:
-```javascript
-listInstance.currentPage.value = 2;
-```
-### Watching for changes
-You can watch for any changes to the [reactive properties](#reactive-properties) using the [List.watch()](#listwatchsource-callback-options) method:
-```javascript
-listInstance.watch(
-  () => listInstance.items,
-  (newItems, oldItems) => {
-    console.log('Items updated:', newItems, oldItems);
-  }
-);
-```
-You can also use the [List.effect()](#listeffectcallback-options) method to run a function whenever the reactive properties change:
-```javascript
-listInstance.effect(() => {
-  console.log('Total items:', listInstance.items.value.length);
-});
-```
-### Reactive properties
-| Property        | Reactive Type                                                      | Value Type                         | Description                                          |
-| --------------- | ------------------------------------------------------------------ | ---------------------------------- | ---------------------------------------------------- |
-| `items`         | [shallowRef](https://vuejs.org/api/reactivity-advanced#shallowref) | [ListItem[]](#the-listitem-object) | The items in the list.                               |
-| `filters`       | [ref](https://vuejs.org/api/reactivity-core.html#ref)              | [Filters](#the-filters-object)     | The filters applied to the list.                     |
-| `sorting`       | [ref](https://vuejs.org/api/reactivity-core.html#ref)              | [Sorting](#the-sorting-object)     | The sorting applied to the list.                     |
-| `currentPage`   | [ref](https://vuejs.org/api/reactivity-core.html#ref)              | `number`                           | The current page number.                             |
-| `itemsPerPage`  | [ref](https://vuejs.org/api/reactivity-core.html#ref)              | `number`                           | The amount of items to display on each page.         |
-| `totalPages`    | [computed](https://vuejs.org/api/reactivity-core.html#computed)    | `number`                           | The total number of pages.                           |
-| `hasInteracted` | [computed](https://vuejs.org/api/reactivity-core.html#computed)    | `number`                           | Defines if the user has interacted with the filters. |
-| `allFieldsData` | [computed](https://vuejs.org/api/reactivity-core.html#computed)    | `Object`                           | Defines the data for all item fields in the list.    |
-### Standard properties
-| Property                        | Type                               | Description                                                                                           |
-| ------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `pageIndex`                     | `number`                           | The index of the list in the page.                                                                    |
-| `instance`                      | `string \| null`                   | The instance key of the list, if defined using `[fs-list-instance]`.                                  |
-| `wrapperElement`                | `HTMLElement`                      | The wrapper element of the list.                                                                      |
-| `listElement`                   | `HTMLElement \| null`              | The list element.                                                                                     |
-| `paginationWrapperElement`      | `HTMLElement \| null \| undefined` | The pagination wrapper element.                                                                       |
-| `paginationCountElement`        | `HTMLElement \| null \| undefined` | The page count element.                                                                               |
-| `initialElement`                | `HTMLElement \| null \| undefined` | An initial element to display when there are no filters applied.                                      |
-| `loaderElement`                 | `HTMLElement \| null \| undefined` | A custom loader element.                                                                              |
-| `itemsCountElement`             | `HTMLElement \| null \| undefined` | An element that displays the total amount of items in the list.                                       |
-| `resultsCountElement`           | `HTMLElement \| null \| undefined` | An element that displays the total amount of items after filtering.                                   |
-| `visibleCountElement`           | `HTMLElement \| null \| undefined` | An element that displays the amount of visible items.                                                 |
-| `visibleCountFromElement`       | `HTMLElement \| null \| undefined` | An element that displays the lower range of visible items.                                            |
-| `visibleCountToElement`         | `HTMLElement \| null \| undefined` | An element that displays the upper range of visible items.                                            |
-| `scrollAnchorElement`           | `HTMLElement \| null \| undefined` | The scroll anchor element.                                                                            |
-| `scrollAnchorFilterElement`     | `HTMLElement \| null \| undefined` | A custom scroll anchor element for filter actions.                                                    |
-| `scrollAnchorSortElement`       | `HTMLElement \| null \| undefined` | A custom scroll anchor element for sort actions.                                                      |
-| `scrollAnchorPaginationElement` | `HTMLElement \| null \| undefined` | A custom scroll anchor element for pagination actions.                                                |
-| `initialItemsPerPage`           | `number`                           | Defines the original amount of items per page.                                                        |
-| `showQuery`                     | `boolean`                          | Defines if the filtering, sorting and pagination state should be added to the URL.                    |
-| `highlight`                     | `boolean \| undefined`             | Defines if the matched fields when filtering should be highlighted.                                   |
-| `cache`                         | `boolean`                          | Defines if loaded Items can be cached using IndexedDB after fetching them.                            |
-| `webflowModules`                | `Set<WebflowModule>`               | Defines the Webflow modules to restart after rendering.                                               |
-| `paginationSearchParam`         | `string \| undefined`              | Defines the URL query key for the paginated pages.                                                    |
-| `searchParamsPrefix`            | `string`                           | Defines the query prefix for all the list's query params.                                             |
-| `loadingSearchParamsData`       | `Promise<void> \| undefined`       | An awaitable Promise that resolves once the pagination data has been retrieved.                       |
-| `loadingPaginationElements`     | `Promise<void> \| undefined`       | An awaitable Promise that resolves once the pagination elements have been loaded.                     |
-| `loadingPaginatedItems`         | `Promise<void> \| undefined`       | An awaitable Promise that resolves once all the Webflow CMS paginated items have been loaded.         |
-| `readingFilters`                | `boolean \| undefined`             | Defines if the filter field values are being collected from the DOM or event listeners are being set. |
-| `settingFilters`                | `boolean \| undefined`             | Defines if the filter field values are being set to the DOM.                                          |
-### Methods
-#### `List.addHook(key, callback)`
-The `addHook` method allows you to add a custom hook to the list instance. The hook will be called when the specified phase is reached.
-It takes two arguments:
-- `key` (string): The key of the hook. This should be one of the lifecycle phases: `start`, `filter`, `sort`, `pagination`, `beforeRender`, `render`, or `afterRender`.
-- `callback` (function): The callback function that will be called when the hook is reached. The callback function receives as an argument the array of [items](#the-listitem-object) returned from the previous phase and accepts an array of items to be returned as well. If the callback function returns a promise, the list instance will wait for the promise to resolve before continuing with the lifecycle.
-```javascript
-// Ensure that only items for the current target are displayed
-listInstance.addHook('filter', (items) => {
-  const isAdult = localStorage.getItem('isAdult') === 'true';
-  const filteredItems = items.filter((item) => {
-    return isAdult ? item.fields.target.value === 'adults' : item.fields.target.value === 'kids';
-  });
-  return filteredItems;
-});
-```
-#### `List.triggerHook(key)`
-The `triggerHook` method allows you to trigger a specific lifecycle phase. This is useful if you want to manually trigger a phase without waiting for the user to interact with the list:
-```javascript
-const isAdultButton = document.querySelector('#isAdultButton');
-isAdultButton.addEventListener('click', () => {
-  localStorage.setItem('isAdult', 'true');
-  listInstance.triggerHook('filter');
-});
-```
-#### `List.createItem(element)`
-The `createItem` method creates a new [ListItem](#the-listitem-object) instance from a given DOM element. See [adding and removing items from the list](#adding-and-removing-items-from-the-list) for more details.
-#### `List.watch(source, callback, options)`
-The `watch` method from the [@vue/reactivity](https://vuejs.org/api/reactivity-core.html#watch).
-#### `List.effect(callback, options)`
-The `effect` method from the [@vue/reactivity](https://vuejs.org/api/reactivity-core.html#watcheffect).
-#### `List.destroy()`
-The `destroy` method destroys the list instance. This will remove all event listeners and reactivity tracking.
-## The `ListItem` object
-The `ListItem` class represents a single collection item within a list. It contains data about the item's fields, DOM elements, and provides methods for interacting with the item.
-### Properties
-| Property         | Type                         | Description                                                             |
-| ---------------- | ---------------------------- | ----------------------------------------------------------------------- |
-| `id`             | `string`                     | A unique ID for the item.                                               |
-| `element`        | `CollectionItemElement`      | The DOM element of the collection item.                                 |
-| `list`           | `List`                       | Reference to the parent List instance.                                  |
-| `currentIndex`   | `number \| undefined`        | The element's current index in the rendered DOM.                        |
-| `href`           | `string \| undefined`        | The URL of the item's `Template Page` if it exists.                     |
-| `fields`         | `ListItemFields`             | Contains the item's field data.                                         |
-| `nesting`        | `Promise<void> \| undefined` | An awaitable Promise that resolves when the item's nesting is complete. |
-| `startingClass`  | `string`                     | The class to apply before rendering the item.                           |
-| `highlightClass` | `string`                     | The class to apply when highlighting matched fields during filtering.   |
-| `stagger`        | `number \| undefined`        | Defines a stagger delay for the item's transitions.                     |
-### Field Types
-Fields that are defined using the `fs-list-field` attribute are stored in the `ListItem.fields` property. By default fields are typed as text, but they can be defined as numbers or dates using the `fs-list-fieldtype` attribute.
-```typescript
-type ListItemFields = {
-  [fieldKey: string]: ListItemField;
-};
-type ListItemField =
-  | {
-      type: 'text';
-      rawValue: string | string[];
-      value: string | string[];
-    }
-  | {
-      type: 'date';
-      rawValue: string | string[];
-      value: Date | Date[];
-    }
-  | {
-      type: 'number';
-      rawValue: string | string[];
-      value: number | number[];
-    };
-```
-### Methods
-#### `ListItem.collectFields()`
-The `collectFields` method scans the item's DOM element for field elements, extracts their values, and stores them in the `ListItem.fields` property.
-## The `Filters` object
-The `Filters` object contains the definition of the filters applied to the list.
-```typescript
-type Filters = {
-  groupsMatch?: FilterMatch; // The match type for the groups. Defaults to 'and'.
-  groups: FiltersGroup[];
-};
-type FilterMatch = 'and' | 'or';
-type FiltersGroup = {
-  id: string; // A unique identifier for the group.
-  conditionsMatch: FilterMatch; // The match type for the group conditions. Defaults to 'and'.
-  conditions: FiltersCondition[];
-};
-type FiltersCondition = {
-  id: string; // A unique identifier for the condition.
-  type: string; // The form field type.
-  fieldKey: string; // The field key of the condition.
-  value: string | string[]; // The value of the condition.
-  op?: FilterOperator; // The operator to use for the condition. Defaults to `contain`.
-  filterMatch?: FilterMatch; // The match type for the value, in case of multiple condition values. Defaults to `or`.
-  fieldMatch?: FilterMatch; // The match type for the field, in case of multiple field values. Defaults to `or`.
-  fuzzyThreshold?: number; // The threshold for fuzzy matching.
-  interacted?: boolean; // If the user has interacted with the form field.
-  customTagField?: string; // A custom field name to display in the tags.
-};
-type FilterOperator =
-  | 'start'
-  | 'empty'
-  | 'equal'
-  | 'not-equal'
-  | 'contain'
-  | 'not-contain'
-  | 'not-start'
-  | 'end'
-  | 'not-end'
-  | 'greater-equal'
-  | 'greater'
-  | 'less-equal'
-  | 'less'
-  | 'not-empty';
-```
-## The `Sorting` object
-The `Sorting` object contains the definition of the sorting applied to the list.
-```typescript
-type Sorting = {
-  fieldKey?: string;
-  direction?: 'asc' | 'desc';
-  interacted?: boolean;
-};
-```
-## License
-[Apache 2.0](../../LICENSE.md)

package/attributes-master/packages/list/package.json DELETED Viewed

@@ -1,37 +0,0 @@
-{
-  "name": "@finsweet/attributes-list",
-  "version": "1.5.0",
-  "description": "Supercharge your Webflow CMS and static lists.",
-  "private": true,
-  "type": "module",
-  "types": "src/index.ts",
-  "scripts": {
-    "lint": "eslint ./src && prettier --check ./src",
-    "lint:fix": "eslint ./src --fix && prettier --write ./src",
-    "check": "tsc --noEmit"
-  },
-  "exports": {
-    ".": {
-      "types": "./src/index.ts",
-      "import": "./src/index.ts"
-    },
-    "./selectors": {
-      "types": "./src/utils/selectors.ts",
-      "import": "./src/utils/selectors.ts"
-    },
-    "./dom": {
-      "types": "./src/utils/dom.ts",
-      "import": "./src/utils/dom.ts"
-    }
-  },
-  "dependencies": {
-    "@finsweet/attributes-utils": "workspace:*",
-    "@vue/reactivity": "^3.5.13",
-    "fuzzysort": "^3.1.0",
-    "just-debounce": "^1.1.0",
-    "just-throttle": "^4.2.0"
-  },
-  "devDependencies": {
-    "@types/dlv": "^1.1.5"
-  }
-}

package/attributes-master/packages/list/src/combine/index.ts DELETED Viewed

@@ -1,38 +0,0 @@
-import { extractCommaSeparatedValues } from '@finsweet/attributes-utils';
-import { effect } from '@vue/reactivity';
-import type { List } from '../components';
-import { listInstancesStore } from '../utils/store';
-/**
- * Initializes the list combine feature.
- * @param targetList The target list.
- * @param rawSourceInstances A comma-separated list of source instances.
- * @returns A cleanup function.
- */
-export const initListCombine = (targetList: List, rawSourceInstances: string) => {
-  const sourceInstances = extractCommaSeparatedValues(rawSourceInstances);
-  const sourceLists = [...listInstancesStore.values()].filter(
-    (list) => list !== targetList && list.instance && sourceInstances.includes(list.instance)
-  );
-  if (!sourceLists.length) return;
-  const cleanups = sourceLists.map((sourceList) => {
-    const runner = effect(() => {
-      if (!sourceList.items.value.length) return;
-      const elements = sourceList.items.value.map((item) => targetList.createItem(item.element));
-      sourceList.items.value = [];
-      targetList.items.value = [...targetList.items.value, ...elements];
-    });
-    return () => runner.effect.stop();
-  });
-  return () => {
-    cleanups.forEach((cleanup) => cleanup());
-  };
-};