@cavuno/board 1.1.0 → 1.2.0

package/dist/index.d.mts

@@ -345,6 +345,27 @@ interface PublicBoard {
     theme: PublicBoardTheme | null;
 }
 
+/**
+ * The public SEO-infra payload (`board.seo()`). The four values a headless
+ * frontend rebuilds `robots.txt` / `ads.txt` / `indexnow-key.txt` (+ the Google
+ * site-verification `<meta>`) from — byte-identically to the hosted board.
+ */
+interface BoardSeo {
+    object: 'board_seo';
+    /** Verbatim `ads.txt` content, or `null` when not configured (the handler 404s). */
+    adsTxt: string | null;
+    /** IndexNow key-file content, or `null` when not configured (the handler 404s). */
+    indexNowKey: string | null;
+    /** Google site-verification token for the `<meta>` tag, or `null`. */
+    googleSiteVerification: string | null;
+    /**
+     * The board's canonical base URL (honours a configured custom domain). Build
+     * the `robots.txt` `Sitemap:` line (`${canonicalBase}/sitemap.xml`) and
+     * canonical links from it — NOT the request origin.
+     */
+    canonicalBase: string;
+}
+
 /**
  * Error raised for every non-2xx Board API response.
  *
@@ -392,7 +413,7 @@ declare function isConflict(e: unknown): e is BoardApiError;
  * constant because the package is platform-neutral and cannot read
  * package.json at runtime.
  */
-declare const SDK_VERSION = "1.1.0";
+declare const SDK_VERSION = "1.2.0";
 
 interface BoardUser {
     id: string;
@@ -443,6 +464,19 @@ interface ResetPasswordBody {
     password: string;
 }
 
+/**
+ * The result of resolving a path against the board's configured redirects
+ * (`board.redirects.resolve()`). A headless frontend 308s to `target`, or 404s
+ * when it's `null`.
+ */
+interface RedirectResolution {
+    object: 'redirect_resolution';
+    /** The path that was resolved. */
+    path: string;
+    /** The redirect target (board-relative), or `null` when no redirect matches. */
+    target: string | null;
+}
+
 /** Author shape embedded on posts (no `object` discriminator). */
 interface BlogAuthorEmbed {
     id: string;
@@ -652,6 +686,15 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
      * const { name, theme } = await board.context();
      */
     context(options?: FetchOptions): Promise<PublicBoard>;
+    /**
+     * Board SEO infra — `ads.txt`, IndexNow key, Google site-verification, and
+     * the canonical base URL. Rebuild `robots.txt` / `ads.txt` /
+     * `indexnow-key.txt` from it.
+     *
+     * @example
+     * const { adsTxt, canonicalBase } = await board.seo();
+     */
+    seo(options?: FetchOptions): Promise<BoardSeo>;
     jobs: {
         list(query?: JobsListQuery, options?: FetchOptions): Promise<JobCardListEnvelope>;
         retrieve(jobSlug: string, query?: Record<string, never>, options?: FetchOptions): Promise<PublicJob>;
@@ -708,7 +751,10 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
             resolve(slug: string, options?: FetchOptions): Promise<TaxonomyResolution>;
         };
     };
+    redirects: {
+        resolve(path: string, options?: FetchOptions): Promise<RedirectResolution>;
+    };
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type Awaitable, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogTagEmbed, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardUser, type CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicJob, type PublicJobCard, type PublicPlace, REFRESH_TOKEN_KEY, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ResetPasswordBody, SDK_VERSION, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type VerifyEmailBody, createBoardClient, isBoardApiError, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type Awaitable, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogTagEmbed, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicJob, type PublicJobCard, type PublicPlace, REFRESH_TOKEN_KEY, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ResetPasswordBody, SDK_VERSION, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type VerifyEmailBody, createBoardClient, isBoardApiError, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };

package/dist/index.d.ts

@@ -345,6 +345,27 @@ interface PublicBoard {
     theme: PublicBoardTheme | null;
 }
 
+/**
+ * The public SEO-infra payload (`board.seo()`). The four values a headless
+ * frontend rebuilds `robots.txt` / `ads.txt` / `indexnow-key.txt` (+ the Google
+ * site-verification `<meta>`) from — byte-identically to the hosted board.
+ */
+interface BoardSeo {
+    object: 'board_seo';
+    /** Verbatim `ads.txt` content, or `null` when not configured (the handler 404s). */
+    adsTxt: string | null;
+    /** IndexNow key-file content, or `null` when not configured (the handler 404s). */
+    indexNowKey: string | null;
+    /** Google site-verification token for the `<meta>` tag, or `null`. */
+    googleSiteVerification: string | null;
+    /**
+     * The board's canonical base URL (honours a configured custom domain). Build
+     * the `robots.txt` `Sitemap:` line (`${canonicalBase}/sitemap.xml`) and
+     * canonical links from it — NOT the request origin.
+     */
+    canonicalBase: string;
+}
+
 /**
  * Error raised for every non-2xx Board API response.
  *
@@ -392,7 +413,7 @@ declare function isConflict(e: unknown): e is BoardApiError;
  * constant because the package is platform-neutral and cannot read
  * package.json at runtime.
  */
