Add behavior parameter to links

ember-link/src/-behavior.ts

@@ -0,0 +1,54 @@
+import type Link from './link';
+
+export const BEHAVIOR = Symbol('prevent');
+
+export interface Behavior {
+  /**
+   * @defaultValue 'transition'
+   */
+  open: 'transition' | 'replace';
+
+  /**
+   * Prevent a link from being invoked. The default implementation is doing
+   * two things:
+   *
+   * 1) allow links to open in new window/tab
+   * 2) prevent default browser behavior on `<a>` tags (to use ember's routing
+   *    system)
+   *
+   * @param event
+   * @param link
+   * @returns
+   */
+  prevent: (event: Event | unknown, link: Link) => boolean;
+}
+
+const MAIN_BUTTON = 0;
+
+function isUnmodifiedLeftClick(event: MouseEvent): boolean {
+  return event.button === MAIN_BUTTON && !event.ctrlKey && !event.metaKey;
+}
+
+function isMouseEvent(event: unknown): event is MouseEvent {
+  return typeof event === 'object' && event !== null && 'button' in event;
+}
+
+export function isRegularOpening(event: unknown) {
+  return isMouseEvent(event) && !isUnmodifiedLeftClick(event);
+}
+
+export function preventDefault(event?: Event | unknown) {
+  if (typeof (event as Event)?.preventDefault === 'function') {
+    (event as Event).preventDefault();
+  }
+}
+
+export function prevent(event: Event | unknown, _link: Link): boolean {
+  if (isRegularOpening(event)) {
+    return true;
+  }
+
+  preventDefault(event);
+
+  return false;
+}

ember-link/src/-models.ts

@@ -0,0 +1,5 @@
+import type RouterService from '@ember/routing/router-service';
+
+export type RouteModel = object | string | number;
+
+export type RouteArgs = Parameters<RouterService['urlFor']>;

ember-link/src/-params.ts

@@ -0,0 +1,69 @@
+import { DEBUG } from '@glimmer/env';
+
+import type { Behavior } from './-behavior';
+import type { RouteModel } from './-models';
+
+export type QueryParams = Record<string, unknown>;
+
+export interface LinkParams {
+  /**
+   * The target route name.
+   */
+  route: string;
+
+  /**
+   * Optional array of models / dynamic segments.
+   */
+  models?: RouteModel[];
+
+  /**
+   * Optional query params object.
+   */
+  query?: QueryParams;
+
+  behavior?: Partial<Behavior>;
+
+  /**
+   * An optional callback that will be fired when the Link is transitioned to.
+   *
+   * The callback is only fired if the Link is explicitly invoked, not if the
+   * app transitions to the Link through other means.
+   */
+  onTransitionTo?: () => void;
+
+  /**
+   * An optional callback that will be fired when the current route is replaced
+   * with the Link.
+   *
+   * The callback is only fired if the Link is explicitly invoked, not if the
+   * app transitions to the Link through other means.
+   */
+  onReplaceWith?: () => void;
+}
+
+type MaybeQueryParams =
+  | RouteModel
+  | { queryParams: object }
+  | {
+      isQueryParams: unknown;
+      values: QueryParams;
+    };
+
+export function isQueryParams(
+  maybeQueryParam?: MaybeQueryParams
+): maybeQueryParam is { values: QueryParams } {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  return maybeQueryParam?.isQueryParams !== undefined && typeof maybeQueryParam.values === 'object';
+}
+
+export function freezeParams(params: LinkParams) {
+  if (DEBUG) {
+    if (params.models) Object.freeze(params.models);
+    if (params.query) Object.freeze(params.query);
+
+    return Object.freeze(params);
+  }
+
+  return params;
+}

ember-link/src/helpers/link.ts

@@ -2,10 +2,12 @@ import Helper from '@ember/component/helper';
 import { assert } from '@ember/debug';
 import { inject as service } from '@ember/service';
 
-import { isQueryParams } from '../link';
+import { isQueryParams, type LinkParams } from '../-params';
 
+import type { RouteArgs, RouteModel } from '../-models';
+import type { QueryParams } from '../-params';
 import type Link from '../link';
-import type { LinkParams, QueryParams, RouteArgs, RouteModel, UILinkParams } from '../link';
+import type { UILinkParams } from '../link';
 import type LinkManagerService from '../services/link-manager';
 
 export type LinkHelperPositionalParams = [] | RouteArgs;
@@ -127,7 +129,8 @@ export default class LinkHelper extends Helper {
         : undefined,
       query: named.query ?? positionalQueryParameters,
       onTransitionTo: named.onTransitionTo,
-      onReplaceWith: named.onReplaceWith
+      onReplaceWith: named.onReplaceWith,
+      behavior: named.behavior
     };
   }
 

ember-link/src/index.ts

@@ -1,3 +1,6 @@
+export { prevent } from './-behavior';
+export type { LinkParams } from './-params';
 export { default as link } from './helpers/link';
-export type { LinkParams, UILinkParams } from './link';
+export type { UILinkParams } from './link';
 export { default as Link, UILink } from './link';
+export type { default as LinkManagerService } from './services/link-manager';