@creopse/utils 0.0.1

package/dist/models/user.js

@@ -0,0 +1,27 @@
+export class UserModel {
+    constructor(avatar, avatarUrl, fullname, lastname, firstname, email, password, profileType, profileId, accountStatus, id, uid, emailVerifiedAt, phone, address, location, preferences, authType, lastLoggedInAt, rememberToken, deletedAt, createdAt, updatedAt) {
+        this.id = id;
+        this.uid = uid;
+        this.avatar = avatar;
+        this.avatarUrl = avatarUrl;
+        this.fullname = fullname;
+        this.lastname = lastname;
+        this.firstname = firstname;
+        this.email = email;
+        this.password = password;
+        this.phone = phone;
+        this.address = address;
+        this.location = location;
+        this.accountStatus = accountStatus;
+        this.emailVerifiedAt = emailVerifiedAt;
+        this.profileType = profileType;
+        this.profileId = profileId;
+        this.preferences = preferences;
+        this.authType = authType;
+        this.lastLoggedInAt = lastLoggedInAt;
+        this.rememberToken = rememberToken;
+        this.deletedAt = deletedAt;
+        this.createdAt = createdAt;
+        this.updatedAt = updatedAt;
+    }
+}

package/dist/models/video-item.d.ts

@@ -0,0 +1,23 @@
+import { VideoDisplayType } from '../enums/video-display-type';
+import { VideoItemSource } from '../enums/video-item-source';
+import { UserModel } from './user';
+export declare class VideoItemModel {
+    id?: number;
+    foreignId?: string | null;
+    publisherId?: number;
+    title: string;
+    slug?: string;
+    description?: string | null;
+    thumbnail?: string | null;
+    thumbnailUrl?: string | null;
+    path: string;
+    url?: string;
+    displayType: VideoDisplayType;
+    source: VideoItemSource;
+    visible: boolean;
+    publishedAt?: string | null;
+    createdAt?: string;
+    updatedAt?: string;
+    publisher?: UserModel;
+    constructor(title: string, path: string, source: VideoItemSource | undefined, displayType: VideoDisplayType | undefined, visible: boolean, id?: number, url?: string, slug?: string, publisherId?: number, foreignId?: string | null, description?: string | null, thumbnail?: string | null, thumbnailUrl?: string | null, publishedAt?: string | null, createdAt?: string, updatedAt?: string);
+}

package/dist/models/video-item.js

@@ -0,0 +1,22 @@
+import { VideoDisplayType } from '../enums/video-display-type';
+import { VideoItemSource } from '../enums/video-item-source';
+export class VideoItemModel {
+    constructor(title, path, source = VideoItemSource.SELF_HOSTED, displayType = VideoDisplayType.HORIZONTAL, visible, id, url, slug, publisherId, foreignId, description, thumbnail, thumbnailUrl, publishedAt, createdAt, updatedAt) {
+        this.id = id;
+        this.foreignId = foreignId;
+        this.publisherId = publisherId;
+        this.title = title;
+        this.slug = slug;
+        this.description = description;
+        this.thumbnail = thumbnail;
+        this.thumbnailUrl = thumbnailUrl;
+        this.path = path;
+        this.url = url;
+        this.source = source;
+        this.visible = visible;
+        this.displayType = displayType;
+        this.publishedAt = publishedAt;
+        this.createdAt = createdAt;
+        this.updatedAt = updatedAt;
+    }
+}

package/dist/models/video-setting.d.ts

@@ -0,0 +1,8 @@
+export declare class VideoSettingModel {
+    id?: number;
+    key: string;
+    value: string;
+    createdAt?: string;
+    updatedAt?: string;
+    constructor(key: string, value: string, id?: number, createdAt?: string, updatedAt?: string);
+}

package/dist/models/video-setting.js

