@proveanything/smartlinks 1.15.0 → 1.15.2

package/dist/openapi.yaml

@@ -3337,6 +3337,63 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /admin/collection/{collectionId}/domain:
+    get:
+      tags:
+        - collection
+      summary: "Get the managed-certificate status for a collection's custom domain (admin only)."
+      operationId: collection_getDomainStatus
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema: {}
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+    post:
+      tags:
+        - collection
+      summary: Register a custom domain for a collection and provision its managed certificate (admin only).
+      operationId: collection_registerDomain
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema: {}
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/DomainTarget"
   /admin/collection/{collectionId}/facets:
     get:
       tags:
@@ -3372,6 +3429,11 @@ paths:
           required: false
           schema:
             type: boolean
+        - name: namespace
+          in: query
+          required: false
+          schema:
+            type: string
       responses:
         200:
           description: Success
@@ -3417,6 +3479,33 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/FacetDefinitionWriteInput"
+  /admin/collection/{collectionId}/facets/namespaces:
+    get:
+      tags:
+        - facets
+      summary: facets.namespaces
+      operationId: facets_namespaces
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FacetNamespaceListResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /admin/collection/{collectionId}/facets/query:
     post:
       tags:
@@ -3871,6 +3960,60 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /admin/collection/{collectionId}/hub:
+    post:
+      tags:
+        - collection
+      summary: Claim or rename the Hub subdomain for a collection (admin only).
+      operationId: collection_claimHub
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CollectionResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/hub/available:
+    get:
+      tags:
+        - collection
+      summary: Check whether a Hub subdomain name is available to claim (admin only).
+      operationId: collection_checkHubAvailability
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HubAvailabilityResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /admin/collection/{collectionId}/interactions:
     get:
       tags:
@@ -9205,6 +9348,52 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/RequestUploadTokenOptions"
+  /public/collection/by-domain/{domain}:
+    get:
+      tags:
+        - collection
+      summary: Resolve the collection for an explicit Hub domain (public endpoint).
+      operationId: collection_getByDomain
+      security: []
+      parameters:
+        - name: domain
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CollectionResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/getByHub:
+    get:
+      tags:
+        - collection
+      summary: Resolve the collection for the current Hub domain (public endpoint).
+      operationId: collection_getByHub
+      security: []
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CollectionResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /public/collection/getShortId/{shortId}:
     get:
       tags:
@@ -10680,6 +10869,11 @@ paths:
           required: false
           schema:
             type: boolean
+        - name: namespace
+          in: query
+          required: false
+          schema:
+            type: string
       responses:
         200:
           description: Success
@@ -10693,6 +10887,32 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /public/collection/{collectionId}/facets/namespaces:
+    get:
+      tags:
+        - facets
+      summary: facets.publicNamespaces
+      operationId: facets_publicNamespaces
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FacetNamespaceListResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /public/collection/{collectionId}/facets/query:
     post:
       tags:
@@ -10748,6 +10968,11 @@ paths:
           required: false
           schema:
             type: boolean
+        - name: namespace
+          in: query
+          required: false
+          schema:
+            type: string
       responses:
         200:
           description: Success
@@ -18908,6 +19133,10 @@ components:
             type: string
         redirectUrl:
           type: string
+        hubName:
+          type: string
+        hubCustomDomain:
+          type: string
         shortId:
           type: string
         dark:
@@ -18942,6 +19171,16 @@ components:
         - variants
         - batches
         - defaultAuthKitId
+    HubAvailabilityResponse:
+      type: object
+      properties:
+        available:
+          type: boolean
+        domain:
+          type: string
+      required:
+        - available
+        - domain
     AppConfig:
       type: object
       properties:
@@ -20552,6 +20791,8 @@ components:
           type: string
         description:
           type: string
+        namespace:
+          type: string
         cardinality:
           type: object
           additionalProperties: true
@@ -20647,6 +20888,8 @@ components:
           type: string
         description:
           type: string
+        namespace:
+          type: string
         cardinality:
           type: object
           additionalProperties: true
@@ -20742,6 +20985,8 @@ components:
           type: boolean
         includeDeleted:
           type: boolean
+        namespace:
+          type: string
         query:
           type: object
           additionalProperties: true
