@proveanything/smartlinks 1.15.3 → 1.15.5

package/dist/openapi.yaml

@@ -9602,7 +9602,7 @@ paths:
     get:
       tags:
         - collection
-      summary: Retrieve all configured app module definitions for a collection (public endpoint).
+      summary: "Retrieve all configured app module definitions for a collection (public endpoint), plus the collection's `appConfig` entitlements data (`system.features`, `system.meters`, `entitledAppGroups`, `itemRecordMode`, etc.) in the same response."
       operationId: collection_getAppsConfig
       security: []
       parameters:
@@ -15592,6 +15592,140 @@ components:
       required:
         - id
         - name
+    AppEntry:
+      type: object
+      properties:
+        id:
+          type: string
+        uniqueName:
+          type: string
+        customName:
+          type: string
+        active:
+          type: boolean
+        all:
+          type: boolean
+        live:
+          type: boolean
+        faIcon:
+          type: string
+        versionChannel:
+          type: string
+          enum:
+            - stable
+            - beta
+            - dev
+        reason:
+          type: string
+          enum:
+            - not_entitled
+      required:
+        - id
+        - uniqueName
+        - active
+    MeterEntry:
+      type: object
+      properties:
+        included:
+          type: number
+        stripePriceId:
+          type: string
+        stripeMeterId:
+          type: string
+      required:
+        - included
+    AppliedOverridesSummary:
+      type: object
+      properties:
+        features:
+          type: array
+          items:
+            type: string
+        meters:
+          type: array
+          items:
+            type: string
+        entitledAppGroups:
+          type: array
+          items:
+            type: string
+        addOnKeys:
+          type: array
+          items:
+            type: string
+        apps:
+          type: array
+          items:
+            type: string
+        accountType:
+          type: boolean
+        note:
+          type: string
+    SystemBlock:
+      type: object
+      properties:
+        basePlanId:
+          type: string
+        addOnKeys:
+          type: array
+          items:
+            type: string
+        apps:
+          type: array
+          items:
+            type: string
+        features:
+          type: object
+          additionalProperties:
+            type: boolean
+        meters:
+          type: object
+          additionalProperties:
+            $ref: "#/components/schemas/MeterEntry"
+        entitledAppGroups:
+          type: array
+          items:
+            type: string
+        accountType:
+          type: string
+          enum:
+            - enterprise
+            - standard
+        syncedAt:
+          type: string
+        syncedFromSubscriptionId:
+          type: string
+        appliedOverrides:
+          $ref: "#/components/schemas/AppliedOverridesSummary"
+    AppConfigSettings:
+      type: object
+      properties:
+        id:
+          type: string
+          enum:
+            - appConfig
+        apps:
+          type: array
+          items:
+            $ref: "#/components/schemas/AppEntry"
+        addOns:
+          type: array
+          items:
+            type: string
+        requestedBasePlanId:
+          type: string
+        itemRecordMode:
+          type: string
+          enum:
+            - registered
+            - owned
+        virtualItemsEnabled:
+          type: boolean
+        system:
+          $ref: "#/components/schemas/SystemBlock"
+      required:
+        - id
+        - apps
     AppBundle:
       type: object
       properties:
@@ -24084,6 +24218,67 @@ components:
             $ref: "#/components/schemas/JsonValue"
       required:
         - claimId
+    ScopedFieldOption:
+      type: object
+      properties:
+        value:
+          type: string
+        label:
+          type: string
+      required:
+        - value
+        - label
+    ScopedFieldDef:
+      type: object
+      properties:
+        key:
+          type: string
+        label:
+          type: string
+        type:
+          $ref: "#/components/schemas/ScopedFieldType"
+        required:
+          type: boolean
+        placeholder:
+          type: string
+        help:
+          type: string
+        options:
+          type: array
+          items:
+            $ref: "#/components/schemas/ScopedFieldOption"
+        defaultValue:
+          $ref: "#/components/schemas/JsonValue"
+        showInTable:
+          type: boolean
+        showInDetail:
+          type: boolean
+      required:
+        - key
+        - label
+        - type
+    ProductFieldsConfig:
+      type: object
+      properties:
+        fields:
+          type: array
+          items:
+            $ref: "#/components/schemas/ProductFieldDef"
+      required:
+        - fields
+    ProofValues:
+      type: object
+      properties:
+        owner:
+          type: object
+          additionalProperties:
+            $ref: "#/components/schemas/JsonValue"
+        personal:
+          type: object
+          additionalProperties:
+            type: object
+            additionalProperties:
+              $ref: "#/components/schemas/JsonValue"
     Proof:
       type: object
       properties:
@@ -24103,9 +24298,16 @@ components:
           type: boolean
         virtual:
           type: boolean
-        values:
+        data:
           type: object
-          additionalProperties: true
+          additionalProperties:
+            $ref: "#/components/schemas/JsonValue"
+        admin:
+          type: object
+          additionalProperties:
+            $ref: "#/components/schemas/JsonValue"
+        values:
+          $ref: "#/components/schemas/ProofValues"
       required:
         - collectionId
         - createdAt