@@ -0,0 +1,9 @@
+export class VideoSettingModel {
+    constructor(key, value, id, createdAt, updatedAt) {
+        this.id = id;
+        this.key = key;
+        this.value = value;
+        this.createdAt = createdAt;
+        this.updatedAt = updatedAt;
+    }
+}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/enums/account-status.ts","../src/enums/ad-content-type.ts","../src/enums/auth-type.ts","../src/enums/bool.ts","../src/enums/content-type.ts","../src/enums/index.ts","../src/enums/media-file-type.ts","../src/enums/menu-item-target-type.ts","../src/enums/news-article-status.ts","../src/enums/notification-source.ts","../src/enums/notification-type.ts","../src/enums/permalink-content-type.ts","../src/enums/profile-type.ts","../src/enums/response-error-code.ts","../src/enums/user-role.ts","../src/enums/video-display-type.ts","../src/enums/video-item-source.ts","../src/models/ad-identifier.ts","../src/models/ad.ts","../src/models/admin-profile.ts","../src/models/app-information.ts","../src/models/app-setting.ts","../src/models/content-model-item.ts","../src/models/content-model.ts","../src/models/index.ts","../src/models/media-file.ts","../src/models/menu-item-group.ts","../src/models/menu-item.ts","../src/models/menu-location.ts","../src/models/menu.ts","../src/models/news-article.ts","../src/models/news-category.ts","../src/models/news-comment.ts","../src/models/news-tag.ts","../src/models/newsletter-campaign.ts","../src/models/newsletter-email.ts","../src/models/newsletter-phone.ts","../src/models/notification.ts","../src/models/page.ts","../src/models/permalink.ts","../src/models/permission.ts","../src/models/role.ts","../src/models/section.ts","../src/models/subscriber-profile.ts","../src/models/user-session.ts","../src/models/user.ts","../src/models/video-item.ts","../src/models/video-setting.ts","../src/types/app-information.ts","../src/types/common.ts","../src/types/index.ts","../src/types/pagination.ts","../src/types/props.ts","../src/utils/chronos.ts","../src/utils/functions.ts","../src/utils/index.ts"],"version":"5.8.3"}

package/dist/types/app-information.d.ts

@@ -0,0 +1,41 @@
+export interface AppInformationObject {
+    name: string;
+    icon: string;
+    oneColorIcon: string;
+    logo: string;
+    oneColorLogo: string;
+    phone: string;
+    email: string;
+    address: string;
+    postalCode: string;
+    description: string;
+    primaryColor: string;
+    secondaryColor: string;
+    accentColor: string;
+    facebook: string;
+    twitter: string;
+    instagram: string;
+    whatsapp: string;
+    linkedin: string;
+    youtube: string;
+    pinterest: string;
+    snapchat: string;
+    tiktok: string;
+    telegram: string;
+    discord: string;
+    reddit: string;
+    tumblr: string;
+    vimeo: string;
+    twitch: string;
+    github: string;
+    dribbble: string;
+    behance: string;
+    medium: string;
+    stackOverflow: string;
+    threads: string;
+    messenger: string;
+    playstore: string;
+    appstore: string;
+    additionalInfo: string;
+}
+export type AppInformationKey = keyof AppInformationObject;

package/dist/types/app-information.js

@@ -0,0 +1 @@
+export {};

package/dist/types/common.d.ts

@@ -0,0 +1,11 @@
+import { Bool } from '../enums/bool';
+export type SettingType = 'string' | 'number' | 'boolean' | 'object' | 'array';
+export interface UserPrefs {
+    inAppNotifEnabled?: Bool;
+    emailNotifEnabled?: Bool;
+    locale?: string;
+}
+export interface Coords {
+    lat: number;
+    lng: number;
+}

package/dist/types/common.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './app-information';
+export * from './pagination';
+export * from './common';
+export * from './props';

package/dist/types/index.js

@@ -0,0 +1,4 @@
+export * from './app-information';
+export * from './pagination';
+export * from './common';
+export * from './props';

package/dist/types/pagination.d.ts

@@ -0,0 +1,26 @@
+import { NewsArticleModel } from '../models/news-article';
+export interface PaginationMeta {
+    current_page: number;
+    from: number;
+    last_page: number;
+    links: {
+        url: string;
+        label: string;
+        active: boolean;
+    }[];
+    path: string;
+    per_page: number;
+    to: number;
+    total: number;
+}
+export interface PaginationLinks {
+    first: string;
+    last: string;
+    prev: string;
+    next: string;
+}
+export interface PaginatedArticles {
+    data: NewsArticleModel[];
+    meta: PaginationMeta;
+    links: PaginationLinks;
+}