@@ -20809,11 +21054,24 @@ components:
           additionalProperties: true
         reserved:
           type: boolean
+        namespace:
+          type: string
     PublicFacetListParams:
       type: object
       properties:
         includeValues:
           type: boolean
+        namespace:
+          type: string
+    FacetNamespaceListResponse:
+      type: object
+      properties:
+        namespaces:
+          type: array
+          items:
+            type: string
+      required:
+        - namespaces
     FacetGetParams:
       type: object
       properties:

package/dist/types/collection.d.ts

@@ -41,6 +41,10 @@ export interface Collection {
     groupTags?: string[];
     /** Whether the collection has a custom domain */
     redirectUrl?: string;
+    /** The claimed Hub subdomain prefix (e.g. "acme" → acme.mysmartlinks.app) */
+    hubName?: string;
+    /** The collection's bring-your-own custom Hub domain (e.g. "hub.acme.com") */
+    hubCustomDomain?: string;
     /** The shortId of this collection */
     shortId: string;
     /** if dark mode is enabled for this collection */
@@ -59,6 +63,21 @@ export interface Collection {
 export type CollectionResponse = Collection;
 export type CollectionCreateRequest = Omit<Collection, 'id' | 'shortId'>;
 export type CollectionUpdateRequest = Partial<Omit<Collection, 'id' | 'shortId'>>;
+/**
+ * Which load balancer / certificate map a custom domain registration targets.
+ * - `"smartlinks"` (default): the id.smartlinks.app load balancer (legacy behaviour)
+ * - `"hub"`: the SmartLinks Hub load balancer
+ */
+export type DomainTarget = "smartlinks" | "hub";
+/**
+ * Response from checking whether a Hub subdomain name is available.
+ */
+export interface HubAvailabilityResponse {
+    /** Whether the name can be claimed by this collection */
+    available: boolean;
+    /** The full domain that was checked (e.g. "acme.mysmartlinks.app") */
+    domain: string;
+}
 /**
  * Configuration for an app module within a collection.
  */

package/dist/types/facets.d.ts

@@ -6,6 +6,7 @@ export interface FacetDefinition {
     key: string;
     name: string;
     description?: string | null;
+    namespace?: string | null;
     cardinality?: "single" | "multi";
     kind?: "system" | "custom";
     hierarchical?: boolean;
@@ -46,6 +47,7 @@ export interface FacetDefinitionWriteInput {
     key?: string;
     name: string;
     description?: string | null;
+    namespace?: string | null;
     cardinality?: "single" | "multi";
     kind?: "system" | "custom";
     hierarchical?: boolean;
@@ -83,6 +85,7 @@ export interface FacetQueryRequest {
     facetKeys?: string[];
     includeEmpty?: boolean;
     includeDeleted?: boolean;
+    namespace?: string | null;
     query?: ProductQueryRequest["query"] & {
         facetEquals?: Record<string, JsonValue | JsonValue[]>;
     };
@@ -109,9 +112,14 @@ export interface FacetListParams {
     includeDeleted?: boolean;
     kind?: "system" | "custom";
     reserved?: boolean;
+    namespace?: string;
 }
 export interface PublicFacetListParams {
     includeValues?: boolean;
+    namespace?: string;
+}
+export interface FacetNamespaceListResponse {
+    namespaces: string[];
 }
 export interface FacetGetParams {
     includeValues?: boolean;

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.15.0  |  Generated: 2026-06-03T10:03:05.999Z
+Version: 1.15.2  |  Generated: 2026-07-05T07:39:20.416Z
 
 This is a concise summary of all available API functions and types.
 
@@ -3606,6 +3606,8 @@ interface Collection {
   } // User roles mapping with user IDs as keys and role names as values
   groupTags?: string[] // Array of group tag names
   redirectUrl?: string // Whether the collection has a custom domain
+  hubName?: string
+  hubCustomDomain?: string
   shortId: string, // The shortId of this collection
   dark?: boolean // if dark mode is enabled for this collection
   primaryColor?: string
@@ -3618,6 +3620,14 @@ interface Collection {
 }
 ```
 
+**HubAvailabilityResponse** (interface)
+```typescript
+interface HubAvailabilityResponse {
+  available: boolean
+  domain: string
+}
+```
+
 **AppConfig** (interface)
 ```typescript
 interface AppConfig {
@@ -3657,6 +3667,8 @@ interface AppsConfigResponse {
 
 **CollectionUpdateRequest** = `Partial<Omit<Collection, 'id' | 'shortId'>>`
 
+**DomainTarget** = `"smartlinks" | "hub"`
+
 ### common
 
 **IdField** = `'userId' | 'contactId'`
@@ -5027,6 +5039,7 @@ interface FacetDefinition {
   key: string
   name: string
   description?: string | null
+  namespace?: string | null
   cardinality?: "single" | "multi"
   kind?: "system" | "custom"
   hierarchical?: boolean
@@ -5075,6 +5088,7 @@ interface FacetDefinitionWriteInput {
   key?: string
   name: string
   description?: string | null
+  namespace?: string | null
   cardinality?: "single" | "multi"
   kind?: "system" | "custom"
   hierarchical?: boolean
@@ -5132,6 +5146,7 @@ interface FacetQueryRequest {
   facetKeys?: string[]
   includeEmpty?: boolean
   includeDeleted?: boolean
+  namespace?: string | null
   query?: ProductQueryRequest["query"] & {
   facetEquals?: Record<string, JsonValue | JsonValue[]>
   }
@@ -5170,6 +5185,7 @@ interface FacetListParams {
   includeDeleted?: boolean
   kind?: "system" | "custom"
   reserved?: boolean
+  namespace?: string
 }
 ```
 
@@ -5177,6 +5193,14 @@ interface FacetListParams {
 ```typescript
 interface PublicFacetListParams {
   includeValues?: boolean
+  namespace?: string
+}
+```
+
+**FacetNamespaceListResponse** (interface)
+```typescript
+interface FacetNamespaceListResponse {
+  namespaces: string[]
 }
 ```
 
@@ -8604,6 +8628,24 @@ Retrieves all Collections.
 **getShortId**(shortId: string) → `Promise<CollectionResponse>`
 Retrieve a collection by its shortId (public endpoint).
 
+**getByHub**() → `Promise<CollectionResponse>`
+Resolve the collection for the current Hub domain (public endpoint). The server derives the requesting domain from the request headers (`X-Source-Domain` / `X-Forwarded-Host` / `Host`), so no identifier is passed — this is the call a Hub frontend makes on load to find out which collection it is serving, whether it's reached via `{brand}.mysmartlinks.app` or a bring-your-own custom domain (e.g. `hub.acme.com`).
+
+**getByDomain**(domain: string) → `Promise<CollectionResponse>`
+Resolve the collection for an explicit Hub domain (public endpoint). Unlike {@link getByHub}, the domain is passed explicitly rather than derived from request headers — use this for raw/cross-origin calls where the Hub frontend knows its own hostname (e.g. "erbauer.mysmartlinks.app").
+
+**checkHubAvailability**(collectionId: string, name: string) → `Promise<HubAvailabilityResponse>`
+Check whether a Hub subdomain name is available to claim (admin only).
+
+**claimHub**(collectionId: string, hubName: string) → `Promise<CollectionResponse>`
+Claim or rename the Hub subdomain for a collection (admin only). Maps `{hubName}.mysmartlinks.app` to the collection. If the collection already had a different hub name, the previous subdomain is released automatically.
+
+**registerDomain**(collectionId: string, domain: string, target: DomainTarget = "smartlinks") → `Promise<any>`
+Register a custom domain for a collection and provision its managed certificate (admin only). `"smartlinks"` (the id.smartlinks.app load balancer). Pass `"hub"` to register a bring-your-own Hub domain.
+
+**getDomainStatus**(collectionId: string, target: DomainTarget = "smartlinks") → `Promise<any>`
+Get the managed-certificate status for a collection's custom domain (admin only). or `"hub"` (uses `hubCustomDomain`)
+
 **getSettings**(collectionId: string, settingGroup: string, admin?: boolean) → `Promise<any>`
 Retrieve a specific settings group for a collection. Public reads return the public view of the settings group. If the stored payload contains a top-level `admin` object, that block is omitted from public responses and included when `admin === true`.
 
@@ -8915,6 +8957,8 @@ Delete a crate for a collection (admin only). This performs a soft delete. ```ty
 **query**(collectionId: string,
     body: FacetQueryRequest) → `Promise<FacetQueryResponse>`
 
+**namespaces**(collectionId: string) → `Promise<FacetNamespaceListResponse>`
+
 **publicList**(collectionId: string,
     params?: PublicFacetListParams) → `Promise<FacetListResponse>`
 
@@ -8932,6 +8976,8 @@ Delete a crate for a collection (admin only). This performs a soft delete. ```ty
 **publicQuery**(collectionId: string,
     body: FacetQueryRequest) → `Promise<FacetQueryResponse>`
 
+**publicNamespaces**(collectionId: string) → `Promise<FacetNamespaceListResponse>`
+
 ### form
 
 **get**(collectionId: string, formId: string, admin?: boolean) → `Promise<any>`

package/docs/PRODUCT_FACETS_SDK.md

@@ -42,6 +42,21 @@ includeValues?: boolean
 includeDeleted?: boolean
 kind?: 'system' | 'custom'
 reserved?: boolean
+namespace?: string
+```
+
+When `namespace` is provided, returns facets matching that namespace plus global facets (`namespace: null`). Omit the param to return all facets.
+
+### List namespaces
+
+```ts
+GET /api/v1/admin/collection/:collectionId/facets/namespaces
+```
+
+Returns all distinct namespaces in use for the collection (excludes globals).
+
+```ts
+{ namespaces: string[] }
 ```
 
 ### Create facet definition
@@ -50,6 +65,8 @@ reserved?: boolean
 POST /api/v1/admin/collection/:collectionId/facets
 ```
 
+Pass `namespace` in the body to scope the facet to a domain (e.g. `"dpp"`, `"nutrition"`). Omit it to create a global facet.
+
 ### Get facet definition
 
 ```ts
@@ -146,6 +163,8 @@ Supported query filters now:
 - `tags`
 - `facetEquals`
 
+Body also accepts `namespace` (optional) to scope aggregation to a namespace plus global facets.
+
 ## Public endpoints
 
 ### List facet definitions
@@ -158,6 +177,21 @@ Optional query params:
 
 ```ts
 includeValues?: boolean
+namespace?: string
+```
+
+When `namespace` is provided, returns facets matching that namespace plus global facets (`namespace: null`). Omit the param to return all facets.
+
+### List namespaces
+
+```ts
+GET /api/v1/public/collection/:collectionId/facets/namespaces
+```
+
+Returns all distinct namespaces in use for the collection (excludes globals).
+
+```ts
+{ namespaces: string[] }
 ```
 
 ### Get facet definition
@@ -215,6 +249,7 @@ export interface FacetDefinition {
   key: string
   name: string
   description?: string | null
+  namespace?: string | null
   cardinality: 'single' | 'multi'
   kind: 'system' | 'custom'
   hierarchical: boolean
@@ -230,6 +265,7 @@ export interface FacetDefinitionWriteInput {
   key?: string
   name: string
   description?: string | null
+  namespace?: string | null
   cardinality?: 'single' | 'multi'
   kind?: 'system' | 'custom'
   hierarchical?: boolean
@@ -305,6 +341,7 @@ export interface FacetQueryRequest {
   facetKeys?: string[]
   includeEmpty?: boolean
   includeDeleted?: boolean
+  namespace?: string | null
   query?: {
     search?: string
     status?: string[]
@@ -326,6 +363,10 @@ export interface FacetBucket {
   count: number
 }
 
+export interface FacetNamespaceListResponse {
+  namespaces: string[]
+}
+
 export interface FacetQueryResponse {
   items: Array<{
     facet: FacetDefinition
@@ -344,4 +385,5 @@ export interface FacetQueryResponse {
 - treat facet definitions and facet values as collection-scoped resources
 - use the facet API to manage definitions and values
 - use product read/write routes to assign facet data onto products
-- treat `label` and `category` as reserved system facets when present
+- treat `label` and `category` as reserved system facets when present
+- facets with `namespace: null` are global and appear in all contexts; namespaced facets belong to a specific domain (e.g. `"dpp"`, `"nutrition"`)