@cavuno/board 1.3.0 → 1.4.0

package/dist/index.d.mts

@@ -368,6 +368,24 @@ interface BoardSeo {
      * canonical links from it — NOT the request origin.
      */
     canonicalBase: string;
+    /**
+     * Absolute URLs for the board's configured favicons / app icons (null when
+     * unset). The variant key implies the role + size; build `<link rel="icon">`
+     * tags + the web-manifest icon list from these.
+     */
+    icons: {
+        ico: string | null;
+        svg: string | null;
+        appleTouch: string | null;
+        icon192: string | null;
+        icon512: string | null;
+        iconMaskable512: string | null;
+    };
+    /** Web-manifest metadata; assemble `site.webmanifest` from this + `icons`. */
+    manifest: {
+        name: string;
+        themeColor: string;
+    };
 }
 
 /**
@@ -423,7 +441,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.3.0";
+declare const SDK_VERSION = "1.4.0";
 
 interface BoardUser {
     id: string;
@@ -522,6 +540,29 @@ interface RedirectResolution {
     target: string | null;
 }
 
+/**
+ * A board legal/about page (ADR-0039 transitional portable-prose field). The
+ * API serves owner-authored prose as portable HTML; the starter authors the
+ * layout + JSON-LD. Impressum additionally carries structured legal-entity
+ * facts and is gated by the board's `impressumEnabled` flag (404 when off).
+ */
+type LegalPageType = 'terms-of-service' | 'privacy-policy' | 'cookie-policy' | 'about' | 'impressum';
+interface LegalEntity {
+    legalName: string | null;
+    address: string | null;
+}
+interface PublicLegalPage {
+    object: 'legal_page';
+    type: string;
+    /** Page heading (H1), with `{{board_name}}` resolved. */
+    title: string;
+    /** Owner-authored prose as portable HTML; `''` when the page has no body. */
+    content: string;
+    contentFormat: 'html';
+    /** Structured impressum facts; `null` for non-impressum pages. */
+    legalEntity: LegalEntity | null;
+}
+
 /** Author shape embedded on posts (no `object` discriminator). */
 interface BlogAuthorEmbed {
     id: string;
@@ -631,6 +672,21 @@ type CompanyJobsListQuery = {
     /** 1–100. */
     limit?: number;
 };
+type CompanySimilarQuery = {
+    /** 1–20, default 6. */
+    limit?: number;
+};
+interface CompanyMarket {
+    object: 'company_market';
+    slug: string;
+    name: string;
+    companyCount: number;
+}
+type CompanyMarketsListQuery = {
+    /** 1–200, default 100 (a top-by-company-count preview). */
+    limit?: number;
+    search?: string;
+};
 interface CompaniesSearchBody {
     /** Free-text query, up to 200 characters. */
     query?: string;
@@ -887,6 +943,8 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
         retrieve(companySlug: string, query?: Record<string, never>, options?: FetchOptions): Promise<PublicCompany>;
         search(body: CompaniesSearchBody, query?: Record<string, never>, options?: FetchOptions): Promise<SearchEnvelope<PublicCompany>>;
         listJobs(companySlug: string, query?: CompanyJobsListQuery, options?: FetchOptions): Promise<JobCardListEnvelope>;
+        similar(companySlug: string, query?: CompanySimilarQuery, options?: FetchOptions): Promise<ListEnvelope<PublicCompany>>;
+        markets(query?: CompanyMarketsListQuery, options?: FetchOptions): Promise<ListEnvelope<CompanyMarket>>;
     };
     blog: {
         posts: {
@@ -905,6 +963,9 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
         };
         search(body: BlogSearchBody, query?: Record<string, never>, options?: FetchOptions): Promise<SearchEnvelope<PublicBlogPostSummary>>;
     };
+    legal: {
+        retrieve(type: LegalPageType, options?: FetchOptions): Promise<PublicLegalPage>;
+    };
     auth: {
         register(body: RegisterBody, options?: FetchOptions): Promise<BoardAuthSession>;
         login(body: LoginBody, options?: FetchOptions): Promise<BoardAuthSession>;
@@ -957,4 +1018,4 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type Awaitable, BOARD_ACCESS_GRANT_KEY, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, 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 EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, type PublicBlogAdjacentPosts, 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, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type Awaitable, BOARD_ACCESS_GRANT_KEY, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CompanyMarket, type CompanyMarketsListQuery, type CompanySimilarQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicJob, type PublicJobCard, type PublicLegalPage, 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, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };

package/dist/index.d.ts

@@ -368,6 +368,24 @@ interface BoardSeo {
      * canonical links from it — NOT the request origin.
      */
     canonicalBase: string;
+    /**
+     * Absolute URLs for the board's configured favicons / app icons (null when
+     * unset). The variant key implies the role + size; build `<link rel="icon">`
+     * tags + the web-manifest icon list from these.
+     */
+    icons: {
+        ico: string | null;
+        svg: string | null;
+        appleTouch: string | null;
+        icon192: string | null;
+        icon512: string | null;
+        iconMaskable512: string | null;
+    };
+    /** Web-manifest metadata; assemble `site.webmanifest` from this + `icons`. */
+    manifest: {
+        name: string;
+        themeColor: string;
+    };
 }
 
 /**
@@ -423,7 +441,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.3.0";
+declare const SDK_VERSION = "1.4.0";
 
 interface BoardUser {
     id: string;
@@ -522,6 +540,29 @@ interface RedirectResolution {
     target: string | null;
 }
 
+/**
+ * A board legal/about page (ADR-0039 transitional portable-prose field). The
+ * API serves owner-authored prose as portable HTML; the starter authors the
+ * layout + JSON-LD. Impressum additionally carries structured legal-entity
+ * facts and is gated by the board's `impressumEnabled` flag (404 when off).
+ */
+type LegalPageType = 'terms-of-service' | 'privacy-policy' | 'cookie-policy' | 'about' | 'impressum';
+interface LegalEntity {
+    legalName: string | null;
+    address: string | null;
+}
+interface PublicLegalPage {
+    object: 'legal_page';
+    type: string;
+    /** Page heading (H1), with `{{board_name}}` resolved. */
+    title: string;
+    /** Owner-authored prose as portable HTML; `''` when the page has no body. */
+    content: string;
+    contentFormat: 'html';
+    /** Structured impressum facts; `null` for non-impressum pages. */
+    legalEntity: LegalEntity | null;
+}
+
 /** Author shape embedded on posts (no `object` discriminator). */
 interface BlogAuthorEmbed {
     id: string;
@@ -631,6 +672,21 @@ type CompanyJobsListQuery = {
     /** 1–100. */
     limit?: number;
 };
+type CompanySimilarQuery = {
+    /** 1–20, default 6. */
+    limit?: number;
+};
+interface CompanyMarket {
+    object: 'company_market';
+    slug: string;
+    name: string;
+    companyCount: number;
+}
+type CompanyMarketsListQuery = {
+    /** 1–200, default 100 (a top-by-company-count preview). */
+    limit?: number;
+    search?: string;
+};
 interface CompaniesSearchBody {
     /** Free-text query, up to 200 characters. */
     query?: string;
@@ -887,6 +943,8 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
         retrieve(companySlug: string, query?: Record<string, never>, options?: FetchOptions): Promise<PublicCompany>;
         search(body: CompaniesSearchBody, query?: Record<string, never>, options?: FetchOptions): Promise<SearchEnvelope<PublicCompany>>;
         listJobs(companySlug: string, query?: CompanyJobsListQuery, options?: FetchOptions): Promise<JobCardListEnvelope>;
+        similar(companySlug: string, query?: CompanySimilarQuery, options?: FetchOptions): Promise<ListEnvelope<PublicCompany>>;
+        markets(query?: CompanyMarketsListQuery, options?: FetchOptions): Promise<ListEnvelope<CompanyMarket>>;
     };
     blog: {
         posts: {
@@ -905,6 +963,9 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
         };
         search(body: BlogSearchBody, query?: Record<string, never>, options?: FetchOptions): Promise<SearchEnvelope<PublicBlogPostSummary>>;
     };
+    legal: {
+        retrieve(type: LegalPageType, options?: FetchOptions): Promise<PublicLegalPage>;
+    };
     auth: {
         register(body: RegisterBody, options?: FetchOptions): Promise<BoardAuthSession>;
         login(body: LoginBody, options?: FetchOptions): Promise<BoardAuthSession>;
@@ -957,4 +1018,4 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type Awaitable, BOARD_ACCESS_GRANT_KEY, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, 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 EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, type PublicBlogAdjacentPosts, 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, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type Awaitable, BOARD_ACCESS_GRANT_KEY, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CompanyMarket, type CompanyMarketsListQuery, type CompanySimilarQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicJob, type PublicJobCard, type PublicLegalPage, 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, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };

package/dist/index.js

@@ -149,7 +149,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.3.0";
+var SDK_VERSION = "1.4.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -530,6 +530,33 @@ function companiesNamespace(client) {
         `/companies/${encodeURIComponent(companySlug)}/jobs`,
         { ...options, query }
       );
+    },
+    /**
+     * List companies similar to one company — the same ranking that powers the
+     * hosted company page's similar-companies rail (most open roles first),
+     * excluding the company itself.
+     *
+     * @example
+     * const { data } = await board.companies.similar('acme', { limit: 6 });
+     */
+    similar(companySlug, query, options) {
+      return client.fetch(
+        `/companies/${encodeURIComponent(companySlug)}/similar`,
+        { ...options, query }
+      );
+    },
+    /**
+     * List the board's company markets (sectors), ranked by company count — the
+     * data behind the hosted companies index's market filter. A top-N preview.
+     *
+     * @example
+     * const { data } = await board.companies.markets({ search: 'robotics' });
+     */
+    markets(query, options) {
+      return client.fetch("/companies/markets", {
+        ...options,
+        query
+      });
     }
   };
 }
