@farthershore/farthershore-js 0.0.0

package/dist/resources/plans.d.ts

@@ -0,0 +1,42 @@
+import { type ClientContext } from "../config.js";
+import type { Bootstrap, Plan } from "../types.js";
+/** Input to `subscribe()`. `compiledPlanId` is the `Plan.id` (immutable
+ *  CompiledPlan pointer). */
+export interface SubscribeInput {
+    /** The plan to subscribe to — pass `plan.id`. */
+    compiledPlanId: string;
+    /** Owning org for org-owned subscriptions (forwarded as the
+     *  `organizationId` query + header). */
+    organizationId?: string | null;
+    /** Where Stripe redirects after a successful paid checkout. */
+    successUrl?: string;
+    /** Where Stripe redirects if the subscriber abandons checkout. */
+    cancelUrl?: string;
+}
+/** Result of `subscribe()`. For a PAID plan, `url` is the Stripe Checkout URL to
+ *  navigate to. For a FREE plan, there is no `url` — the subscriber was
+ *  activated directly and `subscriber` describes the new row. */
+export interface SubscribeResult {
+    /** Stripe Checkout URL (paid plans only). Undefined for free activations. */
+    url?: string;
+    /** The activated subscriber (free plans only). Undefined for paid checkout. */
+    subscriber?: {
+        id: string;
+        productId?: string;
+        status: string;
+    };
+    /** Server-side checkout-attempt id, when returned. */
+    checkoutAttemptId?: string;
+    /** Best-effort initial API key minted on free-plan activation, when present. */
+    autoApiKey?: string;
+}
+export interface PlansResource {
+    /** The product's available plans (resolved via bootstrap). Empty when the
+     *  product has no published, self-serve plans. */
+    list(): Promise<Plan[]>;
+    /** Start checkout for a plan. Paid → `{ url }` (navigate to Stripe). Free →
+     *  `{ subscriber }` (activated directly). */
+    subscribe(input: SubscribeInput): Promise<SubscribeResult>;
+}
+export declare function createPlansResource(ctx: ClientContext, ensureBootstrap: () => Promise<Bootstrap>): PlansResource;
+//# sourceMappingURL=plans.d.ts.map

package/dist/resources/plans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../src/resources/plans.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAGnD;6BAC6B;AAC7B,MAAM,WAAW,cAAc;IAC7B,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;IACvB;4CACwC;IACxC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;iEAEiE;AACjE,MAAM,WAAW,eAAe;IAC9B,6EAA6E;IAC7E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,UAAU,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,sDAAsD;IACtD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AASD,MAAM,WAAW,aAAa;IAC5B;sDACkD;IAClD,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB;iDAC6C;IAC7C,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC5D;AAED,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,aAAa,EAClB,eAAe,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,GACxC,aAAa,CA+Bf"}

package/dist/resources/plans.js

@@ -0,0 +1,43 @@
+// The plans/catalog + purchase surface. `fs.plans.list()` returns the product's
+// available plans (from bootstrap — the same DTO the portal renders from), and
+// `fs.plans.subscribe()` starts checkout: paid plans return a Stripe Checkout
+// URL the caller navigates to; free plans activate the subscriber directly and
+// return the created subscriber (no URL).
+//
+// This is the ONLY purchase path the SDK exposes — it POSTs to the existing core
+// endpoint `/portal/products/:productId/me/checkout-session`, the same route the
+// SSR portal uses.
+import { coreFetch } from "../http.js";
+import { requireProductId, mePath } from "./_shared.js";
+export function createPlansResource(ctx, ensureBootstrap) {
+    return {
+        async list() {
+            return (await ensureBootstrap()).plans;
+        },
+        async subscribe(input) {
+            const productId = requireProductId(ctx);
+            const raw = await coreFetch(ctx, {
+                method: "POST",
+                path: mePath(productId, "/checkout-session"),
+                query: input.organizationId
+                    ? { organizationId: input.organizationId }
+                    : undefined,
+                body: {
+                    compiledPlanId: input.compiledPlanId,
+                    organizationId: input.organizationId ?? undefined,
+                    successUrl: input.successUrl,
+                    cancelUrl: input.cancelUrl,
+                },
+            });
+            return {
+                ...(raw.url ? { url: raw.url } : {}),
+                ...(raw.subscriber ? { subscriber: raw.subscriber } : {}),
+                ...(raw.checkoutAttemptId
+                    ? { checkoutAttemptId: raw.checkoutAttemptId }
+                    : {}),
+                ...(raw.autoApiKey ? { autoApiKey: raw.autoApiKey } : {}),
+            };
+        },
+    };
+}
+//# sourceMappingURL=plans.js.map

