@rancher/shell 3.0.8-rc.8 → 3.0.8-rc.9

package/rancher-components/RcIcon/types.ts

@@ -0,0 +1,160 @@
+import { Status } from '../utils/status';
+
+export const RcIconType = {
+  actions:                 'icon-actions',
+  ai:                      'icon-ai',
+  'alert-alt':             'icon-alert-alt',
+  alert:                   'icon-alert',
+  anchor:                  'icon-anchor',
+  apple:                   'icon-apple',
+  application:             'icon-application',
+  apps:                    'icon-apps',
+  archive:                 'icon-archive',
+  'backup-restore':        'icon-backup-restore',
+  backup:                  'icon-backup',
+  'brush-icon':            'icon-brush-icon',
+  'category-alt':          'icon-category-alt',
+  checkmark:               'icon-checkmark',
+  'chevron-beginning':     'icon-chevron-beginning',
+  'chevron-down':          'icon-chevron-down',
+  'chevron-end':           'icon-chevron-end',
+  'chevron-left':          'icon-chevron-left',
+  'chevron-right':         'icon-chevron-right',
+  'chevron-up':            'icon-chevron-up',
+  'circle-plus':           'icon-circle-plus',
+  cis:                     'icon-cis',
+  close:                   'icon-close',
+  'cluster-management':    'icon-cluster-management',
+  cluster:                 'icon-cluster',
+  code:                    'icon-code',
+  comment:                 'icon-comment',
+  commit:                  'icon-commit',
+  compass:                 'icon-compass',
+  'confirmation-alt':      'icon-confirmation-alt',
+  copy:                    'icon-copy',
+  dashboard:               'icon-dashboard',
+  dock:                    'icon-dock',
+  docker:                  'icon-docker',
+  document:                'icon-document',
+  'dot-half':              'icon-dot-half',
+  'dot-open':              'icon-dot-open',
+  dot:                     'icon-dot',
+  'downgrade-alt':         'icon-downgrade-alt',
+  download:                'icon-download',
+  edit:                    'icon-edit',
+  elemental:               'icon-elemental',
+  endpoints_connected:     'icon-endpoints_connected',
+  endpoints_disconnected:  'icon-endpoints_disconnected',
+  epinio:                  'icon-epinio',
+  error:                   'icon-error',
+  explore:                 'icon-explore',
+  extension:               'icon-extension',
+  'external-link':         'icon-external-link',
+  file:                    'icon-file',
+  filter_alt:              'icon-filter_alt',
+  flask:                   'icon-flask',
+  fleet:                   'icon-fleet',
+  folder:                  'icon-folder',
+  fork:                    'icon-fork',
+  gatekeeper:              'icon-gatekeeper',
+  gear:                    'icon-gear',
+  gemini:                  'icon-gemini',
+  git:                     'icon-git',
+  github:                  'icon-github',
+  gitlab:                  'icon-gitlab',
+  globe:                   'icon-globe',
+  groups:                  'icon-groups',
+  harvester:               'icon-harvester',
+  helm:                    'icon-helm',
+  hide:                    'icon-hide',
+  history:                 'icon-history',
+  home:                    'icon-home',
+  'info-circle':           'icon-info-circle',
+  info:                    'icon-info',
+  init_container:          'icon-init_container',
+  istio:                   'icon-istio',
+  keyboard:                'icon-keyboard',
+  keyboard_tab:            'icon-keyboard_tab',
+  linux:                   'icon-linux',
+  'list-flat':             'icon-list-flat',
+  'list-grouped':          'icon-list-grouped',
+  lock:                    'icon-lock',
+  logging:                 'icon-logging',
+  longhorn:                'icon-longhorn',
+  marketplace:             'icon-marketplace',
+  menu:                    'icon-menu',
+  minus:                   'icon-minus',
+  monitoring:              'icon-monitoring',
+  more:                    'icon-more',
+  namespace:               'icon-namespace',
+  notifier:                'icon-notifier',
+  'notify-announcement':   'icon-notify-announcement',
+  'notify-bell':           'icon-notify-bell',
+  'notify-busy':           'icon-notify-busy',
+  'notify-error':          'icon-notify-error',
+  'notify-info':           'icon-notify-info',
+  'notify-tick':           'icon-notify-tick',
+  'notify-warning':        'icon-notify-warning',
+  ollama:                  'icon-ollama',
+  openai:                  'icon-openai',
+  'os-management':         'icon-os-management',
+  pause:                   'icon-pause',
+  'pin-outlined':          'icon-pin-outlined',
+  pin:                     'icon-pin',
+  pipeline:                'icon-pipeline',
+  play:                    'icon-play',
+  plus:                    'icon-plus',
+  pod_security:            'icon-pod_security',
+  print:                   'icon-print',
+  'question-mark':         'icon-question-mark',
+  'quick-action':          'icon-quick-action',
+  'rancher-desktop':       'icon-rancher-desktop',
+  'rancher-observability': 'icon-rancher-observability',
+  'refresh-alt':           'icon-refresh-alt',
+  refresh:                 'icon-refresh',
+  'repository-alt':        'icon-repository-alt',
+  repository:              'icon-repository',
+  rio:                     'icon-rio',
+  'role-binding':          'icon-role-binding',
+  search:                  'icon-search',
+  send:                    'icon-send',
+  service:                 'icon-service',
+  show:                    'icon-show',
+  snapshot:                'icon-snapshot',
+  'sort-down':             'icon-sort-down',
+  'sort-up':               'icon-sort-up',
+  sort:                    'icon-sort',
+  sources:                 'icon-sources',
+  spinner:                 'icon-spinner',
+  stackstate:              'icon-stackstate',
+  'star-open':             'icon-star-open',
+  star:                    'icon-star',
+  storage:                 'icon-storage',
+  'tag-alt':               'icon-tag-alt',
+  terminal:                'icon-terminal',
+  'thinking-process':      'icon-thinking-process',
+  trash:                   'icon-trash',
+  unlock:                  'icon-unlock',
+  'upgrade-alt':           'icon-upgrade-alt',
+  upload:                  'icon-upload',
+  'user-check':            'icon-user-check',
+  'user-xmark':            'icon-user-xmark',
+  user:                    'icon-user',
+  'version-alt':           'icon-version-alt',
+  warning:                 'icon-warning',
+  windows:                 'icon-windows',
+};
+
+export const RcIconSize = {
+  large:  '25px',
+  medium: '18px',
+  small:  '14px',
+  none:   undefined
+};
+
+export interface RcIconProps {
+  size: keyof typeof RcIconSize;
+  type: keyof typeof RcIconType;
+  ariaHidden?: boolean;
+  status?: Status | 'inherit';
+}

