@creopse/utils 0.0.15 → 0.0.16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Noé Gnanih
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/enums/index.d.ts

@@ -1,6 +1,7 @@
 export * from './content-model/item-creator-type';
 export * from './content-model/access-scope';
 export * from './content-model/intent';
+export * from './access-guard';
 export * from './account-status';
 export * from './ad-content-type';
 export * from './auth-type';
@@ -14,7 +15,9 @@ export * from './notification-source';
 export * from './notification-type';
 export * from './permalink-content-type';
 export * from './profile-type';
+export * from './permission';
 export * from './response-error-code';
+export * from './response-status-code';
 export * from './user-role';
 export * from './video-display-type';
 export * from './video-item-source';

package/dist/enums/index.js

@@ -1,6 +1,7 @@
 export * from './content-model/item-creator-type';
 export * from './content-model/access-scope';
 export * from './content-model/intent';
+export * from './access-guard';
 export * from './account-status';
 export * from './ad-content-type';
 export * from './auth-type';
@@ -14,7 +15,9 @@ export * from './notification-source';
 export * from './notification-type';
 export * from './permalink-content-type';
 export * from './profile-type';
+export * from './permission';
 export * from './response-error-code';
+export * from './response-status-code';
 export * from './user-role';
 export * from './video-display-type';
 export * from './video-item-source';

package/dist/enums/notification-type.d.ts

@@ -1,3 +1,3 @@
 export declare enum NotificationType {
-    WELCOME_USER = "App\\Notifications\\WelcomeUser"
+    WELCOME_USER = "Creopse\\Creopse\\Notifications\\WelcomeUser"
 }

package/dist/enums/notification-type.js

@@ -1,4 +1,4 @@
 export var NotificationType;
 (function (NotificationType) {
-    NotificationType["WELCOME_USER"] = "App\\Notifications\\WelcomeUser";
+    NotificationType["WELCOME_USER"] = "Creopse\\Creopse\\Notifications\\WelcomeUser";
 })(NotificationType || (NotificationType = {}));

package/dist/enums/permission.d.ts

@@ -0,0 +1,28 @@
+export declare enum Permission {
+    VIEW_DASHBOARD = "view-dashboard",
+    VIEW_ACCOUNT = "view-account",
+    EDIT_ACCOUNT = "edit-account",
+    VIEW_NOTIFICATIONS = "view-notifications",
+    MANAGE_NOTIFICATIONS = "manage-notifications",
+    VIEW_ABOUT = "view-about",
+    MANAGE_PLUGINS = "manage-plugins",
+    MANAGE_APP_SETTINGS = "manage-app-settings",
+    VIEW_USERS = "view-users",
+    CREATE_USER = "create-user",
+    EDIT_USER = "edit-user",
+    DELETE_USER = "delete-user",
+    VIEW_ROLES = "view-roles",
+    MANAGE_ROLES = "manage-roles",
+    VIEW_PERMISSIONS = "view-permissions",
+    MANAGE_PERMISSIONS = "manage-permissions",
+    CREATE_ARTICLE = "create-article",
+    EDIT_ARTICLE = "edit-article",
+    DELETE_ARTICLE = "delete-article",
+    MANAGE_NEWS = "manage-news",
+    VIEW_MEDIA = "view-media",
+    UPLOAD_MEDIA = "upload-media",
+    DELETE_MEDIA = "delete-media",
+    VIEW_CONTENT = "view-content",
+    MANAGE_CONTENT = "manage-content",
+    USE_VISUAL_EDITOR = "use-visual-editor"
+}

package/dist/enums/permission.js

@@ -0,0 +1,38 @@
+export var Permission;
+(function (Permission) {
+    // Dashboard Module
+    Permission["VIEW_DASHBOARD"] = "view-dashboard";
+    // Account Module
+    Permission["VIEW_ACCOUNT"] = "view-account";
+    Permission["EDIT_ACCOUNT"] = "edit-account";
+    // Notifications Module
+    Permission["VIEW_NOTIFICATIONS"] = "view-notifications";
+    Permission["MANAGE_NOTIFICATIONS"] = "manage-notifications";
+    // Settings Module
+    Permission["VIEW_ABOUT"] = "view-about";
+    Permission["MANAGE_PLUGINS"] = "manage-plugins";
+    Permission["MANAGE_APP_SETTINGS"] = "manage-app-settings";
+    // Users Module
+    Permission["VIEW_USERS"] = "view-users";
+    Permission["CREATE_USER"] = "create-user";
+    Permission["EDIT_USER"] = "edit-user";
+    Permission["DELETE_USER"] = "delete-user";
+    // Access Module
+    Permission["VIEW_ROLES"] = "view-roles";
+    Permission["MANAGE_ROLES"] = "manage-roles";
+    Permission["VIEW_PERMISSIONS"] = "view-permissions";
+    Permission["MANAGE_PERMISSIONS"] = "manage-permissions";
+    // News Module
+    Permission["CREATE_ARTICLE"] = "create-article";
+    Permission["EDIT_ARTICLE"] = "edit-article";
+    Permission["DELETE_ARTICLE"] = "delete-article";
+    Permission["MANAGE_NEWS"] = "manage-news";
+    // Media Module
+    Permission["VIEW_MEDIA"] = "view-media";
+    Permission["UPLOAD_MEDIA"] = "upload-media";
+    Permission["DELETE_MEDIA"] = "delete-media";
+    // Content Module
+    Permission["VIEW_CONTENT"] = "view-content";
+    Permission["MANAGE_CONTENT"] = "manage-content";
+    Permission["USE_VISUAL_EDITOR"] = "use-visual-editor";
+})(Permission || (Permission = {}));

