@chiselandco/nexus 3.0.0 → 3.1.0

package/README.md

@@ -2,7 +2,7 @@
 
 Self-contained project portfolio components for Next.js App Router. Pass a `clientSlug`, `apiBase`, and `apiKey` — each component fetches, caches, and renders everything it needs with no client-side waterfall requests.
 
-**Version:** 3.0.0
+**Version:** 3.1.0
 
 ---
 
@@ -29,7 +29,7 @@ The most common full setup — a filterable projects grid, a detail page with si
 
 ```tsx
 // app/projects/page.tsx
-import { FilteredPortfolio } from "@chiselandco/nexus"
+import { ProjectPortfolio } from "@chiselandco/nexus"
 
 export default async function ProjectsPage({
   searchParams,
@@ -37,7 +37,7 @@ export default async function ProjectsPage({
   searchParams: Promise<Record<string, string | string[] | undefined>>
 }) {
   return (
-    <FilteredPortfolio
+    <ProjectPortfolio
       clientSlug="your-client-slug"
       apiBase="https://your-api.com"
       apiKey={process.env.YOUR_CLIENT_API_KEY!}
@@ -115,58 +115,11 @@ export function Nav() {
 
 ## Components
 
-### `FilteredPortfolio`
-
-Server component. The recommended primary projects grid. Fetches all projects once, reads `filter[key]=` URL params server-side to narrow results using AND-across-fields / OR-within-field logic, then renders a project count toolbar with a `FilterSidebar` trigger above a responsive card grid.
-
-```tsx
-import { FilteredPortfolio } from "@chiselandco/nexus"
-
-export default async function ProjectsPage({
-  searchParams,
-}: {
-  searchParams: Promise<Record<string, string | string[] | undefined>>
-}) {
-  return (
-    <FilteredPortfolio
-      clientSlug="your-client-slug"
-      apiBase="https://your-api.com"
-      apiKey={process.env.YOUR_CLIENT_API_KEY!}
-      basePath="/projects"
-      searchParams={await searchParams}
-    />
-  )
-}
-```
-
-| Prop | Type | Required | Default | Description |
-|---|---|---|---|---|
-| `clientSlug` | `string` | Yes | — | Client identifier passed to the API |
-| `apiBase` | `string` | Yes | — | Base URL of the Chisel API |
-| `apiKey` | `string` | Yes | — | Client API key — always pass via environment variable, never hardcode |
-| `searchParams` | `Record<string, string \| string[] \| undefined>` | Yes | — | Resolved Next.js `searchParams` — await it before passing in Next.js 16+ |
-| `basePath` | `string` | No | `"/projects"` | Base path for project detail card links |
-| `filterKeys` | `string[]` | No | All eligible fields | Ordered list of field keys to expose in the filter drawer |
-| `font` | `string` | No | System font | Font family string |
-| `noCache` | `boolean` | No | `false` | Sets `cache: "no-store"` — useful during development |
-| `revalidate` | `number` | No | `86400` | Cache revalidation period in seconds |
-| `filterBy` | `{ field: string; value: string }` | No | — | Pre-filter projects by any custom field value. See [Filtering by field](#filtering-by-field). |
-
-#### URL param format
-
-Filters are written to and read from URL params in the form `filter[fieldKey]=slug1,slug2`. Multiple values within a field are OR'd; multiple fields are AND'd.
-
-```
-/projects?filter[application]=hospitality,education&filter[systems]=spacematic
-```
-
----
-
 ### `FilterSidebar`
 
 Client component (`"use client"`). Renders an "Advanced Filters" trigger that opens a right-side drawer with one section per filterable field. Pills are solid black when active and outlined when inactive. Filter state is written to URL params so filtered views are shareable and survive page refresh.
 
-Used internally by `FilteredPortfolio` — only import it standalone if you need to build a custom layout around it.
+Use alongside `ProjectPortfolio` when you want user-driven filtering — place it wherever suits your layout and pass the same `searchParams` to `ProjectPortfolio`.
 
 ```tsx
 import { FilterSidebar } from "@chiselandco/nexus"
