@proveanything/smartlinks 1.14.17 → 1.15.1

package/README.md

@@ -123,7 +123,8 @@ import { products } from '@proveanything/smartlinks'
 
 await products.get(collectionId, productId, false)
 await products.list(collectionId, false)
-await products.query(collectionId, { query: { search: 'cabernet' } })
+await products.query(collectionId, { query: { search: 'cabernet' } }) // public
+await products.query(collectionId, { query: { search: 'cabernet' } }, true) // admin
 ```
 
 Quick mapping:

package/dist/api/collection.d.ts

@@ -1,4 +1,4 @@
-import { CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, AppsConfigResponse } from "../types/collection";
+import { CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, AppsConfigResponse, DomainTarget, HubAvailabilityResponse } from "../types/collection";
 export declare namespace collection {
     /**
      * Retrieves a single Collection by its ID.
@@ -21,6 +21,62 @@ export declare namespace collection {
      * @returns Promise resolving to a CollectionResponse object
      */
     function getShortId(shortId: string): 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`).
+     *
+     * @returns Promise resolving to the CollectionResponse mapped to the domain
+     * @throws ErrorResponse (404) if no collection is mapped to the domain
+     */
+    function getByHub(): Promise<CollectionResponse>;
+    /**
+     * Check whether a Hub subdomain name is available to claim (admin only).
+     * @param collectionId – Identifier of the collection making the request
+     * @param name – Proposed subdomain prefix (lowercase letters, numbers, hyphens; max 63 chars)
+     * @returns Promise resolving to { available, domain }
+     * @throws ErrorResponse (400) if the name fails validation or is reserved
+     */
+    function checkHubAvailability(collectionId: string, name: string): Promise<HubAvailabilityResponse>;
+    /**
+     * 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.
+     *
+     * @param collectionId – Identifier of the collection
+     * @param hubName – The subdomain prefix to claim (e.g. "acme")
+     * @returns Promise resolving to the updated CollectionResponse (with hubName set)
+     * @throws ErrorResponse (400) on invalid/reserved name, (409) if already taken by another collection
+     */
+    function claimHub(collectionId: string, hubName: string): Promise<CollectionResponse>;
+    /**
+     * Register a custom domain for a collection and provision its managed
+     * certificate (admin only).
+     *
+     * @param collectionId – Identifier of the collection
+     * @param domain – The fully-qualified domain to register (e.g. "hub.acme.com")
+     * @param target – Which load balancer / certificate map to use. Defaults to
+     *   `"smartlinks"` (the id.smartlinks.app load balancer). Pass `"hub"` to
+     *   register a bring-your-own Hub domain.
+     * @returns Promise resolving when registration has been initiated
+     * @throws ErrorResponse if the request fails
+     */
+    function registerDomain(collectionId: string, domain: string, target?: DomainTarget): Promise<any>;
+    /**
+     * Get the managed-certificate status for a collection's custom domain (admin only).
+     * @param collectionId – Identifier of the collection
+     * @param target – Which domain to check: `"smartlinks"` (default, uses `redirectUrl`)
+     *   or `"hub"` (uses `hubCustomDomain`)
+     * @returns Promise resolving to the certificate details
+     * @throws ErrorResponse (404) if the relevant domain is not set
+     */
+    function getDomainStatus(collectionId: string, target?: DomainTarget): 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

package/dist/api/collection.js

@@ -37,6 +37,84 @@ export var collection;
         return request(path);
     }
     collection.getShortId = getShortId;