package/dist/enums/profile-type.d.ts

@@ -1,3 +1,4 @@
 export declare enum ProfileType {
+    ADMIN = "Creopse\\Creopse\\Models\\AdminProfile",
     SUBSCRIBER = "App\\Models\\SubscriberProfile"
 }

package/dist/enums/profile-type.js

@@ -1,4 +1,5 @@
 export var ProfileType;
 (function (ProfileType) {
+    ProfileType["ADMIN"] = "Creopse\\Creopse\\Models\\AdminProfile";
     ProfileType["SUBSCRIBER"] = "App\\Models\\SubscriberProfile";
 })(ProfileType || (ProfileType = {}));

package/dist/{utils → helpers}/chronos.d.ts

@@ -1,5 +1,5 @@
 import moment from 'moment';
-import 'moment/dist/locale/fr';
+import 'moment/locale/fr';
 /**
  * Waits for the given amount of milliseconds before resolving the promise.
  * @param {number} ms - The time to wait in milliseconds.

package/dist/{utils → helpers}/chronos.js

@@ -1,5 +1,5 @@
 import moment from 'moment';
-import 'moment/dist/locale/fr';
+import 'moment/locale/fr';
 /**
  * Waits for the given amount of milliseconds before resolving the promise.
  * @param {number} ms - The time to wait in milliseconds.

package/dist/helpers/constants/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DASHBOARD_MODULE_NAME = "PluginDashboard";
+export declare const SETTINGS_MODULE_NAME = "PluginSettings";

package/dist/helpers/constants/constants.js

@@ -0,0 +1,3 @@
+// Modules
+export const DASHBOARD_MODULE_NAME = 'PluginDashboard';
+export const SETTINGS_MODULE_NAME = 'PluginSettings';

package/dist/helpers/constants/index.d.ts

@@ -0,0 +1 @@
+export * from './constants';

package/dist/helpers/constants/index.js

@@ -0,0 +1 @@
+export * from './constants';

package/dist/helpers/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DASHBOARD_MODULE_NAME = "PluginDashboard";
+export declare const SETTINGS_MODULE_NAME = "PluginSettings";

package/dist/helpers/constants.js

@@ -0,0 +1,3 @@
+// Modules
+export const DASHBOARD_MODULE_NAME = 'PluginDashboard';
+export const SETTINGS_MODULE_NAME = 'PluginSettings';

package/dist/helpers/functions/array.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Removes duplicate elements from an array based on a specified property.
+ *
+ * @param {T[]} arr - The array from which duplicate elements will be removed.
+ * @param {keyof T} property - The property used to determine duplicates.
+ * @returns {T[]} The array with duplicate elements removed.
+ */
+export declare function removeDuplicates<T>(arr: T[], property: keyof T): T[];
+/**
+ * Creates a new array of pure JavaScript objects by making a shallow copy of each object in the input array.
+ *
+ * @param {Array<object>} array - The input array containing objects to be copied.
+ * @return {Array<object>} A new array containing the copied objects.
+ */
+export declare function toArrayOfPureJsObjects(array: Array<object>): Array<object>;
+/**
+ * Shuffles the elements in an array in place using the Fisher-Yates algorithm.
+ *
+ * @param {T[]} array - The array to be shuffled.
+ * @return {T[]} The shuffled array.
+ */
+export declare function shuffleArray<T>(array: T[]): T[];

package/dist/helpers/functions/array.js

