@leaflink/stash 50.14.0 → 50.15.0

package/dist/useToasts.d.ts

@@ -17,23 +17,47 @@ export declare type Toast = {
     status: StatusSeverity;
 };
 
-export declare type ToastOptions = {
+declare type ToastIdOrUndefined<O extends ToastOptions | undefined> = O extends {
+    id: string;
+} ? Toast['id'] | undefined : Toast['id'];
+
+export declare interface ToastOptions {
+    /**
+     * The timeout in milliseconds before the toast is automatically dismissed. If set to `false`, the toast will persist until the user clicks on it.
+     * @default DEFAULT_TIMEOUT
+     */
     timeout?: number | boolean;
-};
+    /**
+     * A group name ensures only one toast with the same group and status is visible at any given time.
+     * Toasts with the same group but different statuses will be treated as separate and will display concurrently.
+     */
+    group?: string;
+}
 
-declare function useToasts(globalOptions?: ToastOptions): {
+declare function useToasts(globalOptions?: Omit<ToastOptions, 'group'>): {
     active: readonly {
         readonly id: string;
         readonly text: string | RenderFunction;
         readonly status: "error" | "warning" | "info" | "success";
     }[];
-    remove: (toastId: Toast['id']) => void;
-    create: (text: Toast['text'], status: StatusSeverity, localOptions?: ToastOptions) => Toast['id'];
+    remove: {
+        (toastId: Toast['id']): void;
+        (options: {
+            group: string;
+            status: StatusSeverity;
+        }): void;
+    };
+    create: {
+        (text: Toast['text'], status: StatusSeverity, options?: Omit<ToastOptions, 'group'>): Toast['id'];
+        (text: Toast['text'], status: StatusSeverity, options: ToastOptions & {
+            id: string;
+        }): Toast['id'] | undefined;
+    };
     removeAll: () => void;
-    error: (text: Toast['text'], options?: ToastOptions) => string;
-    info: (text: Toast['text'], options?: ToastOptions) => string;
-    success: (text: Toast['text'], options?: ToastOptions) => string;
-    warning: (text: Toast['text'], options?: ToastOptions) => string;
+    error: <O extends ToastOptions>(text: Toast['text'], options?: O) => ToastIdOrUndefined<O>;
+    info: <O_1 extends ToastOptions>(text: Toast['text'], options?: O_1 | undefined) => ToastIdOrUndefined<O_1>;
+    success: <O_2 extends ToastOptions>(text: Toast['text'], options?: O_2 | undefined) => ToastIdOrUndefined<O_2>;
+    warning: <O_3 extends ToastOptions>(text: Toast['text'], options?: O_3 | undefined) => ToastIdOrUndefined<O_3>;
 };
 export default useToasts;
 

package/dist/useToasts.js

@@ -1,43 +1,48 @@
 import p from "lodash-es/merge";
 import T from "lodash-es/uniqueId";
-import { ref as d, reactive as g, readonly as b } from "vue";
-const h = 5e3, r = d([]);
-function E(c = { timeout: h }) {
-  function u(t) {
-    r.value = r.value.filter(({ id: e }) => e !== t);
+import { ref as h, reactive as y, readonly as b } from "vue";
+const w = 5e3, n = h([]);
+function M(a = { timeout: w }) {
+  function f(e) {
+    const t = typeof e == "string" ? e : void 0, { group: i = void 0, status: r = void 0 } = typeof e == "object" ? e : {};
+    if (!t && (!i || !r))
+      throw new Error("Must provide either a toast ID or both group and type");
+    const o = i && r ? `toast-${r}-${i}` : String(t), c = n.value.findIndex(({ id: l }) => l === o);
+    c !== -1 && n.value.splice(c, 1);
   }
-  function n(t, e, v) {
-    const i = p({}, c, v), o = T("toast-");
-    return r.value.push({ text: t, id: o, status: e }), typeof i.timeout == "number" && setTimeout(() => u(o), Math.abs(i.timeout)), o;
+  function u(e, t, i) {
+    const r = p({}, a, i), o = r != null && r.group ? `toast-${t}-${r.group}` : T("toast-");
+    if (!(r != null && r.group && n.value.some(({ id: c }) => c === o)))
+      return n.value.push({ text: e, id: o, status: t }), typeof r.timeout == "number" && setTimeout(() => f(o), Math.abs(r.timeout)), o;
   }
   function s() {
-    r.value = [];
+    n.value = [];
   }
-  function f(t, e) {
-    return n(t, "error", e);
+  function m(e, t) {
+    return u(e, "error", t);
   }
-  function a(t, e) {
-    return n(t, "info", e);
+  function v(e, t) {
+    return u(e, "info", t);
   }
-  function m(t, e) {
-    return n(t, "success", e);
+  function d(e, t) {
+    return u(e, "success", t);
   }
-  function l(t, e) {
-    return n(t, "warning", e);
+  function g(e, t) {
+    return u(e, "warning", t);
   }
-  return g({
+  return y({
     /**
      * The list of toasts that are currently visible.
      */
-    active: b(r),
+    active: b(n),
     /**
-     * Removes an active/visible toast.
+     * Removes an active/visible toast by id or by group and type.
      */
-    remove: u,
+    remove: f,
     /**
      * Creates a new toast and makes it active/visible.
      */
-    create: n,
+    create: u,
     /**
      * Removes all active/visible toasts.
      */
@@ -45,23 +50,23 @@ function E(c = { timeout: h }) {
     /**
      * Creates a new "error" toast.
      */
-    error: f,
+    error: m,
     /**
      * Creates a new "info" toast.
      */
-    info: a,
+    info: v,
     /**
      * Creates a new "success" toast.
      */
-    success: m,
+    success: d,
     /**
      * Creates a new "warning" toast.
      */
-    warning: l
+    warning: g
   });
 }
 export {
-  h as DEFAULT_TIMEOUT,
-  E as default
+  w as DEFAULT_TIMEOUT,
+  M as default
 };
 //# sourceMappingURL=useToasts.js.map

package/dist/useToasts.js.map

@@ -1 +1 @@
-{"version":3,"file":"useToasts.js","sources":["../src/composables/useToasts/useToasts.ts"],"sourcesContent":["import merge from 'lodash-es/merge';\nimport uniqueId from 'lodash-es/uniqueId';\nimport { reactive, readonly, ref, RenderFunction } from 'vue';\n\nimport { StatusSeverity } from '../../../types/statusLevels';\n\nexport const DEFAULT_TIMEOUT = 5000;\n\nexport type Toast = {\n  id: string;\n  text: string | RenderFunction;\n  status: StatusSeverity;\n};\n\nexport type ToastOptions = {\n  timeout?: number | boolean;\n};\n\nconst active = ref<Toast[]>([]);\n\nexport default function useToasts(globalOptions: ToastOptions = { timeout: DEFAULT_TIMEOUT }) {\n  function remove(toastId: Toast['id']) {\n    active.value = active.value.filter(({ id }) => id !== toastId);\n  }\n\n  function create(text: Toast['text'], status: StatusSeverity, localOptions?: ToastOptions): Toast['id'] {\n    const options = merge({}, globalOptions, localOptions);\n\n    const id = uniqueId('toast-');\n\n    active.value.push({ text, id, status });\n\n    if (typeof options.timeout === 'number') {\n      setTimeout(() => remove(id), Math.abs(options.timeout));\n    }\n\n    return id;\n  }\n\n  function removeAll() {\n    active.value = [];\n  }\n\n  function error(text: Toast['text'], options?: ToastOptions) {\n    return create(text, 'error', options);\n  }\n\n  function info(text: Toast['text'], options?: ToastOptions) {\n    return create(text, 'info', options);\n  }\n\n  function success(text: Toast['text'], options?: ToastOptions) {\n    return create(text, 'success', options);\n  }\n\n  function warning(text: Toast['text'], options?: ToastOptions) {\n    return create(text, 'warning', options);\n  }\n\n  return reactive({\n    /**\n     * The list of toasts that are currently visible.\n     */\n    active: readonly(active),\n\n    /**\n     * Removes an active/visible toast.\n     */\n    remove,\n\n    /**\n     * Creates a new toast and makes it active/visible.\n     */\n    create,\n\n    /**\n     * Removes all active/visible toasts.\n     */\n    removeAll,\n\n    /**\n     * Creates a new \"error\" toast.\n     */\n    error,\n\n    /**\n     * Creates a new \"info\" toast.\n     */\n    info,\n\n    /**\n     * Creates a new \"success\" toast.\n     */\n    success,\n\n    /**\n     * Creates a new \"warning\" toast.\n     */\n    warning,\n  });\n}\n"],"names":["DEFAULT_TIMEOUT","active","ref","useToasts","globalOptions","remove","toastId","id","create","text","status","localOptions","options","merge","uniqueId","removeAll","error","info","success","warning","reactive","readonly"],"mappings":";;;AAMO,MAAMA,IAAkB,KAYzBC,IAASC,EAAa,EAAE;AAE9B,SAAwBC,EAAUC,IAA8B,EAAE,SAASJ,KAAmB;AAC5F,WAASK,EAAOC,GAAsB;AAC7B,IAAAL,EAAA,QAAQA,EAAO,MAAM,OAAO,CAAC,EAAE,IAAAM,EAAA,MAASA,MAAOD,CAAO;AAAA,EAAA;AAGtD,WAAAE,EAAOC,GAAqBC,GAAwBC,GAA0C;AACrG,UAAMC,IAAUC,EAAM,IAAIT,GAAeO,CAAY,GAE/CJ,IAAKO,EAAS,QAAQ;AAE5B,WAAAb,EAAO,MAAM,KAAK,EAAE,MAAAQ,GAAM,IAAAF,GAAI,QAAAG,GAAQ,GAElC,OAAOE,EAAQ,WAAY,YAClB,WAAA,MAAMP,EAAOE,CAAE,GAAG,KAAK,IAAIK,EAAQ,OAAO,CAAC,GAGjDL;AAAA,EAAA;AAGT,WAASQ,IAAY;AACnB,IAAAd,EAAO,QAAQ,CAAC;AAAA,EAAA;AAGT,WAAAe,EAAMP,GAAqBG,GAAwB;AACnD,WAAAJ,EAAOC,GAAM,SAASG,CAAO;AAAA,EAAA;AAG7B,WAAAK,EAAKR,GAAqBG,GAAwB;AAClD,WAAAJ,EAAOC,GAAM,QAAQG,CAAO;AAAA,EAAA;AAG5B,WAAAM,EAAQT,GAAqBG,GAAwB;AACrD,WAAAJ,EAAOC,GAAM,WAAWG,CAAO;AAAA,EAAA;AAG/B,WAAAO,EAAQV,GAAqBG,GAAwB;AACrD,WAAAJ,EAAOC,GAAM,WAAWG,CAAO;AAAA,EAAA;AAGxC,SAAOQ,EAAS;AAAA;AAAA;AAAA;AAAA,IAId,QAAQC,EAASpB,CAAM;AAAA;AAAA;AAAA;AAAA,IAKvB,QAAAI;AAAA;AAAA;AAAA;AAAA,IAKA,QAAAG;AAAA;AAAA;AAAA;AAAA,IAKA,WAAAO;AAAA;AAAA;AAAA;AAAA,IAKA,OAAAC;AAAA;AAAA;AAAA;AAAA,IAKA,MAAAC;AAAA;AAAA;AAAA;AAAA,IAKA,SAAAC;AAAA;AAAA;AAAA;AAAA,IAKA,SAAAC;AAAA,EAAA,CACD;AACH;"}
+{"version":3,"file":"useToasts.js","sources":["../src/composables/useToasts/useToasts.ts"],"sourcesContent":["import merge from 'lodash-es/merge';\nimport uniqueId from 'lodash-es/uniqueId';\nimport { reactive, readonly, ref, RenderFunction } from 'vue';\n\nimport { StatusSeverity } from '../../../types/statusLevels';\n\nexport const DEFAULT_TIMEOUT = 5000;\n\nexport type Toast = {\n  id: string;\n  text: string | RenderFunction;\n  status: StatusSeverity;\n};\n\nexport interface ToastOptions {\n  /**\n   * The timeout in milliseconds before the toast is automatically dismissed. If set to `false`, the toast will persist until the user clicks on it.\n   * @default DEFAULT_TIMEOUT\n   */\n  timeout?: number | boolean;\n  /**\n   * A group name ensures only one toast with the same group and status is visible at any given time.\n   * Toasts with the same group but different statuses will be treated as separate and will display concurrently.\n   */\n  group?: string;\n}\n\ntype ToastIdOrUndefined<O extends ToastOptions | undefined> = O extends { id: string }\n  ? Toast['id'] | undefined\n  : Toast['id'];\n\nconst active = ref<Toast[]>([]);\n\nexport default function useToasts(globalOptions: Omit<ToastOptions, 'group'> = { timeout: DEFAULT_TIMEOUT }) {\n  // method overloads\n  function remove(toastId: Toast['id']): void;\n  function remove(options: { group: string; status: StatusSeverity }): void;\n  function remove(toastIdOrOptions: Toast['id'] | { group: string; status: StatusSeverity }) {\n    const toastId = typeof toastIdOrOptions === 'string' ? toastIdOrOptions : undefined;\n    const { group = undefined, status = undefined } = typeof toastIdOrOptions === 'object' ? toastIdOrOptions : {};\n\n    if (!toastId && (!group || !status)) {\n      throw new Error('Must provide either a toast ID or both group and type');\n    }\n\n    const idToRemove = group && status ? `toast-${status}-${group}` : String(toastId);\n    const index = active.value.findIndex(({ id }) => id === idToRemove);\n    if (index === -1) {\n      return;\n    }\n\n    active.value.splice(index, 1);\n  }\n\n  // method overloads\n  function create(text: Toast['text'], status: StatusSeverity, options?: Omit<ToastOptions, 'group'>): Toast['id'];\n  function create(\n    text: Toast['text'],\n    status: StatusSeverity,\n    options: ToastOptions & { id: string },\n  ): Toast['id'] | undefined;\n  function create(text: Toast['text'], status: StatusSeverity, localOptions?: ToastOptions): Toast['id'] | undefined {\n    const options = merge({}, globalOptions, localOptions);\n\n    const id = options?.group ? `toast-${status}-${options.group}` : uniqueId('toast-');\n    if (options?.group && active.value.some(({ id: existingId }) => existingId === id)) {\n      return;\n    }\n\n    active.value.push({ text, id, status });\n\n    if (typeof options.timeout === 'number') {\n      setTimeout(() => remove(id), Math.abs(options.timeout));\n    }\n\n    return id;\n  }\n\n  function removeAll() {\n    active.value = [];\n  }\n\n  function error<O extends ToastOptions>(text: Toast['text'], options?: O): ToastIdOrUndefined<O> {\n    return create(text, 'error', options);\n  }\n\n  function info<O extends ToastOptions>(text: Toast['text'], options?: O): ToastIdOrUndefined<O> {\n    return create(text, 'info', options);\n  }\n\n  function success<O extends ToastOptions>(text: Toast['text'], options?: O): ToastIdOrUndefined<O> {\n    return create(text, 'success', options);\n  }\n\n  function warning<O extends ToastOptions>(text: Toast['text'], options?: O): ToastIdOrUndefined<O> {\n    return create(text, 'warning', options);\n  }\n\n  return reactive({\n    /**\n     * The list of toasts that are currently visible.\n     */\n    active: readonly(active),\n\n    /**\n     * Removes an active/visible toast by id or by group and type.\n     */\n    remove,\n\n    /**\n     * Creates a new toast and makes it active/visible.\n     */\n    create,\n\n    /**\n     * Removes all active/visible toasts.\n     */\n    removeAll,\n\n    /**\n     * Creates a new \"error\" toast.\n     */\n    error,\n\n    /**\n     * Creates a new \"info\" toast.\n     */\n    info,\n\n    /**\n     * Creates a new \"success\" toast.\n     */\n    success,\n\n    /**\n     * Creates a new \"warning\" toast.\n     */\n    warning,\n  });\n}\n"],"names":["DEFAULT_TIMEOUT","active","ref","useToasts","globalOptions","remove","toastIdOrOptions","toastId","group","status","idToRemove","index","id","create","text","localOptions","options","merge","uniqueId","existingId","removeAll","error","info","success","warning","reactive","readonly"],"mappings":";;;AAMO,MAAMA,IAAkB,KAyBzBC,IAASC,EAAa,EAAE;AAE9B,SAAwBC,EAAUC,IAA6C,EAAE,SAASJ,KAAmB;AAI3G,WAASK,EAAOC,GAA2E;AACzF,UAAMC,IAAU,OAAOD,KAAqB,WAAWA,IAAmB,QACpE,EAAE,OAAAE,IAAQ,QAAW,QAAAC,IAAS,WAAc,OAAOH,KAAqB,WAAWA,IAAmB,CAAC;AAE7G,QAAI,CAACC,MAAY,CAACC,KAAS,CAACC;AACpB,YAAA,IAAI,MAAM,uDAAuD;AAGnE,UAAAC,IAAaF,KAASC,IAAS,SAASA,CAAM,IAAID,CAAK,KAAK,OAAOD,CAAO,GAC1EI,IAAQV,EAAO,MAAM,UAAU,CAAC,EAAE,IAAAW,EAAA,MAASA,MAAOF,CAAU;AAClE,IAAIC,MAAU,MAIPV,EAAA,MAAM,OAAOU,GAAO,CAAC;AAAA,EAAA;AAUrB,WAAAE,EAAOC,GAAqBL,GAAwBM,GAAsD;AACjH,UAAMC,IAAUC,EAAM,IAAIb,GAAeW,CAAY,GAE/CH,IAAKI,KAAA,QAAAA,EAAS,QAAQ,SAASP,CAAM,IAAIO,EAAQ,KAAK,KAAKE,EAAS,QAAQ;AAClF,QAAI,EAAAF,KAAA,QAAAA,EAAS,SAASf,EAAO,MAAM,KAAK,CAAC,EAAE,IAAIkB,EAAW,MAAMA,MAAeP,CAAE;AAIjF,aAAAX,EAAO,MAAM,KAAK,EAAE,MAAAa,GAAM,IAAAF,GAAI,QAAAH,GAAQ,GAElC,OAAOO,EAAQ,WAAY,YAClB,WAAA,MAAMX,EAAOO,CAAE,GAAG,KAAK,IAAII,EAAQ,OAAO,CAAC,GAGjDJ;AAAA,EAAA;AAGT,WAASQ,IAAY;AACnB,IAAAnB,EAAO,QAAQ,CAAC;AAAA,EAAA;AAGT,WAAAoB,EAA8BP,GAAqBE,GAAoC;AACvF,WAAAH,EAAOC,GAAM,SAASE,CAAO;AAAA,EAAA;AAG7B,WAAAM,EAA6BR,GAAqBE,GAAoC;AACtF,WAAAH,EAAOC,GAAM,QAAQE,CAAO;AAAA,EAAA;AAG5B,WAAAO,EAAgCT,GAAqBE,GAAoC;AACzF,WAAAH,EAAOC,GAAM,WAAWE,CAAO;AAAA,EAAA;AAG/B,WAAAQ,EAAgCV,GAAqBE,GAAoC;AACzF,WAAAH,EAAOC,GAAM,WAAWE,CAAO;AAAA,EAAA;AAGxC,SAAOS,EAAS;AAAA;AAAA;AAAA;AAAA,IAId,QAAQC,EAASzB,CAAM;AAAA;AAAA;AAAA;AAAA,IAKvB,QAAAI;AAAA;AAAA;AAAA;AAAA,IAKA,QAAAQ;AAAA;AAAA;AAAA;AAAA,IAKA,WAAAO;AAAA;AAAA;AAAA;AAAA,IAKA,OAAAC;AAAA;AAAA;AAAA;AAAA,IAKA,MAAAC;AAAA;AAAA;AAAA;AAAA,IAKA,SAAAC;AAAA;AAAA;AAAA;AAAA,IAKA,SAAAC;AAAA,EAAA,CACD;AACH;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflink/stash",
-  "version": "50.14.0",
+  "version": "50.15.0",
   "description": "LeafLink's design system.",
   "homepage": "https://stash.leaflink.com",
   "main": "./dist/index.ts",