package/rancher-components/utils/status.test.ts

@@ -0,0 +1,67 @@
+
+import { reactive } from 'vue';
+import { wrapIfVar, useStatusColors, Status } from './status';
+
+describe('utils: status', () => {
+  describe('wrapIfVar', () => {
+    it('should wrap a CSS variable', () => {
+      const result = wrapIfVar('--rc-info');
+
+      expect(result).toBe('var(--rc-info)');
+    });
+
+    it('should not wrap a normal color', () => {
+      const result = wrapIfVar('red');
+
+      expect(result).toBe('red');
+    });
+  });
+
+  describe('useStatusColors', () => {
+    it.each([
+      'info',
+      'success',
+      'warning',
+      'error',
+      'unknown',
+      'none'
+    ])('solid: should return the correct colors for status: %p', (status: Status) => {
+      const props = reactive({ status });
+      const {
+        borderColor,
+        backgroundColor,
+        textColor
+      } = useStatusColors(props, 'solid');
+
+      expect(borderColor.value).toBe(`var(--rc-${ status })`);
+      if (status !== 'none') {
+        // eslint-disable-next-line jest/no-conditional-expect
+        expect(backgroundColor.value).toBe(`var(--rc-${ status })`);
+      }
+      expect(textColor.value).toBe(`var(--rc-${ status }-secondary)`);
+    });
+
+    it.each([
+      'info',
+      'success',
+      'warning',
+      'error',
+      'unknown',
+      'none'
+    ])('outlined: should return the correct colors for status: %p', (status: Status) => {
+      const props = reactive({ status });
+      const {
+        borderColor,
+        backgroundColor,
+        textColor
+      } = useStatusColors(props, 'outlined');
+
+      expect(borderColor.value).toBe(`var(--rc-${ status }-secondary)`);
+      if (status !== 'none') {
+        // eslint-disable-next-line jest/no-conditional-expect
+        expect(backgroundColor.value).toBe(`var(--rc-${ status }-secondary)`);
+      }
+      expect(textColor.value).toBe(`var(--rc-${ status })`);
+    });
+  });
+});

