@layervai/qurl 3.1.1 → 4.0.0

package/dist/esm/client.d.ts

@@ -1,21 +1,15 @@
+import type { AccessCodeListOutput, ApiKey, ApiKeyListOutput, BatchCreateInput, BatchCreateOutput, BillingInvoiceListOutput, CallerIdentity, CheckoutSession, ClientOptions, ConnectorInstallation, ConnectorInstallationListOutput, ConsumerAccessPolicy, ConsumerGrant, ConsumerGrantApprovalInput, ConsumerGrantListOutput, ConsumerInvitation, ConsumerInvitationListOutput, ConsumerListInput, CreateAccessCodeInput, CreateAccessCodeOutput, CreateApiKeyInput, CreateApiKeyOutput, CreateBillingCheckoutInput, CreateDelegatedQurlBatchInput, CreateDelegatedQurlBatchOptions, CreateExternalIdentityBindingInput, CreateExternalIdentityBindingOutput, CreateInput, CreateOutput, CreatePortalOptions, CreateQurlForResourceInput, CreateResourceInput, CreateWebhookInput, Customer, DelegatedQurl, DelegatedQurlBatchAccepted, Domain, DomainListOutput, DomainVerifyResult, ExtendInput, GetDelegatedQurlBatchOptions, GetDelegatedQurlBatchOutput, Invoice, ListApiKeysInput, ListBillingInvoicesInput, ListConnectorInstallationsInput, ListDomainsInput, ListInput, ListOutput, ListWebhookDeliveriesInput, ListWebhooksInput, MintInput, MintOutput, Portal, PortalSession, ProtectUrlOptions, QURL, Quota, QurlSummary, RedeemAccessCodeInput, RedeemAccessCodeOutput, RegisterDomainInput, RequestOptions, ResolveInput, ResolveOutput, Resource, ResourceDetail, ResourceHandle, ResourceListInput, ResourceListOutput, SessionListOutput, SessionTerminateOutput, ShareResourceOptions, UpdateApiKeyInput, UpdateCustomerInput, UpdateInput, UpdateResourceInput, UpdateResourceQurlInput, UpdateWebhookInput, UsageCurrentPeriod, UsageDaily, Webhook, WebhookDelivery, WebhookDeliveryListOutput, WebhookEventTypeInfo, WebhookListOutput, WebhookWithSecret } from "./types.js";
 import { ShareLink } from "./share.js";
