@degreesign/webapp 1.6.8

package/dist/src/types.d.ts

@@ -0,0 +1,262 @@
+import { ResolveOptions } from "webpack";
+import { Configuration, ModuleOptions } from "webpack";
+import CssMinimizerPlugin from "css-minimizer-webpack-plugin";
+export interface StringObj {
+    [key: string]: string;
+}
+export interface Page {
+    /** URI of the page */
+    uri: string;
+    /** Name of the page */
+    name: string;
+    /** Short name of the page (optional) */
+    short_name?: string;
+    /** Description of the page */
+    description: string;
+    /** Icon associated with the page (optional) */
+    icon?: string;
+    /**
+     * [Maskable] Icon associated with the page (optional)
+     *
+     * maskable icon should be centered in safe zone (inner 338x338 pixels of 512x512)
+     * prevents masking from cropping important elements
+    */
+    iconMaskable?: string;
+    /** Flag to indicate if the page is a shortcut (optional) */
+    shortcut?: boolean;
+    /** Flag to indicate if the page should be excluded from indexing (optional) */
+    noindex?: boolean;
+    /** Publication date of the page (optional) */
+    publishDate?: string;
+    /** URL or path to the cover image for the page (optional) */
+    coverImage?: string;
+    /** Description of the cover image (optional) */
+    coverImageDescription?: string;
+    /** Custom header HTML (optional) */
+    headerHTML?: string;
+    /** Custom menu HTML (optional) */
+    menuHTML?: string;
+    /** Custom footer HTML (optional) */
+    footerHTML?: string;
+    /** Custom body HTML Elements (optional) */
+    customHTML?: string[];
+    /** Page code has PHP */
+    isPHP?: boolean;
+    /** Page keywords comma separated (optional) */
+    keywords?: string;
+    /** Custom Canonical URL */
+    canonicalURL?: string;
+}
+export interface ConfigBase {
+    /** Source directory path */
+    srcDir: string;
+    /** Production directory path */
+    productionDir: string;
+    /** Application mode, either development or production */
+    mode?: 'development' | 'production';
+    /** Flag to enable or disable obfuscation */
+    obfuscateON?: boolean;
+    /** Flag to enable or disable JS code minimisation */
+    minimiseON?: boolean;
+    /** Port Number */
+    port?: number;
+    /** File Size (MB) */
+    maxFileSizeMB?: number;
+    /** Resolve Options */
+    resolveOptions?: ResolveOptions;
+    /** License Text */
+    licenseText?: string;
+    /** Show Packages Analyser Window */
+    openAnalyzer?: boolean;
+}
+export interface ConfigWebApp extends ConfigBase {
+    /** Name of the website */
+    websiteName: string;
+    /** Domain of the website */
+    websiteDomain: string;
+    /** Short name of the application */
+    appShortName: string;
+    /** Twitter username associated with the application */
+    twitterUserName: string;
+    /** Publication time of the website */
+    publishedTime: string;
+    /** Author of the website */
+    author: string;
+    /** Title of the website */
+    websiteTitle: string;
+    /** Description of the website */
+    websiteDescription: string;
+    /** URL or path to the cover image */
+    coverImage: string;
+    /** Description of the cover image */
+    coverImageDescription: string;
+    /** Background color for the application */
+    background_color: string;
+    /** Theme color for the application */
+    theme_color: string;
+    /** Path to the application icon */
+    appIcon: string;
+    /**
+     * Path to the application icon (maskable)
+     *
+     * maskable icon should be centered in safe zone (inner 338x338 pixels of 512x512)
+     * prevents masking from cropping important elements
+    */
+    appIconMaskable: string;
+    /** favicon file name or path */
+    fav_icon: string;
+    /** Orientation of the application, either portrait or landscape */
+    orientation: 'portrait' | 'landscape';
+    /** Pages list array */
+    pagesList: Page[];
+    /** Array of common HTML elements to include */
+    htmlCommonElements?: (`header` | `footer` | `menu`)[];
+    /** Assets directory path */
+    assetsDir: string;
+    /** Common directory path */
+    commonDir: string;
+    /** Images directory path */
+    imagesDir: string;
+    /** Pages directory path */
+    pagesDir: string;
+    /** Home page identifier or path */
+    pageHome: string;
+    /** Added to end of htaccess */
+    htaccessCustom: string;
+    /** App start URI */
+    startURI?: string;
+    /** App Language */
+    language?: string;
+    /** css Discard Unused */
+    cssDiscardUnused?: boolean;
+    /** Update service worker */
+    updateServiceWorker?: boolean;
+    /** Online reference file */
+    onlineIndicatorFile?: string;
+}
+export interface ConfigServer extends ConfigBase {
+    /** Server Files list */
+    filesList: string[];
+}
+export type ConfigBuild = {
+    type: `webapp`;
+} & ConfigWebApp | {
+    type: `server`;
+} & ConfigServer;
+/** Update Times */
+export interface UpdateTimes {
+    /** service worker */
+    serviceWorker?: number;
+}
+interface Icon {
+    /** Source URL or path to the icon */
+    src: string;
+    /** MIME type of the icon */
+    type: string;
+    /** Dimensions of the icon (e.g., '192x192') */
+    sizes: string;
+    /** Purpose of the icon, either maskable or any */
+    purpose: 'maskable' | 'any';
+}
+interface Shortcut {
+    /** Name of the shortcut */
+    name: string;
+    /** Short name of the shortcut */
+    short_name: string;
+    /** Description of the shortcut */
+    description: string;
+    /** URL the shortcut points to */
+    url: string;
+    /** Array of icons associated with the shortcut */
+    icons: Icon[];
+}
+export interface WebManifest {
+    /** Background color for the application */
+    background_color: string;
+    /** Theme color for the application */
+    theme_color: string;
+    /** Array of icons for the application */
+    icons: Icon[];
+    /** Array of shortcuts for the application */
+    shortcuts: Shortcut[];
+    /** Display mode for the application (e.g., 'standalone', 'fullscreen') */
+    display: string;
+    /** Orientation of the application, either portrait or landscape */
+    orientation: 'portrait' | 'landscape';
+    /** Short name of the application */
+    short_name: string;
+    /** Starting URL of the application */
+    start_url: string;
+    /** Description of the application */
+    description: string;
+    /** Full name of the application */
+    name: string;
+}
+type MetaTag = string | false | {
+    [attributeName: string]: string | boolean;
+};
+export interface MetaTags {
+    /** Dictionary of meta tags, where the key is the tag name and value is the tag content or attributes */
+    [key: string]: MetaTag;
+}
+export interface MetaTagsInput {
+    /** Author of the website */
+    author: string;
+    /** Description of the website */
+    websiteDescription: string;
+    /** Name of the website */
+    websiteName: string;
+    /** Title of the website */
+    websiteTitle: string;
+    /** URL or path to the cover image */
+    coverImageLink: string;
+    /** Description of the cover image */
+    coverImageDescription: string;
+    /** Publication time of the website */
+    publishedTime: string;
+    /** URL of the website */
+    websiteLink: string;
+    /** Data string for additional metadata */
+    dataString: string;
+    /** Theme color for the website */
+    theme_color: string;
+    /** Twitter username associated with the website */
+    twitterUserName: string;
+    /** Path to the application icon file */
+    appIconFile: string;
+    /** Flag to indicate if the page should be excluded from indexing (optional) */
+    noindex?: boolean;
+    /** Language of the website */
+    language: string;
+    /** check if home */
+    isHome: boolean;
+    /** Keywords (optional) */
+    keywords?: string;
+}
+export interface TemplateHTMLOptions {
+    /** HTML for link tags (optional) */
+    links?: string;
+    /** HTML for the header section (optional) */
+    headerHTML?: string;
+    /** Title of the page (optional) */
+    title?: string;
+    /** HTML for the menu section (optional) */
+    menuHTML?: string;
+    /** Custom HTML content (optional) */
+    bodyHTML?: string;
+    /** HTML for the page body (optional) */
+    pageBody?: string;
+    /** HTML for the footer section (optional) */
+    footerHTML?: string;
+}
+export interface HtmlContent {
+    id: string;
+    content: string;
+}
+export interface WebConfig {
+    entryPoints: StringObj;
+    customWebRules: ModuleOptions["rules"];
+    configWebPlugins: Configuration["plugins"];
+    cssMinimise: CssMinimizerPlugin<CssMinimizerPlugin.CssNanoOptionsExtended>[];
+}
+export {};

