studiocms 0.1.0-beta.10

package/dist/lib/robots/types.d.ts

@@ -0,0 +1,185 @@
+export type SearchEngines = {
+    360: '360Spider' | '360Spider-Image' | '360Spider-Video' | 'HaoSouSpider';
+    Apple: 'Applebot' | 'AppleNewsBot';
+    Baidu: 'Baiduspider' | 'Baiduspider-image' | 'Baiduspider-mobile' | 'Baiduspider-news' | 'Baiduspider-video';
+    Bing: 'bingbot' | 'BingPreview' | 'msnbot' | 'msnbot-media' | 'adidxbot' | 'MSN';
+    Bublup: 'BublupBot';
+    Cliqz: 'Cliqzbot';
+    Coccoc: 'coccoc' | 'coccocbot-image' | 'coccocbot-web';
+    Daumoa: 'Daumoa';
+    Dazoo: 'DeuSu';
+    Duckduckgo: 'DuckDuckBot' | 'DuckDuckGo-Favicons-Bot';
+    Eurip: 'EuripBot';
+    Exploratodo: 'Exploratodo';
+    Findx: 'Findxbot';
+    Goo: 'gooblog' | 'ichiro';
+    Google: 'Googlebot' | 'Googlebot-Image' | 'Googlebot-Mobile' | 'Googlebot-News' | 'Googlebot-Video' | 'Mediapartners-Google' | 'AdsBot-Google' | 'AdsBot-Google-Mobile' | 'AdsBot-Google-Mobile-Apps' | 'Mediapartners-Google' | 'Storebot-Google' | 'Google-InspectionTool' | 'FeedFetcher-Google';
+    Istella: 'istellabot';
+    Jike: 'JikeSpider';
+    Lycos: 'Lycos';
+    Mail: 'Mail.Ru';
+    Mojeek: 'MojeekBot';
+    Orange: 'OrangeBot';
+    Botje: 'Plukkie';
+    Qwant: 'Qwantify';
+    Rambler: 'Rambler';
+    Seznam: 'SeznamBot';
+    Soso: 'Sosospider';
+    Yahoo: 'Slurp';
+    Sogou: 'Sogou blog' | 'Sogou inst spider' | 'Sogou News Spider' | 'Sogou Orion spider' | 'Sogou spider2' | 'Sogou web spider';
+    Sputnik: 'SputnikBot';
+    Ask: 'Teoma';
+    Wortbox: 'wotbox';
+    Yandex: 'Yandex' | 'YandexMobileBot';
+    Naver: 'Yeti';
+    Yioop: 'YioopBot';
+    Yooz: 'yoozBot';
+    Youdao: 'YoudaoBot';
+};
+export type SocialNetwork = {
+    Facebook: 'facebookcatalog' | 'facebookexternalhit' | 'Facebot';
+    Pinterest: 'Pinterest';
+    Tittwer: 'Twitterbot';
+    WhatsApp: 'WhatsApp';
+    LinkedIn: 'LinkedInBot';
+};
+export type SearchEngineOptimization = {
+    Ahrefs: 'AhrefsBot';
+    Moz: 'Moz dotbot' | 'Moz rogerbot';
+    WebMeUp: 'BLEXBot';
+    Botify: 'Botify';
+    Babbar: 'Barkrowler';
+    SEMrush: 'SEMrush' | 'SemrushBotSI';
+    Cxense: 'Cxense';
+    EzoicInc: 'EzoicBot';
+    DataForSEO: 'DataForSEO';
+    PrerenderLLC: 'prerender';
+};
+export type UserAgentType = '*' | SearchEngines[keyof SearchEngines] | SocialNetwork[keyof SocialNetwork] | SearchEngineOptimization[keyof SearchEngineOptimization];
+export interface RobotsConfig {
+    /**
+     * @default false
+     * @description
+     * [ Optional ] Some crawlers(Yandex) support and only accept domain names.
+     * @example
+     * ```ts
+     * integrations:[
+     *  robots({
+     *    host: siteUrl.replace(/^https?:\/\/|:\d+/g, "")
+     *  })
+     * ]
+     * ```
+     */
+    host?: boolean | string;
+    /**
+     * @description
+     * [ Optional, zero or more per file ] The location of a sitemap for this website.
+     * @example
+     * ```ts
+     * sitemap: [
+     *  "https://example.com/sitemap.xml",
+     *  "https://www.example.com/sitemap.xml"
+     * ]
+     * ```
+     * The value of the [SITEMAP](https://developers.google.com/search/docs/crawling-indexing/robots/robots_txt#sitemap) field is case-sensitive.
+     */
+    sitemap?: boolean | string | string[];
+    /**
+     * @description
+     * [ Optional ] List of `policy` rules.
+     * @default
+     * ```ts
+     * policy:[
+     *  {
+     *    userAgent: "*",
+     *    allow: "/"
+     *  }
+     * ]
+     * ```
+     * For more help, refer to [SYNTAX](https://yandex.com/support/webmaster/controlling-robot/robots-txt.html#recommend) by Yandex.
+     */
+    policy?: PolicyOptions[] | undefined;
+}
+export interface PolicyOptions {
+    /**
+     * @description
+     * [ Required ] Indicates the robot to which the rules listed in `robots.txt` apply.
+     * @example
+     * ```ts
+     * policy:[
+     *  {
+     *    userAgent: [
+     *      'Googlebot',
+     *      'Applebot',
+     *      'Baiduspider',
+     *      'bingbot'
+     *    ],
+     *    // crawling rule(s) for above bots
+     *  }
+     * ]
+     * ```
+     * Verified bots, refer to [DITIG](https://www.ditig.com/robots-txt-template#regular-template) or [Cloudflare Radar](https://radar.cloudflare.com/traffic/verified-bots).
+     */
+    userAgent?: UserAgentType | UserAgentType[];
+    /**
+     * @description
+     * [ At least one or more `allow` or `disallow` entries per rule ] Allows indexing site sections or individual pages.
+     * @example
+     * ```ts
+     * policy:[{allow:["/"]}]
+     * ```
+     * Path-based URL matching, refer to [SYNTAX](https://developers.google.com/search/docs/crawling-indexing/robots/robots_txt#url-matching-based-on-path-values) via Google.
+     */
+    allow?: string | string[];
+    /**
+     * @description
+     * [ At least one or more `disallow` or `allow` entries per rule ] Prohibits indexing site sections or individual pages.
+     * @example
+     * ```ts
+     * policy:[
+     *  {
+     *    disallow:[
+     *      "/admin",
+     *      "/uploads/1989-08-21/*.jpg$"
+     *    ]
+     *  }
+     * ]
+     * ```
+     * Path-based URL matching, refer to [SYNTAX](https://developers.google.com/search/docs/crawling-indexing/robots/robots_txt#url-matching-based-on-path-values) via Google.
+     */
+    disallow?: string | string[];
+    /**
+     * @description
+     * [ Optional ] Specifies the minimum interval (in seconds) for the search robot to wait after loading one page, before starting to load another.
+     *
+     * @example
+     * ```ts
+     * policy:[{crawlDelay:5}]
+     * ```
+     * About the [Crawl-delay](https://yandex.com/support/webmaster/robot-workings/crawl-delay.html#crawl-delay) directive.
+     */
+    crawlDelay?: number;
+    /**
+     * @description
+     * [ Optional ] Indicates to the robot that the page URL contains parameters (like UTM tags) that should be ignored when indexing it.
+     *
+     * @example
+     * ```bash
+     * # for URLs like:
+     * www.example2.com/index.php?page=1&sid=2564126ebdec301c607e5df
+     * www.example2.com/index.php?page=1&sid=974017dcd170d6c4a5d76ae
+     * ```
+     * ```ts
+     * policy:[
+     *  {
+     *    cleanParam: [
+     *      "sid /index.php",
+     *    ]
+     *  }
+     * ]
+     * ```
+     * For additional examples, please consult
+     * Yandex's [SYNTAX](https://yandex.com/support/webmaster/robot-workings/clean-param.html#clean-param__additional) guide.
+     */
+    cleanParam?: string | string[];
+}

