@ulu/frontend-vue 0.1.0-beta.9 → 0.1.1-beta.1

package/types/composables/useDocumentTitle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDocumentTitle.d.ts","sourceRoot":"","sources":["../../lib/composables/useDocumentTitle.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;GAcG;AACH,2CALG;IAAqD,KAAK,GAAlD,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM;IACjB,aAAa,GAA9B,MAAM;IACa,QAAQ;IACR,OAAO;CACpC,QAsCA"}

package/types/composables/usePageTitle.d.ts

@@ -0,0 +1,19 @@
+/**
+ * A composable to set the title for the current page/route from within its component.
+ * This provides a single source of truth for a page's title, which can be
+ * consumed by various parts of the application (e.g., breadcrumbs, document title).
+ * @param {import('vue').Ref<string> | string} title The title to set for the current page. Can be a ref, computed, or a plain string.
+ * @param {{ useRoute: Function }} options For dependency injection in tests/stories.
+ */
+export function usePageTitle(title: import("vue").Ref<string> | string, { useRoute }?: {
+    useRoute: Function;
+}): void;
+/**
+ * Gets the dynamically set page title for a given path.
+ * For internal use by consumers like breadcrumb or document title utilities.
+ * @param {string} path The route path to look up.
+ * @returns {string | undefined}
+ */
+export function getPageTitle(path: string): string | undefined;
+export const pageTitles: {};
+//# sourceMappingURL=usePageTitle.d.ts.map

package/types/composables/usePageTitle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePageTitle.d.ts","sourceRoot":"","sources":["../../lib/composables/usePageTitle.js"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,oCAHW,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,iBAClC;IAAE,QAAQ,WAAU;CAAE,QAchC;AAED;;;;;GAKG;AACH,mCAHW,MAAM,GACJ,MAAM,GAAG,SAAS,CAI9B;AA/BD,4BAAuC"}

package/types/composables/usePagination.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A Vue composable for handling pagination logic.
+ * It interacts with vue-router to keep the current page in the URL query string.
+ *
+ * @param {import('vue').Ref<Array<any>>} items - A ref containing the full list of items to be paginated.
+ * @param {number} itemsPerPage - The number of items to display per page.
+ * @returns {{
+ *   currentPage: import('vue').ComputedRef<number>,
+ *   totalPages: import('vue').ComputedRef<number>,
+ *   paginatedItems: import('vue').ComputedRef<Array<any>>,
+ *   pagerItems: import('vue').ComputedRef<object|null>,
+ *   pagerEllipses: import('vue').ComputedRef<{previous: boolean, next: boolean}>
+ * }} - An object containing reactive properties for pagination.
+ */
+export function usePagination(items: import("vue").Ref<Array<any>>, itemsPerPage: number): {
+    currentPage: import("vue").ComputedRef<number>;
+    totalPages: import("vue").ComputedRef<number>;
+    paginatedItems: import("vue").ComputedRef<Array<any>>;
+    pagerItems: import("vue").ComputedRef<object | null>;
+    pagerEllipses: import("vue").ComputedRef<{
+        previous: boolean;
+        next: boolean;
+    }>;
+};
+//# sourceMappingURL=usePagination.d.ts.map

package/types/composables/usePagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePagination.d.ts","sourceRoot":"","sources":["../../lib/composables/usePagination.js"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;GAaG;AACH,qCAVW,OAAO,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,gBAC7B,MAAM,GACJ;IACR,WAAW,EAAE,OAAO,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC/C,UAAU,EAAE,OAAO,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9C,cAAc,EAAE,OAAO,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACtD,UAAU,EAAE,OAAO,KAAK,EAAE,WAAW,CAAC,MAAM,GAAC,IAAI,CAAC,CAAC;IACnD,aAAa,EAAE,OAAO,KAAK,EAAE,WAAW,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAC,CAAC,CAAA;CAC7E,CA0GH"}

package/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./plugins/index.js";
 export * from "./components/index.js";
 export * from "./composables/index.js";
+export * as utils from "./utils/index.js";
 //# sourceMappingURL=index.d.ts.map

package/types/plugins/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/core/index.js"],"names":[],"mappings":"AA6BA,mEAyDC;AA3DD,gCAA0D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/core/index.js"],"names":[],"mappings":"AAkCA,mEAyDC;AA3DD,gCAA0D"}