package/dist/types/pagination.js

@@ -0,0 +1 @@
+export {};

package/dist/types/props.d.ts

@@ -0,0 +1,42 @@
+import type { AdModel } from '../models/ad';
+import type { AdIdentifierModel } from '../models/ad-identifier';
+import type { ContentModelModel } from '../models/content-model';
+import type { ContentModelItemModel } from '../models/content-model-item';
+import type { MenuModel } from '../models/menu';
+import type { MenuItemGroupModel } from '../models/menu-item-group';
+import type { MenuLocationModel } from '../models/menu-location';
+import type { NewsArticleModel } from '../models/news-article';
+import type { NewsCategoryModel } from '../models/news-category';
+import type { NewsTagModel } from '../models/news-tag';
+import type { PageModel } from '../models/page';
+import type { SectionModel } from '../models/section';
+import type { Page } from '@inertiajs/core';
+import type { PaginatedArticles } from './pagination';
+import { AppInformationModel } from '../models/app-information';
+export interface SharedProps extends Page {
+    appLocale: string;
+    appFallbackLocale: string;
+    userData: any;
+    isUserLoggedIn: boolean;
+    pageData: PageModel | null;
+    sectionData: SectionModel | null;
+    articles?: NewsArticleModel[];
+    paginatedArticles?: PaginatedArticles;
+    categories?: NewsCategoryModel[];
+    tags?: NewsTagModel[];
+    article?: NewsArticleModel;
+    category?: NewsCategoryModel;
+    tag?: NewsTagModel;
+    contentModelItem?: ContentModelItemModel;
+    appInformation: AppInformationModel[];
+    adIdentifiers?: AdIdentifierModel[];
+    contentModels?: ContentModelModel[];
+    menus?: MenuModel[];
+    menuLocations?: MenuLocationModel[];
+    menuItemGroups?: MenuItemGroupModel[];
+    ads?: AdModel[];
+    query?: string;
+    data?: any;
+    youtubeChannelId?: string;
+    [key: string]: unknown;
+}

package/dist/types/props.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/chronos.d.ts