package/dist/lib/robots/utils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Reads a JSON file from the specified path and parses its content.
+ *
+ * @template T - The type of the parsed JSON object.
+ * @param {string | URL} path - The path to the JSON file.
+ * @returns {T} The parsed JSON object.
+ */
+export declare function readJson<T>(path: string | URL): T;
+/**
+ * Measures the execution time of a given callback function.
+ *
+ * @param callback - The function whose execution time is to be measured.
+ * @returns The execution time of the callback function in milliseconds.
+ */
+export declare function measureExecutionTime(callback: () => void): number;
+/**
+ * Calculates the size of a file in kilobytes.
+ *
+ * @param filename - The URL of the file to get the size of.
+ * @returns The size of the file in kilobytes.
+ */
+export declare function getFileSizeInKilobytes(filename: URL): number;

package/dist/lib/robots/utils.js

@@ -0,0 +1,22 @@
+import fs from "node:fs";
+function readJson(path) {
+  return JSON.parse(fs.readFileSync(path, "utf-8"));
+}
+function measureExecutionTime(callback) {
+  const startTime = performance.now();
+  callback();
+  const endTime = performance.now();
+  const executionTime = Math.floor(endTime - startTime);
+  return executionTime;
+}
+function getFileSizeInKilobytes(filename) {
+  const stats = fs.statSync(filename);
+  const fileSizeInBytes = stats.size;
+  const fileSizeInKilobytes = fileSizeInBytes / 1024;
+  return fileSizeInKilobytes;
+}
+export {
+  getFileSizeInKilobytes,
+  measureExecutionTime,
+  readJson
+};

