@nodaro/sdk 2.28.0 → 2.31.0

package/dist/entries/billing.d.ts

@@ -0,0 +1,208 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.js';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/**
+ * Plans and prices, the subscription, and the billing surface — the shapes of
+ * the `/v1/billing/*` routes an app may call. Mirrors the backend routes
+ * (`backend/src/ee/routes/billing.ts`, `backend/src/routes/billing-surface.ts`),
+ * the source of truth: keep these in sync if they change.
+ *
+ * Buying, changing the plan and the payment settings stay in the Nodaro app:
+ * those routes refuse API and app tokens, so they have no method here.
+ */
+/** A sum of money in its currency's major unit (`12` = 12.00), with its ISO-4217 code (`"USD"`). */
+interface BillingMoney {
+    amount: number;
+    currency: string;
+}
+/** The credits a price grants, and how often. */
+interface BillingPriceCredits {
+    amount: number;
+    per: "month" | "year";
+}
+/** A monthly price, and what it grants. */
+interface BillingMonthlyPrice extends BillingMoney {
+    /** `null` when the price does not state it. */
+    credits: BillingPriceCredits | null;
+}
+/** A yearly price, what it comes to per month, and what it grants. */
+interface BillingYearlyPrice extends BillingMoney {
+    /** The yearly amount spread over the months it pays for; `null` when that cannot be said. */
+    perMonth: number | null;
+    /** What the price grants — the plan's credits every month, as a monthly price; `null` when the price does not state it. */
+    credits: BillingPriceCredits | null;
+}
+interface BillingPlanPrices {
+    /** `null` = Stripe cannot sell this price right now: show it as unavailable, never as free. */
+    monthly: BillingMonthlyPrice | null;
+    yearly: BillingYearlyPrice | null;
+}
+/** One plan on sale. */
+interface BillingPlan {
+    /** `"free"`, `"basic"`, `"standard"`, … — the stable id. */
+    id: string;
+    name: string;
+    /** `null` for the free plan: there is nothing to pay. */
+    prices: BillingPlanPrices | null;
+    /** The free plan's one-time grant at sign-up; `null` on a paid plan, whose credits come with each price. */
+    signupCredits: number | null;
+    /** How many nodes of one workflow run at once. */
+    parallelism: number;
+    /** Storage for your media, in bytes. */
+    storageBytes: number;
+}
+/** A credit pack: this many credits for this price. */
+interface BillingTopUp {
+    id: string;
+    credits: number;
+    /** `null` when the pack's price cannot be stated right now: show it as unavailable. */
+    price: BillingMoney | null;
+}
+/** The answer of `GET /v1/billing/plans`. */
+interface BillingPlansResult {
+    /** The free plan first, then each paid plan from the smallest. */
+    data: BillingPlan[];
+    /** The credit packs, from the smallest. */
+    topUps: BillingTopUp[];
+    /** Any whole amount in this range can be loaded as credits, at the same rate as the packs. */
+    topUpRange: {
+        min: number;
+        max: number;
+        currency: string;
+    };
+}
+/** The account's latest subscription record. */
+interface BillingSubscription {
+    id: string;
+    stripe_subscription_id: string | null;
+    /** The plan id: `"basic"`, `"standard"`, … */
+    tier: string;
+    /** `"active"`, `"trialing"`, `"past_due"`, `"paused"`, `"canceled"`, `"incomplete"` or `"expired"`. */
+    status: string;
+    stripe_price_id: string | null;
+    /** ISO-8601. */
+    current_period_start: string | null;
+    /** ISO-8601: when the current period ends (and renews, unless cancelled). */
+    current_period_end: string | null;
+    /** True when the subscription ends at `current_period_end` instead of renewing. */
+    cancel_at_period_end: boolean;
+    /** ISO-8601: when a scheduled cancellation takes effect. */
+    cancel_at: string | null;
+    /** ISO-8601: when it was cancelled. */
+    canceled_at: string | null;
+}
+/** The answer of `GET /v1/billing/subscription`. */
+interface BillingSubscriptionResult {
+    /** `null` when the account never subscribed. */
+    data: BillingSubscription | null;
+    /**
+     * The tier the account's entitlements follow: usually a plan id from
+     * `plans()` (`"free"` included); `"payg"` — no subscription, but credits
+     * bought (every model, no watermark); or a tier that is not on sale, such
+     * as `"enterprise"`.
+     */
+    effectiveTier: string;
+}
+/** How this deployment bills, the same for every caller (`GET /v1/billing/surface`). */
+interface BillingSurface {
+    /** The billing-surface contract version (an integer). */
+    contract: number;
+    /** The registered billing provider; `"none"` = this deployment meters nothing. */
+    providerId: string;
+    /** The unit costs display in by default (`"credits"`, `"usd"`, or a deployment's own label). */
+    displayUnit: string;
+    canReport: boolean;
+    canQuote: boolean;
+    canAccount: boolean;
+    /** Whether a cost view belongs on this deployment. */
+    mountCostTab: boolean;
+    /** One billing account pays for every user here. */
+    deploymentPayer: boolean;
+}
+/** One row of {@link BillingAccountSummary.byCategory}. */
+interface BillingUsageCategory {
+    category: string;
+    count: number;
+    /** Spend in the display unit; `null` = unavailable, never 0. */
+    amount: number | null;
+    spent: BillingMoney | null;
+}
+/**
+ * The caller's account as the deployment's billing provider sees it
+ * (`GET /v1/billing/account`). Money and amounts are `null` when the provider
+ * could not say: show that distinctly, never as 0. A field the provider leaves
+ * out is a concept it does not have.
+ */
+interface BillingAccountSummary {
+    /** A plain string; `"unknown"` is a real answer. */
+    plan: string;
+    balance: number | null;
+    dailyAllowance: number | null;
+    unit: string;
+    /** `"external_wallet"` when the balance comes from a wallet outside Nodaro. */
+    balanceSource?: "external_wallet";
+    /** ISO-8601 start of the current usage period. */
+    periodStart?: string | null;
+    /** Generations this period. */
+    generations?: number | null;
+    /** Money spent this period. */
+    spent?: BillingMoney | null;
+    /** Pay-as-you-go state. */
+    payg?: {
+        enabled: boolean;
+        reserve: number | null;
+        rate: {
+            creditsPerUnit: number;
+            currency: string;
+        } | null;
+        monthlyCap: BillingMoney | null;
+    } | null;
+    /** The daily cap and when it resets; prefer it over `dailyAllowance` when present. `limit: 0` means blocked. */
+    daily?: {
+        limit: number;
+        used: number;
+        remaining: number;
+        resetsAt: string;
+    } | null;
+    /** Money value of the pay-as-you-go reserve. */
+    reserveValue?: BillingMoney | null;
+    byCategory?: BillingUsageCategory[] | null;
+    /** The total the balance is drawn from, where the provider grants each user an allocation. */
+    allocated?: number | null;
+}
+declare class BillingResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /**
+     * `GET /v1/billing/plans` → the plans and credit packs on sale, with their
+     * prices. Public: works with no credential, the same for every caller.
+     * Nodaro Cloud only — a self-hosted instance answers 404. Throws on `403
+     * self_serve_disabled` (this deployment does not sell to its users) and on
+     * `503` (`stripe_not_configured`, or prices briefly unavailable).
+     */
+    plans(): Promise<BillingPlansResult>;
+    /**
+     * `GET /v1/billing/subscription` → the account's latest subscription
+     * (`null` when it never subscribed) and the tier its entitlements follow.
+     * Match `effectiveTier` to a {@link BillingPlan} `id` to mark the current
+     * plan (no match: pay-as-you-go, or a tier not on sale). Needs a signed-in
+     * session, a personal API token without a workflow limit, or an app's OAuth
+     * token. Nodaro Cloud only — a self-hosted instance answers 404.
+     */
+    subscription(): Promise<BillingSubscriptionResult>;
+    /**
+     * `GET /v1/billing/surface` → how this deployment bills: whether it meters
+     * at all (`providerId !== "none"`) and in which unit costs display. Public,
+     * every edition.
+     */
+    surface(): Promise<BillingSurface>;
+    /**
+     * `GET /v1/billing/account` → the caller's plan and balance as the
+     * deployment's billing provider reports them, in its display unit. `null`
+     * when the provider could not answer — not a zero balance. Every edition.
+     */
+    account(): Promise<BillingAccountSummary | null>;
+}
+
+export { type BillingAccountSummary, type BillingMoney, type BillingMonthlyPrice, type BillingPlan, type BillingPlanPrices, type BillingPlansResult, type BillingPriceCredits, BillingResource, type BillingSubscription, type BillingSubscriptionResult, type BillingSurface, type BillingTopUp, type BillingUsageCategory, type BillingYearlyPrice };