package/dist/src/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/utils.d.ts

@@ -0,0 +1,18 @@
+import { MetaTags, MetaTagsInput } from "./types";
+declare const 
+/** Write to files */
+writeData: (file: string, code: string) => boolean, 
+/** Write JSON files */
+writeJSON: (file: string, code: any) => boolean, 
+/** Read files */
+readData: (file: string, internal?: boolean) => string, 
+/** Read JSON files */
+readJSON: (file: string, internal?: boolean) => any, metaTags: ({ author, websiteDescription, websiteName, websiteTitle, coverImageLink, coverImageDescription, publishedTime, websiteLink, dataString, theme_color, twitterUserName, appIconFile, noindex, language, isHome, keywords, }: MetaTagsInput) => MetaTags, linkTags: ({ favIconFile, timeNow, coverImageLink, canonicalURL, }: {
+    coverImageLink: string;
+    favIconFile: string;
+    timeNow: number;
+    canonicalURL: string;
+}) => string, 
+/** Check for PHP tag */
+isPHPTag: (code: string) => boolean;
+export { writeData, writeJSON, readData, readJSON, metaTags, linkTags, isPHPTag, };

package/dist/src/utils.js

@@ -0,0 +1,276 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPHPTag = exports.linkTags = exports.metaTags = exports.readJSON = exports.readData = exports.writeJSON = exports.writeData = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const 
+/** Write to files */
+writeData = (file, code) => {
+    try {
+        return code ? (fs_1.default.writeFileSync(path_1.default.resolve(process.cwd(), file), code, `utf8`),
+            true) : (console.log(`no data to write to`, file),
+            false);
+    }
+    catch (e) {
+        console.log(`failed to write data to`, file);
+        return false;
+    }
+    ;
+}, 
+/** Write JSON files */
+writeJSON = (file, code) => {
+    try {
+        if (!code) {
+            console.log(`no JSON data to write to`, file);
+            return false;
+        }
+        ;
+        const data = JSON.stringify(code);
+        writeData(file, data);
+        return true;
+    }
+    catch (e) {
+        console.log(`failed to write JSON at`, file);
+        return false;
+    }
+    ;
+}, 
+/** Read files */
+readData = (file, internal) => {
+    try {
+        const filePath = internal ? path_1.default.join(__dirname, file)
+            : path_1.default.resolve(process.cwd(), file), data = fs_1.default.readFileSync(filePath, `utf8`);
+        if (!data) {
+            console.log(`no data to read at path`, filePath);
+            return ``;
+        }
+        ;
+        return data;
+    }
+    catch (e) {
+        console.log(`failed to read data at`, file);
+        return ``;
+    }
+    ;
+}, 
+/** Read JSON files */
+readJSON = (file, internal) => {
+    try {
+        const data = readData(file, internal);
+        return data ? JSON.parse(data) : undefined;
+    }
+    catch (e) {
+        console.log(`failed to read JSON at`, file);
+        return;
+    }
+    ;
+}, metaTags = ({ author, websiteDescription, websiteName, websiteTitle, coverImageLink, coverImageDescription, publishedTime, websiteLink, dataString, theme_color, twitterUserName, appIconFile, noindex, language, isHome, keywords, }) => {
+    const titleText = isHome ? `${websiteName} | ${websiteTitle}`
+        : `${websiteTitle} | ${websiteName}`;
+    return {
+        // Character Encoding and Content
+        charset: {
+            charset: 'UTF-8',
+        },
+        "http-equiv:content-type": {
+            "http-equiv": "Content-Type",
+            content: "text/html; charset=UTF-8",
+        },
+        // Viewport and Device Compatibility
+        viewport: `width=device-width, initial-scale=1.0`,
+        'http-equiv:X-UA-Compatible': {
+            'http-equiv': `X-UA-Compatible`,
+            content: `ie=edge`,
+        },
+        "mobile-web-app-capable": "yes",
+        "apple-mobile-web-app-capable": "yes",
+        "apple-mobile-web-app-status-bar-style": "black",
+        // SEO Indexing
+        robots: noindex ? `noindex` : `index,follow`,
+        referrer: "origin",
+        'googlebot-news': noindex ? `noindex` : `index,follow`,
+        // Name and Title
+        "apple-mobile-web-app-title": websiteName,
+        author,
+        description: websiteDescription,
+        ...keywords ? { keywords, news_keywords: keywords } : {},
+        // Open Graph (OG)
+        'og:type': {
+            property: 'og:type',
+            content: `website`,
+            name: `type`,
+        },
+        "og:locale": {
+            property: "og:locale",
+            content: language,
+        },
+        'og:title': {
+            property: 'og:title',
+            content: titleText,
+            name: `title`,
+        },
+        "og:site_name": {
+            property: "og:site_name",
+            content: websiteName,
+        },
+        'og:description': {
+            property: 'og:description',
+            content: `${websiteDescription}`,
+            name: `description`,
+        },
+        'og:publish_date': {
+            content: publishedTime,
+            property: `og:publish_date`,
+            name: `publish_date`,
+        },
+        'og:modified_date': {
+            content: dataString,
+            property: `og:modified_date`,
+            name: `modified_date`,
+        },
+        'og:url': {
+            content: websiteLink,
+            property: `og:url`,
+            name: `url`,
+        },
+        'og:image': {
+            property: 'og:image',
+            content: coverImageLink,
+            name: `image`,
+        },
+        "og:image:alt": {
+            property: "og:image:alt",
+            content: coverImageDescription,
+        },
+        // Twitter Tags
+        'twitter:card': {
+            property: 'twitter:card',
+            content: `summary_large_image`
+        },
+        'twitter:site': {
+            property: 'twitter:site',
+            content: `@${twitterUserName}`,
+        },
+        'twitter:title': {
+            property: 'twitter:title',
+            content: titleText
+        },
+        'twitter:description': {
+            property: 'twitter:description',
+            content: websiteDescription,
+        },
+        'twitter:image': {
+            property: 'twitter:image',
+            content: coverImageLink,
+        },
+        'twitter:image:alt': {
+            property: 'twitter:image:alt',
+            content: coverImageDescription,
+        },
+        // App Icons
+        "favicon-32": {
+            href: appIconFile,
+            rel: "icon",
+            type: "image/png",
+            sizes: "32x32",
+        },
+        "favicon-128": {
+            href: appIconFile,
+            rel: "icon",
+            type: "image/png",
+            sizes: "128x128",
+        },
+        "favicon-180": {
+            href: appIconFile,
+            rel: "icon",
+            type: "image/png",
+            sizes: "180x180",
+        },
+        "favicon-192": {
+            href: appIconFile,
+            rel: "icon",
+            type: "image/png",
+            sizes: "192x192",
+        },
+        "shortcut-icon-196": {
+            href: appIconFile,
+            rel: "shortcut icon",
+            type: "image/png",
+            sizes: "196x196",
+        },
+        "shortcut-icon-512": {
+            href: appIconFile,
+            rel: "shortcut icon",
+            type: "image/png",
+            sizes: "512x512",
+        },
+        "apple-touch-icon-120": {
+            href: appIconFile,
+            rel: "apple-touch-icon",
+            type: "image/png",
+            sizes: "120x120",
+        },
+        "apple-touch-icon-152": {
+            href: appIconFile,
+            rel: "apple-touch-icon",
+            type: "image/png",
+            sizes: "152x152",
+        },
+        "apple-touch-icon-180": {
+            href: appIconFile,
+            rel: "apple-touch-icon",
+            type: "image/png",
+            sizes: "180x180",
+        },
+        "apple-touch-icon-512": {
+            href: appIconFile,
+            rel: "apple-touch-icon",
+            type: "image/png",
+            sizes: "512x512",
+        },
+        // Image and Thumbnail
+        'article:published_time': {
+            property: 'article:published_time',
+            content: publishedTime
+        },
+        'article:modified_time': {
+            property: 'article:modified_time',
+            content: dataString
+        },
+        thumbnailUrl: {
+            itemprop: `thumbnailUrl`,
+            content: coverImageLink
+        },
+        image: {
+            itemprop: `image`,
+            content: coverImageLink
+        },
+        // Cache and Security
+        "http-equiv:cache-control": {
+            "http-equiv": "Cache-control",
+            content: "NO-STORE",
+        },
+        "http-equiv:content-security-policy": {
+            "http-equiv": "Content-Security-Policy",
+            content: "",
+        },
+        // Theme
+        "theme-color": theme_color,
+    };
+}, linkTags = ({ favIconFile, timeNow, coverImageLink, canonicalURL, }) => `
+        <link rel="icon" href="${favIconFile}" type="image/x-icon">
+        <link rel="manifest" href="/app.json?v=${timeNow}">
+        <link rel="image_src" href="${coverImageLink}">
+        <link rel="canonical" href="${canonicalURL}">\n`, 
+/** Check for PHP tag */
+isPHPTag = (code) => code?.includes(`<?php`);
+exports.writeData = writeData;
+exports.writeJSON = writeJSON;
+exports.readData = readData;
+exports.readJSON = readJSON;
+exports.metaTags = metaTags;
+exports.linkTags = linkTags;
+exports.isPHPTag = isPHPTag;

package/dist/src/web.d.ts

@@ -0,0 +1,2 @@
+import { ConfigWebApp, WebConfig } from "./types";
+export declare const webConfig: (params: ConfigWebApp) => WebConfig;