@saasicat/ui-vue 0.26.0 → 0.27.0

package/dist/{catalog-Dch1Ryw0.d.ts → catalog-Dv2twuNi.d.ts}

@@ -1,5 +1,5 @@
 import * as _saasicat_types from '@saasicat/types';
-import { AuditQuery, AuditEntry, TenantListFilter, TenantDto, PlanVersionRow, CreatePlanVersionDraftData, PlanVersionMutationResult, UpdatePlanVersionDraftData, PlanRow, CreatePlanData, UpdatePlanData, StandardPageKey, AdminManifest, TenantActionDef } from '@saasicat/types';
+import { AuditQuery, AuditEntry, TenantListFilter, TenantDto, AdminTenantDetail, PromoCodeRecord, MarketingProjectionRow, CreateMarketingProjectionData, UpdateMarketingProjectionData, MarketingSettingsRow, DiscoverySnapshot, BundleVersionRow, CreateBundleVersionDraftData, BundleVersionMutationResult, UpdateBundleVersionDraftData, BundleRow, CreateBundleData, UpdateBundleData, PlanVersionRow, CreatePlanVersionDraftData, PlanVersionMutationResult, UpdatePlanVersionDraftData, PlanRow, CreatePlanData, UpdatePlanData, StandardPageKey, AdminManifest, TenantActionDef } from '@saasicat/types';
 
 /**
  * Minimal abstraction over `fetch`. Consumers may pass their own
@@ -224,6 +224,145 @@ declare const auditResource: ResourceDef<{
 type TenantsListFilter = ListFilterOf<TenantListFilter>;
 declare const tenantsResource: ResourceDef<{
     readonly list: ListOp<TenantDto, TenantsListFilter>;
+    readonly detail: (http: HttpClient, ctx: ResourceContext, slug: string) => Promise<AdminTenantDetail | null>;
+    /**
+     * Suspends a tenant. The reason is recorded on the audit trail, so it is a
+     * required argument rather than an option with a default.
+     */
+    readonly suspend: (http: HttpClient, ctx: ResourceContext, slug: string, reason: string) => Promise<void>;
+    readonly reactivate: (http: HttpClient, ctx: ResourceContext, slug: string) => Promise<void>;
+}>;
+
+/** What the promo list can be narrowed by, including its "all" state. */
+interface PromoCodesFilter {
+    search?: string;
+    status?: string | null;
+}
+declare const promoCodesResource: ResourceDef<{
+    readonly list: (http: HttpClient, ctx: ResourceContext, filter?: PromoCodesFilter) => Promise<PromoCodeRecord[]>;
+    /**
+     * Returns nothing, matching `createAdminResourceClient.createPromo`.
+     *
+     * The endpoint does answer with the created record, but the page it feeds
+     * reloads the list rather than reading it, and promising a body a caller
+     * would then have to trust is a wider contract than anything holds today.
+     */
+    readonly create: (http: HttpClient, ctx: ResourceContext, payload: unknown) => Promise<void>;
+    readonly update: (http: HttpClient, ctx: ResourceContext, id: string, payload: unknown) => Promise<void>;
+    readonly remove: (http: HttpClient, ctx: ResourceContext, id: string) => Promise<void>;
+}>;
+
+/**
+ * What the projection list can be narrowed by, beyond the bound project.
+ *
+ * `projectKey` is deliberately absent: it comes from the context, so a page
+ * cannot list one project's projections while creating in another.
+ */
+interface MarketingProjectionsFilter {
+    targetType?: string;
+    targetVersionId?: string;
+    locale?: string;
+}
+declare const marketingResource: ResourceDef<{
+    readonly listProjections: (http: HttpClient, ctx: ResourceContext, filter?: MarketingProjectionsFilter) => Promise<MarketingProjectionRow[]>;
+    /**
+     * The request only. `useMarketingProjections.create` reloads the list
+     * afterwards because a unique-tuple insert can change what the filter
+     * matches — that is the composable keeping its refs true, not part of
+     * the call.
+     */
+    readonly createProjection: (http: HttpClient, ctx: ResourceContext, data: CreateMarketingProjectionData) => Promise<MarketingProjectionRow>;
+    readonly updateProjection: (http: HttpClient, ctx: ResourceContext, id: string, data: UpdateMarketingProjectionData) => Promise<MarketingProjectionRow>;
+    readonly deleteProjection: (http: HttpClient, ctx: ResourceContext, id: string) => Promise<void>;
+    /**
+     * The activated locale subset, or `null` when none was ever stored.
+     *
+     * `null` means the full pool is active — the server's answer for "no
+     * row", and the state the page falls back to.
+     */
+    readonly settings: (http: HttpClient, ctx: ResourceContext) => Promise<MarketingSettingsRow | null>;
+    /** `PUT`, not `PATCH`: the endpoint replaces the set it is given. */
+    readonly saveSettings: (http: HttpClient, ctx: ResourceContext, activeLocales: readonly string[]) => Promise<void>;
+}>;
+
+/**
+ * The answer to a conditional read.
+ *
+ * `unchanged` carries no snapshot on purpose: the server said the caller's copy
+ * is current, and returning a re-fetched one would defeat the request.
+ */
+type DiscoveryRead = {
+    readonly status: 'unchanged';
+} | {
+    readonly status: 'loaded';
+    readonly snapshot: DiscoverySnapshot;
+    /** `null` when the server sent none — revalidation is then a full read. */
+    readonly etag: string | null;
+};
+declare const discoveryResource: ResourceDef<{
+    /**
+     * Reads the snapshot, revalidating against `etag` when one is passed.
+     *
+     * Pass `null` (or nothing) to force a full read — that is what
+     * `useDiscovery.reload()` does when the operator asks for fresh data.
+     */
+    readonly read: (http: HttpClient, ctx: ResourceContext, etag?: string | null) => Promise<DiscoveryRead>;
+    /**
+     * Re-runs the scan and returns what it found.
+     *
+     * Unconditional by construction: a rescan asks the server to look again,
+     * so revalidating against a tag the previous scan produced would answer
+     * with the snapshot the rescan was meant to replace.
+     */
+    readonly rescan: (http: HttpClient, ctx: ResourceContext) => Promise<{
+        snapshot: DiscoverySnapshot;
+        etag: string | null;
+    }>;
+}>;
+
+/** What `publish` may override at the moment a bundle version goes live. */
+interface PublishBundleVersionOptions {
+    forceRegressive?: boolean;
+    allowZeroPrice?: boolean;
+    validFrom?: string | null;
+    validUntil?: string | null;
+}
+/**
+ * The bundle catalogue — read per project, like the plan catalogue.
+ *
+ * `create` takes the project from the context rather than from the caller, for
+ * the reason spelled out on `plansResource.create`: the composable this
+ * replaces made it the caller's job, so `list()` and `create()` read two
+ * different sources for one value and a stale one creates a bundle outside the
+ * project the list is showing.
+ */
+declare const bundlesResource: ResourceDef<{
+    readonly list: (http: HttpClient, ctx: ResourceContext) => Promise<BundleRow[]>;
+    readonly create: (http: HttpClient, ctx: ResourceContext, data: Omit<CreateBundleData, "projectKey">) => Promise<BundleRow>;
+    readonly update: (http: HttpClient, ctx: ResourceContext, bundleId: string, data: UpdateBundleData) => Promise<BundleRow>;
+    /** Marks the bundle deleted. */
+    readonly softDelete: (http: HttpClient, ctx: ResourceContext, bundleId: string) => Promise<void>;
+}>;
+/**
+ * Bundle version lifecycle.
+ *
+ * `publish` is the request only. `useBundleVersions.publish` reloads the list
+ * afterwards, because publishing may supersede another version — but that is
+ * the composable keeping its own refs consistent, not part of the call. A
+ * descriptor operation that issued a second request would make every override
+ * inherit a reload it cannot see, and a page holding no list would pay for one
+ * it does not read.
+ */
+declare const bundleVersionsResource: ResourceDef<{
+    readonly listForBundle: (http: HttpClient, ctx: ResourceContext, bundleId: string) => Promise<BundleVersionRow[]>;
+    readonly createDraft: (http: HttpClient, ctx: ResourceContext, bundleId: string, data: Omit<CreateBundleVersionDraftData, "bundleId">) => Promise<BundleVersionMutationResult>;
+    readonly updateDraft: (http: HttpClient, ctx: ResourceContext, versionId: string, data: UpdateBundleVersionDraftData) => Promise<BundleVersionMutationResult>;
+    readonly publish: (http: HttpClient, ctx: ResourceContext, versionId: string, options?: PublishBundleVersionOptions) => Promise<BundleVersionMutationResult>;
+    /**
+     * Discards a draft. A published version cannot be discarded — the API
+     * answers 422 `BUNDLE_VERSION_ALREADY_PUBLISHED`.
+     */
+    readonly discardDraft: (http: HttpClient, ctx: ResourceContext, versionId: string) => Promise<void>;
 }>;
 
 /** What `publish` may override at the moment a version goes live. */