+    /**
+     * 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`).
+     *
+     * @returns Promise resolving to the CollectionResponse mapped to the domain
+     * @throws ErrorResponse (404) if no collection is mapped to the domain
+     */
+    async function getByHub() {
+        const path = `/public/collection/getByHub`;
+        return request(path);
+    }
+    collection.getByHub = getByHub;
+    /**
+     * Check whether a Hub subdomain name is available to claim (admin only).
+     * @param collectionId – Identifier of the collection making the request
+     * @param name – Proposed subdomain prefix (lowercase letters, numbers, hyphens; max 63 chars)
+     * @returns Promise resolving to { available, domain }
+     * @throws ErrorResponse (400) if the name fails validation or is reserved
+     */
+    async function checkHubAvailability(collectionId, name) {
+        const queryParams = new URLSearchParams({ name });
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/hub/available?${queryParams}`;
+        return request(path);
+    }
+    collection.checkHubAvailability = checkHubAvailability;
+    /**
+     * 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.
+     *
+     * @param collectionId – Identifier of the collection
+     * @param hubName – The subdomain prefix to claim (e.g. "acme")
+     * @returns Promise resolving to the updated CollectionResponse (with hubName set)
+     * @throws ErrorResponse (400) on invalid/reserved name, (409) if already taken by another collection
+     */
+    async function claimHub(collectionId, hubName) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/hub`;
+        return post(path, { hubName });
+    }
+    collection.claimHub = claimHub;
+    /**
+     * Register a custom domain for a collection and provision its managed
+     * certificate (admin only).
+     *
+     * @param collectionId – Identifier of the collection
+     * @param domain – The fully-qualified domain to register (e.g. "hub.acme.com")
+     * @param target – Which load balancer / certificate map to use. Defaults to
+     *   `"smartlinks"` (the id.smartlinks.app load balancer). Pass `"hub"` to
+     *   register a bring-your-own Hub domain.
+     * @returns Promise resolving when registration has been initiated
+     * @throws ErrorResponse if the request fails
+     */
+    async function registerDomain(collectionId, domain, target = "smartlinks") {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/domain`;
+        return post(path, { domain, target });
+    }
+    collection.registerDomain = registerDomain;
+    /**
+     * Get the managed-certificate status for a collection's custom domain (admin only).
+     * @param collectionId – Identifier of the collection
+     * @param target – Which domain to check: `"smartlinks"` (default, uses `redirectUrl`)
+     *   or `"hub"` (uses `hubCustomDomain`)
+     * @returns Promise resolving to the certificate details
+     * @throws ErrorResponse (404) if the relevant domain is not set
+     */
+    async function getDomainStatus(collectionId, target = "smartlinks") {
+        const queryParams = new URLSearchParams({ target });
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/domain?${queryParams}`;
+        return request(path);
+    }
+    collection.getDomainStatus = getDomainStatus;
     /**
      * Retrieve a specific settings group for a collection.
      * Public reads return the public view of the settings group. If the stored payload contains

package/dist/api/products.d.ts

@@ -5,7 +5,26 @@ export declare namespace products {
     function create(collectionId: string, data: ProductCreateRequest): Promise<ProductResponse>;
     function update(collectionId: string, productId: string, data: ProductUpdateRequest): Promise<ProductResponse>;
     function remove(collectionId: string, productId: string): Promise<void>;
-    function query(collectionId: string, body: ProductQueryRequest): Promise<ProductQueryResponse>;
+    /**
+     * Query products in a collection with filtering, sorting, and pagination.
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param body - Query parameters with filters, sorting, and pagination
+     * @param admin - When `true`, targets the `/admin` endpoint (requires an
+     *   authenticated admin context). Defaults to `false`, which targets the
+     *   `/public` endpoint — consistent with `get`, `list`, and `listAssets`.
+     * @returns Promise resolving to a ProductQueryResponse
+     *
+     * @example
+     * ```typescript
+     * // Public query (default)
+     * await products.query(collectionId, { query: { search: 'cabernet' } })
+     *
+     * // Admin query (authenticated)
+     * await products.query(collectionId, { query: { search: 'cabernet' } }, true)
+     * ```
+     */
+    function query(collectionId: string, body: ProductQueryRequest, admin?: boolean): Promise<ProductQueryResponse>;
     function clone(collectionId: string, productId: string, body?: Record<string, JsonValue>): Promise<ProductResponse>;
     function listAssets(collectionId: string, productId: string, admin?: boolean): Promise<unknown>;
     function createClaimWindow(collectionId: string, productId: string, body: Record<string, JsonValue>): Promise<unknown>;

package/dist/api/products.js

@@ -28,8 +28,28 @@ export var products;
         return del(path);
     }
     products.remove = remove;
-    async function query(collectionId, body) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/products/query`;
+    /**
+     * Query products in a collection with filtering, sorting, and pagination.
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param body - Query parameters with filters, sorting, and pagination
+     * @param admin - When `true`, targets the `/admin` endpoint (requires an
+     *   authenticated admin context). Defaults to `false`, which targets the
+     *   `/public` endpoint — consistent with `get`, `list`, and `listAssets`.
+     * @returns Promise resolving to a ProductQueryResponse
+     *
+     * @example
+     * ```typescript
+     * // Public query (default)
+     * await products.query(collectionId, { query: { search: 'cabernet' } })
+     *
+     * // Admin query (authenticated)
+     * await products.query(collectionId, { query: { search: 'cabernet' } }, true)
+     * ```
+     */
+    async function query(collectionId, body, admin) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/products/query`;
         return post(path, body);
     }
     products.query = query;

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.14.17  |  Generated: 2026-06-02T16:17:46.100Z
+Version: 1.15.1  |  Generated: 2026-06-13T08:46:42.914Z
 
 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'`
