@schematichq/schematic-react 1.15.0 → 1.16.0

package/dist/schematic-react.d.ts

@@ -222,6 +222,12 @@ declare namespace billingApi {
         CatalogPlanRefResponseDataToJSON,
         CatalogPlanRefResponseDataToJSONTyped,
         CatalogPlanRefResponseData,
+        instanceOfCatalogPlanResponseData,
+        CatalogPlanResponseDataFromJSON,
+        CatalogPlanResponseDataFromJSONTyped,
+        CatalogPlanResponseDataToJSON,
+        CatalogPlanResponseDataToJSONTyped,
+        CatalogPlanResponseData,
         instanceOfCatalogPriceResponseData,
         CatalogPriceResponseDataFromJSON,
         CatalogPriceResponseDataFromJSONTyped,
@@ -660,6 +666,18 @@ declare namespace billingApi {
         GetCompanyUpcomingInvoiceResponseToJSON,
         GetCompanyUpcomingInvoiceResponseToJSONTyped,
         GetCompanyUpcomingInvoiceResponse,
+        instanceOfGetPublicCatalogByIDResponse,
+        GetPublicCatalogByIDResponseFromJSON,
+        GetPublicCatalogByIDResponseFromJSONTyped,
+        GetPublicCatalogByIDResponseToJSON,
+        GetPublicCatalogByIDResponseToJSONTyped,
+        GetPublicCatalogByIDResponse,
+        instanceOfGetPublicCatalogResponse,
+        GetPublicCatalogResponseFromJSON,
+        GetPublicCatalogResponseFromJSONTyped,
+        GetPublicCatalogResponseToJSON,
+        GetPublicCatalogResponseToJSONTyped,
+        GetPublicCatalogResponse,
         instanceOfInvoiceStatus,
         InvoiceStatusFromJSON,
         InvoiceStatusFromJSONTyped,
@@ -720,6 +738,12 @@ declare namespace billingApi {
         ProrationLineKindToJSON,
         ProrationLineKindToJSONTyped,
         ProrationLineKind,
+        instanceOfPublicCatalogResponseData,
+        PublicCatalogResponseDataFromJSON,
+        PublicCatalogResponseDataFromJSONTyped,
+        PublicCatalogResponseDataToJSON,
+        PublicCatalogResponseDataToJSONTyped,
+        PublicCatalogResponseData,
         instanceOfScheduledDowngradeConfigBehavior,
         ScheduledDowngradeConfigBehaviorFromJSON,
         ScheduledDowngradeConfigBehaviorFromJSONTyped,
@@ -822,6 +846,13 @@ declare namespace billingApi {
 declare interface BillingClient {
     /** The environment's catalog, or the one `catalogId` names. */
     fetchCatalog(query?: CatalogQuery): Promise<Catalog>;
+    /**
+     * The same catalog with no company's standing in it, read with the
+     * publishable key whether or not a session is active.
+     */
+    fetchPublicCatalog(query?: CatalogQuery): Promise<PublicCatalog>;
+    /** Whether `fetchPublicCatalog` has a key to read with. */
+    readonly hasPublishableKey: boolean;
     /** Opens a checkout, priced when the cart is priceable. */
     createCheckout(selections: CheckoutSelections): Promise<CheckoutWrite>;
     getCheckout(id: string): Promise<Checkout>;
@@ -1020,6 +1051,11 @@ export declare interface BillingDataSource {
      * on a source whose session never changes.
      */
     onSessionChange?: (listener: (event: SessionEvent) => void) => () => void;
+    /**
+     * Which catalog a reader sees now; it changes only with the session, so
+     * `onSessionChange` says when to ask again. Absent, the company's view.
+     */
+    catalogSource?: () => CatalogSource;
 }
 
 /** Per-resource status overrides, for fixtures that simulate loading and failure. */
@@ -1055,7 +1091,10 @@ declare interface BillingPrefetchOptions {
     names: BillingResourceName_2[];
     /** The invoice query to prefetch for; the element must ask the same one. */
     invoices?: InvoiceQuery;
-    /** The catalog to prefetch; the element must ask the same one. */
+    /**
+     * The catalog to prefetch, as `catalog` or `publicCatalog`; the element
+     * must ask the same one.
+     */
     catalog?: CatalogQuery;
 }
 
@@ -1097,7 +1136,7 @@ export declare function BillingProvider({ billingClient, children, initialData,
  * much. Named apart from schematic-js's `BillingClient`, which is the whole
  * interface; this is the part the hooks here call.
  */
-export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchCatalog" | "createCheckout" | "getCheckout" | "updateCheckout" | "finalizeCheckout" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage" | "fetchCompany" | "cancelSubscription" | "fetchTaxIds" | "updateTaxId">;
+export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchCatalog" | "createCheckout" | "getCheckout" | "updateCheckout" | "finalizeCheckout" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage" | "fetchCompany" | "cancelSubscription" | "fetchTaxIds" | "updateTaxId"> & Partial<Pick<BillingClient, "fetchPublicCatalog" | "hasPublishableKey">>;
 
 declare interface BillingProviderDataProps {
     /**
@@ -1150,7 +1189,7 @@ declare const BillingProviderType: {
 declare type BillingProviderType = (typeof BillingProviderType)[keyof typeof BillingProviderType];
 
 /** The resources this package serves; a key of schematic-js's contract. */
-export declare type BillingResourceName = "catalog" | "invoices" | "upcomingInvoice" | "paymentMethods" | "featureUsage" | "creditBalances" | "company" | "taxIds";
+export declare type BillingResourceName = "catalog" | "publicCatalog" | "invoices" | "upcomingInvoice" | "paymentMethods" | "featureUsage" | "creditBalances" | "company" | "taxIds";
 
 declare type BillingResourceName_2 = keyof BillingResources_2;
 
@@ -1159,6 +1198,7 @@ export declare type BillingResourceParams = Pick<BillingResourceParams_2, Billin
 /** `Record<string, never>` marks a singleton; anything else is keyed. */
 declare interface BillingResourceParams_2 {
     catalog: CatalogQuery;
+    publicCatalog: CatalogQuery;
     invoices: InvoiceQuery;
     upcomingInvoice: Record<string, never>;
     paymentMethods: Record<string, never>;
@@ -1183,6 +1223,12 @@ declare interface BillingResources_2 {
      * `catalogId`: the catalog as the company sees it.
      */
     catalog: Catalog;
+    /**
+     * `GET /public/catalog`, or `GET /public/catalogs/{catalog_id}`: the
+     * catalog read with the publishable key. It belongs to no session, so a
+     * session starting, changing or ending leaves it loaded.
+     */
+    publicCatalog: PublicCatalog;
     /** `GET /company/invoices?limit&offset&include_pending`. */
     invoices: InvoicePage;
     /**
@@ -1829,6 +1875,12 @@ declare interface CatalogCreditGrantResponseData {
      * @memberof CatalogCreditGrantResponseData
      */
     scaling: PlanCreditGrantScaling;
+    /**
+     * Whether the catalog shows this credit on the plan. Display-only: a hidden grant is still granted and priced at checkout.
+     * @type {boolean}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    visible: boolean;
 }
 
 /**
@@ -2117,6 +2169,116 @@ declare interface CatalogPlanRefResponseData {
     name: string;
 }
 
+/**
+ *
+ * @export
+ * @interface CatalogPlanResponseData
+ */
+declare interface CatalogPlanResponseData {
+    /**
+     *
+     * @type {Array<PlanPriceCadence>}
+     * @memberof CatalogPlanResponseData
+     */
+    availablePeriods: Array<PlanPriceCadence>;
+    /**
+     *
+     * @type {BillingStrategy}
+     * @memberof CatalogPlanResponseData
+     */
+    billingStrategy: BillingStrategy;
+    /**
+     *
+     * @type {ChargeType}
+     * @memberof CatalogPlanResponseData
+     */
+    chargeType: ChargeType;
+    /**
+     * For add-ons, the plans this add-on may be purchased with. Null means compatible with every plan.
+     * @type {Array<string>}
+     * @memberof CatalogPlanResponseData
+     */
+    compatiblePlanIds?: Array<string> | null;
+    /**
+     *
+     * @type {Array<CatalogCurrencyPricesResponseData>}
+     * @memberof CatalogPlanResponseData
+     */
+    currencyPrices: Array<CatalogCurrencyPricesResponseData>;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPlanResponseData
+     */
+    description: string;
+    /**
+     *
+     * @type {Array<CatalogPlanEntitlementResponseData>}
+     * @memberof CatalogPlanResponseData
+     */
+    entitlements: Array<CatalogPlanEntitlementResponseData>;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPlanResponseData
+     */
+    icon: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPlanResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {Array<CatalogCreditGrantResponseData>}
+     * @memberof CatalogPlanResponseData
+     */
+    includedCreditGrants: Array<CatalogCreditGrantResponseData>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CatalogPlanResponseData
+     */
+    isTrialable: boolean;
+    /**
+     *
+     * @type {CatalogPriceResponseData}
+     * @memberof CatalogPlanResponseData
+     */
+    monthlyPrice?: CatalogPriceResponseData;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPlanResponseData
+     */
+    name: string;
+    /**
+     *
+     * @type {CatalogPriceResponseData}
+     * @memberof CatalogPlanResponseData
+     */
+    oneTimePrice?: CatalogPriceResponseData;
+    /**
+     *
+     * @type {CatalogPriceResponseData}
+     * @memberof CatalogPlanResponseData
+     */
+    quarterlyPrice?: CatalogPriceResponseData;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPlanResponseData
+     */
+    trialDays?: number | null;
+    /**
+     *
+     * @type {CatalogPriceResponseData}
+     * @memberof CatalogPlanResponseData
+     */
+    yearlyPrice?: CatalogPriceResponseData;
+}
+
 /**
  *
  * @export
@@ -2245,6 +2407,9 @@ export declare interface CatalogQuery {
     catalogId?: string;
 }
 
+/** Which catalog `useCatalog` reads: `catalog` or `publicCatalog`. */
+export declare type CatalogSource = CatalogView["source"];
+
 /**
  * Schematic API
  * Schematic API
@@ -2288,6 +2453,19 @@ declare interface CatalogUsageViolationResponseData {
     usage: number;
 }
 
+/**
+ * A catalog as whoever is reading it sees it. Tagged rather than merged: a
+ * public plan is not one the company has no standing against, and filling
+ * `valid` in for it would say something the server did not.
+ */
+export declare type CatalogView = {
+    source: "company";
+    catalog: Catalog;
+} | {
+    source: "public";
+    catalog: PublicCatalog;
+};
+
 /**
  *
  * @export
@@ -6033,6 +6211,89 @@ declare const ProrationLineKind: {
 
 declare type ProrationLineKind = (typeof ProrationLineKind)[keyof typeof ProrationLineKind];
 
+/**
+ * The catalog with no company to stand against it: no `current`, `valid` or
+ * trial standing on its plans, and no checkout settings, since nobody is
+ * signed in to check out.
+ */
+export declare type PublicCatalog = PublicCatalogResponseData;
+
+export declare type PublicCatalogPlan = CatalogPlanResponseData;
+
+/**
+ *
+ * @export
+ * @interface PublicCatalogResponseData
+ */
+declare interface PublicCatalogResponseData {
+    /**
+     *
+     * @type {Array<CatalogPlanResponseData>}
+     * @memberof PublicCatalogResponseData
+     */
+    addOns: Array<CatalogPlanResponseData>;
+    /**
+     *
+     * @type {CatalogCapabilitiesResponseData}
+     * @memberof PublicCatalogResponseData
+     */
+    capabilities: CatalogCapabilitiesResponseData;
+    /**
+     *
+     * @type {Array<CatalogCreditBundleResponseData>}
+     * @memberof PublicCatalogResponseData
+     */
+    creditBundles: Array<CatalogCreditBundleResponseData>;
+    /**
+     * Present when the catalog offers a custom plan; absent when custom plans are hidden.
+     * @type {CatalogCustomPlanCTAResponseData}
+     * @memberof PublicCatalogResponseData
+     */
+    customPlanCta?: CatalogCustomPlanCTAResponseData;
+    /**
+     * ISO 4217 currency of every top-level price slot; currency_prices carries the others.
+     * @type {Currency}
+     * @memberof PublicCatalogResponseData
+     */
+    defaultCurrency: Currency;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicCatalogResponseData
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicCatalogResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicCatalogResponseData
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<CatalogPlanResponseData>}
+     * @memberof PublicCatalogResponseData
+     */
+    plans: Array<CatalogPlanResponseData>;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicCatalogResponseData
+     */
+    pricingModel?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicCatalogResponseData
+     */
+    pricingUrl?: string | null;
+}
+
 declare interface RequestOptions {
     method?: string;
     body?: unknown;
@@ -6163,6 +6424,8 @@ export declare class Schematic {
     constructor(apiKey: string, options?: SchematicOptions);
     get apiUrl(): string;
     get additionalHeaders(): Record<string, string>;
+    /** The key flags are read with, for a billing client reading beside it. */
+    get publishableKey(): string;
     /**
      * Resolve fallback value according to priority order:
      * 1. Callsite fallback value (if provided)
@@ -6414,9 +6677,11 @@ declare class SchematicBillingClient implements BillingClient {
     constructor(options?: BillingClientOptions | SchematicSession);
     get sessionKey(): string | undefined;
     get sessionStatus(): SessionStatus;
+    get hasPublishableKey(): boolean;
     setSession(session: SessionInput): void;
     onSessionChange(listener: (event: SessionEvent) => void): () => void;
     fetchCatalog(query?: CatalogQuery): Promise<Catalog>;
+    fetchPublicCatalog(query?: CatalogQuery): Promise<PublicCatalog>;
     createCheckout(selections: CheckoutSelections): Promise<CheckoutWrite>;
     getCheckout(id: string): Promise<Checkout>;
     updateCheckout(id: string, version: number, selections: CheckoutSelections): Promise<CheckoutWrite>;
@@ -6536,9 +6801,11 @@ declare namespace SchematicJS {
         CatalogEntitlement,
         CatalogPlan,
         CatalogPlanEntitlementResponseData,
+        CatalogPlanResponseData,
         CatalogPriceResponseData,
         CatalogPriceTierResponseData,
         CatalogQuery,
+        CatalogView,
         CheckFlagResponseData,
         CheckFlagReturn,
         CheckFlagReturnFromJSON,
@@ -6639,6 +6906,9 @@ declare namespace SchematicJS {
         PendingListenerFn,
         PerLicenseCreditGrant,
         PlanListenerFn,
+        PublicCatalog,
+        PublicCatalogPlan,
+        PublicCatalogResponseData,
         RequestOptions,
         ResourceState,
         RuleType,
@@ -6761,6 +7031,7 @@ declare class SchematicSession {
     private readonly _apiUrl;
     private readonly _headers;
     private readonly _fetch;
+    private readonly _publishableKey;
     private _session;
     private readonly _tokens;
     private readonly _resolving;
@@ -6773,6 +7044,7 @@ declare class SchematicSession {
     private readonly _listeners;
     constructor(options?: SessionOptions);
     get key(): string | undefined;
+    get hasPublishableKey(): boolean;
     get status(): SessionStatus;
     /** Only a statement that changes which pair is read counts as a change. */
     set(session: SessionInput): void;
@@ -6793,6 +7065,13 @@ declare class SchematicSession {
      * otherwise come back as the answer to a question asked for another pair.
      */
     request(path: string, options?: RequestOptions): Promise<unknown>;
+    /**
+     * A read under the publishable key, whatever the session. Nothing is
+     * refreshed or retried, since the key does not expire, and a session
+     * changing mid-flight does not void the answer: it is the same for
+     * everyone.
+     */
+    requestPublic(path: string): Promise<unknown>;
     /**
      * `request`, with the headers the answer came back with — for a resource
      * whose protocol rides beside the body, as a checkout's session does.
@@ -6851,6 +7130,11 @@ declare function sessionKey(session: Session): string;
 
 declare interface SessionOptions {
     session?: SessionInput;
+    /**
+     * For the reads that belong to no session: the public catalog, which a
+     * page renders before anyone has signed in.
+     */
+    publishableKey?: string;
     apiUrl?: string;
     additionalHeaders?: Record<string, string>;
     /** Override for tests and non-browser runtimes. */
@@ -7214,11 +7498,14 @@ export declare enum UsagePeriod {
 export declare function useBillingDataSource(): BillingDataSource;
 
 /**
- * The catalog as the session's company sees it: what it can buy, and how it
- * stands against each plan and add-on. Without a `catalogId`, the catalog the
- * environment sells; an inline object literal is fine, the hook keys by value.
+ * The catalog as whoever is reading sees it. Signed in, the company's view:
+ * what it can buy, and how it stands against each plan and add-on. Signed
+ * out, or before the session resolves, the public catalog, read with the
+ * publishable key; `data.source` says which, and a session starting swaps
+ * one for the other. Without a `catalogId`, the catalog the environment
+ * sells; an inline object literal is fine, the hook keys by value.
  */
-export declare function useCatalog(query?: CatalogQuery): ResourceHandle<Catalog>;
+export declare function useCatalog(query?: CatalogQuery): ResourceHandle<CatalogView>;
 
 /**
  * A persisted checkout: the first `setSelections` opens it, each later one