package/dist/resources/plans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../src/resources/plans.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,+EAA+E;AAC/E,8EAA8E;AAC9E,+EAA+E;AAC/E,0CAA0C;AAC1C,EAAE;AACF,iFAAiF;AACjF,iFAAiF;AACjF,mBAAmB;AAEnB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AA8CxD,MAAM,UAAU,mBAAmB,CACjC,GAAkB,EAClB,eAAyC;IAEzC,OAAO;QACL,KAAK,CAAC,IAAI;YACR,OAAO,CAAC,MAAM,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC;QACzC,CAAC;QAED,KAAK,CAAC,SAAS,CAAC,KAAK;YACnB,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,MAAM,SAAS,CAAsB,GAAG,EAAE;gBACpD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC;gBAC5C,KAAK,EAAE,KAAK,CAAC,cAAc;oBACzB,CAAC,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,cAAc,EAAE;oBAC1C,CAAC,CAAC,SAAS;gBACb,IAAI,EAAE;oBACJ,cAAc,EAAE,KAAK,CAAC,cAAc;oBACpC,cAAc,EAAE,KAAK,CAAC,cAAc,IAAI,SAAS;oBACjD,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,SAAS,EAAE,KAAK,CAAC,SAAS;iBAC3B;aACF,CAAC,CAAC;YACH,OAAO;gBACL,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzD,GAAG,CAAC,GAAG,CAAC,iBAAiB;oBACvB,CAAC,CAAC,EAAE,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,EAAE;oBAC9C,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC1D,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/resources/product.d.ts

@@ -0,0 +1,7 @@
+import type { Bootstrap, Product } from "../types.js";
+export interface ProductResource {
+    /** The product this frontend is running for (resolved via bootstrap). */
+    get(): Promise<Product>;
+}
+export declare function createProductResource(ensureBootstrap: () => Promise<Bootstrap>): ProductResource;
+//# sourceMappingURL=product.d.ts.map

package/dist/resources/product.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../src/resources/product.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtD,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CACzB;AAED,wBAAgB,qBAAqB,CACnC,eAAe,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,GACxC,eAAe,CAMjB"}

package/dist/resources/product.js

@@ -0,0 +1,8 @@
+export function createProductResource(ensureBootstrap) {
+    return {
+        async get() {
+            return (await ensureBootstrap()).product;
+        },
+    };
+}
+//# sourceMappingURL=product.js.map

package/dist/resources/product.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/resources/product.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,qBAAqB,CACnC,eAAyC;IAEzC,OAAO;QACL,KAAK,CAAC,GAAG;YACP,OAAO,CAAC,MAAM,eAAe,EAAE,CAAC,CAAC,OAAO,CAAC;QAC3C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/resources/usage.d.ts

@@ -0,0 +1,17 @@
+import { type ClientContext } from "../config.js";
+import type { UsageEvent, UsageSummary } from "../types.js";
+export interface UsageRange {
+    from?: string;
+    to?: string;
+}
+export interface UsageResource {
+    /** Dimension → total for the period (requests/tokens/computeMs/dollars…). */
+    summary(range?: UsageRange): Promise<UsageSummary>;
+    /** The most-recent usage events (platform caps this list). */
+    events(range?: UsageRange): Promise<UsageEvent[]>;
+    /** Bucketed timeseries — no platform endpoint yet; derive from `events()` for
+     *  now, or add a Core route later. Throws to stay honest. */
+    timeseries(): never;
+}
+export declare function createUsageResource(ctx: ClientContext): UsageResource;
+//# sourceMappingURL=usage.d.ts.map

package/dist/resources/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/usage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAkB5D,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,OAAO,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACnD,8DAA8D;IAC9D,MAAM,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAClD;iEAC6D;IAC7D,UAAU,IAAI,KAAK,CAAC;CACrB;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CAmCrE"}

package/dist/resources/usage.js