package/dist/entries/billing.js

@@ -0,0 +1,4 @@
+import '../chunk-M6Y5TOYE.js';
+export { BillingResource } from '../chunk-J4WFSKY6.js';
+//# sourceMappingURL=billing.js.map
+//# sourceMappingURL=billing.js.map

package/dist/entries/billing.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"billing.js"}

package/dist/entries/catalogs.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+require('../chunk-43NO4SGC.cjs');
+var chunkBPWUWUZ3_cjs = require('../chunk-BPWUWUZ3.cjs');
+
+
+
+Object.defineProperty(exports, "CatalogsResource", {
+  enumerable: true,
+  get: function () { return chunkBPWUWUZ3_cjs.CatalogsResource; }
+});
+//# sourceMappingURL=catalogs.cjs.map
+//# sourceMappingURL=catalogs.cjs.map

package/dist/entries/catalogs.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"catalogs.cjs"}

package/dist/entries/catalogs.d.cts

@@ -0,0 +1,82 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.cjs';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/**
+ * Catalog projection types. Mirror `@nodaro/shared`'s `ProjectedCatalog` so the
+ * SDK stays dependency-free (same convention as `picker-catalogs.ts`). Tag-free
+ * by design — the deferred `CatalogPolicy` never crosses the wire.
+ */
+interface ProjectedCatalogOption {
+    id: string;
+    label: string;
+    description?: string;
+    category?: string;
+    /** The prompt fragment this id injects downstream. Present only when detail="full". */
+    promptHint?: string;
+    /**
+     * Short professional term injected by compact hint mode; `label` is for
+     * display. Present at BOTH detail levels — a thin client renders `label`
+     * and injects `term`. Empty for a no-op ("auto"/"none") entry that injects
+     * nothing.
+     */
+    term?: string;
+    icon?: string;
+    /**
+     * Absolute URL of the option's picture — a photo, 3D emoji, flag or (Nodaro
+     * Cloud only) rendered look preview — on the installation's own host, or the
+     * Nodaro CDN for look previews. Absent when the option has no picture. Use it
+     * as given: file names carry a content hash, so it can be cached for good.
+     */
+    imageUrl?: string;
+}
+interface ProjectedCatalogDimension {
+    field: string;
+    label: string;
+    options: ProjectedCatalogOption[];
+}
+interface ProjectedCatalog {
+    nodeType: string;
+    label: string;
+    catalogId: string;
+    kind: "single" | "multi";
+    valueField?: string;
+    defaultValue?: string;
+    categoryOrder?: string[];
+    categoryLabels?: Record<string, string>;
+    detail: "compact" | "full";
+    options?: ProjectedCatalogOption[];
+    fields?: string[];
+    dimensions?: ProjectedCatalogDimension[];
+    /** person and styling: the topics their settings are grouped under, in order, each with its picture. */
+    sections?: ProjectedCatalogSection[];
+}
+/** A topic a multi-dim catalog's settings are grouped under in the editor (person, styling). */
+interface ProjectedCatalogSection {
+    label: string;
+    fields: string[];
+    imageUrl?: string;
+}
+/**
+ * `GET /v1/catalogs`. `data` is present only when the deployment registered
+ * catalog packs (`curated: true`); with none the catalogs are the bundled
+ * ones — read them per picker with `client.pickerCatalogs.get(nodeType)`.
+ */
+interface CatalogsListResponse {
+    curated: boolean;
+    packs: number;
+    version: number;
+    data?: ProjectedCatalog[];
+}
+declare class CatalogsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /** Every catalog, projected & pack-composed (honors the deployment's
+     *  registered vendored packs). Cached publicly 5 min. `data` is absent
+     *  when the deployment registered no packs (`curated: false`). */
+    list(opts?: {
+        detail?: "compact" | "full";
+    }): Promise<CatalogsListResponse>;
+}
+
+export { type CatalogsListResponse, CatalogsResource, type ProjectedCatalog, type ProjectedCatalogDimension, type ProjectedCatalogOption, type ProjectedCatalogSection };