@@ -8604,6 +8616,21 @@ 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`).
+
+**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`.
 
@@ -9399,44 +9426,55 @@ Look up a serial number by code for a product (admin only).
     productId: string) → `Promise<void>`
 
 **query**(collectionId: string,
-    body: ProductQueryRequest) → `Promise<ProductQueryResponse>`
+    body: ProductQueryRequest,
+    admin?: boolean) → `Promise<ProductQueryResponse>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **clone**(collectionId: string,
     productId: string,
     body: Record<string, JsonValue> = {}) → `Promise<ProductResponse>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **listAssets**(collectionId: string,
     productId: string,
     admin?: boolean) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **createClaimWindow**(collectionId: string,
     productId: string,
     body: Record<string, JsonValue>) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **updateClaimWindow**(collectionId: string,
     productId: string,
     claimId: string,
     body: Record<string, JsonValue>) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **refresh**(collectionId: string,
     productId: string) → `Promise<ProductResponse>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **getSN**(collectionId: string,
     productId: string,
     startIndex: number = 0,
     count: number = 10) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **lookupSN**(collectionId: string,
     productId: string,
     codeId: string) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **publicLookupClaim**(collectionId: string,
     productId: string,
     claimId: string) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **publicCreateClaim**(collectionId: string,
     productId: string,
     body: ProductClaimCreateRequestBody) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 ### proof
 

package/dist/http.js

@@ -91,7 +91,9 @@ const CACHE_TTL_RULES = [
     // Sub-resources that change frequently — short TTLs, listed first
     { pattern: /\/proof\/[^/]*(\?.*)?$/i, ttlMs: 30000 },
     { pattern: /\/attestation\/[^/]*(\?.*)?$/i, ttlMs: 2 * 60000 },
-    // Slow-changing top-level resources — long TTLs, matched only when path ends at the ID
+    // Slow-changing top-level resources — long TTLs, matched only when path ends at the ID.
+    // getByHub maps a stable Hub domain → collection and matches the /collection rule below,
+    // so it inherits the same 1h caching as a collection detail.
     { pattern: /\/products?\/[^/]*(\?.*)?$/i, ttlMs: 60 * 60000 },
     { pattern: /\/variant\/[^/]*(\?.*)?$/i, ttlMs: 60 * 60000 },
     { pattern: /\/collection\/[^/]*(\?.*)?$/i, ttlMs: 60 * 60000 }, // 1 hour

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export type { AppConfigOptions } from "./api/appConfiguration";
 export type { AdditionalGtin, ISODateString, JsonPrimitive, JsonValue, ProductCreateRequest, ProductClaimCreateInput, ProductClaimCreateRequestBody, ProductClaimLookupInput, ProductFacetMap, ProductFacetValue, ProductImageUrlInput, ProductKey, ProductQueryRequest, ProductQueryResponse, ProductUpdateRequest, Product, ProductWriteInput, PublicProduct, } from "./types/product";
 export type { TranslationLookupMode, TranslationContentType, TranslationQuality, TranslationItemStatus, TranslationContextValue, TranslationContext, TranslationLookupRequestBase, TranslationLookupSingleRequest, TranslationLookupBatchRequest, TranslationLookupRequest, TranslationLookupItem, TranslationLookupResponse, ResolvedTranslationItem, ResolvedTranslationResponse, TranslationHashOptions, TranslationResolveOptions, TranslationRecord, TranslationListParams, TranslationListResponse, TranslationUpdateRequest, } from "./types/translations";
 export type { FacetBucket, FacetDefinition, FacetDefinitionWriteInput, FacetGetParams, FacetListParams, FacetListResponse, FacetQueryRequest, FacetQueryResponse, FacetValue, FacetValueDefinition, FacetValueGetParams, FacetValueListParams, FacetValueListResponse, FacetValueResponse, FacetValueWriteInput, PublicFacetListParams, } from "./types/facets";
-export type { Collection, CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, } from "./types/collection";
+export type { Collection, CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, DomainTarget, HubAvailabilityResponse, } from "./types/collection";
 export type { Proof, ProofResponse, ProofCreateRequest, ProofUpdateRequest, ProofClaimRequest, } from "./types/proof";
 export type { QrShortCodeLookupResponse, } from "./types/qr";
 export type { ReverseTagLookupParams, ReverseTagLookupResponse, } from "./types/tags";

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:
@@ -3871,6 +3928,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:
@@ -6639,39 +6750,6 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/ProductCreateRequest"
-  /admin/collection/{collectionId}/products/query:
-    post:
-      tags:
-        - products
-      summary: products.query
-      operationId: products_query
-      security:
-        - bearerAuth: []
-      parameters:
-        - name: collectionId
-          in: path
-          required: true
-          schema:
-            type: string
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/ProductQueryResponse"
-        400:
-          description: Bad request
-        401:
-          description: Unauthorized
-        404:
-          description: Not found
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/ProductQueryRequest"
   /admin/collection/{collectionId}/products/{productId}:
     put:
       tags:
@@ -9238,6 +9316,26 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/RequestUploadTokenOptions"
+  /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:
@@ -18941,6 +19039,10 @@ components:
             type: string
         redirectUrl:
           type: string
+        hubName:
+          type: string
+        hubCustomDomain:
+          type: string
         shortId:
           type: string
         dark:
@@ -18975,6 +19077,16 @@ components:
         - variants
         - batches
         - defaultAuthKitId
+    HubAvailabilityResponse:
+      type: object
+      properties:
+        available:
+          type: boolean
+        domain:
+          type: string
+      required:
+        - available
+        - domain
     AppConfig:
       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/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.14.17  |  Generated: 2026-06-02T16:17:46.100Z
+Version: 1.15.1  |  Generated: 2026-06-13T08:46:42.914Z
 
 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'`
