@creopse/vue 0.0.8 → 0.0.10

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@creopse/vue",
   "description": "Creopse Vue Toolkit",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "private": false,
   "author": "Noé Gnanih <noegnanih@gmail.com>",
   "license": "MIT",
@@ -28,7 +28,7 @@
     "dev-types": "vue-tsc  --noEmit -p tsconfig.app.json --watch",
     "build": "pnpm build-lib && pnpm build-types",
     "build-lib": "vite build",
-    "build-types": "rm -f *.tsbuildinfo && vue-tsc --emitDeclarationOnly --declaration -p tsconfig.app.json",
+    "build-types": "rm -f *.tsbuildinfo && rm -rf types && vue-tsc --emitDeclarationOnly --declaration -p tsconfig.app.json",
     "lint": "eslint 'src/**/*.{ts,vue}'"
   },
   "peerDependencies": {
@@ -64,4 +64,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/types/components/widgets/MountedTeleport.vue.d.ts

@@ -0,0 +1,15 @@
+interface Props {
+    to: string;
+}
+declare var __VLS_5: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_5) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/components/widgets/ReadMore.vue.d.ts

@@ -0,0 +1,14 @@
+interface Props {
+    moreStr?: string;
+    lessStr?: string;
+    text: string;
+    link?: string;
+    maxChars?: number;
+}
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    link: string;
+    moreStr: string;
+    lessStr: string;
+    maxChars: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/types/components/widgets/StickyBottom.vue.d.ts

@@ -0,0 +1,21 @@
+interface Props {
+    bottom?: number;
+    zIndex?: number;
+    className?: string;
+}
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    bottom: number;
+    zIndex: number;
+    className: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/components/widgets/StickyTop.vue.d.ts

@@ -0,0 +1,21 @@
+interface Props {
+    top?: number;
+    zIndex?: number;
+    className?: string;
+}
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    zIndex: number;
+    className: string;
+    top: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/index.d.ts

@@ -1,9 +1,12 @@
 import type { App } from 'vue';
 import AsyncImg from './components/widgets/AsyncImg.vue';
 import CustomTransition from './components/widgets/CustomTransition.vue';
-import SvgComponent from './components/widgets/SvgComponent.vue';
+import MountedTeleport from './components/widgets/MountedTeleport.vue';
+import ReadMore from './components/widgets/ReadMore.vue';
+import StickyBottom from './components/widgets/StickyBottom.vue';
+import StickyTop from './components/widgets/StickyTop.vue';
 declare const plugin: {
     install(app: App): void;
 };
-export { CustomTransition, SvgComponent, AsyncImg };
+export { CustomTransition, MountedTeleport, StickyBottom, StickyTop, ReadMore, AsyncImg, };
 export default plugin;

package/types/components/widgets/Image.vue.d.ts

@@ -1,23 +0,0 @@
-import type { CSSProperties } from 'vue';
-interface Props {
-    src: string;
-    alt?: string;
-    width?: string | number;
-    height?: string | number;
-    title?: string;
-    loading?: 'lazy' | 'eager';
-    style?: CSSProperties;
-    size?: 'small' | 'medium' | 'large' | 'original';
-    sync?: boolean;
-}
-declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
-    alt: string;
-    width: string | number;
-    height: string | number;
-    title: string;
-    loading: "lazy" | "eager";
-    style: CSSProperties;
-    size: "small" | "medium" | "large" | "original";
-    sync: boolean;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-export default _default;

package/types/components/widgets/SvgComponent.vue.d.ts

@@ -1,5 +0,0 @@
-interface Props {
-    path: string;
-}
-declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-export default _default;

package/types/composables/api.d.ts

@@ -1,57 +0,0 @@
-type Method = 'get' | 'post' | 'put' | 'delete';
-interface Payload {
-    method?: Method;
-    routeBase?: string;
-    params?: object;
-    data?: object;
-    url?: string;
-    id?: string;
-}
-/**
- * This composable is used to make API requests.
- *
- * @function useApi
- * @returns {Object} An object containing the following methods:
- *  - `request`: Makes an API request with the given payload.
- *  - `addItem`: Adds an item to the API.
- *  - `deleteItem`: Deletes an item from the API.
- *  - `updateItem`: Updates an item in the API.
- *  - `getAllItems`: Gets all items from the API.
- *  - `getItem`: Gets an item from the API.
- *  - `handleError`: Handles an error from the API.
- */
-export declare const useApi: () => {
-    request: (payload: Payload) => Promise<any>;
-    getItem: (payload: Payload) => Promise<{
-        success: boolean;
-        failure: boolean;
-        result: any;
-        error: any;
-    }>;
-    addItem: (payload: Payload) => Promise<{
-        success: boolean;
-        failure: boolean;
-        result: any;
-        error: any;
-    }>;
-    updateItem: (payload: Payload) => Promise<{
-        success: boolean;
-        failure: boolean;
-        result: any;
-        error: any;
-    }>;
-    deleteItem: (payload: Payload) => Promise<{
-        success: boolean;
-        failure: boolean;
-        result: any;
-        error: any;
-    }>;
-    getAllItems: (payload: Payload) => Promise<{
-        success: boolean;
-        failure: boolean;
-        result: any;
-        error: any;
-    }>;
-    handleError: (error: any) => void;
-};
-export {};