@@ -0,0 +1,97 @@
+import moment from 'moment';
+import 'moment/dist/locale/fr';
+/**
+ * Waits for the given amount of milliseconds before resolving the promise.
+ * @param {number} ms - The time to wait in milliseconds.
+ * @returns {Promise<void>} - A promise that resolves after the specified time.
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * Returns the current timestamp in seconds.
+ *
+ * @returns {number} The current timestamp in seconds.
+ */
+export declare function getCurrentTimestamp(): number;
+/**
+ * Converts a timestamp in seconds into a formatted date string.
+ *
+ * @param {number} date - The timestamp in seconds to convert.
+ * @param {{locale?: string, pattern?: string}} options - Optional parameters for the conversion.
+ * @param {string} options.locale - The locale to use for the conversion. Defaults to 'en'.
+ * @param {string} options.pattern - The pattern to use for the conversion. Defaults to 'MM/DD/YYYY HH:mm'.
+ * @returns {string} The formatted date string.
+ */
+export declare function getDateFromTimestamp(date: number, { locale, pattern, }?: {
+    locale?: string;
+    pattern?: string;
+}): string;
+/**
+ * Converts a date string or Date object from one format to another.
+ *
+ * @param {string | Date} date - The date string or Date object to convert.
+ * @param {{inPattern?: string, outPattern?: string, locale?: string}} options - Optional parameters for the conversion.
+ * @param {string} options.inPattern - The pattern of the input date string. Defaults to 'YYYY-MM-DD'.
+ * @param {string} options.outPattern - The pattern of the output date string. Defaults to 'DD MMM YYYY'.
+ * @param {string} options.locale - The locale to use for the conversion. Defaults to 'fr'.
+ * @returns {string} The converted date string.
+ */
+export declare function reformatDate(date: string | Date, { inPattern, outPattern, locale, }?: {
+    inPattern?: string;
+    outPattern?: string;
+    locale?: string;
+}): string;
+/**
+ * Converts a date string or Date object into a formatted date string.
+ *
+ * @param {string | Date} date - The date string or Date object to convert.
+ * @param {{outPattern?: string, locale?: string}} options - Optional parameters for the conversion.
+ * @param {string} options.outPattern - The pattern of the output date string. Defaults to 'DD MMM YYYY'.
+ * @param {string} options.locale - The locale to use for the conversion. Defaults to 'fr'.
+ * @returns {string} The formatted date string.
+ */
+export declare function formatDate(date: string | Date, { outPattern, locale, }?: {
+    outPattern?: string;
+    locale?: string;
+}): string;
+/**
+ * Calculates the difference between the given date and today in the given unit.
+ *
+ * @param {string | Date} date - The date to calculate the difference for.
+ * @param {{pattern?: string, unit?: moment.unitOfTime.Diff}} options - Optional parameters for the calculation.
+ * @param {string} options.pattern - The pattern of the input date string. Defaults to 'YYYY-MM-DD'.
+ * @param {moment.unitOfTime.Diff} options.unit - The unit of time to calculate the difference in. Defaults to 'days'.
+ * @returns {number} The difference between the given date and today in the given unit.
+ */
+export declare function differenceWithToday(date: string | Date, { pattern, unit, }?: {
+    pattern?: string;
+    unit?: moment.unitOfTime.Diff;
+}): number;
+/**
+ * Calculates the difference between two dates.
+ *
+ * @param {string | Date} startDate - The start date.
+ * @param {string | Date} endDate - The end date.
+ * @param {{startDatePattern?: string, endDatePattern?: string, unit?: moment.unitOfTime.Diff}} options - Optional parameters for the calculation.
+ * @param {string} options.startDatePattern - The pattern of the start date string. Defaults to 'YYYY-MM-DD'.
+ * @param {string} options.endDatePattern - The pattern of the end date string. Defaults to 'YYYY-MM-DD'.
+ * @param {moment.unitOfTime.Diff} options.unit - The unit of time to calculate the difference in. Defaults to 'days'.
+ * @returns {number} The difference between the start and end dates in the given unit.
+ */
+export declare function differenceBetweenDates(startDate: string | Date, endDate: string | Date, { startDatePattern, endDatePattern, unit, }?: {
+    startDatePattern?: string;
+    endDatePattern?: string;
+    unit?: moment.unitOfTime.Diff;
+}): number;
+/**
+ * Calculates the difference between the given date and now.
+ *
+ * @param {string | Date} date - The date to calculate the difference from.
+ * @param {{locale?: string, pattern?: string}} options - Optional parameters for the calculation.
+ * @param {string} options.locale - The locale to use for the calculation. Defaults to 'en'.
+ * @param {string} options.pattern - The pattern of the date string. Defaults to 'YYYY-MM-DD HH:mm:ss'.
+ * @returns {string} The difference between the given date and now, relative to the given locale.
+ */
+export declare function differenceFromNow(date: string | Date, { locale, pattern, }?: {
+    locale?: string;
+    pattern?: string;
+}): string;

package/dist/utils/chronos.js