@@ -536,7 +489,7 @@ export function Nav() {
 
 ### `ProjectPortfolio`
 
-Server component. Fetches all projects and renders a responsive baseball card grid (1 col mobile / 2 col tablet / 3 col desktop). Supports URL-driven filtering via `searchParams`. Prefer `FilteredPortfolio` for new projects — it includes the full filter sidebar and is the recommended default.
+Server component. The primary projects grid. Fetches all projects, reads `filter[key]=` URL params server-side to narrow results, and renders a responsive card grid (1 col mobile / 2 col tablet / 3 col desktop). Pair with `FilterSidebar` when you want user-driven filtering — place it wherever suits your layout.
 
 ```tsx
 // app/projects/page.tsx
@@ -617,11 +570,11 @@ export default function ProjectsPage() {
 
 ## Filtering by field
 
-`FilteredPortfolio`, `ProjectPortfolio`, `ProjectPortfolioClient`, and `SimilarProjects` all accept an optional `filterBy` prop. It pre-filters the project list by any custom field value before any user-driven filters are applied.
+`ProjectPortfolio`, `ProjectPortfolioClient`, and `SimilarProjects` all accept an optional `filterBy` prop. It pre-filters the project list by any custom field value before any user-driven filters are applied.
 
 ```tsx
 // Only show projects where custom field "side" equals "architectural" or "both"
-<FilteredPortfolio
+<ProjectPortfolio
   clientSlug="hollaender"
   apiBase="https://your-api.com"
   apiKey={process.env.HOLLAENDER_API_KEY!}
@@ -631,7 +584,7 @@ export default function ProjectsPage() {
 />
 
 // Only show projects where custom field "side" equals "speedrail" or "both"
-<FilteredPortfolio
+<ProjectPortfolio
   clientSlug="hollaender"
   apiBase="https://your-api.com"
   apiKey={process.env.HOLLAENDER_API_KEY!}
@@ -655,10 +608,24 @@ The `"both"` fallback is built in — if a project's field value is `"both"` it
 
 ```tsx
 // v2
-<FilteredPortfolio side="architectural" />
+<ProjectPortfolio side="architectural" />
 
 // v3
-<FilteredPortfolio filterBy={{ field: "side", value: "architectural" }} />
+<ProjectPortfolio filterBy={{ field: "side", value: "architectural" }} />
+```
+
+### Migration from v3.0 `FilteredPortfolio`
+
+`FilteredPortfolio` was removed in v3.1. Use `ProjectPortfolio` directly — it has the same props. Pair with `FilterSidebar` if you want a filter drawer.
+
+```tsx
+// v3.0
+import { FilteredPortfolio } from "@chiselandco/nexus"
+<FilteredPortfolio clientSlug="..." apiBase="..." apiKey={...} searchParams={searchParams} />
+
+// v3.1
+import { ProjectPortfolio } from "@chiselandco/nexus"
+<ProjectPortfolio clientSlug="..." apiBase="..." apiKey={...} searchParams={searchParams} />
 ```
 
 ---
@@ -667,10 +634,9 @@ The `"both"` fallback is built in — if a project's field value is `"both"` it
 
 | Component | Type | Notes |
 |---|---|---|
-| `FilteredPortfolio` | Server | Recommended default for project grids |
-| `FilterSidebar` | Client | Used internally by `FilteredPortfolio` |
-| `ProjectPortfolio` | Server | Simpler grid without sidebar |
-| `ProjectPortfolioClient` | Client | For use inside client trees |
+| `ProjectPortfolio` | Server | Primary projects grid |
+| `FilterSidebar` | Client | Optional filter drawer — pair with `ProjectPortfolio` |
+| `ProjectPortfolioClient` | Client | For use inside client component trees |
 | `ProjectDetail` | Server | Full project detail page |
 | `GalleryCarousel` | Client | Used internally by `ProjectDetail` |
 | `SimilarProjects` | Server | After `ProjectDetail` on detail pages |
@@ -685,7 +651,6 @@ All server components must be rendered in a server context. If your parent compo
 
 | Component | Server cache | Client cache |
 |---|---|---|
-| `FilteredPortfolio` | 24h via `next.revalidate` | — |
 | `ProjectPortfolio` | 24h via `next.revalidate` | — |
 | `ProjectDetail` | 24h via `next.revalidate` | — |
 | `SimilarProjects` | 24h via `next.revalidate` | — |

package/dist/FilteredPortfolio.d.ts

@@ -52,5 +52,5 @@ export interface FilteredPortfolioProps {
  *     )
  *   }
  */
-export declare function FilteredPortfolio({ clientSlug, apiBase, apiKey, searchParams, filterKeys, basePath, revalidate, noCache, font, filterBy, }: FilteredPortfolioProps): Promise<import("react").JSX.Element>;
+export declare function FilteredPortfolio({ clientSlug, apiBase, apiKey, searchParams, filterKeys, basePath, revalidate, noCache, font, filterBy, }: FilteredPortfolioProps): Promise<import("react/jsx-runtime").JSX.Element>;
 //# sourceMappingURL=FilteredPortfolio.d.ts.map

package/dist/FilteredPortfolio.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FilteredPortfolio.d.ts","sourceRoot":"","sources":["../src/FilteredPortfolio.tsx"],"names":[],"mappings":"AAIA,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAC5D;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAC5C;AA8ED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAiB,EACjB,UAAU,EACV,QAAsB,EACtB,UAAe,EACf,OAAe,EACf,IAAI,EACJ,QAAQ,GACT,EAAE,sBAAsB,wCAqGxB"}
+{"version":3,"file":"FilteredPortfolio.d.ts","sourceRoot":"","sources":["../src/FilteredPortfolio.tsx"],"names":[],"mappings":"AAIA,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAC5D;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAC5C;AA8ED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAiB,EACjB,UAAU,EACV,QAAsB,EACtB,UAAe,EACf,OAAe,EACf,IAAI,EACJ,QAAQ,GACT,EAAE,sBAAsB,oDAqGxB"}

package/dist/index.d.ts

@@ -16,7 +16,5 @@ export { ProjectCard } from "./ProjectCard";
 export type { CardVariant } from "./ProjectCard";
 export { FilterSidebar } from "./FilterSidebar";
 export type { FilterSidebarProps } from "./FilterSidebar";
-export { FilteredPortfolio } from "./FilteredPortfolio";
-export type { FilteredPortfolioProps } from "./FilteredPortfolio";
 export type { Project, CustomFieldSchema, CustomFieldValue, LocationValue, Media, } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,YAAY,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAA;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACpF,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AACjE,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,KAAK,GACN,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,YAAY,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAA;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACpF,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,KAAK,GACN,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -7,4 +7,3 @@ export { ProjectMenu, fetchProjectMenuData, createMenuHandler } from "./ProjectM
 export { ProjectMenuClient } from "./ProjectMenuClient";
 export { ProjectCard } from "./ProjectCard";
 export { FilterSidebar } from "./FilterSidebar";
-export { FilteredPortfolio } from "./FilteredPortfolio";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chiselandco/nexus",
-  "version": "3.0.0",
-  "description": "Self-contained project portfolio components for Next.js App Router. Includes ProjectPortfolio, ProjectPortfolioClient, ProjectDetail, SimilarProjects, ProjectMenu, ProjectMenuClient, GalleryCarousel, FilterSidebar, and FilteredPortfolio. Pass a clientSlug and apiBase — done.",
+  "version": "3.1.0",
+  "description": "Self-contained project portfolio components for Next.js App Router. Includes ProjectPortfolio, ProjectPortfolioClient, ProjectDetail, SimilarProjects, ProjectMenu, ProjectMenuClient, GalleryCarousel, and FilterSidebar. Pass a clientSlug and apiBase — done.",
   "keywords": [
     "nextjs",
     "react",