@@ -0,0 +1,42 @@
+/**
+ * Removes duplicate elements from an array based on a specified property.
+ *
+ * @param {T[]} arr - The array from which duplicate elements will be removed.
+ * @param {keyof T} property - The property used to determine duplicates.
+ * @returns {T[]} The array with duplicate elements removed.
+ */
+export function removeDuplicates(arr, property) {
+    const uniqueValues = new Set();
+    return arr.filter((obj) => {
+        const value = obj[property];
+        if (!uniqueValues.has(value)) {
+            uniqueValues.add(value);
+            return true;
+        }
+        return false;
+    });
+}
+/**
+ * Creates a new array of pure JavaScript objects by making a shallow copy of each object in the input array.
+ *
+ * @param {Array<object>} array - The input array containing objects to be copied.
+ * @return {Array<object>} A new array containing the copied objects.
+ */
+export function toArrayOfPureJsObjects(array) {
+    return array.map((obj) => {
+        return Object.assign({}, obj);
+    });
+}
+/**
+ * Shuffles the elements in an array in place using the Fisher-Yates algorithm.
+ *
+ * @param {T[]} array - The array to be shuffled.
+ * @return {T[]} The shuffled array.
+ */
+export function shuffleArray(array) {
+    for (let i = array.length - 1; i > 0; i--) {
+        const j = Math.floor(Math.random() * (i + 1));
+        [array[i], array[j]] = [array[j], array[i]]; // Swap elements
+    }
+    return array;
+}

package/dist/helpers/functions/browser.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Generates a function comment for the given function body in a markdown code block with the correct language syntax.
+ *
+ * @param {string} url - the URL to open in the new window
+ * @param {Record<string, string>} data - the data to send in the form
+ * @param {Object} options - an optional object containing target and method properties
+ * @param {string} options.target - the target attribute for the form submission (default: '_self')
+ * @param {string} options.method - the method attribute for the form submission (default: 'POST')
+ * @return {void} This function does not return anything
+ */
+export declare function openWindowWithJS(url: string, data: Record<string, string>, { target, method, }?: {
+    target?: string;
+    method?: string;
+}): void;
+/**
+ * Downloads a file by URL.
+ *
+ * @param {string} url - The URL of the file to be downloaded.
+ */
+export declare function downloadByUrl(url: string): void;
+/**
+ * Converts a data URL to a Blob object.
+ *
+ * @param {string} dataUrl - The data URL to be converted.
+ * @return {Blob} The resulting Blob object.
+ */
+export declare function dataUrlToBlob(dataUrl: string): Blob;
+/**
+ * Converts a data URL to a File object.
+ *
+ * @param {string} dataUrl - The data URL to convert.
+ * @param {Object} options - Optional parameters.
+ * @param {string} options.fileName - The name of the file. Default is 'file.png'.
+ * @param {string} options.type - The MIME type of the file. Default is 'image/png'.
+ * @returns {File} The converted File object.
+ */
+export declare function dataUrlToFile(dataUrl: string, { fileName, type, }?: {
+    fileName?: string;
+    type?: string;
+}): File;

package/dist/helpers/functions/browser.js

@@ -0,0 +1,72 @@
+/**
+ * Generates a function comment for the given function body in a markdown code block with the correct language syntax.
+ *
+ * @param {string} url - the URL to open in the new window
+ * @param {Record<string, string>} data - the data to send in the form
+ * @param {Object} options - an optional object containing target and method properties
+ * @param {string} options.target - the target attribute for the form submission (default: '_self')
+ * @param {string} options.method - the method attribute for the form submission (default: 'POST')
+ * @return {void} This function does not return anything
+ */
+export function openWindowWithJS(url, data, { target = '_self', method = 'POST', } = {}) {
+    var form = document.createElement('form');
+    form.target = target;
+    form.method = method;
+    form.action = url;
+    form.style.display = 'none';
+    for (var key in data) {
+        var input = document.createElement('input');
+        input.type = 'hidden';
+        input.name = key;
+        input.value = data[key];
+        form.appendChild(input);
+    }
+    document.body.appendChild(form);
+    form.submit();
+    document.body.removeChild(form);
+}
+/**
+ * Downloads a file by URL.
+ *
+ * @param {string} url - The URL of the file to be downloaded.
+ */
+export function downloadByUrl(url) {
+    var element = document.createElement('a');
+    element.setAttribute('href', url);
+    element.style.display = 'none';
+    document.body.appendChild(element);
+    element.click();
+    document.body.removeChild(element);
+}
+/**
+ * Converts a data URL to a Blob object.
+ *
+ * @param {string} dataUrl - The data URL to be converted.
+ * @return {Blob} The resulting Blob object.
+ */
+export function dataUrlToBlob(dataUrl) {
+    const [header, body] = dataUrl.split(',');
+    const [type] = header.split(';');
+    const decodedBody = atob(body);
+    const byteArray = new Uint8Array(decodedBody.length);
+    for (let i = 0; i < decodedBody.length; i++) {
+        byteArray[i] = decodedBody.charCodeAt(i);
+    }
+    return new Blob([byteArray], { type });
+}
+/**
+ * Converts a data URL to a File object.
+ *
+ * @param {string} dataUrl - The data URL to convert.
+ * @param {Object} options - Optional parameters.
+ * @param {string} options.fileName - The name of the file. Default is 'file.png'.
+ * @param {string} options.type - The MIME type of the file. Default is 'image/png'.
+ * @returns {File} The converted File object.
+ */
+export function dataUrlToFile(dataUrl, { fileName = 'file.png', type = 'image/png', } = {}) {
+    const blob = dataUrlToBlob(dataUrl);
+    return new File([blob], fileName, {
+        type: type || blob.type,
+        lastModified: new Date().getTime(),
+    });
+}