-declare const SDK_VERSION = "1.1.0";
+declare const SDK_VERSION = "1.2.0";
 
 interface BoardUser {
     id: string;
@@ -443,6 +464,19 @@ interface ResetPasswordBody {
     password: string;
 }
 
+/**
+ * The result of resolving a path against the board's configured redirects
+ * (`board.redirects.resolve()`). A headless frontend 308s to `target`, or 404s
+ * when it's `null`.
+ */
+interface RedirectResolution {
+    object: 'redirect_resolution';
+    /** The path that was resolved. */
+    path: string;
+    /** The redirect target (board-relative), or `null` when no redirect matches. */
+    target: string | null;
+}
+
 /** Author shape embedded on posts (no `object` discriminator). */
 interface BlogAuthorEmbed {
     id: string;
@@ -652,6 +686,15 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
      * const { name, theme } = await board.context();
      */
     context(options?: FetchOptions): Promise<PublicBoard>;
+    /**
+     * Board SEO infra — `ads.txt`, IndexNow key, Google site-verification, and
+     * the canonical base URL. Rebuild `robots.txt` / `ads.txt` /
+     * `indexnow-key.txt` from it.
+     *
+     * @example
+     * const { adsTxt, canonicalBase } = await board.seo();
+     */
+    seo(options?: FetchOptions): Promise<BoardSeo>;
     jobs: {
         list(query?: JobsListQuery, options?: FetchOptions): Promise<JobCardListEnvelope>;
         retrieve(jobSlug: string, query?: Record<string, never>, options?: FetchOptions): Promise<PublicJob>;
@@ -708,7 +751,10 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
             resolve(slug: string, options?: FetchOptions): Promise<TaxonomyResolution>;
         };
     };
+    redirects: {
+        resolve(path: string, options?: FetchOptions): Promise<RedirectResolution>;
+    };
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type Awaitable, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogTagEmbed, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardUser, type CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicJob, type PublicJobCard, type PublicPlace, REFRESH_TOKEN_KEY, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ResetPasswordBody, SDK_VERSION, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type VerifyEmailBody, createBoardClient, isBoardApiError, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type Awaitable, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogTagEmbed, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicJob, type PublicJobCard, type PublicPlace, REFRESH_TOKEN_KEY, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ResetPasswordBody, SDK_VERSION, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type VerifyEmailBody, createBoardClient, isBoardApiError, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };

package/dist/index.js

@@ -143,7 +143,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.1.0";
+var SDK_VERSION = "1.2.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -625,6 +625,26 @@ function meNamespace(client) {
   };
 }
 
+// src/namespaces/redirects.ts
+function redirectsNamespace(client) {
+  return {
+    /**
+     * Resolve a board-relative path against the board's configured redirects —
+     * the same resolution the hosted board's catch-all performs. 308 to
+     * `target`, or 404 when `target` is `null`.
+     *
+     * @example
+     * const { target } = await board.redirects.resolve('/old-jobs')
+     */
+    resolve(path, options) {
+      return client.fetch("/redirects/resolve", {
+        ...options,
+        query: { path }
+      });
+    }
+  };
+}
+
 // src/namespaces/taxonomy.ts
 function taxonomyResolver(client, kind) {
   return {
@@ -681,11 +701,23 @@ function createBoardClient(options) {
     context(options2) {
       return client.fetch("", options2);
     },
+    /**
+     * Board SEO infra — `ads.txt`, IndexNow key, Google site-verification, and
+     * the canonical base URL. Rebuild `robots.txt` / `ads.txt` /
+     * `indexnow-key.txt` from it.
+     *
+     * @example
+     * const { adsTxt, canonicalBase } = await board.seo();
+     */
+    seo(options2) {
+      return client.fetch("/seo", options2);
+    },
     jobs: jobsNamespace(client),
     companies: companiesNamespace(client),
     blog: blogNamespace(client),
     auth: authNamespace(client),
     me: meNamespace(client),
-    taxonomy: taxonomyNamespace(client)
+    taxonomy: taxonomyNamespace(client),
+    redirects: redirectsNamespace(client)
   };
 }

package/dist/index.mjs

@@ -105,7 +105,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.1.0";
+var SDK_VERSION = "1.2.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -587,6 +587,26 @@ function meNamespace(client) {
   };
 }
 
+// src/namespaces/redirects.ts
+function redirectsNamespace(client) {
+  return {
+    /**
+     * Resolve a board-relative path against the board's configured redirects —
+     * the same resolution the hosted board's catch-all performs. 308 to
+     * `target`, or 404 when `target` is `null`.
+     *
+     * @example
+     * const { target } = await board.redirects.resolve('/old-jobs')
+     */
+    resolve(path, options) {
+      return client.fetch("/redirects/resolve", {
+        ...options,
+        query: { path }
+      });
+    }
+  };
+}
+
 // src/namespaces/taxonomy.ts
 function taxonomyResolver(client, kind) {
   return {
@@ -643,12 +663,24 @@ function createBoardClient(options) {
     context(options2) {
       return client.fetch("", options2);
     },
+    /**
+     * Board SEO infra — `ads.txt`, IndexNow key, Google site-verification, and
+     * the canonical base URL. Rebuild `robots.txt` / `ads.txt` /
+     * `indexnow-key.txt` from it.
+     *
+     * @example
+     * const { adsTxt, canonicalBase } = await board.seo();
+     */
+    seo(options2) {
+      return client.fetch("/seo", options2);
+    },
     jobs: jobsNamespace(client),
     companies: companiesNamespace(client),
     blog: blogNamespace(client),
     auth: authNamespace(client),
     me: meNamespace(client),
-    taxonomy: taxonomyNamespace(client)
+    taxonomy: taxonomyNamespace(client),
+    redirects: redirectsNamespace(client)
   };
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cavuno/board",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Typed isomorphic client for the Cavuno Board API",
   "license": "MIT",
   "repository": {