perspectapi-ts-sdk 1.5.0 → 1.5.2

package/README.md

@@ -234,7 +234,8 @@ const content = await client.content.getContent('your-site-name', {
   page: 1,
   limit: 20,
   page_status: 'publish',
-  page_type: 'post'
+  page_type: 'post',
+  slug_prefix: 'blog'  // Optional: filter by slug prefix
 });
 
 // Get content by ID
@@ -274,7 +275,8 @@ await client.content.unpublishContent(123);
 const products = await client.products.getProducts('my-site', {
   page: 1,
   limit: 20,
-  isActive: true
+  isActive: true,
+  slug_prefix: 'shop'  // Optional: filter by slug prefix
 });
 
 // Create new product
@@ -650,6 +652,54 @@ const client = createPerspectApiClient({
 });
 ```
 
+## Slug Prefix Filtering
+
+The SDK supports filtering content and products by `slug_prefix` to organize your content by URL structure:
+
+```typescript
+// Filter blog posts
+const blogPosts = await client.content.getContent('mysite', {
+  slug_prefix: 'blog',      // /blog/post-1, /blog/post-2
+  page_status: 'publish'
+});
+
+// Filter news articles
+const news = await client.content.getContent('mysite', {
+  slug_prefix: 'news',      // /news/article-1, /news/article-2
+  page_status: 'publish'
+});
+
+// Filter shop products
+const shopProducts = await client.products.getProducts('mysite', {
+  slug_prefix: 'shop',      // /shop/product-1, /shop/product-2
+  isActive: true
+});
+
+// Filter artwork products
+const artwork = await client.products.getProducts('mysite', {
+  slug_prefix: 'artwork',   // /artwork/painting-1, /artwork/sculpture-1
+  isActive: true
+});
+
+// Combine with other filters
+const results = await client.content.getContent('mysite', {
+  slug_prefix: 'blog',
+  page_status: 'publish',
+  page_type: 'post',
+  search: 'javascript',     // Search within blog posts only
+  page: 1,
+  limit: 20
+});
+```
+
+**Use Cases:**
+- Organize blog posts, news, and documentation separately
+- Separate shop products from artwork or digital downloads
+- Create multi-section websites with distinct URL structures
+- Filter content/products by section for navigation
+
+**See `examples/slug-prefix-examples.ts` for 20+ real-world examples!**
+
 ## TypeScript Support
 
 The SDK is written in TypeScript and provides comprehensive type definitions:

package/dist/index.d.mts

@@ -188,6 +188,7 @@ interface Content {
     contentMarkdown?: string;
     custom?: Record<string, any>;
     slug?: string;
+    slug_prefix?: string;
     pageStatus: ContentStatus;
     pageType: ContentType;
     userId?: number;
@@ -211,6 +212,7 @@ interface ContentQueryParams extends PaginationParams {
     page_type?: ContentType;
     search?: string;
     user_id?: number;
+    slug_prefix?: string;
 }
 interface Category {
     id: number;
@@ -277,6 +279,7 @@ interface ProductQueryParams extends PaginationParams {
     search?: string;
     category?: string | string[];
     category_id?: number | string | Array<number | string>;
+    slug_prefix?: string;
 }
 interface BlogPost {
     id: string | number;

package/dist/index.d.ts

@@ -188,6 +188,7 @@ interface Content {
     contentMarkdown?: string;
     custom?: Record<string, any>;
     slug?: string;
+    slug_prefix?: string;
     pageStatus: ContentStatus;
     pageType: ContentType;
     userId?: number;
@@ -211,6 +212,7 @@ interface ContentQueryParams extends PaginationParams {
     page_type?: ContentType;
     search?: string;
     user_id?: number;
+    slug_prefix?: string;
 }
 interface Category {
     id: number;
@@ -277,6 +279,7 @@ interface ProductQueryParams extends PaginationParams {
     search?: string;
     category?: string | string[];
     category_id?: number | string | Array<number | string>;
+    slug_prefix?: string;
 }
 interface BlogPost {
     id: string | number;

package/dist/index.js

@@ -749,7 +749,10 @@ var ProductsClient = class extends BaseClient {
         delete normalizedParams.category_id;
       }
     }
-    return this.http.get(this.buildPath(this.siteScopedEndpoint(siteName, "/products")), normalizedParams);
+    return this.http.get(
+      this.buildPath(this.siteScopedEndpoint(siteName, "/products", { includeSitesSegment: false })),
+      normalizedParams
+    );
   }
   /**
    * Get product by ID
@@ -768,7 +771,7 @@ var ProductsClient = class extends BaseClient {
    */
   async getProductBySlug(siteName, slug) {
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/products/slug/${encodeURIComponent(slug)}`)
+      this.siteScopedEndpoint(siteName, `/products/slug/${encodeURIComponent(slug)}`, { includeSitesSegment: false })
     ));
   }
   /**
@@ -866,7 +869,11 @@ var ProductsClient = class extends BaseClient {
       search: params.search
     } : void 0;
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/products/category/${encodeURIComponent(categorySlug)}`)
+      this.siteScopedEndpoint(
+        siteName,
+        `/products/category/${encodeURIComponent(categorySlug)}`,
+        { includeSitesSegment: false }
+      )
     ), queryParams);
   }
 };
@@ -899,7 +906,11 @@ var CategoriesClient = class extends BaseClient {
    */
   async getProductCategoryBySlug(siteName, slug) {
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/product_category/slug/${encodeURIComponent(slug)}`)
+      this.siteScopedEndpoint(
+        siteName,
+        `/product_category/slug/${encodeURIComponent(slug)}`,
+        { includeSitesSegment: false }
+      )
     ));
   }
   /**
@@ -1098,7 +1109,7 @@ var CheckoutClient = class extends BaseClient {
       token = csrfToken2;
     }
     return this.http.request(this.buildPath(
-      this.siteScopedEndpoint(siteName, "/checkout/create-session")
+      this.siteScopedEndpoint(siteName, "/checkout/create-session", { includeSitesSegment: false })
     ), {
       method: "POST",
       body: data,

package/dist/index.mjs

@@ -691,7 +691,10 @@ var ProductsClient = class extends BaseClient {
         delete normalizedParams.category_id;
       }
     }
-    return this.http.get(this.buildPath(this.siteScopedEndpoint(siteName, "/products")), normalizedParams);
+    return this.http.get(
+      this.buildPath(this.siteScopedEndpoint(siteName, "/products", { includeSitesSegment: false })),
+      normalizedParams
+    );
   }
   /**
    * Get product by ID
@@ -710,7 +713,7 @@ var ProductsClient = class extends BaseClient {
    */
   async getProductBySlug(siteName, slug) {
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/products/slug/${encodeURIComponent(slug)}`)
+      this.siteScopedEndpoint(siteName, `/products/slug/${encodeURIComponent(slug)}`, { includeSitesSegment: false })
     ));
   }
   /**
@@ -808,7 +811,11 @@ var ProductsClient = class extends BaseClient {
       search: params.search
     } : void 0;
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/products/category/${encodeURIComponent(categorySlug)}`)
+      this.siteScopedEndpoint(
+        siteName,
+        `/products/category/${encodeURIComponent(categorySlug)}`,
+        { includeSitesSegment: false }
+      )
     ), queryParams);
   }
 };
@@ -841,7 +848,11 @@ var CategoriesClient = class extends BaseClient {
    */
   async getProductCategoryBySlug(siteName, slug) {
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/product_category/slug/${encodeURIComponent(slug)}`)
+      this.siteScopedEndpoint(
+        siteName,
+        `/product_category/slug/${encodeURIComponent(slug)}`,
+        { includeSitesSegment: false }
+      )
     ));
   }
   /**
@@ -1040,7 +1051,7 @@ var CheckoutClient = class extends BaseClient {
       token = csrfToken2;
     }
     return this.http.request(this.buildPath(
-      this.siteScopedEndpoint(siteName, "/checkout/create-session")
+      this.siteScopedEndpoint(siteName, "/checkout/create-session", { includeSitesSegment: false })
     ), {
       method: "POST",
       body: data,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perspectapi-ts-sdk",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "TypeScript SDK for PerspectAPI - Cloudflare Workers compatible",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/client/categories-client.ts

@@ -46,7 +46,11 @@ export class CategoriesClient extends BaseClient {
    */
   async getProductCategoryBySlug(siteName: string, slug: string): Promise<ApiResponse<Category>> {
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/product_category/slug/${encodeURIComponent(slug)}`)
+      this.siteScopedEndpoint(
+        siteName,
+        `/product_category/slug/${encodeURIComponent(slug)}`,
+        { includeSitesSegment: false }
+      )
     ));
   }
 