@@ -0,0 +1,97 @@
+import moment from 'moment';
+import 'moment/dist/locale/fr';
+/**
+ * Waits for the given amount of milliseconds before resolving the promise.
+ * @param {number} ms - The time to wait in milliseconds.
+ * @returns {Promise<void>} - A promise that resolves after the specified time.
+ */
+export function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+/**
+ * Returns the current timestamp in seconds.
+ *
+ * @returns {number} The current timestamp in seconds.
+ */
+export function getCurrentTimestamp() {
+    return Math.round(Number(new Date()) / 1000);
+}
+/**
+ * Converts a timestamp in seconds into a formatted date string.
+ *
+ * @param {number} date - The timestamp in seconds to convert.
+ * @param {{locale?: string, pattern?: string}} options - Optional parameters for the conversion.
+ * @param {string} options.locale - The locale to use for the conversion. Defaults to 'en'.
+ * @param {string} options.pattern - The pattern to use for the conversion. Defaults to 'MM/DD/YYYY HH:mm'.
+ * @returns {string} The formatted date string.
+ */
+export function getDateFromTimestamp(date, { locale = 'en', pattern = 'MM/DD/YYYY HH:mm', } = {}) {
+    return moment(new Date(date * 1000))
+        .locale(locale)
+        .format(pattern);
+}
+/**
+ * Converts a date string or Date object from one format to another.
+ *
+ * @param {string | Date} date - The date string or Date object to convert.
+ * @param {{inPattern?: string, outPattern?: string, locale?: string}} options - Optional parameters for the conversion.
+ * @param {string} options.inPattern - The pattern of the input date string. Defaults to 'YYYY-MM-DD'.
+ * @param {string} options.outPattern - The pattern of the output date string. Defaults to 'DD MMM YYYY'.
+ * @param {string} options.locale - The locale to use for the conversion. Defaults to 'fr'.
+ * @returns {string} The converted date string.
+ */
+export function reformatDate(date, { inPattern = 'YYYY-MM-DD', outPattern = 'DD MMM YYYY', locale = 'fr', } = {}) {
+    return date ? moment(date, inPattern).locale(locale).format(outPattern) : '';
+}
+/**
+ * Converts a date string or Date object into a formatted date string.
+ *
+ * @param {string | Date} date - The date string or Date object to convert.
+ * @param {{outPattern?: string, locale?: string}} options - Optional parameters for the conversion.
+ * @param {string} options.outPattern - The pattern of the output date string. Defaults to 'DD MMM YYYY'.
+ * @param {string} options.locale - The locale to use for the conversion. Defaults to 'fr'.
+ * @returns {string} The formatted date string.
+ */
+export function formatDate(date, { outPattern = 'DD MMM YYYY', locale = 'fr', } = {}) {
+    return date ? moment(date).locale(locale).format(outPattern) : '';
+}
+/**
+ * Calculates the difference between the given date and today in the given unit.
+ *
+ * @param {string | Date} date - The date to calculate the difference for.
+ * @param {{pattern?: string, unit?: moment.unitOfTime.Diff}} options - Optional parameters for the calculation.
+ * @param {string} options.pattern - The pattern of the input date string. Defaults to 'YYYY-MM-DD'.
+ * @param {moment.unitOfTime.Diff} options.unit - The unit of time to calculate the difference in. Defaults to 'days'.
+ * @returns {number} The difference between the given date and today in the given unit.
+ */
+export function differenceWithToday(date, { pattern = 'YYYY-MM-DD', unit = 'days', } = {}) {
+    return moment(date, pattern).diff(moment(), unit);
+}
+/**
+ * Calculates the difference between two dates.
+ *
+ * @param {string | Date} startDate - The start date.
+ * @param {string | Date} endDate - The end date.
+ * @param {{startDatePattern?: string, endDatePattern?: string, unit?: moment.unitOfTime.Diff}} options - Optional parameters for the calculation.
+ * @param {string} options.startDatePattern - The pattern of the start date string. Defaults to 'YYYY-MM-DD'.
+ * @param {string} options.endDatePattern - The pattern of the end date string. Defaults to 'YYYY-MM-DD'.
+ * @param {moment.unitOfTime.Diff} options.unit - The unit of time to calculate the difference in. Defaults to 'days'.
+ * @returns {number} The difference between the start and end dates in the given unit.
+ */
+export function differenceBetweenDates(startDate, endDate, { startDatePattern = 'YYYY-MM-DD', endDatePattern = 'YYYY-MM-DD', unit = 'days', } = {}) {
+    const start = moment(startDate, startDatePattern);
+    const end = moment(endDate, endDatePattern);
+    return start.diff(end, unit);
+}
+/**
+ * Calculates the difference between the given date and now.
+ *
+ * @param {string | Date} date - The date to calculate the difference from.
+ * @param {{locale?: string, pattern?: string}} options - Optional parameters for the calculation.
+ * @param {string} options.locale - The locale to use for the calculation. Defaults to 'en'.
+ * @param {string} options.pattern - The pattern of the date string. Defaults to 'YYYY-MM-DD HH:mm:ss'.
+ * @returns {string} The difference between the given date and now, relative to the given locale.
+ */
+export function differenceFromNow(date, { locale = 'en', pattern = 'YYYY-MM-DD HH:mm:ss', } = {}) {
+    return moment(date, pattern).locale(locale).fromNow();
+}