package/types/utils/dom.d.ts

@@ -5,4 +5,5 @@
  * @returns {HTMLElement} The HTMLElement or undefined if not found/resolved.
  */
 export function refToElement(value: HTMLElement | any): HTMLElement;
+export function newId(prefix?: string): any;
 //# sourceMappingURL=dom.d.ts.map

package/types/utils/dom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../lib/utils/dom.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oCAHW,WAAW,MAAO,GAChB,WAAW,CASvB"}
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../lib/utils/dom.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oCAHW,WAAW,MAAO,GAChB,WAAW,CASvB;AAKD,4CAOC"}

package/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * as dom from "./dom.js";
+export * as router from "./router.js";
+//# sourceMappingURL=index.d.ts.map

package/types/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/utils/index.js"],"names":[],"mappings":""}

package/types/utils/router.d.ts

@@ -0,0 +1,144 @@
+/**
+ * This Module Creates Menus from route or router config
+ * - Note: Functions prefixed with "$" work with $route objects (running application, provided by vue-router ie $router, useRoute, etc),
+ * @module router-utils
+ */
+/**
+ * Resolves a route's title from its meta.
+ * - If `meta.title` is a function, it's called with the `currentRoute` (or the route itself).
+ * - Otherwise, `meta.title` is returned.
+ * This function is the single source of truth for resolving titles from route configuration.
+ * @param {object} route The route or route match object.
+ * @param {object} [currentRoute] The current route from `useRoute()`, passed to functional titles.
+ * @returns {string|undefined} The resolved title, or undefined if not found.
+ */
+export function getRouteTitle(route: object, currentRoute?: object): string | undefined;
+/**
+ * Route Menu Item
+ * @typedef {Object} RouteMenuItem
+ * @property {String} path - Menu item route path
+ * @property {String} title - Menu item title
+ */
+/**
+ * Get root/base static routes as menu items
+ * @param {*} routes Routes to build menu from (not router instance)
+ * @param {Object} options Options
+ * @param {Object} options.qualifier Callback to qualify as a base route (defaults to isStaticBaseRoute)
+ * @param {Object} options.item Options for createMenuItem
+ * @returns {Array.<RouteMenuItem>} Array of menu items
+ */
+export function createBaseMenu(routes: any, options: {
+    qualifier: any;
+    item: any;
+}): Array<RouteMenuItem>;
+/**
+ * Returns menu flat (no parent children)
+ */
+export function flattenMenu(menu: any): any;
+/**
+ * Print out a section's menu based on path
+ * @param {*} routes All routes
+ * @param {*} sectionPath Path for section to create menu
+ * @param {Object} options Options
+ * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie ({ path: "" })
+ * @param {Object} options.item Options to be passed to createMenuItem
+ * @returns {Array.<RouteMenuItem>} Array of menu items
+ */
+export function createSectionMenu(routes: any, sectionPath: any, options: {
+    includeIndex: boolean;
+    item: any;
+}): Array<RouteMenuItem>;
+/**
+ * For a given array of child routes return the index
+ * @param {Array} children Children array of routes
+ * @returns {Object} Route
+ */
+export function getChildIndexRoute(children: any[]): any;
+/**
+ * Creates common menu item structure from route, pulls title and weight from meta (on route or index child)
+ * @param {Object} route Route
+ * @param {Object} routePath The final path for the menu item
+ * @param {Object} options Function to allow alterering the menu item (adding meta, etc)
+ * @param {Function} options.modify Function to allow alterering the menu item (adding meta, etc) (args: item, route)
+ * @param {Function} options.indexMeta Include the routes index child's meta (merged on top of route meta)
+ * @returns {RouteMenuItem} Menu item
+ */
+export function createMenuItem(route: any, routePath: any, options: {
+    modify: Function;
+    indexMeta: Function;
+}): RouteMenuItem;
+/**
+ * Test if route is static (doesn't include parameters)
+ * @param {Object} route Route object to test
+ * @returns {Boolean} Whether or not this route is static (not dynamic)
+ */
+export function isStaticRoute(route: any): boolean;
+/**
+ *
+ * @param {Object} route Route object to test
+ * @returns {Boolean} Whether or not this route is a static base route
+ */
+export function isStaticBaseRoute(route: any): boolean;
+/**
+ * Function to make normal <a> behave as router links instread of page reload
+ * @param {Object} router Router instance (ie src/router) to push routes to
+ * @param {Object} event The event object that triggered route change (ie. onclick) pass event object
+ */
+export function nativeLinkRouter(router: any, event: any): void;
+/**
+ * Returns the child routes for base route
+ * @param {Object} route Route Object
+ * @returns
+ */
+export function $getRouteChildren(route: any, parent?: any): any;
+/**
+ * Returns the route's parent
+ * @param {Object} route Route Object
+ * @param {Object} deepest By default this returns the routes parent, if deepest it will return it's base route (top level parent)
+ * @return {Object|Null} Parent route, if there is no parent route for the given route this will return null
+ */
+export function $getParentRoute(route: any, deepest: any): any | null;
+/**
+ * For a given $route will return all it's children as menu items,
+ * using the route's meta.title property for the title. This is for sections only (routes with children)
+ * - Useful for dynamic menus (menus within some unknown section) where you don't want to write static paths
+ * @param {Object} route Actual $route object
+ * @param {Object} options Options
+ * @param {Object} options.parent Route parent object, defaults to parent of route
+ * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie ({ path: "" })
+ * @param {Object} options.item Options for createMenuItem
+ * @returns {Array.<RouteMenuItem>} Array of menu items
+ */
+export function $createSectionMenu(route: any, options: {
+    parent: any;
+    includeIndex: boolean;
+    item: any;
+}): Array<RouteMenuItem>;
+/**
+ * For a given $route, this will generate a breadcrumb trail.
+ * It iterates through `route.matched` to build the trail.
+ * - Falls back to `meta.title` (string or function).
+ * - Skips routes where `meta.breadcrumb` is set to `false`.
+ * - Avoids duplicate crumbs for nested routes with empty paths.
+ * @param {Object} route The Vue Router `$route` object.
+ * @returns {Array.<{title: String, to: Object, current: Boolean}>} An array of breadcrumb items.
+ */
+export function $createBreadcrumb(route: any): Array<{
+    title: string;
+    to: any;
+    current: boolean;
+}>;
+/**
+ * Route Menu Item
+ */
+export type RouteMenuItem = {
+    /**
+     * - Menu item route path
+     */
+    path: string;
+    /**
+     * - Menu item title
+     */
+    title: string;
+};
+//# sourceMappingURL=router.d.ts.map