@@ -688,6 +715,28 @@ function jobsNamespace(client) {
   };
 }
 
+// src/namespaces/legal.ts
+function legalNamespace(client) {
+  return {
+    /**
+     * Retrieve a board legal/about page — owner-authored prose as portable HTML
+     * (`privacy-policy` / `terms-of-service` / `cookie-policy` / `about`) plus,
+     * for `impressum`, structured legal-entity facts. The starter authors the
+     * layout, breadcrumb labels, and JSON-LD. `impressum` throws
+     * `board_page_not_found` (404) when the board has not enabled it.
+     *
+     * @example
+     * const { title, content } = await board.legal.retrieve('privacy-policy');
+     */
+    retrieve(type, options) {
+      return client.fetch(
+        `/legal/${encodeURIComponent(type)}`,
+        options
+      );
+    }
+  };
+}
+
 // src/namespaces/me.ts
 function meNamespace(client) {
   return {
@@ -870,6 +919,7 @@ function createBoardClient(options) {
     embed: embedNamespace(client),
     companies: companiesNamespace(client),
     blog: blogNamespace(client),
+    legal: legalNamespace(client),
     auth: authNamespace(client),
     me: meNamespace(client),
     password: passwordNamespace(client),

package/dist/index.mjs

@@ -109,7 +109,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.3.0";
+var SDK_VERSION = "1.4.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -490,6 +490,33 @@ function companiesNamespace(client) {
         `/companies/${encodeURIComponent(companySlug)}/jobs`,
         { ...options, query }
       );
+    },
+    /**
+     * List companies similar to one company — the same ranking that powers the
+     * hosted company page's similar-companies rail (most open roles first),
+     * excluding the company itself.
+     *
+     * @example
+     * const { data } = await board.companies.similar('acme', { limit: 6 });
+     */
+    similar(companySlug, query, options) {
+      return client.fetch(
+        `/companies/${encodeURIComponent(companySlug)}/similar`,
+        { ...options, query }
+      );
+    },
+    /**
+     * List the board's company markets (sectors), ranked by company count — the
+     * data behind the hosted companies index's market filter. A top-N preview.
+     *
+     * @example
+     * const { data } = await board.companies.markets({ search: 'robotics' });
+     */
+    markets(query, options) {
+      return client.fetch("/companies/markets", {
+        ...options,
+        query
+      });
     }
   };
 }