package/rancher-components/utils/status.ts

@@ -0,0 +1,77 @@
+import { computed } from 'vue';
+
+export const StatusDefinitions = {
+  info: {
+    primary:   '--rc-info',
+    secondary: '--rc-info-secondary'
+  },
+  success: {
+    primary:   '--rc-success',
+    secondary: '--rc-success-secondary'
+  },
+  warning: {
+    primary:   '--rc-warning',
+    secondary: '--rc-warning-secondary'
+  },
+  error: {
+    primary:   '--rc-error',
+    secondary: '--rc-error-secondary'
+  },
+  unknown: {
+    primary:   '--rc-unknown',
+    secondary: '--rc-unknown-secondary'
+  },
+  none: {
+    primary:   '--rc-none',
+    secondary: '--rc-none-secondary'
+  },
+};
+
+export type Status = keyof typeof StatusDefinitions;
+export type StatusObject = { status: Status };
+export type Style = 'solid' | 'outlined';
+
+export function wrapIfVar(colorVar: string) {
+  return colorVar.startsWith('--') ? `var(${ colorVar })` : colorVar;
+}
+
+/**
+ * A composable to make it easier to use status colors in multiple components
+ *
+ * @param propsWithStatus The props which contain a `status: Status` property. Ideally I'd prefer to just pass status but doing so either forces the consumer to wrap the values in a Ref or this code is no longer reactive.
+ * @param style {@link Style} Will the block of code being using the solid or outlined styling
+ * @returns An object containing the relevant style colors
+ */
+export function useStatusColors(propsWithStatus: StatusObject, style: Style) {
+  const statusColors = computed(() => {
+    return StatusDefinitions[propsWithStatus.status];
+  });
+  const isOutlined = style === 'outlined';
+
+  const borderColor = computed(() => {
+    const colorVar = isOutlined ? statusColors.value.secondary : statusColors.value.primary;
+
+    return wrapIfVar(colorVar);
+  });
+
+  const backgroundColor = computed(() => {
+    if (propsWithStatus.status === 'none') {
+      return 'none';
+    }
+    const colorVar = isOutlined ? statusColors.value.secondary : statusColors.value.primary;
+
+    return wrapIfVar(colorVar);
+  });
+
+  const textColor = computed(() => {
+    const colorVar = isOutlined ? statusColors.value.primary : statusColors.value.secondary;
+
+    return wrapIfVar(colorVar);
+  });
+
+  return {
+    borderColor,
+    backgroundColor,
+    textColor
+  };
+}

package/scripts/typegen.sh