package/types/composables/content.d.ts

@@ -1,51 +0,0 @@
-import type { AppInformationKey, ContentModelItemModel, ContentModelModel, MenuItemGroupModel, MenuItemModel, MenuModel, NewsArticleModel, NewsCategoryModel, NewsTagModel, PageModel, SectionModel, SettingType, SharedProps } from '@creopse/utils';
-import type { ErrorBag, Errors, PageProps } from '@inertiajs/core';
-/**
- * A composable that provides a set of functions and properties for
- * easily accessing and manipulating page data, content models, menus,
- * menu items, and more.
- *
- * @returns {Object}
- */
-export declare const useContent: () => {
-    logo: globalThis.ComputedRef<string>;
-    icon: globalThis.ComputedRef<string>;
-    page: import("@inertiajs/core").Page<SharedProps>;
-    pageData: PageModel | null;
-    newsArticle: NewsArticleModel | undefined;
-    newsCategory: NewsCategoryModel | undefined;
-    newsTag: NewsTagModel | undefined;
-    contentModelItem: ContentModelItemModel | undefined;
-    getProps: () => PageProps & SharedProps & {
-        errors: Errors & ErrorBag;
-    };
-    getMenu: (name: string, filterByIsActive?: boolean) => MenuModel | undefined;
-    getMenuByLocation: (name: string, filterByIsActive?: boolean) => MenuModel | undefined;
-    getMenuItems: (name: string, filterByIsVisible?: boolean) => MenuItemModel[] | undefined;
-    getMenuItemById: (id: number) => MenuItemModel | undefined;
-    getMenuItemsByLocation: (name: string, filterByIsVisible?: boolean) => MenuItemModel[] | undefined;
-    getMenuGroups: (name: string, byLocation?: boolean, filterByIsVisible?: boolean) => MenuItemGroupModel[];
-    getMenuItemsByGroup: (name: string, groupId: number, byLocation?: boolean, filterByIsVisible?: boolean) => MenuItemModel[] | undefined;
-    getMenuGroupedItems: (name: string, byLocation?: boolean, filterByIsVisible?: boolean) => {
-        group: MenuItemGroupModel;
-        items: MenuItemModel[] | undefined;
-    }[];
-    getMenuUngroupedItems: (name: string, byLocation?: boolean, filterByIsVisible?: boolean) => MenuItemModel[] | undefined;
-    getSectionData: (slug: string) => object | any | null;
-    getAnySectionData: (sectionSlug: string, pageSlug: string) => Promise<any>;
-    getSectionsInOrder: () => SectionModel[];
-    getFinalPageSections: () => SectionModel[];
-    getSectionRootData: (slug: string) => any;
-    getComponents: () => Record<string, any>;
-    getContentModel: (name: string) => ContentModelModel | undefined;
-    getContentModelItems: (name: string, filterByIsActive?: boolean) => Promise<ContentModelItemModel[]>;
-    getPaginatedContentModelItems: (name: string, pageSize: number, filterByIsActive?: boolean) => Promise<{
-        items: ContentModelItemModel[];
-        total: number;
-        currentPage: number;
-    }>;
-    getAppInformationValue: (key: AppInformationKey, type?: SettingType) => any;
-    appAccentColor: globalThis.ComputedRef<string>;
-    appPrimaryColor: globalThis.ComputedRef<string>;
-    appSecondaryColor: globalThis.ComputedRef<string>;
-};

package/types/composables/helper.d.ts

@@ -1,29 +0,0 @@
-import { type Language } from '@creopse/utils';
-/**
- * Returns a collection of helper functions and values.
- *
- * @returns {Object}
- */
-export declare const useHelper: () => {
-    is2XlScreen: globalThis.ComputedRef<boolean>;
-    isXlScreen: globalThis.ComputedRef<boolean>;
-    isLgScreen: globalThis.ComputedRef<boolean>;
-    isMdScreen: globalThis.ComputedRef<boolean>;
-    isSmScreen: globalThis.ComputedRef<boolean>;
-    getTranslation: (data: any) => string;
-    getLangageLabel: (value: string) => string | undefined;
-    getLanguageValue: (label: string) => string | undefined;
-    getLinkCursorClass: (url: string) => "tw-cursor-default" | "tw-cursor-pointer";
-    ckEditorToolbarItems: string[];
-    displayFormErrors: (errors: any, displayError: (message: string) => void) => void;
-    resolveHtmlLinks: (data: string | null | undefined) => string;
-    pickByTheme: (lightVal: string | number | null, darkVal: string | number | null) => string | number | null;
-    resolveUrl: (path: string) => string;
-    updateLang: (val: string, reload?: boolean, updateUserPrefs?: boolean) => Promise<void>;
-    languages: Language[];
-    getImage: (path: string, size?: "small" | "medium" | "large" | "original") => Promise<string>;
-    fileUrl: (path: string) => string;
-    currentRoutePath: globalThis.ComputedRef<string>;
-    rHtml: (data: string | null | undefined) => string;
-    tr: (data: any) => string;
-};

