allyhub 0.7.0 → 0.8.0

package/dist/node_modules/@allyhub/protocol/dist/cloud.d.ts

@@ -0,0 +1,325 @@
+import { z } from "zod";
+/** The environment variable that signs in with an API key instead: automation (CI, servers). */
+export declare const API_KEY_ENV = "ALLYHUB_API_KEY";
+/** `GET`: the organization's credits, its plan and its auto top-up. */
+export declare const BILLING_SUMMARY_PATH = "/api/billing/summary";
+/**
+ * Why an auto top-up stopped by itself, for a page to say in its words:
+ * no card saved, a Checkout still saving one, a saved method that is not a
+ * card, the card declined, the bank asking the person to confirm (3D
+ * Secure), Stripe not charging it for another reason, a top-up too small to
+ * clear its line, a top-up refunded, a payment disputed, the month's limit
+ * of automatic charges reached (it starts again next month).
+ */
+export declare const AUTO_TOP_UP_STOPS: readonly ["no_card", "saving_card", "not_a_card", "declined", "needs_authentication", "not_charged", "under_line", "refunded", "disputed", "monthly_limit"];
+export type AutoTopUpStop = (typeof AUTO_TOP_UP_STOPS)[number];
+/** How often a plan is paid. */
+export declare const BILLING_INTERVALS: readonly ["month", "year"];
+export declare const BillingSummarySchema: z.ZodObject<{
+    credits: z.ZodNumber;
+    held: z.ZodNumber;
+    owed: z.ZodNumber;
+    frozen: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    plan: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        interval: z.ZodUnion<readonly [z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>, z.core.$ZodBranded<z.ZodString, "Unknown", "out">]>;
+        status: z.ZodString;
+        renewsAt: z.ZodNullable<z.ZodISODateTime>;
+        endsAt: z.ZodNullable<z.ZodISODateTime>;
+        monthlyCredits: z.ZodDefault<z.ZodNumber>;
+        price: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+            amountCents: z.ZodNumber;
+            currency: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    allowance: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        total: z.ZodNumber;
+        used: z.ZodNumber;
+        renewsAt: z.ZodISODateTime;
+    }, z.core.$strip>>>;
+    bought: z.ZodDefault<z.ZodNumber>;
+    customer: z.ZodDefault<z.ZodBoolean>;
+    autoTopUp: z.ZodNullable<z.ZodObject<{
+        below: z.ZodNumber;
+        amountCents: z.ZodNumber;
+        monthlyLimitCents: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+        chargedThisMonthCents: z.ZodDefault<z.ZodNumber>;
+        stopped: z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
+            no_card: "no_card";
+            saving_card: "saving_card";
+            not_a_card: "not_a_card";
+            declined: "declined";
+            needs_authentication: "needs_authentication";
+            not_charged: "not_charged";
+            under_line: "under_line";
+            refunded: "refunded";
+            disputed: "disputed";
+            monthly_limit: "monthly_limit";
+        }>, z.core.$ZodBranded<z.ZodString, "Unknown", "out">]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type BillingSummary = z.infer<typeof BillingSummarySchema>;
+/** `GET`, open to anyone: the plans offered and their prices, and what a top-up buys. */
+export declare const BILLING_PLANS_PATH = "/api/billing/plans";
+export declare const BillingPlansSchema: z.ZodObject<{
+    plans: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        family: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        recommended: z.ZodDefault<z.ZodBoolean>;
+        monthlyCredits: z.ZodNumber;
+        prices: z.ZodArray<z.ZodObject<{
+            interval: z.ZodUnion<readonly [z.ZodEnum<{
+                month: "month";
+                year: "year";
+            }>, z.core.$ZodBranded<z.ZodString, "Unknown", "out">]>;
+            amountCents: z.ZodNumber;
+            currency: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    topUp: z.ZodObject<{
+        currency: z.ZodString;
+        creditsPerDollar: z.ZodNumber;
+        minCents: z.ZodNumber;
+        maxCents: z.ZodNumber;
+        presetsCents: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+    }, z.core.$strip>;
+    welcomeCredits: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type BillingPlans = z.infer<typeof BillingPlansSchema>;
+/** `GET ?days=30&timeZone=Asia/Shanghai`: credits spent each day, the days with none left out. */
+export declare const BILLING_USAGE_PATH = "/api/billing/usage";
+/** What credits are spent on: AllyHub's models, cloud tools, cloud Studio, anything else. */
+export declare const SPEND_KINDS: readonly ["models", "tools", "studio", "other"];
+export type SpendKind = (typeof SPEND_KINDS)[number];
+export declare const BillingUsageSchema: z.ZodObject<{
+    days: z.ZodArray<z.ZodObject<{
+        day: z.ZodISODate;
+        credits: z.ZodNumber;
+        byKind: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type BillingUsage = z.infer<typeof BillingUsageSchema>;
+/** `POST`, an owner's or an admin's: Stripe Checkout for a plan or a top-up; answers `{ url }`. */
+export declare const BILLING_CHECKOUT_PATH = "/api/billing/checkout";
+export declare const CheckoutRequestSchema: z.ZodUnion<readonly [z.ZodObject<{
+    plan: z.ZodString;
+    interval: z.ZodEnum<{
+        month: "month";
+        year: "year";
+    }>;
+}, z.core.$strict>, z.ZodObject<{
+    topUpCents: z.ZodNumber;
+}, z.core.$strict>]>;
+/**
+ * `POST`, an owner's or an admin's: Stripe's Customer Portal, at its home
+ * (the card, the billing details, invoices) or at one flow: a new card,
+ * a change of plan to confirm, the plan's cancellation; answers `{ url }`.
+ */
+export declare const BILLING_PORTAL_PATH = "/api/billing/portal";
+export declare const PortalRequestSchema: z.ZodDefault<z.ZodUnion<readonly [z.ZodObject<{
+    flow: z.ZodEnum<{
+        home: "home";
+        payment_method: "payment_method";
+        cancel: "cancel";
+    }>;
+}, z.core.$strict>, z.ZodObject<{
+    flow: z.ZodLiteral<"change_plan">;
+    plan: z.ZodString;
+    interval: z.ZodEnum<{
+        month: "month";
+        year: "year";
+    }>;
+}, z.core.$strict>]>>;
+export type PortalRequest = z.infer<typeof PortalRequestSchema>;
+/** `POST`, an owner's or an admin's: a plan cancelled at its period's end taken up again; answers the summary. */
+export declare const BILLING_RESUME_PATH = "/api/billing/resume";
+/** `GET`, an owner's or an admin's: the card charged without the person there, and where Stripe's emails go. */
+export declare const BILLING_PAYMENT_PATH = "/api/billing/payment";
+export declare const BillingPaymentSchema: z.ZodObject<{
+    card: z.ZodNullable<z.ZodObject<{
+        brand: z.ZodString;
+        last4: z.ZodString;
+        expMonth: z.ZodNumber;
+        expYear: z.ZodNumber;
+    }, z.core.$strip>>;
+    email: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type BillingPayment = z.infer<typeof BillingPaymentSchema>;
+/** `POST { topUpCents }`, an owner's or an admin's: credits bought with the saved card at once; answers `{ credits }`, what was added. */
+export declare const BILLING_TOP_UP_PATH = "/api/billing/top-up";
+export declare const TopUpRequestSchema: z.ZodObject<{
+    topUpCents: z.ZodNumber;
+}, z.core.$strict>;
+/** `POST`, any member's: the organization's owners and admins are asked by email to add credits, at most once a day for each member. */
+export declare const BILLING_REQUEST_PATH = "/api/billing/request";
+/**
+ * `PUT { below, amountCents, monthlyLimitCents?, newCard? }`, an owner's or
+ * an admin's: auto top-up on, answered `{ on: true }`, or `{ saveCard: url }`,
+ * a Checkout that saves a card first (or a new one, `newCard`); `DELETE`
+ * turns it off.
+ */
+export declare const AUTO_TOP_UP_PATH = "/api/billing/auto-top-up";
+export declare const AutoTopUpRequestSchema: z.ZodObject<{
+    below: z.ZodNumber;
+    amountCents: z.ZodNumber;
+    monthlyLimitCents: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    newCard: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Why billing refused a request, in `error.data.reason`, for a page to say
+ * in its words, with the values it names: an amount outside a top-up's
+ * bounds (`min`, `max`, in cents), a monthly limit under the amount, a
+ * plan already bought, a plan not offered, nothing to pay with, an
+ * organization frozen by a dispute, a card that could not be charged
+ * (`why`, an auto top-up stop's), a request asked already today.
+ */
+export declare const BILLING_REFUSALS: readonly ["top_up_amount", "monthly_limit", "has_plan", "no_plan", "no_such_plan", "not_customer", "no_card", "frozen", "not_charged", "asked_today"];
+export type BillingRefusal = (typeof BILLING_REFUSALS)[number];
+/** The plan's section of Settings, where a payment that was not made comes back to. */
+export declare const BILLING_PAGE_PATH = "/settings/plan";
+/** Where Stripe's Checkout lands once paid: the plan's section, which follows the balance until what was paid for is there. */
+export declare const BILLING_PAID_PATH = "/settings/plan?paid=1";
+/** The models the organization may use. */
+export declare const LLM_MODELS_PATH = "/api/llm/models";
+/** Anthropic's Messages API (`POST`), streamed or not. */
+export declare const LLM_MESSAGES_PATH = "/api/llm/v1/messages";
+/** A model's tier by its price, the highest first: how a client groups the models. */
+export declare const MODEL_TIERS: readonly ["premium", "standard", "efficient"];
+export type ModelTier = (typeof MODEL_TIERS)[number];
+export declare const ModelCatalogSchema: z.ZodObject<{
+    models: z.ZodArray<z.ZodObject<{
+        reasoning: z.ZodOptional<z.ZodBoolean>;
+        input: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        contextWindow: z.ZodOptional<z.ZodNumber>;
+        maxOutput: z.ZodOptional<z.ZodNumber>;
+        tier: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+            premium: "premium";
+            standard: "standard";
+            efficient: "efficient";
+        }>, z.core.$ZodBranded<z.ZodString, "Unknown", "out">]>>;
+        maker: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$loose>>;
+    defaultModel: z.ZodString;
+    needPlan: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        tier: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+            premium: "premium";
+            standard: "standard";
+            efficient: "efficient";
+        }>, z.core.$ZodBranded<z.ZodString, "Unknown", "out">]>>;
+        maker: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$loose>>>;
+}, z.core.$strip>;
+export type ModelCatalog = z.infer<typeof ModelCatalogSchema>;
+/** A JSON Schema document of a tool's input or output. */
+export declare const JsonSchemaSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export declare const CATALOG_PATH = "/api/catalog";
+export declare const CatalogWorkSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodString;
+}, z.core.$strip>;
+export type CatalogWork = z.infer<typeof CatalogWorkSchema>;
+export declare const CatalogToolSchema: z.ZodObject<{
+    name: z.ZodString;
+    work: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodString;
+    input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    output: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    long: z.ZodBoolean;
+}, z.core.$strip>;
+export type CatalogTool = z.infer<typeof CatalogToolSchema>;
+export declare const CatalogSchema: z.ZodObject<{
+    version: z.ZodString;
+    works: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+    }, z.core.$strip>>;
+    tools: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        work: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        output: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        long: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Catalog = z.infer<typeof CatalogSchema>;
+/** Where a tool's calls are made (POST). */
+export declare const toolCallsPath: (tool: string) => string;
+/** Where a call is read again (GET). */
+export declare const callPath: (id: string) => string;
+export declare const ToolCallRequestSchema: z.ZodObject<{
+    input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strict>;
+export type ToolCallRequest = z.infer<typeof ToolCallRequestSchema>;
+export declare const CALL_STATUS: readonly ["working", "completed", "failed"];
+export declare const ToolCallSchema: z.ZodObject<{
+    id: z.ZodString;
+    tool: z.ZodString;
+    status: z.ZodUnion<readonly [z.ZodEnum<{
+        working: "working";
+        completed: "completed";
+        failed: "failed";
+    }>, z.core.$ZodBranded<z.ZodString, "Unknown", "out">]>;
+    output: z.ZodOptional<z.ZodUnknown>;
+    error: z.ZodOptional<z.ZodObject<{
+        kind: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+    credits: z.ZodOptional<z.ZodNumber>;
+    pollAfterMs: z.ZodOptional<z.ZodNumber>;
+    createdAt: z.ZodString;
+    endedAt: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ToolCall = z.infer<typeof ToolCallSchema>;
+/** A kept file's in-app path, as a tool's output gives it. */
+export declare const allyFilePath: (id: string, name: string) => string;
+/** The file an in-app path points at, or undefined. */
+export declare function parseAllyFilePath(path: string): {
+    id: string;
+    name: string;
+} | undefined;
+/** The largest file kept, in bytes. */
+export declare const FILE_MAX_BYTES: number;
+/** `POST { name, size, sha256, contentType }`: a file to keep; answers its id and where to put its bytes, or no `upload` when it is kept already. */
+export declare const FILES_PATH = "/api/files";
+export declare const FileCreateRequestSchema: z.ZodObject<{
+    name: z.ZodString;
+    size: z.ZodInt;
+    sha256: z.ZodString;
+    contentType: z.ZodString;
+}, z.core.$strict>;
+export type FileCreateRequest = z.infer<typeof FileCreateRequestSchema>;
+export declare const FileCreatedSchema: z.ZodObject<{
+    id: z.ZodString;
+    upload: z.ZodNullable<z.ZodObject<{
+        url: z.ZodURL;
+        headers: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type FileCreated = z.infer<typeof FileCreatedSchema>;
+/** `POST`: the bytes are put; answers the file once storage has them as asked. */
+export declare const fileDonePath: (fileId: string) => string;
+export declare const UploadedFileSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+/** `GET <api>/api/files/<fileId>/content?disposition=…`: a signed URL. */
+export declare const FileContentResponseSchema: z.ZodObject<{
+    url: z.ZodURL;
+}, z.core.$strip>;
+/** The path of a file's signed URL: a download, or shown inline (for a provider to fetch). */
+export declare const fileContentPath: (fileId: string, disposition: "attachment" | "inline") => string;
+//# sourceMappingURL=cloud.d.ts.map

package/dist/node_modules/@allyhub/protocol/dist/cloud.js

@@ -0,0 +1,2 @@
+/*! AllyHub. Copyright (c) 2026 AllyHub, Inc. All rights reserved. Use is subject to LICENSE.md. */
+import{z as t}from"zod";import{openEnum as o}from"./open.js";export const API_KEY_ENV="ALLYHUB_API_KEY",BILLING_SUMMARY_PATH="/api/billing/summary",AUTO_TOP_UP_STOPS=["no_card","saving_card","not_a_card","declined","needs_authentication","not_charged","under_line","refunded","disputed","monthly_limit"],BILLING_INTERVALS=["month","year"],BillingSummarySchema=t.object({credits:t.number(),held:t.number(),owed:t.number(),frozen:t.string().nullable().default(null),plan:t.object({id:t.string(),name:t.string(),interval:o(BILLING_INTERVALS),status:t.string(),renewsAt:t.iso.datetime().nullable(),endsAt:t.iso.datetime().nullable(),monthlyCredits:t.number().default(0),price:t.object({amountCents:t.number(),currency:t.string()}).nullable().default(null)}).nullable(),allowance:t.object({total:t.number(),used:t.number(),renewsAt:t.iso.datetime()}).nullable().default(null),bought:t.number().default(0),customer:t.boolean().default(!1),autoTopUp:t.object({below:t.number(),amountCents:t.number(),monthlyLimitCents:t.number().nullable().default(null),chargedThisMonthCents:t.number().default(0),stopped:o(AUTO_TOP_UP_STOPS).nullable()}).nullable()}),BILLING_PLANS_PATH="/api/billing/plans",BillingPlansSchema=t.object({plans:t.array(t.object({id:t.string(),name:t.string(),family:t.string().nullable().default(null),recommended:t.boolean().default(!1),monthlyCredits:t.number(),prices:t.array(t.object({interval:o(BILLING_INTERVALS),amountCents:t.number(),currency:t.string()}))})),topUp:t.object({currency:t.string(),creditsPerDollar:t.number(),minCents:t.number(),maxCents:t.number(),presetsCents:t.array(t.number()).default([])}),welcomeCredits:t.number().optional()}),BILLING_USAGE_PATH="/api/billing/usage",SPEND_KINDS=["models","tools","studio","other"],BillingUsageSchema=t.object({days:t.array(t.object({day:t.iso.date(),credits:t.number(),byKind:t.record(t.string(),t.number()).default({})}))}),BILLING_CHECKOUT_PATH="/api/billing/checkout",CheckoutRequestSchema=t.union([t.strictObject({plan:t.string(),interval:t.enum(BILLING_INTERVALS)}),t.strictObject({topUpCents:t.number().int()})]),BILLING_PORTAL_PATH="/api/billing/portal",PortalRequestSchema=t.union([t.strictObject({flow:t.enum(["home","payment_method","cancel"])}),t.strictObject({flow:t.literal("change_plan"),plan:t.string(),interval:t.enum(BILLING_INTERVALS)})]).default({flow:"home"}),BILLING_RESUME_PATH="/api/billing/resume",BILLING_PAYMENT_PATH="/api/billing/payment",BillingPaymentSchema=t.object({card:t.object({brand:t.string(),last4:t.string(),expMonth:t.number(),expYear:t.number()}).nullable(),email:t.string().nullable()}),BILLING_TOP_UP_PATH="/api/billing/top-up",TopUpRequestSchema=t.strictObject({topUpCents:t.number().int()}),BILLING_REQUEST_PATH="/api/billing/request",AUTO_TOP_UP_PATH="/api/billing/auto-top-up",AutoTopUpRequestSchema=t.strictObject({below:t.number().nonnegative(),amountCents:t.number().int().positive(),monthlyLimitCents:t.number().int().positive().nullable().optional(),newCard:t.boolean().optional()}),BILLING_REFUSALS=["top_up_amount","monthly_limit","has_plan","no_plan","no_such_plan","not_customer","no_card","frozen","not_charged","asked_today"],BILLING_PAGE_PATH="/settings/plan",BILLING_PAID_PATH="/settings/plan?paid=1",LLM_MODELS_PATH="/api/llm/models",LLM_MESSAGES_PATH="/api/llm/v1/messages",MODEL_TIERS=["premium","standard","efficient"];const a={tier:o(MODEL_TIERS).optional(),maker:t.string().min(1).optional()};export const ModelCatalogSchema=t.object({models:t.array(t.looseObject({id:t.string().min(1),name:t.string().min(1),...a,reasoning:t.boolean().optional(),input:t.array(t.string()).optional(),contextWindow:t.number().int().positive().optional(),maxOutput:t.number().int().positive().optional()})).min(1),defaultModel:t.string().min(1),needPlan:t.array(t.looseObject({id:t.string().min(1),name:t.string().min(1),...a})).default([])}),JsonSchemaSchema=t.record(t.string(),t.unknown()),CATALOG_PATH="/api/catalog",CatalogWorkSchema=t.object({id:t.string().min(1),title:t.string().min(1),description:t.string().min(1)}),CatalogToolSchema=t.object({name:t.string().min(1),work:t.string().min(1),title:t.string().min(1),description:t.string().min(1),input:JsonSchemaSchema,output:JsonSchemaSchema,long:t.boolean()}),CatalogSchema=t.object({version:t.string().min(1),works:t.array(CatalogWorkSchema),tools:t.array(CatalogToolSchema)}),toolCallsPath=e=>`/api/tools/${encodeURIComponent(e)}/calls`,callPath=e=>`/api/calls/${encodeURIComponent(e)}`,ToolCallRequestSchema=t.strictObject({input:t.record(t.string(),t.unknown())}),CALL_STATUS=["working","completed","failed"],ToolCallSchema=t.object({id:t.string().min(1),tool:t.string().min(1),status:o(CALL_STATUS),output:t.unknown().optional(),error:t.object({kind:t.string().min(1),message:t.string().min(1)}).optional(),credits:t.number().nonnegative().optional(),pollAfterMs:t.number().int().nonnegative().optional(),createdAt:t.string(),endedAt:t.string().optional()});const i="ally://data-tool-results/";export const allyFilePath=(e,n)=>`${i}${encodeURIComponent(e)}/${encodeURIComponent(n)}`;export function parseAllyFilePath(e){if(!e.startsWith(i))return;const[n,r,...l]=e.slice(i.length).split("/");if(!(!n||!r||l.length>0))try{return{id:decodeURIComponent(n),name:decodeURIComponent(r)}}catch{return}}export const FILE_MAX_BYTES=1024*1024*1024,FILES_PATH="/api/files",FileCreateRequestSchema=t.strictObject({name:t.string().min(1).max(255),size:t.int().positive().max(FILE_MAX_BYTES),sha256:t.string().regex(/^[0-9a-f]{64}$/u),contentType:t.string().min(1).max(255)}),FileCreatedSchema=t.object({id:t.string().min(1),upload:t.object({url:t.url(),headers:t.record(t.string(),t.string())}).nullable()}),fileDonePath=e=>`${FILES_PATH}/${encodeURIComponent(e)}/done`,UploadedFileSchema=t.object({id:t.string().min(1),name:t.string()}),FileContentResponseSchema=t.object({url:t.url()}),fileContentPath=(e,n)=>`${FILES_PATH}/${encodeURIComponent(e)}/content?disposition=${n}`;