open-brandkit 0.4.7

package/LICENSE

@@ -0,0 +1,72 @@
+Open BrandKit Source-Available License
+Version 1.0
+
+Copyright (c) 2026 Tim Campbell Works, LLC.
+
+Permission is granted, free of charge, to any person or organization obtaining
+a copy of this software and associated documentation files (the "Software"), to
+use, copy, install, run, modify, and create derivative works of the Software for
+personal, internal, client, agency, commercial, and noncommercial projects,
+subject to the terms below.
+
+1. Permitted Use
+
+You may use Open BrandKit to create, build, customize, deploy, and maintain
+brand kit pages and related assets for yourself, your organization, your
+clients, or products and services you operate.
+
+You may charge for services, consulting, implementation work, design work,
+client websites, hosting, or products that use Open BrandKit as part of a
+larger project, provided that you are not selling Open BrandKit itself or a
+substantially similar competing product.
+
+Brand assets, generated pages, generated images, generated manifests, and other
+outputs created for your own projects remain subject to your own rights and the
+rights of the brand owners whose assets you use. This license does not claim
+ownership over your brand assets or generated project output.
+
+2. Restrictions
+
+You may not sell, sublicense, repackage, redistribute, publish, or offer Open
+BrandKit, in whole or substantial part, as a standalone product, competing
+package, hosted installer, template marketplace item, software-as-a-service
+offering, or other product whose value derives primarily from Open BrandKit
+itself.
+
+You may not remove or obscure copyright notices, license notices, or attribution
+notices included with the Software.
+
+You may not use the Open BrandKit name, marks, or project identity to imply
+endorsement, sponsorship, or affiliation without written permission.
+
+3. Sharing Changes
+
+You may fork, study, modify, and share changes to the Software for collaboration,
+review, contribution, or non-resale purposes, provided that shared copies or
+substantial portions retain this license and all required notices.
+
+Any public fork, derivative, variation, improvement, or modified version of Open
+BrandKit that is released must be distributed under this license or terms that
+are substantially equivalent.
+
+4. Contributions
+
+By submitting a contribution to this repository, you agree that your contribution
+is provided under the terms of this license. You represent that you have the
+right to submit the contribution under these terms.
+
+5. Separate Commercial Licensing
+
+If you want to sell, repackage, redistribute, host, or otherwise commercialize
+Open BrandKit itself in a way this license does not allow, you must obtain a
+separate written license from the copyright holders.
+
+6. Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM,
+OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,284 @@
+# Open BrandKit
+
+Open BrandKit turns the brand files you already have into a polished, shareable
+brand kit page for your website.
+
+Most teams eventually need the same little portal: approved logos, colors,
+favicons, social images, avatars, and download buttons. Those assets usually end
+up scattered across folders, design files, old Slack threads, and "which one is
+current?" conversations.
+
+Open BrandKit exists so a website repo can become the source of truth. Put the
+approved brand files in the project, run the installer, and your site gets a
+`/brandkit` page that stays tied to the assets you actually ship.
+
+Open BrandKit is source-available. You can use it in personal, internal,
+client, agency, and commercial projects, but you cannot repackage or resell Open
+BrandKit itself as a standalone or competing product.
+
+## What It Creates
+
+Open BrandKit can generate a brand kit with:
+
+- Logo lockups, wordmarks, and icons grouped into clear sections.
+- Download buttons for approved assets.
+- Brand color cards pulled from a source file.
+- Avatar and favicon generation from your icon files.
+- Ready-to-use social banner images.
+- ZIP downloads for asset groups.
+- A generated manifest for the brand kit page.
+
+The page has an opinionated default design on purpose. A new install should feel
+complete immediately, with the brand inputs doing the changing: your name, your
+logos, your icons, your wordmarks, and your colors.
+
+## What It Works With
+
+Open BrandKit currently works best with:
+
+- A Next.js App Router site.
+- Tailwind CSS 3 or 4.
+- Logos and icons stored in your repo, usually under `public/logos`.
+- SVG or PNG brand assets.
+- A color source file in Markdown, JSON, CSV, or TypeScript config.
+- Vercel or any host that can serve a normal Next.js app.
+
+The generated Next.js page is Tailwind-first. Having Tailwind installed is only
+half of the requirement: your app also needs to include Open BrandKit's shipped
+components when Tailwind builds its CSS. During `init`, Open BrandKit tries to
+wire that up for you.
+
+For Tailwind 3, the installer adds Open BrandKit to the `content` paths in
+`tailwind.config.*`. For Tailwind 4, it adds an `@source` directive to your app
+stylesheet. If `/brandkit` loads but looks unstyled, this scan path is the first
+thing to check.
+
+The installer patches common Tailwind setups automatically. If your Tailwind
+configuration is highly custom, generated, or split across unusual files, Open
+BrandKit may leave it untouched and print the exact scan/source line to add by
+hand.
+
+## What It Does Not Do
+
+Open BrandKit does not design your brand for you. It expects approved source
+files to already exist.
+
+It also does not yet support every framework. The public installer and
+interactive page are focused on Next.js first.
+
+The social banner preset controls can run on production when you wire the Next
+routes. Custom banner uploads, resets, and favicon installation stay local-only
+because they write files that cannot be saved back to your repo from a deployed
+site.
+
+## Prepare Your Assets
+
+Start with a folder of approved brand files. Clear filenames help Open BrandKit
+group things correctly.
+
+Example:
+
+```text
+public/logos/acme-logo.svg
+public/logos/acme-logo-white.svg
+public/logos/acme-wordmark-black.svg
+public/logos/acme-wordmark-blue.svg
+public/logos/acme-icon-green.svg
+public/logos/acme-icon-white.svg
+```
+
+Useful filename words:
+
+- `logo` for full logo lockups.
+- `wordmark` for text-only marks.
+- `icon`, `symbol`, or `favicon` for compact marks.
+- color words like `blue`, `black`, `white`, `green`, or your own color names.
+
+Then add a color source file.
+
+Example Markdown:
+
+```md
+## Brand Colors
+
+### Primary Colors
+
+| Name | Hex |
+| --- | --- |
+| Acme Blue | #2457ff |
+| Acme Green | #32d583 |
+
+### Secondary Colors
+
+| Name | Hex |
+| --- | --- |
+| Acme Black | #101828 |
+| Acme Gray | #667085 |
+```
+
+Primary colors render as a two-column section. Secondary colors render as a
+three-column section. Use those headings when you want Open BrandKit to lay out
+the color system like the default brand kit.
+
+For print swatches, use the exact heading `## Print Color Shades`. Open BrandKit
+uses that heading to render Pantone-style chips with RGB, CMYK, and hex values
+instead of ordinary brand color cards. See
+`examples/acme-studio-color-system.md` for a fuller color-system example.
+
+## Install
+
+From the root of an existing Next.js app:
+
+```bash
+npx open-brandkit init --install --build
+```
+
+The installer asks for your brand name, logo folder, color file, route, and app
+directory. By default, the brand kit lives at:
+
+```text
+/brandkit
+```
+
+For a noninteractive install:
+
+```bash
+npx open-brandkit init \
+  --install \
+  --brand "Acme" \
+  --short-name Acme \
+  --logos public/logos \
+  --colors docs/brand-colors.md \
+  --route /brandkit \
+  --app-dir src/app \
+  --build
+```
+
+Use `app` instead of `src/app` if your project does not use a `src` directory.
+
+After install, your app should have Tailwind pointed at the package code. The
+installer handles the common Tailwind 3 and Tailwind 4 setups automatically, but
+custom Tailwind setups may need a manual check.
+
+## What Gets Added
+
+Open BrandKit writes a small set of files into your app:
+
+```text
+brandkit.config.ts
+src/app/brandkit/page.tsx
+src/app/brandkit/layout.tsx
+src/app/brandkit/favicon/route.ts
+src/app/brandkit/banners/route.ts
+src/app/brandkit/banners/presets/route.ts
+src/app/brandkit/download/[group]/route.ts
+public/brandkit/*
+```
+
+It also adds a script:
+
+```json
+{
+  "scripts": {
+    "brandkit:build": "open-brandkit build"
+  }
+}
+```
+
+## Use It
+
+Start your app:
+
+```bash
+npm run dev
+```
+
+Then open:
+
+```text
+http://localhost:3000/brandkit
+```
+
+When you change logos or colors, rebuild the brand kit:
+
+```bash
+npm run brandkit:build
+```
+
+The build output includes the Open BrandKit version that generated the files, so
+it is easier to troubleshoot installs across projects.
+
+## Customize
+
+Most customization lives in `brandkit.config.ts`.
+
+Use it to change:
+
+- Brand name and description.
+- Logo source folder.
+- Color source file.
+- Logo grouping rules.
+- Banner presets.
+- Banner mark variants.
+- Output paths.
+
+The defaults are meant to be useful without heavy configuration. If your source
+files are named clearly, Open BrandKit should infer a good first version.
+
+## Asset Variant Colors
+
+In the social banner generator, the "Color" control selects a mark file. It does
+not recolor the artwork.
+
+That means a logo like this:
+
+```text
+acme-logo.svg
+acme-logo-blue.svg
+acme-logo-white.svg
+```
+
+becomes three selectable logo variants. Open BrandKit uses filename hints and SVG
+fill colors to choose reasonable color dots for those options.
+
+## Deploy
+
+Commit the generated files and deploy your site as usual.
+
+On Vercel, `/brandkit` works like any other Next.js route once the files are in
+the repo.
+
+If the deployed page appears unstyled, make sure the deployed app is using the
+same Tailwind scan/source change that worked locally. Open BrandKit's styles are
+compiled by the host app, not loaded from a separate stylesheet.
+
+## License
+
+Open BrandKit is source-available.
+
+You may use it commercially in your own projects, internal company work, client
+work, agency projects, websites, and products. You may charge for services,
+implementation, design, hosting, or client work that uses Open BrandKit as part
+of a larger project.
+
+You may not sell, sublicense, repackage, redistribute, publish, or offer Open
+BrandKit itself as a standalone product, competing package, hosted installer,
+template marketplace item, or software-as-a-service product whose value derives
+primarily from Open BrandKit.
+
+See `LICENSE` for the full terms.
+
+## Status
+
+Open BrandKit is early. The main path today is:
+
+```text
+existing Next.js app + local brand assets -> generated /brandkit page
+```
+
+## Up Next
+
+Additional installation paths are planned, including Astro and other static or
+framework-specific setups. For now, the public installer is intentionally focused
+on Next.js App Router projects so the generated brand kit matches the full
+interactive experience.