package/types/utils/router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../lib/utils/router.js"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;GAQG;AACH,qCAJW,MAAM,iBACN,MAAM,GACJ,MAAM,GAAC,SAAS,CAW5B;AAED;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,uCANW,GAAC,WAET;IAAwB,SAAS;IACT,IAAI;CAC5B,GAAU,KAAK,CAAE,aAAa,CAAC,CAgCjC;AAED;;GAEG;AACH,4CAcC;AAED;;;;;;;;GAQG;AACH,0CAPW,GAAC,eACD,GAAC,WAET;IAAyB,YAAY;IACb,IAAI;CAC5B,GAAU,KAAK,CAAE,aAAa,CAAC,CA4BjC;AAED;;;;GAIG;AACH,yDAEC;AAED;;;;;;;;GAQG;AACH,oEAJG;IAA0B,MAAM;IACN,SAAS;CACnC,GAAU,aAAa,CAuBzB;AAED;;;;GAIG;AACH,mDAEC;AAED;;;;GAIG;AACH,uDAGC;AAED;;;;GAIG;AACH,gEAUC;AAED;;;;GAIG;AACH,iEAEC;AAED;;;;;GAKG;AACH,2DAFY,UAAW,CAUtB;AAUD;;;;;;;;;;GAUG;AACH,wDALG;IAAwB,MAAM;IACL,YAAY;IACb,IAAI;CAC5B,GAAU,KAAK,CAAE,aAAa,CAAC,CAgBjC;AAED;;;;;;;;GAQG;AACH,+CAFa,KAAK,CAAE;IAAC,KAAK,SAAS;IAAC,EAAE,MAAS;IAAC,OAAO,UAAS;CAAC,CAAC,CA6BjE"}