@@ -29,6 +29,7 @@ ${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/store/prefs.js --declaration --al
 ${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/store/plugins.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/store > /dev/null
 
 # # plugins
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/i18n.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/ > /dev/null
 ${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/normalize.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
 ${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/resource-class.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
 ${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/classify.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null

package/store/action-menu.js

@@ -111,6 +111,14 @@ export const mutations = {
     state.modalData = data;
   },
 
+  updateModalData(state, data) {
+    state.modalData = state.modalData || {};
+
+    data.forEach(({ key, value }) => {
+      state.modalData[key] = value;
+    });
+  },
+
   clearCallbackData(state) {
     state.performCallbackData = undefined;
   },

package/store/auth.js

@@ -404,18 +404,18 @@ export const actions = {
     // Unload plugins - we will load again on login
     await rootState.$plugin.logout();
 
-    let logoutAction = 'logout';
+    let logoutAction = '';
     const data = {};
 
     // SLO - Single-sign logout - will logout auth provider from all places where it's logged in
     if (options.slo) {
-      logoutAction = 'logoutAll';
+      logoutAction = '?logoutAll';
       data.finalRedirectUrl = returnTo({ isSlo: true }, this);
     }
 
     try {
       const res = await dispatch('rancher/request', {
-        url:                  `/v3/tokens?action=${ logoutAction }`,
+        url:                  `/v1/logout${ logoutAction }`,
         method:               'post',
         data,
         headers:              { 'Content-Type': 'application/json' },

package/store/catalog.js

@@ -504,11 +504,16 @@ function addChart(ctx, map, chart, repo) {
 
   if ( !obj ) {
     if ( ctx ) { }
+
+    const primeOnly = chart.annotations?.[CATALOG_ANNOTATIONS.PRIME_ONLY] === 'true';
     const experimental = !!chart.annotations?.[CATALOG_ANNOTATIONS.EXPERIMENTAL];
     const windowsIncompatible = !(chart.annotations?.[CATALOG_ANNOTATIONS.PERMITTED_OS] || '').includes('windows');
     const deploysOnWindows = (chart.annotations?.[CATALOG_ANNOTATIONS.DEPLOYED_OS] || '').includes('windows');
     const tags = [];
 
+    if (primeOnly) {
+      tags.push(ctx.rootGetters['i18n/withFallback']('generic.primeOnly'));
+    }
     if (experimental) {
       tags.push(ctx.rootGetters['i18n/withFallback']('generic.experimental'));
     }
@@ -542,6 +547,7 @@ function addChart(ctx, map, chart, repo) {
       keywords:         chart.keywords || [],
       categories:       filterCategories(chart.keywords),
       deprecated:       !!chart.deprecated,
+      primeOnly,
       experimental,
       hidden:           !!chart.annotations?.[CATALOG_ANNOTATIONS.HIDDEN],
       targetNamespace:  chart.annotations?.[CATALOG_ANNOTATIONS.NAMESPACE],

package/store/index.js

@@ -1251,10 +1251,10 @@ export const actions = {
     }
   },
 
-  nuxtClientInit({ dispatch, commit, rootState }, nuxt) {
-    commit('setRouter', nuxt.app.router);
-    commit('setRoute', nuxt.route);
-    commit('setPlugin', nuxt.app.$plugin);
+  dashboardClientInit({ dispatch, commit, rootState }, context) {
+    commit('setRouter', context.app.router);
+    commit('setRoute', context.route);
+    commit('setPlugin', context.app.$plugin);
 
     dispatch('management/rehydrateSubscribe');
     dispatch('cluster/rehydrateSubscribe');

package/store/prefs.js

@@ -523,15 +523,14 @@ export const actions = {
   setBrandStyle({ rootState, rootGetters }, dark = false) {
     if (rootState.managementReady) {
       try {
-        const brandSetting = rootGetters['management/byId'](MANAGEMENT.SETTING, SETTING.BRAND);
+        const brandSetting = rootGetters['management/brand'];
 
-        if (brandSetting && brandSetting.value && brandSetting.value !== '') {
-          const brand = brandSetting.value;
-          const brandMeta = getBrandMeta(brand);
+        if (brandSetting !== '') {
+          const brandMeta = getBrandMeta(brandSetting);
           const hasStylesheet = brandMeta.hasStylesheet === 'true';
 
           if (hasStylesheet) {
-            document.body.classList.add(brand);
+            document.body.classList.add(brandMeta);
           } else {
             // TODO option apply color at runtime
           }

package/store/wm.ts

@@ -80,11 +80,11 @@ export const mutations = {
   addTab(state: State, tab: Tab) {
     const existing = state.tabs.find((x) => x.id === tab.id);
 
-    if (!existing) {
-      if (tab.position === undefined) {
-        tab.position = (window.localStorage.getItem(STORAGE_KEY['pin']) || BOTTOM) as Position;
-      }
+    if (tab.position === undefined || tab.position as string === 'undefined') {
+      tab.position = (window.localStorage.getItem(STORAGE_KEY['pin']) || BOTTOM) as Position;
+    }
 
+    if (!existing) {
       if (state.lockedPositions.includes(BOTTOM)) {
         tab.position = BOTTOM;
       }

package/types/shell/index.d.ts

@@ -79,6 +79,7 @@ export namespace CATALOG {
     let _RANCHER: string;
     let _PARTNER: string;
     let _OTHER: string;
+    let PRIME_ONLY: string;
     let EXPERIMENTAL: string;
     let NAMESPACE: string;
     let RELEASE_NAME: string;
@@ -2206,6 +2207,12 @@ export namespace MANAGEMENT {
     export let CLUSTER_PROXY_CONFIG: string;
     export let OIDC_CLIENT: string;
 }
+export namespace BRAND {
+    let SUSE: string;
+    let CSP: string;
+    let FEDERAL: string;
+    let RGS: string;
+}
 export namespace EXT {
     let USER_ACTIVITY: string;
 }
@@ -2442,6 +2449,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: BooleanConstructor;
         default: any;
     };
+    defaultTab: {
+        type: StringConstructor;
+        default: any;
+    };
 }>, {}, {
     errors: any[];
 }, {
@@ -2499,6 +2510,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: BooleanConstructor;
         default: any;
     };
+    defaultTab: {
+        type: StringConstructor;
+        default: any;
+    };
 }>> & Readonly<{
     [x: `on${Capitalize<string>}`]: (...args: any[]) => any;
 }>, {
@@ -2509,6 +2524,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     liveValue: Record<string, any>;
     realMode: string;
     useTabbedHash: boolean;
+    defaultTab: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;
 }
@@ -3315,7 +3331,7 @@ export default class Resource {
         weight: number;
         divider?: undefined;
     })[];
-    showConfiguration(returnFocusSelector: any): void;
+    showConfiguration(returnFocusSelector: any, defaultTab: any): void;
     get _availableActions(): ({
         action: string;
         label: any;
@@ -3633,6 +3649,26 @@ export default class Resource {
 }
 }
 
+// @shell/plugins/i18n
+
+declare module '@shell/plugins/i18n' {
+/**
+ * @param {import('vuex').Store<any>} store
+ * @param {string} key
+ * @param {Record<string, any>} [args]
+ * @param {boolean} [raw]
+ * @param {boolean} [escapehtml]
+ * @returns {string}
+ */
+export function stringFor(store: import("vuex").Store<any>, key: string, args?: Record<string, any>, raw?: boolean, escapehtml?: boolean): string;
+export function directiveSsr(vnode: any, binding: any): void;
+export default i18n;
+declare namespace i18n {
+    let name: string;
+    function install(vueApp: any, _options: any): void;
+}
+}
+
 // @shell/plugins/steve/hybrid-class
 
 declare module '@shell/plugins/steve/hybrid-class' {
@@ -4083,7 +4119,7 @@ export function contrastColor(color: any, contrastOptions?: {
     dark: string;
     light: string;
 }): string;
-export function parseColor(str: any): any;
+export function parseColor(str: any): import("color").ColorInstance;
 export function textColor(color: any): "black" | "white";
 export function hexToRgb(hex: any): {
     r: number;

package/types/store/__tests__/pagination.types.spec.ts

@@ -0,0 +1,137 @@
+import { PaginationFilterEquality, PaginationFilterField } from '@shell/types/store/pagination.types';
+
+describe('pagination-types', () => {
+  describe('class: PaginationFilterField', () => {
+    describe('constructor', () => {
+      it('should set properties correctly with default values', () => {
+        const field = 'testField';
+        const value = 'testValue';
+        const filterField = new PaginationFilterField({ field, value });
+
+        expect(filterField.field).toBe(field);
+        expect(filterField.value).toBe(value);
+        expect(filterField.equals).toBe(true);
+        expect(filterField.exact).toBe(true);
+        expect(filterField.exists).toBe(false);
+        expect(filterField.equality).toBe(PaginationFilterEquality.EQUALS);
+      });
+
+      it('should handle deprecated `equals` and `exact` to set `equality`', () => {
+      // equals: true, exact: true
+        let ff = new PaginationFilterField({
+          field: 'f', value: 'v', equals: true, exact: true
+        });
+
+        expect(ff.equality).toBe(PaginationFilterEquality.EQUALS);
+
+        // equals: true, exact: false
+        ff = new PaginationFilterField({
+          field: 'f', value: 'v', equals: true, exact: false
+        });
+        expect(ff.equality).toBe(PaginationFilterEquality.CONTAINS);
+
+        // equals: false, exact: true
+        ff = new PaginationFilterField({
+          field: 'f', value: 'v', equals: false, exact: true
+        });
+        expect(ff.equality).toBe(PaginationFilterEquality.NOT_EQUALS);
+
+        // equals: false, exact: false
+        ff = new PaginationFilterField({
+          field: 'f', value: 'v', equals: false, exact: false
+        });
+        expect(ff.equality).toBe(PaginationFilterEquality.NOT_CONTAINS);
+      });
+
+      it('should prioritize `equality` over `equals` and `exact`', () => {
+        const filterField = new PaginationFilterField({
+          field:    'f',
+          value:    'v',
+          equals:   false,
+          exact:    false,
+          equality: PaginationFilterEquality.GREATER_THAN
+        });
+
+        expect(filterField.equality).toBe(PaginationFilterEquality.GREATER_THAN);
+      });
+
+      it('should throw an error if no equality can be determined', () => {
+        expect(() => new PaginationFilterField({
+          field:  'f',
+          value:  'v',
+          equals: null,
+          exact:  null
+        })).toThrow('A pagination filter must have either equals or equality set');
+      });
+
+      it('should set `exists` property', () => {
+        const filterField = new PaginationFilterField({ field: 'f', exists: true });
+
+        expect(filterField.exists).toBe(true);
+      });
+    });
+
+    describe('safeEquality', () => {
+      it('should return EQUALS for equals=true, exact=true', () => {
+        const equality = PaginationFilterField.safeEquality({ equals: true, exact: true });
+
+        expect(equality).toBe(PaginationFilterEquality.EQUALS);
+      });
+
+      it('should return CONTAINS for equals=true, exact=false', () => {
+        const equality = PaginationFilterField.safeEquality({ equals: true, exact: false });
+
+        expect(equality).toBe(PaginationFilterEquality.CONTAINS);
+      });
+
+      it('should return NOT_EQUALS for equals=false, exact=true', () => {
+        const equality = PaginationFilterField.safeEquality({ equals: false, exact: true });
+
+        expect(equality).toBe(PaginationFilterEquality.NOT_EQUALS);
+      });
+
+      it('should return NOT_CONTAINS for equals=false, exact=false', () => {
+        const equality = PaginationFilterField.safeEquality({ equals: false, exact: false });
+
+        expect(equality).toBe(PaginationFilterEquality.NOT_CONTAINS);
+      });
+
+      it('should return equality if it is provided', () => {
+        const equality = PaginationFilterField.safeEquality({ equality: PaginationFilterEquality.IN });
+
+        expect(equality).toBe(PaginationFilterEquality.IN);
+      });
+
+      it('should prioritize equality over equals/exact', () => {
+        const equality = PaginationFilterField.safeEquality({
+          equals:   true,
+          exact:    false,
+          equality: PaginationFilterEquality.LESS_THAN
+        });
+
+        expect(equality).toBe(PaginationFilterEquality.LESS_THAN);
+      });
+
+      it('should return undefined if no equality can be determined', () => {
+        const equality = PaginationFilterField.safeEquality({});
+
+        expect(equality).toBeUndefined();
+      });
+
+      it('should work with an instance of PaginationFilterField', () => {
+        const ff = new PaginationFilterField({
+          field:    'f',
+          value:    'v',
+          equals:   false,
+          exact:    false,
+          equality: PaginationFilterEquality.GREATER_THAN
+        });
+
+        // safeEquality will prioritize the `equality` property on the instance
+        const equality = PaginationFilterField.safeEquality(ff);
+
+        expect(equality).toBe(PaginationFilterEquality.GREATER_THAN);
+      });
+    });
+  });
+});