@@ -0,0 +1,35 @@
+import { coreFetch } from "../http.js";
+import { FartherShoreNotImplementedError } from "../errors.js";
+import { mePath, requireProductId } from "./_shared.js";
+export function createUsageResource(ctx) {
+    async function fetchUsage(range) {
+        const productId = requireProductId(ctx);
+        return coreFetch(ctx, {
+            method: "GET",
+            path: mePath(productId, "/usage"),
+            query: { from: range?.from, to: range?.to },
+        });
+    }
+    return {
+        async summary(range) {
+            return (await fetchUsage(range)).summary;
+        },
+        async events(range) {
+            const raw = await fetchUsage(range);
+            return raw.items.map((i) => ({
+                id: i.id,
+                timestamp: i.timestamp,
+                operation: i.operation,
+                statusCode: i.statusCode ?? null,
+                status: i.status,
+                latencyMs: i.latencyMs ?? null,
+                requests: i.requests ?? null,
+                tokens: i.tokens ?? null,
+            }));
+        },
+        timeseries() {
+            throw new FartherShoreNotImplementedError("usage.timeseries() has no platform endpoint yet — derive a series from usage.events(), or add a Core timeseries route. (Deferred.)");
+        },
+    };
+}
+//# sourceMappingURL=usage.js.map

