ember-primitives 0.33.0 → 0.34.0

package/declarations/qp.d.ts

@@ -1,19 +1,61 @@
 import Helper from '@ember/component/helper';
 import type RouterService from '@ember/routing/router-service';
-export interface Signature {
+interface Signature {
     Args: {
         Positional: [string];
     };
     Return: string | undefined;
 }
-declare class QP extends Helper<Signature> {
+/**
+ * Grabs a query-param off the current route from the router service.
+ *
+ * ```gjs
+ * import { qp } from 'ember-primitives/qp';
+ *
+ * <template>
+ *  {{qp "query-param"}}
+ * </template>
+ * ```
+ */
+export declare class qp extends Helper<Signature> {
     router: RouterService;
     compute([name]: [string]): string | undefined;
 }
-export declare const qp: typeof QP;
+/**
+ * Returns a string for use as an `href` on `<a>` tags, updated with the passed query param
+ *
+ * ```gjs
+ * import { withQP } from 'ember-primitives/qp';
+ *
+ * <template>
+ *   <a href={{withQP "foo" "2"}}>
+ *     ...
+ *   </a>
+ * </template>
+ * ```
+ */
+export declare class withQP extends Helper<{
+    Args: {
+        Positional: [string, string];
+    };
+    Return: string;
+}> {
+    router: RouterService;
+    compute([qpName, nextValue]: [string, string]): string;
+}
 /**
  * Cast a query-param string value to a boolean
  *
+ * ```gjs
+ * import { castToBoolean, qp } from 'ember-primitives/qp';
+ *
+ * <template>
+ *  {{#if (castToBoolean (qp 'the-qp'))}}
+ *    ...
+ *  {{/if}}
+ * </template>
+ * ```
+ *
  * The following values are considered "false"
  * - undefined
  * - ""

package/dist/qp.js

@@ -3,7 +3,18 @@ import { assert } from '@ember/debug';
 import { service } from '@ember/service';
 import { g, i } from 'decorator-transforms/runtime';
 
-class QP extends Helper {
+/**
+ * Grabs a query-param off the current route from the router service.
+ *
+ * ```gjs
+ * import { qp } from 'ember-primitives/qp';
+ *
+ * <template>
+ *  {{qp "query-param"}}
+ * </template>
+ * ```
+ */
+class qp extends Helper {
   static {
     g(this.prototype, "router", [service]);
   }
@@ -13,11 +24,48 @@ class QP extends Helper {
     return this.router.currentRoute?.queryParams?.[name];
   }
 }
-const qp = QP;
+
+/**
+ * Returns a string for use as an `href` on `<a>` tags, updated with the passed query param
+ *
+ * ```gjs
+ * import { withQP } from 'ember-primitives/qp';
+ *
+ * <template>
+ *   <a href={{withQP "foo" "2"}}>
+ *     ...
+ *   </a>
+ * </template>
+ * ```
+ */
+class withQP extends Helper {
+  static {
+    g(this.prototype, "router", [service]);
+  }
+  #router = (i(this, "router"), void 0);
+  compute([qpName, nextValue]) {
+    const existing = this.router.currentURL;
+    assert('A queryParam name is required', qpName);
+    assert('There is no currentURL', existing);
+    const url = new URL(existing, location.origin);
+    url.searchParams.set(qpName, nextValue);
+    return url.href;
+  }
+}
 
 /**
  * Cast a query-param string value to a boolean
  *
+ * ```gjs
+ * import { castToBoolean, qp } from 'ember-primitives/qp';
+ *
+ * <template>
+ *  {{#if (castToBoolean (qp 'the-qp'))}}
+ *    ...
+ *  {{/if}}
+ * </template>
+ * ```
+ *
  * The following values are considered "false"
  * - undefined
  * - ""
@@ -40,5 +88,5 @@ function castToBoolean(x) {
   return true;
 }
 
-export { castToBoolean, qp };
+export { castToBoolean, qp, withQP };
 //# sourceMappingURL=qp.js.map

package/dist/qp.js.map

@@ -1 +1 @@
-{"version":3,"file":"qp.js","sources":["../src/qp.ts"],"sourcesContent":["import Helper from '@ember/component/helper';\nimport { assert } from '@ember/debug';\nimport { service } from '@ember/service';\n\nimport type RouterService from '@ember/routing/router-service';\n\nexport interface Signature {\n  Args: {\n    Positional: [string];\n  };\n  Return: string | undefined;\n}\n\nclass QP extends Helper<Signature> {\n  @service declare router: RouterService;\n\n  compute([name]: [string]): string | undefined {\n    assert('A queryParam name is required', name);\n\n    return this.router.currentRoute?.queryParams?.[name] as string | undefined;\n  }\n}\n\nexport const qp = QP;\n\n/**\n * Cast a query-param string value to a boolean\n *\n * The following values are considered \"false\"\n * - undefined\n * - \"\"\n * - \"0\"\n * - false\n * - \"f\"\n * - \"off\"\n * - \"no\"\n * - \"null\"\n * - \"undefined\"\n *\n * All other values are considered truthy\n */\nexport function castToBoolean(x: string | undefined) {\n  if (!x) return false;\n\n  const isFalsey =\n    x === '0' ||\n    x === 'false' ||\n    x === 'f' ||\n    x === 'null' ||\n    x === 'off' ||\n    x === 'undefined' ||\n    x === 'no';\n\n  if (isFalsey) return false;\n\n  // All other values are considered truthy\n  return true;\n}\n"],"names":["QP","Helper","g","prototype","service","i","void 0","compute","name","assert","router","currentRoute","queryParams","qp","castToBoolean","x","isFalsey"],"mappings":";;;;;AAaA,MAAMA,EAAE,SAASC,MAAM,CAAY;AAAA,EAAA;IAAAC,CAAA,CAAA,IAAA,CAAAC,SAAA,EAAA,QAAA,EAAA,CAChCC,OAAO,CAAA,CAAA;AAAA;AAAA,EAAA,OAAA,IAAAC,CAAA,CAAA,IAAA,EAAA,QAAA,CAAA,EAAAC,MAAA;AAERC,EAAAA,OAAOA,CAAC,CAACC,IAAI,CAAW,EAAsB;AAC5CC,IAAAA,MAAM,CAAC,+BAA+B,EAAED,IAAI,CAAC;IAE7C,OAAO,IAAI,CAACE,MAAM,CAACC,YAAY,EAAEC,WAAW,GAAGJ,IAAI,CAAC;AACtD;AACF;AAEO,MAAMK,EAAE,GAAGb;;AAElB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASc,aAAaA,CAACC,CAAqB,EAAE;AACnD,EAAA,IAAI,CAACA,CAAC,EAAE,OAAO,KAAK;AAEpB,EAAA,MAAMC,QAAQ,GACZD,CAAC,KAAK,GAAG,IACTA,CAAC,KAAK,OAAO,IACbA,CAAC,KAAK,GAAG,IACTA,CAAC,KAAK,MAAM,IACZA,CAAC,KAAK,KAAK,IACXA,CAAC,KAAK,WAAW,IACjBA,CAAC,KAAK,IAAI;EAEZ,IAAIC,QAAQ,EAAE,OAAO,KAAK;;AAE1B;AACA,EAAA,OAAO,IAAI;AACb;;;;"}
+{"version":3,"file":"qp.js","sources":["../src/qp.ts"],"sourcesContent":["import Helper from '@ember/component/helper';\nimport { assert } from '@ember/debug';\nimport { service } from '@ember/service';\n\nimport type RouterService from '@ember/routing/router-service';\n\ninterface Signature {\n  Args: {\n    Positional: [string];\n  };\n  Return: string | undefined;\n}\n\n/**\n * Grabs a query-param off the current route from the router service.\n *\n * ```gjs\n * import { qp } from 'ember-primitives/qp';\n *\n * <template>\n *  {{qp \"query-param\"}}\n * </template>\n * ```\n */\nexport class qp extends Helper<Signature> {\n  @service declare router: RouterService;\n\n  compute([name]: [string]): string | undefined {\n    assert('A queryParam name is required', name);\n\n    return this.router.currentRoute?.queryParams?.[name] as string | undefined;\n  }\n}\n\n/**\n * Returns a string for use as an `href` on `<a>` tags, updated with the passed query param\n *\n * ```gjs\n * import { withQP } from 'ember-primitives/qp';\n *\n * <template>\n *   <a href={{withQP \"foo\" \"2\"}}>\n *     ...\n *   </a>\n * </template>\n * ```\n */\nexport class withQP extends Helper<{ Args: { Positional: [string, string] }; Return: string }> {\n  @service declare router: RouterService;\n\n  compute([qpName, nextValue]: [string, string]) {\n    const existing = this.router.currentURL;\n\n    assert('A queryParam name is required', qpName);\n    assert('There is no currentURL', existing);\n\n    const url = new URL(existing, location.origin);\n\n    url.searchParams.set(qpName, nextValue);\n\n    return url.href;\n  }\n}\n\n/**\n * Cast a query-param string value to a boolean\n *\n * ```gjs\n * import { castToBoolean, qp } from 'ember-primitives/qp';\n *\n * <template>\n *  {{#if (castToBoolean (qp 'the-qp'))}}\n *    ...\n *  {{/if}}\n * </template>\n * ```\n *\n * The following values are considered \"false\"\n * - undefined\n * - \"\"\n * - \"0\"\n * - false\n * - \"f\"\n * - \"off\"\n * - \"no\"\n * - \"null\"\n * - \"undefined\"\n *\n * All other values are considered truthy\n */\nexport function castToBoolean(x: string | undefined) {\n  if (!x) return false;\n\n  const isFalsey =\n    x === '0' ||\n    x === 'false' ||\n    x === 'f' ||\n    x === 'null' ||\n    x === 'off' ||\n    x === 'undefined' ||\n    x === 'no';\n\n  if (isFalsey) return false;\n\n  // All other values are considered truthy\n  return true;\n}\n"],"names":["qp","Helper","g","prototype","service","i","void 0","compute","name","assert","router","currentRoute","queryParams","withQP","qpName","nextValue","existing","currentURL","url","URL","location","origin","searchParams","set","href","castToBoolean","x","isFalsey"],"mappings":";;;;;AAaA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,EAAE,SAASC,MAAM,CAAY;AAAA,EAAA;IAAAC,CAAA,CAAA,IAAA,CAAAC,SAAA,EAAA,QAAA,EAAA,CACvCC,OAAO,CAAA,CAAA;AAAA;AAAA,EAAA,OAAA,IAAAC,CAAA,CAAA,IAAA,EAAA,QAAA,CAAA,EAAAC,MAAA;AAERC,EAAAA,OAAOA,CAAC,CAACC,IAAI,CAAW,EAAsB;AAC5CC,IAAAA,MAAM,CAAC,+BAA+B,EAAED,IAAI,CAAC;IAE7C,OAAO,IAAI,CAACE,MAAM,CAACC,YAAY,EAAEC,WAAW,GAAGJ,IAAI,CAAC;AACtD;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMK,MAAM,SAASZ,MAAM,CAA6D;AAAA,EAAA;IAAAC,CAAA,CAAA,IAAA,CAAAC,SAAA,EAAA,QAAA,EAAA,CAC5FC,OAAO,CAAA,CAAA;AAAA;AAAA,EAAA,OAAA,IAAAC,CAAA,CAAA,IAAA,EAAA,QAAA,CAAA,EAAAC,MAAA;AAERC,EAAAA,OAAOA,CAAC,CAACO,MAAM,EAAEC,SAAS,CAAmB,EAAE;AAC7C,IAAA,MAAMC,QAAQ,GAAG,IAAI,CAACN,MAAM,CAACO,UAAU;AAEvCR,IAAAA,MAAM,CAAC,+BAA+B,EAAEK,MAAM,CAAC;AAC/CL,IAAAA,MAAM,CAAC,wBAAwB,EAAEO,QAAQ,CAAC;IAE1C,MAAME,GAAG,GAAG,IAAIC,GAAG,CAACH,QAAQ,EAAEI,QAAQ,CAACC,MAAM,CAAC;IAE9CH,GAAG,CAACI,YAAY,CAACC,GAAG,CAACT,MAAM,EAAEC,SAAS,CAAC;IAEvC,OAAOG,GAAG,CAACM,IAAI;AACjB;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,aAAaA,CAACC,CAAqB,EAAE;AACnD,EAAA,IAAI,CAACA,CAAC,EAAE,OAAO,KAAK;AAEpB,EAAA,MAAMC,QAAQ,GACZD,CAAC,KAAK,GAAG,IACTA,CAAC,KAAK,OAAO,IACbA,CAAC,KAAK,GAAG,IACTA,CAAC,KAAK,MAAM,IACZA,CAAC,KAAK,KAAK,IACXA,CAAC,KAAK,WAAW,IACjBA,CAAC,KAAK,IAAI;EAEZ,IAAIC,QAAQ,EAAE,OAAO,KAAK;;AAE1B;AACA,EAAA,OAAO,IAAI;AACb;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-primitives",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Making apps easier to build",
   "sideEffects": [
     "*.css"