package/dist/entries/catalogs.d.ts

@@ -0,0 +1,82 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.js';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/**
+ * Catalog projection types. Mirror `@nodaro/shared`'s `ProjectedCatalog` so the
+ * SDK stays dependency-free (same convention as `picker-catalogs.ts`). Tag-free
+ * by design — the deferred `CatalogPolicy` never crosses the wire.
+ */
+interface ProjectedCatalogOption {
+    id: string;
+    label: string;
+    description?: string;
+    category?: string;
+    /** The prompt fragment this id injects downstream. Present only when detail="full". */
+    promptHint?: string;
+    /**
+     * Short professional term injected by compact hint mode; `label` is for
+     * display. Present at BOTH detail levels — a thin client renders `label`
+     * and injects `term`. Empty for a no-op ("auto"/"none") entry that injects
+     * nothing.
+     */
+    term?: string;
+    icon?: string;
+    /**
+     * Absolute URL of the option's picture — a photo, 3D emoji, flag or (Nodaro
+     * Cloud only) rendered look preview — on the installation's own host, or the
+     * Nodaro CDN for look previews. Absent when the option has no picture. Use it
+     * as given: file names carry a content hash, so it can be cached for good.
+     */
+    imageUrl?: string;
+}
+interface ProjectedCatalogDimension {
+    field: string;
+    label: string;
+    options: ProjectedCatalogOption[];
+}
+interface ProjectedCatalog {
+    nodeType: string;
+    label: string;
+    catalogId: string;
+    kind: "single" | "multi";
+    valueField?: string;
+    defaultValue?: string;
+    categoryOrder?: string[];
+    categoryLabels?: Record<string, string>;
+    detail: "compact" | "full";
+    options?: ProjectedCatalogOption[];
+    fields?: string[];
+    dimensions?: ProjectedCatalogDimension[];
+    /** person and styling: the topics their settings are grouped under, in order, each with its picture. */
+    sections?: ProjectedCatalogSection[];
+}
+/** A topic a multi-dim catalog's settings are grouped under in the editor (person, styling). */
+interface ProjectedCatalogSection {
+    label: string;
+    fields: string[];
+    imageUrl?: string;
+}
+/**
+ * `GET /v1/catalogs`. `data` is present only when the deployment registered
+ * catalog packs (`curated: true`); with none the catalogs are the bundled
+ * ones — read them per picker with `client.pickerCatalogs.get(nodeType)`.
+ */
+interface CatalogsListResponse {
+    curated: boolean;
+    packs: number;
+    version: number;
+    data?: ProjectedCatalog[];
+}
+declare class CatalogsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /** Every catalog, projected & pack-composed (honors the deployment's
+     *  registered vendored packs). Cached publicly 5 min. `data` is absent
+     *  when the deployment registered no packs (`curated: false`). */
+    list(opts?: {
+        detail?: "compact" | "full";
+    }): Promise<CatalogsListResponse>;
+}
+
+export { type CatalogsListResponse, CatalogsResource, type ProjectedCatalog, type ProjectedCatalogDimension, type ProjectedCatalogOption, type ProjectedCatalogSection };