package/src/client/checkout-client.ts

@@ -52,7 +52,7 @@ export class CheckoutClient extends BaseClient {
 
     // Make the checkout request with CSRF token in headers
     return this.http.request(this.buildPath(
-      this.siteScopedEndpoint(siteName, '/checkout/create-session')
+      this.siteScopedEndpoint(siteName, '/checkout/create-session', { includeSitesSegment: false })
     ), {
       method: 'POST',
       body: data,

package/src/client/products-client.ts

@@ -50,7 +50,10 @@ export class ProductsClient extends BaseClient {
       }
     }
 
-    return this.http.get(this.buildPath(this.siteScopedEndpoint(siteName, '/products')), normalizedParams);
+    return this.http.get(
+      this.buildPath(this.siteScopedEndpoint(siteName, '/products', { includeSitesSegment: false })),
+      normalizedParams
+    );
   }
 
   /**
@@ -72,7 +75,7 @@ export class ProductsClient extends BaseClient {
    */
   async getProductBySlug(siteName: string, slug: string): Promise<ApiResponse<Product & { variants?: any[] }>> {
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/products/slug/${encodeURIComponent(slug)}`)
+      this.siteScopedEndpoint(siteName, `/products/slug/${encodeURIComponent(slug)}`, { includeSitesSegment: false })
     ));
   }
 
@@ -241,7 +244,11 @@ export class ProductsClient extends BaseClient {
     } : undefined;
 
     return this.http.get(this.buildPath(
-      this.siteScopedEndpoint(siteName, `/products/category/${encodeURIComponent(categorySlug)}`)
+      this.siteScopedEndpoint(
+        siteName,
+        `/products/category/${encodeURIComponent(categorySlug)}`,
+        { includeSitesSegment: false }
+      )
     ), queryParams);
   }
 }

package/src/types/index.ts

@@ -221,6 +221,7 @@ export interface Content {
   contentMarkdown?: string;
   custom?: Record<string, any>;
   slug?: string;
+  slug_prefix?: string;
   pageStatus: ContentStatus;
   pageType: ContentType;
   userId?: number;
@@ -246,6 +247,7 @@ export interface ContentQueryParams extends PaginationParams {
   page_type?: ContentType;
   search?: string;
   user_id?: number;
+  slug_prefix?: string;
 }
 
 // Categories
@@ -320,6 +322,7 @@ export interface ProductQueryParams extends PaginationParams {
   search?: string;
   category?: string | string[];
   category_id?: number | string | Array<number | string>;
+  slug_prefix?: string;
 }
 
 export interface BlogPost {