package/types/composables/newsletter.d.ts

@@ -1,29 +0,0 @@
-/**
- * A composable that exposes functions to subscribe the user to the newsletter using
- * email or phone.
- *
- * @returns An object containing the subscribeEmail, subscribePhone, and isLoading
- * properties.
- *
- * @remarks
- * The subscribeEmail and subscribePhone functions are asynchronous and return nothing.
- * The isLoading property is a boolean that indicates whether a subscription request is
- * being processed.
- *
- * The subscribeEmail function takes an email address and an optional success callback.
- * The subscribePhone function takes a phone number and an optional success callback.
- *
- * If the request is successful, the user will be subscribed to the newsletter and the
- * success callback will be called. If the request fails, an appropriate error message
- * will be displayed to the user.
- *
- * The error messages are as follows:
- * - If the request is invalid, the form errors will be displayed.
- * - If the request is valid but results in an error, a generic error message will be
- * displayed.
- */
-export declare const useNewsletter: () => {
-    subscribePhone: (phone: string, displayFormError: (message: string) => void, successCallback?: (() => void) | undefined, failureCallback?: (() => void) | undefined) => Promise<void>;
-    subscribeEmail: (email: string, displayFormError: (message: string) => void, successCallback?: (() => void) | undefined, failureCallback?: (() => void) | undefined) => Promise<void>;
-    isLoading: globalThis.Ref<boolean, boolean>;
-};

package/types/composables/user-preference.d.ts

@@ -1,26 +0,0 @@
-import { Bool, type UserPrefs } from '@creopse/utils';
-/**
- * A composable that exposes the default user preferences.
- *
- * @returns An object containing the `defaultPrefs` property, which is a reactive
- * ref to the default user preferences.
- *
- * The `defaultPrefs` object contains the following properties:
- *
- * - `inAppNotifEnabled`: A boolean indicating whether in-app notifications are
- * enabled by default.
- * - `emailNotifEnabled`: A boolean indicating whether email notifications are
- * enabled by default.
- * - `locale`: The user's preferred locale.
- */
-export declare const useUserPreference: () => {
-    defaultPrefs: globalThis.Ref<{
-        inAppNotifEnabled?: Bool | undefined;
-        emailNotifEnabled?: Bool | undefined;
-        locale?: string | undefined;
-    }, UserPrefs | {
-        inAppNotifEnabled?: Bool | undefined;
-        emailNotifEnabled?: Bool | undefined;
-        locale?: string | undefined;
-    }>;
-};

package/types/constants.d.ts

@@ -1,7 +0,0 @@
-export declare var API_BASE_URL: string;
-export declare var API_URL: string;
-export declare const API_REQUEST_HEADERS: {
-    'X-API-Key': any;
-};
-export declare const LANG_COOKIE = "Lang";
-export declare const ENCRYPTION_KEY = "fb8c9dd4-fef4-4b88-a9b8-fe5725f9e0c1";

package/types/layouts/AuthPage.vue.d.ts

@@ -1,12 +0,0 @@
-declare var __VLS_6: {};
-type __VLS_Slots = {} & {
-    default?: (props: typeof __VLS_6) => any;
-};
-declare const __VLS_component: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
-export default _default;
-type __VLS_WithSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};

package/types/layouts/Page.vue.d.ts

@@ -1,12 +0,0 @@
-declare var __VLS_1: {};
-type __VLS_Slots = {} & {
-    default?: (props: typeof __VLS_1) => any;
-};
-declare const __VLS_component: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
-export default _default;
-type __VLS_WithSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};

package/types/pages/Container.vue.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-export default _default;

package/types/pages/NotFound.vue.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-export default _default;

package/types/stores/auth.d.ts

@@ -1,14 +0,0 @@
-import type { UserModel } from '@creopse/utils';
-export interface AuthState {
-    userData: UserModel | null;
-    rememberMe: boolean;
-    accessToken: string | null;
-    accessTokenDate: number | null;
-}
-export declare const useAuthStore: import("pinia").StoreDefinition<"auth", AuthState, {
-    isUserConnected(state: AuthState): boolean;
-    getUserData(state: AuthState): UserModel | null;
-}, {
-    resetAuthData(): void;
-    reloadUserData(): Promise<void>;
-}>;

package/types/stores/index.d.ts

@@ -1,7 +0,0 @@
-declare module 'pinia' {
-    interface PiniaCustomProperties {
-        router: any;
-    }
-}
-declare const _default: import("pinia").Pinia;
-export default _default;