@@ -648,6 +675,28 @@ function jobsNamespace(client) {
   };
 }
 
+// src/namespaces/legal.ts
+function legalNamespace(client) {
+  return {
+    /**
+     * Retrieve a board legal/about page — owner-authored prose as portable HTML
+     * (`privacy-policy` / `terms-of-service` / `cookie-policy` / `about`) plus,
+     * for `impressum`, structured legal-entity facts. The starter authors the
+     * layout, breadcrumb labels, and JSON-LD. `impressum` throws
+     * `board_page_not_found` (404) when the board has not enabled it.
+     *
+     * @example
+     * const { title, content } = await board.legal.retrieve('privacy-policy');
+     */
+    retrieve(type, options) {
+      return client.fetch(
+        `/legal/${encodeURIComponent(type)}`,
+        options
+      );
+    }
+  };
+}
+
 // src/namespaces/me.ts
 function meNamespace(client) {
   return {
@@ -830,6 +879,7 @@ function createBoardClient(options) {
     embed: embedNamespace(client),
     companies: companiesNamespace(client),
     blog: blogNamespace(client),
+    legal: legalNamespace(client),
     auth: authNamespace(client),
     me: meNamespace(client),
     password: passwordNamespace(client),

package/package.json

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

package/skills/manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.0",
+  "version": "1.4.0",
   "skills": [
     {
       "name": "cavuno-board-auth",