package/dist/resources/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/resources/usage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,cAAc,CAAC;AAE/D,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAgCxD,MAAM,UAAU,mBAAmB,CAAC,GAAkB;IACpD,KAAK,UAAU,UAAU,CAAC,KAAkB;QAC1C,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,SAAS,CAAW,GAAG,EAAE;YAC9B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC;YACjC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,KAAK,CAAC,OAAO,CAAC,KAAK;YACjB,OAAO,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;QAC3C,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,KAAK;YAChB,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC3B,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,SAAS,EAAE,CAAC,CAAC,SAAS;gBACtB,SAAS,EAAE,CAAC,CAAC,SAAS;gBACtB,UAAU,EAAE,CAAC,CAAC,UAAU,IAAI,IAAI;gBAChC,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,SAAS,EAAE,CAAC,CAAC,SAAS,IAAI,IAAI;gBAC9B,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,IAAI;gBAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;aACzB,CAAC,CAAC,CAAC;QACN,CAAC;QAED,UAAU;YACR,MAAM,IAAI,+BAA+B,CACvC,oIAAoI,CACrI,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,206 @@
+export interface Branding {
+    displayName: string;
+    logoUrl: string | null;
+    primaryColor: string | null;
+    /** Marketing/header description for the product, when set. */
+    description: string | null;
+}
+/** A product-level meter definition (the dimension catalog used to label/format
+ *  usage). Mirrors the wire `MeterDefinition`; only the display-relevant fields
+ *  are surfaced. */
+export interface Meter {
+    /** Stable dimension key (e.g. "requests", "tokens"). */
+    key: string;
+    /** Human-friendly label for the dimension. */
+    display: string;
+    /** Optional unit suffix (e.g. "ms", "tokens"). */
+    unit?: string;
+}
+export interface Product {
+    id: string;
+    /** Subdomain slug (the first label of the gateway/portal host). */
+    slug: string;
+    name: string;
+    description: string | null;
+    branding: Branding;
+    /** Gateway origin host for builder-feature calls (the product `runtimeHostname`). */
+    gatewayHost: string;
+    /** Public portal host. */
+    portalHost: string;
+    /** R2 public origin + product prefix where MDX docs live, or null when the
+     *  platform has no docs origin configured (local dev). The `/docs` view
+     *  concatenates the doc filename onto this. */
+    docsBaseUrl: string | null;
+    /** R2 public origin + product prefix for per-product legal MDX
+     *  (terms / privacy), or null. The legal view falls back to the platform
+     *  terms notice when null. */
+    legalBaseUrl: string | null;
+    /** Immutable `CompiledPlan.id` of the featured plan, or null. Used to render
+     *  the "Most Popular" treatment in the plans UI. */
+    featuredCompiledPlanId: string | null;
+    /** Product-level meter definitions — the dimension catalog used to label
+     *  usage rows. Empty when the product declares no meters. */
+    meters: Meter[];
+}
+export type AuthStrategy = "clerk" | "test-personas";
+export interface EnvironmentInfo {
+    id: string;
+    name: string;
+    slug: string;
+    /** Which sign-in flow the portal should drive: Clerk (production) or the
+     *  persona key-exchange (preview/test envs). */
+    authStrategy: AuthStrategy;
+    /** Env branch name (preview/test envs), or null for production scope. */
+    branch: string | null;
+    /** Billing provider mode for the env: "test" (no real money) or "live".
+     *  Null when the resolve was production-scoped (no env block). The plans UI
+     *  surfaces a "Test mode" badge when this is "test". */
+    stripeMode: string | null;
+}
+/** A grant entry on a plan — the unified credit-grant model. Discriminated on
+ *  `kind`. Mirrors the wire `GrantSpec`; consumers iterate the effective list
+ *  (which appends a synthesized `trial` entry when `trialDays > 0`). */
+export type Grant = {
+    kind: "recurring";
+    amount_cents: number;
+} | {
+    kind: "one_time";
+    amount_cents: number;
+} | {
+    kind: "promotional";
+    amount_cents: number;
+    label: string;
+    expires_after_days?: number;
+} | {
+    kind: "trial";
+} | {
+    kind: "rollover";
+    percent: number;
+} | {
+    kind: "top_up";
+    sku: string;
+    label: string;
+    price_cents: number;
+    credit_cents: number;
+} | {
+    kind: "auto_recharge";
+    threshold_cents: number;
+    refill_cents: number;
+};
+/** A metered price entry on a plan (per-dimension $/unit). */
+export interface PlanMeter {
+    dimension: string;
+    price_per_unit_micros: number;
+}
+/** A named rate-limit / quota rule on a plan. `window.name === "month"` rules
+ *  are the included-quota allowances the usage card renders against. */
+export interface PlanLimit {
+    dimension: string;
+    window: {
+        type: "named";
+        name: string;
+    } | {
+        type: "custom";
+        seconds: number;
+    };
+    capacity: number;
+    enforcement?: "enforce" | "track";
+}
+/** A purchasable/available plan in the product catalog. Mirrors core's
+ *  `PortalPlan` (the rich 5-knob unified billing shape) so the template can
+ *  render pricing, included quotas, grants, and a subscribe button. */
+export interface Plan {
+    /** Immutable `CompiledPlan.id` — the pointer passed to `subscribe()`. */
+    id: string;
+    key: string;
+    name: string;
+    description: string | null;
+    /** Recurring fee, in cents (0 for free / pay-as-you-go plans). */
+    recurringFeeCents: number;
+    /** Unified credit-grant array (recurring/prepaid/promotional/...). */
+    grants: Grant[];
+    /** Free-trial length in days (0 = no trial). */
+    trialDays: number;
+    /** Optional monthly spend cap, in cents. */
+    maxMonthlySpendCents: number | null;
+    /** Optional minimum monthly spend floor, in cents. */
+    minMonthlySpendCents: number | null;
+    /** Per-dimension metered prices ($/unit). Empty for non-metered plans. */
+    meters: PlanMeter[];
+    /** Quota + rate-limit rules. Month-window rules are the included allowances. */
+    limits: PlanLimit[];
+    /** Optional builder-authored feature bullets shown on the plan card. */
+    planDetails: string[];
+}
+/** What `fs.bootstrap()` returns — everything a generated/managed frontend needs
+ *  to discover the product it's running for AND render its catalog: the full
+ *  plan list (pricing model, included quotas, grants), product meters, docs /
+ *  legal origins, and the featured-plan pointer. */
+export interface Bootstrap {
+    product: Product;
+    environment: EnvironmentInfo | null;
+    branding: Branding;
+    /** The product's available/purchasable plans (empty when none are
+     *  published). The single source the plans/pricing UI renders from. */
+    plans: Plan[];
+    /** The product's active custom-frontend release hash, or null. Informational
+     *  (diagnostics) — V0 serving is host-keyed at the edge. */
+    frontendReleaseHash: string | null;
+    /** Capability keys derived from the plan set (non-empty once plans exist):
+     *  e.g. "billing", "usage-quota", "credit-grants", "docs", "legal". */
+    capabilities: string[];
+    /** Reserved for future dynamic feature discovery. */
+    features: string[];
+}
+export interface Subscriber {
+    /** Lifecycle status (e.g. ONBOARDING | ACTIVE | SUSPENDED). */
+    status: string | null;
+    /** Denormalized plan key for display. */
+    planKey: string | null;
+    /** Immutable CompiledPlan id currently active for this subscriber. */
+    compiledPlanId: string | null;
+}
+export interface Session {
+    authenticated: boolean;
+    subscriber: Subscriber | null;
+}
+export interface ApiKey {
+    id: string;
+    keyPrefix: string;
+    label: string | null;
+    /** Normalized lowercase, e.g. "active" | "revoked". */
+    status: string;
+    createdAt: string;
+    lastUsedAt: string | null;
+    revokedAt: string | null;
+}
+/** Returned ONLY by create/rotate — carries the full secret, shown once. */
+export interface CreatedApiKey extends ApiKey {
+    /** The full key. The platform never returns it again — store it now. */
+    secret: string;
+}
+export type UsageSummary = Record<string, number>;
+export interface UsageEvent {
+    id: string;
+    timestamp: string;
+    operation: string;
+    statusCode: number | null;
+    status: "success" | "error";
+    latencyMs: number | null;
+    requests: number | null;
+    tokens: number | null;
+}
+export interface Subscription {
+    id: string;
+    status: string;
+    planKey: string | null;
+    planName: string | null;
+    /** The full platform subscription DTO (large + evolving) for advanced reads. */
+    raw: unknown;
+}
+export interface SignInResult {
+    token: string;
+    expiresAt: string;
+    user: unknown;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAWA,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,8DAA8D;IAC9D,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;oBAEoB;AACpB,MAAM,WAAW,KAAK;IACpB,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,qFAAqF;IACrF,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB;;mDAE+C;IAC/C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;kCAE8B;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;wDACoD;IACpD,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC;iEAC6D;IAC7D,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,eAAe,CAAC;AAErD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb;oDACgD;IAChD,YAAY,EAAE,YAAY,CAAC;IAC3B,yEAAyE;IACzE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;4DAEwD;IACxD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;wEAEwE;AACxE,MAAM,MAAM,KAAK,GACb;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,GAC1C;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,GACD;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACrC;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,GACD;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,eAAe,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7E,8DAA8D;AAC9D,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED;wEACwE;AACxE,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9E,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;CACnC;AAED;;uEAEuE;AACvE,MAAM,WAAW,IAAI;IACnB,yEAAyE;IACzE,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,kEAAkE;IAClE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sEAAsE;IACtE,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,sDAAsD;IACtD,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,0EAA0E;IAC1E,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,gFAAgF;IAChF,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,wEAAwE;IACxE,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;;oDAGoD;AACpD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,eAAe,GAAG,IAAI,CAAC;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB;2EACuE;IACvE,KAAK,EAAE,IAAI,EAAE,CAAC;IACd;gEAC4D;IAC5D,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC;2EACuE;IACvE,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,sEAAsE;IACtE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,4EAA4E;AAC5E,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,gFAAgF;IAChF,GAAG,EAAE,OAAO,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACf"}

package/dist/types.js

@@ -0,0 +1,12 @@
+// The SDK's PUBLIC domain types — a clean, frontend-friendly surface that does
+// not leak the platform's internal server contracts. Resources map the raw wire
+// responses into these.
+//
+// NOTE: the plan/meter/grant/limit shapes below intentionally MIRROR the
+// snake_case field names of core's `/portal/public/resolve` DTO (PortalPlan /
+// MeterDefinition / GrantSpec in `@farthershore/contracts`). The SDK is
+// deliberately decoupled from the contracts package — these are SDK-local
+// re-declarations so a generated/managed frontend has a typed catalog surface
+// without pulling the whole server contract graph into the browser bundle.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,gFAAgF;AAChF,wBAAwB;AACxB,EAAE;AACF,yEAAyE;AACzE,8EAA8E;AAC9E,wEAAwE;AACxE,0EAA0E;AAC1E,8EAA8E;AAC9E,2EAA2E"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@farthershore/farthershore-js",
+  "version": "0.0.0",
+  "description": "Farther Shore Frontend SDK — the browser integration layer between static frontends and the Farther Shore platform (Core + Gateway).",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "keywords": [
+    "farthershore",
+    "sdk",
+    "frontend",
+    "portal"
+  ],
+  "author": "Farther Shore",
+  "license": "UNLICENSED",
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.1.0",
+    "@types/node": "^25.7.0",
+    "@types/react": "^19.0.0",
+    "eslint": "^10.3.0",
+    "jsdom": "^26.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.59.3",
+    "vitest": "^4.1.6"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run"
+  }
+}