@@ -279,8 +418,9 @@ declare const planVersionsResource: ResourceDef<{
 /**
  * Every resource the shell offers by default.
  *
- * The registry binds these; an app overrides by key. Partial while the roster
- * grows — a page whose resource is not here yet keeps its props.
+ * The registry binds these; an app overrides by key. A page whose data is
+ * app-owned — pilots, platform e-mail — keeps its props, because there is no
+ * platform default to override.
  */
 declare const platformResources: {
     plans: ResourceDef<{
@@ -299,8 +439,69 @@ declare const platformResources: {
         readonly discardDraft: (http: HttpClient, ctx: ResourceContext, versionId: string) => Promise<void>;
         readonly terminate: (http: HttpClient, ctx: ResourceContext, versionId: string, endsAt: string) => Promise<_saasicat_types.PlanVersionRow>;
     }>;
+    bundles: ResourceDef<{
+        readonly list: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.BundleRow[]>;
+        readonly create: (http: HttpClient, ctx: ResourceContext, data: Omit<_saasicat_types.CreateBundleData, "projectKey">) => Promise<_saasicat_types.BundleRow>;
+        readonly update: (http: HttpClient, ctx: ResourceContext, bundleId: string, data: _saasicat_types.UpdateBundleData) => Promise<_saasicat_types.BundleRow>;
+        readonly softDelete: (http: HttpClient, ctx: ResourceContext, bundleId: string) => Promise<void>;
+    }>;
+    bundleVersions: ResourceDef<{
+        readonly listForBundle: (http: HttpClient, ctx: ResourceContext, bundleId: string) => Promise<_saasicat_types.BundleVersionRow[]>;
+        readonly createDraft: (http: HttpClient, ctx: ResourceContext, bundleId: string, data: Omit<_saasicat_types.CreateBundleVersionDraftData, "bundleId">) => Promise<_saasicat_types.BundleVersionMutationResult>;
+        readonly updateDraft: (http: HttpClient, ctx: ResourceContext, versionId: string, data: _saasicat_types.UpdateBundleVersionDraftData) => Promise<_saasicat_types.BundleVersionMutationResult>;
+        readonly publish: (http: HttpClient, ctx: ResourceContext, versionId: string, options?: PublishBundleVersionOptions) => Promise<_saasicat_types.BundleVersionMutationResult>;
+        readonly discardDraft: (http: HttpClient, ctx: ResourceContext, versionId: string) => Promise<void>;
+    }>;
+    catalog: ResourceDef<{
+        readonly capabilities: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.CapabilityCatalogEntryRow[]>;
+        readonly features: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.FeatureCatalogEntryRow[]>;
+        readonly quotas: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.QuotaCatalogEntryRow[]>;
+        readonly reviewFeature: (http: HttpClient, ctx: ResourceContext, featureKey: string, data: _saasicat_types.ReviewCatalogEntryData) => Promise<_saasicat_types.FeatureCatalogEntryRow>;
+        readonly reviewQuota: (http: HttpClient, ctx: ResourceContext, quotaKey: string, data: _saasicat_types.ReviewCatalogEntryData) => Promise<_saasicat_types.QuotaCatalogEntryRow>;
+        readonly setFeatureI18n: (http: HttpClient, ctx: ResourceContext, featureKey: string, i18n: _saasicat_types.CatalogEntryI18n) => Promise<_saasicat_types.FeatureCatalogEntryRow>;
+        readonly setQuotaI18n: (http: HttpClient, ctx: ResourceContext, quotaKey: string, i18n: _saasicat_types.CatalogEntryI18n) => Promise<_saasicat_types.QuotaCatalogEntryRow>;
+        readonly setFeatureBase: (http: HttpClient, ctx: ResourceContext, featureKey: string, data: _saasicat_types.UpdateCatalogEntryBaseData) => Promise<_saasicat_types.FeatureCatalogEntryRow>;
+        readonly setQuotaBase: (http: HttpClient, ctx: ResourceContext, quotaKey: string, data: _saasicat_types.UpdateCatalogEntryBaseData) => Promise<_saasicat_types.QuotaCatalogEntryRow>;
+        readonly syncDiscovery: (http: HttpClient, ctx: ResourceContext, snapshot: _saasicat_types.DiscoverySnapshot) => Promise<_saasicat_types.SyncDiscoveryResult>;
+    }>;
+    discovery: ResourceDef<{
+        readonly read: (http: HttpClient, ctx: ResourceContext, etag?: string | null) => Promise<DiscoveryRead>;
+        readonly rescan: (http: HttpClient, ctx: ResourceContext) => Promise<{
+            snapshot: _saasicat_types.DiscoverySnapshot;
+            etag: string | null;
+        }>;
+    }>;
+    marketing: ResourceDef<{
+        readonly listProjections: (http: HttpClient, ctx: ResourceContext, filter?: MarketingProjectionsFilter) => Promise<_saasicat_types.MarketingProjectionRow[]>;
+        readonly createProjection: (http: HttpClient, ctx: ResourceContext, data: _saasicat_types.CreateMarketingProjectionData) => Promise<_saasicat_types.MarketingProjectionRow>;
+        readonly updateProjection: (http: HttpClient, ctx: ResourceContext, id: string, data: _saasicat_types.UpdateMarketingProjectionData) => Promise<_saasicat_types.MarketingProjectionRow>;
+        readonly deleteProjection: (http: HttpClient, ctx: ResourceContext, id: string) => Promise<void>;
+        readonly settings: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.MarketingSettingsRow | null>;
+        readonly saveSettings: (http: HttpClient, ctx: ResourceContext, activeLocales: readonly string[]) => Promise<void>;
+    }>;
+    promoCodes: ResourceDef<{
+        readonly list: (http: HttpClient, ctx: ResourceContext, filter?: PromoCodesFilter) => Promise<_saasicat_types.PromoCodeRecord[]>;
+        readonly create: (http: HttpClient, ctx: ResourceContext, payload: unknown) => Promise<void>;
+        readonly update: (http: HttpClient, ctx: ResourceContext, id: string, payload: unknown) => Promise<void>;
+        readonly remove: (http: HttpClient, ctx: ResourceContext, id: string) => Promise<void>;
+    }>;
+    promotions: ResourceDef<{
+        readonly list: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.PromotionRow[]>;
+        readonly create: (http: HttpClient, ctx: ResourceContext, data: _saasicat_types.CreatePromotionData) => Promise<_saasicat_types.PromotionRow>;
+        readonly update: (http: HttpClient, ctx: ResourceContext, id: string, data: _saasicat_types.UpdatePromotionData) => Promise<_saasicat_types.PromotionRow>;
+        readonly remove: (http: HttpClient, ctx: ResourceContext, id: string) => Promise<void>;
+    }>;
     tenants: ResourceDef<{
         readonly list: ListOp<_saasicat_types.TenantDto, TenantsListFilter>;
+        readonly detail: (http: HttpClient, ctx: ResourceContext, slug: string) => Promise<_saasicat_types.AdminTenantDetail | null>;
+        readonly suspend: (http: HttpClient, ctx: ResourceContext, slug: string, reason: string) => Promise<void>;
+        readonly reactivate: (http: HttpClient, ctx: ResourceContext, slug: string) => Promise<void>;
+    }>;
+    users: ResourceDef<{
+        readonly list: (http: HttpClient, ctx: ResourceContext, filter?: _saasicat_types.AdminUserListFilter) => Promise<_saasicat_types.AdminUserListRow[]>;
+    }>;
+    subscriptions: ResourceDef<{
+        readonly list: (http: HttpClient, ctx: ResourceContext) => Promise<_saasicat_types.AdminSubscriptionListRow[]>;
     }>;
     audit: ResourceDef<{
         readonly list: ListOp<_saasicat_types.AuditEntry, AuditListFilter>;
@@ -1956,4 +2157,4 @@ interface SaCatalog {
  */
 declare function createSaCatalog(options?: SaCatalogOptions): SaCatalog;
 
-export { filterQueryString as $, type ActionHandler as A, type Bound as B, SA_LOCALE_LABELS as C, DEFAULT_SA_LOCALE as D, SA_MESSAGES as E, type SaBuiltinLocale as F, type SaCatalog as G, type HttpClient as H, type SaCatalogOptions as I, type TranslationOf as J, type KvStore as K, LIST_FIRST_PAGE as L, type MessageTree as M, auditResource as N, bindResource as O, type PlatformResources as P, clampListPage as Q, type ResourceDef as R, type SaLocale as S, type TenantsListFilter as T, clampListPageSize as U, createSaCatalog as V, defaultHttpClient as W, defaultKvStore as X, defineListOp as Y, defineMessages as Z, defineResource as _, type SaMessages as a, isSaBuiltinLocale as a0, isSentInQuery as a1, listUrl as a2, mergeMessages as a3, planVersionsResource as a4, plansResource as a5, readListPage as a6, resolveMessages as a7, tenantsResource as a8, type SaNavMessages as a9, type SaLocaleOption as b, type SaLocaleDefinition as c, type SaMessagesOverrides as d, type ResourceOps as e, type ResourceContext as f, type ResourceListPage as g, ActionRegistry as h, ActionDefNotInManifestError as i, type AuditListFilter as j, type DefineResourceOptions as k, type HttpResponse as l, LIST_PAGE_SIZE_DEFAULT as m, LIST_PAGE_SIZE_MAX as n, LIST_PAGINATION_PARAMS as o, platformResources as p, type ListFilterOf as q, type ListOp as r, type ListQuery as s, MissingHandlerError as t, type PartialMessages as u, type PublishPlanVersionOptions as v, type ResolvedAction as w, type ResourceOp as x, SA_INTL_LOCALES as y, SA_LOCALES as z };
+export { createSaCatalog as $, type ActionHandler as A, type Bound as B, type ResolvedAction as C, DEFAULT_SA_LOCALE as D, type ResourceOp as E, SA_INTL_LOCALES as F, SA_LOCALES as G, type HttpClient as H, SA_LOCALE_LABELS as I, SA_MESSAGES as J, type KvStore as K, LIST_FIRST_PAGE as L, type MarketingProjectionsFilter as M, type SaBuiltinLocale as N, type SaCatalog as O, type PlatformResources as P, type SaCatalogOptions as Q, type ResourceDef as R, type SaLocale as S, type TenantsListFilter as T, type TranslationOf as U, auditResource as V, bindResource as W, bundleVersionsResource as X, bundlesResource as Y, clampListPage as Z, clampListPageSize as _, type SaMessages as a, defaultHttpClient as a0, defaultKvStore as a1, defineListOp as a2, defineMessages as a3, defineResource as a4, discoveryResource as a5, filterQueryString as a6, isSaBuiltinLocale as a7, isSentInQuery as a8, listUrl as a9, marketingResource as aa, mergeMessages as ab, planVersionsResource as ac, plansResource as ad, promoCodesResource as ae, readListPage as af, resolveMessages as ag, tenantsResource as ah, type SaNavMessages as ai, type SaLocaleOption as b, type SaLocaleDefinition as c, type SaMessagesOverrides as d, type ResourceOps as e, type ResourceContext as f, type ResourceListPage as g, ActionRegistry as h, ActionDefNotInManifestError as i, type AuditListFilter as j, type DefineResourceOptions as k, type DiscoveryRead as l, type HttpResponse as m, LIST_PAGE_SIZE_DEFAULT as n, LIST_PAGE_SIZE_MAX as o, platformResources as p, LIST_PAGINATION_PARAMS as q, type ListFilterOf as r, type ListOp as s, type ListQuery as t, type MessageTree as u, MissingHandlerError as v, type PartialMessages as w, type PromoCodesFilter as x, type PublishBundleVersionOptions as y, type PublishPlanVersionOptions as z };