@@ -8604,6 +8616,21 @@ 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`).
+
+**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`.
 
@@ -9399,44 +9426,55 @@ Look up a serial number by code for a product (admin only).
     productId: string) → `Promise<void>`
 
 **query**(collectionId: string,
-    body: ProductQueryRequest) → `Promise<ProductQueryResponse>`
+    body: ProductQueryRequest,
+    admin?: boolean) → `Promise<ProductQueryResponse>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **clone**(collectionId: string,
     productId: string,
     body: Record<string, JsonValue> = {}) → `Promise<ProductResponse>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **listAssets**(collectionId: string,
     productId: string,
     admin?: boolean) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **createClaimWindow**(collectionId: string,
     productId: string,
     body: Record<string, JsonValue>) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **updateClaimWindow**(collectionId: string,
     productId: string,
     claimId: string,
     body: Record<string, JsonValue>) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **refresh**(collectionId: string,
     productId: string) → `Promise<ProductResponse>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **getSN**(collectionId: string,
     productId: string,
     startIndex: number = 0,
     count: number = 10) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **lookupSN**(collectionId: string,
     productId: string,
     codeId: string) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **publicLookupClaim**(collectionId: string,
     productId: string,
     claimId: string) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 **publicCreateClaim**(collectionId: string,
     productId: string,
     body: ProductClaimCreateRequestBody) → `Promise<unknown>`
+Query products in a collection with filtering, sorting, and pagination. authenticated admin context). Defaults to `false`, which targets the `/public` endpoint — consistent with `get`, `list`, and `listAssets`. ```typescript // Public query (default) await products.query(collectionId, { query: { search: 'cabernet' } }) // Admin query (authenticated) await products.query(collectionId, { query: { search: 'cabernet' } }, true) ```
 
 ### proof
 

package/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:
@@ -3871,6 +3928,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:
@@ -6639,39 +6750,6 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/ProductCreateRequest"
-  /admin/collection/{collectionId}/products/query:
-    post:
-      tags:
-        - products
-      summary: products.query
-      operationId: products_query
-      security:
-        - bearerAuth: []
-      parameters:
-        - name: collectionId
-          in: path
-          required: true
-          schema:
-            type: string
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/ProductQueryResponse"
-        400:
-          description: Bad request
-        401:
-          description: Unauthorized
-        404:
-          description: Not found
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/ProductQueryRequest"
   /admin/collection/{collectionId}/products/{productId}:
     put:
       tags:
@@ -9238,6 +9316,26 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/RequestUploadTokenOptions"
+  /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:
@@ -18941,6 +19039,10 @@ components:
             type: string
         redirectUrl:
           type: string
+        hubName:
+          type: string
+        hubCustomDomain:
+          type: string
         shortId:
           type: string
         dark:
@@ -18975,6 +19077,16 @@ components:
         - variants
         - batches
         - defaultAuthKitId
+    HubAvailabilityResponse:
+      type: object
+      properties:
+        available:
+          type: boolean
+        domain:
+          type: string
+      required:
+        - available
+        - domain
     AppConfig:
       type: object
       properties:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.14.17",
+  "version": "1.15.1",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",