@cntrl-site/sdk 1.26.4 → 1.27.0

package/lib/Client/Client.d.ts

@@ -11,6 +11,7 @@ export declare class Client {
     private static getPageMeta;
     getPageData(pageSlug: string, buildMode?: 'default' | 'self-hosted'): Promise<CntrlPageData>;
     getProjectPagesPaths(): Promise<string[]>;
+    getProject(buildMode?: 'default' | 'self-hosted'): Promise<Project>;
     getLayouts(): Promise<Layout[]>;
     fetchCustomComponents(buildMode?: 'default' | 'self-hosted'): Promise<CustomComponentMeta[]>;
     fetchCustomComponentBundle(componentId: string, buildMode?: 'default' | 'self-hosted'): Promise<string>;

package/lib/Client/Client.js

@@ -70,6 +70,11 @@ class Client {
             }
         });
     }
+    getProject() {
+        return __awaiter(this, arguments, void 0, function* (buildMode = 'default') {
+            return this.fetchProject(buildMode);
+        });
+    }
     getLayouts() {
         return __awaiter(this, void 0, void 0, function* () {
             try {

package/lib/cli.js

@@ -46,6 +46,130 @@ commander_1.program
         process.exit(1);
     }
 }));
+commander_1.program
+    .command('generate-sitemap')
+    .description('Generate sitemap.xml and robots.txt for the published site')
+    .option('-o, --output <outputDir>', 'Output directory', 'public')
+    .option('-e, --env <envFilename>', 'Name of the .env file', '.env.local')
+    .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        (0, dotenv_1.config)({ path: options.env });
+        const apiUrl = process.env.CNTRL_API_URL;
+        if (!apiUrl) {
+            console.warn('[sitemap] CNTRL_API_URL is not set — skipping sitemap/robots generation.');
+            return;
+        }
+        const client = new Client_1.Client(apiUrl);
+        const project = yield client.getProject();
+        const siteUrl = resolveSiteUrl(project.primaryDomain, process.env.SITE_URL);
+        if (!siteUrl) {
+            console.warn('[sitemap] Could not resolve a canonical site URL — skipping sitemap/robots generation.\n' +
+                '          The project has no primary domain in the API response and SITE_URL is not set.\n' +
+                '          Either publish the site (so a primary domain exists) or set SITE_URL.');
+            return;
+        }
+        const indexable = project.pages.filter(isIndexablePage);
+        const lastmod = new Date().toISOString();
+        const outputDir = path_1.default.resolve(process.cwd(), options.output);
+        if (!fs_1.default.existsSync(outputDir)) {
+            fs_1.default.mkdirSync(outputDir, { recursive: true });
+        }
+        const sitemapPath = path_1.default.resolve(outputDir, 'sitemap.xml');
+        const robotsPath = path_1.default.resolve(outputDir, 'robots.txt');
+        fs_1.default.writeFileSync(sitemapPath, renderSitemap(indexable, siteUrl, lastmod));
+        fs_1.default.writeFileSync(robotsPath, renderRobots(siteUrl));
+        console.log(`Generated sitemap.xml at ${sitemapPath} (${indexable.length} of ${project.pages.length} pages)`);
+        console.log(`Generated robots.txt at ${robotsPath}`);
+    }
+    catch (error) {
+        console.warn(`[sitemap] Failed to generate sitemap/robots: ${(error === null || error === void 0 ? void 0 : error.message) || error}`);
+        console.warn('[sitemap] Continuing without updated sitemap.');
+    }
+}));
+function resolveSiteUrl(primaryDomain, override) {
+    const host = override || primaryDomain;
+    if (!host)
+        return null;
+    return parseAsUrl(host);
+}
+function isIndexablePage(page) {
+    if (typeof page.slug !== 'string')
+        return false;
+    if (page.isPublished === false)
+        return false;
+    if (page.isAuthProtected === true)
+        return false;
+    return true;
+}
+function renderSitemap(pages, siteUrl, lastmod) {
+    const entries = pages.map(page => {
+        const loc = escapeXml(buildPageUrl(siteUrl, page.slug));
+        const priority = page.slug === '' ? '1.00' : '0.80';
+        return [
+            '  <url>',
+            `    <loc>${loc}</loc>`,
+            `    <lastmod>${lastmod}</lastmod>`,
+            `    <priority>${priority}</priority>`,
+            '  </url>'
+        ].join('\n');
+    });
+    return [
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">',
+        ...entries,
+        '</urlset>',
+        ''
+    ].join('\n');
+}
+function renderRobots(siteUrl) {
+    const sitemapUrl = new URL('/sitemap.xml', siteUrl.origin).toString();
+    return [
+        'User-agent: *',
+        'Allow: /',
+        '',
+        `Sitemap: ${sitemapUrl}`,
+        ''
+    ].join('\n');
+}
+function buildPageUrl(siteUrl, slug) {
+    const base = new URL(siteUrl.href);
+    if (!base.pathname.endsWith('/'))
+        base.pathname += '/';
+    const relative = stripSlashes(slug);
+    const target = relative ? new URL(`${relative}/`, base) : base;
+    target.search = '';
+    target.hash = '';
+    return target.toString();
+}
+function parseAsUrl(input) {
+    var _a;
+    return (_a = tryParseUrl(input)) !== null && _a !== void 0 ? _a : tryParseUrl(`https://${input}`);
+}
+function tryParseUrl(input) {
+    try {
+        return new URL(input);
+    }
+    catch (_a) {
+        return null;
+    }
+}
+function stripSlashes(value) {
+    let start = 0;
+    let end = value.length;
+    while (start < end && value[start] === '/')
+        start += 1;
+    while (end > start && value[end - 1] === '/')
+        end -= 1;
+    return value.slice(start, end);
+}
+function escapeXml(value) {
+    return value
+        .replace(/&/g, '&amp;')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;')
+        .replace(/'/g, '&apos;');
+}
 function convertLayouts(layouts, maxLayoutWidth = Number.MAX_SAFE_INTEGER) {
     const sorted = layouts.slice().sort((la, lb) => la.startsWith - lb.startsWith);
     const mapped = sorted.map((layout, i, ls) => {

package/lib/schemas/project/Project.schema.d.ts

@@ -74,6 +74,8 @@ export declare const ProjectSchema: z.ZodObject<{
             keywords?: string | undefined;
         }>>;
         id: z.ZodString;
+        isPublished: z.ZodOptional<z.ZodBoolean>;
+        isAuthProtected: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         title: string;
@@ -86,6 +88,8 @@ export declare const ProjectSchema: z.ZodObject<{
             opengraphThumbnail?: string | undefined;
             keywords?: string | undefined;
         } | undefined;
+        isPublished?: boolean | undefined;
+        isAuthProtected?: boolean | undefined;
     }, {
         id: string;
         title: string;
@@ -98,6 +102,8 @@ export declare const ProjectSchema: z.ZodObject<{
             opengraphThumbnail?: string | undefined;
             keywords?: string | undefined;
         } | undefined;
+        isPublished?: boolean | undefined;
+        isAuthProtected?: boolean | undefined;
     }>, "many">;
     fonts: z.ZodObject<{
         google: z.ZodString;
@@ -158,6 +164,7 @@ export declare const ProjectSchema: z.ZodObject<{
         google: string;
         adobe: string;
     }>;
+    primaryDomain: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     html: {
         head: string;
@@ -190,6 +197,8 @@ export declare const ProjectSchema: z.ZodObject<{
             opengraphThumbnail?: string | undefined;
             keywords?: string | undefined;
         } | undefined;
+        isPublished?: boolean | undefined;
+        isAuthProtected?: boolean | undefined;
     }[];
     fonts: {
         custom: {
@@ -204,6 +213,7 @@ export declare const ProjectSchema: z.ZodObject<{
         google: string;
         adobe: string;
     };
+    primaryDomain?: string | null | undefined;
 }, {
     html: {
         head: string;
@@ -236,6 +246,8 @@ export declare const ProjectSchema: z.ZodObject<{
             opengraphThumbnail?: string | undefined;
             keywords?: string | undefined;
         } | undefined;
+        isPublished?: boolean | undefined;
+        isAuthProtected?: boolean | undefined;
     }[];
     fonts: {
         custom: {
@@ -250,4 +262,5 @@ export declare const ProjectSchema: z.ZodObject<{
         google: string;
         adobe: string;
     };
+    primaryDomain?: string | null | undefined;
 }>;

package/lib/schemas/project/Project.schema.js

@@ -30,7 +30,9 @@ exports.ProjectSchema = zod_1.z.object({
             keywords: zod_1.z.string().optional(),
             enabled: zod_1.z.boolean()
         }).optional(),
-        id: zod_1.z.string().min(1)
+        id: zod_1.z.string().min(1),
+        isPublished: zod_1.z.boolean().optional(),
+        isAuthProtected: zod_1.z.boolean().optional()
     })),
     fonts: zod_1.z.object({
         google: zod_1.z.string(),
@@ -44,5 +46,6 @@ exports.ProjectSchema = zod_1.z.object({
                 url: zod_1.z.string()
             }))
         }))
-    })
+    }),
+    primaryDomain: zod_1.z.string().nullable().optional()
 });

package/lib/types/project/Page.d.ts

@@ -8,4 +8,6 @@ export interface Page {
     articleId: string;
     slug: string;
     meta?: PageMeta;
+    isPublished?: boolean;
+    isAuthProtected?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "1.26.4",
+  "version": "1.27.0",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",