package/dist/adapters/next/brandkit-page.d.ts

@@ -0,0 +1,15 @@
+import type { BrandKitManifest } from '../../core/types.js';
+import type { BrandKitBannerControls } from './manifest.js';
+export type BrandKitPageEndpoints = {
+    bannerPresets?: string;
+    bannerUpload?: string;
+    favicon?: string;
+};
+export type BrandKitPageProps = {
+    bannerControls?: BrandKitBannerControls;
+    canUseDevActions?: boolean;
+    endpoints?: BrandKitPageEndpoints;
+    manifest: BrandKitManifest;
+};
+export declare function BrandKitPage({ bannerControls, canUseDevActions, endpoints, manifest, }: BrandKitPageProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=brandkit-page.d.ts.map

package/dist/adapters/next/brandkit-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brandkit-page.d.ts","sourceRoot":"","sources":["../../../src/adapters/next/brandkit-page.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAOV,gBAAgB,EAGjB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAE3D,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,CAAC,EAAE,sBAAsB,CAAA;IACvC,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAA;IACjC,QAAQ,EAAE,gBAAgB,CAAA;CAC3B,CAAA;AA0+ED,wBAAgB,YAAY,CAAC,EAC3B,cAAc,EACd,gBAAuB,EACvB,SAAS,EACT,QAAQ,GACT,EAAE,iBAAiB,2CAkUnB"}