package/dist/entries/catalogs.js

@@ -0,0 +1,4 @@
+import '../chunk-SUCHGNYT.js';
+export { CatalogsResource } from '../chunk-KG4R454Z.js';
+//# sourceMappingURL=catalogs.js.map
+//# sourceMappingURL=catalogs.js.map

package/dist/entries/catalogs.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"catalogs.js"}

package/dist/entries/characters.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+require('../chunk-JOX5BJ6K.cjs');
+var chunkHAKYPZLB_cjs = require('../chunk-HAKYPZLB.cjs');
+
+
+
+Object.defineProperty(exports, "CHARACTER_ASPECT_DEFAULTS", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.CHARACTER_ASPECT_DEFAULTS; }
+});
+Object.defineProperty(exports, "CHARACTER_ASPECT_OPTIONS", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.CHARACTER_ASPECT_OPTIONS; }
+});
+Object.defineProperty(exports, "CHARACTER_STYLES", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.CHARACTER_STYLES; }
+});
+Object.defineProperty(exports, "CharactersResource", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.CharactersResource; }
+});
+Object.defineProperty(exports, "PEOPLE", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.PEOPLE; }
+});
+Object.defineProperty(exports, "PERSON_DIMENSION_LABELS", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.PERSON_DIMENSION_LABELS; }
+});
+Object.defineProperty(exports, "PERSON_DIMENSION_ORDER", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.PERSON_DIMENSION_ORDER; }
+});
+Object.defineProperty(exports, "buildPersonHints", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.buildPersonHints; }
+});
+Object.defineProperty(exports, "buildPersonSeedPrompt", {
+  enumerable: true,
+  get: function () { return chunkHAKYPZLB_cjs.buildPersonSeedPrompt; }
+});
+//# sourceMappingURL=characters.cjs.map
+//# sourceMappingURL=characters.cjs.map

package/dist/entries/characters.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"characters.cjs"}