package/dist/lib/routeMap.d.ts

@@ -0,0 +1,257 @@
+/**
+ * Generates a slugged route by appending the provided slug to the given URL.
+ *
+ * @param url - The base URL to which the slug will be appended.
+ * @param slug - The slug to append to the base URL.
+ * @returns The complete slugged route as a string.
+ */
+export declare function getSluggedRoute(url: string, slug: string): string;
+/**
+ * Generates the edit route for a given page slug.
+ *
+ * @param slug - The slug of the page to generate the edit route for.
+ * @returns The edit route as a string.
+ */
+export declare function getEditRoute(slug: string): string;
+/**
+ * Generates a delete route for a given page slug.
+ *
+ * @param slug - The slug of the page to be deleted.
+ * @returns The complete delete route for the specified page.
+ */
+export declare function getDeleteRoute(slug: string): string;
+/**
+ * Generates a non-dashboard route URL.
+ *
+ * @param route - The optional route string to be appended. If not provided, a default route will be used.
+ * @returns The generated non-dashboard route URL as a string.
+ */
+export declare function makeNonDashboardRoute(route?: string | undefined): string;
+/**
+ * Generates a URL for the dashboard route.
+ *
+ * @param route - An optional string representing the specific route to append to the dashboard URL.
+ * @returns The generated dashboard URL as a string.
+ */
+export declare function makeDashboardRoute(route?: string | undefined): string;
+/**
+ * An object containing various route mappings for the StudioCMS application.
+ */
+export declare const StudioCMSRoutes: {
+    mainLinks: {
+        /**
+         * Base URL for the non-dashboard site.
+         */
+        baseSiteURL: string;
+        /**
+         * URL for the dashboard index.
+         */
+        dashboardIndex: string;
+        /**
+         * URL for the user profile page.
+         */
+        userProfile: string;
+        /**
+         * URL for the content management page.
+         */
+        contentManagement: string;
+        /**
+         * URL for creating content in the content management page.
+         */
+        contentManagementCreate: string;
+        /**
+         * URL for editing content in the content management page.
+         */
+        contentManagementEdit: string;
+        /**
+         * URL for creating a folder in the content management page.
+         */
+        contentManagementFolderCreate: string;
+        /**
+         * URL for editing a folder in the content management page.
+         */
+        contentManagementFolderEdit: string;
+        /**
+         * URL for viewing content differences in the content management page.
+         */
+        contentManagementDiff: string;
+        /**
+         * URL for creating a new page.
+         */
+        createPage: string;
+        /**
+         * URL for the site configuration page.
+         */
+        siteConfiguration: string;
+        /**
+         * URL for the user management page.
+         */
+        userManagement: string;
+        /**
+         * URL for editing user management details.
+         */
+        userManagementEdit: string;
+        /**
+         * URL for the plugins page.
+         */
+        plugins: string;
+    };
+    authLinks: {
+        /**
+         * URL for the login page.
+         */
+        loginURL: string;
+        /**
+         * URL for the logout page.
+         */
+        logoutURL: string;
+        /**
+         * URL for the signup page.
+         */
+        signupURL: string;
+        /**
+         * API route for logging in.
+         */
+        loginAPI: string;
+        /**
+         * API route for logging out.
+         */
+        logoutAPI: string;
+        /**
+         * API route for registering a new user.
+         */
+        registerAPI: string;
+        /**
+         * API route for GitHub authentication index.
+         */
+        githubIndex: string;
+        /**
+         * API route for GitHub authentication callback.
+         */
+        githubCallback: string;
+        /**
+         * API route for Discord authentication index.
+         */
+        discordIndex: string;
+        /**
+         * API route for Discord authentication callback.
+         */
+        discordCallback: string;
+        /**
+         * API route for Google authentication index.
+         */
+        googleIndex: string;
+        /**
+         * API route for Google authentication callback.
+         */
+        googleCallback: string;
+        /**
+         * API route for Auth0 authentication index.
+         */
+        auth0Index: string;
+        /**
+         * API route for Auth0 authentication callback.
+         */
+        auth0Callback: string;
+    };
+    endpointLinks: {
+        /**
+         * API route for searching lists.
+         */
+        searchList: string;
+        partials: {
+            /**
+             * API route for live preview box rendering.
+             */
+            livePreviewBox: string;
+            /**
+             * API route for fetching user list items.
+             */
+            userListItems: string;
+            /**
+             * API route for rendering content.
+             */
+            render: string;
+            /**
+             * API route for the editor.
+             */
+            editor: string;
+        };
+        /**
+         * API route for fetching configuration.
+         */
+        config: string;
+        /**
+         * API route for fetching users.
+         */
+        users: string;
+        /**
+         * API route for fetching user profile.
+         */
+        profile: string;
+        /**
+         * API route for creating a password reset link.
+         */
+        createResetLink: string;
+        /**
+         * API route for resetting password.
+         */
+        resetPassword: string;
+        content: {
+            /**
+             * API route for fetching page content.
+             */
+            page: string;
+            /**
+             * API route for fetching folder content.
+             */
+            folder: string;
+        };
+        /**
+         * API route for fetching plugins.
+         */
+        plugins: string;
+        newUsers: {
+            /**
+             * API route for creating a new user.
+             */
+            create: string;
+            /**
+             * API route for inviting a new user.
+             */
+            invite: string;
+        };
+        /**
+         * API route for fetching API tokens.
+         */
+        apiTokens: string;
+        /**
+         * API route for verifying a user session.
+         */
+        verifySession: string;
+    };
+    sdk: {
+        /**
+         * SDK route for listing pages.
+         */
+        pages: string;
+        /**
+         * SDK route for fetching fallback list of pages.
+         */
+        fallback_pages: string;
+        /**
+         * SDK route for updating the latest version cache.
+         */
+        updateLatestVersionCache: string;
+    };
+    fts: {
+        /**
+         * API route for step 1 of the FTS process.
+         */
+        step1: string;
+        /**
+         * API route for step 2 of the FTS process.
+         */
+        step2: string;
+    };
+};