@@ -24118,14 +24320,30 @@ components:
       type: object
       properties:
         values:
+          $ref: "#/components/schemas/ProofValues"
+        data:
           type: object
-          additionalProperties: true
+          additionalProperties:
+            $ref: "#/components/schemas/JsonValue"
+        admin:
+          type: object
+          additionalProperties:
+            $ref: "#/components/schemas/JsonValue"
         claimable:
           type: boolean
         virtual:
           type: boolean
       required:
         - values
+    ProofFieldsConfig:
+      type: object
+      properties:
+        fields:
+          type: array
+          items:
+            $ref: "#/components/schemas/ProofFieldDef"
+      required:
+        - fields
     ProofResponse:
       type: object
       additionalProperties: true

package/dist/types/appConfiguration.d.ts

@@ -33,3 +33,86 @@ export interface WidgetInstanceSummary {
     type?: string;
     [key: string]: any;
 }
+/** One installed module instance on a collection. */
+export interface AppEntry {
+    /** Instance id (typically === uniqueName). */
+    id: string;
+    /** Module id from the module catalog. */
+    uniqueName: string;
+    /** Display name, overrideable. */
+    customName?: string;
+    /** User toggle. */
+    active: boolean;
+    /** Legacy scope flag. */
+    all?: boolean;
+    /** Legacy flag. */
+    live?: boolean;
+    /** Optional FA icon override. */
+    faIcon?: string;
+    versionChannel?: 'stable' | 'beta' | 'dev';
+    /** Set by reconcile when app category is outside entitledAppGroups. */
+    reason?: 'not_entitled';
+    /** Per-module inline settings preserved verbatim. */
+    [key: string]: unknown;
+}
+export interface MeterEntry {
+    included: number;
+    stripePriceId?: string;
+    stripeMeterId?: string;
+}
+export interface AppliedOverridesSummary {
+    features?: string[];
+    meters?: string[];
+    entitledAppGroups?: string[];
+    addOnKeys?: string[];
+    apps?: string[];
+    accountType?: boolean;
+    note?: string;
+}
+/** Resolved entitlements — written only by `entitlements-reconcile`, safe for every client to read. */
+export interface SystemBlock {
+    basePlanId?: string;
+    addOnKeys?: string[];
+    /** Apps unlocked by add-ons. */
+    apps?: string[];
+    /**
+     * Explicit overrides only — an absent key is NOT "off". Resolve with
+     * `resolveFeature()` / `isFeatureEnabled()`, which apply the accountType
+     * default: `enterprise` defaults every flag to on unless explicitly
+     * `false` here; `standard` defaults every flag to off unless explicitly
+     * `true` here.
+     */
+    features?: Record<string, boolean>;
+    meters?: Record<string, MeterEntry>;
+    /** Lowercased category names. */
+    entitledAppGroups?: string[];
+    /**
+     * Explicit account tier. `'enterprise'` flips the default for every
+     * feature flag to on (see `features`), not just an "unlimited baseline" —
+     * absence of a flag no longer means disabled for enterprise accounts.
+     */
+    accountType?: 'enterprise' | 'standard';
+    /** ISO-8601 UTC. */
+    syncedAt?: string;
+    syncedFromSubscriptionId?: string;
+    /** Diagnostic: which override keys reconcile applied on this pass. */
+    appliedOverrides?: AppliedOverridesSummary;
+}
+/**
+ * Full `appConfig` settings document for a SmartLinks collection.
+ * Fetch with `appConfiguration.getAppConfig(collectionId)`.
+ */
+export interface AppConfigSettings {
+    id: 'appConfig';
+    /** Installed modules — the customer's chosen surface. */
+    apps: AppEntry[];
+    /** Optional mirror of add-on keys the customer has toggled. */
+    addOns?: string[];
+    /** Wizard hint — which base plan the customer picked pre-checkout. */
+    requestedBasePlanId?: string;
+    /** How the account handles individual physical items. */
+    itemRecordMode?: 'registered' | 'owned' | null;
+    virtualItemsEnabled?: boolean;
+    /** Resolved entitlement truth. Read this to gate features. */
+    system?: SystemBlock;
+}

package/dist/types/collection.d.ts

@@ -1,4 +1,5 @@
 import { AssetRef } from "./asset";
+import type { AppConfigSettings } from "./appConfiguration";
 /**
  * Represents a Collection object.
  */
@@ -118,8 +119,16 @@ export interface AppConfig {
 }
 /**
  * Response containing app configurations for a collection.
+ *
+ * As of 2026-07-18 this endpoint (`/public/collection/:id/app/config`) also
+ * carries the `appConfig` settings-group entitlements data (`system`,
+ * `addOns`, `itemRecordMode`, etc.) alongside the app catalog — the same
+ * dataset documented in docs/appConfig.md, delivered by this endpoint
+ * instead of a separate `appConfiguration.getConfig({ appId: 'appConfig' })`
+ * call. Admin-only overrides are never included here since this is a
+ * public-only endpoint.
  */