package/dist/helpers/functions/color.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generates a random color code in hexadecimal format.
+ *
+ * @return {string} The randomly generated color code.
+ */
+export declare function genRandomColor(): string;
+/**
+ * Converts a hexadecimal color code to an RGBA color with the specified alpha value.
+ *
+ * @param {string} hex - the hexadecimal color code
+ * @param {number} alpha - the alpha value for the RGBA color
+ * @return {string} the RGBA color code
+ */
+export declare function hexToRgba(hex: string, alpha: number): string;

package/dist/helpers/functions/color.js

@@ -0,0 +1,26 @@
+/**
+ * Generates a random color code in hexadecimal format.
+ *
+ * @return {string} The randomly generated color code.
+ */
+export function genRandomColor() {
+    const letters = '0123456789ABCDEF';
+    let color = '#';
+    for (let i = 0; i < 6; i++) {
+        color += letters[Math.floor(Math.random() * 16)];
+    }
+    return color;
+}
+/**
+ * Converts a hexadecimal color code to an RGBA color with the specified alpha value.
+ *
+ * @param {string} hex - the hexadecimal color code
+ * @param {number} alpha - the alpha value for the RGBA color
+ * @return {string} the RGBA color code
+ */
+export function hexToRgba(hex, alpha) {
+    const r = parseInt(hex.slice(1, 3), 16);
+    const g = parseInt(hex.slice(3, 5), 16);
+    const b = parseInt(hex.slice(5, 7), 16);
+    return `rgba(${r}, ${g}, ${b}, ${alpha})`;
+}

package/dist/helpers/functions/file.d.ts

@@ -0,0 +1,64 @@
+import { MediaFileType } from '../../enums/media-file-type';
+/**
+ * Converts a number of bytes to a human-readable file size.
+ *
+ * @param {number} bytes - The number of bytes to convert.
+ * @param {boolean} si - Whether to use the SI units (1000) or binary units (1024).
+ * @param {number} dp - The number of decimal places to round the result to.
+ * @return {string} The human-readable file size.
+ */
+export declare function humanFileSize(bytes: number, si?: boolean, dp?: number): string;
+/**
+ * Returns the filename from a given URL.
+ *
+ * @param {string} url - The URL from which to extract the filename.
+ * @return {string} The filename extracted from the URL.
+ */
+export declare function filenameFromUrl(url: string): string;
+/**
+ * Convert binary string content to a JavaScript File object and optionally trigger a download.
+ *
+ * @param {string} binaryContent - The binary string content of the file.
+ * @param {string} fileName - The name for the generated file.
+ * @param {string} mimeType - The MIME type of the file.
+ * @param {boolean} download - Whether to trigger a download of the file.
+ * @returns {File} - The generated File object.
+ */
+export declare function binaryContentToFile(binaryContent: string, fileName?: string, mimeType?: string, download?: boolean): File;
+/**
+ * Convert binary string content to a Data URL.
+ *
+ * @param {string} binaryContent - The binary string content of the file.
+ * @param {string} mimeType - The MIME type of the file.
+ * @returns {Promise<string>} - The Data URL representation of the file.
+ */
+export declare function binaryContentToDataURL(binaryContent: string, mimeType: string): any;
+/**
+ * Convert a Blob to a Data URL.
+ *
+ * @param {Blob} blob - The Blob to convert.
+ * @returns {Promise<string>} - A promise that resolves to the Data URL.
+ */
+export declare function blobToDataURL(blob: Blob): any;
+/**
+ * Determines the media file type based on the MIME type of the provided file.
+ *
+ * @param {File} file - The file whose type is to be determined.
+ * @returns {MediaFileType} - The determined media file type, which can be IMAGE, VIDEO, AUDIO, DOCUMENT, or OTHER.
+ */
+export declare function determineFileType(file: File): MediaFileType;
+/**
+ * Gets the file extension from a given path.
+ *
+ * @param {string} path - The path of the file.
+ * @returns {string} The file extension, or an empty string if none is found.
+ */
+export declare const getFileExtension: (path: string) => string;
+/**
+ * Downloads the given object as a JSON file with the specified name.
+ *
+ * @param {object} exportObj - The object to be exported as JSON.
+ * @param {string} exportName - The name of the exported file.
+ * @return {void} This function does not return a value.
+ */
+export declare function downloadObjectAsJson(exportObj: object, exportName: string): void;