@flocon-ai/react 0.0.1 → 0.0.2

package/dist/index.cjs

@@ -508,19 +508,18 @@ function removeTrailingSlash(url) {
 
 // src/client.ts
 var PACKAGES_API_URL = "https://api.flocon-ai.com";
-function createFloconClient() {
+function createFloconClient({ token = process.env.FLOCON_TOKEN } = {}) {
   if (typeof window !== "undefined") {
     throw new Error("Flocon: call this on the server only (route loader, server function), never in the browser");
   }
-  const token = process.env.FLOCON_TOKEN;
-  if (!token) throw new Error("FLOCON_TOKEN is missing");
+  if (!token) throw new Error("FLOCON_TOKEN is missing (or pass the `token` option)");
   return createClient({
     baseUrl: PACKAGES_API_URL,
     headers: { Authorization: `Bearer ${token}` }
   });
 }
-async function getPage({ path, locale }) {
-  const client = createFloconClient();
+async function getPage({ path, locale, token }) {
+  const client = createFloconClient({ token });
   const { data: website, error: websiteError } = await client.GET("/website");
   if (!website) throw new Error(`Flocon: could not load the website: ${JSON.stringify(websiteError)}`);
   const res = await client.GET("/pages/{locale}/{path}", {
@@ -537,14 +536,14 @@ async function getPage({ path, locale }) {
 }
 
 // src/pages.ts
-async function getAllPages() {
-  const { data, error } = await createFloconClient().GET("/pages");
+async function getAllPages(options = {}) {
+  const { data, error } = await createFloconClient(options).GET("/pages");
   if (!data) throw new Error(`Flocon getAllPages failed: ${JSON.stringify(error)}`);
   return data;
 }
 var xml = (s) => s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
-async function floconSitemap({ url }) {
-  const pages = await getAllPages();
+async function floconSitemap({ url, token }) {
+  const pages = await getAllPages({ token });
   const entries = pages.map((page) => {
     const links = [page.locale, ...page.alternates].map((l) => `<xhtml:link rel="alternate" hreflang="${xml(l)}" href="${xml(url({ locale: l, path: page.path }))}"/>`).join("");
     return `<url><loc>${xml(url(page))}</loc><lastmod>${xml(page.updatedAt)}</lastmod>${links}</url>`;
@@ -555,9 +554,13 @@ async function floconSitemap({ url }) {
 </urlset>
 `;
 }
-async function floconLlmsTxt({ url }) {
-  const pages = await getAllPages();
-  return pages.map((page) => `- [${page.title}](${url(page)})`).join("\n") + "\n";
+async function floconLlmsTxt({ url, token }) {
+  const [pages, website] = await Promise.all([getAllPages({ token }), createFloconClient({ token }).GET("/website")]);
+  if (!website.data) throw new Error(`Flocon floconLlmsTxt failed: ${JSON.stringify(website.error)}`);
+  const text = pages.map((page) => `- [${page.title}](${url(page)})`).join("\n") + "\n";
+  return website.data.badge ? `${text}
+Made with [Flocon AI](https://flocon-ai.com)
+` : text;
 }
 
 // src/markdown.tsx
@@ -762,7 +765,7 @@ function FloconPage({ page, url }) {
           return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("div", { className: "flocon-space", "aria-hidden": "true" }, i);
       }
     }),
-    page.badge && /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("p", { className: "flocon-badge", children: /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("a", { href: "https://flocon-ai.com", children: "\u2744 Made with Flocon AI" }) })
+    page.badge && /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("p", { className: "flocon-badge", children: /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("a", { href: "https://flocon-ai.com", children: "\u2744 Made with Flocon AI \xB7 flocon-ai.com" }) })
   ] });
 }
 
@@ -780,6 +783,8 @@ function getFloconMetadata({ page, url }) {
     title: page.seo.title,
     description: page.seo.description,
     keywords: page.seo.keywords,
+    /** Free plan: `<meta name="generator" content="Flocon AI">`. Put it in the `<head>`. */
+    ...page.badge && { generator: "Flocon AI" },
     canonical,
     /** hreflang: locale (or "x-default") → URL. */
     languages,

package/dist/index.d.cts

@@ -287,14 +287,18 @@ type FloconPageData = components["schemas"]["PackagesPage"] & {
     /** Website default locale. Used for `x-default` in the hreflang links. */
     defaultLocale?: string;
 };
-declare function createFloconClient(): openapi_fetch.Client<paths, `${string}/${string}`>;
-type GetPageOptions = {
+/** Optional on every helper that calls the Packages API. Not given = `FLOCON_TOKEN`. */
+type TokenOption = {
+    token?: string;
+};
+declare function createFloconClient({ token }?: TokenOption): openapi_fetch.Client<paths, `${string}/${string}`>;
+type GetPageOptions = TokenOption & {
     /** Page path, e.g. "/vs/notion". */
     path: string;
     /** Defaults to the website's default locale. No fallback to another locale. */
     locale?: string;
 };
-declare function getPage({ path, locale }: GetPageOptions): Promise<FloconPageData | null>;
+declare function getPage({ path, locale, token }: GetPageOptions): Promise<FloconPageData | null>;
 
 type PageEntry = components["schemas"]["PackagesSitemapEntry"];
 type UrlOption = {
@@ -302,10 +306,10 @@ type UrlOption = {
         locale: string;
         path: string;
     }) => string;
-};
-declare function getAllPages(): Promise<PageEntry[]>;
-declare function floconSitemap({ url }: UrlOption): Promise<string>;
-declare function floconLlmsTxt({ url }: UrlOption): Promise<string>;
+} & TokenOption;
+declare function getAllPages(options?: TokenOption): Promise<PageEntry[]>;
+declare function floconSitemap({ url, token }: UrlOption): Promise<string>;
+declare function floconLlmsTxt({ url, token }: UrlOption): Promise<string>;
 
 type Props = {
     /** Page data from `getPage()`. No fetching here. */
@@ -322,9 +326,6 @@ type Options = UrlOption & {
     page: FloconPageData;
 };
 declare function getFloconMetadata({ page, url }: Options): {
-    title: string;
-    description: string;
-    keywords: string[] | undefined;
     canonical: string;
     /** hreflang: locale (or "x-default") → URL. */
     languages: Record<string, string>;
@@ -340,6 +341,10 @@ declare function getFloconMetadata({ page, url }: Options): {
         title: string;
         description: string;
     };
+    generator?: string | undefined;
+    title: string;
+    description: string;
+    keywords: string[] | undefined;
 };
 
-export { FloconPage, type FloconPageData, type PageEntry, type UrlOption, type components, createFloconClient, floconLlmsTxt, floconSitemap, getAllPages, getFloconMetadata, getPage, type paths };
+export { FloconPage, type FloconPageData, type PageEntry, type TokenOption, type UrlOption, type components, createFloconClient, floconLlmsTxt, floconSitemap, getAllPages, getFloconMetadata, getPage, type paths };

package/dist/index.d.ts

@@ -287,14 +287,18 @@ type FloconPageData = components["schemas"]["PackagesPage"] & {
     /** Website default locale. Used for `x-default` in the hreflang links. */
     defaultLocale?: string;
 };
-declare function createFloconClient(): openapi_fetch.Client<paths, `${string}/${string}`>;
-type GetPageOptions = {
+/** Optional on every helper that calls the Packages API. Not given = `FLOCON_TOKEN`. */
+type TokenOption = {
+    token?: string;
+};
+declare function createFloconClient({ token }?: TokenOption): openapi_fetch.Client<paths, `${string}/${string}`>;
+type GetPageOptions = TokenOption & {
     /** Page path, e.g. "/vs/notion". */
     path: string;
     /** Defaults to the website's default locale. No fallback to another locale. */
     locale?: string;
 };
-declare function getPage({ path, locale }: GetPageOptions): Promise<FloconPageData | null>;
+declare function getPage({ path, locale, token }: GetPageOptions): Promise<FloconPageData | null>;
 
 type PageEntry = components["schemas"]["PackagesSitemapEntry"];
 type UrlOption = {
@@ -302,10 +306,10 @@ type UrlOption = {
         locale: string;
         path: string;
     }) => string;
-};
-declare function getAllPages(): Promise<PageEntry[]>;
-declare function floconSitemap({ url }: UrlOption): Promise<string>;
-declare function floconLlmsTxt({ url }: UrlOption): Promise<string>;
+} & TokenOption;
+declare function getAllPages(options?: TokenOption): Promise<PageEntry[]>;
+declare function floconSitemap({ url, token }: UrlOption): Promise<string>;
+declare function floconLlmsTxt({ url, token }: UrlOption): Promise<string>;
 
 type Props = {
     /** Page data from `getPage()`. No fetching here. */
@@ -322,9 +326,6 @@ type Options = UrlOption & {
     page: FloconPageData;
 };
 declare function getFloconMetadata({ page, url }: Options): {
-    title: string;
-    description: string;
-    keywords: string[] | undefined;
     canonical: string;
     /** hreflang: locale (or "x-default") → URL. */
     languages: Record<string, string>;
@@ -340,6 +341,10 @@ declare function getFloconMetadata({ page, url }: Options): {
         title: string;
         description: string;
     };
+    generator?: string | undefined;
+    title: string;
+    description: string;
+    keywords: string[] | undefined;
 };
 
-export { FloconPage, type FloconPageData, type PageEntry, type UrlOption, type components, createFloconClient, floconLlmsTxt, floconSitemap, getAllPages, getFloconMetadata, getPage, type paths };
+export { FloconPage, type FloconPageData, type PageEntry, type TokenOption, type UrlOption, type components, createFloconClient, floconLlmsTxt, floconSitemap, getAllPages, getFloconMetadata, getPage, type paths };

package/dist/index.js

@@ -476,19 +476,18 @@ function removeTrailingSlash(url) {
 
 // src/client.ts
 var PACKAGES_API_URL = "https://api.flocon-ai.com";
-function createFloconClient() {
+function createFloconClient({ token = process.env.FLOCON_TOKEN } = {}) {
   if (typeof window !== "undefined") {
     throw new Error("Flocon: call this on the server only (route loader, server function), never in the browser");
   }
-  const token = process.env.FLOCON_TOKEN;
-  if (!token) throw new Error("FLOCON_TOKEN is missing");
+  if (!token) throw new Error("FLOCON_TOKEN is missing (or pass the `token` option)");
   return createClient({
     baseUrl: PACKAGES_API_URL,
     headers: { Authorization: `Bearer ${token}` }
   });
 }
-async function getPage({ path, locale }) {
-  const client = createFloconClient();
+async function getPage({ path, locale, token }) {
+  const client = createFloconClient({ token });
   const { data: website, error: websiteError } = await client.GET("/website");
   if (!website) throw new Error(`Flocon: could not load the website: ${JSON.stringify(websiteError)}`);
   const res = await client.GET("/pages/{locale}/{path}", {
@@ -505,14 +504,14 @@ async function getPage({ path, locale }) {
 }
 
 // src/pages.ts
-async function getAllPages() {
-  const { data, error } = await createFloconClient().GET("/pages");
+async function getAllPages(options = {}) {
+  const { data, error } = await createFloconClient(options).GET("/pages");
   if (!data) throw new Error(`Flocon getAllPages failed: ${JSON.stringify(error)}`);
   return data;
 }
 var xml = (s) => s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
-async function floconSitemap({ url }) {
-  const pages = await getAllPages();
+async function floconSitemap({ url, token }) {
+  const pages = await getAllPages({ token });
   const entries = pages.map((page) => {
     const links = [page.locale, ...page.alternates].map((l) => `<xhtml:link rel="alternate" hreflang="${xml(l)}" href="${xml(url({ locale: l, path: page.path }))}"/>`).join("");
     return `<url><loc>${xml(url(page))}</loc><lastmod>${xml(page.updatedAt)}</lastmod>${links}</url>`;
@@ -523,9 +522,13 @@ async function floconSitemap({ url }) {
 </urlset>
 `;
 }
-async function floconLlmsTxt({ url }) {
-  const pages = await getAllPages();
-  return pages.map((page) => `- [${page.title}](${url(page)})`).join("\n") + "\n";
+async function floconLlmsTxt({ url, token }) {
+  const [pages, website] = await Promise.all([getAllPages({ token }), createFloconClient({ token }).GET("/website")]);
+  if (!website.data) throw new Error(`Flocon floconLlmsTxt failed: ${JSON.stringify(website.error)}`);
+  const text = pages.map((page) => `- [${page.title}](${url(page)})`).join("\n") + "\n";
+  return website.data.badge ? `${text}
+Made with [Flocon AI](https://flocon-ai.com)
+` : text;
 }
 
 // src/markdown.tsx
@@ -730,7 +733,7 @@ function FloconPage({ page, url }) {
           return /* @__PURE__ */ jsx2("div", { className: "flocon-space", "aria-hidden": "true" }, i);
       }
     }),
-    page.badge && /* @__PURE__ */ jsx2("p", { className: "flocon-badge", children: /* @__PURE__ */ jsx2("a", { href: "https://flocon-ai.com", children: "\u2744 Made with Flocon AI" }) })
+    page.badge && /* @__PURE__ */ jsx2("p", { className: "flocon-badge", children: /* @__PURE__ */ jsx2("a", { href: "https://flocon-ai.com", children: "\u2744 Made with Flocon AI \xB7 flocon-ai.com" }) })
   ] });
 }
 
@@ -748,6 +751,8 @@ function getFloconMetadata({ page, url }) {
     title: page.seo.title,
     description: page.seo.description,
     keywords: page.seo.keywords,
+    /** Free plan: `<meta name="generator" content="Flocon AI">`. Put it in the `<head>`. */
+    ...page.badge && { generator: "Flocon AI" },
     canonical,
     /** hreflang: locale (or "x-default") → URL. */
     languages,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flocon-ai/react",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Flocon AI pages for server-rendered React",
   "license": "UNLICENSED",
   "type": "module",