-export interface AppsConfigResponse {
-    /** Array of app configurations */
+export interface AppsConfigResponse extends Omit<AppConfigSettings, 'id' | 'apps'> {
+    /** Array of app catalog definitions for this collection. */
     apps: AppConfig[];
 }

package/dist/types/product.d.ts

@@ -85,7 +85,9 @@ export interface Product extends ProductKey {
     facets?: ProductFacetMap;
     /** Tag keys where value is true */
     tags?: Record<string, boolean>;
+    /** Public custom data — readable by everyone, writable by business admins only. */
     data?: Record<string, JsonValue>;
+    /** Business-only custom data — stripped from public/non-admin reads. See docs/proof-product-data-scoping.md. */
     admin?: Record<string, JsonValue>;
     extra?: Record<string, JsonValue>;
     validCollections?: string[] | null;
@@ -161,3 +163,38 @@ export type ProductClaimCreateRequestBody = Omit<ProductClaimCreateInput, 'colle
 export type ProductResponse = Product;
 export type ProductCreateRequest = ProductWriteInput;
 export type ProductUpdateRequest = Partial<Omit<ProductWriteInput, 'id'>>;
+export type ScopedFieldType = 'text' | 'textarea' | 'number' | 'date' | 'select' | 'switch' | 'url';
+export interface ScopedFieldOption {
+    value: string;
+    label: string;
+}
+export interface ScopedFieldDef {
+    /** Stable key. Written into the resolved bag at this name. */
+    key: string;
+    /** Human label for editors and read-only renderers. */
+    label: string;
+    type: ScopedFieldType;
+    required?: boolean;
+    placeholder?: string;
+    help?: string;
+    /** Required when type === 'select'. */
+    options?: ScopedFieldOption[];
+    /** Default value applied when creating a new record. */
+    defaultValue?: JsonValue;
+    /** Show as a column in the default items table. */
+    showInTable?: boolean;
+    /** Show on the inline detail / edit view. */
+    showInDetail?: boolean;
+}
+/**
+ * `'public'` (default, omitted) reads/writes `product.data[key]`.
+ * `'admin'` reads/writes `product.admin[key]` (admin only).
+ */
+export type ProductFieldScope = 'public' | 'admin';
+export type ProductFieldDef = ScopedFieldDef & {
+    scope?: ProductFieldScope;
+};
+/** Shape of the `productFields` collection settings group. */
+export interface ProductFieldsConfig {
+    fields: ProductFieldDef[];
+}

package/dist/types/proof.d.ts

@@ -1,3 +1,17 @@
+import { JsonValue, ScopedFieldDef } from './product';
+/**
+ * `proof.values` — the owner + business-writable bag.
+ * Public keys sit at the root (business + current owner can write, everyone
+ * can read); `owner` and `personal` are reserved sub-keys with their own
+ * read/write rules. See docs/proof-product-data-scoping.md.
+ */
+export interface ProofValues {
+    [key: string]: JsonValue | Record<string, JsonValue> | Record<string, Record<string, JsonValue>> | undefined;
+    /** Owner-scoped: read/write by business + current owner; transfers with ownership. */
+    owner?: Record<string, JsonValue>;
+    /** Per-user: read/write only by the matching userId; not visible to the next owner, not even business admins. */
+    personal?: Record<string, Record<string, JsonValue>>;
+}
 /**
  * Represents a Proof object.
  */
@@ -18,14 +32,36 @@ export interface Proof {
     claimable?: boolean;
     /** Is this proof virtual */
     virtual?: boolean;
-    /** Arbitrary key-value pairs for proof values */
-    values: Record<string, any>;
+    /** Public, business-writable spec data — readable by everyone. */
+    data?: Record<string, JsonValue>;
+    /** Business-only spec data — stripped from public/non-admin reads. */
+    admin?: Record<string, JsonValue>;
+    /** Owner + business-writable consumer data. See ProofValues. */
+    values: ProofValues;
 }
 export type ProofResponse = Proof;
 export interface ProofCreateRequest {
-    values: Record<string, any>;
+    values: ProofValues;
+    /** Business-writable public spec data. */
+    data?: Record<string, JsonValue>;
+    /** Business-only spec data. */
+    admin?: Record<string, JsonValue>;
     claimable?: boolean;
     virtual?: boolean;
 }
 export type ProofUpdateRequest = Partial<ProofCreateRequest>;
 export type ProofClaimRequest = Record<string, any>;
+/**
+ * `'public'` (default, omitted) reads/writes `proof.values[key]`.
+ * `'owner'` reads/writes `proof.values.owner[key]`.
+ * `'personal'` reads/writes `proof.values.personal[userId][key]`.
+ * `'admin'` reads/writes `proof.admin[key]` (admin only).
+ */
+export type ProofFieldScope = 'public' | 'owner' | 'personal' | 'admin';
+export type ProofFieldDef = ScopedFieldDef & {
+    scope?: ProofFieldScope;
+};
+/** Shape of the `proofFields` collection settings group. */
+export interface ProofFieldsConfig {
+    fields: ProofFieldDef[];
+}