Merge pull request #45 from brand-dot-dev/release-please--branches--main--changes--next--components--brand.dev

release: 0.28.0

Author: YahiaBakour

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.27.0"
+  ".": "0.28.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 20
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2cdd67823c6ac9d1ab68032a695c31a098ad285ffb0c073b9dfc00afe5de9b88.yml
-openapi_spec_hash: ac8a965beb9b667b6204a5c573507219
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-3614380ba4315687bbaf6561e9872fd72dd876f9230ce690c35d7efc1250e808.yml
+openapi_spec_hash: f1aa17e08d0379766a61de68714c7c21
 config_hash: 4cd3173ea1cce7183640aae49cfbb374

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.28.0 (2026-02-24)
+
+Full Changelog: [v0.27.0...v0.28.0](https://github.com/brand-dot-dev/typescript-sdk/compare/v0.27.0...v0.28.0)
+
+### Features
+
+* **api:** api update ([349b511](https://github.com/brand-dot-dev/typescript-sdk/commit/349b511bc530fae82b93221aeec7032503da6a51))
+
 ## 0.27.0 (2026-02-23)
 
 Full Changelog: [v0.26.0...v0.27.0](https://github.com/brand-dot-dev/typescript-sdk/compare/v0.26.0...v0.27.0)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "brand.dev",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "The official TypeScript library for the Brand Dev API",
   "author": "Brand Dev <hello@brand.dev>",
   "types": "dist/index.d.ts",

packages/mcp-server/manifest.json

@@ -1,7 +1,7 @@
 {
   "dxt_version": "0.2",
   "name": "brand.dev-mcp",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "The official MCP Server for the Brand Dev API",
   "author": {
     "name": "Brand Dev",

packages/mcp-server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brand.dev-mcp",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "The official MCP Server for the Brand Dev API",
   "author": "Brand Dev <hello@brand.dev>",
   "types": "dist/index.d.ts",

packages/mcp-server/src/server.ts

@@ -20,7 +20,7 @@ export const newMcpServer = async (stainlessApiKey: string | undefined) =>
   new McpServer(
     {
       name: 'brand_dev_api',
-      version: '0.27.0',
+      version: '0.28.0',
     },
     {
       instructions: await getInstructions(stainlessApiKey),

src/resources/brand.ts

@@ -166,8 +166,13 @@ export class Brand extends APIResource {
   /**
    * Automatically extract comprehensive design system information from a brand's
    * website including colors, typography, spacing, shadows, and UI components.
+   * Either 'domain' or 'directUrl' must be provided as a query parameter, but not
+   * both.
    */
-  styleguide(query: BrandStyleguideParams, options?: RequestOptions): APIPromise<BrandStyleguideResponse> {
+  styleguide(
+    query: BrandStyleguideParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrandStyleguideResponse> {
     return this._client.get('/brand/styleguide', { query, ...options });
   }
 
@@ -5948,11 +5953,17 @@ export interface BrandScreenshotParams {
 }
 
 export interface BrandStyleguideParams {
+  /**
+   * A specific URL to fetch the styleguide from directly, bypassing domain
+   * resolution (e.g., 'https://example.com/design-system').
+   */
+  directUrl?: string;
+
   /**
    * Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
    * domain will be automatically normalized and validated.
    */
-  domain: string;
+  domain?: string;
 
   /**
    * Optional parameter to prioritize screenshot capture for styleguide extraction.

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.27.0'; // x-release-please-version
+export const VERSION = '0.28.0'; // x-release-please-version

tests/api-resources/brand.test.ts

@@ -347,8 +347,8 @@ describe('resource brand', () => {
   });
 
   // Mock server tests are disabled
-  test.skip('styleguide: only required params', async () => {
-    const responsePromise = client.brand.styleguide({ domain: 'domain' });
+  test.skip('styleguide', async () => {
+    const responsePromise = client.brand.styleguide();
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -359,12 +359,19 @@ describe('resource brand', () => {
   });
 
   // Mock server tests are disabled
-  test.skip('styleguide: required and optional params', async () => {
-    const response = await client.brand.styleguide({
-      domain: 'domain',
-      prioritize: 'speed',
-      timeoutMS: 1000,
-    });
+  test.skip('styleguide: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      client.brand.styleguide(
+        {
+          directUrl: 'https://example.com',
+          domain: 'domain',
+          prioritize: 'speed',
+          timeoutMS: 1000,
+        },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(BrandDev.NotFoundError);
   });
 
   // Mock server tests are disabled