-import type { ConsumerAccessPolicy, ConsumerInvitation, ConsumerGrant, ConsumerGrantApprovalInput, ConsumerListInput, ConsumerInvitationListOutput, ConsumerGrantListOutput, AccessCodeListOutput, ApiKey, ApiKeyListOutput, ApiKeyRequestScope, BillingInvoiceListOutput, BatchCreateInput, BatchCreateOutput, ClientOptions, ConnectorInstallation, ConnectorInstallationListOutput, CreateAccessCodeInput, CreateAccessCodeOutput, CreateApiKeyInput, CreateApiKeyOutput, CreateBillingCheckoutInput, CreateDelegatedQurlBatchInput, CreateDelegatedQurlBatchOptions, CreateInput, CreateOutput, CreatePortalOptions, CreateQurlForResourceInput, CreateResourceInput, CreateWebhookInput, Customer, CheckoutSession, Domain, DomainListOutput, DomainVerifyResult, DelegatedQurl, DelegatedQurlBatchAccepted, GetDelegatedQurlBatchOptions, GetDelegatedQurlBatchOutput, ExtendInput, Invoice, ListInput, ListOutput, ListApiKeysInput, ListBillingInvoicesInput, ListConnectorInstallationsInput, ListDomainsInput, ListWebhookDeliveriesInput, ListWebhooksInput, MintInput, MintOutput, Portal, PortalSession, ProtectUrlOptions, QURL, QurlSummary, Quota, RedeemAccessCodeInput, RedeemAccessCodeOutput, RegisterDomainInput, Resource, ResourceDetail, ResourceHandle, ResourceListInput, ResourceListOutput, RequestOptions, ResolveInput, ResolveOutput, SessionListOutput, SessionTerminateOutput, ShareResourceOptions, UpdateApiKeyInput, UpdateCustomerInput, UpdateInput, UpdateResourceInput, UpdateResourceQurlInput, UpdateWebhookInput, UsageCurrentPeriod, UsageDaily, Webhook, WebhookDelivery, WebhookDeliveryListOutput, WebhookEventTypeInfo, WebhookListOutput, WebhookWithSecret } from "./types.js";
-/** Narrow a response scope before reusing it in a create/update request. */
-export declare function isApiKeyRequestScope(scope: string): scope is ApiKeyRequestScope;
-/**
- * Shape of qurl-go's offline signed-fragment links: three or more
- * dot-separated base64url parts (<version>.<claims>.<secret>.<sig>).
- * Detected only to give those links a precise error in extractAccessToken.
- *
- * @internal Exported for in-package tests; not re-exported from index.ts.
- */
-export declare const SIGNED_FRAGMENT_RE: RegExp;
+import { ProtectedResource } from "./client-portals.js";
+import { ConnectorResource } from "./client-connectors.js";
+import type { EnsureConnectorResourceResult } from "./client-connectors.js";
 /** qURL API client. */
 export declare class QURLClient {
     private readonly baseUrl;
     private readonly apiKey;
     private readonly fetchFn;
     private readonly maxRetries;
+    private readonly maxResponseBodyBytes;
     private readonly timeout;
     private readonly userAgent;
     private readonly debugFn;
@@ -68,7 +62,9 @@ export declare class QURLClient {
      * {@link ProtectedResource.createPortal}:
      *
      * ```ts
-     * const resource = await client.protectUrl("https://internal.example.com/dashboard");
+     * const resource = await client.protectUrl("https://internal.example.com/dashboard", {
+     *   name: "Team dashboard",
+     * });
      * const portal = await resource.createPortal({ validFor: "5m" });
      * share(portal.link);
      * ```
@@ -95,8 +91,18 @@ export declare class QURLClient {
      * need the full resource details.
      */
     resourceByCrid(id: string): ProtectedResource;
-    /** Find or create the active qURL Connector resource for an immutable slug. */
-    ensureConnectorResource(slug: string, requestOptions?: RequestOptions, consumerAccess?: ConsumerAccessPolicy): Promise<EnsureConnectorResourceResult>;
+    /**
+     * Find or create the active qURL Connector resource for an immutable slug.
+     *
+     * `name` is the public name recipients see. The service requires it when the
+     * slug is new (`400 name_required` otherwise) and ignores it on reuse.
+     *
+     * @param slug - Immutable owner-scoped Connector slug.
+     * @param requestOptions - Per-call request options.
+     * @param consumerAccess - Private consumer policy for a new resource.
+     * @param name - Public resource name; required when the slug is new.
+     */
+    ensureConnectorResource(slug: string, requestOptions?: RequestOptions, consumerAccess?: ConsumerAccessPolicy, name?: string): Promise<EnsureConnectorResourceResult>;
     /** Fetch a qURL Connector resource by its CRID. */
     getConnectorResource(crid: string): Promise<ConnectorResource>;
     /** Fetch the single active qURL Connector resource for an immutable slug. */
@@ -184,6 +190,8 @@ export declare class QURLClient {
      *   populated `BatchCreateOutput` body in this case; whitelisted via
      *   `passthroughStatuses` so the structured per-item errors aren't
      *   swallowed by the generic error path.
+     *   HTTP 400 is the documented all-item validation failure. HTTP 422 is
+     *   not a batch passthrough status and follows normal error handling.
      *
      * Callers that only catch thrown errors will **silently miss partial
      * failures**. Always branch on `result.failed > 0` before treating the
@@ -336,6 +344,8 @@ export declare class QURLClient {
      * Accepts a plain token string or a `ResolveInput` object.
      */
     resolve(input: ResolveInput | string, options?: RequestOptions): Promise<ResolveOutput>;
+    /** Get the caller's account and credential identity. */
+    getIdentity(): Promise<CallerIdentity>;
     /** Get quota and usage information. */
     getQuota(): Promise<Quota>;
     /** List resources from the `/v1/resources` API. */
@@ -358,6 +368,15 @@ export declare class QURLClient {
     getResource(id: string): Promise<ResourceDetail>;
     /** Update resource metadata. */
     updateResource(id: string, input: UpdateResourceInput, options?: RequestOptions): Promise<Resource>;
+    /** Start Stripe Connect onboarding for this publisher. LayerV collects 3%. */
+    connectPublisherStripe(): Promise<{
+        url: string;
+    }>;
+    /** Read this publisher's connected account and the fixed application fee. */
+    publisherStripeAccount(): Promise<{
+        account_id: string;
+        layerv_fee_percent: number;
+    }>;
     /** Send a publisher-only invitation. Mail delivery does not prove enrollment. */
     inviteConsumer(id: string, email: string): Promise<ConsumerInvitation>;
     listConsumerInvitations(id: string, input?: ConsumerListInput): Promise<ConsumerInvitationListOutput>;
@@ -482,6 +501,13 @@ export declare class QURLClient {
      * iteration begins.
      */
     listAllWebhookDeliveries(id: string, input?: Omit<ListWebhookDeliveriesInput, "cursor">): AsyncGenerator<WebhookDelivery, void, undefined>;
+    /**
+     * Bind an external identity using the provider's trusted OAuth JWT as the
+     * client's bearer credential. Persist the request key before calling, then
+     * securely store the returned one-time plaintext key without logging it.
+     * Retry a lost response within 24 hours with the same key and body.
+     */
+    createExternalIdentityBinding(input: CreateExternalIdentityBindingInput, options: RequestOptions): Promise<CreateExternalIdentityBindingOutput>;
     /** Create a new API key. */
     createApiKey(input: CreateApiKeyInput, options?: RequestOptions): Promise<CreateApiKeyOutput>;
     /** List API keys. */
@@ -547,65 +573,8 @@ export declare class QURLClient {
     private classifyFetchError;
     private classifyResponseReadError;
 }
-/**
- * A LayerV-protected resource, bound to the client that produced it.
- *
- * Obtained from {@link QURLClient.protectUrl} or {@link QURLClient.resourceByCrid} —
- * not constructed directly. Mint short-lived access links for the resource
- * with {@link createPortal} (qurl-go: `qurl.Resource`).
- */
-export declare class ProtectedResource {
-    #private;
-    /** The public resource CRID. */
-    readonly crid: string;
-    /** The private URL protected by this resource, when known. */
-    readonly targetUrl?: string;
-    /**
-     * Full server-populated {@link Resource} metadata when the handle came
-     * from an API response; `undefined` for {@link QURLClient.resourceByCrid}
-     * handles and for the one-call {@link QURLClient.createPortalForUrl} path.
-     */
-    readonly details?: Resource;
-    constructor(client: QURLClient, id: string, targetUrl?: string, details?: Resource);
-    /**
-     * Whether `resource` was produced by `client`. A static because the
-     * binding lives in a private field that only this class can read; used
-     * by {@link QURLClient.createPortal} to refuse handles bound to a
-     * different client.
-     */
-    static isBoundTo(resource: ProtectedResource, client: QURLClient): boolean;
-    /**
-     * Mint a short-lived qURL link (a portal) for this resource. See
-     * {@link QURLClient.createPortal} for the option reference.
-     */
-    createPortal(opts?: CreatePortalOptions, requestOptions?: RequestOptions): Promise<Portal>;
-}
-/** Result of idempotently ensuring a qURL Connector resource. */
-export interface EnsureConnectorResourceResult {
-    resource: ConnectorResource;
-    foundExisting: boolean;
-}
-declare const CONNECTOR_RESOURCE_CONSTRUCTOR_TOKEN: unique symbol;
-/**
- * A validated qURL Connector resource bound to the client that loaded it.
- *
- * Resource identity, reverse-routing identity, and NHP admission identity are
- * distinct server-issued values. Callers must consume each field verbatim and
- * must never derive one from another.
- */
-export declare class ConnectorResource {
-    #private;
-    readonly resourcePublicKey: string;
-    /** Required public identifier, verified against the returned resource key. */
-    readonly crid: string;
-    readonly connectorRoutingId: string;
-    readonly knockResourceId: string;
-    readonly slug: string;
-    readonly alias?: string;
-    /** @internal Instances are returned by QURLClient after wire validation. */
-    constructor(client: QURLClient, details: Resource, validationToken: typeof CONNECTOR_RESOURCE_CONSTRUCTOR_TOKEN);
-    /** Mint a short-lived portal for this Connector resource. */
-    createPortal(opts?: CreatePortalOptions, requestOptions?: RequestOptions): Promise<Portal>;
-}
-export {};
-//# sourceMappingURL=client.d.ts.map
+export { isApiKeyRequestScope } from "./client-management.js";
+export { SIGNED_FRAGMENT_RE } from "./client-portals.js";
+export { ProtectedResource } from "./client-portals.js";
+export type { EnsureConnectorResourceResult } from "./client-connectors.js";
+export { ConnectorResource } from "./client-connectors.js";